emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Rasmus <rasmus@gmx.us>
To: emacs-orgmode@gnu.org
Subject: Re: [ox, patch] #+SUBTITLE
Date: Tue, 31 Mar 2015 12:35:18 +0200	[thread overview]
Message-ID: <871tk5jvyx.fsf@gmx.us> (raw)
In-Reply-To: <87d23pzczl.fsf@nicolasgoaziou.fr> (Nicolas Goaziou's message of "Tue, 31 Mar 2015 12:18:38 +0200")

Hi,

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

> As I explained, both are linked:
>
>   - Anything defined in "ox.el" is documented in "Export settings" ;
>   - Anything defined in "ox-backend.el" is documented in "Backend
>     export".
>
> This is a hard rule.

OK.

> Even if it means repeating documentation in three
> different places, some back-end might use differently the same keyword
> than others.
>
> For the record, if the situation ever rises again, I think that
> a keyword can be added to "ox.el" only if
>
>   - it is supported at least in every major back-end (ASCII, HTML,
>     LaTeX, ODT and Texinfo)
>   - it comes with a toggle in the OPTIONS line e.g. keyword:nil

For subtitle I'm reusing :with-title.  If you think it necessary, I can
add a :with-subtitle, but I didn't think it was necessary.

>> So should I also move the SUBTITLE to ox.el or keep it in files?  I think
>> it's OK to just define it in the files where it makes sense...
>
> SUBTITLE, DESCRIPTION and KEYWORDS can be defined in the libraries where
> they are used. Only the documentation needs to be adapted, per above.
>
> Sorry for the confusion.

OK.  So with the above the in mind the game plan seems to be:

     - Remove DESCRIPTION/KEYWORD from it's current position in org.texi
       to backend descriptions and retain them in relevant backends.

       This imply some repetition, but also allows greater details,
       e.g. with latex we can point to the hyperref template.

     - In the subtitle patch documentation should be documented in the
       relevant backend sections.

>>> We will have to take care about support for missing back-ends. E.g.,
>>> ASCII could treat DESCRIPTION as a quote box just below title.
>>
>> Would that not be an abstract?  I'm not sure I think description should be
>> handled like that.
>
> Forget about it. I'm not sure DESCRIPTION should be handled at all in
> ASCII back-end.

OK.  If you want something like the above, I think we should just
recognize abstract blocks and reuse the quote formatting.

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

> Let's erase my suggestion from the internet archives. Pretty please.

You can ask Lars to remove the post from gmane, at least . . . :)

—Rasmus

-- 
Dung makes an excellent fertilizer

  reply	other threads:[~2015-03-31 10:35 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-27 14:19 Rasmus
2015-03-27 15:08 ` Andreas Leha
2015-03-27 15:12   ` Rasmus
2015-03-27 15:35     ` Andreas Leha
2015-03-28 15:40 ` Nicolas Goaziou
2015-03-28 15:55   ` Rasmus
2015-03-28 17:15     ` Thomas S. Dye
2015-03-29  9:44     ` Nicolas Goaziou
2015-03-29 11:50       ` Rasmus
2015-03-29 13:05         ` Nicolas Goaziou
2015-03-29 13:13           ` Rasmus
2015-03-30  7:39             ` Nicolas Goaziou
2015-03-30 10:35               ` Rasmus
2015-03-31 10:18                 ` Nicolas Goaziou
2015-03-31 10:35                   ` Rasmus [this message]
2015-03-31 10:47                     ` Nicolas Goaziou
2015-03-31 15:50                       ` [org.texi] New keywords tables (was: [ox, patch] #+SUBTITLE) Rasmus
2015-03-31 20:33                         ` [org.texi] New keywords tables Nicolas Goaziou
2015-03-31 21:57                           ` Rasmus
2015-04-01 11:53                           ` Rasmus
2015-04-01 19:37                             ` Nicolas Goaziou
2015-04-01 21:55                               ` Rasmus
2015-04-01 22:34                       ` [ox, patch] #+SUBTITLE Rasmus
2015-04-08 21:25                         ` Rasmus
2015-03-29 11:16   ` Rasmus
2015-03-31 10:21     ` Nicolas Goaziou

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=871tk5jvyx.fsf@gmx.us \
    --to=rasmus@gmx.us \
    --cc=emacs-orgmode@gnu.org \
    --subject='Re: [ox, patch] #+SUBTITLE' \
    /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

Code repositories for project(s) associated with this 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).