yatex

annotate docs/yatexe @ 272:78d0fdc0459c

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