yatex

diff docs/yatexe @ 471:d63ba3e187ca

Add description on \label-generation
author HIROSE Yuuji <yuuji@gentei.org>
date Tue, 22 Aug 2017 18:13:21 +0859
parents 510106cf15fb
children 355b28fc0025
line diff
     1.1 --- a/docs/yatexe	Sun Jul 12 10:06:47 2015 +0900
     1.2 +++ b/docs/yatexe	Tue Aug 22 18:13:21 2017 +0859
     1.3 @@ -65,9 +65,9 @@
     1.4     * Semiautomatic replacing of `\includeonly'
     1.5     * Jumping to error line(`C-c '')
     1.6     * Completing-read of LaTeX commands such as `\begin{}', `\section' etc.
     1.7 -     (`C-c b', `C-c s', `C-c l', `C-c m')
     1.8 +             (`C-c b', `C-c s', `C-c l', `C-c m')
     1.9     * Enclosing text into LaTeX environments or commands (ABOVEKEYSTROKES
    1.10 -     after region setting)
    1.11 +           after region setting)
    1.12     * Displaying the structure of text at entering sectioning commands
    1.13     * Lump shifting of sectioning commands (*Note view-sectioning::)
    1.14     * Learning unknown/new LaTeX commands for the next completion
    1.15 @@ -76,15 +76,16 @@
    1.16     * Quick changing or deleting of LaTeX commands(`C-c c', `C-c k')
    1.17     * Jumping from and to inter-file, begin<->end, ref<->label(`C-c g')
    1.18     * Blanket commenting out or uncommenting (`C-c >', `C-c <', `C-c ,',
    1.19 -     `C-c .')
    1.20 +             `C-c .')
    1.21     * Easy input of accent mark, math-mode's commands and Greek letters
    1.22 -     (`C-c a', `;', `:')
    1.23 +             (`C-c a', `;', `:')
    1.24     * Online help for the popular LaTeX commands (`C-c ?', `C-c /')
    1.25     * Document files hierarchy browser (`C-c d')
    1.26     * Adding automatically \usepackage corresponding to inputting LaTeX
    1.27 -     macro with completion
    1.28 +           macro with completion
    1.29     * Allow you to forget creating \label{}s, \ref{} or \cite{} completion
    1.30 -     automatically generate labels.
    1.31 +           automatically generate labels.
    1.32 +   * \includegraphics by Drag&Drop of image file
    1.33  
    1.34  
    1.35  
    1.36 @@ -130,7 +131,7 @@
    1.37               ... invoke typesetter on region
    1.38  `[prefix] t e'
    1.39               ... `on-the-fly preview' on current environment or whole
    1.40 -     portion of current formulas in math-mode
    1.41 +              portion of current formulas in math-mode
    1.42  `[prefix] t d'
    1.43          ... invoke dvipdfmx after successful typesetting
    1.44  `[prefix] t k'
    1.45 @@ -293,12 +294,12 @@
    1.46  (see *Note Cursor jump::), take described below into consideration.
    1.47  
    1.48     * You can put split texts in sub directory, but not in sub directory of
    1.49 -     sub directory.
    1.50 +      sub directory.
    1.51     * In the main text, specify the child file name with relative path name
    1.52 -     such as \include{chap1/sub}, when you include the file in a
    1.53 -     sub-directory.
    1.54 +      such as \include{chap1/sub}, when you include the file in a
    1.55 +      sub-directory.
    1.56     * In a sub-text, write `%#!latex main.tex' even if `main.tex' is in the
    1.57 -     parent directory(not %#!latex ../main.tex).
    1.58 +      parent directory(not %#!latex ../main.tex).
    1.59  
    1.60  
    1.61  
    1.62 @@ -336,7 +337,7 @@
    1.63  
    1.64  
    1.65  
    1.66 -File: yatexe, Node: Lpr format, Prev: Static region for typesetting, Up: %#notation
    1.67 +File: yatexe, Node: Lpr format, Next: Controlling which command to invoke, Prev: Static region for typesetting, Up: %#notation
    1.68  
    1.69  Lpr format
    1.70  ==========
    1.71 @@ -439,6 +440,7 @@
    1.72  
    1.73  * Begin-type completion::
    1.74  * Section-type completion::
    1.75 +* Label Generation::
    1.76  * Large-type completion::
    1.77  * Maketitle-type completion::
    1.78  * Arbitrary completion::
    1.79 @@ -533,7 +535,7 @@
    1.80  
    1.81  
    1.82  
    1.83 -File: yatexe, Node: Section-type completion, Next: Large-type completion, Prev: Begin-type completion, Up: Completion
    1.84 +File: yatexe, Node: Section-type completion, Prev: Begin-type completion, Up: Completion
    1.85  
    1.86  Section-type completion
    1.87  =======================
    1.88 @@ -655,9 +657,44 @@
    1.89               ... Hide sectioning commands whose level is lower than n
    1.90  
    1.91  
    1.92 -
    1.93  
    1.94 -File: yatexe, Node: Large-type completion, Next: Maketitle-type completion, Prev: Section-type completion, Up: Completion
    1.95 +File: yatexe, Node: Label Generation, Next: Large-type completion, Prev: Section-type completion, Up: Completion
    1.96 +
    1.97 +Label Generation
    1.98 +================
    1.99 +
   1.100 +When you want to type-in references of `\ref' or `\cite', all you have to
   1.101 +do is type `[prefix] s ref' without adding labels beforehand.  You will
   1.102 +see possible LaTeX-counters in the next window even if some counter does
   1.103 +not have `\label'.  Selecting the counter will automatically set the label
   1.104 +to that counter.
   1.105 +
   1.106 +All possible counter list in the buffer tends to be large.  You can reduce
   1.107 +the number of list by filtering type of counters by key-commands as
   1.108 +follows.
   1.109 +      `M-a'
   1.110 +
   1.111 +        ... Show all(disable filtering)
   1.112 +      `M-c'
   1.113 +
   1.114 +        ... Captions only
   1.115 +      `M-e'
   1.116 +
   1.117 +        ... equations (with counters) only
   1.118 +      `M-i'
   1.119 +
   1.120 +        ... numbers items only
   1.121 +      `M-s'
   1.122 +
   1.123 +        ... sections only
   1.124 +      `M-m'
   1.125 +
   1.126 +        ... other counters only
   1.127 +
   1.128 +
   1.129 +
   1.130 +
   1.131 +File: yatexe, Node: Large-type completion, Next: Maketitle-type completion, Prev: Label Generation, Up: Completion
   1.132  
   1.133  Large-type completion
   1.134  =====================
   1.135 @@ -720,7 +757,7 @@
   1.136  ==============
   1.137  
   1.138    YaTeX automatically detects the opened environment and close it with
   1.139 -`\end{environment}'.  Though proficient YaTeX users never fail to make
   1.140 +\`\end{environment}'.  Though proficient YaTeX users never fail to make
   1.141  environment with begin-type completion, some may begin an environment
   1.142  manually.  In that case, type
   1.143  
   1.144 @@ -1256,7 +1293,7 @@
   1.145     * `tabular', `tabular*', `array'
   1.146  
   1.147               Corresponding number of `&' and `\\'.  And `\hline' if
   1.148 -     needed.
   1.149 +             needed.
   1.150  
   1.151     * `tabbing'
   1.152  
   1.153 @@ -1606,8 +1643,8 @@
   1.154  
   1.155   -- Variable: YaTeX-fill-inhibit-environments
   1.156       Inhibit fill in these environments (`'("tabular" "tabular*" "array"
   1.157 -     picture" "eqnarray" "eqnarray*" "equation" "math" "displaymath"
   1.158 -     verbatim" "verbatim*")')
   1.159 +     "picture" "eqnarray" "eqnarray*" "equation" "math" "displaymath"
   1.160 +     "verbatim" "verbatim*")')
   1.161  
   1.162   -- Variable: YaTeX-uncomment-once
   1.163       T for deleting all preceding `%' (`nil')
   1.164 @@ -2082,10 +2119,11 @@
   1.165  ----------------
   1.166  
   1.167    The latter generator is invoked by the next sequence.  `M-x
   1.168 -YaTeX-generate-simple' This generator can make both "option add-in" and
   1.169 -argument add-in" (*refer the section add-in functions* *Note How the
   1.170 -add-in function works::), whereas `YaTeX-generate' cannot make "argument
   1.171 -addin".
   1.172 +                       YaTeX-generate-simple' This generator can make both
   1.173 +                       "option add-in" and "argument add-in" (*refer the
   1.174 +                       section add-in functions* *Note How the add-in
   1.175 +                       function works::), whereas `YaTeX-generate' cannot
   1.176 +                       make "argument addin".
   1.177  
   1.178    For example, assume you have the LaTeX command as follows.
   1.179  
   1.180 @@ -2267,65 +2305,66 @@
   1.181  Node: Top256
   1.182  Node: What is YaTeX?1583
   1.183  Node: Main features1956
   1.184 -Node: Installation3500
   1.185 -Node: Typesetting4277
   1.186 -Node: Calling typesetter5389
   1.187 -Node: Calling previewer7916
   1.188 -Node: Printing out8277
   1.189 -Node: %#notation8569
   1.190 -Node: Changing typesetter8940
   1.191 -Node: Splitting input files9304
   1.192 -Node: Static region for typesetting10729
   1.193 -Node: Lpr format11858
   1.194 -Node: Controlling which command to invoke12888
   1.195 -Node: Editing %# notation13845
   1.196 -Node: Completion14389
   1.197 -Node: Begin-type completion14904
   1.198 -Node: Section-type completion17758
   1.199 -Node: view-sectioning20179
   1.200 -Node: Large-type completion21759
   1.201 -Node: Maketitle-type completion22412
   1.202 -Node: Arbitrary completion22964
   1.203 -Node: End completion23354
   1.204 -Node: Accent completion23823
   1.205 -Node: Image completion24440
   1.206 -Node: Greek letters completion26695
   1.207 -Node: Inserting parentheses27451
   1.208 -Node: Local dictionaries27858
   1.209 -Node: Commenting out28795
   1.210 -Node: Cursor jump30254
   1.211 -Node: Jump to corresponding object30545
   1.212 -Node: Invoking image processor31945
   1.213 -Node: Jump to main file33288
   1.214 -Node: Jumping around the environment33654
   1.215 -Node: Jumping to last completion position34072
   1.216 -Node: Changing and Deleting34581
   1.217 -Node: Changing LaTeX commands34962
   1.218 -Node: Killing LaTeX commands36139
   1.219 -Node: Filling37324
   1.220 -Node: Updation of includeonly39179
   1.221 -Node: What column39976
   1.222 -Node: Intelligent newline41061
   1.223 -Node: Usepackage checker42714
   1.224 -Node: Online help43305
   1.225 -Node: Browsing file hierarchy44980
   1.226 -Node: Cooperation with other packages46717
   1.227 -Node: Customizations47422
   1.228 -Node: Lisp variables47718
   1.229 -Node: All customizable variables48677
   1.230 -Node: Sample definitions60640
   1.231 -Node: Hook variables61153
   1.232 -Node: Hook file61857
   1.233 -Node: Add-in functions62196
   1.234 -Node: How the add-in function works63034
   1.235 -Node: Defining option-add-in65220
   1.236 -Node: Defining argument-add-in65942
   1.237 -Node: Defining enclosing-add-in66823
   1.238 -Node: How the function is called67679
   1.239 -Node: Useful functions for creating add-in68355
   1.240 -Node: Contribution69765
   1.241 -Node: Add-in generator70039
   1.242 -Node: Etcetera75499
   1.243 -Node: Copying76104
   1.244 +Node: Installation3591
   1.245 +Node: Typesetting4368
   1.246 +Node: Calling typesetter5489
   1.247 +Node: Calling previewer8016
   1.248 +Node: Printing out8377
   1.249 +Node: %#notation8669
   1.250 +Node: Changing typesetter9040
   1.251 +Node: Splitting input files9404
   1.252 +Node: Static region for typesetting10833
   1.253 +Node: Lpr format11962
   1.254 +Node: Controlling which command to invoke13035
   1.255 +Node: Editing %# notation13992
   1.256 +Node: Completion14536
   1.257 +Node: Begin-type completion15072
   1.258 +Node: Section-type completion17926
   1.259 +Node: view-sectioning20318
   1.260 +Node: Label Generation21897
   1.261 +Node: Large-type completion22797
   1.262 +Node: Maketitle-type completion23443
   1.263 +Node: Arbitrary completion23995
   1.264 +Node: End completion24385
   1.265 +Node: Accent completion24855
   1.266 +Node: Image completion25472
   1.267 +Node: Greek letters completion27727
   1.268 +Node: Inserting parentheses28483
   1.269 +Node: Local dictionaries28890
   1.270 +Node: Commenting out29827
   1.271 +Node: Cursor jump31286
   1.272 +Node: Jump to corresponding object31577
   1.273 +Node: Invoking image processor32977
   1.274 +Node: Jump to main file34320
   1.275 +Node: Jumping around the environment34686
   1.276 +Node: Jumping to last completion position35104
   1.277 +Node: Changing and Deleting35613
   1.278 +Node: Changing LaTeX commands35994
   1.279 +Node: Killing LaTeX commands37171
   1.280 +Node: Filling38356
   1.281 +Node: Updation of includeonly40211
   1.282 +Node: What column41008
   1.283 +Node: Intelligent newline42093
   1.284 +Node: Usepackage checker43754
   1.285 +Node: Online help44345
   1.286 +Node: Browsing file hierarchy46020
   1.287 +Node: Cooperation with other packages47757
   1.288 +Node: Customizations48462
   1.289 +Node: Lisp variables48758
   1.290 +Node: All customizable variables49717
   1.291 +Node: Sample definitions61682
   1.292 +Node: Hook variables62195
   1.293 +Node: Hook file62899
   1.294 +Node: Add-in functions63238
   1.295 +Node: How the add-in function works64076
   1.296 +Node: Defining option-add-in66262
   1.297 +Node: Defining argument-add-in66984
   1.298 +Node: Defining enclosing-add-in67865
   1.299 +Node: How the function is called68721
   1.300 +Node: Useful functions for creating add-in69397
   1.301 +Node: Contribution70807
   1.302 +Node: Add-in generator71081
   1.303 +Node: Etcetera76657
   1.304 +Node: Copying77262
   1.305  
   1.306  End tag table