yatex

annotate docs/yatexe.tex @ 46:cd1b63102eed

find changesets by author, revision, files, or words in the commit message
Support Mule2
author yuuji
date Mon, 19 Sep 1994 16:54:19 +0000
parents 56f7676ed8ca
children a0640ff3f72f
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@20 28 * What is YaTeX?::
yuuji@20 29 * Main features::
yuuji@20 30 * Installation::
yuuji@20 31 * Typesetting::
yuuji@20 32 * %# notation::
yuuji@20 33 * Completion::
yuuji@20 34 * Commenting out::
yuuji@20 35 * Cursor jump::
yuuji@20 36 * Changing and Deleting::
yuuji@20 37 * Filling an item::
yuuji@20 38 * Local dictionaries::
yuuji@20 39 * Updation of @code{\includeonly}::
yuuji@20 40 * What column?::
yuuji@28 41 * Intelligent newline::
yuuji@20 42 * Online help::
yuuji@20 43 * Cooperation with other packages::
yuuji@20 44 * Customizations::
yuuji@20 45 * Etcetera::
yuuji@20 46 * Copying::
yuuji@20 47
yuuji@20 48 --- The Detailed Node Listing ---
yuuji@20 49
yuuji@20 50 %# notation
yuuji@20 51
yuuji@20 52 * Changing typesetter::
yuuji@20 53 * Static region for typesetting::
yuuji@20 54 * Lpr format::
yuuji@20 55 * Editing %# notation::
yuuji@20 56
yuuji@20 57 Completion
yuuji@20 58
yuuji@20 59 * Begin-type completion::
yuuji@20 60 * Section-type completion::
yuuji@20 61 * Large-type completion::
yuuji@20 62 * Maketitle-type completion::
yuuji@20 63 * Arbitrary completion::
yuuji@20 64 * End completion::
yuuji@20 65 * Accent completion::
yuuji@20 66 * Image completion::
yuuji@20 67 * Greek letters completion::
yuuji@20 68
yuuji@20 69 Section-type completion
yuuji@20 70
yuuji@20 71 * view-sectioning::
yuuji@20 72
yuuji@20 73 Customizations
yuuji@20 74
yuuji@20 75 * Lisp variables::
yuuji@20 76 * Add-in functions::
yuuji@20 77
yuuji@20 78 Lisp variables
yuuji@20 79
yuuji@20 80 * All customizable variables::
yuuji@20 81 * Sample definitions::
yuuji@20 82 * Hook variables::
yuuji@20 83 * Hook file::
yuuji@20 84 @end menu
yuuji@20 85
yuuji@20 86 @node What is YaTeX?, Main features, Top, Top
yuuji@20 87 @comment node-name, next, previous, up
yuuji@20 88 @chapter What is YaTeX?
yuuji@20 89
yuuji@20 90 YaTeX automates typesetting and previewing of LaTeX and enables
yuuji@20 91 completing input of LaTeX mark-up command such as
yuuji@20 92 @code{\begin@{@}}..@code{\end@{@}}.
yuuji@20 93
yuuji@20 94 YaTeX also supports Demacs which runs on MS-DOS(386), Mule (Multi
yuuji@20 95 Language Enhancement to GNU Emacs), and latex on DOS.
yuuji@20 96
yuuji@20 97 @node Main features, Installation, What is YaTeX?, Top
yuuji@20 98 @comment node-name, next, previous, up
yuuji@20 99 @chapter Main features
yuuji@20 100
yuuji@20 101 @itemize
yuuji@46 102 @item Invocation of typesetter, previewer and related programs(@kbd{C-c t})
yuuji@20 103 @item Typesetting on static region which is independent from point
yuuji@20 104 @item Semiautomatic replacing of @code{\include only}
yuuji@20 105 @item Jumping to error line(@kbd{C-c '})
yuuji@20 106 @item Completing-read of La@TeX{} commands such as @code{\begin@{@}},
yuuji@20 107 @code{\section} etc.
yuuji@20 108 (@kbd{C-c b}, @kbd{C-c s}, @kbd{C-c l}, @kbd{C-c m})
yuuji@20 109 @item Enclosing text into La@TeX{} environments or commands
yuuji@20 110 (@kbd{C-u} @var{AboveKeyStrokes})
yuuji@20 111 @item Learning unknown/new La@TeX{} commands for the next completion
yuuji@20 112 @item Argument reading with a guide for complicated La@TeX{} commands
yuuji@20 113 @item Generating argument-readers for new/unsupported commands(@file{yatexgen})
yuuji@20 114 @item Quick changing or deleting of La@TeX{} commands(@kbd{C-c c}, @kbd{C-c k})
yuuji@20 115 @item Jumping from and to inter-file, begin<->end, ref<->label(@kbd{C-c g})
yuuji@20 116 @item Blanket commenting out or uncommenting
yuuji@20 117 (@kbd{C-c >}, @kbd{C-c <}, @kbd{C-c ,}, @kbd{C-c .})
yuuji@20 118 @item Easy input of accent mark, math-mode's commands and Greek letters
yuuji@20 119 (@kbd{C-c a}, @kbd{;}, @kbd{/})
yuuji@20 120 @item Online help for the popular La@TeX{} commands
yuuji@20 121 (@kbd{C-c ?}, @kbd{C-c /})(English help is not yet supported)
yuuji@20 122 @end itemize
yuuji@20 123
yuuji@20 124 @node Installation, Typesetting, Main features, Top
yuuji@20 125 @comment node-name, next, previous, up
yuuji@20 126 @chapter Installation
yuuji@20 127 @cindex installation
yuuji@20 128 @cindex .emacs
yuuji@20 129 @cindex auto-mode-alist
yuuji@20 130 @cindex autoload
yuuji@20 131
yuuji@20 132 Put next two expressions into your @file{~/.emacs}.
yuuji@20 133
yuuji@20 134 @lisp
yuuji@20 135 (setq auto-mode-alist
yuuji@46 136 (cons (cons "\\.tex$" 'yatex-mode) auto-mode-alist))
yuuji@20 137 (autoload 'yatex-mode "yatex" "Yet Another La@TeX{} mode" t)
yuuji@20 138 @end lisp
yuuji@20 139
yuuji@20 140 Next, add certain path name where you put files of YaTeX to your
yuuji@20 141 load-path. If you want to put them in @file{~/src/emacs}, write
yuuji@20 142
yuuji@20 143 @lisp
yuuji@20 144 (setq load-path
yuuji@20 145 (cons (expand-file-name "~/src/emacs") load-path))
yuuji@20 146 @end lisp
yuuji@20 147
yuuji@20 148 @noindent
yuuji@20 149 in your @file{~/.emacs}
yuuji@20 150
yuuji@20 151 Then, yatex-mode will be automatically loaded when you visit a
yuuji@20 152 file which has extension @file{.tex}. If yatex-mode is successfully
yuuji@20 153 loaded, mode string on mode line will be turned to "YaTeX".
yuuji@20 154
yuuji@20 155
yuuji@20 156 @node Typesetting, %# notation, Installation, Top
yuuji@20 157 @comment node-name, next, previous, up
yuuji@20 158 @chapter Typesetting
yuuji@20 159 @cindex typesetting
yuuji@20 160 @cindex previewer
yuuji@20 161 @cindex typesetter
yuuji@20 162 @cindex latex
yuuji@20 163 @cindex printing out
yuuji@20 164
yuuji@20 165 The prefix key stroke of yatex-mode is @kbd{C-c} (Press 'C' with Control
yuuji@20 166 key) by default. If you don't intend to change the prefix key stroke,
yuuji@20 167 assume all @kbd{[prefix]} as @kbd{C-c} in this document. These key
yuuji@20 168 strokes execute typeset or preview command.
yuuji@20 169
yuuji@20 170 @table @kbd
yuuji@20 171 @item [prefix] tj
yuuji@46 172 @dots{} invoke latex
yuuji@20 173 @item [prefix] tr
yuuji@46 174 @dots{} invoke latex on region
yuuji@20 175 @item [prefix] tk
yuuji@46 176 @dots{} kill current typesetting process
yuuji@20 177 @item [prefix] tb
yuuji@46 178 @dots{} invoke bibtex
yuuji@20 179 @item [prefix] tp
yuuji@46 180 @dots{} preview
yuuji@20 181 @item [prefix] tl
yuuji@46 182 @dots{} lpr dvi-file
yuuji@20 183 @end table
yuuji@20 184
yuuji@20 185 The current editing window will be divided horizontally when you
yuuji@20 186 invoke latex command, and log message of La@TeX{} typesetting will be
yuuji@20 187 displayed in the other window; called typesetting buffer. The
yuuji@20 188 typesetting buffer automatically scrolls up and traces La@TeX{}
yuuji@20 189 warnings and error messages. If you see latex stopping by an
yuuji@20 190 error, you can send string to latex in the typesetting buffer.
yuuji@20 191
yuuji@20 192 If an error stops the La@TeX{} typesetting, this key stroke will
yuuji@20 193 move the cursor to the line where La@TeX{} error is detected.
yuuji@20 194
yuuji@20 195 @table @kbd
yuuji@20 196 @item [prefix] '
yuuji@20 197 @itemx ([prefix]+single quotation)
yuuji@20 198
yuuji@46 199 @dots{} jump to the previous error or warning
yuuji@20 200 @end table
yuuji@20 201
yuuji@20 202 If you find a noticeable error, move to the typesetting buffer and move
yuuji@20 203 the cursor on the line of error message and type @kbd{SPACE} key. This
yuuji@20 204 makes the cursor move to corresponding source line.
yuuji@20 205
yuuji@20 206 Since @kbd{[prefix] tr} pastes the region into the file
yuuji@20 207 @file{texput.tex} in the current directory, you should be careful of
yuuji@20 208 overwriting. The method of specification of the region is shown in the
yuuji@20 209 section @xref{%#NOTATION}.
yuuji@20 210
yuuji@20 211 The documentstyle for typeset-region is the same as that of editing
yuuji@20 212 file if you edit one file, and is the same as main file's if you
yuuji@20 213 edit splitting files.
yuuji@20 214
yuuji@20 215 YaTeX asks you the range of dvi-printing by default. You can
yuuji@20 216 skip this by invoking it with universal-argument as follows:
yuuji@20 217
yuuji@20 218 @example
yuuji@20 219 C-u [prefix] tl
yuuji@20 220 @end example
yuuji@20 221
yuuji@20 222 @node %# notation, Completion, Typesetting, Top
yuuji@20 223 @comment node-name, next, previous, up
yuuji@20 224 @chapter %# notation
yuuji@20 225 @cindex %# notation
yuuji@20 226
yuuji@20 227 You can control the typesetting process by describing @code{%#}
yuuji@20 228 notations in the source text.
yuuji@20 229
yuuji@20 230 @menu
yuuji@20 231 * Changing typesetter::
yuuji@20 232 * Static region for typesetting::
yuuji@20 233 * Lpr format::
yuuji@20 234 * Editing %# notation::
yuuji@20 235 @end menu
yuuji@20 236
yuuji@33 237 @node Changing typesetter, Static region for typesetting, %# notation, %# notation
yuuji@20 238 @comment node-name, next, previous, up
yuuji@20 239 @section To change the `latex' command or to split a source text.
yuuji@20 240 @cindex typesetter
yuuji@20 241
yuuji@20 242 To change the typesetting command, write
yuuji@20 243
yuuji@20 244 @example
yuuji@46 245 %#!latex-big
yuuji@20 246 @end example
yuuji@20 247
yuuji@20 248 @noindent
yuuji@20 249 anywhere in the source text. And if you split the source text and
yuuji@20 250 edit subfile that should be included from main text.
yuuji@20 251
yuuji@20 252 @example
yuuji@46 253 %#!latex main.tex
yuuji@20 254 @end example
yuuji@20 255
yuuji@20 256 @noindent
yuuji@20 257 will be helpful to execute latex on main file from sub text buffer. Since
yuuji@20 258 this command line after @kbd{%#!} will be sent to shell literally, next
yuuji@20 259 description makes it convenient to use ghostview as dvi-previewer.
yuuji@20 260
yuuji@20 261 @example
yuuji@46 262 %#!latex main ; dvi2ps main.dvi > main
yuuji@20 263 @end example
yuuji@20 264
yuuji@20 265 @noindent
yuuji@20 266 Note that YaTeX assumes the component before the last period of
yuuji@20 267 the last word in this line as base name of the main La@TeX{} source.
yuuji@20 268
yuuji@20 269 Here are the restrictions on splitting sources.
yuuji@20 270
yuuji@20 271 @itemize
yuuji@20 272 @item All the file name should be different.
yuuji@20 273 @item You can put split texts in sub directory, but not in
yuuji@20 274 sub directory of sub directory.
yuuji@20 275 @item In the main text,specify the file with relative path name
yuuji@20 276 such as \include{chap1/sub}, when you include the file in
yuuji@20 277 a sub-directory.
yuuji@20 278 @item In a sub-text, write @code{%#!latex main.tex} even if @file{main.tex}
yuuji@20 279 is in the parent directory(not %#!latex ../main.tex).
yuuji@20 280 @end itemize
yuuji@20 281
yuuji@20 282 @node Static region for typesetting, Lpr format, Changing typesetter, %# notation
yuuji@20 283 @comment node-name, next, previous, up
yuuji@20 284 @section Static region
yuuji@20 285 @cindex static region
yuuji@20 286 @cindex Fixed region
yuuji@20 287
yuuji@20 288 Typeset-region by @kbd{[prefix] tr} passes the region between point and
yuuji@20 289 mark to typesetting command by default. But when you want to typeset
yuuji@20 290 static region, enclose the region by @code{%#BEGIN} and @code{%#END} as
yuuji@20 291 follows.
yuuji@20 292
yuuji@20 293 @example
yuuji@46 294 %#BEGIN
yuuji@46 295 TheRegionYouWantToTypesetManyTimes
yuuji@46 296 %#END
yuuji@20 297 @end example
yuuji@20 298
yuuji@20 299 This is the rule of deciding the region.
yuuji@20 300
yuuji@20 301 @enumerate
yuuji@20 302 @item
yuuji@20 303 If there exists %#BEGIN before point,
yuuji@20 304
yuuji@20 305 @enumerate
yuuji@20 306 @item
yuuji@20 307 If there exists %#END after %#BEGIN,
yuuji@20 308 @itemize
yuuji@20 309 @item From %#BEGIN to %#END.
yuuji@20 310 @end itemize
yuuji@20 311
yuuji@20 312 @item
yuuji@20 313 If %#END does not exist after %#BEGIN,
yuuji@20 314 @itemize
yuuji@20 315 @item From %#BEGIN to the end of buffer.
yuuji@20 316 @end itemize
yuuji@20 317 @end enumerate
yuuji@20 318
yuuji@20 319 @item
yuuji@20 320 If there does not exist %#BEGIN before point,
yuuji@20 321 @itemize
yuuji@20 322 @item Between point and mark(standard method of Emacs).
yuuji@20 323 @end itemize
yuuji@20 324 @end enumerate
yuuji@20 325
yuuji@20 326 It is useful to write @code{%#BEGIN} in the previous line of \begin and
yuuji@20 327 @code{%#END} in the next line of \@code{end} when you try complex
yuuji@20 328 environment such as `tabular' many times. It is also useful to put only
yuuji@20 329 @code{%#BEGIN} alone at the middle of very long text. Do not forget to
yuuji@20 330 erase @code{%#BEGIN} @code{%#END} pair.
yuuji@20 331
yuuji@20 332 @node Lpr format, Editing %# notation, Static region for typesetting, %# notation
yuuji@20 333 @comment node-name, next, previous, up
yuuji@20 334 @section Lpr format
yuuji@20 335 @cindex lpr format
yuuji@20 336
yuuji@20 337 Lpr format is specified by three Lisp variables. Here are the
yuuji@20 338 default values of them.
yuuji@20 339
yuuji@20 340 @table @code
yuuji@20 341 @item (1)dviprint-command-format
yuuji@46 342 @code{"dvi2ps %f %t %s | lpr"}
yuuji@20 343 @item (2)dviprint-from-format
yuuji@46 344 @code{"-f %b"}
yuuji@20 345 @item (3)dviprint-to-format
yuuji@46 346 @code{"-t %e"}
yuuji@20 347 @end table
yuuji@20 348
yuuji@20 349 On YaTeX-lpr, @code{%s} in (1) is replaced by the file name of main
yuuji@20 350 text, @code{%f} by contents of (2), %t by contents of (3). At these
yuuji@20 351 replacements, @code{%b} in (2) is also replaced by the number of beginning
yuuji@20 352 page, @code{%e} in (3) is replaced by the number of ending page. But
yuuji@20 353 @code{%f} and @code{%t} are ignored when you omit the range of print-out
yuuji@20 354 by @kbd{C-u [prefix] tl}.
yuuji@20 355
yuuji@20 356 If you want to change this lpr format temporarily, put a command
yuuji@20 357 such as follows somewhere in the text:
yuuji@20 358
yuuji@20 359 @example
yuuji@46 360 %#LPR dvi2ps %f %t %s | 4up -page 4 | texfix | lpr -Plp2
yuuji@20 361 @end example
yuuji@20 362
yuuji@20 363 And if you want YaTeX not to ask you the range of printing
yuuji@20 364 out, the next example may be helpful.
yuuji@20 365
yuuji@20 366 @example
yuuji@46 367 %#LPR dvi2ps %s | lpr
yuuji@20 368 @end example
yuuji@20 369
yuuji@20 370 @node Editing %# notation, , Lpr format, %# notation
yuuji@20 371 @comment node-name, next, previous, up
yuuji@20 372 @section Editing %# notation
yuuji@20 373
yuuji@20 374 To edit @code{%#} notation described above, type
yuuji@20 375
yuuji@20 376 @table @kbd
yuuji@20 377 @item [prefix] %
yuuji@46 378 @dots{} editing %# notation menu
yuuji@20 379 @end table
yuuji@20 380
yuuji@20 381 @noindent
yuuji@20 382 and select one of the entry of the menu as follows.
yuuji@20 383
yuuji@20 384 @example
yuuji@46 385 !)Edit-%#! B)EGIN-END-region L)Edit-%#LPR
yuuji@20 386 @end example
yuuji@20 387
yuuji@20 388 @noindent
yuuji@20 389 Type @kbd{!} to edit @code{%#!} entry, @code{b} to enclose the region with
yuuji@20 390 @code{%#BEGIN} and @code{%#END}, and @code{l} to edit @code{%#LPR} entry.
yuuji@20 391 When you type @kbd{b}, all @code{%#BEGIN} and @code{%#END} are
yuuji@20 392 automatically erased.
yuuji@20 393
yuuji@20 394 @node Completion, Commenting out, %# notation, Top
yuuji@20 395 @comment node-name, next, previous, up
yuuji@20 396 @chapter Completion
yuuji@20 397 @cindex completion
yuuji@20 398
yuuji@20 399 YaTeX makes it easy to input the La@TeX{} commands. There are several
yuuji@20 400 kinds of completion type, begin-type, section-type, large-type, etc...
yuuji@20 401
yuuji@20 402 @menu
yuuji@20 403 * Begin-type completion::
yuuji@20 404 * Section-type completion::
yuuji@20 405 * Large-type completion::
yuuji@20 406 * Maketitle-type completion::
yuuji@20 407 * Arbitrary completion::
yuuji@20 408 * End completion::
yuuji@20 409 * Accent completion::
yuuji@20 410 * Image completion::
yuuji@20 411 * Greek letters completion::
yuuji@20 412 @end menu
yuuji@20 413
yuuji@33 414 @node Begin-type completion, Section-type completion, Completion, Completion
yuuji@20 415 @comment node-name, next, previous, up
yuuji@20 416 @section Begin-type completion
yuuji@20 417 @cindex begin-type completion
yuuji@20 418 @cindex environment
yuuji@20 419 @cindex prefix b
yuuji@20 420
yuuji@20 421 "Begin-type completion" completes commands of @code{\begin@{env@}} ...
yuuji@20 422 @code{\end@{env@}}. All of the begin-type completions begin with this key
yuuji@20 423 sequence.
yuuji@20 424
yuuji@20 425 @table @kbd
yuuji@20 426 @item [prefix] b
yuuji@46 427 @dots{} start begin-type completion
yuuji@20 428 @end table
yuuji@20 429
yuuji@20 430 @noindent
yuuji@20 431 An additional key stroke immediately completes a frequently used
yuuji@20 432 La@TeX{} @code{\begin@{@}}...@code{\@code{end}@{@}} environment.
yuuji@20 433
yuuji@20 434 @table @kbd
yuuji@20 435 @item [prefix] b c
yuuji@46 436 @dots{} @code{\begin@{center@}...\end@{center@}}
yuuji@20 437 @item [prefix] b d
yuuji@46 438 @dots{} @code{\begin@{document@}...\end@{document@}}
yuuji@20 439 @item [prefix] b D
yuuji@46 440 @dots{} @code{\begin@{description@}...\end@{description@}}
yuuji@20 441 @item [prefix] b e
yuuji@46 442 @dots{} @code{\begin@{enumerate@}...\end@{enumerate@}}
yuuji@20 443 @item [prefix] b E
yuuji@46 444 @dots{} @code{\begin@{equation@}...\end@{equation@}}
yuuji@20 445 @item [prefix] b i
yuuji@46 446 @dots{} @code{\begin@{itemize@}...\end@{itemize@}}
yuuji@20 447 @item [prefix] b l
yuuji@46 448 @dots{} @code{\begin@{flushleft@}...\end@{flushleft@}}
yuuji@20 449 @item [prefix] b m
yuuji@46 450 @dots{} @code{\begin@{minipage@}...\end@{minipage@}}
yuuji@20 451 @item [prefix] b t
yuuji@46 452 @dots{} @code{\begin@{tabbing@}...\end@{tabbing@}}
yuuji@20 453 @item [prefix] b T
yuuji@46 454 @dots{} @code{\begin@{tabular@}...\end@{tabular@}}
yuuji@20 455 @item [prefix] b^T
yuuji@46 456 @dots{} @code{\begin@{table@}...\end@{table@}}
yuuji@20 457 @item [prefix] b p
yuuji@46 458 @dots{} @code{\begin@{picture@}...\end@{picture@}}
yuuji@20 459 @item [prefix] b q
yuuji@46 460 @dots{} @code{\begin@{quote@}...\end@{quote@}}
yuuji@20 461 @item [prefix] b Q
yuuji@46 462 @dots{} @code{\begin@{quotation@}...\end@{quotation@}}
yuuji@20 463 @item [prefix] b r
yuuji@46 464 @dots{} @code{\begin@{flushright@}...\end@{flushright@}}
yuuji@20 465 @item [prefix] b v
yuuji@46 466 @dots{} @code{\begin@{verbatim@}...\end@{verbatim@}}
yuuji@20 467 @item [prefix] b V
yuuji@46 468 @dots{} @code{\begin@{verse@}...\end@{verse@}}
yuuji@20 469 @end table
yuuji@20 470
yuuji@20 471 Any other La@TeX{} environments are made by completing-read of the
yuuji@20 472 Emacs function.
yuuji@20 473
yuuji@20 474 @table @kbd
yuuji@20 475 @item [prefix] b SPACE
yuuji@46 476 @dots{} begin-type completion
yuuji@20 477 @end table
yuuji@20 478
yuuji@20 479 @noindent
yuuji@20 480 The next message will show up in the minibuffer
yuuji@20 481
yuuji@20 482 @example
yuuji@46 483 Begin environment(default document):
yuuji@20 484 @end example
yuuji@20 485
yuuji@20 486 @noindent
yuuji@20 487 by typing @kbd{[prefix] b}. Put the wishing environment with completion
yuuji@20 488 in the minibuffer, and @code{\begin@{env@}}...\@code{\end@{env@}} will be
yuuji@20 489 inserted in the La@TeX{} source text. If the environment you want to put
yuuji@20 490 does not exist in the YaTeX completion table, it will be registered in the
yuuji@20 491 user completion table. YaTeX automatically saves the user completion
yuuji@20 492 table in the user dictionary file at exiting of emacs.
yuuji@20 493
yuuji@20 494 If you want to enclose some paragraphs which have already been
yuuji@20 495 written, invoke the begin-type completion with changing the case
yuuji@20 496 of @kbd{b} of key sequence upper(or invoke it with universal argument
yuuji@20 497 by @kbd{C-u} prefix).
yuuji@20 498 @cindex enclose region into environment
yuuji@20 499
yuuji@20 500 The following example encloses a region with `description'
yuuji@20 501 environment.
yuuji@20 502
yuuji@20 503 @table @kbd
yuuji@20 504 @item [prefix] B D
yuuji@20 505 @itemx (or ESC 1 [prefix] b D)
yuuji@20 506 @itemx (or C-u [prefix] b D)
yuuji@20 507
yuuji@46 508 @dots{} begin-type completion for region
yuuji@20 509 @end table
yuuji@20 510
yuuji@20 511 This enclosing holds good for the completing input by @kbd{[prefix] b
yuuji@20 512 SPC}. @kbd{[prefix] B SPC} enclose a region with the environment selected
yuuji@20 513 by completing-read.
yuuji@20 514
yuuji@20 515 @node Section-type completion, Large-type completion, Begin-type completion, Completion
yuuji@20 516 @comment node-name, next, previous, up
yuuji@20 517 @section Section-type completion
yuuji@20 518 @cindex section-type completion
yuuji@20 519 @cindex prefix s
yuuji@20 520
yuuji@20 521 "Section-type completion" completes section-type commands which take an
yuuji@20 522 argument or more such as @code{\section@{foo@}}. To invoke section-type
yuuji@20 523 completion, type
yuuji@20 524
yuuji@20 525 @table @kbd
yuuji@20 526 @item [prefix] s
yuuji@46 527 @dots{} section-type completion
yuuji@20 528 @end table
yuuji@20 529
yuuji@20 530 @noindent
yuuji@20 531 then the prompt
yuuji@20 532
yuuji@20 533 @example
yuuji@46 534 (C-v for view) \???@{@} (default documentstyle):
yuuji@20 535 @end example
yuuji@20 536
yuuji@20 537 @noindent
yuuji@20 538 will show up in the minibuffer. Section-type La@TeX{} commands are
yuuji@20 539 completed by space key, and the default value is selected when you
yuuji@20 540 type nothing in the minibuffer.
yuuji@20 541
yuuji@20 542 Next,
yuuji@20 543
yuuji@20 544 @example
yuuji@46 545 \section@{???@}:
yuuji@20 546 @end example
yuuji@20 547
yuuji@20 548 @noindent
yuuji@20 549 prompts you the argument of section-type La@TeX{} command. For
yuuji@20 550 example, the following inputs
yuuji@20 551
yuuji@20 552 @example
yuuji@46 553 \???@{@} (default documentstyle): section
yuuji@46 554 \section{???}: Hello world.
yuuji@20 555 @end example
yuuji@20 556
yuuji@20 557 @noindent
yuuji@20 558 will insert the string
yuuji@20 559
yuuji@20 560 @example
yuuji@46 561 \section@{Hello world.@}
yuuji@20 562 @end example
yuuji@20 563
yuuji@20 564 in your La@TeX{} source. When you neglect argument such as
yuuji@20 565
yuuji@20 566 @example
yuuji@46 567 (C-v for view) \???@{@} (default section): vspace*
yuuji@46 568 \vspace*@{???@}:
yuuji@20 569 @end example
yuuji@20 570
yuuji@20 571 YaTeX puts
yuuji@20 572
yuuji@20 573 @example
yuuji@46 574 \vspace*@{@}
yuuji@20 575 @end example
yuuji@20 576
yuuji@20 577 @noindent
yuuji@20 578 and move the cursor in the braces.
yuuji@20 579
yuuji@20 580 In La@TeX{} command, there are commands which take more than one
yuuji@20 581 arguments such as @code{\addtolength{\topmargin}{8mm}}. To complete these
yuuji@20 582 commands, invoke section-type completion with universal argument as,
yuuji@20 583 @cindex number of argument
yuuji@20 584
yuuji@20 585 @example
yuuji@20 586 C-u 2 [prefix] s (or ESC 2 [prefix] s)
yuuji@20 587 @end example
yuuji@20 588
yuuji@20 589 @noindent
yuuji@20 590 and make answers in minibuffer like this.
yuuji@20 591
yuuji@20 592 @example
yuuji@46 593 (C-v for view) \???@{@} (default vspace*): addtolength
yuuji@46 594 \addtolength@{???@}: \topmargin
yuuji@46 595 Argument 2: 8mm
yuuji@20 596 @end example
yuuji@20 597
yuuji@20 598 @code{\addtolength} and the first argument @code{\topmargin} can be typed
yuuji@20 599 easily by completing read. Since YaTeX also learns the number of
yuuji@20 600 arguments of section-type command and will ask that many arguments in
yuuji@20 601 future completion, you had better tell the number of arguments to YaTeX at
yuuji@20 602 the first completion of the new word. But you can change the number of
yuuji@20 603 arguments by calling the completion with different universal argument
yuuji@20 604 again.
yuuji@20 605
yuuji@20 606 The special number of argument 0 makes YaTeX use read-string to
yuuji@20 607 read the first argument instead of completing-read. It is more
yuuji@20 608 comfortable to enter first argument without completion when you
yuuji@20 609 put section title which contains space character. Normally, such
yuuji@20 610 sectioning commands as chapter, section, paragraph..., have
yuuji@20 611 argument 0 in the completion table.
yuuji@20 612
yuuji@20 613 Invoking section-type completion with @code{[Prefix] S} (Capital `S')
yuuji@20 614 includes the region as the first argument of section-type command.
yuuji@20 615
yuuji@20 616 The section/large/maketitle type completion can work at the
yuuji@20 617 prompt for the argument of other section-type completion.
yuuji@20 618 Nested La@TeX{} commands are efficiently read with the recursive
yuuji@20 619 completion by typing YaTeX's completion key sequence in the
yuuji@20 620 minibuffer.
yuuji@20 621
yuuji@20 622 @menu
yuuji@20 623 * view-sectioning::
yuuji@20 624 @end menu
yuuji@20 625
yuuji@33 626 @node view-sectioning, , Section-type completion, Section-type completion
yuuji@20 627 @comment node-name, next, previous, up
yuuji@20 628 @subsection view-sectioning
yuuji@20 629 @cindex view sectioning
yuuji@20 630 @cindex outline
yuuji@20 631
yuuji@20 632 In the minibuffer at the prompt of section-type command completion,
yuuji@20 633 typing @kbd{C-v} shows a list of sectioning commands in source text(The
yuuji@20 634 line with @code{<<--} mark is the nearest sectioning command). Then,
yuuji@20 635 default sectioning command appears in the minibuffer. You can go up/down
yuuji@20 636 sectioning command by typing @kbd{C-p}/@kbd{C-n}, can scrolls up/down the
yuuji@20 637 listing buffer by @kbd{C-v}/@kbd{M-v}, and can hide sectioning commands
yuuji@20 638 under certain level by 0 through 6. Type @kbd{?} in the minibuffer of
yuuji@20 639 sectioning prompt for more information.
yuuji@20 640
yuuji@20 641 @node Large-type completion, Maketitle-type completion, Section-type completion, Completion
yuuji@20 642 @comment node-name, next, previous, up
yuuji@20 643 @section Large-type completion
yuuji@20 644
yuuji@20 645 "Large-type completion" inputs the font or size changing
yuuji@20 646 descriptions such as @code{@{\large @}}. When you type
yuuji@20 647
yuuji@20 648 @table @kbd
yuuji@20 649 @item [prefix] l
yuuji@46 650 @dots{} large-type completion
yuuji@20 651 @end table
yuuji@20 652
yuuji@20 653 @noindent
yuuji@20 654 the message in the minibuffer
yuuji@20 655
yuuji@20 656 @example
yuuji@46 657 @{\??? @} (default large):
yuuji@20 658 @end example
yuuji@20 659
yuuji@20 660 prompts prompts you large-type command with completing-read. There are
yuuji@20 661 TeX commands to change fonts or sizes, @code{it}, @code{huge} and so on,
yuuji@20 662 in the completion table.
yuuji@20 663
yuuji@20 664 Region-based completion is also invoked by changing the letter after
yuuji@20 665 prefix key stroke as @kbd{[prefix] L}. It encloses the region by braces
yuuji@20 666 with large-type command.
yuuji@20 667
yuuji@20 668 @node Maketitle-type completion, Arbitrary completion, Large-type completion, Completion
yuuji@20 669 @comment node-name, next, previous, up
yuuji@20 670 @section Maketitle-type completion
yuuji@20 671 @cindex maketitle-type completion
yuuji@20 672
yuuji@20 673 We call it "maketitle-type completion" which completes commands such as
yuuji@20 674 @code{\maketitle}. Take notice that maketitle-type commands take no
yuuji@20 675 arguments. Then, typing
yuuji@20 676
yuuji@20 677 @table @kbd
yuuji@20 678 @item [prefix] m
yuuji@46 679 @dots{} maketitle-type completion
yuuji@20 680 @end table
yuuji@20 681
yuuji@20 682 @noindent
yuuji@20 683 begins maketitle-completion. Above mentioned method is true for
yuuji@20 684 maketitle-completion, and there are La@TeX{} commands with no
yuuji@20 685 arguments in completion table.
yuuji@20 686
yuuji@20 687 @node Arbitrary completion, End completion, Maketitle-type completion, Completion
yuuji@20 688 @comment node-name, next, previous, up
yuuji@20 689 @section Arbitrary completion
yuuji@20 690 @cindex arbitrary completion
yuuji@20 691
yuuji@20 692 @noindent
yuuji@20 693 You can complete certain La@TeX{} command anywhere without typical
yuuji@20 694 completing method as described, by typing
yuuji@20 695
yuuji@20 696 @table @kbd
yuuji@20 697 @item [prefix] SPC
yuuji@46 698 @dots{} arbitrary completion
yuuji@20 699 @end table
yuuji@20 700
yuuji@20 701 @noindent
yuuji@20 702 after the initial string of La@TeX{} command that is preceded by @code{\}.
yuuji@20 703
yuuji@20 704 @node End completion, Accent completion, Arbitrary completion, Completion
yuuji@20 705 @comment node-name, next, previous, up
yuuji@20 706 @section End completion
yuuji@20 707 @cindex end completion
yuuji@20 708
yuuji@20 709 @noindent
yuuji@20 710 YaTeX automatically detects the opened environment and close it with
yuuji@20 711 \@code{\end@{environment@}}. Though proficient YaTeX users never fail to
yuuji@20 712 make environment with begin-type completion, some may begin an environment
yuuji@20 713 manually. In that case, type
yuuji@20 714
yuuji@20 715 @table @kbd
yuuji@20 716 @item [prefix] e
yuuji@46 717 @dots{} @code{end} completion
yuuji@20 718 @end table
yuuji@20 719
yuuji@20 720 @noindent
yuuji@20 721 at the end of the opened environment.
yuuji@20 722
yuuji@20 723 @node Accent completion, Image completion, End completion, Completion
yuuji@20 724 @comment node-name, next, previous, up
yuuji@20 725 @section Accent completion
yuuji@20 726 @cindex accent completion
yuuji@20 727
yuuji@20 728 When you want to write the European accent marks(like @code{\`@{o@}}),
yuuji@20 729
yuuji@20 730 @table @kbd
yuuji@20 731 @item [prefix] a
yuuji@46 732 @dots{} accent completion
yuuji@20 733 @end table
yuuji@20 734
yuuji@20 735 @noindent
yuuji@20 736 shows the menu
yuuji@20 737
yuuji@20 738 @example
yuuji@46 739 1:` 2:' 3:^ 4:" 5:~ 6:= 7:. u v H t c d b
yuuji@20 740 @end example
yuuji@20 741
yuuji@20 742 @noindent
yuuji@20 743 in the minibuffer. Chose one character or corresponding numeric,
yuuji@20 744 and you will see
yuuji@20 745
yuuji@20 746 @example
yuuji@46 747 \`{}
yuuji@20 748 @end example
yuuji@20 749
yuuji@20 750 @noindent
yuuji@20 751 in the editing buffer with the cursor positioned in braces. Type
yuuji@20 752 one more character `o' for example, then
yuuji@20 753
yuuji@20 754 @example
yuuji@46 755 \`{o}
yuuji@20 756 @end example
yuuji@20 757
yuuji@20 758 @noindent
yuuji@20 759 will be completed, and the cursor gets out from braces.
yuuji@20 760
yuuji@20 761 @node Image completion, Greek letters completion, Accent completion, Completion
yuuji@20 762 @comment node-name, next, previous, up
yuuji@20 763 @section Image completion of mathematical sign
yuuji@20 764 @cindex image completion
yuuji@20 765 @cindex math-mode
yuuji@20 766 @cindex sigma
yuuji@20 767 @cindex leftarrow
yuuji@20 768 @cindex ;
yuuji@20 769
yuuji@20 770 Arrow marks, sigma mark and those signs mainly used in the
yuuji@20 771 TeX's math environment are completed by key sequences which
yuuji@20 772 imitate the corresponding symbols graphically. This completion
yuuji@20 773 only works in the math environment. YaTeX automatically detects
yuuji@20 774 whether the cursor located in math environment or not, and
yuuji@20 775 change the behavior of key strokes @kbd{;} and @kbd{/}.
yuuji@20 776
yuuji@20 777 By the way, we often express the leftarrow mark by `<-' for example.
yuuji@20 778 Considering such image, you can write @code{\leftarrow} by typing @kbd{<-}
yuuji@20 779 after @kbd{;} (semicolon) as a prefix. In the same way,
yuuji@20 780 @code{\longleftarrow} (@code{<--}) is completed by typing @kbd{;<--},
yuuji@20 781 infinity mark which is imitated by @code{oo} is completed by typing
yuuji@20 782 @kbd{;oo}.
yuuji@20 783
yuuji@20 784 Here are the sample operations in YaTeX math-mode.
yuuji@20 785
yuuji@20 786 @example
yuuji@20 787 INPUT Completed La@TeX{} commands
yuuji@20 788 ; < - @code{\leftarrow}
yuuji@20 789 ; < - - @code{\longleftarrow}
yuuji@20 790 ; < - - > @code{\longleftrightarrow}
yuuji@20 791 ; o @code{\circ}
yuuji@20 792 ; o o @code{\infty}
yuuji@20 793 @end example
yuuji@20 794
yuuji@20 795 In any case, you can quit from image completion and can move
yuuji@20 796 to the next editing operation if the La@TeX{} command you want is
yuuji@20 797 shown in the buffer.
yuuji@20 798
yuuji@20 799 @code{;} itself in math-environment is inserted by @kbd{;;}. Typing
yuuji@20 800 @kbd{TAB} in the midst of image completion shows all of the La@TeX{}
yuuji@20 801 commands that start with the same name as string you previously typed in.
yuuji@20 802 In this menu buffer, press @kbd{RET} after moving the cursor (by @kbd{n},
yuuji@20 803 @kbd{p}, @kbd{b}, @kbd{f}) to insert the La@TeX{} command.
yuuji@20 804
yuuji@20 805 To know all of the completion table, type @kbd{TAB} just after @kbd{;}.
yuuji@20 806 And here is the sample menu by @kbd{TAB} after @kbd{;<}.
yuuji@20 807
yuuji@20 808 @example
yuuji@20 809 KEY LaTeX sequence sign
yuuji@20 810 < \leq <
yuuji@20 811 ~
yuuji@20 812 << \ll <<
yuuji@20 813 <- \leftarrow <-
yuuji@20 814 <= \Leftarrow <=
yuuji@20 815 @end example
yuuji@20 816
yuuji@20 817 You can define your favorite key-vs-sequence completion table in the
yuuji@20 818 Emacs-Lisp variable @code{YaTeX-math-sign-alist-private}. See also
yuuji@20 819 @file{yatexmth.el} for the information of the structure of this variable.
yuuji@20 820
yuuji@20 821 @node Greek letters completion, , Image completion, Completion
yuuji@20 822 @comment node-name, next, previous, up
yuuji@20 823 @section Greek letters completion
yuuji@20 824 @cindex Greek letters completion
yuuji@20 825 @cindex /
yuuji@20 826
yuuji@20 827 Math-mode of YaTeX provides another image completion, Greek letters
yuuji@20 828 completion in the same method. After prefix @kbd{/}, typing @kbd{a} makes
yuuji@20 829 @code{\alpha}, @kbd{b} makes @code{\beta} and @kbd{g} makes @code{\gamma}
yuuji@20 830 and so on. First, type @kbd{/TAB} to know all the correspondence of
yuuji@20 831 alphabets v.s. Greek letters.
yuuji@20 832
yuuji@20 833 If you will find @kbd{;} or @kbd{/} doesn't work in correct position of
yuuji@20 834 math environment, it may be a bug of YaTeX. Please send me a bug report
yuuji@20 835 with the configuration of your text, and avoid it temporarily by typing
yuuji@20 836 @kbd{;} or @kbd{/} after universal-argument(@kbd{C-u}) which forces
yuuji@20 837 @kbd{;} and @kbd{/} to work as math-prefix.
yuuji@20 838
yuuji@20 839 @node Commenting out, Cursor jump, Completion, Top
yuuji@20 840 @comment node-name, next, previous, up
yuuji@20 841 @chapter Commenting out
yuuji@20 842 @cindex commenting out
yuuji@20 843 @cindex prefix >
yuuji@20 844 @cindex prefix <
yuuji@20 845 @cindex prefix ,
yuuji@20 846 @cindex prefix .
yuuji@20 847
yuuji@20 848 You may want to comment out some region.
yuuji@20 849
yuuji@20 850 @table @kbd
yuuji@20 851 @item [prefix] >
yuuji@46 852 @dots{} comment out region by %
yuuji@20 853 @item [prefix] <
yuuji@46 854 @dots{} uncomment region
yuuji@20 855 @end table
yuuji@20 856
yuuji@20 857 @noindent
yuuji@20 858 cause an operation to the region between point and mark.
yuuji@20 859
yuuji@20 860 @table @kbd
yuuji@20 861 @item [prefix] .
yuuji@46 862 @dots{} comment out current paragraph
yuuji@20 863 @item [prefix] ,
yuuji@46 864 @dots{} uncomment current paragraph
yuuji@20 865 @end table
yuuji@20 866
yuuji@20 867 @noindent
yuuji@20 868 comments or uncomments the paragraph where the cursor belongs.
yuuji@20 869 This `paragraph' means the region marked by the function
yuuji@20 870 mark-paragraph, bound to @kbd{ESC h} by default. It is NOT
yuuji@20 871 predictable what will happen when you continuously comment out
yuuji@20 872 some paragraph many times.
yuuji@20 873
yuuji@20 874 You can also comment out an environment between @code{\begin} and
yuuji@20 875 @code{\end}, or a @code{\begin}-\@code{\end} pair themselves, by making the
yuuji@20 876 following key strokes on the line where @code{\begin@{@}} or
yuuji@20 877 @code{\end@{@}} exists.
yuuji@20 878
yuuji@20 879 @table @kbd
yuuji@20 880 @item [prefix] >
yuuji@46 881 @dots{} comment out from \begin to \@code{end}
yuuji@20 882 @item [prefix] <
yuuji@46 883 @dots{} uncomment from \begin to \@code{end}
yuuji@20 884 @end table
yuuji@20 885
yuuji@20 886 @noindent
yuuji@20 887 comment whole the contents of environment. Moreover,
yuuji@20 888
yuuji@20 889 @table @kbd
yuuji@20 890 @item [prefix] .
yuuji@46 891 @dots{} comment out \begin and \@code{end}
yuuji@20 892 @item [prefix] ,
yuuji@46 893 @dots{} uncomment \begin and \@code{end}
yuuji@20 894 @end table
yuuji@20 895
yuuji@20 896 @noindent
yuuji@20 897 (un)comments out only environment declaration: @code{\begin@{@}} and
yuuji@20 898 @code{\end@{@}}. NOTE that even if you intend to comment out some region,
yuuji@20 899 invoking @kbd{[prefix] >} on the @code{\begin},@code{\end} line decides to
yuuji@20 900 work in `commenting out from @code{\begin} to @code{\end}' mode.
yuuji@20 901
yuuji@20 902
yuuji@20 903 @node Cursor jump, Changing and Deleting, Commenting out, Top
yuuji@20 904 @comment node-name, next, previous, up
yuuji@20 905 @chapter Cursor jump
yuuji@20 906 @cindex cursor jump
yuuji@20 907 @cindex prefix g
yuuji@20 908
yuuji@20 909 On a @code{\begin},@code{\end} line, the key stroke
yuuji@20 910
yuuji@20 911 @table @kbd
yuuji@20 912 @item [prefix] g
yuuji@46 913 @dots{} go to corresponding object
yuuji@20 914 @end table
yuuji@20 915
yuuji@20 916 @noindent
yuuji@20 917 moves the cursor to the corresponding @code{\end},@code{\begin} line, if
yuuji@20 918 its partner really exists. It is also applicable to A @code{%#BEGIN} and
yuuji@20 919 @code{%#END} pair.
yuuji@20 920
yuuji@20 921 If you type @code{[prefix] g} on the line of @code{\include@{chap1@}},
yuuji@46 922 maybe in main text, YaTeX switches buffer to @file{chap1.tex}. On the
yuuji@20 923 contrary, the key strokes
yuuji@20 924
yuuji@20 925 @table @kbd
yuuji@20 926 @item [prefix] ^
yuuji@46 927 @dots{} visit main file
yuuji@20 928 @item [prefix] 4^
yuuji@46 929 @dots{} visit main file in other buffer
yuuji@20 930 @end table
yuuji@20 931 @cindex prefix ^
yuuji@20 932 @cindex prefix 4 ^
yuuji@20 933
yuuji@20 934 in a sub text switch the buffer to the main text specified by
yuuji@20 935 @code{%#!} notation.
yuuji@20 936
yuuji@20 937 And these are the functions which work on the current La@TeX{}
yuuji@20 938 environment:
yuuji@20 939
yuuji@20 940 @table @kbd
yuuji@20 941 @item M-C-a
yuuji@46 942 @dots{} beginning of environment
yuuji@20 943 @item M-C-e
yuuji@46 944 @dots{} @code{end} of environment
yuuji@20 945 @item M-C-@@
yuuji@46 946 @dots{} mark environment
yuuji@20 947 @end table
yuuji@20 948 @cindex M-C-a
yuuji@20 949 @cindex M-C-e
yuuji@20 950 @cindex M-C-@@
yuuji@20 951
yuuji@20 952 @node Changing and Deleting, Filling an item, Cursor jump, Top
yuuji@20 953 @comment node-name, next, previous, up
yuuji@20 954 @chapter Changing and Deleting
yuuji@20 955
yuuji@20 956 These functions are for change or deletion of La@TeX{} commands
yuuji@20 957 already entered.
yuuji@20 958
yuuji@20 959 @table @kbd
yuuji@20 960 @item [prefix] c
yuuji@46 961 @dots{} change La@TeX{} command
yuuji@20 962 @item [prefix] k
yuuji@46 963 @dots{} kill La@TeX{} command
yuuji@20 964 @end table
yuuji@20 965 @cindex prefix c
yuuji@20 966 @cindex prefix k
yuuji@20 967
yuuji@20 968 @kbd{[prefix] c} can change the name of the corresponding environment
yuuji@20 969 declaration. @kbd{[prefix] k} works as follows:
yuuji@20 970
yuuji@20 971 @example
yuuji@20 972 [Invoking position] [action]
yuuji@20 973 \begin,\end line kill \begin,\end pairs
yuuji@20 974 %BEGIN, %END line kill %BEGIN,%END pairs
yuuji@20 975 on a Section-type command kill section-type command
yuuji@20 976 on a parenthesis kill parentheses
yuuji@20 977 @end example
yuuji@20 978
yuuji@20 979 While all operations above are to kill `containers' which surround some
yuuji@20 980 text, universal argument (@kbd{C-u}) for these commands kills not only
yuuji@20 981 `containers' but also `contents' of them. See below as a sample.
yuuji@20 982
yuuji@20 983 @example
yuuji@46 984 Original text: [prefix] k C-u [prefix] k
yuuji@46 985 Main \footnote@{note@} here. Main note here. Main here.
yuuji@20 986 ~(cursor)
yuuji@20 987 @end example
yuuji@20 988
yuuji@20 989 @node Filling an item, Local dictionaries, Changing and Deleting, Top
yuuji@20 990 @comment node-name, next, previous, up
yuuji@20 991 @chapter Filling an item
yuuji@20 992 @cindex filling an item
yuuji@20 993 @cindex prefix i
yuuji@20 994
yuuji@20 995 To fill a term (sentence) of @code{\item}, type
yuuji@20 996
yuuji@20 997 @table @kbd
yuuji@20 998 @item [prefix] i
yuuji@46 999 @dots{} fill item
yuuji@20 1000 @end table
yuuji@20 1001
yuuji@20 1002 @noindent
yuuji@20 1003 on that item.
yuuji@20 1004
yuuji@20 1005 YaTeX uses the value of the variable @code{YaTeX-item-regexp} as the
yuuji@20 1006 regular expression to search item header in itemize environment.
yuuji@20 1007 If you make a newcommand to itemize terms(eg. @code{\underlineitem}), put
yuuji@20 1008
yuuji@20 1009 @lisp
yuuji@46 1010 (setq YaTeX-item-regexp
yuuji@46 1011 "\\(\\\\item\\)\\|\\(\\\\underlineitem\\)")
yuuji@20 1012 @end lisp
yuuji@20 1013 @cindex YaTeX-item-regexp
yuuji@20 1014
yuuji@20 1015 in your @file{~/.emacs}. If you are not familiar with regular expression
yuuji@20 1016 for Emacs-Lisp, name a newcommand for `itemize' beginning with
yuuji@20 1017 @code{\item} such as @code{\itembf}, not @code{\bfitem}.
yuuji@20 1018
yuuji@20 1019 @node Local dictionaries, Updation of @code{\includeonly}, Filling an item, Top
yuuji@20 1020 @comment node-name, next, previous, up
yuuji@33 1021 @chapter Local dictionaries
yuuji@20 1022 @cindex local dictionaries
yuuji@20 1023 @cindex nervous users
yuuji@20 1024
yuuji@33 1025 Tables for completion consist of three dictionaries; `standard
yuuji@33 1026 dictionary' built in @file{yatex.el}, `user dictionary' for your common
yuuji@33 1027 private commands, and `local dictionary' that is effective in a certain
yuuji@33 1028 directory.
yuuji@33 1029
yuuji@33 1030 When you input the command unknown to YaTeX at a completion in the
yuuji@33 1031 minibuffer, YaTeX asks you with the following prompt;
yuuji@33 1032
yuuji@33 1033 @example
yuuji@33 1034 `foo' is not in table. Register into: U)serTable L)ocal N)one
yuuji@33 1035 @end example
yuuji@33 1036
yuuji@33 1037 @noindent
yuuji@33 1038 In this menu, typing `u' updates your `user dictionary', `l' updates your
yuuji@33 1039 local dictionary, and `n' updates no dictionary and throws the word away.
yuuji@33 1040
yuuji@33 1041 If you find this switching feature meaningless and bothersome, put the
yuuji@33 1042 next expression into your @file{~/.emacs}
yuuji@20 1043
yuuji@20 1044 @lisp
yuuji@46 1045 (setq YaTeX-nervous nil)
yuuji@20 1046 @end lisp
yuuji@20 1047
yuuji@20 1048 @node Updation of @code{\includeonly}, What column?, Local dictionaries, Top
yuuji@20 1049 @comment node-name, next, previous, up
yuuji@20 1050 @chapter Updation of @code{\includeonly}
yuuji@20 1051 @cindex includeonly
yuuji@20 1052
yuuji@20 1053 When you edit splitting source texts, the notation
yuuji@20 1054
yuuji@20 1055 @example
yuuji@46 1056 \includeonly@{CurrentEditingFileName@}
yuuji@20 1057 @end example
yuuji@20 1058
yuuji@20 1059 @noindent
yuuji@20 1060 in the main file reduces the time of typesetting. If you want
yuuji@20 1061 to hack other file a little however, you have to rewrite it to
yuuji@20 1062
yuuji@20 1063 @example
yuuji@46 1064 \includeonly@{OtherFileNameYouWantToFix@}
yuuji@20 1065 @end example
yuuji@20 1066
yuuji@20 1067 @noindent
yuuji@20 1068 in the main file. YaTeX automatically detects that the current
yuuji@20 1069 edited text is not in includeonly list and prompts you
yuuji@20 1070
yuuji@20 1071 @example
yuuji@46 1072 A)dd R)eplace %)comment?
yuuji@20 1073 @end example
yuuji@20 1074
yuuji@20 1075 in the minibuffer. Type @kbd{a} if you want to add the current file name
yuuji@20 1076 to @code{\includeonly} list, @kbd{r} to replace \@code{includeonly} list
yuuji@20 1077 by the current file, and type @kbd{%} to comment out the
yuuji@20 1078 @code{\includeonly} line.
yuuji@20 1079
yuuji@28 1080 @node What column?, Intelligent newline, Updation of @code{\includeonly}, Top
yuuji@20 1081 @comment node-name, next, previous, up
yuuji@20 1082 @chapter What column?
yuuji@20 1083 @cindex what column
yuuji@20 1084 @cindex complex tabular
yuuji@20 1085 @cindex prefix &
yuuji@20 1086
yuuji@20 1087 We are often get tired of finding the corresponding column in
yuuji@20 1088 large tabulars. For example,
yuuji@20 1089
yuuji@20 1090 @example
yuuji@20 1091 \begin@{tabular@}@{|c|c|c|c|c|c|c|c|@}\hline
yuuji@20 1092 Name&Position&Post No.&Addr.&Phone No.&FAX No.&
yuuji@20 1093 Home Addr.&Home Phone\\ \hline
yuuji@20 1094 Thunder Bird & 6 & 223 & LA & xxx-yyy &
yuuji@20 1095 zzz-www & Japan & 9876-54321 \\
yuuji@20 1096 & 2 & \multicolumn@{2@}@{c|@}@{Unknown@}
yuuji@20 1097 &&&(???)
yuuji@20 1098 \\ \hline
yuuji@20 1099 \end@{tabular@}
yuuji@20 1100 @end example
yuuji@20 1101
yuuji@20 1102 Suppose you have the cursor located at @code{(???)} mark, can you tell
yuuji@20 1103 which column it is belonging at once? Maybe no. In such case,
yuuji@20 1104 type
yuuji@20 1105
yuuji@20 1106 @table @kbd
yuuji@20 1107 @item [prefix] &
yuuji@46 1108 @dots{} What column
yuuji@20 1109 @end table
yuuji@20 1110
yuuji@20 1111 @noindent
yuuji@20 1112 in that position. YaTeX tells you the column header of the
yuuji@20 1113 current field. Since YaTeX assumes the first line of tabular
yuuji@20 1114 environment as a row of column headers, you can create a row of
yuuji@20 1115 virtual column headers by putting them in the first line and
yuuji@20 1116 commenting that line with @code{%}.
yuuji@20 1117
yuuji@28 1118 @node Intelligent newline, Online help, What column?, Top
yuuji@28 1119 @comment node-name, next, previous, up
yuuji@28 1120 @chapter Intelligent newline
yuuji@28 1121 @cindex Intelligent newline
yuuji@28 1122 @cindex ESC RET
yuuji@28 1123 @cindex M-C-m
yuuji@28 1124
yuuji@28 1125 In tabular[*], array, itemize, enumerate or tabbing environment,
yuuji@28 1126
yuuji@28 1127 @table @kbd
yuuji@28 1128 @item ESC RET
yuuji@46 1129 @dots{} Intelligent newline
yuuji@28 1130 @end table
yuuji@28 1131
yuuji@28 1132 @noindent
yuuji@28 1133 inserts the contents corresponding to the current environment in the next
yuuji@28 1134 line. In @code{tabular} environment, for example, @kbd{ESC RET} inserts
yuuji@28 1135 the certain number of @code{&} and trailing @code{\\}, and @code{\hline}
yuuji@28 1136 if other @code{\hline} is found in backward. Here are the list of
yuuji@28 1137 contents v.s. environments.
yuuji@28 1138
yuuji@28 1139 @itemize
yuuji@28 1140 @item @code{tabular}, @code{tabular*}, @code{array}
yuuji@28 1141
yuuji@46 1142 Corresponding number of @code{&} and @code{\\}.
yuuji@46 1143 And @code{\hline} if needed.
yuuji@28 1144
yuuji@28 1145 @item @code{tabbing}
yuuji@28 1146
yuuji@46 1147 The same number of @code{\>} as @code{\=} in the first line.
yuuji@28 1148
yuuji@28 1149 @item @code{itemize}, @code{enumerate}, @code{description}, @code{list}
yuuji@28 1150
yuuji@46 1151 @code{\item} or @code{item[]}.
yuuji@28 1152 @end itemize
yuuji@28 1153
yuuji@28 1154 Note that since this function works seeing the contents of the first
yuuji@28 1155 line, please call this after the second line if possible.
yuuji@28 1156
yuuji@28 1157 If you want to apply these trick to other environments, @code{foo}
yuuji@28 1158 environment for example, define the function named
yuuji@28 1159 @code{YaTeX-intelligent-newline-foo} to insert corresponding contents.
yuuji@28 1160 That function will be called at the beginning of the next line after the
yuuji@28 1161 newline is inserted to the current line. Since the function
yuuji@28 1162 @code{YaTeX-indent-line} is designed to indent the current line properly,
yuuji@28 1163 calling this function before your code to insert certain contents must be
yuuji@28 1164 useful. See the definition of the function
yuuji@28 1165 @code{YaTeX-intelligent-newline-itemize} as an example.
yuuji@28 1166
yuuji@28 1167 @node Online help, Cooperation with other packages, Intelligent newline, Top
yuuji@20 1168 @comment node-name, next, previous, up
yuuji@20 1169 @chapter Online help
yuuji@20 1170 @cindex online help
yuuji@20 1171 @cindex prefix ?
yuuji@20 1172 @cindex prefix /
yuuji@20 1173 @cindex apropos
yuuji@20 1174 @cindex keyword search
yuuji@20 1175
yuuji@20 1176 YaTeX provides you the online help with popular La@TeX{} commands.
yuuji@20 1177
yuuji@20 1178 Here are the key strokes for the online help.
yuuji@20 1179
yuuji@20 1180 @table @kbd
yuuji@20 1181 @item [prefix] ?
yuuji@46 1182 @dots{} Online help
yuuji@20 1183 @item [prefix] /
yuuji@46 1184 @dots{} Online apropos
yuuji@20 1185 @end table
yuuji@20 1186
yuuji@20 1187 @section Online help
yuuji@20 1188
yuuji@20 1189 `Online help' shows the documentation for the popular La@TeX{}
yuuji@20 1190 commands(defaults to the commands on the cursor) in the next buffer.
yuuji@20 1191 There are two help file, `global help' and `private help'. The former
yuuji@20 1192 file contains the descriptions on the standard La@TeX{} command and is
yuuji@20 1193 specified its name by variable @code{YaTeX-help-file}. Usually, the
yuuji@20 1194 global help file should be located in public space (@code{$EMACSEXECPATH}
yuuji@20 1195 by default) and should be world writable so that anyone can update it to
yuuji@20 1196 enrich its contents. The latter file contains descriptions on
yuuji@20 1197 non-standard or personal command definitions and is specified by
yuuji@20 1198 @code{YaTeX-help-file-private}. This file should be put into private
yuuji@20 1199 directory.
yuuji@20 1200
yuuji@20 1201 @section Online apropos
yuuji@20 1202
yuuji@20 1203 `Online apropos' is an equivalent of GNU Emacs's apropos. It
yuuji@20 1204 shows all the documentations that contains the keyword entered by
yuuji@20 1205 the user.
yuuji@20 1206
yuuji@20 1207 @section When no descriptions are found...
yuuji@20 1208
yuuji@20 1209 If there is no description on a command in help files, YaTeX
yuuji@20 1210 requires you to write a description on that command. If you are
yuuji@20 1211 willing to do, determine which help file to add and write the
yuuji@20 1212 description on it referring your manual of (La)TeX. Please send
yuuji@20 1213 me your additional descriptions if you describe the help on some
yuuji@20 1214 standard commands. I might want to include it in the next
yuuji@20 1215 distribution.
yuuji@20 1216
yuuji@20 1217 @node Cooperation with other packages, Customizations, Online help, Top
yuuji@20 1218 @comment node-name, next, previous, up
yuuji@20 1219 @chapter Cooperation with other packages
yuuji@20 1220
yuuji@20 1221 YaTeX works better with other brilliant packages.
yuuji@20 1222
yuuji@20 1223 @section gmhist
yuuji@20 1224 @cindex gmhist
yuuji@20 1225 @cindex command history
yuuji@20 1226 @cindex minibuffer history
yuuji@20 1227
yuuji@20 1228 When you are loading @file{gmhist.el} and @file{gmhist-mh.el}, you can
yuuji@20 1229 use independent command history list at the prompt of preview command
yuuji@20 1230 (@kbd{[prefix] tp}) and print command (@kbd{[prefix] tl}). On each
yuuji@20 1231 prompt, you can enter the previous command line string repeatedly by
yuuji@20 1232 typing @kbd{M-p}.
yuuji@20 1233
yuuji@20 1234 @section min-out
yuuji@20 1235 @cindex min-out
yuuji@20 1236
yuuji@20 1237 @file{min-out}, the outline minor mode, can be used in yatex-mode
yuuji@20 1238 buffers. If you want to use it with YaTeX, please refer the
yuuji@20 1239 file @file{yatexm-o.el} as an example.
yuuji@20 1240
yuuji@20 1241 @node Customizations, Etcetera, Cooperation with other packages, Top
yuuji@20 1242 @comment node-name, next, previous, up
yuuji@20 1243 @chapter Customizations
yuuji@20 1244 @cindex customizations
yuuji@20 1245
yuuji@20 1246 You can customize YaTeX by setting Emacs-Lisp variables and by making
yuuji@20 1247 add-in functions.
yuuji@20 1248
yuuji@20 1249 @menu
yuuji@20 1250 * Lisp variables::
yuuji@20 1251 * Add-in functions::
yuuji@20 1252 @end menu
yuuji@20 1253
yuuji@33 1254 @node Lisp variables, Add-in functions, Customizations, Customizations
yuuji@20 1255 @comment node-name, next, previous, up
yuuji@20 1256 @section Lisp variables
yuuji@20 1257 @cindex customizable variables
yuuji@20 1258
yuuji@20 1259 You can change the key assignments or make completion more
yuuji@20 1260 comfortable by setting the values of various variables which
yuuji@20 1261 control the movement of yatex-mode.
yuuji@20 1262
yuuji@20 1263 For example, if you want to change the prefix key stroke from @kbd{C-c}
yuuji@20 1264 to any other sequence, set YaTeX-prefix to whatever you want to use. If
yuuji@20 1265 you don't want to use the key sequence @kbd{C-c letter} which is assumed
yuuji@20 1266 to be the user reserved sequence in Emacs world, set
yuuji@20 1267 @code{YaTeX-inhibit-prefix-letter} to @code{t}, and all of the default key
yuuji@20 1268 bind of @kbd{C-c letter} will turn to the corresponding @kbd{C-c C-letter}
yuuji@20 1269 (but the region based completions that is invoked with @kbd{C-c
yuuji@20 1270 Capital-letter} remain valid, if you want to disable those bindings, set
yuuji@20 1271 that variable to 1 instead of @code{t}).
yuuji@20 1272
yuuji@20 1273 @menu
yuuji@20 1274 * All customizable variables::
yuuji@20 1275 * Sample definitions::
yuuji@20 1276 * Hook variables::
yuuji@20 1277 * Hook file::
yuuji@20 1278 @end menu
yuuji@20 1279
yuuji@33 1280 @node All customizable variables, Sample definitions, Lisp variables, Lisp variables
yuuji@20 1281 @comment node-name, next, previous, up
yuuji@20 1282 @subsection All customizable variables
yuuji@20 1283 @cindex all customizable variables
yuuji@20 1284
yuuji@20 1285 Here are the customizable variables of yatex-mode. Each value setq-ed
yuuji@20 1286 in @file{~/.emacs} is preferred and that of defined in @file{yatex.el} is
yuuji@20 1287 neglected. Parenthesized contents stands for the default value.
yuuji@20 1288
yuuji@46 1289 @defvar YaTeX-prefix
yuuji@46 1290 Prefix key stroke (@kbd{C-c})
yuuji@46 1291 @end defvar
yuuji@20 1292
yuuji@46 1293 @defvar YaTeX-inhibit-prefix-letter
yuuji@20 1294 Change key stroke from @kbd{C-c letter} to @kbd{C-c C-letter}
yuuji@20 1295 (@code{nil})
yuuji@46 1296 @end defvar
yuuji@20 1297
yuuji@46 1298 @defvar YaTeX-fill-prefix
yuuji@46 1299 Fill-prefix used in yatex-mode (@code{nil})
yuuji@46 1300 @end defvar
yuuji@20 1301
yuuji@46 1302 @defvar YaTeX-open-lines
yuuji@46 1303 Number of blank lines between cursor and @code{\begin@{@}},
yuuji@46 1304 @code{\@code{end}@{@}} (0)
yuuji@46 1305 @end defvar
yuuji@20 1306
yuuji@46 1307 @defvar YaTeX-user-completion-table
yuuji@46 1308 Name of user dictionary where learned completion table will be stored.
yuuji@46 1309 (@code{"~/.yatexrc"})
yuuji@46 1310 @end defvar
yuuji@20 1311
yuuji@46 1312 @defvar YaTeX-item-regexp
yuuji@46 1313 Regular expression of item command(@code{"\\\\item"})
yuuji@46 1314 @end defvar
yuuji@20 1315
yuuji@46 1316 @defvar tex-command
yuuji@46 1317 La@TeX{} typesetter command (@code{"latex"})
yuuji@46 1318 @end defvar
yuuji@20 1319
yuuji@46 1320 @defvar dvi2-command
yuuji@46 1321 Preview command
yuuji@46 1322 (@code{"xdvi -geo +0+0 -s 4 -display (getenv"DISPLAY")"})
yuuji@46 1323 @end defvar
yuuji@20 1324
yuuji@46 1325 @defvar dviprint-command-format
yuuji@46 1326 Command format to print dvi file (@code{"dvi2ps %f %t %s | lpr"})
yuuji@46 1327 @end defvar
yuuji@20 1328
yuuji@46 1329 @defvar dviprint-from-format
yuuji@46 1330 Start page format of above %f. %b will turn to start page
yuuji@46 1331 (@code{"-f %b"})
yuuji@46 1332 @end defvar
yuuji@20 1333
yuuji@46 1334 @defvar dviprint-to-format
yuuji@46 1335 End page format of above %t. %e will turn to @code{end} page
yuuji@46 1336 (@code{"-t %e"})
yuuji@46 1337 @end defvar
yuuji@20 1338
yuuji@46 1339 @defvar section-name
yuuji@46 1340 Initial default value at the first section-type completion
yuuji@46 1341 (@code{"documentstyle"})
yuuji@46 1342 @end defvar
yuuji@20 1343
yuuji@46 1344 @defvar env-name
yuuji@46 1345 Initial default value at the first begin-type completion
yuuji@46 1346 (@code{"document"})
yuuji@46 1347 @end defvar
yuuji@20 1348
yuuji@46 1349 @defvar fontsize-name
yuuji@46 1350 Ditto of large-type (@code{"large"})
yuuji@46 1351 @end defvar
yuuji@20 1352
yuuji@46 1353 @defvar single-command
yuuji@46 1354 Ditto of maketitle-type (@code{"maketitle"})
yuuji@46 1355 @end defvar
yuuji@20 1356
yuuji@46 1357 @defvar YaTeX-need-nonstop
yuuji@46 1358 Put @code{\nonstopmode@{@}} or not (@code{nil})
yuuji@46 1359 @end defvar
yuuji@20 1360
yuuji@46 1361 @defvar latex-warning-regexp
yuuji@46 1362 Regular expression of warning message latex command puts out
yuuji@46 1363 (@code{"line.* [0-9]*"})
yuuji@46 1364 @end defvar
yuuji@20 1365
yuuji@46 1366 @defvar latex-error-regexp
yuuji@46 1367 Regular expression of error message (@code{"l\\.[1-9][0-9]*"})
yuuji@46 1368 @end defvar
yuuji@20 1369
yuuji@46 1370 @defvar latex-dos-emergency-message
yuuji@46 1371 Message latex command running on DOS puts at abort
yuuji@46 1372 (@code{"Emergency stop"})
yuuji@46 1373 @end defvar
yuuji@20 1374
yuuji@46 1375 @defvar YaTeX-item-regexp
yuuji@46 1376 Regexp of La@TeX{} itemization command (@code{"\\\\(sub\\)*item"})
yuuji@46 1377 @end defvar
yuuji@20 1378
yuuji@46 1379 @defvar YaTeX-nervous
yuuji@46 1380 T for using local dictionary (@code{t})
yuuji@46 1381 @end defvar
yuuji@20 1382
yuuji@46 1383 @defvar YaTeX-sectioning-regexp
yuuji@46 1384 Regexp of La@TeX{} sectioning command
yuuji@20 1385
yuuji@46 1386 (@code{"part\\|chapter\\|\\(sub\\)*\\(section\\|paragraph\\)"})
yuuji@46 1387 @end defvar
yuuji@20 1388
yuuji@46 1389 @defvar YaTeX-fill-inhibit-environments
yuuji@46 1390 Inhibit fill in these environments (@code{'("verbatim" "tabular")})
yuuji@46 1391 @end defvar
yuuji@20 1392
yuuji@46 1393 @defvar YaTeX-uncomment-once
yuuji@46 1394 @code{T} for deleting all preceding @code{%} (@code{nil})
yuuji@46 1395 @end defvar
yuuji@20 1396
yuuji@46 1397 @defvar YaTeX-close-paren-always
yuuji@46 1398 @code{T} for always close all parenthesis automatically,
yuuji@46 1399 @code{nil} for only eol(@code{t})
yuuji@46 1400 @end defvar
yuuji@20 1401
yuuji@46 1402 @defvar YaTeX-auto-math-mode
yuuji@46 1403 Switch math-mode automatically(@code{t})
yuuji@46 1404 @end defvar
yuuji@20 1405
yuuji@46 1406 @defvar YaTeX-default-pop-window-height
yuuji@20 1407 Initial height of typesetting buffer when one-window.
yuuji@20 1408 Number for the lines of the buffer, numerical string for
yuuji@20 1409 the percentage of the screen-height.
yuuji@20 1410 @code{nil} for half height(10)
yuuji@46 1411 @end defvar
yuuji@20 1412
yuuji@46 1413 @defvar YaTeX-help-file
yuuji@46 1414 Global online help file name (@file{$EMACS/etc/YATEXHLP.jp})
yuuji@46 1415 @end defvar
yuuji@20 1416
yuuji@46 1417 @defvar YaTeX-help-file-private
yuuji@46 1418 Private online help file name (@file{"~/YATEXHLP.jp"})
yuuji@46 1419 @end defvar
yuuji@20 1420
yuuji@46 1421 @defvar YaTeX-no-begend-shortcut
yuuji@46 1422 Disable [prefix] b ?? shortcut (@code{nil)}
yuuji@46 1423 @end defvar
yuuji@20 1424
yuuji@20 1425 @node Sample definitions, Hook variables, All customizable variables, Lisp variables
yuuji@20 1426 @comment node-name, next, previous, up
yuuji@20 1427 @subsection Sample definitions
yuuji@20 1428 @cindex prefix key stroke
yuuji@20 1429 @cindex fill-prefix
yuuji@20 1430
yuuji@20 1431 For instance, to change the prefix key stroke to @kbd{ESC}, and name of
yuuji@20 1432 the user dictionary @file{~/src/emacs/yatexrc}, and set @code{fill-prefix}
yuuji@20 1433 to single TAB character, add the following @code{setq} to @file{~/.emacs}.
yuuji@20 1434
yuuji@20 1435 @lisp
yuuji@46 1436 (setq YaTeX-prefix "\e"
yuuji@46 1437 YaTeX-user-completion-table "~/src/emacs/yatexrc"
yuuji@46 1438 YaTeX-fill-prefix " ")
yuuji@20 1439 @end lisp
yuuji@20 1440
yuuji@20 1441 @node Hook variables, Hook file, Sample definitions, Lisp variables
yuuji@20 1442 @comment node-name, next, previous, up
yuuji@20 1443 @subsection Hook variables
yuuji@20 1444 @cindex hook variables
yuuji@20 1445
yuuji@20 1446 More customizations will be done by the hook-function defined in
yuuji@20 1447 hook-variable @code{yatex-mode-hook}. This is useful to define a shortcut
yuuji@20 1448 key sequence to enter some environments other than @code{document} and
yuuji@20 1449 @code{enumerate} etc. The following statement defines @code{[prefix] ba}
yuuji@20 1450 to enter @code{\begin@{abstract@}} ... @code{=end@{abstract@}}
yuuji@20 1451 immediately.
yuuji@20 1452
yuuji@20 1453 @lisp
yuuji@46 1454 (setq yatex-mode-hook
yuuji@46 1455 '(lambda() (YaTeX-define-begend-key "ba" "abstract")))
yuuji@20 1456 @end lisp
yuuji@20 1457
yuuji@46 1458 You should use functions @code{YaTeX-define-key}, or
yuuji@46 1459 @code{YaTeX-define-begend-key} to define all the key sequences of
yuuji@20 1460 yatex-mode.
yuuji@20 1461
yuuji@20 1462 @node Hook file, , Hook variables, Lisp variables
yuuji@20 1463 @comment node-name, next, previous, up
yuuji@20 1464 @subsection Hook file
yuuji@20 1465 @cindex hook file
yuuji@20 1466
yuuji@20 1467 You can stuff all of YaTeX relating expressions into a file named
yuuji@20 1468 @file{yatexhks.el} if you have a lot of codes. YaTeX automatically load
yuuji@20 1469 this file at the initialization of itself. Using @file{yatexhks.el}
yuuji@20 1470 makes @code{yatex-mode-load-hook} unnecessary.
yuuji@20 1471
yuuji@20 1472 @node Add-in functions, , Lisp variables, Customizations
yuuji@20 1473 @comment node-name, next, previous, up
yuuji@20 1474 @section Add-in functions
yuuji@20 1475 @cindex add-in functions
yuuji@20 1476
yuuji@20 1477 You can easily define a function to input detailed arguments
yuuji@20 1478 with completion according to La@TeX{} environments or commands. To
yuuji@20 1479 know the way to define these functions, see also @file{yatexadd.doc} in
yuuji@20 1480 this package please.
yuuji@20 1481
yuuji@20 1482
yuuji@20 1483 @node Etcetera, Copying, Customizations, Top
yuuji@20 1484 @comment node-name, next, previous, up
yuuji@20 1485 @chapter Etcetera
yuuji@20 1486
yuuji@20 1487 The standard completion tables provided in @file{yatex.el} contain a
yuuji@20 1488 few La@TeX{} commands I frequently use. This is to lessen the key
yuuji@20 1489 strokes to complete entire word, because too many candidates
yuuji@20 1490 rarely used often cause too many hits. Therefore always try to
yuuji@20 1491 use completion in order to enrich your dictionary, and you will
yuuji@20 1492 also find `Wild Bird' growing suitable for your La@TeX{} style.
yuuji@20 1493
yuuji@20 1494
yuuji@20 1495 @node Copying, , Etcetera, Top
yuuji@20 1496 @comment node-name, next, previous, up
yuuji@20 1497 @chapter Copying
yuuji@20 1498
yuuji@20 1499 This program is distributed as a free software. You can
yuuji@20 1500 redistribute this software freely but with NO warranty to anything
yuuji@20 1501 as a result of using this software. However, any reports and
yuuji@20 1502 suggestions are welcome as long as I feel interests in this
yuuji@20 1503 software. My possible e-mail address is `yuuji@@ae.keio.ac.jp'.
yuuji@20 1504 (up to Mar.1993 at least)
yuuji@20 1505
yuuji@20 1506 The specification of this software will be surely modified
yuuji@20 1507 (depending on my feelings) without notice :-p.
yuuji@20 1508
yuuji@20 1509
yuuji@20 1510 @flushright
yuuji@20 1511 HIROSE Yuuji
yuuji@20 1512 @end flushright
yuuji@20 1513 @bye
yuuji@20 1514
yuuji@20 1515 Local variables:
yuuji@20 1516 mode: texinfo
yuuji@20 1517 fill-prefix: nil
yuuji@20 1518 fill-column: 74
yuuji@20 1519 End: