yatex: docs/yatexe.tex annotate

yatex

annotate docs/yatexe.tex @ 472:355b28fc0025

Preparing release of 1.80

author	HIROSE Yuuji <yuuji@gentei.org>
date	Sun, 10 Sep 2017 00:03:52 +0859
parents	d63ba3e187ca
children	668632d9392e

rev	line source
yuuji@46	1 \def\lang{jp} % -- texinfo --
yuuji@20	2 \input texinfo.tex
yuuji@20	3 @setfilename yatexe
yuuji@20	4 @settitle Yet Another tex-mode for Emacs
yuuji@272	5 @direntry
yuuji@272	6 * YaTeX-e: (yatexe). Yet Another tex-mode for Emacs (English).
yuuji@272	7 @end direntry
yuuji@20	8
yuuji@20	9 @iftex
yuuji@46	10 @c @syncodeindex fn cp
yuuji@472	11 @c Last modified Sat Sep 9 23:41:37 2017 on firestorm
yuuji@20	12 @syncodeindex vr cp
yuuji@20	13 @end iftex
yuuji@20	14
yuuji@20	15 @titlepage
yuuji@20	16 @sp 10
yuuji@20	17 @center
yuuji@20	18 @subtitle Yet Another tex-mode for emacs
yuuji@20	19 @title Wild Bird
yuuji@20	20 @subtitle // YaTeX //
yuuji@471	21 @author @copyright{} 1991-2017 by HIROSE, Yuuji [yuuji@@yatex.org]
yuuji@20	22 @end titlepage
yuuji@20	23
yuuji@20	24 @node Top, What is YaTeX?, (dir), (dir)
yuuji@20	25 @comment node-name, next, previous, up
yuuji@20	26 @cindex Demacs
yuuji@20	27 @cindex Mule
yuuji@20	28 @cindex LaTeX
yuuji@20	29 @cindex YaTeX
yuuji@20	30
yuuji@20	31 @menu
yuuji@471	32 * What is YaTeX?::
yuuji@51	33 * Main features:: What YaTeX can do
yuuji@51	34 * Installation:: Guide to install
yuuji@51	35 * Typesetting:: Call typesetting processes
yuuji@79	36 * %#notation:: Meta-keyword `%#'
yuuji@51	37 * Completion:: Input LaTeX commands with completion
yuuji@51	38 * Local dictionaries:: Directory dependent completion
yuuji@51	39 * Commenting out:: Commenting/uncommenting text
yuuji@51	40 * Cursor jump:: Jumping to related position
yuuji@51	41 * Changing and Deleting:: Changing/deleting certain unit of text
yuuji@51	42 * Filling:: Filling an item or paragraph
yuuji@53	43 * Updation of includeonly:: Free from maintaining includeonly
yuuji@59	44 * What column:: Check what table-column the cursor belong
yuuji@51	45 * Intelligent newline:: Guess requisites of new line
yuuji@79	46 * Usepackage checker:: Selecting correct \usepackage is YaTeX's job
yuuji@51	47 * Online help:: On-line documentation of LaTeX
yuuji@53	48 * Browsing file hierarchy:: Walking through file hierarchy
yuuji@51	49 * Cooperation with other packages:: Work well with gmhist, min-out
yuuji@51	50 * Customizations:: How to breed `Wild Bird'
yuuji@51	51 * Etcetera:: YaTeX is acquisitive.
yuuji@51	52 * Copying:: Redistribution
yuuji@20	53
yuuji@265	54 @end menu
yuuji@20	55
yuuji@20	56 @node What is YaTeX?, Main features, Top, Top
yuuji@20	57 @comment node-name, next, previous, up
yuuji@20	58 @chapter What is YaTeX?
yuuji@20	59
yuuji@20	60 YaTeX automates typesetting and previewing of LaTeX and enables
yuuji@20	61 completing input of LaTeX mark-up command such as
yuuji@20	62 @code{\begin@{@}}..@code{\end@{@}}.
yuuji@20	63
yuuji@20	64 YaTeX also supports Demacs which runs on MS-DOS(386), Mule (Multi
yuuji@20	65 Language Enhancement to GNU Emacs), and latex on DOS.
yuuji@20	66
yuuji@20	67 @node Main features, Installation, What is YaTeX?, Top
yuuji@20	68 @comment node-name, next, previous, up
yuuji@20	69 @chapter Main features
yuuji@20	70
yuuji@20	71 @itemize
yuuji@46	72 @item Invocation of typesetter, previewer and related programs(@kbd{C-c t})
yuuji@20	73 @item Typesetting on static region which is independent from point
yuuji@60	74 @item Semiautomatic replacing of @code{\includeonly}
yuuji@20	75 @item Jumping to error line(@kbd{C-c '})
yuuji@20	76 @item Completing-read of La@TeX{} commands such as @code{\begin@{@}},
yuuji@20	77 @code{\section} etc.
yuuji@20	78 (@kbd{C-c b}, @kbd{C-c s}, @kbd{C-c l}, @kbd{C-c m})
yuuji@20	79 @item Enclosing text into La@TeX{} environments or commands
yuuji@392	80 (@var{AboveKeyStrokes} after region setting)
yuuji@59	81 @item Displaying the structure of text at entering sectioning commands
yuuji@59	82 @item Lump shifting of sectioning commands (@ref{view-sectioning})
yuuji@20	83 @item Learning unknown/new La@TeX{} commands for the next completion
yuuji@20	84 @item Argument reading with a guide for complicated La@TeX{} commands
yuuji@20	85 @item Generating argument-readers for new/unsupported commands(@file{yatexgen})
yuuji@20	86 @item Quick changing or deleting of La@TeX{} commands(@kbd{C-c c}, @kbd{C-c k})
yuuji@20	87 @item Jumping from and to inter-file, begin<->end, ref<->label(@kbd{C-c g})
yuuji@20	88 @item Blanket commenting out or uncommenting
yuuji@20	89 (@kbd{C-c >}, @kbd{C-c <}, @kbd{C-c ,}, @kbd{C-c .})
yuuji@20	90 @item Easy input of accent mark, math-mode's commands and Greek letters
yuuji@52	91 (@kbd{C-c a}, @kbd{;}, @kbd{:})
yuuji@20	92 @item Online help for the popular La@TeX{} commands
yuuji@58	93 (@kbd{C-c ?}, @kbd{C-c /})
yuuji@53	94 @item Document files hierarchy browser (@kbd{C-c d})
yuuji@80	95 @item Adding automatically \usepackage corresponding to inputting LaTeX
yuuji@80	96 macro with completion
yuuji@265	97 @item Allow you to forget creating \label@{@}s, \ref@{@} or \cite@{@}
yuuji@265	98 completion automatically generate labels.
yuuji@471	99 @item \includegraphics by Drag&Drop of image file
yuuji@20	100 @end itemize
yuuji@20	101
yuuji@20	102 @node Installation, Typesetting, Main features, Top
yuuji@20	103 @comment node-name, next, previous, up
yuuji@20	104 @chapter Installation
yuuji@20	105 @cindex installation
yuuji@20	106 @cindex .emacs
yuuji@20	107 @cindex auto-mode-alist
yuuji@20	108 @cindex autoload
yuuji@20	109
yuuji@20	110 Put next two expressions into your @file{~/.emacs}.
yuuji@20	111
yuuji@20	112 @lisp
yuuji@20	113 (setq auto-mode-alist
yuuji@46	114 (cons (cons "\\.tex$" 'yatex-mode) auto-mode-alist))
yuuji@20	115 (autoload 'yatex-mode "yatex" "Yet Another La@TeX{} mode" t)
yuuji@20	116 @end lisp
yuuji@20	117
yuuji@20	118 Next, add certain path name where you put files of YaTeX to your
yuuji@20	119 load-path. If you want to put them in @file{~/src/emacs}, write
yuuji@20	120
yuuji@20	121 @lisp
yuuji@20	122 (setq load-path
yuuji@20	123 (cons (expand-file-name "~/src/emacs") load-path))
yuuji@20	124 @end lisp
yuuji@20	125
yuuji@20	126 @noindent
yuuji@20	127 in your @file{~/.emacs}
yuuji@20	128
yuuji@20	129 Then, yatex-mode will be automatically loaded when you visit a
yuuji@20	130 file which has extension @file{.tex}. If yatex-mode is successfully
yuuji@20	131 loaded, mode string on mode line will be turned to "YaTeX".
yuuji@20	132
yuuji@20	133
yuuji@68	134 @node Typesetting, %#notation, Installation, Top
yuuji@20	135 @comment node-name, next, previous, up
yuuji@20	136 @chapter Typesetting
yuuji@20	137 @cindex typesetting
yuuji@20	138 @cindex previewer
yuuji@20	139 @cindex typesetter
yuuji@20	140 @cindex latex
yuuji@20	141 @cindex printing out
yuuji@20	142
yuuji@20	143 The prefix key stroke of yatex-mode is @kbd{C-c} (Press 'C' with Control
yuuji@20	144 key) by default. If you don't intend to change the prefix key stroke,
yuuji@20	145 assume all @kbd{[prefix]} as @kbd{C-c} in this document. These key
yuuji@20	146 strokes execute typeset or preview command.
yuuji@20	147
yuuji@20	148 @table @kbd
yuuji@58	149 @item [prefix] t j
yuuji@392	150 @dots{} invoke typesetter
yuuji@58	151 @item [prefix] t r
yuuji@392	152 @dots{} invoke typesetter on region
yuuji@130	153 @item [prefix] t e
yuuji@392	154 @dots{} `on-the-fly preview' on current environment or whole
yuuji@392	155 portion of current formulas in math-mode
yuuji@242	156 @item [prefix] t d
yuuji@242	157 @dots{} invoke dvipdfmx after successful typesetting
yuuji@58	158 @item [prefix] t k
yuuji@46	159 @dots{} kill current typesetting process
yuuji@58	160 @item [prefix] t b
yuuji@46	161 @dots{} invoke bibtex
yuuji@126	162 @item [prefix] t i
yuuji@126	163 @dots{} invoke makeindex
yuuji@126	164 @item [prefix] t d
yuuji@126	165 @dots{} invoke latex && dvipdfmx
yuuji@58	166 @item [prefix] t p
yuuji@46	167 @dots{} preview
yuuji@58	168 @item [prefix] t l
yuuji@46	169 @dots{} lpr dvi-file
yuuji@58	170 @item [prefix] t s
yuuji@58	171 @dots{} search current string on xdvi-remote
yuuji@20	172 @end table
yuuji@20	173
yuuji@58	174 @menu
yuuji@471	175 * Calling typesetter::
yuuji@471	176 * Calling previewer::
yuuji@471	177 * Printing out::
yuuji@58	178 @end menu
yuuji@58	179
yuuji@58	180 @node Calling typesetter, Calling previewer, Typesetting, Typesetting
yuuji@58	181 @comment node-name, next, previous, up
yuuji@68	182 @section Calling typesetter
yuuji@58	183
yuuji@58	184 Typing @kbd{[prefix] t j}, the current editing window will be divided
yuuji@58	185 horizontally when you invoke latex command, and log message of La@TeX{}
yuuji@58	186 typesetting will be displayed in the other window; called typesetting
yuuji@58	187 buffer. The typesetting buffer automatically scrolls up and traces
yuuji@58	188 La@TeX{} warnings and error messages. If you see latex stopping by an
yuuji@20	189 error, you can send string to latex in the typesetting buffer.
yuuji@20	190
yuuji@20	191 If an error stops the La@TeX{} typesetting, this key stroke will
yuuji@20	192 move the cursor to the line where La@TeX{} error is detected.
yuuji@20	193
yuuji@20	194 @table @kbd
yuuji@20	195 @item [prefix] '
yuuji@20	196 @itemx ([prefix]+single quotation)
yuuji@20	197
yuuji@46	198 @dots{} jump to the previous error or warning
yuuji@20	199 @end table
yuuji@20	200
yuuji@20	201 If you find a noticeable error, move to the typesetting buffer and move
yuuji@20	202 the cursor on the line of error message and type @kbd{SPACE} key. This
yuuji@20	203 makes the cursor move to corresponding source line.
yuuji@20	204
yuuji@131	205 YaTeX-typeset-region invoked by @kbd{[prefix] tr} call typesetter
yuuji@131	206 for region. The region is specified by standard point and mark, or
yuuji@131	207 by @code{%#BEGIN} and @code{%#END} marks. Selected region will be
yuuji@131	208 copied to the temporary file @file{texput.tex} with the same preamble
yuuji@131	209 as the main file of current editing sources. Be sure to put
yuuji@265	210 all local macro settings in preamble, not after @code{\begin@{document@}}.
yuuji@131	211 The method of specification of the region is shown in the
yuuji@68	212 section @xref{%#notation}.
yuuji@20	213
yuuji@73	214 The documentclass for typeset-region is the same as that of editing
yuuji@20	215 file if you edit one file, and is the same as main file's if you
yuuji@20	216 edit splitting files.
yuuji@20	217
yuuji@130	218 The @kbd{[prefix] te} key automatically marks current inner environment
yuuji@392	219 or inner math mode or paragraph, and then call typeset-region with marked
yuuji@392	220 region. This
yuuji@130	221 is convenient to quick view of current tabular environment or current
yuuji@392	222 editing formulas. If running Emacs has the ability of displaying images,
yuuji@392	223 typeset image will be shown in the next window. Further more,
yuuji@392	224 if you modify the content within that environment, YaTeX performs
yuuji@392	225 `on-the-fly' preview that automatically update preview image as you typed.
yuuji@392	226
yuuji@392	227 If your Emacs does not supply on-the-fly preview,
yuuji@392	228 keeping previewer window for @file{texput.dvi} is handy
yuuji@131	229 for debugging. Since @kbd{[prefix] te} selects the inner-most environment
yuuji@131	230 as region, it is not suitable for partial typesetting of doubly or more
yuuji@131	231 composed environment. If you want to do partial typesetting for a nested
yuuji@131	232 environment, use @kbd{[prefix] tr} for static-region, which is described
yuuji@131	233 in the section @xref{%#notation}.
yuuji@130	234
yuuji@58	235 @node Calling previewer, Printing out, Calling typesetter, Typesetting
yuuji@58	236 @comment node-name, next, previous, up
yuuji@68	237 @section Calling previewer
yuuji@58	238
yuuji@58	239 @kbd{[prefix] t p} invokes the TeX previewer. And if you are using
yuuji@58	240 xdvi-remote, which can be controled from other terminals, @kbd{[prefix] t
yuuji@58	241 s} enables you to search current string at the cursor on the running xdvi
yuuji@72	242 window.
yuuji@58	243
yuuji@58	244 @node Printing out, , Calling previewer, Typesetting
yuuji@58	245 @comment node-name, next, previous, up
yuuji@68	246 @section Printing out
yuuji@58	247
yuuji@58	248 When you type @code{[preifx] t l}, YaTeX asks you the range of
yuuji@58	249 dvi-printing by default. You can skip this by invoking it with
yuuji@58	250 universal-argument as follows:
yuuji@20	251
yuuji@20	252 @example
yuuji@49	253 C-u [prefix] tl
yuuji@20	254 @end example
yuuji@20	255
yuuji@68	256 @node %#notation, Completion, Typesetting, Top
yuuji@20	257 @comment node-name, next, previous, up
yuuji@20	258 @chapter %# notation
yuuji@20	259 @cindex %# notation
yuuji@20	260
yuuji@20	261 You can control the typesetting process by describing @code{%#}
yuuji@20	262 notations in the source text.
yuuji@20	263
yuuji@20	264 @menu
yuuji@471	265 * Changing typesetter::
yuuji@471	266 * Splitting input files::
yuuji@471	267 * Static region for typesetting::
yuuji@471	268 * Lpr format::
yuuji@471	269 * Controlling which command to invoke::
yuuji@471	270 * Editing %# notation::
yuuji@20	271 @end menu
yuuji@20	272
yuuji@70	273 @node Changing typesetter, Splitting input files, %#notation, %#notation
yuuji@20	274 @comment node-name, next, previous, up
yuuji@20	275 @section To change the `latex' command or to split a source text.
yuuji@20	276 @cindex typesetter
yuuji@20	277
yuuji@20	278 To change the typesetting command, write
yuuji@20	279
yuuji@20	280 @example
yuuji@46	281 %#!latex-big
yuuji@20	282 @end example
yuuji@20	283
yuuji@20	284 @noindent
yuuji@51	285 anywhere in the source text. This is useful for changing
yuuji@51	286 typesetter.
yuuji@51	287
yuuji@68	288 @node Splitting input files, Static region for typesetting, Changing typesetter, %#notation
yuuji@51	289 @comment node-name, next, previous, up
yuuji@70	290 @section Splitting input files
yuuji@51	291
yuuji@51	292 And if you split the source text and
yuuji@20	293 edit subfile that should be included from main text.
yuuji@20	294
yuuji@20	295 @example
yuuji@46	296 %#!latex main.tex
yuuji@20	297 @end example
yuuji@20	298
yuuji@20	299 @noindent
yuuji@20	300 will be helpful to execute latex on main file from sub text buffer. Since
yuuji@20	301 this command line after @kbd{%#!} will be sent to shell literally, next
yuuji@20	302 description makes it convenient to use ghostview as dvi-previewer.
yuuji@20	303
yuuji@20	304 @example
yuuji@242	305 %#!latex main && dvi2ps main.dvi > main
yuuji@20	306 @end example
yuuji@20	307
yuuji@20	308 @noindent
yuuji@20	309 Note that YaTeX assumes the component before the last period of
yuuji@20	310 the last word in this line as base name of the main La@TeX{} source.
yuuji@80	311 The @code{%f} notation in this line is replaced by main file name, and
yuuji@80	312 @code{%r} replaced by root name of main file name. If you specify
yuuji@80	313 @code{%f} or @code{%r}, YaTeX always ask you the name of main file at the
yuuji@80	314 first typesetting.
yuuji@20	315
yuuji@51	316 To make best use of the feature of inter-file jumping by
yuuji@51	317 @kbd{[prefix] g} (see @ref{Cursor jump}), take described below into
yuuji@51	318 consideration.
yuuji@20	319
yuuji@20	320 @itemize
yuuji@20	321 @item You can put split texts in sub directory, but not in
yuuji@20	322 sub directory of sub directory.
yuuji@51	323 @item In the main text, specify the child file name with relative path name
yuuji@70	324 such as \include@{chap1/sub@}, when you include the file in
yuuji@20	325 a sub-directory.
yuuji@20	326 @item In a sub-text, write @code{%#!latex main.tex} even if @file{main.tex}
yuuji@20	327 is in the parent directory(not %#!latex ../main.tex).
yuuji@20	328 @end itemize
yuuji@20	329
yuuji@70	330 @node Static region for typesetting, Lpr format, Splitting input files, %#notation
yuuji@20	331 @comment node-name, next, previous, up
yuuji@20	332 @section Static region
yuuji@20	333 @cindex static region
yuuji@20	334 @cindex Fixed region
yuuji@20	335
yuuji@20	336 Typeset-region by @kbd{[prefix] tr} passes the region between point and
yuuji@20	337 mark to typesetting command by default. But when you want to typeset
yuuji@20	338 static region, enclose the region by @code{%#BEGIN} and @code{%#END} as
yuuji@20	339 follows.
yuuji@20	340
yuuji@20	341 @example
yuuji@46	342 %#BEGIN
yuuji@46	343 TheRegionYouWantToTypesetManyTimes
yuuji@46	344 %#END
yuuji@20	345 @end example
yuuji@20	346
yuuji@20	347 This is the rule of deciding the region.
yuuji@20	348
yuuji@20	349 @enumerate
yuuji@20	350 @item
yuuji@20	351 If there exists %#BEGIN before point,
yuuji@20	352
yuuji@20	353 @enumerate
yuuji@20	354 @item
yuuji@20	355 If there exists %#END after %#BEGIN,
yuuji@20	356 @itemize
yuuji@20	357 @item From %#BEGIN to %#END.
yuuji@20	358 @end itemize
yuuji@20	359
yuuji@20	360 @item
yuuji@20	361 If %#END does not exist after %#BEGIN,
yuuji@20	362 @itemize
yuuji@20	363 @item From %#BEGIN to the end of buffer.
yuuji@20	364 @end itemize
yuuji@20	365 @end enumerate
yuuji@20	366
yuuji@20	367 @item
yuuji@20	368 If there does not exist %#BEGIN before point,
yuuji@20	369 @itemize
yuuji@20	370 @item Between point and mark(standard method of Emacs).
yuuji@20	371 @end itemize
yuuji@20	372 @end enumerate
yuuji@20	373
yuuji@20	374 It is useful to write @code{%#BEGIN} in the previous line of \begin and
yuuji@20	375 @code{%#END} in the next line of \@code{end} when you try complex
yuuji@20	376 environment such as `tabular' many times. It is also useful to put only
yuuji@20	377 @code{%#BEGIN} alone at the middle of very long text. Do not forget to
yuuji@20	378 erase @code{%#BEGIN} @code{%#END} pair.
yuuji@20	379
yuuji@471	380 @node Lpr format, Controlling which command to invoke, Static region for typesetting, %#notation
yuuji@20	381 @comment node-name, next, previous, up
yuuji@20	382 @section Lpr format
yuuji@20	383 @cindex lpr format
yuuji@20	384
yuuji@20	385 Lpr format is specified by three Lisp variables. Here are the
yuuji@20	386 default values of them.
yuuji@20	387
yuuji@20	388 @table @code
yuuji@20	389 @item (1)dviprint-command-format
yuuji@46	390 @code{"dvi2ps %f %t %s \| lpr"}
yuuji@20	391 @item (2)dviprint-from-format
yuuji@46	392 @code{"-f %b"}
yuuji@20	393 @item (3)dviprint-to-format
yuuji@46	394 @code{"-t %e"}
yuuji@20	395 @end table
yuuji@20	396
yuuji@20	397 On YaTeX-lpr, @code{%s} in (1) is replaced by the file name of main
yuuji@20	398 text, @code{%f} by contents of (2), %t by contents of (3). At these
yuuji@20	399 replacements, @code{%b} in (2) is also replaced by the number of beginning
yuuji@20	400 page, @code{%e} in (3) is replaced by the number of ending page. But
yuuji@20	401 @code{%f} and @code{%t} are ignored when you omit the range of print-out
yuuji@20	402 by @kbd{C-u [prefix] tl}.
yuuji@20	403
yuuji@20	404 If you want to change this lpr format temporarily, put a command
yuuji@20	405 such as follows somewhere in the text:
yuuji@20	406
yuuji@20	407 @example
yuuji@46	408 %#LPR dvi2ps %f %t %s \| 4up -page 4 \| texfix \| lpr -Plp2
yuuji@20	409 @end example
yuuji@20	410
yuuji@20	411 And if you want YaTeX not to ask you the range of printing
yuuji@20	412 out, the next example may be helpful.
yuuji@20	413
yuuji@20	414 @example
yuuji@46	415 %#LPR dvi2ps %s \| lpr
yuuji@20	416 @end example
yuuji@20	417
yuuji@269	418 @node Controlling which command to invoke, Editing %# notation, Lpr format, %#notation
yuuji@242	419 @comment node-name, next, previous, up
yuuji@242	420 @section Controlling which command to invoke
yuuji@242	421
yuuji@242	422 These %# notation below can control which command to invoke for
yuuji@242	423 La@TeX{} related process.
yuuji@242	424
yuuji@242	425 @table @code
yuuji@410	426 @item %#PREVIEW
yuuji@410	427 @dots{} Command line for DVI viewing ([prefix] t p)
yuuji@410	428 @item %#MAKEINDEX
yuuji@410	429 @dots{} Command line for makeindex ([prefix] t i)
yuuji@242	430 @item %#BIBTEX
yuuji@242	431 @dots{} Command line for bibtex ([prefix] t b)
yuuji@329	432 @item %#DVIPDF
yuuji@329	433 @dots{} Command line for dvipdf(mx) ([prefix] t b)
yuuji@410	434 @item %#LPR
yuuji@410	435 @dots{} Command line for printing out([prefix] t l)
yuuji@410	436 @item %#PDFVIEW
yuuji@410	437 @dots{} Command line for PDF viewing
yuuji@410	438 @item %#IMAGEDPI
yuuji@410	439 @dots{} DPI value for converting to on-the-fly prewview image
yuuji@242	440 @end table
yuuji@242	441
yuuji@242	442 If you want to invoke ``makeidx hogehoge'' to update index,
yuuji@242	443 put the next line some upper place in the source, for example.
yuuji@242	444
yuuji@242	445 @example
yuuji@242	446 %#MAKEINDEX makeidx hogehoge
yuuji@242	447 @end example
yuuji@242	448
yuuji@242	449
yuuji@269	450 @node Editing %# notation, , Controlling which command to invoke, %#notation
yuuji@20	451 @comment node-name, next, previous, up
yuuji@20	452 @section Editing %# notation
yuuji@20	453
yuuji@20	454 To edit @code{%#} notation described above, type
yuuji@20	455
yuuji@20	456 @table @kbd
yuuji@20	457 @item [prefix] %
yuuji@46	458 @dots{} editing %# notation menu
yuuji@20	459 @end table
yuuji@20	460
yuuji@20	461 @noindent
yuuji@20	462 and select one of the entry of the menu as follows.
yuuji@20	463
yuuji@20	464 @example
yuuji@46	465 !)Edit-%#! B)EGIN-END-region L)Edit-%#LPR
yuuji@20	466 @end example
yuuji@20	467
yuuji@20	468 @noindent
yuuji@20	469 Type @kbd{!} to edit @code{%#!} entry, @code{b} to enclose the region with
yuuji@20	470 @code{%#BEGIN} and @code{%#END}, and @code{l} to edit @code{%#LPR} entry.
yuuji@20	471 When you type @kbd{b}, all @code{%#BEGIN} and @code{%#END} are
yuuji@20	472 automatically erased.
yuuji@20	473
yuuji@68	474 @node Completion, Local dictionaries, %#notation, Top
yuuji@20	475 @comment node-name, next, previous, up
yuuji@20	476 @chapter Completion
yuuji@20	477 @cindex completion
yuuji@20	478
yuuji@20	479 YaTeX makes it easy to input the La@TeX{} commands. There are several
yuuji@20	480 kinds of completion type, begin-type, section-type, large-type, etc...
yuuji@20	481
yuuji@20	482 @menu
yuuji@392	483 * Begin-type completion::
yuuji@392	484 * Section-type completion::
yuuji@471	485 * Label Generation::
yuuji@392	486 * Large-type completion::
yuuji@392	487 * Maketitle-type completion::
yuuji@392	488 * Arbitrary completion::
yuuji@392	489 * End completion::
yuuji@392	490 * Accent completion::
yuuji@392	491 * Image completion::
yuuji@392	492 * Greek letters completion::
yuuji@392	493 * Inserting parentheses::
yuuji@20	494 @end menu
yuuji@20	495
yuuji@33	496 @node Begin-type completion, Section-type completion, Completion, Completion
yuuji@20	497 @comment node-name, next, previous, up
yuuji@20	498 @section Begin-type completion
yuuji@20	499 @cindex begin-type completion
yuuji@20	500 @cindex environment
yuuji@20	501 @cindex prefix b
yuuji@20	502
yuuji@20	503 "Begin-type completion" completes commands of @code{\begin@{env@}} ...
yuuji@20	504 @code{\end@{env@}}. All of the begin-type completions begin with this key
yuuji@20	505 sequence.
yuuji@20	506
yuuji@20	507 @table @kbd
yuuji@20	508 @item [prefix] b
yuuji@46	509 @dots{} start begin-type completion
yuuji@20	510 @end table
yuuji@20	511
yuuji@20	512 @noindent
yuuji@20	513 An additional key stroke immediately completes a frequently used
yuuji@20	514 La@TeX{} @code{\begin@{@}}...@code{\@code{end}@{@}} environment.
yuuji@20	515
yuuji@20	516 @table @kbd
yuuji@20	517 @item [prefix] b c
yuuji@46	518 @dots{} @code{\begin@{center@}...\end@{center@}}
yuuji@20	519 @item [prefix] b d
yuuji@46	520 @dots{} @code{\begin@{document@}...\end@{document@}}
yuuji@20	521 @item [prefix] b D
yuuji@46	522 @dots{} @code{\begin@{description@}...\end@{description@}}
yuuji@20	523 @item [prefix] b e
yuuji@46	524 @dots{} @code{\begin@{enumerate@}...\end@{enumerate@}}
yuuji@20	525 @item [prefix] b E
yuuji@46	526 @dots{} @code{\begin@{equation@}...\end@{equation@}}
yuuji@20	527 @item [prefix] b i
yuuji@46	528 @dots{} @code{\begin@{itemize@}...\end@{itemize@}}
yuuji@20	529 @item [prefix] b l
yuuji@46	530 @dots{} @code{\begin@{flushleft@}...\end@{flushleft@}}
yuuji@20	531 @item [prefix] b m
yuuji@46	532 @dots{} @code{\begin@{minipage@}...\end@{minipage@}}
yuuji@20	533 @item [prefix] b t
yuuji@46	534 @dots{} @code{\begin@{tabbing@}...\end@{tabbing@}}
yuuji@20	535 @item [prefix] b T
yuuji@46	536 @dots{} @code{\begin@{tabular@}...\end@{tabular@}}
yuuji@20	537 @item [prefix] b^T
yuuji@46	538 @dots{} @code{\begin@{table@}...\end@{table@}}
yuuji@20	539 @item [prefix] b p
yuuji@46	540 @dots{} @code{\begin@{picture@}...\end@{picture@}}
yuuji@20	541 @item [prefix] b q
yuuji@46	542 @dots{} @code{\begin@{quote@}...\end@{quote@}}
yuuji@20	543 @item [prefix] b Q
yuuji@46	544 @dots{} @code{\begin@{quotation@}...\end@{quotation@}}
yuuji@20	545 @item [prefix] b r
yuuji@46	546 @dots{} @code{\begin@{flushright@}...\end@{flushright@}}
yuuji@20	547 @item [prefix] b v
yuuji@46	548 @dots{} @code{\begin@{verbatim@}...\end@{verbatim@}}
yuuji@20	549 @item [prefix] b V
yuuji@46	550 @dots{} @code{\begin@{verse@}...\end@{verse@}}
yuuji@20	551 @end table
yuuji@20	552
yuuji@20	553 Any other La@TeX{} environments are made by completing-read of the
yuuji@20	554 Emacs function.
yuuji@20	555
yuuji@20	556 @table @kbd
yuuji@20	557 @item [prefix] b SPACE
yuuji@46	558 @dots{} begin-type completion
yuuji@20	559 @end table
yuuji@20	560
yuuji@20	561 @noindent
yuuji@20	562 The next message will show up in the minibuffer
yuuji@20	563
yuuji@20	564 @example
yuuji@46	565 Begin environment(default document):
yuuji@20	566 @end example
yuuji@20	567
yuuji@20	568 @noindent
yuuji@20	569 by typing @kbd{[prefix] b}. Put the wishing environment with completion
yuuji@20	570 in the minibuffer, and @code{\begin@{env@}}...\@code{\end@{env@}} will be
yuuji@20	571 inserted in the La@TeX{} source text. If the environment you want to put
yuuji@20	572 does not exist in the YaTeX completion table, it will be registered in the
yuuji@20	573 user completion table. YaTeX automatically saves the user completion
yuuji@20	574 table in the user dictionary file at exiting of emacs.
yuuji@20	575
yuuji@58	576 At the completion of certain environments, the expected initial entry will
yuuji@58	577 automatically inserted such as @code{\item} for @code{itemize}
yuuji@58	578 environment. If you don't want the entry, it can be removed by undoing.
yuuji@58	579
yuuji@392	580 If you want to enclose some paragraphs which have already been written
yuuji@392	581 into environment, invoke the begin-type completion right after region marking.
yuuji@20	582 @cindex enclose region into environment
yuuji@20	583
yuuji@392	584 If you set @code{transient-mark-mode} to @code{nil} in your
yuuji@392	585 @file{~/.emacs}, typing @kbd{C-space} (@code{set-mark-command}) twice
yuuji@392	586 turns @code{transient-mark-mode} on temporarily. Then, type call
yuuji@392	587 begin-type completion to enclose text into a environment.
yuuji@392	588
yuuji@20	589
yuuji@471	590 @node Section-type completion, , Begin-type completion, Completion
yuuji@20	591 @comment node-name, next, previous, up
yuuji@20	592 @section Section-type completion
yuuji@20	593 @cindex section-type completion
yuuji@20	594 @cindex prefix s
yuuji@20	595
yuuji@20	596 "Section-type completion" completes section-type commands which take an
yuuji@20	597 argument or more such as @code{\section@{foo@}}. To invoke section-type
yuuji@20	598 completion, type
yuuji@20	599
yuuji@20	600 @table @kbd
yuuji@20	601 @item [prefix] s
yuuji@46	602 @dots{} section-type completion
yuuji@20	603 @end table
yuuji@20	604
yuuji@20	605 @noindent
yuuji@20	606 then the prompt
yuuji@20	607
yuuji@20	608 @example
yuuji@73	609 (C-v for view) \???@{@} (default documentclass):
yuuji@20	610 @end example
yuuji@20	611
yuuji@20	612 @noindent
yuuji@20	613 will show up in the minibuffer. Section-type La@TeX{} commands are
yuuji@20	614 completed by space key, and the default value is selected when you
yuuji@20	615 type nothing in the minibuffer.
yuuji@20	616
yuuji@20	617 Next,
yuuji@20	618
yuuji@20	619 @example
yuuji@46	620 \section@{???@}:
yuuji@20	621 @end example
yuuji@20	622
yuuji@20	623 @noindent
yuuji@20	624 prompts you the argument of section-type La@TeX{} command. For
yuuji@20	625 example, the following inputs
yuuji@20	626
yuuji@20	627 @example
yuuji@73	628 \???@{@} (default documentclass): section
yuuji@70	629 \section@{???@}: Hello world.
yuuji@20	630 @end example
yuuji@20	631
yuuji@20	632 @noindent
yuuji@20	633 will insert the string
yuuji@20	634
yuuji@20	635 @example
yuuji@46	636 \section@{Hello world.@}
yuuji@20	637 @end example
yuuji@20	638
yuuji@20	639 in your La@TeX{} source. When you neglect argument such as
yuuji@20	640
yuuji@20	641 @example
yuuji@46	642 (C-v for view) \???@{@} (default section): vspace*
yuuji@46	643 \vspace*@{???@}:
yuuji@20	644 @end example
yuuji@20	645
yuuji@20	646 YaTeX puts
yuuji@20	647
yuuji@20	648 @example
yuuji@46	649 \vspace*@{@}
yuuji@20	650 @end example
yuuji@20	651
yuuji@20	652 @noindent
yuuji@20	653 and move the cursor in the braces.
yuuji@20	654
yuuji@20	655 In La@TeX{} command, there are commands which take more than one
yuuji@70	656 arguments such as @code{\addtolength@{\topmargin@}@{8mm@}}. To complete these
yuuji@20	657 commands, invoke section-type completion with universal argument as,
yuuji@20	658 @cindex number of argument
yuuji@20	659
yuuji@20	660 @example
yuuji@49	661 C-u 2 [prefix] s (or ESC 2 [prefix] s)
yuuji@20	662 @end example
yuuji@20	663
yuuji@20	664 @noindent
yuuji@20	665 and make answers in minibuffer like this.
yuuji@20	666
yuuji@20	667 @example
yuuji@46	668 (C-v for view) \???@{@} (default vspace*): addtolength
yuuji@46	669 \addtolength@{???@}: \topmargin
yuuji@46	670 Argument 2: 8mm
yuuji@20	671 @end example
yuuji@20	672
yuuji@20	673 @code{\addtolength} and the first argument @code{\topmargin} can be typed
yuuji@20	674 easily by completing read. Since YaTeX also learns the number of
yuuji@20	675 arguments of section-type command and will ask that many arguments in
yuuji@20	676 future completion, you had better tell the number of arguments to YaTeX at
yuuji@20	677 the first completion of the new word. But you can change the number of
yuuji@20	678 arguments by calling the completion with different universal argument
yuuji@20	679 again.
yuuji@20	680
yuuji@20	681
yuuji@20	682 Invoking section-type completion with @code{[Prefix] S} (Capital `S')
yuuji@20	683 includes the region as the first argument of section-type command.
yuuji@20	684
yuuji@20	685 The section/large/maketitle type completion can work at the
yuuji@20	686 prompt for the argument of other section-type completion.
yuuji@20	687 Nested La@TeX{} commands are efficiently read with the recursive
yuuji@20	688 completion by typing YaTeX's completion key sequence in the
yuuji@20	689 minibuffer.
yuuji@20	690
yuuji@20	691 @menu
yuuji@471	692 * view-sectioning::
yuuji@20	693 @end menu
yuuji@20	694
yuuji@33	695 @node view-sectioning, , Section-type completion, Section-type completion
yuuji@20	696 @comment node-name, next, previous, up
yuuji@20	697 @subsection view-sectioning
yuuji@20	698 @cindex view sectioning
yuuji@20	699 @cindex outline
yuuji@20	700
yuuji@20	701 In the minibuffer at the prompt of section-type command completion,
yuuji@20	702 typing @kbd{C-v} shows a list of sectioning commands in source text(The
yuuji@20	703 line with @code{<<--} mark is the nearest sectioning command). Then,
yuuji@20	704 default sectioning command appears in the minibuffer. You can go up/down
yuuji@20	705 sectioning command by typing @kbd{C-p}/@kbd{C-n}, can scrolls up/down the
yuuji@20	706 listing buffer by @kbd{C-v}/@kbd{M-v}, and can hide sectioning commands
yuuji@20	707 under certain level by 0 through 6. Type @kbd{?} in the minibuffer of
yuuji@20	708 sectioning prompt for more information.
yuuji@20	709
yuuji@58	710 You can generate this listing buffer (@code{Sectioning Lines} buffer)
yuuji@58	711 by typing
yuuji@58	712 @table @kbd
yuuji@58	713 @item M-x YaTeX-section-overview
yuuji@58	714 @dots{} Generate Sectioning Lines buffer
yuuji@58	715 @end table
yuuji@58	716 @cindex{Generate the listing of sectioning units}
yuuji@58	717 from the LaTeX source buffer. In this listing buffer, typing @kbd{u} on
yuuji@58	718 the sectioning command shifts up the corresponding sectioning command in
yuuji@58	719 source text and @kbd{d} shifts down. After marking lines in the listing
yuuji@58	720 buffer, typing @kbd{U} shifts up all sectioning commands in the region,
yuuji@58	721 and @kbd{U} shifts down. Here are all the key bindings of
yuuji@58	722 @code{Sectioning Lines} buffer.
yuuji@58	723
yuuji@58	724 @table @kbd
yuuji@58	725 @item SPC
yuuji@58	726 @dots{} Jump to corresponding source line
yuuji@58	727 @item .
yuuji@58	728 @dots{} Display corresponding source line
yuuji@58	729 @item u
yuuji@58	730 @dots{} Shift up a sectioning line
yuuji@58	731 @item d
yuuji@58	732 @dots{} Shift down a sectioning line
yuuji@58	733 @item U
yuuji@58	734 @dots{} Shift up sectioning lines in region
yuuji@58	735 @item D
yuuji@58	736 @dots{} Shift down sectioning lines in region
yuuji@68	737 @item 0@dots{}6
yuuji@58	738 @dots{} Hide sectioning commands whose level is lower than n
yuuji@58	739 @end table
yuuji@58	740
yuuji@471	741 @node Label Generation, Large-type completion, Section-type completion, Completion
yuuji@471	742 @section Label Generation
yuuji@471	743 @comment label generation
yuuji@471	744 @cindex label generation
yuuji@471	745 @cindex ref label cite
yuuji@471	746
yuuji@471	747 When you want to type-in references of @code{\ref} or @code{\cite},
yuuji@471	748 all you have to do is type @kbd{[prefix] s ref} without adding labels
yuuji@471	749 beforehand. You will see possible La@TeX{}-counters in the next window
yuuji@471	750 even if some counter does not have @code{\label}. Selecting the counter
yuuji@471	751 will automatically set the label to that counter.
yuuji@471	752
yuuji@471	753 All possible counter list in the buffer tends to be large.
yuuji@471	754 You can reduce the number of list by filtering type of counters by
yuuji@471	755 key-commands as follows.
yuuji@471	756 @table @kbd
yuuji@471	757 @item M-a
yuuji@471	758 @dots{} Show all(disable filtering)
yuuji@471	759 @item M-c
yuuji@471	760 @dots{} Captions only
yuuji@471	761 @item M-e
yuuji@471	762 @dots{} equations (with counters) only
yuuji@471	763 @item M-i
yuuji@471	764 @dots{} numbers items only
yuuji@471	765 @item M-s
yuuji@471	766 @dots{} sections only
yuuji@471	767 @item M-m
yuuji@471	768 @dots{} other counters only
yuuji@471	769 @end table
yuuji@471	770
yuuji@471	771
yuuji@471	772 @node Large-type completion, Maketitle-type completion, Label Generation, Completion
yuuji@20	773 @comment node-name, next, previous, up
yuuji@20	774 @section Large-type completion
yuuji@20	775
yuuji@20	776 "Large-type completion" inputs the font or size changing
yuuji@20	777 descriptions such as @code{@{\large @}}. When you type
yuuji@20	778
yuuji@20	779 @table @kbd
yuuji@20	780 @item [prefix] l
yuuji@46	781 @dots{} large-type completion
yuuji@20	782 @end table
yuuji@20	783
yuuji@20	784 @noindent
yuuji@20	785 the message in the minibuffer
yuuji@20	786
yuuji@20	787 @example
yuuji@46	788 @{\??? @} (default large):
yuuji@20	789 @end example
yuuji@20	790
yuuji@20	791 prompts prompts you large-type command with completing-read. There are
yuuji@20	792 TeX commands to change fonts or sizes, @code{it}, @code{huge} and so on,
yuuji@20	793 in the completion table.
yuuji@20	794
yuuji@392	795 Region-based completion is also invoked by calling completion
yuuji@392	796 after region activated.
yuuji@20	797
yuuji@20	798 @node Maketitle-type completion, Arbitrary completion, Large-type completion, Completion
yuuji@20	799 @comment node-name, next, previous, up
yuuji@20	800 @section Maketitle-type completion
yuuji@20	801 @cindex maketitle-type completion
yuuji@20	802
yuuji@20	803 We call it "maketitle-type completion" which completes commands such as
yuuji@20	804 @code{\maketitle}. Take notice that maketitle-type commands take no
yuuji@20	805 arguments. Then, typing
yuuji@20	806
yuuji@20	807 @table @kbd
yuuji@20	808 @item [prefix] m
yuuji@46	809 @dots{} maketitle-type completion
yuuji@20	810 @end table
yuuji@20	811
yuuji@20	812 @noindent
yuuji@20	813 begins maketitle-completion. Above mentioned method is true for
yuuji@20	814 maketitle-completion, and there are La@TeX{} commands with no
yuuji@20	815 arguments in completion table.
yuuji@20	816
yuuji@20	817 @node Arbitrary completion, End completion, Maketitle-type completion, Completion
yuuji@20	818 @comment node-name, next, previous, up
yuuji@20	819 @section Arbitrary completion
yuuji@20	820 @cindex arbitrary completion
yuuji@20	821
yuuji@20	822 @noindent
yuuji@20	823 You can complete certain La@TeX{} command anywhere without typical
yuuji@20	824 completing method as described, by typing
yuuji@20	825
yuuji@20	826 @table @kbd
yuuji@20	827 @item [prefix] SPC
yuuji@46	828 @dots{} arbitrary completion
yuuji@20	829 @end table
yuuji@20	830
yuuji@20	831 @noindent
yuuji@20	832 after the initial string of La@TeX{} command that is preceded by @code{\}.
yuuji@20	833
yuuji@20	834 @node End completion, Accent completion, Arbitrary completion, Completion
yuuji@20	835 @comment node-name, next, previous, up
yuuji@20	836 @section End completion
yuuji@20	837 @cindex end completion
yuuji@20	838
yuuji@20	839 @noindent
yuuji@20	840 YaTeX automatically detects the opened environment and close it with
yuuji@20	841 \@code{\end@{environment@}}. Though proficient YaTeX users never fail to
yuuji@20	842 make environment with begin-type completion, some may begin an environment
yuuji@20	843 manually. In that case, type
yuuji@20	844
yuuji@20	845 @table @kbd
yuuji@20	846 @item [prefix] e
yuuji@46	847 @dots{} @code{end} completion
yuuji@20	848 @end table
yuuji@20	849
yuuji@20	850 @noindent
yuuji@20	851 at the end of the opened environment.
yuuji@20	852
yuuji@20	853 @node Accent completion, Image completion, End completion, Completion
yuuji@20	854 @comment node-name, next, previous, up
yuuji@20	855 @section Accent completion
yuuji@20	856 @cindex accent completion
yuuji@20	857
yuuji@20	858 When you want to write the European accent marks(like @code{\`@{o@}}),
yuuji@20	859
yuuji@20	860 @table @kbd
yuuji@20	861 @item [prefix] a
yuuji@46	862 @dots{} accent completion
yuuji@20	863 @end table
yuuji@20	864
yuuji@20	865 @noindent
yuuji@20	866 shows the menu
yuuji@20	867
yuuji@20	868 @example
yuuji@46	869 1:` 2:' 3:^ 4:" 5:~ 6:= 7:. u v H t c d b
yuuji@20	870 @end example
yuuji@20	871
yuuji@20	872 @noindent
yuuji@20	873 in the minibuffer. Chose one character or corresponding numeric,
yuuji@20	874 and you will see
yuuji@20	875
yuuji@20	876 @example
yuuji@70	877 \`@{@}
yuuji@20	878 @end example
yuuji@20	879
yuuji@20	880 @noindent
yuuji@20	881 in the editing buffer with the cursor positioned in braces. Type
yuuji@20	882 one more character `o' for example, then
yuuji@20	883
yuuji@20	884 @example
yuuji@70	885 \`@{o@}
yuuji@20	886 @end example
yuuji@20	887
yuuji@20	888 @noindent
yuuji@20	889 will be completed, and the cursor gets out from braces.
yuuji@20	890
yuuji@20	891 @node Image completion, Greek letters completion, Accent completion, Completion
yuuji@20	892 @comment node-name, next, previous, up
yuuji@20	893 @section Image completion of mathematical sign
yuuji@20	894 @cindex image completion
yuuji@20	895 @cindex math-mode
yuuji@20	896 @cindex sigma
yuuji@20	897 @cindex leftarrow
yuuji@20	898 @cindex ;
yuuji@20	899
yuuji@20	900 Arrow marks, sigma mark and those signs mainly used in the
yuuji@20	901 TeX's math environment are completed by key sequences which
yuuji@20	902 imitate the corresponding symbols graphically. This completion
yuuji@20	903 only works in the math environment. YaTeX automatically detects
yuuji@20	904 whether the cursor located in math environment or not, and
yuuji@52	905 change the behavior of key strokes @kbd{;} and @kbd{:}.
yuuji@20	906
yuuji@20	907 By the way, we often express the leftarrow mark by `<-' for example.
yuuji@20	908 Considering such image, you can write @code{\leftarrow} by typing @kbd{<-}
yuuji@20	909 after @kbd{;} (semicolon) as a prefix. In the same way,
yuuji@20	910 @code{\longleftarrow} (@code{<--}) is completed by typing @kbd{;<--},
yuuji@20	911 infinity mark which is imitated by @code{oo} is completed by typing
yuuji@20	912 @kbd{;oo}.
yuuji@20	913
yuuji@20	914 Here are the sample operations in YaTeX math-mode.
yuuji@20	915
yuuji@20	916 @example
yuuji@20	917 INPUT Completed La@TeX{} commands
yuuji@20	918 ; < - @code{\leftarrow}
yuuji@20	919 ; < - - @code{\longleftarrow}
yuuji@20	920 ; < - - > @code{\longleftrightarrow}
yuuji@20	921 ; o @code{\circ}
yuuji@20	922 ; o o @code{\infty}
yuuji@20	923 @end example
yuuji@20	924
yuuji@20	925 In any case, you can quit from image completion and can move
yuuji@20	926 to the next editing operation if the La@TeX{} command you want is
yuuji@20	927 shown in the buffer.
yuuji@20	928
yuuji@20	929 @code{;} itself in math-environment is inserted by @kbd{;;}. Typing
yuuji@20	930 @kbd{TAB} in the midst of image completion shows all of the La@TeX{}
yuuji@20	931 commands that start with the same name as string you previously typed in.
yuuji@20	932 In this menu buffer, press @kbd{RET} after moving the cursor (by @kbd{n},
yuuji@20	933 @kbd{p}, @kbd{b}, @kbd{f}) to insert the La@TeX{} command.
yuuji@20	934
yuuji@20	935 To know all of the completion table, type @kbd{TAB} just after @kbd{;}.
yuuji@20	936 And here is the sample menu by @kbd{TAB} after @kbd{;<}.
yuuji@20	937
yuuji@20	938 @example
yuuji@20	939 KEY LaTeX sequence sign
yuuji@20	940 < \leq <
yuuji@20	941 ~
yuuji@20	942 << \ll <<
yuuji@20	943 <- \leftarrow <-
yuuji@20	944 <= \Leftarrow <=
yuuji@20	945 @end example
yuuji@20	946
yuuji@20	947 You can define your favorite key-vs-sequence completion table in the
yuuji@20	948 Emacs-Lisp variable @code{YaTeX-math-sign-alist-private}. See also
yuuji@20	949 @file{yatexmth.el} for the information of the structure of this variable.
yuuji@20	950
yuuji@392	951 @node Greek letters completion, Inserting parentheses, Image completion, Completion
yuuji@20	952 @comment node-name, next, previous, up
yuuji@20	953 @section Greek letters completion
yuuji@20	954 @cindex Greek letters completion
yuuji@52	955 @cindex :
yuuji@20	956
yuuji@20	957 Math-mode of YaTeX provides another image completion, Greek letters
yuuji@52	958 completion in the same method. After prefix @kbd{:}, typing @kbd{a} makes
yuuji@20	959 @code{\alpha}, @kbd{b} makes @code{\beta} and @kbd{g} makes @code{\gamma}
yuuji@58	960 and so on. First, type @kbd{:TAB} to know all the correspondence of
yuuji@58	961 alphabets vs. Greek letters.
yuuji@20	962
yuuji@52	963 If you will find @kbd{;} or @kbd{:} doesn't work in correct position of
yuuji@20	964 math environment, it may be a bug of YaTeX. Please send me a bug report
yuuji@20	965 with the configuration of your text, and avoid it temporarily by typing
yuuji@52	966 @kbd{;} or @kbd{:} after universal-argument(@kbd{C-u}) which forces
yuuji@52	967 @kbd{;} and @kbd{:} to work as math-prefix.
yuuji@20	968
yuuji@392	969 @node Inserting parentheses, , Greek letters completion, Completion
yuuji@392	970 @section Inserting parentheses
yuuji@392	971
yuuji@392	972 Typing opening parenthesis, one of @code{(}, @code{@{ and @code{[}},
yuuji@392	973 automatically inserts the closing one. If a opening bracket is typed
yuuji@392	974 after @code{\}, @code{\]} is automatically inserted with computed
yuuji@392	975 indentation. If you stop automatic insertion, type @kbd{C-q} before
yuuji@392	976 opening parenthesis.
yuuji@392	977
yuuji@49	978 @node Local dictionaries, Commenting out, Completion, Top
yuuji@49	979 @comment node-name, next, previous, up
yuuji@49	980 @chapter Local dictionaries
yuuji@49	981 @cindex local dictionaries
yuuji@49	982 @cindex nervous users
yuuji@49	983
yuuji@49	984 Tables for completion consist of three dictionaries; `standard
yuuji@49	985 dictionary' built in @file{yatex.el}, `user dictionary' for your common
yuuji@49	986 private commands, and `local dictionary' that is effective in a certain
yuuji@49	987 directory.
yuuji@49	988
yuuji@49	989 When you input the command unknown to YaTeX at a completion in the
yuuji@49	990 minibuffer, YaTeX asks you with the following prompt;
yuuji@49	991
yuuji@49	992 @example
yuuji@73	993 `foo' is not in table. Register into: U)serDic L)ocalDic N)one D)iscard
yuuji@49	994 @end example
yuuji@49	995
yuuji@265	996 @noindent
yuuji@51	997 In this menu, typing @kbd{u} updates your `user dictionary', @kbd{l}
yuuji@51	998 updates your local dictionary, @kbd{n} updates only on-memory dictionary
yuuji@51	999 which go through only current Emacs session, and @kbd{d} updates no
yuuji@51	1000 dictionary and throws the new word away.
yuuji@49	1001
yuuji@49	1002 If you find this switching feature meaningless and bothersome, put the
yuuji@49	1003 next expression into your @file{~/.emacs}
yuuji@49	1004
yuuji@49	1005 @lisp
yuuji@49	1006 (setq YaTeX-nervous nil)
yuuji@49	1007 @end lisp
yuuji@49	1008
yuuji@49	1009 @node Commenting out, Cursor jump, Local dictionaries, Top
yuuji@20	1010 @comment node-name, next, previous, up
yuuji@20	1011 @chapter Commenting out
yuuji@20	1012 @cindex commenting out
yuuji@20	1013 @cindex prefix >
yuuji@20	1014 @cindex prefix <
yuuji@20	1015 @cindex prefix ,
yuuji@20	1016 @cindex prefix .
yuuji@20	1017
yuuji@20	1018 You may want to comment out some region.
yuuji@20	1019
yuuji@20	1020 @table @kbd
yuuji@20	1021 @item [prefix] >
yuuji@46	1022 @dots{} comment out region by %
yuuji@20	1023 @item [prefix] <
yuuji@46	1024 @dots{} uncomment region
yuuji@20	1025 @end table
yuuji@20	1026
yuuji@20	1027 @noindent
yuuji@20	1028 cause an operation to the region between point and mark.
yuuji@20	1029
yuuji@20	1030 @table @kbd
yuuji@20	1031 @item [prefix] .
yuuji@46	1032 @dots{} comment out current paragraph
yuuji@20	1033 @item [prefix] ,
yuuji@46	1034 @dots{} uncomment current paragraph
yuuji@20	1035 @end table
yuuji@20	1036
yuuji@20	1037 @noindent
yuuji@20	1038 comments or uncomments the paragraph where the cursor belongs.
yuuji@20	1039 This `paragraph' means the region marked by the function
yuuji@20	1040 mark-paragraph, bound to @kbd{ESC h} by default. It is NOT
yuuji@20	1041 predictable what will happen when you continuously comment out
yuuji@20	1042 some paragraph many times.
yuuji@20	1043
yuuji@20	1044 You can also comment out an environment between @code{\begin} and
yuuji@20	1045 @code{\end}, or a @code{\begin}-\@code{\end} pair themselves, by making the
yuuji@20	1046 following key strokes on the line where @code{\begin@{@}} or
yuuji@20	1047 @code{\end@{@}} exists.
yuuji@20	1048
yuuji@20	1049 @table @kbd
yuuji@20	1050 @item [prefix] >
yuuji@46	1051 @dots{} comment out from \begin to \@code{end}
yuuji@20	1052 @item [prefix] <
yuuji@46	1053 @dots{} uncomment from \begin to \@code{end}
yuuji@20	1054 @end table
yuuji@20	1055
yuuji@20	1056 @noindent
yuuji@20	1057 comment whole the contents of environment. Moreover,
yuuji@20	1058
yuuji@20	1059 @table @kbd
yuuji@20	1060 @item [prefix] .
yuuji@46	1061 @dots{} comment out \begin and \@code{end}
yuuji@20	1062 @item [prefix] ,
yuuji@46	1063 @dots{} uncomment \begin and \@code{end}
yuuji@20	1064 @end table
yuuji@20	1065
yuuji@20	1066 @noindent
yuuji@20	1067 (un)comments out only environment declaration: @code{\begin@{@}} and
yuuji@20	1068 @code{\end@{@}}. NOTE that even if you intend to comment out some region,
yuuji@20	1069 invoking @kbd{[prefix] >} on the @code{\begin},@code{\end} line decides to
yuuji@20	1070 work in `commenting out from @code{\begin} to @code{\end}' mode.
yuuji@20	1071
yuuji@20	1072
yuuji@20	1073 @node Cursor jump, Changing and Deleting, Commenting out, Top
yuuji@20	1074 @comment node-name, next, previous, up
yuuji@20	1075 @chapter Cursor jump
yuuji@20	1076 @cindex cursor jump
yuuji@20	1077 @cindex prefix g
yuuji@20	1078
yuuji@68	1079
yuuji@68	1080 @menu
yuuji@471	1081 * Jump to corresponding object::
yuuji@471	1082 * Invoking image processor::
yuuji@471	1083 * Jump to main file::
yuuji@471	1084 * Jumping around the environment::
yuuji@471	1085 * Jumping to last completion position::
yuuji@68	1086 @end menu
yuuji@68	1087
yuuji@68	1088 @node Jump to corresponding object, Invoking image processor, Cursor jump, Cursor jump
yuuji@68	1089 @comment node-name, next, previous, up
yuuji@51	1090 @section Jump to corresponding object
yuuji@51	1091
yuuji@48	1092 Typing
yuuji@20	1093
yuuji@20	1094 @table @kbd
yuuji@20	1095 @item [prefix] g
yuuji@46	1096 @dots{} go to corresponding object
yuuji@20	1097 @end table
yuuji@20	1098
yuuji@20	1099 @noindent
yuuji@48	1100 in a certain place move the cursor to the place corresponding to the
yuuji@48	1101 La@TeX{} command of last place. YaTeX recognize the followings as pairs
yuuji@48	1102 that have relation each other.
yuuji@48	1103
yuuji@49	1104 @itemize @bullet
yuuji@48	1105 @item @code{\begin@{@}} <-> @code{\end@{@}}
yuuji@48	1106 @item @code{%#BEGIN} <-> @code{%#END}
yuuji@59	1107 @item On the image-including line -> corresponding viewer or drawing tool
yuuji@48	1108 @item @code{\label@{@}} <-> @code{\ref@{@}}
yuuji@48	1109 @item @code{\include(\input)} -> included file
yuuji@48	1110 @item @code{\bibitem@{@}} <-> @code{\cite@{@}}
yuuji@49	1111 @end itemize
yuuji@48	1112
yuuji@49	1113 On a @code{\begin},@code{\end} line, typing @kbd{[prefix] g} moves the
yuuji@49	1114 cursor to the corresponding @code{\end},@code{\begin} line, if its partner
yuuji@51	1115 really exists. The behavior on the line @code{%#BEGIN} and @code{%#END}
yuuji@49	1116 are the same. Note that if the correspondent of @code{label/ref} or
yuuji@51	1117 @code{cite/bibitem} exists in another file, that file have to be opened to
yuuji@49	1118 make a round trip between references by @kbd{[prefix] g}.
yuuji@20	1119
yuuji@20	1120 If you type @code{[prefix] g} on the line of @code{\include@{chap1@}},
yuuji@48	1121 typically in the main text, YaTeX switches buffer to @file{chap1.tex}.
yuuji@51	1122
yuuji@51	1123 @table @kbd
yuuji@51	1124 @item [prefix] 4 g
yuuji@51	1125 @dots{} go to corresponding object in other window
yuuji@51	1126 @end table
yuuji@51	1127
yuuji@51	1128 @noindent
yuuji@51	1129 do the same job as @kbd{[prefix] g} except it's done in other window.
yuuji@51	1130 Note that this function doesn't work on @code{begin/end},
yuuji@51	1131 @code{%#BEGIN/%#END} pairs because it is meaningless.
yuuji@51	1132
yuuji@68	1133 @node Invoking image processor, Jump to main file, Jump to corresponding object, Cursor jump
yuuji@68	1134 @comment node-name, next, previous, up
yuuji@68	1135 @section Invoking image processor
yuuji@59	1136 @cindex{Drawing tool invocation}
yuuji@59	1137
yuuji@59	1138 `image-including line' described above means such lines as
yuuji@59	1139 @code{\epsfile@{file=foo.ps@}}. If you type @kbd{[prefix] g} on that
yuuji@59	1140 line, YaTeX automatically searches source of `foo.ps' and invokes image
yuuji@59	1141 viewer or drawing tool correspoinding to it. For example; if you draw
yuuji@59	1142 an image foo.obj with Tgif and enclose its product named foo.eps by
yuuji@59	1143 @code{\epsfile} command. Typing @kbd{[prefix] g} on @code{\epsfile} line
yuuji@59	1144 make YaTeX invoke @code{tgif foo.obj}. How a processor is choosen is as
yuuji@59	1145 follows.
yuuji@59	1146
yuuji@59	1147 @enumerate
yuuji@59	1148 @item
yuuji@59	1149 If there is an expression matching with one of the pattern
yuuji@59	1150 defined in @code{YaTeX-processed-file-regexp-alist}, extract file name
yuuji@59	1151 from regexp group surrounded by \$\$. (Which group corresponds is
yuuji@59	1152 written in the cdr part of each list.) If no matches were found, do
yuuji@59	1153 nothing.
yuuji@59	1154 @item
yuuji@59	1155 If there is a pattern as `%PROCESSOR' which is defined in the variable
yuuji@59	1156 @code{YaTeX-file-processor-alist}, call that processor giving the
yuuji@59	1157 file name with corresponding extension.
yuuji@59	1158 @item
yuuji@59	1159 If not, check the existence of each file which is supplied the
yuuji@59	1160 extension in the cdr part of each list of
yuuji@59	1161 @code{YaTeX-file-processor-alist}. If any, call the corresponding
yuuji@59	1162 image viewer or drawing tool.
yuuji@59	1163 @end enumerate
yuuji@59	1164
yuuji@68	1165 @node Jump to main file, Jumping around the environment, Invoking image processor, Cursor jump
yuuji@68	1166 @comment node-name, next, previous, up
yuuji@51	1167 @section Jump to main file
yuuji@51	1168
yuuji@51	1169 Typing
yuuji@20	1170
yuuji@20	1171 @table @kbd
yuuji@20	1172 @item [prefix] ^
yuuji@46	1173 @dots{} visit main file
yuuji@20	1174 @item [prefix] 4^
yuuji@46	1175 @dots{} visit main file in other buffer
yuuji@20	1176 @end table
yuuji@20	1177 @cindex prefix ^
yuuji@20	1178 @cindex prefix 4 ^
yuuji@20	1179
yuuji@20	1180 in a sub text switch the buffer to the main text specified by
yuuji@20	1181 @code{%#!} notation.
yuuji@20	1182
yuuji@68	1183 @node Jumping around the environment, Jumping to last completion position, Jump to main file, Cursor jump
yuuji@68	1184 @comment node-name, next, previous, up
yuuji@68	1185 @section Jumping around the environment
yuuji@51	1186
yuuji@20	1187 And these are the functions which work on the current La@TeX{}
yuuji@20	1188 environment:
yuuji@20	1189
yuuji@20	1190 @table @kbd
yuuji@20	1191 @item M-C-a
yuuji@46	1192 @dots{} beginning of environment
yuuji@20	1193 @item M-C-e
yuuji@46	1194 @dots{} @code{end} of environment
yuuji@20	1195 @item M-C-@@
yuuji@46	1196 @dots{} mark environment
yuuji@20	1197 @end table
yuuji@20	1198 @cindex M-C-a
yuuji@20	1199 @cindex M-C-e
yuuji@20	1200 @cindex M-C-@@
yuuji@20	1201
yuuji@68	1202 @node Jumping to last completion position, , Jumping around the environment, Cursor jump
yuuji@68	1203 @comment node-name, next, previous, up
yuuji@68	1204 @section Jumping to last completion position
yuuji@68	1205
yuuji@68	1206 YaTeX always memorize the position of completion into register @code{3}.
yuuji@68	1207 So every time you make a trip to any other part of text other than you are
yuuji@68	1208 writing, you can return to the editing paragraph by calling
yuuji@68	1209 register-to-point with argument YaTeX-current-position-register, which is
yuuji@68	1210 achieved by typing @kbd{C-x j 3}(by default).
yuuji@68	1211
yuuji@51	1212 @node Changing and Deleting, Filling, Cursor jump, Top
yuuji@20	1213 @comment node-name, next, previous, up
yuuji@20	1214 @chapter Changing and Deleting
yuuji@20	1215
yuuji@20	1216 These functions are for change or deletion of La@TeX{} commands
yuuji@20	1217 already entered.
yuuji@20	1218
yuuji@20	1219 @table @kbd
yuuji@20	1220 @item [prefix] c
yuuji@46	1221 @dots{} change La@TeX{} command
yuuji@20	1222 @item [prefix] k
yuuji@46	1223 @dots{} kill La@TeX{} command
yuuji@20	1224 @end table
yuuji@20	1225 @cindex prefix c
yuuji@20	1226 @cindex prefix k
yuuji@20	1227
yuuji@49	1228 @menu
yuuji@471	1229 * Changing LaTeX commands::
yuuji@471	1230 * Killing LaTeX commands::
yuuji@49	1231 @end menu
yuuji@49	1232
yuuji@68	1233 @node Changing LaTeX commands, Killing LaTeX commands, Changing and Deleting, Changing and Deleting
yuuji@49	1234 @comment node-name, next, previous, up
yuuji@49	1235 @section Changing La@TeX{} commands
yuuji@49	1236
yuuji@49	1237 @kbd{[prefix] c} can change the various (La)@TeX{} commands. This can
yuuji@49	1238 change the followings.
yuuji@49	1239 @itemize @bullet
yuuji@49	1240 @item Environment names
yuuji@49	1241 @item Section-type commands
yuuji@49	1242 @item Argument of section-type commands
yuuji@49	1243 @item Optional parameters (enclosed by []) of section-type commands
yuuji@49	1244 @item Font/size designators
yuuji@52	1245 @item Math-mode's maketitle-type commands that can be inputted with
yuuji@52	1246 image completion
yuuji@49	1247 @end itemize
yuuji@49	1248
yuuji@49	1249 Typing @kbd{[prefix] c} on one of above objects you want to change
yuuji@49	1250 brings a suitable reading function sometimes with completion.
yuuji@49	1251 Note: If you want to change the argument of section-type command that
yuuji@49	1252 contains other La@TeX{} commands, type @kbd{[prefix] c} either of
yuuji@49	1253 surrounding braces of the argument in order to make YaTeX ignore the
yuuji@49	1254 internal La@TeX{} sequences as an object of changing. Anyway, it is
yuuji@49	1255 very difficult to know which argument position the cursor belongs because
yuuji@49	1256 the La@TeX{} commands can be nested and braces can freely emerge. So keep
yuuji@49	1257 it mind to put the cursor on a brace when you are thinking of changing a
yuuji@49	1258 complicated argument.
yuuji@49	1259
yuuji@68	1260 @node Killing LaTeX commands, , Changing LaTeX commands, Changing and Deleting
yuuji@49	1261 @comment node-name, next, previous, up
yuuji@49	1262 @section Killing La@TeX{} commands
yuuji@49	1263 @cindex Killing La@TeX{} commands
yuuji@49	1264
yuuji@49	1265 @kbd{[prefix] k} kills the La@TeX{} commands sometimes with their
yuuji@49	1266 arguments. Following table illustrates the correspondence of the invoking
yuuji@49	1267 position and what is killed.
yuuji@20	1268
yuuji@20	1269 @example
yuuji@20	1270 [Invoking position] [action]
yuuji@49	1271 \begin, \end line kill \begin,\end pairs
yuuji@49	1272 %#BEGIN, %#END line kill %#BEGIN,%#END pairs
yuuji@20	1273 on a Section-type command kill section-type command
yuuji@20	1274 on a parenthesis kill parentheses
yuuji@20	1275 @end example
yuuji@20	1276
yuuji@49	1277 Note that when killing @code{\begin, \end} or @code{%#BEGIN, %#END} pair,
yuuji@49	1278 the lines @code{\begin, \end} or @code{%#BEGIN, %#END} exist will be
yuuji@49	1279 killed entirely. So take care not to create any line that contains more
yuuji@49	1280 than one @code{\begin} or so.
yuuji@49	1281
yuuji@20	1282 While all operations above are to kill `containers' which surround some
yuuji@20	1283 text, universal argument (@kbd{C-u}) for these commands kills not only
yuuji@20	1284 `containers' but also `contents' of them. See below as a sample.
yuuji@20	1285
yuuji@20	1286 @example
yuuji@46	1287 Original text: [prefix] k C-u [prefix] k
yuuji@46	1288 Main \footnote@{note@} here. Main note here. Main here.
yuuji@20	1289 ~(cursor)
yuuji@20	1290 @end example
yuuji@20	1291
yuuji@58	1292 @node Filling, Updation of includeonly, Changing and Deleting, Top
yuuji@20	1293 @comment node-name, next, previous, up
yuuji@51	1294 @chapter Filling
yuuji@51	1295 @cindex filling
yuuji@51	1296
yuuji@51	1297 @section Filling an item
yuuji@20	1298 @cindex filling an item
yuuji@20	1299 @cindex prefix i
yuuji@20	1300
yuuji@51	1301 To fill a term (descriptive sentences) of @code{\item}, type
yuuji@20	1302
yuuji@58	1303 @c @table @kbd
yuuji@58	1304 @c @item [prefix] i
yuuji@58	1305 @c @dots{} fill item
yuuji@58	1306 @c @end table
yuuji@20	1307 @table @kbd
yuuji@58	1308 @item M-q
yuuji@46	1309 @dots{} fill item
yuuji@20	1310 @end table
yuuji@20	1311
yuuji@20	1312 @noindent
yuuji@20	1313 on that item.
yuuji@20	1314
yuuji@20	1315 YaTeX uses the value of the variable @code{YaTeX-item-regexp} as the
yuuji@20	1316 regular expression to search item header in itemize environment.
yuuji@51	1317 If you make a newcommand to itemize terms(e.g. @code{\underlineitem}), put
yuuji@20	1318
yuuji@20	1319 @lisp
yuuji@46	1320 (setq YaTeX-item-regexp
yuuji@58	1321 "\$\\\\\\(sub\$*item\\)\\\|\$\\\\underlineitem\$")
yuuji@20	1322 @end lisp
yuuji@20	1323 @cindex YaTeX-item-regexp
yuuji@20	1324
yuuji@20	1325 in your @file{~/.emacs}. If you are not familiar with regular expression
yuuji@20	1326 for Emacs-Lisp, name a newcommand for `itemize' beginning with
yuuji@20	1327 @code{\item} such as @code{\itembf}, not @code{\bfitem}.
yuuji@20	1328
yuuji@58	1329 This function reformats the @code{\item} into `hang-indented' style.
yuuji@58	1330 For example:
yuuji@51	1331
yuuji@51	1332 @example
yuuji@58	1333 itemize, enumerate environment:
yuuji@51	1334 >
yuuji@51	1335 >\item[foo] `foo' is the typical word for describing an
yuuji@51	1336 > arbitrarily written....
yuuji@58	1337 description environment:
yuuji@58	1338 > \item[bar] When the word `for' is used as an arbitrarily
yuuji@58	1339 > word, `bar' is bound to follow it.
yuuji@51	1340 @end example
yuuji@51	1341
yuuji@52	1342 Note that the indent depth of an @code{\item} word and its descriptive
yuuji@51	1343 paragraph are the same in latter case. If you want to use different
yuuji@51	1344 depth, invoke fill-paragraph at the beginning of non-whitespace
yuuji@51	1345 character(see below).
yuuji@51	1346
yuuji@51	1347 @section Filling paragraph
yuuji@51	1348 @cindex Filling paragraph
yuuji@51	1349 @cindex M-q
yuuji@51	1350
yuuji@51	1351 Fill-paragraph is little bit adapted for La@TeX{} sources. It retains from
yuuji@51	1352 filling in certain environments where formatting leads to a disaster such
yuuji@51	1353 as verbatim, tabular, or so. And it protects @code{\verb} expressions
yuuji@51	1354 from being folded (The variable @code{YaTeX-verb-regexp} controls this).
yuuji@51	1355 Besides, putting cursor on the first occurrence of non-whitespace
yuuji@51	1356 character on a line changes the fill-prefix temporarily to the depth of
yuuji@51	1357 the line.
yuuji@51	1358
yuuji@59	1359 @node Updation of includeonly, What column, Filling, Top
yuuji@20	1360 @comment node-name, next, previous, up
yuuji@20	1361 @chapter Updation of @code{\includeonly}
yuuji@20	1362 @cindex includeonly
yuuji@20	1363
yuuji@20	1364 When you edit splitting source texts, the notation
yuuji@20	1365
yuuji@20	1366 @example
yuuji@46	1367 \includeonly@{CurrentEditingFileName@}
yuuji@20	1368 @end example
yuuji@20	1369
yuuji@20	1370 @noindent
yuuji@20	1371 in the main file reduces the time of typesetting. If you want
yuuji@20	1372 to hack other file a little however, you have to rewrite it to
yuuji@20	1373
yuuji@20	1374 @example
yuuji@46	1375 \includeonly@{OtherFileNameYouWantToFix@}
yuuji@20	1376 @end example
yuuji@20	1377
yuuji@20	1378 @noindent
yuuji@20	1379 in the main file. YaTeX automatically detects that the current
yuuji@20	1380 edited text is not in includeonly list and prompts you
yuuji@20	1381
yuuji@20	1382 @example
yuuji@46	1383 A)dd R)eplace %)comment?
yuuji@20	1384 @end example
yuuji@20	1385
yuuji@20	1386 in the minibuffer. Type @kbd{a} if you want to add the current file name
yuuji@20	1387 to @code{\includeonly} list, @kbd{r} to replace \@code{includeonly} list
yuuji@79	1388 with the current file, and type @kbd{%} to comment out the
yuuji@20	1389 @code{\includeonly} line.
yuuji@20	1390
yuuji@59	1391 @node What column, Intelligent newline, Updation of includeonly, Top
yuuji@20	1392 @comment node-name, next, previous, up
yuuji@20	1393 @chapter What column?
yuuji@20	1394 @cindex what column
yuuji@20	1395 @cindex complex tabular
yuuji@20	1396 @cindex prefix &
yuuji@20	1397
yuuji@20	1398 We are often get tired of finding the corresponding column in
yuuji@20	1399 large tabulars. For example,
yuuji@20	1400
yuuji@20	1401 @example
yuuji@20	1402 \begin@{tabular@}@{\|c\|c\|c\|c\|c\|c\|c\|c\|@}\hline
yuuji@20	1403 Name&Position&Post No.&Addr.&Phone No.&FAX No.&
yuuji@20	1404 Home Addr.&Home Phone\\ \hline
yuuji@20	1405 Thunder Bird & 6 & 223 & LA & xxx-yyy &
yuuji@20	1406 zzz-www & Japan & 9876-54321 \\
yuuji@20	1407 & 2 & \multicolumn@{2@}@{c\|@}@{Unknown@}
yuuji@20	1408 &&&(???)
yuuji@20	1409 \\ \hline
yuuji@20	1410 \end@{tabular@}
yuuji@20	1411 @end example
yuuji@20	1412
yuuji@20	1413 Suppose you have the cursor located at @code{(???)} mark, can you tell
yuuji@20	1414 which column it is belonging at once? Maybe no. In such case,
yuuji@20	1415 type
yuuji@20	1416
yuuji@20	1417 @table @kbd
yuuji@20	1418 @item [prefix] &
yuuji@46	1419 @dots{} What column
yuuji@20	1420 @end table
yuuji@20	1421
yuuji@20	1422 @noindent
yuuji@20	1423 in that position. YaTeX tells you the column header of the
yuuji@20	1424 current field. Since YaTeX assumes the first line of tabular
yuuji@20	1425 environment as a row of column headers, you can create a row of
yuuji@20	1426 virtual column headers by putting them in the first line and
yuuji@20	1427 commenting that line with @code{%}.
yuuji@20	1428
yuuji@79	1429 @node Intelligent newline, Usepackage checker, What column, Top
yuuji@28	1430 @comment node-name, next, previous, up
yuuji@28	1431 @chapter Intelligent newline
yuuji@28	1432 @cindex Intelligent newline
yuuji@28	1433 @cindex ESC RET
yuuji@28	1434 @cindex M-C-m
yuuji@28	1435
yuuji@58	1436 At the end of begin-type completion of tabular[*], array, itemize,
yuuji@58	1437 enumerate or tabbing environment, or typing
yuuji@28	1438
yuuji@28	1439 @table @kbd
yuuji@28	1440 @item ESC RET
yuuji@46	1441 @dots{} Intelligent newline
yuuji@28	1442 @end table
yuuji@28	1443
yuuji@265	1444 @noindent
yuuji@58	1445 in these environments inserts the contents corresponding to the current
yuuji@58	1446 environment in the next line. (At the begin-type completion, this
yuuji@58	1447 contents can be removed by `undo'.) In @code{tabular} environment, for
yuuji@58	1448 example, @kbd{ESC RET} inserts the certain number of @code{&} and trailing
yuuji@58	1449 @code{\\}, and @code{\hline} if other @code{\hline} is found in backward.
yuuji@58	1450 Here are the list of contents vs. environments.
yuuji@28	1451
yuuji@28	1452 @itemize
yuuji@28	1453 @item @code{tabular}, @code{tabular*}, @code{array}
yuuji@28	1454
yuuji@46	1455 Corresponding number of @code{&} and @code{\\}.
yuuji@46	1456 And @code{\hline} if needed.
yuuji@28	1457
yuuji@28	1458 @item @code{tabbing}
yuuji@28	1459
yuuji@46	1460 The same number of @code{\>} as @code{\=} in the first line.
yuuji@28	1461
yuuji@28	1462 @item @code{itemize}, @code{enumerate}, @code{description}, @code{list}
yuuji@28	1463
yuuji@46	1464 @code{\item} or @code{item[]}.
yuuji@28	1465 @end itemize
yuuji@28	1466
yuuji@28	1467 Note that since this function works seeing the contents of the first
yuuji@28	1468 line, please call this after the second line if possible.
yuuji@28	1469
yuuji@28	1470 If you want to apply these trick to other environments, @code{foo}
yuuji@28	1471 environment for example, define the function named
yuuji@28	1472 @code{YaTeX-intelligent-newline-foo} to insert corresponding contents.
yuuji@28	1473 That function will be called at the beginning of the next line after the
yuuji@28	1474 newline is inserted to the current line. Since the function
yuuji@28	1475 @code{YaTeX-indent-line} is designed to indent the current line properly,
yuuji@28	1476 calling this function before your code to insert certain contents must be
yuuji@28	1477 useful. See the definition of the function
yuuji@28	1478 @code{YaTeX-intelligent-newline-itemize} as an example.
yuuji@28	1479
yuuji@79	1480 @node Usepackage checker, Online help, Intelligent newline, Top
yuuji@79	1481 @comment node-name, next, previous, up
yuuji@79	1482 @chapter Usepackage checker
yuuji@79	1483 @cindex usepackage
yuuji@79	1484
yuuji@79	1485 When you input begint-type, section-type, maketitle-type macros with
yuuji@79	1486 completion, and it requires some LaTeX2e package, YaTeX examines
yuuji@79	1487 the existence of correct @code{\usepackage}. If not, YaTeX inserts
yuuji@79	1488 the @code{\usepackage@{@}} declaration corresponding to input macro.
yuuji@79	1489
yuuji@79	1490 To activate the package completion for your favarite package,
yuuji@79	1491 set the variable @code{YaTeX-package-alist-private} correctly.
yuuji@79	1492 Please refere the value of @code{YaTeX-package-alist-default} as an
yuuji@79	1493 example.
yuuji@79	1494
yuuji@79	1495 @node Online help, Browsing file hierarchy, Usepackage checker, Top
yuuji@20	1496 @comment node-name, next, previous, up
yuuji@20	1497 @chapter Online help
yuuji@20	1498 @cindex online help
yuuji@20	1499 @cindex prefix ?
yuuji@20	1500 @cindex prefix /
yuuji@20	1501 @cindex apropos
yuuji@20	1502 @cindex keyword search
yuuji@20	1503
yuuji@20	1504 YaTeX provides you the online help with popular La@TeX{} commands.
yuuji@20	1505
yuuji@20	1506 Here are the key strokes for the online help.
yuuji@20	1507
yuuji@20	1508 @table @kbd
yuuji@20	1509 @item [prefix] ?
yuuji@46	1510 @dots{} Online help
yuuji@20	1511 @item [prefix] /
yuuji@46	1512 @dots{} Online apropos
yuuji@20	1513 @end table
yuuji@20	1514
yuuji@20	1515 @section Online help
yuuji@20	1516
yuuji@20	1517 `Online help' shows the documentation for the popular La@TeX{}
yuuji@20	1518 commands(defaults to the commands on the cursor) in the next buffer.
yuuji@20	1519 There are two help file, `global help' and `private help'. The former
yuuji@20	1520 file contains the descriptions on the standard La@TeX{} command and is
yuuji@20	1521 specified its name by variable @code{YaTeX-help-file}. Usually, the
yuuji@20	1522 global help file should be located in public space (@code{$EMACSEXECPATH}
yuuji@20	1523 by default) and should be world writable so that anyone can update it to
yuuji@20	1524 enrich its contents. The latter file contains descriptions on
yuuji@20	1525 non-standard or personal command definitions and is specified by
yuuji@20	1526 @code{YaTeX-help-file-private}. This file should be put into private
yuuji@20	1527 directory.
yuuji@20	1528
yuuji@20	1529 @section Online apropos
yuuji@20	1530
yuuji@20	1531 `Online apropos' is an equivalent of GNU Emacs's apropos. It
yuuji@20	1532 shows all the documentations that contains the keyword entered by
yuuji@20	1533 the user.
yuuji@20	1534
yuuji@20	1535 @section When no descriptions are found...
yuuji@20	1536
yuuji@20	1537 If there is no description on a command in help files, YaTeX
yuuji@20	1538 requires you to write a description on that command. If you are
yuuji@20	1539 willing to do, determine which help file to add and write the
yuuji@20	1540 description on it referring your manual of (La)TeX. Please send
yuuji@20	1541 me your additional descriptions if you describe the help on some
yuuji@20	1542 standard commands. I might want to include it in the next
yuuji@20	1543 distribution.
yuuji@20	1544
yuuji@53	1545 @node Browsing file hierarchy, Cooperation with other packages, Online help, Top
yuuji@53	1546 @comment node-name, next, previous, up
yuuji@53	1547 @chapter Browsing file hierarchy
yuuji@53	1548 @cindex hierarchy
yuuji@53	1549 @cindex browsing
yuuji@53	1550
yuuji@53	1551 When you are editing multi-file source, typing
yuuji@53	1552
yuuji@53	1553 @table @kbd
yuuji@53	1554 @item [prefix] d
yuuji@53	1555 @dots{} browse file hierarchy
yuuji@53	1556 @end table
yuuji@53	1557
yuuji@53	1558 @noindent
yuuji@53	1559 asks you the parent-most file (which may be defaulted) and displays the
yuuji@53	1560 documentation hierarchy in the next window. In this buffer, the following
yuuji@53	1561 commands are available.
yuuji@53	1562
yuuji@53	1563 @table @kbd
yuuji@53	1564 @item n
yuuji@53	1565 @dots{} move to the next line and show its contents
yuuji@53	1566 @item p
yuuji@53	1567 @dots{} move to the previous line and show its contents
yuuji@53	1568 @item N
yuuji@53	1569 @dots{} move to the next file in the same inclusion level
yuuji@53	1570 @item P
yuuji@53	1571 @dots{} move to the previous file in the same inclusion level
yuuji@53	1572 @item j
yuuji@53	1573 @dots{} move to the next line
yuuji@53	1574 @item k
yuuji@53	1575 @dots{} move to the previous line
yuuji@53	1576 @item u
yuuji@53	1577 @dots{} move to the parent file
yuuji@53	1578 @item .
yuuji@53	1579 @dots{} show the current files contents in the next window
yuuji@53	1580 @item SPC
yuuji@53	1581 @dots{} scroll up the current file window
yuuji@53	1582 @item DEL, b
yuuji@53	1583 @dots{} scroll down the current file window
yuuji@53	1584 @item <
yuuji@53	1585 @dots{} show the beginning of the current file
yuuji@53	1586 @item >
yuuji@53	1587 @dots{} show the end of the current file
yuuji@53	1588 @item >
yuuji@53	1589 @dots{} return to the previous postion after @kbd{<} or @kbd{>}
yuuji@53	1590 @item RET, g
yuuji@53	1591 @dots{} open the current file in the next window
yuuji@53	1592 @item mouse-2
yuuji@53	1593 @dots{} same as RET(available only with window system)
yuuji@53	1594 @item o
yuuji@53	1595 @dots{} other window
yuuji@53	1596 @item 1
yuuji@53	1597 @dots{} delete other windows
yuuji@53	1598 @item -
yuuji@53	1599 @dots{} shrink hierarchy buffer window
yuuji@53	1600 @item +
yuuji@53	1601 @dots{} enlarge hierarchy buffer window
yuuji@53	1602 @item ?
yuuji@53	1603 @dots{} describe mode
yuuji@53	1604 @item q
yuuji@53	1605 @dots{} quit
yuuji@53	1606 @end table
yuuji@53	1607
yuuji@53	1608 Note that operations on the file contents in the next window do not work
yuuji@53	1609 correctly when you close the corresponding file.
yuuji@53	1610
yuuji@53	1611 @node Cooperation with other packages, Customizations, Browsing file hierarchy, Top
yuuji@20	1612 @comment node-name, next, previous, up
yuuji@20	1613 @chapter Cooperation with other packages
yuuji@20	1614
yuuji@20	1615 YaTeX works better with other brilliant packages.
yuuji@20	1616
yuuji@20	1617 @section gmhist
yuuji@20	1618 @cindex gmhist
yuuji@20	1619 @cindex command history
yuuji@20	1620 @cindex minibuffer history
yuuji@20	1621
yuuji@20	1622 When you are loading @file{gmhist.el} and @file{gmhist-mh.el}, you can
yuuji@20	1623 use independent command history list at the prompt of preview command
yuuji@20	1624 (@kbd{[prefix] tp}) and print command (@kbd{[prefix] tl}). On each
yuuji@20	1625 prompt, you can enter the previous command line string repeatedly by
yuuji@20	1626 typing @kbd{M-p}.
yuuji@20	1627
yuuji@20	1628 @section min-out
yuuji@20	1629 @cindex min-out
yuuji@20	1630
yuuji@20	1631 @file{min-out}, the outline minor mode, can be used in yatex-mode
yuuji@20	1632 buffers. If you want to use it with YaTeX, please refer the
yuuji@20	1633 file @file{yatexm-o.el} as an example.
yuuji@20	1634
yuuji@20	1635 @node Customizations, Etcetera, Cooperation with other packages, Top
yuuji@20	1636 @comment node-name, next, previous, up
yuuji@20	1637 @chapter Customizations
yuuji@20	1638 @cindex customizations
yuuji@20	1639
yuuji@20	1640 You can customize YaTeX by setting Emacs-Lisp variables and by making
yuuji@20	1641 add-in functions.
yuuji@20	1642
yuuji@20	1643 @menu
yuuji@471	1644 * Lisp variables::
yuuji@471	1645 * Add-in functions::
yuuji@471	1646 * Add-in generator::
yuuji@20	1647 @end menu
yuuji@20	1648
yuuji@33	1649 @node Lisp variables, Add-in functions, Customizations, Customizations
yuuji@20	1650 @comment node-name, next, previous, up
yuuji@20	1651 @section Lisp variables
yuuji@20	1652 @cindex customizable variables
yuuji@20	1653
yuuji@60	1654 You can change the key assignments or make completion more comfortable
yuuji@60	1655 by setting the values of various variables which control the movement of
yuuji@60	1656 yatex-mode.
yuuji@20	1657
yuuji@20	1658 For example, if you want to change the prefix key stroke from @kbd{C-c}
yuuji@20	1659 to any other sequence, set YaTeX-prefix to whatever you want to use. If
yuuji@20	1660 you don't want to use the key sequence @kbd{C-c letter} which is assumed
yuuji@20	1661 to be the user reserved sequence in Emacs world, set
yuuji@20	1662 @code{YaTeX-inhibit-prefix-letter} to @code{t}, and all of the default key
yuuji@20	1663 bind of @kbd{C-c letter} will turn to the corresponding @kbd{C-c C-letter}
yuuji@20	1664 (but the region based completions that is invoked with @kbd{C-c
yuuji@20	1665 Capital-letter} remain valid, if you want to disable those bindings, set
yuuji@20	1666 that variable to 1 instead of @code{t}).
yuuji@20	1667
yuuji@20	1668 @menu
yuuji@471	1669 * All customizable variables::
yuuji@471	1670 * Sample definitions::
yuuji@471	1671 * Hook variables::
yuuji@471	1672 * Hook file::
yuuji@20	1673 @end menu
yuuji@20	1674
yuuji@33	1675 @node All customizable variables, Sample definitions, Lisp variables, Lisp variables
yuuji@20	1676 @comment node-name, next, previous, up
yuuji@20	1677 @subsection All customizable variables
yuuji@20	1678 @cindex all customizable variables
yuuji@20	1679
yuuji@20	1680 Here are the customizable variables of yatex-mode. Each value setq-ed
yuuji@20	1681 in @file{~/.emacs} is preferred and that of defined in @file{yatex.el} is
yuuji@49	1682 neglected. Parenthesized contents stands for the default value. When you
yuuji@49	1683 are to change some of these variables, see more detailed documentation of
yuuji@49	1684 the variable by @kbd{M-x describe-variable}.
yuuji@20	1685
yuuji@79	1686 @defvar YaTeX-japan
yuuji@79	1687 Set this nil to produce all messages in English
yuuji@79	1688 (@code{Depends on Japanese feature of Emacs})
yuuji@79	1689 @end defvar
yuuji@79	1690
yuuji@79	1691 @defvar YaTeX-kanji-code
yuuji@79	1692 Default buffer-file-coding-system for YaTeX modes' buffer.
yuuji@79	1693 Set this 0 to no language conversion. Nil to preserve original
yuuji@118	1694 coding-system. 1=Shift JIS, 2=JIS, 3=EUC, 4=UTF-8 (@code{1 or 2})
yuuji@79	1695 @end defvar
yuuji@79	1696
yuuji@46	1697 @defvar YaTeX-prefix
yuuji@60	1698 Prefix key stroke (@kbd{C-c})
yuuji@46	1699 @end defvar
yuuji@20	1700
yuuji@46	1701 @defvar YaTeX-inhibit-prefix-letter
yuuji@60	1702 Change key stroke from @kbd{C-c letter} to @kbd{C-c C-letter} (@code{nil})
yuuji@46	1703 @end defvar
yuuji@20	1704
yuuji@46	1705 @defvar YaTeX-fill-prefix
yuuji@60	1706 Fill-prefix used in yatex-mode (@code{nil})
yuuji@46	1707 @end defvar
yuuji@20	1708
yuuji@46	1709 @defvar YaTeX-user-completion-table
yuuji@60	1710 Name of user dictionary where learned completion table will be stored.
yuuji@60	1711 (@code{"~/.yatexrc"})
yuuji@60	1712 @end defvar
yuuji@60	1713
yuuji@60	1714 @defvar tex-command
yuuji@60	1715 La@TeX{} typesetter command (@code{"latex"})
yuuji@60	1716 @end defvar
yuuji@60	1717
yuuji@60	1718 @defvar dvi2-command
yuuji@60	1719 Preview command (@code{"xdvi -geo +0+0 -s 4"})
yuuji@60	1720 @end defvar
yuuji@60	1721
yuuji@60	1722 @defvar dviprint-command-format
yuuji@60	1723 Command format to print dvi file (@code{"dvi2ps %f %t %s \| lpr"})
yuuji@60	1724 @end defvar
yuuji@60	1725
yuuji@60	1726 @defvar dviprint-from-format
yuuji@60	1727 Start page format of above %f. %b will turn to start page (@code{"-f %b"})
yuuji@60	1728 @end defvar
yuuji@60	1729
yuuji@60	1730 @defvar dviprint-to-format
yuuji@60	1731 End page format of above %t. %e will turn to @code{end} page (@code{"-t %e"})
yuuji@60	1732 @end defvar
yuuji@60	1733
yuuji@60	1734 @defvar makeindex-command
yuuji@60	1735 Default makeindex command (@code{"makeindex"} (@code{"makeind"} on MS-DOS))
yuuji@60	1736 @end defvar
yuuji@60	1737
yuuji@126	1738 @defvar YaTeX-dvipdf-command
yuuji@126	1739 Default command name to convert .dvi to PDF (@code{"dvipdfmx"})
yuuji@126	1740 @end defvar
yuuji@126	1741
yuuji@379	1742 @defvar YaTeX-on-the-fly-preview-interval
yuuji@379	1743 Interval time in seconds of idle to trigger on-the-fly preview of
yuuji@379	1744 environment by @kbd{[prefix] t e}(0.9).
yuuji@379	1745 @code{Nil} disables on-the-fly preview.
yuuji@379	1746 @end defvar
yuuji@379	1747
yuuji@392	1748 @defvar YaTeX-on-the-fly-math-preview-engine
yuuji@392	1749 Function symbol to use on-the-fly preview of MATH environment
yuuji@392	1750 started by @kbd{[prefix] t e} (@code{'YaTeX-typeset-environment-by-lmp}
yuuji@392	1751 which calls latex-math-preview-expression function if latex-math-preview
yuuji@392	1752 is available, otherwise @code{'YaTeX-typeset-environment-by-builtin} which
yuuji@392	1753 alls built-in function).
yuuji@392	1754
yuuji@392	1755 @code{Nil} disables on-the-fly preview.
yuuji@392	1756 @end defvar
yuuji@392	1757
yuuji@336	1758 @defvar YaTeX-cmd-gimp
yuuji@336	1759 Command name of GIMP (code{"gimp"})
yuuji@336	1760 @end defvar
yuuji@336	1761 @defvar YaTeX-cmd-tgif
yuuji@336	1762 Command name of tgif (code{"tgif"})
yuuji@336	1763 @end defvar
yuuji@336	1764 @defvar YaTeX-cmd-inkscape
yuuji@336	1765 Command name of Inkscape (code{"inkscape"})
yuuji@336	1766 @end defvar
yuuji@336	1767 @defvar YaTeX-cmd-dia
yuuji@336	1768 Command name of Dia (code{"dia"})
yuuji@336	1769 @end defvar
yuuji@336	1770 @defvar YaTeX-cmd-ooo
yuuji@336	1771 Command name of OpenOffice.org/LibreOffice (code{"soffice"})
yuuji@336	1772 @end defvar
yuuji@336	1773 @defvar YaTeX-cmd-gs
yuuji@336	1774 Command name of Ghostscript (code{"gs"})
yuuji@336	1775 @end defvar
yuuji@363	1776 @defvar YaTeX-cmd-dvips
yuuji@363	1777 Command name of dvips (code{"dvips"})
yuuji@363	1778 @end defvar
yuuji@363	1779 @defvar YaTeX-cmd-displayline
yuuji@363	1780 Command name of displayline
yuuji@363	1781 (code{"/Applications/Skim.app/Contents/SharedSupport/displayline"})
yuuji@363	1782 @end defvar
yuuji@336	1783 @defvar YaTeX-cmd-edit-ps
yuuji@336	1784 Command name for editing PostScript files(Value of code{"YaTeX-cmd-gimp"})
yuuji@336	1785 @end defvar
yuuji@336	1786 @defvar YaTeX-cmd-edit-pdf
yuuji@336	1787 Command name for editing PDF files(Value of code{"YaTeX-cmd-ooo"})
yuuji@336	1788 @end defvar
yuuji@336	1789 @defvar YaTeX-cmd-edit-ai
yuuji@336	1790 Command name for editing `.ai' files(Value of code{"YaTeX-cmd-inkscape"})
yuuji@336	1791 @end defvar
yuuji@336	1792 @defvar YaTeX-cmd-edit-svg
yuuji@336	1793 Command name for editing SVG files(Value of code{"YaTeX-cmd-inkscape"})
yuuji@336	1794 @end defvar
yuuji@336	1795 @defvar YaTeX-cmd-edit-images
yuuji@336	1796 Command name for editing image files(Value of code{"YaTeX-cmd-gimp"})
yuuji@336	1797 @end defvar
yuuji@336	1798
yuuji@60	1799 @defvar YaTeX-need-nonstop
yuuji@60	1800 Put @code{\nonstopmode@{@}} or not (@code{nil})
yuuji@60	1801 @end defvar
yuuji@60	1802
yuuji@60	1803 @defvar latex-warning-regexp
yuuji@60	1804 Regular expression of warning message latex command puts out
yuuji@60	1805 (@code{"line.* [0-9]*"})
yuuji@60	1806 @end defvar
yuuji@60	1807
yuuji@60	1808 @defvar latex-error-regexp
yuuji@60	1809 Regular expression of error message (@code{"l\\.[1-9][0-9]*"})
yuuji@60	1810 @end defvar
yuuji@60	1811
yuuji@60	1812 @defvar latex-dos-emergency-message
yuuji@60	1813 Message latex command running on DOS puts at abort (@code{"Emergency stop"})
yuuji@46	1814 @end defvar
yuuji@20	1815
yuuji@46	1816 @defvar YaTeX-item-regexp
yuuji@60	1817 Regular expression of item command (@code{"\\\\item"})
yuuji@46	1818 @end defvar
yuuji@20	1819
yuuji@51	1820 @defvar YaTeX-verb-regexp
yuuji@60	1821 Regexp of verb family. Omit \\\\. (@code{"verb\\*?\\\|path"})
yuuji@51	1822 @end defvar
yuuji@51	1823
yuuji@60	1824 @defvar YaTeX-nervous
yuuji@60	1825 T for using local dictionary (@code{t})
yuuji@46	1826 @end defvar
yuuji@20	1827
yuuji@46	1828 @defvar YaTeX-sectioning-regexp
yuuji@60	1829 Regexp of La@TeX{} sectioning command
yuuji@60	1830 (@code{"\$part\\\|chapter\\?\\\|\\(sub\$\$section\\\|paragraph\$\\*?\\)\\b"})
yuuji@46	1831 @end defvar
yuuji@20	1832
yuuji@46	1833 @defvar YaTeX-fill-inhibit-environments
yuuji@60	1834 Inhibit fill in these environments
yuuji@60	1835 (@code{'("tabular" "tabular" "array" "picture" "eqnarray" "eqnarray" "equation" "math" "displaymath" "verbatim" "verbatim*")})
yuuji@46	1836 @end defvar
yuuji@20	1837
yuuji@46	1838 @defvar YaTeX-uncomment-once
yuuji@60	1839 T for deleting all preceding @code{%} (@code{nil})
yuuji@46	1840 @end defvar
yuuji@20	1841
yuuji@46	1842 @defvar YaTeX-close-paren-always
yuuji@60	1843 T for always close all parenthesis automatically, @code{nil} for only eol
yuuji@60	1844 (@code{t})
yuuji@46	1845 @end defvar
yuuji@20	1846
yuuji@46	1847 @defvar YaTeX-auto-math-mode
yuuji@60	1848 Switch math-mode automatically (@code{t})
yuuji@46	1849 @end defvar
yuuji@20	1850
yuuji@51	1851 @defvar YaTeX-math-key-list-private
yuuji@60	1852 User defined alist, math-mode-prefix vs completion alist
yuuji@60	1853 used in image completion (@code{nil}). See @file{yatexmth.el}
yuuji@60	1854 for the information about how to define a completion alist.
yuuji@51	1855 @end defvar
yuuji@51	1856
yuuji@46	1857 @defvar YaTeX-default-pop-window-height
yuuji@60	1858 Initial height of typesetting buffer when one-window.
yuuji@60	1859 Number for the lines of the buffer, numerical string for
yuuji@60	1860 the percentage of the screen-height. @code{nil} for half height (10)
yuuji@46	1861 @end defvar
yuuji@20	1862
yuuji@46	1863 @defvar YaTeX-help-file
yuuji@73	1864 Global online help file name (@file{$doc-directory/../../site-lisp/YATEXHLP.eng})
yuuji@46	1865 @end defvar
yuuji@20	1866
yuuji@46	1867 @defvar YaTeX-help-file-private
yuuji@73	1868 Private online help file name (@file{"~/YATEXHLP.eng"})
yuuji@46	1869 @end defvar
yuuji@20	1870
yuuji@46	1871 @defvar YaTeX-no-begend-shortcut
yuuji@60	1872 Disable [prefix] b ?? shortcut (@code{nil)}
yuuji@46	1873 @end defvar
yuuji@20	1874
yuuji@49	1875 @defvar YaTeX-hilit-pattern-adjustment-private
yuuji@49	1876 List of the list that contain the regular expression and the symbol of
yuuji@49	1877 logical meaning of the string that matches the pattern. See also the
yuuji@49	1878 value from @code{(assq 'yatex-mode hilit-patterns-alist)} and the value of
yuuji@49	1879 @code{YaTeX-hilit-pattern-adjustment-default} (and even the document of
yuuji@49	1880 hilit19.el).
yuuji@49	1881 @end defvar
yuuji@49	1882
yuuji@49	1883 @defvar YaTeX-sectioning-level
yuuji@49	1884 Alist of LaTeX's sectioning command vs its height.
yuuji@49	1885 @end defvar
yuuji@49	1886
yuuji@53	1887 @defvar YaTeX-hierarchy-ignore-heading-regexp
yuuji@53	1888 @code{YaTeX-display-hierarchy} searches for sectioning command first, and
yuuji@53	1889 comment line secondary as a file headings. In latter case, ignore lines
yuuji@53	1890 that match with regular expression of this variable. Default value of
yuuji@53	1891 this variable is RCS header expressions and mode specifying line `-*- xxxx
yuuji@53	1892 -*'.
yuuji@53	1893 @end defvar
yuuji@53	1894
yuuji@54	1895 @defvar YaTeX-skip-default-reader
yuuji@54	1896 Non-nil for this variable skips the default argument reader of
yuuji@60	1897 section-type command when add-in function for it is not defined
yuuji@60	1898 (@code{nil})
yuuji@54	1899 @end defvar
yuuji@54	1900
yuuji@56	1901 @defvar YaTeX-create-file-prefix-g
yuuji@56	1902 When typing @kbd{prefix g} on the @code{\include} line,
yuuji@60	1903 open the target file even if the file doesn't exist (@code{nil})
yuuji@56	1904 @end defvar
yuuji@56	1905
yuuji@56	1906 @defvar YaTeX-simple-messages
yuuji@60	1907 Simplyfy messages of various completions (@code{nil})
yuuji@56	1908 @end defvar
yuuji@56	1909
yuuji@57	1910 @defvar YaTeX-hilit-sectioning-face
yuuji@57	1911 When hilit19 and yatex19 is active, YaTeX colors the sectioning commands.
yuuji@57	1912 This variable specifies the foreground and background color of
yuuji@57	1913 @code{\part} macro. The default value is @code{'(yellow/dodgerblue
yuuji@57	1914 yellow/slateblue)}. The first element of this list is for the screen when
yuuji@57	1915 @code{hilit-background-mode} is @code{'light}, and the second element is
yuuji@57	1916 for @code{'dark}. You should specify both color as `forecolor/backcolor'.
yuuji@57	1917 @end defvar
yuuji@57	1918
yuuji@57	1919 @defvar YaTeX-hilit-sectioning-attenuation-rate
yuuji@57	1920 When color mode, this variable specifies how much attenuate the color
yuuji@60	1921 density of @code{\subparagraph} compared with that of @code{\chapter}
yuuji@60	1922 (@code{'(15 40)}) See also @code{YaTeX-hilit-sectioning-face}.
yuuji@57	1923 @end defvar
yuuji@56	1924
yuuji@58	1925 @defvar YaTeX-use-AMS-LaTeX
yuuji@60	1926 If you use AMS-LaTeX, set to @code{t} (@code{nil})
yuuji@58	1927 @end defvar
yuuji@56	1928
yuuji@70	1929 @defvar YaTeX-use-LaTeX2e
yuuji@73	1930 If you use LaTeX2e, set to @code{t} (@code{t})
yuuji@70	1931 @end defvar
yuuji@70	1932
yuuji@65	1933 @defvar YaTeX-template-file
yuuji@65	1934 File name which is automatically inserted at creation
yuuji@65	1935 (@code{~/work/template.tex})
yuuji@65	1936 @end defvar
yuuji@65	1937
yuuji@72	1938 @defvar YaTeX-search-file-from-top-directory
yuuji@72	1939 Non-nil means to search input-files from the directory where main file exists
yuuji@72	1940 (@code{t})
yuuji@72	1941 @end defvar
yuuji@72	1942
yuuji@72	1943 @defvar YaTeX-use-font-lock
yuuji@72	1944 Use font-lock to fontify buffer or not (@code{(featurep 'font-lock)}
yuuji@72	1945 @end defvar
yuuji@72	1946
yuuji@72	1947 @defvar YaTeX-use-hilit19
yuuji@72	1948 Use hilit19 to highlight buffer or not (@code{(featurep 'hilit19)}
yuuji@72	1949 @end defvar
yuuji@72	1950
yuuji@72	1951 @defvar YaTeX-use-italic-bold
yuuji@72	1952 YaTeX tries to search italic, bold fontsets or not
yuuji@72	1953 (@code{t} if Emacs-20 or later). This variable is effective only when
yuuji@72	1954 font-lock is used.
yuuji@72	1955 (@code{(featurep 'hilit19)}
yuuji@72	1956 @end defvar
yuuji@72	1957
yuuji@79	1958 @defvar YaTeX-singlecmd-suffix
yuuji@79	1959 Suffix which is always inserted after maketitle-type macros.
yuuji@265	1960 @code{"@{@}"} is recommended.
yuuji@79	1961 @end defvar
yuuji@79	1962
yuuji@79	1963 @defvar YaTeX-package-alist-private
yuuji@79	1964 Alist of LaTeX2e-package name vs. lists of macros in it.
yuuji@79	1965 Set this alist properly and YaTeX automatically check the declaratiion of
yuuji@79	1966 `usepackage' for corresponding macro, when you input that macro with
yuuji@79	1967 completion. If required `usepackage' is not found, YaTeX also
yuuji@79	1968 automatically inserts `\usepackage'. Alist is as follows;
yuuji@79	1969 @lisp
yuuji@79	1970 '((PackageName1
yuuji@79	1971 (completionType ListOfMacro)
yuuji@79	1972 (completionType ListOfMacro))
yuuji@79	1973 (PackageName2
yuuji@79	1974 (completionType ListOfMacro)
yuuji@79	1975 (completionType ListOfMacro...))....)
yuuji@79	1976 @end lisp
yuuji@79	1977 completionType is one of @code{env, section, maketitle}.
yuuji@79	1978 Consult the value of @code{YaTeX-package-alist-default} as an example.
yuuji@79	1979 @end defvar
yuuji@72	1980
yuuji@80	1981 @defvar YaTeX-tabular-indentation
yuuji@80	1982 At indentation by @kbd{C-i} in tabular or array environment,
yuuji@80	1983 YaTeX put the additional spaces to the normail indentation depth.
yuuji@80	1984 The number of additional spaces is the product of YaTeX-tabular-indentation
yuuji@80	1985 and the number of column position in tabular.
yuuji@80	1986 @end defvar
yuuji@80	1987
yuuji@80	1988 @defvar YaTeX-noindent-env-regexp
yuuji@80	1989 Regexp of environment names that should begin with no indentation.
yuuji@80	1990 All verbatime-like environment name should match with.
yuuji@80	1991 @end defvar
yuuji@80	1992
yuuji@409	1993 @defvar YaTeX-electric-indent-mode
yuuji@409	1994 Emacs 24.4 introduces automatic indentation of current and new lines.
yuuji@409	1995 This might be annoying for some people. Pass this value to the function
yuuji@409	1996 'electric-indent-local-mode. If you prefer to stop electric-indent-mode
yuuji@409	1997 in yatex-mode, set `-1' to this variable.
yuuji@409	1998 @end defvar
yuuji@409	1999
yuuji@80	2000 @defvar YaTeX-ref-default-label-string
yuuji@80	2001 Default \\ref time string format.
yuuji@80	2002 This format is like strftime(3) but allowed conversion char are as follows;
yuuji@80	2003 %y -> Last 2 digit of year, %b -> Month name, %m -> Monthe number(1-12),
yuuji@80	2004 %d -> Day, %H -> Hour, %M -> Minute, %S -> Second,
yuuji@80	2005 %qx -> alphabetical-decimal conversion of yymmdd.
yuuji@80	2006 %qX -> alphabetical-decimal conversion of HHMMSS.
yuuji@80	2007 Beware defualt label-string should be always unique. So this format string
yuuji@80	2008 should have both time part (%H+%M+%S or %qX) and date
yuuji@80	2009 part (%y+(%b\|%m)+%d or %qx).
yuuji@80	2010 @end defvar
yuuji@80	2011
yuuji@80	2012 @defvar YaTeX-ref-generate-label-function
yuuji@265	2013 Function to generate default label string for unnamed \\label@{@}s.
yuuji@80	2014 The function pointed to this value should take two arguments.
yuuji@80	2015 First argument is LaTeX macro's name, second is macro's argument.
yuuji@80	2016 Here is an example for using this value.
yuuji@80	2017 @lisp
yuuji@80	2018 (setq YaTeX-ref-generate-label-function 'my-yatex-generate-label)
yuuji@80	2019 (defun my-yatex-generate-label (command value)
yuuji@80	2020 (and (string= command "caption")
yuuji@265	2021 (re-search-backward "\\\\begin@{\$figure\\\|table\$@}" nil t)
yuuji@80	2022 (setq command (match-string 1)))
yuuji@80	2023 (let ((alist '(("chapter" . "chap")
yuuji@80	2024 ("section" . "sec")
yuuji@80	2025 ("subsection" . "subsec")
yuuji@80	2026 ("figure" . "fig")
yuuji@80	2027 ("table" . "tbl"))))
yuuji@80	2028 (if (setq command (cdr (assoc command alist)))
yuuji@80	2029 (concat command ":" value)
yuuji@80	2030 (YaTeX::ref-generate-label nil nil))))
yuuji@80	2031 @end lisp
yuuji@80	2032 @end defvar
yuuji@80	2033
yuuji@80	2034
yuuji@20	2035 @node Sample definitions, Hook variables, All customizable variables, Lisp variables
yuuji@20	2036 @comment node-name, next, previous, up
yuuji@20	2037 @subsection Sample definitions
yuuji@20	2038 @cindex prefix key stroke
yuuji@20	2039 @cindex fill-prefix
yuuji@20	2040
yuuji@20	2041 For instance, to change the prefix key stroke to @kbd{ESC}, and name of
yuuji@20	2042 the user dictionary @file{~/src/emacs/yatexrc}, and set @code{fill-prefix}
yuuji@20	2043 to single TAB character, add the following @code{setq} to @file{~/.emacs}.
yuuji@20	2044
yuuji@20	2045 @lisp
yuuji@46	2046 (setq YaTeX-prefix "\e"
yuuji@46	2047 YaTeX-user-completion-table "~/src/emacs/yatexrc"
yuuji@46	2048 YaTeX-fill-prefix " ")
yuuji@20	2049 @end lisp
yuuji@20	2050
yuuji@20	2051 @node Hook variables, Hook file, Sample definitions, Lisp variables
yuuji@20	2052 @comment node-name, next, previous, up
yuuji@20	2053 @subsection Hook variables
yuuji@20	2054 @cindex hook variables
yuuji@20	2055
yuuji@20	2056 More customizations will be done by the hook-function defined in
yuuji@20	2057 hook-variable @code{yatex-mode-hook}. This is useful to define a shortcut
yuuji@20	2058 key sequence to enter some environments other than @code{document} and
yuuji@20	2059 @code{enumerate} etc. The following statement defines @code{[prefix] ba}
yuuji@20	2060 to enter @code{\begin@{abstract@}} ... @code{=end@{abstract@}}
yuuji@20	2061 immediately.
yuuji@20	2062
yuuji@20	2063 @lisp
yuuji@46	2064 (setq yatex-mode-hook
yuuji@46	2065 '(lambda() (YaTeX-define-begend-key "ba" "abstract")))
yuuji@20	2066 @end lisp
yuuji@20	2067
yuuji@46	2068 You should use functions @code{YaTeX-define-key}, or
yuuji@46	2069 @code{YaTeX-define-begend-key} to define all the key sequences of
yuuji@20	2070 yatex-mode.
yuuji@20	2071
yuuji@20	2072 @node Hook file, , Hook variables, Lisp variables
yuuji@20	2073 @comment node-name, next, previous, up
yuuji@20	2074 @subsection Hook file
yuuji@20	2075 @cindex hook file
yuuji@20	2076
yuuji@58	2077 You can stuff all of YaTeX related expressions into a file named
yuuji@20	2078 @file{yatexhks.el} if you have a lot of codes. YaTeX automatically load
yuuji@20	2079 this file at the initialization of itself. Using @file{yatexhks.el}
yuuji@20	2080 makes @code{yatex-mode-load-hook} unnecessary.
yuuji@20	2081
yuuji@49	2082 @node Add-in functions, Add-in generator, Lisp variables, Customizations
yuuji@20	2083 @comment node-name, next, previous, up
yuuji@20	2084 @section Add-in functions
yuuji@20	2085 @cindex add-in functions
yuuji@49	2086 @cindex yatexadd.el
yuuji@20	2087
yuuji@20	2088 You can easily define a function to input detailed arguments
yuuji@49	2089 with completion according to La@TeX{} environments or commands.
yuuji@20	2090
yuuji@49	2091 @c @node What is add-in functions?, , Add-in functions, Add-in functions
yuuji@49	2092 @comment node-name, next, previous, up
yuuji@49	2093 @subsection What is add-in functions?
yuuji@49	2094 @cindex tabular
yuuji@49	2095
yuuji@49	2096 When you input @code{tabular} environment, don't you think ``I want
yuuji@49	2097 YaTeX to complete its argument toward my favorite one such as
yuuji@49	2098 @code{@{\|c\|c\|c\|@}}...''? Yes, you can define the function to complete
yuuji@49	2099 arguments for any environment and any La@TeX{} commands.
yuuji@49	2100
yuuji@49	2101 @subsection Procedure
yuuji@49	2102
yuuji@49	2103 Here is the procedure to define add-in functions.
yuuji@49	2104 @enumerate
yuuji@49	2105 @item
yuuji@49	2106 Define the function
yuuji@49	2107 @item
yuuji@49	2108 Put the function into @file{yatexhks.el}
yuuji@49	2109 @end enumerate
yuuji@49	2110
yuuji@49	2111 @menu
yuuji@471	2112 * How the add-in function works::
yuuji@471	2113 * How the function is called::
yuuji@471	2114 * Useful functions for creating add-in::
yuuji@471	2115 * Contribution::
yuuji@49	2116 @end menu
yuuji@49	2117
yuuji@58	2118 @node How the add-in function works, How the function is called, Add-in functions, Add-in functions
yuuji@49	2119 @comment node-name, next, previous, up
yuuji@58	2120 @subsection How the add-in function works
yuuji@49	2121
yuuji@79	2122 There are three types of add-in.
yuuji@79	2123
yuuji@79	2124 @enumerate
yuuji@79	2125 @item
yuuji@79	2126 Option add-in
yuuji@79	2127 @item
yuuji@79	2128 argument add-in
yuuji@79	2129 @item
yuuji@79	2130 enclosing add-in
yuuji@79	2131 @end enumerate
yuuji@79	2132
yuuji@79	2133 @dfn{Option add-in} returns the
yuuji@49	2134 La@TeX{}'s optional parameters such as optional strings after
yuuji@49	2135 @code{\begin@{ENV@}}, optional strings between a section-type command
yuuji@49	2136 and its first argument, and optional strings just after type
yuuji@49	2137 maketitle-type command. The following illustrates the name of add-in
yuuji@49	2138 functions, where underlined strings are generated by add-in functions.
yuuji@49	2139
yuuji@49	2140 @display
yuuji@70	2141 \begin@{table@}[ht] (Function name: YaTeX:table)
yuuji@49	2142 ~~~~
yuuji@70	2143 \put(100,200)@{@} (Function name: YaTeX:put)
yuuji@49	2144 ~~~~~~~~~
yuuji@70	2145 \sum_@{i=0@}^@{n@} (Function name: YaTeX:sum)
yuuji@49	2146 ~~~~~~~~~~
yuuji@49	2147 @end display
yuuji@49	2148
yuuji@49	2149 Obviously, the function name is decided by concatenating the prefix
yuuji@49	2150 `YaTeX:' and La@TeX{} command's name.
yuuji@49	2151
yuuji@49	2152 Another add-in type is @dfn{argument add-in}, which completes arguments
yuuji@49	2153 for section-type commands.
yuuji@49	2154
yuuji@49	2155 @display
yuuji@70	2156 \newcommand@{\foo@}@{bar@} (Function name: YaTeX::newcommand)
yuuji@49	2157 ~~~~ ~~~
yuuji@49	2158 @end display
yuuji@49	2159
yuuji@49	2160 When the section-type command is inputted, the function named by
yuuji@49	2161 concatenating `YaTeX::' and section-type command, is called automatically
yuuji@49	2162 with an integer argument which indicates which argument of section-type
yuuji@49	2163 command is being read. Thus the add-in should determine the
yuuji@51	2164 job referring the value of its argument.
yuuji@49	2165
yuuji@79	2166 @dfn{enclosing add-in} is for modifying and/or checking the region that
yuuji@79	2167 will be enclosed by section-type commands via @kbd{[prefix] S}. An
yuuji@79	2168 enclosing add-in function will be called with two arguments, beginning of
yuuji@79	2169 the enclosed region and end of the region. Suppose you want to enclose
yuuji@265	2170 the existing text @code{(a+b)/c} by @code{\frac@{@}}.
yuuji@79	2171
yuuji@79	2172 @display
yuuji@79	2173 a/c
yuuji@79	2174 \| \|
yuuji@79	2175 A B
yuuji@79	2176 @end display
yuuji@79	2177
yuuji@79	2178 You do set-mark-command at point A and then move to point B. Typing
yuuji@79	2179 @kbd{[prefix] S} and input @code{frac} enclose the region like this;
yuuji@79	2180
yuuji@79	2181 @display
yuuji@265	2182 \frac@{a/c@}
yuuji@79	2183 @end display
yuuji@79	2184
yuuji@79	2185 Normally, the expression @code{a/c} is translated to
yuuji@79	2186 @code{\frac@{a@}@{c@}}. An enclosing add-in is useful for modifying
yuuji@79	2187 @code{/} to @code{@}@{}.
yuuji@79	2188
yuuji@49	2189 @menu
yuuji@471	2190 * Defining option-add-in::
yuuji@471	2191 * Defining argument-add-in::
yuuji@471	2192 * Defining enclosing-add-in::
yuuji@49	2193 @end menu
yuuji@49	2194
yuuji@68	2195 @node Defining option-add-in, Defining argument-add-in, How the add-in function works, How the add-in function works
yuuji@49	2196 @comment node-name, next, previous, up
yuuji@49	2197 @subsubsection Defining `option add-in'
yuuji@49	2198
yuuji@49	2199 If you want @code{@{\|c\|c\|c\|@}} for all @code{tabular} environment,
yuuji@49	2200
yuuji@49	2201 @lisp
yuuji@49	2202 (defun YaTeX:tabular ()
yuuji@70	2203 "@{\|c\|c\|c\|@}")
yuuji@49	2204 @end lisp
yuuji@49	2205
yuuji@49	2206 @noindent
yuuji@49	2207 is enough. If you want more complicated format, define as below.
yuuji@49	2208
yuuji@49	2209 @lisp
yuuji@49	2210 (defun YaTeX:tabular ()
yuuji@49	2211 "@{@@@{\\vrule width 1pt\\ @}\|\|\|@@@{\\ \\vrule width 1pt@}@}")
yuuji@49	2212 @end lisp
yuuji@49	2213
yuuji@49	2214 @noindent
yuuji@49	2215 Note that the character @code{\} must be described as @code{\\} in
yuuji@49	2216 Emacs-Lisp. The next example reads the tabular format from keyboard.
yuuji@49	2217 @lisp
yuuji@49	2218 (defun YaTeX:tabular ()
yuuji@70	2219 (concat "@{" (read-string "Rule: ") "@}"))
yuuji@49	2220 @end lisp
yuuji@49	2221
yuuji@79	2222 @node Defining argument-add-in, Defining enclosing-add-in, Defining option-add-in, How the add-in function works
yuuji@49	2223 @comment node-name, next, previous, up
yuuji@49	2224 @subsubsection Defining `argument add-in'
yuuji@49	2225
yuuji@49	2226 This section describes how to define the add-in function for
yuuji@49	2227 @code{\newcommand}.
yuuji@49	2228
yuuji@49	2229 The first argument of @code{\newcommand} begins always with @code{\}.
yuuji@49	2230 The second argument is usually so complex that we can not edit them in the
yuuji@49	2231 minibuffer. Here is the created function considering this.
yuuji@49	2232
yuuji@49	2233 @lisp
yuuji@49	2234 (defun YaTeX::newcommand (n) ;n is argument position
yuuji@49	2235 (cond
yuuji@49	2236 ((= n 1) ;1st argument is macro name
yuuji@49	2237 (read-string "Command: " "\\")) ;initial input `\'
yuuji@49	2238 ((= n 2) "") ;do nothing when reading arg#2
yuuji@49	2239 (t nil)))
yuuji@49	2240 @end lisp
yuuji@49	2241
yuuji@49	2242 Note that when the `argument add-in' function return `nil', normal
yuuji@49	2243 argument reader will be called.
yuuji@49	2244
yuuji@79	2245 @node Defining enclosing-add-in, , Defining argument-add-in, How the add-in function works
yuuji@79	2246 @comment node-name, next, previous, up
yuuji@79	2247 @subsubsection Defining `enclosing add-in'
yuuji@79	2248
yuuji@79	2249 This section describes how to define the add-in function for
yuuji@79	2250 text enclosed by @code{\frac@{@}}.
yuuji@79	2251
yuuji@79	2252 When enclosing the text @code{5/3} by @code{\frac@{@}}, you might want to
yuuji@79	2253 replace @code{/} with @code{@}@{}. Enclosing function
yuuji@79	2254 @code{YaTeX::frac-region} is called with two arguments, beginning of
yuuji@79	2255 enclosed text and end of enclosed text. The function is expected to
yuuji@79	2256 replace @code{/} with @code{@}@{}. Here is an example expression.
yuuji@79	2257
yuuji@79	2258 @lisp
yuuji@79	2259 (defun YaTeX::frac-region (beg end)
yuuji@79	2260 (catch 'done
yuuji@79	2261 (while (search-forward "/" end t)
yuuji@79	2262 (goto-char (match-beginning 0))
yuuji@269	2263 (if (y-or-n-p "Replace this slash(/) with `@}@{'")
yuuji@269	2264 (throw 'done (replace-match "@}@{")))
yuuji@79	2265 (goto-char (match-end 0)))))
yuuji@79	2266 @end lisp
yuuji@79	2267
yuuji@58	2268 @node How the function is called, Useful functions for creating add-in, How the add-in function works, Add-in functions
yuuji@49	2269 @comment node-name, next, previous, up
yuuji@49	2270 @subsection How the function is called
yuuji@49	2271
yuuji@49	2272 YaTeX calls the add-in functions for specified begin-type, section-type,
yuuji@49	2273 and maketitle-type command, if any. `Option add-in' functions for
yuuji@49	2274 begin-type are called when @code{\begin@{ENV@}} has been inserted,
yuuji@49	2275 functions for section-type are called just before input of the first
yuuji@49	2276 argument, and functions for maketitle-type is called after maketitle-type
yuuji@49	2277 command has been inserted. `Argument add-in' functions are called at each
yuuji@49	2278 entry of arguments for section-type commands.
yuuji@49	2279
yuuji@49	2280 @node Useful functions for creating add-in, Contribution, How the function is called, Add-in functions
yuuji@49	2281 @comment node-name, next, previous, up
yuuji@49	2282 @subsection Useful functions for creating add-in
yuuji@49	2283
yuuji@49	2284 Many add-in functions for typical La@TeX{} commands are defined in
yuuji@49	2285 @file{yatexadd.el}. Those are also useful as references. Here are the
yuuji@49	2286 short descriptions on useful functions, where [F] means function, [A]
yuuji@49	2287 means arguments, [D] means description.
yuuji@49	2288
yuuji@69	2289 @table @kbd
yuuji@49	2290 @item [F]
yuuji@49	2291 YaTeX:read-position
yuuji@49	2292 @itemx [A]
yuuji@49	2293 Character list which can show up in the brackets
yuuji@49	2294 @itemx [D]
yuuji@49	2295 Return the location specifier such as `[htb]'. When
yuuji@49	2296 nothing is entered, omit [] itself. If the possible characters
yuuji@49	2297 are "htbp", call this function as
yuuji@49	2298 @code{(YaTeX:read-position "htbp")}
yuuji@49	2299
yuuji@49	2300 @item [F]
yuuji@49	2301 YaTeX:read-coordinates
yuuji@49	2302 @itemx [A]
yuuji@49	2303 Base prompt, X-axis prompt, Y-axis prompt (each optional)
yuuji@49	2304 @itemx [D]
yuuji@51	2305 Read the coordinates with the prompt ``BasePrompt X-axisPrompt:'' for
yuuji@49	2306 X-axis, ``BasePrompt Y-axisPrompt:'' for Y-axis, and return it in the form
yuuji@51	2307 of ``(X,Y)''. The default prompts are @code{Dimension}, @code{X},
yuuji@49	2308 @code{Y} respectively.
yuuji@49	2309
yuuji@49	2310 @item [F]
yuuji@51	2311 YaTeX:check-completion-type
yuuji@49	2312 @itemx [A]
yuuji@49	2313 One of the symbols: 'begin, 'section, or 'maketitle
yuuji@49	2314 @itemx [D]
yuuji@49	2315 Check the current completion type is specified one and cause error if
yuuji@49	2316 not. The variable @code{YaTeX-current-completion-type} holds the symbol
yuuji@49	2317 according to the current completion type.
yuuji@69	2318 @end table
yuuji@49	2319
yuuji@49	2320 @node Contribution, , Useful functions for creating add-in, Add-in functions
yuuji@49	2321 @comment node-name, next, previous, up
yuuji@49	2322 @subsection Contribution
yuuji@49	2323
yuuji@49	2324 If you make your own pretty function and you let it be in public, please
yuuji@49	2325 send me the function. I'm going to include it in the next release.
yuuji@49	2326
yuuji@49	2327 @node Add-in generator, , Add-in functions, Customizations
yuuji@49	2328 @comment node-name, next, previous, up
yuuji@49	2329 @section Add-in generator
yuuji@49	2330
yuuji@49	2331 First, don't forget to read the section of add-in functions @ref{Add-in
yuuji@49	2332 functions}. If you easily understand how to define them, there's no need
yuuji@49	2333 to read this section. But being not familiar with Emacs-Lisp, when you
yuuji@49	2334 don't have clear idea what to do, this section describes how to get YaTeX
yuuji@49	2335 make add-in function.
yuuji@49	2336
yuuji@49	2337 There are two methods of generation. One is for fully interactive
yuuji@49	2338 generator for beginners and another requires little knowledge of
yuuji@49	2339 Emacs-Lisp.
yuuji@49	2340
yuuji@49	2341 @subsection Generator for beginners
yuuji@49	2342 The former generator is called by
yuuji@49	2343 @center @kbd{M-x YaTeX-generate}
yuuji@49	2344
yuuji@49	2345 @noindent
yuuji@49	2346 strokes. All you have to do is follow the guidances. Defying them may cases
yuuji@49	2347 the disaster (I wonder what is it???). So when you make some mistake, it
yuuji@49	2348 is recommendable to type @kbd{C-g} and start afresh.
yuuji@49	2349
yuuji@49	2350 @subsection Simple generator
yuuji@49	2351
yuuji@49	2352 The latter generator is invoked by the next sequence.
yuuji@49	2353 @center @kbd{M-x YaTeX-generate-simple}
yuuji@49	2354 This generator can make both ``option add-in'' and ``argument add-in''
yuuji@49	2355 (@emph{refer the section add-in functions}
yuuji@68	2356 @ref{How the add-in function works}), whereas @code{YaTeX-generate}
yuuji@49	2357 cannot make ``argument addin''.
yuuji@49	2358
yuuji@49	2359 For example, assume you have the LaTeX command as follows.
yuuji@49	2360
yuuji@49	2361 @example
yuuji@70	2362 \epsinput[t](250,50)@{hoge.eps@}@{plain@}@{Picture of foo@}
yuuji@49	2363 (A) (B) (1) (2) (3)
yuuji@49	2364 (A)Optional parameter to specify the position
yuuji@49	2365 One of t(top), b(bottom), l(left), r(right)
yuuji@49	2366 (B)Maximum size of frame
yuuji@49	2367 (1)1st argument is filename of EPS file
yuuji@49	2368 (2)2nd argument indicates
yuuji@49	2369 plain do nothing
yuuji@49	2370 frame make frame around image
yuuji@49	2371 dframe make double-frame around image
yuuji@49	2372 for included EPS file.
yuuji@49	2373 (3)Caption for the picture
yuuji@49	2374 @end example
yuuji@49	2375
yuuji@49	2376 Now get start with generation. Typing @kbd{M-x YaTeX-generate-simple}
yuuji@49	2377 brings the prompt:
yuuji@49	2378 @display
yuuji@49	2379 (O)ption? (A)rgument?
yuuji@49	2380 @end display
yuuji@49	2381
yuuji@49	2382 @subsubsection Generating ``option add-in''
yuuji@49	2383 @cindex option add-in
yuuji@49	2384
yuuji@49	2385 Since (A), (B) above are optional argument, all we have to do to
yuuji@49	2386 complete them is define the option add-in for them. Let's generate the
yuuji@49	2387 function to complete (A).
yuuji@49	2388
yuuji@49	2389 @display
yuuji@49	2390 M-x YaTeX-generate-simple RET
yuuji@49	2391 epsinput RET
yuuji@49	2392 o
yuuji@49	2393 @end display
yuuji@49	2394
yuuji@49	2395 @noindent
yuuji@49	2396 Typing as above leads the next prompt.
yuuji@49	2397
yuuji@49	2398 @display
yuuji@49	2399 Read type(1): (S)tring (C)omplete (F)ile ([)option (P)osition co(O)rd. (q)uit
yuuji@49	2400 @end display
yuuji@49	2401
yuuji@49	2402 @noindent
yuuji@49	2403 This asks that ``Which type is the completion style of 1st argument?''.
yuuji@49	2404 Here are the possible completion style.
yuuji@49	2405
yuuji@49	2406 @table @code
yuuji@49	2407 @item String
yuuji@49	2408 read plain string
yuuji@49	2409 @item Complete
yuuji@49	2410 read with completion
yuuji@49	2411 @item File
yuuji@49	2412 read file name
yuuji@49	2413 @item Option
yuuji@49	2414 read optional string (if string omitted, omit [] too)
yuuji@49	2415 @item Position
yuuji@49	2416 read positional option (like [htbp])
yuuji@49	2417 @item Coord.
yuuji@51	2418 read coordinates
yuuji@49	2419 @item Quit
yuuji@51	2420 quit from generating
yuuji@49	2421 @end table
yuuji@49	2422
yuuji@49	2423 Since (A) is the optional argument to specify the location of included
yuuji@49	2424 EPS file, the completion style is @code{Position}, and the possible
yuuji@49	2425 characters are t, b, l, and r. To tell these information to generator,
yuuji@49	2426 operate as follows.
yuuji@49	2427
yuuji@49	2428 @display
yuuji@49	2429 Read type(1).... p
yuuji@49	2430 Acceptable characters: tblr RET
yuuji@49	2431 @end display
yuuji@49	2432
yuuji@49	2433 (B) is coordinate. So its completion style is coOrd. We want a prompt
yuuji@49	2434 meaning ``Maximum size'' when completion.
yuuji@49	2435
yuuji@49	2436 @display
yuuji@49	2437 Read type(2).... o
yuuji@49	2438 Prompt for coordinates: Max size RET
yuuji@49	2439 @end display
yuuji@49	2440
yuuji@49	2441 That's all for optional argument. Select quit.
yuuji@49	2442
yuuji@49	2443 @display
yuuji@49	2444 Read type(3).... q
yuuji@49	2445 @end display
yuuji@49	2446
yuuji@49	2447 Then the generated option add-in function for \epsinput will be shown in
yuuji@49	2448 the next window.
yuuji@49	2449
yuuji@49	2450 @subsubsection Generating ``argument add-in''
yuuji@49	2451 @cindex argument add-in
yuuji@49	2452
yuuji@49	2453 Next, create the argument add-in. The arguments for \epsinput are EPS
yuuji@49	2454 file name, framing style, and caption string in sequence.
yuuji@49	2455
yuuji@49	2456 @display
yuuji@49	2457 M-x YaTeX-generate-simple RET
yuuji@49	2458 epsinput RET
yuuji@49	2459 a
yuuji@49	2460 @end display
yuuji@49	2461
yuuji@49	2462 Above key strokes bring the prompt that asks the number of argument.
yuuji@49	2463 Answer it with 3.
yuuji@49	2464
yuuji@49	2465 @display
yuuji@49	2466 How many arguments?: 3 RET
yuuji@49	2467 @end display
yuuji@49	2468
yuuji@49	2469 Then the generator asks the completion style and prompt for completion.
yuuji@49	2470 Answer them. @kbd{f} for FileName and prompt string.
yuuji@49	2471
yuuji@49	2472 @display
yuuji@49	2473 Read type(1).... f
yuuji@49	2474 Prompt for argument#1 EPS file name RET
yuuji@49	2475 @end display
yuuji@49	2476
yuuji@49	2477 The second argument is one of selected symbol. So the completion type
yuuji@49	2478 is @code{Completion}.
yuuji@49	2479
yuuji@49	2480 @display
yuuji@49	2481 Read type(2).... c
yuuji@49	2482 Prompt for argument#2 Include style RET
yuuji@49	2483 @end display
yuuji@49	2484
yuuji@49	2485 Then all the candidates ready to be read. Type single RET after
yuuji@49	2486 entering all.
yuuji@49	2487
yuuji@49	2488 @display
yuuji@49	2489 Item[1](RET to exit): plain RET
yuuji@49	2490 Item[2](RET to exit): frame RET
yuuji@49	2491 Item[3](RET to exit): dframe RET
yuuji@49	2492 Item[4](RET to exit): RET
yuuji@49	2493 @end display
yuuji@49	2494
yuuji@49	2495 The following prompt asks whether the entered string must belong to
yuuji@49	2496 candidates or not. In this case, since the argument must be one of
yuuji@49	2497 @code{plain}, @code{frame}, and @code{dframe}, type @code{y}.
yuuji@49	2498
yuuji@49	2499 @display
yuuji@49	2500 Require match? (y or n) y
yuuji@49	2501 @end display
yuuji@49	2502
yuuji@49	2503 The last argument is the caption string for which any completion is
yuuji@49	2504 needed.
yuuji@49	2505
yuuji@49	2506 @display
yuuji@49	2507 Read type(3).... s
yuuji@49	2508 Prompt for argument#3 Caption RET
yuuji@49	2509 default: Figure of RET
yuuji@49	2510 @end display
yuuji@49	2511
yuuji@49	2512 Finally we'll get the argument add-in in the next window.
yuuji@49	2513
yuuji@49	2514 @subsection Contribution
yuuji@49	2515
yuuji@49	2516 If you get your own pretty function and you let it be in public, please
yuuji@51	2517 steel yourself in the happy atmosphere and do not send me the function.
yuuji@49	2518 I do know it is not fine because it is generated by yatexgen:-p.
yuuji@20	2519
yuuji@20	2520 @node Etcetera, Copying, Customizations, Top
yuuji@20	2521 @comment node-name, next, previous, up
yuuji@20	2522 @chapter Etcetera
yuuji@20	2523
yuuji@20	2524 The standard completion tables provided in @file{yatex.el} contain a
yuuji@20	2525 few La@TeX{} commands I frequently use. This is to lessen the key
yuuji@20	2526 strokes to complete entire word, because too many candidates
yuuji@20	2527 rarely used often cause too many hits. Therefore always try to
yuuji@20	2528 use completion in order to enrich your dictionary, and you will
yuuji@20	2529 also find `Wild Bird' growing suitable for your La@TeX{} style.
yuuji@20	2530
yuuji@51	2531 The package name `Wild Bird' is the English translation of Japanese
yuuji@51	2532 title `Yachou', which is a trick on words of Japanese.
yuuji@20	2533
yuuji@20	2534 @node Copying, , Etcetera, Top
yuuji@20	2535 @comment node-name, next, previous, up
yuuji@20	2536 @chapter Copying
yuuji@20	2537
yuuji@80	2538 This program is distributed as a free software. You can
yuuji@80	2539 use/copy/modify/redistribute this software freely but with NO warranty to
yuuji@80	2540 anything as a result of using this software. Adopting code from this
yuuji@80	2541 program is also free. But I would not do contract act.
yuuji@80	2542
yuuji@472	2543 This software can be treated with: ``The 2-Clause BSD License''
yuuji@472	2544 (since 2017-09-09, yatex 1.80).
yuuji@472	2545
yuuji@80	2546 Any reports and suggestions are welcome as long as I feel interests in
yuuji@80	2547 this software. My possible e-mail address is `yuuji@@yatex.org'. (as of
yuuji@472	2548 Sep.2017) And there is mailing list for YaTeX. Although the common
yuuji@80	2549 language is Japanese, questions in English will be welcome. To join the
yuuji@80	2550 ML, send the mail whose subject is `append' to the address
yuuji@80	2551 `yatex@@yatex.org. If you have some question, please ask to
yuuji@80	2552 `yatex-admin@@yatex.org'.
yuuji@20	2553
yuuji@20	2554 The specification of this software will be surely modified
yuuji@20	2555 (depending on my feelings) without notice :-p.
yuuji@20	2556
yuuji@20	2557
yuuji@20	2558 @flushright
yuuji@20	2559 HIROSE Yuuji
yuuji@20	2560 @end flushright
yuuji@20	2561 @bye
yuuji@20	2562
yuuji@20	2563 Local variables:
yuuji@20	2564 mode: texinfo
yuuji@20	2565 fill-prefix: nil
yuuji@20	2566 fill-column: 74
yuuji@20	2567 End: