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