yatex: 78d0fdc0459c docs/yatexe

1836 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

1837

1838 Defining `option add-in'

1839 ........................

1840

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

1842

1843 (defun YaTeX:tabular ()

1844 "{|c|c|c|}")

1845

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

1847

1848 (defun YaTeX:tabular ()

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

1850

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

1852 next example reads the tabular format from keyboard.

1853 (defun YaTeX:tabular ()

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

1855

1856

1857

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

1859

1860 Defining `argument add-in'

1861 ..........................

1862

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

1864 `\newcommand'.

1865

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

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

1868 minibuffer. Here is the created function considering this.

1869

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

1871 (cond

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

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

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

1875 (t nil)))

1876

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

1878 argument reader will be called.

1879

1880

1881

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

1883

1884 Defining `enclosing add-in'

1885 ...........................

1886

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

1888 enclosed by `\frac{}'.

1889

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

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

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

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

1894 expression.

1895

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

1897 (catch 'done

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

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

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

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

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

1903

1904

1905

1906 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

1907

1908 How the function is called

1909 --------------------------

1910

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

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

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

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

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

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

1917 arguments for section-type commands.

1918