Replace org-mode-p with usual (eq major-mode 'org-mode) check
[org-mode.git] / lisp / org-html.el
1 ;;; org-html.el --- HTML export for Org-mode
2
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
4
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.
10 ;;
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.
15
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.
20
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (require 'org-exp)
30 (require 'format-spec)
31
32 (eval-when-compile (require 'cl))
33
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))
38
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)
43
44 (defcustom org-export-html-footnotes-section "<div id=\"footnotes\">
45 <h2 class=\"footnotes\">%s: </h2>
46 <div id=\"text-footnotes\">
47 %s
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)
56
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)
62
63
64 (defcustom org-export-html-footnote-separator "<sup>, </sup>"
65   "Text used to separate footnotes."
66   :group 'org-export-html
67   :type 'string)
68
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)
73
74 (defcustom org-export-html-extension "html"
75   "The extension for exported HTML files."
76   :group 'org-export-html
77   :type 'string)
78
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")))))
92
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)
99
100 (defconst org-export-html-scripts
101 "<script type=\"text/javascript\">
102 <!--/*--><![CDATA[/*><!--*/
103  function CodeHighlightOn(elem, id)
104  {
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\";
111    }
112  }
113  function CodeHighlightOff(elem, id)
114  {
115    var target = document.getElementById(id);
116    if(elem.cacheClassElem)
117      elem.className = elem.cacheClassElem;
118    if(elem.cacheClassTarget)
119      target.className = elem.cacheClassTarget;
120  }
121 /*]]>*///-->
122 </script>"
123 "Basic JavaScript that is needed by HTML files produced by Org-mode.")
124
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;
147   }
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;
164   }
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'.")
180
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)
190
191 (defcustom org-export-html-style ""
192   "Org-wide style definitions for exported HTML files.
193
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.
198
199 For example, a valid value would be:
200
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; }
208     ]]>
209    </style>
210
211 If you'd like to refer to an external style file, use something like
212
213    <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
214
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)
222
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)
233
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.
241
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.
250
251 You can also customize this for each buffer, using something like
252
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))))
266
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))
293
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\"
312         },
313         showProcessingMessages: true,
314         displayAlign: \"%ALIGN\",
315         displayIndent: \"%INDENT\",
316
317         \"HTML-CSS\": {
318              scale: %SCALE,
319              availableFonts: [\"STIX\",\"TeX\"],
320              preferredFont: \"TeX\",
321              webFont: \"TeX\",
322              imageFont: \"TeX\",
323              showMathMenu: true,
324         },
325         MMLorHTML: {
326              prefer: {
327                  MSIE:    \"MML\",
328                  Firefox: \"MML\",
329                  Opera:   \"HTML\",
330                  other:   \"HTML\"
331              }
332         }
333     });
334 /*]]>*///-->
335 </script>"
336   "The MathJax setup for XHTML files."
337   :group 'org-export-html
338   :type 'string)
339
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)
348
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)
357
358 (defcustom org-export-html-preamble t
359   "Non-nil means insert a preamble in HTML export.
360
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.
367
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)")))
375
376 (defcustom org-export-html-preamble-format '(("en" ""))
377   "The format for the HTML preamble.
378
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.
383
384 If you need to use a \"%\" character, you need to escape it
385 like that: \"%%\"."
386   :group 'org-export-html
387   :type 'string)
388
389 (defcustom org-export-html-postamble 'auto
390   "Non-nil means insert a postamble in HTML export.
391
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.
400
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)")))
409
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>
415 "))
416   "The format for the HTML postamble.
417
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'.
423
424 If you need to use a \"%\" character, you need to escape it
425 like that: \"%%\"."
426   :group 'org-export-html
427   :type 'string)
428
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>
432  |
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)
442
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)
453
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)
465
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)))
476
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")))
482
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)
490
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")))
500
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")))
509
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
518
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>\"))
526
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))))
536
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)
544
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)
550
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)
556
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.")
561
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.")
566
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"))))
575
576 (defgroup org-export-htmlize nil
577   "Options for processing examples with htmlize.el."
578   :tag "Org Export Htmlize"
579   :group 'org-export-html)
580
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.
586
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)))
599
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)
604
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")))
618
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.
624
625 This variable is obsolete since Org version 7.7.
626 Please set `org-export-html-divs' instead.")
627
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:")))
638
639 ;;; Hooks
640
641 (defvar org-export-html-after-blockquotes-hook nil
642   "Hook run during HTML export, after blockquote, verse, center are done.")
643
644 (defvar org-export-html-final-hook nil
645   "Hook run at the end of HTML export, in the new buffer.")
646
647 ;;; HTML export
648
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)))))
675
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))))
687
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))
697
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*")))
706
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)))
730
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:
741
742   (setq html (org-export-region-as-html beg end t 'string))
743
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)))
762
763 (defvar html-table-tag nil) ; dynamically scoped into this.
764 (defvar org-par-open nil)
765
766 ;;; org-html-cvt-link-fn
767 (defconst org-html-cvt-link-fn
768    nil
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'." )
774
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'"
779
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))
790                   "."
791                   (plist-get opt-plist :html-extension)))))))
792
793
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)))
808
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."
820
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))))
838
839                ;;Second pass.  Components converted so they can refer
840                ;;to a remote site.
841                (components-2
842                   (or
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)))
851
852
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))))
864
865             (t))
866
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)))
875
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>")))))
887
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
935                  ""
936                  ""
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)))
972
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))))
989
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))))
995
996        ((string= type "file")
997         ;; FILE link
998         (save-match-data
999           (let*
1000               ((components
1001                 (if
1002                     (string-match "::\\(.*\\)" path)
1003                     (list
1004                      (replace-match "" t nil path)
1005                      (match-string 1 path))
1006                   (list path nil)))
1007
1008                ;;The proper path, without a fragment
1009                (path-1
1010                 (first components))
1011
1012                ;;The raw fragment
1013                (fragment-0
1014                 (second components))
1015
1016                ;;Check the fragment.  If it can't be used as
1017                ;;target fragment we'll pass nil instead.
1018                (fragment-1
1019                 (if
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)))
1036
1037             (setq rpl
1038                   (if
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)))))))
1046
1047        (t
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))
1055
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)
1076
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")))
1085
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)
1112               nil
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)))
1123                          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 "^[ \t]*" org-quote-string "\\>"))
1179          (quote-re    (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string "\\>\\)"))
1180          (inquote     nil)
1181          (infixed     nil)
1182          (inverse     nil)
1183          (email       (plist-get opt-plist :email))
1184          (language    (plist-get opt-plist :language))
1185          (keywords    (plist-get opt-plist :keywords))
1186          (description (plist-get opt-plist :description))
1187          (num         (plist-get opt-plist :section-numbers))
1188          (lang-words  nil)
1189          (head-count  0) cnt
1190          (start       0)
1191          (coding-system (and (boundp 'buffer-file-coding-system)
1192                              buffer-file-coding-system))
1193          (coding-system-for-write (or org-export-html-coding-system
1194                                       coding-system))
1195          (save-buffer-coding-system (or org-export-html-coding-system
1196                                         coding-system))
1197          (charset (and coding-system-for-write
1198                        (fboundp 'coding-system-get)
1199                        (coding-system-get coding-system-for-write
1200                                           'mime-charset)))
1201          (region
1202           (buffer-substring
1203            (if region-p (region-beginning) (point-min))
1204            (if region-p (region-end) (point-max))))
1205          (org-export-have-math nil)
1206          (org-export-footnotes-seen nil)
1207          (org-export-footnotes-data (org-footnote-all-labels 'with-defs))
1208          (lines
1209           (org-split-string
1210            (org-export-preprocess-string
1211             region
1212             :emph-multiline t
1213             :for-backend 'html
1214             :skip-before-1st-heading
1215             (plist-get opt-plist :skip-before-1st-heading)
1216             :drawers (plist-get opt-plist :drawers)
1217             :todo-keywords (plist-get opt-plist :todo-keywords)
1218             :tasks (plist-get opt-plist :tasks)
1219             :tags (plist-get opt-plist :tags)
1220             :priority (plist-get opt-plist :priority)
1221             :footnotes (plist-get opt-plist :footnotes)
1222             :timestamps (plist-get opt-plist :timestamps)
1223             :archived-trees
1224             (plist-get opt-plist :archived-trees)
1225             :select-tags (plist-get opt-plist :select-tags)
1226             :exclude-tags (plist-get opt-plist :exclude-tags)
1227             :add-text
1228             (plist-get opt-plist :text)
1229             :LaTeX-fragments
1230             (plist-get opt-plist :LaTeX-fragments))
1231            "[\r\n]"))
1232          (mathjax
1233           (if (or (eq (plist-get opt-plist :LaTeX-fragments) 'mathjax)
1234                   (and org-export-have-math
1235                        (eq (plist-get opt-plist :LaTeX-fragments) t)))
1236
1237               (org-export-html-mathjax-config
1238                org-export-html-mathjax-template
1239                org-export-html-mathjax-options
1240                (or (plist-get opt-plist :mathjax) ""))
1241             ""))
1242          table-open
1243          table-buffer table-orig-buffer
1244          ind
1245          rpl path attr desc descp desc1 desc2 link
1246          snumber fnc
1247          footnotes footref-seen
1248          href
1249          )
1250
1251     (let ((inhibit-read-only t))
1252       (org-unmodified
1253        (remove-text-properties (point-min) (point-max)
1254                                '(:org-license-to-kill t))))
1255
1256     (message "Exporting...")
1257
1258     (setq org-min-level (org-get-min-level lines level-offset))
1259     (setq org-last-level org-min-level)
1260     (org-init-section-numbers)
1261
1262     (cond
1263      ((and date (string-match "%" date))
1264       (setq date (format-time-string date)))
1265      (date)
1266      (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
1267
1268     ;; Get the language-dependent settings
1269     (setq lang-words (or (assoc language org-export-language-setup)
1270                          (assoc "en" org-export-language-setup)))
1271
1272     ;; Switch to the output buffer
1273     (set-buffer buffer)
1274     (let ((inhibit-read-only t)) (erase-buffer))
1275     (fundamental-mode)
1276     (org-install-letbind)
1277
1278     (and (fboundp 'set-buffer-file-coding-system)
1279          (set-buffer-file-coding-system coding-system-for-write))
1280
1281     (let ((case-fold-search nil)
1282           (org-odd-levels-only odd))
1283       ;; create local variables for all options, to make sure all called
1284       ;; functions get the correct information
1285       (mapc (lambda (x)
1286               (set (make-local-variable (nth 2 x))
1287                    (plist-get opt-plist (car x))))
1288             org-export-plist-vars)
1289       (setq umax (if arg (prefix-numeric-value arg)
1290                    org-export-headline-levels))
1291       (setq umax-toc (if (integerp org-export-with-toc)
1292                          (min org-export-with-toc umax)
1293                        umax))
1294       (unless body-only
1295         ;; File header
1296         (insert (format
1297                  "%s
1298 <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
1299                \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
1300 <html xmlns=\"http://www.w3.org/1999/xhtml\"
1301 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=\"generator\" content=\"Org-mode\"/>
1306 <meta name=\"generated\" content=\"%s\"/>
1307 <meta name=\"author\" content=\"%s\"/>
1308 <meta name=\"description\" content=\"%s\"/>
1309 <meta name=\"keywords\" content=\"%s\"/>
1310 %s
1311 %s
1312 </head>
1313 <body>
1314 %s
1315 "
1316                  (format
1317                   (or (and (stringp org-export-html-xml-declaration)
1318                            org-export-html-xml-declaration)
1319                       (cdr (assoc html-extension org-export-html-xml-declaration))
1320                       (cdr (assoc "html" org-export-html-xml-declaration))
1321
1322                       "")
1323                   (or charset "iso-8859-1"))
1324                  language language
1325                  title
1326                  (or charset "iso-8859-1")
1327                  date author description keywords
1328                  style
1329                  mathjax
1330                  (if (or link-up link-home)
1331                      (concat
1332                       (format org-export-html-home/up-format
1333                               (or link-up link-home)
1334                               (or link-home link-up))
1335                       "\n")
1336                    "")))
1337
1338         ;; insert html preamble
1339         (when (plist-get opt-plist :html-preamble)
1340           (let ((html-pre (plist-get opt-plist :html-preamble)))
1341             (insert "<div id=\"" (nth 0 org-export-html-divs) "\">\n")
1342             (cond ((stringp html-pre)
1343                    (insert
1344                     (format-spec html-pre `((?t . ,title) (?a . ,author)
1345                                             (?d . ,date) (?e . ,email)))))
1346                   ((functionp html-pre)
1347                    (funcall html-pre))
1348                   (t
1349                    (insert
1350                     (format-spec
1351                      (or (cadr (assoc (nth 0 lang-words)
1352                                       org-export-html-preamble-format))
1353                          (cadr (assoc "en" org-export-html-preamble-format)))
1354                      `((?t . ,title) (?a . ,author)
1355                        (?d . ,date) (?e . ,email))))))
1356             (insert "\n</div>\n")))
1357
1358         ;; begin wrap around body
1359         (insert (format "\n<div id=\"%s\">"
1360                         ;; FIXME org-export-html-content-div is obsolete since 7.7
1361                         (or org-export-html-content-div
1362                             (nth 1 org-export-html-divs)))
1363                 ;; FIXME this should go in the preamble but is here so
1364                 ;; that org-infojs can still find it
1365                 "\n<h1 class=\"title\">" title "</h1>\n"))
1366
1367       ;; insert body
1368       (if (and org-export-with-toc (not body-only))
1369           (progn
1370             (push (format "<h%d>%s</h%d>\n"
1371                           org-export-html-toplevel-hlevel
1372                           (nth 3 lang-words)
1373                           org-export-html-toplevel-hlevel)
1374                   thetoc)
1375             (push "<div id=\"text-table-of-contents\">\n" thetoc)
1376             (push "<ul>\n<li>" thetoc)
1377             (setq lines
1378                   (mapcar
1379                    #'(lambda (line)
1380                        (if (and (string-match org-todo-line-regexp line)
1381                                 (not (get-text-property 0 'org-protected line)))
1382                            ;; This is a headline
1383                            (progn
1384                              (setq have-headings t)
1385                              (setq level (- (match-end 1) (match-beginning 1)
1386                                             level-offset)
1387                                    level (org-tr-level level)
1388                                    txt (save-match-data
1389                                          (org-html-expand
1390                                           (org-export-cleanup-toc-line
1391                                            (match-string 3 line))))
1392                                    todo
1393                                    (or (and org-export-mark-todo-in-toc
1394                                             (match-beginning 2)
1395                                             (not (member (match-string 2 line)
1396                                                          org-done-keywords)))
1397                                         ; TODO, not DONE
1398                                        (and org-export-mark-todo-in-toc
1399                                             (= level umax-toc)
1400                                             (org-search-todo-below
1401                                              line lines level))))
1402                              (if (string-match
1403                                   (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt)
1404                                  (setq txt (replace-match
1405                                             "&nbsp;&nbsp;&nbsp;<span class=\"tag\"> \\1</span>" t nil txt)))
1406                              (if (string-match quote-re0 txt)
1407                                  (setq txt (replace-match "" t t txt)))
1408                              (setq snumber (org-section-number level))
1409                              (if (and num (if (integerp num)
1410                                               (>= num level)
1411                                             num))
1412                                  (setq txt (concat snumber " " txt)))
1413                              (if (<= level (max umax umax-toc))
1414                                  (setq head-count (+ head-count 1)))
1415                              (if (<= level umax-toc)
1416                                  (progn
1417                                    (if (> level org-last-level)
1418                                        (progn
1419                                          (setq cnt (- level org-last-level))
1420                                          (while (>= (setq cnt (1- cnt)) 0)
1421                                            (push "\n<ul>\n<li>" thetoc))
1422                                          (push "\n" thetoc)))
1423                                    (if (< level org-last-level)
1424                                        (progn
1425                                          (setq cnt (- org-last-level level))
1426                                          (while (>= (setq cnt (1- cnt)) 0)
1427                                            (push "</li>\n</ul>" thetoc))
1428                                          (push "\n" thetoc)))
1429                                    ;; Check for targets
1430                                    (while (string-match org-any-target-regexp line)
1431                                      (setq line (replace-match
1432                                                  (concat "@<span class=\"target\">"
1433                                                          (match-string 1 line) "@</span> ")
1434                                                  t t line)))
1435                                    (while (string-match "&lt;\\(&lt;\\)+\\|&gt;\\(&gt;\\)+" txt)
1436                                      (setq txt (replace-match "" t t txt)))
1437                                    (setq href
1438                                          (replace-regexp-in-string
1439                                           "\\." "-" (format "sec-%s" snumber)))
1440                                    (setq href (org-solidify-link-text
1441                                                (or (cdr (assoc href
1442                                                                org-export-preferred-target-alist)) href)))
1443                                    (push
1444                                     (format
1445                                      (if todo
1446                                          "</li>\n<li><a href=\"#%s\"><span class=\"todo\">%s</span></a>"
1447                                        "</li>\n<li><a href=\"#%s\">%s</a>")
1448                                      href txt) thetoc)
1449
1450                                    (setq org-last-level level)))))
1451                        line)
1452                    lines))
1453             (while (> org-last-level (1- org-min-level))
1454               (setq org-last-level (1- org-last-level))
1455               (push "</li>\n</ul>\n" thetoc))
1456             (push "</div>\n" thetoc)
1457             (setq thetoc (if have-headings (nreverse thetoc) nil))))
1458
1459       (setq head-count 0)
1460       (org-init-section-numbers)
1461
1462       (org-open-par)
1463
1464       (while (setq line (pop lines) origline line)
1465         (catch 'nextline
1466
1467           ;; end of quote section?
1468           (when (and inquote (string-match org-outline-regexp-bol line))
1469             (insert "</pre>\n")
1470             (org-open-par)
1471             (setq inquote nil))
1472           ;; inside a quote section?
1473           (when inquote
1474             (insert (org-html-protect line) "\n")
1475             (throw 'nextline nil))
1476
1477           ;; Fixed-width, verbatim lines (examples)
1478           (when (and org-export-with-fixed-width
1479                      (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line))
1480             (when (not infixed)
1481               (setq infixed t)
1482               (org-close-par-maybe)
1483
1484               (insert "<pre class=\"example\">\n"))
1485             (insert (org-html-protect (match-string 3 line)) "\n")
1486             (when (or (not lines)
1487                       (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
1488                                          (car lines))))
1489               (setq infixed nil)
1490               (insert "</pre>\n")
1491               (org-open-par))
1492             (throw 'nextline nil))
1493
1494           ;; Protected HTML
1495           (when (and (get-text-property 0 'org-protected line)
1496                      ;; Make sure it is the entire line that is protected
1497                      (not (< (or (next-single-property-change
1498                                   0 'org-protected line) 10000)
1499                              (length line))))
1500             (let (par (ind (get-text-property 0 'original-indentation line)))
1501               (when (re-search-backward
1502                      "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t)
1503                 (setq par (match-string 1))
1504                 (replace-match "\\2\n"))
1505               (insert line "\n")
1506               (while (and lines
1507                           (or (= (length (car lines)) 0)
1508                               (not ind)
1509                               (equal ind (get-text-property 0 'original-indentation (car lines))))
1510                           (or (= (length (car lines)) 0)
1511                               (get-text-property 0 'org-protected (car lines))))
1512                 (insert (pop lines) "\n"))
1513               (and par (insert "<p>\n")))
1514             (throw 'nextline nil))
1515
1516           ;; Blockquotes, verse, and center
1517           (when (equal "ORG-BLOCKQUOTE-START" line)
1518             (org-close-par-maybe)
1519             (insert "<blockquote>\n")
1520             (org-open-par)
1521             (throw 'nextline nil))
1522           (when (equal "ORG-BLOCKQUOTE-END" line)
1523             (org-close-par-maybe)
1524             (insert "\n</blockquote>\n")
1525             (org-open-par)
1526             (throw 'nextline nil))
1527           (when (equal "ORG-VERSE-START" line)
1528             (org-close-par-maybe)
1529             (insert "\n<p class=\"verse\">\n")
1530             (setq org-par-open t)
1531             (setq inverse t)
1532             (throw 'nextline nil))
1533           (when (equal "ORG-VERSE-END" line)
1534             (insert "</p>\n")
1535             (setq org-par-open nil)
1536             (org-open-par)
1537             (setq inverse nil)
1538             (throw 'nextline nil))
1539           (when (equal "ORG-CENTER-START" line)
1540             (org-close-par-maybe)
1541             (insert "\n<div style=\"text-align: center\">")
1542             (org-open-par)
1543             (throw 'nextline nil))
1544           (when (equal "ORG-CENTER-END" line)
1545             (org-close-par-maybe)
1546             (insert "\n</div>")
1547             (org-open-par)
1548             (throw 'nextline nil))
1549           (run-hooks 'org-export-html-after-blockquotes-hook)
1550           (when inverse
1551             (let ((i (org-get-string-indentation line)))
1552               (if (> i 0)
1553                   (setq line (concat (mapconcat 'identity
1554                                                 (make-list (* 2 i) "\\nbsp") "")
1555                                      " " (org-trim line))))
1556               (unless (string-match "\\\\\\\\[ \t]*$" line)
1557                 (setq line (concat line "\\\\")))))
1558
1559           ;; make targets to anchors
1560           (setq start 0)
1561           (while (string-match
1562                   "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start)
1563             (cond
1564              ((get-text-property (match-beginning 1) 'org-protected line)
1565               (setq start (match-end 1)))
1566              ((match-end 2)
1567               (setq line (replace-match
1568                           (format
1569                            "@<a name=\"%s\" id=\"%s\">@</a>"
1570                            (org-solidify-link-text (match-string 1 line))
1571                            (org-solidify-link-text (match-string 1 line)))
1572                           t t line)))
1573              ((and org-export-with-toc (equal (string-to-char line) ?*))
1574               ;; FIXME: NOT DEPENDENT on TOC?????????????????????
1575               (setq line (replace-match
1576                           (concat "@<span class=\"target\">"
1577                                   (match-string 1 line) "@</span> ")
1578                           ;; (concat "@<i>" (match-string 1 line) "@</i> ")
1579                           t t line)))
1580              (t
1581               (setq line (replace-match
1582                           (concat "@<a name=\""
1583                                   (org-solidify-link-text (match-string 1 line))
1584                                   "\" class=\"target\">" (match-string 1 line)
1585                                   "@</a> ")
1586                           t t line)))))
1587
1588           (setq line (org-html-handle-time-stamps line))
1589
1590           ;; replace "&" by "&amp;", "<" and ">" by "&lt;" and "&gt;"
1591           ;; handle @<..> HTML tags (replace "@&gt;..&lt;" by "<..>")
1592           ;; Also handle sub_superscripts and checkboxes
1593           (or (string-match org-table-hline-regexp line)
1594               (string-match "^[ \t]*\\([+]-\\||[ ]\\)[-+ |]*[+|][ \t]*$" line)
1595               (setq line (org-html-expand line)))
1596
1597           ;; Format the links
1598           (setq line (org-html-handle-links line opt-plist))
1599
1600           ;; TODO items
1601           (if (and org-todo-line-regexp
1602                    (string-match org-todo-line-regexp line)
1603                    (match-beginning 2))
1604
1605               (setq line
1606                     (concat (substring line 0 (match-beginning 2))
1607                             "<span class=\""
1608                             (if (member (match-string 2 line)
1609                                         org-done-keywords)
1610                                 "done" "todo")
1611                             " " (match-string 2 line)
1612                             "\"> " (org-export-html-get-todo-kwd-class-name
1613                                     (match-string 2 line))
1614                             "</span>" (substring line (match-end 2)))))
1615
1616           ;; Does this contain a reference to a footnote?
1617           (when org-export-with-footnotes
1618             (setq start 0)
1619             (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start)
1620               ;; Discard protected matches not clearly identified as
1621               ;; footnote markers.
1622               (if (or (get-text-property (match-beginning 2) 'org-protected line)
1623                       (not (get-text-property (match-beginning 2) 'org-footnote line)))
1624                   (setq start (match-end 2))
1625                 (let ((n (match-string 2 line)) extra a)
1626                   (if (setq a (assoc n footref-seen))
1627                       (progn
1628                         (setcdr a (1+ (cdr a)))
1629                         (setq extra (format ".%d" (cdr a))))
1630                     (setq extra "")
1631                     (push (cons n 1) footref-seen))
1632                   (setq line
1633                         (replace-match
1634                          (concat
1635                           (format
1636                            (concat "%s"
1637                                    (format org-export-html-footnote-format
1638                                            (concat "<a class=\"footref\" name=\"fnr.%s%s\" href=\"#fn.%s\">%s</a>")))
1639                            (or (match-string 1 line) "") n extra n n)
1640                           ;; If another footnote is following the
1641                           ;; current one, add a separator.
1642                           (if (save-match-data
1643                                 (string-match "\\`\\[[0-9]+\\]"
1644                                               (substring line (match-end 0))))
1645                               org-export-html-footnote-separator
1646                             ""))
1647                          t t line))))))
1648
1649           (cond
1650            ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
1651             ;; This is a headline
1652             (setq level (org-tr-level (- (match-end 1) (match-beginning 1)
1653                                          level-offset))
1654                   txt (match-string 2 line))
1655             (if (string-match quote-re0 txt)
1656                 (setq txt (replace-match "" t t txt)))
1657             (if (<= level (max umax umax-toc))
1658                 (setq head-count (+ head-count 1)))
1659             (setq first-heading-pos (or first-heading-pos (point)))
1660             (org-html-level-start level txt umax
1661                                   (and org-export-with-toc (<= level umax))
1662                                   head-count opt-plist)
1663
1664             ;; QUOTES
1665             (when (string-match quote-re line)
1666               (org-close-par-maybe)
1667               (insert "<pre>")
1668               (setq inquote t)))
1669
1670            ((and org-export-with-tables
1671                  (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
1672             (when (not table-open)
1673               ;; New table starts
1674               (setq table-open t table-buffer nil table-orig-buffer nil))
1675
1676             ;; Accumulate lines
1677             (setq table-buffer (cons line table-buffer)
1678                   table-orig-buffer (cons origline table-orig-buffer))
1679             (when (or (not lines)
1680                       (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
1681                                          (car lines))))
1682               (setq table-open nil
1683                     table-buffer (nreverse table-buffer)
1684                     table-orig-buffer (nreverse table-orig-buffer))
1685               (org-close-par-maybe)
1686               (insert (org-format-table-html table-buffer table-orig-buffer))))
1687
1688            ;; Normal lines
1689
1690            (t
1691             ;; This line either is list item or end a list.
1692             (when (get-text-property 0 'list-item line)
1693               (setq line (org-html-export-list-line
1694                           line
1695                           (get-text-property 0 'list-item line)
1696                           (get-text-property 0 'list-struct line)
1697                           (get-text-property 0 'list-prevs line))))
1698
1699             ;; Horizontal line
1700             (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line)
1701               (if org-par-open
1702                   (insert "\n</p>\n<hr/>\n<p>\n")
1703                 (insert "\n<hr/>\n"))
1704               (throw 'nextline nil))
1705
1706             ;; Empty lines start a new paragraph.  If hand-formatted lists
1707             ;; are not fully interpreted, lines starting with "-", "+", "*"
1708             ;; also start a new paragraph.
1709             (if (string-match "^ [-+*]-\\|^[ \t]*$" line) (org-open-par))
1710
1711             ;; Is this the start of a footnote?
1712             (when org-export-with-footnotes
1713               (when (and (boundp 'footnote-section-tag-regexp)
1714                          (string-match (concat "^" footnote-section-tag-regexp)
1715                                        line))
1716                 ;; ignore this line
1717                 (throw 'nextline nil))
1718               (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line)
1719                 (org-close-par-maybe)
1720                 (let ((n (match-string 1 line)))
1721                   (setq org-par-open t
1722                         line (replace-match
1723                               (format
1724                                (concat "<p class=\"footnote\">"
1725                                        (format org-export-html-footnote-format
1726                                                "<a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a>"))
1727                                n n n) t t line)))))
1728             ;; Check if the line break needs to be conserved
1729             (cond
1730              ((string-match "\\\\\\\\[ \t]*$" line)
1731               (setq line (replace-match "<br/>" t t line)))
1732              (org-export-preserve-breaks
1733               (setq line (concat line "<br/>"))))
1734
1735             ;; Check if a paragraph should be started
1736             (let ((start 0))
1737               (while (and org-par-open
1738                           (string-match "\\\\par\\>" line start))
1739                 ;; Leave a space in the </p> so that the footnote matcher
1740                 ;; does not see this.
1741                 (if (not (get-text-property (match-beginning 0)
1742                                             'org-protected line))
1743                     (setq line (replace-match "</p ><p >" t t line)))
1744                 (setq start (match-end 0))))
1745
1746             (insert line "\n")))))
1747
1748       ;; Properly close all local lists and other lists
1749       (when inquote
1750         (insert "</pre>\n")
1751         (org-open-par))
1752
1753       (org-html-level-start 1 nil umax
1754                             (and org-export-with-toc (<= level umax))
1755                             head-count opt-plist)
1756       ;; the </div> to close the last text-... div.
1757       (when (and (> umax 0) first-heading-pos) (insert "</div>\n"))
1758
1759       (save-excursion
1760         (goto-char (point-min))
1761         (while (re-search-forward
1762                 "\\(\\(<p class=\"footnote\">\\)[^\000]*?\\)\\(\\(\\2\\)\\|\\'\\)"
1763                 nil t)
1764           (push (match-string 1) footnotes)
1765           (replace-match "\\4" t nil)
1766           (goto-char (match-beginning 0))))
1767       (when footnotes
1768         (insert (format org-export-html-footnotes-section
1769                         (nth 4 lang-words)
1770                         (mapconcat 'identity (nreverse footnotes) "\n"))
1771                 "\n"))
1772       (let ((bib (org-export-html-get-bibliography)))
1773         (when bib
1774           (insert "\n" bib "\n")))
1775
1776       (unless body-only
1777         ;; end wrap around body
1778         (insert "</div>\n")
1779
1780         ;; export html postamble
1781         (let ((html-post (plist-get opt-plist :html-postamble))
1782               (email
1783                (mapconcat (lambda(e)
1784                             (format "<a href=\"mailto:%s\">%s</a>" e e))
1785                           (split-string email ",+ *")
1786                           ", "))
1787               (creator-info
1788                (concat "Org version " org-version " with Emacs version "
1789                        (number-to-string emacs-major-version))))
1790
1791           (when (plist-get opt-plist :html-postamble)
1792             (insert "\n<div id=\"" (nth 2 org-export-html-divs) "\">\n")
1793             (cond ((stringp html-post)
1794                    (insert (format-spec html-post
1795                                         `((?a . ,author) (?e . ,email)
1796                                           (?d . ,date)   (?c . ,creator-info)
1797                                           (?v . ,html-validation-link)))))
1798                   ((functionp html-post)
1799                    (funcall html-post))
1800                   ((eq html-post 'auto)
1801                    ;; fall back on default postamble
1802                    (when (plist-get opt-plist :time-stamp-file)
1803                      (insert "<p class=\"date\">" (nth 2 lang-words) ": " date "</p>\n"))
1804                    (when (and (plist-get opt-plist :author-info) author)
1805                        (insert "<p class=\"author\">" (nth 1 lang-words) ": " author "</p>\n"))
1806                    (when (and (plist-get opt-plist :email-info) email)
1807                      (insert "<p class=\"email\">" email "</p>\n"))
1808                    (when (plist-get opt-plist :creator-info)
1809                      (insert "<p class=\"creator\">"
1810                              (concat "Org version " org-version " with Emacs version "
1811                                      (number-to-string emacs-major-version) "</p>\n")))
1812                    (insert html-validation-link "\n"))
1813                   (t
1814                    (insert (format-spec
1815                             (or (cadr (assoc (nth 0 lang-words)
1816                                              org-export-html-postamble-format))
1817                                 (cadr (assoc "en" org-export-html-postamble-format)))
1818                             `((?a . ,author) (?e . ,email)
1819                               (?d . ,date)   (?c . ,creator-info)
1820                               (?v . ,html-validation-link))))))
1821             (insert "\n</div>"))))
1822
1823       ;; FIXME `org-export-html-with-timestamp' has been declared
1824       ;; obsolete since Org 7.7 -- don't forget to remove this.
1825       (if org-export-html-with-timestamp
1826           (insert org-export-html-html-helper-timestamp))
1827
1828       (unless body-only (insert "\n</body>\n</html>\n"))
1829
1830       (unless (plist-get opt-plist :buffer-will-be-killed)
1831         (normal-mode)
1832         (if (eq major-mode (default-value 'major-mode))
1833             (html-mode)))
1834
1835       ;; insert the table of contents
1836       (goto-char (point-min))
1837       (when thetoc
1838         (if (or (re-search-forward
1839                  "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t)
1840                 (re-search-forward
1841                  "\\[TABLE-OF-CONTENTS\\]" nil t))
1842             (progn
1843               (goto-char (match-beginning 0))
1844               (replace-match ""))
1845           (goto-char first-heading-pos)
1846           (when (looking-at "\\s-*</p>")
1847             (goto-char (match-end 0))
1848             (insert "\n")))
1849         (insert "<div id=\"table-of-contents\">\n")
1850         (let ((beg (point)))
1851           (mapc 'insert thetoc)
1852           (insert "</div>\n")
1853           (while (re-search-backward "<li>[ \r\n\t]*</li>\n?" beg t)
1854             (replace-match ""))))
1855       ;; remove empty paragraphs
1856       (goto-char (point-min))
1857       (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t)
1858         (replace-match ""))
1859       (goto-char (point-min))
1860       ;; Convert whitespace place holders
1861       (goto-char (point-min))
1862       (let (beg end n)
1863         (while (setq beg (next-single-property-change (point) 'org-whitespace))
1864           (setq n (get-text-property beg 'org-whitespace)
1865                 end (next-single-property-change beg 'org-whitespace))
1866           (goto-char beg)
1867           (delete-region beg end)
1868           (insert (format "<span style=\"visibility:hidden;\">%s</span>"
1869                           (make-string n ?x)))))
1870       ;; Remove empty lines at the beginning of the file.
1871       (goto-char (point-min))
1872       (when (looking-at "\\s-+\n") (replace-match ""))
1873       ;; Remove display properties
1874       (remove-text-properties (point-min) (point-max) '(display t))
1875       ;; Run the hook
1876       (run-hooks 'org-export-html-final-hook)
1877       (or to-buffer (save-buffer))
1878       (goto-char (point-min))
1879       (or (org-export-push-to-kill-ring "HTML")
1880           (message "Exporting... done"))
1881       (if (eq to-buffer 'string)
1882           (prog1 (buffer-substring (point-min) (point-max))
1883             (kill-buffer (current-buffer)))
1884         (current-buffer)))))
1885
1886 (defun org-export-html-format-href (s)
1887   "Make sure the S is valid as a href reference in an XHTML document."
1888   (save-match-data
1889     (let ((start 0))
1890       (while (string-match "&" s start)
1891         (setq start (+ (match-beginning 0) 3)
1892               s (replace-match "&amp;" t t s)))))
1893   s)
1894
1895 (defun org-export-html-format-desc (s)
1896   "Make sure the S is valid as a description in a link."
1897   (if (and s (not (get-text-property 1 'org-protected s)))
1898       (save-match-data
1899         (org-html-do-expand s))
1900     s))
1901
1902 (defun org-export-html-format-image (src par-open)
1903   "Create image tag with source and attributes."
1904   (save-match-data
1905     (if (string-match "^ltxpng/" src)
1906         (format "<img src=\"%s\" alt=\"%s\"/>"
1907                 src (org-find-text-property-in-string 'org-latex-src src))
1908       (let* ((caption (org-find-text-property-in-string 'org-caption src))
1909              (attr (org-find-text-property-in-string 'org-attributes src))
1910              (label (org-find-text-property-in-string 'org-label src)))
1911         (setq caption (and caption (org-html-do-expand caption)))
1912         (concat
1913         (if caption
1914             (format "%s<div %sclass=\"figure\">
1915 <p>"
1916                     (if org-par-open "</p>\n" "")
1917                     (if label (format "id=\"%s\" " (org-solidify-link-text label)) "")))
1918         (format "<img src=\"%s\"%s />"
1919                 src
1920                 (if (string-match "\\<alt=" (or attr ""))
1921                     (concat " " attr )
1922                   (concat " " attr " alt=\"" src "\"")))
1923         (if caption
1924             (format "</p>%s
1925 </div>%s"
1926                 (concat "\n<p>" caption "</p>")
1927                 (if org-par-open "\n<p>" ""))))))))
1928
1929 (defun org-export-html-get-bibliography ()
1930   "Find bibliography, cut it out and return it."
1931   (catch 'exit
1932     (let (beg end (cnt 1) bib)
1933       (save-excursion
1934         (goto-char (point-min))
1935         (when (re-search-forward "^[ \t]*<div \\(id\\|class\\)=\"bibliography\"" nil t)
1936           (setq beg (match-beginning 0))
1937           (while (re-search-forward "</?div\\>" nil t)
1938             (setq cnt (+ cnt (if (string= (match-string 0) "<div") +1 -1)))
1939             (when (= cnt 0)
1940               (and (looking-at ">") (forward-char 1))
1941               (setq bib (buffer-substring beg (point)))
1942               (delete-region beg (point))
1943             (throw 'exit bib))))
1944         nil))))
1945
1946 (defvar org-table-number-regexp) ; defined in org-table.el
1947 (defun org-format-table-html (lines olines &optional no-css)
1948   "Find out which HTML converter to use and return the HTML code.
1949 NO-CSS is passed to the exporter."
1950   (if (stringp lines)
1951       (setq lines (org-split-string lines "\n")))
1952   (if (string-match "^[ \t]*|" (car lines))
1953       ;; A normal org table
1954       (org-format-org-table-html lines nil no-css)
1955     ;; Table made by table.el
1956     (or (org-format-table-table-html-using-table-generate-source
1957          olines (not org-export-prefer-native-exporter-for-tables))
1958         ;; We are here only when table.el table has NO col or row
1959         ;; spanning and the user prefers using org's own converter for
1960         ;; exporting of such simple table.el tables.
1961         (org-format-table-table-html lines))))
1962
1963 (defvar org-table-number-fraction) ; defined in org-table.el
1964 (defun org-format-org-table-html (lines &optional splice no-css)
1965   "Format a table into HTML.
1966 LINES is a list of lines.  Optional argument SPLICE means, do not
1967 insert header and surrounding <table> tags, just format the lines.
1968 Optional argument NO-CSS means use XHTML attributes instead of CSS
1969 for formatting.  This is required for the DocBook exporter."
1970   (require 'org-table)
1971   ;; Get rid of hlines at beginning and end
1972   (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
1973   (setq lines (nreverse lines))
1974   (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
1975   (setq lines (nreverse lines))
1976   (when org-export-table-remove-special-lines
1977     ;; Check if the table has a marking column.  If yes remove the
1978     ;; column and the special lines
1979     (setq lines (org-table-clean-before-export lines)))
1980
1981   (let* ((caption (org-find-text-property-in-string 'org-caption (car lines)))
1982          (label (org-find-text-property-in-string 'org-label (car lines)))
1983          (col-cookies (org-find-text-property-in-string 'org-col-cookies
1984                                                         (car lines)))
1985          (attributes (org-find-text-property-in-string 'org-attributes
1986                                                        (car lines)))
1987          (html-table-tag (org-export-splice-attributes
1988                           html-table-tag attributes))
1989          (head (and org-export-highlight-first-table-line
1990                     (delq nil (mapcar
1991                                (lambda (x) (string-match "^[ \t]*|-" x))
1992                                (cdr lines)))))
1993          (nline 0) fnum nfields i (cnt 0)
1994          tbopen line fields html gr colgropen rowstart rowend
1995          ali align aligns n)
1996     (setq caption (and caption (org-html-do-expand caption)))
1997     (when (and col-cookies org-table-clean-did-remove-column)
1998       (setq col-cookies
1999             (mapcar (lambda (x) (cons (1- (car x)) (cdr x))) col-cookies)))
2000     (if splice (setq head nil))
2001     (unless splice (push (if head "<thead>" "<tbody>") html))
2002     (setq tbopen t)
2003     (while (setq line (pop lines))
2004       (catch 'next-line
2005         (if (string-match "^[ \t]*|-" line)
2006             (progn
2007               (unless splice
2008                 (push (if head "</thead>" "</tbody>") html)
2009                 (if lines (push "<tbody>" html) (setq tbopen nil)))
2010               (setq head nil)   ;; head ends here, first time around
2011               ;; ignore this line
2012               (throw 'next-line t)))
2013         ;; Break the line into fields
2014         (setq fields (org-split-string line "[ \t]*|[ \t]*"))
2015         (unless fnum (setq fnum (make-vector (length fields) 0)
2016                            nfields (length fnum)))
2017         (setq nline (1+ nline) i -1
2018               rowstart (eval (car org-export-table-row-tags))
2019               rowend (eval (cdr org-export-table-row-tags)))
2020         (push (concat rowstart
2021                       (mapconcat
2022                        (lambda (x)
2023                          (setq i (1+ i) ali (format "@@class%03d@@" i))
2024                          (if (and (< i nfields) ; make sure no rogue line causes an error here
2025                                   (string-match org-table-number-regexp x))
2026                              (incf (aref fnum i)))
2027                          (cond
2028                           (head
2029                            (concat
2030                             (format (car org-export-table-header-tags)
2031                                     "col" ali)
2032                             x
2033                             (cdr org-export-table-header-tags)))
2034                           ((and (= i 0) org-export-html-table-use-header-tags-for-first-column)
2035                            (concat
2036                             (format (car org-export-table-header-tags)
2037                                     "row" ali)
2038                             x
2039                             (cdr org-export-table-header-tags)))
2040                           (t
2041                            (concat (format (car org-export-table-data-tags) ali)
2042                                    x
2043                                    (cdr org-export-table-data-tags)))))
2044                        fields "")
2045                       rowend)
2046               html)))
2047     (unless splice (if tbopen (push "</tbody>" html)))
2048     (unless splice (push "</table>\n" html))
2049     (setq html (nreverse html))
2050     (unless splice
2051       ;; Put in col tags with the alignment (unfortunately often ignored...)
2052       (unless (car org-table-colgroup-info)
2053         (setq org-table-colgroup-info
2054               (cons :start (cdr org-table-colgroup-info))))
2055       (setq i 0)
2056       (push (mapconcat
2057              (lambda (x)
2058                (setq gr (pop org-table-colgroup-info)
2059                      i (1+ i)
2060                      align (if (nth 1 (assoc i col-cookies))
2061                                (cdr (assoc (nth 1 (assoc i col-cookies))
2062                                            '(("l" . "left") ("r" . "right")
2063                                              ("c" . "center"))))
2064                              (if (> (/ (float x) nline)
2065                                     org-table-number-fraction)
2066                                  "right" "left")))
2067                (push align aligns)
2068                (format (if no-css
2069                            "%s<col align=\"%s\" />%s"
2070                          "%s<col class=\"%s\" />%s")
2071                        (if (memq gr '(:start :startend))
2072                            (prog1
2073                                (if colgropen
2074                                    "</colgroup>\n<colgroup>"
2075                                  "<colgroup>")
2076                              (setq colgropen t))
2077                          "")
2078                        align
2079                        (if (memq gr '(:end :startend))
2080                            (progn (setq colgropen nil) "</colgroup>")
2081                          "")))
2082              fnum "")
2083             html)
2084       (setq aligns (nreverse aligns))
2085       (if colgropen (setq html (cons (car html)
2086                                      (cons "</colgroup>" (cdr html)))))
2087       ;; Since the output of HTML table formatter can also be used in
2088       ;; DocBook document, we want to always include the caption to make
2089       ;; DocBook XML file valid.
2090       (push (format "<caption>%s</caption>" (or caption "")) html)
2091       (when label
2092               (setq html-table-tag (org-export-splice-attributes html-table-tag (format "id=\"%s\"" (org-solidify-link-text label)))))
2093       (push html-table-tag html))
2094     (setq html (mapcar
2095                 (lambda (x)
2096                   (replace-regexp-in-string
2097                    "@@class\\([0-9]+\\)@@"
2098                    (lambda (txt)
2099                      (if (not org-export-html-table-align-individual-fields)
2100                          ""
2101                        (setq n (string-to-number (match-string 1 txt)))
2102                        (format (if no-css " align=\"%s\"" " class=\"%s\"")
2103                                (or (nth n aligns) "left"))))
2104                    x))
2105                 html))
2106     (concat (mapconcat 'identity html "\n") "\n")))
2107
2108 (defun org-export-splice-attributes (tag attributes)
2109   "Read attributes in string ATTRIBUTES, add and replace in HTML tag TAG."
2110   (if (not attributes)
2111       tag
2112     (let (oldatt newatt)
2113       (setq oldatt (org-extract-attributes-from-string tag)
2114             tag (pop oldatt)
2115             newatt (cdr (org-extract-attributes-from-string attributes)))
2116       (while newatt
2117         (setq oldatt (plist-put oldatt (pop newatt) (pop newatt))))
2118       (if (string-match ">" tag)
2119           (setq tag
2120                 (replace-match (concat (org-attributes-to-string oldatt) ">")
2121                                t t tag)))
2122       tag)))
2123
2124 (defun org-format-table-table-html (lines)
2125   "Format a table generated by table.el into HTML.
2126 This conversion does *not* use `table-generate-source' from table.el.
2127 This has the advantage that Org-mode's HTML conversions can be used.
2128 But it has the disadvantage, that no cell- or row-spanning is allowed."
2129   (let (line field-buffer
2130              (head org-export-highlight-first-table-line)
2131              fields html empty i)
2132     (setq html (concat html-table-tag "\n"))
2133     (while (setq line (pop lines))
2134       (setq empty "&nbsp;")
2135       (catch 'next-line
2136         (if (string-match "^[ \t]*\\+-" line)
2137             (progn
2138               (if field-buffer
2139                   (progn
2140                     (setq
2141                      html
2142                      (concat
2143                       html
2144                       "<tr>"
2145                       (mapconcat
2146                        (lambda (x)
2147                          (if (equal x "") (setq x empty))
2148                          (if head
2149                              (concat
2150                               (format (car org-export-table-header-tags) "col" "")
2151                               x
2152                               (cdr org-export-table-header-tags))
2153                            (concat (format (car org-export-table-data-tags) "") x
2154                                    (cdr org-export-table-data-tags))))
2155                        field-buffer "\n")
2156                       "</tr>\n"))
2157                     (setq head nil)
2158                     (setq field-buffer nil)))
2159               ;; Ignore this line
2160               (throw 'next-line t)))
2161         ;; Break the line into fields and store the fields
2162         (setq fields (org-split-string line "[ \t]*|[ \t]*"))
2163         (if field-buffer
2164             (setq field-buffer (mapcar
2165                                 (lambda (x)
2166                                   (concat x "<br/>" (pop fields)))
2167                                 field-buffer))
2168           (setq field-buffer fields))))
2169     (setq html (concat html "</table>\n"))
2170     html))
2171
2172 (defun org-format-table-table-html-using-table-generate-source (lines
2173                                                                 &optional
2174                                                                 spanned-only)
2175   "Format a table into html, using `table-generate-source' from table.el.
2176 Use SPANNED-ONLY to suppress exporting of simple table.el tables.
2177
2178 When SPANNED-ONLY is nil, all table.el tables are exported.  When
2179 SPANNED-ONLY is non-nil, only tables with either row or column
2180 spans are exported.
2181
2182 This routine returns the generated source or nil as appropriate.
2183
2184 Refer docstring of `org-export-prefer-native-exporter-for-tables'
2185 for further information."
2186   (require 'table)
2187   (with-current-buffer (get-buffer-create " org-tmp1 ")
2188     (erase-buffer)
2189     (insert (mapconcat 'identity lines "\n"))
2190     (goto-char (point-min))
2191     (if (not (re-search-forward "|[^+]" nil t))
2192         (error "Error processing table"))
2193     (table-recognize-table)
2194     (when (or (not spanned-only)
2195               (let* ((dim (table-query-dimension))
2196                      (c (nth 4 dim)) (r (nth 5 dim)) (cells (nth 6 dim)))
2197                 (not (= (* c r) cells))))
2198       (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
2199       (table-generate-source 'html " org-tmp2 ")
2200       (set-buffer " org-tmp2 ")
2201       (buffer-substring (point-min) (point-max)))))
2202
2203 (defun org-export-splice-style (style extra)
2204   "Splice EXTRA into STYLE, just before \"</style>\"."
2205   (if (and (stringp extra)
2206            (string-match "\\S-" extra)
2207            (string-match "</style>" style))
2208       (concat (substring style 0 (match-beginning 0))
2209               "\n" extra "\n"
2210               (substring style (match-beginning 0)))
2211     style))
2212
2213 (defun org-html-handle-time-stamps (s)
2214   "Format time stamps in string S, or remove them."
2215   (catch 'exit
2216     (let (r b)
2217       (when org-maybe-keyword-time-regexp
2218         (while (string-match org-maybe-keyword-time-regexp s)
2219           (or b (setq b (substring s 0 (match-beginning 0))))
2220           (setq r (concat
2221                    r (substring s 0 (match-beginning 0))
2222                    " @<span class=\"timestamp-wrapper\">"
2223                    (if (match-end 1)
2224                        (format "@<span class=\"timestamp-kwd\">%s @</span>"
2225                                (match-string 1 s)))
2226                    (format " @<span class=\"timestamp\">%s@</span>"
2227                            (substring
2228                             (org-translate-time (match-string 3 s)) 1 -1))
2229                    "@</span>")
2230                 s (substring s (match-end 0)))))
2231       ;; Line break if line started and ended with time stamp stuff
2232       (if (not r)
2233           s
2234         (setq r (concat r s))
2235         (unless (string-match "\\S-" (concat b s))
2236           (setq r (concat r "@<br/>")))
2237         r))))
2238
2239 (defvar htmlize-buffer-places)  ; from htmlize.el
2240 (defun org-export-htmlize-region-for-paste (beg end)
2241   "Convert the region to HTML, using htmlize.el.
2242 This is much like `htmlize-region-for-paste', only that it uses
2243 the settings define in the org-... variables."
2244   (let* ((htmlize-output-type org-export-htmlize-output-type)
2245          (htmlize-css-name-prefix org-export-htmlize-css-font-prefix)
2246          (htmlbuf (htmlize-region beg end)))
2247     (unwind-protect
2248         (with-current-buffer htmlbuf
2249           (buffer-substring (plist-get htmlize-buffer-places 'content-start)
2250                             (plist-get htmlize-buffer-places 'content-end)))
2251       (kill-buffer htmlbuf))))
2252
2253 ;;;###autoload
2254 (defun org-export-htmlize-generate-css ()
2255   "Create the CSS for all font definitions in the current Emacs session.
2256 Use this to create face definitions in your CSS style file that can then
2257 be used by code snippets transformed by htmlize.
2258 This command just produces a buffer that contains class definitions for all
2259 faces used in the current Emacs session.  You can copy and paste the ones you
2260 need into your CSS file.
2261
2262 If you then set `org-export-htmlize-output-type' to `css', calls to
2263 the function `org-export-htmlize-region-for-paste' will produce code
2264 that uses these same face definitions."
2265   (interactive)
2266   (require 'htmlize)
2267   (and (get-buffer "*html*") (kill-buffer "*html*"))
2268   (with-temp-buffer
2269     (let ((fl (face-list))
2270           (htmlize-css-name-prefix "org-")
2271           (htmlize-output-type 'css)
2272           f i)
2273       (while (setq f (pop fl)
2274                    i (and f (face-attribute f :inherit)))
2275         (when (and (symbolp f) (or (not i) (not (listp i))))
2276           (insert (org-add-props (copy-sequence "1") nil 'face f))))
2277       (htmlize-region (point-min) (point-max))))
2278   (org-pop-to-buffer-same-window "*html*")
2279   (goto-char (point-min))
2280   (if (re-search-forward "<style" nil t)
2281       (delete-region (point-min) (match-beginning 0)))
2282   (if (re-search-forward "</style>" nil t)
2283       (delete-region (1+ (match-end 0)) (point-max)))
2284   (beginning-of-line 1)
2285   (if (looking-at " +") (replace-match ""))
2286   (goto-char (point-min)))
2287
2288 (defun org-html-protect (s)
2289   "Convert characters to HTML equivalent.
2290 Possible conversions are set in `org-export-html-protect-char-alist'."
2291   (let ((cl org-export-html-protect-char-alist) c)
2292     (while (setq c (pop cl))
2293       (let ((start 0))
2294         (while (string-match (car c) s start)
2295           (setq s (replace-match (cdr c) t t s)
2296                 start (1+ (match-beginning 0))))))
2297     s))
2298
2299 (defun org-html-expand (string)
2300   "Prepare STRING for HTML export.  Apply all active conversions.
2301 If there are links in the string, don't modify these."
2302   (let* ((re (concat org-bracket-link-regexp "\\|"
2303                      (org-re "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")))
2304          m s l res)
2305     (while (setq m (string-match re string))
2306       (setq s (substring string 0 m)
2307             l (match-string 0 string)
2308             string (substring string (match-end 0)))
2309       (push (org-html-do-expand s) res)
2310       (push l res))
2311     (push (org-html-do-expand string) res)
2312     (apply 'concat (nreverse res))))
2313
2314 (defun org-html-do-expand (s)
2315   "Apply all active conversions to translate special ASCII to HTML."
2316   (setq s (org-html-protect s))
2317   (if org-export-html-expand
2318       (while (string-match "@&lt;\\([^&]*\\)&gt;" s)
2319         (setq s (replace-match "<\\1>" t nil s))))
2320   (if org-export-with-emphasize
2321       (setq s (org-export-html-convert-emphasize s)))
2322   (if org-export-with-special-strings
2323       (setq s (org-export-html-convert-special-strings s)))
2324   (if org-export-with-sub-superscripts
2325       (setq s (org-export-html-convert-sub-super s)))
2326   (if org-export-with-TeX-macros
2327       (let ((start 0) wd rep)
2328         (while (setq start (string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
2329                                          s start))
2330           (if (get-text-property (match-beginning 0) 'org-protected s)
2331               (setq start (match-end 0))
2332             (setq wd (match-string 1 s))
2333             (if (setq rep (org-entity-get-representation wd 'html))
2334                 (setq s (replace-match rep t t s))
2335               (setq start (+ start (length wd))))))))
2336   s)
2337
2338 (defun org-export-html-convert-special-strings (string)
2339   "Convert special characters in STRING to HTML."
2340   (let ((all org-export-html-special-string-regexps)
2341         e a re rpl start)
2342     (while (setq a (pop all))
2343       (setq re (car a) rpl (cdr a) start 0)
2344       (while (string-match re string start)
2345         (if (get-text-property (match-beginning 0) 'org-protected string)
2346             (setq start (match-end 0))
2347           (setq string (replace-match rpl t nil string)))))
2348     string))
2349
2350 (defun org-export-html-convert-sub-super (string)
2351   "Convert sub- and superscripts in STRING to HTML."
2352   (let (key c (s 0) (requireb (eq org-export-with-sub-superscripts '{})))
2353     (while (string-match org-match-substring-regexp string s)
2354       (cond
2355        ((and requireb (match-end 8)) (setq s (match-end 2)))
2356        ((get-text-property  (match-beginning 2) 'org-protected string)
2357         (setq s (match-end 2)))
2358        (t
2359         (setq s (match-end 1)
2360               key (if (string= (match-string 2 string) "_") "sub" "sup")
2361               c (or (match-string 8 string)
2362                     (match-string 6 string)
2363                     (match-string 5 string))
2364               string (replace-match
2365                       (concat (match-string 1 string)
2366                               "<" key ">" c "</" key ">")
2367                       t t string)))))
2368     (while (string-match "\\\\\\([_^]\\)" string)
2369       (setq string (replace-match (match-string 1 string) t t string)))
2370     string))
2371
2372 (defun org-export-html-convert-emphasize (string)
2373   "Apply emphasis."
2374   (let ((s 0) rpl)
2375     (while (string-match org-emph-re string s)
2376       (if (not (equal
2377                 (substring string (match-beginning 3) (1+ (match-beginning 3)))
2378                 (substring string (match-beginning 4) (1+ (match-beginning 4)))))
2379           (setq s (match-beginning 0)
2380                 rpl
2381                 (concat
2382                  (match-string 1 string)
2383                  (nth 2 (assoc (match-string 3 string) org-emphasis-alist))
2384                  (match-string 4 string)
2385                  (nth 3 (assoc (match-string 3 string)
2386                                org-emphasis-alist))
2387                  (match-string 5 string))
2388                 string (replace-match rpl t t string)
2389                 s (+ s (- (length rpl) 2)))
2390         (setq s (1+ s))))
2391     string))
2392
2393 (defun org-open-par ()
2394   "Insert <p>, but first close previous paragraph if any."
2395   (org-close-par-maybe)
2396   (insert "\n<p>")
2397   (setq org-par-open t))
2398 (defun org-close-par-maybe ()
2399   "Close paragraph if there is one open."
2400   (when org-par-open
2401     (insert "</p>")
2402     (setq org-par-open nil)))
2403 (defun org-close-li (&optional type)
2404   "Close <li> if necessary."
2405   (org-close-par-maybe)
2406   (insert (if (equal type "d") "</dd>\n" "</li>\n")))
2407
2408 (defvar body-only) ; dynamically scoped into this.
2409 (defun org-html-level-start (level title umax with-toc head-count &optional opt-plist)
2410   "Insert a new level in HTML export.
2411 When TITLE is nil, just close all open levels."
2412   (org-close-par-maybe)
2413   (let* ((target (and title (org-get-text-property-any 0 'target title)))
2414          (extra-targets (and target
2415                              (assoc target org-export-target-aliases)))
2416          (extra-class (and title (org-get-text-property-any 0 'html-container-class title)))
2417          (preferred (and target
2418                          (cdr (assoc target org-export-preferred-target-alist))))
2419          (l org-level-max)
2420          (num (plist-get opt-plist :section-numbers))
2421          snumber snu href suffix)
2422     (setq extra-targets (remove (or preferred target) extra-targets))
2423     (setq extra-targets
2424           (mapconcat (lambda (x)
2425                        (setq x (org-solidify-link-text
2426                                 (if (org-uuidgen-p x) (concat "ID-" x) x)))
2427                        (format "<a name=\"%s\" id=\"%s\"></a>"
2428                                x x))
2429                      extra-targets
2430                      ""))
2431     (while (>= l level)
2432       (if (aref org-levels-open (1- l))
2433           (progn
2434             (org-html-level-close l umax)
2435             (aset org-levels-open (1- l) nil)))
2436       (setq l (1- l)))
2437     (when title
2438       ;; If title is nil, this means this function is called to close
2439       ;; all levels, so the rest is done only if title is given
2440         (when (string-match (org-re "\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") title)
2441           (setq title (replace-match
2442                        (if org-export-with-tags
2443                            (save-match-data
2444                              (concat
2445                               "&nbsp;&nbsp;&nbsp;<span class=\"tag\">"
2446                               (mapconcat
2447                                (lambda (x)
2448                                  (format "<span class=\"%s\">%s</span>"
2449                                          (org-export-html-get-tag-class-name x)
2450                                          x))
2451                                (org-split-string (match-string 1 title) ":")
2452                                "&nbsp;")
2453                               "</span>"))
2454                          "")
2455                        t t title)))
2456       (if (> level umax)
2457           (progn
2458             (if (aref org-levels-open (1- level))
2459                 (progn
2460                   (org-close-li)
2461                   (if target
2462                       (insert (format "<li id=\"%s\">" (org-solidify-link-text (or preferred target)))
2463                               extra-targets title "<br/>\n")
2464                     (insert "<li>" title "<br/>\n")))
2465               (aset org-levels-open (1- level) t)
2466               (org-close-par-maybe)
2467               (if target
2468                   (insert (format "<ul>\n<li id=\"%s\">" (org-solidify-link-text (or preferred target)))
2469                           extra-targets title "<br/>\n")
2470                 (insert "<ul>\n<li>" title "<br/>\n"))))
2471         (aset org-levels-open (1- level) t)
2472         (setq snumber (org-section-number level)
2473               snu (replace-regexp-in-string "\\." "-" snumber))
2474         (setq level (+ level org-export-html-toplevel-hlevel -1))
2475         (if (and num (not body-only))
2476             (setq title (concat
2477                          (format "<span class=\"section-number-%d\">%s</span>"
2478                                  level
2479                                  (if (and num
2480                                           (if (integerp num)
2481                                               ;; fix up num to take into
2482                                               ;; account the top-level
2483                                               ;; heading value
2484                                               (>= (+ num org-export-html-toplevel-hlevel -1)
2485                                                   level)
2486                                             num))
2487                                      snumber
2488                                    ""))
2489                          " " title)))
2490         (unless (= head-count 1) (insert "\n</div>\n"))
2491         (setq href (cdr (assoc (concat "sec-" snu) org-export-preferred-target-alist)))
2492         (setq suffix (org-solidify-link-text (or href snu)))
2493         (setq href (org-solidify-link-text (or href (concat "sec-" snu))))
2494         (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"
2495                         suffix level (if extra-class (concat " " extra-class) "")
2496                         level href
2497                         extra-targets
2498                         title level level suffix))
2499         (org-open-par)))))
2500
2501 (defun org-export-html-get-tag-class-name (tag)
2502   "Turn tag into a valid class name.
2503 Replaces invalid characters with \"_\" and then prepends a prefix."
2504   (save-match-data
2505     (while (string-match "[^a-zA-Z0-9_]" tag)
2506       (setq tag (replace-match "_" t t tag))))
2507   (concat org-export-html-tag-class-prefix tag))
2508
2509 (defun org-export-html-get-todo-kwd-class-name (kwd)
2510   "Turn todo keyword into a valid class name.
2511 Replaces invalid characters with \"_\" and then prepends a prefix."
2512   (save-match-data
2513     (while (string-match "[^a-zA-Z0-9_]" kwd)
2514       (setq kwd (replace-match "_" t t kwd))))
2515   (concat org-export-html-todo-kwd-class-prefix kwd))
2516
2517 (defun org-html-level-close (level max-outline-level)
2518   "Terminate one level in HTML export."
2519   (if (<= level max-outline-level)
2520       (insert "</div>\n")
2521     (org-close-li)
2522     (insert "</ul>\n")))
2523
2524 (defun org-html-export-list-line (line pos struct prevs)
2525   "Insert list syntax in export buffer. Return LINE, maybe modified.
2526
2527 POS is the item position or line position the line had before
2528 modifications to buffer. STRUCT is the list structure. PREVS is
2529 the alist of previous items."
2530   (let* ((get-type
2531           (function
2532            ;; Translate type of list containing POS to "d", "o" or
2533            ;; "u".
2534            (lambda (pos struct prevs)
2535              (let ((type (org-list-get-list-type pos struct prevs)))
2536                (cond
2537                 ((eq 'ordered type) "o")
2538                 ((eq 'descriptive type) "d")
2539                 (t "u"))))))
2540          (get-closings
2541           (function
2542            ;; Return list of all items and sublists ending at POS, in
2543            ;; reverse order.
2544            (lambda (pos)
2545              (let (out)
2546                (catch 'exit
2547                  (mapc (lambda (e)
2548                          (let ((end (nth 6 e))
2549                                (item (car e)))
2550                            (cond
2551                             ((= end pos) (push item out))
2552                             ((>= item pos) (throw 'exit nil)))))
2553                        struct))
2554                out)))))
2555     ;; First close any previous item, or list, ending at POS.
2556     (mapc (lambda (e)
2557             (let* ((lastp (= (org-list-get-last-item e struct prevs) e))
2558                    (first-item (org-list-get-list-begin e struct prevs))
2559                    (type (funcall get-type first-item struct prevs)))
2560               (org-close-par-maybe)
2561               ;; Ending for every item
2562               (org-close-li type)
2563               ;; We're ending last item of the list: end list.
2564               (when lastp
2565                 (insert (format "</%sl>\n" type))
2566                 (org-open-par))))
2567           (funcall get-closings pos))
2568     (cond
2569      ;; At an item: insert appropriate tags in export buffer.
2570      ((assq pos struct)
2571       (string-match
2572        (concat "[ \t]*\\(\\S-+[ \t]*\\)"
2573                "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
2574                "\\(?:\\(\\[[ X-]\\]\\)[ \t]+\\)?"
2575                "\\(?:\\(.*\\)[ \t]+::\\(?:[ \t]+\\|$\\)\\)?"
2576                "\\(.*\\)") line)
2577       (let* ((checkbox (match-string 3 line))
2578              (desc-tag (or (match-string 4 line) "???"))
2579              (body (or (match-string 5 line) ""))
2580              (list-beg (org-list-get-list-begin pos struct prevs))
2581              (firstp (= list-beg pos))
2582              ;; Always refer to first item to determine list type, in
2583              ;; case list is ill-formed.
2584              (type (funcall get-type list-beg struct prevs))
2585              (counter (let ((count-tmp (org-list-get-counter pos struct)))
2586                         (cond
2587                          ((not count-tmp) nil)
2588                          ((string-match "[A-Za-z]" count-tmp)
2589                           (- (string-to-char (upcase count-tmp)) 64))
2590                          ((string-match "[0-9]+" count-tmp)
2591                           count-tmp)))))
2592         (when firstp
2593           (org-close-par-maybe)
2594           (insert (format "<%sl>\n" type)))
2595         (insert (cond
2596                  ((equal type "d")
2597                   (format "<dt>%s</dt><dd>" desc-tag))
2598                  ((and (equal type "o") counter)
2599                   (format "<li value=\"%s\">" counter))
2600                  (t "<li>")))
2601         ;; If line had a checkbox, some additional modification is required.
2602         (when checkbox
2603           (setq body
2604                 (concat
2605                  (cond
2606                   ((string-match "X" checkbox) "<code>[X]</code> ")
2607                   ((string-match " " checkbox) "<code>[&nbsp;]</code> ")
2608                   (t "<code>[-]</code> "))
2609                  body)))
2610         ;; Return modified line
2611         body))
2612      ;; At a list ender: go to next line (side-effects only).
2613      ((equal "ORG-LIST-END-MARKER" line) (throw 'nextline nil))
2614      ;; Not at an item: return line unchanged (side-effects only).
2615      (t line))))
2616
2617 (provide 'org-html)
2618
2619 ;;; org-html.el ends here