yatex: a925cf5222f3 docs/yatexe

1760 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

1761

1762 Defining `option add-in'

1763 ........................

1764

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

1766

1767 (defun YaTeX:tabular ()

1768 "{|c|c|c|}")

1769

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

1771

1772 (defun YaTeX:tabular ()

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

1774

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

1776 next example reads the tabular format from keyboard.

1777 (defun YaTeX:tabular ()

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

1779

1780

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

1782

1783 Defining `argument add-in'

1784 ..........................

1785

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

1787 `\newcommand'.

1788

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

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

1791 minibuffer. Here is the created function considering this.

1792

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

1794 (cond

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

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

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

1798 (t nil)))

1799

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

1801 argument reader will be called.

1802

1803

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

1805

1806 Defining `enclosing add-in'

1807 ...........................

1808

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

1810 enclosed by `\frac{}'.

1811

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

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

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

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

1816 expression.

1817

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

1819 (catch 'done

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

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

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

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

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

1825

1826

1827 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

1828

1829 How the function is called

1830 --------------------------

1831

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

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

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

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

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

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

1838 arguments for section-type commands.

1839