diff docs/yatexe.tex @ 392:c44910b36b95 dev

Switch to region-mode if completion called with active region.
author HIROSE Yuuji <yuuji@gentei.org>
date Thu, 15 Jan 2015 23:21:24 +0900
parents 09a2b5a3b3d8
children 781604df4cbd
line wrap: on
line diff
--- a/docs/yatexe.tex	Thu Jan 15 23:20:31 2015 +0900
+++ b/docs/yatexe.tex	Thu Jan 15 23:21:24 2015 +0900
@@ -8,7 +8,7 @@
 
 @iftex
 @c @syncodeindex fn cp
-@c Last modified Sun Jan  4 18:17:02 2015 on firestorm
+@c Last modified Thu Jan 15 13:28:10 2015 on firestorm
 @syncodeindex vr cp
 @end iftex
 
@@ -77,7 +77,7 @@
         @code{\section} etc. 
         (@kbd{C-c b}, @kbd{C-c s}, @kbd{C-c l}, @kbd{C-c m})
 @item Enclosing text into La@TeX{} environments or commands
-      (@kbd{C-u} @var{AboveKeyStrokes})
+      (@var{AboveKeyStrokes} after region setting)
 @item Displaying the structure of text at entering sectioning commands
 @item Lump shifting of sectioning commands (@ref{view-sectioning})
 @item Learning unknown/new La@TeX{} commands for the next completion
@@ -146,12 +146,12 @@
 
 @table @kbd
 @item [prefix] t j
-        @dots{} invoke latex
+        @dots{} invoke typesetter
 @item [prefix] t r
-        @dots{} invoke latex on region
+        @dots{} invoke typesetter on region
 @item [prefix] t e
-        @dots{} invoke latex on current environment or whole
-         portion of current formulas in math-mode.
+        @dots{} `on-the-fly preview' on current environment or whole
+         portion of current formulas in math-mode
 @item [prefix] t d
 	@dots{} invoke dvipdfmx after successful typesetting
 @item [prefix] t k
@@ -215,9 +215,16 @@
 edit splitting files.
 
   The @kbd{[prefix] te} key automatically marks current inner environment
-or inner math mode and then call typeset-region with marked region.  This
+or inner math mode or paragraph, and then call typeset-region with marked
+region.  This
 is convenient to quick view of current tabular environment or current
-editing formulas.  Keeping previewer window for @file{texput.dvi} is handy
+editing formulas.  If running Emacs has the ability of displaying images,
+typeset image will be shown in the next window.  Further more,
+if you modify the content within that environment, YaTeX performs
+`on-the-fly' preview that automatically update preview image as you typed.
+
+If your Emacs does not supply on-the-fly preview,
+keeping previewer window for @file{texput.dvi} is handy
 for debugging.  Since @kbd{[prefix] te} selects the inner-most environment
 as region, it is not suitable for partial typesetting of doubly or more
 composed environment.  If you want to do partial typesetting for a nested
