yatex: c996fbcc2e79 docs/yatexe

1919 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

1920

1921 Defining `option add-in'

1922 ........................

1923

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

1925

1926 (defun YaTeX:tabular ()

1927 "{|c|c|c|}")

1928

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

1930

1931 (defun YaTeX:tabular ()

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

1933

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

1935 next example reads the tabular format from keyboard.

1936 (defun YaTeX:tabular ()

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

1938

1939

1940

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

1942

1943 Defining `argument add-in'

1944 ..........................

1945

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

1947 `\newcommand'.

1948

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

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

1951 minibuffer. Here is the created function considering this.

1952

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

1954 (cond

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

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

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

1958 (t nil)))

1959

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

1961 argument reader will be called.

1962

1963

1964

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

1966

1967 Defining `enclosing add-in'

1968 ...........................

1969

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

1971 enclosed by `\frac{}'.

1972

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

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

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

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

1977 expression.

1978

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

1980 (catch 'done

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

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

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

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

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

1986

1987

1988

1989 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

1990

1991 How the function is called

1992 --------------------------

1993

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

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

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

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

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

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

2000 arguments for section-type commands.

2001