yatex: f7ae3e4be0bb docs/yatexe

1870 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

1871

1872 Defining `option add-in'

1873 ........................

1874

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

1876

1877 (defun YaTeX:tabular ()

1878 "{|c|c|c|}")

1879

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

1881

1882 (defun YaTeX:tabular ()

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

1884

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

1886 next example reads the tabular format from keyboard.

1887 (defun YaTeX:tabular ()

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

1889

1890

1891

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

1893

1894 Defining `argument add-in'

1895 ..........................

1896

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

1898 `\newcommand'.

1899

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

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

1902 minibuffer. Here is the created function considering this.

1903

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

1905 (cond

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

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

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

1909 (t nil)))

1910

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

1912 argument reader will be called.

1913

1914

1915

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

1917

1918 Defining `enclosing add-in'

1919 ...........................

1920

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

1922 enclosed by `\frac{}'.

1923

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

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

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

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

1928 expression.

1929

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

1931 (catch 'done

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

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

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

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

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

1937

1938

1939

1940 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

1941

1942 How the function is called

1943 --------------------------

1944

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

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

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

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

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

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

1951 arguments for section-type commands.

1952