yatex: 91bf68eeefe8 docs/yatexe

1742 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

1743

1744 Defining `option add-in'

1745 ........................

1746

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

1748

1749 (defun YaTeX:tabular ()

1750 "{|c|c|c|}")

1751

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

1753

1754 (defun YaTeX:tabular ()

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

1756

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

1758 next example reads the tabular format from keyboard.

1759 (defun YaTeX:tabular ()

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

1761

1762

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

1764

1765 Defining `argument add-in'

1766 ..........................

1767

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

1769 `\newcommand'.

1770

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

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

1773 minibuffer. Here is the created function considering this.

1774

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

1776 (cond

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

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

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

1780 (t nil)))

1781

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

1783 argument reader will be called.

1784

1785

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

1787

1788 Defining `enclosing add-in'

1789 ...........................

1790

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

1792 enclosed by `\frac{}'.

1793

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

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

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

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

1798 expression.

1799

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

1801 (catch 'done

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

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

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

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

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

1807

1808

1809 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

1810

1811 How the function is called

1812 --------------------------

1813

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

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

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

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

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

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

1820 arguments for section-type commands.

1821