emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[O] [RFC] Make QUOTE an export keyword instead of an element type


From: Nicolas Goaziou
Subject: [O] [RFC] Make QUOTE an export keyword instead of an element type
Date: Sun, 26 Jan 2014 14:57:26 +0100

Hello,

Quote sections are special sections triggered when their headline
container has the "QUOTE" keyword in it:

  * QUOTE Headline

    This is a quote section.

They are inherited (as many other things) from the previous export
framework. The behaviour of this keyword in undocumented in Org manual,
but, judging by old sources, it means that contents of such an headline
should be exported verbatim (i.e. as an /example/ block, not a /quote/
block).

At the moment, they are parsed specially by Org Elements, but I think it
is a mistake. Like "COMMENT" keyword in headlines, "QUOTE" is more an
instruction for the export framework. Therefore, they should be parsed
as regular sections, and treated specially during export. The following
patches permit it, in 3 steps:

  1. Remove special parsing from "org-element.el",
  2. Turn section contents into a big example block.
  3. Remove quote section translators from export back-ends (contrib
     directory handled separately)

This change implies that any quote-section translator and filter is
ignored (but it will not generate an error if present). It also means
that an export back-end cannot tell the difference between an example
block and a quote section.

Since quote sections were treated as example blocks (except in
ox-ascii.el), the export behaviour will remain unchanged (except in
ox-ascii.el).

Alternatives:

 - Treat their contents as `quote-blocks' instead of `example-block'
 - Remove them altogether, since they don't bring anything new.

As a side note, if they are here to stay, it would be good to document
them.

WDYT?


Regards,

-- 
Nicolas Goaziou

Attachment: 0001-org-element-Do-not-parse-quote-sections-specially.patch
Description: Text Data

Attachment: 0002-ox-Handle-quote-sections-internally.patch
Description: Text Data

Attachment: 0003-Export-back-ends-Remove-quote-section-translators.patch
Description: Text Data

Attachment: 0004-ox-groff-Remove-quote-section-translator.patch
Description: Text Data


reply via email to

[Prev in Thread] Current Thread [Next in Thread]