yatex: 784b25b062cc docs/yatexe

1841 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

1842

1843 Defining `option add-in'

1844 ........................

1845

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

1847

1848 (defun YaTeX:tabular ()

1849 "{|c|c|c|}")

1850

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

1852

1853 (defun YaTeX:tabular ()

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

1855

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

1857 next example reads the tabular format from keyboard.

1858 (defun YaTeX:tabular ()

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

1860

1861

1862

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

1864

1865 Defining `argument add-in'

1866 ..........................

1867

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

1869 `\newcommand'.

1870

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

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

1873 minibuffer. Here is the created function considering this.

1874

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

1876 (cond

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

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

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

1880 (t nil)))

1881

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

1883 argument reader will be called.

1884

1885

1886

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

1888

1889 Defining `enclosing add-in'

1890 ...........................

1891

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

1893 enclosed by `\frac{}'.

1894

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

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

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

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

1899 expression.

1900

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

1902 (catch 'done

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

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

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

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

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

1908

1909

1910

1911 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

1912

1913 How the function is called

1914 --------------------------

1915

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

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

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

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

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

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

1922 arguments for section-type commands.

1923