yatex: 99cb56e58ec3 docs/yatexe

1809 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

1810

1811 Defining `option add-in'

1812 ........................

1813

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

1815

1816 (defun YaTeX:tabular ()

1817 "{|c|c|c|}")

1818

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

1820

1821 (defun YaTeX:tabular ()

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

1823

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

1825 next example reads the tabular format from keyboard.

1826 (defun YaTeX:tabular ()

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

1828

1829

1830

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

1832

1833 Defining `argument add-in'

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

1835

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

1837 `\newcommand'.

1838

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

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

1841 minibuffer. Here is the created function considering this.

1842

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

1844 (cond

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

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

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

1848 (t nil)))

1849

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

1851 argument reader will be called.

1852

1853

1854

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

1856

1857 Defining `enclosing add-in'

1858 ...........................

1859

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

1861 enclosed by `\frac{}'.

1862

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

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

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

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

1867 expression.

1868

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

1870 (catch 'done

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

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

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

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

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

1876

1877

1878

1879 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

1880

1881 How the function is called

1882 --------------------------

1883

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

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

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

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

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

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

1890 arguments for section-type commands.

1891