From mboxrd@z Thu Jan 1 00:00:00 1970 From: Rasmus Subject: [ox, patch] #+SUBTITLE Date: Fri, 27 Mar 2015 15:19:45 +0100 Message-ID: <87y4miv7y6.fsf@gmx.us> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:36608) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YbV7j-0005kd-7G for emacs-orgmode@gnu.org; Fri, 27 Mar 2015 10:20:41 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YbV7f-00023D-QZ for emacs-orgmode@gnu.org; Fri, 27 Mar 2015 10:20:35 -0400 Received: from plane.gmane.org ([80.91.229.3]:37798) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YbV7f-000234-Bq for emacs-orgmode@gnu.org; Fri, 27 Mar 2015 10:20:31 -0400 Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1YbV7O-0002wX-Em for emacs-orgmode@gnu.org; Fri, 27 Mar 2015 15:20:14 +0100 Received: from tsn77-247-182-241.dyn.nltelcom.net ([77.247.182.241]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Fri, 27 Mar 2015 15:20:14 +0100 Received: from rasmus by tsn77-247-182-241.dyn.nltelcom.net with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Fri, 27 Mar 2015 15:20:14 +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: emacs-orgmode@gnu.org --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Hi, I'm starting a new thread as the previous discussion attracted much dissuasion not directly related to the patch in question. Changes: - Html subtitles now follow the W3 recommendations, I think/hope. It would be great if somebody who knows css would check the styling. - The texinfo subtitle is interpreted. - Documentation and NEWS is added. 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. —Rasmus -- Er du tosset for noge' lårt! --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=0001-ox-Add-SUBTITLE-property-in-some-backends.patch >From 6d4e46af0b9ef5623c1a638c4659997fb735350b Mon Sep 17 00:00:00 2001 From: Rasmus Date: Sun, 1 Mar 2015 22:09:19 +0100 Subject: [PATCH] ox: Add SUBTITLE property in some backends * ox-ascii.el (org-ascii-template--document-title) (org-ascii-template--document-title) ox-deck.el (org-deck-title-slide-template) ox-s5.el (org-s5-title-slide-template) ox-html.el (org-html--build-meta-info, org-html-format-spec) (org-html--build-meta-info, org-html-format-spec) (org-html--build-meta-info, org-html-format-spec) ox-org.el (org), (org-org-keyword): Use SUBTITLE. * ox-beamer.el (org-beamer-template) ox-html (org-html-template) ox-latex.el (org-latex-template) ox-org (org-org-template): Insert SUBTITLE. * ox-html (org-html-preamble-format) (org-html-postamble-format): Update docstring. * ox-html (org-html-style-default): Add .subtitle style and change .title style. * ox-texinfo.el (org-texinfo-template): Interpret subtitle. * org.texi (Export settings): Document SUBTITLE. * ORG-NEWS: Add entry on SUBTITLE. The patch adds a #+SUBTITLE keyword to ox-ascii, ox-latex, ox-html and ox-odt. --- contrib/lisp/ox-deck.el | 2 ++ contrib/lisp/ox-s5.el | 2 ++ doc/org.texi | 7 ++++++- etc/ORG-NEWS | 3 +++ lisp/ox-ascii.el | 23 ++++++++++++++++++----- lisp/ox-beamer.el | 10 +++++++++- lisp/ox-html.el | 37 +++++++++++++++++++++++++++++++------ lisp/ox-latex.el | 41 ++++++++++++++++++++++++++++++++++++----- lisp/ox-odt.el | 32 +++++++++++++++++++++++++++++--- lisp/ox-org.el | 9 +++++++-- lisp/ox-texinfo.el | 10 +++++++--- 11 files changed, 150 insertions(+), 26 deletions(-) diff --git a/contrib/lisp/ox-deck.el b/contrib/lisp/ox-deck.el index 0ebde41..a76384b 100644 --- a/contrib/lisp/ox-deck.el +++ b/contrib/lisp/ox-deck.el @@ -259,6 +259,7 @@ Defaults to styles for the title page." (defcustom org-deck-title-slide-template "

