1.1 --- a/docs/yatexe.tex	Fri Nov 25 08:26:13 1994 +0000
     1.2 +++ b/docs/yatexe.tex	Tue Dec 20 21:00:21 1994 +0000
     1.3 @@ -25,25 +25,25 @@
     1.4  @cindex YaTeX
     1.5  
     1.6  @menu
     1.7 -* What is YaTeX?::              
     1.8 -* Main features::               
     1.9 -* Installation::                
    1.10 -* Typesetting::                 
    1.11 -* %# notation::                 
    1.12 -* Completion::                  
    1.13 -* Local dictionaries::          
    1.14 -* Commenting out::              
    1.15 -* Cursor jump::                 
    1.16 -* Changing and Deleting::       
    1.17 -* Filling an item::             
    1.18 -* Updation of @code{\includeonly}::  
    1.19 -* What column?::                
    1.20 -* Intelligent newline::         
    1.21 -* Online help::                 
    1.22 -* Cooperation with other packages::  
    1.23 -* Customizations::              
    1.24 -* Etcetera::                    
    1.25 -* Copying::                     
    1.26 +* What is YaTeX?::              Introduction
    1.27 +* Main features::               What YaTeX can do
    1.28 +* Installation::                Guide to install
    1.29 +* Typesetting::                 Call typesetting processes
    1.30 +* %# notation::                 Quick notation of controlling YaTeX
    1.31 +* Completion::                  Input LaTeX commands with completion
    1.32 +* Local dictionaries::          Directory dependent completion
    1.33 +* Commenting out::              Commenting/uncommenting text
    1.34 +* Cursor jump::                 Jumping to related position
    1.35 +* Changing and Deleting::       Changing/deleting certain unit of text
    1.36 +* Filling::                     Filling an item or paragraph
    1.37 +* Updation of @code{\includeonly}::  Maintaining @code{\includeonly}
    1.38 +* What column?::                Column position guide in tabular
    1.39 +* Intelligent newline::         Guess requisites of new line
    1.40 +* Online help::                 On-line documentation of LaTeX
    1.41 +* Cooperation with other packages::  Work well with gmhist, min-out
    1.42 +* Customizations::              How to breed `Wild Bird'
    1.43 +* Etcetera::                    YaTeX is acquisitive.
    1.44 +* Copying::                     Redistribution
    1.45  
    1.46   --- The Detailed Node Listing ---
    1.47  
    1.48 @@ -265,7 +265,13 @@
    1.49  @end example
    1.50  
    1.51  @noindent
    1.52 -anywhere in the source text.  And if you split the source text and
    1.53 +anywhere in the source text.  This is useful for changing
    1.54 +typesetter.
    1.55 +
    1.56 +@node Splitting input files, Static region for typesetting, Changing typesetter, %# notation
    1.57 +@comment  node-name,  next,  previous,  up
    1.58 +
    1.59 +  And if you split the source text and
    1.60  edit subfile that should be included from main text.
    1.61  
    1.62  @example
    1.63 @@ -285,13 +291,14 @@
    1.64  Note that YaTeX  assumes the component  before the  last period of
    1.65  the last word in this line as base name of the main La@TeX{} source.
    1.66  
    1.67 -  Here are the restrictions on splitting sources.
    1.68 +  To make best use of the feature of inter-file jumping by
    1.69 +@kbd{[prefix] g} (see @ref{Cursor jump}), take described below into
    1.70 +consideration.
    1.71  
    1.72  @itemize
    1.73 -@item All the file name should be different.
    1.74  @item You can put split texts in sub directory, but not in
    1.75   sub directory of sub directory.
    1.76 -@item In the main text,specify the file with relative path name
    1.77 +@item In the main text, specify the child file name with relative path name
    1.78   such as \include{chap1/sub}, when you include the file in
    1.79   a sub-directory.
    1.80  @item In a sub-text, write @code{%#!latex main.tex} even if @file{main.tex}
    1.81 @@ -864,12 +871,14 @@
    1.82  minibuffer, YaTeX asks you with the following prompt;
    1.83  
    1.84  @example
    1.85 -  `foo' is not in table. Register into: U)serTable L)ocal N)one
    1.86 +  `foo' is not in table. Register into: U)serDic L)ocalDic N)one D)iscad
    1.87  @end example
    1.88  
    1.89  @noindent 
    1.90 -In this menu, typing `u' updates your `user dictionary', `l' updates your
    1.91 -local dictionary, and `n' updates no dictionary and throws the word away.
    1.92 +In this menu, typing @kbd{u} updates your `user dictionary', @kbd{l}
    1.93 +updates your local dictionary, @kbd{n} updates only on-memory dictionary
    1.94 +which go through only current Emacs session, and @kbd{d} updates no
    1.95 +dictionary and throws the new word away.
    1.96  
    1.97    If you find this switching feature meaningless and bothersome, put the
    1.98  next expression into your @file{~/.emacs}
    1.99 @@ -948,6 +957,8 @@
   1.100  @cindex cursor jump
   1.101  @cindex prefix g
   1.102  
   1.103 +@section Jump to corresponding object
   1.104 +
   1.105    Typing
   1.106  
   1.107  @table @kbd
   1.108 @@ -970,14 +981,27 @@
   1.109  
   1.110    On a @code{\begin},@code{\end} line, typing @kbd{[prefix] g} moves the
   1.111  cursor to the corresponding @code{\end},@code{\begin} line, if its partner
   1.112 -really exists.  The behaviour on the line @code{%#BEGIN} and @code{%#END}
   1.113 +really exists.  The behavior on the line @code{%#BEGIN} and @code{%#END}
   1.114  are the same.  Note that if the correspondent of @code{label/ref} or
   1.115 -@code{cite/bibitem} exists in another file, that file have to be opend to
   1.116 +@code{cite/bibitem} exists in another file, that file have to be opened to
   1.117  make a round trip between references by @kbd{[prefix] g}.
   1.118  
   1.119    If you type @code{[prefix] g} on the line of @code{\include@{chap1@}},
   1.120  typically in the main text, YaTeX switches buffer to @file{chap1.tex}.
   1.121 -The key strokes below work to the contrary.  Typing
   1.122 +
   1.123 +@table @kbd
   1.124 +@item [prefix] 4 g
   1.125 +        @dots{} go to corresponding object in other window
   1.126 +@end table
   1.127 +
   1.128 +@noindent
   1.129 +do the same job as @kbd{[prefix] g} except it's done in other window.
   1.130 +Note that this function doesn't work on @code{begin/end},
   1.131 +@code{%#BEGIN/%#END} pairs because it is meaningless.
   1.132 +
   1.133 +@section Jump to main file
   1.134 +
   1.135 +  Typing
   1.136  
   1.137  @table @kbd
   1.138  @item [prefix] ^
   1.139 @@ -991,6 +1015,8 @@
   1.140  in a sub text switch the buffer to the main text specified by
   1.141  @code{%#!}  notation.
   1.142  
   1.143 +@section Other jumping features
   1.144 +
   1.145    And these are the functions which work on the current La@TeX{}
   1.146  environment:
   1.147  
   1.148 @@ -1006,7 +1032,7 @@
   1.149  @cindex M-C-e
   1.150  @cindex M-C-@@
   1.151  
   1.152 -@node Changing and Deleting, Filling an item, Cursor jump, Top
   1.153 +@node Changing and Deleting, Filling, Cursor jump, Top
   1.154  @comment  node-name,  next,  previous,  up
   1.155  @chapter Changing and Deleting
   1.156  
   1.157 @@ -1084,13 +1110,16 @@
   1.158         ~(cursor)
   1.159  @end example
   1.160  
   1.161 -@node Filling an item, Updation of @code{\includeonly}, Changing and Deleting, Top
   1.162 +@node Filling, Updation of @code{\includeonly}, Changing and Deleting, Top
   1.163  @comment  node-name,  next,  previous,  up
   1.164 -@chapter Filling an item
   1.165 +@chapter Filling
   1.166 +@cindex filling
   1.167 +
   1.168 +@section Filling an item
   1.169  @cindex filling an item
   1.170  @cindex prefix i
   1.171  
   1.172 -  To fill a term (sentence) of @code{\item}, type
   1.173 +  To fill a term (descriptive sentences) of @code{\item}, type
   1.174  
   1.175  @table @kbd
   1.176  @item [prefix] i
   1.177 @@ -1102,7 +1131,7 @@
   1.178  
   1.179    YaTeX uses the value of  the variable @code{YaTeX-item-regexp} as the
   1.180  regular expression to search item header  in  itemize environment.
   1.181 -If you make a newcommand to itemize terms(eg. @code{\underlineitem}), put
   1.182 +If you make a newcommand to itemize terms(e.g. @code{\underlineitem}), put
   1.183  
   1.184  @lisp
   1.185          (setq YaTeX-item-regexp
   1.186 @@ -1114,7 +1143,42 @@
   1.187  for Emacs-Lisp, name  a newcommand  for  `itemize' beginning  with
   1.188  @code{\item} such as @code{\itembf}, not @code{\bfitem}.
   1.189  
   1.190 -@node Updation of @code{\includeonly}, What column?, Filling an item, Top
   1.191 +  This function -- YaTeX-fill-item -- reformats the @code{\item} into
   1.192 +`hang-indented' style.  When you separate the topic word and its
   1.193 +description, use @kbd{M-q} instead.  For example:
   1.194 +
   1.195 +@example
   1.196 +Hang indentation:
   1.197 +       >
   1.198 +       >\item[foo] `foo' is the typical word for describing an
   1.199 +       >           arbitrarily written....
   1.200 +
   1.201 +Normal indentation:
   1.202 +       >
   1.203 +       > \item bar
   1.204 +       >
   1.205 +       > When the word `for' is used as an arbitrarily word, `bar' 
   1.206 +       > is bound to follow it.
   1.207 +@end example
   1.208 +
   1.209 +  Note that the indent depth of the @code{\item} and its descriptive
   1.210 +paragraph are the same in latter case.  If you want to use different
   1.211 +depth, invoke fill-paragraph at the beginning of non-whitespace
   1.212 +character(see below).
   1.213 +
   1.214 +@section Filling paragraph
   1.215 +@cindex Filling paragraph
   1.216 +@cindex M-q
   1.217 +
   1.218 +  Fill-paragraph is little bit adapted for La@TeX{} sources.  It retains from
   1.219 +filling in certain environments where formatting leads to a disaster such
   1.220 +as verbatim, tabular, or so.  And it protects @code{\verb} expressions
   1.221 +from being folded (The variable @code{YaTeX-verb-regexp} controls this).
   1.222 +Besides, putting cursor on the first occurrence of non-whitespace
   1.223 +character on a line changes the fill-prefix temporarily to the depth of
   1.224 +the line.
   1.225 +
   1.226 +@node Updation of @code{\includeonly}, What column?, Filling, Top
   1.227  @comment  node-name,  next,  previous,  up
   1.228  @chapter Updation of @code{\includeonly}
   1.229  @cindex includeonly
   1.230 @@ -1448,6 +1512,11 @@
   1.231          Regexp of La@TeX{} itemization command (@code{"\\\\(sub\\)*item"})
   1.232  @end defvar
   1.233  
   1.234 +@defvar YaTeX-verb-regexp
   1.235 +        Regexp of La@TeX{} verb command family.  Omit \\\\.
   1.236 +        (@code{"verb\\*?\\|path"})
   1.237 +@end defvar
   1.238 +
   1.239  @defvar         YaTeX-nervous
   1.240          T for using local dictionary (@code{t})
   1.241  @end defvar
   1.242 @@ -1475,6 +1544,12 @@
   1.243          Switch math-mode automatically(@code{t})
   1.244  @end defvar
   1.245  
   1.246 +@defvar YaTeX-math-key-list-private
   1.247 +        User defined alist, math-mode-prefix vs completion alist
   1.248 +        used in image completion(@code{nil}).  See @file{yatexmth.el}
   1.249 +        for the information about how to define a completion alist.
   1.250 +@end defvar
   1.251 +
   1.252  @defvar YaTeX-default-pop-window-height
   1.253          Initial height of typesetting buffer when one-window.
   1.254          Number for the lines of the buffer, numerical string for
   1.255 @@ -1624,7 +1699,7 @@
   1.256  concatenating `YaTeX::' and section-type command, is called automatically
   1.257  with an integer argument which indicates which argument of section-type
   1.258  command is being read.  Thus the add-in should determine the
   1.259 -job refering the value of its argument.
   1.260 +job referring the value of its argument.
   1.261  
   1.262  @menu
   1.263  * Defining `option add-in'::    
   1.264 @@ -1718,13 +1793,13 @@
   1.265  @itemx [A]
   1.266  Base prompt, X-axis prompt, Y-axis prompt     (each optional)        
   1.267  @itemx [D]
   1.268 -  Read the coodinates with the prompt ``BasePrompt X-axisPrompt:'' for
   1.269 +  Read the coordinates with the prompt ``BasePrompt X-axisPrompt:'' for
   1.270  X-axis, ``BasePrompt Y-axisPrompt:'' for Y-axis, and return it in the form 
   1.271 -of ``(X,Y)''.  The default prompts are @code{Dimention}, @code{X},
   1.272 +of ``(X,Y)''.  The default prompts are @code{Dimension}, @code{X},
   1.273  @code{Y} respectively.
   1.274  
   1.275  @item [F]
   1.276 -YaTeX:check-comletion-type
   1.277 +YaTeX:check-completion-type
   1.278  @itemx [A]
   1.279  One of the symbols: 'begin, 'section, or 'maketitle
   1.280  @itemx [D]
   1.281 @@ -1831,9 +1906,9 @@
   1.282  @item Position
   1.283  read positional option (like [htbp])
   1.284  @item Coord.
   1.285 -read coodinates
   1.286 +read coordinates
   1.287  @item Quit
   1.288 -quit from genarating
   1.289 +quit from generating
   1.290  @end table
   1.291  
   1.292    Since (A) is the optional argument to specify the location of included
   1.293 @@ -1930,7 +2005,7 @@
   1.294  @subsection Contribution
   1.295  
   1.296    If you get your own pretty function and you let it be in public, please 
   1.297 -steel yourself in the happy atomospher and do not send me the function.
   1.298 +steel yourself in the happy atmosphere and do not send me the function.
   1.299  I do know it is not fine because it is generated by yatexgen:-p.
   1.300  
   1.301  @node Etcetera, Copying, Customizations, Top
   1.302 @@ -1944,6 +2019,8 @@
   1.303  use completion  in order to  enrich your dictionary,  and you will
   1.304  also find `Wild Bird' growing suitable for your La@TeX{} style.
   1.305  
   1.306 +  The package name `Wild Bird' is the English translation of Japanese
   1.307 +title `Yachou', which is a trick on words of Japanese.
   1.308  
   1.309  @node Copying,  , Etcetera, Top
   1.310  @comment  node-name,  next,  previous,  up