emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Rasmus <rasmus@gmx.us>
Cc: emacs-orgmode@gnu.org
Subject: Re: [ox, patch] #+SUBTITLE
Date: Sat, 28 Mar 2015 16:40:52 +0100	[thread overview]
Message-ID: <87a8yxi0zf.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <87y4miv7y6.fsf@gmx.us> (rasmus@gmx.us's message of "Fri, 27 Mar 2015 15:19:45 +0100")

Hello,

Rasmus <rasmus@gmx.us> 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

  parent reply	other threads:[~2015-03-28 15:39 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 [this message]
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
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=87a8yxi0zf.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --cc=emacs-orgmode@gnu.org \
    --cc=rasmus@gmx.us \
    --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).