%t

+

%s

%a

%e

%d

" @@ -446,6 +447,7 @@ holding export options." ;; title page (format "<%s id='title-slide' class='slide'>" (plist-get info :html-container)) + ;; TODO: format-spec isn't great for missing details. (format-spec org-deck-title-slide-template (org-html-format-spec info)) (format "" (plist-get info :html-container)) ;; toc page diff --git a/contrib/lisp/ox-s5.el b/contrib/lisp/ox-s5.el index b003919..8b28692 100644 --- a/contrib/lisp/ox-s5.el +++ b/contrib/lisp/ox-s5.el @@ -174,6 +174,7 @@ or an empty string." (defcustom org-s5-title-slide-template "

%t

+

%s

%a

%e

%d

" @@ -329,6 +330,7 @@ holding export options." ;; title page (format "<%s id='title-slide' class='slide'>" (plist-get info :html-container)) + ;; TODO: format-spec isn't great for missing details. (format-spec org-s5-title-slide-template (org-html-format-spec info)) (format "" (plist-get info :html-container)) ;; table of contents. diff --git a/doc/org.texi b/doc/org.texi index 6b56c4a..64a34e5 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -10711,6 +10711,12 @@ default value is @code{:export:}. Within a subtree tagged with below). When headlines are selectively exported with @code{:export:} anywhere in a file, text before the first headline is ignored. +@item SUBTITLE +@cindex #+SUBTITLE +The document subtitle. The keyword is supported by by @LaTeX{}-backends, +HTML backends, ASCII backends, the texinfo backend, and the ODT backend. You +can use several such keywords for long subtitles. + @item EXCLUDE_TAGS @cindex #+EXCLUDE_TAGS @vindex org-export-exclude-tags @@ -13174,7 +13180,6 @@ to define your own class in @code{org-texinfo-classes}, which see. Set @subsubheading Title and copyright page @cindex #+TEXINFO_PRINTED_TITLE -@cindex #+SUBTITLE The default template includes a title page for hard copy output. The title and author displayed on this page are extracted from, respectively, @code{#+TITLE} and @code{#+AUTHOR} keywords (@pxref{Export settings}). It is diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index 9c262f4..7f53123 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -323,6 +323,9 @@ leading spaces within table cells. *** New MathJax configuration options. Org uses the MathJax CDN by default. See the manual and the docstring of ~org-html-mathjax-options~ for details. +*** New ~#+SUBTITLE~ keyword +Org can now typeset a subtitle in some backends. See the manual for +details. ** Miscellaneous *** Strip all meta data from ITEM special property ITEM special property does not contain TODO, priority or tags anymore. diff --git a/lisp/ox-ascii.el b/lisp/ox-ascii.el index b7d8425..e9d5b55 100644 --- a/lisp/ox-ascii.el +++ b/lisp/ox-ascii.el @@ -121,7 +121,8 @@ org-ascii-filter-comment-spacing) (:filter-section . org-ascii-filter-headline-blank-lines)) :options-alist - '((:ascii-bullets nil nil org-ascii-bullets) + '((:subtitle "SUBTITLE" nil nil space) + (:ascii-bullets nil nil org-ascii-bullets) (:ascii-caption-above nil nil org-ascii-caption-above) (:ascii-charset nil nil org-ascii-charset) (:ascii-global-margin nil nil org-ascii-global-margin) @@ -969,9 +970,15 @@ INFO is a plist used as a communication channel." ;; Links in the title will not be resolved later, so we make ;; sure their path is located right after them. (info (org-combine-plists info '(:ascii-links-to-notes nil))) - (title (if (plist-get info :with-title) - (org-export-data (plist-get info :title) info) - "")) + (with-title (plist-get info :with-title)) + (title (org-export-data + (when with-title (plist-get info :title)) info)) + (subtitle (org-export-data + (when with-title + (org-element-parse-secondary-string + (plist-get info :subtitle) + (org-element-restriction 'keyword))) + info)) (author (and (plist-get info :with-author) (let ((auth (plist-get info :author))) (and auth (org-export-data auth info))))) @@ -1014,8 +1021,12 @@ INFO is a plist used as a communication channel." (let* ((utf8p (eq (plist-get info :ascii-charset) 'utf-8)) ;; Format TITLE. It may be filled if it is too wide, ;; that is wider than the two thirds of the total width. - (title-len (min (length title) (/ (* 2 text-width) 3))) + (title-len (min (max (length title) + (length subtitle)) + (/ (* 2 text-width) 3))) (formatted-title (org-ascii--fill-string title title-len info)) + (formatted-subtitle (when (org-string-nw-p subtitle) + (org-ascii--fill-string subtitle title-len info))) (line (make-string (min (+ (max title-len @@ -1027,6 +1038,8 @@ INFO is a plist used as a communication channel." (concat line "\n" (unless utf8p "\n") (upcase formatted-title) + (when formatted-subtitle + (concat "\n" formatted-subtitle)) (cond ((and (org-string-nw-p author) (org-string-nw-p email)) (concat "\n\n" author "\n" email)) diff --git a/lisp/ox-beamer.el b/lisp/ox-beamer.el index 5d0b55d..7d69d45 100644 --- a/lisp/ox-beamer.el +++ b/lisp/ox-beamer.el @@ -233,6 +233,7 @@ Return overlay specification, as a string, or nil." :options-alist '((:headline-levels nil "H" org-beamer-frame-level) (:latex-class "LATEX_CLASS" nil "beamer" t) + (:latex-subtitle-format nil nil "\\subtitle{%s}") (:beamer-column-view-format "COLUMNS" nil org-beamer-column-view-format) (:beamer-theme "BEAMER_THEME" nil org-beamer-theme) (:beamer-color-theme "BEAMER_COLOR_THEME" nil nil t) @@ -810,7 +811,12 @@ information." "Return complete document string after Beamer conversion. CONTENTS is the transcoded contents string. INFO is a plist holding export options." - (let ((title (org-export-data (plist-get info :title) info))) + (let ((title (org-export-data (plist-get info :title) info)) + (subtitle (org-export-data + (org-element-parse-secondary-string + (plist-get info :subtitle) + (org-element-restriction 'keyword)) + info))) (concat ;; 1. Time-stamp. (and (plist-get info :time-stamp-file) @@ -877,6 +883,8 @@ holding export options." (format "\\date{%s}\n" (org-export-data date info))) ;; 7. Title (format "\\title{%s}\n" title) + (when (org-string-nw-p subtitle) + (format (plist-get info :latex-subtitle-format) subtitle)) ;; 8. Beamer-header (let ((beamer-header (plist-get info :beamer-header))) (when beamer-header diff --git a/lisp/ox-html.el b/lisp/ox-html.el index 7ed73f6..6b0f757 100644 --- a/lisp/ox-html.el +++ b/lisp/ox-html.el @@ -108,7 +108,8 @@ (if a (org-html-export-to-html t s v b) (org-open-file (org-html-export-to-html nil s v b))))))) :options-alist - '((:html-doctype "HTML_DOCTYPE" nil org-html-doctype) + '((:subtitle "SUBTITLE" nil nil space) + (:html-doctype "HTML_DOCTYPE" nil org-html-doctype) (:html-container "HTML_CONTAINER" nil org-html-container-element) (:html-html5-fancy nil "html5-fancy" org-html-html5-fancy) (:html-link-use-abs-url nil "html-link-use-abs-url" org-html-link-use-abs-url) @@ -270,7 +271,12 @@ for the JavaScript code in this tag. (defconst org-html-style-default "