This is a record of naming changes proposed to the draft version of
org-latex-preview.el, the LaTeX preview system rewrite for Org.  These
changes were discussed in

https://list.orgmode.org/87tt2o49ja....@gmail.com

and over voice call.  This fork of Org mode is available at

https://git.tecosaur.net/tec/org-mode.git

Naming changes:

org-latex-preview-auto-mode will be renamed to org-latex-preview-mode,
and user options that affect its behavior will be renamed accordingly.

Before:
- org-latex-preview-auto-mode                   (minor mode for automatic 
updates)
  - org-latex-preview-auto-track-inserts        (track and preview new 
fragments?)
  - org-latex-preview-auto-ignored-commands     (don't reveal fragments when...)
  - org-latex-preview-auto-ignored-environments (don't update previews for...)
  - org-latex-preview-live                      (display preview as you edit?)
  - org-latex-preview-live-display-type         (how to display preview as you 
edit?)
  - org-latex-preview-live-debounce             (min delay between updates 
while editing)
  - org-latex-preview-live-throttle             (limit update frequency, 
internal var)     

After:
- org-latex-preview-mode                        (minor mode for automatic 
updates)       
  - org-latex-preview-mode-track-inserts        (track and preview new 
fragments?)       
  - org-latex-preview-mode-ignored-commands     (don't reveal fragments 
when...)        
  - org-latex-preview-mode-ignored-environments (don't update previews for...)  
       
  - org-latex-preview-mode-display              (display preview as you edit?)  
          
  - org-latex-preview-mode-display-type         (how to display preview as you 
edit?)  
  - org-latex-preview-mode-update-delay         (min delay between updates 
while editing)
  - org-latex-preview-mode-update-throttle      (limit update frequency, 
internal var)     

-----------------------

The above is from the discussion. But these seem too long to me now.  I am
considering further shortening them by dropping the -mode, and working around
ambiguities with non-minor-mode behavior:

Suggested:
- org-latex-preview-mode                     (minor mode for automatic updates)
  - org-latex-preview-track-inserts          (track and preview new fragments?)
  - org-latex-preview-ignored-commands       (don't reveal fragments when...)
  - org-latex-preview-untracked-environments (don't update previews for...)
  - org-latex-preview-display                (display preview as you edit?)
  - org-latex-preview-display-type           (how to display preview as you 
edit?)
  - org-latex-preview-update-delay           (min delay between updates while 
editing)
  - org-latex-preview-update-throttle        (limit update frequency, internal 
var)

The only potential ambiguity I see is with
org-latex-preview-untracked-environments: it reads like this could 
apply to M-x org-latex-preview as well, but it actually only applies
to edits made when org-latex-preview-mode is on.

+ Workaround 1: Maybe it can apply to M-x org-latex-preview as well?  This way
  is more consistent, but we lose the ability to manually preview certain
  environments without also auto-previewing them.  I am leaning towards
  this approach.
+ Workaround 2: Maybe the ambiguity is fine?

Let me know if you have suggestions.

Karthik

Reply via email to