org-mime.el: Fix org-mime-htmlize
[org-mode.git] / lisp / ox-html.el
blobd454fabae74474f7bc5da130c66f78ba5d483565
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 { display: inline; }
338 .footdef { margin-bottom: 1em; }
339 .figure { padding: 1em; }
340 .figure p { text-align: center; }
341 .inlinetask {
342 padding: 10px;
343 border: 2px solid gray;
344 margin: 10px;
345 background: #ffffcc;
347 #org-div-home-and-up
348 { text-align: right; font-size: 70%; white-space: nowrap; }
349 textarea { overflow-x: auto; }
350 .linenr { font-size: smaller }
351 .code-highlighted { background-color: #ffff00; }
352 .org-info-js_info-navigation { border-style: none; }
353 #org-info-js_console-label
354 { font-size: 10px; font-weight: bold; white-space: nowrap; }
355 .org-info-js_search-highlight
356 { background-color: #ffff00; color: #000000; font-weight: bold; }
357 /*]]>*/-->
358 </style>"
359 "The default style specification for exported HTML files.
360 You can use `org-html-head' and `org-html-head-extra' to add to
361 this style. If you don't want to include this default style,
362 customize `org-html-head-include-default-style'.")
365 ;;; User Configuration Variables
367 (defgroup org-export-html nil
368 "Options for exporting Org mode files to HTML."
369 :tag "Org Export HTML"
370 :group 'org-export)
372 ;;;; Handle infojs
374 (defvar org-html-infojs-opts-table
375 '((path PATH "http://orgmode.org/org-info.js")
376 (view VIEW "info")
377 (toc TOC :with-toc)
378 (ftoc FIXED_TOC "0")
379 (tdepth TOC_DEPTH "max")
380 (sdepth SECTION_DEPTH "max")
381 (mouse MOUSE_HINT "underline")
382 (buttons VIEW_BUTTONS "0")
383 (ltoc LOCAL_TOC "1")
384 (up LINK_UP :html-link-up)
385 (home LINK_HOME :html-link-home))
386 "JavaScript options, long form for script, default values.")
388 (defcustom org-html-use-infojs 'when-configured
389 "Non-nil when Sebastian Rose's Java Script org-info.js should be active.
390 This option can be nil or t to never or always use the script.
391 It can also be the symbol `when-configured', meaning that the
392 script will be linked into the export file if and only if there
393 is a \"#+INFOJS_OPT:\" line in the buffer. See also the variable
394 `org-html-infojs-options'."
395 :group 'org-export-html
396 :version "24.4"
397 :package-version '(Org . "8.0")
398 :type '(choice
399 (const :tag "Never" nil)
400 (const :tag "When configured in buffer" when-configured)
401 (const :tag "Always" t)))
403 (defcustom org-html-infojs-options
404 (mapcar (lambda (x) (cons (car x) (nth 2 x))) org-html-infojs-opts-table)
405 "Options settings for the INFOJS JavaScript.
406 Each of the options must have an entry in `org-html-infojs-opts-table'.
407 The value can either be a string that will be passed to the script, or
408 a property. This property is then assumed to be a property that is defined
409 by the Export/Publishing setup of Org.
410 The `sdepth' and `tdepth' parameters can also be set to \"max\", which
411 means to use the maximum value consistent with other options."
412 :group 'org-export-html
413 :version "24.4"
414 :package-version '(Org . "8.0")
415 :type
416 `(set :greedy t :inline t
417 ,@(mapcar
418 (lambda (x)
419 (list 'cons (list 'const (car x))
420 '(choice
421 (symbol :tag "Publishing/Export property")
422 (string :tag "Value"))))
423 org-html-infojs-opts-table)))
425 (defcustom org-html-infojs-template
426 "<script type=\"text/javascript\" src=\"%SCRIPT_PATH\">
429 * @source: %SCRIPT_PATH
431 * @licstart The following is the entire license notice for the
432 * JavaScript code in %SCRIPT_PATH.
434 * Copyright (C) 2012-2013 Free Software Foundation, Inc.
437 * The JavaScript code in this tag is free software: you can
438 * redistribute it and/or modify it under the terms of the GNU
439 * General Public License (GNU GPL) as published by the Free Software
440 * Foundation, either version 3 of the License, or (at your option)
441 * any later version. The code is distributed WITHOUT ANY WARRANTY;
442 * without even the implied warranty of MERCHANTABILITY or FITNESS
443 * FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
445 * As additional permission under GNU GPL version 3 section 7, you
446 * may distribute non-source (e.g., minimized or compacted) forms of
447 * that code without the copy of the GNU GPL normally required by
448 * section 4, provided you include this license notice and a URL
449 * through which recipients can access the Corresponding Source.
451 * @licend The above is the entire license notice
452 * for the JavaScript code in %SCRIPT_PATH.
455 </script>
457 <script type=\"text/javascript\">
460 @licstart The following is the entire license notice for the
461 JavaScript code in this tag.
463 Copyright (C) 2012-2013 Free Software Foundation, Inc.
465 The JavaScript code in this tag is free software: you can
466 redistribute it and/or modify it under the terms of the GNU
467 General Public License (GNU GPL) as published by the Free Software
468 Foundation, either version 3 of the License, or (at your option)
469 any later version. The code is distributed WITHOUT ANY WARRANTY;
470 without even the implied warranty of MERCHANTABILITY or FITNESS
471 FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
473 As additional permission under GNU GPL version 3 section 7, you
474 may distribute non-source (e.g., minimized or compacted) forms of
475 that code without the copy of the GNU GPL normally required by
476 section 4, provided you include this license notice and a URL
477 through which recipients can access the Corresponding Source.
480 @licend The above is the entire license notice
481 for the JavaScript code in this tag.
484 <!--/*--><![CDATA[/*><!--*/
485 %MANAGER_OPTIONS
486 org_html_manager.setup(); // activate after the parameters are set
487 /*]]>*///-->
488 </script>"
489 "The template for the export style additions when org-info.js is used.
490 Option settings will replace the %MANAGER-OPTIONS cookie."
491 :group 'org-export-html
492 :version "24.4"
493 :package-version '(Org . "8.0")
494 :type 'string)
496 (defun org-html-infojs-install-script (exp-plist backend)
497 "Install script in export options when appropriate.
498 EXP-PLIST is a plist containing export options. BACKEND is the
499 export back-end currently used."
500 (unless (or (memq 'body-only (plist-get exp-plist :export-options))
501 (not (plist-get exp-plist :html-use-infojs))
502 (and (eq (plist-get exp-plist :html-use-infojs) 'when-configured)
503 (let ((opt (plist-get exp-plist :infojs-opt)))
504 (or (not opt)
505 (string= "" opt)
506 (string-match "\\<view:nil\\>" opt)))))
507 (let* ((template (plist-get exp-plist :html-infojs-template))
508 (ptoc (plist-get exp-plist :with-toc))
509 (hlevels (plist-get exp-plist :headline-levels))
510 (sdepth hlevels)
511 (tdepth (if (integerp ptoc) (min ptoc hlevels) hlevels))
512 (options (plist-get exp-plist :infojs-opt))
513 (infojs-opt (plist-get exp-plist :html-infojs-options))
514 (table org-html-infojs-opts-table)
515 style)
516 (dolist (entry table)
517 (let* ((opt (car entry))
518 (var (nth 1 entry))
519 ;; Compute default values for script option OPT from
520 ;; `org-html-infojs-options' variable.
521 (default
522 (let ((default (cdr (assq opt infojs-opt))))
523 (if (and (symbolp default) (not (memq default '(t nil))))
524 (plist-get exp-plist default)
525 default)))
526 ;; Value set through INFOJS_OPT keyword has precedence
527 ;; over the default one.
528 (val (if (and options
529 (string-match (format "\\<%s:\\(\\S-+\\)" opt)
530 options))
531 (match-string 1 options)
532 default)))
533 (case opt
534 (path (setq template
535 (replace-regexp-in-string
536 "%SCRIPT_PATH" val template t t)))
537 (sdepth (when (integerp (read val))
538 (setq sdepth (min (read val) sdepth))))
539 (tdepth (when (integerp (read val))
540 (setq tdepth (min (read val) tdepth))))
541 (otherwise (setq val
542 (cond
543 ((or (eq val t) (equal val "t")) "1")
544 ((or (eq val nil) (equal val "nil")) "0")
545 ((stringp val) val)
546 (t (format "%s" val))))
547 (push (cons var val) style)))))
548 ;; Now we set the depth of the *generated* TOC to SDEPTH,
549 ;; because the toc will actually determine the splitting. How
550 ;; much of the toc will actually be displayed is governed by the
551 ;; TDEPTH option.
552 (setq exp-plist (plist-put exp-plist :with-toc sdepth))
553 ;; The table of contents should not show more sections than we
554 ;; generate.
555 (setq tdepth (min tdepth sdepth))
556 (push (cons "TOC_DEPTH" tdepth) style)
557 ;; Build style string.
558 (setq style (mapconcat
559 (lambda (x)
560 (format "org_html_manager.set(\"%s\", \"%s\");"
561 (car x) (cdr x)))
562 style "\n"))
563 (when (and style (> (length style) 0))
564 (and (string-match "%MANAGER_OPTIONS" template)
565 (setq style (replace-match style t t template))
566 (setq exp-plist
567 (plist-put
568 exp-plist :html-head-extra
569 (concat (or (plist-get exp-plist :html-head-extra) "")
570 "\n"
571 style)))))
572 ;; This script absolutely needs the table of contents, so we
573 ;; change that setting.
574 (unless (plist-get exp-plist :with-toc)
575 (setq exp-plist (plist-put exp-plist :with-toc t)))
576 ;; Return the modified property list.
577 exp-plist)))
579 ;;;; Bold, etc.
581 (defcustom org-html-text-markup-alist
582 '((bold . "<b>%s</b>")
583 (code . "<code>%s</code>")
584 (italic . "<i>%s</i>")
585 (strike-through . "<del>%s</del>")
586 (underline . "<span class=\"underline\">%s</span>")
587 (verbatim . "<code>%s</code>"))
588 "Alist of HTML expressions to convert text markup.
590 The key must be a symbol among `bold', `code', `italic',
591 `strike-through', `underline' and `verbatim'. The value is
592 a formatting string to wrap fontified text with.
594 If no association can be found for a given markup, text will be
595 returned as-is."
596 :group 'org-export-html
597 :version "24.4"
598 :package-version '(Org . "8.0")
599 :type '(alist :key-type (symbol :tag "Markup type")
600 :value-type (string :tag "Format string"))
601 :options '(bold code italic strike-through underline verbatim))
603 (defcustom org-html-indent nil
604 "Non-nil means to indent the generated HTML.
605 Warning: non-nil may break indentation of source code blocks."
606 :group 'org-export-html
607 :version "24.4"
608 :package-version '(Org . "8.0")
609 :type 'boolean)
611 (defcustom org-html-use-unicode-chars nil
612 "Non-nil means to use unicode characters instead of HTML entities."
613 :group 'org-export-html
614 :version "24.4"
615 :package-version '(Org . "8.0")
616 :type 'boolean)
618 ;;;; Drawers
620 (defcustom org-html-format-drawer-function (lambda (name contents) contents)
621 "Function called to format a drawer in HTML code.
623 The function must accept two parameters:
624 NAME the drawer name, like \"LOGBOOK\"
625 CONTENTS the contents of the drawer.
627 The function should return the string to be exported.
629 For example, the variable could be set to the following function
630 in order to mimic default behaviour:
632 The default value simply returns the value of CONTENTS."
633 :group 'org-export-html
634 :version "24.4"
635 :package-version '(Org . "8.0")
636 :type 'function)
638 ;;;; Footnotes
640 (defcustom org-html-footnotes-section "<div id=\"footnotes\">
641 <h2 class=\"footnotes\">%s: </h2>
642 <div id=\"text-footnotes\">
644 </div>
645 </div>"
646 "Format for the footnotes section.
647 Should contain a two instances of %s. The first will be replaced with the
648 language-specific word for \"Footnotes\", the second one will be replaced
649 by the footnotes themselves."
650 :group 'org-export-html
651 :type 'string)
653 (defcustom org-html-footnote-format "<sup>%s</sup>"
654 "The format for the footnote reference.
655 %s will be replaced by the footnote reference itself."
656 :group 'org-export-html
657 :type 'string)
659 (defcustom org-html-footnote-separator "<sup>, </sup>"
660 "Text used to separate footnotes."
661 :group 'org-export-html
662 :type 'string)
664 ;;;; Headline
666 (defcustom org-html-toplevel-hlevel 2
667 "The <H> level for level 1 headings in HTML export.
668 This is also important for the classes that will be wrapped around headlines
669 and outline structure. If this variable is 1, the top-level headlines will
670 be <h1>, and the corresponding classes will be outline-1, section-number-1,
671 and outline-text-1. If this is 2, all of these will get a 2 instead.
672 The default for this variable is 2, because we use <h1> for formatting the
673 document title."
674 :group 'org-export-html
675 :type 'integer)
677 (defcustom org-html-format-headline-function
678 'org-html-format-headline-default-function
679 "Function to format headline text.
681 This function will be called with six arguments:
682 TODO the todo keyword (string or nil).
683 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
684 PRIORITY the priority of the headline (integer or nil)
685 TEXT the main headline text (string).
686 TAGS the tags (string or nil).
687 INFO the export options (plist).
689 The function result will be used in the section format string."
690 :group 'org-export-html
691 :version "25.1"
692 :package-version '(Org . "8.3")
693 :type 'function)
695 ;;;; HTML-specific
697 (defcustom org-html-allow-name-attribute-in-anchors nil
698 "When nil, do not set \"name\" attribute in anchors.
699 By default, when appropriate, anchors are formatted with \"id\"
700 but without \"name\" attribute."
701 :group 'org-export-html
702 :version "24.4"
703 :package-version '(Org . "8.0")
704 :type 'boolean)
706 ;;;; Inlinetasks
708 (defcustom org-html-format-inlinetask-function
709 'org-html-format-inlinetask-default-function
710 "Function called to format an inlinetask in HTML code.
712 The function must accept seven parameters:
713 TODO the todo keyword, as a string
714 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
715 PRIORITY the inlinetask priority, as a string
716 NAME the inlinetask name, as a string.
717 TAGS the inlinetask tags, as a list of strings.
718 CONTENTS the contents of the inlinetask, as a string.
719 INFO the export options, as a plist
721 The function should return the string to be exported."
722 :group 'org-export-html
723 :version "25.1"
724 :package-version '(Org . "8.3")
725 :type 'function)
727 ;;;; LaTeX
729 (defcustom org-html-with-latex org-export-with-latex
730 "Non-nil means process LaTeX math snippets.
732 When set, the exporter will process LaTeX environments and
733 fragments.
735 This option can also be set with the +OPTIONS line,
736 e.g. \"tex:mathjax\". Allowed values are:
738 nil Ignore math snippets.
739 `verbatim' Keep everything in verbatim
740 `dvipng' Process the LaTeX fragments to images. This will also
741 include processing of non-math environments.
742 `imagemagick' Convert the LaTeX fragments to pdf files and use
743 imagemagick to convert pdf files to png files.
744 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
745 be loaded.
746 t Synonym for `mathjax'."
747 :group 'org-export-html
748 :version "24.4"
749 :package-version '(Org . "8.0")
750 :type '(choice
751 (const :tag "Do not process math in any way" nil)
752 (const :tag "Use dvipng to make images" dvipng)
753 (const :tag "Use imagemagick to make images" imagemagick)
754 (const :tag "Use MathJax to display math" mathjax)
755 (const :tag "Leave math verbatim" verbatim)))
757 ;;;; Links :: Generic
759 (defcustom org-html-link-org-files-as-html t
760 "Non-nil means make file links to `file.org' point to `file.html'.
761 When `org-mode' is exporting an `org-mode' file to HTML, links to
762 non-html files are directly put into a href tag in HTML.
763 However, links to other Org-mode files (recognized by the
764 extension `.org.) should become links to the corresponding html
765 file, assuming that the linked `org-mode' file will also be
766 converted to HTML.
767 When nil, the links still point to the plain `.org' file."
768 :group 'org-export-html
769 :type 'boolean)
771 ;;;; Links :: Inline images
773 (defcustom org-html-inline-images t
774 "Non-nil means inline images into exported HTML pages.
775 This is done using an <img> tag. When nil, an anchor with href is used to
776 link to the image."
777 :group 'org-export-html
778 :version "24.4"
779 :package-version '(Org . "8.1")
780 :type 'boolean)
782 (defcustom org-html-inline-image-rules
783 '(("file" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")
784 ("http" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")
785 ("https" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'"))
786 "Rules characterizing image files that can be inlined into HTML.
787 A rule consists in an association whose key is the type of link
788 to consider, and value is a regexp that will be matched against
789 link's path."
790 :group 'org-export-html
791 :version "24.4"
792 :package-version '(Org . "8.0")
793 :type '(alist :key-type (string :tag "Type")
794 :value-type (regexp :tag "Path")))
796 ;;;; Plain Text
798 (defvar org-html-protect-char-alist
799 '(("&" . "&amp;")
800 ("<" . "&lt;")
801 (">" . "&gt;"))
802 "Alist of characters to be converted by `org-html-encode-plain-text'.")
804 ;;;; Src Block
806 (defcustom org-html-htmlize-output-type 'inline-css
807 "Output type to be used by htmlize when formatting code snippets.
808 Choices are `css' to export the CSS selectors only,`inline-css'
809 to export the CSS attribute values inline in the HTML or `nil' to
810 export plain text. We use as default `inline-css', in order to
811 make the resulting HTML self-containing.
813 However, this will fail when using Emacs in batch mode for export, because
814 then no rich font definitions are in place. It will also not be good if
815 people with different Emacs setup contribute HTML files to a website,
816 because the fonts will represent the individual setups. In these cases,
817 it is much better to let Org/Htmlize assign classes only, and to use
818 a style file to define the look of these classes.
819 To get a start for your css file, start Emacs session and make sure that
820 all the faces you are interested in are defined, for example by loading files
821 in all modes you want. Then, use the command
822 \\[org-html-htmlize-generate-css] to extract class definitions."
823 :group 'org-export-html
824 :type '(choice (const css) (const inline-css) (const nil)))
826 (defcustom org-html-htmlize-font-prefix "org-"
827 "The prefix for CSS class names for htmlize font specifications."
828 :group 'org-export-html
829 :type 'string)
831 ;;;; Table
833 (defcustom org-html-table-default-attributes
834 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups" :frame "hsides")
835 "Default attributes and values which will be used in table tags.
836 This is a plist where attributes are symbols, starting with
837 colons, and values are strings.
839 When exporting to HTML5, these values will be disregarded."
840 :group 'org-export-html
841 :version "24.4"
842 :package-version '(Org . "8.0")
843 :type '(plist :key-type (symbol :tag "Property")
844 :value-type (string :tag "Value")))
846 (defcustom org-html-table-header-tags '("<th scope=\"%s\"%s>" . "</th>")
847 "The opening and ending tags for table header fields.
848 This is customizable so that alignment options can be specified.
849 The first %s will be filled with the scope of the field, either row or col.
850 The second %s will be replaced by a style entry to align the field.
851 See also the variable `org-html-table-use-header-tags-for-first-column'.
852 See also the variable `org-html-table-align-individual-fields'."
853 :group 'org-export-html
854 :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
856 (defcustom org-html-table-data-tags '("<td%s>" . "</td>")
857 "The opening and ending tags for table data fields.
858 This is customizable so that alignment options can be specified.
859 The first %s will be filled with the scope of the field, either row or col.
860 The second %s will be replaced by a style entry to align the field.
861 See also the variable `org-html-table-align-individual-fields'."
862 :group 'org-export-html
863 :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
865 (defcustom org-html-table-row-tags '("<tr>" . "</tr>")
866 "The opening and ending tags for table rows.
867 This is customizable so that alignment options can be specified.
868 Instead of strings, these can be Lisp forms that will be
869 evaluated for each row in order to construct the table row tags.
871 During evaluation, these variables will be dynamically bound so that
872 you can reuse them:
874 `row-number': row number (0 is the first row)
875 `rowgroup-number': group number of current row
876 `start-rowgroup-p': non-nil means the row starts a group
877 `end-rowgroup-p': non-nil means the row ends a group
878 `top-row-p': non-nil means this is the top row
879 `bottom-row-p': non-nil means this is the bottom row
881 For example:
883 \(setq org-html-table-row-tags
884 (cons '(cond (top-row-p \"<tr class=\\\"tr-top\\\">\")
885 (bottom-row-p \"<tr class=\\\"tr-bottom\\\">\")
886 (t (if (= (mod row-number 2) 1)
887 \"<tr class=\\\"tr-odd\\\">\"
888 \"<tr class=\\\"tr-even\\\">\")))
889 \"</tr>\"))
891 will use the \"tr-top\" and \"tr-bottom\" classes for the top row
892 and the bottom row, and otherwise alternate between \"tr-odd\" and
893 \"tr-even\" for odd and even rows."
894 :group 'org-export-html
895 :type '(cons
896 (choice :tag "Opening tag"
897 (string :tag "Specify")
898 (sexp))
899 (choice :tag "Closing tag"
900 (string :tag "Specify")
901 (sexp))))
903 (defcustom org-html-table-align-individual-fields t
904 "Non-nil means attach style attributes for alignment to each table field.
905 When nil, alignment will only be specified in the column tags, but this
906 is ignored by some browsers (like Firefox, Safari). Opera does it right
907 though."
908 :group 'org-export-html
909 :type 'boolean)
911 (defcustom org-html-table-use-header-tags-for-first-column nil
912 "Non-nil means format column one in tables with header tags.
913 When nil, also column one will use data tags."
914 :group 'org-export-html
915 :type 'boolean)
917 (defcustom org-html-table-caption-above t
918 "When non-nil, place caption string at the beginning of the table.
919 Otherwise, place it near the end."
920 :group 'org-export-html
921 :type 'boolean)
923 ;;;; Tags
925 (defcustom org-html-tag-class-prefix ""
926 "Prefix to class names for TODO keywords.
927 Each tag gets a class given by the tag itself, with this prefix.
928 The default prefix is empty because it is nice to just use the keyword
929 as a class name. But if you get into conflicts with other, existing
930 CSS classes, then this prefix can be very useful."
931 :group 'org-export-html
932 :type 'string)
934 ;;;; Template :: Generic
936 (defcustom org-html-extension "html"
937 "The extension for exported HTML files."
938 :group 'org-export-html
939 :type 'string)
941 (defcustom org-html-xml-declaration
942 '(("html" . "<?xml version=\"1.0\" encoding=\"%s\"?>")
943 ("php" . "<?php echo \"<?xml version=\\\"1.0\\\" encoding=\\\"%s\\\" ?>\"; ?>"))
944 "The extension for exported HTML files.
945 %s will be replaced with the charset of the exported file.
946 This may be a string, or an alist with export extensions
947 and corresponding declarations.
949 This declaration only applies when exporting to XHTML."
950 :group 'org-export-html
951 :type '(choice
952 (string :tag "Single declaration")
953 (repeat :tag "Dependent on extension"
954 (cons (string :tag "Extension")
955 (string :tag "Declaration")))))
957 (defcustom org-html-coding-system 'utf-8
958 "Coding system for HTML export.
959 Use utf-8 as the default value."
960 :group 'org-export-html
961 :version "24.4"
962 :package-version '(Org . "8.0")
963 :type 'coding-system)
965 (defcustom org-html-doctype "xhtml-strict"
966 "Document type definition to use for exported HTML files.
967 Can be set with the in-buffer HTML_DOCTYPE property or for
968 publishing, with :html-doctype."
969 :group 'org-export-html
970 :version "24.4"
971 :package-version '(Org . "8.0")
972 :type (append
973 '(choice)
974 (mapcar (lambda (x) `(const ,(car x))) org-html-doctype-alist)
975 '((string :tag "Custom doctype" ))))
977 (defcustom org-html-html5-fancy nil
978 "Non-nil means using new HTML5 elements.
979 This variable is ignored for anything other than HTML5 export.
981 For compatibility with Internet Explorer, it's probably a good
982 idea to download some form of the html5shiv (for instance
983 https://code.google.com/p/html5shiv/) and add it to your
984 HTML_HEAD_EXTRA, so that your pages don't break for users of IE
985 versions 8 and below."
986 :group 'org-export-html
987 :version "24.4"
988 :package-version '(Org . "8.0")
989 :type 'boolean)
991 (defcustom org-html-container-element "div"
992 "HTML element to use for wrapping top level sections.
993 Can be set with the in-buffer HTML_CONTAINER property or for
994 publishing, with :html-container.
996 Note that changing the default will prevent you from using
997 org-info.js for your website."
998 :group 'org-export-html
999 :version "24.4"
1000 :package-version '(Org . "8.0")
1001 :type 'string)
1003 (defcustom org-html-divs
1004 '((preamble "div" "preamble")
1005 (content "div" "content")
1006 (postamble "div" "postamble"))
1007 "Alist of the three section elements for HTML export.
1008 The car of each entry is one of 'preamble, 'content or 'postamble.
1009 The cdrs of each entry are the ELEMENT_TYPE and ID for each
1010 section of the exported document.
1012 Note that changing the default will prevent you from using
1013 org-info.js for your website."
1014 :group 'org-export-html
1015 :version "24.4"
1016 :package-version '(Org . "8.0")
1017 :type '(list :greedy t
1018 (list :tag "Preamble"
1019 (const :format "" preamble)
1020 (string :tag "element") (string :tag " id"))
1021 (list :tag "Content"
1022 (const :format "" content)
1023 (string :tag "element") (string :tag " id"))
1024 (list :tag "Postamble" (const :format "" postamble)
1025 (string :tag " id") (string :tag "element"))))
1027 (defconst org-html-checkbox-types
1028 '((unicode .
1029 ((on . "&#x2611;") (off . "&#x2610;") (trans . "&#x2610;")))
1030 (ascii .
1031 ((on . "<code>[X]</code>")
1032 (off . "<code>[&#xa0;]</code>")
1033 (trans . "<code>[-]</code>")))
1034 (html .
1035 ((on . "<input type='checkbox' checked='checked' />")
1036 (off . "<input type='checkbox' />")
1037 (trans . "<input type='checkbox' />"))))
1038 "Alist of checkbox types.
1039 The cdr of each entry is an alist list three checkbox types for
1040 HTML export: `on', `off' and `trans'.
1042 The choices are:
1043 `unicode' Unicode characters (HTML entities)
1044 `ascii' ASCII characters
1045 `html' HTML checkboxes
1047 Note that only the ascii characters implement tri-state
1048 checkboxes. The other two use the `off' checkbox for `trans'.")
1050 (defcustom org-html-checkbox-type 'ascii
1051 "The type of checkboxes to use for HTML export.
1052 See `org-html-checkbox-types' for for the values used for each
1053 option."
1054 :group 'org-export-html
1055 :version "24.4"
1056 :package-version '(Org . "8.0")
1057 :type '(choice
1058 (const :tag "ASCII characters" ascii)
1059 (const :tag "Unicode characters" unicode)
1060 (const :tag "HTML checkboxes" html)))
1062 (defcustom org-html-metadata-timestamp-format "%Y-%m-%d %a %H:%M"
1063 "Format used for timestamps in preamble, postamble and metadata.
1064 See `format-time-string' for more information on its components."
1065 :group 'org-export-html
1066 :version "24.4"
1067 :package-version '(Org . "8.0")
1068 :type 'string)
1070 ;;;; Template :: Mathjax
1072 (defcustom org-html-mathjax-options
1073 '((path "http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML" )
1074 (scale "100")
1075 (align "center")
1076 (font "TeX")
1077 (linebreaks "false")
1078 (autonumber "AMS")
1079 (indent "0em")
1080 (multlinewidth "85%")
1081 (tagindent ".8em")
1082 (tagside "right"))
1083 "Options for MathJax setup.
1085 Alist of the following elements. All values are strings.
1087 path The path to MathJax.
1088 scale Scaling with HTML-CSS, MathML and SVG output engines.
1089 align How to align display math: left, center, or right.
1090 font The font to use with HTML-CSS and SVG output. As of MathJax 2.5
1091 the following values are understood: \"TeX\", \"STIX-Web\",
1092 \"Asana-Math\", \"Neo-Euler\", \"Gyre-Pagella\",
1093 \"Gyre-Termes\", and \"Latin-Modern\".
1094 linebreaks Let MathJax perform automatic linebreaks. Valid values
1095 are \"true\" and \"false\".
1096 indent If align is not center, how far from the left/right side?
1097 Valid values are \"left\" and \"right\"
1098 multlinewidth The width of the multline environment.
1099 autonumber How to number equations. Valid values are \"None\",
1100 \"all\" and \"AMS Math\".
1101 tagindent The amount tags are indented.
1102 tagside Which side to show tags/labels on. Valid values are
1103 \"left\" and \"right\"
1105 You can also customize this for each buffer, using something like
1107 #+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
1109 For further information about MathJax options, see the MathJax documentation:
1111 http://docs.mathjax.org/
1113 Please note that by using the default CDN one must agree with
1114 MathJax CDN Terms of Service.
1116 http://www.mathjax.org/mathjax-cdn-terms-of-service.html"
1117 :group 'org-export-html
1118 :package-version '(Org . "8.3")
1119 :type '(list :greedy t
1120 (list :tag "path (the path from where to load MathJax.js)"
1121 (const :format " " path) (string))
1122 (list :tag "scale (scaling for the displayed math)"
1123 (const :format " " scale) (string))
1124 (list :tag "align (alignment of displayed equations)"
1125 (const :format " " align) (string))
1126 (list :tag "font (used to display math)"
1127 (const :format " " font)
1128 (choice (const "TeX")
1129 (const "STIX-Web")
1130 (const "Asana-Math")
1131 (const "Neo-Euler")
1132 (const "Gyre-Pagella")
1133 (const "Gyre-Termes")
1134 (const "Latin-Modern")))
1135 (list :tag "linebreaks (automatic line-breaking)"
1136 (const :format " " linebreaks)
1137 (choice (const "true")
1138 (const "false")))
1139 (list :tag "autonumber (when should equations be numbered)"
1140 (const :format " " autonumber)
1141 (choice (const "AMS")
1142 (const "None")
1143 (const "All")))
1144 (list :tag "indent (indentation with left or right alignment)"
1145 (const :format " " indent) (string))
1146 (list :tag "multlinewidth (width to use for the multline environment)"
1147 (const :format " " multlinewidth) (string))
1148 (list :tag "tagindent (the indentation of tags from left or right)"
1149 (const :format " " tagindent) (string))
1150 (list :tag "tagside (location of tags)"
1151 (const :format " " tagside)
1152 (choice (const "left")
1153 (const "right")))))
1155 (defcustom org-html-mathjax-template
1156 "<script type=\"text/x-mathjax-config\">
1157 MathJax.Hub.Config({
1158 displayAlign: \"%ALIGN\",
1159 displayIndent: \"%INDENT\",
1161 \"HTML-CSS\": { scale: %SCALE,
1162 linebreaks: { automatic: \"%LINEBREAKS\" },
1163 webFont: \"%FONT\"
1165 SVG: {scale: %SCALE,
1166 linebreaks: { automatic: \"%LINEBREAKS\" },
1167 font: \"%FONT\"},
1168 NativeMML: {scale: %SCALE},
1169 TeX: { equationNumbers: {autoNumber: \"%AUTONUMBER\"},
1170 MultLineWidth: \"%MULTLINEWIDTH\",
1171 TagSide: \"%TAGSIDE\",
1172 TagIndent: \"%TAGINDENT\"
1175 </script>
1176 <script type=\"text/javascript\"
1177 src=\"%PATH\"></script>"
1178 "The MathJax template. See also `org-html-mathjax-options'."
1179 :group 'org-export-html
1180 :type 'string)
1182 ;;;; Template :: Postamble
1184 (defcustom org-html-postamble 'auto
1185 "Non-nil means insert a postamble in HTML export.
1187 When set to 'auto, check against the
1188 `org-export-with-author/email/creator/date' variables to set the
1189 content of the postamble. When set to a string, use this string
1190 as the postamble. When t, insert a string as defined by the
1191 formatting string in `org-html-postamble-format'.
1193 When set to a function, apply this function and insert the
1194 returned string. The function takes the property list of export
1195 options as its only argument.
1197 Setting :html-postamble in publishing projects will take
1198 precedence over this variable."
1199 :group 'org-export-html
1200 :type '(choice (const :tag "No postamble" nil)
1201 (const :tag "Auto postamble" auto)
1202 (const :tag "Default formatting string" t)
1203 (string :tag "Custom formatting string")
1204 (function :tag "Function (must return a string)")))
1206 (defcustom org-html-postamble-format
1207 '(("en" "<p class=\"author\">Author: %a (%e)</p>
1208 <p class=\"date\">Date: %d</p>
1209 <p class=\"creator\">%c</p>
1210 <p class=\"validation\">%v</p>"))
1211 "Alist of languages and format strings for the HTML postamble.
1213 The first element of each list is the language code, as used for
1214 the LANGUAGE keyword. See `org-export-default-language'.
1216 The second element of each list is a format string to format the
1217 postamble itself. This format string can contain these elements:
1219 %t stands for the title.
1220 %s stands for the subtitle.
1221 %a stands for the author's name.
1222 %e stands for the author's email.
1223 %d stands for the date.
1224 %c will be replaced by `org-html-creator-string'.
1225 %v will be replaced by `org-html-validation-link'.
1226 %T will be replaced by the export time.
1227 %C will be replaced by the last modification time.
1229 If you need to use a \"%\" character, you need to escape it
1230 like that: \"%%\"."
1231 :group 'org-export-html
1232 :type '(repeat
1233 (list (string :tag "Language")
1234 (string :tag "Format string"))))
1236 (defcustom org-html-validation-link
1237 "<a href=\"http://validator.w3.org/check?uri=referer\">Validate</a>"
1238 "Link to HTML validation service."
1239 :group 'org-export-html
1240 :type 'string)
1242 (defcustom org-html-creator-string
1243 (format "<a href=\"http://www.gnu.org/software/emacs/\">Emacs</a> %s (<a href=\"http://orgmode.org\">Org</a> mode %s)"
1244 emacs-version
1245 (if (fboundp 'org-version) (org-version) "unknown version"))
1246 "Information about the creator of the HTML document.
1247 This option can also be set on with the CREATOR keyword."
1248 :group 'org-export-html
1249 :version "24.4"
1250 :package-version '(Org . "8.0")
1251 :type '(string :tag "Creator string"))
1253 ;;;; Template :: Preamble
1255 (defcustom org-html-preamble t
1256 "Non-nil means insert a preamble in HTML export.
1258 When t, insert a string as defined by the formatting string in
1259 `org-html-preamble-format'. When set to a string, use this
1260 formatting string instead (see `org-html-postamble-format' for an
1261 example of such a formatting string).
1263 When set to a function, apply this function and insert the
1264 returned string. The function takes the property list of export
1265 options as its only argument.
1267 Setting :html-preamble in publishing projects will take
1268 precedence over this variable."
1269 :group 'org-export-html
1270 :type '(choice (const :tag "No preamble" nil)
1271 (const :tag "Default preamble" t)
1272 (string :tag "Custom formatting string")
1273 (function :tag "Function (must return a string)")))
1275 (defcustom org-html-preamble-format '(("en" ""))
1276 "Alist of languages and format strings for the HTML preamble.
1278 The first element of each list is the language code, as used for
1279 the LANGUAGE keyword. See `org-export-default-language'.
1281 The second element of each list is a format string to format the
1282 preamble itself. This format string can contain these elements:
1284 %t stands for the title.
1285 %s stands for the subtitle.
1286 %a stands for the author's name.
1287 %e stands for the author's email.
1288 %d stands for the date.
1289 %c will be replaced by `org-html-creator-string'.
1290 %v will be replaced by `org-html-validation-link'.
1291 %T will be replaced by the export time.
1292 %C will be replaced by the last modification time.
1294 If you need to use a \"%\" character, you need to escape it
1295 like that: \"%%\".
1297 See the default value of `org-html-postamble-format' for an
1298 example."
1299 :group 'org-export-html
1300 :type '(repeat
1301 (list (string :tag "Language")
1302 (string :tag "Format string"))))
1304 (defcustom org-html-link-up ""
1305 "Where should the \"UP\" link of exported HTML pages lead?"
1306 :group 'org-export-html
1307 :type '(string :tag "File or URL"))
1309 (defcustom org-html-link-home ""
1310 "Where should the \"HOME\" link of exported HTML pages lead?"
1311 :group 'org-export-html
1312 :type '(string :tag "File or URL"))
1314 (defcustom org-html-link-use-abs-url nil
1315 "Should we prepend relative links with HTML_LINK_HOME?"
1316 :group 'org-export-html
1317 :version "24.4"
1318 :package-version '(Org . "8.1")
1319 :type 'boolean)
1321 (defcustom org-html-home/up-format
1322 "<div id=\"org-div-home-and-up\">
1323 <a accesskey=\"h\" href=\"%s\"> UP </a>
1325 <a accesskey=\"H\" href=\"%s\"> HOME </a>
1326 </div>"
1327 "Snippet used to insert the HOME and UP links.
1328 This is a format string, the first %s will receive the UP link,
1329 the second the HOME link. If both `org-html-link-up' and
1330 `org-html-link-home' are empty, the entire snippet will be
1331 ignored."
1332 :group 'org-export-html
1333 :type 'string)
1335 ;;;; Template :: Scripts
1337 (define-obsolete-variable-alias
1338 'org-html-style-include-scripts 'org-html-head-include-scripts "24.4")
1339 (defcustom org-html-head-include-scripts t
1340 "Non-nil means include the JavaScript snippets in exported HTML files.
1341 The actual script is defined in `org-html-scripts' and should
1342 not be modified."
1343 :group 'org-export-html
1344 :version "24.4"
1345 :package-version '(Org . "8.0")
1346 :type 'boolean)
1348 ;;;; Template :: Styles
1350 (define-obsolete-variable-alias
1351 'org-html-style-include-default 'org-html-head-include-default-style "24.4")
1352 (defcustom org-html-head-include-default-style t
1353 "Non-nil means include the default style in exported HTML files.
1354 The actual style is defined in `org-html-style-default' and
1355 should not be modified. Use `org-html-head' to use your own
1356 style information."
1357 :group 'org-export-html
1358 :version "24.4"
1359 :package-version '(Org . "8.0")
1360 :type 'boolean)
1361 ;;;###autoload
1362 (put 'org-html-head-include-default-style 'safe-local-variable 'booleanp)
1364 (define-obsolete-variable-alias 'org-html-style 'org-html-head "24.4")
1365 (defcustom org-html-head ""
1366 "Org-wide head definitions for exported HTML files.
1368 This variable can contain the full HTML structure to provide a
1369 style, including the surrounding HTML tags. You can consider
1370 including definitions for the following classes: title, todo,
1371 done, timestamp, timestamp-kwd, tag, target.
1373 For example, a valid value would be:
1375 <style type=\"text/css\">
1376 <![CDATA[
1377 p { font-weight: normal; color: gray; }
1378 h1 { color: black; }
1379 .title { text-align: center; }
1380 .todo, .timestamp-kwd { color: red; }
1381 .done { color: green; }
1383 </style>
1385 If you want to refer to an external style, use something like
1387 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\" />
1389 As the value of this option simply gets inserted into the HTML
1390 <head> header, you can use it to add any arbitrary text to the
1391 header.
1393 You can set this on a per-file basis using #+HTML_HEAD:,
1394 or for publication projects using the :html-head property."
1395 :group 'org-export-html
1396 :version "24.4"
1397 :package-version '(Org . "8.0")
1398 :type 'string)
1399 ;;;###autoload
1400 (put 'org-html-head 'safe-local-variable 'stringp)
1402 (defcustom org-html-head-extra ""
1403 "More head information to add in the HTML output.
1405 You can set this on a per-file basis using #+HTML_HEAD_EXTRA:,
1406 or for publication projects using the :html-head-extra property."
1407 :group 'org-export-html
1408 :version "24.4"
1409 :package-version '(Org . "8.0")
1410 :type 'string)
1411 ;;;###autoload
1412 (put 'org-html-head-extra 'safe-local-variable 'stringp)
1414 ;;;; Template :: Viewport
1416 (defcustom org-html-viewport '((width "device-width")
1417 (initial-scale "1")
1418 (minimum-scale "")
1419 (maximum-scale "")
1420 (user-scalable ""))
1421 "Viewport options for mobile-optimized sites.
1423 The following values are recognized
1425 width Size of the viewport.
1426 initial-scale Zoom level when the page is first loaded.
1427 minimum-scale Minimum allowed zoom level.
1428 maximum-scale Maximum allowed zoom level.
1429 user-scalable Whether zoom can be changed.
1431 The viewport meta tag is inserted if this variable is non-nil.
1433 See the following site for a reference:
1434 https://developer.mozilla.org/en-US/docs/Mozilla/Mobile/Viewport_meta_tag"
1435 :group 'org-export-html
1436 :version "25.1"
1437 :package-version '(Org . "8.3")
1438 :type '(choice (const :tag "Disable" nil)
1439 (list :tag "Enable"
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 "<div class=\"footpara\">%s</div>"
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 (or (org-element-property :CUSTOM_ID headline)
2204 (org-export-get-reference headline info))
2205 ;; Body.
2206 (concat
2207 (and (not (org-export-low-level-p headline info))
2208 (org-export-numbered-headline-p headline info)
2209 (concat (mapconcat #'number-to-string headline-number ".")
2210 ". "))
2211 (apply (plist-get info :html-format-headline-function)
2212 todo todo-type priority text tags :section-number nil)))))
2214 (defun org-html-list-of-listings (info)
2215 "Build a list of listings.
2216 INFO is a plist used as a communication channel. Return the list
2217 of listings as a string, or nil if it is empty."
2218 (let ((lol-entries (org-export-collect-listings info)))
2219 (when lol-entries
2220 (concat "<div id=\"list-of-listings\">\n"
2221 (let ((top-level (plist-get info :html-toplevel-hlevel)))
2222 (format "<h%d>%s</h%d>\n"
2223 top-level
2224 (org-html--translate "List of Listings" info)
2225 top-level))
2226 "<div id=\"text-list-of-listings\">\n<ul>\n"
2227 (let ((count 0)
2228 (initial-fmt (format "<span class=\"listing-number\">%s</span>"
2229 (org-html--translate "Listing %d:" info))))
2230 (mapconcat
2231 (lambda (entry)
2232 (let ((label (and (org-element-property :name entry)
2233 (org-export-get-reference entry info)))
2234 (title (org-trim
2235 (org-export-data
2236 (or (org-export-get-caption entry t)
2237 (org-export-get-caption entry))
2238 info))))
2239 (concat
2240 "<li>"
2241 (if (not label)
2242 (concat (format initial-fmt (incf count)) " " title)
2243 (format "<a href=\"#%s\">%s %s</a>"
2244 label
2245 (format initial-fmt (incf count))
2246 title))
2247 "</li>")))
2248 lol-entries "\n"))
2249 "\n</ul>\n</div>\n</div>"))))
2251 (defun org-html-list-of-tables (info)
2252 "Build a list of tables.
2253 INFO is a plist used as a communication channel. Return the list
2254 of tables as a string, or nil if it is empty."
2255 (let ((lol-entries (org-export-collect-tables info)))
2256 (when lol-entries
2257 (concat "<div id=\"list-of-tables\">\n"
2258 (let ((top-level (plist-get info :html-toplevel-hlevel)))
2259 (format "<h%d>%s</h%d>\n"
2260 top-level
2261 (org-html--translate "List of Tables" info)
2262 top-level))
2263 "<div id=\"text-list-of-tables\">\n<ul>\n"
2264 (let ((count 0)
2265 (initial-fmt (format "<span class=\"table-number\">%s</span>"
2266 (org-html--translate "Table %d:" info))))
2267 (mapconcat
2268 (lambda (entry)
2269 (let ((label (and (org-element-property :name entry)
2270 (org-export-get-reference entry info)))
2271 (title (org-trim
2272 (org-export-data
2273 (or (org-export-get-caption entry t)
2274 (org-export-get-caption entry))
2275 info))))
2276 (concat
2277 "<li>"
2278 (if (not label)
2279 (concat (format initial-fmt (incf count)) " " title)
2280 (format "<a href=\"#%s\">%s %s</a>"
2281 label
2282 (format initial-fmt (incf count))
2283 title))
2284 "</li>")))
2285 lol-entries "\n"))
2286 "\n</ul>\n</div>\n</div>"))))
2289 ;;; Transcode Functions
2291 ;;;; Bold
2293 (defun org-html-bold (bold contents info)
2294 "Transcode BOLD from Org to HTML.
2295 CONTENTS is the text with bold markup. INFO is a plist holding
2296 contextual information."
2297 (format (or (cdr (assq 'bold (plist-get info :html-text-markup-alist))) "%s")
2298 contents))
2300 ;;;; Center Block
2302 (defun org-html-center-block (center-block contents info)
2303 "Transcode a CENTER-BLOCK element from Org to HTML.
2304 CONTENTS holds the contents of the block. INFO is a plist
2305 holding contextual information."
2306 (format "<div class=\"center\">\n%s</div>" contents))
2308 ;;;; Clock
2310 (defun org-html-clock (clock contents info)
2311 "Transcode a CLOCK element from Org to HTML.
2312 CONTENTS is nil. INFO is a plist used as a communication
2313 channel."
2314 (format "<p>
2315 <span class=\"timestamp-wrapper\">
2316 <span class=\"timestamp-kwd\">%s</span> <span class=\"timestamp\">%s</span>%s
2317 </span>
2318 </p>"
2319 org-clock-string
2320 (org-timestamp-translate (org-element-property :value clock))
2321 (let ((time (org-element-property :duration clock)))
2322 (and time (format " <span class=\"timestamp\">(%s)</span>" time)))))
2324 ;;;; Code
2326 (defun org-html-code (code contents info)
2327 "Transcode CODE from Org to HTML.
2328 CONTENTS is nil. INFO is a plist holding contextual
2329 information."
2330 (format (or (cdr (assq 'code (plist-get info :html-text-markup-alist))) "%s")
2331 (org-html-encode-plain-text (org-element-property :value code))))
2333 ;;;; Drawer
2335 (defun org-html-drawer (drawer contents info)
2336 "Transcode a DRAWER element from Org to HTML.
2337 CONTENTS holds the contents of the block. INFO is a plist
2338 holding contextual information."
2339 (funcall (plist-get info :html-format-drawer-function)
2340 (org-element-property :drawer-name drawer)
2341 contents))
2343 ;;;; Dynamic Block
2345 (defun org-html-dynamic-block (dynamic-block contents info)
2346 "Transcode a DYNAMIC-BLOCK element from Org to HTML.
2347 CONTENTS holds the contents of the block. INFO is a plist
2348 holding contextual information. See `org-export-data'."
2349 contents)
2351 ;;;; Entity
2353 (defun org-html-entity (entity contents info)
2354 "Transcode an ENTITY object from Org to HTML.
2355 CONTENTS are the definition itself. INFO is a plist holding
2356 contextual information."
2357 (org-element-property :html entity))
2359 ;;;; Example Block
2361 (defun org-html-example-block (example-block contents info)
2362 "Transcode a EXAMPLE-BLOCK element from Org to HTML.
2363 CONTENTS is nil. INFO is a plist holding contextual
2364 information."
2365 (if (org-export-read-attribute :attr_html example-block :textarea)
2366 (org-html--textarea-block example-block)
2367 (format "<pre class=\"example\">\n%s</pre>"
2368 (org-html-format-code example-block info))))
2370 ;;;; Export Snippet
2372 (defun org-html-export-snippet (export-snippet contents info)
2373 "Transcode a EXPORT-SNIPPET object from Org to HTML.
2374 CONTENTS is nil. INFO is a plist holding contextual
2375 information."
2376 (when (eq (org-export-snippet-backend export-snippet) 'html)
2377 (org-element-property :value export-snippet)))
2379 ;;;; Export Block
2381 (defun org-html-export-block (export-block contents info)
2382 "Transcode a EXPORT-BLOCK element from Org to HTML.
2383 CONTENTS is nil. INFO is a plist holding contextual information."
2384 (when (string= (org-element-property :type export-block) "HTML")
2385 (org-remove-indentation (org-element-property :value export-block))))
2387 ;;;; Fixed Width
2389 (defun org-html-fixed-width (fixed-width contents info)
2390 "Transcode a FIXED-WIDTH element from Org to HTML.
2391 CONTENTS is nil. INFO is a plist holding contextual information."
2392 (format "<pre class=\"example\">\n%s</pre>"
2393 (org-html-do-format-code
2394 (org-remove-indentation
2395 (org-element-property :value fixed-width)))))
2397 ;;;; Footnote Reference
2399 (defun org-html-footnote-reference (footnote-reference contents info)
2400 "Transcode a FOOTNOTE-REFERENCE element from Org to HTML.
2401 CONTENTS is nil. INFO is a plist holding contextual information."
2402 (concat
2403 ;; Insert separator between two footnotes in a row.
2404 (let ((prev (org-export-get-previous-element footnote-reference info)))
2405 (when (eq (org-element-type prev) 'footnote-reference)
2406 (plist-get info :html-footnote-separator)))
2407 (let* ((n (org-export-get-footnote-number footnote-reference info))
2408 (id (format "fnr.%d%s"
2410 (if (org-export-footnote-first-reference-p
2411 footnote-reference info)
2413 ".100"))))
2414 (format
2415 (plist-get info :html-footnote-format)
2416 (org-html--anchor
2417 id n (format " class=\"footref\" href=\"#fn.%d\"" n) info)))))
2419 ;;;; Headline
2421 (defun org-html-headline (headline contents info)
2422 "Transcode a HEADLINE element from Org to HTML.
2423 CONTENTS holds the contents of the headline. INFO is a plist
2424 holding contextual information."
2425 (unless (org-element-property :footnote-section-p headline)
2426 (let* ((numberedp (org-export-numbered-headline-p headline info))
2427 (numbers (org-export-get-headline-number headline info))
2428 (section-number (and numbers
2429 (mapconcat #'number-to-string numbers "-")))
2430 (level (+ (org-export-get-relative-level headline info)
2431 (1- (plist-get info :html-toplevel-hlevel))))
2432 (todo (and (plist-get info :with-todo-keywords)
2433 (let ((todo (org-element-property :todo-keyword headline)))
2434 (and todo (org-export-data todo info)))))
2435 (todo-type (and todo (org-element-property :todo-type headline)))
2436 (priority (and (plist-get info :with-priority)
2437 (org-element-property :priority headline)))
2438 (text (org-export-data (org-element-property :title headline) info))
2439 (tags (and (plist-get info :with-tags)
2440 (org-export-get-tags headline info)))
2441 (full-text (funcall (plist-get info :html-format-headline-function)
2442 todo todo-type priority text tags info))
2443 (contents (or contents ""))
2444 (ids (delq nil
2445 (list (org-element-property :CUSTOM_ID headline)
2446 (org-export-get-reference headline info)
2447 (org-element-property :ID headline))))
2448 (preferred-id (car ids))
2449 (extra-ids
2450 (mapconcat
2451 (lambda (id)
2452 (org-html--anchor
2453 (if (org-uuidgen-p id) (concat "ID-" id) id)
2454 nil nil info))
2455 (cdr ids) "")))
2456 (if (org-export-low-level-p headline info)
2457 ;; This is a deep sub-tree: export it as a list item.
2458 (let* ((type (if numberedp 'ordered 'unordered))
2459 (itemized-body
2460 (org-html-format-list-item
2461 contents type nil info nil
2462 (concat (org-html--anchor preferred-id nil nil info)
2463 extra-ids
2464 full-text))))
2465 (concat (and (org-export-first-sibling-p headline info)
2466 (org-html-begin-plain-list type))
2467 itemized-body
2468 (and (org-export-last-sibling-p headline info)
2469 (org-html-end-plain-list type))))
2470 (let ((extra-class (org-element-property :HTML_CONTAINER_CLASS headline))
2471 (first-content (car (org-element-contents headline))))
2472 ;; Standard headline. Export it as a section.
2473 (format "<%s id=\"%s\" class=\"%s\">%s%s</%s>\n"
2474 (org-html--container headline info)
2475 (concat "outline-container-"
2476 (org-export-get-reference headline info))
2477 (concat (format "outline-%d" level)
2478 (and extra-class " ")
2479 extra-class)
2480 (format "\n<h%d id=\"%s\">%s%s</h%d>\n"
2481 level
2482 preferred-id
2483 extra-ids
2484 (concat
2485 (and numberedp
2486 (format
2487 "<span class=\"section-number-%d\">%s</span> "
2488 level
2489 (mapconcat #'number-to-string numbers ".")))
2490 full-text)
2491 level)
2492 ;; When there is no section, pretend there is an
2493 ;; empty one to get the correct <div
2494 ;; class="outline-...> which is needed by
2495 ;; `org-info.js'.
2496 (if (eq (org-element-type first-content) 'section) contents
2497 (concat (org-html-section first-content "" info) contents))
2498 (org-html--container headline info)))))))
2500 (defun org-html-format-headline-default-function
2501 (todo todo-type priority text tags info)
2502 "Default format function for a headline.
2503 See `org-html-format-headline-function' for details."
2504 (let ((todo (org-html--todo todo info))
2505 (priority (org-html--priority priority info))
2506 (tags (org-html--tags tags info)))
2507 (concat todo (and todo " ")
2508 priority (and priority " ")
2509 text
2510 (and tags "&#xa0;&#xa0;&#xa0;") tags)))
2512 (defun org-html--container (headline info)
2513 (or (org-element-property :HTML_CONTAINER headline)
2514 (if (= 1 (org-export-get-relative-level headline info))
2515 (plist-get info :html-container)
2516 "div")))
2518 ;;;; Horizontal Rule
2520 (defun org-html-horizontal-rule (horizontal-rule contents info)
2521 "Transcode an HORIZONTAL-RULE object from Org to HTML.
2522 CONTENTS is nil. INFO is a plist holding contextual information."
2523 (org-html-close-tag "hr" nil info))
2525 ;;;; Inline Src Block
2527 (defun org-html-inline-src-block (inline-src-block contents info)
2528 "Transcode an INLINE-SRC-BLOCK element from Org to HTML.
2529 CONTENTS holds the contents of the item. INFO is a plist holding
2530 contextual information."
2531 (let ((lang (org-element-property :language inline-src-block))
2532 (code (org-html-format-code inline-src-block info))
2533 (label
2534 (let ((lbl (and (org-element-property :name inline-src-block)
2535 (org-export-get-reference inline-src-block info))))
2536 (if (not lbl) "" (format " id=\"%s\"" lbl)))))
2537 (format "<code class=\"src src-%s\"%s>%s</code>" lang label code)))
2539 ;;;; Inlinetask
2541 (defun org-html-inlinetask (inlinetask contents info)
2542 "Transcode an INLINETASK element from Org to HTML.
2543 CONTENTS holds the contents of the block. INFO is a plist
2544 holding contextual information."
2545 (let* ((todo (and (plist-get info :with-todo-keywords)
2546 (let ((todo (org-element-property :todo-keyword inlinetask)))
2547 (and todo (org-export-data todo info)))))
2548 (todo-type (and todo (org-element-property :todo-type inlinetask)))
2549 (priority (and (plist-get info :with-priority)
2550 (org-element-property :priority inlinetask)))
2551 (text (org-export-data (org-element-property :title inlinetask) info))
2552 (tags (and (plist-get info :with-tags)
2553 (org-export-get-tags inlinetask info))))
2554 (funcall (plist-get info :html-format-inlinetask-function)
2555 todo todo-type priority text tags contents info)))
2557 (defun org-html-format-inlinetask-default-function
2558 (todo todo-type priority text tags contents info)
2559 "Default format function for a inlinetasks.
2560 See `org-html-format-inlinetask-function' for details."
2561 (format "<div class=\"inlinetask\">\n<b>%s</b>%s\n%s</div>"
2562 (org-html-format-headline-default-function
2563 todo todo-type priority text tags info)
2564 (org-html-close-tag "br" nil info)
2565 contents))
2567 ;;;; Italic
2569 (defun org-html-italic (italic contents info)
2570 "Transcode ITALIC from Org to HTML.
2571 CONTENTS is the text with italic markup. INFO is a plist holding
2572 contextual information."
2573 (format
2574 (or (cdr (assq 'italic (plist-get info :html-text-markup-alist))) "%s")
2575 contents))
2577 ;;;; Item
2579 (defun org-html-checkbox (checkbox info)
2580 "Format CHECKBOX into HTML.
2581 INFO is a plist holding contextual information. See
2582 `org-html-checkbox-type' for customization options."
2583 (cdr (assq checkbox
2584 (cdr (assq (plist-get info :html-checkbox-type)
2585 org-html-checkbox-types)))))
2587 (defun org-html-format-list-item (contents type checkbox info
2588 &optional term-counter-id
2589 headline)
2590 "Format a list item into HTML."
2591 (let ((class (if checkbox
2592 (format " class=\"%s\""
2593 (symbol-name checkbox)) ""))
2594 (checkbox (concat (org-html-checkbox checkbox info)
2595 (and checkbox " ")))
2596 (br (org-html-close-tag "br" nil info)))
2597 (concat
2598 (case type
2599 (ordered
2600 (let* ((counter term-counter-id)
2601 (extra (if counter (format " value=\"%s\"" counter) "")))
2602 (concat
2603 (format "<li%s%s>" class extra)
2604 (when headline (concat headline br)))))
2605 (unordered
2606 (let* ((id term-counter-id)
2607 (extra (if id (format " id=\"%s\"" id) "")))
2608 (concat
2609 (format "<li%s%s>" class extra)
2610 (when headline (concat headline br)))))
2611 (descriptive
2612 (let* ((term term-counter-id))
2613 (setq term (or term "(no term)"))
2614 ;; Check-boxes in descriptive lists are associated to tag.
2615 (concat (format "<dt%s>%s</dt>"
2616 class (concat checkbox term))
2617 "<dd>"))))
2618 (unless (eq type 'descriptive) checkbox)
2619 (and contents (org-trim contents))
2620 (case type
2621 (ordered "</li>")
2622 (unordered "</li>")
2623 (descriptive "</dd>")))))
2625 (defun org-html-item (item contents info)
2626 "Transcode an ITEM element from Org to HTML.
2627 CONTENTS holds the contents of the item. INFO is a plist holding
2628 contextual information."
2629 (let* ((plain-list (org-export-get-parent item))
2630 (type (org-element-property :type plain-list))
2631 (counter (org-element-property :counter item))
2632 (checkbox (org-element-property :checkbox item))
2633 (tag (let ((tag (org-element-property :tag item)))
2634 (and tag (org-export-data tag info)))))
2635 (org-html-format-list-item
2636 contents type checkbox info (or tag counter))))
2638 ;;;; Keyword
2640 (defun org-html-keyword (keyword contents info)
2641 "Transcode a KEYWORD element from Org to HTML.
2642 CONTENTS is nil. INFO is a plist holding contextual information."
2643 (let ((key (org-element-property :key keyword))
2644 (value (org-element-property :value keyword)))
2645 (cond
2646 ((string= key "HTML") value)
2647 ((string= key "TOC")
2648 (let ((case-fold-search t))
2649 (cond
2650 ((string-match "\\<headlines\\>" value)
2651 (let ((depth (and (string-match "\\<[0-9]+\\>" value)
2652 (string-to-number (match-string 0 value))))
2653 (localp (org-string-match-p "\\<local\\>" value)))
2654 (org-html-toc depth info (and localp keyword))))
2655 ((string= "listings" value) (org-html-list-of-listings info))
2656 ((string= "tables" value) (org-html-list-of-tables info))))))))
2658 ;;;; Latex Environment
2660 (defun org-html-format-latex (latex-frag processing-type info)
2661 "Format a LaTeX fragment LATEX-FRAG into HTML.
2662 PROCESSING-TYPE designates the tool used for conversion. It is
2663 a symbol among `mathjax', `dvipng', `imagemagick', `verbatim' nil
2664 and t. See `org-html-with-latex' for more information. INFO is
2665 a plist containing export properties."
2666 (let ((cache-relpath "") (cache-dir ""))
2667 (unless (eq processing-type 'mathjax)
2668 (let ((bfn (or (buffer-file-name)
2669 (make-temp-name
2670 (expand-file-name "latex" temporary-file-directory))))
2671 (latex-header
2672 (let ((header (plist-get info :latex-header)))
2673 (and header
2674 (concat (mapconcat
2675 (lambda (line) (concat "#+LATEX_HEADER: " line))
2676 (org-split-string header "\n")
2677 "\n")
2678 "\n")))))
2679 (setq cache-relpath
2680 (concat "ltxpng/"
2681 (file-name-sans-extension
2682 (file-name-nondirectory bfn)))
2683 cache-dir (file-name-directory bfn))
2684 ;; Re-create LaTeX environment from original buffer in
2685 ;; temporary buffer so that dvipng/imagemagick can properly
2686 ;; turn the fragment into an image.
2687 (setq latex-frag (concat latex-header latex-frag))))
2688 (with-temp-buffer
2689 (insert latex-frag)
2690 (org-format-latex cache-relpath cache-dir nil "Creating LaTeX Image..."
2691 nil processing-type)
2692 (buffer-string))))
2694 (defun org-html-latex-environment (latex-environment contents info)
2695 "Transcode a LATEX-ENVIRONMENT element from Org to HTML.
2696 CONTENTS is nil. INFO is a plist holding contextual information."
2697 (let ((processing-type (plist-get info :with-latex))
2698 (latex-frag (org-remove-indentation
2699 (org-element-property :value latex-environment)))
2700 (attributes (org-export-read-attribute :attr_html latex-environment)))
2701 (case processing-type
2702 ((t mathjax)
2703 (org-html-format-latex latex-frag 'mathjax info))
2704 ((dvipng imagemagick)
2705 (let ((formula-link
2706 (org-html-format-latex latex-frag processing-type info)))
2707 (when (and formula-link (string-match "file:\\([^]]*\\)" formula-link))
2708 ;; Do not provide a caption or a name to be consistent with
2709 ;; `mathjax' handling.
2710 (org-html--wrap-image
2711 (org-html--format-image
2712 (match-string 1 formula-link) attributes info) info))))
2713 (t latex-frag))))
2715 ;;;; Latex Fragment
2717 (defun org-html-latex-fragment (latex-fragment contents info)
2718 "Transcode a LATEX-FRAGMENT object from Org to HTML.
2719 CONTENTS is nil. INFO is a plist holding contextual information."
2720 (let ((latex-frag (org-element-property :value latex-fragment))
2721 (processing-type (plist-get info :with-latex)))
2722 (case processing-type
2723 ((t mathjax)
2724 (org-html-format-latex latex-frag 'mathjax info))
2725 ((dvipng imagemagick)
2726 (let ((formula-link
2727 (org-html-format-latex latex-frag processing-type info)))
2728 (when (and formula-link (string-match "file:\\([^]]*\\)" formula-link))
2729 (org-html--format-image (match-string 1 formula-link) nil info))))
2730 (t latex-frag))))
2732 ;;;; Line Break
2734 (defun org-html-line-break (line-break contents info)
2735 "Transcode a LINE-BREAK object from Org to HTML.
2736 CONTENTS is nil. INFO is a plist holding contextual information."
2737 (concat (org-html-close-tag "br" nil info) "\n"))
2739 ;;;; Link
2741 (defun org-html-inline-image-p (link info)
2742 "Non-nil when LINK is meant to appear as an image.
2743 INFO is a plist used as a communication channel. LINK is an
2744 inline image when it has no description and targets an image
2745 file (see `org-html-inline-image-rules' for more information), or
2746 if its description is a single link targeting an image file."
2747 (if (not (org-element-contents link))
2748 (org-export-inline-image-p
2749 link (plist-get info :html-inline-image-rules))
2750 (not
2751 (let ((link-count 0))
2752 (org-element-map (org-element-contents link)
2753 (cons 'plain-text org-element-all-objects)
2754 (lambda (obj)
2755 (case (org-element-type obj)
2756 (plain-text (org-string-nw-p obj))
2757 (link (if (= link-count 1) t
2758 (incf link-count)
2759 (not (org-export-inline-image-p
2760 obj (plist-get info :html-inline-image-rules)))))
2761 (otherwise t)))
2762 info t)))))
2764 (defvar org-html-standalone-image-predicate)
2765 (defun org-html-standalone-image-p (element info)
2766 "Non-nil if ELEMENT is a standalone image.
2768 INFO is a plist holding contextual information.
2770 An element or object is a standalone image when
2772 - its type is `paragraph' and its sole content, save for white
2773 spaces, is a link that qualifies as an inline image;
2775 - its type is `link' and its containing paragraph has no other
2776 content save white spaces.
2778 Bind `org-html-standalone-image-predicate' to constrain paragraph
2779 further. For example, to check for only captioned standalone
2780 images, set it to:
2782 \(lambda (paragraph) (org-element-property :caption paragraph))"
2783 (let ((paragraph (case (org-element-type element)
2784 (paragraph element)
2785 (link (org-export-get-parent element)))))
2786 (and (eq (org-element-type paragraph) 'paragraph)
2787 (or (not (fboundp 'org-html-standalone-image-predicate))
2788 (funcall org-html-standalone-image-predicate paragraph))
2789 (catch 'exit
2790 (let ((link-count 0))
2791 (org-element-map (org-element-contents paragraph)
2792 (cons 'plain-text org-element-all-objects)
2793 #'(lambda (obj)
2794 (when (case (org-element-type obj)
2795 (plain-text (org-string-nw-p obj))
2796 (link (or (> (incf link-count) 1)
2797 (not (org-html-inline-image-p obj info))))
2798 (otherwise t))
2799 (throw 'exit nil)))
2800 info nil 'link)
2801 (= link-count 1))))))
2803 (defun org-html-link (link desc info)
2804 "Transcode a LINK object from Org to HTML.
2805 DESC is the description part of the link, or the empty string.
2806 INFO is a plist holding contextual information. See
2807 `org-export-data'."
2808 (let* ((home (when (plist-get info :html-link-home)
2809 (org-trim (plist-get info :html-link-home))))
2810 (use-abs-url (plist-get info :html-link-use-abs-url))
2811 (link-org-files-as-html-maybe
2812 (function
2813 (lambda (raw-path info)
2814 "Treat links to `file.org' as links to `file.html', if needed.
2815 See `org-html-link-org-files-as-html'."
2816 (cond
2817 ((and (plist-get info :html-link-org-files-as-html)
2818 (string= ".org"
2819 (downcase (file-name-extension raw-path "."))))
2820 (concat (file-name-sans-extension raw-path) "."
2821 (plist-get info :html-extension)))
2822 (t raw-path)))))
2823 (type (org-element-property :type link))
2824 (raw-path (org-element-property :path link))
2825 ;; Ensure DESC really exists, or set it to nil.
2826 (desc (org-string-nw-p desc))
2827 (path
2828 (cond
2829 ((member type '("http" "https" "ftp" "mailto"))
2830 (org-html-encode-plain-text
2831 (org-link-escape-browser
2832 (org-link-unescape (concat type ":" raw-path)))))
2833 ((string= type "file")
2834 ;; Treat links to ".org" files as ".html", if needed.
2835 (setq raw-path
2836 (funcall link-org-files-as-html-maybe raw-path info))
2837 ;; If file path is absolute, prepend it with protocol
2838 ;; component - "file://".
2839 (cond
2840 ((file-name-absolute-p raw-path)
2841 (setq raw-path (org-export-file-uri raw-path)))
2842 ((and home use-abs-url)
2843 (setq raw-path (concat (file-name-as-directory home) raw-path))))
2844 ;; Add search option, if any. A search option can be
2845 ;; relative to a custom-id, a headline title a name,
2846 ;; a target or a radio-target.
2847 (let ((option (org-element-property :search-option link)))
2848 (if (not option) raw-path
2849 (concat raw-path
2851 (org-publish-resolve-external-link
2852 option
2853 (org-element-property :path link))))))
2854 (t raw-path)))
2855 ;; Extract attributes from parent's paragraph. HACK: Only do
2856 ;; this for the first link in parent (inner image link for
2857 ;; inline images). This is needed as long as attributes
2858 ;; cannot be set on a per link basis.
2859 (attributes-plist
2860 (let* ((parent (org-export-get-parent-element link))
2861 (link (let ((container (org-export-get-parent link)))
2862 (if (and (eq (org-element-type container) 'link)
2863 (org-html-inline-image-p link info))
2864 container
2865 link))))
2866 (and (eq (org-element-map parent 'link 'identity info t) link)
2867 (org-export-read-attribute :attr_html parent))))
2868 (attributes
2869 (let ((attr (org-html--make-attribute-string attributes-plist)))
2870 (if (org-string-nw-p attr) (concat " " attr) ""))))
2871 (cond
2872 ;; Link type is handled by a special function.
2873 ((org-export-custom-protocol-maybe link desc 'html))
2874 ;; Image file.
2875 ((and (plist-get info :html-inline-images)
2876 (org-export-inline-image-p
2877 link (plist-get info :html-inline-image-rules)))
2878 (org-html--format-image path attributes-plist info))
2879 ;; Radio target: Transcode target's contents and use them as
2880 ;; link's description.
2881 ((string= type "radio")
2882 (let ((destination (org-export-resolve-radio-link link info)))
2883 (if (not destination) desc
2884 (format "<a href=\"#%s\"%s>%s</a>"
2885 (org-export-get-reference destination info)
2886 attributes
2887 desc))))
2888 ;; Links pointing to a headline: Find destination and build
2889 ;; appropriate referencing command.
2890 ((member type '("custom-id" "fuzzy" "id"))
2891 (let ((destination (if (string= type "fuzzy")
2892 (org-export-resolve-fuzzy-link link info)
2893 (org-export-resolve-id-link link info))))
2894 (case (org-element-type destination)
2895 ;; ID link points to an external file.
2896 (plain-text
2897 (let ((fragment (concat "ID-" path))
2898 ;; Treat links to ".org" files as ".html", if needed.
2899 (path (funcall link-org-files-as-html-maybe
2900 destination info)))
2901 (format "<a href=\"%s#%s\"%s>%s</a>"
2902 path fragment attributes (or desc destination))))
2903 ;; Fuzzy link points nowhere.
2904 ((nil)
2905 (format "<i>%s</i>"
2906 (or desc
2907 (org-export-data
2908 (org-element-property :raw-link link) info))))
2909 ;; Link points to a headline.
2910 (headline
2911 (let ((href (or (org-element-property :CUSTOM_ID destination)
2912 (org-export-get-reference destination info)))
2913 ;; What description to use?
2914 (desc
2915 ;; Case 1: Headline is numbered and LINK has no
2916 ;; description. Display section number.
2917 (if (and (org-export-numbered-headline-p destination info)
2918 (not desc))
2919 (mapconcat #'number-to-string
2920 (org-export-get-headline-number
2921 destination info) ".")
2922 ;; Case 2: Either the headline is un-numbered or
2923 ;; LINK has a custom description. Display LINK's
2924 ;; description or headline's title.
2925 (or desc
2926 (org-export-data
2927 (org-element-property :title destination) info)))))
2928 (format "<a href=\"#%s\"%s>%s</a>" href attributes desc)))
2929 ;; Fuzzy link points to a target or an element.
2931 (let* ((ref (org-export-get-reference destination info))
2932 (org-html-standalone-image-predicate
2933 #'org-html--has-caption-p)
2934 (number (cond
2935 (desc nil)
2936 ((org-html-standalone-image-p destination info)
2937 (org-export-get-ordinal
2938 (org-element-map destination 'link
2939 #'identity info t)
2940 info 'link 'org-html-standalone-image-p))
2941 (t (org-export-get-ordinal
2942 destination info nil 'org-html--has-caption-p))))
2943 (desc (cond (desc)
2944 ((not number) "No description for this link")
2945 ((numberp number) (number-to-string number))
2946 (t (mapconcat #'number-to-string number ".")))))
2947 (format "<a href=\"#%s\"%s>%s</a>" ref attributes desc))))))
2948 ;; Coderef: replace link with the reference name or the
2949 ;; equivalent line number.
2950 ((string= type "coderef")
2951 (let ((fragment (concat "coderef-" path)))
2952 (format "<a href=\"#%s\"%s%s>%s</a>"
2953 fragment
2954 (org-trim
2955 (format (concat "class=\"coderef\""
2956 " onmouseover=\"CodeHighlightOn(this, '%s');\""
2957 " onmouseout=\"CodeHighlightOff(this, '%s');\"")
2958 fragment fragment))
2959 attributes
2960 (format (org-export-get-coderef-format path desc)
2961 (org-export-resolve-coderef path info)))))
2962 ;; External link with a description part.
2963 ((and path desc) (format "<a href=\"%s\"%s>%s</a>" path attributes desc))
2964 ;; External link without a description part.
2965 (path (format "<a href=\"%s\"%s>%s</a>" path attributes path))
2966 ;; No path, only description. Try to do something useful.
2967 (t (format "<i>%s</i>" desc)))))
2969 ;;;; Node Property
2971 (defun org-html-node-property (node-property contents info)
2972 "Transcode a NODE-PROPERTY element from Org to HTML.
2973 CONTENTS is nil. INFO is a plist holding contextual
2974 information."
2975 (format "%s:%s"
2976 (org-element-property :key node-property)
2977 (let ((value (org-element-property :value node-property)))
2978 (if value (concat " " value) ""))))
2980 ;;;; Paragraph
2982 (defun org-html-paragraph (paragraph contents info)
2983 "Transcode a PARAGRAPH element from Org to HTML.
2984 CONTENTS is the contents of the paragraph, as a string. INFO is
2985 the plist used as a communication channel."
2986 (let* ((parent (org-export-get-parent paragraph))
2987 (parent-type (org-element-type parent))
2988 (style '((footnote-definition " class=\"footpara\"")
2989 (org-data " class=\"footpara\"")))
2990 (attributes (org-html--make-attribute-string
2991 (org-export-read-attribute :attr_html paragraph)))
2992 (extra (or (cadr (assq parent-type style)) "")))
2993 (cond
2994 ((and (eq parent-type 'item)
2995 (not (org-export-get-previous-element paragraph info))
2996 (let ((followers (org-export-get-next-element paragraph info 2)))
2997 (and (not (cdr followers))
2998 (memq (org-element-type (car followers)) '(nil plain-list)))))
2999 ;; First paragraph in an item has no tag if it is alone or
3000 ;; followed, at most, by a sub-list.
3001 contents)
3002 ((org-html-standalone-image-p paragraph info)
3003 ;; Standalone image.
3004 (let ((caption
3005 (let ((raw (org-export-data
3006 (org-export-get-caption paragraph) info))
3007 (org-html-standalone-image-predicate
3008 'org-html--has-caption-p))
3009 (if (not (org-string-nw-p raw)) raw
3010 (concat
3011 "<span class=\"figure-number\">"
3012 (format (org-html--translate "Figure %d:" info)
3013 (org-export-get-ordinal
3014 (org-element-map paragraph 'link
3015 'identity info t)
3016 info nil 'org-html-standalone-image-p))
3017 "</span> " raw))))
3018 (label (and (org-element-property :name paragraph)
3019 (org-export-get-reference paragraph info))))
3020 (org-html--wrap-image contents info caption label)))
3021 ;; Regular paragraph.
3022 (t (format "<p%s%s>\n%s</p>"
3023 (if (org-string-nw-p attributes)
3024 (concat " " attributes) "")
3025 extra contents)))))
3027 ;;;; Plain List
3029 ;; FIXME Maybe arg1 is not needed because <li value="20"> already sets
3030 ;; the correct value for the item counter
3031 (defun org-html-begin-plain-list (type &optional arg1)
3032 "Insert the beginning of the HTML list depending on TYPE.
3033 When ARG1 is a string, use it as the start parameter for ordered
3034 lists."
3035 (case type
3036 (ordered
3037 (format "<ol class=\"org-ol\"%s>"
3038 (if arg1 (format " start=\"%d\"" arg1) "")))
3039 (unordered "<ul class=\"org-ul\">")
3040 (descriptive "<dl class=\"org-dl\">")))
3042 (defun org-html-end-plain-list (type)
3043 "Insert the end of the HTML list depending on TYPE."
3044 (case type
3045 (ordered "</ol>")
3046 (unordered "</ul>")
3047 (descriptive "</dl>")))
3049 (defun org-html-plain-list (plain-list contents info)
3050 "Transcode a PLAIN-LIST element from Org to HTML.
3051 CONTENTS is the contents of the list. INFO is a plist holding
3052 contextual information."
3053 (let* (arg1 ;; (assoc :counter (org-element-map plain-list 'item
3054 (type (org-element-property :type plain-list)))
3055 (format "%s\n%s%s"
3056 (org-html-begin-plain-list type)
3057 contents (org-html-end-plain-list type))))
3059 ;;;; Plain Text
3061 (defun org-html-convert-special-strings (string)
3062 "Convert special characters in STRING to HTML."
3063 (let ((all org-html-special-string-regexps)
3064 e a re rpl start)
3065 (while (setq a (pop all))
3066 (setq re (car a) rpl (cdr a) start 0)
3067 (while (string-match re string start)
3068 (setq string (replace-match rpl t nil string))))
3069 string))
3071 (defun org-html-encode-plain-text (text)
3072 "Convert plain text characters from TEXT to HTML equivalent.
3073 Possible conversions are set in `org-html-protect-char-alist'."
3074 (dolist (pair org-html-protect-char-alist text)
3075 (setq text (replace-regexp-in-string (car pair) (cdr pair) text t t))))
3077 (defun org-html-plain-text (text info)
3078 "Transcode a TEXT string from Org to HTML.
3079 TEXT is the string to transcode. INFO is a plist holding
3080 contextual information."
3081 (let ((output text))
3082 ;; Protect following characters: <, >, &.
3083 (setq output (org-html-encode-plain-text output))
3084 ;; Handle smart quotes. Be sure to provide original string since
3085 ;; OUTPUT may have been modified.
3086 (when (plist-get info :with-smart-quotes)
3087 (setq output (org-export-activate-smart-quotes output :html info text)))
3088 ;; Handle special strings.
3089 (when (plist-get info :with-special-strings)
3090 (setq output (org-html-convert-special-strings output)))
3091 ;; Handle break preservation if required.
3092 (when (plist-get info :preserve-breaks)
3093 (setq output
3094 (replace-regexp-in-string
3095 "\\(\\\\\\\\\\)?[ \t]*\n"
3096 (concat (org-html-close-tag "br" nil info) "\n") output)))
3097 ;; Return value.
3098 output))
3101 ;; Planning
3103 (defun org-html-planning (planning contents info)
3104 "Transcode a PLANNING element from Org to HTML.
3105 CONTENTS is nil. INFO is a plist used as a communication
3106 channel."
3107 (let ((span-fmt "<span class=\"timestamp-kwd\">%s</span> <span class=\"timestamp\">%s</span>"))
3108 (format
3109 "<p><span class=\"timestamp-wrapper\">%s</span></p>"
3110 (mapconcat
3111 'identity
3112 (delq nil
3113 (list
3114 (let ((closed (org-element-property :closed planning)))
3115 (when closed
3116 (format span-fmt org-closed-string
3117 (org-timestamp-translate closed))))
3118 (let ((deadline (org-element-property :deadline planning)))
3119 (when deadline
3120 (format span-fmt org-deadline-string
3121 (org-timestamp-translate deadline))))
3122 (let ((scheduled (org-element-property :scheduled planning)))
3123 (when scheduled
3124 (format span-fmt org-scheduled-string
3125 (org-timestamp-translate scheduled))))))
3126 " "))))
3128 ;;;; Property Drawer
3130 (defun org-html-property-drawer (property-drawer contents info)
3131 "Transcode a PROPERTY-DRAWER element from Org to HTML.
3132 CONTENTS holds the contents of the drawer. INFO is a plist
3133 holding contextual information."
3134 (and (org-string-nw-p contents)
3135 (format "<pre class=\"example\">\n%s</pre>" contents)))
3137 ;;;; Quote Block
3139 (defun org-html-quote-block (quote-block contents info)
3140 "Transcode a QUOTE-BLOCK element from Org to HTML.
3141 CONTENTS holds the contents of the block. INFO is a plist
3142 holding contextual information."
3143 (format "<blockquote>\n%s</blockquote>" contents))
3145 ;;;; Section
3147 (defun org-html-section (section contents info)
3148 "Transcode a SECTION element from Org to HTML.
3149 CONTENTS holds the contents of the section. INFO is a plist
3150 holding contextual information."
3151 (let ((parent (org-export-get-parent-headline section)))
3152 ;; Before first headline: no container, just return CONTENTS.
3153 (if (not parent) contents
3154 ;; Get div's class and id references.
3155 (let* ((class-num (+ (org-export-get-relative-level parent info)
3156 (1- (plist-get info :html-toplevel-hlevel))))
3157 (section-number
3158 (and (org-export-numbered-headline-p parent info)
3159 (mapconcat
3160 #'number-to-string
3161 (org-export-get-headline-number parent info) "-"))))
3162 ;; Build return value.
3163 (format "<div class=\"outline-text-%d\" id=\"text-%s\">\n%s</div>"
3164 class-num
3165 (or (org-element-property :CUSTOM_ID parent)
3166 section-number
3167 (org-export-get-reference parent info))
3168 (or contents ""))))))
3170 ;;;; Radio Target
3172 (defun org-html-radio-target (radio-target text info)
3173 "Transcode a RADIO-TARGET object from Org to HTML.
3174 TEXT is the text of the target. INFO is a plist holding
3175 contextual information."
3176 (let ((ref (org-export-get-reference radio-target info)))
3177 (org-html--anchor ref text nil info)))
3179 ;;;; Special Block
3181 (defun org-html-special-block (special-block contents info)
3182 "Transcode a SPECIAL-BLOCK element from Org to HTML.
3183 CONTENTS holds the contents of the block. INFO is a plist
3184 holding contextual information."
3185 (let* ((block-type (org-element-property :type special-block))
3186 (contents (or contents ""))
3187 (html5-fancy (and (org-html-html5-p info)
3188 (plist-get info :html-html5-fancy)
3189 (member block-type org-html-html5-elements)))
3190 (attributes (org-export-read-attribute :attr_html special-block)))
3191 (unless html5-fancy
3192 (let ((class (plist-get attributes :class)))
3193 (setq attributes (plist-put attributes :class
3194 (if class (concat class " " block-type)
3195 block-type)))))
3196 (setq attributes (org-html--make-attribute-string attributes))
3197 (when (not (equal attributes ""))
3198 (setq attributes (concat " " attributes)))
3199 (if html5-fancy
3200 (format "<%s%s>\n%s</%s>" block-type attributes
3201 contents block-type)
3202 (format "<div%s>\n%s\n</div>" attributes contents))))
3204 ;;;; Src Block
3206 (defun org-html-src-block (src-block contents info)
3207 "Transcode a SRC-BLOCK element from Org to HTML.
3208 CONTENTS holds the contents of the item. INFO is a plist holding
3209 contextual information."
3210 (if (org-export-read-attribute :attr_html src-block :textarea)
3211 (org-html--textarea-block src-block)
3212 (let ((lang (org-element-property :language src-block))
3213 (caption (org-export-get-caption src-block))
3214 (code (org-html-format-code src-block info))
3215 (label (let ((lbl (and (org-element-property :name src-block)
3216 (org-export-get-reference src-block info))))
3217 (if lbl (format " id=\"%s\"" lbl) ""))))
3218 (if (not lang) (format "<pre class=\"example\"%s>\n%s</pre>" label code)
3219 (format
3220 "<div class=\"org-src-container\">\n%s%s\n</div>"
3221 (if (not caption) ""
3222 (format "<label class=\"org-src-name\">%s</label>"
3223 (org-export-data caption info)))
3224 (format "\n<pre class=\"src src-%s\"%s>%s</pre>" lang label code))))))
3226 ;;;; Statistics Cookie
3228 (defun org-html-statistics-cookie (statistics-cookie contents info)
3229 "Transcode a STATISTICS-COOKIE object from Org to HTML.
3230 CONTENTS is nil. INFO is a plist holding contextual information."
3231 (let ((cookie-value (org-element-property :value statistics-cookie)))
3232 (format "<code>%s</code>" cookie-value)))
3234 ;;;; Strike-Through
3236 (defun org-html-strike-through (strike-through contents info)
3237 "Transcode STRIKE-THROUGH from Org to HTML.
3238 CONTENTS is the text with strike-through markup. INFO is a plist
3239 holding contextual information."
3240 (format
3241 (or (cdr (assq 'strike-through (plist-get info :html-text-markup-alist)))
3242 "%s")
3243 contents))
3245 ;;;; Subscript
3247 (defun org-html-subscript (subscript contents info)
3248 "Transcode a SUBSCRIPT object from Org to HTML.
3249 CONTENTS is the contents of the object. INFO is a plist holding
3250 contextual information."
3251 (format "<sub>%s</sub>" contents))
3253 ;;;; Superscript
3255 (defun org-html-superscript (superscript contents info)
3256 "Transcode a SUPERSCRIPT object from Org to HTML.
3257 CONTENTS is the contents of the object. INFO is a plist holding
3258 contextual information."
3259 (format "<sup>%s</sup>" contents))
3261 ;;;; Table Cell
3263 (defun org-html-table-cell (table-cell contents info)
3264 "Transcode a TABLE-CELL element from Org to HTML.
3265 CONTENTS is nil. INFO is a plist used as a communication
3266 channel."
3267 (let* ((table-row (org-export-get-parent table-cell))
3268 (table (org-export-get-parent-table table-cell))
3269 (cell-attrs
3270 (if (not (plist-get info :html-table-align-individual-fields)) ""
3271 (format (if (and (boundp 'org-html-format-table-no-css)
3272 org-html-format-table-no-css)
3273 " align=\"%s\"" " class=\"org-%s\"")
3274 (org-export-table-cell-alignment table-cell info)))))
3275 (when (or (not contents) (string= "" (org-trim contents)))
3276 (setq contents "&#xa0;"))
3277 (cond
3278 ((and (org-export-table-has-header-p table info)
3279 (= 1 (org-export-table-row-group table-row info)))
3280 (let ((header-tags (plist-get info :html-table-header-tags)))
3281 (concat "\n" (format (car header-tags) "col" cell-attrs)
3282 contents
3283 (cdr header-tags))))
3284 ((and (plist-get info :html-table-use-header-tags-for-first-column)
3285 (zerop (cdr (org-export-table-cell-address table-cell info))))
3286 (let ((header-tags (plist-get info :html-table-header-tags)))
3287 (concat "\n" (format (car header-tags) "row" cell-attrs)
3288 contents
3289 (cdr header-tags))))
3290 (t (let ((data-tags (plist-get info :html-table-data-tags)))
3291 (concat "\n" (format (car data-tags) cell-attrs)
3292 contents
3293 (cdr data-tags)))))))
3295 ;;;; Table Row
3297 (defun org-html-table-row (table-row contents info)
3298 "Transcode a TABLE-ROW element from Org to HTML.
3299 CONTENTS is the contents of the row. INFO is a plist used as a
3300 communication channel."
3301 ;; Rules are ignored since table separators are deduced from
3302 ;; borders of the current row.
3303 (when (eq (org-element-property :type table-row) 'standard)
3304 (let* ((rowgroup-number (org-export-table-row-group table-row info))
3305 (row-number (org-export-table-row-number table-row info))
3306 (start-rowgroup-p
3307 (org-export-table-row-starts-rowgroup-p table-row info))
3308 (end-rowgroup-p
3309 (org-export-table-row-ends-rowgroup-p table-row info))
3310 ;; `top-row-p' and `end-rowgroup-p' are not used directly
3311 ;; but should be set so that `org-html-table-row-tags' can
3312 ;; use them (see the docstring of this variable.)
3313 (top-row-p (and (equal start-rowgroup-p '(top))
3314 (equal end-rowgroup-p '(below top))))
3315 (bottom-row-p (and (equal start-rowgroup-p '(above))
3316 (equal end-rowgroup-p '(bottom above))))
3317 (rowgroup-tags
3318 (cond
3319 ;; Case 1: Row belongs to second or subsequent rowgroups.
3320 ((not (= 1 rowgroup-number))
3321 '("<tbody>" . "\n</tbody>"))
3322 ;; Case 2: Row is from first rowgroup. Table has >=1 rowgroups.
3323 ((org-export-table-has-header-p
3324 (org-export-get-parent-table table-row) info)
3325 '("<thead>" . "\n</thead>"))
3326 ;; Case 2: Row is from first and only row group.
3327 (t '("<tbody>" . "\n</tbody>")))))
3328 (concat
3329 ;; Begin a rowgroup?
3330 (when start-rowgroup-p (car rowgroup-tags))
3331 ;; Actual table row
3332 (concat "\n" (eval (car (plist-get info :html-table-row-tags)))
3333 contents
3334 "\n"
3335 (eval (cdr (plist-get info :html-table-row-tags))))
3336 ;; End a rowgroup?
3337 (when end-rowgroup-p (cdr rowgroup-tags))))))
3339 ;;;; Table
3341 (defun org-html-table-first-row-data-cells (table info)
3342 "Transcode the first row of TABLE.
3343 INFO is a plist used as a communication channel."
3344 (let ((table-row
3345 (org-element-map table 'table-row
3346 (lambda (row)
3347 (unless (eq (org-element-property :type row) 'rule) row))
3348 info 'first-match))
3349 (special-column-p (org-export-table-has-special-column-p table)))
3350 (if (not special-column-p) (org-element-contents table-row)
3351 (cdr (org-element-contents table-row)))))
3353 (defun org-html-table--table.el-table (table info)
3354 "Format table.el tables into HTML.
3355 INFO is a plist used as a communication channel."
3356 (when (eq (org-element-property :type table) 'table.el)
3357 (require 'table)
3358 (let ((outbuf (with-current-buffer
3359 (get-buffer-create "*org-export-table*")
3360 (erase-buffer) (current-buffer))))
3361 (with-temp-buffer
3362 (insert (org-element-property :value table))
3363 (goto-char 1)
3364 (re-search-forward "^[ \t]*|[^|]" nil t)
3365 (table-generate-source 'html outbuf))
3366 (with-current-buffer outbuf
3367 (prog1 (org-trim (buffer-string))
3368 (kill-buffer) )))))
3370 (defun org-html-table (table contents info)
3371 "Transcode a TABLE element from Org to HTML.
3372 CONTENTS is the contents of the table. INFO is a plist holding
3373 contextual information."
3374 (case (org-element-property :type table)
3375 ;; Case 1: table.el table. Convert it using appropriate tools.
3376 (table.el (org-html-table--table.el-table table info))
3377 ;; Case 2: Standard table.
3379 (let* ((caption (org-export-get-caption table))
3380 (number (org-export-get-ordinal
3381 table info nil #'org-html--has-caption-p))
3382 (attributes
3383 (org-html--make-attribute-string
3384 (org-combine-plists
3385 (and (org-element-property :name table)
3386 (list :id (org-export-get-reference table info)))
3387 (and (not (org-html-html5-p info))
3388 (plist-get info :html-table-attributes))
3389 (org-export-read-attribute :attr_html table))))
3390 (alignspec
3391 (if (and (boundp 'org-html-format-table-no-css)
3392 org-html-format-table-no-css)
3393 "align=\"%s\"" "class=\"org-%s\""))
3394 (table-column-specs
3395 (function
3396 (lambda (table info)
3397 (mapconcat
3398 (lambda (table-cell)
3399 (let ((alignment (org-export-table-cell-alignment
3400 table-cell info)))
3401 (concat
3402 ;; Begin a colgroup?
3403 (when (org-export-table-cell-starts-colgroup-p
3404 table-cell info)
3405 "\n<colgroup>")
3406 ;; Add a column. Also specify it's alignment.
3407 (format "\n%s"
3408 (org-html-close-tag
3409 "col" (concat " " (format alignspec alignment)) info))
3410 ;; End a colgroup?
3411 (when (org-export-table-cell-ends-colgroup-p
3412 table-cell info)
3413 "\n</colgroup>"))))
3414 (org-html-table-first-row-data-cells table info) "\n")))))
3415 (format "<table%s>\n%s\n%s\n%s</table>"
3416 (if (equal attributes "") "" (concat " " attributes))
3417 (if (not caption) ""
3418 (format (if (plist-get info :html-table-caption-above)
3419 "<caption class=\"t-above\">%s</caption>"
3420 "<caption class=\"t-bottom\">%s</caption>")
3421 (concat
3422 "<span class=\"table-number\">"
3423 (format (org-html--translate "Table %d:" info) number)
3424 "</span> " (org-export-data caption info))))
3425 (funcall table-column-specs table info)
3426 contents)))))
3428 ;;;; Target
3430 (defun org-html-target (target contents info)
3431 "Transcode a TARGET object from Org to HTML.
3432 CONTENTS is nil. INFO is a plist holding contextual
3433 information."
3434 (let ((ref (org-export-get-reference target info)))
3435 (org-html--anchor ref nil nil info)))
3437 ;;;; Timestamp
3439 (defun org-html-timestamp (timestamp contents info)
3440 "Transcode a TIMESTAMP object from Org to HTML.
3441 CONTENTS is nil. INFO is a plist holding contextual
3442 information."
3443 (let ((value (org-html-plain-text (org-timestamp-translate timestamp) info)))
3444 (format "<span class=\"timestamp-wrapper\"><span class=\"timestamp\">%s</span></span>"
3445 (replace-regexp-in-string "--" "&#x2013;" value))))
3447 ;;;; Underline
3449 (defun org-html-underline (underline contents info)
3450 "Transcode UNDERLINE from Org to HTML.
3451 CONTENTS is the text with underline markup. INFO is a plist
3452 holding contextual information."
3453 (format (or (cdr (assq 'underline (plist-get info :html-text-markup-alist)))
3454 "%s")
3455 contents))
3457 ;;;; Verbatim
3459 (defun org-html-verbatim (verbatim contents info)
3460 "Transcode VERBATIM from Org to HTML.
3461 CONTENTS is nil. INFO is a plist holding contextual
3462 information."
3463 (format (or (cdr (assq 'verbatim (plist-get info :html-text-markup-alist))) "%s")
3464 (org-html-encode-plain-text (org-element-property :value verbatim))))
3466 ;;;; Verse Block
3468 (defun org-html-verse-block (verse-block contents info)
3469 "Transcode a VERSE-BLOCK element from Org to HTML.
3470 CONTENTS is verse block contents. INFO is a plist holding
3471 contextual information."
3472 ;; Replace each newline character with line break. Also replace
3473 ;; each blank line with a line break.
3474 (setq contents (replace-regexp-in-string
3475 "^ *\\\\\\\\$" (format "%s\n" (org-html-close-tag "br" nil info))
3476 (replace-regexp-in-string
3477 "\\(\\\\\\\\\\)?[ \t]*\n"
3478 (format "%s\n" (org-html-close-tag "br" nil info)) contents)))
3479 ;; Replace each white space at beginning of a line with a
3480 ;; non-breaking space.
3481 (while (string-match "^[ \t]+" contents)
3482 (let* ((num-ws (length (match-string 0 contents)))
3483 (ws (let (out) (dotimes (i num-ws out)
3484 (setq out (concat out "&#xa0;"))))))
3485 (setq contents (replace-match ws nil t contents))))
3486 (format "<p class=\"verse\">\n%s</p>" contents))
3489 ;;; Filter Functions
3491 (defun org-html-final-function (contents backend info)
3492 "Filter to indent the HTML and convert HTML entities."
3493 (with-temp-buffer
3494 (insert contents)
3495 (set-auto-mode t)
3496 (if (plist-get info :html-indent)
3497 (indent-region (point-min) (point-max)))
3498 (when (plist-get info :html-use-unicode-chars)
3499 (require 'mm-url)
3500 (mm-url-decode-entities))
3501 (buffer-substring-no-properties (point-min) (point-max))))
3504 ;;; End-user functions
3506 ;;;###autoload
3507 (defun org-html-export-as-html
3508 (&optional async subtreep visible-only body-only ext-plist)
3509 "Export current buffer to an HTML buffer.
3511 If narrowing is active in the current buffer, only export its
3512 narrowed part.
3514 If a region is active, export that region.
3516 A non-nil optional argument ASYNC means the process should happen
3517 asynchronously. The resulting buffer should be accessible
3518 through the `org-export-stack' interface.
3520 When optional argument SUBTREEP is non-nil, export the sub-tree
3521 at point, extracting information from the headline properties
3522 first.
3524 When optional argument VISIBLE-ONLY is non-nil, don't export
3525 contents of hidden elements.
3527 When optional argument BODY-ONLY is non-nil, only write code
3528 between \"<body>\" and \"</body>\" tags.
3530 EXT-PLIST, when provided, is a property list with external
3531 parameters overriding Org default settings, but still inferior to
3532 file-local settings.
3534 Export is done in a buffer named \"*Org HTML Export*\", which
3535 will be displayed when `org-export-show-temporary-export-buffer'
3536 is non-nil."
3537 (interactive)
3538 (org-export-to-buffer 'html "*Org HTML Export*"
3539 async subtreep visible-only body-only ext-plist
3540 (lambda () (set-auto-mode t))))
3542 ;;;###autoload
3543 (defun org-html-convert-region-to-html ()
3544 "Assume the current region has org-mode syntax, and convert it to HTML.
3545 This can be used in any buffer. For example, you can write an
3546 itemized list in org-mode syntax in an HTML buffer and use this
3547 command to convert it."
3548 (interactive)
3549 (org-export-replace-region-by 'html))
3551 ;;;###autoload
3552 (defun org-html-export-to-html
3553 (&optional async subtreep visible-only body-only ext-plist)
3554 "Export current buffer to a HTML file.
3556 If narrowing is active in the current buffer, only export its
3557 narrowed part.
3559 If a region is active, export that region.
3561 A non-nil optional argument ASYNC means the process should happen
3562 asynchronously. The resulting file should be accessible through
3563 the `org-export-stack' interface.
3565 When optional argument SUBTREEP is non-nil, export the sub-tree
3566 at point, extracting information from the headline properties
3567 first.
3569 When optional argument VISIBLE-ONLY is non-nil, don't export
3570 contents of hidden elements.
3572 When optional argument BODY-ONLY is non-nil, only write code
3573 between \"<body>\" and \"</body>\" tags.
3575 EXT-PLIST, when provided, is a property list with external
3576 parameters overriding Org default settings, but still inferior to
3577 file-local settings.
3579 Return output file's name."
3580 (interactive)
3581 (let* ((extension (concat "." (or (plist-get ext-plist :html-extension)
3582 org-html-extension
3583 "html")))
3584 (file (org-export-output-file-name extension subtreep))
3585 (org-export-coding-system org-html-coding-system))
3586 (org-export-to-file 'html file
3587 async subtreep visible-only body-only ext-plist)))
3589 ;;;###autoload
3590 (defun org-html-publish-to-html (plist filename pub-dir)
3591 "Publish an org file to HTML.
3593 FILENAME is the filename of the Org file to be published. PLIST
3594 is the property list for the given project. PUB-DIR is the
3595 publishing directory.
3597 Return output file name."
3598 (org-publish-org-to 'html filename
3599 (concat "." (or (plist-get plist :html-extension)
3600 org-html-extension
3601 "html"))
3602 plist pub-dir))
3605 (provide 'ox-html)
3607 ;; Local variables:
3608 ;; generated-autoload-file: "org-loaddefs.el"
3609 ;; End:
3611 ;;; ox-html.el ends here