From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nicolas Goaziou Subject: Re: [ox, patch] #+SUBTITLE Date: Sat, 28 Mar 2015 16:40:52 +0100 Message-ID: <87a8yxi0zf.fsf@nicolasgoaziou.fr> References: <87y4miv7y6.fsf@gmx.us> Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:34864) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Ybspr-0004GE-A3 for emacs-orgmode@gnu.org; Sat, 28 Mar 2015 11:39:44 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Ybspm-0003hC-7J for emacs-orgmode@gnu.org; Sat, 28 Mar 2015 11:39:43 -0400 Received: from relay6-d.mail.gandi.net ([2001:4b98:c:538::198]:46101) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Ybspl-0003gF-Vu for emacs-orgmode@gnu.org; Sat, 28 Mar 2015 11:39:38 -0400 In-Reply-To: <87y4miv7y6.fsf@gmx.us> (rasmus@gmx.us's message of "Fri, 27 Mar 2015 15:19:45 +0100") 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 Hello, Rasmus writes: > Note: *the patch does not touch ox.el*. SUBTITLE is *only* supported in a > tiny fraction of the backends, namely ox-latex, ox-ascii, ox-html, and > ox-odt. For some definition of "tiny". > + ;; TODO: format-spec isn't great for missing details. Could you elaborate a bit in the comment? > +@item SUBTITLE > +@cindex #+SUBTITLE > +The document subtitle. The keyword is supported by by @LaTeX{}-backends, ^^^ Typo. > +HTML backends, ASCII backends, the texinfo backend, and the ODT > backend. You "Texinfo" > +can use several such keywords for long subtitles. However this section is not for back-end specific keywords. It should be moved within their own chapter. > + (when formatted-subtitle > + (concat "\n" formatted-subtitle)) Nitpick: (and formatted-subtitle ...) > + (:latex-subtitle-format nil nil "\\subtitle{%s}") If it is meant to be changed it should be coupled to a defcustom. Otherwise, you can hard-code it in `org-beamer-template'. > @@ -1209,6 +1215,7 @@ The second element of each list is a format string to format the > postamble itself. This format string can contain these elements: > > %t stands for the title. > + %s will be replaced by the export subtitle. "stands for", for the sake of consistency. > %a stands for the author's name. > %e stands for the author's email. > %d stands for the date. > @@ -1273,6 +1280,7 @@ The second element of each list is a format string to format the > preamble itself. This format string can contain these elements: > > %t stands for the title. > + %s will be replaced by the export subtitle. Ditto. > (:latex-class-options "LATEX_CLASS_OPTIONS" nil nil t) > (:latex-header "LATEX_HEADER" nil nil newline) > (:latex-header-extra "LATEX_HEADER_EXTRA" nil nil newline) > + (:subtitle "SUBTITLE" nil nil space) > ;; Other variables. > (:latex-active-timestamp-format nil nil org-latex-active-timestamp-format) > (:latex-caption-above nil nil org-latex-caption-above) > @@ -135,6 +136,8 @@ > (:latex-listings-options nil nil org-latex-listings-options) > (:latex-minted-langs nil nil org-latex-minted-langs) > (:latex-minted-options nil nil org-latex-minted-options) > + (:latex-subtitle-format nil nil org-latex-subtitle-format) > + (:latex-subtitle-separate nil nil org-latex-subtitle-separate) They need to be added to Publishing options in manual. > +(defcustom org-latex-subtitle-format "\\\\\\smallskip\n\\large %s" > + "Format string used for transcoded subtitle. > +The format string should have at most one \"%s\"-expression, > +which is replaced with the subtitle.") Missing keywords: :version, :package-version, :type, :group > +(defcustom org-latex-subtitle-separate nil > + "Non-nil means the subtitle is not typeset as part of title.") Ditto. > --- a/lisp/ox-org.el > +++ b/lisp/ox-org.el > @@ -102,6 +102,7 @@ setting of `org-html-htmlize-output-type' is 'css." > (underline . org-org-identity) > (verbatim . org-org-identity) > (verse-block . org-org-identity)) > + :options-alist '((:subtitle "SUBTITLE" nil nil space)) I don't see a valid reason to treat #+SUBTITLE specially in `org' back-end. It will appear anyway as a regular keyword. You can ignore that part altogether. Also, assuming you keep :subtitle instead of :BACKEND-subtitle, these should also be documented in Publishing options. Thank you. Regards, -- Nicolas Goaziou