From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nicolas Goaziou Subject: Re: [ox, patch] #+SUBTITLE Date: Tue, 31 Mar 2015 12:18:38 +0200 Message-ID: <87d23pzczl.fsf@nicolasgoaziou.fr> References: <87y4miv7y6.fsf@gmx.us> <87a8yxi0zf.fsf@nicolasgoaziou.fr> <87k2y1qfpi.fsf@gmx.us> <87d23sdtod.fsf@nicolasgoaziou.fr> <87oanct43z.fsf@gmx.us> <874mp4dkeb.fsf@nicolasgoaziou.fr> <87bnjct08z.fsf@gmx.us> <87a8yv0w8v.fsf@nicolasgoaziou.fr> <87twx24vt5.fsf@gmx.us> Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:49813) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YctEc-0006O1-Aj for emacs-orgmode@gnu.org; Tue, 31 Mar 2015 06:17:27 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YctEZ-0000GA-I2 for emacs-orgmode@gnu.org; Tue, 31 Mar 2015 06:17:26 -0400 Received: from relay5-d.mail.gandi.net ([2001:4b98:c:538::197]:59462) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YctEZ-0000Fx-B6 for emacs-orgmode@gnu.org; Tue, 31 Mar 2015 06:17:23 -0400 In-Reply-To: <87twx24vt5.fsf@gmx.us> (rasmus@gmx.us's message of "Mon, 30 Mar 2015 12:35:34 +0200") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Rasmus Cc: emacs-orgmode@gnu.org Rasmus writes: > Nicolas Goaziou writes: > >>> So I would keep them. The documentation explicitly states which backend >>> these keywords are supported by. >> >> OK. Then DESCRIPTION and KEYWORD stay in "ox.el", and documented in >> "Export settings". You need to revert your patch about it. > > I thought we were just discussing criteria for being at a particular spot > in the manual, not in the code. 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. 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 Even when these criteria are met, this move shouldn't be taken lightly as it implies all back-ends should try hard to support it. Again, keywords in this category are to be documented in (info "(org)Export settings"). > 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. >> 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. Regards,