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