org-element: Implement `org-element-create'
[org-mode/org-tableheadings.git] / lisp / ox-html.el
blob4b268ff3faab9119984ff400de0198cf253add0a
1 ;;; ox-html.el --- HTML Back-End for Org Export Engine
3 ;; Copyright (C) 2011-2015 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Jambunathan K <kjambunathan at gmail dot com>
7 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This library implements a HTML back-end for Org generic exporter.
27 ;; See Org manual for more information.
29 ;;; Code:
31 ;;; Dependencies
33 (require 'ox)
34 (require 'ox-publish)
35 (require 'format-spec)
36 (eval-when-compile (require 'cl) (require 'table nil 'noerror))
39 ;;; Function Declarations
41 (declare-function org-id-find-id-file "org-id" (id))
42 (declare-function htmlize-region "ext:htmlize" (beg end))
43 (declare-function org-pop-to-buffer-same-window
44 "org-compat" (&optional buffer-or-name norecord label))
45 (declare-function mm-url-decode-entities "mm-url" ())
47 ;;; Define Back-End
49 (org-export-define-backend 'html
50 '((bold . org-html-bold)
51 (center-block . org-html-center-block)
52 (clock . org-html-clock)
53 (code . org-html-code)
54 (drawer . org-html-drawer)
55 (dynamic-block . org-html-dynamic-block)
56 (entity . org-html-entity)
57 (example-block . org-html-example-block)
58 (export-block . org-html-export-block)
59 (export-snippet . org-html-export-snippet)
60 (fixed-width . org-html-fixed-width)
61 (footnote-definition . org-html-footnote-definition)
62 (footnote-reference . org-html-footnote-reference)
63 (headline . org-html-headline)
64 (horizontal-rule . org-html-horizontal-rule)
65 (inline-src-block . org-html-inline-src-block)
66 (inlinetask . org-html-inlinetask)
67 (inner-template . org-html-inner-template)
68 (italic . org-html-italic)
69 (item . org-html-item)
70 (keyword . org-html-keyword)
71 (latex-environment . org-html-latex-environment)
72 (latex-fragment . org-html-latex-fragment)
73 (line-break . org-html-line-break)
74 (link . org-html-link)
75 (node-property . org-html-node-property)
76 (paragraph . org-html-paragraph)
77 (plain-list . org-html-plain-list)
78 (plain-text . org-html-plain-text)
79 (planning . org-html-planning)
80 (property-drawer . org-html-property-drawer)
81 (quote-block . org-html-quote-block)
82 (radio-target . org-html-radio-target)
83 (section . org-html-section)
84 (special-block . org-html-special-block)
85 (src-block . org-html-src-block)
86 (statistics-cookie . org-html-statistics-cookie)
87 (strike-through . org-html-strike-through)
88 (subscript . org-html-subscript)
89 (superscript . org-html-superscript)
90 (table . org-html-table)
91 (table-cell . org-html-table-cell)
92 (table-row . org-html-table-row)
93 (target . org-html-target)
94 (template . org-html-template)
95 (timestamp . org-html-timestamp)
96 (underline . org-html-underline)
97 (verbatim . org-html-verbatim)
98 (verse-block . org-html-verse-block))
99 :export-block "HTML"
100 :filters-alist '((:filter-options . org-html-infojs-install-script)
101 (:filter-final-output . org-html-final-function))
102 :menu-entry
103 '(?h "Export to HTML"
104 ((?H "As HTML buffer" org-html-export-as-html)
105 (?h "As HTML file" org-html-export-to-html)
106 (?o "As HTML file and open"
107 (lambda (a s v b)
108 (if a (org-html-export-to-html t s v b)
109 (org-open-file (org-html-export-to-html nil s v b)))))))
110 :options-alist
111 '((:html-doctype "HTML_DOCTYPE" nil org-html-doctype)
112 (:html-container "HTML_CONTAINER" nil org-html-container-element)
113 (:description "DESCRIPTION" nil nil newline)
114 (:keywords "KEYWORDS" nil nil space)
115 (:html-html5-fancy nil "html5-fancy" org-html-html5-fancy)
116 (:html-link-use-abs-url nil "html-link-use-abs-url" org-html-link-use-abs-url)
117 (:html-link-home "HTML_LINK_HOME" nil org-html-link-home)
118 (:html-link-up "HTML_LINK_UP" nil org-html-link-up)
119 (:html-mathjax "HTML_MATHJAX" nil "" space)
120 (:html-link-use-abs-url nil "html-link-use-abs-url" org-html-link-use-abs-url)
121 (:html-postamble nil "html-postamble" org-html-postamble)
122 (:html-preamble nil "html-preamble" org-html-preamble)
123 (:html-head "HTML_HEAD" nil org-html-head newline)
124 (:html-head-extra "HTML_HEAD_EXTRA" nil org-html-head-extra newline)
125 (:subtitle "SUBTITLE" nil nil parse)
126 (:html-head-include-default-style
127 nil "html-style" org-html-head-include-default-style)
128 (:html-head-include-scripts nil "html-scripts" org-html-head-include-scripts)
129 (:html-allow-name-attribute-in-anchors
130 nil nil org-html-allow-name-attribute-in-anchors)
131 (:html-divs nil nil org-html-divs)
132 (:html-checkbox-type nil nil org-html-checkbox-type)
133 (:html-extension nil nil org-html-extension)
134 (:html-footnote-format nil nil org-html-footnote-format)
135 (:html-footnote-separator nil nil org-html-footnote-separator)
136 (:html-footnotes-section nil nil org-html-footnotes-section)
137 (:html-format-drawer-function nil nil org-html-format-drawer-function)
138 (:html-format-headline-function nil nil org-html-format-headline-function)
139 (:html-format-inlinetask-function
140 nil nil org-html-format-inlinetask-function)
141 (:html-home/up-format nil nil org-html-home/up-format)
142 (:html-indent nil nil org-html-indent)
143 (:html-infojs-options nil nil org-html-infojs-options)
144 (:html-infojs-template nil nil org-html-infojs-template)
145 (:html-inline-image-rules nil nil org-html-inline-image-rules)
146 (:html-link-org-files-as-html nil nil org-html-link-org-files-as-html)
147 (:html-mathjax-options nil nil org-html-mathjax-options)
148 (:html-mathjax-template nil nil org-html-mathjax-template)
149 (:html-metadata-timestamp-format nil nil org-html-metadata-timestamp-format)
150 (:html-postamble-format nil nil org-html-postamble-format)
151 (:html-preamble-format nil nil org-html-preamble-format)
152 (:html-table-align-individual-fields
153 nil nil org-html-table-align-individual-fields)
154 (:html-table-caption-above nil nil org-html-table-caption-above)
155 (:html-table-data-tags nil nil org-html-table-data-tags)
156 (:html-table-header-tags nil nil org-html-table-header-tags)
157 (:html-table-use-header-tags-for-first-column
158 nil nil org-html-table-use-header-tags-for-first-column)
159 (:html-tag-class-prefix nil nil org-html-tag-class-prefix)
160 (:html-text-markup-alist nil nil org-html-text-markup-alist)
161 (:html-todo-kwd-class-prefix nil nil org-html-todo-kwd-class-prefix)
162 (:html-toplevel-hlevel nil nil org-html-toplevel-hlevel)
163 (:html-use-infojs nil nil org-html-use-infojs)
164 (:html-use-unicode-chars nil nil org-html-use-unicode-chars)
165 (:html-validation-link nil nil org-html-validation-link)
166 (:html-viewport nil nil org-html-viewport)
167 (:html-inline-images nil nil org-html-inline-images)
168 (:html-table-attributes nil nil org-html-table-default-attributes)
169 (:html-table-row-tags nil nil org-html-table-row-tags)
170 (:html-xml-declaration nil nil org-html-xml-declaration)
171 (:infojs-opt "INFOJS_OPT" nil nil)
172 ;; Redefine regular options.
173 (:creator "CREATOR" nil org-html-creator-string)
174 (:with-latex nil "tex" org-html-with-latex)
175 ;; Retrieve LaTeX header for fragments.
176 (:latex-header "LATEX_HEADER" nil nil newline)))
179 ;;; Internal Variables
181 (defvar org-html-format-table-no-css)
182 (defvar htmlize-buffer-places) ; from htmlize.el
184 (defvar org-html--pre/postamble-class "status"
185 "CSS class used for pre/postamble")
187 (defconst org-html-doctype-alist
188 '(("html4-strict" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"
189 \"http://www.w3.org/TR/html4/strict.dtd\">")
190 ("html4-transitional" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\"
191 \"http://www.w3.org/TR/html4/loose.dtd\">")
192 ("html4-frameset" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Frameset//EN\"
193 \"http://www.w3.org/TR/html4/frameset.dtd\">")
195 ("xhtml-strict" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
196 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">")
197 ("xhtml-transitional" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"
198 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">")
199 ("xhtml-frameset" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Frameset//EN\"
200 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd\">")
201 ("xhtml-11" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\"
202 \"http://www.w3.org/TR/xhtml1/DTD/xhtml11.dtd\">")
204 ("html5" . "<!DOCTYPE html>")
205 ("xhtml5" . "<!DOCTYPE html>"))
206 "An alist mapping (x)html flavors to specific doctypes.")
208 (defconst org-html-html5-elements
209 '("article" "aside" "audio" "canvas" "details" "figcaption"
210 "figure" "footer" "header" "menu" "meter" "nav" "output"
211 "progress" "section" "video")
212 "New elements in html5.
214 For blocks that should contain headlines, use the HTML_CONTAINER
215 property on the headline itself.")
217 (defconst org-html-special-string-regexps
218 '(("\\\\-" . "&#x00ad;") ; shy
219 ("---\\([^-]\\)" . "&#x2014;\\1") ; mdash
220 ("--\\([^-]\\)" . "&#x2013;\\1") ; ndash
221 ("\\.\\.\\." . "&#x2026;")) ; hellip
222 "Regular expressions for special string conversion.")
224 (defconst org-html-scripts
225 "<script type=\"text/javascript\">
227 @licstart The following is the entire license notice for the
228 JavaScript code in this tag.
230 Copyright (C) 2012-2013 Free Software Foundation, Inc.
232 The JavaScript code in this tag is free software: you can
233 redistribute it and/or modify it under the terms of the GNU
234 General Public License (GNU GPL) as published by the Free Software
235 Foundation, either version 3 of the License, or (at your option)
236 any later version. The code is distributed WITHOUT ANY WARRANTY;
237 without even the implied warranty of MERCHANTABILITY or FITNESS
238 FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
240 As additional permission under GNU GPL version 3 section 7, you
241 may distribute non-source (e.g., minimized or compacted) forms of
242 that code without the copy of the GNU GPL normally required by
243 section 4, provided you include this license notice and a URL
244 through which recipients can access the Corresponding Source.
247 @licend The above is the entire license notice
248 for the JavaScript code in this tag.
250 <!--/*--><![CDATA[/*><!--*/
251 function CodeHighlightOn(elem, id)
253 var target = document.getElementById(id);
254 if(null != target) {
255 elem.cacheClassElem = elem.className;
256 elem.cacheClassTarget = target.className;
257 target.className = \"code-highlighted\";
258 elem.className = \"code-highlighted\";
261 function CodeHighlightOff(elem, id)
263 var target = document.getElementById(id);
264 if(elem.cacheClassElem)
265 elem.className = elem.cacheClassElem;
266 if(elem.cacheClassTarget)
267 target.className = elem.cacheClassTarget;
269 /*]]>*///-->
270 </script>"
271 "Basic JavaScript that is needed by HTML files produced by Org mode.")
273 (defconst org-html-style-default
274 "<style type=\"text/css\">
275 <!--/*--><![CDATA[/*><!--*/
276 .title { text-align: center;
277 margin-bottom: .2em; }
278 .subtitle { text-align: center;
279 font-size: medium;
280 font-weight: bold;
281 margin-top:0; }
282 .todo { font-family: monospace; color: red; }
283 .done { font-family: monospace; color: green; }
284 .priority { font-family: monospace; color: orange; }
285 .tag { background-color: #eee; font-family: monospace;
286 padding: 2px; font-size: 80%; font-weight: normal; }
287 .timestamp { color: #bebebe; }
288 .timestamp-kwd { color: #5f9ea0; }
289 .org-right { margin-left: auto; margin-right: 0px; text-align: right; }
290 .org-left { margin-left: 0px; margin-right: auto; text-align: left; }
291 .org-center { margin-left: auto; margin-right: auto; text-align: center; }
292 .underline { text-decoration: underline; }
293 #postamble p, #preamble p { font-size: 90%; margin: .2em; }
294 p.verse { margin-left: 3%; }
295 pre {
296 border: 1px solid #ccc;
297 box-shadow: 3px 3px 3px #eee;
298 padding: 8pt;
299 font-family: monospace;
300 overflow: auto;
301 margin: 1.2em;
303 pre.src {
304 position: relative;
305 overflow: visible;
306 padding-top: 1.2em;
308 pre.src:before {
309 display: none;
310 position: absolute;
311 background-color: white;
312 top: -10px;
313 right: 10px;
314 padding: 3px;
315 border: 1px solid black;
317 pre.src:hover:before { display: inline;}
318 pre.src-sh:before { content: 'sh'; }
319 pre.src-bash:before { content: 'sh'; }
320 pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
321 pre.src-R:before { content: 'R'; }
322 pre.src-perl:before { content: 'Perl'; }
323 pre.src-java:before { content: 'Java'; }
324 pre.src-sql:before { content: 'SQL'; }
326 table { border-collapse:collapse; }
327 caption.t-above { caption-side: top; }
328 caption.t-bottom { caption-side: bottom; }
329 td, th { vertical-align:top; }
330 th.org-right { text-align: center; }
331 th.org-left { text-align: center; }
332 th.org-center { text-align: center; }
333 td.org-right { text-align: right; }
334 td.org-left { text-align: left; }
335 td.org-center { text-align: center; }
336 dt { font-weight: bold; }
337 .footpara:nth-child(2) { display: inline; }
338 .footpara { display: block; }
339 .footdef { margin-bottom: 1em; }
340 .figure { padding: 1em; }
341 .figure p { text-align: center; }
342 .inlinetask {
343 padding: 10px;
344 border: 2px solid gray;
345 margin: 10px;
346 background: #ffffcc;
348 #org-div-home-and-up
349 { text-align: right; font-size: 70%; white-space: nowrap; }
350 textarea { overflow-x: auto; }
351 .linenr { font-size: smaller }
352 .code-highlighted { background-color: #ffff00; }
353 .org-info-js_info-navigation { border-style: none; }
354 #org-info-js_console-label
355 { font-size: 10px; font-weight: bold; white-space: nowrap; }
356 .org-info-js_search-highlight
357 { background-color: #ffff00; color: #000000; font-weight: bold; }
358 /*]]>*/-->
359 </style>"
360 "The default style specification for exported HTML files.
361 You can use `org-html-head' and `org-html-head-extra' to add to
362 this style. If you don't want to include this default style,
363 customize `org-html-head-include-default-style'.")
366 ;;; User Configuration Variables
368 (defgroup org-export-html nil
369 "Options for exporting Org mode files to HTML."
370 :tag "Org Export HTML"
371 :group 'org-export)
373 ;;;; Handle infojs
375 (defvar org-html-infojs-opts-table
376 '((path PATH "http://orgmode.org/org-info.js")
377 (view VIEW "info")
378 (toc TOC :with-toc)
379 (ftoc FIXED_TOC "0")
380 (tdepth TOC_DEPTH "max")
381 (sdepth SECTION_DEPTH "max")
382 (mouse MOUSE_HINT "underline")
383 (buttons VIEW_BUTTONS "0")
384 (ltoc LOCAL_TOC "1")
385 (up LINK_UP :html-link-up)
386 (home LINK_HOME :html-link-home))
387 "JavaScript options, long form for script, default values.")
389 (defcustom org-html-use-infojs 'when-configured
390 "Non-nil when Sebastian Rose's Java Script org-info.js should be active.
391 This option can be nil or t to never or always use the script.
392 It can also be the symbol `when-configured', meaning that the
393 script will be linked into the export file if and only if there
394 is a \"#+INFOJS_OPT:\" line in the buffer. See also the variable
395 `org-html-infojs-options'."
396 :group 'org-export-html
397 :version "24.4"
398 :package-version '(Org . "8.0")
399 :type '(choice
400 (const :tag "Never" nil)
401 (const :tag "When configured in buffer" when-configured)
402 (const :tag "Always" t)))
404 (defcustom org-html-infojs-options
405 (mapcar (lambda (x) (cons (car x) (nth 2 x))) org-html-infojs-opts-table)
406 "Options settings for the INFOJS JavaScript.
407 Each of the options must have an entry in `org-html-infojs-opts-table'.
408 The value can either be a string that will be passed to the script, or
409 a property. This property is then assumed to be a property that is defined
410 by the Export/Publishing setup of Org.
411 The `sdepth' and `tdepth' parameters can also be set to \"max\", which
412 means to use the maximum value consistent with other options."
413 :group 'org-export-html
414 :version "24.4"
415 :package-version '(Org . "8.0")
416 :type
417 `(set :greedy t :inline t
418 ,@(mapcar
419 (lambda (x)
420 (list 'cons (list 'const (car x))
421 '(choice
422 (symbol :tag "Publishing/Export property")
423 (string :tag "Value"))))
424 org-html-infojs-opts-table)))
426 (defcustom org-html-infojs-template
427 "<script type=\"text/javascript\" src=\"%SCRIPT_PATH\">
430 * @source: %SCRIPT_PATH
432 * @licstart The following is the entire license notice for the
433 * JavaScript code in %SCRIPT_PATH.
435 * Copyright (C) 2012-2013 Free Software Foundation, Inc.
438 * The JavaScript code in this tag is free software: you can
439 * redistribute it and/or modify it under the terms of the GNU
440 * General Public License (GNU GPL) as published by the Free Software
441 * Foundation, either version 3 of the License, or (at your option)
442 * any later version. The code is distributed WITHOUT ANY WARRANTY;
443 * without even the implied warranty of MERCHANTABILITY or FITNESS
444 * FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
446 * As additional permission under GNU GPL version 3 section 7, you
447 * may distribute non-source (e.g., minimized or compacted) forms of
448 * that code without the copy of the GNU GPL normally required by
449 * section 4, provided you include this license notice and a URL
450 * through which recipients can access the Corresponding Source.
452 * @licend The above is the entire license notice
453 * for the JavaScript code in %SCRIPT_PATH.
456 </script>
458 <script type=\"text/javascript\">
461 @licstart The following is the entire license notice for the
462 JavaScript code in this tag.
464 Copyright (C) 2012-2013 Free Software Foundation, Inc.
466 The JavaScript code in this tag is free software: you can
467 redistribute it and/or modify it under the terms of the GNU
468 General Public License (GNU GPL) as published by the Free Software
469 Foundation, either version 3 of the License, or (at your option)
470 any later version. The code is distributed WITHOUT ANY WARRANTY;
471 without even the implied warranty of MERCHANTABILITY or FITNESS
472 FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
474 As additional permission under GNU GPL version 3 section 7, you
475 may distribute non-source (e.g., minimized or compacted) forms of
476 that code without the copy of the GNU GPL normally required by
477 section 4, provided you include this license notice and a URL
478 through which recipients can access the Corresponding Source.
481 @licend The above is the entire license notice
482 for the JavaScript code in this tag.
485 <!--/*--><![CDATA[/*><!--*/
486 %MANAGER_OPTIONS
487 org_html_manager.setup(); // activate after the parameters are set
488 /*]]>*///-->
489 </script>"
490 "The template for the export style additions when org-info.js is used.
491 Option settings will replace the %MANAGER-OPTIONS cookie."
492 :group 'org-export-html
493 :version "24.4"
494 :package-version '(Org . "8.0")
495 :type 'string)
497 (defun org-html-infojs-install-script (exp-plist backend)
498 "Install script in export options when appropriate.
499 EXP-PLIST is a plist containing export options. BACKEND is the
500 export back-end currently used."
501 (unless (or (memq 'body-only (plist-get exp-plist :export-options))
502 (not (plist-get exp-plist :html-use-infojs))
503 (and (eq (plist-get exp-plist :html-use-infojs) 'when-configured)
504 (let ((opt (plist-get exp-plist :infojs-opt)))
505 (or (not opt)
506 (string= "" opt)
507 (string-match "\\<view:nil\\>" opt)))))
508 (let* ((template (plist-get exp-plist :html-infojs-template))
509 (ptoc (plist-get exp-plist :with-toc))
510 (hlevels (plist-get exp-plist :headline-levels))
511 (sdepth hlevels)
512 (tdepth (if (integerp ptoc) (min ptoc hlevels) hlevels))
513 (options (plist-get exp-plist :infojs-opt))
514 (infojs-opt (plist-get exp-plist :html-infojs-options))
515 (table org-html-infojs-opts-table)
516 style)
517 (dolist (entry table)
518 (let* ((opt (car entry))
519 (var (nth 1 entry))
520 ;; Compute default values for script option OPT from
521 ;; `org-html-infojs-options' variable.
522 (default
523 (let ((default (cdr (assq opt infojs-opt))))
524 (if (and (symbolp default) (not (memq default '(t nil))))
525 (plist-get exp-plist default)
526 default)))
527 ;; Value set through INFOJS_OPT keyword has precedence
528 ;; over the default one.
529 (val (if (and options
530 (string-match (format "\\<%s:\\(\\S-+\\)" opt)
531 options))
532 (match-string 1 options)
533 default)))
534 (case opt
535 (path (setq template
536 (replace-regexp-in-string
537 "%SCRIPT_PATH" val template t t)))
538 (sdepth (when (integerp (read val))
539 (setq sdepth (min (read val) sdepth))))
540 (tdepth (when (integerp (read val))
541 (setq tdepth (min (read val) tdepth))))
542 (otherwise (setq val
543 (cond
544 ((or (eq val t) (equal val "t")) "1")
545 ((or (eq val nil) (equal val "nil")) "0")
546 ((stringp val) val)
547 (t (format "%s" val))))
548 (push (cons var val) style)))))
549 ;; Now we set the depth of the *generated* TOC to SDEPTH,
550 ;; because the toc will actually determine the splitting. How
551 ;; much of the toc will actually be displayed is governed by the
552 ;; TDEPTH option.
553 (setq exp-plist (plist-put exp-plist :with-toc sdepth))
554 ;; The table of contents should not show more sections than we
555 ;; generate.
556 (setq tdepth (min tdepth sdepth))
557 (push (cons "TOC_DEPTH" tdepth) style)
558 ;; Build style string.
559 (setq style (mapconcat
560 (lambda (x)
561 (format "org_html_manager.set(\"%s\", \"%s\");"
562 (car x) (cdr x)))
563 style "\n"))
564 (when (and style (> (length style) 0))
565 (and (string-match "%MANAGER_OPTIONS" template)
566 (setq style (replace-match style t t template))
567 (setq exp-plist
568 (plist-put
569 exp-plist :html-head-extra
570 (concat (or (plist-get exp-plist :html-head-extra) "")
571 "\n"
572 style)))))
573 ;; This script absolutely needs the table of contents, so we
574 ;; change that setting.
575 (unless (plist-get exp-plist :with-toc)
576 (setq exp-plist (plist-put exp-plist :with-toc t)))
577 ;; Return the modified property list.
578 exp-plist)))
580 ;;;; Bold, etc.
582 (defcustom org-html-text-markup-alist
583 '((bold . "<b>%s</b>")
584 (code . "<code>%s</code>")
585 (italic . "<i>%s</i>")
586 (strike-through . "<del>%s</del>")
587 (underline . "<span class=\"underline\">%s</span>")
588 (verbatim . "<code>%s</code>"))
589 "Alist of HTML expressions to convert text markup.
591 The key must be a symbol among `bold', `code', `italic',
592 `strike-through', `underline' and `verbatim'. The value is
593 a formatting string to wrap fontified text with.
595 If no association can be found for a given markup, text will be
596 returned as-is."
597 :group 'org-export-html
598 :version "24.4"
599 :package-version '(Org . "8.0")
600 :type '(alist :key-type (symbol :tag "Markup type")
601 :value-type (string :tag "Format string"))
602 :options '(bold code italic strike-through underline verbatim))
604 (defcustom org-html-indent nil
605 "Non-nil means to indent the generated HTML.
606 Warning: non-nil may break indentation of source code blocks."
607 :group 'org-export-html
608 :version "24.4"
609 :package-version '(Org . "8.0")
610 :type 'boolean)
612 (defcustom org-html-use-unicode-chars nil
613 "Non-nil means to use unicode characters instead of HTML entities."
614 :group 'org-export-html
615 :version "24.4"
616 :package-version '(Org . "8.0")
617 :type 'boolean)
619 ;;;; Drawers
621 (defcustom org-html-format-drawer-function (lambda (name contents) contents)
622 "Function called to format a drawer in HTML code.
624 The function must accept two parameters:
625 NAME the drawer name, like \"LOGBOOK\"
626 CONTENTS the contents of the drawer.
628 The function should return the string to be exported.
630 For example, the variable could be set to the following function
631 in order to mimic default behaviour:
633 The default value simply returns the value of CONTENTS."
634 :group 'org-export-html
635 :version "24.4"
636 :package-version '(Org . "8.0")
637 :type 'function)
639 ;;;; Footnotes
641 (defcustom org-html-footnotes-section "<div id=\"footnotes\">
642 <h2 class=\"footnotes\">%s: </h2>
643 <div id=\"text-footnotes\">
645 </div>
646 </div>"
647 "Format for the footnotes section.
648 Should contain a two instances of %s. The first will be replaced with the
649 language-specific word for \"Footnotes\", the second one will be replaced
650 by the footnotes themselves."
651 :group 'org-export-html
652 :type 'string)
654 (defcustom org-html-footnote-format "<sup>%s</sup>"
655 "The format for the footnote reference.
656 %s will be replaced by the footnote reference itself."
657 :group 'org-export-html
658 :type 'string)
660 (defcustom org-html-footnote-separator "<sup>, </sup>"
661 "Text used to separate footnotes."
662 :group 'org-export-html
663 :type 'string)
665 ;;;; Headline
667 (defcustom org-html-toplevel-hlevel 2
668 "The <H> level for level 1 headings in HTML export.
669 This is also important for the classes that will be wrapped around headlines
670 and outline structure. If this variable is 1, the top-level headlines will
671 be <h1>, and the corresponding classes will be outline-1, section-number-1,
672 and outline-text-1. If this is 2, all of these will get a 2 instead.
673 The default for this variable is 2, because we use <h1> for formatting the
674 document title."
675 :group 'org-export-html
676 :type 'integer)
678 (defcustom org-html-format-headline-function
679 'org-html-format-headline-default-function
680 "Function to format headline text.
682 This function will be called with six arguments:
683 TODO the todo keyword (string or nil).
684 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
685 PRIORITY the priority of the headline (integer or nil)
686 TEXT the main headline text (string).
687 TAGS the tags (string or nil).
688 INFO the export options (plist).
690 The function result will be used in the section format string."
691 :group 'org-export-html
692 :version "25.1"
693 :package-version '(Org . "8.3")
694 :type 'function)
696 ;;;; HTML-specific
698 (defcustom org-html-allow-name-attribute-in-anchors nil
699 "When nil, do not set \"name\" attribute in anchors.
700 By default, when appropriate, anchors are formatted with \"id\"
701 but without \"name\" attribute."
702 :group 'org-export-html
703 :version "24.4"
704 :package-version '(Org . "8.0")
705 :type 'boolean)
707 ;;;; Inlinetasks
709 (defcustom org-html-format-inlinetask-function
710 'org-html-format-inlinetask-default-function
711 "Function called to format an inlinetask in HTML code.
713 The function must accept seven parameters:
714 TODO the todo keyword, as a string
715 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
716 PRIORITY the inlinetask priority, as a string
717 NAME the inlinetask name, as a string.
718 TAGS the inlinetask tags, as a list of strings.
719 CONTENTS the contents of the inlinetask, as a string.
720 INFO the export options, as a plist
722 The function should return the string to be exported."
723 :group 'org-export-html
724 :version "25.1"
725 :package-version '(Org . "8.3")
726 :type 'function)
728 ;;;; LaTeX
730 (defcustom org-html-with-latex org-export-with-latex
731 "Non-nil means process LaTeX math snippets.
733 When set, the exporter will process LaTeX environments and
734 fragments.
736 This option can also be set with the +OPTIONS line,
737 e.g. \"tex:mathjax\". Allowed values are:
739 nil Ignore math snippets.
740 `verbatim' Keep everything in verbatim
741 `dvipng' Process the LaTeX fragments to images. This will also
742 include processing of non-math environments.
743 `imagemagick' Convert the LaTeX fragments to pdf files and use
744 imagemagick to convert pdf files to png files.
745 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
746 be loaded.
747 t Synonym for `mathjax'."
748 :group 'org-export-html
749 :version "24.4"
750 :package-version '(Org . "8.0")
751 :type '(choice
752 (const :tag "Do not process math in any way" nil)
753 (const :tag "Use dvipng to make images" dvipng)
754 (const :tag "Use imagemagick to make images" imagemagick)
755 (const :tag "Use MathJax to display math" mathjax)
756 (const :tag "Leave math verbatim" verbatim)))
758 ;;;; Links :: Generic
760 (defcustom org-html-link-org-files-as-html t
761 "Non-nil means make file links to `file.org' point to `file.html'.
762 When `org-mode' is exporting an `org-mode' file to HTML, links to
763 non-html files are directly put into a href tag in HTML.
764 However, links to other Org-mode files (recognized by the
765 extension `.org.) should become links to the corresponding html
766 file, assuming that the linked `org-mode' file will also be
767 converted to HTML.
768 When nil, the links still point to the plain `.org' file."
769 :group 'org-export-html
770 :type 'boolean)
772 ;;;; Links :: Inline images
774 (defcustom org-html-inline-images t
775 "Non-nil means inline images into exported HTML pages.
776 This is done using an <img> tag. When nil, an anchor with href is used to
777 link to the image."
778 :group 'org-export-html
779 :version "24.4"
780 :package-version '(Org . "8.1")
781 :type 'boolean)
783 (defcustom org-html-inline-image-rules
784 '(("file" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")
785 ("http" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")
786 ("https" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'"))
787 "Rules characterizing image files that can be inlined into HTML.
788 A rule consists in an association whose key is the type of link
789 to consider, and value is a regexp that will be matched against
790 link's path."
791 :group 'org-export-html
792 :version "24.4"
793 :package-version '(Org . "8.0")
794 :type '(alist :key-type (string :tag "Type")
795 :value-type (regexp :tag "Path")))
797 ;;;; Plain Text
799 (defvar org-html-protect-char-alist
800 '(("&" . "&amp;")
801 ("<" . "&lt;")
802 (">" . "&gt;"))
803 "Alist of characters to be converted by `org-html-encode-plain-text'.")
805 ;;;; Src Block
807 (defcustom org-html-htmlize-output-type 'inline-css
808 "Output type to be used by htmlize when formatting code snippets.
809 Choices are `css' to export the CSS selectors only,`inline-css'
810 to export the CSS attribute values inline in the HTML or `nil' to
811 export plain text. We use as default `inline-css', in order to
812 make the resulting HTML self-containing.
814 However, this will fail when using Emacs in batch mode for export, because
815 then no rich font definitions are in place. It will also not be good if
816 people with different Emacs setup contribute HTML files to a website,
817 because the fonts will represent the individual setups. In these cases,
818 it is much better to let Org/Htmlize assign classes only, and to use
819 a style file to define the look of these classes.
820 To get a start for your css file, start Emacs session and make sure that
821 all the faces you are interested in are defined, for example by loading files
822 in all modes you want. Then, use the command
823 \\[org-html-htmlize-generate-css] to extract class definitions."
824 :group 'org-export-html
825 :type '(choice (const css) (const inline-css) (const nil)))
827 (defcustom org-html-htmlize-font-prefix "org-"
828 "The prefix for CSS class names for htmlize font specifications."
829 :group 'org-export-html
830 :type 'string)
832 ;;;; Table
834 (defcustom org-html-table-default-attributes
835 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups" :frame "hsides")
836 "Default attributes and values which will be used in table tags.
837 This is a plist where attributes are symbols, starting with
838 colons, and values are strings.
840 When exporting to HTML5, these values will be disregarded."
841 :group 'org-export-html
842 :version "24.4"
843 :package-version '(Org . "8.0")
844 :type '(plist :key-type (symbol :tag "Property")
845 :value-type (string :tag "Value")))
847 (defcustom org-html-table-header-tags '("<th scope=\"%s\"%s>" . "</th>")
848 "The opening and ending tags for table header fields.
849 This is customizable so that alignment options can be specified.
850 The first %s will be filled with the scope of the field, either row or col.
851 The second %s will be replaced by a style entry to align the field.
852 See also the variable `org-html-table-use-header-tags-for-first-column'.
853 See also the variable `org-html-table-align-individual-fields'."
854 :group 'org-export-html
855 :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
857 (defcustom org-html-table-data-tags '("<td%s>" . "</td>")
858 "The opening and ending tags for table data fields.
859 This is customizable so that alignment options can be specified.
860 The first %s will be filled with the scope of the field, either row or col.
861 The second %s will be replaced by a style entry to align the field.
862 See also the variable `org-html-table-align-individual-fields'."
863 :group 'org-export-html
864 :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
866 (defcustom org-html-table-row-tags '("<tr>" . "</tr>")
867 "The opening and ending tags for table rows.
868 This is customizable so that alignment options can be specified.
869 Instead of strings, these can be Lisp forms that will be
870 evaluated for each row in order to construct the table row tags.
872 During evaluation, these variables will be dynamically bound so that
873 you can reuse them:
875 `row-number': row number (0 is the first row)
876 `rowgroup-number': group number of current row
877 `start-rowgroup-p': non-nil means the row starts a group
878 `end-rowgroup-p': non-nil means the row ends a group
879 `top-row-p': non-nil means this is the top row
880 `bottom-row-p': non-nil means this is the bottom row
882 For example:
884 \(setq org-html-table-row-tags
885 (cons '(cond (top-row-p \"<tr class=\\\"tr-top\\\">\")
886 (bottom-row-p \"<tr class=\\\"tr-bottom\\\">\")
887 (t (if (= (mod row-number 2) 1)
888 \"<tr class=\\\"tr-odd\\\">\"
889 \"<tr class=\\\"tr-even\\\">\")))
890 \"</tr>\"))
892 will use the \"tr-top\" and \"tr-bottom\" classes for the top row
893 and the bottom row, and otherwise alternate between \"tr-odd\" and
894 \"tr-even\" for odd and even rows."
895 :group 'org-export-html
896 :type '(cons
897 (choice :tag "Opening tag"
898 (string :tag "Specify")
899 (sexp))
900 (choice :tag "Closing tag"
901 (string :tag "Specify")
902 (sexp))))
904 (defcustom org-html-table-align-individual-fields t
905 "Non-nil means attach style attributes for alignment to each table field.
906 When nil, alignment will only be specified in the column tags, but this
907 is ignored by some browsers (like Firefox, Safari). Opera does it right
908 though."
909 :group 'org-export-html
910 :type 'boolean)
912 (defcustom org-html-table-use-header-tags-for-first-column nil
913 "Non-nil means format column one in tables with header tags.
914 When nil, also column one will use data tags."
915 :group 'org-export-html
916 :type 'boolean)
918 (defcustom org-html-table-caption-above t
919 "When non-nil, place caption string at the beginning of the table.
920 Otherwise, place it near the end."
921 :group 'org-export-html
922 :type 'boolean)
924 ;;;; Tags
926 (defcustom org-html-tag-class-prefix ""
927 "Prefix to class names for TODO keywords.
928 Each tag gets a class given by the tag itself, with this prefix.
929 The default prefix is empty because it is nice to just use the keyword
930 as a class name. But if you get into conflicts with other, existing
931 CSS classes, then this prefix can be very useful."
932 :group 'org-export-html
933 :type 'string)
935 ;;;; Template :: Generic
937 (defcustom org-html-extension "html"
938 "The extension for exported HTML files."
939 :group 'org-export-html
940 :type 'string)
942 (defcustom org-html-xml-declaration
943 '(("html" . "<?xml version=\"1.0\" encoding=\"%s\"?>")
944 ("php" . "<?php echo \"<?xml version=\\\"1.0\\\" encoding=\\\"%s\\\" ?>\"; ?>"))
945 "The extension for exported HTML files.
946 %s will be replaced with the charset of the exported file.
947 This may be a string, or an alist with export extensions
948 and corresponding declarations.
950 This declaration only applies when exporting to XHTML."
951 :group 'org-export-html
952 :type '(choice
953 (string :tag "Single declaration")
954 (repeat :tag "Dependent on extension"
955 (cons (string :tag "Extension")
956 (string :tag "Declaration")))))
958 (defcustom org-html-coding-system 'utf-8
959 "Coding system for HTML export.
960 Use utf-8 as the default value."
961 :group 'org-export-html
962 :version "24.4"
963 :package-version '(Org . "8.0")
964 :type 'coding-system)
966 (defcustom org-html-doctype "xhtml-strict"
967 "Document type definition to use for exported HTML files.
968 Can be set with the in-buffer HTML_DOCTYPE property or for
969 publishing, with :html-doctype."
970 :group 'org-export-html
971 :version "24.4"
972 :package-version '(Org . "8.0")
973 :type (append
974 '(choice)
975 (mapcar (lambda (x) `(const ,(car x))) org-html-doctype-alist)
976 '((string :tag "Custom doctype" ))))
978 (defcustom org-html-html5-fancy nil
979 "Non-nil means using new HTML5 elements.
980 This variable is ignored for anything other than HTML5 export.
982 For compatibility with Internet Explorer, it's probably a good
983 idea to download some form of the html5shiv (for instance
984 https://code.google.com/p/html5shiv/) and add it to your
985 HTML_HEAD_EXTRA, so that your pages don't break for users of IE
986 versions 8 and below."
987 :group 'org-export-html
988 :version "24.4"
989 :package-version '(Org . "8.0")
990 :type 'boolean)
992 (defcustom org-html-container-element "div"
993 "HTML element to use for wrapping top level sections.
994 Can be set with the in-buffer HTML_CONTAINER property or for
995 publishing, with :html-container.
997 Note that changing the default will prevent you from using
998 org-info.js for your website."
999 :group 'org-export-html
1000 :version "24.4"
1001 :package-version '(Org . "8.0")
1002 :type 'string)
1004 (defcustom org-html-divs
1005 '((preamble "div" "preamble")
1006 (content "div" "content")
1007 (postamble "div" "postamble"))
1008 "Alist of the three section elements for HTML export.
1009 The car of each entry is one of 'preamble, 'content or 'postamble.
1010 The cdrs of each entry are the ELEMENT_TYPE and ID for each
1011 section of the exported document.
1013 Note that changing the default will prevent you from using
1014 org-info.js for your website."
1015 :group 'org-export-html
1016 :version "24.4"
1017 :package-version '(Org . "8.0")
1018 :type '(list :greedy t
1019 (list :tag "Preamble"
1020 (const :format "" preamble)
1021 (string :tag "element") (string :tag " id"))
1022 (list :tag "Content"
1023 (const :format "" content)
1024 (string :tag "element") (string :tag " id"))
1025 (list :tag "Postamble" (const :format "" postamble)
1026 (string :tag " id") (string :tag "element"))))
1028 (defconst org-html-checkbox-types
1029 '((unicode .
1030 ((on . "&#x2611;") (off . "&#x2610;") (trans . "&#x2610;")))
1031 (ascii .
1032 ((on . "<code>[X]</code>")
1033 (off . "<code>[&#xa0;]</code>")
1034 (trans . "<code>[-]</code>")))
1035 (html .
1036 ((on . "<input type='checkbox' checked='checked' />")
1037 (off . "<input type='checkbox' />")
1038 (trans . "<input type='checkbox' />"))))
1039 "Alist of checkbox types.
1040 The cdr of each entry is an alist list three checkbox types for
1041 HTML export: `on', `off' and `trans'.
1043 The choices are:
1044 `unicode' Unicode characters (HTML entities)
1045 `ascii' ASCII characters
1046 `html' HTML checkboxes
1048 Note that only the ascii characters implement tri-state
1049 checkboxes. The other two use the `off' checkbox for `trans'.")
1051 (defcustom org-html-checkbox-type 'ascii
1052 "The type of checkboxes to use for HTML export.
1053 See `org-html-checkbox-types' for for the values used for each
1054 option."
1055 :group 'org-export-html
1056 :version "24.4"
1057 :package-version '(Org . "8.0")
1058 :type '(choice
1059 (const :tag "ASCII characters" ascii)
1060 (const :tag "Unicode characters" unicode)
1061 (const :tag "HTML checkboxes" html)))
1063 (defcustom org-html-metadata-timestamp-format "%Y-%m-%d %a %H:%M"
1064 "Format used for timestamps in preamble, postamble and metadata.
1065 See `format-time-string' for more information on its components."
1066 :group 'org-export-html
1067 :version "24.4"
1068 :package-version '(Org . "8.0")
1069 :type 'string)
1071 ;;;; Template :: Mathjax
1073 (defcustom org-html-mathjax-options
1074 '((path "http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML" )
1075 (scale "100")
1076 (align "center")
1077 (font "TeX")
1078 (linebreaks "false")
1079 (autonumber "AMS")
1080 (indent "0em")
1081 (multlinewidth "85%")
1082 (tagindent ".8em")
1083 (tagside "right"))
1084 "Options for MathJax setup.
1086 Alist of the following elements. All values are strings.
1088 path The path to MathJax.
1089 scale Scaling with HTML-CSS, MathML and SVG output engines.
1090 align How to align display math: left, center, or right.
1091 font The font to use with HTML-CSS and SVG output. As of MathJax 2.5
1092 the following values are understood: \"TeX\", \"STIX-Web\",
1093 \"Asana-Math\", \"Neo-Euler\", \"Gyre-Pagella\",
1094 \"Gyre-Termes\", and \"Latin-Modern\".
1095 linebreaks Let MathJax perform automatic linebreaks. Valid values
1096 are \"true\" and \"false\".
1097 indent If align is not center, how far from the left/right side?
1098 Valid values are \"left\" and \"right\"
1099 multlinewidth The width of the multline environment.
1100 autonumber How to number equations. Valid values are \"None\",
1101 \"all\" and \"AMS Math\".
1102 tagindent The amount tags are indented.
1103 tagside Which side to show tags/labels on. Valid values are
1104 \"left\" and \"right\"
1106 You can also customize this for each buffer, using something like
1108 #+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
1110 For further information about MathJax options, see the MathJax documentation:
1112 http://docs.mathjax.org/
1114 Please note that by using the default CDN one must agree with
1115 MathJax CDN Terms of Service.
1117 http://www.mathjax.org/mathjax-cdn-terms-of-service.html"
1118 :group 'org-export-html
1119 :package-version '(Org . "8.3")
1120 :type '(list :greedy t
1121 (list :tag "path (the path from where to load MathJax.js)"
1122 (const :format " " path) (string))
1123 (list :tag "scale (scaling for the displayed math)"
1124 (const :format " " scale) (string))
1125 (list :tag "align (alignment of displayed equations)"
1126 (const :format " " align) (string))
1127 (list :tag "font (used to display math)"
1128 (const :format " " font)
1129 (choice (const "TeX")
1130 (const "STIX-Web")
1131 (const "Asana-Math")
1132 (const "Neo-Euler")
1133 (const "Gyre-Pagella")
1134 (const "Gyre-Termes")
1135 (const "Latin-Modern")))
1136 (list :tag "linebreaks (automatic line-breaking)"
1137 (const :format " " linebreaks)
1138 (choice (const "true")
1139 (const "false")))
1140 (list :tag "autonumber (when should equations be numbered)"
1141 (const :format " " autonumber)
1142 (choice (const "AMS")
1143 (const "None")
1144 (const "All")))
1145 (list :tag "indent (indentation with left or right alignment)"
1146 (const :format " " indent) (string))
1147 (list :tag "multlinewidth (width to use for the multline environment)"
1148 (const :format " " multlinewidth) (string))
1149 (list :tag "tagindent (the indentation of tags from left or right)"
1150 (const :format " " tagindent) (string))
1151 (list :tag "tagside (location of tags)"
1152 (const :format " " tagside)
1153 (choice (const "left")
1154 (const "right")))))
1156 (defcustom org-html-mathjax-template
1157 "<script type=\"text/x-mathjax-config\">
1158 MathJax.Hub.Config({
1159 displayAlign: \"%ALIGN\",
1160 displayIndent: \"%INDENT\",
1162 \"HTML-CSS\": { scale: %SCALE,
1163 linebreaks: { automatic: \"%LINEBREAKS\" },
1164 webFont: \"%FONT\"
1166 SVG: {scale: %SCALE,
1167 linebreaks: { automatic: \"%LINEBREAKS\" },
1168 font: \"%FONT\"},
1169 NativeMML: {scale: %SCALE},
1170 TeX: { equationNumbers: {autoNumber: \"%AUTONUMBER\"},
1171 MultLineWidth: \"%MULTLINEWIDTH\",
1172 TagSide: \"%TAGSIDE\",
1173 TagIndent: \"%TAGINDENT\"
1176 </script>
1177 <script type=\"text/javascript\"
1178 src=\"%PATH\"></script>"
1179 "The MathJax template. See also `org-html-mathjax-options'."
1180 :group 'org-export-html
1181 :type 'string)
1183 ;;;; Template :: Postamble
1185 (defcustom org-html-postamble 'auto
1186 "Non-nil means insert a postamble in HTML export.
1188 When set to 'auto, check against the
1189 `org-export-with-author/email/creator/date' variables to set the
1190 content of the postamble. When set to a string, use this string
1191 as the postamble. When t, insert a string as defined by the
1192 formatting string in `org-html-postamble-format'.
1194 When set to a function, apply this function and insert the
1195 returned string. The function takes the property list of export
1196 options as its only argument.
1198 Setting :html-postamble in publishing projects will take
1199 precedence over this variable."
1200 :group 'org-export-html
1201 :type '(choice (const :tag "No postamble" nil)
1202 (const :tag "Auto postamble" auto)
1203 (const :tag "Default formatting string" t)
1204 (string :tag "Custom formatting string")
1205 (function :tag "Function (must return a string)")))
1207 (defcustom org-html-postamble-format
1208 '(("en" "<p class=\"author\">Author: %a (%e)</p>
1209 <p class=\"date\">Date: %d</p>
1210 <p class=\"creator\">%c</p>
1211 <p class=\"validation\">%v</p>"))
1212 "Alist of languages and format strings for the HTML postamble.
1214 The first element of each list is the language code, as used for
1215 the LANGUAGE keyword. See `org-export-default-language'.
1217 The second element of each list is a format string to format the
1218 postamble itself. This format string can contain these elements:
1220 %t stands for the title.
1221 %s stands for the subtitle.
1222 %a stands for the author's name.
1223 %e stands for the author's email.
1224 %d stands for the date.
1225 %c will be replaced by `org-html-creator-string'.
1226 %v will be replaced by `org-html-validation-link'.
1227 %T will be replaced by the export time.
1228 %C will be replaced by the last modification time.
1230 If you need to use a \"%\" character, you need to escape it
1231 like that: \"%%\"."
1232 :group 'org-export-html
1233 :type '(repeat
1234 (list (string :tag "Language")
1235 (string :tag "Format string"))))
1237 (defcustom org-html-validation-link
1238 "<a href=\"http://validator.w3.org/check?uri=referer\">Validate</a>"
1239 "Link to HTML validation service."
1240 :group 'org-export-html
1241 :type 'string)
1243 (defcustom org-html-creator-string
1244 (format "<a href=\"http://www.gnu.org/software/emacs/\">Emacs</a> %s (<a href=\"http://orgmode.org\">Org</a> mode %s)"
1245 emacs-version
1246 (if (fboundp 'org-version) (org-version) "unknown version"))
1247 "Information about the creator of the HTML document.
1248 This option can also be set on with the CREATOR keyword."
1249 :group 'org-export-html
1250 :version "24.4"
1251 :package-version '(Org . "8.0")
1252 :type '(string :tag "Creator string"))
1254 ;;;; Template :: Preamble
1256 (defcustom org-html-preamble t
1257 "Non-nil means insert a preamble in HTML export.
1259 When t, insert a string as defined by the formatting string in
1260 `org-html-preamble-format'. When set to a string, use this
1261 formatting string instead (see `org-html-postamble-format' for an
1262 example of such a formatting string).
1264 When set to a function, apply this function and insert the
1265 returned string. The function takes the property list of export
1266 options as its only argument.
1268 Setting :html-preamble in publishing projects will take
1269 precedence over this variable."
1270 :group 'org-export-html
1271 :type '(choice (const :tag "No preamble" nil)
1272 (const :tag "Default preamble" t)
1273 (string :tag "Custom formatting string")
1274 (function :tag "Function (must return a string)")))
1276 (defcustom org-html-preamble-format '(("en" ""))
1277 "Alist of languages and format strings for the HTML preamble.
1279 The first element of each list is the language code, as used for
1280 the LANGUAGE keyword. See `org-export-default-language'.
1282 The second element of each list is a format string to format the
1283 preamble itself. This format string can contain these elements:
1285 %t stands for the title.
1286 %s stands for the subtitle.
1287 %a stands for the author's name.
1288 %e stands for the author's email.
1289 %d stands for the date.
1290 %c will be replaced by `org-html-creator-string'.
1291 %v will be replaced by `org-html-validation-link'.
1292 %T will be replaced by the export time.
1293 %C will be replaced by the last modification time.
1295 If you need to use a \"%\" character, you need to escape it
1296 like that: \"%%\".
1298 See the default value of `org-html-postamble-format' for an
1299 example."
1300 :group 'org-export-html
1301 :type '(repeat
1302 (list (string :tag "Language")
1303 (string :tag "Format string"))))
1305 (defcustom org-html-link-up ""
1306 "Where should the \"UP\" link of exported HTML pages lead?"
1307 :group 'org-export-html
1308 :type '(string :tag "File or URL"))
1310 (defcustom org-html-link-home ""
1311 "Where should the \"HOME\" link of exported HTML pages lead?"
1312 :group 'org-export-html
1313 :type '(string :tag "File or URL"))
1315 (defcustom org-html-link-use-abs-url nil
1316 "Should we prepend relative links with HTML_LINK_HOME?"
1317 :group 'org-export-html
1318 :version "24.4"
1319 :package-version '(Org . "8.1")
1320 :type 'boolean)
1322 (defcustom org-html-home/up-format
1323 "<div id=\"org-div-home-and-up\">
1324 <a accesskey=\"h\" href=\"%s\"> UP </a>
1326 <a accesskey=\"H\" href=\"%s\"> HOME </a>
1327 </div>"
1328 "Snippet used to insert the HOME and UP links.
1329 This is a format string, the first %s will receive the UP link,
1330 the second the HOME link. If both `org-html-link-up' and
1331 `org-html-link-home' are empty, the entire snippet will be
1332 ignored."
1333 :group 'org-export-html
1334 :type 'string)
1336 ;;;; Template :: Scripts
1338 (define-obsolete-variable-alias
1339 'org-html-style-include-scripts 'org-html-head-include-scripts "24.4")
1340 (defcustom org-html-head-include-scripts t
1341 "Non-nil means include the JavaScript snippets in exported HTML files.
1342 The actual script is defined in `org-html-scripts' and should
1343 not be modified."
1344 :group 'org-export-html
1345 :version "24.4"
1346 :package-version '(Org . "8.0")
1347 :type 'boolean)
1349 ;;;; Template :: Styles
1351 (define-obsolete-variable-alias
1352 'org-html-style-include-default 'org-html-head-include-default-style "24.4")
1353 (defcustom org-html-head-include-default-style t
1354 "Non-nil means include the default style in exported HTML files.
1355 The actual style is defined in `org-html-style-default' and
1356 should not be modified. Use `org-html-head' to use your own
1357 style information."
1358 :group 'org-export-html
1359 :version "24.4"
1360 :package-version '(Org . "8.0")
1361 :type 'boolean)
1362 ;;;###autoload
1363 (put 'org-html-head-include-default-style 'safe-local-variable 'booleanp)
1365 (define-obsolete-variable-alias 'org-html-style 'org-html-head "24.4")
1366 (defcustom org-html-head ""
1367 "Org-wide head definitions for exported HTML files.
1369 This variable can contain the full HTML structure to provide a
1370 style, including the surrounding HTML tags. You can consider
1371 including definitions for the following classes: title, todo,
1372 done, timestamp, timestamp-kwd, tag, target.
1374 For example, a valid value would be:
1376 <style type=\"text/css\">
1377 <![CDATA[
1378 p { font-weight: normal; color: gray; }
1379 h1 { color: black; }
1380 .title { text-align: center; }
1381 .todo, .timestamp-kwd { color: red; }
1382 .done { color: green; }
1384 </style>
1386 If you want to refer to an external style, use something like
1388 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\" />
1390 As the value of this option simply gets inserted into the HTML
1391 <head> header, you can use it to add any arbitrary text to the
1392 header.
1394 You can set this on a per-file basis using #+HTML_HEAD:,
1395 or for publication projects using the :html-head property."
1396 :group 'org-export-html
1397 :version "24.4"
1398 :package-version '(Org . "8.0")
1399 :type 'string)
1400 ;;;###autoload
1401 (put 'org-html-head 'safe-local-variable 'stringp)
1403 (defcustom org-html-head-extra ""
1404 "More head information to add in the HTML output.
1406 You can set this on a per-file basis using #+HTML_HEAD_EXTRA:,
1407 or for publication projects using the :html-head-extra property."
1408 :group 'org-export-html
1409 :version "24.4"
1410 :package-version '(Org . "8.0")
1411 :type 'string)
1412 ;;;###autoload
1413 (put 'org-html-head-extra 'safe-local-variable 'stringp)
1415 ;;;; Template :: Viewport
1417 (defcustom org-html-viewport '((width "device-width")
1418 (initial-scale "1")
1419 (minimum-scale "")
1420 (maximum-scale "")
1421 (user-scalable ""))
1422 "Viewport options for mobile-optimized sites.
1424 The following values are recognized
1426 width Size of the viewport.
1427 initial-scale Zoom level when the page is first loaded.
1428 minimum-scale Minimum allowed zoom level.
1429 maximum-scale Maximum allowed zoom level.
1430 user-scalable Whether zoom can be changed.
1432 The viewport meta tag is inserted if this variable is non-nil.
1434 See the following site for a reference:
1435 https://developer.mozilla.org/en-US/docs/Mozilla/Mobile/Viewport_meta_tag"
1436 :group 'org-export-html
1437 :version "25.1"
1438 :package-version '(Org . "8.3")
1439 :type '(list :greedy t
1440 (list :tag "Width of viewport"
1441 (const :format " " width)
1442 (choice (const :tag "unset" "")
1443 (string)))
1444 (list :tag "Initial scale"
1445 (const :format " " initial-scale)
1446 (choice (const :tag "unset" "")
1447 (string)))
1448 (list :tag "Minimum scale/zoom"
1449 (const :format " " minimum-scale)
1450 (choice (const :tag "unset" "")
1451 (string)))
1452 (list :tag "Maximum scale/zoom"
1453 (const :format " " maximum-scale)
1454 (choice (const :tag "unset" "")
1455 (string)))
1456 (list :tag "User scalable/zoomable"
1457 (const :format " " user-scalable)
1458 (choice (const :tag "unset" "")
1459 (const "true")
1460 (const "false")))))
1462 ;;;; Todos
1464 (defcustom org-html-todo-kwd-class-prefix ""
1465 "Prefix to class names for TODO keywords.
1466 Each TODO keyword gets a class given by the keyword itself, with this prefix.
1467 The default prefix is empty because it is nice to just use the keyword
1468 as a class name. But if you get into conflicts with other, existing
1469 CSS classes, then this prefix can be very useful."
1470 :group 'org-export-html
1471 :type 'string)
1474 ;;; Internal Functions
1476 (defun org-html-xhtml-p (info)
1477 (let ((dt (downcase (plist-get info :html-doctype))))
1478 (string-match-p "xhtml" dt)))
1480 (defun org-html-html5-p (info)
1481 (let ((dt (downcase (plist-get info :html-doctype))))
1482 (member dt '("html5" "xhtml5" "<!doctype html>"))))
1484 (defun org-html-close-tag (tag attr info)
1485 (concat "<" tag " " attr
1486 (if (org-html-xhtml-p info) " />" ">")))
1488 (defun org-html-doctype (info)
1489 "Return correct html doctype tag from `org-html-doctype-alist',
1490 or the literal value of :html-doctype from INFO if :html-doctype
1491 is not found in the alist.
1492 INFO is a plist used as a communication channel."
1493 (let ((dt (plist-get info :html-doctype)))
1494 (or (cdr (assoc dt org-html-doctype-alist)) dt)))
1496 (defun org-html--make-attribute-string (attributes)
1497 "Return a list of attributes, as a string.
1498 ATTRIBUTES is a plist where values are either strings or nil. An
1499 attributes with a nil value will be omitted from the result."
1500 (let (output)
1501 (dolist (item attributes (mapconcat 'identity (nreverse output) " "))
1502 (cond ((null item) (pop output))
1503 ((symbolp item) (push (substring (symbol-name item) 1) output))
1504 (t (let ((key (car output))
1505 (value (replace-regexp-in-string
1506 "\"" "&quot;" (org-html-encode-plain-text item))))
1507 (setcar output (format "%s=\"%s\"" key value))))))))
1509 (defun org-html--wrap-image (contents info &optional caption label)
1510 "Wrap CONTENTS string within an appropriate environment for images.
1511 INFO is a plist used as a communication channel. When optional
1512 arguments CAPTION and LABEL are given, use them for caption and
1513 \"id\" attribute."
1514 (let ((html5-fancy (and (org-html-html5-p info)
1515 (plist-get info :html-html5-fancy))))
1516 (format (if html5-fancy "\n<figure%s>%s%s\n</figure>"
1517 "\n<div%s class=\"figure\">%s%s\n</div>")
1518 ;; ID.
1519 (if (org-string-nw-p label) (format " id=\"%s\"" label) "")
1520 ;; Contents.
1521 (format "\n<p>%s</p>" contents)
1522 ;; Caption.
1523 (if (not (org-string-nw-p caption)) ""
1524 (format (if html5-fancy "\n<figcaption>%s</figcaption>"
1525 "\n<p>%s</p>")
1526 caption)))))
1528 (defun org-html--format-image (source attributes info)
1529 "Return \"img\" tag with given SOURCE and ATTRIBUTES.
1530 SOURCE is a string specifying the location of the image.
1531 ATTRIBUTES is a plist, as returned by
1532 `org-export-read-attribute'. INFO is a plist used as
1533 a communication channel."
1534 (if (string= "svg" (file-name-extension source))
1535 (org-html--svg-image source attributes info)
1536 (org-html-close-tag
1537 "img"
1538 (org-html--make-attribute-string
1539 (org-combine-plists
1540 (list :src source
1541 :alt (if (string-match-p "^ltxpng/" source)
1542 (org-html-encode-plain-text
1543 (org-find-text-property-in-string 'org-latex-src source))
1544 (file-name-nondirectory source)))
1545 attributes))
1546 info)))
1548 (defun org-html--svg-image (source attributes info)
1549 "Return \"object\" appropriate for embedding svg file SOURCE
1550 with assoicated ATTRIBUTES. INFO is a plist used as a
1551 communication channel.
1553 The special attribute \"fallback\" can be used to specify a fallback
1554 image file to use if the object embedding is not supported."
1555 (let ((fallback (plist-get attributes :fallback))
1556 (attrs (org-html--make-attribute-string
1557 (plist-put attributes :fallback nil))))
1558 (format "<object type=\"image/svg+xml\" data=\"%s\" %s>\n%s</object>"
1559 source attrs
1560 (if fallback
1561 (org-html-close-tag
1562 "img" (format "src=\"%s\" %s" fallback attrs) info)
1563 "Sorry, your browser does not support SVG."))))
1565 (defun org-html--textarea-block (element)
1566 "Transcode ELEMENT into a textarea block.
1567 ELEMENT is either a src block or an example block."
1568 (let* ((code (car (org-export-unravel-code element)))
1569 (attr (org-export-read-attribute :attr_html element)))
1570 (format "<p>\n<textarea cols=\"%s\" rows=\"%s\">\n%s</textarea>\n</p>"
1571 (or (plist-get attr :width) 80)
1572 (or (plist-get attr :height) (org-count-lines code))
1573 code)))
1575 (defun org-html--has-caption-p (element &optional info)
1576 "Non-nil when ELEMENT has a caption affiliated keyword.
1577 INFO is a plist used as a communication channel. This function
1578 is meant to be used as a predicate for `org-export-get-ordinal' or
1579 a value to `org-html-standalone-image-predicate'."
1580 (org-element-property :caption element))
1582 ;;;; Table
1584 (defun org-html-htmlize-region-for-paste (beg end)
1585 "Convert the region between BEG and END to HTML, using htmlize.el.
1586 This is much like `htmlize-region-for-paste', only that it uses
1587 the settings define in the org-... variables."
1588 (let* ((htmlize-output-type org-html-htmlize-output-type)
1589 (htmlize-css-name-prefix org-html-htmlize-font-prefix)
1590 (htmlbuf (htmlize-region beg end)))
1591 (unwind-protect
1592 (with-current-buffer htmlbuf
1593 (buffer-substring (plist-get htmlize-buffer-places 'content-start)
1594 (plist-get htmlize-buffer-places 'content-end)))
1595 (kill-buffer htmlbuf))))
1597 ;;;###autoload
1598 (defun org-html-htmlize-generate-css ()
1599 "Create the CSS for all font definitions in the current Emacs session.
1600 Use this to create face definitions in your CSS style file that can then
1601 be used by code snippets transformed by htmlize.
1602 This command just produces a buffer that contains class definitions for all
1603 faces used in the current Emacs session. You can copy and paste the ones you
1604 need into your CSS file.
1606 If you then set `org-html-htmlize-output-type' to `css', calls
1607 to the function `org-html-htmlize-region-for-paste' will
1608 produce code that uses these same face definitions."
1609 (interactive)
1610 (require 'htmlize)
1611 (and (get-buffer "*html*") (kill-buffer "*html*"))
1612 (with-temp-buffer
1613 (let ((fl (face-list))
1614 (htmlize-css-name-prefix "org-")
1615 (htmlize-output-type 'css)
1616 f i)
1617 (while (setq f (pop fl)
1618 i (and f (face-attribute f :inherit)))
1619 (when (and (symbolp f) (or (not i) (not (listp i))))
1620 (insert (org-add-props (copy-sequence "1") nil 'face f))))
1621 (htmlize-region (point-min) (point-max))))
1622 (org-pop-to-buffer-same-window "*html*")
1623 (goto-char (point-min))
1624 (if (re-search-forward "<style" nil t)
1625 (delete-region (point-min) (match-beginning 0)))
1626 (if (re-search-forward "</style>" nil t)
1627 (delete-region (1+ (match-end 0)) (point-max)))
1628 (beginning-of-line 1)
1629 (if (looking-at " +") (replace-match ""))
1630 (goto-char (point-min)))
1632 (defun org-html--make-string (n string)
1633 "Build a string by concatenating N times STRING."
1634 (let (out) (dotimes (i n out) (setq out (concat string out)))))
1636 (defun org-html-fix-class-name (kwd) ; audit callers of this function
1637 "Turn todo keyword KWD into a valid class name.
1638 Replaces invalid characters with \"_\"."
1639 (save-match-data
1640 (while (string-match "[^a-zA-Z0-9_]" kwd)
1641 (setq kwd (replace-match "_" t t kwd))))
1642 kwd)
1644 (defun org-html-footnote-section (info)
1645 "Format the footnote section.
1646 INFO is a plist used as a communication channel."
1647 (let* ((fn-alist (org-export-collect-footnote-definitions info))
1648 (fn-alist
1649 (loop for (n type raw) in fn-alist collect
1650 (cons n (if (eq (org-element-type raw) 'org-data)
1651 (org-trim (org-export-data raw info))
1652 (format "<p class=\"footpara\">%s</p>"
1653 (org-trim (org-export-data raw info))))))))
1654 (when fn-alist
1655 (format
1656 (plist-get info :html-footnotes-section)
1657 (org-html--translate "Footnotes" info)
1658 (format
1659 "\n%s\n"
1660 (mapconcat
1661 (lambda (fn)
1662 (let ((n (car fn)) (def (cdr fn)))
1663 (format
1664 "<div class=\"footdef\">%s %s</div>\n"
1665 (format
1666 (plist-get info :html-footnote-format)
1667 (org-html--anchor
1668 (format "fn.%d" n)
1670 (format " class=\"footnum\" href=\"#fnr.%d\"" n)
1671 info))
1672 def)))
1673 fn-alist
1674 "\n"))))))
1677 ;;; Template
1679 (defun org-html--build-meta-info (info)
1680 "Return meta tags for exported document.
1681 INFO is a plist used as a communication channel."
1682 (let ((protect-string
1683 (lambda (str)
1684 (replace-regexp-in-string
1685 "\"" "&quot;" (org-html-encode-plain-text str))))
1686 (title (org-export-data (plist-get info :title) info))
1687 (author (and (plist-get info :with-author)
1688 (let ((auth (plist-get info :author)))
1689 (and auth
1690 ;; Return raw Org syntax, skipping non
1691 ;; exportable objects.
1692 (org-element-interpret-data
1693 (org-element-map auth
1694 (cons 'plain-text org-element-all-objects)
1695 'identity info))))))
1696 (description (plist-get info :description))
1697 (keywords (plist-get info :keywords))
1698 (charset (or (and org-html-coding-system
1699 (fboundp 'coding-system-get)
1700 (coding-system-get org-html-coding-system
1701 'mime-charset))
1702 "iso-8859-1")))
1703 (concat
1704 (when (plist-get info :time-stamp-file)
1705 (format-time-string
1706 (concat "<!-- "
1707 (plist-get info :html-metadata-timestamp-format)
1708 " -->\n")))
1709 (format
1710 (if (org-html-html5-p info)
1711 (org-html-close-tag "meta" " charset=\"%s\"" info)
1712 (org-html-close-tag
1713 "meta" " http-equiv=\"Content-Type\" content=\"text/html;charset=%s\""
1714 info))
1715 charset) "\n"
1716 (let ((viewport-options
1717 (org-remove-if-not (lambda (cell) (org-string-nw-p (cadr cell)))
1718 (plist-get info :html-viewport))))
1719 (and viewport-options
1720 (concat
1721 (org-html-close-tag
1722 "meta"
1723 (format " name=\"viewport\" content=\"%s\""
1724 (mapconcat
1725 (lambda (elm) (format "%s=%s" (car elm) (cadr elm)))
1726 viewport-options ", "))
1727 info)
1728 "\n")))
1729 (format "<title>%s</title>\n" title)
1730 (org-html-close-tag "meta" " name=\"generator\" content=\"Org-mode\"" info)
1731 "\n"
1732 (and (org-string-nw-p author)
1733 (concat
1734 (org-html-close-tag "meta"
1735 (format " name=\"author\" content=\"%s\""
1736 (funcall protect-string author))
1737 info)
1738 "\n"))
1739 (and (org-string-nw-p description)
1740 (concat
1741 (org-html-close-tag "meta"
1742 (format " name=\"description\" content=\"%s\"\n"
1743 (funcall protect-string description))
1744 info)
1745 "\n"))
1746 (and (org-string-nw-p keywords)
1747 (concat
1748 (org-html-close-tag "meta"
1749 (format " name=\"keywords\" content=\"%s\""
1750 (funcall protect-string keywords))
1751 info)
1752 "\n")))))
1754 (defun org-html--build-head (info)
1755 "Return information for the <head>..</head> of the HTML output.
1756 INFO is a plist used as a communication channel."
1757 (org-element-normalize-string
1758 (concat
1759 (when (plist-get info :html-head-include-default-style)
1760 (org-element-normalize-string org-html-style-default))
1761 (org-element-normalize-string (plist-get info :html-head))
1762 (org-element-normalize-string (plist-get info :html-head-extra))
1763 (when (and (plist-get info :html-htmlized-css-url)
1764 (eq org-html-htmlize-output-type 'css))
1765 (org-html-close-tag "link"
1766 (format " rel=\"stylesheet\" href=\"%s\" type=\"text/css\""
1767 (plist-get info :html-htmlized-css-url))
1768 info))
1769 (when (plist-get info :html-head-include-scripts) org-html-scripts))))
1771 (defun org-html--build-mathjax-config (info)
1772 "Insert the user setup into the mathjax template.
1773 INFO is a plist used as a communication channel."
1774 (when (and (memq (plist-get info :with-latex) '(mathjax t))
1775 (org-element-map (plist-get info :parse-tree)
1776 '(latex-fragment latex-environment) 'identity info t))
1777 (let ((template (plist-get info :html-mathjax-template))
1778 (options (plist-get info :html-mathjax-options))
1779 (in-buffer (or (plist-get info :html-mathjax) ""))
1780 name val x)
1781 (mapc
1782 (lambda (e)
1783 (setq name (car e) val (nth 1 e))
1784 (if (string-match (concat "\\<" (symbol-name name) ":") in-buffer)
1785 (setq val (car (read-from-string
1786 (substring in-buffer (match-end 0))))))
1787 (if (not (stringp val)) (setq val (format "%s" val)))
1788 (while (string-match (concat "%" (upcase (symbol-name name))) template)
1789 (setq template (replace-match val t t template))))
1790 options)
1791 ;; Return the modified template.
1792 (org-element-normalize-string template))))
1794 (defun org-html-format-spec (info)
1795 "Return format specification for elements that can be
1796 used in the preamble or postamble."
1797 `((?t . ,(org-export-data (plist-get info :title) info))
1798 (?s . ,(org-export-data (plist-get info :subtitle) info))
1799 (?d . ,(org-export-data (org-export-get-date info) info))
1800 (?T . ,(format-time-string
1801 (plist-get info :html-metadata-timestamp-format)))
1802 (?a . ,(org-export-data (plist-get info :author) info))
1803 (?e . ,(mapconcat
1804 (lambda (e)
1805 (format "<a href=\"mailto:%s\">%s</a>" e e))
1806 (split-string (plist-get info :email) ",+ *")
1807 ", "))
1808 (?c . ,(plist-get info :creator))
1809 (?C . ,(let ((file (plist-get info :input-file)))
1810 (format-time-string
1811 (plist-get info :html-metadata-timestamp-format)
1812 (if file (nth 5 (file-attributes file)) (current-time)))))
1813 (?v . ,(or (plist-get info :html-validation-link) ""))))
1815 (defun org-html--build-pre/postamble (type info)
1816 "Return document preamble or postamble as a string, or nil.
1817 TYPE is either 'preamble or 'postamble, INFO is a plist used as a
1818 communication channel."
1819 (let ((section (plist-get info (intern (format ":html-%s" type))))
1820 (spec (org-html-format-spec info)))
1821 (when section
1822 (let ((section-contents
1823 (if (functionp section) (funcall section info)
1824 (cond
1825 ((stringp section) (format-spec section spec))
1826 ((eq section 'auto)
1827 (let ((date (cdr (assq ?d spec)))
1828 (author (cdr (assq ?a spec)))
1829 (email (cdr (assq ?e spec)))
1830 (creator (cdr (assq ?c spec)))
1831 (timestamp (cdr (assq ?T spec)))
1832 (validation-link (cdr (assq ?v spec))))
1833 (concat
1834 (when (and (plist-get info :with-date)
1835 (org-string-nw-p date))
1836 (format "<p class=\"date\">%s: %s</p>\n"
1837 (org-html--translate "Date" info)
1838 date))
1839 (when (and (plist-get info :with-author)
1840 (org-string-nw-p author))
1841 (format "<p class=\"author\">%s: %s</p>\n"
1842 (org-html--translate "Author" info)
1843 author))
1844 (when (and (plist-get info :with-email)
1845 (org-string-nw-p email))
1846 (format "<p class=\"email\">%s: %s</p>\n"
1847 (org-html--translate "Email" info)
1848 email))
1849 (when (plist-get info :time-stamp-file)
1850 (format
1851 "<p class=\"date\">%s: %s</p>\n"
1852 (org-html--translate "Created" info)
1853 (format-time-string
1854 (plist-get info :html-metadata-timestamp-format))))
1855 (when (plist-get info :with-creator)
1856 (format "<p class=\"creator\">%s</p>\n" creator))
1857 (format "<p class=\"validation\">%s</p>\n"
1858 validation-link))))
1859 (t (format-spec
1860 (or (cadr (assoc
1861 (plist-get info :language)
1862 (eval (intern
1863 (format "org-html-%s-format" type)))))
1864 (cadr
1865 (assoc
1866 "en"
1867 (eval
1868 (intern (format "org-html-%s-format" type))))))
1869 spec))))))
1870 (let ((div (assq type (plist-get info :html-divs))))
1871 (when (org-string-nw-p section-contents)
1872 (concat
1873 (format "<%s id=\"%s\" class=\"%s\">\n"
1874 (nth 1 div)
1875 (nth 2 div)
1876 org-html--pre/postamble-class)
1877 (org-element-normalize-string section-contents)
1878 (format "</%s>\n" (nth 1 div)))))))))
1880 (defun org-html-inner-template (contents info)
1881 "Return body of document string after HTML conversion.
1882 CONTENTS is the transcoded contents string. INFO is a plist
1883 holding export options."
1884 (concat
1885 ;; Table of contents.
1886 (let ((depth (plist-get info :with-toc)))
1887 (when depth (org-html-toc depth info)))
1888 ;; Document contents.
1889 contents
1890 ;; Footnotes section.
1891 (org-html-footnote-section info)))
1893 (defun org-html-template (contents info)
1894 "Return complete document string after HTML conversion.
1895 CONTENTS is the transcoded contents string. INFO is a plist
1896 holding export options."
1897 (concat
1898 (when (and (not (org-html-html5-p info)) (org-html-xhtml-p info))
1899 (let* ((xml-declaration (plist-get info :html-xml-declaration))
1900 (decl (or (and (stringp xml-declaration) xml-declaration)
1901 (cdr (assoc (plist-get info :html-extension)
1902 xml-declaration))
1903 (cdr (assoc "html" xml-declaration))
1904 "")))
1905 (when (not (or (not decl) (string= "" decl)))
1906 (format "%s\n"
1907 (format decl
1908 (or (and org-html-coding-system
1909 (fboundp 'coding-system-get)
1910 (coding-system-get org-html-coding-system 'mime-charset))
1911 "iso-8859-1"))))))
1912 (org-html-doctype info)
1913 "\n"
1914 (concat "<html"
1915 (when (org-html-xhtml-p info)
1916 (format
1917 " xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"%s\" xml:lang=\"%s\""
1918 (plist-get info :language) (plist-get info :language)))
1919 ">\n")
1920 "<head>\n"
1921 (org-html--build-meta-info info)
1922 (org-html--build-head info)
1923 (org-html--build-mathjax-config info)
1924 "</head>\n"
1925 "<body>\n"
1926 (let ((link-up (org-trim (plist-get info :html-link-up)))
1927 (link-home (org-trim (plist-get info :html-link-home))))
1928 (unless (and (string= link-up "") (string= link-home ""))
1929 (format (plist-get info :html-home/up-format)
1930 (or link-up link-home)
1931 (or link-home link-up))))
1932 ;; Preamble.
1933 (org-html--build-pre/postamble 'preamble info)
1934 ;; Document contents.
1935 (let ((div (assq 'content (plist-get info :html-divs))))
1936 (format "<%s id=\"%s\">\n" (nth 1 div) (nth 2 div)))
1937 ;; Document title.
1938 (when (plist-get info :with-title)
1939 (let ((title (plist-get info :title))
1940 (subtitle (plist-get info :subtitle)))
1941 (when title
1942 (format
1943 (if (plist-get info :html-html5-fancy)
1944 "<header>\n<h1 class=\"title\">%s</h1>\n%s</header>"
1945 "<h1 class=\"title\">%s%s</h1>\n")
1946 (org-export-data title info)
1947 (if subtitle
1948 (format
1949 (if (plist-get info :html-html5-fancy)
1950 "<p class=\"subtitle\">%s</p>\n"
1951 "\n<br>\n<span class=\"subtitle\">%s</span>\n")
1952 (org-export-data subtitle info))
1953 "")))))
1954 contents
1955 (format "</%s>\n" (nth 1 (assq 'content (plist-get info :html-divs))))
1956 ;; Postamble.
1957 (org-html--build-pre/postamble 'postamble info)
1958 ;; Closing document.
1959 "</body>\n</html>"))
1961 (defun org-html--translate (s info)
1962 "Translate string S according to specified language.
1963 INFO is a plist used as a communication channel."
1964 (org-export-translate s :html info))
1966 ;;;; Anchor
1968 (defun org-html--anchor (id desc attributes info)
1969 "Format a HTML anchor."
1970 (let* ((name (and (plist-get info :html-allow-name-attribute-in-anchors) id))
1971 (attributes (concat (and id (format " id=\"%s\"" id))
1972 (and name (format " name=\"%s\"" name))
1973 attributes)))
1974 (format "<a%s>%s</a>" attributes (or desc ""))))
1976 ;;;; Todo
1978 (defun org-html--todo (todo info)
1979 "Format TODO keywords into HTML."
1980 (when todo
1981 (format "<span class=\"%s %s%s\">%s</span>"
1982 (if (member todo org-done-keywords) "done" "todo")
1983 (plist-get info :html-todo-kwd-class-prefix)
1984 (org-html-fix-class-name todo)
1985 todo)))
1987 ;;;; Priority
1989 (defun org-html--priority (priority info)
1990 "Format a priority into HTML.
1991 PRIORITY is the character code of the priority or nil. INFO is
1992 a plist containing export options."
1993 (and priority (format "<span class=\"priority\">[%c]</span>" priority)))
1995 ;;;; Tags
1997 (defun org-html--tags (tags info)
1998 "Format TAGS into HTML.
1999 INFO is a plist containing export options."
2000 (when tags
2001 (format "<span class=\"tag\">%s</span>"
2002 (mapconcat
2003 (lambda (tag)
2004 (format "<span class=\"%s\">%s</span>"
2005 (concat (plist-get info :html-tag-class-prefix)
2006 (org-html-fix-class-name tag))
2007 tag))
2008 tags "&#xa0;"))))
2010 ;;;; Src Code
2012 (defun org-html-fontify-code (code lang)
2013 "Color CODE with htmlize library.
2014 CODE is a string representing the source code to colorize. LANG
2015 is the language used for CODE, as a string, or nil."
2016 (when code
2017 (cond
2018 ;; Case 1: No lang. Possibly an example block.
2019 ((not lang)
2020 ;; Simple transcoding.
2021 (org-html-encode-plain-text code))
2022 ;; Case 2: No htmlize or an inferior version of htmlize
2023 ((not (and (require 'htmlize nil t) (fboundp 'htmlize-region-for-paste)))
2024 ;; Emit a warning.
2025 (message "Cannot fontify src block (htmlize.el >= 1.34 required)")
2026 ;; Simple transcoding.
2027 (org-html-encode-plain-text code))
2028 ;; Case 3: plain text explicitly set
2029 ((not org-html-htmlize-output-type)
2030 ;; Simple transcoding.
2031 (org-html-encode-plain-text code))
2033 ;; Map language
2034 (setq lang (or (assoc-default lang org-src-lang-modes) lang))
2035 (let* ((lang-mode (and lang (intern (format "%s-mode" lang)))))
2036 (cond
2037 ;; Case 1: Language is not associated with any Emacs mode
2038 ((not (functionp lang-mode))
2039 ;; Simple transcoding.
2040 (org-html-encode-plain-text code))
2041 ;; Case 2: Default. Fontify code.
2043 ;; htmlize
2044 (setq code (with-temp-buffer
2045 ;; Switch to language-specific mode.
2046 (funcall lang-mode)
2047 (insert code)
2048 ;; Fontify buffer.
2049 (font-lock-ensure)
2050 ;; Remove formatting on newline characters.
2051 (save-excursion
2052 (let ((beg (point-min))
2053 (end (point-max)))
2054 (goto-char beg)
2055 (while (progn (end-of-line) (< (point) end))
2056 (put-text-property (point) (1+ (point)) 'face nil)
2057 (forward-char 1))))
2058 (org-src-mode)
2059 (set-buffer-modified-p nil)
2060 ;; Htmlize region.
2061 (org-html-htmlize-region-for-paste
2062 (point-min) (point-max))))
2063 ;; Strip any enclosing <pre></pre> tags.
2064 (let* ((beg (and (string-match "\\`<pre[^>]*>\n*" code) (match-end 0)))
2065 (end (and beg (string-match "</pre>\\'" code))))
2066 (if (and beg end) (substring code beg end) code)))))))))
2068 (defun org-html-do-format-code
2069 (code &optional lang refs retain-labels num-start)
2070 "Format CODE string as source code.
2071 Optional arguments LANG, REFS, RETAIN-LABELS and NUM-START are,
2072 respectively, the language of the source code, as a string, an
2073 alist between line numbers and references (as returned by
2074 `org-export-unravel-code'), a boolean specifying if labels should
2075 appear in the source code, and the number associated to the first
2076 line of code."
2077 (let* ((code-lines (org-split-string code "\n"))
2078 (code-length (length code-lines))
2079 (num-fmt
2080 (and num-start
2081 (format "%%%ds: "
2082 (length (number-to-string (+ code-length num-start))))))
2083 (code (org-html-fontify-code code lang)))
2084 (org-export-format-code
2085 code
2086 (lambda (loc line-num ref)
2087 (setq loc
2088 (concat
2089 ;; Add line number, if needed.
2090 (when num-start
2091 (format "<span class=\"linenr\">%s</span>"
2092 (format num-fmt line-num)))
2093 ;; Transcoded src line.
2095 ;; Add label, if needed.
2096 (when (and ref retain-labels) (format " (%s)" ref))))
2097 ;; Mark transcoded line as an anchor, if needed.
2098 (if (not ref) loc
2099 (format "<span id=\"coderef-%s\" class=\"coderef-off\">%s</span>"
2100 ref loc)))
2101 num-start refs)))
2103 (defun org-html-format-code (element info)
2104 "Format contents of ELEMENT as source code.
2105 ELEMENT is either an example block or a src block. INFO is
2106 a plist used as a communication channel."
2107 (let* ((lang (org-element-property :language element))
2108 ;; Extract code and references.
2109 (code-info (org-export-unravel-code element))
2110 (code (car code-info))
2111 (refs (cdr code-info))
2112 ;; Does the src block contain labels?
2113 (retain-labels (org-element-property :retain-labels element))
2114 ;; Does it have line numbers?
2115 (num-start (case (org-element-property :number-lines element)
2116 (continued (org-export-get-loc element info))
2117 (new 0))))
2118 (org-html-do-format-code code lang refs retain-labels num-start)))
2121 ;;; Tables of Contents
2123 (defun org-html-toc (depth info &optional scope)
2124 "Build a table of contents.
2125 DEPTH is an integer specifying the depth of the table. INFO is
2126 a plist used as a communication channel. Optional argument SCOPE
2127 is an element defining the scope of the table. Return the table
2128 of contents as a string, or nil if it is empty."
2129 (let ((toc-entries
2130 (mapcar (lambda (headline)
2131 (cons (org-html--format-toc-headline headline info)
2132 (org-export-get-relative-level headline info)))
2133 (org-export-collect-headlines info depth scope))))
2134 (when toc-entries
2135 (let ((toc (concat "<div id=\"text-table-of-contents\">"
2136 (org-html--toc-text toc-entries)
2137 "</div>\n")))
2138 (if scope toc
2139 (let ((outer-tag (if (and (org-html-html5-p info)
2140 (plist-get info :html-html5-fancy))
2141 "nav"
2142 "div")))
2143 (concat (format "<%s id=\"table-of-contents\">\n" outer-tag)
2144 (let ((top-level (plist-get info :html-toplevel-hlevel)))
2145 (format "<h%d>%s</h%d>\n"
2146 top-level
2147 (org-html--translate "Table of Contents" info)
2148 top-level))
2150 (format "</%s>\n" outer-tag))))))))
2152 (defun org-html--toc-text (toc-entries)
2153 "Return innards of a table of contents, as a string.
2154 TOC-ENTRIES is an alist where key is an entry title, as a string,
2155 and value is its relative level, as an integer."
2156 (let* ((prev-level (1- (cdar toc-entries)))
2157 (start-level prev-level))
2158 (concat
2159 (mapconcat
2160 (lambda (entry)
2161 (let ((headline (car entry))
2162 (level (cdr entry)))
2163 (concat
2164 (let* ((cnt (- level prev-level))
2165 (times (if (> cnt 0) (1- cnt) (- cnt)))
2166 rtn)
2167 (setq prev-level level)
2168 (concat
2169 (org-html--make-string
2170 times (cond ((> cnt 0) "\n<ul>\n<li>")
2171 ((< cnt 0) "</li>\n</ul>\n")))
2172 (if (> cnt 0) "\n<ul>\n<li>" "</li>\n<li>")))
2173 headline)))
2174 toc-entries "")
2175 (org-html--make-string (- prev-level start-level) "</li>\n</ul>\n"))))
2177 (defun org-html--format-toc-headline (headline info)
2178 "Return an appropriate table of contents entry for HEADLINE.
2179 INFO is a plist used as a communication channel."
2180 (let* ((headline-number (org-export-get-headline-number headline info))
2181 (todo (and (plist-get info :with-todo-keywords)
2182 (let ((todo (org-element-property :todo-keyword headline)))
2183 (and todo (org-export-data todo info)))))
2184 (todo-type (and todo (org-element-property :todo-type headline)))
2185 (priority (and (plist-get info :with-priority)
2186 (org-element-property :priority headline)))
2187 (text (org-export-data-with-backend
2188 (org-export-get-alt-title headline info)
2189 ;; Create an anonymous back-end that will ignore any
2190 ;; footnote-reference, link, radio-target and target
2191 ;; in table of contents.
2192 (org-export-create-backend
2193 :parent 'html
2194 :transcoders '((footnote-reference . ignore)
2195 (link . (lambda (object c i) c))
2196 (radio-target . (lambda (object c i) c))
2197 (target . ignore)))
2198 info))
2199 (tags (and (eq (plist-get info :with-tags) t)
2200 (org-export-get-tags headline info))))
2201 (format "<a href=\"#%s\">%s</a>"
2202 ;; Label.
2203 (org-export-get-reference headline info)
2204 ;; Body.
2205 (concat
2206 (and (not (org-export-low-level-p headline info))
2207 (org-export-numbered-headline-p headline info)
2208 (concat (mapconcat #'number-to-string headline-number ".")
2209 ". "))
2210 (apply (plist-get info :html-format-headline-function)
2211 todo todo-type priority text tags :section-number nil)))))
2213 (defun org-html-list-of-listings (info)
2214 "Build a list of listings.
2215 INFO is a plist used as a communication channel. Return the list
2216 of listings as a string, or nil if it is empty."
2217 (let ((lol-entries (org-export-collect-listings info)))
2218 (when lol-entries
2219 (concat "<div id=\"list-of-listings\">\n"
2220 (let ((top-level (plist-get info :html-toplevel-hlevel)))
2221 (format "<h%d>%s</h%d>\n"
2222 top-level
2223 (org-html--translate "List of Listings" info)
2224 top-level))
2225 "<div id=\"text-list-of-listings\">\n<ul>\n"
2226 (let ((count 0)
2227 (initial-fmt (format "<span class=\"listing-number\">%s</span>"
2228 (org-html--translate "Listing %d:" info))))
2229 (mapconcat
2230 (lambda (entry)
2231 (let ((label (and (org-element-property :name entry)
2232 (org-export-get-reference entry info)))
2233 (title (org-trim
2234 (org-export-data
2235 (or (org-export-get-caption entry t)
2236 (org-export-get-caption entry))
2237 info))))
2238 (concat
2239 "<li>"
2240 (if (not label)
2241 (concat (format initial-fmt (incf count)) " " title)
2242 (format "<a href=\"#%s\">%s %s</a>"
2243 label
2244 (format initial-fmt (incf count))
2245 title))
2246 "</li>")))
2247 lol-entries "\n"))
2248 "\n</ul>\n</div>\n</div>"))))
2250 (defun org-html-list-of-tables (info)
2251 "Build a list of tables.
2252 INFO is a plist used as a communication channel. Return the list
2253 of tables as a string, or nil if it is empty."
2254 (let ((lol-entries (org-export-collect-tables info)))
2255 (when lol-entries
2256 (concat "<div id=\"list-of-tables\">\n"
2257 (let ((top-level (plist-get info :html-toplevel-hlevel)))
2258 (format "<h%d>%s</h%d>\n"
2259 top-level
2260 (org-html--translate "List of Tables" info)
2261 top-level))
2262 "<div id=\"text-list-of-tables\">\n<ul>\n"
2263 (let ((count 0)
2264 (initial-fmt (format "<span class=\"table-number\">%s</span>"
2265 (org-html--translate "Table %d:" info))))
2266 (mapconcat
2267 (lambda (entry)
2268 (let ((label (and (org-element-property :name entry)
2269 (org-export-get-reference entry info)))
2270 (title (org-trim
2271 (org-export-data
2272 (or (org-export-get-caption entry t)
2273 (org-export-get-caption entry))
2274 info))))
2275 (concat
2276 "<li>"
2277 (if (not label)
2278 (concat (format initial-fmt (incf count)) " " title)
2279 (format "<a href=\"#%s\">%s %s</a>"
2280 label
2281 (format initial-fmt (incf count))
2282 title))
2283 "</li>")))
2284 lol-entries "\n"))
2285 "\n</ul>\n</div>\n</div>"))))
2288 ;;; Transcode Functions
2290 ;;;; Bold
2292 (defun org-html-bold (bold contents info)
2293 "Transcode BOLD from Org to HTML.
2294 CONTENTS is the text with bold markup. INFO is a plist holding
2295 contextual information."
2296 (format (or (cdr (assq 'bold (plist-get info :html-text-markup-alist))) "%s")
2297 contents))
2299 ;;;; Center Block
2301 (defun org-html-center-block (center-block contents info)
2302 "Transcode a CENTER-BLOCK element from Org to HTML.
2303 CONTENTS holds the contents of the block. INFO is a plist
2304 holding contextual information."
2305 (format "<div class=\"center\">\n%s</div>" contents))
2307 ;;;; Clock
2309 (defun org-html-clock (clock contents info)
2310 "Transcode a CLOCK element from Org to HTML.
2311 CONTENTS is nil. INFO is a plist used as a communication
2312 channel."
2313 (format "<p>
2314 <span class=\"timestamp-wrapper\">
2315 <span class=\"timestamp-kwd\">%s</span> <span class=\"timestamp\">%s</span>%s
2316 </span>
2317 </p>"
2318 org-clock-string
2319 (org-timestamp-translate (org-element-property :value clock))
2320 (let ((time (org-element-property :duration clock)))
2321 (and time (format " <span class=\"timestamp\">(%s)</span>" time)))))
2323 ;;;; Code
2325 (defun org-html-code (code contents info)
2326 "Transcode CODE from Org to HTML.
2327 CONTENTS is nil. INFO is a plist holding contextual
2328 information."
2329 (format (or (cdr (assq 'code (plist-get info :html-text-markup-alist))) "%s")
2330 (org-html-encode-plain-text (org-element-property :value code))))
2332 ;;;; Drawer
2334 (defun org-html-drawer (drawer contents info)
2335 "Transcode a DRAWER element from Org to HTML.
2336 CONTENTS holds the contents of the block. INFO is a plist
2337 holding contextual information."
2338 (funcall (plist-get info :html-format-drawer-function)
2339 (org-element-property :drawer-name drawer)
2340 contents))
2342 ;;;; Dynamic Block
2344 (defun org-html-dynamic-block (dynamic-block contents info)
2345 "Transcode a DYNAMIC-BLOCK element from Org to HTML.
2346 CONTENTS holds the contents of the block. INFO is a plist
2347 holding contextual information. See `org-export-data'."
2348 contents)
2350 ;;;; Entity
2352 (defun org-html-entity (entity contents info)
2353 "Transcode an ENTITY object from Org to HTML.
2354 CONTENTS are the definition itself. INFO is a plist holding
2355 contextual information."
2356 (org-element-property :html entity))
2358 ;;;; Example Block
2360 (defun org-html-example-block (example-block contents info)
2361 "Transcode a EXAMPLE-BLOCK element from Org to HTML.
2362 CONTENTS is nil. INFO is a plist holding contextual
2363 information."
2364 (if (org-export-read-attribute :attr_html example-block :textarea)
2365 (org-html--textarea-block example-block)
2366 (format "<pre class=\"example\">\n%s</pre>"
2367 (org-html-format-code example-block info))))
2369 ;;;; Export Snippet
2371 (defun org-html-export-snippet (export-snippet contents info)
2372 "Transcode a EXPORT-SNIPPET object from Org to HTML.
2373 CONTENTS is nil. INFO is a plist holding contextual
2374 information."
2375 (when (eq (org-export-snippet-backend export-snippet) 'html)
2376 (org-element-property :value export-snippet)))
2378 ;;;; Export Block
2380 (defun org-html-export-block (export-block contents info)
2381 "Transcode a EXPORT-BLOCK element from Org to HTML.
2382 CONTENTS is nil. INFO is a plist holding contextual information."
2383 (when (string= (org-element-property :type export-block) "HTML")
2384 (org-remove-indentation (org-element-property :value export-block))))
2386 ;;;; Fixed Width
2388 (defun org-html-fixed-width (fixed-width contents info)
2389 "Transcode a FIXED-WIDTH element from Org to HTML.
2390 CONTENTS is nil. INFO is a plist holding contextual information."
2391 (format "<pre class=\"example\">\n%s</pre>"
2392 (org-html-do-format-code
2393 (org-remove-indentation
2394 (org-element-property :value fixed-width)))))
2396 ;;;; Footnote Reference
2398 (defun org-html-footnote-reference (footnote-reference contents info)
2399 "Transcode a FOOTNOTE-REFERENCE element from Org to HTML.
2400 CONTENTS is nil. INFO is a plist holding contextual information."
2401 (concat
2402 ;; Insert separator between two footnotes in a row.
2403 (let ((prev (org-export-get-previous-element footnote-reference info)))
2404 (when (eq (org-element-type prev) 'footnote-reference)
2405 (plist-get info :html-footnote-separator)))
2406 (let* ((n (org-export-get-footnote-number footnote-reference info))
2407 (id (format "fnr.%d%s"
2409 (if (org-export-footnote-first-reference-p
2410 footnote-reference info)
2412 ".100"))))
2413 (format
2414 (plist-get info :html-footnote-format)
2415 (org-html--anchor
2416 id n (format " class=\"footref\" href=\"#fn.%d\"" n) info)))))
2418 ;;;; Headline
2420 (defun org-html-headline (headline contents info)
2421 "Transcode a HEADLINE element from Org to HTML.
2422 CONTENTS holds the contents of the headline. INFO is a plist
2423 holding contextual information."
2424 (unless (org-element-property :footnote-section-p headline)
2425 (let* ((numberedp (org-export-numbered-headline-p headline info))
2426 (numbers (org-export-get-headline-number headline info))
2427 (section-number (and numbers
2428 (mapconcat #'number-to-string numbers "-")))
2429 (level (+ (org-export-get-relative-level headline info)
2430 (1- (plist-get info :html-toplevel-hlevel))))
2431 (todo (and (plist-get info :with-todo-keywords)
2432 (let ((todo (org-element-property :todo-keyword headline)))
2433 (and todo (org-export-data todo info)))))
2434 (todo-type (and todo (org-element-property :todo-type headline)))
2435 (priority (and (plist-get info :with-priority)
2436 (org-element-property :priority headline)))
2437 (text (org-export-data (org-element-property :title headline) info))
2438 (tags (and (plist-get info :with-tags)
2439 (org-export-get-tags headline info)))
2440 (full-text (funcall (plist-get info :html-format-headline-function)
2441 todo todo-type priority text tags info))
2442 (contents (or contents ""))
2443 (ids (delq nil
2444 (list (org-element-property :CUSTOM_ID headline)
2445 (org-export-get-reference headline info)
2446 (org-element-property :ID headline))))
2447 (preferred-id (car ids))
2448 (extra-ids
2449 (mapconcat
2450 (lambda (id)
2451 (org-html--anchor
2452 (if (org-uuidgen-p id) (concat "ID-" id) id)
2453 nil nil info))
2454 (cdr ids) "")))
2455 (if (org-export-low-level-p headline info)
2456 ;; This is a deep sub-tree: export it as a list item.
2457 (let* ((type (if numberedp 'ordered 'unordered))
2458 (itemized-body
2459 (org-html-format-list-item
2460 contents type nil info nil
2461 (concat (org-html--anchor preferred-id nil nil info)
2462 extra-ids
2463 full-text))))
2464 (concat (and (org-export-first-sibling-p headline info)
2465 (org-html-begin-plain-list type))
2466 itemized-body
2467 (and (org-export-last-sibling-p headline info)
2468 (org-html-end-plain-list type))))
2469 (let ((extra-class (org-element-property :HTML_CONTAINER_CLASS headline))
2470 (first-content (car (org-element-contents headline))))
2471 ;; Standard headline. Export it as a section.
2472 (format "<%s id=\"%s\" class=\"%s\">%s%s</%s>\n"
2473 (org-html--container headline info)
2474 (concat "outline-container-"
2475 (org-export-get-reference headline info))
2476 (concat (format "outline-%d" level)
2477 (and extra-class " ")
2478 extra-class)
2479 (format "\n<h%d id=\"%s\">%s%s</h%d>\n"
2480 level
2481 preferred-id
2482 extra-ids
2483 (concat
2484 (and numberedp
2485 (format
2486 "<span class=\"section-number-%d\">%s</span> "
2487 level
2488 (mapconcat #'number-to-string numbers ".")))
2489 full-text)
2490 level)
2491 ;; When there is no section, pretend there is an
2492 ;; empty one to get the correct <div
2493 ;; class="outline-...> which is needed by
2494 ;; `org-info.js'.
2495 (if (eq (org-element-type first-content) 'section) contents
2496 (concat (org-html-section first-content "" info) contents))
2497 (org-html--container headline info)))))))
2499 (defun org-html-format-headline-default-function
2500 (todo todo-type priority text tags info)
2501 "Default format function for a headline.
2502 See `org-html-format-headline-function' for details."
2503 (let ((todo (org-html--todo todo info))
2504 (priority (org-html--priority priority info))
2505 (tags (org-html--tags tags info)))
2506 (concat todo (and todo " ")
2507 priority (and priority " ")
2508 text
2509 (and tags "&#xa0;&#xa0;&#xa0;") tags)))
2511 (defun org-html--container (headline info)
2512 (or (org-element-property :HTML_CONTAINER headline)
2513 (if (= 1 (org-export-get-relative-level headline info))
2514 (plist-get info :html-container)
2515 "div")))
2517 ;;;; Horizontal Rule
2519 (defun org-html-horizontal-rule (horizontal-rule contents info)
2520 "Transcode an HORIZONTAL-RULE object from Org to HTML.
2521 CONTENTS is nil. INFO is a plist holding contextual information."
2522 (org-html-close-tag "hr" nil info))
2524 ;;;; Inline Src Block
2526 (defun org-html-inline-src-block (inline-src-block contents info)
2527 "Transcode an INLINE-SRC-BLOCK element from Org to HTML.
2528 CONTENTS holds the contents of the item. INFO is a plist holding
2529 contextual information."
2530 (let ((lang (org-element-property :language inline-src-block))
2531 (code (org-html-format-code inline-src-block info))
2532 (label
2533 (let ((lbl (and (org-element-property :name inline-src-block)
2534 (org-export-get-reference inline-src-block info))))
2535 (if (not lbl) "" (format " id=\"%s\"" lbl)))))
2536 (format "<code class=\"src src-%s\"%s>%s</code>" lang label code)))
2538 ;;;; Inlinetask
2540 (defun org-html-inlinetask (inlinetask contents info)
2541 "Transcode an INLINETASK element from Org to HTML.
2542 CONTENTS holds the contents of the block. INFO is a plist
2543 holding contextual information."
2544 (let* ((todo (and (plist-get info :with-todo-keywords)
2545 (let ((todo (org-element-property :todo-keyword inlinetask)))
2546 (and todo (org-export-data todo info)))))
2547 (todo-type (and todo (org-element-property :todo-type inlinetask)))
2548 (priority (and (plist-get info :with-priority)
2549 (org-element-property :priority inlinetask)))
2550 (text (org-export-data (org-element-property :title inlinetask) info))
2551 (tags (and (plist-get info :with-tags)
2552 (org-export-get-tags inlinetask info))))
2553 (funcall (plist-get info :html-format-inlinetask-function)
2554 todo todo-type priority text tags contents info)))
2556 (defun org-html-format-inlinetask-default-function
2557 (todo todo-type priority text tags contents info)
2558 "Default format function for a inlinetasks.
2559 See `org-html-format-inlinetask-function' for details."
2560 (format "<div class=\"inlinetask\">\n<b>%s</b>%s\n%s</div>"
2561 (org-html-format-headline-default-function
2562 todo todo-type priority text tags info)
2563 (org-html-close-tag "br" nil info)
2564 contents))
2566 ;;;; Italic
2568 (defun org-html-italic (italic contents info)
2569 "Transcode ITALIC from Org to HTML.
2570 CONTENTS is the text with italic markup. INFO is a plist holding
2571 contextual information."
2572 (format
2573 (or (cdr (assq 'italic (plist-get info :html-text-markup-alist))) "%s")
2574 contents))
2576 ;;;; Item
2578 (defun org-html-checkbox (checkbox info)
2579 "Format CHECKBOX into HTML.
2580 INFO is a plist holding contextual information. See
2581 `org-html-checkbox-type' for customization options."
2582 (cdr (assq checkbox
2583 (cdr (assq (plist-get info :html-checkbox-type)
2584 org-html-checkbox-types)))))
2586 (defun org-html-format-list-item (contents type checkbox info
2587 &optional term-counter-id
2588 headline)
2589 "Format a list item into HTML."
2590 (let ((class (if checkbox
2591 (format " class=\"%s\""
2592 (symbol-name checkbox)) ""))
2593 (checkbox (concat (org-html-checkbox checkbox info)
2594 (and checkbox " ")))
2595 (br (org-html-close-tag "br" nil info)))
2596 (concat
2597 (case type
2598 (ordered
2599 (let* ((counter term-counter-id)
2600 (extra (if counter (format " value=\"%s\"" counter) "")))
2601 (concat
2602 (format "<li%s%s>" class extra)
2603 (when headline (concat headline br)))))
2604 (unordered
2605 (let* ((id term-counter-id)
2606 (extra (if id (format " id=\"%s\"" id) "")))
2607 (concat
2608 (format "<li%s%s>" class extra)
2609 (when headline (concat headline br)))))
2610 (descriptive
2611 (let* ((term term-counter-id))
2612 (setq term (or term "(no term)"))
2613 ;; Check-boxes in descriptive lists are associated to tag.
2614 (concat (format "<dt%s>%s</dt>"
2615 class (concat checkbox term))
2616 "<dd>"))))
2617 (unless (eq type 'descriptive) checkbox)
2618 (and contents (org-trim contents))
2619 (case type
2620 (ordered "</li>")
2621 (unordered "</li>")
2622 (descriptive "</dd>")))))
2624 (defun org-html-item (item contents info)
2625 "Transcode an ITEM element from Org to HTML.
2626 CONTENTS holds the contents of the item. INFO is a plist holding
2627 contextual information."
2628 (let* ((plain-list (org-export-get-parent item))
2629 (type (org-element-property :type plain-list))
2630 (counter (org-element-property :counter item))
2631 (checkbox (org-element-property :checkbox item))
2632 (tag (let ((tag (org-element-property :tag item)))
2633 (and tag (org-export-data tag info)))))
2634 (org-html-format-list-item
2635 contents type checkbox info (or tag counter))))
2637 ;;;; Keyword
2639 (defun org-html-keyword (keyword contents info)
2640 "Transcode a KEYWORD element from Org to HTML.
2641 CONTENTS is nil. INFO is a plist holding contextual information."
2642 (let ((key (org-element-property :key keyword))
2643 (value (org-element-property :value keyword)))
2644 (cond
2645 ((string= key "HTML") value)
2646 ((string= key "TOC")
2647 (let ((case-fold-search t))
2648 (cond
2649 ((string-match "\\<headlines\\>" value)
2650 (let ((depth (and (string-match "\\<[0-9]+\\>" value)
2651 (string-to-number (match-string 0 value))))
2652 (localp (org-string-match-p "\\<local\\>" value)))
2653 (org-html-toc depth info (and localp keyword))))
2654 ((string= "listings" value) (org-html-list-of-listings info))
2655 ((string= "tables" value) (org-html-list-of-tables info))))))))
2657 ;;;; Latex Environment
2659 (defun org-html-format-latex (latex-frag processing-type info)
2660 "Format a LaTeX fragment LATEX-FRAG into HTML.
2661 PROCESSING-TYPE designates the tool used for conversion. It is
2662 a symbol among `mathjax', `dvipng', `imagemagick', `verbatim' nil
2663 and t. See `org-html-with-latex' for more information. INFO is
2664 a plist containing export properties."
2665 (let ((cache-relpath "") (cache-dir ""))
2666 (unless (eq processing-type 'mathjax)
2667 (let ((bfn (or (buffer-file-name)
2668 (make-temp-name
2669 (expand-file-name "latex" temporary-file-directory))))
2670 (latex-header
2671 (let ((header (plist-get info :latex-header)))
2672 (and header
2673 (concat (mapconcat
2674 (lambda (line) (concat "#+LATEX_HEADER: " line))
2675 (org-split-string header "\n")
2676 "\n")
2677 "\n")))))
2678 (setq cache-relpath
2679 (concat "ltxpng/"
2680 (file-name-sans-extension
2681 (file-name-nondirectory bfn)))
2682 cache-dir (file-name-directory bfn))
2683 ;; Re-create LaTeX environment from original buffer in
2684 ;; temporary buffer so that dvipng/imagemagick can properly
2685 ;; turn the fragment into an image.
2686 (setq latex-frag (concat latex-header latex-frag))))
2687 (with-temp-buffer
2688 (insert latex-frag)
2689 (org-format-latex cache-relpath cache-dir nil "Creating LaTeX Image..."
2690 nil processing-type)
2691 (buffer-string))))
2693 (defun org-html-latex-environment (latex-environment contents info)
2694 "Transcode a LATEX-ENVIRONMENT element from Org to HTML.
2695 CONTENTS is nil. INFO is a plist holding contextual information."
2696 (let ((processing-type (plist-get info :with-latex))
2697 (latex-frag (org-remove-indentation
2698 (org-element-property :value latex-environment)))
2699 (attributes (org-export-read-attribute :attr_html latex-environment)))
2700 (case processing-type
2701 ((t mathjax)
2702 (org-html-format-latex latex-frag 'mathjax info))
2703 ((dvipng imagemagick)
2704 (let ((formula-link
2705 (org-html-format-latex latex-frag processing-type info)))
2706 (when (and formula-link (string-match "file:\\([^]]*\\)" formula-link))
2707 ;; Do not provide a caption or a name to be consistent with
2708 ;; `mathjax' handling.
2709 (org-html--wrap-image
2710 (org-html--format-image
2711 (match-string 1 formula-link) attributes info) info))))
2712 (t latex-frag))))
2714 ;;;; Latex Fragment
2716 (defun org-html-latex-fragment (latex-fragment contents info)
2717 "Transcode a LATEX-FRAGMENT object from Org to HTML.
2718 CONTENTS is nil. INFO is a plist holding contextual information."
2719 (let ((latex-frag (org-element-property :value latex-fragment))
2720 (processing-type (plist-get info :with-latex)))
2721 (case processing-type
2722 ((t mathjax)
2723 (org-html-format-latex latex-frag 'mathjax info))
2724 ((dvipng imagemagick)
2725 (let ((formula-link
2726 (org-html-format-latex latex-frag processing-type info)))
2727 (when (and formula-link (string-match "file:\\([^]]*\\)" formula-link))
2728 (org-html--format-image (match-string 1 formula-link) nil info))))
2729 (t latex-frag))))
2731 ;;;; Line Break
2733 (defun org-html-line-break (line-break contents info)
2734 "Transcode a LINE-BREAK object from Org to HTML.
2735 CONTENTS is nil. INFO is a plist holding contextual information."
2736 (concat (org-html-close-tag "br" nil info) "\n"))
2738 ;;;; Link
2740 (defun org-html-inline-image-p (link info)
2741 "Non-nil when LINK is meant to appear as an image.
2742 INFO is a plist used as a communication channel. LINK is an
2743 inline image when it has no description and targets an image
2744 file (see `org-html-inline-image-rules' for more information), or
2745 if its description is a single link targeting an image file."
2746 (if (not (org-element-contents link))
2747 (org-export-inline-image-p
2748 link (plist-get info :html-inline-image-rules))
2749 (not
2750 (let ((link-count 0))
2751 (org-element-map (org-element-contents link)
2752 (cons 'plain-text org-element-all-objects)
2753 (lambda (obj)
2754 (case (org-element-type obj)
2755 (plain-text (org-string-nw-p obj))
2756 (link (if (= link-count 1) t
2757 (incf link-count)
2758 (not (org-export-inline-image-p
2759 obj (plist-get info :html-inline-image-rules)))))
2760 (otherwise t)))
2761 info t)))))
2763 (defvar org-html-standalone-image-predicate)
2764 (defun org-html-standalone-image-p (element info)
2765 "Non-nil if ELEMENT is a standalone image.
2767 INFO is a plist holding contextual information.
2769 An element or object is a standalone image when
2771 - its type is `paragraph' and its sole content, save for white
2772 spaces, is a link that qualifies as an inline image;
2774 - its type is `link' and its containing paragraph has no other
2775 content save white spaces.
2777 Bind `org-html-standalone-image-predicate' to constrain paragraph
2778 further. For example, to check for only captioned standalone
2779 images, set it to:
2781 \(lambda (paragraph) (org-element-property :caption paragraph))"
2782 (let ((paragraph (case (org-element-type element)
2783 (paragraph element)
2784 (link (org-export-get-parent element)))))
2785 (and (eq (org-element-type paragraph) 'paragraph)
2786 (or (not (fboundp 'org-html-standalone-image-predicate))
2787 (funcall org-html-standalone-image-predicate paragraph))
2788 (catch 'exit
2789 (let ((link-count 0))
2790 (org-element-map (org-element-contents paragraph)
2791 (cons 'plain-text org-element-all-objects)
2792 #'(lambda (obj)
2793 (when (case (org-element-type obj)
2794 (plain-text (org-string-nw-p obj))
2795 (link (or (> (incf link-count) 1)
2796 (not (org-html-inline-image-p obj info))))
2797 (otherwise t))
2798 (throw 'exit nil)))
2799 info nil 'link)
2800 (= link-count 1))))))
2802 (defun org-html-link (link desc info)
2803 "Transcode a LINK object from Org to HTML.
2804 DESC is the description part of the link, or the empty string.
2805 INFO is a plist holding contextual information. See
2806 `org-export-data'."
2807 (let* ((home (when (plist-get info :html-link-home)
2808 (org-trim (plist-get info :html-link-home))))
2809 (use-abs-url (plist-get info :html-link-use-abs-url))
2810 (link-org-files-as-html-maybe
2811 (function
2812 (lambda (raw-path info)
2813 "Treat links to `file.org' as links to `file.html', if needed.
2814 See `org-html-link-org-files-as-html'."
2815 (cond
2816 ((and (plist-get info :html-link-org-files-as-html)
2817 (string= ".org"
2818 (downcase (file-name-extension raw-path "."))))
2819 (concat (file-name-sans-extension raw-path) "."
2820 (plist-get info :html-extension)))
2821 (t raw-path)))))
2822 (type (org-element-property :type link))
2823 (raw-path (org-element-property :path link))
2824 ;; Ensure DESC really exists, or set it to nil.
2825 (desc (org-string-nw-p desc))
2826 (path
2827 (cond
2828 ((member type '("http" "https" "ftp" "mailto"))
2829 (org-html-encode-plain-text
2830 (org-link-escape-browser
2831 (org-link-unescape (concat type ":" raw-path)))))
2832 ((string= type "file")
2833 ;; Treat links to ".org" files as ".html", if needed.
2834 (setq raw-path
2835 (funcall link-org-files-as-html-maybe raw-path info))
2836 ;; If file path is absolute, prepend it with protocol
2837 ;; component - "file://".
2838 (cond
2839 ((file-name-absolute-p raw-path)
2840 (setq raw-path (org-export-file-uri raw-path)))
2841 ((and home use-abs-url)
2842 (setq raw-path (concat (file-name-as-directory home) raw-path))))
2843 ;; Add search option, if any. A search option can be
2844 ;; relative to a custom-id, a headline title a name,
2845 ;; a target or a radio-target.
2846 (let ((option (org-element-property :search-option link)))
2847 (if (not option) raw-path
2848 (concat raw-path
2850 (org-publish-resolve-external-link
2851 option
2852 (org-element-property :path link))))))
2853 (t raw-path)))
2854 ;; Extract attributes from parent's paragraph. HACK: Only do
2855 ;; this for the first link in parent (inner image link for
2856 ;; inline images). This is needed as long as attributes
2857 ;; cannot be set on a per link basis.
2858 (attributes-plist
2859 (let* ((parent (org-export-get-parent-element link))
2860 (link (let ((container (org-export-get-parent link)))
2861 (if (and (eq (org-element-type container) 'link)
2862 (org-html-inline-image-p link info))
2863 container
2864 link))))
2865 (and (eq (org-element-map parent 'link 'identity info t) link)
2866 (org-export-read-attribute :attr_html parent))))
2867 (attributes
2868 (let ((attr (org-html--make-attribute-string attributes-plist)))
2869 (if (org-string-nw-p attr) (concat " " attr) ""))))
2870 (cond
2871 ;; Link type is handled by a special function.
2872 ((org-export-custom-protocol-maybe link desc 'html))
2873 ;; Image file.
2874 ((and (plist-get info :html-inline-images)
2875 (org-export-inline-image-p
2876 link (plist-get info :html-inline-image-rules)))
2877 (org-html--format-image path attributes-plist info))
2878 ;; Radio target: Transcode target's contents and use them as
2879 ;; link's description.
2880 ((string= type "radio")
2881 (let ((destination (org-export-resolve-radio-link link info)))
2882 (if (not destination) desc
2883 (format "<a href=\"#%s\"%s>%s</a>"
2884 (org-export-get-reference destination info)
2885 attributes
2886 desc))))
2887 ;; Links pointing to a headline: Find destination and build
2888 ;; appropriate referencing command.
2889 ((member type '("custom-id" "fuzzy" "id"))
2890 (let ((destination (if (string= type "fuzzy")
2891 (org-export-resolve-fuzzy-link link info)
2892 (org-export-resolve-id-link link info))))
2893 (case (org-element-type destination)
2894 ;; ID link points to an external file.
2895 (plain-text
2896 (let ((fragment (concat "ID-" path))
2897 ;; Treat links to ".org" files as ".html", if needed.
2898 (path (funcall link-org-files-as-html-maybe
2899 destination info)))
2900 (format "<a href=\"%s#%s\"%s>%s</a>"
2901 path fragment attributes (or desc destination))))
2902 ;; Fuzzy link points nowhere.
2903 ((nil)
2904 (format "<i>%s</i>"
2905 (or desc
2906 (org-export-data
2907 (org-element-property :raw-link link) info))))
2908 ;; Link points to a headline.
2909 (headline
2910 (let ((href (or (org-element-property :CUSTOM_ID destination)
2911 (org-export-get-reference destination info)))
2912 ;; What description to use?
2913 (desc
2914 ;; Case 1: Headline is numbered and LINK has no
2915 ;; description. Display section number.
2916 (if (and (org-export-numbered-headline-p destination info)
2917 (not desc))
2918 (mapconcat #'number-to-string
2919 (org-export-get-headline-number
2920 destination info) ".")
2921 ;; Case 2: Either the headline is un-numbered or
2922 ;; LINK has a custom description. Display LINK's
2923 ;; description or headline's title.
2924 (or desc
2925 (org-export-data
2926 (org-element-property :title destination) info)))))
2927 (format "<a href=\"#%s\"%s>%s</a>" href attributes desc)))
2928 ;; Fuzzy link points to a target or an element.
2930 (let* ((ref (org-export-get-reference destination info))
2931 (org-html-standalone-image-predicate
2932 #'org-html--has-caption-p)
2933 (number (cond
2934 (desc nil)
2935 ((org-html-standalone-image-p destination info)
2936 (org-export-get-ordinal
2937 (org-element-map destination 'link
2938 #'identity info t)
2939 info 'link 'org-html-standalone-image-p))
2940 (t (org-export-get-ordinal
2941 destination info nil 'org-html--has-caption-p))))
2942 (desc (cond (desc)
2943 ((not number) "No description for this link")
2944 ((numberp number) (number-to-string number))
2945 (t (mapconcat #'number-to-string number ".")))))
2946 (format "<a href=\"#%s\"%s>%s</a>" ref attributes desc))))))
2947 ;; Coderef: replace link with the reference name or the
2948 ;; equivalent line number.
2949 ((string= type "coderef")
2950 (let ((fragment (concat "coderef-" path)))
2951 (format "<a href=\"#%s\"%s%s>%s</a>"
2952 fragment
2953 (org-trim
2954 (format (concat "class=\"coderef\""
2955 " onmouseover=\"CodeHighlightOn(this, '%s');\""
2956 " onmouseout=\"CodeHighlightOff(this, '%s');\"")
2957 fragment fragment))
2958 attributes
2959 (format (org-export-get-coderef-format path desc)
2960 (org-export-resolve-coderef path info)))))
2961 ;; External link with a description part.
2962 ((and path desc) (format "<a href=\"%s\"%s>%s</a>" path attributes desc))
2963 ;; External link without a description part.
2964 (path (format "<a href=\"%s\"%s>%s</a>" path attributes path))
2965 ;; No path, only description. Try to do something useful.
2966 (t (format "<i>%s</i>" desc)))))
2968 ;;;; Node Property
2970 (defun org-html-node-property (node-property contents info)
2971 "Transcode a NODE-PROPERTY element from Org to HTML.
2972 CONTENTS is nil. INFO is a plist holding contextual
2973 information."
2974 (format "%s:%s"
2975 (org-element-property :key node-property)
2976 (let ((value (org-element-property :value node-property)))
2977 (if value (concat " " value) ""))))
2979 ;;;; Paragraph
2981 (defun org-html-paragraph (paragraph contents info)
2982 "Transcode a PARAGRAPH element from Org to HTML.
2983 CONTENTS is the contents of the paragraph, as a string. INFO is
2984 the plist used as a communication channel."
2985 (let* ((parent (org-export-get-parent paragraph))
2986 (parent-type (org-element-type parent))
2987 (style '((footnote-definition " class=\"footpara\"")
2988 (org-data " class=\"footpara\"")))
2989 (attributes (org-html--make-attribute-string
2990 (org-export-read-attribute :attr_html paragraph)))
2991 (extra (or (cadr (assq parent-type style)) "")))
2992 (cond
2993 ((and (eq parent-type 'item)
2994 (not (org-export-get-previous-element paragraph info))
2995 (let ((followers (org-export-get-next-element paragraph info 2)))
2996 (and (not (cdr followers))
2997 (memq (org-element-type (car followers)) '(nil plain-list)))))
2998 ;; First paragraph in an item has no tag if it is alone or
2999 ;; followed, at most, by a sub-list.
3000 contents)
3001 ((org-html-standalone-image-p paragraph info)
3002 ;; Standalone image.
3003 (let ((caption
3004 (let ((raw (org-export-data
3005 (org-export-get-caption paragraph) info))
3006 (org-html-standalone-image-predicate
3007 'org-html--has-caption-p))
3008 (if (not (org-string-nw-p raw)) raw
3009 (concat
3010 "<span class=\"figure-number\">"
3011 (format (org-html--translate "Figure %d:" info)
3012 (org-export-get-ordinal
3013 (org-element-map paragraph 'link
3014 'identity info t)
3015 info nil 'org-html-standalone-image-p))
3016 "</span> " raw))))
3017 (label (and (org-element-property :name paragraph)
3018 (org-export-get-reference paragraph info))))
3019 (org-html--wrap-image contents info caption label)))
3020 ;; Regular paragraph.
3021 (t (format "<p%s%s>\n%s</p>"
3022 (if (org-string-nw-p attributes)
3023 (concat " " attributes) "")
3024 extra contents)))))
3026 ;;;; Plain List
3028 ;; FIXME Maybe arg1 is not needed because <li value="20"> already sets
3029 ;; the correct value for the item counter
3030 (defun org-html-begin-plain-list (type &optional arg1)
3031 "Insert the beginning of the HTML list depending on TYPE.
3032 When ARG1 is a string, use it as the start parameter for ordered
3033 lists."
3034 (case type
3035 (ordered
3036 (format "<ol class=\"org-ol\"%s>"
3037 (if arg1 (format " start=\"%d\"" arg1) "")))
3038 (unordered "<ul class=\"org-ul\">")
3039 (descriptive "<dl class=\"org-dl\">")))
3041 (defun org-html-end-plain-list (type)
3042 "Insert the end of the HTML list depending on TYPE."
3043 (case type
3044 (ordered "</ol>")
3045 (unordered "</ul>")
3046 (descriptive "</dl>")))
3048 (defun org-html-plain-list (plain-list contents info)
3049 "Transcode a PLAIN-LIST element from Org to HTML.
3050 CONTENTS is the contents of the list. INFO is a plist holding
3051 contextual information."
3052 (let* (arg1 ;; (assoc :counter (org-element-map plain-list 'item
3053 (type (org-element-property :type plain-list)))
3054 (format "%s\n%s%s"
3055 (org-html-begin-plain-list type)
3056 contents (org-html-end-plain-list type))))
3058 ;;;; Plain Text
3060 (defun org-html-convert-special-strings (string)
3061 "Convert special characters in STRING to HTML."
3062 (let ((all org-html-special-string-regexps)
3063 e a re rpl start)
3064 (while (setq a (pop all))
3065 (setq re (car a) rpl (cdr a) start 0)
3066 (while (string-match re string start)
3067 (setq string (replace-match rpl t nil string))))
3068 string))
3070 (defun org-html-encode-plain-text (text)
3071 "Convert plain text characters from TEXT to HTML equivalent.
3072 Possible conversions are set in `org-html-protect-char-alist'."
3073 (dolist (pair org-html-protect-char-alist text)
3074 (setq text (replace-regexp-in-string (car pair) (cdr pair) text t t))))
3076 (defun org-html-plain-text (text info)
3077 "Transcode a TEXT string from Org to HTML.
3078 TEXT is the string to transcode. INFO is a plist holding
3079 contextual information."
3080 (let ((output text))
3081 ;; Protect following characters: <, >, &.
3082 (setq output (org-html-encode-plain-text output))
3083 ;; Handle smart quotes. Be sure to provide original string since
3084 ;; OUTPUT may have been modified.
3085 (when (plist-get info :with-smart-quotes)
3086 (setq output (org-export-activate-smart-quotes output :html info text)))
3087 ;; Handle special strings.
3088 (when (plist-get info :with-special-strings)
3089 (setq output (org-html-convert-special-strings output)))
3090 ;; Handle break preservation if required.
3091 (when (plist-get info :preserve-breaks)
3092 (setq output
3093 (replace-regexp-in-string
3094 "\\(\\\\\\\\\\)?[ \t]*\n"
3095 (concat (org-html-close-tag "br" nil info) "\n") output)))
3096 ;; Return value.
3097 output))
3100 ;; Planning
3102 (defun org-html-planning (planning contents info)
3103 "Transcode a PLANNING element from Org to HTML.
3104 CONTENTS is nil. INFO is a plist used as a communication
3105 channel."
3106 (let ((span-fmt "<span class=\"timestamp-kwd\">%s</span> <span class=\"timestamp\">%s</span>"))
3107 (format
3108 "<p><span class=\"timestamp-wrapper\">%s</span></p>"
3109 (mapconcat
3110 'identity
3111 (delq nil
3112 (list
3113 (let ((closed (org-element-property :closed planning)))
3114 (when closed
3115 (format span-fmt org-closed-string
3116 (org-timestamp-translate closed))))
3117 (let ((deadline (org-element-property :deadline planning)))
3118 (when deadline
3119 (format span-fmt org-deadline-string
3120 (org-timestamp-translate deadline))))
3121 (let ((scheduled (org-element-property :scheduled planning)))
3122 (when scheduled
3123 (format span-fmt org-scheduled-string
3124 (org-timestamp-translate scheduled))))))
3125 " "))))
3127 ;;;; Property Drawer
3129 (defun org-html-property-drawer (property-drawer contents info)
3130 "Transcode a PROPERTY-DRAWER element from Org to HTML.
3131 CONTENTS holds the contents of the drawer. INFO is a plist
3132 holding contextual information."
3133 (and (org-string-nw-p contents)
3134 (format "<pre class=\"example\">\n%s</pre>" contents)))
3136 ;;;; Quote Block
3138 (defun org-html-quote-block (quote-block contents info)
3139 "Transcode a QUOTE-BLOCK element from Org to HTML.
3140 CONTENTS holds the contents of the block. INFO is a plist
3141 holding contextual information."
3142 (format "<blockquote>\n%s</blockquote>" contents))
3144 ;;;; Section
3146 (defun org-html-section (section contents info)
3147 "Transcode a SECTION element from Org to HTML.
3148 CONTENTS holds the contents of the section. INFO is a plist
3149 holding contextual information."
3150 (let ((parent (org-export-get-parent-headline section)))
3151 ;; Before first headline: no container, just return CONTENTS.
3152 (if (not parent) contents
3153 ;; Get div's class and id references.
3154 (let* ((class-num (+ (org-export-get-relative-level parent info)
3155 (1- (plist-get info :html-toplevel-hlevel))))
3156 (section-number
3157 (and (org-export-numbered-headline-p parent info)
3158 (mapconcat
3159 #'number-to-string
3160 (org-export-get-headline-number parent info) "-"))))
3161 ;; Build return value.
3162 (format "<div class=\"outline-text-%d\" id=\"text-%s\">\n%s</div>"
3163 class-num
3164 (or (org-element-property :CUSTOM_ID parent)
3165 section-number
3166 (org-export-get-reference parent info))
3167 (or contents ""))))))
3169 ;;;; Radio Target
3171 (defun org-html-radio-target (radio-target text info)
3172 "Transcode a RADIO-TARGET object from Org to HTML.
3173 TEXT is the text of the target. INFO is a plist holding
3174 contextual information."
3175 (let ((ref (org-export-get-reference radio-target info)))
3176 (org-html--anchor ref text nil info)))
3178 ;;;; Special Block
3180 (defun org-html-special-block (special-block contents info)
3181 "Transcode a SPECIAL-BLOCK element from Org to HTML.
3182 CONTENTS holds the contents of the block. INFO is a plist
3183 holding contextual information."
3184 (let* ((block-type (org-element-property :type special-block))
3185 (contents (or contents ""))
3186 (html5-fancy (and (org-html-html5-p info)
3187 (plist-get info :html-html5-fancy)
3188 (member block-type org-html-html5-elements)))
3189 (attributes (org-export-read-attribute :attr_html special-block)))
3190 (unless html5-fancy
3191 (let ((class (plist-get attributes :class)))
3192 (setq attributes (plist-put attributes :class
3193 (if class (concat class " " block-type)
3194 block-type)))))
3195 (setq attributes (org-html--make-attribute-string attributes))
3196 (when (not (equal attributes ""))
3197 (setq attributes (concat " " attributes)))
3198 (if html5-fancy
3199 (format "<%s%s>\n%s</%s>" block-type attributes
3200 contents block-type)
3201 (format "<div%s>\n%s\n</div>" attributes contents))))
3203 ;;;; Src Block
3205 (defun org-html-src-block (src-block contents info)
3206 "Transcode a SRC-BLOCK element from Org to HTML.
3207 CONTENTS holds the contents of the item. INFO is a plist holding
3208 contextual information."
3209 (if (org-export-read-attribute :attr_html src-block :textarea)
3210 (org-html--textarea-block src-block)
3211 (let ((lang (org-element-property :language src-block))
3212 (caption (org-export-get-caption src-block))
3213 (code (org-html-format-code src-block info))
3214 (label (let ((lbl (and (org-element-property :name src-block)
3215 (org-export-get-reference src-block info))))
3216 (if lbl (format " id=\"%s\"" lbl) ""))))
3217 (if (not lang) (format "<pre class=\"example\"%s>\n%s</pre>" label code)
3218 (format
3219 "<div class=\"org-src-container\">\n%s%s\n</div>"
3220 (if (not caption) ""
3221 (format "<label class=\"org-src-name\">%s</label>"
3222 (org-export-data caption info)))
3223 (format "\n<pre class=\"src src-%s\"%s>%s</pre>" lang label code))))))
3225 ;;;; Statistics Cookie
3227 (defun org-html-statistics-cookie (statistics-cookie contents info)
3228 "Transcode a STATISTICS-COOKIE object from Org to HTML.
3229 CONTENTS is nil. INFO is a plist holding contextual information."
3230 (let ((cookie-value (org-element-property :value statistics-cookie)))
3231 (format "<code>%s</code>" cookie-value)))
3233 ;;;; Strike-Through
3235 (defun org-html-strike-through (strike-through contents info)
3236 "Transcode STRIKE-THROUGH from Org to HTML.
3237 CONTENTS is the text with strike-through markup. INFO is a plist
3238 holding contextual information."
3239 (format
3240 (or (cdr (assq 'strike-through (plist-get info :html-text-markup-alist)))
3241 "%s")
3242 contents))
3244 ;;;; Subscript
3246 (defun org-html-subscript (subscript contents info)
3247 "Transcode a SUBSCRIPT object from Org to HTML.
3248 CONTENTS is the contents of the object. INFO is a plist holding
3249 contextual information."
3250 (format "<sub>%s</sub>" contents))
3252 ;;;; Superscript
3254 (defun org-html-superscript (superscript contents info)
3255 "Transcode a SUPERSCRIPT object from Org to HTML.
3256 CONTENTS is the contents of the object. INFO is a plist holding
3257 contextual information."
3258 (format "<sup>%s</sup>" contents))
3260 ;;;; Table Cell
3262 (defun org-html-table-cell (table-cell contents info)
3263 "Transcode a TABLE-CELL element from Org to HTML.
3264 CONTENTS is nil. INFO is a plist used as a communication
3265 channel."
3266 (let* ((table-row (org-export-get-parent table-cell))
3267 (table (org-export-get-parent-table table-cell))
3268 (cell-attrs
3269 (if (not (plist-get info :html-table-align-individual-fields)) ""
3270 (format (if (and (boundp 'org-html-format-table-no-css)
3271 org-html-format-table-no-css)
3272 " align=\"%s\"" " class=\"org-%s\"")
3273 (org-export-table-cell-alignment table-cell info)))))
3274 (when (or (not contents) (string= "" (org-trim contents)))
3275 (setq contents "&#xa0;"))
3276 (cond
3277 ((and (org-export-table-has-header-p table info)
3278 (= 1 (org-export-table-row-group table-row info)))
3279 (let ((header-tags (plist-get info :html-table-header-tags)))
3280 (concat "\n" (format (car header-tags) "col" cell-attrs)
3281 contents
3282 (cdr header-tags))))
3283 ((and (plist-get info :html-table-use-header-tags-for-first-column)
3284 (zerop (cdr (org-export-table-cell-address table-cell info))))
3285 (let ((header-tags (plist-get info :html-table-header-tags)))
3286 (concat "\n" (format (car header-tags) "row" cell-attrs)
3287 contents
3288 (cdr header-tags))))
3289 (t (let ((data-tags (plist-get info :html-table-data-tags)))
3290 (concat "\n" (format (car data-tags) cell-attrs)
3291 contents
3292 (cdr data-tags)))))))
3294 ;;;; Table Row
3296 (defun org-html-table-row (table-row contents info)
3297 "Transcode a TABLE-ROW element from Org to HTML.
3298 CONTENTS is the contents of the row. INFO is a plist used as a
3299 communication channel."
3300 ;; Rules are ignored since table separators are deduced from
3301 ;; borders of the current row.
3302 (when (eq (org-element-property :type table-row) 'standard)
3303 (let* ((rowgroup-number (org-export-table-row-group table-row info))
3304 (row-number (org-export-table-row-number table-row info))
3305 (start-rowgroup-p
3306 (org-export-table-row-starts-rowgroup-p table-row info))
3307 (end-rowgroup-p
3308 (org-export-table-row-ends-rowgroup-p table-row info))
3309 ;; `top-row-p' and `end-rowgroup-p' are not used directly
3310 ;; but should be set so that `org-html-table-row-tags' can
3311 ;; use them (see the docstring of this variable.)
3312 (top-row-p (and (equal start-rowgroup-p '(top))
3313 (equal end-rowgroup-p '(below top))))
3314 (bottom-row-p (and (equal start-rowgroup-p '(above))
3315 (equal end-rowgroup-p '(bottom above))))
3316 (rowgroup-tags
3317 (cond
3318 ;; Case 1: Row belongs to second or subsequent rowgroups.
3319 ((not (= 1 rowgroup-number))
3320 '("<tbody>" . "\n</tbody>"))
3321 ;; Case 2: Row is from first rowgroup. Table has >=1 rowgroups.
3322 ((org-export-table-has-header-p
3323 (org-export-get-parent-table table-row) info)
3324 '("<thead>" . "\n</thead>"))
3325 ;; Case 2: Row is from first and only row group.
3326 (t '("<tbody>" . "\n</tbody>")))))
3327 (concat
3328 ;; Begin a rowgroup?
3329 (when start-rowgroup-p (car rowgroup-tags))
3330 ;; Actual table row
3331 (concat "\n" (eval (car (plist-get info :html-table-row-tags)))
3332 contents
3333 "\n"
3334 (eval (cdr (plist-get info :html-table-row-tags))))
3335 ;; End a rowgroup?
3336 (when end-rowgroup-p (cdr rowgroup-tags))))))
3338 ;;;; Table
3340 (defun org-html-table-first-row-data-cells (table info)
3341 "Transcode the first row of TABLE.
3342 INFO is a plist used as a communication channel."
3343 (let ((table-row
3344 (org-element-map table 'table-row
3345 (lambda (row)
3346 (unless (eq (org-element-property :type row) 'rule) row))
3347 info 'first-match))
3348 (special-column-p (org-export-table-has-special-column-p table)))
3349 (if (not special-column-p) (org-element-contents table-row)
3350 (cdr (org-element-contents table-row)))))
3352 (defun org-html-table--table.el-table (table info)
3353 "Format table.el tables into HTML.
3354 INFO is a plist used as a communication channel."
3355 (when (eq (org-element-property :type table) 'table.el)
3356 (require 'table)
3357 (let ((outbuf (with-current-buffer
3358 (get-buffer-create "*org-export-table*")
3359 (erase-buffer) (current-buffer))))
3360 (with-temp-buffer
3361 (insert (org-element-property :value table))
3362 (goto-char 1)
3363 (re-search-forward "^[ \t]*|[^|]" nil t)
3364 (table-generate-source 'html outbuf))
3365 (with-current-buffer outbuf
3366 (prog1 (org-trim (buffer-string))
3367 (kill-buffer) )))))
3369 (defun org-html-table (table contents info)
3370 "Transcode a TABLE element from Org to HTML.
3371 CONTENTS is the contents of the table. INFO is a plist holding
3372 contextual information."
3373 (case (org-element-property :type table)
3374 ;; Case 1: table.el table. Convert it using appropriate tools.
3375 (table.el (org-html-table--table.el-table table info))
3376 ;; Case 2: Standard table.
3378 (let* ((caption (org-export-get-caption table))
3379 (number (org-export-get-ordinal
3380 table info nil #'org-html--has-caption-p))
3381 (attributes
3382 (org-html--make-attribute-string
3383 (org-combine-plists
3384 (and (org-element-property :name table)
3385 (list :id (org-export-get-reference table info)))
3386 (and (not (org-html-html5-p info))
3387 (plist-get info :html-table-attributes))
3388 (org-export-read-attribute :attr_html table))))
3389 (alignspec
3390 (if (and (boundp 'org-html-format-table-no-css)
3391 org-html-format-table-no-css)
3392 "align=\"%s\"" "class=\"org-%s\""))
3393 (table-column-specs
3394 (function
3395 (lambda (table info)
3396 (mapconcat
3397 (lambda (table-cell)
3398 (let ((alignment (org-export-table-cell-alignment
3399 table-cell info)))
3400 (concat
3401 ;; Begin a colgroup?
3402 (when (org-export-table-cell-starts-colgroup-p
3403 table-cell info)
3404 "\n<colgroup>")
3405 ;; Add a column. Also specify it's alignment.
3406 (format "\n%s"
3407 (org-html-close-tag
3408 "col" (concat " " (format alignspec alignment)) info))
3409 ;; End a colgroup?
3410 (when (org-export-table-cell-ends-colgroup-p
3411 table-cell info)
3412 "\n</colgroup>"))))
3413 (org-html-table-first-row-data-cells table info) "\n")))))
3414 (format "<table%s>\n%s\n%s\n%s</table>"
3415 (if (equal attributes "") "" (concat " " attributes))
3416 (if (not caption) ""
3417 (format (if (plist-get info :html-table-caption-above)
3418 "<caption class=\"t-above\">%s</caption>"
3419 "<caption class=\"t-bottom\">%s</caption>")
3420 (concat
3421 "<span class=\"table-number\">"
3422 (format (org-html--translate "Table %d:" info) number)
3423 "</span> " (org-export-data caption info))))
3424 (funcall table-column-specs table info)
3425 contents)))))
3427 ;;;; Target
3429 (defun org-html-target (target contents info)
3430 "Transcode a TARGET object from Org to HTML.
3431 CONTENTS is nil. INFO is a plist holding contextual
3432 information."
3433 (let ((ref (org-export-get-reference target info)))
3434 (org-html--anchor ref nil nil info)))
3436 ;;;; Timestamp
3438 (defun org-html-timestamp (timestamp contents info)
3439 "Transcode a TIMESTAMP object from Org to HTML.
3440 CONTENTS is nil. INFO is a plist holding contextual
3441 information."
3442 (let ((value (org-html-plain-text (org-timestamp-translate timestamp) info)))
3443 (format "<span class=\"timestamp-wrapper\"><span class=\"timestamp\">%s</span></span>"
3444 (replace-regexp-in-string "--" "&#x2013;" value))))
3446 ;;;; Underline
3448 (defun org-html-underline (underline contents info)
3449 "Transcode UNDERLINE from Org to HTML.
3450 CONTENTS is the text with underline markup. INFO is a plist
3451 holding contextual information."
3452 (format (or (cdr (assq 'underline (plist-get info :html-text-markup-alist)))
3453 "%s")
3454 contents))
3456 ;;;; Verbatim
3458 (defun org-html-verbatim (verbatim contents info)
3459 "Transcode VERBATIM from Org to HTML.
3460 CONTENTS is nil. INFO is a plist holding contextual
3461 information."
3462 (format (or (cdr (assq 'verbatim (plist-get info :html-text-markup-alist))) "%s")
3463 (org-html-encode-plain-text (org-element-property :value verbatim))))
3465 ;;;; Verse Block
3467 (defun org-html-verse-block (verse-block contents info)
3468 "Transcode a VERSE-BLOCK element from Org to HTML.
3469 CONTENTS is verse block contents. INFO is a plist holding
3470 contextual information."
3471 ;; Replace each newline character with line break. Also replace
3472 ;; each blank line with a line break.
3473 (setq contents (replace-regexp-in-string
3474 "^ *\\\\\\\\$" (format "%s\n" (org-html-close-tag "br" nil info))
3475 (replace-regexp-in-string
3476 "\\(\\\\\\\\\\)?[ \t]*\n"
3477 (format "%s\n" (org-html-close-tag "br" nil info)) contents)))
3478 ;; Replace each white space at beginning of a line with a
3479 ;; non-breaking space.
3480 (while (string-match "^[ \t]+" contents)
3481 (let* ((num-ws (length (match-string 0 contents)))
3482 (ws (let (out) (dotimes (i num-ws out)
3483 (setq out (concat out "&#xa0;"))))))
3484 (setq contents (replace-match ws nil t contents))))
3485 (format "<p class=\"verse\">\n%s</p>" contents))
3488 ;;; Filter Functions
3490 (defun org-html-final-function (contents backend info)
3491 "Filter to indent the HTML and convert HTML entities."
3492 (with-temp-buffer
3493 (insert contents)
3494 (set-auto-mode t)
3495 (if (plist-get info :html-indent)
3496 (indent-region (point-min) (point-max)))
3497 (when (plist-get info :html-use-unicode-chars)
3498 (require 'mm-url)
3499 (mm-url-decode-entities))
3500 (buffer-substring-no-properties (point-min) (point-max))))
3503 ;;; End-user functions
3505 ;;;###autoload
3506 (defun org-html-export-as-html
3507 (&optional async subtreep visible-only body-only ext-plist)
3508 "Export current buffer to an HTML buffer.
3510 If narrowing is active in the current buffer, only export its
3511 narrowed part.
3513 If a region is active, export that region.
3515 A non-nil optional argument ASYNC means the process should happen
3516 asynchronously. The resulting buffer should be accessible
3517 through the `org-export-stack' interface.
3519 When optional argument SUBTREEP is non-nil, export the sub-tree
3520 at point, extracting information from the headline properties
3521 first.
3523 When optional argument VISIBLE-ONLY is non-nil, don't export
3524 contents of hidden elements.
3526 When optional argument BODY-ONLY is non-nil, only write code
3527 between \"<body>\" and \"</body>\" tags.
3529 EXT-PLIST, when provided, is a property list with external
3530 parameters overriding Org default settings, but still inferior to
3531 file-local settings.
3533 Export is done in a buffer named \"*Org HTML Export*\", which
3534 will be displayed when `org-export-show-temporary-export-buffer'
3535 is non-nil."
3536 (interactive)
3537 (org-export-to-buffer 'html "*Org HTML Export*"
3538 async subtreep visible-only body-only ext-plist
3539 (lambda () (set-auto-mode t))))
3541 ;;;###autoload
3542 (defun org-html-convert-region-to-html ()
3543 "Assume the current region has org-mode syntax, and convert it to HTML.
3544 This can be used in any buffer. For example, you can write an
3545 itemized list in org-mode syntax in an HTML buffer and use this
3546 command to convert it."
3547 (interactive)
3548 (org-export-replace-region-by 'html))
3550 ;;;###autoload
3551 (defun org-html-export-to-html
3552 (&optional async subtreep visible-only body-only ext-plist)
3553 "Export current buffer to a HTML file.
3555 If narrowing is active in the current buffer, only export its
3556 narrowed part.
3558 If a region is active, export that region.
3560 A non-nil optional argument ASYNC means the process should happen
3561 asynchronously. The resulting file should be accessible through
3562 the `org-export-stack' interface.
3564 When optional argument SUBTREEP is non-nil, export the sub-tree
3565 at point, extracting information from the headline properties
3566 first.
3568 When optional argument VISIBLE-ONLY is non-nil, don't export
3569 contents of hidden elements.
3571 When optional argument BODY-ONLY is non-nil, only write code
3572 between \"<body>\" and \"</body>\" tags.
3574 EXT-PLIST, when provided, is a property list with external
3575 parameters overriding Org default settings, but still inferior to
3576 file-local settings.
3578 Return output file's name."
3579 (interactive)
3580 (let* ((extension (concat "." (or (plist-get ext-plist :html-extension)
3581 org-html-extension
3582 "html")))
3583 (file (org-export-output-file-name extension subtreep))
3584 (org-export-coding-system org-html-coding-system))
3585 (org-export-to-file 'html file
3586 async subtreep visible-only body-only ext-plist)))
3588 ;;;###autoload
3589 (defun org-html-publish-to-html (plist filename pub-dir)
3590 "Publish an org file to HTML.
3592 FILENAME is the filename of the Org file to be published. PLIST
3593 is the property list for the given project. PUB-DIR is the
3594 publishing directory.
3596 Return output file name."
3597 (org-publish-org-to 'html filename
3598 (concat "." (or (plist-get plist :html-extension)
3599 org-html-extension
3600 "html"))
3601 plist pub-dir))
3604 (provide 'ox-html)
3606 ;; Local variables:
3607 ;; generated-autoload-file: "org-loaddefs.el"
3608 ;; End:
3610 ;;; ox-html.el ends here