yatex: e95ae850eefb docs/yatexe

1875 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

1876

1877 Defining `option add-in'

1878 ........................

1879

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

1881

1882 (defun YaTeX:tabular ()

1883 "{|c|c|c|}")

1884

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

1886

1887 (defun YaTeX:tabular ()

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

1889

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

1891 next example reads the tabular format from keyboard.

1892 (defun YaTeX:tabular ()

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

1894

1895

1896

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

1898

1899 Defining `argument add-in'

1900 ..........................

1901

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

1903 `\newcommand'.

1904

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

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

1907 minibuffer. Here is the created function considering this.

1908

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

1910 (cond

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

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

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

1914 (t nil)))

1915

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

1917 argument reader will be called.

1918

1919

1920

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

1922

1923 Defining `enclosing add-in'

1924 ...........................

1925

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

1927 enclosed by `\frac{}'.

1928

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

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

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

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

1933 expression.

1934

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

1936 (catch 'done

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

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

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

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

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

1942

1943

1944

1945 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

1946

1947 How the function is called

1948 --------------------------

1949

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

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

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

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

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

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

1956 arguments for section-type commands.

1957