ox: Fix a test
[org-mode.git] / lisp / ox-html.el
blob14b31b27b702a0a6ae03f258662d0f0ee5492fb5
1 ;;; ox-html.el --- HTML Back-End for Org Export Engine
3 ;; Copyright (C) 2011-2013 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 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
22 ;;; Commentary:
24 ;; This library implements a HTML back-end for Org generic exporter.
26 ;; To test it, run:
28 ;; M-x org-html-export-as-html
30 ;; in an Org mode buffer. See ox.el for more details on how this
31 ;; exporter works.
33 ;;; Code:
35 ;;; Dependencies
37 (require 'ox)
38 (require 'ox-publish)
39 (require 'format-spec)
40 (eval-when-compile (require 'cl) (require 'table nil 'noerror))
43 ;;; Function Declarations
45 (declare-function org-id-find-id-file "org-id" (id))
46 (declare-function htmlize-region "ext:htmlize" (beg end))
47 (declare-function org-pop-to-buffer-same-window
48 "org-compat" (&optional buffer-or-name norecord label))
49 (declare-function mm-url-decode-entities "mm-url" ())
51 ;;; Define Back-End
53 (org-export-define-backend 'html
54 '((bold . org-html-bold)
55 (center-block . org-html-center-block)
56 (clock . org-html-clock)
57 (code . org-html-code)
58 (drawer . org-html-drawer)
59 (dynamic-block . org-html-dynamic-block)
60 (entity . org-html-entity)
61 (example-block . org-html-example-block)
62 (export-block . org-html-export-block)
63 (export-snippet . org-html-export-snippet)
64 (fixed-width . org-html-fixed-width)
65 (footnote-definition . org-html-footnote-definition)
66 (footnote-reference . org-html-footnote-reference)
67 (headline . org-html-headline)
68 (horizontal-rule . org-html-horizontal-rule)
69 (inline-src-block . org-html-inline-src-block)
70 (inlinetask . org-html-inlinetask)
71 (inner-template . org-html-inner-template)
72 (italic . org-html-italic)
73 (item . org-html-item)
74 (keyword . org-html-keyword)
75 (latex-environment . org-html-latex-environment)
76 (latex-fragment . org-html-latex-fragment)
77 (line-break . org-html-line-break)
78 (link . org-html-link)
79 (paragraph . org-html-paragraph)
80 (plain-list . org-html-plain-list)
81 (plain-text . org-html-plain-text)
82 (planning . org-html-planning)
83 (property-drawer . org-html-property-drawer)
84 (quote-block . org-html-quote-block)
85 (quote-section . org-html-quote-section)
86 (radio-target . org-html-radio-target)
87 (section . org-html-section)
88 (special-block . org-html-special-block)
89 (src-block . org-html-src-block)
90 (statistics-cookie . org-html-statistics-cookie)
91 (strike-through . org-html-strike-through)
92 (subscript . org-html-subscript)
93 (superscript . org-html-superscript)
94 (table . org-html-table)
95 (table-cell . org-html-table-cell)
96 (table-row . org-html-table-row)
97 (target . org-html-target)
98 (template . org-html-template)
99 (timestamp . org-html-timestamp)
100 (underline . org-html-underline)
101 (verbatim . org-html-verbatim)
102 (verse-block . org-html-verse-block))
103 :export-block "HTML"
104 :filters-alist '((:filter-options . org-html-infojs-install-script)
105 (:filter-final-output . org-html-final-function))
106 :menu-entry
107 '(?h "Export to HTML"
108 ((?H "As HTML buffer" org-html-export-as-html)
109 (?h "As HTML file" org-html-export-to-html)
110 (?o "As HTML file and open"
111 (lambda (a s v b)
112 (if a (org-html-export-to-html t s v b)
113 (org-open-file (org-html-export-to-html nil s v b)))))))
114 :options-alist
115 '((:html-extension nil nil org-html-extension)
116 (:html-link-org-as-html nil nil org-html-link-org-files-as-html)
117 (:html-doctype "HTML_DOCTYPE" nil org-html-doctype)
118 (:html-container "HTML_CONTAINER" nil org-html-container-element)
119 (:html-html5-fancy nil "html5-fancy" org-html-html5-fancy)
120 (:html-link-use-abs-url nil "html-link-use-abs-url" org-html-link-use-abs-url)
121 (:html-link-home "HTML_LINK_HOME" nil org-html-link-home)
122 (:html-link-up "HTML_LINK_UP" nil org-html-link-up)
123 (:html-mathjax "HTML_MATHJAX" nil "" space)
124 (:html-postamble nil "html-postamble" org-html-postamble)
125 (:html-preamble nil "html-preamble" org-html-preamble)
126 (:html-head "HTML_HEAD" nil org-html-head newline)
127 (:html-head-extra "HTML_HEAD_EXTRA" nil org-html-head-extra newline)
128 (:html-head-include-default-style nil "html-style" org-html-head-include-default-style)
129 (:html-head-include-scripts nil "html-scripts" org-html-head-include-scripts)
130 (:html-table-attributes nil nil org-html-table-default-attributes)
131 (:html-table-row-tags nil nil org-html-table-row-tags)
132 (:html-xml-declaration nil nil org-html-xml-declaration)
133 (:html-inline-images nil nil org-html-inline-images)
134 (:infojs-opt "INFOJS_OPT" nil nil)
135 ;; Redefine regular options.
136 (:creator "CREATOR" nil org-html-creator-string)
137 (:with-latex nil "tex" org-html-with-latex)))
140 ;;; Internal Variables
142 (defvar org-html-format-table-no-css)
143 (defvar htmlize-buffer-places) ; from htmlize.el
145 (defvar org-html--pre/postamble-class "status"
146 "CSS class used for pre/postamble")
148 (defconst org-html-doctype-alist
149 '(("html4-strict" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"
150 \"http://www.w3.org/TR/html4/strict.dtd\">")
151 ("html4-transitional" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\"
152 \"http://www.w3.org/TR/html4/loose.dtd\">")
153 ("html4-frameset" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Frameset//EN\"
154 \"http://www.w3.org/TR/html4/frameset.dtd\">")
156 ("xhtml-strict" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
157 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">")
158 ("xhtml-transitional" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"
159 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">")
160 ("xhtml-framset" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Frameset//EN\"
161 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd\">")
162 ("xhtml-11" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\"
163 \"http://www.w3.org/TR/xhtml1/DTD/xhtml11.dtd\">")
165 ("html5" . "<!DOCTYPE html>")
166 ("xhtml5" . "<!DOCTYPE html>"))
167 "An alist mapping (x)html flavors to specific doctypes.")
169 (defconst org-html-html5-elements
170 '("article" "aside" "audio" "canvas" "details" "figcaption"
171 "figure" "footer" "header" "menu" "meter" "nav" "output"
172 "progress" "section" "video")
173 "New elements in html5.
175 <hgroup> is not included because it's currently impossible to
176 wrap special blocks around multiple headlines. For other blocks
177 that should contain headlines, use the HTML_CONTAINER property on
178 the headline itself.")
180 (defconst org-html-special-string-regexps
181 '(("\\\\-" . "&#x00ad;") ; shy
182 ("---\\([^-]\\)" . "&#x2014;\\1") ; mdash
183 ("--\\([^-]\\)" . "&#x2013;\\1") ; ndash
184 ("\\.\\.\\." . "&#x2026;")) ; hellip
185 "Regular expressions for special string conversion.")
187 (defconst org-html-scripts
188 "<script type=\"text/javascript\">
190 @licstart The following is the entire license notice for the
191 JavaScript code in this tag.
193 Copyright (C) 2012 Free Software Foundation, Inc.
195 The JavaScript code in this tag is free software: you can
196 redistribute it and/or modify it under the terms of the GNU
197 General Public License (GNU GPL) as published by the Free Software
198 Foundation, either version 3 of the License, or (at your option)
199 any later version. The code is distributed WITHOUT ANY WARRANTY;
200 without even the implied warranty of MERCHANTABILITY or FITNESS
201 FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
203 As additional permission under GNU GPL version 3 section 7, you
204 may distribute non-source (e.g., minimized or compacted) forms of
205 that code without the copy of the GNU GPL normally required by
206 section 4, provided you include this license notice and a URL
207 through which recipients can access the Corresponding Source.
210 @licend The above is the entire license notice
211 for the JavaScript code in this tag.
213 <!--/*--><![CDATA[/*><!--*/
214 function CodeHighlightOn(elem, id)
216 var target = document.getElementById(id);
217 if(null != target) {
218 elem.cacheClassElem = elem.className;
219 elem.cacheClassTarget = target.className;
220 target.className = \"code-highlighted\";
221 elem.className = \"code-highlighted\";
224 function CodeHighlightOff(elem, id)
226 var target = document.getElementById(id);
227 if(elem.cacheClassElem)
228 elem.className = elem.cacheClassElem;
229 if(elem.cacheClassTarget)
230 target.className = elem.cacheClassTarget;
232 /*]]>*///-->
233 </script>"
234 "Basic JavaScript that is needed by HTML files produced by Org mode.")
236 (defconst org-html-style-default
237 "<style type=\"text/css\">
238 <!--/*--><![CDATA[/*><!--*/
239 .title { text-align: center; }
240 .todo { font-family: monospace; color: red; }
241 .done { color: green; }
242 .tag { background-color: #eee; font-family: monospace;
243 padding: 2px; font-size: 80%; font-weight: normal; }
244 .timestamp { color: #bebebe; }
245 .timestamp-kwd { color: #5f9ea0; }
246 .right { margin-left: auto; margin-right: 0px; text-align: right; }
247 .left { margin-left: 0px; margin-right: auto; text-align: left; }
248 .center { margin-left: auto; margin-right: auto; text-align: center; }
249 .underline { text-decoration: underline; }
250 #postamble p, #preamble p { font-size: 90%; margin: .2em; }
251 p.verse { margin-left: 3%; }
252 pre {
253 border: 1px solid #ccc;
254 box-shadow: 3px 3px 3px #eee;
255 padding: 8pt;
256 font-family: monospace;
257 overflow: auto;
258 margin: 1.2em;
260 pre.src {
261 position: relative;
262 overflow: visible;
263 padding-top: 1.2em;
265 pre.src:before {
266 display: none;
267 position: absolute;
268 background-color: white;
269 top: -10px;
270 right: 10px;
271 padding: 3px;
272 border: 1px solid black;
274 pre.src:hover:before { display: inline;}
275 pre.src-sh:before { content: 'sh'; }
276 pre.src-bash:before { content: 'sh'; }
277 pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
278 pre.src-R:before { content: 'R'; }
279 pre.src-perl:before { content: 'Perl'; }
280 pre.src-java:before { content: 'Java'; }
281 pre.src-sql:before { content: 'SQL'; }
283 table { border-collapse:collapse; }
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; }
297 .inlinetask {
298 padding: 10px;
299 border: 2px solid gray;
300 margin: 10px;
301 background: #ffffcc;
303 #org-div-home-and-up
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; }
313 /*]]>*/-->
314 </style>"
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"
326 :group 'org-export)
328 ;;;; Handle infojs
330 (defvar org-html-infojs-opts-table
331 '((path PATH "http://orgmode.org/org-info.js")
332 (view VIEW "info")
333 (toc TOC :with-toc)
334 (ftoc FIXED_TOC "0")
335 (tdepth TOC_DEPTH "max")
336 (sdepth SECTION_DEPTH "max")
337 (mouse MOUSE_HINT "underline")
338 (buttons VIEW_BUTTONS "0")
339 (ltoc LOCAL_TOC "1")
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
352 :version "24.4"
353 :package-version '(Org . "8.0")
354 :type '(choice
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
369 :version "24.4"
370 :package-version '(Org . "8.0")
371 :type
372 `(set :greedy t :inline t
373 ,@(mapcar
374 (lambda (x)
375 (list 'cons (list 'const (car x))
376 '(choice
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 Sebastian Rose
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.
411 </script>
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[/*><!--*/
441 %MANAGER_OPTIONS
442 org_html_manager.setup(); // activate after the parameters are set
443 /*]]>*///-->
444 </script>"
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
448 :version "24.4"
449 :package-version '(Org . "8.0")
450 :type 'string)
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))
465 (sdepth hlevels)
466 (tdepth (if (integerp ptoc) (min ptoc hlevels) hlevels))
467 (options (plist-get exp-plist :infojs-opt))
468 (table org-html-infojs-opts-table)
469 style)
470 (dolist (entry table)
471 (let* ((opt (car entry))
472 (var (nth 1 entry))
473 ;; Compute default values for script option OPT from
474 ;; `org-html-infojs-options' variable.
475 (default
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)
479 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)
484 options))
485 (match-string 1 options)
486 default)))
487 (case opt
488 (path (setq template
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))))
495 (otherwise (setq val
496 (cond
497 ((or (eq val t) (equal val "t")) "1")
498 ((or (eq val nil) (equal val "nil")) "0")
499 ((stringp val) val)
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
505 ;; TDEPTH option.
506 (setq exp-plist (plist-put exp-plist :with-toc sdepth))
507 ;; The table of contents should not show more sections than we
508 ;; generate.
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\");"
514 (car x)
515 (cdr x)))
516 style "\n"))
517 (when (and style (> (length style) 0))
518 (and (string-match "%MANAGER_OPTIONS" template)
519 (setq style (replace-match style t t template))
520 (setq exp-plist
521 (plist-put
522 exp-plist :html-head-extra
523 (concat (or (plist-get exp-plist :html-head-extra) "")
524 "\n"
525 style)))))
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.
531 exp-plist)))
533 ;;;; Bold, etc.
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
549 returned as-is."
550 :group 'org-export-html
551 :type '(alist :key-type (symbol :tag "Markup type")
552 :value-type (string :tag "Format string"))
553 :options '(bold code italic strike-through underline verbatim))
555 (defcustom org-html-indent nil
556 "Non-nil means to indent the generated HTML.
557 Warning: non-nil may break indentation of source code blocks."
558 :group 'org-export-html
559 :version "24.4"
560 :package-version '(Org . "8.0")
561 :type 'boolean)
563 (defcustom org-html-use-unicode-chars nil
564 "Non-nil means to use unicode characters instead of HTML entities."
565 :group 'org-export-html
566 :version "24.4"
567 :package-version '(Org . "8.0")
568 :type 'boolean)
570 ;;;; Drawers
572 (defcustom org-html-format-drawer-function nil
573 "Function called to format a drawer in HTML code.
575 The function must accept two parameters:
576 NAME the drawer name, like \"LOGBOOK\"
577 CONTENTS the contents of the drawer.
579 The function should return the string to be exported.
581 For example, the variable could be set to the following function
582 in order to mimic default behaviour:
584 \(defun org-html-format-drawer-default \(name contents\)
585 \"Format a drawer element for HTML export.\"
586 contents\)"
587 :group 'org-export-html
588 :type 'function)
590 ;;;; Footnotes
592 (defcustom org-html-footnotes-section "<div id=\"footnotes\">
593 <h2 class=\"footnotes\">%s: </h2>
594 <div id=\"text-footnotes\">
596 </div>
597 </div>"
598 "Format for the footnotes section.
599 Should contain a two instances of %s. The first will be replaced with the
600 language-specific word for \"Footnotes\", the second one will be replaced
601 by the footnotes themselves."
602 :group 'org-export-html
603 :type 'string)
605 (defcustom org-html-footnote-format "<sup>%s</sup>"
606 "The format for the footnote reference.
607 %s will be replaced by the footnote reference itself."
608 :group 'org-export-html
609 :type 'string)
611 (defcustom org-html-footnote-separator "<sup>, </sup>"
612 "Text used to separate footnotes."
613 :group 'org-export-html
614 :type 'string)
616 ;;;; Headline
618 (defcustom org-html-toplevel-hlevel 2
619 "The <H> level for level 1 headings in HTML export.
620 This is also important for the classes that will be wrapped around headlines
621 and outline structure. If this variable is 1, the top-level headlines will
622 be <h1>, and the corresponding classes will be outline-1, section-number-1,
623 and outline-text-1. If this is 2, all of these will get a 2 instead.
624 The default for this variable is 2, because we use <h1> for formatting the
625 document title."
626 :group 'org-export-html
627 :type 'integer)
629 (defcustom org-html-format-headline-function nil
630 "Function to format headline text.
632 This function will be called with 5 arguments:
633 TODO the todo keyword (string or nil).
634 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
635 PRIORITY the priority of the headline (integer or nil)
636 TEXT the main headline text (string).
637 TAGS the tags (string or nil).
639 The function result will be used in the section format string."
640 :group 'org-export-html
641 :type 'function)
643 ;;;; HTML-specific
645 (defcustom org-html-allow-name-attribute-in-anchors t
646 "When nil, do not set \"name\" attribute in anchors.
647 By default, anchors are formatted with both \"id\" and \"name\"
648 attributes, when appropriate."
649 :group 'org-export-html
650 :version "24.4"
651 :package-version '(Org . "8.0")
652 :type 'boolean)
654 ;;;; Inlinetasks
656 (defcustom org-html-format-inlinetask-function nil
657 "Function called to format an inlinetask in HTML code.
659 The function must accept six parameters:
660 TODO the todo keyword, as a string
661 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
662 PRIORITY the inlinetask priority, as a string
663 NAME the inlinetask name, as a string.
664 TAGS the inlinetask tags, as a list of strings.
665 CONTENTS the contents of the inlinetask, as a string.
667 The function should return the string to be exported."
668 :group 'org-export-html
669 :type 'function)
671 ;;;; LaTeX
673 (defcustom org-html-with-latex org-export-with-latex
674 "Non-nil means process LaTeX math snippets.
676 When set, the exporter will process LaTeX environments and
677 fragments.
679 This option can also be set with the +OPTIONS line,
680 e.g. \"tex:mathjax\". Allowed values are:
682 nil Ignore math snippets.
683 `verbatim' Keep everything in verbatim
684 `dvipng' Process the LaTeX fragments to images. This will also
685 include processing of non-math environments.
686 `imagemagick' Convert the LaTeX fragments to pdf files and use
687 imagemagick to convert pdf files to png files.
688 `mathjax' Do MathJax preprocessing and arrange for MathJax.js to
689 be loaded.
690 t Synonym for `mathjax'."
691 :group 'org-export-html
692 :version "24.4"
693 :package-version '(Org . "8.0")
694 :type '(choice
695 (const :tag "Do not process math in any way" nil)
696 (const :tag "Use dvipng to make images" dvipng)
697 (const :tag "Use imagemagick to make images" imagemagick)
698 (const :tag "Use MathJax to display math" mathjax)
699 (const :tag "Leave math verbatim" verbatim)))
701 ;;;; Links :: Generic
703 (defcustom org-html-link-org-files-as-html t
704 "Non-nil means make file links to `file.org' point to `file.html'.
705 When `org-mode' is exporting an `org-mode' file to HTML, links to
706 non-html files are directly put into a href tag in HTML.
707 However, links to other Org-mode files (recognized by the
708 extension `.org.) should become links to the corresponding html
709 file, assuming that the linked `org-mode' file will also be
710 converted to HTML.
711 When nil, the links still point to the plain `.org' file."
712 :group 'org-export-html
713 :type 'boolean)
715 ;;;; Links :: Inline images
717 (defcustom org-html-inline-images t
718 "Non-nil means inline images into exported HTML pages.
719 This is done using an <img> tag. When nil, an anchor with href is used to
720 link to the image."
721 :group 'org-export-html
722 :version "24.4"
723 :package-version '(Org . "8.1")
724 :type 'boolean)
726 (defcustom org-html-inline-image-rules
727 '(("file" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")
728 ("http" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")
729 ("https" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'"))
730 "Rules characterizing image files that can be inlined into HTML.
731 A rule consists in an association whose key is the type of link
732 to consider, and value is a regexp that will be matched against
733 link's path."
734 :group 'org-export-html
735 :version "24.4"
736 :package-version '(Org . "8.0")
737 :type '(alist :key-type (string :tag "Type")
738 :value-type (regexp :tag "Path")))
740 ;;;; Plain Text
742 (defcustom org-html-protect-char-alist
743 '(("&" . "&amp;")
744 ("<" . "&lt;")
745 (">" . "&gt;"))
746 "Alist of characters to be converted by `org-html-protect'."
747 :group 'org-export-html
748 :type '(repeat (cons (string :tag "Character")
749 (string :tag "HTML equivalent"))))
751 ;;;; Src Block
753 (defcustom org-html-htmlize-output-type 'inline-css
754 "Output type to be used by htmlize when formatting code snippets.
755 Choices are `css', to export the CSS selectors only, or `inline-css', to
756 export the CSS attribute values inline in the HTML. We use as default
757 `inline-css', in order to make the resulting HTML self-containing.
759 However, this will fail when using Emacs in batch mode for export, because
760 then no rich font definitions are in place. It will also not be good if
761 people with different Emacs setup contribute HTML files to a website,
762 because the fonts will represent the individual setups. In these cases,
763 it is much better to let Org/Htmlize assign classes only, and to use
764 a style file to define the look of these classes.
765 To get a start for your css file, start Emacs session and make sure that
766 all the faces you are interested in are defined, for example by loading files
767 in all modes you want. Then, use the command
768 \\[org-html-htmlize-generate-css] to extract class definitions."
769 :group 'org-export-html
770 :type '(choice (const css) (const inline-css)))
772 (defcustom org-html-htmlize-font-prefix "org-"
773 "The prefix for CSS class names for htmlize font specifications."
774 :group 'org-export-html
775 :type 'string)
777 ;;;; Table
779 (defcustom org-html-table-default-attributes
780 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups" :frame "hsides")
781 "Default attributes and values which will be used in table tags.
782 This is a plist where attributes are symbols, starting with
783 colons, and values are strings.
785 When exporting to HTML5, these values will be disregarded."
786 :group 'org-export-html
787 :version "24.4"
788 :package-version '(Org . "8.0")
789 :type '(plist :key-type (symbol :tag "Property")
790 :value-type (string :tag "Value")))
792 (defcustom org-html-table-header-tags '("<th scope=\"%s\"%s>" . "</th>")
793 "The opening tag for table header fields.
794 This is customizable so that alignment options can be specified.
795 The first %s will be filled with the scope of the field, either row or col.
796 The second %s will be replaced by a style entry to align the field.
797 See also the variable `org-html-table-use-header-tags-for-first-column'.
798 See also the variable `org-html-table-align-individual-fields'."
799 :group 'org-export-html
800 :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
802 (defcustom org-html-table-data-tags '("<td%s>" . "</td>")
803 "The opening tag for table data fields.
804 This is customizable so that alignment options can be specified.
805 The first %s will be filled with the scope of the field, either row or col.
806 The second %s will be replaced by a style entry to align the field.
807 See also the variable `org-html-table-align-individual-fields'."
808 :group 'org-export-html
809 :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
811 (defcustom org-html-table-row-tags '("<tr>" . "</tr>")
812 "The opening and ending tags for table rows.
813 This is customizable so that alignment options can be specified.
814 Instead of strings, these can be Lisp forms that will be
815 evaluated for each row in order to construct the table row tags.
817 During evaluation, these variables will be dynamically bound so that
818 you can reuse them:
820 `row-number': row number (0 is the first row)
821 `rowgroup-number': group number of current row
822 `start-rowgroup-p': non-nil means the row starts a group
823 `end-rowgroup-p': non-nil means the row ends a group
824 `top-row-p': non-nil means this is the top row
825 `bottom-row-p': non-nil means this is the bottom row
827 For example:
829 \(setq org-html-table-row-tags
830 (cons '(cond (top-row-p \"<tr class=\\\"tr-top\\\">\")
831 (bottom-row-p \"<tr class=\\\"tr-bottom\\\">\")
832 (t (if (= (mod row-number 2) 1)
833 \"<tr class=\\\"tr-odd\\\">\"
834 \"<tr class=\\\"tr-even\\\">\")))
835 \"</tr>\"))
837 will use the \"tr-top\" and \"tr-bottom\" classes for the top row
838 and the bottom row, and otherwise alternate between \"tr-odd\" and
839 \"tr-even\" for odd and even rows."
840 :group 'org-export-html
841 :type '(cons
842 (choice :tag "Opening tag"
843 (string :tag "Specify")
844 (sexp))
845 (choice :tag "Closing tag"
846 (string :tag "Specify")
847 (sexp))))
849 (defcustom org-html-table-align-individual-fields t
850 "Non-nil means attach style attributes for alignment to each table field.
851 When nil, alignment will only be specified in the column tags, but this
852 is ignored by some browsers (like Firefox, Safari). Opera does it right
853 though."
854 :group 'org-export-html
855 :type 'boolean)
857 (defcustom org-html-table-use-header-tags-for-first-column nil
858 "Non-nil means format column one in tables with header tags.
859 When nil, also column one will use data tags."
860 :group 'org-export-html
861 :type 'boolean)
863 (defcustom org-html-table-caption-above t
864 "When non-nil, place caption string at the beginning of the table.
865 Otherwise, place it near the end."
866 :group 'org-export-html
867 :type 'boolean)
869 ;;;; Tags
871 (defcustom org-html-tag-class-prefix ""
872 "Prefix to class names for TODO keywords.
873 Each tag gets a class given by the tag itself, with this prefix.
874 The default prefix is empty because it is nice to just use the keyword
875 as a class name. But if you get into conflicts with other, existing
876 CSS classes, then this prefix can be very useful."
877 :group 'org-export-html
878 :type 'string)
880 ;;;; Template :: Generic
882 (defcustom org-html-extension "html"
883 "The extension for exported HTML files."
884 :group 'org-export-html
885 :type 'string)
887 (defcustom org-html-xml-declaration
888 '(("html" . "<?xml version=\"1.0\" encoding=\"%s\"?>")
889 ("php" . "<?php echo \"<?xml version=\\\"1.0\\\" encoding=\\\"%s\\\" ?>\"; ?>"))
890 "The extension for exported HTML files.
891 %s will be replaced with the charset of the exported file.
892 This may be a string, or an alist with export extensions
893 and corresponding declarations.
895 This declaration only applies when exporting to XHTML."
896 :group 'org-export-html
897 :type '(choice
898 (string :tag "Single declaration")
899 (repeat :tag "Dependent on extension"
900 (cons (string :tag "Extension")
901 (string :tag "Declaration")))))
903 (defcustom org-html-coding-system 'utf-8
904 "Coding system for HTML export.
905 Use utf-8 as the default value."
906 :group 'org-export-html
907 :version "24.4"
908 :package-version '(Org . "8.0")
909 :type 'coding-system)
911 (defcustom org-html-doctype "xhtml-strict"
912 "Document type definition to use for exported HTML files.
913 Can be set with the in-buffer HTML_DOCTYPE property or for
914 publishing, with :html-doctype."
915 :group 'org-export-html
916 :version "24.4"
917 :package-version '(Org . "8.0")
918 :type 'string)
920 (defcustom org-html-html5-fancy nil
921 "Non-nil means using new HTML5 elements.
922 This variable is ignored for anything other than HTML5 export.
924 For compatibility with Internet Explorer, it's probably a good
925 idea to download some form of the html5shiv (for instance
926 https://code.google.com/p/html5shiv/) and add it to your
927 HTML_HEAD_EXTRA, so that your pages don't break for users of IE
928 versions 8 and below."
929 :group 'org-export-html
930 :version "24.4"
931 :package-version '(Org . "8.0")
932 :type 'boolean)
934 (defcustom org-html-container-element "div"
935 "HTML element to use for wrapping top level sections.
936 Can be set with the in-buffer HTML_CONTAINER property or for
937 publishing, with :html-container.
939 Note that changing the default will prevent you from using
940 org-info.js for your website."
941 :group 'org-export-html
942 :version "24.4"
943 :package-version '(Org . "8.0")
944 :type 'string)
946 (defcustom org-html-divs
947 '((preamble "div" "preamble")
948 (content "div" "content")
949 (postamble "div" "postamble"))
950 "Alist of the three section elements for HTML export.
951 The car of each entry is one of 'preamble, 'content or 'postamble.
952 The cdrs of each entry are the ELEMENT_TYPE and ID for each
953 section of the exported document.
955 Note that changing the default will prevent you from using
956 org-info.js for your website."
957 :group 'org-export-html
958 :version "24.4"
959 :package-version '(Org . "8.0")
960 :type '(list :greedy t
961 (list :tag "Preamble"
962 (const :format "" preamble)
963 (string :tag "element") (string :tag " id"))
964 (list :tag "Content"
965 (const :format "" content)
966 (string :tag "element") (string :tag " id"))
967 (list :tag "Postamble" (const :format "" postamble)
968 (string :tag " id") (string :tag "element"))))
970 (defcustom org-html-metadata-timestamp-format "%Y-%m-%d %a %H:%M"
971 "Format used for timestamps in preamble, postamble and metadata.
972 See `format-time-string' for more information on its components."
973 :group 'org-export-html
974 :version "24.4"
975 :package-version '(Org . "8.0")
976 :type 'string)
978 ;;;; Template :: Mathjax
980 (defcustom org-html-mathjax-options
981 '((path "http://orgmode.org/mathjax/MathJax.js")
982 (scale "100")
983 (align "center")
984 (indent "2em")
985 (mathml nil))
986 "Options for MathJax setup.
988 path The path where to find MathJax
989 scale Scaling for the HTML-CSS backend, usually between 100 and 133
990 align How to align display math: left, center, or right
991 indent If align is not center, how far from the left/right side?
992 mathml Should a MathML player be used if available?
993 This is faster and reduces bandwidth use, but currently
994 sometimes has lower spacing quality. Therefore, the default is
995 nil. When browsers get better, this switch can be flipped.
997 You can also customize this for each buffer, using something like
999 #+MATHJAX: scale:\"133\" align:\"right\" mathml:t path:\"/MathJax/\""
1000 :group 'org-export-html
1001 :type '(list :greedy t
1002 (list :tag "path (the path from where to load MathJax.js)"
1003 (const :format " " path) (string))
1004 (list :tag "scale (scaling for the displayed math)"
1005 (const :format " " scale) (string))
1006 (list :tag "align (alignment of displayed equations)"
1007 (const :format " " align) (string))
1008 (list :tag "indent (indentation with left or right alignment)"
1009 (const :format " " indent) (string))
1010 (list :tag "mathml (should MathML display be used is possible)"
1011 (const :format " " mathml) (boolean))))
1013 (defcustom org-html-mathjax-template
1014 "<script type=\"text/javascript\" src=\"%PATH\"></script>
1015 <script type=\"text/javascript\">
1016 <!--/*--><![CDATA[/*><!--*/
1017 MathJax.Hub.Config({
1018 // Only one of the two following lines, depending on user settings
1019 // First allows browser-native MathML display, second forces HTML/CSS
1020 :MMLYES: config: [\"MMLorHTML.js\"], jax: [\"input/TeX\"],
1021 :MMLNO: jax: [\"input/TeX\", \"output/HTML-CSS\"],
1022 extensions: [\"tex2jax.js\",\"TeX/AMSmath.js\",\"TeX/AMSsymbols.js\",
1023 \"TeX/noUndefined.js\"],
1024 tex2jax: {
1025 inlineMath: [ [\"\\\\(\",\"\\\\)\"] ],
1026 displayMath: [ ['$$','$$'], [\"\\\\[\",\"\\\\]\"], [\"\\\\begin{displaymath}\",\"\\\\end{displaymath}\"] ],
1027 skipTags: [\"script\",\"noscript\",\"style\",\"textarea\",\"pre\",\"code\"],
1028 ignoreClass: \"tex2jax_ignore\",
1029 processEscapes: false,
1030 processEnvironments: true,
1031 preview: \"TeX\"
1033 showProcessingMessages: true,
1034 displayAlign: \"%ALIGN\",
1035 displayIndent: \"%INDENT\",
1037 \"HTML-CSS\": {
1038 scale: %SCALE,
1039 availableFonts: [\"STIX\",\"TeX\"],
1040 preferredFont: \"TeX\",
1041 webFont: \"TeX\",
1042 imageFont: \"TeX\",
1043 showMathMenu: true,
1045 MMLorHTML: {
1046 prefer: {
1047 MSIE: \"MML\",
1048 Firefox: \"MML\",
1049 Opera: \"HTML\",
1050 other: \"HTML\"
1054 /*]]>*///-->
1055 </script>"
1056 "The MathJax setup for XHTML files."
1057 :group 'org-export-html
1058 :type 'string)
1060 ;;;; Template :: Postamble
1062 (defcustom org-html-postamble 'auto
1063 "Non-nil means insert a postamble in HTML export.
1065 When set to 'auto, check against the
1066 `org-export-with-author/email/creator/date' variables to set the
1067 content of the postamble. When set to a string, use this string
1068 as the postamble. When t, insert a string as defined by the
1069 formatting string in `org-html-postamble-format'.
1071 When set to a function, apply this function and insert the
1072 returned string. The function takes the property list of export
1073 options as its only argument.
1075 Setting :html-postamble in publishing projects will take
1076 precedence over this variable."
1077 :group 'org-export-html
1078 :type '(choice (const :tag "No postamble" nil)
1079 (const :tag "Auto postamble" auto)
1080 (const :tag "Default formatting string" t)
1081 (string :tag "Custom formatting string")
1082 (function :tag "Function (must return a string)")))
1084 (defcustom org-html-postamble-format
1085 '(("en" "<p class=\"author\">Author: %a (%e)</p>
1086 <p class=\"date\">Date: %d</p>
1087 <p class=\"creator\">%c</p>
1088 <p class=\"validation\">%v</p>"))
1089 "Alist of languages and format strings for the HTML postamble.
1091 The first element of each list is the language code, as used for
1092 the LANGUAGE keyword. See `org-export-default-language'.
1094 The second element of each list is a format string to format the
1095 postamble itself. This format string can contain these elements:
1097 %t stands for the title.
1098 %a stands for the author's name.
1099 %e stands for the author's email.
1100 %d stands for the date.
1101 %c will be replaced by `org-html-creator-string'.
1102 %v will be replaced by `org-html-validation-link'.
1103 %T will be replaced by the export time.
1104 %C will be replaced by the last modification time.
1106 If you need to use a \"%\" character, you need to escape it
1107 like that: \"%%\"."
1108 :group 'org-export-html
1109 :type '(repeat
1110 (list (string :tag "Language")
1111 (string :tag "Format string"))))
1113 (defcustom org-html-validation-link
1114 "<a href=\"http://validator.w3.org/check?uri=referer\">Validate</a>"
1115 "Link to HTML validation service."
1116 :group 'org-export-html
1117 :type 'string)
1119 (defcustom org-html-creator-string
1120 (format "<a href=\"http://www.gnu.org/software/emacs/\">Emacs</a> %s (<a href=\"http://orgmode.org\">Org</a> mode %s)"
1121 emacs-version
1122 (if (fboundp 'org-version) (org-version) "unknown version"))
1123 "Information about the creator of the HTML document.
1124 This option can also be set on with the CREATOR keyword."
1125 :group 'org-export-html
1126 :type '(string :tag "Creator string"))
1128 ;;;; Template :: Preamble
1130 (defcustom org-html-preamble t
1131 "Non-nil means insert a preamble in HTML export.
1133 When t, insert a string as defined by the formatting string in
1134 `org-html-preamble-format'. When set to a string, use this
1135 formatting string instead (see `org-html-postamble-format' for an
1136 example of such a formatting string).
1138 When set to a function, apply this function and insert the
1139 returned string. The function takes the property list of export
1140 options as its only argument.
1142 Setting :html-preamble in publishing projects will take
1143 precedence over this variable."
1144 :group 'org-export-html
1145 :type '(choice (const :tag "No preamble" nil)
1146 (const :tag "Default preamble" t)
1147 (string :tag "Custom formatting string")
1148 (function :tag "Function (must return a string)")))
1150 (defcustom org-html-preamble-format '(("en" ""))
1151 "Alist of languages and format strings for the HTML preamble.
1153 The first element of each list is the language code, as used for
1154 the LANGUAGE keyword. See `org-export-default-language'.
1156 The second element of each list is a format string to format the
1157 preamble itself. This format string can contain these elements:
1159 %t stands for the title.
1160 %a stands for the author's name.
1161 %e stands for the author's email.
1162 %d stands for the date.
1163 %c will be replaced by `org-html-creator-string'.
1164 %v will be replaced by `org-html-validation-link'.
1165 %T will be replaced by the export time.
1166 %C will be replaced by the last modification time.
1168 If you need to use a \"%\" character, you need to escape it
1169 like that: \"%%\".
1171 See the default value of `org-html-postamble-format' for an
1172 example."
1173 :group 'org-export-html
1174 :type '(repeat
1175 (list (string :tag "Language")
1176 (string :tag "Format string"))))
1178 (defcustom org-html-link-up ""
1179 "Where should the \"UP\" link of exported HTML pages lead?"
1180 :group 'org-export-html
1181 :type '(string :tag "File or URL"))
1183 (defcustom org-html-link-home ""
1184 "Where should the \"HOME\" link of exported HTML pages lead?"
1185 :group 'org-export-html
1186 :type '(string :tag "File or URL"))
1188 (defcustom org-html-link-use-abs-url nil
1189 "Should we prepend relative links with HTML_LINK_HOME?"
1190 :group 'org-export-html
1191 :version "24.4"
1192 :package-version '(Org . "8.1")
1193 :type 'boolean)
1195 (defcustom org-html-home/up-format
1196 "<div id=\"org-div-home-and-up\">
1197 <a accesskey=\"h\" href=\"%s\"> UP </a>
1199 <a accesskey=\"H\" href=\"%s\"> HOME </a>
1200 </div>"
1201 "Snippet used to insert the HOME and UP links.
1202 This is a format string, the first %s will receive the UP link,
1203 the second the HOME link. If both `org-html-link-up' and
1204 `org-html-link-home' are empty, the entire snippet will be
1205 ignored."
1206 :group 'org-export-html
1207 :type 'string)
1209 ;;;; Template :: Scripts
1211 (define-obsolete-variable-alias
1212 'org-html-style-include-scripts 'org-html-head-include-scripts "24.4")
1213 (defcustom org-html-head-include-scripts t
1214 "Non-nil means include the JavaScript snippets in exported HTML files.
1215 The actual script is defined in `org-html-scripts' and should
1216 not be modified."
1217 :group 'org-export-html
1218 :version "24.4"
1219 :package-version '(Org . "8.0")
1220 :type 'boolean)
1222 ;;;; Template :: Styles
1224 (define-obsolete-variable-alias
1225 'org-html-style-include-default 'org-html-head-include-default-style "24.4")
1226 (defcustom org-html-head-include-default-style t
1227 "Non-nil means include the default style in exported HTML files.
1228 The actual style is defined in `org-html-style-default' and
1229 should not be modified. Use `org-html-head' to use your own
1230 style information."
1231 :group 'org-export-html
1232 :version "24.4"
1233 :package-version '(Org . "8.0")
1234 :type 'boolean)
1235 ;;;###autoload
1236 (put 'org-html-head-include-default-style 'safe-local-variable 'booleanp)
1238 (define-obsolete-variable-alias 'org-html-style 'org-html-head "24.4")
1239 (defcustom org-html-head ""
1240 "Org-wide head definitions for exported HTML files.
1242 This variable can contain the full HTML structure to provide a
1243 style, including the surrounding HTML tags. You can consider
1244 including definitions for the following classes: title, todo,
1245 done, timestamp, timestamp-kwd, tag, target.
1247 For example, a valid value would be:
1249 <style type=\"text/css\">
1250 <![CDATA[
1251 p { font-weight: normal; color: gray; }
1252 h1 { color: black; }
1253 .title { text-align: center; }
1254 .todo, .timestamp-kwd { color: red; }
1255 .done { color: green; }
1257 </style>
1259 If you want to refer to an external style, use something like
1261 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\" />
1263 As the value of this option simply gets inserted into the HTML
1264 <head> header, you can use it to add any arbitrary text to the
1265 header.
1267 You can set this on a per-file basis using #+HTML_HEAD:,
1268 or for publication projects using the :html-head property."
1269 :group 'org-export-html
1270 :version "24.4"
1271 :package-version '(Org . "8.0")
1272 :type 'string)
1273 ;;;###autoload
1274 (put 'org-html-head 'safe-local-variable 'stringp)
1276 (defcustom org-html-head-extra ""
1277 "More head information to add in the HTML output.
1279 You can set this on a per-file basis using #+HTML_HEAD_EXTRA:,
1280 or for publication projects using the :html-head-extra property."
1281 :group 'org-export-html
1282 :version "24.4"
1283 :package-version '(Org . "8.0")
1284 :type 'string)
1285 ;;;###autoload
1286 (put 'org-html-head-extra 'safe-local-variable 'stringp)
1288 ;;;; Todos
1290 (defcustom org-html-todo-kwd-class-prefix ""
1291 "Prefix to class names for TODO keywords.
1292 Each TODO keyword gets a class given by the keyword itself, with this prefix.
1293 The default prefix is empty because it is nice to just use the keyword
1294 as a class name. But if you get into conflicts with other, existing
1295 CSS classes, then this prefix can be very useful."
1296 :group 'org-export-html
1297 :type 'string)
1300 ;;; Internal Functions
1302 (defun org-html-xhtml-p (info)
1303 (let ((dt (downcase (plist-get info :html-doctype))))
1304 (string-match-p "xhtml" dt)))
1306 (defun org-html-html5-p (info)
1307 (let ((dt (downcase (plist-get info :html-doctype))))
1308 (member dt '("html5" "xhtml5" "<!doctype html>"))))
1310 (defun org-html-close-tag (tag attr info)
1311 (concat "<" tag " " attr
1312 (if (org-html-xhtml-p info) " />" ">")))
1314 (defun org-html-doctype (info)
1315 "Return correct html doctype tag from `org-html-doctype-alist',
1316 or the literal value of :html-doctype from INFO if :html-doctype
1317 is not found in the alist.
1318 INFO is a plist used as a communication channel."
1319 (let ((dt (plist-get info :html-doctype)))
1320 (or (cdr (assoc dt org-html-doctype-alist)) dt)))
1322 (defun org-html--make-attribute-string (attributes)
1323 "Return a list of attributes, as a string.
1324 ATTRIBUTES is a plist where values are either strings or nil. An
1325 attributes with a nil value will be omitted from the result."
1326 (let (output)
1327 (dolist (item attributes (mapconcat 'identity (nreverse output) " "))
1328 (cond ((null item) (pop output))
1329 ((symbolp item) (push (substring (symbol-name item) 1) output))
1330 (t (let ((key (car output))
1331 (value (replace-regexp-in-string
1332 "\"" "&quot;" (org-html-encode-plain-text item))))
1333 (setcar output (format "%s=\"%s\"" key value))))))))
1335 (defun org-html--wrap-image (contents info &optional caption label)
1336 "Wrap CONTENTS string within an appropriate environment for images.
1337 INFO is a plist used as a communication channel. When optional
1338 arguments CAPTION and LABEL are given, use them for caption and
1339 \"id\" attribute."
1340 (let ((html5-fancy (and (org-html-html5-p info)
1341 (plist-get info :html-html5-fancy))))
1342 (format (if html5-fancy "\n<figure%s>%s%s\n</figure>"
1343 "\n<div%s class=\"figure\">%s%s\n</div>")
1344 ;; ID.
1345 (if (not (org-string-nw-p label)) ""
1346 (format " id=\"%s\"" (org-export-solidify-link-text label)))
1347 ;; Contents.
1348 (format "\n<p>%s</p>" contents)
1349 ;; Caption.
1350 (if (not (org-string-nw-p caption)) ""
1351 (format (if html5-fancy "\n<figcaption>%s</figcaption>"
1352 "\n<p>%s</p>")
1353 caption)))))
1355 (defun org-html--format-image (source attributes info)
1356 "Return \"img\" tag with given SOURCE and ATTRIBUTES.
1357 SOURCE is a string specifying the location of the image.
1358 ATTRIBUTES is a plist, as returned by
1359 `org-export-read-attribute'. INFO is a plist used as
1360 a communication channel."
1361 (org-html-close-tag
1362 "img"
1363 (org-html--make-attribute-string
1364 (org-combine-plists
1365 (list :src source
1366 :alt (if (string-match-p "^ltxpng/" source)
1367 (org-html-encode-plain-text
1368 (org-find-text-property-in-string 'org-latex-src source))
1369 (file-name-nondirectory source)))
1370 attributes))
1371 info))
1373 (defun org-html--textarea-block (element)
1374 "Transcode ELEMENT into a textarea block.
1375 ELEMENT is either a src block or an example block."
1376 (let* ((code (car (org-export-unravel-code element)))
1377 (attr (org-export-read-attribute :attr_html element)))
1378 (format "<p>\n<textarea cols=\"%s\" rows=\"%s\">\n%s</textarea>\n</p>"
1379 (or (plist-get attr :width) 80)
1380 (or (plist-get attr :height) (org-count-lines code))
1381 code)))
1383 (defun org-html--has-caption-p (element &optional info)
1384 "Non-nil when ELEMENT has a caption affiliated keyword.
1385 INFO is a plist used as a communication channel. This function
1386 is meant to be used as a predicate for `org-export-get-ordinal' or
1387 a value to `org-html-standalone-image-predicate'."
1388 (org-element-property :caption element))
1390 ;;;; Table
1392 (defun org-html-htmlize-region-for-paste (beg end)
1393 "Convert the region between BEG and END to HTML, using htmlize.el.
1394 This is much like `htmlize-region-for-paste', only that it uses
1395 the settings define in the org-... variables."
1396 (let* ((htmlize-output-type org-html-htmlize-output-type)
1397 (htmlize-css-name-prefix org-html-htmlize-font-prefix)
1398 (htmlbuf (htmlize-region beg end)))
1399 (unwind-protect
1400 (with-current-buffer htmlbuf
1401 (buffer-substring (plist-get htmlize-buffer-places 'content-start)
1402 (plist-get htmlize-buffer-places 'content-end)))
1403 (kill-buffer htmlbuf))))
1405 ;;;###autoload
1406 (defun org-html-htmlize-generate-css ()
1407 "Create the CSS for all font definitions in the current Emacs session.
1408 Use this to create face definitions in your CSS style file that can then
1409 be used by code snippets transformed by htmlize.
1410 This command just produces a buffer that contains class definitions for all
1411 faces used in the current Emacs session. You can copy and paste the ones you
1412 need into your CSS file.
1414 If you then set `org-html-htmlize-output-type' to `css', calls
1415 to the function `org-html-htmlize-region-for-paste' will
1416 produce code that uses these same face definitions."
1417 (interactive)
1418 (require 'htmlize)
1419 (and (get-buffer "*html*") (kill-buffer "*html*"))
1420 (with-temp-buffer
1421 (let ((fl (face-list))
1422 (htmlize-css-name-prefix "org-")
1423 (htmlize-output-type 'css)
1424 f i)
1425 (while (setq f (pop fl)
1426 i (and f (face-attribute f :inherit)))
1427 (when (and (symbolp f) (or (not i) (not (listp i))))
1428 (insert (org-add-props (copy-sequence "1") nil 'face f))))
1429 (htmlize-region (point-min) (point-max))))
1430 (org-pop-to-buffer-same-window "*html*")
1431 (goto-char (point-min))
1432 (if (re-search-forward "<style" nil t)
1433 (delete-region (point-min) (match-beginning 0)))
1434 (if (re-search-forward "</style>" nil t)
1435 (delete-region (1+ (match-end 0)) (point-max)))
1436 (beginning-of-line 1)
1437 (if (looking-at " +") (replace-match ""))
1438 (goto-char (point-min)))
1440 (defun org-html--make-string (n string)
1441 "Build a string by concatenating N times STRING."
1442 (let (out) (dotimes (i n out) (setq out (concat string out)))))
1444 (defun org-html-fix-class-name (kwd) ; audit callers of this function
1445 "Turn todo keyword KWD into a valid class name.
1446 Replaces invalid characters with \"_\"."
1447 (save-match-data
1448 (while (string-match "[^a-zA-Z0-9_]" kwd)
1449 (setq kwd (replace-match "_" t t kwd))))
1450 kwd)
1452 (defun org-html-format-footnote-reference (n def refcnt)
1453 "Format footnote reference N with definition DEF into HTML."
1454 (let ((extra (if (= refcnt 1) "" (format ".%d" refcnt))))
1455 (format org-html-footnote-format
1456 (let* ((id (format "fnr.%s%s" n extra))
1457 (href (format " href=\"#fn.%s\"" n))
1458 (attributes (concat " class=\"footref\"" href)))
1459 (org-html--anchor id n attributes)))))
1461 (defun org-html-format-footnotes-section (section-name definitions)
1462 "Format footnotes section SECTION-NAME."
1463 (if (not definitions) ""
1464 (format org-html-footnotes-section section-name definitions)))
1466 (defun org-html-format-footnote-definition (fn)
1467 "Format the footnote definition FN."
1468 (let ((n (car fn)) (def (cdr fn)))
1469 (format
1470 "<div class=\"footdef\">%s %s</div>\n"
1471 (format org-html-footnote-format
1472 (let* ((id (format "fn.%s" n))
1473 (href (format " href=\"#fnr.%s\"" n))
1474 (attributes (concat " class=\"footnum\"" href)))
1475 (org-html--anchor id n attributes)))
1476 def)))
1478 (defun org-html-footnote-section (info)
1479 "Format the footnote section.
1480 INFO is a plist used as a communication channel."
1481 (let* ((fn-alist (org-export-collect-footnote-definitions
1482 (plist-get info :parse-tree) info))
1483 (fn-alist
1484 (loop for (n type raw) in fn-alist collect
1485 (cons n (if (eq (org-element-type raw) 'org-data)
1486 (org-trim (org-export-data raw info))
1487 (format "<p>%s</p>"
1488 (org-trim (org-export-data raw info))))))))
1489 (when fn-alist
1490 (org-html-format-footnotes-section
1491 (org-html--translate "Footnotes" info)
1492 (format
1493 "\n%s\n"
1494 (mapconcat 'org-html-format-footnote-definition fn-alist "\n"))))))
1497 ;;; Template
1499 (defun org-html--build-meta-info (info)
1500 "Return meta tags for exported document.
1501 INFO is a plist used as a communication channel."
1502 (let ((protect-string
1503 (lambda (str)
1504 (replace-regexp-in-string
1505 "\"" "&quot;" (org-html-encode-plain-text str))))
1506 (title (org-export-data (plist-get info :title) info))
1507 (author (and (plist-get info :with-author)
1508 (let ((auth (plist-get info :author)))
1509 (and auth
1510 ;; Return raw Org syntax, skipping non
1511 ;; exportable objects.
1512 (org-element-interpret-data
1513 (org-element-map auth
1514 (cons 'plain-text org-element-all-objects)
1515 'identity info))))))
1516 (description (plist-get info :description))
1517 (keywords (plist-get info :keywords))
1518 (charset (or (and org-html-coding-system
1519 (fboundp 'coding-system-get)
1520 (coding-system-get org-html-coding-system
1521 'mime-charset))
1522 "iso-8859-1")))
1523 (concat
1524 (format "<title>%s</title>\n" title)
1525 (when (plist-get info :time-stamp-file)
1526 (format-time-string
1527 (concat "<!-- " org-html-metadata-timestamp-format " -->\n")))
1528 (format
1529 (if (org-html-html5-p info)
1530 (org-html-close-tag "meta" " charset=\"%s\"" info)
1531 (org-html-close-tag
1532 "meta" " http-equiv=\"Content-Type\" content=\"text/html;charset=%s\""
1533 info))
1534 charset) "\n"
1535 (org-html-close-tag "meta" " name=\"generator\" content=\"Org-mode\"" info)
1536 "\n"
1537 (and (org-string-nw-p author)
1538 (concat
1539 (org-html-close-tag "meta"
1540 (format " name=\"author\" content=\"%s\""
1541 (funcall protect-string author))
1542 info)
1543 "\n"))
1544 (and (org-string-nw-p description)
1545 (concat
1546 (org-html-close-tag "meta"
1547 (format " name=\"description\" content=\"%s\"\n"
1548 (funcall protect-string description))
1549 info)
1550 "\n"))
1551 (and (org-string-nw-p keywords)
1552 (concat
1553 (org-html-close-tag "meta"
1554 (format " name=\"keywords\" content=\"%s\""
1555 (funcall protect-string keywords))
1556 info)
1557 "\n")))))
1559 (defun org-html--build-head (info)
1560 "Return information for the <head>..</head> of the HTML output.
1561 INFO is a plist used as a communication channel."
1562 (org-element-normalize-string
1563 (concat
1564 (when (plist-get info :html-head-include-default-style)
1565 (org-element-normalize-string org-html-style-default))
1566 (org-element-normalize-string (plist-get info :html-head))
1567 (org-element-normalize-string (plist-get info :html-head-extra))
1568 (when (and (plist-get info :html-htmlized-css-url)
1569 (eq org-html-htmlize-output-type 'css))
1570 (org-html-close-tag "link"
1571 (format " rel=\"stylesheet\" href=\"%s\" type=\"text/css\""
1572 (plist-get info :html-htmlized-css-url))
1573 info))
1574 (when (plist-get info :html-head-include-scripts) org-html-scripts))))
1576 (defun org-html--build-mathjax-config (info)
1577 "Insert the user setup into the mathjax template.
1578 INFO is a plist used as a communication channel."
1579 (when (and (memq (plist-get info :with-latex) '(mathjax t))
1580 (org-element-map (plist-get info :parse-tree)
1581 '(latex-fragment latex-environment) 'identity info t))
1582 (let ((template org-html-mathjax-template)
1583 (options org-html-mathjax-options)
1584 (in-buffer (or (plist-get info :html-mathjax) ""))
1585 name val (yes " ") (no "// ") x)
1586 (mapc
1587 (lambda (e)
1588 (setq name (car e) val (nth 1 e))
1589 (if (string-match (concat "\\<" (symbol-name name) ":") in-buffer)
1590 (setq val (car (read-from-string
1591 (substring in-buffer (match-end 0))))))
1592 (if (not (stringp val)) (setq val (format "%s" val)))
1593 (if (string-match (concat "%" (upcase (symbol-name name))) template)
1594 (setq template (replace-match val t t template))))
1595 options)
1596 (setq val (nth 1 (assq 'mathml options)))
1597 (if (string-match (concat "\\<mathml:") in-buffer)
1598 (setq val (car (read-from-string
1599 (substring in-buffer (match-end 0))))))
1600 ;; Exchange prefixes depending on mathml setting.
1601 (if (not val) (setq x yes yes no no x))
1602 ;; Replace cookies to turn on or off the config/jax lines.
1603 (if (string-match ":MMLYES:" template)
1604 (setq template (replace-match yes t t template)))
1605 (if (string-match ":MMLNO:" template)
1606 (setq template (replace-match no t t template)))
1607 ;; Return the modified template.
1608 (org-element-normalize-string template))))
1610 (defun org-html-format-spec (info)
1611 "Return format specification for elements that can be
1612 used in the preamble or postamble."
1613 `((?t . ,(org-export-data (plist-get info :title) info))
1614 (?d . ,(org-export-data (org-export-get-date info) info))
1615 (?T . ,(format-time-string org-html-metadata-timestamp-format))
1616 (?a . ,(org-export-data (plist-get info :author) info))
1617 (?e . ,(mapconcat
1618 (lambda (e)
1619 (format "<a href=\"mailto:%s\">%s</a>" e e))
1620 (split-string (plist-get info :email) ",+ *")
1621 ", "))
1622 (?c . ,(plist-get info :creator))
1623 (?C . ,(let ((file (plist-get info :input-file)))
1624 (format-time-string org-html-metadata-timestamp-format
1625 (if file (nth 5 (file-attributes file))
1626 (current-time)))))
1627 (?v . ,(or org-html-validation-link ""))))
1629 (defun org-html--build-pre/postamble (type info)
1630 "Return document preamble or postamble as a string, or nil.
1631 TYPE is either 'preamble or 'postamble, INFO is a plist used as a
1632 communication channel."
1633 (let ((section (plist-get info (intern (format ":html-%s" type))))
1634 (spec (org-html-format-spec info)))
1635 (when section
1636 (let ((section-contents
1637 (if (functionp section) (funcall section info)
1638 (cond
1639 ((stringp section) (format-spec section spec))
1640 ((eq section 'auto)
1641 (let ((date (cdr (assq ?d spec)))
1642 (author (cdr (assq ?a spec)))
1643 (email (cdr (assq ?e spec)))
1644 (creator (cdr (assq ?c spec)))
1645 (timestamp (cdr (assq ?T spec)))
1646 (validation-link (cdr (assq ?v spec))))
1647 (concat
1648 (when (and (plist-get info :with-date)
1649 (org-string-nw-p date))
1650 (format "<p class=\"date\">%s: %s</p>\n"
1651 (org-html--translate "Date" info)
1652 date))
1653 (when (and (plist-get info :with-author)
1654 (org-string-nw-p author))
1655 (format "<p class=\"author\">%s: %s</p>\n"
1656 (org-html--translate "Author" info)
1657 author))
1658 (when (and (plist-get info :with-email)
1659 (org-string-nw-p email))
1660 (format "<p class=\"email\">%s: %s</p>\n"
1661 (org-html--translate "Email" info)
1662 email))
1663 (when (plist-get info :time-stamp-file)
1664 (format
1665 "<p class=\"date\">%s: %s</p>\n"
1666 (org-html--translate "Created" info)
1667 (format-time-string org-html-metadata-timestamp-format)))
1668 (when (plist-get info :with-creator)
1669 (format "<p class=\"creator\">%s</p>\n" creator))
1670 (format "<p class=\"validation\">%s</p>\n"
1671 validation-link))))
1672 (t (format-spec
1673 (or (cadr (assoc
1674 (plist-get info :language)
1675 (eval (intern
1676 (format "org-html-%s-format" type)))))
1677 (cadr
1678 (assoc
1679 "en"
1680 (eval
1681 (intern (format "org-html-%s-format" type))))))
1682 spec))))))
1683 (when (org-string-nw-p section-contents)
1684 (concat
1685 (format "<%s id=\"%s\" class=\"%s\">\n"
1686 (nth 1 (assq type org-html-divs))
1687 (nth 2 (assq type org-html-divs))
1688 org-html--pre/postamble-class)
1689 (org-element-normalize-string section-contents)
1690 (format "</%s>\n" (nth 1 (assq type org-html-divs)))))))))
1692 (defun org-html-inner-template (contents info)
1693 "Return body of document string after HTML conversion.
1694 CONTENTS is the transcoded contents string. INFO is a plist
1695 holding export options."
1696 (concat
1697 ;; Table of contents.
1698 (let ((depth (plist-get info :with-toc)))
1699 (when depth (org-html-toc depth info)))
1700 ;; Document contents.
1701 contents
1702 ;; Footnotes section.
1703 (org-html-footnote-section info)))
1705 (defun org-html-template (contents info)
1706 "Return complete document string after HTML conversion.
1707 CONTENTS is the transcoded contents string. INFO is a plist
1708 holding export options."
1709 (concat
1710 (when (and (not (org-html-html5-p info)) (org-html-xhtml-p info))
1711 (let ((decl (or (and (stringp org-html-xml-declaration)
1712 org-html-xml-declaration)
1713 (cdr (assoc (plist-get info :html-extension)
1714 org-html-xml-declaration))
1715 (cdr (assoc "html" org-html-xml-declaration))
1717 "")))
1718 (when (not (or (eq nil decl) (string= "" decl)))
1719 (format "%s\n"
1720 (format decl
1721 (or (and org-html-coding-system
1722 (fboundp 'coding-system-get)
1723 (coding-system-get org-html-coding-system 'mime-charset))
1724 "iso-8859-1"))))))
1725 (org-html-doctype info)
1726 "\n"
1727 (concat "<html"
1728 (when (org-html-xhtml-p info)
1729 (format
1730 " xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"%s\" xml:lang=\"%s\""
1731 (plist-get info :language) (plist-get info :language)))
1732 ">\n")
1733 "<head>\n"
1734 (org-html--build-meta-info info)
1735 (org-html--build-head info)
1736 (org-html--build-mathjax-config info)
1737 "</head>\n"
1738 "<body>\n"
1739 (let ((link-up (org-trim (plist-get info :html-link-up)))
1740 (link-home (org-trim (plist-get info :html-link-home))))
1741 (unless (and (string= link-up "") (string= link-home ""))
1742 (format org-html-home/up-format
1743 (or link-up link-home)
1744 (or link-home link-up))))
1745 ;; Preamble.
1746 (org-html--build-pre/postamble 'preamble info)
1747 ;; Document contents.
1748 (format "<%s id=\"%s\">\n"
1749 (nth 1 (assq 'content org-html-divs))
1750 (nth 2 (assq 'content org-html-divs)))
1751 ;; Document title.
1752 (let ((title (plist-get info :title)))
1753 (format "<h1 class=\"title\">%s</h1>\n" (org-export-data (or title "") info)))
1754 contents
1755 (format "</%s>\n"
1756 (nth 1 (assq 'content org-html-divs)))
1757 ;; Postamble.
1758 (org-html--build-pre/postamble 'postamble info)
1759 ;; Closing document.
1760 "</body>\n</html>"))
1762 (defun org-html--translate (s info)
1763 "Translate string S according to specified language.
1764 INFO is a plist used as a communication channel."
1765 (org-export-translate s :html info))
1767 ;;;; Anchor
1769 (defun org-html--anchor (&optional id desc attributes)
1770 "Format a HTML anchor."
1771 (let* ((name (and org-html-allow-name-attribute-in-anchors id))
1772 (attributes (concat (and id (format " id=\"%s\"" id))
1773 (and name (format " name=\"%s\"" name))
1774 attributes)))
1775 (format "<a%s>%s</a>" attributes (or desc ""))))
1777 ;;;; Todo
1779 (defun org-html--todo (todo)
1780 "Format TODO keywords into HTML."
1781 (when todo
1782 (format "<span class=\"%s %s%s\">%s</span>"
1783 (if (member todo org-done-keywords) "done" "todo")
1784 org-html-todo-kwd-class-prefix (org-html-fix-class-name todo)
1785 todo)))
1787 ;;;; Tags
1789 (defun org-html--tags (tags)
1790 "Format TAGS into HTML."
1791 (when tags
1792 (format "<span class=\"tag\">%s</span>"
1793 (mapconcat
1794 (lambda (tag)
1795 (format "<span class=\"%s\">%s</span>"
1796 (concat org-html-tag-class-prefix
1797 (org-html-fix-class-name tag))
1798 tag))
1799 tags "&#xa0;"))))
1801 ;;;; Headline
1803 (defun* org-html-format-headline
1804 (todo todo-type priority text tags
1805 &key level section-number headline-label &allow-other-keys)
1806 "Format a headline in HTML."
1807 (let ((section-number
1808 (when section-number
1809 (format "<span class=\"section-number-%d\">%s</span> "
1810 level section-number)))
1811 (todo (org-html--todo todo))
1812 (tags (org-html--tags tags)))
1813 (concat section-number todo (and todo " ") text
1814 (and tags "&#xa0;&#xa0;&#xa0;") tags)))
1816 ;;;; Src Code
1818 (defun org-html-fontify-code (code lang)
1819 "Color CODE with htmlize library.
1820 CODE is a string representing the source code to colorize. LANG
1821 is the language used for CODE, as a string, or nil."
1822 (when code
1823 (cond
1824 ;; Case 1: No lang. Possibly an example block.
1825 ((not lang)
1826 ;; Simple transcoding.
1827 (org-html-encode-plain-text code))
1828 ;; Case 2: No htmlize or an inferior version of htmlize
1829 ((not (and (require 'htmlize nil t) (fboundp 'htmlize-region-for-paste)))
1830 ;; Emit a warning.
1831 (message "Cannot fontify src block (htmlize.el >= 1.34 required)")
1832 ;; Simple transcoding.
1833 (org-html-encode-plain-text code))
1835 ;; Map language
1836 (setq lang (or (assoc-default lang org-src-lang-modes) lang))
1837 (let* ((lang-mode (and lang (intern (format "%s-mode" lang)))))
1838 (cond
1839 ;; Case 1: Language is not associated with any Emacs mode
1840 ((not (functionp lang-mode))
1841 ;; Simple transcoding.
1842 (org-html-encode-plain-text code))
1843 ;; Case 2: Default. Fontify code.
1845 ;; htmlize
1846 (setq code (with-temp-buffer
1847 ;; Switch to language-specific mode.
1848 (funcall lang-mode)
1849 (insert code)
1850 ;; Fontify buffer.
1851 (font-lock-fontify-buffer)
1852 ;; Remove formatting on newline characters.
1853 (save-excursion
1854 (let ((beg (point-min))
1855 (end (point-max)))
1856 (goto-char beg)
1857 (while (progn (end-of-line) (< (point) end))
1858 (put-text-property (point) (1+ (point)) 'face nil)
1859 (forward-char 1))))
1860 (org-src-mode)
1861 (set-buffer-modified-p nil)
1862 ;; Htmlize region.
1863 (org-html-htmlize-region-for-paste
1864 (point-min) (point-max))))
1865 ;; Strip any enclosing <pre></pre> tags.
1866 (let* ((beg (and (string-match "\\`<pre[^>]*>\n*" code) (match-end 0)))
1867 (end (and beg (string-match "</pre>\\'" code))))
1868 (if (and beg end) (substring code beg end) code)))))))))
1870 (defun org-html-do-format-code
1871 (code &optional lang refs retain-labels num-start)
1872 "Format CODE string as source code.
1873 Optional arguments LANG, REFS, RETAIN-LABELS and NUM-START are,
1874 respectively, the language of the source code, as a string, an
1875 alist between line numbers and references (as returned by
1876 `org-export-unravel-code'), a boolean specifying if labels should
1877 appear in the source code, and the number associated to the first
1878 line of code."
1879 (let* ((code-lines (org-split-string code "\n"))
1880 (code-length (length code-lines))
1881 (num-fmt
1882 (and num-start
1883 (format "%%%ds: "
1884 (length (number-to-string (+ code-length num-start))))))
1885 (code (org-html-fontify-code code lang)))
1886 (org-export-format-code
1887 code
1888 (lambda (loc line-num ref)
1889 (setq loc
1890 (concat
1891 ;; Add line number, if needed.
1892 (when num-start
1893 (format "<span class=\"linenr\">%s</span>"
1894 (format num-fmt line-num)))
1895 ;; Transcoded src line.
1897 ;; Add label, if needed.
1898 (when (and ref retain-labels) (format " (%s)" ref))))
1899 ;; Mark transcoded line as an anchor, if needed.
1900 (if (not ref) loc
1901 (format "<span id=\"coderef-%s\" class=\"coderef-off\">%s</span>"
1902 ref loc)))
1903 num-start refs)))
1905 (defun org-html-format-code (element info)
1906 "Format contents of ELEMENT as source code.
1907 ELEMENT is either an example block or a src block. INFO is
1908 a plist used as a communication channel."
1909 (let* ((lang (org-element-property :language element))
1910 ;; Extract code and references.
1911 (code-info (org-export-unravel-code element))
1912 (code (car code-info))
1913 (refs (cdr code-info))
1914 ;; Does the src block contain labels?
1915 (retain-labels (org-element-property :retain-labels element))
1916 ;; Does it have line numbers?
1917 (num-start (case (org-element-property :number-lines element)
1918 (continued (org-export-get-loc element info))
1919 (new 0))))
1920 (org-html-do-format-code code lang refs retain-labels num-start)))
1923 ;;; Tables of Contents
1925 (defun org-html-toc (depth info)
1926 "Build a table of contents.
1927 DEPTH is an integer specifying the depth of the table. INFO is a
1928 plist used as a communication channel. Return the table of
1929 contents as a string, or nil if it is empty."
1930 (let ((toc-entries
1931 (mapcar (lambda (headline)
1932 (cons (org-html--format-toc-headline headline info)
1933 (org-export-get-relative-level headline info)))
1934 (org-export-collect-headlines info depth)))
1935 (outer-tag (if (and (org-html-html5-p info)
1936 (plist-get info :html-html5-fancy))
1937 "nav"
1938 "div")))
1939 (when toc-entries
1940 (concat (format "<%s id=\"table-of-contents\">\n" outer-tag)
1941 (format "<h%d>%s</h%d>\n"
1942 org-html-toplevel-hlevel
1943 (org-html--translate "Table of Contents" info)
1944 org-html-toplevel-hlevel)
1945 "<div id=\"text-table-of-contents\">"
1946 (org-html--toc-text toc-entries)
1947 "</div>\n"
1948 (format "</%s>\n" outer-tag)))))
1950 (defun org-html--toc-text (toc-entries)
1951 "Return innards of a table of contents, as a string.
1952 TOC-ENTRIES is an alist where key is an entry title, as a string,
1953 and value is its relative level, as an integer."
1954 (let* ((prev-level (1- (cdar toc-entries)))
1955 (start-level prev-level))
1956 (concat
1957 (mapconcat
1958 (lambda (entry)
1959 (let ((headline (car entry))
1960 (level (cdr entry)))
1961 (concat
1962 (let* ((cnt (- level prev-level))
1963 (times (if (> cnt 0) (1- cnt) (- cnt)))
1964 rtn)
1965 (setq prev-level level)
1966 (concat
1967 (org-html--make-string
1968 times (cond ((> cnt 0) "\n<ul>\n<li>")
1969 ((< cnt 0) "</li>\n</ul>\n")))
1970 (if (> cnt 0) "\n<ul>\n<li>" "</li>\n<li>")))
1971 headline)))
1972 toc-entries "")
1973 (org-html--make-string (- prev-level start-level) "</li>\n</ul>\n"))))
1975 (defun org-html--format-toc-headline (headline info)
1976 "Return an appropriate table of contents entry for HEADLINE.
1977 INFO is a plist used as a communication channel."
1978 (let* ((headline-number (org-export-get-headline-number headline info))
1979 (section-number
1980 (and (not (org-export-low-level-p headline info))
1981 (org-export-numbered-headline-p headline info)
1982 (concat (mapconcat 'number-to-string headline-number ".") ". ")))
1983 (tags (and (eq (plist-get info :with-tags) t)
1984 (org-export-get-tags headline info))))
1985 (format "<a href=\"#%s\">%s</a>"
1986 ;; Label.
1987 (org-export-solidify-link-text
1988 (or (org-element-property :CUSTOM_ID headline)
1989 (concat "sec-" (mapconcat 'number-to-string
1990 headline-number "-"))))
1991 ;; Body.
1992 (concat section-number
1993 (org-export-data-with-backend
1994 (org-export-get-alt-title headline info)
1995 ;; Create an anonymous back-end that will ignore
1996 ;; any footnote-reference, link, radio-target and
1997 ;; target in table of contents.
1998 (org-export-create-backend
1999 :parent 'html
2000 :transcoders '((footnote-reference . ignore)
2001 (link . (lambda (object c i) c))
2002 (radio-target . (lambda (object c i) c))
2003 (target . ignore)))
2004 info)
2005 (and tags "&#xa0;&#xa0;&#xa0;") (org-html--tags tags)))))
2007 (defun org-html-list-of-listings (info)
2008 "Build a list of listings.
2009 INFO is a plist used as a communication channel. Return the list
2010 of listings as a string, or nil if it is empty."
2011 (let ((lol-entries (org-export-collect-listings info)))
2012 (when lol-entries
2013 (concat "<div id=\"list-of-listings\">\n"
2014 (format "<h%d>%s</h%d>\n"
2015 org-html-toplevel-hlevel
2016 (org-html--translate "List of Listings" info)
2017 org-html-toplevel-hlevel)
2018 "<div id=\"text-list-of-listings\">\n<ul>\n"
2019 (let ((count 0)
2020 (initial-fmt (format "<span class=\"listing-number\">%s</span>"
2021 (org-html--translate "Listing %d:" info))))
2022 (mapconcat
2023 (lambda (entry)
2024 (let ((label (org-element-property :name entry))
2025 (title (org-trim
2026 (org-export-data
2027 (or (org-export-get-caption entry t)
2028 (org-export-get-caption entry))
2029 info))))
2030 (concat
2031 "<li>"
2032 (if (not label)
2033 (concat (format initial-fmt (incf count)) " " title)
2034 (format "<a href=\"#%s\">%s %s</a>"
2035 (org-export-solidify-link-text label)
2036 (format initial-fmt (incf count))
2037 title))
2038 "</li>")))
2039 lol-entries "\n"))
2040 "\n</ul>\n</div>\n</div>"))))
2042 (defun org-html-list-of-tables (info)
2043 "Build a list of tables.
2044 INFO is a plist used as a communication channel. Return the list
2045 of tables as a string, or nil if it is empty."
2046 (let ((lol-entries (org-export-collect-tables info)))
2047 (when lol-entries
2048 (concat "<div id=\"list-of-tables\">\n"
2049 (format "<h%d>%s</h%d>\n"
2050 org-html-toplevel-hlevel
2051 (org-html--translate "List of Tables" info)
2052 org-html-toplevel-hlevel)
2053 "<div id=\"text-list-of-tables\">\n<ul>\n"
2054 (let ((count 0)
2055 (initial-fmt (format "<span class=\"table-number\">%s</span>"
2056 (org-html--translate "Table %d:" info))))
2057 (mapconcat
2058 (lambda (entry)
2059 (let ((label (org-element-property :name entry))
2060 (title (org-trim
2061 (org-export-data
2062 (or (org-export-get-caption entry t)
2063 (org-export-get-caption entry))
2064 info))))
2065 (concat
2066 "<li>"
2067 (if (not label)
2068 (concat (format initial-fmt (incf count)) " " title)
2069 (format "<a href=\"#%s\">%s %s</a>"
2070 (org-export-solidify-link-text label)
2071 (format initial-fmt (incf count))
2072 title))
2073 "</li>")))
2074 lol-entries "\n"))
2075 "\n</ul>\n</div>\n</div>"))))
2078 ;;; Transcode Functions
2080 ;;;; Bold
2082 (defun org-html-bold (bold contents info)
2083 "Transcode BOLD from Org to HTML.
2084 CONTENTS is the text with bold markup. INFO is a plist holding
2085 contextual information."
2086 (format (or (cdr (assq 'bold org-html-text-markup-alist)) "%s")
2087 contents))
2089 ;;;; Center Block
2091 (defun org-html-center-block (center-block contents info)
2092 "Transcode a CENTER-BLOCK element from Org to HTML.
2093 CONTENTS holds the contents of the block. INFO is a plist
2094 holding contextual information."
2095 (format "<div class=\"center\">\n%s</div>" contents))
2097 ;;;; Clock
2099 (defun org-html-clock (clock contents info)
2100 "Transcode a CLOCK element from Org to HTML.
2101 CONTENTS is nil. INFO is a plist used as a communication
2102 channel."
2103 (format "<p>
2104 <span class=\"timestamp-wrapper\">
2105 <span class=\"timestamp-kwd\">%s</span> <span class=\"timestamp\">%s</span>%s
2106 </span>
2107 </p>"
2108 org-clock-string
2109 (org-translate-time
2110 (org-element-property :raw-value
2111 (org-element-property :value clock)))
2112 (let ((time (org-element-property :duration clock)))
2113 (and time (format " <span class=\"timestamp\">(%s)</span>" time)))))
2115 ;;;; Code
2117 (defun org-html-code (code contents info)
2118 "Transcode CODE from Org to HTML.
2119 CONTENTS is nil. INFO is a plist holding contextual
2120 information."
2121 (format (or (cdr (assq 'code org-html-text-markup-alist)) "%s")
2122 (org-html-encode-plain-text (org-element-property :value code))))
2124 ;;;; Drawer
2126 (defun org-html-drawer (drawer contents info)
2127 "Transcode a DRAWER element from Org to HTML.
2128 CONTENTS holds the contents of the block. INFO is a plist
2129 holding contextual information."
2130 (if (functionp org-html-format-drawer-function)
2131 (funcall org-html-format-drawer-function
2132 (org-element-property :drawer-name drawer)
2133 contents)
2134 ;; If there's no user defined function: simply
2135 ;; display contents of the drawer.
2136 contents))
2138 ;;;; Dynamic Block
2140 (defun org-html-dynamic-block (dynamic-block contents info)
2141 "Transcode a DYNAMIC-BLOCK element from Org to HTML.
2142 CONTENTS holds the contents of the block. INFO is a plist
2143 holding contextual information. See `org-export-data'."
2144 contents)
2146 ;;;; Entity
2148 (defun org-html-entity (entity contents info)
2149 "Transcode an ENTITY object from Org to HTML.
2150 CONTENTS are the definition itself. INFO is a plist holding
2151 contextual information."
2152 (org-element-property :html entity))
2154 ;;;; Example Block
2156 (defun org-html-example-block (example-block contents info)
2157 "Transcode a EXAMPLE-BLOCK element from Org to HTML.
2158 CONTENTS is nil. INFO is a plist holding contextual
2159 information."
2160 (if (org-export-read-attribute :attr_html example-block :textarea)
2161 (org-html--textarea-block example-block)
2162 (format "<pre class=\"example\">\n%s</pre>"
2163 (org-html-format-code example-block info))))
2165 ;;;; Export Snippet
2167 (defun org-html-export-snippet (export-snippet contents info)
2168 "Transcode a EXPORT-SNIPPET object from Org to HTML.
2169 CONTENTS is nil. INFO is a plist holding contextual
2170 information."
2171 (when (eq (org-export-snippet-backend export-snippet) 'html)
2172 (org-element-property :value export-snippet)))
2174 ;;;; Export Block
2176 (defun org-html-export-block (export-block contents info)
2177 "Transcode a EXPORT-BLOCK element from Org to HTML.
2178 CONTENTS is nil. INFO is a plist holding contextual information."
2179 (when (string= (org-element-property :type export-block) "HTML")
2180 (org-remove-indentation (org-element-property :value export-block))))
2182 ;;;; Fixed Width
2184 (defun org-html-fixed-width (fixed-width contents info)
2185 "Transcode a FIXED-WIDTH element from Org to HTML.
2186 CONTENTS is nil. INFO is a plist holding contextual information."
2187 (format "<pre class=\"example\">\n%s</pre>"
2188 (org-html-do-format-code
2189 (org-remove-indentation
2190 (org-element-property :value fixed-width)))))
2192 ;;;; Footnote Reference
2194 (defun org-html-footnote-reference (footnote-reference contents info)
2195 "Transcode a FOOTNOTE-REFERENCE element from Org to HTML.
2196 CONTENTS is nil. INFO is a plist holding contextual information."
2197 (concat
2198 ;; Insert separator between two footnotes in a row.
2199 (let ((prev (org-export-get-previous-element footnote-reference info)))
2200 (when (eq (org-element-type prev) 'footnote-reference)
2201 org-html-footnote-separator))
2202 (cond
2203 ((not (org-export-footnote-first-reference-p footnote-reference info))
2204 (org-html-format-footnote-reference
2205 (org-export-get-footnote-number footnote-reference info)
2206 "IGNORED" 100))
2207 ;; Inline definitions are secondary strings.
2208 ((eq (org-element-property :type footnote-reference) 'inline)
2209 (org-html-format-footnote-reference
2210 (org-export-get-footnote-number footnote-reference info)
2211 "IGNORED" 1))
2212 ;; Non-inline footnotes definitions are full Org data.
2213 (t (org-html-format-footnote-reference
2214 (org-export-get-footnote-number footnote-reference info)
2215 "IGNORED" 1)))))
2217 ;;;; Headline
2219 (defun org-html-format-headline--wrap
2220 (headline info &optional format-function &rest extra-keys)
2221 "Transcode a HEADLINE element from Org to HTML.
2222 CONTENTS holds the contents of the headline. INFO is a plist
2223 holding contextual information."
2224 (let* ((level (+ (org-export-get-relative-level headline info)
2225 (1- org-html-toplevel-hlevel)))
2226 (headline-number (org-export-get-headline-number headline info))
2227 (section-number (and (not (org-export-low-level-p headline info))
2228 (org-export-numbered-headline-p headline info)
2229 (mapconcat 'number-to-string
2230 headline-number ".")))
2231 (todo (and (plist-get info :with-todo-keywords)
2232 (let ((todo (org-element-property :todo-keyword headline)))
2233 (and todo (org-export-data todo info)))))
2234 (todo-type (and todo (org-element-property :todo-type headline)))
2235 (priority (and (plist-get info :with-priority)
2236 (org-element-property :priority headline)))
2237 (text (org-export-data (org-element-property :title headline) info))
2238 (tags (and (plist-get info :with-tags)
2239 (org-export-get-tags headline info)))
2240 (headline-label (or (org-element-property :CUSTOM_ID headline)
2241 (concat "sec-" (mapconcat 'number-to-string
2242 headline-number "-"))))
2243 (format-function
2244 (cond ((functionp format-function) format-function)
2245 ((functionp org-html-format-headline-function)
2246 (lambda (todo todo-type priority text tags &rest ignore)
2247 (funcall org-html-format-headline-function
2248 todo todo-type priority text tags)))
2249 (t 'org-html-format-headline))))
2250 (apply format-function
2251 todo todo-type priority text tags
2252 :headline-label headline-label :level level
2253 :section-number section-number extra-keys)))
2255 (defun org-html-headline (headline contents info)
2256 "Transcode a HEADLINE element from Org to HTML.
2257 CONTENTS holds the contents of the headline. INFO is a plist
2258 holding contextual information."
2259 ;; Empty contents?
2260 (setq contents (or contents ""))
2261 (let* ((numberedp (org-export-numbered-headline-p headline info))
2262 (level (org-export-get-relative-level headline info))
2263 (text (org-export-data (org-element-property :title headline) info))
2264 (todo (and (plist-get info :with-todo-keywords)
2265 (let ((todo (org-element-property :todo-keyword headline)))
2266 (and todo (org-export-data todo info)))))
2267 (todo-type (and todo (org-element-property :todo-type headline)))
2268 (tags (and (plist-get info :with-tags)
2269 (org-export-get-tags headline info)))
2270 (priority (and (plist-get info :with-priority)
2271 (org-element-property :priority headline)))
2272 (section-number (and (org-export-numbered-headline-p headline info)
2273 (mapconcat 'number-to-string
2274 (org-export-get-headline-number
2275 headline info) ".")))
2276 ;; Create the headline text.
2277 (full-text (org-html-format-headline--wrap headline info)))
2278 (cond
2279 ;; Case 1: This is a footnote section: ignore it.
2280 ((org-element-property :footnote-section-p headline) nil)
2281 ;; Case 2. This is a deep sub-tree: export it as a list item.
2282 ;; Also export as items headlines for which no section
2283 ;; format has been found.
2284 ((org-export-low-level-p headline info)
2285 ;; Build the real contents of the sub-tree.
2286 (let* ((type (if numberedp 'ordered 'unordered))
2287 (itemized-body (org-html-format-list-item
2288 contents type nil info nil full-text)))
2289 (concat
2290 (and (org-export-first-sibling-p headline info)
2291 (org-html-begin-plain-list type))
2292 itemized-body
2293 (and (org-export-last-sibling-p headline info)
2294 (org-html-end-plain-list type)))))
2295 ;; Case 3. Standard headline. Export it as a section.
2297 (let* ((section-number (mapconcat 'number-to-string
2298 (org-export-get-headline-number
2299 headline info) "-"))
2300 (ids (remove 'nil
2301 (list (org-element-property :CUSTOM_ID headline)
2302 (concat "sec-" section-number)
2303 (org-element-property :ID headline))))
2304 (preferred-id (car ids))
2305 (extra-ids (cdr ids))
2306 (extra-class (org-element-property :HTML_CONTAINER_CLASS headline))
2307 (level1 (+ level (1- org-html-toplevel-hlevel)))
2308 (first-content (car (org-element-contents headline))))
2309 (format "<%s id=\"%s\" class=\"%s\">%s%s</%s>\n"
2310 (org-html--container headline info)
2311 (format "outline-container-%s"
2312 (or (org-element-property :CUSTOM_ID headline)
2313 (concat "sec-" section-number)))
2314 (concat (format "outline-%d" level1) (and extra-class " ")
2315 extra-class)
2316 (format "\n<h%d id=\"%s\">%s%s</h%d>\n"
2317 level1
2318 preferred-id
2319 (mapconcat
2320 (lambda (x)
2321 (let ((id (org-export-solidify-link-text
2322 (if (org-uuidgen-p x) (concat "ID-" x)
2323 x))))
2324 (org-html--anchor id)))
2325 extra-ids "")
2326 full-text
2327 level1)
2328 ;; When there is no section, pretend there is an empty
2329 ;; one to get the correct <div class="outline- ...>
2330 ;; which is needed by `org-info.js'.
2331 (if (not (eq (org-element-type first-content) 'section))
2332 (concat (org-html-section first-content "" info)
2333 contents)
2334 contents)
2335 (org-html--container headline info)))))))
2337 (defun org-html--container (headline info)
2338 (or (org-element-property :HTML_CONTAINER headline)
2339 (if (= 1 (org-export-get-relative-level headline info))
2340 (plist-get info :html-container)
2341 "div")))
2343 ;;;; Horizontal Rule
2345 (defun org-html-horizontal-rule (horizontal-rule contents info)
2346 "Transcode an HORIZONTAL-RULE object from Org to HTML.
2347 CONTENTS is nil. INFO is a plist holding contextual information."
2348 (org-html-close-tag "hr" nil info))
2350 ;;;; Inline Src Block
2352 (defun org-html-inline-src-block (inline-src-block contents info)
2353 "Transcode an INLINE-SRC-BLOCK element from Org to HTML.
2354 CONTENTS holds the contents of the item. INFO is a plist holding
2355 contextual information."
2356 (let* ((org-lang (org-element-property :language inline-src-block))
2357 (code (org-element-property :value inline-src-block)))
2358 (error "Cannot export inline src block")))
2360 ;;;; Inlinetask
2362 (defun org-html-format-section (text class &optional id)
2363 "Format a section with TEXT into a HTML div with CLASS and ID."
2364 (let ((extra (concat (when id (format " id=\"%s\"" id)))))
2365 (concat (format "<div class=\"%s\"%s>\n" class extra) text "</div>\n")))
2367 (defun org-html-inlinetask (inlinetask contents info)
2368 "Transcode an INLINETASK element from Org to HTML.
2369 CONTENTS holds the contents of the block. INFO is a plist
2370 holding contextual information."
2371 (cond
2372 ;; If `org-html-format-inlinetask-function' is provided, call it
2373 ;; with appropriate arguments.
2374 ((functionp org-html-format-inlinetask-function)
2375 (let ((format-function
2376 (function*
2377 (lambda (todo todo-type priority text tags
2378 &key contents &allow-other-keys)
2379 (funcall org-html-format-inlinetask-function
2380 todo todo-type priority text tags contents)))))
2381 (org-html-format-headline--wrap
2382 inlinetask info format-function :contents contents)))
2383 ;; Otherwise, use a default template.
2384 (t (format "<div class=\"inlinetask\">\n<b>%s</b>%s\n%s</div>"
2385 (org-html-format-headline--wrap inlinetask info)
2386 (org-html-close-tag "br" nil info)
2387 contents))))
2389 ;;;; Italic
2391 (defun org-html-italic (italic contents info)
2392 "Transcode ITALIC from Org to HTML.
2393 CONTENTS is the text with italic markup. INFO is a plist holding
2394 contextual information."
2395 (format (or (cdr (assq 'italic org-html-text-markup-alist)) "%s") contents))
2397 ;;;; Item
2399 (defun org-html-checkbox (checkbox)
2400 "Format CHECKBOX into HTML."
2401 (case checkbox (on "<code>[X]</code>")
2402 (off "<code>[&#xa0;]</code>")
2403 (trans "<code>[-]</code>")
2404 (t "")))
2406 (defun org-html-format-list-item (contents type checkbox info
2407 &optional term-counter-id
2408 headline)
2409 "Format a list item into HTML."
2410 (let ((checkbox (concat (org-html-checkbox checkbox) (and checkbox " ")))
2411 (br (org-html-close-tag "br" nil info)))
2412 (concat
2413 (case type
2414 (ordered
2415 (let* ((counter term-counter-id)
2416 (extra (if counter (format " value=\"%s\"" counter) "")))
2417 (concat
2418 (format "<li%s>" extra)
2419 (when headline (concat headline br)))))
2420 (unordered
2421 (let* ((id term-counter-id)
2422 (extra (if id (format " id=\"%s\"" id) "")))
2423 (concat
2424 (format "<li%s>" extra)
2425 (when headline (concat headline br)))))
2426 (descriptive
2427 (let* ((term term-counter-id))
2428 (setq term (or term "(no term)"))
2429 ;; Check-boxes in descriptive lists are associated to tag.
2430 (concat (format "<dt> %s </dt>"
2431 (concat checkbox term))
2432 "<dd>"))))
2433 (unless (eq type 'descriptive) checkbox)
2434 contents
2435 (case type
2436 (ordered "</li>")
2437 (unordered "</li>")
2438 (descriptive "</dd>")))))
2440 (defun org-html-item (item contents info)
2441 "Transcode an ITEM element from Org to HTML.
2442 CONTENTS holds the contents of the item. INFO is a plist holding
2443 contextual information."
2444 (let* ((plain-list (org-export-get-parent item))
2445 (type (org-element-property :type plain-list))
2446 (counter (org-element-property :counter item))
2447 (checkbox (org-element-property :checkbox item))
2448 (tag (let ((tag (org-element-property :tag item)))
2449 (and tag (org-export-data tag info)))))
2450 (org-html-format-list-item
2451 contents type checkbox info (or tag counter))))
2453 ;;;; Keyword
2455 (defun org-html-keyword (keyword contents info)
2456 "Transcode a KEYWORD element from Org to HTML.
2457 CONTENTS is nil. INFO is a plist holding contextual information."
2458 (let ((key (org-element-property :key keyword))
2459 (value (org-element-property :value keyword)))
2460 (cond
2461 ((string= key "HTML") value)
2462 ((string= key "TOC")
2463 (let ((value (downcase value)))
2464 (cond
2465 ((string-match "\\<headlines\\>" value)
2466 (let ((depth (or (and (string-match "[0-9]+" value)
2467 (string-to-number (match-string 0 value)))
2468 (plist-get info :with-toc))))
2469 (org-html-toc depth info)))
2470 ((string= "listings" value) (org-html-list-of-listings info))
2471 ((string= "tables" value) (org-html-list-of-tables info))))))))
2473 ;;;; Latex Environment
2475 (defun org-html-format-latex (latex-frag processing-type)
2476 "Format a LaTeX fragment LATEX-FRAG into HTML."
2477 (let ((cache-relpath "") (cache-dir ""))
2478 (unless (eq processing-type 'mathjax)
2479 (let ((bfn (or (buffer-file-name)
2480 (make-temp-name
2481 (expand-file-name "latex" temporary-file-directory)))))
2482 (setq cache-relpath
2483 (concat "ltxpng/"
2484 (file-name-sans-extension
2485 (file-name-nondirectory bfn)))
2486 cache-dir (file-name-directory bfn))))
2487 (with-temp-buffer
2488 (insert latex-frag)
2489 (org-format-latex cache-relpath cache-dir nil "Creating LaTeX Image..."
2490 nil nil processing-type)
2491 (buffer-string))))
2493 (defun org-html-latex-environment (latex-environment contents info)
2494 "Transcode a LATEX-ENVIRONMENT element from Org to HTML.
2495 CONTENTS is nil. INFO is a plist holding contextual information."
2496 (let ((processing-type (plist-get info :with-latex))
2497 (latex-frag (org-remove-indentation
2498 (org-element-property :value latex-environment)))
2499 (attributes (org-export-read-attribute :attr_html latex-environment)))
2500 (case processing-type
2501 ((t mathjax)
2502 (org-html-format-latex latex-frag 'mathjax))
2503 ((dvipng imagemagick)
2504 (let ((formula-link (org-html-format-latex latex-frag processing-type)))
2505 (when (and formula-link (string-match "file:\\([^]]*\\)" formula-link))
2506 ;; Do not provide a caption or a name to be consistent with
2507 ;; `mathjax' handling.
2508 (org-html--wrap-image
2509 (org-html--format-image
2510 (match-string 1 formula-link) attributes info) info))))
2511 (t latex-frag))))
2513 ;;;; Latex Fragment
2515 (defun org-html-latex-fragment (latex-fragment contents info)
2516 "Transcode a LATEX-FRAGMENT object from Org to HTML.
2517 CONTENTS is nil. INFO is a plist holding contextual information."
2518 (let ((latex-frag (org-element-property :value latex-fragment))
2519 (processing-type (plist-get info :with-latex)))
2520 (case processing-type
2521 ((t mathjax)
2522 (org-html-format-latex latex-frag 'mathjax))
2523 ((dvipng imagemagick)
2524 (let ((formula-link (org-html-format-latex latex-frag processing-type)))
2525 (when (and formula-link (string-match "file:\\([^]]*\\)" formula-link))
2526 (org-html--format-image (match-string 1 formula-link) nil info))))
2527 (t latex-frag))))
2529 ;;;; Line Break
2531 (defun org-html-line-break (line-break contents info)
2532 "Transcode a LINE-BREAK object from Org to HTML.
2533 CONTENTS is nil. INFO is a plist holding contextual information."
2534 (concat (org-html-close-tag "br" nil info) "\n"))
2536 ;;;; Link
2538 (defun org-html-inline-image-p (link info)
2539 "Non-nil when LINK is meant to appear as an image.
2540 INFO is a plist used as a communication channel. LINK is an
2541 inline image when it has no description and targets an image
2542 file (see `org-html-inline-image-rules' for more information), or
2543 if its description is a single link targeting an image file."
2544 (if (not (org-element-contents link))
2545 (org-export-inline-image-p link org-html-inline-image-rules)
2546 (not
2547 (let ((link-count 0))
2548 (org-element-map (org-element-contents link)
2549 (cons 'plain-text org-element-all-objects)
2550 (lambda (obj)
2551 (case (org-element-type obj)
2552 (plain-text (org-string-nw-p obj))
2553 (link (if (= link-count 1) t
2554 (incf link-count)
2555 (not (org-export-inline-image-p
2556 obj org-html-inline-image-rules))))
2557 (otherwise t)))
2558 info t)))))
2560 (defvar org-html-standalone-image-predicate)
2561 (defun org-html-standalone-image-p (element info)
2562 "Test if ELEMENT is a standalone image.
2564 INFO is a plist holding contextual information.
2566 Return non-nil, if ELEMENT is of type paragraph and its sole
2567 content, save for white spaces, is a link that qualifies as an
2568 inline image.
2570 Return non-nil, if ELEMENT is of type link and its containing
2571 paragraph has no other content save white spaces.
2573 Return nil, otherwise.
2575 Bind `org-html-standalone-image-predicate' to constrain paragraph
2576 further. For example, to check for only captioned standalone
2577 images, set it to:
2579 \(lambda (paragraph) (org-element-property :caption paragraph))"
2580 (let ((paragraph (case (org-element-type element)
2581 (paragraph element)
2582 (link (org-export-get-parent element)))))
2583 (and (eq (org-element-type paragraph) 'paragraph)
2584 (or (not (and (boundp 'org-html-standalone-image-predicate)
2585 (functionp org-html-standalone-image-predicate)))
2586 (funcall org-html-standalone-image-predicate paragraph))
2587 (not (let ((link-count 0))
2588 (org-element-map (org-element-contents paragraph)
2589 (cons 'plain-text org-element-all-objects)
2590 (lambda (obj) (case (org-element-type obj)
2591 (plain-text (org-string-nw-p obj))
2592 (link
2593 (or (> (incf link-count) 1)
2594 (not (org-html-inline-image-p obj info))))
2595 (otherwise t)))
2596 info 'first-match 'link))))))
2598 (defun org-html-link (link desc info)
2599 "Transcode a LINK object from Org to HTML.
2601 DESC is the description part of the link, or the empty string.
2602 INFO is a plist holding contextual information. See
2603 `org-export-data'."
2604 (let* ((home (when (plist-get info :html-link-home)
2605 (org-trim (plist-get info :html-link-home))))
2606 (use-abs-url (plist-get info :html-link-use-abs-url))
2607 (link-org-files-as-html-maybe
2608 (function
2609 (lambda (raw-path info)
2610 "Treat links to `file.org' as links to `file.html', if needed.
2611 See `org-html-link-org-files-as-html'."
2612 (cond
2613 ((and org-html-link-org-files-as-html
2614 (string= ".org"
2615 (downcase (file-name-extension raw-path "."))))
2616 (concat (file-name-sans-extension raw-path) "."
2617 (plist-get info :html-extension)))
2618 (t raw-path)))))
2619 (type (org-element-property :type link))
2620 (raw-path (org-element-property :path link))
2621 ;; Ensure DESC really exists, or set it to nil.
2622 (desc (org-string-nw-p desc))
2623 (path
2624 (cond
2625 ((member type '("http" "https" "ftp" "mailto"))
2626 (concat type ":" raw-path))
2627 ((string= type "file")
2628 ;; Treat links to ".org" files as ".html", if needed.
2629 (setq raw-path
2630 (funcall link-org-files-as-html-maybe raw-path info))
2631 ;; If file path is absolute, prepend it with protocol
2632 ;; component - "file://".
2633 (cond ((file-name-absolute-p raw-path)
2634 (setq raw-path
2635 (concat "file://" (expand-file-name
2636 raw-path))))
2637 ((and home use-abs-url)
2638 (setq raw-path (concat (file-name-as-directory home) raw-path))))
2639 ;; Add search option, if any. A search option can be
2640 ;; relative to a custom-id or a headline title. Any other
2641 ;; option is ignored.
2642 (let ((option (org-element-property :search-option link)))
2643 (cond ((not option) raw-path)
2644 ((eq (aref option 0) ?#) (concat raw-path option))
2645 ;; External fuzzy link: try to resolve it if path
2646 ;; belongs to current project, if any.
2647 ((eq (aref option 0) ?*)
2648 (concat
2649 raw-path
2650 (let ((numbers
2651 (org-publish-resolve-external-fuzzy-link
2652 (org-element-property :path link) option)))
2653 (and numbers (concat "#sec-"
2654 (mapconcat 'number-to-string
2655 numbers "-"))))))
2656 (t raw-path))))
2657 (t raw-path)))
2658 ;; Extract attributes from parent's paragraph. HACK: Only do
2659 ;; this for the first link in parent (inner image link for
2660 ;; inline images). This is needed as long as attributes
2661 ;; cannot be set on a per link basis.
2662 (attributes-plist
2663 (let* ((parent (org-export-get-parent-element link))
2664 (link (let ((container (org-export-get-parent link)))
2665 (if (and (eq (org-element-type container) 'link)
2666 (org-html-inline-image-p link info))
2667 container
2668 link))))
2669 (and (eq (org-element-map parent 'link 'identity info t) link)
2670 (org-export-read-attribute :attr_html parent))))
2671 (attributes
2672 (let ((attr (org-html--make-attribute-string attributes-plist)))
2673 (if (org-string-nw-p attr) (concat " " attr) "")))
2674 protocol)
2675 (cond
2676 ;; Image file.
2677 ((and org-html-inline-images
2678 (org-export-inline-image-p link org-html-inline-image-rules))
2679 (org-html--format-image path attributes-plist info))
2680 ;; Radio target: Transcode target's contents and use them as
2681 ;; link's description.
2682 ((string= type "radio")
2683 (let ((destination (org-export-resolve-radio-link link info)))
2684 (when destination
2685 (format "<a href=\"#%s\"%s>%s</a>"
2686 (org-export-solidify-link-text path)
2687 attributes
2688 (org-export-data (org-element-contents destination) info)))))
2689 ;; Links pointing to a headline: Find destination and build
2690 ;; appropriate referencing command.
2691 ((member type '("custom-id" "fuzzy" "id"))
2692 (let ((destination (if (string= type "fuzzy")
2693 (org-export-resolve-fuzzy-link link info)
2694 (org-export-resolve-id-link link info))))
2695 (case (org-element-type destination)
2696 ;; ID link points to an external file.
2697 (plain-text
2698 (let ((fragment (concat "ID-" path))
2699 ;; Treat links to ".org" files as ".html", if needed.
2700 (path (funcall link-org-files-as-html-maybe
2701 destination info)))
2702 (format "<a href=\"%s#%s\"%s>%s</a>"
2703 path fragment attributes (or desc destination))))
2704 ;; Fuzzy link points nowhere.
2705 ((nil)
2706 (format "<i>%s</i>"
2707 (or desc
2708 (org-export-data
2709 (org-element-property :raw-link link) info))))
2710 ;; Link points to a headline.
2711 (headline
2712 (let ((href
2713 ;; What href to use?
2714 (cond
2715 ;; Case 1: Headline is linked via it's CUSTOM_ID
2716 ;; property. Use CUSTOM_ID.
2717 ((string= type "custom-id")
2718 (org-element-property :CUSTOM_ID destination))
2719 ;; Case 2: Headline is linked via it's ID property
2720 ;; or through other means. Use the default href.
2721 ((member type '("id" "fuzzy"))
2722 (format "sec-%s"
2723 (mapconcat 'number-to-string
2724 (org-export-get-headline-number
2725 destination info) "-")))
2726 (t (error "Shouldn't reach here"))))
2727 ;; What description to use?
2728 (desc
2729 ;; Case 1: Headline is numbered and LINK has no
2730 ;; description. Display section number.
2731 (if (and (org-export-numbered-headline-p destination info)
2732 (not desc))
2733 (mapconcat 'number-to-string
2734 (org-export-get-headline-number
2735 destination info) ".")
2736 ;; Case 2: Either the headline is un-numbered or
2737 ;; LINK has a custom description. Display LINK's
2738 ;; description or headline's title.
2739 (or desc (org-export-data (org-element-property
2740 :title destination) info)))))
2741 (format "<a href=\"#%s\"%s>%s</a>"
2742 (org-export-solidify-link-text href) attributes desc)))
2743 ;; Fuzzy link points to a target or an element.
2745 (let* ((path (org-export-solidify-link-text path))
2746 (org-html-standalone-image-predicate 'org-html--has-caption-p)
2747 (number (cond
2748 (desc nil)
2749 ((org-html-standalone-image-p destination info)
2750 (org-export-get-ordinal
2751 (org-element-map destination 'link
2752 'identity info t)
2753 info 'link 'org-html-standalone-image-p))
2754 (t (org-export-get-ordinal
2755 destination info nil 'org-html--has-caption-p))))
2756 (desc (cond (desc)
2757 ((not number) "No description for this link")
2758 ((numberp number) (number-to-string number))
2759 (t (mapconcat 'number-to-string number ".")))))
2760 (format "<a href=\"#%s\"%s>%s</a>" path attributes desc))))))
2761 ;; Coderef: replace link with the reference name or the
2762 ;; equivalent line number.
2763 ((string= type "coderef")
2764 (let ((fragment (concat "coderef-" path)))
2765 (format "<a href=\"#%s\"%s%s>%s</a>"
2766 fragment
2767 (org-trim
2768 (format (concat "class=\"coderef\""
2769 " onmouseover=\"CodeHighlightOn(this, '%s');\""
2770 " onmouseout=\"CodeHighlightOff(this, '%s');\"")
2771 fragment fragment))
2772 attributes
2773 (format (org-export-get-coderef-format path desc)
2774 (org-export-resolve-coderef path info)))))
2775 ;; Link type is handled by a special function.
2776 ((functionp (setq protocol (nth 2 (assoc type org-link-protocols))))
2777 (funcall protocol (org-link-unescape path) desc 'html))
2778 ;; External link with a description part.
2779 ((and path desc) (format "<a href=\"%s\"%s>%s</a>" path attributes desc))
2780 ;; External link without a description part.
2781 (path (format "<a href=\"%s\"%s>%s</a>" path attributes path))
2782 ;; No path, only description. Try to do something useful.
2783 (t (format "<i>%s</i>" desc)))))
2785 ;;;; Paragraph
2787 (defun org-html-paragraph (paragraph contents info)
2788 "Transcode a PARAGRAPH element from Org to HTML.
2789 CONTENTS is the contents of the paragraph, as a string. INFO is
2790 the plist used as a communication channel."
2791 (let* ((parent (org-export-get-parent paragraph))
2792 (parent-type (org-element-type parent))
2793 (style '((footnote-definition " class=\"footpara\"")))
2794 (extra (or (cadr (assoc parent-type style)) "")))
2795 (cond
2796 ((and (eq (org-element-type parent) 'item)
2797 (= (org-element-property :begin paragraph)
2798 (org-element-property :contents-begin parent)))
2799 ;; Leading paragraph in a list item have no tags.
2800 contents)
2801 ((org-html-standalone-image-p paragraph info)
2802 ;; Standalone image.
2803 (let ((caption
2804 (let ((raw (org-export-data
2805 (org-export-get-caption paragraph) info))
2806 (org-html-standalone-image-predicate
2807 'org-html--has-caption-p))
2808 (if (not (org-string-nw-p raw)) raw
2809 (concat
2810 "<span class=\"figure-number\">"
2811 (format (org-html--translate "Figure %d:" info)
2812 (org-export-get-ordinal
2813 (org-element-map paragraph 'link
2814 'identity info t)
2815 info nil 'org-html-standalone-image-p))
2816 "</span> " raw))))
2817 (label (org-element-property :name paragraph)))
2818 (org-html--wrap-image contents info caption label)))
2819 ;; Regular paragraph.
2820 (t (format "<p%s>\n%s</p>" extra contents)))))
2822 ;;;; Plain List
2824 ;; FIXME Maybe arg1 is not needed because <li value="20"> already sets
2825 ;; the correct value for the item counter
2826 (defun org-html-begin-plain-list (type &optional arg1)
2827 "Insert the beginning of the HTML list depending on TYPE.
2828 When ARG1 is a string, use it as the start parameter for ordered
2829 lists."
2830 (case type
2831 (ordered
2832 (format "<ol class=\"org-ol\"%s>"
2833 (if arg1 (format " start=\"%d\"" arg1) "")))
2834 (unordered "<ul class=\"org-ul\">")
2835 (descriptive "<dl class=\"org-dl\">")))
2837 (defun org-html-end-plain-list (type)
2838 "Insert the end of the HTML list depending on TYPE."
2839 (case type
2840 (ordered "</ol>")
2841 (unordered "</ul>")
2842 (descriptive "</dl>")))
2844 (defun org-html-plain-list (plain-list contents info)
2845 "Transcode a PLAIN-LIST element from Org to HTML.
2846 CONTENTS is the contents of the list. INFO is a plist holding
2847 contextual information."
2848 (let* (arg1 ;; (assoc :counter (org-element-map plain-list 'item
2849 (type (org-element-property :type plain-list)))
2850 (format "%s\n%s%s"
2851 (org-html-begin-plain-list type)
2852 contents (org-html-end-plain-list type))))
2854 ;;;; Plain Text
2856 (defun org-html-convert-special-strings (string)
2857 "Convert special characters in STRING to HTML."
2858 (let ((all org-html-special-string-regexps)
2859 e a re rpl start)
2860 (while (setq a (pop all))
2861 (setq re (car a) rpl (cdr a) start 0)
2862 (while (string-match re string start)
2863 (setq string (replace-match rpl t nil string))))
2864 string))
2866 (defun org-html-encode-plain-text (text)
2867 "Convert plain text characters from TEXT to HTML equivalent.
2868 Possible conversions are set in `org-html-protect-char-alist'."
2869 (mapc
2870 (lambda (pair)
2871 (setq text (replace-regexp-in-string (car pair) (cdr pair) text t t)))
2872 org-html-protect-char-alist)
2873 text)
2875 (defun org-html-plain-text (text info)
2876 "Transcode a TEXT string from Org to HTML.
2877 TEXT is the string to transcode. INFO is a plist holding
2878 contextual information."
2879 (let ((output text))
2880 ;; Protect following characters: <, >, &.
2881 (setq output (org-html-encode-plain-text output))
2882 ;; Handle smart quotes. Be sure to provide original string since
2883 ;; OUTPUT may have been modified.
2884 (when (plist-get info :with-smart-quotes)
2885 (setq output (org-export-activate-smart-quotes output :html info text)))
2886 ;; Handle special strings.
2887 (when (plist-get info :with-special-strings)
2888 (setq output (org-html-convert-special-strings output)))
2889 ;; Handle break preservation if required.
2890 (when (plist-get info :preserve-breaks)
2891 (setq output
2892 (replace-regexp-in-string
2893 "\\(\\\\\\\\\\)?[ \t]*\n"
2894 (concat (org-html-close-tag "br" nil info) "\n") output)))
2895 ;; Return value.
2896 output))
2899 ;; Planning
2901 (defun org-html-planning (planning contents info)
2902 "Transcode a PLANNING element from Org to HTML.
2903 CONTENTS is nil. INFO is a plist used as a communication
2904 channel."
2905 (let ((span-fmt "<span class=\"timestamp-kwd\">%s</span> <span class=\"timestamp\">%s</span>"))
2906 (format
2907 "<p><span class=\"timestamp-wrapper\">%s</span></p>"
2908 (mapconcat
2909 'identity
2910 (delq nil
2911 (list
2912 (let ((closed (org-element-property :closed planning)))
2913 (when closed
2914 (format span-fmt org-closed-string
2915 (org-translate-time
2916 (org-element-property :raw-value closed)))))
2917 (let ((deadline (org-element-property :deadline planning)))
2918 (when deadline
2919 (format span-fmt org-deadline-string
2920 (org-translate-time
2921 (org-element-property :raw-value deadline)))))
2922 (let ((scheduled (org-element-property :scheduled planning)))
2923 (when scheduled
2924 (format span-fmt org-scheduled-string
2925 (org-translate-time
2926 (org-element-property :raw-value scheduled)))))))
2927 " "))))
2929 ;;;; Property Drawer
2931 (defun org-html-property-drawer (property-drawer contents info)
2932 "Transcode a PROPERTY-DRAWER element from Org to HTML.
2933 CONTENTS is nil. INFO is a plist holding contextual
2934 information."
2935 ;; The property drawer isn't exported but we want separating blank
2936 ;; lines nonetheless.
2939 ;;;; Quote Block
2941 (defun org-html-quote-block (quote-block contents info)
2942 "Transcode a QUOTE-BLOCK element from Org to HTML.
2943 CONTENTS holds the contents of the block. INFO is a plist
2944 holding contextual information."
2945 (format "<blockquote>\n%s</blockquote>" contents))
2947 ;;;; Quote Section
2949 (defun org-html-quote-section (quote-section contents info)
2950 "Transcode a QUOTE-SECTION element from Org to HTML.
2951 CONTENTS is nil. INFO is a plist holding contextual information."
2952 (let ((value (org-remove-indentation
2953 (org-element-property :value quote-section))))
2954 (when value (format "<pre>\n%s</pre>" value))))
2956 ;;;; Section
2958 (defun org-html-section (section contents info)
2959 "Transcode a SECTION element from Org to HTML.
2960 CONTENTS holds the contents of the section. INFO is a plist
2961 holding contextual information."
2962 (let ((parent (org-export-get-parent-headline section)))
2963 ;; Before first headline: no container, just return CONTENTS.
2964 (if (not parent) contents
2965 ;; Get div's class and id references.
2966 (let* ((class-num (+ (org-export-get-relative-level parent info)
2967 (1- org-html-toplevel-hlevel)))
2968 (section-number
2969 (mapconcat
2970 'number-to-string
2971 (org-export-get-headline-number parent info) "-")))
2972 ;; Build return value.
2973 (format "<div class=\"outline-text-%d\" id=\"text-%s\">\n%s</div>"
2974 class-num
2975 (or (org-element-property :CUSTOM_ID parent) section-number)
2976 contents)))))
2978 ;;;; Radio Target
2980 (defun org-html-radio-target (radio-target text info)
2981 "Transcode a RADIO-TARGET object from Org to HTML.
2982 TEXT is the text of the target. INFO is a plist holding
2983 contextual information."
2984 (let ((id (org-export-solidify-link-text
2985 (org-element-property :value radio-target))))
2986 (org-html--anchor id text)))
2988 ;;;; Special Block
2990 (defun org-html-special-block (special-block contents info)
2991 "Transcode a SPECIAL-BLOCK element from Org to HTML.
2992 CONTENTS holds the contents of the block. INFO is a plist
2993 holding contextual information."
2994 (let* ((block-type (downcase
2995 (org-element-property :type special-block)))
2996 (contents (or contents ""))
2997 (html5-fancy (and (org-html-html5-p info)
2998 (plist-get info :html-html5-fancy)
2999 (member block-type org-html-html5-elements)))
3000 (attributes (org-export-read-attribute :attr_html special-block)))
3001 (unless html5-fancy
3002 (let ((class (plist-get attributes :class)))
3003 (setq attributes (plist-put attributes :class
3004 (if class (concat class " " block-type)
3005 block-type)))))
3006 (setq attributes (org-html--make-attribute-string attributes))
3007 (when (not (equal attributes ""))
3008 (setq attributes (concat " " attributes)))
3009 (if html5-fancy
3010 (format "<%s%s>\n%s</%s>" block-type attributes
3011 contents block-type)
3012 (format "<div%s>\n%s\n</div>" attributes contents))))
3014 ;;;; Src Block
3016 (defun org-html-src-block (src-block contents info)
3017 "Transcode a SRC-BLOCK element from Org to HTML.
3018 CONTENTS holds the contents of the item. INFO is a plist holding
3019 contextual information."
3020 (if (org-export-read-attribute :attr_html src-block :textarea)
3021 (org-html--textarea-block src-block)
3022 (let ((lang (org-element-property :language src-block))
3023 (caption (org-export-get-caption src-block))
3024 (code (org-html-format-code src-block info))
3025 (label (let ((lbl (org-element-property :name src-block)))
3026 (if (not lbl) ""
3027 (format " id=\"%s\""
3028 (org-export-solidify-link-text lbl))))))
3029 (if (not lang) (format "<pre class=\"example\"%s>\n%s</pre>" label code)
3030 (format
3031 "<div class=\"org-src-container\">\n%s%s\n</div>"
3032 (if (not caption) ""
3033 (format "<label class=\"org-src-name\">%s</label>"
3034 (org-export-data caption info)))
3035 (format "\n<pre class=\"src src-%s\"%s>%s</pre>" lang label code))))))
3037 ;;;; Statistics Cookie
3039 (defun org-html-statistics-cookie (statistics-cookie contents info)
3040 "Transcode a STATISTICS-COOKIE object from Org to HTML.
3041 CONTENTS is nil. INFO is a plist holding contextual information."
3042 (let ((cookie-value (org-element-property :value statistics-cookie)))
3043 (format "<code>%s</code>" cookie-value)))
3045 ;;;; Strike-Through
3047 (defun org-html-strike-through (strike-through contents info)
3048 "Transcode STRIKE-THROUGH from Org to HTML.
3049 CONTENTS is the text with strike-through markup. INFO is a plist
3050 holding contextual information."
3051 (format (or (cdr (assq 'strike-through org-html-text-markup-alist)) "%s")
3052 contents))
3054 ;;;; Subscript
3056 (defun org-html-subscript (subscript contents info)
3057 "Transcode a SUBSCRIPT object from Org to HTML.
3058 CONTENTS is the contents of the object. INFO is a plist holding
3059 contextual information."
3060 (format "<sub>%s</sub>" contents))
3062 ;;;; Superscript
3064 (defun org-html-superscript (superscript contents info)
3065 "Transcode a SUPERSCRIPT object from Org to HTML.
3066 CONTENTS is the contents of the object. INFO is a plist holding
3067 contextual information."
3068 (format "<sup>%s</sup>" contents))
3070 ;;;; Tabel Cell
3072 (defun org-html-table-cell (table-cell contents info)
3073 "Transcode a TABLE-CELL element from Org to HTML.
3074 CONTENTS is nil. INFO is a plist used as a communication
3075 channel."
3076 (let* ((table-row (org-export-get-parent table-cell))
3077 (table (org-export-get-parent-table table-cell))
3078 (cell-attrs
3079 (if (not org-html-table-align-individual-fields) ""
3080 (format (if (and (boundp 'org-html-format-table-no-css)
3081 org-html-format-table-no-css)
3082 " align=\"%s\"" " class=\"%s\"")
3083 (org-export-table-cell-alignment table-cell info)))))
3084 (when (or (not contents) (string= "" (org-trim contents)))
3085 (setq contents "&#xa0;"))
3086 (cond
3087 ((and (org-export-table-has-header-p table info)
3088 (= 1 (org-export-table-row-group table-row info)))
3089 (concat "\n" (format (car org-html-table-header-tags) "col" cell-attrs)
3090 contents (cdr org-html-table-header-tags)))
3091 ((and org-html-table-use-header-tags-for-first-column
3092 (zerop (cdr (org-export-table-cell-address table-cell info))))
3093 (concat "\n" (format (car org-html-table-header-tags) "row" cell-attrs)
3094 contents (cdr org-html-table-header-tags)))
3095 (t (concat "\n" (format (car org-html-table-data-tags) cell-attrs)
3096 contents (cdr org-html-table-data-tags))))))
3098 ;;;; Table Row
3100 (defun org-html-table-row (table-row contents info)
3101 "Transcode a TABLE-ROW element from Org to HTML.
3102 CONTENTS is the contents of the row. INFO is a plist used as a
3103 communication channel."
3104 ;; Rules are ignored since table separators are deduced from
3105 ;; borders of the current row.
3106 (when (eq (org-element-property :type table-row) 'standard)
3107 (let* ((rowgroup-number (org-export-table-row-group table-row info))
3108 (row-number (org-export-table-row-number table-row info))
3109 (start-rowgroup-p
3110 (org-export-table-row-starts-rowgroup-p table-row info))
3111 (end-rowgroup-p
3112 (org-export-table-row-ends-rowgroup-p table-row info))
3113 ;; `top-row-p' and `end-rowgroup-p' are not used directly
3114 ;; but should be set so that `org-html-table-row-tags' can
3115 ;; use them (see the docstring of this variable.)
3116 (top-row-p (and (equal start-rowgroup-p '(top))
3117 (equal end-rowgroup-p '(below top))))
3118 (bottom-row-p (and (equal start-rowgroup-p '(above))
3119 (equal end-rowgroup-p '(bottom above))))
3120 (rowgroup-tags
3121 (cond
3122 ;; Case 1: Row belongs to second or subsequent rowgroups.
3123 ((not (= 1 rowgroup-number))
3124 '("<tbody>" . "\n</tbody>"))
3125 ;; Case 2: Row is from first rowgroup. Table has >=1 rowgroups.
3126 ((org-export-table-has-header-p
3127 (org-export-get-parent-table table-row) info)
3128 '("<thead>" . "\n</thead>"))
3129 ;; Case 2: Row is from first and only row group.
3130 (t '("<tbody>" . "\n</tbody>")))))
3131 (concat
3132 ;; Begin a rowgroup?
3133 (when start-rowgroup-p (car rowgroup-tags))
3134 ;; Actual table row
3135 (concat "\n" (eval (car org-html-table-row-tags))
3136 contents
3137 "\n"
3138 (eval (cdr org-html-table-row-tags)))
3139 ;; End a rowgroup?
3140 (when end-rowgroup-p (cdr rowgroup-tags))))))
3142 ;;;; Table
3144 (defun org-html-table-first-row-data-cells (table info)
3145 "Transcode the first row of TABLE.
3146 INFO is a plist used as a communication channel."
3147 (let ((table-row
3148 (org-element-map table 'table-row
3149 (lambda (row)
3150 (unless (eq (org-element-property :type row) 'rule) row))
3151 info 'first-match))
3152 (special-column-p (org-export-table-has-special-column-p table)))
3153 (if (not special-column-p) (org-element-contents table-row)
3154 (cdr (org-element-contents table-row)))))
3156 (defun org-html-table--table.el-table (table info)
3157 "Format table.el tables into HTML.
3158 INFO is a plist used as a communication channel."
3159 (when (eq (org-element-property :type table) 'table.el)
3160 (require 'table)
3161 (let ((outbuf (with-current-buffer
3162 (get-buffer-create "*org-export-table*")
3163 (erase-buffer) (current-buffer))))
3164 (with-temp-buffer
3165 (insert (org-element-property :value table))
3166 (goto-char 1)
3167 (re-search-forward "^[ \t]*|[^|]" nil t)
3168 (table-generate-source 'html outbuf))
3169 (with-current-buffer outbuf
3170 (prog1 (org-trim (buffer-string))
3171 (kill-buffer) )))))
3173 (defun org-html-table (table contents info)
3174 "Transcode a TABLE element from Org to HTML.
3175 CONTENTS is the contents of the table. INFO is a plist holding
3176 contextual information."
3177 (case (org-element-property :type table)
3178 ;; Case 1: table.el table. Convert it using appropriate tools.
3179 (table.el (org-html-table--table.el-table table info))
3180 ;; Case 2: Standard table.
3182 (let* ((label (org-element-property :name table))
3183 (caption (org-export-get-caption table))
3184 (number (org-export-get-ordinal
3185 table info nil 'org-html--has-caption-p))
3186 (attributes
3187 (org-html--make-attribute-string
3188 (org-combine-plists
3189 (and label (list :id (org-export-solidify-link-text label)))
3190 (and (not (org-html-html5-p info))
3191 (plist-get info :html-table-attributes))
3192 (org-export-read-attribute :attr_html table))))
3193 (alignspec
3194 (if (and (boundp 'org-html-format-table-no-css)
3195 org-html-format-table-no-css)
3196 "align=\"%s\"" "class=\"%s\""))
3197 (table-column-specs
3198 (function
3199 (lambda (table info)
3200 (mapconcat
3201 (lambda (table-cell)
3202 (let ((alignment (org-export-table-cell-alignment
3203 table-cell info)))
3204 (concat
3205 ;; Begin a colgroup?
3206 (when (org-export-table-cell-starts-colgroup-p
3207 table-cell info)
3208 "\n<colgroup>")
3209 ;; Add a column. Also specify it's alignment.
3210 (format "\n%s"
3211 (org-html-close-tag
3212 "col" (concat " " (format alignspec alignment)) info))
3213 ;; End a colgroup?
3214 (when (org-export-table-cell-ends-colgroup-p
3215 table-cell info)
3216 "\n</colgroup>"))))
3217 (org-html-table-first-row-data-cells table info) "\n")))))
3218 (format "<table%s>\n%s\n%s\n%s</table>"
3219 (if (equal attributes "") "" (concat " " attributes))
3220 (if (not caption) ""
3221 (format (if org-html-table-caption-above
3222 "<caption align=\"above\">%s</caption>"
3223 "<caption align=\"bottom\">%s</caption>")
3224 (concat
3225 "<span class=\"table-number\">"
3226 (format (org-html--translate "Table %d:" info) number)
3227 "</span> " (org-export-data caption info))))
3228 (funcall table-column-specs table info)
3229 contents)))))
3231 ;;;; Target
3233 (defun org-html-target (target contents info)
3234 "Transcode a TARGET object from Org to HTML.
3235 CONTENTS is nil. INFO is a plist holding contextual
3236 information."
3237 (let ((id (org-export-solidify-link-text
3238 (org-element-property :value target))))
3239 (org-html--anchor id)))
3241 ;;;; Timestamp
3243 (defun org-html-timestamp (timestamp contents info)
3244 "Transcode a TIMESTAMP object from Org to HTML.
3245 CONTENTS is nil. INFO is a plist holding contextual
3246 information."
3247 (let ((value (org-html-plain-text
3248 (org-timestamp-translate timestamp) info)))
3249 (format "<span class=\"timestamp-wrapper\"><span class=\"timestamp\">%s</span></span>"
3250 (replace-regexp-in-string "--" "&#x2013;" value))))
3252 ;;;; Underline
3254 (defun org-html-underline (underline contents info)
3255 "Transcode UNDERLINE from Org to HTML.
3256 CONTENTS is the text with underline markup. INFO is a plist
3257 holding contextual information."
3258 (format (or (cdr (assq 'underline org-html-text-markup-alist)) "%s")
3259 contents))
3261 ;;;; Verbatim
3263 (defun org-html-verbatim (verbatim contents info)
3264 "Transcode VERBATIM from Org to HTML.
3265 CONTENTS is nil. INFO is a plist holding contextual
3266 information."
3267 (format (or (cdr (assq 'verbatim org-html-text-markup-alist)) "%s")
3268 (org-html-encode-plain-text (org-element-property :value verbatim))))
3270 ;;;; Verse Block
3272 (defun org-html-verse-block (verse-block contents info)
3273 "Transcode a VERSE-BLOCK element from Org to HTML.
3274 CONTENTS is verse block contents. INFO is a plist holding
3275 contextual information."
3276 ;; Replace each newline character with line break. Also replace
3277 ;; each blank line with a line break.
3278 (setq contents (replace-regexp-in-string
3279 "^ *\\\\\\\\$" (format "%s\n" (org-html-close-tag "br" nil info))
3280 (replace-regexp-in-string
3281 "\\(\\\\\\\\\\)?[ \t]*\n"
3282 (format "%s\n" (org-html-close-tag "br" nil info)) contents)))
3283 ;; Replace each white space at beginning of a line with a
3284 ;; non-breaking space.
3285 (while (string-match "^[ \t]+" contents)
3286 (let* ((num-ws (length (match-string 0 contents)))
3287 (ws (let (out) (dotimes (i num-ws out)
3288 (setq out (concat out "&#xa0;"))))))
3289 (setq contents (replace-match ws nil t contents))))
3290 (format "<p class=\"verse\">\n%s</p>" contents))
3293 ;;; Filter Functions
3295 (defun org-html-final-function (contents backend info)
3296 "Filter to indent the HTML and convert HTML entities."
3297 (with-temp-buffer
3298 (insert contents)
3299 (set-auto-mode t)
3300 (if org-html-indent
3301 (indent-region (point-min) (point-max)))
3302 (when org-html-use-unicode-chars
3303 (require 'mm-url)
3304 (mm-url-decode-entities))
3305 (buffer-substring-no-properties (point-min) (point-max))))
3308 ;;; End-user functions
3310 ;;;###autoload
3311 (defun org-html-export-as-html
3312 (&optional async subtreep visible-only body-only ext-plist)
3313 "Export current buffer to an HTML buffer.
3315 If narrowing is active in the current buffer, only export its
3316 narrowed part.
3318 If a region is active, export that region.
3320 A non-nil optional argument ASYNC means the process should happen
3321 asynchronously. The resulting buffer should be accessible
3322 through the `org-export-stack' interface.
3324 When optional argument SUBTREEP is non-nil, export the sub-tree
3325 at point, extracting information from the headline properties
3326 first.
3328 When optional argument VISIBLE-ONLY is non-nil, don't export
3329 contents of hidden elements.
3331 When optional argument BODY-ONLY is non-nil, only write code
3332 between \"<body>\" and \"</body>\" tags.
3334 EXT-PLIST, when provided, is a property list with external
3335 parameters overriding Org default settings, but still inferior to
3336 file-local settings.
3338 Export is done in a buffer named \"*Org HTML Export*\", which
3339 will be displayed when `org-export-show-temporary-export-buffer'
3340 is non-nil."
3341 (interactive)
3342 (org-export-to-buffer 'html "*Org HTML Export*"
3343 async subtreep visible-only body-only ext-plist
3344 (lambda () (set-auto-mode t))))
3346 ;;;###autoload
3347 (defun org-html-convert-region-to-html ()
3348 "Assume the current region has org-mode syntax, and convert it to HTML.
3349 This can be used in any buffer. For example, you can write an
3350 itemized list in org-mode syntax in an HTML buffer and use this
3351 command to convert it."
3352 (interactive)
3353 (org-export-replace-region-by 'html))
3355 ;;;###autoload
3356 (defun org-html-export-to-html
3357 (&optional async subtreep visible-only body-only ext-plist)
3358 "Export current buffer to a HTML file.
3360 If narrowing is active in the current buffer, only export its
3361 narrowed part.
3363 If a region is active, export that region.
3365 A non-nil optional argument ASYNC means the process should happen
3366 asynchronously. The resulting file should be accessible through
3367 the `org-export-stack' interface.
3369 When optional argument SUBTREEP is non-nil, export the sub-tree
3370 at point, extracting information from the headline properties
3371 first.
3373 When optional argument VISIBLE-ONLY is non-nil, don't export
3374 contents of hidden elements.
3376 When optional argument BODY-ONLY is non-nil, only write code
3377 between \"<body>\" and \"</body>\" tags.
3379 EXT-PLIST, when provided, is a property list with external
3380 parameters overriding Org default settings, but still inferior to
3381 file-local settings.
3383 Return output file's name."
3384 (interactive)
3385 (let* ((extension (concat "." org-html-extension))
3386 (file (org-export-output-file-name extension subtreep))
3387 (org-export-coding-system org-html-coding-system))
3388 (org-export-to-file 'html file
3389 async subtreep visible-only body-only ext-plist)))
3391 ;;;###autoload
3392 (defun org-html-publish-to-html (plist filename pub-dir)
3393 "Publish an org file to HTML.
3395 FILENAME is the filename of the Org file to be published. PLIST
3396 is the property list for the given project. PUB-DIR is the
3397 publishing directory.
3399 Return output file name."
3400 (org-publish-org-to 'html filename
3401 (concat "." (or (plist-get plist :html-extension)
3402 org-html-extension "html"))
3403 plist pub-dir))
3406 ;;; FIXME
3408 ;;;; org-format-table-html
3409 ;;;; org-format-org-table-html
3410 ;;;; org-format-table-table-html
3411 ;;;; org-table-number-fraction
3412 ;;;; org-table-number-regexp
3413 ;;;; org-html-inline-image-extensions
3414 ;;;; org-export-preferred-target-alist
3415 ;;;; class for anchors
3416 ;;;; org-export-mark-todo-in-toc
3417 ;;;; org-html-format-org-link
3418 ;;;; (caption (and caption (org-xml-encode-org-text caption)))
3419 ;;;; alt = (file-name-nondirectory path)
3421 (provide 'ox-html)
3423 ;; Local variables:
3424 ;; generated-autoload-file: "org-loaddefs.el"
3425 ;; End:
3427 ;;; ox-html.el ends here