yatex: 355b28fc0025 docs/yatexe

1956 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

1957

1958 Defining `option add-in'

1959 ........................

1960

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

1962

1963 (defun YaTeX:tabular ()

1964 "{|c|c|c|}")

1965

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

1967

1968 (defun YaTeX:tabular ()

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

1970

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

1972 next example reads the tabular format from keyboard.

1973 (defun YaTeX:tabular ()

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

1975

1976

1977

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

1979

1980 Defining `argument add-in'

1981 ..........................

1982

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

1984 `\newcommand'.

1985

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

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

1988 minibuffer. Here is the created function considering this.

1989

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

1991 (cond

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

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

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

1995 (t nil)))

1996

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

1998 argument reader will be called.

1999

2000

2001

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

2003

2004 Defining `enclosing add-in'

2005 ...........................

2006

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

2008 enclosed by `\frac{}'.

2009

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

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

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

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

2014 expression.

2015

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

2017 (catch 'done

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

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

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

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

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

2023

2024

2025

2026 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

2027

2028 How the function is called

2029 --------------------------

2030

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

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

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

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

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

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

2037 arguments for section-type commands.

2038