From: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
To: Tony Zorman <mail@tony-zorman.com>, emacs-orgmode@gnu.org
Subject: Re: Using org-latex-preview in other major modes
Date: Sun, 21 Apr 2024 20:41:15 -0700 [thread overview]
Message-ID: <87o7a2gj38.fsf@gmail.com> (raw)
In-Reply-To: <87cyqi8rb6.fsf@hyperspace>
> Anyways, before I put this off for much longer, there is some more code
> attached. Live previews (and general environments) work now, and besides
> the above mentioned points there were no new surprises waiting—at least
> for getting the basic functionality to work.
Thank you for the update! This looks promising. I'll test it when I
have time.
> I did notice that precompilation being a bit flaky. In the end, this
> was the result of importing local packages; with the precompilation
> happening somewhere in /tmp/, access to these files wasn't given.
> haven't looked too closely into this—and it's probably a use-case
> that's specific to LaTeX-mode—but it seems worth considering
Sorry, I should have mentioned this in my original write-up. There is a
reason for this, as explained below. This issue should not be happening
in most cases though, so I'll need more details to help.
> (lots of people carry one big style file around that they include in
> all of their projects).
This is true of Org mode files that are intended for LaTeX export too,
but we avoid this problem in Org.
1. Why we precompile in /tmp:
Precompilation is a blocking operation, so we want to do it as
infrequently as possible. Imagine if LaTeX previews in every Org
buffer/file you opened required a precompile step that blocked Emacs
for 3 seconds.
Precompiled dump files are identified by a hash that includes the
preamble and a default-directory. If we precompile in /tmp (or some
other fixed directory), we can reuse dump files for all Org buffers
that have the same preamble, irrespective of where they're located.
Precompiled files are stored in org-persist and don't expire for a
long time. So we'd like to avoid generating loads of them, and reuse
them whenever possible.
1a. Why is precompilation a blocking operation?
It doesn't have to be, but including it in the async chain is a
little annoying. It can be made async in the future.
2. What happens if the user includes a directory-local .sty, .cls or
other tex files in the header?
When precompiling, we check the header to see if it has an \input{}
or \include{} statement. If it does, we assume that there are local
dependencies and precompile it in the default-directory. See
org-latex-preview--create-tex-file for the implementation of this
logic.
Is there some other common way that a LaTeX file can have local
dependencies?
3. How to force precompilation to occur in the default-directory instead
of in /tmp:
Based on 1 and 2, the easiest way would be to add an \input{} or
\include{} statement to the preamble. The current test is very
simple, you can even place it in a LaTeX comment and it should work.
Karthik
next prev parent reply other threads:[~2024-04-22 3:42 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-07 7:22 Using org-latex-preview in other major modes Tony Zorman
2024-04-07 11:59 ` Ihor Radchenko
2024-04-07 18:06 ` Karthik Chikmagalur
2024-04-09 14:11 ` Ihor Radchenko
2024-04-07 17:48 ` Karthik Chikmagalur
2024-04-08 6:23 ` Tony Zorman
2024-04-08 6:36 ` Karthik Chikmagalur
2024-04-09 20:06 ` Tony Zorman
2024-04-21 19:10 ` Tony Zorman
2024-04-22 3:41 ` Karthik Chikmagalur [this message]
2024-04-22 9:29 ` Tony Zorman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87o7a2gj38.fsf@gmail.com \
--to=karthikchikmagalur@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=mail@tony-zorman.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).