yatex: 590fc51462c7 docs/yatexe

1785 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

1786

1787 Defining `option add-in'

1788 ........................

1789

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

1791

1792 (defun YaTeX:tabular ()

1793 "{|c|c|c|}")

1794

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

1796

1797 (defun YaTeX:tabular ()

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

1799

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

1801 next example reads the tabular format from keyboard.

1802 (defun YaTeX:tabular ()

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

1804

1805

1806

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

1808

1809 Defining `argument add-in'

1810 ..........................

1811

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

1813 `\newcommand'.

1814

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

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

1817 minibuffer. Here is the created function considering this.

1818

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

1820 (cond

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

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

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

1824 (t nil)))

1825

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

1827 argument reader will be called.

1828

1829

1830

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

1832

1833 Defining `enclosing add-in'

1834 ...........................

1835

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

1837 enclosed by `\frac{}'.

1838

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

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

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

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

1843 expression.

1844

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

1846 (catch 'done

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

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

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

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

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

1852

1853

1854

1855 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

1856

1857 How the function is called

1858 --------------------------

1859

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

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

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

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

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

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

1866 arguments for section-type commands.

1867