1
0
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-11-26 07:33:39 +00:00

org-e-html: Fix some variables values, docstrings and customize types

* contrib/lisp/org-e-html.el (org-e-html-scripts): Fix default value.
(org-e-html-style-default): Small fix to indentation.
(org-e-html-content-div): Remove obsolete variable.
(org-e-html-toplevel-hlevel): Fix type.
(org-e-html-postamble-format, org-e-html-preamble-format): Fix
docstring and type.
This commit is contained in:
Nicolas Goaziou 2012-09-25 22:17:54 +02:00
parent d42349d3cf
commit 5b303c8df3

View File

@ -157,9 +157,32 @@ Intended to be locally bound around a call to `org-export-as-html'." )
("\\.\\.\\." . "…"))
"Regular expressions for special string conversion.")
(defconst org-e-html-scripts
"<script type=\"text/javascript\">
"<script type=\"text/javascript\">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
@ -181,11 +204,10 @@ Intended to be locally bound around a call to `org-export-as-html'." )
}
/*]]>*///-->
</script>"
"Basic JavaScript that is needed by HTML files produced by Org-mode.")
"Basic JavaScript that is needed by HTML files produced by Org mode.")
(defconst org-e-html-style-default
"<style type=\"text/css\">
"<style type=\"text/css\">
<!--/*--><![CDATA[/*><!--*/
html { font-family: Times, serif; font-size: 12pt; }
.title { text-align: center; }
@ -241,14 +263,6 @@ have the default style included, customize the variable
`org-e-html-style-include-default'.")
(defvar org-e-html-content-div "content"
"The name of the container DIV that holds all the page contents.
This variable is obsolete since Org version 7.7.
Please set `org-e-html-divs' instead.")
;;; User Configuration Variables
@ -353,7 +367,7 @@ and outline-text-1. If this is 2, all of these will get a 2 instead.
The default for this variable is 2, because we use <h1> for formatting the
document title."
:group 'org-export-e-html
:type 'string)
:type 'integer)
(defcustom org-e-html-format-headline-function nil
"Function to format headline text.
@ -802,20 +816,26 @@ precedence over this variable."
'(("en" "<p class=\"author\">Author: %a (%e)</p>
<p class=\"date\">Date: %d</p>
<p class=\"creator\">Generated by %c</p>
<p class=\"xhtml-validation\">%v</p>
"))
"The format for the HTML postamble.
<p class=\"xhtml-validation\">%v</p>"))
"Alist of languages and format strings for the HTML postamble.
%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.
%v will be replaced by `org-e-html-validation-link'.
The first element of each list is the language code, as used for
the #+LANGUAGE keyword.
The second element of each list is a format string to format the
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.
%v will be replaced by `org-e-html-validation-link'.
If you need to use a \"%\" character, you need to escape it
like that: \"%%\"."
:group 'org-export-e-html
:type 'string)
:type '(alist :key-type (string :tag "Language")
:value-type (string :tag "Format string")))
(defcustom org-e-html-validation-link
"<a href=\"http://validator.w3.org/check?uri=referer\">Validate XHTML 1.0</a>"
@ -853,17 +873,24 @@ precedence over this variable."
(function :tag "Function (must return a string)")))
(defcustom org-e-html-preamble-format '(("en" ""))
"The format for the HTML preamble.
"Alist of languages and format strings for the HTML preamble.
%t stands for the title.
%a stands for the author's name.
%e stands for the author's email.
%d stands for the date.
The first element of each list is the language code, as used for
the #+LANGUAGE keyword.
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.
%a stands for the author's name.
%e stands for the author's email.
%d stands for the date.
If you need to use a \"%\" character, you need to escape it
like that: \"%%\"."
:group 'org-export-e-html
:type 'string)
:type '(alist :key-type (string :tag "Language")
:value-type (string :tag "Format string")))
(defcustom org-e-html-link-up ""
"Where should the \"UP\" link of exported HTML pages lead?"