@@ -369,7 +376,7 @@
 @code{%#BEGIN} alone at the middle of very long text.  Do not forget to
 erase @code{%#BEGIN} @code{%#END} pair.
 
-@node Lpr format, Controlling which command to invoke, Static region for typesetting, %#notation
+@node Lpr format,  , Static region for typesetting, %#notation
 @comment  node-name,  next,  previous,  up
 @section Lpr format
 @cindex lpr format
@@ -464,15 +471,16 @@
 kinds of completion type, begin-type, section-type, large-type, etc...
 
 @menu
-* Begin-type completion::       
-* Section-type completion::     
-* Large-type completion::       
-* Maketitle-type completion::   
-* Arbitrary completion::        
-* End completion::              
-* Accent completion::           
-* Image completion::            
-* Greek letters completion::    
+* Begin-type completion::
+* Section-type completion::
+* Large-type completion::
+* Maketitle-type completion::
+* Arbitrary completion::
+* End completion::
+* Accent completion::
+* Image completion::
+* Greek letters completion::
+* Inserting parentheses::
 @end menu
 
 @node Begin-type completion, Section-type completion, Completion, Completion
@@ -559,26 +567,15 @@
 automatically inserted such as @code{\item} for @code{itemize}
 environment.  If you don't want the entry, it can be removed by undoing.
 
-  If you want to  enclose some paragraphs  which have already been
-written, invoke the  begin-type completion with changing  the case
-of @kbd{b} of key sequence upper(or invoke it with  universal argument
-by @kbd{C-u} prefix).
+  If you want to enclose some paragraphs which have already been written
+into environment, invoke the begin-type completion right after region marking.
 @cindex enclose region into environment
 
-  The following example encloses a region with `description'
-environment.
-
-@table @kbd
-@item [prefix] B D
-@itemx (or ESC 1 [prefix] b D)
-@itemx (or  C-u  [prefix] b D)
-
-        @dots{} begin-type completion for region
-@end table
-
-  This enclosing holds good for the completing input by @kbd{[prefix] b
-SPC}.  @kbd{[prefix] B SPC} enclose a region with the environment selected
-by completing-read.
+If you set @code{transient-mark-mode} to @code{nil} in your
+@file{~/.emacs},  typing @kbd{C-space} (@code{set-mark-command}) twice
+turns @code{transient-mark-mode} on temporarily.  Then, type call
+begin-type completion to enclose text into a environment.
+
 
 @node Section-type completion, Large-type completion, Begin-type completion, Completion
 @comment  node-name,  next,  previous,  up
@@ -755,9 +752,8 @@
 TeX commands to change fonts or sizes, @code{it}, @code{huge} and so on,
 in the completion table.
 
-  Region-based completion is also invoked by changing the letter after
-prefix key stroke as @kbd{[prefix] L}.  It encloses the region by braces
-with large-type command.
+  Region-based completion is also invoked by calling completion
+after region activated.
 
 @node Maketitle-type completion, Arbitrary completion, Large-type completion, Completion
 @comment  node-name,  next,  previous,  up
@@ -912,7 +908,7 @@
 Emacs-Lisp variable @code{YaTeX-math-sign-alist-private}.  See also
 @file{yatexmth.el} for the information of the structure of this variable.
 
-@node Greek letters completion,  , Image completion, Completion
+@node Greek letters completion, Inserting parentheses, Image completion, Completion
 @comment  node-name,  next,  previous,  up
 @section Greek letters completion
 @cindex Greek letters completion
@@ -930,6 +926,15 @@
 @kbd{;} or @kbd{:} after universal-argument(@kbd{C-u}) which forces
 @kbd{;} and @kbd{:} to work as math-prefix.
 
+@node Inserting parentheses,  , Greek letters completion, Completion
+@section Inserting parentheses
+
+  Typing opening parenthesis, one of @code{(}, @code{@{ and @code{[}},
+automatically inserts the closing one.  If a opening bracket is typed
+after @code{\}, @code{\]} is automatically inserted with computed
+indentation.  If you stop automatic insertion, type @kbd{C-q} before
+opening parenthesis.
+
 @node Local dictionaries, Commenting out, Completion, Top
 @comment  node-name,  next,  previous,  up
 @chapter Local dictionaries
@@ -1700,6 +1705,16 @@
 @code{Nil} disables on-the-fly preview.
 @end defvar
 
+@defvar YaTeX-on-the-fly-math-preview-engine
+Function symbol to use on-the-fly preview of MATH environment
+started by @kbd{[prefix] t e} (@code{'YaTeX-typeset-environment-by-lmp}
+which calls latex-math-preview-expression function if latex-math-preview
+is available, otherwise @code{'YaTeX-typeset-environment-by-builtin} which
+alls built-in function).
+
+@code{Nil} disables on-the-fly preview.
+@end defvar
+
 @defvar YaTeX-cmd-gimp
 Command name of GIMP (code{"gimp"})
 @end defvar

yatex.org