yatex: 781604df4cbd docs/yatexe

1896 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

1897

1898 Defining `option add-in'

1899 ........................

1900

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

1902

1903 (defun YaTeX:tabular ()

1904 "{|c|c|c|}")

1905

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

1907

1908 (defun YaTeX:tabular ()

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

1910

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

1912 next example reads the tabular format from keyboard.

1913 (defun YaTeX:tabular ()

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

1915

1916

1917

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

1919

1920 Defining `argument add-in'

1921 ..........................

1922

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

1924 `\newcommand'.

1925

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

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

1928 minibuffer. Here is the created function considering this.

1929

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

1931 (cond

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

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

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

1935 (t nil)))

1936

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

1938 argument reader will be called.

1939

1940

1941

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

1943

1944 Defining `enclosing add-in'

1945 ...........................

1946

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

1948 enclosed by `\frac{}'.

1949

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

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

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

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

1954 expression.

1955

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

1957 (catch 'done

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

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

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

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

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

1963

1964

1965

1966 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

1967

1968 How the function is called

1969 --------------------------

1970

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

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

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

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

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

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

1977 arguments for section-type commands.

1978