yatex

annotate docs/yatexe.tex @ 60:9e08ed569d80

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