yatex: d467c0fb6083 docs/yatexe

1832 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

1833

1834 Defining `option add-in'

1835 ........................

1836

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

1838

1839 (defun YaTeX:tabular ()

1840 "{|c|c|c|}")

1841

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

1843

1844 (defun YaTeX:tabular ()

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

1846

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

1848 next example reads the tabular format from keyboard.

1849 (defun YaTeX:tabular ()

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

1851

1852

1853

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

1855

1856 Defining `argument add-in'

1857 ..........................

1858

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

1860 `\newcommand'.

1861

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

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

1864 minibuffer. Here is the created function considering this.

1865

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

1867 (cond

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

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

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

1871 (t nil)))

1872

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

1874 argument reader will be called.

1875

1876

1877

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

1879

1880 Defining `enclosing add-in'

1881 ...........................

1882

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

1884 enclosed by `\frac{}'.

1885

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

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

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

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

1890 expression.

1891

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

1893 (catch 'done

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

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

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

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

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

1899

1900

1901

1902 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

1903

1904 How the function is called

1905 --------------------------

1906

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

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

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

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

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

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

1913 arguments for section-type commands.

1914