yatex: 9cef5d10a0f1 docs/yatexe

1839 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

1840

1841 Defining `option add-in'

1842 ........................

1843

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

1845

1846 (defun YaTeX:tabular ()

1847 "{|c|c|c|}")

1848

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

1850

1851 (defun YaTeX:tabular ()

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

1853

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

1855 next example reads the tabular format from keyboard.

1856 (defun YaTeX:tabular ()

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

1858

1859

1860

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

1862

1863 Defining `argument add-in'

1864 ..........................

1865

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

1867 `\newcommand'.

1868

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

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

1871 minibuffer. Here is the created function considering this.

1872

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

1874 (cond

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

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

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

1878 (t nil)))

1879

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

1881 argument reader will be called.

1882

1883

1884

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

1886

1887 Defining `enclosing add-in'

1888 ...........................

1889

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

1891 enclosed by `\frac{}'.

1892

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

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

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

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

1897 expression.

1898

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

1900 (catch 'done

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

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

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

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

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

1906

1907

1908

1909 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

1910

1911 How the function is called

1912 --------------------------

1913

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

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

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

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

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

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

1920 arguments for section-type commands.

1921