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