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