From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Shiyuan <gshy2014@gmail.com>
Cc: "emacs-orgmode@gnu.org" <emacs-orgmode@gnu.org>
Subject: Re: org-latex filters
Date: Wed, 30 Jul 2014 20:09:03 +0200 [thread overview]
Message-ID: <87a97qsoqo.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <CAOm4EMukETPeRJxDirPQO2nhUPA2UmLHG=XPxjdBDn9FXaU2Ug@mail.gmail.com> (Shiyuan's message of "Wed, 30 Jul 2014 00:12:31 -0700")
Hello,
Shiyuan <gshy2014@gmail.com> writes:
> I try to understand what the filter system is for and why the
> transcoders itself doesn't suffice. So I take an example and want to see
> how the filters are used in real exporter. I look at ox-latex.el and try
> to make sense of the filters
>
> 1. There are only two filters are used:
>
> :filters-alist '((:filter-options . org-latex-math-block-options-filter)
> (:filter-parse-tree . org-latex-math-block-tree-filter))
>
> The purpose of org-latex-math-block-options-filter seems to be converting
> whatever in the property list of :author, :date, :title to strings of
> latex commands(please correct me if I am wrong). But what is the purpose
> of org-latex-math-block-tree-filter?
The same as `org-latex-math-block-options-filter', but on the parse tree
itself.
> The org-latex--wrap-latex-math-block is quite sophisticate and I don't
> get what it's doing.
It merges contiguous math objects into a single one, and give it a new
type (i.e, a pseudo type), which requires its own translator. For
example:
\(1\)\alpha$+1$
more or less becomes
\(\beta\alpha+1\)
> 2. For the filters of the form :filter-TYPE, there is also a transcoder for
> processing the same TYPE. For example, for bold, there are :filter-bold,
> but bold is also processed in the transcoder specified in the transcoder
> alist when the backend is defined(by org-export-define-backend). When shall
> we use a transcode and when shall we use a filter?
A transcoder is mandatory. It transforms the parsed object into
a string. If there is no transcoder for a given type of object, all
objects of that type will be omitted from output.
A filter is applied on the output of the transcoder, for further
tweaking. Filters mainly target users, who do not have complete control
over transcoders (unless they create their own derived back-end).
There are also three special filters, which are not applied to the
output of a transcoder. Among them, two can be useful even for
a back-end developer: options filter and parse tree filter. For example,
they permit, as in "ox-latex.el" to introduce pseudo objects into the
parsed data.
You can also read "The Filter System" section in "ox.el".
HTH,
--
Nicolas Goaziou
prev parent reply other threads:[~2014-07-30 18:08 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-07-30 7:12 org-latex filters Shiyuan
2014-07-30 18:09 ` Nicolas Goaziou [this message]
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=87a97qsoqo.fsf@nicolasgoaziou.fr \
--to=mail@nicolasgoaziou.fr \
--cc=emacs-orgmode@gnu.org \
--cc=gshy2014@gmail.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).