yatex

annotate docs/yatexe.tex @ 79:0734be649cb8

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