1 ;;; ox-html.el --- HTML Back-End for Org Export Engine
3 ;; Copyright (C) 2011-2014 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Jambunathan K <kjambunathan at gmail dot com>
7 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; This library implements a HTML back-end for Org generic exporter.
27 ;; See Org manual for more information.
35 (require 'format-spec
)
36 (eval-when-compile (require 'cl
) (require 'table nil
'noerror
))
39 ;;; Function Declarations
41 (declare-function org-id-find-id-file
"org-id" (id))
42 (declare-function htmlize-region
"ext:htmlize" (beg end
))
43 (declare-function org-pop-to-buffer-same-window
44 "org-compat" (&optional buffer-or-name norecord label
))
45 (declare-function mm-url-decode-entities
"mm-url" ())
49 (org-export-define-backend 'html
50 '((bold . org-html-bold
)
51 (center-block . org-html-center-block
)
52 (clock . org-html-clock
)
53 (code . org-html-code
)
54 (drawer . org-html-drawer
)
55 (dynamic-block . org-html-dynamic-block
)
56 (entity . org-html-entity
)
57 (example-block . org-html-example-block
)
58 (export-block . org-html-export-block
)
59 (export-snippet . org-html-export-snippet
)
60 (fixed-width . org-html-fixed-width
)
61 (footnote-definition . org-html-footnote-definition
)
62 (footnote-reference . org-html-footnote-reference
)
63 (headline . org-html-headline
)
64 (horizontal-rule . org-html-horizontal-rule
)
65 (inline-src-block . org-html-inline-src-block
)
66 (inlinetask . org-html-inlinetask
)
67 (inner-template . org-html-inner-template
)
68 (italic . org-html-italic
)
69 (item . org-html-item
)
70 (keyword . org-html-keyword
)
71 (latex-environment . org-html-latex-environment
)
72 (latex-fragment . org-html-latex-fragment
)
73 (line-break . org-html-line-break
)
74 (link . org-html-link
)
75 (node-property . org-html-node-property
)
76 (paragraph . org-html-paragraph
)
77 (plain-list . org-html-plain-list
)
78 (plain-text . org-html-plain-text
)
79 (planning . org-html-planning
)
80 (property-drawer . org-html-property-drawer
)
81 (quote-block . org-html-quote-block
)
82 (quote-section . org-html-quote-section
)
83 (radio-target . org-html-radio-target
)
84 (section . org-html-section
)
85 (special-block . org-html-special-block
)
86 (src-block . org-html-src-block
)
87 (statistics-cookie . org-html-statistics-cookie
)
88 (strike-through . org-html-strike-through
)
89 (subscript . org-html-subscript
)
90 (superscript . org-html-superscript
)
91 (table . org-html-table
)
92 (table-cell . org-html-table-cell
)
93 (table-row . org-html-table-row
)
94 (target . org-html-target
)
95 (template . org-html-template
)
96 (timestamp . org-html-timestamp
)
97 (underline . org-html-underline
)
98 (verbatim . org-html-verbatim
)
99 (verse-block . org-html-verse-block
))
101 :filters-alist
'((:filter-options . org-html-infojs-install-script
)
102 (:filter-final-output . org-html-final-function
))
104 '(?h
"Export to HTML"
105 ((?H
"As HTML buffer" org-html-export-as-html
)
106 (?h
"As HTML file" org-html-export-to-html
)
107 (?o
"As HTML file and open"
109 (if a
(org-html-export-to-html t s v b
)
110 (org-open-file (org-html-export-to-html nil s v b
)))))))
112 '((:creator
"CREATOR" nil org-html-creator-string
)
113 (:html-doctype
"HTML_DOCTYPE" nil org-html-doctype
)
114 (:html-link-home
"HTML_LINK_HOME" nil org-html-link-home
)
115 (:html-link-up
"HTML_LINK_UP" nil org-html-link-up
)
116 (:html-head
"HTML_HEAD" nil org-html-head newline
)
117 (:html-head-extra
"HTML_HEAD_EXTRA" nil org-html-head-extra newline
)
118 (:html-container
"HTML_CONTAINER" nil org-html-container-element
)
119 (:html-mathjax
"HTML_MATHJAX" nil
"" space
)
120 (:infojs-opt
"INFOJS_OPT" nil nil
)
121 ;; Retrieve LaTeX header for fragments.
122 (:latex-header
"LATEX_HEADER" nil nil newline
)
123 (:html-extension nil nil org-html-extension
)
124 (:html-link-org-as-html nil nil org-html-link-org-files-as-html
)
125 (:html-html5-fancy nil
"html5-fancy" org-html-html5-fancy
)
126 (:html-link-use-abs-url nil
"html-link-use-abs-url" org-html-link-use-abs-url
)
127 (:html-postamble nil
"html-postamble" org-html-postamble
)
128 (:html-preamble nil
"html-preamble" org-html-preamble
)
129 (:html-head-include-default-style nil
"html-style" org-html-head-include-default-style
)
130 (:html-head-include-scripts nil
"html-scripts" org-html-head-include-scripts
)
131 (:html-table-attributes nil nil org-html-table-default-attributes
)
132 (:html-table-row-tags nil nil org-html-table-row-tags
)
133 (:html-xml-declaration nil nil org-html-xml-declaration
)
134 (:html-inline-images nil nil org-html-inline-images
)
135 (:with-latex nil
"tex" org-html-with-latex
)))
138 ;;; Internal Variables
140 (defvar org-html-format-table-no-css
)
141 (defvar htmlize-buffer-places
) ; from htmlize.el
143 (defvar org-html--pre
/postamble-class
"status"
144 "CSS class used for pre/postamble")
146 (defconst org-html-doctype-alist
147 '(("html4-strict" .
"<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"
148 \"http://www.w3.org/TR/html4/strict.dtd\">")
149 ("html4-transitional" .
"<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\"
150 \"http://www.w3.org/TR/html4/loose.dtd\">")
151 ("html4-frameset" .
"<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Frameset//EN\"
152 \"http://www.w3.org/TR/html4/frameset.dtd\">")
154 ("xhtml-strict" .
"<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
155 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">")
156 ("xhtml-transitional" .
"<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"
157 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">")
158 ("xhtml-frameset" .
"<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Frameset//EN\"
159 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd\">")
160 ("xhtml-11" .
"<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\"
161 \"http://www.w3.org/TR/xhtml1/DTD/xhtml11.dtd\">")
163 ("html5" .
"<!DOCTYPE html>")
164 ("xhtml5" .
"<!DOCTYPE html>"))
165 "An alist mapping (x)html flavors to specific doctypes.")
167 (defconst org-html-html5-elements
168 '("article" "aside" "audio" "canvas" "details" "figcaption"
169 "figure" "footer" "header" "menu" "meter" "nav" "output"
170 "progress" "section" "video")
171 "New elements in html5.
173 <hgroup> is not included because it's currently impossible to
174 wrap special blocks around multiple headlines. For other blocks
175 that should contain headlines, use the HTML_CONTAINER property on
176 the headline itself.")
178 (defconst org-html-special-string-regexps
179 '(("\\\\-" .
"­") ; shy
180 ("---\\([^-]\\)" .
"—\\1") ; mdash
181 ("--\\([^-]\\)" .
"–\\1") ; ndash
182 ("\\.\\.\\." .
"…")) ; hellip
183 "Regular expressions for special string conversion.")
185 (defconst org-html-scripts
186 "<script type=\"text/javascript\">
188 @licstart The following is the entire license notice for the
189 JavaScript code in this tag.
191 Copyright (C) 2012-2013 Free Software Foundation, Inc.
193 The JavaScript code in this tag is free software: you can
194 redistribute it and/or modify it under the terms of the GNU
195 General Public License (GNU GPL) as published by the Free Software
196 Foundation, either version 3 of the License, or (at your option)
197 any later version. The code is distributed WITHOUT ANY WARRANTY;
198 without even the implied warranty of MERCHANTABILITY or FITNESS
199 FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
201 As additional permission under GNU GPL version 3 section 7, you
202 may distribute non-source (e.g., minimized or compacted) forms of
203 that code without the copy of the GNU GPL normally required by
204 section 4, provided you include this license notice and a URL
205 through which recipients can access the Corresponding Source.
208 @licend The above is the entire license notice
209 for the JavaScript code in this tag.
211 <!--/*--><![CDATA[/*><!--*/
212 function CodeHighlightOn(elem, id)
214 var target = document.getElementById(id);
216 elem.cacheClassElem = elem.className;
217 elem.cacheClassTarget = target.className;
218 target.className = \"code-highlighted\";
219 elem.className = \"code-highlighted\";
222 function CodeHighlightOff(elem, id)
224 var target = document.getElementById(id);
225 if(elem.cacheClassElem)
226 elem.className = elem.cacheClassElem;
227 if(elem.cacheClassTarget)
228 target.className = elem.cacheClassTarget;
232 "Basic JavaScript that is needed by HTML files produced by Org mode.")
234 (defconst org-html-style-default
235 "<style type=\"text/css\">
236 <!--/*--><![CDATA[/*><!--*/
237 .title { text-align: center; }
238 .todo { font-family: monospace; color: red; }
239 .done { color: green; }
240 .tag { background-color: #eee; font-family: monospace;
241 padding: 2px; font-size: 80%; font-weight: normal; }
242 .timestamp { color: #bebebe; }
243 .timestamp-kwd { color: #5f9ea0; }
244 .right { margin-left: auto; margin-right: 0px; text-align: right; }
245 .left { margin-left: 0px; margin-right: auto; text-align: left; }
246 .center { margin-left: auto; margin-right: auto; text-align: center; }
247 .underline { text-decoration: underline; }
248 #postamble p, #preamble p { font-size: 90%; margin: .2em; }
249 p.verse { margin-left: 3%; }
251 border: 1px solid #ccc;
252 box-shadow: 3px 3px 3px #eee;
254 font-family: monospace;
266 background-color: white;
270 border: 1px solid black;
272 pre.src:hover:before { display: inline;}
273 pre.src-sh:before { content: 'sh'; }
274 pre.src-bash:before { content: 'sh'; }
275 pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
276 pre.src-R:before { content: 'R'; }
277 pre.src-perl:before { content: 'Perl'; }
278 pre.src-java:before { content: 'Java'; }
279 pre.src-sql:before { content: 'SQL'; }
281 table { border-collapse:collapse; }
282 caption.t-above { caption-side: top; }
283 caption.t-bottom { caption-side: bottom; }
284 td, th { vertical-align:top; }
285 th.right { text-align: center; }
286 th.left { text-align: center; }
287 th.center { text-align: center; }
288 td.right { text-align: right; }
289 td.left { text-align: left; }
290 td.center { text-align: center; }
291 dt { font-weight: bold; }
292 .footpara:nth-child(2) { display: inline; }
293 .footpara { display: block; }
294 .footdef { margin-bottom: 1em; }
295 .figure { padding: 1em; }
296 .figure p { text-align: center; }
299 border: 2px solid gray;
304 { text-align: right; font-size: 70%; white-space: nowrap; }
305 textarea { overflow-x: auto; }
306 .linenr { font-size: smaller }
307 .code-highlighted { background-color: #ffff00; }
308 .org-info-js_info-navigation { border-style: none; }
309 #org-info-js_console-label
310 { font-size: 10px; font-weight: bold; white-space: nowrap; }
311 .org-info-js_search-highlight
312 { background-color: #ffff00; color: #000000; font-weight: bold; }
315 "The default style specification for exported HTML files.
316 You can use `org-html-head' and `org-html-head-extra' to add to
317 this style. If you don't want to include this default style,
318 customize `org-html-head-include-default-style'.")
321 ;;; User Configuration Variables
323 (defgroup org-export-html nil
324 "Options for exporting Org mode files to HTML."
325 :tag
"Org Export HTML"
330 (defvar org-html-infojs-opts-table
331 '((path PATH
"http://orgmode.org/org-info.js")
335 (tdepth TOC_DEPTH
"max")
336 (sdepth SECTION_DEPTH
"max")
337 (mouse MOUSE_HINT
"underline")
338 (buttons VIEW_BUTTONS
"0")
340 (up LINK_UP
:html-link-up
)
341 (home LINK_HOME
:html-link-home
))
342 "JavaScript options, long form for script, default values.")
344 (defcustom org-html-use-infojs
'when-configured
345 "Non-nil when Sebastian Rose's Java Script org-info.js should be active.
346 This option can be nil or t to never or always use the script.
347 It can also be the symbol `when-configured', meaning that the
348 script will be linked into the export file if and only if there
349 is a \"#+INFOJS_OPT:\" line in the buffer. See also the variable
350 `org-html-infojs-options'."
351 :group
'org-export-html
353 :package-version
'(Org .
"8.0")
355 (const :tag
"Never" nil
)
356 (const :tag
"When configured in buffer" when-configured
)
357 (const :tag
"Always" t
)))
359 (defcustom org-html-infojs-options
360 (mapcar (lambda (x) (cons (car x
) (nth 2 x
))) org-html-infojs-opts-table
)
361 "Options settings for the INFOJS JavaScript.
362 Each of the options must have an entry in `org-html-infojs-opts-table'.
363 The value can either be a string that will be passed to the script, or
364 a property. This property is then assumed to be a property that is defined
365 by the Export/Publishing setup of Org.
366 The `sdepth' and `tdepth' parameters can also be set to \"max\", which
367 means to use the maximum value consistent with other options."
368 :group
'org-export-html
370 :package-version
'(Org .
"8.0")
372 `(set :greedy t
:inline t
375 (list 'cons
(list 'const
(car x
))
377 (symbol :tag
"Publishing/Export property")
378 (string :tag
"Value"))))
379 org-html-infojs-opts-table
)))
381 (defcustom org-html-infojs-template
382 "<script type=\"text/javascript\" src=\"%SCRIPT_PATH\">
385 * @source: %SCRIPT_PATH
387 * @licstart The following is the entire license notice for the
388 * JavaScript code in %SCRIPT_PATH.
390 * Copyright (C) 2012-2013 Free Software Foundation, Inc.
393 * The JavaScript code in this tag is free software: you can
394 * redistribute it and/or modify it under the terms of the GNU
395 * General Public License (GNU GPL) as published by the Free Software
396 * Foundation, either version 3 of the License, or (at your option)
397 * any later version. The code is distributed WITHOUT ANY WARRANTY;
398 * without even the implied warranty of MERCHANTABILITY or FITNESS
399 * FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
401 * As additional permission under GNU GPL version 3 section 7, you
402 * may distribute non-source (e.g., minimized or compacted) forms of
403 * that code without the copy of the GNU GPL normally required by
404 * section 4, provided you include this license notice and a URL
405 * through which recipients can access the Corresponding Source.
407 * @licend The above is the entire license notice
408 * for the JavaScript code in %SCRIPT_PATH.
413 <script type=\"text/javascript\">
416 @licstart The following is the entire license notice for the
417 JavaScript code in this tag.
419 Copyright (C) 2012-2013 Free Software Foundation, Inc.
421 The JavaScript code in this tag is free software: you can
422 redistribute it and/or modify it under the terms of the GNU
423 General Public License (GNU GPL) as published by the Free Software
424 Foundation, either version 3 of the License, or (at your option)
425 any later version. The code is distributed WITHOUT ANY WARRANTY;
426 without even the implied warranty of MERCHANTABILITY or FITNESS
427 FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
429 As additional permission under GNU GPL version 3 section 7, you
430 may distribute non-source (e.g., minimized or compacted) forms of
431 that code without the copy of the GNU GPL normally required by
432 section 4, provided you include this license notice and a URL
433 through which recipients can access the Corresponding Source.
436 @licend The above is the entire license notice
437 for the JavaScript code in this tag.
440 <!--/*--><![CDATA[/*><!--*/
442 org_html_manager.setup(); // activate after the parameters are set
445 "The template for the export style additions when org-info.js is used.
446 Option settings will replace the %MANAGER-OPTIONS cookie."
447 :group
'org-export-html
449 :package-version
'(Org .
"8.0")
452 (defun org-html-infojs-install-script (exp-plist backend
)
453 "Install script in export options when appropriate.
454 EXP-PLIST is a plist containing export options. BACKEND is the
455 export back-end currently used."
456 (unless (or (memq 'body-only
(plist-get exp-plist
:export-options
))
457 (not org-html-use-infojs
)
458 (and (eq org-html-use-infojs
'when-configured
)
459 (or (not (plist-get exp-plist
:infojs-opt
))
460 (string-match "\\<view:nil\\>"
461 (plist-get exp-plist
:infojs-opt
)))))
462 (let* ((template org-html-infojs-template
)
463 (ptoc (plist-get exp-plist
:with-toc
))
464 (hlevels (plist-get exp-plist
:headline-levels
))
466 (tdepth (if (integerp ptoc
) (min ptoc hlevels
) hlevels
))
467 (options (plist-get exp-plist
:infojs-opt
))
468 (table org-html-infojs-opts-table
)
470 (dolist (entry table
)
471 (let* ((opt (car entry
))
473 ;; Compute default values for script option OPT from
474 ;; `org-html-infojs-options' variable.
476 (let ((default (cdr (assq opt org-html-infojs-options
))))
477 (if (and (symbolp default
) (not (memq default
'(t nil
))))
478 (plist-get exp-plist default
)
480 ;; Value set through INFOJS_OPT keyword has precedence
481 ;; over the default one.
482 (val (if (and options
483 (string-match (format "\\<%s:\\(\\S-+\\)" opt
)
485 (match-string 1 options
)
489 (replace-regexp-in-string
490 "%SCRIPT_PATH" val template t t
)))
491 (sdepth (when (integerp (read val
))
492 (setq sdepth
(min (read val
) sdepth
))))
493 (tdepth (when (integerp (read val
))
494 (setq tdepth
(min (read val
) tdepth
))))
497 ((or (eq val t
) (equal val
"t")) "1")
498 ((or (eq val nil
) (equal val
"nil")) "0")
500 (t (format "%s" val
))))
501 (push (cons var val
) style
)))))
502 ;; Now we set the depth of the *generated* TOC to SDEPTH,
503 ;; because the toc will actually determine the splitting. How
504 ;; much of the toc will actually be displayed is governed by the
506 (setq exp-plist
(plist-put exp-plist
:with-toc sdepth
))
507 ;; The table of contents should not show more sections than we
509 (setq tdepth
(min tdepth sdepth
))
510 (push (cons "TOC_DEPTH" tdepth
) style
)
511 ;; Build style string.
512 (setq style
(mapconcat
513 (lambda (x) (format "org_html_manager.set(\"%s\", \"%s\");"
517 (when (and style
(> (length style
) 0))
518 (and (string-match "%MANAGER_OPTIONS" template
)
519 (setq style
(replace-match style t t template
))
522 exp-plist
:html-head-extra
523 (concat (or (plist-get exp-plist
:html-head-extra
) "")
526 ;; This script absolutely needs the table of contents, so we
527 ;; change that setting.
528 (unless (plist-get exp-plist
:with-toc
)
529 (setq exp-plist
(plist-put exp-plist
:with-toc t
)))
530 ;; Return the modified property list.
535 (defcustom org-html-text-markup-alist
536 '((bold .
"<b>%s</b>")
537 (code .
"<code>%s</code>")
538 (italic .
"<i>%s</i>")
539 (strike-through .
"<del>%s</del>")
540 (underline .
"<span class=\"underline\">%s</span>")
541 (verbatim .
"<code>%s</code>"))
542 "Alist of HTML expressions to convert text markup.
544 The key must be a symbol among `bold', `code', `italic',
545 `strike-through', `underline' and `verbatim'. The value is
546 a formatting string to wrap fontified text with.
548 If no association can be found for a given markup, text will be
550 :group
'org-export-html
552 :package-version
'(Org .
"8.0")
553 :type
'(alist :key-type
(symbol :tag
"Markup type")
554 :value-type
(string :tag
"Format string"))
555 :options
'(bold code italic strike-through underline verbatim
))
557 (defcustom org-html-indent nil
558 "Non-nil means to indent the generated HTML.
559 Warning: non-nil may break indentation of source code blocks."
560 :group
'org-export-html
562 :package-version
'(Org .
"8.0")
565 (defcustom org-html-use-unicode-chars nil
566 "Non-nil means to use unicode characters instead of HTML entities."
567 :group
'org-export-html
569 :package-version
'(Org .
"8.0")
574 (defcustom org-html-format-drawer-function
575 (lambda (name contents
) contents
)
576 "Function called to format a drawer in HTML code.
578 The function must accept two parameters:
579 NAME the drawer name, like \"LOGBOOK\"
580 CONTENTS the contents of the drawer.
582 The function should return the string to be exported.
584 For example, the variable could be set to the following function
585 in order to mimic default behaviour:
587 The default value simply returns the value of CONTENTS."
588 :group
'org-export-html
590 :package-version
'(Org .
"8.0")
595 (defcustom org-html-footnotes-section
"<div id=\"footnotes\">
596 <h2 class=\"footnotes\">%s: </h2>
597 <div id=\"text-footnotes\">
601 "Format for the footnotes section.
602 Should contain a two instances of %s. The first will be replaced with the
603 language-specific word for \"Footnotes\", the second one will be replaced
604 by the footnotes themselves."
605 :group
'org-export-html
608 (defcustom org-html-footnote-format
"<sup>%s</sup>"
609 "The format for the footnote reference.
610 %s will be replaced by the footnote reference itself."
611 :group
'org-export-html
614 (defcustom org-html-footnote-separator
"<sup>, </sup>"
615 "Text used to separate footnotes."
616 :group
'org-export-html
621 (defcustom org-html-toplevel-hlevel
2
622 "The <H> level for level 1 headings in HTML export.
623 This is also important for the classes that will be wrapped around headlines
624 and outline structure. If this variable is 1, the top-level headlines will
625 be <h1>, and the corresponding classes will be outline-1, section-number-1,
626 and outline-text-1. If this is 2, all of these will get a 2 instead.
627 The default for this variable is 2, because we use <h1> for formatting the
629 :group
'org-export-html
632 (defcustom org-html-format-headline-function
'ignore
633 "Function to format headline text.
635 This function will be called with 5 arguments:
636 TODO the todo keyword (string or nil).
637 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
638 PRIORITY the priority of the headline (integer or nil)
639 TEXT the main headline text (string).
640 TAGS the tags (string or nil).
642 The function result will be used in the section format string."
643 :group
'org-export-html
645 :package-version
'(Org .
"8.0")
650 (defcustom org-html-allow-name-attribute-in-anchors nil
651 "When nil, do not set \"name\" attribute in anchors.
652 By default, when appropriate, anchors are formatted with \"id\"
653 but without \"name\" attribute."
654 :group
'org-export-html
656 :package-version
'(Org .
"8.0")
661 (defcustom org-html-format-inlinetask-function
'ignore
662 "Function called to format an inlinetask in HTML code.
664 The function must accept six parameters:
665 TODO the todo keyword, as a string
666 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
667 PRIORITY the inlinetask priority, as a string
668 NAME the inlinetask name, as a string.
669 TAGS the inlinetask tags, as a list of strings.
670 CONTENTS the contents of the inlinetask, as a string.
672 The function should return the string to be exported."
673 :group
'org-export-html
675 :package-version
'(Org .
"8.0")
680 (defcustom org-html-with-latex org-export-with-latex
681 "Non-nil means process LaTeX math snippets.
683 When set, the exporter will process LaTeX environments and
686 This option can also be set with the +OPTIONS line,
687 e.g. \"tex:mathjax\". Allowed values are:
689 nil Ignore math snippets.
690 `verbatim' Keep everything in verbatim
691 `dvipng' Process the LaTeX fragments to images. This will also
692 include processing of non-math environments.
693 `imagemagick' Convert the LaTeX fragments to pdf files and use
694 imagemagick to convert pdf files to png files.
695 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
697 t Synonym for `mathjax'."
698 :group
'org-export-html
700 :package-version
'(Org .
"8.0")
702 (const :tag
"Do not process math in any way" nil
)
703 (const :tag
"Use dvipng to make images" dvipng
)
704 (const :tag
"Use imagemagick to make images" imagemagick
)
705 (const :tag
"Use MathJax to display math" mathjax
)
706 (const :tag
"Leave math verbatim" verbatim
)))
708 ;;;; Links :: Generic
710 (defcustom org-html-link-org-files-as-html t
711 "Non-nil means make file links to `file.org' point to `file.html'.
712 When `org-mode' is exporting an `org-mode' file to HTML, links to
713 non-html files are directly put into a href tag in HTML.
714 However, links to other Org-mode files (recognized by the
715 extension `.org.) should become links to the corresponding html
716 file, assuming that the linked `org-mode' file will also be
718 When nil, the links still point to the plain `.org' file."
719 :group
'org-export-html
722 ;;;; Links :: Inline images
724 (defcustom org-html-inline-images t
725 "Non-nil means inline images into exported HTML pages.
726 This is done using an <img> tag. When nil, an anchor with href is used to
728 :group
'org-export-html
730 :package-version
'(Org .
"8.1")
733 (defcustom org-html-inline-image-rules
734 '(("file" .
"\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")
735 ("http" .
"\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")
736 ("https" .
"\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'"))
737 "Rules characterizing image files that can be inlined into HTML.
738 A rule consists in an association whose key is the type of link
739 to consider, and value is a regexp that will be matched against
741 :group
'org-export-html
743 :package-version
'(Org .
"8.0")
744 :type
'(alist :key-type
(string :tag
"Type")
745 :value-type
(regexp :tag
"Path")))
749 (defcustom org-html-protect-char-alist
753 "Alist of characters to be converted by `org-html-protect'."
754 :group
'org-export-html
755 :type
'(repeat (cons (string :tag
"Character")
756 (string :tag
"HTML equivalent"))))
760 (defcustom org-html-htmlize-output-type
'inline-css
761 "Output type to be used by htmlize when formatting code snippets.
762 Choices are `css', to export the CSS selectors only, or `inline-css', to
763 export the CSS attribute values inline in the HTML. We use as default
764 `inline-css', in order to make the resulting HTML self-containing.
766 However, this will fail when using Emacs in batch mode for export, because
767 then no rich font definitions are in place. It will also not be good if
768 people with different Emacs setup contribute HTML files to a website,
769 because the fonts will represent the individual setups. In these cases,
770 it is much better to let Org/Htmlize assign classes only, and to use
771 a style file to define the look of these classes.
772 To get a start for your css file, start Emacs session and make sure that
773 all the faces you are interested in are defined, for example by loading files
774 in all modes you want. Then, use the command
775 \\[org-html-htmlize-generate-css] to extract class definitions."
776 :group
'org-export-html
777 :type
'(choice (const css
) (const inline-css
)))
779 (defcustom org-html-htmlize-font-prefix
"org-"
780 "The prefix for CSS class names for htmlize font specifications."
781 :group
'org-export-html
786 (defcustom org-html-table-default-attributes
787 '(:border
"2" :cellspacing
"0" :cellpadding
"6" :rules
"groups" :frame
"hsides")
788 "Default attributes and values which will be used in table tags.
789 This is a plist where attributes are symbols, starting with
790 colons, and values are strings.
792 When exporting to HTML5, these values will be disregarded."
793 :group
'org-export-html
795 :package-version
'(Org .
"8.0")
796 :type
'(plist :key-type
(symbol :tag
"Property")
797 :value-type
(string :tag
"Value")))
799 (defcustom org-html-table-header-tags
'("<th scope=\"%s\"%s>" .
"</th>")
800 "The opening tag for table header fields.
801 This is customizable so that alignment options can be specified.
802 The first %s will be filled with the scope of the field, either row or col.
803 The second %s will be replaced by a style entry to align the field.
804 See also the variable `org-html-table-use-header-tags-for-first-column'.
805 See also the variable `org-html-table-align-individual-fields'."
806 :group
'org-export-html
807 :type
'(cons (string :tag
"Opening tag") (string :tag
"Closing tag")))
809 (defcustom org-html-table-data-tags
'("<td%s>" .
"</td>")
810 "The opening tag for table data fields.
811 This is customizable so that alignment options can be specified.
812 The first %s will be filled with the scope of the field, either row or col.
813 The second %s will be replaced by a style entry to align the field.
814 See also the variable `org-html-table-align-individual-fields'."
815 :group
'org-export-html
816 :type
'(cons (string :tag
"Opening tag") (string :tag
"Closing tag")))
818 (defcustom org-html-table-row-tags
'("<tr>" .
"</tr>")
819 "The opening and ending tags for table rows.
820 This is customizable so that alignment options can be specified.
821 Instead of strings, these can be Lisp forms that will be
822 evaluated for each row in order to construct the table row tags.
824 During evaluation, these variables will be dynamically bound so that
827 `row-number': row number (0 is the first row)
828 `rowgroup-number': group number of current row
829 `start-rowgroup-p': non-nil means the row starts a group
830 `end-rowgroup-p': non-nil means the row ends a group
831 `top-row-p': non-nil means this is the top row
832 `bottom-row-p': non-nil means this is the bottom row
836 \(setq org-html-table-row-tags
837 (cons '(cond (top-row-p \"<tr class=\\\"tr-top\\\">\")
838 (bottom-row-p \"<tr class=\\\"tr-bottom\\\">\")
839 (t (if (= (mod row-number 2) 1)
840 \"<tr class=\\\"tr-odd\\\">\"
841 \"<tr class=\\\"tr-even\\\">\")))
844 will use the \"tr-top\" and \"tr-bottom\" classes for the top row
845 and the bottom row, and otherwise alternate between \"tr-odd\" and
846 \"tr-even\" for odd and even rows."
847 :group
'org-export-html
849 (choice :tag
"Opening tag"
850 (string :tag
"Specify")
852 (choice :tag
"Closing tag"
853 (string :tag
"Specify")
856 (defcustom org-html-table-align-individual-fields t
857 "Non-nil means attach style attributes for alignment to each table field.
858 When nil, alignment will only be specified in the column tags, but this
859 is ignored by some browsers (like Firefox, Safari). Opera does it right
861 :group
'org-export-html
864 (defcustom org-html-table-use-header-tags-for-first-column nil
865 "Non-nil means format column one in tables with header tags.
866 When nil, also column one will use data tags."
867 :group
'org-export-html
870 (defcustom org-html-table-caption-above t
871 "When non-nil, place caption string at the beginning of the table.
872 Otherwise, place it near the end."
873 :group
'org-export-html
878 (defcustom org-html-tag-class-prefix
""
879 "Prefix to class names for TODO keywords.
880 Each tag gets a class given by the tag itself, with this prefix.
881 The default prefix is empty because it is nice to just use the keyword
882 as a class name. But if you get into conflicts with other, existing
883 CSS classes, then this prefix can be very useful."
884 :group
'org-export-html
887 ;;;; Template :: Generic
889 (defcustom org-html-extension
"html"
890 "The extension for exported HTML files."
891 :group
'org-export-html
894 (defcustom org-html-xml-declaration
895 '(("html" .
"<?xml version=\"1.0\" encoding=\"%s\"?>")
896 ("php" .
"<?php echo \"<?xml version=\\\"1.0\\\" encoding=\\\"%s\\\" ?>\"; ?>"))
897 "The extension for exported HTML files.
898 %s will be replaced with the charset of the exported file.
899 This may be a string, or an alist with export extensions
900 and corresponding declarations.
902 This declaration only applies when exporting to XHTML."
903 :group
'org-export-html
905 (string :tag
"Single declaration")
906 (repeat :tag
"Dependent on extension"
907 (cons (string :tag
"Extension")
908 (string :tag
"Declaration")))))
910 (defcustom org-html-coding-system
'utf-8
911 "Coding system for HTML export.
912 Use utf-8 as the default value."
913 :group
'org-export-html
915 :package-version
'(Org .
"8.0")
916 :type
'coding-system
)
918 (defcustom org-html-doctype
"xhtml-strict"
919 "Document type definition to use for exported HTML files.
920 Can be set with the in-buffer HTML_DOCTYPE property or for
921 publishing, with :html-doctype."
922 :group
'org-export-html
924 :package-version
'(Org .
"8.0")
927 (mapcar (lambda (x) `(const ,(car x
))) org-html-doctype-alist
)
928 '((string :tag
"Custom doctype" ))))
930 (defcustom org-html-html5-fancy nil
931 "Non-nil means using new HTML5 elements.
932 This variable is ignored for anything other than HTML5 export.
934 For compatibility with Internet Explorer, it's probably a good
935 idea to download some form of the html5shiv (for instance
936 https://code.google.com/p/html5shiv/) and add it to your
937 HTML_HEAD_EXTRA, so that your pages don't break for users of IE
938 versions 8 and below."
939 :group
'org-export-html
941 :package-version
'(Org .
"8.0")
944 (defcustom org-html-container-element
"div"
945 "HTML element to use for wrapping top level sections.
946 Can be set with the in-buffer HTML_CONTAINER property or for
947 publishing, with :html-container.
949 Note that changing the default will prevent you from using
950 org-info.js for your website."
951 :group
'org-export-html
953 :package-version
'(Org .
"8.0")
956 (defcustom org-html-divs
957 '((preamble "div" "preamble")
958 (content "div" "content")
959 (postamble "div" "postamble"))
960 "Alist of the three section elements for HTML export.
961 The car of each entry is one of 'preamble, 'content or 'postamble.
962 The cdrs of each entry are the ELEMENT_TYPE and ID for each
963 section of the exported document.
965 Note that changing the default will prevent you from using
966 org-info.js for your website."
967 :group
'org-export-html
969 :package-version
'(Org .
"8.0")
970 :type
'(list :greedy t
971 (list :tag
"Preamble"
972 (const :format
"" preamble
)
973 (string :tag
"element") (string :tag
" id"))
975 (const :format
"" content
)
976 (string :tag
"element") (string :tag
" id"))
977 (list :tag
"Postamble" (const :format
"" postamble
)
978 (string :tag
" id") (string :tag
"element"))))
980 (defconst org-html-checkbox-types
982 ((on .
"☑") (off .
"☐") (trans .
"☐")))
984 ((on .
"<code>[X]</code>")
985 (off .
"<code>[ ]</code>")
986 (trans .
"<code>[-]</code>")))
988 ((on .
"<input type='checkbox' checked='checked' />")
989 (off .
"<input type='checkbox' />")
990 (trans .
"<input type='checkbox' />"))))
991 "Alist of checkbox types.
992 The cdr of each entry is an alist list three checkbox types for
993 HTML export: `on', `off' and `trans'.
996 `unicode' Unicode characters (HTML entities)
997 `ascii' ASCII characters
998 `html' HTML checkboxes
1000 Note that only the ascii characters implement tri-state
1001 checkboxes. The other two use the `off' checkbox for `trans'.")
1003 (defcustom org-html-checkbox-type
'ascii
1004 "The type of checkboxes to use for HTML export.
1005 See `org-html-checkbox-types' for for the values used for each
1007 :group
'org-export-html
1009 :package-version
'(Org .
"8.0")
1011 (const :tag
"ASCII characters" ascii
)
1012 (const :tag
"Unicode characters" unicode
)
1013 (const :tag
"HTML checkboxes" html
)))
1015 (defcustom org-html-metadata-timestamp-format
"%Y-%m-%d %a %H:%M"
1016 "Format used for timestamps in preamble, postamble and metadata.
1017 See `format-time-string' for more information on its components."
1018 :group
'org-export-html
1020 :package-version
'(Org .
"8.0")
1023 ;;;; Template :: Mathjax
1025 (defcustom org-html-mathjax-options
1026 '((path "http://orgmode.org/mathjax/MathJax.js")
1031 "Options for MathJax setup.
1033 path The path where to find MathJax
1034 scale Scaling for the HTML-CSS backend, usually between 100 and 133
1035 align How to align display math: left, center, or right
1036 indent If align is not center, how far from the left/right side?
1037 mathml Should a MathML player be used if available?
1038 This is faster and reduces bandwidth use, but currently
1039 sometimes has lower spacing quality. Therefore, the default is
1040 nil. When browsers get better, this switch can be flipped.
1042 You can also customize this for each buffer, using something like
1044 #+MATHJAX: scale:\"133\" align:\"right\" mathml:t path:\"/MathJax/\""
1045 :group
'org-export-html
1046 :type
'(list :greedy t
1047 (list :tag
"path (the path from where to load MathJax.js)"
1048 (const :format
" " path
) (string))
1049 (list :tag
"scale (scaling for the displayed math)"
1050 (const :format
" " scale
) (string))
1051 (list :tag
"align (alignment of displayed equations)"
1052 (const :format
" " align
) (string))
1053 (list :tag
"indent (indentation with left or right alignment)"
1054 (const :format
" " indent
) (string))
1055 (list :tag
"mathml (should MathML display be used is possible)"
1056 (const :format
" " mathml
) (boolean))))
1058 (defcustom org-html-mathjax-template
1059 "<script type=\"text/javascript\" src=\"%PATH\"></script>
1060 <script type=\"text/javascript\">
1061 <!--/*--><![CDATA[/*><!--*/
1062 MathJax.Hub.Config({
1063 // Only one of the two following lines, depending on user settings
1064 // First allows browser-native MathML display, second forces HTML/CSS
1065 :MMLYES: config: [\"MMLorHTML.js\"], jax: [\"input/TeX\"],
1066 :MMLNO: jax: [\"input/TeX\", \"output/HTML-CSS\"],
1067 extensions: [\"tex2jax.js\",\"TeX/AMSmath.js\",\"TeX/AMSsymbols.js\",
1068 \"TeX/noUndefined.js\"],
1070 inlineMath: [ [\"\\\\(\",\"\\\\)\"] ],
1071 displayMath: [ ['$$','$$'], [\"\\\\[\",\"\\\\]\"], [\"\\\\begin{displaymath}\",\"\\\\end{displaymath}\"] ],
1072 skipTags: [\"script\",\"noscript\",\"style\",\"textarea\",\"pre\",\"code\"],
1073 ignoreClass: \"tex2jax_ignore\",
1074 processEscapes: false,
1075 processEnvironments: true,
1078 showProcessingMessages: true,
1079 displayAlign: \"%ALIGN\",
1080 displayIndent: \"%INDENT\",
1084 availableFonts: [\"STIX\",\"TeX\"],
1085 preferredFont: \"TeX\",
1101 "The MathJax setup for XHTML files."
1102 :group
'org-export-html
1105 ;;;; Template :: Postamble
1107 (defcustom org-html-postamble
'auto
1108 "Non-nil means insert a postamble in HTML export.
1110 When set to 'auto, check against the
1111 `org-export-with-author/email/creator/date' variables to set the
1112 content of the postamble. When set to a string, use this string
1113 as the postamble. When t, insert a string as defined by the
1114 formatting string in `org-html-postamble-format'.
1116 When set to a function, apply this function and insert the
1117 returned string. The function takes the property list of export
1118 options as its only argument.
1120 Setting :html-postamble in publishing projects will take
1121 precedence over this variable."
1122 :group
'org-export-html
1123 :type
'(choice (const :tag
"No postamble" nil
)
1124 (const :tag
"Auto postamble" auto
)
1125 (const :tag
"Default formatting string" t
)
1126 (string :tag
"Custom formatting string")
1127 (function :tag
"Function (must return a string)")))
1129 (defcustom org-html-postamble-format
1130 '(("en" "<p class=\"author\">Author: %a (%e)</p>
1131 <p class=\"date\">Date: %d</p>
1132 <p class=\"creator\">%c</p>
1133 <p class=\"validation\">%v</p>"))
1134 "Alist of languages and format strings for the HTML postamble.
1136 The first element of each list is the language code, as used for
1137 the LANGUAGE keyword. See `org-export-default-language'.
1139 The second element of each list is a format string to format the
1140 postamble itself. This format string can contain these elements:
1142 %t stands for the title.
1143 %a stands for the author's name.
1144 %e stands for the author's email.
1145 %d stands for the date.
1146 %c will be replaced by `org-html-creator-string'.
1147 %v will be replaced by `org-html-validation-link'.
1148 %T will be replaced by the export time.
1149 %C will be replaced by the last modification time.
1151 If you need to use a \"%\" character, you need to escape it
1153 :group
'org-export-html
1155 (list (string :tag
"Language")
1156 (string :tag
"Format string"))))
1158 (defcustom org-html-validation-link
1159 "<a href=\"http://validator.w3.org/check?uri=referer\">Validate</a>"
1160 "Link to HTML validation service."
1161 :group
'org-export-html
1164 (defcustom org-html-creator-string
1165 (format "<a href=\"http://www.gnu.org/software/emacs/\">Emacs</a> %s (<a href=\"http://orgmode.org\">Org</a> mode %s)"
1167 (if (fboundp 'org-version
) (org-version) "unknown version"))
1168 "Information about the creator of the HTML document.
1169 This option can also be set on with the CREATOR keyword."
1170 :group
'org-export-html
1172 :package-version
'(Org .
"8.0")
1173 :type
'(string :tag
"Creator string"))
1175 ;;;; Template :: Preamble
1177 (defcustom org-html-preamble t
1178 "Non-nil means insert a preamble in HTML export.
1180 When t, insert a string as defined by the formatting string in
1181 `org-html-preamble-format'. When set to a string, use this
1182 formatting string instead (see `org-html-postamble-format' for an
1183 example of such a formatting string).
1185 When set to a function, apply this function and insert the
1186 returned string. The function takes the property list of export
1187 options as its only argument.
1189 Setting :html-preamble in publishing projects will take
1190 precedence over this variable."
1191 :group
'org-export-html
1192 :type
'(choice (const :tag
"No preamble" nil
)
1193 (const :tag
"Default preamble" t
)
1194 (string :tag
"Custom formatting string")
1195 (function :tag
"Function (must return a string)")))
1197 (defcustom org-html-preamble-format
'(("en" ""))
1198 "Alist of languages and format strings for the HTML preamble.
1200 The first element of each list is the language code, as used for
1201 the LANGUAGE keyword. See `org-export-default-language'.
1203 The second element of each list is a format string to format the
1204 preamble itself. This format string can contain these elements:
1206 %t stands for the title.
1207 %a stands for the author's name.
1208 %e stands for the author's email.
1209 %d stands for the date.
1210 %c will be replaced by `org-html-creator-string'.
1211 %v will be replaced by `org-html-validation-link'.
1212 %T will be replaced by the export time.
1213 %C will be replaced by the last modification time.
1215 If you need to use a \"%\" character, you need to escape it
1218 See the default value of `org-html-postamble-format' for an
1220 :group
'org-export-html
1222 (list (string :tag
"Language")
1223 (string :tag
"Format string"))))
1225 (defcustom org-html-link-up
""
1226 "Where should the \"UP\" link of exported HTML pages lead?"
1227 :group
'org-export-html
1228 :type
'(string :tag
"File or URL"))
1230 (defcustom org-html-link-home
""
1231 "Where should the \"HOME\" link of exported HTML pages lead?"
1232 :group
'org-export-html
1233 :type
'(string :tag
"File or URL"))
1235 (defcustom org-html-link-use-abs-url nil
1236 "Should we prepend relative links with HTML_LINK_HOME?"
1237 :group
'org-export-html
1239 :package-version
'(Org .
"8.1")
1242 (defcustom org-html-home
/up-format
1243 "<div id=\"org-div-home-and-up\">
1244 <a accesskey=\"h\" href=\"%s\"> UP </a>
1246 <a accesskey=\"H\" href=\"%s\"> HOME </a>
1248 "Snippet used to insert the HOME and UP links.
1249 This is a format string, the first %s will receive the UP link,
1250 the second the HOME link. If both `org-html-link-up' and
1251 `org-html-link-home' are empty, the entire snippet will be
1253 :group
'org-export-html
1256 ;;;; Template :: Scripts
1258 (define-obsolete-variable-alias
1259 'org-html-style-include-scripts
'org-html-head-include-scripts
"24.4")
1260 (defcustom org-html-head-include-scripts t
1261 "Non-nil means include the JavaScript snippets in exported HTML files.
1262 The actual script is defined in `org-html-scripts' and should
1264 :group
'org-export-html
1266 :package-version
'(Org .
"8.0")
1269 ;;;; Template :: Styles
1271 (define-obsolete-variable-alias
1272 'org-html-style-include-default
'org-html-head-include-default-style
"24.4")
1273 (defcustom org-html-head-include-default-style t
1274 "Non-nil means include the default style in exported HTML files.
1275 The actual style is defined in `org-html-style-default' and
1276 should not be modified. Use `org-html-head' to use your own
1278 :group
'org-export-html
1280 :package-version
'(Org .
"8.0")
1283 (put 'org-html-head-include-default-style
'safe-local-variable
'booleanp
)
1285 (define-obsolete-variable-alias 'org-html-style
'org-html-head
"24.4")
1286 (defcustom org-html-head
""
1287 "Org-wide head definitions for exported HTML files.
1289 This variable can contain the full HTML structure to provide a
1290 style, including the surrounding HTML tags. You can consider
1291 including definitions for the following classes: title, todo,
1292 done, timestamp, timestamp-kwd, tag, target.
1294 For example, a valid value would be:
1296 <style type=\"text/css\">
1298 p { font-weight: normal; color: gray; }
1299 h1 { color: black; }
1300 .title { text-align: center; }
1301 .todo, .timestamp-kwd { color: red; }
1302 .done { color: green; }
1306 If you want to refer to an external style, use something like
1308 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\" />
1310 As the value of this option simply gets inserted into the HTML
1311 <head> header, you can use it to add any arbitrary text to the
1314 You can set this on a per-file basis using #+HTML_HEAD:,
1315 or for publication projects using the :html-head property."
1316 :group
'org-export-html
1318 :package-version
'(Org .
"8.0")
1321 (put 'org-html-head
'safe-local-variable
'stringp
)
1323 (defcustom org-html-head-extra
""
1324 "More head information to add in the HTML output.
1326 You can set this on a per-file basis using #+HTML_HEAD_EXTRA:,
1327 or for publication projects using the :html-head-extra property."
1328 :group
'org-export-html
1330 :package-version
'(Org .
"8.0")
1333 (put 'org-html-head-extra
'safe-local-variable
'stringp
)
1337 (defcustom org-html-todo-kwd-class-prefix
""
1338 "Prefix to class names for TODO keywords.
1339 Each TODO keyword gets a class given by the keyword itself, with this prefix.
1340 The default prefix is empty because it is nice to just use the keyword
1341 as a class name. But if you get into conflicts with other, existing
1342 CSS classes, then this prefix can be very useful."
1343 :group
'org-export-html
1347 ;;; Internal Functions
1349 (defun org-html-xhtml-p (info)
1350 (let ((dt (downcase (plist-get info
:html-doctype
))))
1351 (string-match-p "xhtml" dt
)))
1353 (defun org-html-html5-p (info)
1354 (let ((dt (downcase (plist-get info
:html-doctype
))))
1355 (member dt
'("html5" "xhtml5" "<!doctype html>"))))
1357 (defun org-html-close-tag (tag attr info
)
1358 (concat "<" tag
" " attr
1359 (if (org-html-xhtml-p info
) " />" ">")))
1361 (defun org-html-doctype (info)
1362 "Return correct html doctype tag from `org-html-doctype-alist',
1363 or the literal value of :html-doctype from INFO if :html-doctype
1364 is not found in the alist.
1365 INFO is a plist used as a communication channel."
1366 (let ((dt (plist-get info
:html-doctype
)))
1367 (or (cdr (assoc dt org-html-doctype-alist
)) dt
)))
1369 (defun org-html--make-attribute-string (attributes)
1370 "Return a list of attributes, as a string.
1371 ATTRIBUTES is a plist where values are either strings or nil. An
1372 attributes with a nil value will be omitted from the result."
1374 (dolist (item attributes
(mapconcat 'identity
(nreverse output
) " "))
1375 (cond ((null item
) (pop output
))
1376 ((symbolp item
) (push (substring (symbol-name item
) 1) output
))
1377 (t (let ((key (car output
))
1378 (value (replace-regexp-in-string
1379 "\"" """ (org-html-encode-plain-text item
))))
1380 (setcar output
(format "%s=\"%s\"" key value
))))))))
1382 (defun org-html--wrap-image (contents info
&optional caption label
)
1383 "Wrap CONTENTS string within an appropriate environment for images.
1384 INFO is a plist used as a communication channel. When optional
1385 arguments CAPTION and LABEL are given, use them for caption and
1387 (let ((html5-fancy (and (org-html-html5-p info
)
1388 (plist-get info
:html-html5-fancy
))))
1389 (format (if html5-fancy
"\n<figure%s>%s%s\n</figure>"
1390 "\n<div%s class=\"figure\">%s%s\n</div>")
1392 (if (not (org-string-nw-p label
)) ""
1393 (format " id=\"%s\"" (org-export-solidify-link-text label
)))
1395 (format "\n<p>%s</p>" contents
)
1397 (if (not (org-string-nw-p caption
)) ""
1398 (format (if html5-fancy
"\n<figcaption>%s</figcaption>"
1402 (defun org-html--format-image (source attributes info
)
1403 "Return \"img\" tag with given SOURCE and ATTRIBUTES.
1404 SOURCE is a string specifying the location of the image.
1405 ATTRIBUTES is a plist, as returned by
1406 `org-export-read-attribute'. INFO is a plist used as
1407 a communication channel."
1408 (if (string= "svg" (file-name-extension source
))
1409 (org-html--svg-image source attributes info
)
1412 (org-html--make-attribute-string
1415 :alt
(if (string-match-p "^ltxpng/" source
)
1416 (org-html-encode-plain-text
1417 (org-find-text-property-in-string 'org-latex-src source
))
1418 (file-name-nondirectory source
)))
1422 (defun org-html--svg-image (source attributes info
)
1423 "Return \"object\" appropriate for embedding svg file SOURCE
1424 with assoicated ATTRIBUTES. INFO is a plist used as a
1425 communication channel.
1427 The special attribute \"fallback\" can be used to specify a fallback
1428 image file to use if the object embedding is not supported."
1429 (let ((fallback (plist-get attributes
:fallback
))
1430 (attrs (org-html--make-attribute-string
1431 (plist-put attributes
:fallback nil
))))
1432 (format "<object type=\"image/svg+xml\" data=\"%s\" %s>\n%s</object>"
1436 "img" (format "src=\"%s\" %s" fallback attrs
) info
)
1437 "Sorry, your browser does not support SVG."))))
1439 (defun org-html--textarea-block (element)
1440 "Transcode ELEMENT into a textarea block.
1441 ELEMENT is either a src block or an example block."
1442 (let* ((code (car (org-export-unravel-code element
)))
1443 (attr (org-export-read-attribute :attr_html element
)))
1444 (format "<p>\n<textarea cols=\"%s\" rows=\"%s\">\n%s</textarea>\n</p>"
1445 (or (plist-get attr
:width
) 80)
1446 (or (plist-get attr
:height
) (org-count-lines code
))
1449 (defun org-html--has-caption-p (element &optional info
)
1450 "Non-nil when ELEMENT has a caption affiliated keyword.
1451 INFO is a plist used as a communication channel. This function
1452 is meant to be used as a predicate for `org-export-get-ordinal' or
1453 a value to `org-html-standalone-image-predicate'."
1454 (org-element-property :caption element
))
1458 (defun org-html-htmlize-region-for-paste (beg end
)
1459 "Convert the region between BEG and END to HTML, using htmlize.el.
1460 This is much like `htmlize-region-for-paste', only that it uses
1461 the settings define in the org-... variables."
1462 (let* ((htmlize-output-type org-html-htmlize-output-type
)
1463 (htmlize-css-name-prefix org-html-htmlize-font-prefix
)
1464 (htmlbuf (htmlize-region beg end
)))
1466 (with-current-buffer htmlbuf
1467 (buffer-substring (plist-get htmlize-buffer-places
'content-start
)
1468 (plist-get htmlize-buffer-places
'content-end
)))
1469 (kill-buffer htmlbuf
))))
1472 (defun org-html-htmlize-generate-css ()
1473 "Create the CSS for all font definitions in the current Emacs session.
1474 Use this to create face definitions in your CSS style file that can then
1475 be used by code snippets transformed by htmlize.
1476 This command just produces a buffer that contains class definitions for all
1477 faces used in the current Emacs session. You can copy and paste the ones you
1478 need into your CSS file.
1480 If you then set `org-html-htmlize-output-type' to `css', calls
1481 to the function `org-html-htmlize-region-for-paste' will
1482 produce code that uses these same face definitions."
1485 (and (get-buffer "*html*") (kill-buffer "*html*"))
1487 (let ((fl (face-list))
1488 (htmlize-css-name-prefix "org-")
1489 (htmlize-output-type 'css
)
1491 (while (setq f
(pop fl
)
1492 i
(and f
(face-attribute f
:inherit
)))
1493 (when (and (symbolp f
) (or (not i
) (not (listp i
))))
1494 (insert (org-add-props (copy-sequence "1") nil
'face f
))))
1495 (htmlize-region (point-min) (point-max))))
1496 (org-pop-to-buffer-same-window "*html*")
1497 (goto-char (point-min))
1498 (if (re-search-forward "<style" nil t
)
1499 (delete-region (point-min) (match-beginning 0)))
1500 (if (re-search-forward "</style>" nil t
)
1501 (delete-region (1+ (match-end 0)) (point-max)))
1502 (beginning-of-line 1)
1503 (if (looking-at " +") (replace-match ""))
1504 (goto-char (point-min)))
1506 (defun org-html--make-string (n string
)
1507 "Build a string by concatenating N times STRING."
1508 (let (out) (dotimes (i n out
) (setq out
(concat string out
)))))
1510 (defun org-html-fix-class-name (kwd) ; audit callers of this function
1511 "Turn todo keyword KWD into a valid class name.
1512 Replaces invalid characters with \"_\"."
1514 (while (string-match "[^a-zA-Z0-9_]" kwd
)
1515 (setq kwd
(replace-match "_" t t kwd
))))
1518 (defun org-html-format-footnote-reference (n def refcnt
)
1519 "Format footnote reference N with definition DEF into HTML."
1520 (let ((extra (if (= refcnt
1) "" (format ".%d" refcnt
))))
1521 (format org-html-footnote-format
1522 (let* ((id (format "fnr.%s%s" n extra
))
1523 (href (format " href=\"#fn.%s\"" n
))
1524 (attributes (concat " class=\"footref\"" href
)))
1525 (org-html--anchor id n attributes
)))))
1527 (defun org-html-format-footnotes-section (section-name definitions
)
1528 "Format footnotes section SECTION-NAME."
1529 (if (not definitions
) ""
1530 (format org-html-footnotes-section section-name definitions
)))
1532 (defun org-html-format-footnote-definition (fn)
1533 "Format the footnote definition FN."
1534 (let ((n (car fn
)) (def (cdr fn
)))
1536 "<div class=\"footdef\">%s %s</div>\n"
1537 (format org-html-footnote-format
1538 (let* ((id (format "fn.%s" n
))
1539 (href (format " href=\"#fnr.%s\"" n
))
1540 (attributes (concat " class=\"footnum\"" href
)))
1541 (org-html--anchor id n attributes
)))
1544 (defun org-html-footnote-section (info)
1545 "Format the footnote section.
1546 INFO is a plist used as a communication channel."
1547 (let* ((fn-alist (org-export-collect-footnote-definitions
1548 (plist-get info
:parse-tree
) info
))
1550 (loop for
(n type raw
) in fn-alist collect
1551 (cons n
(if (eq (org-element-type raw
) 'org-data
)
1552 (org-trim (org-export-data raw info
))
1554 (org-trim (org-export-data raw info
))))))))
1556 (org-html-format-footnotes-section
1557 (org-html--translate "Footnotes" info
)
1560 (mapconcat 'org-html-format-footnote-definition fn-alist
"\n"))))))
1565 (defun org-html--build-meta-info (info)
1566 "Return meta tags for exported document.
1567 INFO is a plist used as a communication channel."
1568 (let ((protect-string
1570 (replace-regexp-in-string
1571 "\"" """ (org-html-encode-plain-text str
))))
1572 (title (org-export-data (plist-get info
:title
) info
))
1573 (author (and (plist-get info
:with-author
)
1574 (let ((auth (plist-get info
:author
)))
1576 ;; Return raw Org syntax, skipping non
1577 ;; exportable objects.
1578 (org-element-interpret-data
1579 (org-element-map auth
1580 (cons 'plain-text org-element-all-objects
)
1581 'identity info
))))))
1582 (description (plist-get info
:description
))
1583 (keywords (plist-get info
:keywords
))
1584 (charset (or (and org-html-coding-system
1585 (fboundp 'coding-system-get
)
1586 (coding-system-get org-html-coding-system
1590 (format "<title>%s</title>\n" title
)
1591 (when (plist-get info
:time-stamp-file
)
1593 (concat "<!-- " org-html-metadata-timestamp-format
" -->\n")))
1595 (if (org-html-html5-p info
)
1596 (org-html-close-tag "meta" " charset=\"%s\"" info
)
1598 "meta" " http-equiv=\"Content-Type\" content=\"text/html;charset=%s\""
1601 (org-html-close-tag "meta" " name=\"generator\" content=\"Org-mode\"" info
)
1603 (and (org-string-nw-p author
)
1605 (org-html-close-tag "meta"
1606 (format " name=\"author\" content=\"%s\""
1607 (funcall protect-string author
))
1610 (and (org-string-nw-p description
)
1612 (org-html-close-tag "meta"
1613 (format " name=\"description\" content=\"%s\"\n"
1614 (funcall protect-string description
))
1617 (and (org-string-nw-p keywords
)
1619 (org-html-close-tag "meta"
1620 (format " name=\"keywords\" content=\"%s\""
1621 (funcall protect-string keywords
))
1625 (defun org-html--build-head (info)
1626 "Return information for the <head>..</head> of the HTML output.
1627 INFO is a plist used as a communication channel."
1628 (org-element-normalize-string
1630 (when (plist-get info
:html-head-include-default-style
)
1631 (org-element-normalize-string org-html-style-default
))
1632 (org-element-normalize-string (plist-get info
:html-head
))
1633 (org-element-normalize-string (plist-get info
:html-head-extra
))
1634 (when (and (plist-get info
:html-htmlized-css-url
)
1635 (eq org-html-htmlize-output-type
'css
))
1636 (org-html-close-tag "link"
1637 (format " rel=\"stylesheet\" href=\"%s\" type=\"text/css\""
1638 (plist-get info
:html-htmlized-css-url
))
1640 (when (plist-get info
:html-head-include-scripts
) org-html-scripts
))))
1642 (defun org-html--build-mathjax-config (info)
1643 "Insert the user setup into the mathjax template.
1644 INFO is a plist used as a communication channel."
1645 (when (and (memq (plist-get info
:with-latex
) '(mathjax t
))
1646 (org-element-map (plist-get info
:parse-tree
)
1647 '(latex-fragment latex-environment
) 'identity info t
))
1648 (let ((template org-html-mathjax-template
)
1649 (options org-html-mathjax-options
)
1650 (in-buffer (or (plist-get info
:html-mathjax
) ""))
1651 name val
(yes " ") (no "// ") x
)
1654 (setq name
(car e
) val
(nth 1 e
))
1655 (if (string-match (concat "\\<" (symbol-name name
) ":") in-buffer
)
1656 (setq val
(car (read-from-string
1657 (substring in-buffer
(match-end 0))))))
1658 (if (not (stringp val
)) (setq val
(format "%s" val
)))
1659 (if (string-match (concat "%" (upcase (symbol-name name
))) template
)
1660 (setq template
(replace-match val t t template
))))
1662 (setq val
(nth 1 (assq 'mathml options
)))
1663 (if (string-match (concat "\\<mathml:") in-buffer
)
1664 (setq val
(car (read-from-string
1665 (substring in-buffer
(match-end 0))))))
1666 ;; Exchange prefixes depending on mathml setting.
1667 (if (not val
) (setq x yes yes no no x
))
1668 ;; Replace cookies to turn on or off the config/jax lines.
1669 (if (string-match ":MMLYES:" template
)
1670 (setq template
(replace-match yes t t template
)))
1671 (if (string-match ":MMLNO:" template
)
1672 (setq template
(replace-match no t t template
)))
1673 ;; Return the modified template.
1674 (org-element-normalize-string template
))))
1676 (defun org-html-format-spec (info)
1677 "Return format specification for elements that can be
1678 used in the preamble or postamble."
1679 `((?t .
,(org-export-data (plist-get info
:title
) info
))
1680 (?d .
,(org-export-data (org-export-get-date info
) info
))
1681 (?T .
,(format-time-string org-html-metadata-timestamp-format
))
1682 (?a .
,(org-export-data (plist-get info
:author
) info
))
1685 (format "<a href=\"mailto:%s\">%s</a>" e e
))
1686 (split-string (plist-get info
:email
) ",+ *")
1688 (?c .
,(plist-get info
:creator
))
1689 (?C .
,(let ((file (plist-get info
:input-file
)))
1690 (format-time-string org-html-metadata-timestamp-format
1691 (if file
(nth 5 (file-attributes file
))
1693 (?v .
,(or org-html-validation-link
""))))
1695 (defun org-html--build-pre/postamble
(type info
)
1696 "Return document preamble or postamble as a string, or nil.
1697 TYPE is either 'preamble or 'postamble, INFO is a plist used as a
1698 communication channel."
1699 (let ((section (plist-get info
(intern (format ":html-%s" type
))))
1700 (spec (org-html-format-spec info
)))
1702 (let ((section-contents
1703 (if (functionp section
) (funcall section info
)
1705 ((stringp section
) (format-spec section spec
))
1707 (let ((date (cdr (assq ?d spec
)))
1708 (author (cdr (assq ?a spec
)))
1709 (email (cdr (assq ?e spec
)))
1710 (creator (cdr (assq ?c spec
)))
1711 (timestamp (cdr (assq ?T spec
)))
1712 (validation-link (cdr (assq ?v spec
))))
1714 (when (and (plist-get info
:with-date
)
1715 (org-string-nw-p date
))
1716 (format "<p class=\"date\">%s: %s</p>\n"
1717 (org-html--translate "Date" info
)
1719 (when (and (plist-get info
:with-author
)
1720 (org-string-nw-p author
))
1721 (format "<p class=\"author\">%s: %s</p>\n"
1722 (org-html--translate "Author" info
)
1724 (when (and (plist-get info
:with-email
)
1725 (org-string-nw-p email
))
1726 (format "<p class=\"email\">%s: %s</p>\n"
1727 (org-html--translate "Email" info
)
1729 (when (plist-get info
:time-stamp-file
)
1731 "<p class=\"date\">%s: %s</p>\n"
1732 (org-html--translate "Created" info
)
1733 (format-time-string org-html-metadata-timestamp-format
)))
1734 (when (plist-get info
:with-creator
)
1735 (format "<p class=\"creator\">%s</p>\n" creator
))
1736 (format "<p class=\"validation\">%s</p>\n"
1740 (plist-get info
:language
)
1742 (format "org-html-%s-format" type
)))))
1747 (intern (format "org-html-%s-format" type
))))))
1749 (when (org-string-nw-p section-contents
)
1751 (format "<%s id=\"%s\" class=\"%s\">\n"
1752 (nth 1 (assq type org-html-divs
))
1753 (nth 2 (assq type org-html-divs
))
1754 org-html--pre
/postamble-class
)
1755 (org-element-normalize-string section-contents
)
1756 (format "</%s>\n" (nth 1 (assq type org-html-divs
)))))))))
1758 (defun org-html-inner-template (contents info
)
1759 "Return body of document string after HTML conversion.
1760 CONTENTS is the transcoded contents string. INFO is a plist
1761 holding export options."
1763 ;; Table of contents.
1764 (let ((depth (plist-get info
:with-toc
)))
1765 (when depth
(org-html-toc depth info
)))
1766 ;; Document contents.
1768 ;; Footnotes section.
1769 (org-html-footnote-section info
)))
1771 (defun org-html-template (contents info
)
1772 "Return complete document string after HTML conversion.
1773 CONTENTS is the transcoded contents string. INFO is a plist
1774 holding export options."
1776 (when (and (not (org-html-html5-p info
)) (org-html-xhtml-p info
))
1777 (let ((decl (or (and (stringp org-html-xml-declaration
)
1778 org-html-xml-declaration
)
1779 (cdr (assoc (plist-get info
:html-extension
)
1780 org-html-xml-declaration
))
1781 (cdr (assoc "html" org-html-xml-declaration
))
1784 (when (not (or (eq nil decl
) (string= "" decl
)))
1787 (or (and org-html-coding-system
1788 (fboundp 'coding-system-get
)
1789 (coding-system-get org-html-coding-system
'mime-charset
))
1791 (org-html-doctype info
)
1794 (when (org-html-xhtml-p info
)
1796 " xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"%s\" xml:lang=\"%s\""
1797 (plist-get info
:language
) (plist-get info
:language
)))
1800 (org-html--build-meta-info info
)
1801 (org-html--build-head info
)
1802 (org-html--build-mathjax-config info
)
1805 (let ((link-up (org-trim (plist-get info
:html-link-up
)))
1806 (link-home (org-trim (plist-get info
:html-link-home
))))
1807 (unless (and (string= link-up
"") (string= link-home
""))
1808 (format org-html-home
/up-format
1809 (or link-up link-home
)
1810 (or link-home link-up
))))
1812 (org-html--build-pre/postamble
'preamble info
)
1813 ;; Document contents.
1814 (format "<%s id=\"%s\">\n"
1815 (nth 1 (assq 'content org-html-divs
))
1816 (nth 2 (assq 'content org-html-divs
)))
1818 (let ((title (plist-get info
:title
)))
1819 (format "<h1 class=\"title\">%s</h1>\n" (org-export-data (or title
"") info
)))
1822 (nth 1 (assq 'content org-html-divs
)))
1824 (org-html--build-pre/postamble
'postamble info
)
1825 ;; Closing document.
1826 "</body>\n</html>"))
1828 (defun org-html--translate (s info
)
1829 "Translate string S according to specified language.
1830 INFO is a plist used as a communication channel."
1831 (org-export-translate s
:html info
))
1835 (defun org-html--anchor (&optional id desc attributes
)
1836 "Format a HTML anchor."
1837 (let* ((name (and org-html-allow-name-attribute-in-anchors id
))
1838 (attributes (concat (and id
(format " id=\"%s\"" id
))
1839 (and name
(format " name=\"%s\"" name
))
1841 (format "<a%s>%s</a>" attributes
(or desc
""))))
1845 (defun org-html--todo (todo)
1846 "Format TODO keywords into HTML."
1848 (format "<span class=\"%s %s%s\">%s</span>"
1849 (if (member todo org-done-keywords
) "done" "todo")
1850 org-html-todo-kwd-class-prefix
(org-html-fix-class-name todo
)
1855 (defun org-html--tags (tags)
1856 "Format TAGS into HTML."
1858 (format "<span class=\"tag\">%s</span>"
1861 (format "<span class=\"%s\">%s</span>"
1862 (concat org-html-tag-class-prefix
1863 (org-html-fix-class-name tag
))
1869 (defun* org-html-format-headline
1870 (todo todo-type priority text tags
1871 &key level section-number headline-label
&allow-other-keys
)
1872 "Format a headline in HTML."
1873 (let ((section-number
1874 (when section-number
1875 (format "<span class=\"section-number-%d\">%s</span> "
1876 level section-number
)))
1877 (todo (org-html--todo todo
))
1878 (tags (org-html--tags tags
)))
1879 (concat section-number todo
(and todo
" ") text
1880 (and tags
"   ") tags
)))
1884 (defun org-html-fontify-code (code lang
)
1885 "Color CODE with htmlize library.
1886 CODE is a string representing the source code to colorize. LANG
1887 is the language used for CODE, as a string, or nil."
1890 ;; Case 1: No lang. Possibly an example block.
1892 ;; Simple transcoding.
1893 (org-html-encode-plain-text code
))
1894 ;; Case 2: No htmlize or an inferior version of htmlize
1895 ((not (and (require 'htmlize nil t
) (fboundp 'htmlize-region-for-paste
)))
1897 (message "Cannot fontify src block (htmlize.el >= 1.34 required)")
1898 ;; Simple transcoding.
1899 (org-html-encode-plain-text code
))
1902 (setq lang
(or (assoc-default lang org-src-lang-modes
) lang
))
1903 (let* ((lang-mode (and lang
(intern (format "%s-mode" lang
)))))
1905 ;; Case 1: Language is not associated with any Emacs mode
1906 ((not (functionp lang-mode
))
1907 ;; Simple transcoding.
1908 (org-html-encode-plain-text code
))
1909 ;; Case 2: Default. Fontify code.
1912 (setq code
(with-temp-buffer
1913 ;; Switch to language-specific mode.
1917 (font-lock-fontify-buffer)
1918 ;; Remove formatting on newline characters.
1920 (let ((beg (point-min))
1923 (while (progn (end-of-line) (< (point) end
))
1924 (put-text-property (point) (1+ (point)) 'face nil
)
1927 (set-buffer-modified-p nil
)
1929 (org-html-htmlize-region-for-paste
1930 (point-min) (point-max))))
1931 ;; Strip any enclosing <pre></pre> tags.
1932 (let* ((beg (and (string-match "\\`<pre[^>]*>\n*" code
) (match-end 0)))
1933 (end (and beg
(string-match "</pre>\\'" code
))))
1934 (if (and beg end
) (substring code beg end
) code
)))))))))
1936 (defun org-html-do-format-code
1937 (code &optional lang refs retain-labels num-start
)
1938 "Format CODE string as source code.
1939 Optional arguments LANG, REFS, RETAIN-LABELS and NUM-START are,
1940 respectively, the language of the source code, as a string, an
1941 alist between line numbers and references (as returned by
1942 `org-export-unravel-code'), a boolean specifying if labels should
1943 appear in the source code, and the number associated to the first
1945 (let* ((code-lines (org-split-string code
"\n"))
1946 (code-length (length code-lines
))
1950 (length (number-to-string (+ code-length num-start
))))))
1951 (code (org-html-fontify-code code lang
)))
1952 (org-export-format-code
1954 (lambda (loc line-num ref
)
1957 ;; Add line number, if needed.
1959 (format "<span class=\"linenr\">%s</span>"
1960 (format num-fmt line-num
)))
1961 ;; Transcoded src line.
1963 ;; Add label, if needed.
1964 (when (and ref retain-labels
) (format " (%s)" ref
))))
1965 ;; Mark transcoded line as an anchor, if needed.
1967 (format "<span id=\"coderef-%s\" class=\"coderef-off\">%s</span>"
1971 (defun org-html-format-code (element info
)
1972 "Format contents of ELEMENT as source code.
1973 ELEMENT is either an example block or a src block. INFO is
1974 a plist used as a communication channel."
1975 (let* ((lang (org-element-property :language element
))
1976 ;; Extract code and references.
1977 (code-info (org-export-unravel-code element
))
1978 (code (car code-info
))
1979 (refs (cdr code-info
))
1980 ;; Does the src block contain labels?
1981 (retain-labels (org-element-property :retain-labels element
))
1982 ;; Does it have line numbers?
1983 (num-start (case (org-element-property :number-lines element
)
1984 (continued (org-export-get-loc element info
))
1986 (org-html-do-format-code code lang refs retain-labels num-start
)))
1989 ;;; Tables of Contents
1991 (defun org-html-toc (depth info
)
1992 "Build a table of contents.
1993 DEPTH is an integer specifying the depth of the table. INFO is a
1994 plist used as a communication channel. Return the table of
1995 contents as a string, or nil if it is empty."
1997 (mapcar (lambda (headline)
1998 (cons (org-html--format-toc-headline headline info
)
1999 (org-export-get-relative-level headline info
)))
2000 (org-export-collect-headlines info depth
)))
2001 (outer-tag (if (and (org-html-html5-p info
)
2002 (plist-get info
:html-html5-fancy
))
2006 (concat (format "<%s id=\"table-of-contents\">\n" outer-tag
)
2007 (format "<h%d>%s</h%d>\n"
2008 org-html-toplevel-hlevel
2009 (org-html--translate "Table of Contents" info
)
2010 org-html-toplevel-hlevel
)
2011 "<div id=\"text-table-of-contents\">"
2012 (org-html--toc-text toc-entries
)
2014 (format "</%s>\n" outer-tag
)))))
2016 (defun org-html--toc-text (toc-entries)
2017 "Return innards of a table of contents, as a string.
2018 TOC-ENTRIES is an alist where key is an entry title, as a string,
2019 and value is its relative level, as an integer."
2020 (let* ((prev-level (1- (cdar toc-entries
)))
2021 (start-level prev-level
))
2025 (let ((headline (car entry
))
2026 (level (cdr entry
)))
2028 (let* ((cnt (- level prev-level
))
2029 (times (if (> cnt
0) (1- cnt
) (- cnt
)))
2031 (setq prev-level level
)
2033 (org-html--make-string
2034 times
(cond ((> cnt
0) "\n<ul>\n<li>")
2035 ((< cnt
0) "</li>\n</ul>\n")))
2036 (if (> cnt
0) "\n<ul>\n<li>" "</li>\n<li>")))
2039 (org-html--make-string (- prev-level start-level
) "</li>\n</ul>\n"))))
2041 (defun org-html--format-toc-headline (headline info
)
2042 "Return an appropriate table of contents entry for HEADLINE.
2043 INFO is a plist used as a communication channel."
2044 (let* ((headline-number (org-export-get-headline-number headline info
))
2045 (todo (and (plist-get info
:with-todo-keywords
)
2046 (let ((todo (org-element-property :todo-keyword headline
)))
2047 (and todo
(org-export-data todo info
)))))
2048 (todo-type (and todo
(org-element-property :todo-type headline
)))
2049 (priority (and (plist-get info
:with-priority
)
2050 (org-element-property :priority headline
)))
2051 (text (org-export-data-with-backend
2052 (org-export-get-alt-title headline info
)
2053 ;; Create an anonymous back-end that will ignore any
2054 ;; footnote-reference, link, radio-target and target
2055 ;; in table of contents.
2056 (org-export-create-backend
2058 :transcoders
'((footnote-reference . ignore
)
2059 (link .
(lambda (object c i
) c
))
2060 (radio-target .
(lambda (object c i
) c
))
2063 (tags (and (eq (plist-get info
:with-tags
) t
)
2064 (org-export-get-tags headline info
))))
2065 (format "<a href=\"#%s\">%s</a>"
2067 (org-export-solidify-link-text
2068 (or (org-element-property :CUSTOM_ID headline
)
2070 (mapconcat #'number-to-string headline-number
"-"))))
2073 (and (not (org-export-low-level-p headline info
))
2074 (org-export-numbered-headline-p headline info
)
2075 (concat (mapconcat #'number-to-string headline-number
".")
2077 (apply (if (not (eq org-html-format-headline-function
'ignore
))
2078 (lambda (todo todo-type priority text tags
&rest ignore
)
2079 (funcall org-html-format-headline-function
2080 todo todo-type priority text tags
))
2081 #'org-html-format-headline
)
2082 todo todo-type priority text tags
:section-number nil
)))))
2084 (defun org-html-list-of-listings (info)
2085 "Build a list of listings.
2086 INFO is a plist used as a communication channel. Return the list
2087 of listings as a string, or nil if it is empty."
2088 (let ((lol-entries (org-export-collect-listings info
)))
2090 (concat "<div id=\"list-of-listings\">\n"
2091 (format "<h%d>%s</h%d>\n"
2092 org-html-toplevel-hlevel
2093 (org-html--translate "List of Listings" info
)
2094 org-html-toplevel-hlevel
)
2095 "<div id=\"text-list-of-listings\">\n<ul>\n"
2097 (initial-fmt (format "<span class=\"listing-number\">%s</span>"
2098 (org-html--translate "Listing %d:" info
))))
2101 (let ((label (org-element-property :name entry
))
2104 (or (org-export-get-caption entry t
)
2105 (org-export-get-caption entry
))
2110 (concat (format initial-fmt
(incf count
)) " " title
)
2111 (format "<a href=\"#%s\">%s %s</a>"
2112 (org-export-solidify-link-text label
)
2113 (format initial-fmt
(incf count
))
2117 "\n</ul>\n</div>\n</div>"))))
2119 (defun org-html-list-of-tables (info)
2120 "Build a list of tables.
2121 INFO is a plist used as a communication channel. Return the list
2122 of tables as a string, or nil if it is empty."
2123 (let ((lol-entries (org-export-collect-tables info
)))
2125 (concat "<div id=\"list-of-tables\">\n"
2126 (format "<h%d>%s</h%d>\n"
2127 org-html-toplevel-hlevel
2128 (org-html--translate "List of Tables" info
)
2129 org-html-toplevel-hlevel
)
2130 "<div id=\"text-list-of-tables\">\n<ul>\n"
2132 (initial-fmt (format "<span class=\"table-number\">%s</span>"
2133 (org-html--translate "Table %d:" info
))))
2136 (let ((label (org-element-property :name entry
))
2139 (or (org-export-get-caption entry t
)
2140 (org-export-get-caption entry
))
2145 (concat (format initial-fmt
(incf count
)) " " title
)
2146 (format "<a href=\"#%s\">%s %s</a>"
2147 (org-export-solidify-link-text label
)
2148 (format initial-fmt
(incf count
))
2152 "\n</ul>\n</div>\n</div>"))))
2155 ;;; Transcode Functions
2159 (defun org-html-bold (bold contents info
)
2160 "Transcode BOLD from Org to HTML.
2161 CONTENTS is the text with bold markup. INFO is a plist holding
2162 contextual information."
2163 (format (or (cdr (assq 'bold org-html-text-markup-alist
)) "%s")
2168 (defun org-html-center-block (center-block contents info
)
2169 "Transcode a CENTER-BLOCK element from Org to HTML.
2170 CONTENTS holds the contents of the block. INFO is a plist
2171 holding contextual information."
2172 (format "<div class=\"center\">\n%s</div>" contents
))
2176 (defun org-html-clock (clock contents info
)
2177 "Transcode a CLOCK element from Org to HTML.
2178 CONTENTS is nil. INFO is a plist used as a communication
2181 <span class=\"timestamp-wrapper\">
2182 <span class=\"timestamp-kwd\">%s</span> <span class=\"timestamp\">%s</span>%s
2187 (org-element-property :raw-value
2188 (org-element-property :value clock
)))
2189 (let ((time (org-element-property :duration clock
)))
2190 (and time
(format " <span class=\"timestamp\">(%s)</span>" time
)))))
2194 (defun org-html-code (code contents info
)
2195 "Transcode CODE from Org to HTML.
2196 CONTENTS is nil. INFO is a plist holding contextual
2198 (format (or (cdr (assq 'code org-html-text-markup-alist
)) "%s")
2199 (org-html-encode-plain-text (org-element-property :value code
))))
2203 (defun org-html-drawer (drawer contents info
)
2204 "Transcode a DRAWER element from Org to HTML.
2205 CONTENTS holds the contents of the block. INFO is a plist
2206 holding contextual information."
2207 (if (functionp org-html-format-drawer-function
)
2208 (funcall org-html-format-drawer-function
2209 (org-element-property :drawer-name drawer
)
2211 ;; If there's no user defined function: simply
2212 ;; display contents of the drawer.
2217 (defun org-html-dynamic-block (dynamic-block contents info
)
2218 "Transcode a DYNAMIC-BLOCK element from Org to HTML.
2219 CONTENTS holds the contents of the block. INFO is a plist
2220 holding contextual information. See `org-export-data'."
2225 (defun org-html-entity (entity contents info
)
2226 "Transcode an ENTITY object from Org to HTML.
2227 CONTENTS are the definition itself. INFO is a plist holding
2228 contextual information."
2229 (org-element-property :html entity
))
2233 (defun org-html-example-block (example-block contents info
)
2234 "Transcode a EXAMPLE-BLOCK element from Org to HTML.
2235 CONTENTS is nil. INFO is a plist holding contextual
2237 (if (org-export-read-attribute :attr_html example-block
:textarea
)
2238 (org-html--textarea-block example-block
)
2239 (format "<pre class=\"example\">\n%s</pre>"
2240 (org-html-format-code example-block info
))))
2244 (defun org-html-export-snippet (export-snippet contents info
)
2245 "Transcode a EXPORT-SNIPPET object from Org to HTML.
2246 CONTENTS is nil. INFO is a plist holding contextual
2248 (when (eq (org-export-snippet-backend export-snippet
) 'html
)
2249 (org-element-property :value export-snippet
)))
2253 (defun org-html-export-block (export-block contents info
)
2254 "Transcode a EXPORT-BLOCK element from Org to HTML.
2255 CONTENTS is nil. INFO is a plist holding contextual information."
2256 (when (string= (org-element-property :type export-block
) "HTML")
2257 (org-remove-indentation (org-element-property :value export-block
))))
2261 (defun org-html-fixed-width (fixed-width contents info
)
2262 "Transcode a FIXED-WIDTH element from Org to HTML.
2263 CONTENTS is nil. INFO is a plist holding contextual information."
2264 (format "<pre class=\"example\">\n%s</pre>"
2265 (org-html-do-format-code
2266 (org-remove-indentation
2267 (org-element-property :value fixed-width
)))))
2269 ;;;; Footnote Reference
2271 (defun org-html-footnote-reference (footnote-reference contents info
)
2272 "Transcode a FOOTNOTE-REFERENCE element from Org to HTML.
2273 CONTENTS is nil. INFO is a plist holding contextual information."
2275 ;; Insert separator between two footnotes in a row.
2276 (let ((prev (org-export-get-previous-element footnote-reference info
)))
2277 (when (eq (org-element-type prev
) 'footnote-reference
)
2278 org-html-footnote-separator
))
2280 ((not (org-export-footnote-first-reference-p footnote-reference info
))
2281 (org-html-format-footnote-reference
2282 (org-export-get-footnote-number footnote-reference info
)
2284 ;; Inline definitions are secondary strings.
2285 ((eq (org-element-property :type footnote-reference
) 'inline
)
2286 (org-html-format-footnote-reference
2287 (org-export-get-footnote-number footnote-reference info
)
2289 ;; Non-inline footnotes definitions are full Org data.
2290 (t (org-html-format-footnote-reference
2291 (org-export-get-footnote-number footnote-reference info
)
2296 (defun org-html-format-headline--wrap
2297 (headline info
&optional format-function
&rest extra-keys
)
2298 "Transcode a HEADLINE element from Org to HTML.
2299 CONTENTS holds the contents of the headline. INFO is a plist
2300 holding contextual information."
2301 (let* ((level (+ (org-export-get-relative-level headline info
)
2302 (1- org-html-toplevel-hlevel
)))
2303 (headline-number (org-export-get-headline-number headline info
))
2304 (section-number (and (not (org-export-low-level-p headline info
))
2305 (org-export-numbered-headline-p headline info
)
2306 (mapconcat 'number-to-string
2307 headline-number
".")))
2308 (todo (and (plist-get info
:with-todo-keywords
)
2309 (let ((todo (org-element-property :todo-keyword headline
)))
2310 (and todo
(org-export-data todo info
)))))
2311 (todo-type (and todo
(org-element-property :todo-type headline
)))
2312 (priority (and (plist-get info
:with-priority
)
2313 (org-element-property :priority headline
)))
2314 (text (org-export-data (org-element-property :title headline
) info
))
2315 (tags (and (plist-get info
:with-tags
)
2316 (org-export-get-tags headline info
)))
2317 (headline-label (or (org-element-property :CUSTOM_ID headline
)
2318 (concat "sec-" (mapconcat 'number-to-string
2319 headline-number
"-"))))
2321 (cond ((functionp format-function
) format-function
)
2322 ((not (eq org-html-format-headline-function
'ignore
))
2323 (lambda (todo todo-type priority text tags
&rest ignore
)
2324 (funcall org-html-format-headline-function
2325 todo todo-type priority text tags
)))
2326 (t 'org-html-format-headline
))))
2327 (apply format-function
2328 todo todo-type priority text tags
2329 :headline-label headline-label
:level level
2330 :section-number section-number extra-keys
)))
2332 (defun org-html-headline (headline contents info
)
2333 "Transcode a HEADLINE element from Org to HTML.
2334 CONTENTS holds the contents of the headline. INFO is a plist
2335 holding contextual information."
2337 (setq contents
(or contents
""))
2338 (let* ((numberedp (org-export-numbered-headline-p headline info
))
2339 (level (org-export-get-relative-level headline info
))
2340 (text (org-export-data (org-element-property :title headline
) info
))
2341 (todo (and (plist-get info
:with-todo-keywords
)
2342 (let ((todo (org-element-property :todo-keyword headline
)))
2343 (and todo
(org-export-data todo info
)))))
2344 (todo-type (and todo
(org-element-property :todo-type headline
)))
2345 (tags (and (plist-get info
:with-tags
)
2346 (org-export-get-tags headline info
)))
2347 (priority (and (plist-get info
:with-priority
)
2348 (org-element-property :priority headline
)))
2349 (section-number (and (org-export-numbered-headline-p headline info
)
2350 (mapconcat 'number-to-string
2351 (org-export-get-headline-number
2352 headline info
) ".")))
2353 ;; Create the headline text.
2354 (full-text (org-html-format-headline--wrap headline info
)))
2356 ;; Case 1: This is a footnote section: ignore it.
2357 ((org-element-property :footnote-section-p headline
) nil
)
2358 ;; Case 2. This is a deep sub-tree: export it as a list item.
2359 ;; Also export as items headlines for which no section
2360 ;; format has been found.
2361 ((org-export-low-level-p headline info
)
2362 ;; Build the real contents of the sub-tree.
2363 (let* ((type (if numberedp
'ordered
'unordered
))
2364 (itemized-body (org-html-format-list-item
2365 contents type nil info nil full-text
)))
2367 (and (org-export-first-sibling-p headline info
)
2368 (org-html-begin-plain-list type
))
2370 (and (org-export-last-sibling-p headline info
)
2371 (org-html-end-plain-list type
)))))
2372 ;; Case 3. Standard headline. Export it as a section.
2374 (let* ((section-number (mapconcat 'number-to-string
2375 (org-export-get-headline-number
2376 headline info
) "-"))
2378 (list (org-element-property :CUSTOM_ID headline
)
2379 (concat "sec-" section-number
)
2380 (org-element-property :ID headline
))))
2381 (preferred-id (car ids
))
2382 (extra-ids (cdr ids
))
2383 (extra-class (org-element-property :HTML_CONTAINER_CLASS headline
))
2384 (level1 (+ level
(1- org-html-toplevel-hlevel
)))
2385 (first-content (car (org-element-contents headline
))))
2386 (format "<%s id=\"%s\" class=\"%s\">%s%s</%s>\n"
2387 (org-html--container headline info
)
2388 (format "outline-container-%s"
2389 (or (org-element-property :CUSTOM_ID headline
)
2390 (concat "sec-" section-number
)))
2391 (concat (format "outline-%d" level1
) (and extra-class
" ")
2393 (format "\n<h%d id=\"%s\">%s%s</h%d>\n"
2398 (let ((id (org-export-solidify-link-text
2399 (if (org-uuidgen-p x
) (concat "ID-" x
)
2401 (org-html--anchor id
)))
2405 ;; When there is no section, pretend there is an empty
2406 ;; one to get the correct <div class="outline- ...>
2407 ;; which is needed by `org-info.js'.
2408 (if (not (eq (org-element-type first-content
) 'section
))
2409 (concat (org-html-section first-content
"" info
)
2412 (org-html--container headline info
)))))))
2414 (defun org-html--container (headline info
)
2415 (or (org-element-property :HTML_CONTAINER headline
)
2416 (if (= 1 (org-export-get-relative-level headline info
))
2417 (plist-get info
:html-container
)
2420 ;;;; Horizontal Rule
2422 (defun org-html-horizontal-rule (horizontal-rule contents info
)
2423 "Transcode an HORIZONTAL-RULE object from Org to HTML.
2424 CONTENTS is nil. INFO is a plist holding contextual information."
2425 (org-html-close-tag "hr" nil info
))
2427 ;;;; Inline Src Block
2429 (defun org-html-inline-src-block (inline-src-block contents info
)
2430 "Transcode an INLINE-SRC-BLOCK element from Org to HTML.
2431 CONTENTS holds the contents of the item. INFO is a plist holding
2432 contextual information."
2433 (let* ((org-lang (org-element-property :language inline-src-block
))
2434 (code (org-element-property :value inline-src-block
)))
2435 (error "Cannot export inline src block")))
2439 (defun org-html-format-section (text class
&optional id
)
2440 "Format a section with TEXT into a HTML div with CLASS and ID."
2441 (let ((extra (concat (when id
(format " id=\"%s\"" id
)))))
2442 (concat (format "<div class=\"%s\"%s>\n" class extra
) text
"</div>\n")))
2444 (defun org-html-inlinetask (inlinetask contents info
)
2445 "Transcode an INLINETASK element from Org to HTML.
2446 CONTENTS holds the contents of the block. INFO is a plist
2447 holding contextual information."
2449 ;; If `org-html-format-inlinetask-function' is not 'ignore, call it
2450 ;; with appropriate arguments.
2451 ((not (eq org-html-format-inlinetask-function
'ignore
))
2452 (let ((format-function
2454 (lambda (todo todo-type priority text tags
2455 &key contents
&allow-other-keys
)
2456 (funcall org-html-format-inlinetask-function
2457 todo todo-type priority text tags contents
)))))
2458 (org-html-format-headline--wrap
2459 inlinetask info format-function
:contents contents
)))
2460 ;; Otherwise, use a default template.
2461 (t (format "<div class=\"inlinetask\">\n<b>%s</b>%s\n%s</div>"
2462 (org-html-format-headline--wrap inlinetask info
)
2463 (org-html-close-tag "br" nil info
)
2468 (defun org-html-italic (italic contents info
)
2469 "Transcode ITALIC from Org to HTML.
2470 CONTENTS is the text with italic markup. INFO is a plist holding
2471 contextual information."
2472 (format (or (cdr (assq 'italic org-html-text-markup-alist
)) "%s") contents
))
2476 (defun org-html-checkbox (checkbox info
)
2477 "Format CHECKBOX into HTML.
2478 INFO is a plist holding contextual information. See
2479 `org-html-checkbox-type' for customization options."
2481 (cdr (assq org-html-checkbox-type org-html-checkbox-types
)))))
2483 (defun org-html-format-list-item (contents type checkbox info
2484 &optional term-counter-id
2486 "Format a list item into HTML."
2487 (let ((checkbox (concat (org-html-checkbox checkbox info
)
2488 (and checkbox
" ")))
2489 (br (org-html-close-tag "br" nil info
)))
2493 (let* ((counter term-counter-id
)
2494 (extra (if counter
(format " value=\"%s\"" counter
) "")))
2496 (format "<li%s>" extra
)
2497 (when headline
(concat headline br
)))))
2499 (let* ((id term-counter-id
)
2500 (extra (if id
(format " id=\"%s\"" id
) "")))
2502 (format "<li%s>" extra
)
2503 (when headline
(concat headline br
)))))
2505 (let* ((term term-counter-id
))
2506 (setq term
(or term
"(no term)"))
2507 ;; Check-boxes in descriptive lists are associated to tag.
2508 (concat (format "<dt> %s </dt>"
2509 (concat checkbox term
))
2511 (unless (eq type
'descriptive
) checkbox
)
2516 (descriptive "</dd>")))))
2518 (defun org-html-item (item contents info
)
2519 "Transcode an ITEM element from Org to HTML.
2520 CONTENTS holds the contents of the item. INFO is a plist holding
2521 contextual information."
2522 (let* ((plain-list (org-export-get-parent item
))
2523 (type (org-element-property :type plain-list
))
2524 (counter (org-element-property :counter item
))
2525 (checkbox (org-element-property :checkbox item
))
2526 (tag (let ((tag (org-element-property :tag item
)))
2527 (and tag
(org-export-data tag info
)))))
2528 (org-html-format-list-item
2529 contents type checkbox info
(or tag counter
))))
2533 (defun org-html-keyword (keyword contents info
)
2534 "Transcode a KEYWORD element from Org to HTML.
2535 CONTENTS is nil. INFO is a plist holding contextual information."
2536 (let ((key (org-element-property :key keyword
))
2537 (value (org-element-property :value keyword
)))
2539 ((string= key
"HTML") value
)
2540 ((string= key
"TOC")
2541 (let ((value (downcase value
)))
2543 ((string-match "\\<headlines\\>" value
)
2544 (let ((depth (or (and (string-match "[0-9]+" value
)
2545 (string-to-number (match-string 0 value
)))
2546 (plist-get info
:with-toc
))))
2547 (org-html-toc depth info
)))
2548 ((string= "listings" value
) (org-html-list-of-listings info
))
2549 ((string= "tables" value
) (org-html-list-of-tables info
))))))))
2551 ;;;; Latex Environment
2553 (defun org-html-format-latex (latex-frag processing-type info
)
2554 "Format a LaTeX fragment LATEX-FRAG into HTML.
2555 PROCESSING-TYPE designates the tool used for conversion. It is
2556 a symbol among `mathjax', `dvipng', `imagemagick', `verbatim' nil
2557 and t. See `org-html-with-latex' for more information. INFO is
2558 a plist containing export properties."
2559 (let ((cache-relpath "") (cache-dir ""))
2560 (unless (eq processing-type
'mathjax
)
2561 (let ((bfn (or (buffer-file-name)
2563 (expand-file-name "latex" temporary-file-directory
))))
2565 (let ((header (plist-get info
:latex-header
)))
2568 (lambda (line) (concat "#+LATEX_HEADER: " line
))
2569 (org-split-string header
"\n")
2574 (file-name-sans-extension
2575 (file-name-nondirectory bfn
)))
2576 cache-dir
(file-name-directory bfn
))
2577 ;; Re-create LaTeX environment from original buffer in
2578 ;; temporary buffer so that dvipng/imagemagick can properly
2579 ;; turn the fragment into an image.
2580 (setq latex-frag
(concat latex-header latex-frag
))))
2583 (org-format-latex cache-relpath cache-dir nil
"Creating LaTeX Image..."
2584 nil nil processing-type
)
2587 (defun org-html-latex-environment (latex-environment contents info
)
2588 "Transcode a LATEX-ENVIRONMENT element from Org to HTML.
2589 CONTENTS is nil. INFO is a plist holding contextual information."
2590 (let ((processing-type (plist-get info
:with-latex
))
2591 (latex-frag (org-remove-indentation
2592 (org-element-property :value latex-environment
)))
2593 (attributes (org-export-read-attribute :attr_html latex-environment
)))
2594 (case processing-type
2596 (org-html-format-latex latex-frag
'mathjax info
))
2597 ((dvipng imagemagick
)
2599 (org-html-format-latex latex-frag processing-type info
)))
2600 (when (and formula-link
(string-match "file:\\([^]]*\\)" formula-link
))
2601 ;; Do not provide a caption or a name to be consistent with
2602 ;; `mathjax' handling.
2603 (org-html--wrap-image
2604 (org-html--format-image
2605 (match-string 1 formula-link
) attributes info
) info
))))
2610 (defun org-html-latex-fragment (latex-fragment contents info
)
2611 "Transcode a LATEX-FRAGMENT object from Org to HTML.
2612 CONTENTS is nil. INFO is a plist holding contextual information."
2613 (let ((latex-frag (org-element-property :value latex-fragment
))
2614 (processing-type (plist-get info
:with-latex
)))
2615 (case processing-type
2617 (org-html-format-latex latex-frag
'mathjax info
))
2618 ((dvipng imagemagick
)
2620 (org-html-format-latex latex-frag processing-type info
)))
2621 (when (and formula-link
(string-match "file:\\([^]]*\\)" formula-link
))
2622 (org-html--format-image (match-string 1 formula-link
) nil info
))))
2627 (defun org-html-line-break (line-break contents info
)
2628 "Transcode a LINE-BREAK object from Org to HTML.
2629 CONTENTS is nil. INFO is a plist holding contextual information."
2630 (concat (org-html-close-tag "br" nil info
) "\n"))
2634 (defun org-html-inline-image-p (link info
)
2635 "Non-nil when LINK is meant to appear as an image.
2636 INFO is a plist used as a communication channel. LINK is an
2637 inline image when it has no description and targets an image
2638 file (see `org-html-inline-image-rules' for more information), or
2639 if its description is a single link targeting an image file."
2640 (if (not (org-element-contents link
))
2641 (org-export-inline-image-p link org-html-inline-image-rules
)
2643 (let ((link-count 0))
2644 (org-element-map (org-element-contents link
)
2645 (cons 'plain-text org-element-all-objects
)
2647 (case (org-element-type obj
)
2648 (plain-text (org-string-nw-p obj
))
2649 (link (if (= link-count
1) t
2651 (not (org-export-inline-image-p
2652 obj org-html-inline-image-rules
))))
2656 (defvar org-html-standalone-image-predicate
)
2657 (defun org-html-standalone-image-p (element info
)
2658 "Test if ELEMENT is a standalone image.
2660 INFO is a plist holding contextual information.
2662 Return non-nil, if ELEMENT is of type paragraph and its sole
2663 content, save for white spaces, is a link that qualifies as an
2666 Return non-nil, if ELEMENT is of type link and its containing
2667 paragraph has no other content save white spaces.
2669 Return nil, otherwise.
2671 Bind `org-html-standalone-image-predicate' to constrain paragraph
2672 further. For example, to check for only captioned standalone
2675 \(lambda (paragraph) (org-element-property :caption paragraph))"
2676 (let ((paragraph (case (org-element-type element
)
2678 (link (org-export-get-parent element
)))))
2679 (and (eq (org-element-type paragraph
) 'paragraph
)
2680 (or (not (and (boundp 'org-html-standalone-image-predicate
)
2681 (functionp org-html-standalone-image-predicate
)))
2682 (funcall org-html-standalone-image-predicate paragraph
))
2683 (not (let ((link-count 0))
2684 (org-element-map (org-element-contents paragraph
)
2685 (cons 'plain-text org-element-all-objects
)
2686 (lambda (obj) (case (org-element-type obj
)
2687 (plain-text (org-string-nw-p obj
))
2689 (or (> (incf link-count
) 1)
2690 (not (org-html-inline-image-p obj info
))))
2692 info
'first-match
'link
))))))
2694 (defun org-html-link (link desc info
)
2695 "Transcode a LINK object from Org to HTML.
2697 DESC is the description part of the link, or the empty string.
2698 INFO is a plist holding contextual information. See
2700 (let* ((home (when (plist-get info
:html-link-home
)
2701 (org-trim (plist-get info
:html-link-home
))))
2702 (use-abs-url (plist-get info
:html-link-use-abs-url
))
2703 (link-org-files-as-html-maybe
2705 (lambda (raw-path info
)
2706 "Treat links to `file.org' as links to `file.html', if needed.
2707 See `org-html-link-org-files-as-html'."
2709 ((and org-html-link-org-files-as-html
2711 (downcase (file-name-extension raw-path
"."))))
2712 (concat (file-name-sans-extension raw-path
) "."
2713 (plist-get info
:html-extension
)))
2715 (type (org-element-property :type link
))
2716 (raw-path (org-element-property :path link
))
2717 ;; Ensure DESC really exists, or set it to nil.
2718 (desc (org-string-nw-p desc
))
2721 ((member type
'("http" "https" "ftp" "mailto"))
2724 (concat type
":" raw-path
)) org-link-escape-chars-browser
))
2725 ((string= type
"file")
2726 ;; Treat links to ".org" files as ".html", if needed.
2728 (funcall link-org-files-as-html-maybe raw-path info
))
2729 ;; If file path is absolute, prepend it with protocol
2730 ;; component - "file://".
2731 (cond ((file-name-absolute-p raw-path
)
2733 (concat "file://" (expand-file-name
2735 ((and home use-abs-url
)
2736 (setq raw-path
(concat (file-name-as-directory home
) raw-path
))))
2737 ;; Add search option, if any. A search option can be
2738 ;; relative to a custom-id or a headline title. Append
2739 ;; a hash sign to any unresolved option, as it might point
2741 (let ((option (org-element-property :search-option link
)))
2742 (cond ((not option
) raw-path
)
2743 ((eq (aref option
0) ?
#) (concat raw-path option
))
2746 (org-publish-resolve-external-fuzzy-link
2747 (org-element-property :path link
) option
)))
2749 (if (not destination
) (concat "#" option
)
2751 (mapconcat #'number-to-string
2752 destination
"-")))))))))
2754 ;; Extract attributes from parent's paragraph. HACK: Only do
2755 ;; this for the first link in parent (inner image link for
2756 ;; inline images). This is needed as long as attributes
2757 ;; cannot be set on a per link basis.
2759 (let* ((parent (org-export-get-parent-element link
))
2760 (link (let ((container (org-export-get-parent link
)))
2761 (if (and (eq (org-element-type container
) 'link
)
2762 (org-html-inline-image-p link info
))
2765 (and (eq (org-element-map parent
'link
'identity info t
) link
)
2766 (org-export-read-attribute :attr_html parent
))))
2768 (let ((attr (org-html--make-attribute-string attributes-plist
)))
2769 (if (org-string-nw-p attr
) (concat " " attr
) "")))
2773 ((and org-html-inline-images
2774 (org-export-inline-image-p link org-html-inline-image-rules
))
2775 (org-html--format-image path attributes-plist info
))
2776 ;; Radio target: Transcode target's contents and use them as
2777 ;; link's description.
2778 ((string= type
"radio")
2779 (let ((destination (org-export-resolve-radio-link link info
)))
2781 (format "<a href=\"#%s\"%s>%s</a>"
2782 (org-export-solidify-link-text path
)
2784 (org-export-data (org-element-contents destination
) info
)))))
2785 ;; Links pointing to a headline: Find destination and build
2786 ;; appropriate referencing command.
2787 ((member type
'("custom-id" "fuzzy" "id"))
2788 (let ((destination (if (string= type
"fuzzy")
2789 (org-export-resolve-fuzzy-link link info
)
2790 (org-export-resolve-id-link link info
))))
2791 (case (org-element-type destination
)
2792 ;; ID link points to an external file.
2794 (let ((fragment (concat "ID-" path
))
2795 ;; Treat links to ".org" files as ".html", if needed.
2796 (path (funcall link-org-files-as-html-maybe
2798 (format "<a href=\"%s#%s\"%s>%s</a>"
2799 path fragment attributes
(or desc destination
))))
2800 ;; Fuzzy link points nowhere.
2805 (org-element-property :raw-link link
) info
))))
2806 ;; Link points to a headline.
2809 ;; What href to use?
2811 ;; Case 1: Headline is linked via it's CUSTOM_ID
2812 ;; property. Use CUSTOM_ID.
2813 ((string= type
"custom-id")
2814 (org-element-property :CUSTOM_ID destination
))
2815 ;; Case 2: Headline is linked via it's ID property
2816 ;; or through other means. Use the default href.
2817 ((member type
'("id" "fuzzy"))
2819 (mapconcat 'number-to-string
2820 (org-export-get-headline-number
2821 destination info
) "-")))
2822 (t (error "Shouldn't reach here"))))
2823 ;; What description to use?
2825 ;; Case 1: Headline is numbered and LINK has no
2826 ;; description. Display section number.
2827 (if (and (org-export-numbered-headline-p destination info
)
2829 (mapconcat 'number-to-string
2830 (org-export-get-headline-number
2831 destination info
) ".")
2832 ;; Case 2: Either the headline is un-numbered or
2833 ;; LINK has a custom description. Display LINK's
2834 ;; description or headline's title.
2835 (or desc
(org-export-data (org-element-property
2836 :title destination
) info
)))))
2837 (format "<a href=\"#%s\"%s>%s</a>"
2838 (org-export-solidify-link-text href
) attributes desc
)))
2839 ;; Fuzzy link points to a target or an element.
2841 (let* ((path (org-export-solidify-link-text path
))
2842 (org-html-standalone-image-predicate 'org-html--has-caption-p
)
2845 ((org-html-standalone-image-p destination info
)
2846 (org-export-get-ordinal
2847 (org-element-map destination
'link
2849 info
'link
'org-html-standalone-image-p
))
2850 (t (org-export-get-ordinal
2851 destination info nil
'org-html--has-caption-p
))))
2853 ((not number
) "No description for this link")
2854 ((numberp number
) (number-to-string number
))
2855 (t (mapconcat 'number-to-string number
".")))))
2856 (format "<a href=\"#%s\"%s>%s</a>" path attributes desc
))))))
2857 ;; Coderef: replace link with the reference name or the
2858 ;; equivalent line number.
2859 ((string= type
"coderef")
2860 (let ((fragment (concat "coderef-" path
)))
2861 (format "<a href=\"#%s\"%s%s>%s</a>"
2864 (format (concat "class=\"coderef\""
2865 " onmouseover=\"CodeHighlightOn(this, '%s');\""
2866 " onmouseout=\"CodeHighlightOff(this, '%s');\"")
2869 (format (org-export-get-coderef-format path desc
)
2870 (org-export-resolve-coderef path info
)))))
2871 ;; Link type is handled by a special function.
2872 ((functionp (setq protocol
(nth 2 (assoc type org-link-protocols
))))
2873 (funcall protocol
(org-link-unescape path
) desc
'html
))
2874 ;; External link with a description part.
2875 ((and path desc
) (format "<a href=\"%s\"%s>%s</a>" path attributes desc
))
2876 ;; External link without a description part.
2877 (path (format "<a href=\"%s\"%s>%s</a>" path attributes path
))
2878 ;; No path, only description. Try to do something useful.
2879 (t (format "<i>%s</i>" desc
)))))
2883 (defun org-html-node-property (node-property contents info
)
2884 "Transcode a NODE-PROPERTY element from Org to HTML.
2885 CONTENTS is nil. INFO is a plist holding contextual
2888 (org-element-property :key node-property
)
2889 (let ((value (org-element-property :value node-property
)))
2890 (if value
(concat " " value
) ""))))
2894 (defun org-html-paragraph (paragraph contents info
)
2895 "Transcode a PARAGRAPH element from Org to HTML.
2896 CONTENTS is the contents of the paragraph, as a string. INFO is
2897 the plist used as a communication channel."
2898 (let* ((parent (org-export-get-parent paragraph
))
2899 (parent-type (org-element-type parent
))
2900 (style '((footnote-definition " class=\"footpara\"")))
2901 (extra (or (cadr (assoc parent-type style
)) "")))
2903 ((and (eq (org-element-type parent
) 'item
)
2904 (= (org-element-property :begin paragraph
)
2905 (org-element-property :contents-begin parent
)))
2906 ;; Leading paragraph in a list item have no tags.
2908 ((org-html-standalone-image-p paragraph info
)
2909 ;; Standalone image.
2911 (let ((raw (org-export-data
2912 (org-export-get-caption paragraph
) info
))
2913 (org-html-standalone-image-predicate
2914 'org-html--has-caption-p
))
2915 (if (not (org-string-nw-p raw
)) raw
2917 "<span class=\"figure-number\">"
2918 (format (org-html--translate "Figure %d:" info
)
2919 (org-export-get-ordinal
2920 (org-element-map paragraph
'link
2922 info nil
'org-html-standalone-image-p
))
2924 (label (org-element-property :name paragraph
)))
2925 (org-html--wrap-image contents info caption label
)))
2926 ;; Regular paragraph.
2927 (t (format "<p%s>\n%s</p>" extra contents
)))))
2931 ;; FIXME Maybe arg1 is not needed because <li value="20"> already sets
2932 ;; the correct value for the item counter
2933 (defun org-html-begin-plain-list (type &optional arg1
)
2934 "Insert the beginning of the HTML list depending on TYPE.
2935 When ARG1 is a string, use it as the start parameter for ordered
2939 (format "<ol class=\"org-ol\"%s>"
2940 (if arg1
(format " start=\"%d\"" arg1
) "")))
2941 (unordered "<ul class=\"org-ul\">")
2942 (descriptive "<dl class=\"org-dl\">")))
2944 (defun org-html-end-plain-list (type)
2945 "Insert the end of the HTML list depending on TYPE."
2949 (descriptive "</dl>")))
2951 (defun org-html-plain-list (plain-list contents info
)
2952 "Transcode a PLAIN-LIST element from Org to HTML.
2953 CONTENTS is the contents of the list. INFO is a plist holding
2954 contextual information."
2955 (let* (arg1 ;; (assoc :counter (org-element-map plain-list 'item
2956 (type (org-element-property :type plain-list
)))
2958 (org-html-begin-plain-list type
)
2959 contents
(org-html-end-plain-list type
))))
2963 (defun org-html-convert-special-strings (string)
2964 "Convert special characters in STRING to HTML."
2965 (let ((all org-html-special-string-regexps
)
2967 (while (setq a
(pop all
))
2968 (setq re
(car a
) rpl
(cdr a
) start
0)
2969 (while (string-match re string start
)
2970 (setq string
(replace-match rpl t nil string
))))
2973 (defun org-html-encode-plain-text (text)
2974 "Convert plain text characters from TEXT to HTML equivalent.
2975 Possible conversions are set in `org-html-protect-char-alist'."
2978 (setq text
(replace-regexp-in-string (car pair
) (cdr pair
) text t t
)))
2979 org-html-protect-char-alist
)
2982 (defun org-html-plain-text (text info
)
2983 "Transcode a TEXT string from Org to HTML.
2984 TEXT is the string to transcode. INFO is a plist holding
2985 contextual information."
2986 (let ((output text
))
2987 ;; Protect following characters: <, >, &.
2988 (setq output
(org-html-encode-plain-text output
))
2989 ;; Handle smart quotes. Be sure to provide original string since
2990 ;; OUTPUT may have been modified.
2991 (when (plist-get info
:with-smart-quotes
)
2992 (setq output
(org-export-activate-smart-quotes output
:html info text
)))
2993 ;; Handle special strings.
2994 (when (plist-get info
:with-special-strings
)
2995 (setq output
(org-html-convert-special-strings output
)))
2996 ;; Handle break preservation if required.
2997 (when (plist-get info
:preserve-breaks
)
2999 (replace-regexp-in-string
3000 "\\(\\\\\\\\\\)?[ \t]*\n"
3001 (concat (org-html-close-tag "br" nil info
) "\n") output
)))
3008 (defun org-html-planning (planning contents info
)
3009 "Transcode a PLANNING element from Org to HTML.
3010 CONTENTS is nil. INFO is a plist used as a communication
3012 (let ((span-fmt "<span class=\"timestamp-kwd\">%s</span> <span class=\"timestamp\">%s</span>"))
3014 "<p><span class=\"timestamp-wrapper\">%s</span></p>"
3019 (let ((closed (org-element-property :closed planning
)))
3021 (format span-fmt org-closed-string
3023 (org-element-property :raw-value closed
)))))
3024 (let ((deadline (org-element-property :deadline planning
)))
3026 (format span-fmt org-deadline-string
3028 (org-element-property :raw-value deadline
)))))
3029 (let ((scheduled (org-element-property :scheduled planning
)))
3031 (format span-fmt org-scheduled-string
3033 (org-element-property :raw-value scheduled
)))))))
3036 ;;;; Property Drawer
3038 (defun org-html-property-drawer (property-drawer contents info
)
3039 "Transcode a PROPERTY-DRAWER element from Org to HTML.
3040 CONTENTS holds the contents of the drawer. INFO is a plist
3041 holding contextual information."
3042 (and (org-string-nw-p contents
)
3043 (format "<pre class=\"example\">\n%s</pre>" contents
)))
3047 (defun org-html-quote-block (quote-block contents info
)
3048 "Transcode a QUOTE-BLOCK element from Org to HTML.
3049 CONTENTS holds the contents of the block. INFO is a plist
3050 holding contextual information."
3051 (format "<blockquote>\n%s</blockquote>" contents
))
3055 (defun org-html-quote-section (quote-section contents info
)
3056 "Transcode a QUOTE-SECTION element from Org to HTML.
3057 CONTENTS is nil. INFO is a plist holding contextual information."
3058 (let ((value (org-remove-indentation
3059 (org-element-property :value quote-section
))))
3060 (when value
(format "<pre>\n%s</pre>" value
))))
3064 (defun org-html-section (section contents info
)
3065 "Transcode a SECTION element from Org to HTML.
3066 CONTENTS holds the contents of the section. INFO is a plist
3067 holding contextual information."
3068 (let ((parent (org-export-get-parent-headline section
)))
3069 ;; Before first headline: no container, just return CONTENTS.
3070 (if (not parent
) contents
3071 ;; Get div's class and id references.
3072 (let* ((class-num (+ (org-export-get-relative-level parent info
)
3073 (1- org-html-toplevel-hlevel
)))
3077 (org-export-get-headline-number parent info
) "-")))
3078 ;; Build return value.
3079 (format "<div class=\"outline-text-%d\" id=\"text-%s\">\n%s</div>"
3081 (or (org-element-property :CUSTOM_ID parent
) section-number
)
3086 (defun org-html-radio-target (radio-target text info
)
3087 "Transcode a RADIO-TARGET object from Org to HTML.
3088 TEXT is the text of the target. INFO is a plist holding
3089 contextual information."
3090 (let ((id (org-export-solidify-link-text
3091 (org-element-property :value radio-target
))))
3092 (org-html--anchor id text
)))
3096 (defun org-html-special-block (special-block contents info
)
3097 "Transcode a SPECIAL-BLOCK element from Org to HTML.
3098 CONTENTS holds the contents of the block. INFO is a plist
3099 holding contextual information."
3100 (let* ((block-type (downcase
3101 (org-element-property :type special-block
)))
3102 (contents (or contents
""))
3103 (html5-fancy (and (org-html-html5-p info
)
3104 (plist-get info
:html-html5-fancy
)
3105 (member block-type org-html-html5-elements
)))
3106 (attributes (org-export-read-attribute :attr_html special-block
)))
3108 (let ((class (plist-get attributes
:class
)))
3109 (setq attributes
(plist-put attributes
:class
3110 (if class
(concat class
" " block-type
)
3112 (setq attributes
(org-html--make-attribute-string attributes
))
3113 (when (not (equal attributes
""))
3114 (setq attributes
(concat " " attributes
)))
3116 (format "<%s%s>\n%s</%s>" block-type attributes
3117 contents block-type
)
3118 (format "<div%s>\n%s\n</div>" attributes contents
))))
3122 (defun org-html-src-block (src-block contents info
)
3123 "Transcode a SRC-BLOCK element from Org to HTML.
3124 CONTENTS holds the contents of the item. INFO is a plist holding
3125 contextual information."
3126 (if (org-export-read-attribute :attr_html src-block
:textarea
)
3127 (org-html--textarea-block src-block
)
3128 (let ((lang (org-element-property :language src-block
))
3129 (caption (org-export-get-caption src-block
))
3130 (code (org-html-format-code src-block info
))
3131 (label (let ((lbl (org-element-property :name src-block
)))
3133 (format " id=\"%s\""
3134 (org-export-solidify-link-text lbl
))))))
3135 (if (not lang
) (format "<pre class=\"example\"%s>\n%s</pre>" label code
)
3137 "<div class=\"org-src-container\">\n%s%s\n</div>"
3138 (if (not caption
) ""
3139 (format "<label class=\"org-src-name\">%s</label>"
3140 (org-export-data caption info
)))
3141 (format "\n<pre class=\"src src-%s\"%s>%s</pre>" lang label code
))))))
3143 ;;;; Statistics Cookie
3145 (defun org-html-statistics-cookie (statistics-cookie contents info
)
3146 "Transcode a STATISTICS-COOKIE object from Org to HTML.
3147 CONTENTS is nil. INFO is a plist holding contextual information."
3148 (let ((cookie-value (org-element-property :value statistics-cookie
)))
3149 (format "<code>%s</code>" cookie-value
)))
3153 (defun org-html-strike-through (strike-through contents info
)
3154 "Transcode STRIKE-THROUGH from Org to HTML.
3155 CONTENTS is the text with strike-through markup. INFO is a plist
3156 holding contextual information."
3157 (format (or (cdr (assq 'strike-through org-html-text-markup-alist
)) "%s")
3162 (defun org-html-subscript (subscript contents info
)
3163 "Transcode a SUBSCRIPT object from Org to HTML.
3164 CONTENTS is the contents of the object. INFO is a plist holding
3165 contextual information."
3166 (format "<sub>%s</sub>" contents
))
3170 (defun org-html-superscript (superscript contents info
)
3171 "Transcode a SUPERSCRIPT object from Org to HTML.
3172 CONTENTS is the contents of the object. INFO is a plist holding
3173 contextual information."
3174 (format "<sup>%s</sup>" contents
))
3178 (defun org-html-table-cell (table-cell contents info
)
3179 "Transcode a TABLE-CELL element from Org to HTML.
3180 CONTENTS is nil. INFO is a plist used as a communication
3182 (let* ((table-row (org-export-get-parent table-cell
))
3183 (table (org-export-get-parent-table table-cell
))
3185 (if (not org-html-table-align-individual-fields
) ""
3186 (format (if (and (boundp 'org-html-format-table-no-css
)
3187 org-html-format-table-no-css
)
3188 " align=\"%s\"" " class=\"%s\"")
3189 (org-export-table-cell-alignment table-cell info
)))))
3190 (when (or (not contents
) (string= "" (org-trim contents
)))
3191 (setq contents
" "))
3193 ((and (org-export-table-has-header-p table info
)
3194 (= 1 (org-export-table-row-group table-row info
)))
3195 (concat "\n" (format (car org-html-table-header-tags
) "col" cell-attrs
)
3196 contents
(cdr org-html-table-header-tags
)))
3197 ((and org-html-table-use-header-tags-for-first-column
3198 (zerop (cdr (org-export-table-cell-address table-cell info
))))
3199 (concat "\n" (format (car org-html-table-header-tags
) "row" cell-attrs
)
3200 contents
(cdr org-html-table-header-tags
)))
3201 (t (concat "\n" (format (car org-html-table-data-tags
) cell-attrs
)
3202 contents
(cdr org-html-table-data-tags
))))))
3206 (defun org-html-table-row (table-row contents info
)
3207 "Transcode a TABLE-ROW element from Org to HTML.
3208 CONTENTS is the contents of the row. INFO is a plist used as a
3209 communication channel."
3210 ;; Rules are ignored since table separators are deduced from
3211 ;; borders of the current row.
3212 (when (eq (org-element-property :type table-row
) 'standard
)
3213 (let* ((rowgroup-number (org-export-table-row-group table-row info
))
3214 (row-number (org-export-table-row-number table-row info
))
3216 (org-export-table-row-starts-rowgroup-p table-row info
))
3218 (org-export-table-row-ends-rowgroup-p table-row info
))
3219 ;; `top-row-p' and `end-rowgroup-p' are not used directly
3220 ;; but should be set so that `org-html-table-row-tags' can
3221 ;; use them (see the docstring of this variable.)
3222 (top-row-p (and (equal start-rowgroup-p
'(top))
3223 (equal end-rowgroup-p
'(below top
))))
3224 (bottom-row-p (and (equal start-rowgroup-p
'(above))
3225 (equal end-rowgroup-p
'(bottom above
))))
3228 ;; Case 1: Row belongs to second or subsequent rowgroups.
3229 ((not (= 1 rowgroup-number
))
3230 '("<tbody>" .
"\n</tbody>"))
3231 ;; Case 2: Row is from first rowgroup. Table has >=1 rowgroups.
3232 ((org-export-table-has-header-p
3233 (org-export-get-parent-table table-row
) info
)
3234 '("<thead>" .
"\n</thead>"))
3235 ;; Case 2: Row is from first and only row group.
3236 (t '("<tbody>" .
"\n</tbody>")))))
3238 ;; Begin a rowgroup?
3239 (when start-rowgroup-p
(car rowgroup-tags
))
3241 (concat "\n" (eval (car org-html-table-row-tags
))
3244 (eval (cdr org-html-table-row-tags
)))
3246 (when end-rowgroup-p
(cdr rowgroup-tags
))))))
3250 (defun org-html-table-first-row-data-cells (table info
)
3251 "Transcode the first row of TABLE.
3252 INFO is a plist used as a communication channel."
3254 (org-element-map table
'table-row
3256 (unless (eq (org-element-property :type row
) 'rule
) row
))
3258 (special-column-p (org-export-table-has-special-column-p table
)))
3259 (if (not special-column-p
) (org-element-contents table-row
)
3260 (cdr (org-element-contents table-row
)))))
3262 (defun org-html-table--table.el-table
(table info
)
3263 "Format table.el tables into HTML.
3264 INFO is a plist used as a communication channel."
3265 (when (eq (org-element-property :type table
) 'table.el
)
3267 (let ((outbuf (with-current-buffer
3268 (get-buffer-create "*org-export-table*")
3269 (erase-buffer) (current-buffer))))
3271 (insert (org-element-property :value table
))
3273 (re-search-forward "^[ \t]*|[^|]" nil t
)
3274 (table-generate-source 'html outbuf
))
3275 (with-current-buffer outbuf
3276 (prog1 (org-trim (buffer-string))
3279 (defun org-html-table (table contents info
)
3280 "Transcode a TABLE element from Org to HTML.
3281 CONTENTS is the contents of the table. INFO is a plist holding
3282 contextual information."
3283 (case (org-element-property :type table
)
3284 ;; Case 1: table.el table. Convert it using appropriate tools.
3285 (table.el
(org-html-table--table.el-table table info
))
3286 ;; Case 2: Standard table.
3288 (let* ((label (org-element-property :name table
))
3289 (caption (org-export-get-caption table
))
3290 (number (org-export-get-ordinal
3291 table info nil
'org-html--has-caption-p
))
3293 (org-html--make-attribute-string
3295 (and label
(list :id
(org-export-solidify-link-text label
)))
3296 (and (not (org-html-html5-p info
))
3297 (plist-get info
:html-table-attributes
))
3298 (org-export-read-attribute :attr_html table
))))
3300 (if (and (boundp 'org-html-format-table-no-css
)
3301 org-html-format-table-no-css
)
3302 "align=\"%s\"" "class=\"%s\""))
3305 (lambda (table info
)
3307 (lambda (table-cell)
3308 (let ((alignment (org-export-table-cell-alignment
3311 ;; Begin a colgroup?
3312 (when (org-export-table-cell-starts-colgroup-p
3315 ;; Add a column. Also specify it's alignment.
3318 "col" (concat " " (format alignspec alignment
)) info
))
3320 (when (org-export-table-cell-ends-colgroup-p
3323 (org-html-table-first-row-data-cells table info
) "\n")))))
3324 (format "<table%s>\n%s\n%s\n%s</table>"
3325 (if (equal attributes
"") "" (concat " " attributes
))
3326 (if (not caption
) ""
3327 (format (if org-html-table-caption-above
3328 "<caption class=\"t-above\">%s</caption>"
3329 "<caption class=\"t-bottom\">%s</caption>")
3331 "<span class=\"table-number\">"
3332 (format (org-html--translate "Table %d:" info
) number
)
3333 "</span> " (org-export-data caption info
))))
3334 (funcall table-column-specs table info
)
3339 (defun org-html-target (target contents info
)
3340 "Transcode a TARGET object from Org to HTML.
3341 CONTENTS is nil. INFO is a plist holding contextual
3343 (let ((id (org-export-solidify-link-text
3344 (org-element-property :value target
))))
3345 (org-html--anchor id
)))
3349 (defun org-html-timestamp (timestamp contents info
)
3350 "Transcode a TIMESTAMP object from Org to HTML.
3351 CONTENTS is nil. INFO is a plist holding contextual
3353 (let ((value (org-html-plain-text
3354 (org-timestamp-translate timestamp
) info
)))
3355 (format "<span class=\"timestamp-wrapper\"><span class=\"timestamp\">%s</span></span>"
3356 (replace-regexp-in-string "--" "–" value
))))
3360 (defun org-html-underline (underline contents info
)
3361 "Transcode UNDERLINE from Org to HTML.
3362 CONTENTS is the text with underline markup. INFO is a plist
3363 holding contextual information."
3364 (format (or (cdr (assq 'underline org-html-text-markup-alist
)) "%s")
3369 (defun org-html-verbatim (verbatim contents info
)
3370 "Transcode VERBATIM from Org to HTML.
3371 CONTENTS is nil. INFO is a plist holding contextual
3373 (format (or (cdr (assq 'verbatim org-html-text-markup-alist
)) "%s")
3374 (org-html-encode-plain-text (org-element-property :value verbatim
))))
3378 (defun org-html-verse-block (verse-block contents info
)
3379 "Transcode a VERSE-BLOCK element from Org to HTML.
3380 CONTENTS is verse block contents. INFO is a plist holding
3381 contextual information."
3382 ;; Replace each newline character with line break. Also replace
3383 ;; each blank line with a line break.
3384 (setq contents
(replace-regexp-in-string
3385 "^ *\\\\\\\\$" (format "%s\n" (org-html-close-tag "br" nil info
))
3386 (replace-regexp-in-string
3387 "\\(\\\\\\\\\\)?[ \t]*\n"
3388 (format "%s\n" (org-html-close-tag "br" nil info
)) contents
)))
3389 ;; Replace each white space at beginning of a line with a
3390 ;; non-breaking space.
3391 (while (string-match "^[ \t]+" contents
)
3392 (let* ((num-ws (length (match-string 0 contents
)))
3393 (ws (let (out) (dotimes (i num-ws out
)
3394 (setq out
(concat out
" "))))))
3395 (setq contents
(replace-match ws nil t contents
))))
3396 (format "<p class=\"verse\">\n%s</p>" contents
))
3399 ;;; Filter Functions
3401 (defun org-html-final-function (contents backend info
)
3402 "Filter to indent the HTML and convert HTML entities."
3407 (indent-region (point-min) (point-max)))
3408 (when org-html-use-unicode-chars
3410 (mm-url-decode-entities))
3411 (buffer-substring-no-properties (point-min) (point-max))))
3414 ;;; End-user functions
3417 (defun org-html-export-as-html
3418 (&optional async subtreep visible-only body-only ext-plist
)
3419 "Export current buffer to an HTML buffer.
3421 If narrowing is active in the current buffer, only export its
3424 If a region is active, export that region.
3426 A non-nil optional argument ASYNC means the process should happen
3427 asynchronously. The resulting buffer should be accessible
3428 through the `org-export-stack' interface.
3430 When optional argument SUBTREEP is non-nil, export the sub-tree
3431 at point, extracting information from the headline properties
3434 When optional argument VISIBLE-ONLY is non-nil, don't export
3435 contents of hidden elements.
3437 When optional argument BODY-ONLY is non-nil, only write code
3438 between \"<body>\" and \"</body>\" tags.
3440 EXT-PLIST, when provided, is a property list with external
3441 parameters overriding Org default settings, but still inferior to
3442 file-local settings.
3444 Export is done in a buffer named \"*Org HTML Export*\", which
3445 will be displayed when `org-export-show-temporary-export-buffer'
3448 (org-export-to-buffer 'html
"*Org HTML Export*"
3449 async subtreep visible-only body-only ext-plist
3450 (lambda () (set-auto-mode t
))))
3453 (defun org-html-convert-region-to-html ()
3454 "Assume the current region has org-mode syntax, and convert it to HTML.
3455 This can be used in any buffer. For example, you can write an
3456 itemized list in org-mode syntax in an HTML buffer and use this
3457 command to convert it."
3459 (org-export-replace-region-by 'html
))
3462 (defun org-html-export-to-html
3463 (&optional async subtreep visible-only body-only ext-plist
)
3464 "Export current buffer to a HTML file.
3466 If narrowing is active in the current buffer, only export its
3469 If a region is active, export that region.
3471 A non-nil optional argument ASYNC means the process should happen
3472 asynchronously. The resulting file should be accessible through
3473 the `org-export-stack' interface.
3475 When optional argument SUBTREEP is non-nil, export the sub-tree
3476 at point, extracting information from the headline properties
3479 When optional argument VISIBLE-ONLY is non-nil, don't export
3480 contents of hidden elements.
3482 When optional argument BODY-ONLY is non-nil, only write code
3483 between \"<body>\" and \"</body>\" tags.
3485 EXT-PLIST, when provided, is a property list with external
3486 parameters overriding Org default settings, but still inferior to
3487 file-local settings.
3489 Return output file's name."
3491 (let* ((extension (concat "." org-html-extension
))
3492 (file (org-export-output-file-name extension subtreep
))
3493 (org-export-coding-system org-html-coding-system
))
3494 (org-export-to-file 'html file
3495 async subtreep visible-only body-only ext-plist
)))
3498 (defun org-html-publish-to-html (plist filename pub-dir
)
3499 "Publish an org file to HTML.
3501 FILENAME is the filename of the Org file to be published. PLIST
3502 is the property list for the given project. PUB-DIR is the
3503 publishing directory.
3505 Return output file name."
3506 (org-publish-org-to 'html filename
3507 (concat "." (or (plist-get plist
:html-extension
)
3508 org-html-extension
"html"))
3515 ;; generated-autoload-file: "org-loaddefs.el"
3518 ;;; ox-html.el ends here