yatex: docs/yatexe.tex annotate

yatex

annotate docs/yatexe.tex @ 131:bd0a9177e5e7

About [prefix] t e.

author	yuuji@gentei.org
date	Thu, 27 May 2010 20:02:32 +0900
parents	8703f090c628
children	cb4449ecb9f3

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