yatex: 680d92784c1a docs/yatexe

1735 File: yatexe, Node: Defining option-add-in, Next: Defining argument-add-in, Prev: How the add-in function works, Up: How the add-in function works

1736

1737 Defining `option add-in'

1738 ........................

1739

1740 If you want `{|c|c|c|}' for all `tabular' environment,

1741

1742 (defun YaTeX:tabular ()

1743 "{|c|c|c|}")

1744

1745 is enough. If you want more complicated format, define as below.

1746

1747 (defun YaTeX:tabular ()

1748 "{@{\\vrule width 1pt\\ }|||@{\\ \\vrule width 1pt}}")

1749

1750 Note that the character `\' must be described as `\\' in Emacs-Lisp. The

1751 next example reads the tabular format from keyboard.

1752 (defun YaTeX:tabular ()

1753 (concat "{" (read-string "Rule: ") "}"))

1754

1755

1756 File: yatexe, Node: Defining argument-add-in, Next: Defining enclosing-add-in, Prev: Defining option-add-in, Up: How the add-in function works

1757

1758 Defining `argument add-in'

1759 ..........................

1760

1761 This section describes how to define the add-in function for

1762 `\newcommand'.

1763

1764 The first argument of `\newcommand' begins always with `\'. The second

1765 argument is usually so complex that we can not edit them in the

1766 minibuffer. Here is the created function considering this.

1767

1768 (defun YaTeX::newcommand (n) ;n is argument position

1769 (cond

1770 ((= n 1) ;1st argument is macro name

1771 (read-string "Command: " "\\")) ;initial input `\'

1772 ((= n 2) "") ;do nothing when reading arg#2

1773 (t nil)))

1774

1775 Note that when the `argument add-in' function return `nil', normal

1776 argument reader will be called.

1777

1778

1779 File: yatexe, Node: Defining enclosing-add-in, Prev: Defining argument-add-in, Up: How the add-in function works

1780

1781 Defining `enclosing add-in'

1782 ...........................

1783

1784 This section describes how to define the add-in function for text

1785 enclosed by `\frac{}'.

1786

1787 When enclosing the text `5/3' by `\frac{}', you might want to replace

1788 `/' with `}{'. Enclosing function `YaTeX::frac-region' is called with two

1789 arguments, beginning of enclosed text and end of enclosed text. The

1790 function is expected to replace `/' with `}{'. Here is an example

1791 expression.

1792

1793 (defun YaTeX::frac-region (beg end)

1794 (catch 'done

1795 (while (search-forward "/" end t)

1796 (goto-char (match-beginning 0))

1797 (if (y-or-n-p "Replace this slash(/) with `}{'")

1798 (throw 'done (replace-match "}{")))

1799 (goto-char (match-end 0)))))

1800

1801

1802 File: yatexe, Node: How the function is called, Next: Useful functions for creating add-in, Prev: How the add-in function works, Up: Add-in functions

1803

1804 How the function is called

1805 --------------------------

1806

1807 YaTeX calls the add-in functions for specified begin-type, section-type,

1808 and maketitle-type command, if any. `Option add-in' functions for

1809 begin-type are called when `\begin{ENV}' has been inserted, functions for

1810 section-type are called just before input of the first argument, and

1811 functions for maketitle-type is called after maketitle-type command has

1812 been inserted. `Argument add-in' functions are called at each entry of

1813 arguments for section-type commands.

1814