annotate docs/yatexref.eng @ 515:b6853d450b0a dev

Add a function to examine the point is in %#BEGIN/%#END or not.
author HIROSE Yuuji <yuuji@gentei.org>
date Thu, 04 Jan 2018 23:58:07 +0900
parents 09a2b5a3b3d8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
54
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
1 ----------------------------------------------------------------------------
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
2 YaTeX
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
3 Quick Reference
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
4 ----------------------------------------------------------------------------
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
5
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
6
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
7 [Caution]
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
8
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
9 You can customize the prefix key (C-c by default) so this will be
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
10 written as [prefix] in this document. If you have not customized
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
11 [prefix] a will stand for C-c a.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
12
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
13 Begin-type commands are those like \begin-\end, Section-type
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
14 commands are those that take arguments as \section{NAME},
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
15 Large-type commands are font/size definition commands that are put
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
16 in parenthesis as {\tt}, Maketitle-type commands are commands that
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
17 don't take arguments as \maketitle.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
18
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
19 [Completion]
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
20
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
21 *Accent completion [prefix] a
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
22 *Begin-type completion [prefix] b SPC
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
23 *Begin-type completion (region) [prefix] B SPC
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
24 *Begin-type completion (immediate) [prefix] b initial_of_environment
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
25 *Begin-type completion (immediate on region)
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
26 [prefix] B initial_of_environment
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
27 *End completion [prefix] e
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
28 *Large-type completion [prefix] l
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
29 *Large-type completion (region) [prefix] L
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
30 *Maketitle-type completion [prefix] m
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
31 *Section-type completion [prefix] s
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
32 *Section-type completion (region) [prefix] S
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
33 *General completion [prefix] SPC
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
34
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
35 For the initials used in immediate Begin-type completions, see the
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
36 Info manual. In the (region)-mode, region between the mark and
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
37 the present point will be put within a \begin{foo}...\end{foo} or
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
38 {\large } and such.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
39
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
40 *Math sign image completion ;
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
41 *Greek letter image completion :
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
42
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
43 Above two commands may be used only in the math environment. If
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
44 you want to use the completion in other environments, do C-u and
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
45 then ; or :.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
46
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
47
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
48 [Process invoking]
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
49
379
09a2b5a3b3d8 Describe about [prefix] t d and [prefix] t e and so on.
HIROSE Yuuji <yuuji@gentei.org>
parents: 70
diff changeset
50 *invoke latex [prefix] tj
09a2b5a3b3d8 Describe about [prefix] t d and [prefix] t e and so on.
HIROSE Yuuji <yuuji@gentei.org>
parents: 70
diff changeset
51 *invoke latex (on region) [prefix] tr
09a2b5a3b3d8 Describe about [prefix] t d and [prefix] t e and so on.
HIROSE Yuuji <yuuji@gentei.org>
parents: 70
diff changeset
52 *on-the-fly preview environment [prefix] te
54
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
53 *invoke bibtex [prefix] tb
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
54 *invoke makeindex [prefix] ti
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
55 *kill current typesetting process [prefix] tk **
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
56 *lpr dvi-file [prefix] tl
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
57 *lpr dvi-file (all pages) C-u [prefix] tl
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
58 *invoke previewer [prefix] tp
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
59 *invoke lpq [prefix] tq
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
60
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
61 Hitting [prefix] t will get you the menu, so there is no need to
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
62 remember the key after [prefix] t.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
63
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
64 **Unavailable on MS-DOS
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
65
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
66 The region used in [prefix] tr are the lines between %#BEGIN and
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
67 %#END. If %#END is not found then from %#BEGIN and the end of
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
68 the text. If both are missing then from the mark to the
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
69 present point.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
70
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
71 [Cursor Jump]
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
72 *To the typeset error [prefix] '
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
73
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
74 Will jump to the position where the typeset error occurred from the
379
09a2b5a3b3d8 Describe about [prefix] t d and [prefix] t e and so on.
HIROSE Yuuji <yuuji@gentei.org>
parents: 70
diff changeset
75 end. Only effective when there was a error returned from typesetter.
54
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
76
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
77 *Jump to corresponding object [prefix] g
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
78 *Jump to corresponding object (in another her window) [prefix] 4g
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
79
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
80 Where to jump will be decided by what's on the line [prefix] g was
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
81 hit.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
82
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
83 -on a \begin{} or \end{} to a matching \end{} or \begin{}
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
84 -on a %#BEGIN or %#END to a matching %#END or %#BEGIN
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
85 -on a \include(only) or \input to the matching file
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
86 -on a \ref or \label to the matching \label or \ref
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
87 -on a \cite or \bibitem to the matching \bibitem or \cite
379
09a2b5a3b3d8 Describe about [prefix] t d and [prefix] t e and so on.
HIROSE Yuuji <yuuji@gentei.org>
parents: 70
diff changeset
88 -other to the matching line in previewer
54
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
89
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
90 *Jump to the main file [prefix] ^
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
91 *Jump to the main file in another window [prefix] 4^
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
92
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
93 To tell YaTeX which the main file is, write
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
94 %#jlatex MAIN_FILE_NAME
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
95 somewhere in the file you are creating.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
96
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
97 *Jump to beginning of environment ESC C-a
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
98 *Jump to end of environment ESC C-e
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
99 *Mark whole environment ESC C-h
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
100
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
101 [Commenting out by %]
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
102
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
103 *Comment out the region/environment [prefix] >
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
104 *Uncomment the region/environment [prefix] <
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
105
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
106 If the point is on a line with \begin{} or \end{}, everything
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
107 within the environment will be (un)commented. Otherwise,
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
108 everything between the mark and point will be (un)commented.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
109
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
110 *Comment out a paragraph or environment declaration [prefix] .
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
111 *Uncomment out a paragraph or environment declaration [prefix] ,
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
112
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
113 If the point is on a line with \begin{} or \end, the two lines
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
114 with it will be (un)commented. Otherwise the paragraph that the
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
115 point is in will be (un)commented.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
116
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
117 [ETC]
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
118
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
119 *Align and fill item [prefix] i
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
120
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
121 Available only in an environment. Will do a hanging indent on the
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
122 \item.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
123
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
124 *Change LaTeX command [prefix] c
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
125
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
126 On a line with \begin{} or \end{}, will change the name of the
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
127 environment. On a section-type command, will change the command
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
128 name, and also change arguments if invoked on the argument. For
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
129 large-type command, will change font/size definitions. On a math
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
130 mode command entered using image-type completion, will return to
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
131 the completion operation.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
132
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
133 *Kill commands [prefix] k
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
134
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
135 For \begin{}/\end{}, %#BEGIN/%#END, and parenthesis, will delete
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
136 them in pairs. For section-type commands, font/size definition,
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
137 will delete the command ant parenthesis surrounding them.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
138
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
139 *Enclose region with () [prefix] )
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
140 *Enclose region with {} [prefix] }
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
141 *Enclose region with [] [prefix] ]
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
142 *Enclose region with $$ [prefix] $
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
143
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
144 *Toggle modes [prefix] w
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
145
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
146 Will toggle between modify mode and math mode.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
147
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
148 *%# editing [prefix] %
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
149 *Show columns in tabular/array [prefix] &
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
150 *Online help [prefix] h
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
151 *Online apropos [prefix] /
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
152 *Intelligent return ESC RET
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
153
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
154 Intelligent return can be used in tabular, array, itemize,
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
155 enumerate, list and description environments.
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
156
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
157 *Browse included structure [prefix] d
379
09a2b5a3b3d8 Describe about [prefix] t d and [prefix] t e and so on.
HIROSE Yuuji <yuuji@gentei.org>
parents: 70
diff changeset
158 *Force re-highlight font-lock [prefix] u
54
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
159
69
807c1e7e68b7 yahtml-escape-chars-region
yuuji
parents: 54
diff changeset
160 HIROSE Yuuji
70
44e3a5e1e883 Fix makefile for Windows
yuuji
parents: 69
diff changeset
161 yuuji@yatex.org
54
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
162
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
163 Local variables:
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
164 mode: text
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
165 fill-prefix: " "
2d45e43fb35f Full support of English documents
yuuji
parents:
diff changeset
166 End:

yatex.org