From 033f7b89f9f7d8a6776bc0758b0bd2db69eb24d1 Mon Sep 17 00:00:00 2001 From: Rasmus Date: Fri, 13 Mar 2015 21:38:26 +0100 Subject: [PATCH 1/2] ox: Move KEYWORD and DESCRIPTION out of ox * ox.el: Remove KEYWORD and DESCRIPTION. * ox-deck.el, ox-rss.el, ox-html, ox-latex, ox-odt, ox-org: Add keyword and description. * org.texi (Export settings): Explicit state which backends support DESCRIPTION and KEYWORDS. --- contrib/lisp/ox-deck.el | 4 +++- contrib/lisp/ox-rss.el | 4 +++- doc/org.texi | 9 ++++++--- lisp/ox-html.el | 2 ++ lisp/ox-latex.el | 2 ++ lisp/ox-odt.el | 2 ++ lisp/ox-org.el | 2 ++ lisp/ox.el | 2 -- 8 files changed, 20 insertions(+), 7 deletions(-) diff --git a/contrib/lisp/ox-deck.el b/contrib/lisp/ox-deck.el index 0ebde41..7155863 100644 --- a/contrib/lisp/ox-deck.el +++ b/contrib/lisp/ox-deck.el @@ -51,7 +51,9 @@ (if a (org-deck-export-to-html t s v b) (org-open-file (org-deck-export-to-html nil s v b))))))) :options-alist - '((:html-link-home "HTML_LINK_HOME" nil nil) + '((:description "DESCRIPTION" nil nil newline) + (:keywords "KEYWORDS" nil nil space) + (:html-link-home "HTML_LINK_HOME" nil nil) (:html-link-up "HTML_LINK_UP" nil nil) (:deck-postamble "DECK_POSTAMBLE" nil org-deck-postamble newline) (:deck-preamble "DECK_PREAMBLE" nil org-deck-preamble newline) diff --git a/contrib/lisp/ox-rss.el b/contrib/lisp/ox-rss.el index 67b925f..8d3cc27 100644 --- a/contrib/lisp/ox-rss.el +++ b/contrib/lisp/ox-rss.el @@ -122,7 +122,9 @@ When nil, Org will create ids using `org-icalendar-create-uid'." (if a (org-rss-export-to-rss t s v) (org-open-file (org-rss-export-to-rss nil s v))))))) :options-alist - '((:with-toc nil nil nil) ;; Never include HTML's toc + '((:description "DESCRIPTION" nil nil newline) + (:keywords "KEYWORDS" nil nil space) + (:with-toc nil nil nil) ;; Never include HTML's toc (:rss-extension "RSS_EXTENSION" nil org-rss-extension) (:rss-image-url "RSS_IMAGE_URL" nil org-rss-image-url) (:rss-categories nil nil org-rss-categories)) diff --git a/doc/org.texi b/doc/org.texi index 632eb19..8fd958c 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -10612,7 +10612,9 @@ exported.}. @item DESCRIPTION @cindex #+DESCRIPTION The document description. Back-ends handle it as they see fit (e.g., for the -XHTML meta tag), if at all. You can use several such keywords for long +XHTML meta tag), if at all. The description-keyword is used in +@LaTeX{}-backends (see @var{org-latex-hyperref-template}), the HTML backend, +and the ODT backend. You can use several such keywords for long descriptions. @item EMAIL @@ -10623,8 +10625,9 @@ The email address (@code{user-mail-address}). @item KEYWORDS @cindex #+KEYWORDS The keywords defining the contents of the document. Back-ends handle it as -they see fit (e.g., for the XHTML meta tag), if at all. You can use several -such keywords if the list is long. +they see fit (e.g., for the XHTML meta tag), if at all. Keywords are used in +@LaTeX{} backends, (see @var{org-latex-hyperref-template}), the HTML backend, +and the ODT backend. You can use several such keywords if the list is long. @item LANGUAGE @cindex #+LANGUAGE diff --git a/lisp/ox-html.el b/lisp/ox-html.el index 92fe3d9..21e6122 100644 --- a/lisp/ox-html.el +++ b/lisp/ox-html.el @@ -110,6 +110,8 @@ :options-alist '((:html-doctype "HTML_DOCTYPE" nil org-html-doctype) (:html-container "HTML_CONTAINER" nil org-html-container-element) + (:description "DESCRIPTION" nil nil newline) + (:keywords "KEYWORDS" nil nil space) (: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) (:html-link-home "HTML_LINK_HOME" nil org-html-link-home) diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el index 6cec8a1..f3c47dc 100644 --- a/lisp/ox-latex.el +++ b/lisp/ox-latex.el @@ -110,6 +110,8 @@ (: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) + (:description "DESCRIPTION" nil nil newline) + (:keywords "KEYWORDS" 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) diff --git a/lisp/ox-odt.el b/lisp/ox-odt.el index 386e894..dd3020e 100644 --- a/lisp/ox-odt.el +++ b/lisp/ox-odt.el @@ -97,6 +97,8 @@ (org-open-file (org-odt-export-to-odt nil s v) 'system)))))) :options-alist '((:odt-styles-file "ODT_STYLES_FILE" nil nil t) + (:description "DESCRIPTION" nil nil newline) + (:keywords "KEYWORDS" nil nil space) ;; Other variables. (:odt-content-template-file nil nil org-odt-content-template-file) (:odt-display-outline-level nil nil org-odt-display-outline-level) diff --git a/lisp/ox-org.el b/lisp/ox-org.el index 734b8d2..3d65465 100644 --- a/lisp/ox-org.el +++ b/lisp/ox-org.el @@ -102,6 +102,8 @@ setting of `org-html-htmlize-output-type' is 'css." (underline . org-org-identity) (verbatim . org-org-identity) (verse-block . org-org-identity)) + :options-alist '((:description "DESCRIPTION" nil nil newline) + (:keywords "KEYWORDS" nil nil space)) :menu-entry '(?O "Export to Org" ((?O "As Org buffer" org-org-export-as-org) diff --git a/lisp/ox.el b/lisp/ox.el index 0c7728f..213e56d 100644 --- a/lisp/ox.el +++ b/lisp/ox.el @@ -102,8 +102,6 @@ (:date "DATE" nil nil t) (:author "AUTHOR" nil user-full-name t) (:email "EMAIL" nil user-mail-address t) - (:description "DESCRIPTION" nil nil newline) - (:keywords "KEYWORDS" nil nil space) (:language "LANGUAGE" nil org-export-default-language t) (:select-tags "SELECT_TAGS" nil org-export-select-tags split) (:exclude-tags "EXCLUDE_TAGS" nil org-export-exclude-tags split) -- 2.3.2