Merge branch 'master' of orgmode.org:org-mode
[org-mode/org-jambu.git] / lisp / org-html.el
blob5632d5cd88f85e84794be39fc99230a7ae581298
1 ;;; org-html.el --- HTML export for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.5
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;; Commentary:
29 ;;; Code:
31 (require 'org-exp)
32 (require 'format-spec)
34 (eval-when-compile (require 'cl))
36 (declare-function org-id-find-id-file "org-id" (id))
37 (declare-function htmlize-region "ext:htmlize" (beg end))
39 (defgroup org-export-html nil
40 "Options specific for HTML export of Org-mode files."
41 :tag "Org Export HTML"
42 :group 'org-export)
44 (defcustom org-export-html-footnotes-section "<div id=\"footnotes\">
45 <h2 class=\"footnotes\">%s: </h2>
46 <div id=\"text-footnotes\">
48 </div>
49 </div>"
50 "Format for the footnotes section.
51 Should contain a two instances of %s. The first will be replaced with the
52 language-specific word for \"Footnotes\", the second one will be replaced
53 by the footnotes themselves."
54 :group 'org-export-html
55 :type 'string)
57 (defcustom org-export-html-footnote-format "<sup>%s</sup>"
58 "The format for the footnote reference.
59 %s will be replaced by the footnote reference itself."
60 :group 'org-export-html
61 :type 'string)
63 (defcustom org-export-html-coding-system nil
64 "Coding system for HTML export, defaults to `buffer-file-coding-system'."
65 :group 'org-export-html
66 :type 'coding-system)
68 (defcustom org-export-html-extension "html"
69 "The extension for exported HTML files."
70 :group 'org-export-html
71 :type 'string)
73 (defcustom org-export-html-xml-declaration
74 '(("html" . "<?xml version=\"1.0\" encoding=\"%s\"?>")
75 ("php" . "<?php echo \"<?xml version=\\\"1.0\\\" encoding=\\\"%s\\\" ?>\"; ?>"))
76 "The extension for exported HTML files.
77 %s will be replaced with the charset of the exported file.
78 This may be a string, or an alist with export extensions
79 and corresponding declarations."
80 :group 'org-export-html
81 :type '(choice
82 (string :tag "Single declaration")
83 (repeat :tag "Dependent on extension"
84 (cons (string :tag "Extension")
85 (string :tag "Declaration")))))
87 (defcustom org-export-html-style-include-scripts t
88 "Non-nil means include the JavaScript snippets in exported HTML files.
89 The actual script is defined in `org-export-html-scripts' and should
90 not be modified."
91 :group 'org-export-html
92 :type 'boolean)
94 (defconst org-export-html-scripts
95 "<script type=\"text/javascript\">
96 <!--/*--><![CDATA[/*><!--*/
97 function CodeHighlightOn(elem, id)
99 var target = document.getElementById(id);
100 if(null != target) {
101 elem.cacheClassElem = elem.className;
102 elem.cacheClassTarget = target.className;
103 target.className = \"code-highlighted\";
104 elem.className = \"code-highlighted\";
107 function CodeHighlightOff(elem, id)
109 var target = document.getElementById(id);
110 if(elem.cacheClassElem)
111 elem.className = elem.cacheClassElem;
112 if(elem.cacheClassTarget)
113 target.className = elem.cacheClassTarget;
115 /*]]>*///-->
116 </script>"
117 "Basic JavaScript that is needed by HTML files produced by Org-mode.")
119 (defconst org-export-html-style-default
120 "<style type=\"text/css\">
121 <!--/*--><![CDATA[/*><!--*/
122 html { font-family: Times, serif; font-size: 12pt; }
123 .title { text-align: center; }
124 .todo { color: red; }
125 .done { color: green; }
126 .tag { background-color: #add8e6; font-weight:normal }
127 .target { }
128 .timestamp { color: #bebebe; }
129 .timestamp-kwd { color: #5f9ea0; }
130 .right {margin-left:auto; margin-right:0px; text-align:right;}
131 .left {margin-left:0px; margin-right:auto; text-align:left;}
132 .center {margin-left:auto; margin-right:auto; text-align:center;}
133 p.verse { margin-left: 3% }
134 pre {
135 border: 1pt solid #AEBDCC;
136 background-color: #F3F5F7;
137 padding: 5pt;
138 font-family: courier, monospace;
139 font-size: 90%;
140 overflow:auto;
142 table { border-collapse: collapse; }
143 td, th { vertical-align: top; }
144 th.right { text-align:center; }
145 th.left { text-align:center; }
146 th.center { text-align:center; }
147 td.right { text-align:right; }
148 td.left { text-align:left; }
149 td.center { text-align:center; }
150 dt { font-weight: bold; }
151 div.figure { padding: 0.5em; }
152 div.figure p { text-align: center; }
153 textarea { overflow-x: auto; }
154 .linenr { font-size:smaller }
155 .code-highlighted {background-color:#ffff00;}
156 .org-info-js_info-navigation { border-style:none; }
157 #org-info-js_console-label { font-size:10px; font-weight:bold;
158 white-space:nowrap; }
159 .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
160 font-weight:bold; }
161 /*]]>*/-->
162 </style>"
163 "The default style specification for exported HTML files.
164 Please use the variables `org-export-html-style' and
165 `org-export-html-style-extra' to add to this style. If you wish to not
166 have the default style included, customize the variable
167 `org-export-html-style-include-default'.")
169 (defcustom org-export-html-style-include-default t
170 "Non-nil means include the default style in exported HTML files.
171 The actual style is defined in `org-export-html-style-default' and should
172 not be modified. Use the variables `org-export-html-style' to add
173 your own style information."
174 :group 'org-export-html
175 :type 'boolean)
176 ;;;###autoload
177 (put 'org-export-html-style-include-default 'safe-local-variable 'booleanp)
179 (defcustom org-export-html-style ""
180 "Org-wide style definitions for exported HTML files.
182 This variable needs to contain the full HTML structure to provide a style,
183 including the surrounding HTML tags. If you set the value of this variable,
184 you should consider to include definitions for the following classes:
185 title, todo, done, timestamp, timestamp-kwd, tag, target.
187 For example, a valid value would be:
189 <style type=\"text/css\">
190 <![CDATA[
191 p { font-weight: normal; color: gray; }
192 h1 { color: black; }
193 .title { text-align: center; }
194 .todo, .timestamp-kwd { color: red; }
195 .done { color: green; }
197 </style>
199 If you'd like to refer to en external style file, use something like
201 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
203 As the value of this option simply gets inserted into the HTML <head> header,
204 you can \"misuse\" it to add arbitrary text to the header.
205 See also the variable `org-export-html-style-extra'."
206 :group 'org-export-html
207 :type 'string)
208 ;;;###autoload
209 (put 'org-export-html-style 'safe-local-variable 'stringp)
211 (defcustom org-export-html-style-extra ""
212 "Additional style information for HTML export.
213 The value of this variable is inserted into the HTML buffer right after
214 the value of `org-export-html-style'. Use this variable for per-file
215 settings of style information, and do not forget to surround the style
216 settings with <style>...</style> tags."
217 :group 'org-export-html
218 :type 'string)
219 ;;;###autoload
220 (put 'org-export-html-style-extra 'safe-local-variable 'stringp)
222 (defcustom org-export-html-mathjax-options
223 '((path "http://orgmode.org/mathjax/MathJax.js")
224 (scale "100")
225 (align "center")
226 (indent "2em")
227 (mathml nil))
228 "Options for MathJax setup.
230 path The path where to find MathJax
231 scale Scaling for the HTML-CSS backend, usually between 100 and 133
232 align How to align display math: left, center, or right
233 indent If align is not center, how far from the left/right side?
234 mathml Should a MathML player be used if available?
235 This is faster and reduces bandwidth use, but currently
236 sometimes has lower spacing quality. Therefore, the default is
237 nil. When browsers get better, this switch can be flipped.
239 You can also customize this for each buffer, using something like
241 #+MATHJAX: scale:\"133\" align:\"right\" mathml:t path:\"/MathJax/\""
242 :group 'org-export-html
243 :type '(list :greedy t
244 (list :tag "path (the path from where to load MathJax.js)"
245 (const :format " " path) (string))
246 (list :tag "scale (scaling for the displayed math)"
247 (const :format " " scale) (string))
248 (list :tag "align (alignment of displayed equations)"
249 (const :format " " align) (string))
250 (list :tag "indent (indentation with left or right alignment)"
251 (const :format " " indent) (string))
252 (list :tag "mathml (should MathML display be used is possible)"
253 (const :format " " mathml) (boolean))))
255 (defun org-export-html-mathjax-config (template options in-buffer)
256 "Insert the user setup into the matchjax template."
257 (let (name val (yes " ") (no "// ") x)
258 (mapc
259 (lambda (e)
260 (setq name (car e) val (nth 1 e))
261 (if (string-match (concat "\\<" (symbol-name name) ":") in-buffer)
262 (setq val (car (read-from-string
263 (substring in-buffer (match-end 0))))))
264 (if (not (stringp val)) (setq val (format "%s" val)))
265 (if (string-match (concat "%" (upcase (symbol-name name))) template)
266 (setq template (replace-match val t t template))))
267 options)
268 (setq val (nth 1 (assq 'mathml options)))
269 (if (string-match (concat "\\<mathml:") in-buffer)
270 (setq val (car (read-from-string
271 (substring in-buffer (match-end 0))))))
272 ;; Exchange prefixes depending on mathml setting
273 (if (not val) (setq x yes yes no no x))
274 ;; Replace cookies to turn on or off the config/jax lines
275 (if (string-match ":MMLYES:" template)
276 (setq template (replace-match yes t t template)))
277 (if (string-match ":MMLNO:" template)
278 (setq template (replace-match no t t template)))
279 ;; Return the modified template
280 template))
282 (defcustom org-export-html-mathjax-template
283 "<script type=\"text/javascript\" src=\"%PATH\">
284 <!--/*--><![CDATA[/*><!--*/
285 MathJax.Hub.Config({
286 // Only one of the two following lines, depending on user settings
287 // First allows browser-native MathML display, second forces HTML/CSS
288 :MMLYES: config: [\"MMLorHTML.js\"], jax: [\"input/TeX\"],
289 :MMLNO: jax: [\"input/TeX\", \"output/HTML-CSS\"],
290 extensions: [\"tex2jax.js\",\"TeX/AMSmath.js\",\"TeX/AMSsymbols.js\",
291 \"TeX/noUndefined.js\"],
292 tex2jax: {
293 inlineMath: [ [\"\\\\(\",\"\\\\)\"] ],
294 displayMath: [ ['$$','$$'], [\"\\\\[\",\"\\\\]\"], [\"\\\\begin{displaymath}\",\"\\\\end{displaymath}\"] ],
295 skipTags: [\"script\",\"noscript\",\"style\",\"textarea\",\"pre\",\"code\"],
296 ignoreClass: \"tex2jax_ignore\",
297 processEscapes: false,
298 processEnvironments: true,
299 preview: \"TeX\"
301 showProcessingMessages: true,
302 displayAlign: \"%ALIGN\",
303 displayIndent: \"%INDENT\",
305 \"HTML-CSS\": {
306 scale: %SCALE,
307 availableFonts: [\"STIX\",\"TeX\"],
308 preferredFont: \"TeX\",
309 webFont: \"TeX\",
310 imageFont: \"TeX\",
311 showMathMenu: true,
313 MMLorHTML: {
314 prefer: {
315 MSIE: \"MML\",
316 Firefox: \"MML\",
317 Opera: \"HTML\",
318 other: \"HTML\"
322 /*]]>*///-->
323 </script>"
324 "The MathJax setup for XHTML files."
325 :group 'org-export-html
326 :type 'string)
328 (defcustom org-export-html-tag-class-prefix ""
329 "Prefix to class names for TODO keywords.
330 Each tag gets a class given by the tag itself, with this prefix.
331 The default prefix is empty because it is nice to just use the keyword
332 as a class name. But if you get into conflicts with other, existing
333 CSS classes, then this prefix can be very useful."
334 :group 'org-export-html
335 :type 'string)
337 (defcustom org-export-html-todo-kwd-class-prefix ""
338 "Prefix to class names for TODO keywords.
339 Each TODO keyword gets a class given by the keyword itself, with this prefix.
340 The default prefix is empty because it is nice to just use the keyword
341 as a class name. But if you get into conflicts with other, existing
342 CSS classes, then this prefix can be very useful."
343 :group 'org-export-html
344 :type 'string)
346 (defcustom org-export-html-preamble t
347 "Non-nil means insert a preamble in HTML export.
349 When `t', insert a string as defined by one of the formatting
350 strings in `org-export-html-preamble-format'. When set to a
351 string, this string overrides `org-export-html-preamble-format'.
352 When set to a function, apply this function and insert the
353 returned string. The function takes the property list of export
354 options as its only argument.
356 Setting :html-preamble in publishing projects will take
357 precedence over this variable."
358 :group 'org-export-html
359 :type '(choice (const :tag "No preamble" nil)
360 (const :tag "Default preamble" t)
361 (string :tag "Custom formatting string")
362 (function :tag "Function (must return a string)")))
364 (defcustom org-export-html-preamble-format
365 '(("en" "<h1 class=\"title\">%t</h1>"))
366 "The format for the HTML preamble.
368 %t stands for the title.
370 If you need to use a \"%\" character, you need to escape it
371 like that: \"%%\"."
372 :group 'org-export-html
373 :type 'string)
375 (defcustom org-export-html-postamble 'auto
376 "Non-nil means insert a postamble in HTML export.
378 When `t', insert a string as defined by the formatting string in
379 `org-export-html-postamble-format'. When set to a string, this
380 string overrides `org-export-html-postamble-format'. When set to
381 'auto, discard `org-export-html-postamble-format' and honor
382 `org-export-author/email/creator-info' variables. When set to a
383 function, apply this function and insert the returned string.
384 The function takes the property list of export options as its
385 only argument.
387 Setting :html-postamble in publishing projects will take
388 precedence over this variable."
389 :group 'org-export-html
390 :type '(choice (const :tag "No postamble" nil)
391 (const :tag "Auto preamble" 'auto)
392 (const :tag "Default formatting string" t)
393 (string :tag "Custom formatting string")
394 (function :tag "Function (must return a string)")))
396 (defcustom org-export-html-postamble-format
397 '(("en" "<p class=\"author\">Author: %a (%e)</p>
398 <p class=\"date\">Date: %d</p>
399 <p class=\"creator\">Generated by %c</p>
400 <p class=\"xhtml-validation\">%v</p>
402 "The format for the HTML postamble.
404 %a stands for the author.
405 %e stands for the email(s).
406 %d stands for the date.
407 %c will be replaced by information about Org/Emacs.
408 %v will be replaced by `org-export-html-validation-link'.
410 If you need to use a \"%\" character, you need to escape it
411 like that: \"%%\"."
412 :group 'org-export-html
413 :type 'string)
415 (defcustom org-export-html-home/up-format
416 "<div id=\"org-div-home-and-up\" style=\"text-align:right;font-size:70%%;white-space:nowrap;\">
417 <a accesskey=\"h\" href=\"%s\"> UP </a>
419 <a accesskey=\"H\" href=\"%s\"> HOME </a>
420 </div>"
421 "Snippet used to insert the HOME and UP links.
422 This is a format string, the first %s will receive the UP link,
423 the second the HOME link. If both `org-export-html-link-up' and
424 `org-export-html-link-home' are empty, the entire snippet will be
425 ignored."
426 :group 'org-export-html
427 :type 'string)
429 (defcustom org-export-html-toplevel-hlevel 2
430 "The <H> level for level 1 headings in HTML export.
431 This is also important for the classes that will be wrapped around headlines
432 and outline structure. If this variable is 1, the top-level headlines will
433 be <h1>, and the corresponding classes will be outline-1, section-number-1,
434 and outline-text-1. If this is 2, all of these will get a 2 instead.
435 The default for this variable is 2, because we use <h1> for formatting the
436 document title."
437 :group 'org-export-html
438 :type 'string)
440 (defcustom org-export-html-link-org-files-as-html t
441 "Non-nil means make file links to `file.org' point to `file.html'.
442 When org-mode is exporting an org-mode file to HTML, links to
443 non-html files are directly put into a href tag in HTML.
444 However, links to other Org-mode files (recognized by the
445 extension `.org.) should become links to the corresponding html
446 file, assuming that the linked org-mode file will also be
447 converted to HTML.
448 When nil, the links still point to the plain `.org' file."
449 :group 'org-export-html
450 :type 'boolean)
452 (defcustom org-export-html-inline-images 'maybe
453 "Non-nil means inline images into exported HTML pages.
454 This is done using an <img> tag. When nil, an anchor with href is used to
455 link to the image. If this option is `maybe', then images in links with
456 an empty description will be inlined, while images with a description will
457 be linked only."
458 :group 'org-export-html
459 :type '(choice (const :tag "Never" nil)
460 (const :tag "Always" t)
461 (const :tag "When there is no description" maybe)))
463 (defcustom org-export-html-inline-image-extensions
464 '("png" "jpeg" "jpg" "gif" "svg")
465 "Extensions of image files that can be inlined into HTML."
466 :group 'org-export-html
467 :type '(repeat (string :tag "Extension")))
469 (defcustom org-export-html-table-tag
470 "<table border=\"2\" cellspacing=\"0\" cellpadding=\"6\" rules=\"groups\" frame=\"hsides\">"
471 "The HTML tag that is used to start a table.
472 This must be a <table> tag, but you may change the options like
473 borders and spacing."
474 :group 'org-export-html
475 :type 'string)
477 (defcustom org-export-table-header-tags '("<th scope=\"%s\"%s>" . "</th>")
478 "The opening tag for table header fields.
479 This is customizable so that alignment options can be specified.
480 The first %s will be filled with the scope of the field, either row or col.
481 The second %s will be replaced by a style entry to align the field.
482 See also the variable `org-export-html-table-use-header-tags-for-first-column'.
483 See also the variable `org-export-html-table-align-individual-fields'."
484 :group 'org-export-tables
485 :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
487 (defcustom org-export-table-data-tags '("<td%s>" . "</td>")
488 "The opening tag for table data fields.
489 This is customizable so that alignment options can be specified.
490 The first %s will be filled with the scope of the field, either row or col.
491 The second %s will be replaced by a style entry to align the field.
492 See also the variable `org-export-html-table-align-individual-fields'."
493 :group 'org-export-tables
494 :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
496 (defcustom org-export-table-row-tags '("<tr>" . "</tr>")
497 "The opening tag for table data fields.
498 This is customizable so that alignment options can be specified.
499 Instead of strings, these can be Lisp forms that will be evaluated
500 for each row in order to construct the table row tags. During evaluation,
501 the variable `head' will be true when this is a header line, nil when this
502 is a body line. And the variable `nline' will contain the line number,
503 starting from 1 in the first header line. For example
505 (setq org-export-table-row-tags
506 (cons '(if head
507 \"<tr>\"
508 (if (= (mod nline 2) 1)
509 \"<tr class=\\\"tr-odd\\\">\"
510 \"<tr class=\\\"tr-even\\\">\"))
511 \"</tr>\"))
513 will give even lines the class \"tr-even\" and odd lines the class \"tr-odd\"."
514 :group 'org-export-tables
515 :type '(cons
516 (choice :tag "Opening tag"
517 (string :tag "Specify")
518 (sexp))
519 (choice :tag "Closing tag"
520 (string :tag "Specify")
521 (sexp))))
523 (defcustom org-export-html-table-align-individual-fields t
524 "Non-nil means attach style attributes for alignment to each table field.
525 When nil, alignment will only be specified in the column tags, but this
526 is ignored by some browsers (like Firefox, Safari). Opera does it right
527 though."
528 :group 'org-export-tables
529 :type 'boolean)
531 (defcustom org-export-html-table-use-header-tags-for-first-column nil
532 "Non-nil means format column one in tables with header tags.
533 When nil, also column one will use data tags."
534 :group 'org-export-tables
535 :type 'boolean)
537 (defcustom org-export-html-validation-link
538 "<a href=\"http://validator.w3.org/check?uri=referer\">Validate XHTML 1.0</a>"
539 "Link to HTML validation service."
540 :group 'org-export-html
541 :type 'string)
543 (defcustom org-export-html-with-timestamp nil
544 "If non-nil, write timestamp into the exported HTML text.
545 If non-nil, write `org-export-html-html-helper-timestamp' into the
546 exported HTML text. Otherwise, the buffer will just be saved to
547 a file."
548 :group 'org-export-html
549 :type 'boolean)
551 (defcustom org-export-html-html-helper-timestamp
552 "<br/><br/><hr/><p><!-- hhmts start --> <!-- hhmts end --></p>\n"
553 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
554 :group 'org-export-html
555 :type 'string)
557 (defcustom org-export-html-protect-char-alist
558 '(("&" . "&amp;")
559 ("<" . "&lt;")
560 (">" . "&gt;"))
561 "Alist of characters to be converted by `org-html-protect'."
562 :type '(repeat (cons (string :tag "Character")
563 (string :tag "HTML equivalent"))))
565 (defgroup org-export-htmlize nil
566 "Options for processing examples with htmlize.el."
567 :tag "Org Export Htmlize"
568 :group 'org-export-html)
570 (defcustom org-export-htmlize-output-type 'inline-css
571 "Output type to be used by htmlize when formatting code snippets.
572 Choices are `css', to export the CSS selectors only, or `inline-css', to
573 export the CSS attribute values inline in the HTML. We use as default
574 `inline-css', in order to make the resulting HTML self-containing.
576 However, this will fail when using Emacs in batch mode for export, because
577 then no rich font definitions are in place. It will also not be good if
578 people with different Emacs setup contribute HTML files to a website,
579 because the fonts will represent the individual setups. In these cases,
580 it is much better to let Org/Htmlize assign classes only, and to use
581 a style file to define the look of these classes.
582 To get a start for your css file, start Emacs session and make sure that
583 all the faces you are interested in are defined, for example by loading files
584 in all modes you want. Then, use the command
585 \\[org-export-htmlize-generate-css] to extract class definitions."
586 :group 'org-export-htmlize
587 :type '(choice (const css) (const inline-css)))
589 (defcustom org-export-htmlize-css-font-prefix "org-"
590 "The prefix for CSS class names for htmlize font specifications."
591 :group 'org-export-htmlize
592 :type 'string)
594 (defcustom org-export-htmlized-org-css-url nil
595 "URL pointing to a CSS file defining text colors for htmlized Emacs buffers.
596 Normally when creating an htmlized version of an Org buffer, htmlize will
597 create CSS to define the font colors. However, this does not work when
598 converting in batch mode, and it also can look bad if different people
599 with different fontification setup work on the same website.
600 When this variable is non-nil, creating an htmlized version of an Org buffer
601 using `org-export-as-org' will remove the internal CSS section and replace it
602 with a link to this URL."
603 :group 'org-export-htmlize
604 :type '(choice
605 (const :tag "Keep internal css" nil)
606 (string :tag "URL or local href")))
608 ;;; Hooks
610 (defvar org-export-html-after-blockquotes-hook nil
611 "Hook run during HTML export, after blockquote, verse, center are done.")
613 (defvar org-export-html-final-hook nil
614 "Hook run at the end of HTML export, in the new buffer.")
616 ;;; HTML export
618 (defun org-export-html-preprocess (parameters)
619 "Convert LaTeX fragments to images."
620 (when (and org-current-export-file
621 (plist-get parameters :LaTeX-fragments))
622 (org-format-latex
623 (concat "ltxpng/" (file-name-sans-extension
624 (file-name-nondirectory
625 org-current-export-file)))
626 org-current-export-dir nil "Creating LaTeX image %s"
627 nil nil
628 (cond
629 ((eq (plist-get parameters :LaTeX-fragments) 'verbatim) 'verbatim)
630 ((eq (plist-get parameters :LaTeX-fragments) 'mathjax ) 'mathjax)
631 ((eq (plist-get parameters :LaTeX-fragments) t ) 'mathjax)
632 ((eq (plist-get parameters :LaTeX-fragments) 'dvipng ) 'dvipng)
633 (t nil))))
634 (goto-char (point-min))
635 (let (label l1)
636 (while (re-search-forward "\\\\ref{\\([^{}\n]+\\)}" nil t)
637 (org-if-unprotected-at (match-beginning 1)
638 (setq label (match-string 1))
639 (save-match-data
640 (if (string-match "\\`[a-z]\\{1,10\\}:\\(.+\\)" label)
641 (setq l1 (substring label (match-beginning 1)))
642 (setq l1 label)))
643 (replace-match (format "[[#%s][%s]]" label l1) t t)))))
645 ;;;###autoload
646 (defun org-export-as-html-and-open (arg)
647 "Export the outline as HTML and immediately open it with a browser.
648 If there is an active region, export only the region.
649 The prefix ARG specifies how many levels of the outline should become
650 headlines. The default is 3. Lower levels will become bulleted lists."
651 (interactive "P")
652 (org-export-as-html arg 'hidden)
653 (org-open-file buffer-file-name)
654 (when org-export-kill-product-buffer-when-displayed
655 (kill-buffer (current-buffer))))
657 ;;;###autoload
658 (defun org-export-as-html-batch ()
659 "Call the function `org-export-as-html'.
660 This function can be used in batch processing as:
661 emacs --batch
662 --load=$HOME/lib/emacs/org.el
663 --eval \"(setq org-export-headline-levels 2)\"
664 --visit=MyFile --funcall org-export-as-html-batch"
665 (org-export-as-html org-export-headline-levels 'hidden))
667 ;;;###autoload
668 (defun org-export-as-html-to-buffer (arg)
669 "Call `org-export-as-html` with output to a temporary buffer.
670 No file is created. The prefix ARG is passed through to `org-export-as-html'."
671 (interactive "P")
672 (org-export-as-html arg nil nil "*Org HTML Export*")
673 (when org-export-show-temporary-export-buffer
674 (switch-to-buffer-other-window "*Org HTML Export*")))
676 ;;;###autoload
677 (defun org-replace-region-by-html (beg end)
678 "Assume the current region has org-mode syntax, and convert it to HTML.
679 This can be used in any buffer. For example, you could write an
680 itemized list in org-mode syntax in an HTML buffer and then use this
681 command to convert it."
682 (interactive "r")
683 (let (reg html buf pop-up-frames)
684 (save-window-excursion
685 (if (org-mode-p)
686 (setq html (org-export-region-as-html
687 beg end t 'string))
688 (setq reg (buffer-substring beg end)
689 buf (get-buffer-create "*Org tmp*"))
690 (with-current-buffer buf
691 (erase-buffer)
692 (insert reg)
693 (org-mode)
694 (setq html (org-export-region-as-html
695 (point-min) (point-max) t 'string)))
696 (kill-buffer buf)))
697 (delete-region beg end)
698 (insert html)))
700 ;;;###autoload
701 (defun org-export-region-as-html (beg end &optional body-only buffer)
702 "Convert region from BEG to END in org-mode buffer to HTML.
703 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
704 contents, and only produce the region of converted text, useful for
705 cut-and-paste operations.
706 If BUFFER is a buffer or a string, use/create that buffer as a target
707 of the converted HTML. If BUFFER is the symbol `string', return the
708 produced HTML as a string and leave not buffer behind. For example,
709 a Lisp program could call this function in the following way:
711 (setq html (org-export-region-as-html beg end t 'string))
713 When called interactively, the output buffer is selected, and shown
714 in a window. A non-interactive call will only return the buffer."
715 (interactive "r\nP")
716 (when (interactive-p)
717 (setq buffer "*Org HTML Export*"))
718 (let ((transient-mark-mode t) (zmacs-regions t)
719 ext-plist rtn)
720 (setq ext-plist (plist-put ext-plist :ignore-subtree-p t))
721 (goto-char end)
722 (set-mark (point)) ;; to activate the region
723 (goto-char beg)
724 (setq rtn (org-export-as-html
725 nil nil ext-plist
726 buffer body-only))
727 (if (fboundp 'deactivate-mark) (deactivate-mark))
728 (if (and (interactive-p) (bufferp rtn))
729 (switch-to-buffer-other-window rtn)
730 rtn)))
732 (defvar html-table-tag nil) ; dynamically scoped into this.
733 (defvar org-par-open nil)
735 ;;; org-html-cvt-link-fn
736 (defconst org-html-cvt-link-fn
738 "Function to convert link URLs to exportable URLs.
739 Takes two arguments, TYPE and PATH.
740 Returns exportable url as (TYPE PATH), or nil to signal that it
741 didn't handle this case.
742 Intended to be locally bound around a call to `org-export-as-html'." )
744 (defun org-html-cvt-org-as-html (opt-plist type path)
745 "Convert an org filename to an equivalent html filename.
746 If TYPE is not file, just return `nil'.
747 See variable `org-export-html-link-org-files-as-html'"
749 (save-match-data
750 (and
751 org-export-html-link-org-files-as-html
752 (string= type "file")
753 (string-match "\\.org$" path)
754 (progn
755 (list
756 "file"
757 (concat
758 (substring path 0 (match-beginning 0))
760 (plist-get opt-plist :html-extension)))))))
763 ;;; org-html-should-inline-p
764 (defun org-html-should-inline-p (filename descp)
765 "Return non-nil if link FILENAME should be inlined.
766 The decision to inline the FILENAME link is based on the current
767 settings. DESCP is the boolean of whether there was a link
768 description. See variables `org-export-html-inline-images' and
769 `org-export-html-inline-image-extensions'."
770 (declare (special
771 org-export-html-inline-images
772 org-export-html-inline-image-extensions))
773 (and (or (eq t org-export-html-inline-images)
774 (and org-export-html-inline-images (not descp)))
775 (org-file-image-p
776 filename org-export-html-inline-image-extensions)))
778 ;;; org-html-make-link
779 (defun org-html-make-link (opt-plist type path fragment desc attr
780 may-inline-p)
781 "Make an HTML link.
782 OPT-PLIST is an options list.
783 TYPE is the device-type of the link (THIS://foo.html)
784 PATH is the path of the link (http://THIS#locationx)
785 FRAGMENT is the fragment part of the link, if any (foo.html#THIS)
786 DESC is the link description, if any.
787 ATTR is a string of other attributes of the a element.
788 MAY-INLINE-P allows inlining it as an image."
790 (declare (special org-par-open))
791 (save-match-data
792 (let* ((filename path)
793 ;;First pass. Just sanity stuff.
794 (components-1
795 (cond
796 ((string= type "file")
797 (list
798 type
799 ;;Substitute just if original path was absolute.
800 ;;(Otherwise path must remain relative)
801 (if (file-name-absolute-p path)
802 (concat "file://" (expand-file-name path))
803 path)))
804 ((string= type "")
805 (list nil path))
806 (t (list type path))))
808 ;;Second pass. Components converted so they can refer
809 ;;to a remote site.
810 (components-2
812 (and org-html-cvt-link-fn
813 (apply org-html-cvt-link-fn
814 opt-plist components-1))
815 (apply #'org-html-cvt-org-as-html
816 opt-plist components-1)
817 components-1))
818 (type (first components-2))
819 (thefile (second components-2)))
822 ;;Third pass. Build final link except for leading type
823 ;;spec.
824 (cond
825 ((or
826 (not type)
827 (string= type "http")
828 (string= type "https")
829 (string= type "file"))
830 (if fragment
831 (setq thefile (concat thefile "#" fragment))))
833 (t))
835 ;;Final URL-build, for all types.
836 (setq thefile
837 (let
838 ((str (org-export-html-format-href thefile)))
839 (if (and type (not (string= "file" type)))
840 (concat type ":" str)
841 str)))
843 (if (and
844 may-inline-p
845 ;;Can't inline a URL with a fragment.
846 (not fragment))
847 (progn
848 (message "image %s %s" thefile org-par-open)
849 (org-export-html-format-image thefile org-par-open))
850 (concat
851 "<a href=\"" thefile "\"" (if attr (concat " " attr)) ">"
852 (org-export-html-format-desc desc)
853 "</a>")))))
855 (defun org-html-handle-links (line opt-plist)
856 "Return LINE with markup of Org mode links.
857 OPT-PLIST is the export options list."
858 (let ((start 0)
859 (current-dir (if buffer-file-name
860 (file-name-directory buffer-file-name)
861 default-directory))
862 (link-validate (plist-get opt-plist :link-validation-function))
863 type id-file fnc
864 rpl path attr desc descp desc1 desc2 link)
865 (while (string-match org-bracket-link-analytic-regexp++ line start)
866 (setq start (match-beginning 0))
867 (setq path (save-match-data (org-link-unescape
868 (match-string 3 line))))
869 (setq type (cond
870 ((match-end 2) (match-string 2 line))
871 ((save-match-data
872 (or (file-name-absolute-p path)
873 (string-match "^\\.\\.?/" path)))
874 "file")
875 (t "internal")))
876 (setq path (org-extract-attributes (org-link-unescape path)))
877 (setq attr (get-text-property 0 'org-attributes path))
878 (setq desc1 (if (match-end 5) (match-string 5 line))
879 desc2 (if (match-end 2) (concat type ":" path) path)
880 descp (and desc1 (not (equal desc1 desc2)))
881 desc (or desc1 desc2))
882 ;; Make an image out of the description if that is so wanted
883 (when (and descp (org-file-image-p
884 desc org-export-html-inline-image-extensions))
885 (save-match-data
886 (if (string-match "^file:" desc)
887 (setq desc (substring desc (match-end 0)))))
888 (setq desc (org-add-props
889 (concat "<img src=\"" desc "\"/>")
890 '(org-protected t))))
891 (cond
892 ((equal type "internal")
893 (let
894 ((frag-0
895 (if (= (string-to-char path) ?#)
896 (substring path 1)
897 path)))
898 (setq rpl
899 (org-html-make-link
900 opt-plist
903 (org-solidify-link-text
904 (save-match-data (org-link-unescape frag-0))
905 nil)
906 desc attr nil))))
907 ((and (equal type "id")
908 (setq id-file (org-id-find-id-file path)))
909 ;; This is an id: link to another file (if it was the same file,
910 ;; it would have become an internal link...)
911 (save-match-data
912 (setq id-file (file-relative-name
913 id-file
914 (file-name-directory org-current-export-file)))
915 (setq rpl
916 (org-html-make-link opt-plist
917 "file" id-file
918 (concat (if (org-uuidgen-p path) "ID-") path)
919 desc
920 attr
921 nil))))
922 ((member type '("http" "https"))
923 ;; standard URL, can inline as image
924 (setq rpl
925 (org-html-make-link opt-plist
926 type path nil
927 desc
928 attr
929 (org-html-should-inline-p path descp))))
930 ((member type '("ftp" "mailto" "news"))
931 ;; standard URL, can't inline as image
932 (setq rpl
933 (org-html-make-link opt-plist
934 type path nil
935 desc
936 attr
937 nil)))
939 ((string= type "coderef")
940 (let*
941 ((coderef-str (format "coderef-%s" path))
942 (attr-1
943 (format "class=\"coderef\" onmouseover=\"CodeHighlightOn(this, '%s');\" onmouseout=\"CodeHighlightOff(this, '%s');\""
944 coderef-str coderef-str)))
945 (setq rpl
946 (org-html-make-link opt-plist
947 type "" coderef-str
948 (format
949 (org-export-get-coderef-format
950 path
951 (and descp desc))
952 (cdr (assoc path org-export-code-refs)))
953 attr-1
954 nil))))
956 ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
957 ;; The link protocol has a function for format the link
958 (setq rpl
959 (save-match-data
960 (funcall fnc (org-link-unescape path) desc1 'html))))
962 ((string= type "file")
963 ;; FILE link
964 (save-match-data
965 (let*
966 ((components
968 (string-match "::\\(.*\\)" path)
969 (list
970 (replace-match "" t nil path)
971 (match-string 1 path))
972 (list path nil)))
974 ;;The proper path, without a fragment
975 (path-1
976 (first components))
978 ;;The raw fragment
979 (fragment-0
980 (second components))
982 ;;Check the fragment. If it can't be used as
983 ;;target fragment we'll pass nil instead.
984 (fragment-1
986 (and fragment-0
987 (not (string-match "^[0-9]*$" fragment-0))
988 (not (string-match "^\\*" fragment-0))
989 (not (string-match "^/.*/$" fragment-0)))
990 (org-solidify-link-text
991 (org-link-unescape fragment-0))
992 nil))
993 (desc-2
994 ;;Description minus "file:" and ".org"
995 (if (string-match "^file:" desc)
996 (let
997 ((desc-1 (replace-match "" t t desc)))
998 (if (string-match "\\.org$" desc-1)
999 (replace-match "" t t desc-1)
1000 desc-1))
1001 desc)))
1003 (setq rpl
1005 (and
1006 (functionp link-validate)
1007 (not (funcall link-validate path-1 current-dir)))
1008 desc
1009 (org-html-make-link opt-plist
1010 "file" path-1 fragment-1 desc-2 attr
1011 (org-html-should-inline-p path-1 descp)))))))
1014 ;; just publish the path, as default
1015 (setq rpl (concat "@<i>&lt;" type ":"
1016 (save-match-data (org-link-unescape path))
1017 "&gt;@</i>"))))
1018 (setq line (replace-match rpl t t line)
1019 start (+ start (length rpl))))
1020 line))
1022 ;;; org-export-as-html
1023 ;;;###autoload
1024 (defun org-export-as-html (arg &optional hidden ext-plist
1025 to-buffer body-only pub-dir)
1026 "Export the outline as a pretty HTML file.
1027 If there is an active region, export only the region. The prefix
1028 ARG specifies how many levels of the outline should become
1029 headlines. The default is 3. Lower levels will become bulleted
1030 lists. HIDDEN is obsolete and does nothing.
1031 EXT-PLIST is a property list with external parameters overriding
1032 org-mode's default settings, but still inferior to file-local
1033 settings. When TO-BUFFER is non-nil, create a buffer with that
1034 name and export to that buffer. If TO-BUFFER is the symbol
1035 `string', don't leave any buffer behind but just return the
1036 resulting HTML as a string. When BODY-ONLY is set, don't produce
1037 the file header and footer, simply return the content of
1038 <body>...</body>, without even the body tags themselves. When
1039 PUB-DIR is set, use this as the publishing directory."
1040 (interactive "P")
1041 (run-hooks 'org-export-first-hook)
1043 ;; Make sure we have a file name when we need it.
1044 (when (and (not (or to-buffer body-only))
1045 (not buffer-file-name))
1046 (if (buffer-base-buffer)
1047 (org-set-local 'buffer-file-name
1048 (with-current-buffer (buffer-base-buffer)
1049 buffer-file-name))
1050 (error "Need a file name to be able to export")))
1052 (message "Exporting...")
1053 (setq-default org-todo-line-regexp org-todo-line-regexp)
1054 (setq-default org-deadline-line-regexp org-deadline-line-regexp)
1055 (setq-default org-done-keywords org-done-keywords)
1056 (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp)
1057 (let* ((opt-plist
1058 (org-export-process-option-filters
1059 (org-combine-plists (org-default-export-plist)
1060 ext-plist
1061 (org-infile-export-plist))))
1062 (body-only (or body-only (plist-get opt-plist :body-only)))
1063 (style (concat (if (plist-get opt-plist :style-include-default)
1064 org-export-html-style-default)
1065 (plist-get opt-plist :style)
1066 (plist-get opt-plist :style-extra)
1067 "\n"
1068 (if (plist-get opt-plist :style-include-scripts)
1069 org-export-html-scripts)))
1070 (html-extension (plist-get opt-plist :html-extension))
1071 valid thetoc have-headings first-heading-pos
1072 (odd org-odd-levels-only)
1073 (region-p (org-region-active-p))
1074 (rbeg (and region-p (region-beginning)))
1075 (rend (and region-p (region-end)))
1076 (subtree-p
1077 (if (plist-get opt-plist :ignore-subtree-p)
1079 (when region-p
1080 (save-excursion
1081 (goto-char rbeg)
1082 (and (org-at-heading-p)
1083 (>= (org-end-of-subtree t t) rend))))))
1084 (level-offset (if subtree-p
1085 (save-excursion
1086 (goto-char rbeg)
1087 (+ (funcall outline-level)
1088 (if org-odd-levels-only 1 0)))
1090 (opt-plist (setq org-export-opt-plist
1091 (if subtree-p
1092 (org-export-add-subtree-options opt-plist rbeg)
1093 opt-plist)))
1094 ;; The following two are dynamically scoped into other
1095 ;; routines below.
1096 (org-current-export-dir
1097 (or pub-dir (org-export-directory :html opt-plist)))
1098 (org-current-export-file buffer-file-name)
1099 (level 0) (line "") (origline "") txt todo
1100 (umax nil)
1101 (umax-toc nil)
1102 (filename (if to-buffer nil
1103 (expand-file-name
1104 (concat
1105 (file-name-sans-extension
1106 (or (and subtree-p
1107 (org-entry-get (region-beginning)
1108 "EXPORT_FILE_NAME" t))
1109 (file-name-nondirectory buffer-file-name)))
1110 "." html-extension)
1111 (file-name-as-directory
1112 (or pub-dir (org-export-directory :html opt-plist))))))
1113 (current-dir (if buffer-file-name
1114 (file-name-directory buffer-file-name)
1115 default-directory))
1116 (buffer (if to-buffer
1117 (cond
1118 ((eq to-buffer 'string) (get-buffer-create "*Org HTML Export*"))
1119 (t (get-buffer-create to-buffer)))
1120 (find-file-noselect filename)))
1121 (org-levels-open (make-vector org-level-max nil))
1122 (date (plist-get opt-plist :date))
1123 (author (plist-get opt-plist :author))
1124 (html-validation-link (or org-export-html-validation-link ""))
1125 (title (org-html-expand
1126 (or (and subtree-p (org-export-get-title-from-subtree))
1127 (plist-get opt-plist :title)
1128 (and (not body-only)
1129 (not
1130 (plist-get opt-plist :skip-before-1st-heading))
1131 (org-export-grab-title-from-buffer))
1132 (and buffer-file-name
1133 (file-name-sans-extension
1134 (file-name-nondirectory buffer-file-name)))
1135 "UNTITLED")))
1136 (link-up (and (plist-get opt-plist :link-up)
1137 (string-match "\\S-" (plist-get opt-plist :link-up))
1138 (plist-get opt-plist :link-up)))
1139 (link-home (and (plist-get opt-plist :link-home)
1140 (string-match "\\S-" (plist-get opt-plist :link-home))
1141 (plist-get opt-plist :link-home)))
1142 (dummy (setq opt-plist (plist-put opt-plist :title title)))
1143 (html-table-tag (plist-get opt-plist :html-table-tag))
1144 (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
1145 (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string "\\>\\)"))
1146 (inquote nil)
1147 (infixed nil)
1148 (inverse nil)
1149 (email (plist-get opt-plist :email))
1150 (language (plist-get opt-plist :language))
1151 (keywords (plist-get opt-plist :keywords))
1152 (description (plist-get opt-plist :description))
1153 (num (plist-get opt-plist :section-numbers))
1154 (lang-words nil)
1155 (head-count 0) cnt
1156 (start 0)
1157 (coding-system (and (boundp 'buffer-file-coding-system)
1158 buffer-file-coding-system))
1159 (coding-system-for-write (or org-export-html-coding-system
1160 coding-system))
1161 (save-buffer-coding-system (or org-export-html-coding-system
1162 coding-system))
1163 (charset (and coding-system-for-write
1164 (fboundp 'coding-system-get)
1165 (coding-system-get coding-system-for-write
1166 'mime-charset)))
1167 (region
1168 (buffer-substring
1169 (if region-p (region-beginning) (point-min))
1170 (if region-p (region-end) (point-max))))
1171 (org-export-have-math nil)
1172 (lines
1173 (org-split-string
1174 (org-export-preprocess-string
1175 region
1176 :emph-multiline t
1177 :for-backend 'html
1178 :skip-before-1st-heading
1179 (plist-get opt-plist :skip-before-1st-heading)
1180 :drawers (plist-get opt-plist :drawers)
1181 :todo-keywords (plist-get opt-plist :todo-keywords)
1182 :tasks (plist-get opt-plist :tasks)
1183 :tags (plist-get opt-plist :tags)
1184 :priority (plist-get opt-plist :priority)
1185 :footnotes (plist-get opt-plist :footnotes)
1186 :timestamps (plist-get opt-plist :timestamps)
1187 :archived-trees
1188 (plist-get opt-plist :archived-trees)
1189 :select-tags (plist-get opt-plist :select-tags)
1190 :exclude-tags (plist-get opt-plist :exclude-tags)
1191 :add-text
1192 (plist-get opt-plist :text)
1193 :LaTeX-fragments
1194 (plist-get opt-plist :LaTeX-fragments))
1195 "[\r\n]"))
1196 (mathjax
1197 (if (or (eq (plist-get opt-plist :LaTeX-fragments) 'mathjax)
1198 (and org-export-have-math
1199 (eq (plist-get opt-plist :LaTeX-fragments) t)))
1201 (org-export-html-mathjax-config
1202 org-export-html-mathjax-template
1203 org-export-html-mathjax-options
1204 (or (plist-get opt-plist :mathjax) ""))
1205 ""))
1206 table-open
1207 table-buffer table-orig-buffer
1209 rpl path attr desc descp desc1 desc2 link
1210 snumber fnc
1211 footnotes footref-seen
1212 href
1215 (let ((inhibit-read-only t))
1216 (org-unmodified
1217 (remove-text-properties (point-min) (point-max)
1218 '(:org-license-to-kill t))))
1220 (message "Exporting...")
1222 (setq org-min-level (org-get-min-level lines level-offset))
1223 (setq org-last-level org-min-level)
1224 (org-init-section-numbers)
1226 (cond
1227 ((and date (string-match "%" date))
1228 (setq date (format-time-string date)))
1229 (date)
1230 (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
1232 ;; Get the language-dependent settings
1233 (setq lang-words (or (assoc language org-export-language-setup)
1234 (assoc "en" org-export-language-setup)))
1236 ;; Switch to the output buffer
1237 (set-buffer buffer)
1238 (let ((inhibit-read-only t)) (erase-buffer))
1239 (fundamental-mode)
1240 (org-install-letbind)
1242 (and (fboundp 'set-buffer-file-coding-system)
1243 (set-buffer-file-coding-system coding-system-for-write))
1245 (let ((case-fold-search nil)
1246 (org-odd-levels-only odd))
1247 ;; create local variables for all options, to make sure all called
1248 ;; functions get the correct information
1249 (mapc (lambda (x)
1250 (set (make-local-variable (nth 2 x))
1251 (plist-get opt-plist (car x))))
1252 org-export-plist-vars)
1253 (setq umax (if arg (prefix-numeric-value arg)
1254 org-export-headline-levels))
1255 (setq umax-toc (if (integerp org-export-with-toc)
1256 (min org-export-with-toc umax)
1257 umax))
1258 (unless body-only
1259 ;; File header
1260 (insert (format
1262 <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
1263 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
1264 <html xmlns=\"http://www.w3.org/1999/xhtml\"
1265 lang=\"%s\" xml:lang=\"%s\">
1266 <head>
1267 <title>%s</title>
1268 <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
1269 <meta name=\"generator\" content=\"Org-mode\"/>
1270 <meta name=\"generated\" content=\"%s\"/>
1271 <meta name=\"author\" content=\"%s\"/>
1272 <meta name=\"description\" content=\"%s\"/>
1273 <meta name=\"keywords\" content=\"%s\"/>
1276 </head>
1277 <body>
1278 <div id=\"content\">
1281 (format
1282 (or (and (stringp org-export-html-xml-declaration)
1283 org-export-html-xml-declaration)
1284 (cdr (assoc html-extension org-export-html-xml-declaration))
1285 (cdr (assoc "html" org-export-html-xml-declaration))
1288 (or charset "iso-8859-1"))
1289 language language
1290 title
1291 (or charset "iso-8859-1")
1292 date author description keywords
1293 style
1294 mathjax
1295 (if (or link-up link-home)
1296 (concat
1297 (format org-export-html-home/up-format
1298 (or link-up link-home)
1299 (or link-home link-up))
1300 "\n")
1301 "")))
1303 ;; insert html preamble
1304 (when (plist-get opt-plist :html-preamble)
1305 (let ((html-pre (plist-get opt-plist :html-preamble)))
1306 (cond ((stringp html-pre)
1307 (insert
1308 (format-spec html-pre `((?t . ,title) (?a . ,author)
1309 (?d . ,date) (?e . ,email)))))
1310 ((functionp html-pre)
1311 (funcall html-pre opt-plist))
1313 (insert
1314 (format-spec
1315 (or (cadr (assoc (nth 0 lang-words)
1316 org-export-html-preamble-format))
1317 (cadr (assoc "en" org-export-html-preamble-format)))
1318 `((?t . ,title) (?a . ,author)
1319 (?d . ,date) (?e . ,email)))))))))
1321 (if (and org-export-with-toc (not body-only))
1322 (progn
1323 (push (format "<h%d>%s</h%d>\n"
1324 org-export-html-toplevel-hlevel
1325 (nth 3 lang-words)
1326 org-export-html-toplevel-hlevel)
1327 thetoc)
1328 (push "<div id=\"text-table-of-contents\">\n" thetoc)
1329 (push "<ul>\n<li>" thetoc)
1330 (setq lines
1331 (mapcar '(lambda (line)
1332 (if (and (string-match org-todo-line-regexp line)
1333 (not (get-text-property 0 'org-protected line)))
1334 ;; This is a headline
1335 (progn
1336 (setq have-headings t)
1337 (setq level (- (match-end 1) (match-beginning 1)
1338 level-offset)
1339 level (org-tr-level level)
1340 txt (save-match-data
1341 (org-html-expand
1342 (org-export-cleanup-toc-line
1343 (match-string 3 line))))
1344 todo
1345 (or (and org-export-mark-todo-in-toc
1346 (match-beginning 2)
1347 (not (member (match-string 2 line)
1348 org-done-keywords)))
1349 ; TODO, not DONE
1350 (and org-export-mark-todo-in-toc
1351 (= level umax-toc)
1352 (org-search-todo-below
1353 line lines level))))
1354 (if (string-match
1355 (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt)
1356 (setq txt (replace-match "&nbsp;&nbsp;&nbsp;<span class=\"tag\"> \\1</span>" t nil txt)))
1357 (if (string-match quote-re0 txt)
1358 (setq txt (replace-match "" t t txt)))
1359 (setq snumber (org-section-number level))
1360 (if (and num (if (integerp num)
1361 (>= num level)
1362 num))
1363 (setq txt (concat snumber " " txt)))
1364 (if (<= level (max umax umax-toc))
1365 (setq head-count (+ head-count 1)))
1366 (if (<= level umax-toc)
1367 (progn
1368 (if (> level org-last-level)
1369 (progn
1370 (setq cnt (- level org-last-level))
1371 (while (>= (setq cnt (1- cnt)) 0)
1372 (push "\n<ul>\n<li>" thetoc))
1373 (push "\n" thetoc)))
1374 (if (< level org-last-level)
1375 (progn
1376 (setq cnt (- org-last-level level))
1377 (while (>= (setq cnt (1- cnt)) 0)
1378 (push "</li>\n</ul>" thetoc))
1379 (push "\n" thetoc)))
1380 ;; Check for targets
1381 (while (string-match org-any-target-regexp line)
1382 (setq line (replace-match
1383 (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
1384 t t line)))
1385 (while (string-match "&lt;\\(&lt;\\)+\\|&gt;\\(&gt;\\)+" txt)
1386 (setq txt (replace-match "" t t txt)))
1387 (setq href
1388 (replace-regexp-in-string
1389 "\\." "_" (format "sec-%s" snumber)))
1390 (setq href (org-solidify-link-text (or (cdr (assoc href org-export-preferred-target-alist)) href)))
1391 (push
1392 (format
1393 (if todo
1394 "</li>\n<li><a href=\"#%s\"><span class=\"todo\">%s</span></a>"
1395 "</li>\n<li><a href=\"#%s\">%s</a>")
1396 href txt) thetoc)
1398 (setq org-last-level level))
1400 line)
1401 lines))
1402 (while (> org-last-level (1- org-min-level))
1403 (setq org-last-level (1- org-last-level))
1404 (push "</li>\n</ul>\n" thetoc))
1405 (push "</div>\n" thetoc)
1406 (setq thetoc (if have-headings (nreverse thetoc) nil))))
1408 (setq head-count 0)
1409 (org-init-section-numbers)
1411 (org-open-par)
1413 (while (setq line (pop lines) origline line)
1414 (catch 'nextline
1416 ;; end of quote section?
1417 (when (and inquote (string-match "^\\*+ " line))
1418 (insert "</pre>\n")
1419 (org-open-par)
1420 (setq inquote nil))
1421 ;; inside a quote section?
1422 (when inquote
1423 (insert (org-html-protect line) "\n")
1424 (throw 'nextline nil))
1426 ;; Fixed-width, verbatim lines (examples)
1427 (when (and org-export-with-fixed-width
1428 (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line))
1429 (when (not infixed)
1430 (setq infixed t)
1431 (org-close-par-maybe)
1433 (insert "<pre class=\"example\">\n"))
1434 (insert (org-html-protect (match-string 3 line)) "\n")
1435 (when (or (not lines)
1436 (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
1437 (car lines))))
1438 (setq infixed nil)
1439 (insert "</pre>\n")
1440 (org-open-par))
1441 (throw 'nextline nil))
1443 ;; Protected HTML
1444 (when (and (get-text-property 0 'org-protected line)
1445 ;; Make sure it is the entire line that is protected
1446 (not (< (or (next-single-property-change
1447 0 'org-protected line) 10000)
1448 (length line))))
1449 (let (par (ind (get-text-property 0 'original-indentation line)))
1450 (when (re-search-backward
1451 "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t)
1452 (setq par (match-string 1))
1453 (replace-match "\\2\n"))
1454 (insert line "\n")
1455 (while (and lines
1456 (or (= (length (car lines)) 0)
1457 (not ind)
1458 (equal ind (get-text-property 0 'original-indentation (car lines))))
1459 (or (= (length (car lines)) 0)
1460 (get-text-property 0 'org-protected (car lines))))
1461 (insert (pop lines) "\n"))
1462 (and par (insert "<p>\n")))
1463 (throw 'nextline nil))
1465 ;; Blockquotes, verse, and center
1466 (when (equal "ORG-BLOCKQUOTE-START" line)
1467 (org-close-par-maybe)
1468 (insert "<blockquote>\n")
1469 (org-open-par)
1470 (throw 'nextline nil))
1471 (when (equal "ORG-BLOCKQUOTE-END" line)
1472 (org-close-par-maybe)
1473 (insert "\n</blockquote>\n")
1474 (org-open-par)
1475 (throw 'nextline nil))
1476 (when (equal "ORG-VERSE-START" line)
1477 (org-close-par-maybe)
1478 (insert "\n<p class=\"verse\">\n")
1479 (setq org-par-open t)
1480 (setq inverse t)
1481 (throw 'nextline nil))
1482 (when (equal "ORG-VERSE-END" line)
1483 (insert "</p>\n")
1484 (setq org-par-open nil)
1485 (org-open-par)
1486 (setq inverse nil)
1487 (throw 'nextline nil))
1488 (when (equal "ORG-CENTER-START" line)
1489 (org-close-par-maybe)
1490 (insert "\n<div style=\"text-align: center\">")
1491 (org-open-par)
1492 (throw 'nextline nil))
1493 (when (equal "ORG-CENTER-END" line)
1494 (org-close-par-maybe)
1495 (insert "\n</div>")
1496 (org-open-par)
1497 (throw 'nextline nil))
1498 (run-hooks 'org-export-html-after-blockquotes-hook)
1499 (when inverse
1500 (let ((i (org-get-string-indentation line)))
1501 (if (> i 0)
1502 (setq line (concat (mapconcat 'identity
1503 (make-list (* 2 i) "\\nbsp") "")
1504 " " (org-trim line))))
1505 (unless (string-match "\\\\\\\\[ \t]*$" line)
1506 (setq line (concat line "\\\\")))))
1508 ;; make targets to anchors
1509 (setq start 0)
1510 (while (string-match
1511 "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start)
1512 (cond
1513 ((get-text-property (match-beginning 1) 'org-protected line)
1514 (setq start (match-end 1)))
1515 ((match-end 2)
1516 (setq line (replace-match
1517 (format
1518 "@<a name=\"%s\" id=\"%s\">@</a>"
1519 (org-solidify-link-text (match-string 1 line))
1520 (org-solidify-link-text (match-string 1 line)))
1521 t t line)))
1522 ((and org-export-with-toc (equal (string-to-char line) ?*))
1523 ;; FIXME: NOT DEPENDENT on TOC?????????????????????
1524 (setq line (replace-match
1525 (concat "@<span class=\"target\">"
1526 (match-string 1 line) "@</span> ")
1527 ;; (concat "@<i>" (match-string 1 line) "@</i> ")
1528 t t line)))
1530 (setq line (replace-match
1531 (concat "@<a name=\""
1532 (org-solidify-link-text (match-string 1 line))
1533 "\" class=\"target\">" (match-string 1 line)
1534 "@</a> ")
1535 t t line)))))
1537 (setq line (org-html-handle-time-stamps line))
1539 ;; replace "&" by "&amp;", "<" and ">" by "&lt;" and "&gt;"
1540 ;; handle @<..> HTML tags (replace "@&gt;..&lt;" by "<..>")
1541 ;; Also handle sub_superscripts and checkboxes
1542 (or (string-match org-table-hline-regexp line)
1543 (setq line (org-html-expand line)))
1545 ;; Format the links
1546 (setq line (org-html-handle-links line opt-plist))
1548 ;; TODO items
1549 (if (and (string-match org-todo-line-regexp line)
1550 (match-beginning 2))
1552 (setq line
1553 (concat (substring line 0 (match-beginning 2))
1554 "<span class=\""
1555 (if (member (match-string 2 line)
1556 org-done-keywords)
1557 "done" "todo")
1558 " " (match-string 2 line)
1559 "\"> " (org-export-html-get-todo-kwd-class-name
1560 (match-string 2 line))
1561 "</span>" (substring line (match-end 2)))))
1563 ;; Does this contain a reference to a footnote?
1564 (when org-export-with-footnotes
1565 (setq start 0)
1566 (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start)
1567 (if (get-text-property (match-beginning 2) 'org-protected line)
1568 (setq start (match-end 2))
1569 (let ((n (match-string 2 line)) extra a)
1570 (if (setq a (assoc n footref-seen))
1571 (progn
1572 (setcdr a (1+ (cdr a)))
1573 (setq extra (format ".%d" (cdr a))))
1574 (setq extra "")
1575 (push (cons n 1) footref-seen))
1576 (setq line
1577 (replace-match
1578 (format
1579 (concat "%s"
1580 (format org-export-html-footnote-format
1581 "<a class=\"footref\" name=\"fnr.%s%s\" href=\"#fn.%s\">%s</a>"))
1582 (or (match-string 1 line) "") n extra n n)
1583 t t line))))))
1585 (cond
1586 ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
1587 ;; This is a headline
1588 (setq level (org-tr-level (- (match-end 1) (match-beginning 1)
1589 level-offset))
1590 txt (match-string 2 line))
1591 (if (string-match quote-re0 txt)
1592 (setq txt (replace-match "" t t txt)))
1593 (if (<= level (max umax umax-toc))
1594 (setq head-count (+ head-count 1)))
1595 (setq first-heading-pos (or first-heading-pos (point)))
1596 (org-html-level-start level txt umax
1597 (and org-export-with-toc (<= level umax))
1598 head-count opt-plist)
1600 ;; QUOTES
1601 (when (string-match quote-re line)
1602 (org-close-par-maybe)
1603 (insert "<pre>")
1604 (setq inquote t)))
1606 ((and org-export-with-tables
1607 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
1608 (when (not table-open)
1609 ;; New table starts
1610 (setq table-open t table-buffer nil table-orig-buffer nil))
1612 ;; Accumulate lines
1613 (setq table-buffer (cons line table-buffer)
1614 table-orig-buffer (cons origline table-orig-buffer))
1615 (when (or (not lines)
1616 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
1617 (car lines))))
1618 (setq table-open nil
1619 table-buffer (nreverse table-buffer)
1620 table-orig-buffer (nreverse table-orig-buffer))
1621 (org-close-par-maybe)
1622 (insert (org-format-table-html table-buffer table-orig-buffer))))
1624 ;; Normal lines
1627 ;; This line either is list item or end a list.
1628 (when (get-text-property 0 'list-item line)
1629 (setq line (org-html-export-list-line
1630 line
1631 (get-text-property 0 'list-item line)
1632 (get-text-property 0 'list-struct line)
1633 (get-text-property 0 'list-prevs line))))
1635 ;; Horizontal line
1636 (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line)
1637 (if org-par-open
1638 (insert "\n</p>\n<hr/>\n<p>\n")
1639 (insert "\n<hr/>\n"))
1640 (throw 'nextline nil))
1642 ;; Empty lines start a new paragraph. If hand-formatted lists
1643 ;; are not fully interpreted, lines starting with "-", "+", "*"
1644 ;; also start a new paragraph.
1645 (if (string-match "^ [-+*]-\\|^[ \t]*$" line) (org-open-par))
1647 ;; Is this the start of a footnote?
1648 (when org-export-with-footnotes
1649 (when (and (boundp 'footnote-section-tag-regexp)
1650 (string-match (concat "^" footnote-section-tag-regexp)
1651 line))
1652 ;; ignore this line
1653 (throw 'nextline nil))
1654 (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line)
1655 (org-close-par-maybe)
1656 (let ((n (match-string 1 line)))
1657 (setq org-par-open t
1658 line (replace-match
1659 (format
1660 (concat "<p class=\"footnote\">"
1661 (format org-export-html-footnote-format
1662 "<a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a>"))
1663 n n n) t t line)))))
1664 ;; Check if the line break needs to be conserved
1665 (cond
1666 ((string-match "\\\\\\\\[ \t]*$" line)
1667 (setq line (replace-match "<br/>" t t line)))
1668 (org-export-preserve-breaks
1669 (setq line (concat line "<br/>"))))
1671 ;; Check if a paragraph should be started
1672 (let ((start 0))
1673 (while (and org-par-open
1674 (string-match "\\\\par\\>" line start))
1675 ;; Leave a space in the </p> so that the footnote matcher
1676 ;; does not see this.
1677 (if (not (get-text-property (match-beginning 0)
1678 'org-protected line))
1679 (setq line (replace-match "</p ><p >" t t line)))
1680 (setq start (match-end 0))))
1682 (insert line "\n")))))
1684 ;; Properly close all local lists and other lists
1685 (when inquote
1686 (insert "</pre>\n")
1687 (org-open-par))
1689 (org-html-level-start 1 nil umax
1690 (and org-export-with-toc (<= level umax))
1691 head-count opt-plist)
1692 ;; the </div> to close the last text-... div.
1693 (when (and (> umax 0) first-heading-pos) (insert "</div>\n"))
1695 (save-excursion
1696 (goto-char (point-min))
1697 (while (re-search-forward
1698 "\\(\\(<p class=\"footnote\">\\)[^\000]*?\\)\\(\\(\\2\\)\\|\\'\\)"
1699 nil t)
1700 (push (match-string 1) footnotes)
1701 (replace-match "\\4" t nil)
1702 (goto-char (match-beginning 0))))
1703 (when footnotes
1704 (insert (format org-export-html-footnotes-section
1705 (nth 4 lang-words)
1706 (mapconcat 'identity (nreverse footnotes) "\n"))
1707 "\n"))
1708 (let ((bib (org-export-html-get-bibliography)))
1709 (when bib
1710 (insert "\n" bib "\n")))
1712 ;; export html postamble
1713 (unless body-only
1714 (let ((html-post (plist-get opt-plist :html-postamble))
1715 (email
1716 (mapconcat (lambda(e)
1717 (format "<a href=\"mailto:%s\">%s</a>" e e))
1718 (split-string email ",+ *")
1719 ", "))
1720 (creator-info
1721 (concat "Org version " org-version " with Emacs version "
1722 (number-to-string emacs-major-version))))
1723 (when (plist-get opt-plist :html-postamble)
1724 (cond ((stringp html-post)
1725 (insert "<div id=\"postamble\">\n")
1726 (insert (format-spec html-post
1727 `((?a . ,author) (?e . ,email)
1728 (?d . ,date) (?c . ,creator-info)
1729 (?v . ,html-validation-link))))
1730 (insert "</div>"))
1731 ((functionp html-post)
1732 (funcall html-post opt-plist))
1733 ((eq html-post 'auto)
1734 ;; fall back on default postamble
1735 (insert "<div id=\"postamble\">\n")
1736 (when (plist-get opt-plist :time-stamp-file)
1737 (insert "<p class=\"date\">" (nth 2 lang-words) ": " date "</p>\n"))
1738 (when (and (plist-get opt-plist :author-info) author)
1739 (insert "<p class=\"author\">" (nth 1 lang-words) ": " author "</p>\n"))
1740 (when (and (plist-get opt-plist :email-info) email)
1741 (insert "<p class=\"email\">" email "</p>\n"))
1742 (when (plist-get opt-plist :creator-info)
1743 (insert "<p class=\"creator\">"
1744 (concat "Org version " org-version " with Emacs version "
1745 (number-to-string emacs-major-version) "</p>\n")))
1746 (insert html-validation-link "\n</div>"))
1748 (insert "<div id=\"postamble\">\n")
1749 (insert (format-spec
1750 (or (cadr (assoc (nth 0 lang-words)
1751 org-export-html-postamble-format))
1752 (cadr (assoc "en" org-export-html-postamble-format)))
1753 `((?a . ,author) (?e . ,email)
1754 (?d . ,date) (?c . ,creator-info)
1755 (?v . ,html-validation-link))))
1756 (insert "</div>"))))))
1758 (if org-export-html-with-timestamp
1759 (insert org-export-html-html-helper-timestamp))
1761 (unless body-only (insert "\n</div>\n</body>\n</html>\n"))
1763 (unless (plist-get opt-plist :buffer-will-be-killed)
1764 (normal-mode)
1765 (if (eq major-mode (default-value 'major-mode))
1766 (html-mode)))
1768 ;; insert the table of contents
1769 (goto-char (point-min))
1770 (when thetoc
1771 (if (or (re-search-forward
1772 "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t)
1773 (re-search-forward
1774 "\\[TABLE-OF-CONTENTS\\]" nil t))
1775 (progn
1776 (goto-char (match-beginning 0))
1777 (replace-match ""))
1778 (goto-char first-heading-pos)
1779 (when (looking-at "\\s-*</p>")
1780 (goto-char (match-end 0))
1781 (insert "\n")))
1782 (insert "<div id=\"table-of-contents\">\n")
1783 (let ((beg (point)))
1784 (mapc 'insert thetoc)
1785 (insert "</div>\n")
1786 (while (re-search-backward "<li>[ \r\n\t]*</li>\n?" beg t)
1787 (replace-match ""))))
1788 ;; remove empty paragraphs
1789 (goto-char (point-min))
1790 (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t)
1791 (replace-match ""))
1792 (goto-char (point-min))
1793 ;; Convert whitespace place holders
1794 (goto-char (point-min))
1795 (let (beg end n)
1796 (while (setq beg (next-single-property-change (point) 'org-whitespace))
1797 (setq n (get-text-property beg 'org-whitespace)
1798 end (next-single-property-change beg 'org-whitespace))
1799 (goto-char beg)
1800 (delete-region beg end)
1801 (insert (format "<span style=\"visibility:hidden;\">%s</span>"
1802 (make-string n ?x)))))
1803 ;; Remove empty lines at the beginning of the file.
1804 (goto-char (point-min))
1805 (when (looking-at "\\s-+\n") (replace-match ""))
1806 ;; Remove display properties
1807 (remove-text-properties (point-min) (point-max) '(display t))
1808 ;; Run the hook
1809 (run-hooks 'org-export-html-final-hook)
1810 (or to-buffer (save-buffer))
1811 (goto-char (point-min))
1812 (or (org-export-push-to-kill-ring "HTML")
1813 (message "Exporting... done"))
1814 (if (eq to-buffer 'string)
1815 (prog1 (buffer-substring (point-min) (point-max))
1816 (kill-buffer (current-buffer)))
1817 (current-buffer)))))
1819 (defun org-export-html-format-href (s)
1820 "Make sure the S is valid as a href reference in an XHTML document."
1821 (save-match-data
1822 (let ((start 0))
1823 (while (string-match "&" s start)
1824 (setq start (+ (match-beginning 0) 3)
1825 s (replace-match "&amp;" t t s)))))
1828 (defun org-export-html-format-desc (s)
1829 "Make sure the S is valid as a description in a link."
1830 (if (and s (not (get-text-property 1 'org-protected s)))
1831 (save-match-data
1832 (org-html-do-expand s))
1835 (defun org-export-html-format-image (src par-open)
1836 "Create image tag with source and attributes."
1837 (save-match-data
1838 (if (string-match "^ltxpng/" src)
1839 (format "<img src=\"%s\" alt=\"%s\"/>"
1840 src (org-find-text-property-in-string 'org-latex-src src))
1841 (let* ((caption (org-find-text-property-in-string 'org-caption src))
1842 (attr (org-find-text-property-in-string 'org-attributes src))
1843 (label (org-find-text-property-in-string 'org-label src)))
1844 (setq caption (and caption (org-html-do-expand caption)))
1845 (concat
1846 (if caption
1847 (format "%s<div %sclass=\"figure\">
1848 <p>"
1849 (if org-par-open "</p>\n" "")
1850 (if label (format "id=\"%s\" " (org-solidify-link-text label)) "")))
1851 (format "<img src=\"%s\"%s />"
1853 (if (string-match "\\<alt=" (or attr ""))
1854 (concat " " attr )
1855 (concat " " attr " alt=\"" src "\"")))
1856 (if caption
1857 (format "</p>%s
1858 </div>%s"
1859 (concat "\n<p>" caption "</p>")
1860 (if org-par-open "\n<p>" ""))))))))
1862 (defun org-export-html-get-bibliography ()
1863 "Find bibliography, cut it out and return it."
1864 (catch 'exit
1865 (let (beg end (cnt 1) bib)
1866 (save-excursion
1867 (goto-char (point-min))
1868 (when (re-search-forward "^[ \t]*<div \\(id\\|class\\)=\"bibliography\"" nil t)
1869 (setq beg (match-beginning 0))
1870 (while (re-search-forward "</?div\\>" nil t)
1871 (setq cnt (+ cnt (if (string= (match-string 0) "<div") +1 -1)))
1872 (when (= cnt 0)
1873 (and (looking-at ">") (forward-char 1))
1874 (setq bib (buffer-substring beg (point)))
1875 (delete-region beg (point))
1876 (throw 'exit bib))))
1877 nil))))
1879 (defvar org-table-number-regexp) ; defined in org-table.el
1880 (defun org-format-table-html (lines olines &optional no-css)
1881 "Find out which HTML converter to use and return the HTML code.
1882 NO-CSS is passed to the exporter."
1883 (if (stringp lines)
1884 (setq lines (org-split-string lines "\n")))
1885 (if (string-match "^[ \t]*|" (car lines))
1886 ;; A normal org table
1887 (org-format-org-table-html lines nil no-css)
1888 ;; Table made by table.el - test for spanning
1889 (let* ((hlines (delq nil (mapcar
1890 (lambda (x)
1891 (if (string-match "^[ \t]*\\+-" x) x
1892 nil))
1893 lines)))
1894 (first (car hlines))
1895 (ll (and (string-match "\\S-+" first)
1896 (match-string 0 first)))
1897 (re (concat "^[ \t]*" (regexp-quote ll)))
1898 (spanning (delq nil (mapcar (lambda (x) (not (string-match re x)))
1899 hlines))))
1900 (if (and (not spanning)
1901 (not org-export-prefer-native-exporter-for-tables))
1902 ;; We can use my own converter with HTML conversions
1903 (org-format-table-table-html lines)
1904 ;; Need to use the code generator in table.el, with the original text.
1905 (org-format-table-table-html-using-table-generate-source olines)))))
1907 (defvar org-table-number-fraction) ; defined in org-table.el
1908 (defun org-format-org-table-html (lines &optional splice no-css)
1909 "Format a table into HTML.
1910 LINES is a list of lines. Optional argument SPLICE means, do not
1911 insert header and surrounding <table> tags, just format the lines.
1912 Optional argument NO-CSS means use XHTML attributes instead of CSS
1913 for formatting. This is required for the DocBook exporter."
1914 (require 'org-table)
1915 ;; Get rid of hlines at beginning and end
1916 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
1917 (setq lines (nreverse lines))
1918 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
1919 (setq lines (nreverse lines))
1920 (when org-export-table-remove-special-lines
1921 ;; Check if the table has a marking column. If yes remove the
1922 ;; column and the special lines
1923 (setq lines (org-table-clean-before-export lines)))
1925 (let* ((caption (org-find-text-property-in-string 'org-caption (car lines)))
1926 (label (org-find-text-property-in-string 'org-label (car lines)))
1927 (forced-aligns (org-find-text-property-in-string 'org-forced-aligns
1928 (car lines)))
1929 (attributes (org-find-text-property-in-string 'org-attributes
1930 (car lines)))
1931 (html-table-tag (org-export-splice-attributes
1932 html-table-tag attributes))
1933 (head (and org-export-highlight-first-table-line
1934 (delq nil (mapcar
1935 (lambda (x) (string-match "^[ \t]*|-" x))
1936 (cdr lines)))))
1937 (nline 0) fnum nfields i (cnt 0)
1938 tbopen line fields html gr colgropen rowstart rowend
1939 ali align aligns n)
1940 (setq caption (and caption (org-html-do-expand caption)))
1941 (when (and forced-aligns org-table-clean-did-remove-column)
1942 (setq forced-aligns
1943 (mapcar (lambda (x) (cons (1- (car x)) (cdr x))) forced-aligns)))
1944 (if splice (setq head nil))
1945 (unless splice (push (if head "<thead>" "<tbody>") html))
1946 (setq tbopen t)
1947 (while (setq line (pop lines))
1948 (catch 'next-line
1949 (if (string-match "^[ \t]*|-" line)
1950 (progn
1951 (unless splice
1952 (push (if head "</thead>" "</tbody>") html)
1953 (if lines (push "<tbody>" html) (setq tbopen nil)))
1954 (setq head nil) ;; head ends here, first time around
1955 ;; ignore this line
1956 (throw 'next-line t)))
1957 ;; Break the line into fields
1958 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
1959 (unless fnum (setq fnum (make-vector (length fields) 0)
1960 nfields (length fnum)))
1961 (setq nline (1+ nline) i -1
1962 rowstart (eval (car org-export-table-row-tags))
1963 rowend (eval (cdr org-export-table-row-tags)))
1964 (push (concat rowstart
1965 (mapconcat
1966 (lambda (x)
1967 (setq i (1+ i) ali (format "@@class%03d@@" i))
1968 (if (and (< i nfields) ; make sure no rogue line causes an error here
1969 (string-match org-table-number-regexp x))
1970 (incf (aref fnum i)))
1971 (cond
1972 (head
1973 (concat
1974 (format (car org-export-table-header-tags)
1975 "col" ali)
1977 (cdr org-export-table-header-tags)))
1978 ((and (= i 0) org-export-html-table-use-header-tags-for-first-column)
1979 (concat
1980 (format (car org-export-table-header-tags)
1981 "row" ali)
1983 (cdr org-export-table-header-tags)))
1985 (concat (format (car org-export-table-data-tags) ali)
1987 (cdr org-export-table-data-tags)))))
1988 fields "")
1989 rowend)
1990 html)))
1991 (unless splice (if tbopen (push "</tbody>" html)))
1992 (unless splice (push "</table>\n" html))
1993 (setq html (nreverse html))
1994 (unless splice
1995 ;; Put in col tags with the alignment (unfortunately often ignored...)
1996 (unless (car org-table-colgroup-info)
1997 (setq org-table-colgroup-info
1998 (cons :start (cdr org-table-colgroup-info))))
1999 (setq i 0)
2000 (push (mapconcat
2001 (lambda (x)
2002 (setq gr (pop org-table-colgroup-info)
2003 i (1+ i)
2004 align (if (assoc i forced-aligns)
2005 (cdr (assoc (cdr (assoc i forced-aligns))
2006 '(("l" . "left") ("r" . "right")
2007 ("c" . "center"))))
2008 (if (> (/ (float x) nline)
2009 org-table-number-fraction)
2010 "right" "left")))
2011 (push align aligns)
2012 (format (if no-css
2013 "%s<col align=\"%s\" />%s"
2014 "%s<col class=\"%s\" />%s")
2015 (if (memq gr '(:start :startend))
2016 (prog1
2017 (if colgropen
2018 "</colgroup>\n<colgroup>"
2019 "<colgroup>")
2020 (setq colgropen t))
2022 align
2023 (if (memq gr '(:end :startend))
2024 (progn (setq colgropen nil) "</colgroup>")
2025 "")))
2026 fnum "")
2027 html)
2028 (setq aligns (nreverse aligns))
2029 (if colgropen (setq html (cons (car html)
2030 (cons "</colgroup>" (cdr html)))))
2031 ;; Since the output of HTML table formatter can also be used in
2032 ;; DocBook document, we want to always include the caption to make
2033 ;; DocBook XML file valid.
2034 (push (format "<caption>%s</caption>" (or caption "")) html)
2035 (when label
2036 (setq html-table-tag (org-export-splice-attributes html-table-tag (format "id=\"%s\"" (org-solidify-link-text label)))))
2037 (push html-table-tag html))
2038 (setq html (mapcar
2039 (lambda (x)
2040 (replace-regexp-in-string
2041 "@@class\\([0-9]+\\)@@"
2042 (lambda (txt)
2043 (if (not org-export-html-table-align-individual-fields)
2045 (setq n (string-to-number (match-string 1 txt)))
2046 (format (if no-css " align=\"%s\"" " class=\"%s\"")
2047 (or (nth n aligns) "left"))))
2049 html))
2050 (concat (mapconcat 'identity html "\n") "\n")))
2052 (defun org-export-splice-attributes (tag attributes)
2053 "Read attributes in string ATTRIBUTES, add and replace in HTML tag TAG."
2054 (if (not attributes)
2056 (let (oldatt newatt)
2057 (setq oldatt (org-extract-attributes-from-string tag)
2058 tag (pop oldatt)
2059 newatt (cdr (org-extract-attributes-from-string attributes)))
2060 (while newatt
2061 (setq oldatt (plist-put oldatt (pop newatt) (pop newatt))))
2062 (if (string-match ">" tag)
2063 (setq tag
2064 (replace-match (concat (org-attributes-to-string oldatt) ">")
2065 t t tag)))
2066 tag)))
2068 (defun org-format-table-table-html (lines)
2069 "Format a table generated by table.el into HTML.
2070 This conversion does *not* use `table-generate-source' from table.el.
2071 This has the advantage that Org-mode's HTML conversions can be used.
2072 But it has the disadvantage, that no cell- or row-spanning is allowed."
2073 (let (line field-buffer
2074 (head org-export-highlight-first-table-line)
2075 fields html empty i)
2076 (setq html (concat html-table-tag "\n"))
2077 (while (setq line (pop lines))
2078 (setq empty "&nbsp;")
2079 (catch 'next-line
2080 (if (string-match "^[ \t]*\\+-" line)
2081 (progn
2082 (if field-buffer
2083 (progn
2084 (setq
2085 html
2086 (concat
2087 html
2088 "<tr>"
2089 (mapconcat
2090 (lambda (x)
2091 (if (equal x "") (setq x empty))
2092 (if head
2093 (concat
2094 (format (car org-export-table-header-tags) "col" "")
2096 (cdr org-export-table-header-tags))
2097 (concat (format (car org-export-table-data-tags) "") x
2098 (cdr org-export-table-data-tags))))
2099 field-buffer "\n")
2100 "</tr>\n"))
2101 (setq head nil)
2102 (setq field-buffer nil)))
2103 ;; Ignore this line
2104 (throw 'next-line t)))
2105 ;; Break the line into fields and store the fields
2106 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
2107 (if field-buffer
2108 (setq field-buffer (mapcar
2109 (lambda (x)
2110 (concat x "<br/>" (pop fields)))
2111 field-buffer))
2112 (setq field-buffer fields))))
2113 (setq html (concat html "</table>\n"))
2114 html))
2116 (defun org-format-table-table-html-using-table-generate-source (lines)
2117 "Format a table into html, using `table-generate-source' from table.el.
2118 This has the advantage that cell- or row-spanning is allowed.
2119 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
2120 (require 'table)
2121 (with-current-buffer (get-buffer-create " org-tmp1 ")
2122 (erase-buffer)
2123 (insert (mapconcat 'identity lines "\n"))
2124 (goto-char (point-min))
2125 (if (not (re-search-forward "|[^+]" nil t))
2126 (error "Error processing table"))
2127 (table-recognize-table)
2128 (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
2129 (table-generate-source 'html " org-tmp2 ")
2130 (set-buffer " org-tmp2 ")
2131 (buffer-substring (point-min) (point-max))))
2133 (defun org-export-splice-style (style extra)
2134 "Splice EXTRA into STYLE, just before \"</style>\"."
2135 (if (and (stringp extra)
2136 (string-match "\\S-" extra)
2137 (string-match "</style>" style))
2138 (concat (substring style 0 (match-beginning 0))
2139 "\n" extra "\n"
2140 (substring style (match-beginning 0)))
2141 style))
2143 (defun org-html-handle-time-stamps (s)
2144 "Format time stamps in string S, or remove them."
2145 (catch 'exit
2146 (let (r b)
2147 (while (string-match org-maybe-keyword-time-regexp s)
2148 (or b (setq b (substring s 0 (match-beginning 0))))
2149 (setq r (concat
2150 r (substring s 0 (match-beginning 0))
2151 " @<span class=\"timestamp-wrapper\">"
2152 (if (match-end 1)
2153 (format "@<span class=\"timestamp-kwd\">%s @</span>"
2154 (match-string 1 s)))
2155 (format " @<span class=\"timestamp\">%s@</span>"
2156 (substring
2157 (org-translate-time (match-string 3 s)) 1 -1))
2158 "@</span>")
2159 s (substring s (match-end 0))))
2160 ;; Line break if line started and ended with time stamp stuff
2161 (if (not r)
2163 (setq r (concat r s))
2164 (unless (string-match "\\S-" (concat b s))
2165 (setq r (concat r "@<br/>")))
2166 r))))
2168 (defvar htmlize-buffer-places) ; from htmlize.el
2169 (defun org-export-htmlize-region-for-paste (beg end)
2170 "Convert the region to HTML, using htmlize.el.
2171 This is much like `htmlize-region-for-paste', only that it uses
2172 the settings define in the org-... variables."
2173 (let* ((htmlize-output-type org-export-htmlize-output-type)
2174 (htmlize-css-name-prefix org-export-htmlize-css-font-prefix)
2175 (htmlbuf (htmlize-region beg end)))
2176 (unwind-protect
2177 (with-current-buffer htmlbuf
2178 (buffer-substring (plist-get htmlize-buffer-places 'content-start)
2179 (plist-get htmlize-buffer-places 'content-end)))
2180 (kill-buffer htmlbuf))))
2182 ;;;###autoload
2183 (defun org-export-htmlize-generate-css ()
2184 "Create the CSS for all font definitions in the current Emacs session.
2185 Use this to create face definitions in your CSS style file that can then
2186 be used by code snippets transformed by htmlize.
2187 This command just produces a buffer that contains class definitions for all
2188 faces used in the current Emacs session. You can copy and paste the ones you
2189 need into your CSS file.
2191 If you then set `org-export-htmlize-output-type' to `css', calls to
2192 the function `org-export-htmlize-region-for-paste' will produce code
2193 that uses these same face definitions."
2194 (interactive)
2195 (require 'htmlize)
2196 (and (get-buffer "*html*") (kill-buffer "*html*"))
2197 (with-temp-buffer
2198 (let ((fl (face-list))
2199 (htmlize-css-name-prefix "org-")
2200 (htmlize-output-type 'css)
2201 f i)
2202 (while (setq f (pop fl)
2203 i (and f (face-attribute f :inherit)))
2204 (when (and (symbolp f) (or (not i) (not (listp i))))
2205 (insert (org-add-props (copy-sequence "1") nil 'face f))))
2206 (htmlize-region (point-min) (point-max))))
2207 (switch-to-buffer "*html*")
2208 (goto-char (point-min))
2209 (if (re-search-forward "<style" nil t)
2210 (delete-region (point-min) (match-beginning 0)))
2211 (if (re-search-forward "</style>" nil t)
2212 (delete-region (1+ (match-end 0)) (point-max)))
2213 (beginning-of-line 1)
2214 (if (looking-at " +") (replace-match ""))
2215 (goto-char (point-min)))
2217 (defun org-html-protect (s)
2218 "Convert characters to HTML equivalent.
2219 Possible conversions are set in `org-export-html-protect-char-alist'."
2220 (let ((cl org-export-html-protect-char-alist) c)
2221 (while (setq c (pop cl))
2222 (let ((start 0))
2223 (while (string-match (car c) s start)
2224 (setq s (replace-match (cdr c) t t s)
2225 start (1+ (match-beginning 0))))))
2228 (defun org-html-expand (string)
2229 "Prepare STRING for HTML export. Apply all active conversions.
2230 If there are links in the string, don't modify these."
2231 (let* ((re (concat org-bracket-link-regexp "\\|"
2232 (org-re "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")))
2233 m s l res)
2234 (if (string-match "^[ \t]*\\+-[-+]*\\+[ \t]*$" string)
2235 string
2236 (while (setq m (string-match re string))
2237 (setq s (substring string 0 m)
2238 l (match-string 0 string)
2239 string (substring string (match-end 0)))
2240 (push (org-html-do-expand s) res)
2241 (push l res))
2242 (push (org-html-do-expand string) res)
2243 (apply 'concat (nreverse res)))))
2245 (defun org-html-do-expand (s)
2246 "Apply all active conversions to translate special ASCII to HTML."
2247 (setq s (org-html-protect s))
2248 (if org-export-html-expand
2249 (while (string-match "@&lt;\\([^&]*\\)&gt;" s)
2250 (setq s (replace-match "<\\1>" t nil s))))
2251 (if org-export-with-emphasize
2252 (setq s (org-export-html-convert-emphasize s)))
2253 (if org-export-with-special-strings
2254 (setq s (org-export-html-convert-special-strings s)))
2255 (if org-export-with-sub-superscripts
2256 (setq s (org-export-html-convert-sub-super s)))
2257 (if org-export-with-TeX-macros
2258 (let ((start 0) wd rep)
2259 (while (setq start (string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
2260 s start))
2261 (if (get-text-property (match-beginning 0) 'org-protected s)
2262 (setq start (match-end 0))
2263 (setq wd (match-string 1 s))
2264 (if (setq rep (org-entity-get-representation wd 'html))
2265 (setq s (replace-match rep t t s))
2266 (setq start (+ start (length wd))))))))
2269 (defun org-export-html-convert-special-strings (string)
2270 "Convert special characters in STRING to HTML."
2271 (let ((all org-export-html-special-string-regexps)
2272 e a re rpl start)
2273 (while (setq a (pop all))
2274 (setq re (car a) rpl (cdr a) start 0)
2275 (while (string-match re string start)
2276 (if (get-text-property (match-beginning 0) 'org-protected string)
2277 (setq start (match-end 0))
2278 (setq string (replace-match rpl t nil string)))))
2279 string))
2281 (defun org-export-html-convert-sub-super (string)
2282 "Convert sub- and superscripts in STRING to HTML."
2283 (let (key c (s 0) (requireb (eq org-export-with-sub-superscripts '{})))
2284 (while (string-match org-match-substring-regexp string s)
2285 (cond
2286 ((and requireb (match-end 8)) (setq s (match-end 2)))
2287 ((get-text-property (match-beginning 2) 'org-protected string)
2288 (setq s (match-end 2)))
2290 (setq s (match-end 1)
2291 key (if (string= (match-string 2 string) "_") "sub" "sup")
2292 c (or (match-string 8 string)
2293 (match-string 6 string)
2294 (match-string 5 string))
2295 string (replace-match
2296 (concat (match-string 1 string)
2297 "<" key ">" c "</" key ">")
2298 t t string)))))
2299 (while (string-match "\\\\\\([_^]\\)" string)
2300 (setq string (replace-match (match-string 1 string) t t string)))
2301 string))
2303 (defun org-export-html-convert-emphasize (string)
2304 "Apply emphasis."
2305 (let ((s 0) rpl)
2306 (while (string-match org-emph-re string s)
2307 (if (not (equal
2308 (substring string (match-beginning 3) (1+ (match-beginning 3)))
2309 (substring string (match-beginning 4) (1+ (match-beginning 4)))))
2310 (setq s (match-beginning 0)
2312 (concat
2313 (match-string 1 string)
2314 (nth 2 (assoc (match-string 3 string) org-emphasis-alist))
2315 (match-string 4 string)
2316 (nth 3 (assoc (match-string 3 string)
2317 org-emphasis-alist))
2318 (match-string 5 string))
2319 string (replace-match rpl t t string)
2320 s (+ s (- (length rpl) 2)))
2321 (setq s (1+ s))))
2322 string))
2324 (defun org-open-par ()
2325 "Insert <p>, but first close previous paragraph if any."
2326 (org-close-par-maybe)
2327 (insert "\n<p>")
2328 (setq org-par-open t))
2329 (defun org-close-par-maybe ()
2330 "Close paragraph if there is one open."
2331 (when org-par-open
2332 (insert "</p>")
2333 (setq org-par-open nil)))
2334 (defun org-close-li (&optional type)
2335 "Close <li> if necessary."
2336 (org-close-par-maybe)
2337 (insert (if (equal type "d") "</dd>\n" "</li>\n")))
2339 (defvar body-only) ; dynamically scoped into this.
2340 (defun org-html-level-start (level title umax with-toc head-count &optional opt-plist)
2341 "Insert a new level in HTML export.
2342 When TITLE is nil, just close all open levels."
2343 (org-close-par-maybe)
2344 (let* ((target (and title (org-get-text-property-any 0 'target title)))
2345 (extra-targets (and target
2346 (assoc target org-export-target-aliases)))
2347 (extra-class (and title (org-get-text-property-any 0 'html-container-class title)))
2348 (preferred (and target
2349 (cdr (assoc target org-export-preferred-target-alist))))
2350 (l org-level-max)
2351 (num (plist-get opt-plist :section-numbers))
2352 snumber snu href suffix)
2353 (setq extra-targets (remove (or preferred target) extra-targets))
2354 (setq extra-targets
2355 (mapconcat (lambda (x)
2356 (setq x (org-solidify-link-text
2357 (if (org-uuidgen-p x) (concat "ID-" x) x)))
2358 (format "<a name=\"%s\" id=\"%s\"></a>"
2359 x x))
2360 extra-targets
2361 ""))
2362 (while (>= l level)
2363 (if (aref org-levels-open (1- l))
2364 (progn
2365 (org-html-level-close l umax)
2366 (aset org-levels-open (1- l) nil)))
2367 (setq l (1- l)))
2368 (when title
2369 ;; If title is nil, this means this function is called to close
2370 ;; all levels, so the rest is done only if title is given
2371 (when (string-match (org-re "\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") title)
2372 (setq title (replace-match
2373 (if org-export-with-tags
2374 (save-match-data
2375 (concat
2376 "&nbsp;&nbsp;&nbsp;<span class=\"tag\">"
2377 (mapconcat
2378 (lambda (x)
2379 (format "<span class=\"%s\">%s</span>"
2380 (org-export-html-get-tag-class-name x)
2382 (org-split-string (match-string 1 title) ":")
2383 "&nbsp;")
2384 "</span>"))
2386 t t title)))
2387 (if (> level umax)
2388 (progn
2389 (if (aref org-levels-open (1- level))
2390 (progn
2391 (org-close-li)
2392 (if target
2393 (insert (format "<li id=\"%s\">" (org-solidify-link-text (or preferred target)))
2394 extra-targets title "<br/>\n")
2395 (insert "<li>" title "<br/>\n")))
2396 (aset org-levels-open (1- level) t)
2397 (org-close-par-maybe)
2398 (if target
2399 (insert (format "<ul>\n<li id=\"%s\">" (org-solidify-link-text (or preferred target)))
2400 extra-targets title "<br/>\n")
2401 (insert "<ul>\n<li>" title "<br/>\n"))))
2402 (aset org-levels-open (1- level) t)
2403 (setq snumber (org-section-number level)
2404 snu (replace-regexp-in-string "\\." "_" snumber))
2405 (setq level (+ level org-export-html-toplevel-hlevel -1))
2406 (if (and num (not body-only))
2407 (setq title (concat
2408 (format "<span class=\"section-number-%d\">%s</span>"
2409 level
2410 (if (and num
2411 (if (integerp num)
2412 ;; fix up num to take into
2413 ;; account the top-level
2414 ;; heading value
2415 (>= (+ num org-export-html-toplevel-hlevel -1)
2416 level)
2417 num))
2418 snumber
2419 ""))
2420 " " title)))
2421 (unless (= head-count 1) (insert "\n</div>\n"))
2422 (setq href (cdr (assoc (concat "sec-" snu) org-export-preferred-target-alist)))
2423 (setq suffix (org-solidify-link-text (or href snu)))
2424 (setq href (org-solidify-link-text (or href (concat "sec-" snu))))
2425 (insert (format "\n<div id=\"outline-container-%s\" class=\"outline-%d%s\">\n<h%d id=\"%s\">%s%s</h%d>\n<div class=\"outline-text-%d\" id=\"text-%s\">\n"
2426 suffix level (if extra-class (concat " " extra-class) "")
2427 level href
2428 extra-targets
2429 title level level suffix))
2430 (org-open-par)))))
2432 (defun org-export-html-get-tag-class-name (tag)
2433 "Turn tag into a valid class name.
2434 Replaces invalid characters with \"_\" and then prepends a prefix."
2435 (save-match-data
2436 (while (string-match "[^a-zA-Z0-9_]" tag)
2437 (setq tag (replace-match "_" t t tag))))
2438 (concat org-export-html-tag-class-prefix tag))
2440 (defun org-export-html-get-todo-kwd-class-name (kwd)
2441 "Turn todo keyword into a valid class name.
2442 Replaces invalid characters with \"_\" and then prepends a prefix."
2443 (save-match-data
2444 (while (string-match "[^a-zA-Z0-9_]" kwd)
2445 (setq kwd (replace-match "_" t t kwd))))
2446 (concat org-export-html-todo-kwd-class-prefix kwd))
2448 (defun org-html-level-close (level max-outline-level)
2449 "Terminate one level in HTML export."
2450 (if (<= level max-outline-level)
2451 (insert "</div>\n")
2452 (org-close-li)
2453 (insert "</ul>\n")))
2455 (defun org-html-export-list-line (line pos struct prevs)
2456 "Insert list syntax in export buffer. Return LINE, maybe modified.
2458 POS is the item position or line position the line had before
2459 modifications to buffer. STRUCT is the list structure. PREVS is
2460 the alist of previous items."
2461 (let* ((get-type
2462 (function
2463 ;; Translate type of list containing POS to "d", "o" or
2464 ;; "u".
2465 (lambda (pos struct prevs)
2466 (let ((type (org-list-get-list-type pos struct prevs)))
2467 (cond
2468 ((eq 'ordered type) "o")
2469 ((eq 'descriptive type) "d")
2470 (t "u"))))))
2471 (get-closings
2472 (function
2473 ;; Return list of all items and sublists ending at POS, in
2474 ;; reverse order.
2475 (lambda (pos)
2476 (let (out)
2477 (catch 'exit
2478 (mapc (lambda (e)
2479 (let ((end (nth 6 e))
2480 (item (car e)))
2481 (cond
2482 ((= end pos) (push item out))
2483 ((>= item pos) (throw 'exit nil)))))
2484 struct))
2485 out)))))
2486 ;; First close any previous item, or list, ending at POS.
2487 (mapc (lambda (e)
2488 (let* ((lastp (= (org-list-get-last-item e struct prevs) e))
2489 (first-item (org-list-get-list-begin e struct prevs))
2490 (type (funcall get-type first-item struct prevs)))
2491 (org-close-par-maybe)
2492 ;; Ending for every item
2493 (org-close-li type)
2494 ;; We're ending last item of the list: end list.
2495 (when lastp
2496 (insert (format "</%sl>\n" type))
2497 (org-open-par))))
2498 (funcall get-closings pos))
2499 (cond
2500 ;; At an item: insert appropriate tags in export buffer.
2501 ((assq pos struct)
2502 (string-match
2503 (concat "[ \t]*\\(\\S-+[ \t]*\\)"
2504 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\]\\)?"
2505 "\\(?:\\(\\[[ X-]\\]\\)[ \t]+\\)?"
2506 "\\(?:\\(.*\\)[ \t]+::[ \t]+\\)?"
2507 "\\(.*\\)") line)
2508 (let* ((checkbox (match-string 3 line))
2509 (desc-tag (or (match-string 4 line) "???"))
2510 (body (or (match-string 5 line) ""))
2511 (list-beg (org-list-get-list-begin pos struct prevs))
2512 (firstp (= list-beg pos))
2513 ;; Always refer to first item to determine list type, in
2514 ;; case list is ill-formed.
2515 (type (funcall get-type list-beg struct prevs))
2516 (counter (let ((count-tmp (org-list-get-counter pos struct)))
2517 (cond
2518 ((not count-tmp) nil)
2519 ((string-match "[A-Za-z]" count-tmp)
2520 (- (string-to-char (upcase count-tmp)) 64))
2521 ((string-match "[0-9]+" count-tmp)
2522 count-tmp)))))
2523 (when firstp
2524 (org-close-par-maybe)
2525 (insert (format "<%sl>\n" type)))
2526 (insert (cond
2527 ((equal type "d")
2528 (format "<dt>%s</dt><dd>" desc-tag))
2529 ((and (equal type "o") counter)
2530 (format "<li value=\"%s\">" counter))
2531 (t "<li>")))
2532 ;; If line had a checkbox, some additional modification is required.
2533 (when checkbox
2534 (setq body
2535 (concat
2536 (cond
2537 ((string-match "X" checkbox) "<code>[X]</code> ")
2538 ((string-match " " checkbox) "<code>[&nbsp;]</code> ")
2539 (t "<code>[-]</code> "))
2540 body)))
2541 ;; Return modified line
2542 body))
2543 ;; At a list ender: go to next line (side-effects only).
2544 ((equal "ORG-LIST-END-MARKER" line) (throw 'nextline nil))
2545 ;; Not at an item: return line unchanged (side-effects only).
2546 (t line))))
2548 (provide 'org-html)
2550 ;; arch-tag: 8109d84d-eb8f-460b-b1a8-f45f3a6c7ea1
2551 ;;; org-html.el ends here