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