branch: elpa
commit 86a4c75b47f1c57b133b935748523cc5c0f721b5
Author: Uwe Brauer <o...@mat.ucm.es>
Commit: Tassilo Horn <t...@gnu.org>
Add information about prettify and semi WYSIWYG features.
* doc/auctex.texi (Display): Add a sentence about
prettify-symbols-unprettify-at-point.
(Fontification of math): add `invisible' to
`font-latex-fontify-script'.
---
doc/auctex.texi | 37 ++++++++++++++++++++++++++++++-------
1 file changed, 30 insertions(+), 7 deletions(-)
diff --git a/doc/auctex.texi b/doc/auctex.texi
index 673b6ad..c8e28f7 100644
--- a/doc/auctex.texi
+++ b/doc/auctex.texi
@@ -1811,8 +1811,19 @@ Moreover, you can focus in a specific portion of the
code by narrowing
the buffer to the desired region. @AUCTeX{} provides also functions to
narrow the buffer to the current group and to @LaTeX{} environments.
-Lastly, @AUCTeX{} with Emacs 25 or later can display certain math macros
-using Unicode characters. That's called prettification.
+Another tool to obtain more WYSIWYG feeling is to set
+@code{font-latex-fontify-script} to @code{invisible} so that the
+@code{^} and @code{_} in sub and superscripts are not displayed.
+
+Lastly, @AUCTeX{} with GNU Emacs 25 or later can display certain math
+macros using Unicode characters. That's called prettification and is
+pretty lightweight and reasonable robust, however it only provides a
+limited WYSIWYG feature compared to @previewlatex{} a subsystem of
+@AUCTeX{}, see @ref{Top,,Introduction,preview-latex,The @previewlatex{}
+Manual} which let LaTeX generate images that are displayed in your
+buffer. It is extremely accurate but sometimes fragile with some
+packages. Please note that you can use prettification and preview-latex
+together.
@menu
* Font Locking:: Font Locking
@@ -2174,16 +2185,25 @@ variables @code{font-latex-fontify-script} and
@defopt font-latex-fontify-script
If non-nil, fontify subscript and superscript strings.
-Note that this feature is not available on XEmacs, for which it is
-disabled per default. In GNU Emacs raising and lowering is not enabled
-for versions 21.3 and before due to it working not properly.
+In addition you can configure Emacs so that the @code{^} and @code{_} in
+sub and superscripts are not displayed. To enable that feature you have
+to set the variable @code{font-latex-fontify-script} to
+@code{invisible}. Another possiblity is setting this variable to
+the symbol @code{multi-level}, then y is raised above x, and z is raised
+above y. With many script levels, the text might become too small to be
+readable.
+
+Note that this feature is not available on XEmacs, for which
+it is disabled per default. In GNU Emacs raising and lowering is not
+enabled for versions 21.3 and before due to it working not properly.
+
@end defopt
@defopt font-latex-script-display
Display specification for subscript and superscript content. The car is
used for subscript, the cdr is used for superscript. The feature is
implemented using so-called display properties. For information on what
-exactly to specify for the values, see @ref{Other Display Specs, , Other
+exactly to specify for the values, see @xref{Other Display Specs, , Other
Display Specifications, elisp, GNU Emacs Lisp Reference Manual}.
@end defopt
@@ -2595,7 +2615,10 @@ Lisp buffers.
and greek letters using their Unicode representation, too. For example,
the @TeX{} code @code{\alpha \times \beta} will be displayed as @code{α
× β}. When point is on one of the characters, it'll be unprettified
-automatically, meaning you see the verbatim text again.
+automatically, meaning you see the verbatim text again. For this
+behaviour however you need to set
+@code{prettify-symbols-unprettify-at-point} to t or @code{right-edge}
+which will unprettify the symbol when point moves into or near it.
To enable prettification in @AUCTeX{}, simply add
@code{prettify-symbols-mode} to @code{TeX-mode-hook}. If you enabled
