1.1 --- a/docs/yatexe.tex	Sat Dec 02 18:35:28 1995 +0000
     1.2 +++ b/docs/yatexe.tex	Thu Feb 01 18:55:47 1996 +0000
     1.3 @@ -25,7 +25,7 @@
     1.4  @cindex YaTeX
     1.5  
     1.6  @menu
     1.7 -* What is YaTeX?::              Introduction
     1.8 +* What is YaTeX?::              
     1.9  * Main features::               What YaTeX can do
    1.10  * Installation::                Guide to install
    1.11  * Typesetting::                 Call typesetting processes
    1.12 @@ -48,6 +48,12 @@
    1.13  
    1.14   --- The Detailed Node Listing ---
    1.15  
    1.16 +Typesetting
    1.17 +
    1.18 +* Calling typesetter::          
    1.19 +* Calling previewer::           
    1.20 +* Printing out::                
    1.21 +
    1.22  %# notation
    1.23  
    1.24  * Changing typesetter::         
    1.25 @@ -91,12 +97,12 @@
    1.26  
    1.27  Procedure
    1.28  
    1.29 -* How the add-in function works?::  
    1.30 +* How the add-in function works::  
    1.31  * How the function is called::  
    1.32  * Useful functions for creating add-in::  
    1.33  * Contribution::                
    1.34  
    1.35 -How the add-in function works?
    1.36 +How the add-in function works
    1.37  
    1.38  * Defining `option add-in'::    
    1.39  * Defining `argument add-in'::  
    1.40 @@ -138,7 +144,7 @@
    1.41  @item Easy input of accent mark, math-mode's commands and Greek letters
    1.42          (@kbd{C-c a}, @kbd{;}, @kbd{:})
    1.43  @item Online help for the popular La@TeX{} commands
    1.44 -      (@kbd{C-c ?}, @kbd{C-c /})(English help is not yet supported)
    1.45 +      (@kbd{C-c ?}, @kbd{C-c /})
    1.46  @item Document files hierarchy browser (@kbd{C-c d})
    1.47  @end itemize
    1.48  
    1.49 @@ -189,25 +195,37 @@
    1.50  strokes execute typeset or preview command.
    1.51  
    1.52  @table @kbd
    1.53 -@item [prefix] tj
    1.54 +@item [prefix] t j
    1.55          @dots{} invoke latex
    1.56 -@item [prefix] tr
    1.57 +@item [prefix] t r
    1.58          @dots{} invoke latex on region
    1.59 -@item [prefix] tk
    1.60 +@item [prefix] t k
    1.61          @dots{} kill current typesetting process
    1.62 -@item [prefix] tb
    1.63 +@item [prefix] t b
    1.64          @dots{} invoke bibtex
    1.65 -@item [prefix] tp
    1.66 +@item [prefix] t p
    1.67          @dots{} preview
    1.68 -@item [prefix] tl
    1.69 +@item [prefix] t l
    1.70          @dots{} lpr dvi-file
    1.71 +@item [prefix] t s
    1.72 +        @dots{} search current string on xdvi-remote
    1.73  @end table
    1.74  
    1.75 -  The current editing window will be divided horizontally when you
    1.76 -invoke latex command, and log message of La@TeX{} typesetting will be
    1.77 -displayed   in the other window;   called typesetting buffer.  The
    1.78 -typesetting  buffer automatically  scrolls  up  and  traces  La@TeX{}
    1.79 -warnings and  error  messages.  If  you  see latex stopping  by an
    1.80 +@menu
    1.81 +* Calling typesetter::          
    1.82 +* Calling previewer::           
    1.83 +* Printing out::                
    1.84 +@end menu
    1.85 +
    1.86 +@node Calling typesetter, Calling previewer, Typesetting, Typesetting
    1.87 +@comment  node-name,  next,  previous,  up
    1.88 +@section{Calling typesetter}
    1.89 +
    1.90 +  Typing @kbd{[prefix] t j}, the current editing window will be divided
    1.91 +horizontally when you invoke latex command, and log message of La@TeX{}
    1.92 +typesetting will be displayed in the other window; called typesetting
    1.93 +buffer.  The typesetting buffer automatically scrolls up and traces
    1.94 +La@TeX{} warnings and error messages.  If you see latex stopping by an
    1.95  error, you can send string to latex in the typesetting buffer.
    1.96  
    1.97    If an error  stops the La@TeX{}  typesetting, this  key stroke will
    1.98 @@ -233,8 +251,23 @@
    1.99  file if you edit one  file,  and is the same as main file's if you
   1.100  edit splitting files.
   1.101  
   1.102 -  YaTeX asks you the range of dvi-printing by default.  You can
   1.103 -skip this by invoking it with universal-argument as follows:
   1.104 +@node Calling previewer, Printing out, Calling typesetter, Typesetting
   1.105 +@comment  node-name,  next,  previous,  up
   1.106 +@section{Calling previewer}
   1.107 +
   1.108 +  @kbd{[prefix] t p} invokes the TeX previewer.  And if you are using
   1.109 +xdvi-remote, which can be controled from other terminals, @kbd{[prefix] t
   1.110 +s} enables you to search current string at the cursor on the running xdvi
   1.111 +window.  You can get xdvi with `-remote feature' from;
   1.112 +@code{ftp://ftp.ae.keio.ac.jp/pub/text/xdvi/xdvi-remote}.
   1.113 +
   1.114 +@node Printing out,  , Calling previewer, Typesetting
   1.115 +@comment  node-name,  next,  previous,  up
   1.116 +@section{Printing out}
   1.117 +
   1.118 +  When you type @code{[preifx] t l}, YaTeX asks you the range of
   1.119 +dvi-printing by default.  You can skip this by invoking it with
   1.120 +universal-argument as follows:
   1.121  
   1.122  @example
   1.123          C-u [prefix] tl
   1.124 @@ -519,6 +552,10 @@
   1.125  user completion table.  YaTeX automatically saves the user completion
   1.126  table in the user dictionary file at exiting of emacs.
   1.127  
   1.128 +At the completion of certain environments, the expected initial entry will 
   1.129 +automatically inserted such as @code{\item} for @code{itemize}
   1.130 +environment.  If you don't want the entry, it can be removed by undoing.
   1.131 +
   1.132    If you want to  enclose some paragraphs  which have already been
   1.133  written, invoke the  begin-type completion with changing  the case
   1.134  of @kbd{b} of key sequence upper(or invoke it with  universal argument
   1.135 @@ -660,6 +697,38 @@
   1.136  under certain level by 0 through 6.  Type @kbd{?}  in the minibuffer of
   1.137  sectioning prompt for more information.
   1.138  
   1.139 +  You can generate this listing buffer (@code{*Sectioning Lines*} buffer)
   1.140 +by typing
   1.141 +@table @kbd
   1.142 +@item M-x YaTeX-section-overview
   1.143 +        @dots{} Generate *Sectioning Lines* buffer
   1.144 +@end table
   1.145 +@cindex{Generate the listing of sectioning units}
   1.146 +from the LaTeX source buffer.  In this listing buffer, typing @kbd{u} on
   1.147 +the sectioning command shifts up the corresponding sectioning command in
   1.148 +source text and @kbd{d} shifts down.  After marking lines in the listing
   1.149 +buffer, typing @kbd{U} shifts up all sectioning commands in the region,
   1.150 +and @kbd{U} shifts down.  Here are all the key bindings of
   1.151 +@code{*Sectioning Lines*} buffer.
   1.152 +
   1.153 +@table @kbd
   1.154 +@item SPC
   1.155 +        @dots{} Jump to corresponding source line
   1.156 +@item .
   1.157 +        @dots{} Display corresponding source line
   1.158 +@item u
   1.159 +        @dots{} Shift up a sectioning line
   1.160 +@item d
   1.161 +        @dots{} Shift down a sectioning line
   1.162 +@item U
   1.163 +        @dots{} Shift up sectioning lines in region
   1.164 +@item D
   1.165 +        @dots{} Shift down sectioning lines in region
   1.166 +@item 0〜6
   1.167 +        @dots{} Hide sectioning commands whose level is lower than n
   1.168 +@end table
   1.169 +
   1.170 +
   1.171  @node Large-type completion, Maketitle-type completion, Section-type completion, Completion
   1.172  @comment  node-name,  next,  previous,  up
   1.173  @section Large-type completion
   1.174 @@ -849,8 +918,8 @@
   1.175    Math-mode of YaTeX provides another image completion, Greek letters
   1.176  completion in the same method.  After prefix @kbd{:}, typing @kbd{a} makes
   1.177  @code{\alpha}, @kbd{b} makes @code{\beta} and @kbd{g} makes @code{\gamma}
   1.178 -and so on.  First, type @kbd{/TAB} to know all the correspondence of
   1.179 -alphabets v.s. Greek letters.
   1.180 +and so on.  First, type @kbd{:TAB} to know all the correspondence of
   1.181 +alphabets vs. Greek letters.
   1.182  
   1.183    If you will find @kbd{;} or @kbd{:} doesn't work in correct position of
   1.184  math environment, it may be a bug of YaTeX.  Please send me a bug report
   1.185 @@ -1114,7 +1183,7 @@
   1.186         ~(cursor)
   1.187  @end example
   1.188  
   1.189 -@node Filling, Updation of @code{\includeonly}, Changing and Deleting, Top
   1.190 +@node Filling, Updation of includeonly, Changing and Deleting, Top
   1.191  @comment  node-name,  next,  previous,  up
   1.192  @chapter Filling
   1.193  @cindex filling
   1.194 @@ -1125,8 +1194,12 @@
   1.195  
   1.196    To fill a term (descriptive sentences) of @code{\item}, type
   1.197  
   1.198 +@c @table @kbd
   1.199 +@c @item [prefix] i
   1.200 +@c         @dots{} fill item
   1.201 +@c @end table
   1.202  @table @kbd
   1.203 -@item [prefix] i
   1.204 +@item M-q
   1.205          @dots{} fill item
   1.206  @end table
   1.207  
   1.208 @@ -1139,7 +1212,7 @@
   1.209  
   1.210  @lisp
   1.211          (setq YaTeX-item-regexp
   1.212 -              "\\(\\\\item\\)\\|\\(\\\\underlineitem\\)")
   1.213 +              "\\(\\\\\\(sub\\)*item\\)\\|\\(\\\\underlineitem\\)")
   1.214  @end lisp
   1.215  @cindex YaTeX-item-regexp
   1.216  
   1.217 @@ -1147,22 +1220,17 @@
   1.218  for Emacs-Lisp, name  a newcommand  for  `itemize' beginning  with
   1.219  @code{\item} such as @code{\itembf}, not @code{\bfitem}.
   1.220  
   1.221 -  This function -- YaTeX-fill-item -- reformats the @code{\item} into
   1.222 -`hang-indented' style.  When you separate the topic word and its
   1.223 -description, use @kbd{M-q} instead.  For example:
   1.224 +  This function reformats the @code{\item} into `hang-indented' style.
   1.225 +For example:
   1.226  
   1.227  @example
   1.228 -Hang indentation:
   1.229 +itemize, enumerate environment:
   1.230         >
   1.231         >\item[foo] `foo' is the typical word for describing an
   1.232         >           arbitrarily written....
   1.233 -
   1.234 -Normal indentation:
   1.235 -       >
   1.236 -       > \item bar
   1.237 -       >
   1.238 -       >       When the word `for' is used as an arbitrarily word, `bar' 
   1.239 -       >       is bound to follow it.
   1.240 +description environment:
   1.241 +       > \item[bar] When the word `for' is used as an arbitrarily
   1.242 +       >        word, `bar'  is bound to follow it.
   1.243  @end example
   1.244  
   1.245    Note that the indent depth of an @code{\item} word and its descriptive
   1.246 @@ -1214,7 +1282,7 @@
   1.247  by the current file, and type @kbd{%} to comment out the
   1.248  @code{\includeonly} line.
   1.249  
   1.250 -@node What column?, Intelligent newline, Updation of @code{\includeonly}, Top
   1.251 +@node What column?, Intelligent newline, Updation of includeonly, Top
   1.252  @comment  node-name,  next,  previous,  up
   1.253  @chapter What column?
   1.254  @cindex what column
   1.255 @@ -1259,7 +1327,8 @@
   1.256  @cindex ESC RET
   1.257  @cindex M-C-m
   1.258  
   1.259 -  In tabular[*], array, itemize, enumerate or tabbing environment,
   1.260 +  At the end of begin-type completion of tabular[*], array, itemize,
   1.261 +enumerate or tabbing environment, or typing 
   1.262  
   1.263  @table @kbd
   1.264  @item ESC RET
   1.265 @@ -1267,11 +1336,12 @@
   1.266  @end table
   1.267  
   1.268  @noindent 
   1.269 -inserts the contents corresponding to the current environment in the next
   1.270 -line.  In @code{tabular} environment, for example, @kbd{ESC RET} inserts
   1.271 -the certain number of @code{&} and trailing @code{\\}, and @code{\hline}
   1.272 -if other @code{\hline} is found in backward.  Here are the list of
   1.273 -contents v.s. environments.
   1.274 +in these environments inserts the contents corresponding to the current
   1.275 +environment in the next line.  (At the begin-type completion, this
   1.276 +contents can be removed by `undo'.)  In @code{tabular} environment, for
   1.277 +example, @kbd{ESC RET} inserts the certain number of @code{&} and trailing
   1.278 +@code{\\}, and @code{\hline} if other @code{\hline} is found in backward.
   1.279 +Here are the list of contents vs. environments.
   1.280  
   1.281  @itemize
   1.282  @item @code{tabular}, @code{tabular*}, @code{array}
   1.283 @@ -1505,11 +1575,6 @@
   1.284          Fill-prefix used in yatex-mode (@code{nil})
   1.285  @end defvar
   1.286  
   1.287 -@defvar YaTeX-open-lines
   1.288 -        Number of blank lines between cursor and @code{\begin@{@}},
   1.289 -        @code{\@code{end}@{@}} (0)
   1.290 -@end defvar
   1.291 -
   1.292  @defvar YaTeX-user-completion-table
   1.293          Name of user dictionary where learned completion table will be stored.
   1.294          (@code{"~/.yatexrc"})
   1.295 @@ -1688,6 +1753,9 @@
   1.296  See also 。@code{YaTeX-hilit-sectioning-face}.
   1.297  @end defvar
   1.298  
   1.299 +@defvar YaTeX-use-AMS-LaTeX
   1.300 +If you use AMS-LaTeX, set to @code{t}(@code{nil}).
   1.301 +@end defvar
   1.302  
   1.303  @node Sample definitions, Hook variables, All customizable variables, Lisp variables
   1.304  @comment  node-name,  next,  previous,  up
   1.305 @@ -1731,7 +1799,7 @@
   1.306  @subsection Hook file
   1.307  @cindex hook file
   1.308  
   1.309 -  You can stuff all of YaTeX relating expressions into a file named
   1.310 +  You can stuff all of YaTeX related expressions into a file named
   1.311  @file{yatexhks.el} if you have a lot of codes.  YaTeX automatically load
   1.312  this file at the initialization of itself.  Using @file{yatexhks.el}
   1.313  makes @code{yatex-mode-load-hook} unnecessary.
   1.314 @@ -1766,15 +1834,15 @@
   1.315  @end enumerate
   1.316  
   1.317  @menu
   1.318 -* How the add-in function works?::  
   1.319 +* How the add-in function works::  
   1.320  * How the function is called::  
   1.321  * Useful functions for creating add-in::  
   1.322  * Contribution::                
   1.323  @end menu
   1.324  
   1.325 -@node How the add-in function works?, How the function is called, Add-in functions, Add-in functions
   1.326 +@node How the add-in function works, How the function is called, Add-in functions, Add-in functions
   1.327  @comment  node-name,  next,  previous,  up
   1.328 -@subsection How the add-in function works?
   1.329 +@subsection How the add-in function works
   1.330  
   1.331    There are two kinds of add-in.  @dfn{Option add-in} returns the
   1.332  La@TeX{}'s optional parameters such as optional strings after
   1.333 @@ -1814,7 +1882,7 @@
   1.334  * Defining `argument add-in'::  
   1.335  @end menu
   1.336  
   1.337 -@node Defining `option add-in', Defining `argument add-in', How the add-in function works?, How the add-in function works?
   1.338 +@node Defining `option add-in', Defining `argument add-in', How the add-in function works, How the add-in function works
   1.339  @comment  node-name,  next,  previous,  up
   1.340  @subsubsection Defining `option add-in'
   1.341  
   1.342 @@ -1841,7 +1909,7 @@
   1.343            (concat "{" (read-string "Rule: ") "}"))
   1.344  @end lisp
   1.345  
   1.346 -@node Defining `argument add-in',  , Defining `option add-in', How the add-in function works?
   1.347 +@node Defining `argument add-in',  , Defining `option add-in', How the add-in function works
   1.348  @comment  node-name,  next,  previous,  up
   1.349  @subsubsection Defining `argument add-in'
   1.350  
   1.351 @@ -1864,7 +1932,7 @@
   1.352    Note that when the `argument add-in' function return `nil', normal
   1.353  argument reader will be called.
   1.354  
   1.355 -@node How the function is called, Useful functions for creating add-in, How the add-in function works?, Add-in functions
   1.356 +@node How the function is called, Useful functions for creating add-in, How the add-in function works, Add-in functions
   1.357  @comment  node-name,  next,  previous,  up
   1.358  @subsection How the function is called
   1.359