yatex: docs/yatexe.tex annotate

yatex

annotate docs/yatexe.tex @ 271:d467c0fb6083

Preparing for 1.76 release

author	HIROSE Yuuji <yuuji@gentei.org>
date	Thu, 10 May 2012 11:40:02 +0900
parents	032d4c4bf7ac
children	78d0fdc0459c

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