summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <n.goaziou@gmail.com>2013-04-07 12:36:48 (GMT)
committer Nicolas Goaziou <n.goaziou@gmail.com>2013-04-07 12:36:48 (GMT)
commit2d6a90229da0526a5fcb7ffd98dc6bf0aae15130 (patch)
tree5395ee10f93fd36578e6ff943e4c201ae15ba372
parent220b083091f8517327fca7aa7b17d404e93eb637 (diff)
downloadorg-mode-2d6a90229da0526a5fcb7ffd98dc6bf0aae15130.zip
org-mode-2d6a90229da0526a5fcb7ffd98dc6bf0aae15130.tar.gz
ox/ox-html: Fix defcustoms
* lisp/ox.el (org-export-with-archived-trees, org-export-with-author, org-export-with-clocks, org-export-with-date, org-export-creator-string, org-export-with-drawers, org-export-with-email, org-export-with-emphasize, org-export-exclude-tags, org-export-with-fixed-width, org-export-with-footnotes, org-export-with-latex, org-export-headline-levels, org-export-default-language, org-export-preserve-breaks, org-export-with-entities, org-export-with-inlinetasks, org-export-with-planning, org-export-with-priority, org-export-with-section-numbers, org-export-select-tags, org-export-with-smart-quotes, org-export-with-special-strings, org-export-with-statistics-cookies, org-export-with-sub-superscripts, org-export-with-toc, org-export-with-tables, org-export-with-tags, org-export-with-tasks, org-export-time-stamp-file, org-export-with-timestamps, org-export-with-todo-keywords): Fix docstrings. * lisp/ox-html.el (org-html-postamble-format): Slightly change default value so "Generated by" string doesn't get duplicated. (org-html-creator-string): Fix docstring.
-rw-r--r--lisp/ox-html.el12
-rw-r--r--lisp/ox.el83
2 files changed, 52 insertions, 43 deletions
diff --git a/lisp/ox-html.el b/lisp/ox-html.el
index 4eabad4..9a2da62 100644
--- a/lisp/ox-html.el
+++ b/lisp/ox-html.el
@@ -1020,12 +1020,12 @@ precedence over this variable."
(defcustom org-html-postamble-format
'(("en" "<p class=\"author\">Author: %a (%e)</p>
<p class=\"date\">Date: %d</p>
-<p class=\"creator\">Generated by %c</p>
+<p class=\"creator\">%c</p>
<p class=\"xhtml-validation\">%v</p>"))
"Alist of languages and format strings for the HTML postamble.
The first element of each list is the language code, as used for
-the #+LANGUAGE keyword.
+the LANGUAGE keyword. See `org-export-default-language'
The second element of each list is a format string to format the
postamble itself. This format string can contain these elements:
@@ -1034,9 +1034,10 @@ postamble itself. This format string can contain these elements:
%a stands for the author's name.
%e stands for the author's email.
%d stands for the date.
- %c will be replaced by information about Org/Emacs versions.
+ %c will be replaced by creator information. See
+ `org-html-creator-string'.
%v will be replaced by `org-html-validation-link'.
- %T will be replace by the creation time of the file.
+ %T will be replaced by the creation time of the HTML file.
If you need to use a \"%\" character, you need to escape it
like that: \"%%\"."
@@ -1054,7 +1055,8 @@ like that: \"%%\"."
(format "Generated by <a href=\"http://orgmode.org\">Org</a> mode %s in <a href=\"http://www.gnu.org/software/emacs/\">Emacs</a> %s."
(if (fboundp 'org-version) (org-version) "(Unknown)")
emacs-version)
- "String to insert at the end of the HTML document."
+ "Information about the creator of the HTML document.
+This option can also be set on with the CREATOR keyword."
:group 'org-export-html
:type '(string :tag "Creator string"))
diff --git a/lisp/ox.el b/lisp/ox.el
index 69ac821..86aa7dd 100644
--- a/lisp/ox.el
+++ b/lisp/ox.el
@@ -329,7 +329,7 @@ nil Do not export, pretend this tree is not present.
t Do export the entire tree.
`headline' Only export the headline, but skip the tree below it.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"arch:nil\"."
:group 'org-export-general
:type '(choice
@@ -339,14 +339,14 @@ e.g. \"arch:nil\"."
(defcustom org-export-with-author t
"Non-nil means insert author name into the exported file.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"author:nil\"."
:group 'org-export-general
:type 'boolean)
(defcustom org-export-with-clocks nil
"Non-nil means export CLOCK keywords.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"c:t\"."
:group 'org-export-general
:type 'boolean)
@@ -366,8 +366,10 @@ If the value is `comment' insert it as a comment."
(defcustom org-export-with-date t
"Non-nil means insert date in the exported document.
-This options can also be set with the OPTIONS keyword,
-e.g. \"date:nil\".")
+This option can also be set with the OPTIONS keyword,
+e.g. \"date:nil\"."
+ :group 'org-export-general
+ :type 'boolean)
(defcustom org-export-date-timestamp-format nil
"Time-stamp format string to use for DATE keyword.
@@ -386,7 +388,8 @@ string."
(format "Generated by Org mode %s in Emacs %s."
(if (fboundp 'org-version) (org-version) "(Unknown)")
emacs-version)
- "String to insert at the end of the generated document."
+ "Information about the creator of the document.
+This option can also be set on with the CREATOR keyword."
:group 'org-export-general
:type '(string :tag "Creator string"))
@@ -399,7 +402,7 @@ drawers with such names will be ignored.
This variable doesn't apply to properties drawers.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"d:nil\"."
:group 'org-export-general
:version "24.4"
@@ -417,7 +420,7 @@ e.g. \"d:nil\"."
(defcustom org-export-with-email nil
"Non-nil means insert author email into the exported file.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"email:t\"."
:group 'org-export-general
:type 'boolean)
@@ -429,7 +432,8 @@ If the export target supports emphasizing text, the word will be
typeset in bold, italic, with an underline or strike-through,
respectively.
-This option can also be set with the #+OPTIONS line, e.g. \"*:nil\"."
+This option can also be set with the OPTIONS keyword,
+e.g. \"*:nil\"."
:group 'org-export-general
:type 'boolean)
@@ -440,7 +444,7 @@ All trees carrying any of these tags will be excluded from
export. This is without condition, so even subtrees inside that
carry one of the `org-export-select-tags' will be removed.
-This option can also be set with the #+EXCLUDE_TAGS: keyword."
+This option can also be set with the EXCLUDE_TAGS keyword."
:group 'org-export-general
:type '(repeat (string :tag "Tag")))
@@ -455,13 +459,14 @@ etc. For example:
will be looking just like this in also HTML. See also the QUOTE
keyword. Not all export backends support this.
-This option can also be set with the #+OPTIONS line, e.g. \"::nil\"."
+This option can also be set with the OPTIONS keyword,
+e.g. \"::nil\"."
:group 'org-export-general
:type 'boolean)
(defcustom org-export-with-footnotes t
"Non-nil means Org footnotes should be exported.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"f:nil\"."
:group 'org-export-general
:type 'boolean)
@@ -469,7 +474,7 @@ e.g. \"f:nil\"."
(defcustom org-export-with-latex t
"Non-nil means process LaTeX environments and fragments.
-This option can also be set with the +OPTIONS line,
+This option can also be set with the OPTIONS line,
e.g. \"tex:verbatim\". Allowed values are:
nil Ignore math snippets.
@@ -486,23 +491,25 @@ t Allow export of math snippets."
(defcustom org-export-headline-levels 3
"The last level which is still exported as a headline.
-Inferior levels will produce itemize or enumerate lists when
-exported.
+Inferior levels will usually produce itemize or enumerate lists
+when exported, but back-end behaviour may differ.
-This option can also be set with the #+OPTIONS line, e.g. \"H:2\"."
+This option can also be set with the OPTIONS keyword,
+e.g. \"H:2\"."
:group 'org-export-general
:type 'integer)
(defcustom org-export-default-language "en"
"The default language for export and clocktable translations, as a string.
This may have an association in
-`org-clock-clocktable-language-setup'."
+`org-clock-clocktable-language-setup'. This option can also be
+set with the LANGUAGE keyword."
:group 'org-export-general
:type '(string :tag "Language"))
(defcustom org-export-preserve-breaks nil
"Non-nil means preserve all line breaks when exporting.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"\\n:t\"."
:group 'org-export-general
:type 'boolean)
@@ -516,14 +523,14 @@ For example, HTML export converts \\alpha to &alpha; and \\AA to
For a list of supported names, see the constant `org-entities'
and the user option `org-entities-user'.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"e:nil\"."
:group 'org-export-general
:type 'boolean)
(defcustom org-export-with-inlinetasks t
"Non-nil means inlinetasks should be exported.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"inline:nil\"."
:group 'org-export-general
:version "24.4"
@@ -532,7 +539,7 @@ e.g. \"inline:nil\"."
(defcustom org-export-with-planning nil
"Non-nil means include planning info in export.
-This option can also be set with the #+OPTIONS: line,
+This option can also be set with the OPTIONS keyword,
e.g. \"p:t\"."
:group 'org-export-general
:version "24.4"
@@ -541,7 +548,7 @@ e.g. \"p:t\"."
(defcustom org-export-with-priority nil
"Non-nil means include priority cookies in export.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"pri:t\"."
:group 'org-export-general
:type 'boolean)
@@ -552,7 +559,7 @@ e.g. \"pri:t\"."
When set to an integer n, numbering will only happen for
headlines whose relative level is higher or equal to n.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"num:t\"."
:group 'org-export-general
:type 'boolean)
@@ -565,13 +572,13 @@ one of these tags will be ignored during export. Inside trees
that are selected like this, you can still deselect a subtree by
tagging it with one of the `org-export-exclude-tags'.
-This option can also be set with the #+SELECT_TAGS: keyword."
+This option can also be set with the SELECT_TAGS keyword."
:group 'org-export-general
:type '(repeat (string :tag "Tag")))
(defcustom org-export-with-smart-quotes nil
"Non-nil means activate smart quotes during export.
-This option can also be set with the #+OPTIONS: line,
+This option can also be set with the OPTIONS keyword,
e.g. \"':t\"."
:group 'org-export-general
:version "24.4"
@@ -590,14 +597,14 @@ When this option is turned on, these strings will be exported as:
--- &mdash; --- —
... &hellip; \\ldots …
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"-:nil\"."
:group 'org-export-general
:type 'boolean)
(defcustom org-export-with-statistics-cookies t
"Non-nil means include statistics cookies in export.
-This option can also be set with the #+OPTIONS: line,
+This option can also be set with the OPTIONS keyword,
e.g. \"stat:nil\""
:group 'org-export-general
:version "24.4"
@@ -625,7 +632,7 @@ the sub/superscript. If you set this variable to the symbol
interpretations as sub/superscript. This can be helpful in
documents that need \"_\" frequently in plain text.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"^:nil\"."
:group 'org-export-general
:type '(choice
@@ -643,7 +650,7 @@ up to N in the toc, this may then be different from
larger than the number of headline levels. When nil, no table of
contents is made.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"toc:nil\" or \"toc:3\"."
:group 'org-export-general
:type '(choice
@@ -659,7 +666,8 @@ For example:
|-------------+----------+-----------|
| Arthur Dent | England | 29.2.2100 |
-This option can also be set with the #+OPTIONS line, e.g. \"|:nil\"."
+This option can also be set with the OPTIONS keyword,
+e.g. \"|:nil\"."
:group 'org-export-general
:type 'boolean)
@@ -670,7 +678,7 @@ If this is the symbol `not-in-toc', tags will be removed from
table of contents entries, but still be shown in the headlines of
the document.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"tags:nil\"."
:group 'org-export-general
:type '(choice
@@ -688,7 +696,7 @@ t include tasks independent of state.
nil ignore all tasks.
list of keywords include tasks with these keywords.
-This option can also be set with the #+OPTIONS line,
+This option can also be set with the OPTIONS keyword,
e.g. \"tasks:nil\"."
:group 'org-export-general
:type '(choice
@@ -701,10 +709,8 @@ e.g. \"tasks:nil\"."
(defcustom org-export-time-stamp-file t
"Non-nil means insert a time stamp into the exported file.
-The time stamp shows when the file was created.
-
-This option can also be set with the #+OPTIONS line,
-e.g. \"timestamp:nil\"."
+The time stamp shows when the file was created. This option can
+also be set with the OPTIONS keyword, e.g. \"timestamp:nil\"."
:group 'org-export-general
:type 'boolean)
@@ -715,7 +721,7 @@ It can be set to `active', `inactive', t or nil, in order to
export, respectively, only active timestamps, only inactive ones,
all of them or none.
-This option can also be set with the #+OPTIONS line, e.g.
+This option can also be set with the OPTIONS keyword, e.g.
\"<:nil\"."
:group 'org-export-general
:type '(choice
@@ -726,7 +732,8 @@ This option can also be set with the #+OPTIONS line, e.g.
(defcustom org-export-with-todo-keywords t
"Non-nil means include TODO keywords in export.
-When nil, remove all these keywords from the export."
+When nil, remove all these keywords from the export. This option
+can also be set with the OPTIONS keyword, e.g. \"todo:nil\"."
:group 'org-export-general
:type 'boolean)