yatex: docs/yatexe.tex annotate

yatex

annotate docs/yatexe.tex @ 53:5f4b18da14b3

Fix functions relating YaTeX-beginning-of-environment or YaTeX-end-of-environment. Line indentation by TAB much improved. Functions that work at enclosing environments, YaTeX-enclose-<ENVNAME>, introduced. Functions for enclosing verbatim and equations are supplied. SPC, DEL, +, - in YaTeX-hierarchy buffer. Compensate odd highlighting of hilit19.

author	yuuji
date	Thu, 02 Feb 1995 17:18:29 +0000
parents	5d94deabb9f9
children	2d45e43fb35f

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