yatex: 668632d9392e docs/yatexe

1981 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

1982

1983 Defining `option add-in'

1984 ........................

1985

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

1987

1988 (defun YaTeX:tabular ()

1989 "{|c|c|c|}")

1990

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

1992

1993 (defun YaTeX:tabular ()

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

1995

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

1997 next example reads the tabular format from keyboard.

1998 (defun YaTeX:tabular ()

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

2000

2001

2002

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

2004

2005 Defining `argument add-in'

2006 ..........................

2007

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

2009 `\newcommand'.

2010

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

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

2013 minibuffer. Here is the created function considering this.

2014

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

2016 (cond

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

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

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

2020 (t nil)))

2021

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

2023 argument reader will be called.

2024

2025

2026

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

2028

2029 Defining `enclosing add-in'

2030 ...........................

2031

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

2033 enclosed by `\frac{}'.

2034

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

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

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

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

2039 expression.

2040

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

2042 (catch 'done

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

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

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

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

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

2048

2049

2050

2051 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

2052

2053 How the function is called

2054 --------------------------

2055

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

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

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

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

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

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

2062 arguments for section-type commands.

2063