Karthik Chikmagalur <karthikchikmaga...@gmail.com> writes:

> Please pull from tecosaur's fork to see the updated version of the
> manual.  

Thanks!

>>> -#+vindex: org-format-latex-header
>>> +#+vindex: org-latex-preview-header
>>
>> I think that it is a good idea for the time being to leave old index
>> entries, so that people can still search the manual using the obsolete
>> variable names.
>
> I've left it in.

But not in all the places where you replaced #+vindex. Let's leave it
everywhere and only remove the obsolete vindex entry from the manual
when we actually remove that variable.

> - Live previews: In addition to the above, continuously preview LaTeX
>   fragments as you type, giving you near immediate feedback
>   (especially when using =pdflatex=).  The preview image will continue
>   to be displayed adjacent to the fragment even when editing it.

I think you can remove "In addition to the above" as it is already a list.

> - (~org-latex-preview-auto-mode~) ::
>   #+findex: org-latex-preview-auto-mode
> 
>   Generate previews of LaTeX fragments as they are entered in the
>   buffer.  Previews will be generated (removed) when there is any
>   change to the buffer that includes the insertion (deletion) of a
>   LaTeX environment or fragment.

When reading this section, I feel confused about the difference between
"automatic" and "live" previews. The words "automatic" and "live" feel
too similar: "Generate previews of LaTeX fragments as they are entered
in the buffer" can be interpreted both as "automatic" and "live".

The above description is also not fully consistent with the minor mode
docstring:

> LaTeX fragments in Org
> buffers are automatically previewed after being inserted, and
> hidden when the cursor moves into them

IMHO, `org-latex-preview-auto-mode' is kind of doing double job: (1)
implementing something akin org-appear; (2) providing live preview for
newly inserted and edited fragments.

May these two jobs be separated? I feel like the minimal job that is
done by `org-latex-preview-auto-mode' is closer to org-appear, and it
would better be called `org-latex-preview-appear-mode'. Then, a
reasonable design for customization will be:
1. Configure whether the previews are completely hidden or just
   displayed aside/below when the cursor enters latex formula. This may
   be a single customization.
2. Configure whether new previews are also automatically created when
   the new fragments are inserted/edited.

Maybe (2) can even be a mode of its own.

>   Generate previews of LaTeX fragments as they are entered in the
>   buffer.  Previews will be generated (removed) when there is any
>   change to the buffer that includes the insertion (deletion) of a
>   LaTeX environment or fragment.

generated (removed) and insertion (deletion) read slightly confusing.
Maybe generated (or removed) and insertion (or deletion)?

> You can control where LaTeX previews are cached by customizing
> ~org-latex-preview-cache~.  By default, Org stores them in the
> org-persist cache with an expiry determined by

Maybe we can instead refer to `org-persist-directory', as we do not talk
about org-persist in the manual (for now).

> You can customize ~org-latex-preview-preamble~ to specify the default
> LaTeX preamble used for processing LaTeX fragments.  This can include
> the placeholder strings =[DEFAULT-PACKAGES]= and =[PACKAGES]= to
> include packages specified in ~org-latex-default-packages-alist~ and
> ~org-latex-packages-alist~ respectively.  When previewing, this
> preamble will be combined with keywords specified in the document via

We may refer to `org-latex-classes' for more detailed description of the
placeholders.

> If the results are not to your liking, you can customize the
> appearance of LaTeX previews by modifying
> ~org-latex-preview-appearance-options~. This plist can be used to
> specify the following aspects of the apperance of LaTeX previews:

*appearance

> - Page width: The ~:page-width~ property determines the width of the
>   preview image (including whitespace padding) of display-math
>   environments.

What is "display-math"?

> **** New options
> 
> ***** New option ~org-latex-preview-cache~ to enable preview image caching

I think that you do not need to list every single new option in the
news. It should be enough to (1) Say that we have a new library
org-latex-preview.el. (2) That the relevant options can be found via M-x
cusomize-group ... and in the manual.

Obsolete and changed existing options should still be listed, but
probably moved to "New and changed options"/"Removed or renamed functions and 
variables".
Also, the renamed options can be grouped under a single heading.

> +If you still want to use python-mode with ob-python, you might
> +consider 
> [[https://gitlab.com/jackkamm/ob-python-mode-mode][ob-python-mode-mode]], 
> where the code to support python-mode
> +has been ported to.

This is a stray change (or problem with rebasing).

> It should be org-latex-preview-preamble everywhere.  ob-latex.el is not
> yet fixed, please ignore this file for now.

Ok. Leaving for later.

> I will address the :matchers issue in a separate email.

Ok.

-- 
Ihor Radchenko // yantar92,
Org mode maintainer,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Reply via email to