yatex: docs/yatexe annotate

yatex

annotate docs/yatexe @ 84:73cba5ddd111

Converted from RCS of yatex

author	yuuji
date	Sun, 27 Sep 2009 13:04:14 +0000
parents
children	590fc51462c7

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