From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Rasmus <rasmus@gmx.us>
Cc: emacs-orgmode@gnu.org
Subject: Re: [ox, patch] #+SUBTITLE
Date: Sun, 29 Mar 2015 15:05:00 +0200 [thread overview]
Message-ID: <874mp4dkeb.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <87oanct43z.fsf@gmx.us> (rasmus@gmx.us's message of "Sun, 29 Mar 2015 13:50:08 +0200")
Rasmus <rasmus@gmx.us> writes:
> Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:
>
>> I would like to keep a clear and somewhat future-proof rule about this:
>>
>> 1. A keyword a user can expect to find in all back-ends where it makes
>> sense should be defined in "ox.el". To put it differently, it can be
>> considered as a bug if a back-end could /simply/ support a keyword
>> in this category but doesn't. Keywords in this category are to be
>> documented in (info "(org)Export settings").
I would add that, to be in that category, a keyword needs to be
supported by at least 3 major back-ends (among ASCII, HTML, ODT and
LaTeX).
>> 2. Other keywords are defined in their respective back-end, and
>> documented in their respective chapter in the manual.
>>
>> As a non-trivial example, consider :email. You can expect it to produce
>> something sensible in any back-end. Yet, "ox-icalendar" doesn't use it.
>> It still belongs to first category.
>>
>> If we support SUBTITLE everywhere it makes sense, it might be worth
>> adding it to the first category. Actually, considering the rule above,
>> I even lean towards adding it to that category. WDYT?
>
> I think it's hard to make a clear-cut rule.
The rule above is good enough to make a decision in most cases, IMO.
> I think keywords that are well-supported by Org-core should be there.
That doesn't contradict category 1.
> From a user perspective, I think it should be close to TITLE. Further,
> putting it there also signal to external writers, e.g. ox-reveal, that
> they should now try to support it. I think SUBTITLE, KEYWORD, and
> DESCRIPTION is within the same category and should be treated the
> same.
Do you mean KEYWORD and DESCRIPTION should also belong to category 1?
I'm not against it, but then, back-ends are required to support them
whenever possible.
> We could add a subsection with "text document properties" which are
> keywords that are supported by the set: {ox-html, ox-ascii, ox-odt,
> ox-latex}. These would be sort of 1½ class citizens.
I don't want to create a third category (à la
`org-element-document-properties', which I'm trying to remove).
> We can't support SUBTITLE everywhere, 'cause it simply does not make sense
> (only in "text document producers" IMO).
That doesn't contradict category 1 either, as shown by EMAIL example.
> The support of SUBTITLE is:
>
> W/Emacs: support is 6/9
That's fine as there is no simple way to support SUBTITLE in the
3 back-ends left. Also, the "big four" support it.
> W/Contrib: support is 8/20
> - BTW: ox-groff seems to have some support for subtitles, but
> I'm not sure how this works, so I haven't tried to unify
> it.
> - I guess it could be added to ox-rss could support it. Atom
> seems to support subtitle, but it does not seem rss 2.0 has
> it in its definition... I don't know the details of RSS
> well.
>
> W/"the wild": for all I know the limit of the fraction is zero.
We are not maintaining the former and have no control over the latter,
so it doesn't matter.
Regards,
next prev parent reply other threads:[~2015-03-29 13:03 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-03-27 14:19 [ox, patch] #+SUBTITLE 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 [this message]
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
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=874mp4dkeb.fsf@nicolasgoaziou.fr \
--to=mail@nicolasgoaziou.fr \
--cc=emacs-orgmode@gnu.org \
--cc=rasmus@gmx.us \
/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).