Re: [AUCTeX-devel] patch with improved commit message

[Tassilo Horn]

Uwe Brauer <address@hidden> writes:

> Subject: [PATCH] Add informations about prettify and semi WYSIWYG

"information" is already plural.

> * doc/auctex.texi (Display): Repair some markup
> questions. Add sentences about
> prettify-symbols-unprettify-at-point. Add paragaph about Semi WYSIWYG.

The markup questions were only in text you've edited/added in a previous
HG changeset.  Nobody will see them here, so there's no use in
mentioning that in the ChangLog entry.

We also use double-space sentence ends in ChangeLog entries.

> diff --git a/doc/auctex.texi b/doc/auctex.texi
> index 673b6ad..627df9d 100644
> --- a/doc/auctex.texi
> +++ b/doc/auctex.texi
> @@ -102,7 +102,7 @@ navigation and a few other things.  
> (@pxref{Installation,,,reftex,The
>  address@hidden manual})
>  
>  For detailed information about the @previewlatex{} subsystem of
> address@hidden, see @ref{Top,,Introduction,preview-latex,The @previewlatex{}
> address@hidden, see @xref{Top,,Introduction,preview-latex,The @previewlatex{}
>  Manual}.

Ah, I'm sorry.  I was wrong with that @xref thing.  @xref is only for
references at the start of a sentence (and then it adds a "See" in front
of the reference).  So please keep the @ref as is or use "(@pxref{...})"
which produces "see <RefText>".  @pxref if for use in parentheses.

> -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
> address@hidden to @code{invisible} so that the
> address@hidden and @code{_} in sub and superscripts are not displayed.

Making it invisible is just one possibility.  Mainly the variable's
purpose is to raise/lower text in super/subscripts.

> +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
> address@hidden, see @xref{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,6 +2185,10 @@ variables @code{font-latex-fontify-script} and
>  @defopt font-latex-fontify-script
>  If non-nil, fontify subscript and superscript strings.
>  
> +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}.

What about `multi-level'?  I think in a previous patch of yours, that
has already been included.

>  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.
> @@ -2183,7 +2198,7 @@ for versions 21.3 and before due to it working not 
> properly.
>  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

Don't change that @ref to @xref please.

>  Display Specifications, elisp, GNU Emacs Lisp Reference Manual}.
>  @end defopt
>  
> @@ -2587,7 +2602,7 @@ will no longer be required for them.
>  @section Prettifying
>  
>  Emacs 25 is able to prettify symbols in programming language buffers,
> address@hidden for Programs,,,emacs,GNU Emacs Manual}.  The canonical
> address@hidden for Programs,,,emacs,GNU Emacs Manual}. The canonical

Here you removed the double-space at the end of the sentence.

>  example is to display @code{(lambda () ...)} as @code{(λ () ...)} in
>  Lisp buffers.
>  
> @@ -2595,7 +2610,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
> address@hidden to t or @code{right-edge}
> +which will unprettify the symbol when point moves into or near it.

That's good.

Bye,
Tassilo