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