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