Merge branch 'master' of git+ssh://repo.or.cz/srv/git/org-mode
[org-mode.git] / lisp / org-html.el
blob71f62ebfd8f25e6627190d1d4987e90b212c7d88
1 ;;; org-html.el --- HTML export for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 6.35trans
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;; Commentary:
29 (require 'org-exp)
30 (eval-when-compile (require 'cl))
32 (declare-function org-id-find-id-file "org-id" (id))
33 (declare-function htmlize-region "ext:htmlize" (beg end))
35 (defgroup org-export-html nil
36 "Options specific for HTML export of Org-mode files."
37 :tag "Org Export HTML"
38 :group 'org-export)
40 (defcustom org-export-html-footnotes-section "<div id=\"footnotes\">
41 <h2 class=\"footnotes\">%s: </h2>
42 <div id=\"text-footnotes\">
44 </div>
45 </div>"
46 "Format for the footnotes section.
47 Should contain a two instances of %s. The first will be replaced with the
48 language-specific word for \"Footnotes\", the second one will be replaced
49 by the footnotes themselves."
50 :group 'org-export-html
51 :type 'string)
53 (defcustom org-export-html-footnote-format "<sup>%s</sup>"
54 "The format for the footnote reference.
55 %s will be replaced by the footnote reference itself."
56 :group 'org-export-html
57 :type 'string)
59 (defcustom org-export-html-coding-system nil
60 "Coding system for HTML export, defaults to buffer-file-coding-system."
61 :group 'org-export-html
62 :type 'coding-system)
64 (defcustom org-export-html-extension "html"
65 "The extension for exported HTML files."
66 :group 'org-export-html
67 :type 'string)
69 (defcustom org-export-html-xml-declaration
70 '(("html" . "<?xml version=\"1.0\" encoding=\"%s\"?>")
71 ("php" . "<?php echo \"<?xml version=\\\"1.0\\\" encoding=\\\"%s\\\" ?>\"; ?>"))
72 "The extension for exported HTML files.
73 %s will be replaced with the charset of the exported file.
74 This may be a string, or an alist with export extensions
75 and corresponding declarations."
76 :group 'org-export-html
77 :type '(choice
78 (string :tag "Single declaration")
79 (repeat :tag "Dependent on extension"
80 (cons (string :tag "Extension")
81 (string :tag "Declaration")))))
83 (defcustom org-export-html-style-include-scripts t
84 "Non-nil means include the javascript snippets in exported HTML files.
85 The actual script is defined in `org-export-html-scripts' and should
86 not be modified."
87 :group 'org-export-html
88 :type 'boolean)
90 (defconst org-export-html-scripts
91 "<script type=\"text/javascript\">
92 <!--/*--><![CDATA[/*><!--*/
93 function CodeHighlightOn(elem, id)
95 var target = document.getElementById(id);
96 if(null != target) {
97 elem.cacheClassElem = elem.className;
98 elem.cacheClassTarget = target.className;
99 target.className = \"code-highlighted\";
100 elem.className = \"code-highlighted\";
103 function CodeHighlightOff(elem, id)
105 var target = document.getElementById(id);
106 if(elem.cacheClassElem)
107 elem.className = elem.cacheClassElem;
108 if(elem.cacheClassTarget)
109 target.className = elem.cacheClassTarget;
111 /*]]>*///-->
112 </script>"
113 "Basic javascript that is needed by HTML files produced by Org-mode.")
115 (defconst org-export-html-style-default
116 "<style type=\"text/css\">
117 <!--/*--><![CDATA[/*><!--*/
118 html { font-family: Times, serif; font-size: 12pt; }
119 .title { text-align: center; }
120 .todo { color: red; }
121 .done { color: green; }
122 .tag { background-color: #add8e6; font-weight:normal }
123 .target { }
124 .timestamp { color: #bebebe; }
125 .timestamp-kwd { color: #5f9ea0; }
126 p.verse { margin-left: 3% }
127 pre {
128 border: 1pt solid #AEBDCC;
129 background-color: #F3F5F7;
130 padding: 5pt;
131 font-family: courier, monospace;
132 font-size: 90%;
133 overflow:auto;
135 table { border-collapse: collapse; }
136 td, th { vertical-align: top; }
137 dt { font-weight: bold; }
138 div.figure { padding: 0.5em; }
139 div.figure p { text-align: center; }
140 textarea { overflow-x: auto; }
141 .linenr { font-size:smaller }
142 .code-highlighted {background-color:#ffff00;}
143 .org-info-js_info-navigation { border-style:none; }
144 #org-info-js_console-label { font-size:10px; font-weight:bold;
145 white-space:nowrap; }
146 .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
147 font-weight:bold; }
148 /*]]>*/-->
149 </style>"
150 "The default style specification for exported HTML files.
151 Please use the variables `org-export-html-style' and
152 `org-export-html-style-extra' to add to this style. If you wish to not
153 have the default style included, customize the variable
154 `org-export-html-style-include-default'.")
156 (defcustom org-export-html-style-include-default t
157 "Non-nil means include the default style in exported HTML files.
158 The actual style is defined in `org-export-html-style-default' and should
159 not be modified. Use the variables `org-export-html-style' to add
160 your own style information."
161 :group 'org-export-html
162 :type 'boolean)
163 ;;;###autoload
164 (put 'org-export-html-style-include-default 'safe-local-variable 'booleanp)
166 (defcustom org-export-html-style ""
167 "Org-wide style definitions for exported HTML files.
169 This variable needs to contain the full HTML structure to provide a style,
170 including the surrounding HTML tags. If you set the value of this variable,
171 you should consider to include definitions for the following classes:
172 title, todo, done, timestamp, timestamp-kwd, tag, target.
174 For example, a valid value would be:
176 <style type=\"text/css\">
177 <![CDATA[
178 p { font-weight: normal; color: gray; }
179 h1 { color: black; }
180 .title { text-align: center; }
181 .todo, .timestamp-kwd { color: red; }
182 .done { color: green; }
184 </style>
186 If you'd like to refer to en external style file, use something like
188 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
190 As the value of this option simply gets inserted into the HTML <head> header,
191 you can \"misuse\" it to add arbitrary text to the header.
192 See also the variable `org-export-html-style-extra'."
193 :group 'org-export-html
194 :type 'string)
195 ;;;###autoload
196 (put 'org-export-html-style 'safe-local-variable 'stringp)
198 (defcustom org-export-html-style-extra ""
199 "Additional style information for HTML export.
200 The value of this variable is inserted into the HTML buffer right after
201 the value of `org-export-html-style'. Use this variable for per-file
202 settings of style information, and do not forget to surround the style
203 settings with <style>...</style> tags."
204 :group 'org-export-html
205 :type 'string)
206 ;;;###autoload
207 (put 'org-export-html-style-extra 'safe-local-variable 'stringp)
209 (defcustom org-export-html-tag-class-prefix ""
210 "Prefix to clas names for TODO keywords.
211 Each tag gets a class given by the tag itself, with this prefix.
212 The default prefix is empty because it is nice to just use the keyword
213 as a class name. But if you get into conflicts with other, existing
214 CSS classes, then this prefic can be very useful."
215 :group 'org-export-html
216 :type 'string)
218 (defcustom org-export-html-todo-kwd-class-prefix ""
219 "Prefix to clas names for TODO keywords.
220 Each TODO keyword gets a class given by the keyword itself, with this prefix.
221 The default prefix is empty because it is nice to just use the keyword
222 as a class name. But if you get into conflicts with other, existing
223 CSS classes, then this prefic can be very useful."
224 :group 'org-export-html
225 :type 'string)
227 (defcustom org-export-html-title-format "<h1 class=\"title\">%s</h1>\n"
228 "Format for typesetting the document title in HTML export."
229 :group 'org-export-html
230 :type 'string)
232 (defcustom org-export-html-home/up-format
233 "<div id=\"org-div-home-and-up\" style=\"text-align:right;font-size:70%%;white-space:nowrap;\">
234 <a accesskey=\"h\" href=\"%s\"> UP </a>
236 <a accesskey=\"H\" href=\"%s\"> HOME </a>
237 </div>"
238 "Snippet used to insert the HOME and UP links. This is a format,
239 the first %s will receive the UP link, the second the HOME link.
240 If both `org-export-html-link-up' and `org-export-html-link-home' are
241 empty, the entire snippet will be ignored."
242 :group 'org-export-html
243 :type 'string)
245 (defcustom org-export-html-toplevel-hlevel 2
246 "The <H> level for level 1 headings in HTML export.
247 This is also important for the classes that will be wrapped around headlines
248 and outline structure. If this variable is 1, the top-level headlines will
249 be <h1>, and the corresponding classes will be outline-1, section-number-1,
250 and outline-text-1. If this is 2, all of these will get a 2 instead.
251 The default for this variable is 2, because we use <h1> for formatting the
252 document title."
253 :group 'org-export-html
254 :type 'string)
256 (defcustom org-export-html-link-org-files-as-html t
257 "Non-nil means make file links to `file.org' point to `file.html'.
258 When org-mode is exporting an org-mode file to HTML, links to
259 non-html files are directly put into a href tag in HTML.
260 However, links to other Org-mode files (recognized by the
261 extension `.org.) should become links to the corresponding html
262 file, assuming that the linked org-mode file will also be
263 converted to HTML.
264 When nil, the links still point to the plain `.org' file."
265 :group 'org-export-html
266 :type 'boolean)
268 (defcustom org-export-html-inline-images 'maybe
269 "Non-nil means inline images into exported HTML pages.
270 This is done using an <img> tag. When nil, an anchor with href is used to
271 link to the image. If this option is `maybe', then images in links with
272 an empty description will be inlined, while images with a description will
273 be linked only."
274 :group 'org-export-html
275 :type '(choice (const :tag "Never" nil)
276 (const :tag "Always" t)
277 (const :tag "When there is no description" maybe)))
279 (defcustom org-export-html-inline-image-extensions
280 '("png" "jpeg" "jpg" "gif")
281 "Extensions of image files that can be inlined into HTML."
282 :group 'org-export-html
283 :type '(repeat (string :tag "Extension")))
285 (defcustom org-export-html-table-tag
286 "<table border=\"2\" cellspacing=\"0\" cellpadding=\"6\" rules=\"groups\" frame=\"hsides\">"
287 "The HTML tag that is used to start a table.
288 This must be a <table> tag, but you may change the options like
289 borders and spacing."
290 :group 'org-export-html
291 :type 'string)
293 (defcustom org-export-table-header-tags '("<th scope=\"%s\">" . "</th>")
294 "The opening tag for table header fields.
295 This is customizable so that alignment options can be specified.
296 %s will be filled with the scope of the field, either row or col.
297 See also the variable `org-export-html-table-use-header-tags-for-first-column'."
298 :group 'org-export-tables
299 :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
301 (defcustom org-export-table-data-tags '("<td>" . "</td>")
302 "The opening tag for table data fields.
303 This is customizable so that alignment options can be specified."
304 :group 'org-export-tables
305 :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
307 (defcustom org-export-table-row-tags '("<tr>" . "</tr>")
308 "The opening tag for table data fields.
309 This is customizable so that alignment options can be specified.
310 Instead of strings, these can be Lisp forms that will be evaluated
311 for each row in order to construct the table row tags. During evaluation,
312 the variable `head' will be true when this is a header line, nil when this
313 is a body line. And the variable `nline' will contain the line number,
314 starting from 1 in the first header line. For example
316 (setq org-export-table-row-tags
317 (cons '(if head
318 \"<tr>\"
319 (if (= (mod nline 2) 1)
320 \"<tr class=\\\"tr-odd\\\">\"
321 \"<tr class=\\\"tr-even\\\">\"))
322 \"</tr>\"))
324 will give even lines the class \"tr-even\" and odd lines the class \"tr-odd\"."
325 :group 'org-export-tables
326 :type '(cons
327 (choice :tag "Opening tag"
328 (string :tag "Specify")
329 (sexp))
330 (choice :tag "Closing tag"
331 (string :tag "Specify")
332 (sexp))))
336 (defcustom org-export-html-table-use-header-tags-for-first-column nil
337 "Non-nil means format column one in tables with header tags.
338 When nil, also column one will use data tags."
339 :group 'org-export-tables
340 :type 'boolean)
342 (defcustom org-export-html-validation-link nil
343 "Non-nil means add validationlink to postamble of HTML exported files."
344 :group 'org-export-html
345 :type '(choice
346 (const :tag "Nothing" nil)
347 (const :tag "XHTML 1.0" "<p class=\"xhtml-validation\"><a href=\"http://validator.w3.org/check?uri=referer\">Validate XHTML 1.0</a></p>")
348 (string :tag "Specify full HTML")))
351 (defcustom org-export-html-with-timestamp nil
352 "If non-nil, write `org-export-html-html-helper-timestamp'
353 into the exported HTML text. Otherwise, the buffer will just be saved
354 to a file."
355 :group 'org-export-html
356 :type 'boolean)
358 (defcustom org-export-html-html-helper-timestamp
359 "<br/><br/><hr><p><!-- hhmts start --> <!-- hhmts end --></p>\n"
360 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
361 :group 'org-export-html
362 :type 'string)
364 (defgroup org-export-htmlize nil
365 "Options for processing examples with htmlize.el."
366 :tag "Org Export Htmlize"
367 :group 'org-export-html)
369 (defcustom org-export-htmlize-output-type 'inline-css
370 "Output type to be used by htmlize when formatting code snippets.
371 We use as default `inline-css', in order to make the resulting
372 HTML self-containing.
373 However, this will fail when using Emacs in batch mode for export, because
374 then no rich font definitions are in place. It will also not be good if
375 people with different Emacs setup contribute HTML files to a website,
376 because the fonts will represent the individual setups. In these cases,
377 it is much better to let Org/Htmlize assign classes only, and to use
378 a style file to define the look of these classes.
379 To get a start for your css file, start Emacs session and make sure that
380 all the faces you are interested in are defined, for example by loading files
381 in all modes you want. Then, use the command
382 \\[org-export-htmlize-generate-css] to extract class definitions."
383 :group 'org-export-htmlize
384 :type '(choice (const css) (const inline-css)))
386 (defcustom org-export-htmlize-css-font-prefix "org-"
387 "The prefix for CSS class names for htmlize font specifications."
388 :group 'org-export-htmlize
389 :type 'string)
391 (defcustom org-export-htmlized-org-css-url nil
392 "URL pointing to a CSS file defining text colors for htmlized Emacs buffers.
393 Normally when creating an htmlized version of an Org buffer, htmlize will
394 create CSS to define the font colors. However, this does not work when
395 converting in batch mode, and it also can look bad if different people
396 with different fontification setup work on the same website.
397 When this variable is non-nil, creating an htmlized version of an Org buffer
398 using `org-export-as-org' will remove the internal CSS section and replace it
399 with a link to this URL."
400 :group 'org-export-htmlize
401 :type '(choice
402 (const :tag "Keep internal css" nil)
403 (string :tag "URL or local href")))
405 ;;; Variables, constants, and parameter plists
407 (defvar org-export-html-preamble nil
408 "Preamble, to be inserted just before <body>. Set by publishing functions.
409 This may also be a function, building and inserting the preamble.")
410 (defvar org-export-html-postamble nil
411 "Preamble, to be inserted just after </body>. Set by publishing functions.
412 This may also be a function, building and inserting the postamble.")
413 (defvar org-export-html-auto-preamble t
414 "Should default preamble be inserted? Set by publishing functions.")
415 (defvar org-export-html-auto-postamble t
416 "Should default postamble be inserted? Set by publishing functions.")
418 ;;; Hooks
420 (defvar org-export-html-after-blockquotes-hook nil
421 "Hook run during HTML export, after blockquote, verse, center are done.")
423 (defvar org-export-html-final-hook nil
424 "Hook run at the end of HTML export, in the new buffer.")
426 ;;; HTML export
428 (defun org-export-html-preprocess (parameters)
429 ;; Convert LaTeX fragments to images
430 (when (and org-current-export-file
431 (plist-get parameters :LaTeX-fragments))
432 (org-format-latex
433 (concat "ltxpng/" (file-name-sans-extension
434 (file-name-nondirectory
435 org-current-export-file)))
436 org-current-export-dir nil "Creating LaTeX image %s"))
437 (goto-char (point-min))
438 (let (label l1)
439 (while (re-search-forward "\\\\ref{\\([^{}\n]+\\)}" nil t)
440 (org-if-unprotected-at (match-beginning 1)
441 (setq label (match-string 1))
442 (save-match-data
443 (if (string-match "\\`[a-z]\\{1,10\\}:\\(.+\\)" label)
444 (setq l1 (substring label (match-beginning 1)))
445 (setq l1 label)))
446 (replace-match (format "[[#%s][%s]]" label l1) t t)))))
448 ;;;###autoload
449 (defun org-export-as-html-and-open (arg)
450 "Export the outline as HTML and immediately open it with a browser.
451 If there is an active region, export only the region.
452 The prefix ARG specifies how many levels of the outline should become
453 headlines. The default is 3. Lower levels will become bulleted lists."
454 (interactive "P")
455 (org-export-as-html arg 'hidden)
456 (org-open-file buffer-file-name)
457 (when org-export-kill-product-buffer-when-displayed
458 (kill-buffer (current-buffer))))
460 ;;;###autoload
461 (defun org-export-as-html-batch ()
462 "Call `org-export-as-html', may be used in batch processing as
463 emacs --batch
464 --load=$HOME/lib/emacs/org.el
465 --eval \"(setq org-export-headline-levels 2)\"
466 --visit=MyFile --funcall org-export-as-html-batch"
467 (org-export-as-html org-export-headline-levels 'hidden))
469 ;;;###autoload
470 (defun org-export-as-html-to-buffer (arg)
471 "Call `org-export-as-html` with output to a temporary buffer.
472 No file is created. The prefix ARG is passed through to `org-export-as-html'."
473 (interactive "P")
474 (org-export-as-html arg nil nil "*Org HTML Export*")
475 (when org-export-show-temporary-export-buffer
476 (switch-to-buffer-other-window "*Org HTML Export*")))
478 ;;;###autoload
479 (defun org-replace-region-by-html (beg end)
480 "Assume the current region has org-mode syntax, and convert it to HTML.
481 This can be used in any buffer. For example, you could write an
482 itemized list in org-mode syntax in an HTML buffer and then use this
483 command to convert it."
484 (interactive "r")
485 (let (reg html buf pop-up-frames)
486 (save-window-excursion
487 (if (org-mode-p)
488 (setq html (org-export-region-as-html
489 beg end t 'string))
490 (setq reg (buffer-substring beg end)
491 buf (get-buffer-create "*Org tmp*"))
492 (with-current-buffer buf
493 (erase-buffer)
494 (insert reg)
495 (org-mode)
496 (setq html (org-export-region-as-html
497 (point-min) (point-max) t 'string)))
498 (kill-buffer buf)))
499 (delete-region beg end)
500 (insert html)))
502 ;;;###autoload
503 (defun org-export-region-as-html (beg end &optional body-only buffer)
504 "Convert region from BEG to END in org-mode buffer to HTML.
505 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
506 contents, and only produce the region of converted text, useful for
507 cut-and-paste operations.
508 If BUFFER is a buffer or a string, use/create that buffer as a target
509 of the converted HTML. If BUFFER is the symbol `string', return the
510 produced HTML as a string and leave not buffer behind. For example,
511 a Lisp program could call this function in the following way:
513 (setq html (org-export-region-as-html beg end t 'string))
515 When called interactively, the output buffer is selected, and shown
516 in a window. A non-interactive call will only return the buffer."
517 (interactive "r\nP")
518 (when (interactive-p)
519 (setq buffer "*Org HTML Export*"))
520 (let ((transient-mark-mode t) (zmacs-regions t)
521 ext-plist rtn)
522 (setq ext-plist (plist-put ext-plist :ignore-subtree-p t))
523 (goto-char end)
524 (set-mark (point)) ;; to activate the region
525 (goto-char beg)
526 (setq rtn (org-export-as-html
527 nil nil ext-plist
528 buffer body-only))
529 (if (fboundp 'deactivate-mark) (deactivate-mark))
530 (if (and (interactive-p) (bufferp rtn))
531 (switch-to-buffer-other-window rtn)
532 rtn)))
534 (defvar html-table-tag nil) ; dynamically scoped into this.
535 (defvar org-par-open nil)
536 ;;;###autoload
537 (defun org-export-as-html (arg &optional hidden ext-plist
538 to-buffer body-only pub-dir)
539 "Export the outline as a pretty HTML file.
540 If there is an active region, export only the region. The prefix
541 ARG specifies how many levels of the outline should become
542 headlines. The default is 3. Lower levels will become bulleted
543 lists. HIDDEN is obsolete and does nothing.
544 EXT-PLIST is a property list with external parameters overriding
545 org-mode's default settings, but still inferior to file-local
546 settings. When TO-BUFFER is non-nil, create a buffer with that
547 name and export to that buffer. If TO-BUFFER is the symbol
548 `string', don't leave any buffer behind but just return the
549 resulting HTML as a string. When BODY-ONLY is set, don't produce
550 the file header and footer, simply return the content of
551 <body>...</body>, without even the body tags themselves. When
552 PUB-DIR is set, use this as the publishing directory."
553 (interactive "P")
554 (run-hooks 'org-export-first-hook)
556 ;; Make sure we have a file name when we need it.
557 (when (and (not (or to-buffer body-only))
558 (not buffer-file-name))
559 (if (buffer-base-buffer)
560 (org-set-local 'buffer-file-name
561 (with-current-buffer (buffer-base-buffer)
562 buffer-file-name))
563 (error "Need a file name to be able to export")))
565 (message "Exporting...")
566 (setq-default org-todo-line-regexp org-todo-line-regexp)
567 (setq-default org-deadline-line-regexp org-deadline-line-regexp)
568 (setq-default org-done-keywords org-done-keywords)
569 (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp)
570 (let* ((opt-plist
571 (org-export-process-option-filters
572 (org-combine-plists (org-default-export-plist)
573 ext-plist
574 (org-infile-export-plist))))
575 (body-only (or body-only (plist-get opt-plist :body-only)))
576 (style (concat (if (plist-get opt-plist :style-include-default)
577 org-export-html-style-default)
578 (plist-get opt-plist :style)
579 (plist-get opt-plist :style-extra)
580 "\n"
581 (if (plist-get opt-plist :style-include-scripts)
582 org-export-html-scripts)))
583 (html-extension (plist-get opt-plist :html-extension))
584 (link-validate (plist-get opt-plist :link-validation-function))
585 valid thetoc have-headings first-heading-pos
586 (odd org-odd-levels-only)
587 (region-p (org-region-active-p))
588 (rbeg (and region-p (region-beginning)))
589 (rend (and region-p (region-end)))
590 (subtree-p
591 (if (plist-get opt-plist :ignore-subtree-p)
593 (when region-p
594 (save-excursion
595 (goto-char rbeg)
596 (and (org-at-heading-p)
597 (>= (org-end-of-subtree t t) rend))))))
598 (level-offset (if subtree-p
599 (save-excursion
600 (goto-char rbeg)
601 (+ (funcall outline-level)
602 (if org-odd-levels-only 1 0)))
604 (opt-plist (setq org-export-opt-plist
605 (if subtree-p
606 (org-export-add-subtree-options opt-plist rbeg)
607 opt-plist)))
608 ;; The following two are dynamically scoped into other
609 ;; routines below.
610 (org-current-export-dir
611 (or pub-dir (org-export-directory :html opt-plist)))
612 (org-current-export-file buffer-file-name)
613 (level 0) (line "") (origline "") txt todo
614 (umax nil)
615 (umax-toc nil)
616 (filename (if to-buffer nil
617 (expand-file-name
618 (concat
619 (file-name-sans-extension
620 (or (and subtree-p
621 (org-entry-get (region-beginning)
622 "EXPORT_FILE_NAME" t))
623 (file-name-nondirectory buffer-file-name)))
624 "." html-extension)
625 (file-name-as-directory
626 (or pub-dir (org-export-directory :html opt-plist))))))
627 (current-dir (if buffer-file-name
628 (file-name-directory buffer-file-name)
629 default-directory))
630 (buffer (if to-buffer
631 (cond
632 ((eq to-buffer 'string) (get-buffer-create "*Org HTML Export*"))
633 (t (get-buffer-create to-buffer)))
634 (find-file-noselect filename)))
635 (org-levels-open (make-vector org-level-max nil))
636 (date (plist-get opt-plist :date))
637 (author (plist-get opt-plist :author))
638 (title (or (and subtree-p (org-export-get-title-from-subtree))
639 (plist-get opt-plist :title)
640 (and (not body-only)
641 (not
642 (plist-get opt-plist :skip-before-1st-heading))
643 (org-export-grab-title-from-buffer))
644 (and buffer-file-name
645 (file-name-sans-extension
646 (file-name-nondirectory buffer-file-name)))
647 "UNTITLED"))
648 (link-up (and (plist-get opt-plist :link-up)
649 (string-match "\\S-" (plist-get opt-plist :link-up))
650 (plist-get opt-plist :link-up)))
651 (link-home (and (plist-get opt-plist :link-home)
652 (string-match "\\S-" (plist-get opt-plist :link-home))
653 (plist-get opt-plist :link-home)))
654 (dummy (setq opt-plist (plist-put opt-plist :title title)))
655 (html-table-tag (plist-get opt-plist :html-table-tag))
656 (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
657 (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string "\\>\\)"))
658 (inquote nil)
659 (infixed nil)
660 (inverse nil)
661 (in-local-list nil)
662 (local-list-type nil)
663 (local-list-indent nil)
664 (llt org-plain-list-ordered-item-terminator)
665 (email (plist-get opt-plist :email))
666 (language (plist-get opt-plist :language))
667 (keywords (plist-get opt-plist :keywords))
668 (description (plist-get opt-plist :description))
669 (lang-words nil)
670 (head-count 0) cnt
671 (start 0)
672 (coding-system (and (boundp 'buffer-file-coding-system)
673 buffer-file-coding-system))
674 (coding-system-for-write (or org-export-html-coding-system
675 coding-system))
676 (save-buffer-coding-system (or org-export-html-coding-system
677 coding-system))
678 (charset (and coding-system-for-write
679 (fboundp 'coding-system-get)
680 (coding-system-get coding-system-for-write
681 'mime-charset)))
682 (region
683 (buffer-substring
684 (if region-p (region-beginning) (point-min))
685 (if region-p (region-end) (point-max))))
686 (lines
687 (org-split-string
688 (org-export-preprocess-string
689 region
690 :emph-multiline t
691 :for-html t
692 :skip-before-1st-heading
693 (plist-get opt-plist :skip-before-1st-heading)
694 :drawers (plist-get opt-plist :drawers)
695 :todo-keywords (plist-get opt-plist :todo-keywords)
696 :tags (plist-get opt-plist :tags)
697 :priority (plist-get opt-plist :priority)
698 :footnotes (plist-get opt-plist :footnotes)
699 :timestamps (plist-get opt-plist :timestamps)
700 :archived-trees
701 (plist-get opt-plist :archived-trees)
702 :select-tags (plist-get opt-plist :select-tags)
703 :exclude-tags (plist-get opt-plist :exclude-tags)
704 :add-text
705 (plist-get opt-plist :text)
706 :LaTeX-fragments
707 (plist-get opt-plist :LaTeX-fragments))
708 "[\r\n]"))
709 table-open type
710 table-buffer table-orig-buffer
711 ind item-type starter didclose
712 rpl path attr desc descp desc1 desc2 link
713 snumber fnc item-tag
714 footnotes footref-seen
715 id-file href
718 (let ((inhibit-read-only t))
719 (org-unmodified
720 (remove-text-properties (point-min) (point-max)
721 '(:org-license-to-kill t))))
723 (message "Exporting...")
725 (setq org-min-level (org-get-min-level lines level-offset))
726 (setq org-last-level org-min-level)
727 (org-init-section-numbers)
729 (cond
730 ((and date (string-match "%" date))
731 (setq date (format-time-string date)))
732 (date)
733 (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
735 ;; Get the language-dependent settings
736 (setq lang-words (or (assoc language org-export-language-setup)
737 (assoc "en" org-export-language-setup)))
739 ;; Switch to the output buffer
740 (set-buffer buffer)
741 (let ((inhibit-read-only t)) (erase-buffer))
742 (fundamental-mode)
743 (org-install-letbind)
745 (and (fboundp 'set-buffer-file-coding-system)
746 (set-buffer-file-coding-system coding-system-for-write))
748 (let ((case-fold-search nil)
749 (org-odd-levels-only odd))
750 ;; create local variables for all options, to make sure all called
751 ;; functions get the correct information
752 (mapc (lambda (x)
753 (set (make-local-variable (nth 2 x))
754 (plist-get opt-plist (car x))))
755 org-export-plist-vars)
756 (setq umax (if arg (prefix-numeric-value arg)
757 org-export-headline-levels))
758 (setq umax-toc (if (integerp org-export-with-toc)
759 (min org-export-with-toc umax)
760 umax))
761 (unless body-only
762 ;; File header
763 (insert (format
765 <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
766 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
767 <html xmlns=\"http://www.w3.org/1999/xhtml\"
768 lang=\"%s\" xml:lang=\"%s\">
769 <head>
770 <title>%s</title>
771 <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
772 <meta name=\"generator\" content=\"Org-mode\"/>
773 <meta name=\"generated\" content=\"%s\"/>
774 <meta name=\"author\" content=\"%s\"/>
775 <meta name=\"description\" content=\"%s\"/>
776 <meta name=\"keywords\" content=\"%s\"/>
778 </head>
779 <body>
780 <div id=\"content\">
783 (format
784 (or (and (stringp org-export-html-xml-declaration)
785 org-export-html-xml-declaration)
786 (cdr (assoc html-extension org-export-html-xml-declaration))
787 (cdr (assoc "html" org-export-html-xml-declaration))
790 (or charset "iso-8859-1"))
791 language language
792 (org-html-expand title)
793 (or charset "iso-8859-1")
794 date author description keywords
795 style
796 (if (or link-up link-home)
797 (concat
798 (format org-export-html-home/up-format
799 (or link-up link-home)
800 (or link-home link-up))
801 "\n")
802 "")))
804 (org-export-html-insert-plist-item opt-plist :preamble opt-plist)
806 (when (plist-get opt-plist :auto-preamble)
807 (if title (insert (format org-export-html-title-format
808 (org-html-expand title))))))
810 (if (and org-export-with-toc (not body-only))
811 (progn
812 (push (format "<h%d>%s</h%d>\n"
813 org-export-html-toplevel-hlevel
814 (nth 3 lang-words)
815 org-export-html-toplevel-hlevel)
816 thetoc)
817 (push "<div id=\"text-table-of-contents\">\n" thetoc)
818 (push "<ul>\n<li>" thetoc)
819 (setq lines
820 (mapcar '(lambda (line)
821 (if (and (string-match org-todo-line-regexp line)
822 (not (get-text-property 0 'org-protected line)))
823 ;; This is a headline
824 (progn
825 (setq have-headings t)
826 (setq level (- (match-end 1) (match-beginning 1)
827 level-offset)
828 level (org-tr-level level)
829 txt (save-match-data
830 (org-html-expand
831 (org-export-cleanup-toc-line
832 (match-string 3 line))))
833 todo
834 (or (and org-export-mark-todo-in-toc
835 (match-beginning 2)
836 (not (member (match-string 2 line)
837 org-done-keywords)))
838 ; TODO, not DONE
839 (and org-export-mark-todo-in-toc
840 (= level umax-toc)
841 (org-search-todo-below
842 line lines level))))
843 (if (string-match
844 (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt)
845 (setq txt (replace-match "&nbsp;&nbsp;&nbsp;<span class=\"tag\"> \\1</span>" t nil txt)))
846 (if (string-match quote-re0 txt)
847 (setq txt (replace-match "" t t txt)))
848 (setq snumber (org-section-number level))
849 (if org-export-with-section-numbers
850 (setq txt (concat snumber " " txt)))
851 (if (<= level (max umax umax-toc))
852 (setq head-count (+ head-count 1)))
853 (if (<= level umax-toc)
854 (progn
855 (if (> level org-last-level)
856 (progn
857 (setq cnt (- level org-last-level))
858 (while (>= (setq cnt (1- cnt)) 0)
859 (push "\n<ul>\n<li>" thetoc))
860 (push "\n" thetoc)))
861 (if (< level org-last-level)
862 (progn
863 (setq cnt (- org-last-level level))
864 (while (>= (setq cnt (1- cnt)) 0)
865 (push "</li>\n</ul>" thetoc))
866 (push "\n" thetoc)))
867 ;; Check for targets
868 (while (string-match org-any-target-regexp line)
869 (setq line (replace-match
870 (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
871 t t line)))
872 (while (string-match "&lt;\\(&lt;\\)+\\|&gt;\\(&gt;\\)+" txt)
873 (setq txt (replace-match "" t t txt)))
874 (setq href (format "sec-%s" snumber))
875 (setq href (or (cdr (assoc href org-export-preferred-target-alist)) href))
876 (push
877 (format
878 (if todo
879 "</li>\n<li><a href=\"#%s\"><span class=\"todo\">%s</span></a>"
880 "</li>\n<li><a href=\"#%s\">%s</a>")
881 href txt) thetoc)
883 (setq org-last-level level))
885 line)
886 lines))
887 (while (> org-last-level (1- org-min-level))
888 (setq org-last-level (1- org-last-level))
889 (push "</li>\n</ul>\n" thetoc))
890 (push "</div>\n" thetoc)
891 (setq thetoc (if have-headings (nreverse thetoc) nil))))
893 (setq head-count 0)
894 (org-init-section-numbers)
896 (org-open-par)
898 (while (setq line (pop lines) origline line)
899 (catch 'nextline
901 ;; end of quote section?
902 (when (and inquote (string-match "^\\*+ " line))
903 (insert "</pre>\n")
904 (org-open-par)
905 (setq inquote nil))
906 ;; inside a quote section?
907 (when inquote
908 (insert (org-html-protect line) "\n")
909 (throw 'nextline nil))
911 ;; Fixed-width, verbatim lines (examples)
912 (when (and org-export-with-fixed-width
913 (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line))
914 (when (not infixed)
915 (setq infixed t)
916 (org-close-par-maybe)
918 (insert "<pre class=\"example\">\n"))
919 (insert (org-html-protect (match-string 3 line)) "\n")
920 (when (or (not lines)
921 (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
922 (car lines))))
923 (setq infixed nil)
924 (insert "</pre>\n")
925 (org-open-par))
926 (throw 'nextline nil))
928 (org-export-html-close-lists-maybe line)
930 ;; Protected HTML
931 (when (get-text-property 0 'org-protected line)
932 (let (par (ind (get-text-property 0 'original-indentation line)))
933 (when (re-search-backward
934 "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t)
935 (setq par (match-string 1))
936 (replace-match "\\2\n"))
937 (insert line "\n")
938 (while (and lines
939 (or (= (length (car lines)) 0)
940 (not ind)
941 (equal ind (get-text-property 0 'original-indentation (car lines))))
942 (or (= (length (car lines)) 0)
943 (get-text-property 0 'org-protected (car lines))))
944 (insert (pop lines) "\n"))
945 (and par (insert "<p>\n")))
946 (throw 'nextline nil))
948 ;; Blockquotes, verse, and center
949 (when (equal "ORG-BLOCKQUOTE-START" line)
950 (org-close-par-maybe)
951 (insert "<blockquote>\n")
952 (org-open-par)
953 (throw 'nextline nil))
954 (when (equal "ORG-BLOCKQUOTE-END" line)
955 (org-close-par-maybe)
956 (insert "\n</blockquote>\n")
957 (org-open-par)
958 (throw 'nextline nil))
959 (when (equal "ORG-VERSE-START" line)
960 (org-close-par-maybe)
961 (insert "\n<p class=\"verse\">\n")
962 (setq org-par-open t)
963 (setq inverse t)
964 (throw 'nextline nil))
965 (when (equal "ORG-VERSE-END" line)
966 (insert "</p>\n")
967 (setq org-par-open nil)
968 (org-open-par)
969 (setq inverse nil)
970 (throw 'nextline nil))
971 (when (equal "ORG-CENTER-START" line)
972 (org-close-par-maybe)
973 (insert "\n<div style=\"text-align: center\">")
974 (org-open-par)
975 (throw 'nextline nil))
976 (when (equal "ORG-CENTER-END" line)
977 (org-close-par-maybe)
978 (insert "\n</div>")
979 (org-open-par)
980 (throw 'nextline nil))
981 (run-hooks 'org-export-html-after-blockquotes-hook)
982 (when inverse
983 (let ((i (org-get-string-indentation line)))
984 (if (> i 0)
985 (setq line (concat (mapconcat 'identity
986 (make-list (* 2 i) "\\nbsp") "")
987 " " (org-trim line))))
988 (unless (string-match "\\\\\\\\[ \t]*$" line)
989 (setq line (concat line "\\\\")))))
991 ;; make targets to anchors
992 (setq start 0)
993 (while (string-match
994 "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start)
995 (cond
996 ((get-text-property (match-beginning 1) 'org-protected line)
997 (setq start (match-end 1)))
998 ((match-end 2)
999 (setq line (replace-match
1000 (format
1001 "@<a name=\"%s\" id=\"%s\">@</a>"
1002 (org-solidify-link-text (match-string 1 line))
1003 (org-solidify-link-text (match-string 1 line)))
1004 t t line)))
1005 ((and org-export-with-toc (equal (string-to-char line) ?*))
1006 ;; FIXME: NOT DEPENDENT on TOC?????????????????????
1007 (setq line (replace-match
1008 (concat "@<span class=\"target\">"
1009 (match-string 1 line) "@</span> ")
1010 ;; (concat "@<i>" (match-string 1 line) "@</i> ")
1011 t t line)))
1013 (setq line (replace-match
1014 (concat "@<a name=\""
1015 (org-solidify-link-text (match-string 1 line))
1016 "\" class=\"target\">" (match-string 1 line)
1017 "@</a> ")
1018 t t line)))))
1020 (setq line (org-html-handle-time-stamps line))
1022 ;; replace "&" by "&amp;", "<" and ">" by "&lt;" and "&gt;"
1023 ;; handle @<..> HTML tags (replace "@&gt;..&lt;" by "<..>")
1024 ;; Also handle sub_superscripts and checkboxes
1025 (or (string-match org-table-hline-regexp line)
1026 (setq line (org-html-expand line)))
1028 ;; Format the links
1029 (setq start 0)
1030 (while (string-match org-bracket-link-analytic-regexp++ line start)
1031 (setq start (match-beginning 0))
1032 (setq path (save-match-data (org-link-unescape
1033 (match-string 3 line))))
1034 (setq type (cond
1035 ((match-end 2) (match-string 2 line))
1036 ((save-match-data
1037 (or (file-name-absolute-p path)
1038 (string-match "^\\.\\.?/" path)))
1039 "file")
1040 (t "internal")))
1041 (setq path (org-extract-attributes (org-link-unescape path)))
1042 (setq attr (get-text-property 0 'org-attributes path))
1043 (setq desc1 (if (match-end 5) (match-string 5 line))
1044 desc2 (if (match-end 2) (concat type ":" path) path)
1045 descp (and desc1 (not (equal desc1 desc2)))
1046 desc (or desc1 desc2))
1047 ;; Make an image out of the description if that is so wanted
1048 (when (and descp (org-file-image-p
1049 desc org-export-html-inline-image-extensions))
1050 (save-match-data
1051 (if (string-match "^file:" desc)
1052 (setq desc (substring desc (match-end 0)))))
1053 (setq desc (org-add-props
1054 (concat "<img src=\"" desc "\"/>")
1055 '(org-protected t))))
1056 ;; FIXME: do we need to unescape here somewhere?
1057 (cond
1058 ((equal type "internal")
1059 (setq rpl
1060 (concat
1061 "<a href=\""
1062 (if (= (string-to-char path) ?#) "" "#")
1063 (org-solidify-link-text
1064 (save-match-data (org-link-unescape path)) nil)
1065 "\"" attr ">"
1066 (org-export-html-format-desc desc)
1067 "</a>")))
1068 ((and (equal type "id")
1069 (setq id-file (org-id-find-id-file path)))
1070 ;; This is an id: link to another file (if it was the same file,
1071 ;; it would have become an internal link...)
1072 (save-match-data
1073 (setq id-file (file-relative-name
1074 id-file (file-name-directory org-current-export-file)))
1075 (setq id-file (concat (file-name-sans-extension id-file)
1076 "." html-extension))
1077 (setq rpl (concat "<a href=\"" id-file "#"
1078 (if (org-uuidgen-p path) "ID-")
1079 path "\""
1080 attr ">"
1081 (org-export-html-format-desc desc)
1082 "</a>"))))
1083 ((member type '("http" "https"))
1084 ;; standard URL, just check if we need to inline an image
1085 (if (and (or (eq t org-export-html-inline-images)
1086 (and org-export-html-inline-images (not descp)))
1087 (org-file-image-p
1088 path org-export-html-inline-image-extensions))
1089 (setq rpl (org-export-html-format-image
1090 (concat type ":" path) org-par-open))
1091 (setq link (concat type ":" path))
1092 (setq rpl (concat "<a href=\""
1093 (org-export-html-format-href link)
1094 "\"" attr ">"
1095 (org-export-html-format-desc desc)
1096 "</a>"))))
1097 ((member type '("ftp" "mailto" "news"))
1098 ;; standard URL
1099 (setq link (concat type ":" path))
1100 (setq rpl (concat "<a href=\""
1101 (org-export-html-format-href link)
1102 "\"" attr ">"
1103 (org-export-html-format-desc desc)
1104 "</a>")))
1106 ((string= type "coderef")
1107 (setq rpl (format "<a href=\"#coderef-%s\" class=\"coderef\" onmouseover=\"CodeHighlightOn(this, 'coderef-%s');\" onmouseout=\"CodeHighlightOff(this, 'coderef-%s');\">%s</a>"
1108 path path path
1109 (format (org-export-get-coderef-format path (and descp desc))
1110 (cdr (assoc path org-export-code-refs))))))
1112 ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
1113 ;; The link protocol has a function for format the link
1114 (setq rpl
1115 (save-match-data
1116 (funcall fnc (org-link-unescape path) desc1 'html))))
1118 ((string= type "file")
1119 ;; FILE link
1120 (let* ((filename path)
1121 (abs-p (file-name-absolute-p filename))
1122 thefile file-is-image-p search)
1123 (save-match-data
1124 (if (string-match "::\\(.*\\)" filename)
1125 (setq search (match-string 1 filename)
1126 filename (replace-match "" t nil filename)))
1127 (setq valid
1128 (if (functionp link-validate)
1129 (funcall link-validate filename current-dir)
1131 (setq file-is-image-p
1132 (org-file-image-p
1133 filename org-export-html-inline-image-extensions))
1134 (setq thefile (if abs-p (expand-file-name filename) filename))
1135 (when (and org-export-html-link-org-files-as-html
1136 (string-match "\\.org$" thefile))
1137 (setq thefile (concat (substring thefile 0
1138 (match-beginning 0))
1139 "." html-extension))
1140 (if (and search
1141 ;; make sure this is can be used as target search
1142 (not (string-match "^[0-9]*$" search))
1143 (not (string-match "^\\*" search))
1144 (not (string-match "^/.*/$" search)))
1145 (setq thefile
1146 (concat thefile
1147 (if (= (string-to-char search) ?#) "" "#")
1148 (org-solidify-link-text
1149 (org-link-unescape search)))))
1150 (when (string-match "^file:" desc)
1151 (setq desc (replace-match "" t t desc))
1152 (if (string-match "\\.org$" desc)
1153 (setq desc (replace-match "" t t desc))))))
1154 (setq rpl (if (and file-is-image-p
1155 (or (eq t org-export-html-inline-images)
1156 (and org-export-html-inline-images
1157 (not descp))))
1158 (progn
1159 (message "image %s %s" thefile org-par-open)
1160 (org-export-html-format-image thefile org-par-open))
1161 (concat "<a href=\"" thefile "\"" attr ">"
1162 (org-export-html-format-desc desc)
1163 "</a>")))
1164 (if (not valid) (setq rpl desc))))
1167 ;; just publish the path, as default
1168 (setq rpl (concat "<i>&lt;" type ":"
1169 (save-match-data (org-link-unescape path))
1170 "&gt;</i>"))))
1171 (setq line (replace-match rpl t t line)
1172 start (+ start (length rpl))))
1174 ;; TODO items
1175 (if (and (string-match org-todo-line-regexp line)
1176 (match-beginning 2))
1178 (setq line
1179 (concat (substring line 0 (match-beginning 2))
1180 "<span class=\""
1181 (if (member (match-string 2 line)
1182 org-done-keywords)
1183 "done" "todo")
1184 " " (match-string 2 line)
1185 "\"> " (org-export-html-get-todo-kwd-class-name
1186 (match-string 2 line))
1187 "</span>" (substring line (match-end 2)))))
1189 ;; Does this contain a reference to a footnote?
1190 (when org-export-with-footnotes
1191 (setq start 0)
1192 (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start)
1193 (if (get-text-property (match-beginning 2) 'org-protected line)
1194 (setq start (match-end 2))
1195 (let ((n (match-string 2 line)) extra a)
1196 (if (setq a (assoc n footref-seen))
1197 (progn
1198 (setcdr a (1+ (cdr a)))
1199 (setq extra (format ".%d" (cdr a))))
1200 (setq extra "")
1201 (push (cons n 1) footref-seen))
1202 (setq line
1203 (replace-match
1204 (format
1205 (concat "%s"
1206 (format org-export-html-footnote-format
1207 "<a class=\"footref\" name=\"fnr.%s%s\" href=\"#fn.%s\">%s</a>"))
1208 (or (match-string 1 line) "") n extra n n)
1209 t t line))))))
1211 (cond
1212 ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
1213 ;; This is a headline
1214 (setq level (org-tr-level (- (match-end 1) (match-beginning 1)
1215 level-offset))
1216 txt (match-string 2 line))
1217 (if (string-match quote-re0 txt)
1218 (setq txt (replace-match "" t t txt)))
1219 (if (<= level (max umax umax-toc))
1220 (setq head-count (+ head-count 1)))
1221 (when in-local-list
1222 ;; Close any local lists before inserting a new header line
1223 (while local-list-type
1224 (org-close-li (car local-list-type))
1225 (insert (format "</%sl>\n" (car local-list-type)))
1226 (pop local-list-type))
1227 (setq local-list-indent nil
1228 in-local-list nil))
1229 (setq first-heading-pos (or first-heading-pos (point)))
1230 (org-html-level-start level txt umax
1231 (and org-export-with-toc (<= level umax))
1232 head-count)
1234 ;; QUOTES
1235 (when (string-match quote-re line)
1236 (org-close-par-maybe)
1237 (insert "<pre>")
1238 (setq inquote t)))
1240 ((string-match "^[ \t]*- __+[ \t]*$" line)
1241 ;; Explicit list closure
1242 (when local-list-type
1243 (let ((ind (org-get-indentation line)))
1244 (while (and local-list-indent
1245 (<= ind (car local-list-indent)))
1246 (org-close-li (car local-list-type))
1247 (insert (format "</%sl>\n" (car local-list-type)))
1248 (pop local-list-type)
1249 (pop local-list-indent))
1250 (or local-list-indent (setq in-local-list nil))))
1251 (throw 'nextline nil))
1253 ((and org-export-with-tables
1254 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
1255 (when (not table-open)
1256 ;; New table starts
1257 (setq table-open t table-buffer nil table-orig-buffer nil))
1259 ;; Accumulate lines
1260 (setq table-buffer (cons line table-buffer)
1261 table-orig-buffer (cons origline table-orig-buffer))
1262 (when (or (not lines)
1263 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
1264 (car lines))))
1265 (setq table-open nil
1266 table-buffer (nreverse table-buffer)
1267 table-orig-buffer (nreverse table-orig-buffer))
1268 (org-close-par-maybe)
1269 (insert (org-format-table-html table-buffer table-orig-buffer))))
1271 ;; Normal lines
1272 (when (string-match
1273 (cond
1274 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
1275 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
1276 ((= llt ?\)) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+)\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
1277 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))
1278 line)
1279 (setq ind (or (get-text-property 0 'original-indentation line)
1280 (org-get-string-indentation line))
1281 item-type (if (match-beginning 4) "o" "u")
1282 starter (if (match-beginning 2)
1283 (substring (match-string 2 line) 0 -1))
1284 line (substring line (match-beginning 5))
1285 item-tag nil)
1286 (if (and starter (string-match "\\(.*?\\) ::[ \t]*" line))
1287 (setq item-type "d"
1288 item-tag (match-string 1 line)
1289 line (substring line (match-end 0))))
1290 (when (and (not (equal item-type "d"))
1291 (not (string-match "[^ \t]" line)))
1292 ;; empty line. Pretend indentation is large.
1293 (setq ind (if org-empty-line-terminates-plain-lists
1295 (1+ (or (car local-list-indent) 1)))))
1296 (setq didclose nil)
1297 (while (and in-local-list
1298 (or (and (= ind (car local-list-indent))
1299 (not starter))
1300 (< ind (car local-list-indent))))
1301 (setq didclose t)
1302 (org-close-li (car local-list-type))
1303 (insert (format "</%sl>\n" (car local-list-type)))
1304 (pop local-list-type) (pop local-list-indent)
1305 (setq in-local-list local-list-indent))
1306 (cond
1307 ((and starter
1308 (or (not in-local-list)
1309 (> ind (car local-list-indent))))
1310 ;; Start new (level of) list
1311 (org-close-par-maybe)
1312 (insert (cond
1313 ((equal item-type "u") "<ul>\n<li>\n")
1314 ((equal item-type "o") "<ol>\n<li>\n")
1315 ((equal item-type "d")
1316 (format "<dl>\n<dt>%s</dt><dd>\n" item-tag))))
1317 (push item-type local-list-type)
1318 (push ind local-list-indent)
1319 (setq in-local-list t))
1320 (starter
1321 ;; continue current list
1322 (org-close-li (car local-list-type))
1323 (insert (cond
1324 ((equal (car local-list-type) "d")
1325 (format "<dt>%s</dt><dd>\n" (or item-tag "???")))
1326 (t "<li>\n"))))
1327 (didclose
1328 ;; we did close a list, normal text follows: need <p>
1329 (org-open-par)))
1330 (if (string-match "^[ \t]*\\[\\([X ]\\)\\]" line)
1331 (setq line
1332 (replace-match
1333 (if (equal (match-string 1 line) "X")
1334 "<b>[X]</b>"
1335 "<b>[<span style=\"visibility:hidden;\">X</span>]</b>")
1336 t t line))))
1338 ;; Horizontal line
1339 (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line)
1340 (if org-par-open
1341 (insert "\n</p>\n<hr/>\n<p>\n")
1342 (insert "\n<hr/>\n"))
1343 (throw 'nextline nil))
1345 ;; Empty lines start a new paragraph. If hand-formatted lists
1346 ;; are not fully interpreted, lines starting with "-", "+", "*"
1347 ;; also start a new paragraph.
1348 (if (string-match "^ [-+*]-\\|^[ \t]*$" line) (org-open-par))
1350 ;; Is this the start of a footnote?
1351 (when org-export-with-footnotes
1352 (when (and (boundp 'footnote-section-tag-regexp)
1353 (string-match (concat "^" footnote-section-tag-regexp)
1354 line))
1355 ;; ignore this line
1356 (throw 'nextline nil))
1357 (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line)
1358 (org-close-par-maybe)
1359 (let ((n (match-string 1 line)))
1360 (setq org-par-open t
1361 line (replace-match
1362 (format
1363 (concat "<p class=\"footnote\">"
1364 (format org-export-html-footnote-format
1365 "<a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a>"))
1366 n n n) t t line)))))
1367 ;; Check if the line break needs to be conserved
1368 (cond
1369 ((string-match "\\\\\\\\[ \t]*$" line)
1370 (setq line (replace-match "<br/>" t t line)))
1371 (org-export-preserve-breaks
1372 (setq line (concat line "<br/>"))))
1374 ;; Check if a paragraph should be started
1375 (let ((start 0))
1376 (while (and org-par-open
1377 (string-match "\\\\par\\>" line start))
1378 ;; Leave a space in the </p> so that the footnote matcher
1379 ;; does not see this.
1380 (if (not (get-text-property (match-beginning 0)
1381 'org-protected line))
1382 (setq line (replace-match "</p ><p >" t t line)))
1383 (setq start (match-end 0))))
1385 (insert line "\n")))))
1387 ;; Properly close all local lists and other lists
1388 (when inquote
1389 (insert "</pre>\n")
1390 (org-open-par))
1391 (when in-local-list
1392 ;; Close any local lists before inserting a new header line
1393 (while local-list-type
1394 (org-close-li (car local-list-type))
1395 (insert (format "</%sl>\n" (car local-list-type)))
1396 (pop local-list-type))
1397 (setq local-list-indent nil
1398 in-local-list nil))
1399 (org-html-level-start 1 nil umax
1400 (and org-export-with-toc (<= level umax))
1401 head-count)
1402 ;; the </div> to close the last text-... div.
1403 (when (and (> umax 0) first-heading-pos) (insert "</div>\n"))
1405 (save-excursion
1406 (goto-char (point-min))
1407 (while (re-search-forward "<p class=\"footnote\">[^\000]*?\\(</p>\\|\\'\\)" nil t)
1408 (push (match-string 0) footnotes)
1409 (replace-match "" t t)))
1410 (when footnotes
1411 (insert (format org-export-html-footnotes-section
1412 (nth 4 lang-words)
1413 (mapconcat 'identity (nreverse footnotes) "\n"))
1414 "\n"))
1415 (let ((bib (org-export-html-get-bibliography)))
1416 (when bib
1417 (insert "\n" bib "\n")))
1418 (unless body-only
1419 (when (plist-get opt-plist :auto-postamble)
1420 (insert "<div id=\"postamble\">\n")
1421 (when (and org-export-author-info author)
1422 (insert "<p class=\"author\"> "
1423 (nth 1 lang-words) ": " author "\n")
1424 (when (and org-export-email-info email (string-match "\\S-" email))
1425 (if (listp (split-string email ",+ *"))
1426 (mapc (lambda(e)
1427 (insert "<a href=\"mailto:" e "\">&lt;"
1428 e "&gt;</a>\n"))
1429 (split-string email ",+ *"))
1430 (insert "<a href=\"mailto:" email "\">&lt;"
1431 email "&gt;</a>\n")))
1432 (insert "</p>\n"))
1433 (when (and date org-export-time-stamp-file)
1434 (insert "<p class=\"date\"> "
1435 (nth 2 lang-words) ": "
1436 date "</p>\n"))
1437 (when org-export-creator-info
1438 (insert (format "<p class=\"creator\">HTML generated by org-mode %s in emacs %s</p>\n"
1439 org-version emacs-major-version)))
1440 (when org-export-html-validation-link
1441 (insert org-export-html-validation-link "\n"))
1442 (insert "</div>"))
1444 (if org-export-html-with-timestamp
1445 (insert org-export-html-html-helper-timestamp))
1446 (org-export-html-insert-plist-item opt-plist :postamble opt-plist)
1447 (insert "\n</div>\n</body>\n</html>\n"))
1449 (unless (plist-get opt-plist :buffer-will-be-killed)
1450 (normal-mode)
1451 (if (eq major-mode (default-value 'major-mode))
1452 (html-mode)))
1454 ;; insert the table of contents
1455 (goto-char (point-min))
1456 (when thetoc
1457 (if (or (re-search-forward
1458 "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t)
1459 (re-search-forward
1460 "\\[TABLE-OF-CONTENTS\\]" nil t))
1461 (progn
1462 (goto-char (match-beginning 0))
1463 (replace-match ""))
1464 (goto-char first-heading-pos)
1465 (when (looking-at "\\s-*</p>")
1466 (goto-char (match-end 0))
1467 (insert "\n")))
1468 (insert "<div id=\"table-of-contents\">\n")
1469 (mapc 'insert thetoc)
1470 (insert "</div>\n"))
1471 ;; remove empty paragraphs and lists
1472 (goto-char (point-min))
1473 (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t)
1474 (replace-match ""))
1475 (goto-char (point-min))
1476 (while (re-search-forward "<li>[ \r\n\t]*</li>\n?" nil t)
1477 (replace-match ""))
1478 (goto-char (point-min))
1479 (while (re-search-forward "</ul>\\s-*<ul>\n?" nil t)
1480 (replace-match ""))
1481 ;; Convert whitespace place holders
1482 (goto-char (point-min))
1483 (let (beg end n)
1484 (while (setq beg (next-single-property-change (point) 'org-whitespace))
1485 (setq n (get-text-property beg 'org-whitespace)
1486 end (next-single-property-change beg 'org-whitespace))
1487 (goto-char beg)
1488 (delete-region beg end)
1489 (insert (format "<span style=\"visibility:hidden;\">%s</span>"
1490 (make-string n ?x)))))
1491 ;; Remove empty lines at the beginning of the file.
1492 (goto-char (point-min))
1493 (when (looking-at "\\s-+\n") (replace-match ""))
1494 ;; Remove display properties
1495 (remove-text-properties (point-min) (point-max) '(display t))
1496 ;; Run the hook
1497 (run-hooks 'org-export-html-final-hook)
1498 (or to-buffer (save-buffer))
1499 (goto-char (point-min))
1500 (or (org-export-push-to-kill-ring "HTML")
1501 (message "Exporting... done"))
1502 (if (eq to-buffer 'string)
1503 (prog1 (buffer-substring (point-min) (point-max))
1504 (kill-buffer (current-buffer)))
1505 (current-buffer)))))
1507 (defun org-export-html-insert-plist-item (plist key &rest args)
1508 (let ((item (plist-get plist key)))
1509 (cond ((functionp item)
1510 (apply item args))
1511 (item
1512 (insert item)))))
1514 (defun org-export-html-format-href (s)
1515 "Make sure the S is valid as a href reference in an XHTML document."
1516 (save-match-data
1517 (let ((start 0))
1518 (while (string-match "&" s start)
1519 (setq start (+ (match-beginning 0) 3)
1520 s (replace-match "&amp;" t t s)))))
1523 (defun org-export-html-format-desc (s)
1524 "Make sure the S is valid as a description in a link."
1525 (if (and s (not (get-text-property 1 'org-protected s)))
1526 (save-match-data
1527 (org-html-do-expand s))
1530 (defun org-export-html-format-image (src par-open)
1531 "Create image tag with source and attributes."
1532 (save-match-data
1533 (if (string-match "^ltxpng/" src)
1534 (format "<img src=\"%s\" alt=\"%s\"/>"
1535 src (org-find-text-property-in-string 'org-latex-src src))
1536 (let* ((caption (org-find-text-property-in-string 'org-caption src))
1537 (attr (org-find-text-property-in-string 'org-attributes src))
1538 (label (org-find-text-property-in-string 'org-label src)))
1539 (setq caption (and caption (org-html-do-expand caption)))
1540 (concat
1541 (if caption
1542 (format "%s<div %sclass=\"figure\">
1543 <p>"
1544 (if org-par-open "</p>\n" "")
1545 (if label (format "id=\"%s\" " label) "")))
1546 (format "<img src=\"%s\"%s />"
1548 (if (string-match "\\<alt=" (or attr ""))
1549 (concat " " attr )
1550 (concat " " attr " alt=\"" src "\"")))
1551 (if caption
1552 (format "</p>%s
1553 </div>%s"
1554 (concat "\n<p>" caption "</p>")
1555 (if org-par-open "\n<p>" ""))))))))
1557 (defun org-export-html-get-bibliography ()
1558 "Find bibliography, cut it out and return it."
1559 (catch 'exit
1560 (let (beg end (cnt 1) bib)
1561 (save-excursion
1562 (goto-char (point-min))
1563 (when (re-search-forward "^[ \t]*<div \\(id\\|class\\)=\"bibliography\"" nil t)
1564 (setq beg (match-beginning 0))
1565 (while (re-search-forward "</?div\\>" nil t)
1566 (setq cnt (+ cnt (if (string= (match-string 0) "<div") +1 -1)))
1567 (when (= cnt 0)
1568 (and (looking-at ">") (forward-char 1))
1569 (setq bib (buffer-substring beg (point)))
1570 (delete-region beg (point))
1571 (throw 'exit bib))))
1572 nil))))
1574 (defvar org-table-number-regexp) ; defined in org-table.el
1575 (defun org-format-table-html (lines olines)
1576 "Find out which HTML converter to use and return the HTML code."
1577 (if (stringp lines)
1578 (setq lines (org-split-string lines "\n")))
1579 (if (string-match "^[ \t]*|" (car lines))
1580 ;; A normal org table
1581 (org-format-org-table-html lines)
1582 ;; Table made by table.el - test for spanning
1583 (let* ((hlines (delq nil (mapcar
1584 (lambda (x)
1585 (if (string-match "^[ \t]*\\+-" x) x
1586 nil))
1587 lines)))
1588 (first (car hlines))
1589 (ll (and (string-match "\\S-+" first)
1590 (match-string 0 first)))
1591 (re (concat "^[ \t]*" (regexp-quote ll)))
1592 (spanning (delq nil (mapcar (lambda (x) (not (string-match re x)))
1593 hlines))))
1594 (if (and (not spanning)
1595 (not org-export-prefer-native-exporter-for-tables))
1596 ;; We can use my own converter with HTML conversions
1597 (org-format-table-table-html lines)
1598 ;; Need to use the code generator in table.el, with the original text.
1599 (org-format-table-table-html-using-table-generate-source olines)))))
1601 (defvar org-table-number-fraction) ; defined in org-table.el
1602 (defun org-format-org-table-html (lines &optional splice)
1603 "Format a table into HTML."
1604 (require 'org-table)
1605 ;; Get rid of hlines at beginning and end
1606 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
1607 (setq lines (nreverse lines))
1608 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
1609 (setq lines (nreverse lines))
1610 (when org-export-table-remove-special-lines
1611 ;; Check if the table has a marking column. If yes remove the
1612 ;; column and the special lines
1613 (setq lines (org-table-clean-before-export lines)))
1615 (let* ((caption (org-find-text-property-in-string 'org-caption (car lines)))
1616 (label (org-find-text-property-in-string 'org-label (car lines)))
1617 (attributes (org-find-text-property-in-string 'org-attributes
1618 (car lines)))
1619 (html-table-tag (org-export-splice-attributes
1620 html-table-tag attributes))
1621 (head (and org-export-highlight-first-table-line
1622 (delq nil (mapcar
1623 (lambda (x) (string-match "^[ \t]*|-" x))
1624 (cdr lines)))))
1626 (nline 0) fnum i
1627 tbopen line fields html gr colgropen rowstart rowend)
1628 (setq caption (and caption (org-html-do-expand caption)))
1629 (if splice (setq head nil))
1630 (unless splice (push (if head "<thead>" "<tbody>") html))
1631 (setq tbopen t)
1632 (while (setq line (pop lines))
1633 (catch 'next-line
1634 (if (string-match "^[ \t]*|-" line)
1635 (progn
1636 (unless splice
1637 (push (if head "</thead>" "</tbody>") html)
1638 (if lines (push "<tbody>" html) (setq tbopen nil)))
1639 (setq head nil) ;; head ends here, first time around
1640 ;; ignore this line
1641 (throw 'next-line t)))
1642 ;; Break the line into fields
1643 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
1644 (unless fnum (setq fnum (make-vector (length fields) 0)))
1645 (setq nline (1+ nline) i -1
1646 rowstart (eval (car org-export-table-row-tags))
1647 rowend (eval (cdr org-export-table-row-tags)))
1648 (push (concat rowstart
1649 (mapconcat
1650 (lambda (x)
1651 (setq i (1+ i))
1652 (if (and (< i nline)
1653 (string-match org-table-number-regexp x))
1654 (incf (aref fnum i)))
1655 (cond
1656 (head
1657 (concat
1658 (format (car org-export-table-header-tags) "col")
1660 (cdr org-export-table-header-tags)))
1661 ((and (= i 0) org-export-html-table-use-header-tags-for-first-column)
1662 (concat
1663 (format (car org-export-table-header-tags) "row")
1665 (cdr org-export-table-header-tags)))
1667 (concat (car org-export-table-data-tags) x
1668 (cdr org-export-table-data-tags)))))
1669 fields "")
1670 rowend)
1671 html)))
1672 (unless splice (if tbopen (push "</tbody>" html)))
1673 (unless splice (push "</table>\n" html))
1674 (setq html (nreverse html))
1675 (unless splice
1676 ;; Put in col tags with the alignment (unfortunately often ignored...)
1677 (unless (car org-table-colgroup-info)
1678 (setq org-table-colgroup-info
1679 (cons :start (cdr org-table-colgroup-info))))
1680 (push (mapconcat
1681 (lambda (x)
1682 (setq gr (pop org-table-colgroup-info))
1683 (format "%s<col align=\"%s\" />%s"
1684 (if (memq gr '(:start :startend))
1685 (prog1
1686 (if colgropen "</colgroup>\n<colgroup>" "<colgroup>")
1687 (setq colgropen t))
1689 (if (> (/ (float x) nline) org-table-number-fraction)
1690 "right" "left")
1691 (if (memq gr '(:end :startend))
1692 (progn (setq colgropen nil) "</colgroup>")
1693 "")))
1694 fnum "")
1695 html)
1696 (if colgropen (setq html (cons (car html) (cons "</colgroup>" (cdr html)))))
1697 ;; Since the output of HTML table formatter can also be used in
1698 ;; DocBook document, we want to always include the caption to make
1699 ;; DocBook XML file valid.
1700 (push (format "<caption>%s</caption>" (or caption "")) html)
1701 (when label (push (format "<a name=\"%s\" id=\"%s\"></a>" label label)
1702 html))
1703 (push html-table-tag html))
1704 (concat (mapconcat 'identity html "\n") "\n")))
1706 (defun org-export-splice-attributes (tag attributes)
1707 "Read attributes in string ATTRIBUTES, add and replace in HTML tag TAG."
1708 (if (not attributes)
1710 (let (oldatt newatt)
1711 (setq oldatt (org-extract-attributes-from-string tag)
1712 tag (pop oldatt)
1713 newatt (cdr (org-extract-attributes-from-string attributes)))
1714 (while newatt
1715 (setq oldatt (plist-put oldatt (pop newatt) (pop newatt))))
1716 (if (string-match ">" tag)
1717 (setq tag
1718 (replace-match (concat (org-attributes-to-string oldatt) ">")
1719 t t tag)))
1720 tag)))
1722 (defun org-format-table-table-html (lines)
1723 "Format a table generated by table.el into HTML.
1724 This conversion does *not* use `table-generate-source' from table.el.
1725 This has the advantage that Org-mode's HTML conversions can be used.
1726 But it has the disadvantage, that no cell- or row-spanning is allowed."
1727 (let (line field-buffer
1728 (head org-export-highlight-first-table-line)
1729 fields html empty i)
1730 (setq html (concat html-table-tag "\n"))
1731 (while (setq line (pop lines))
1732 (setq empty "&nbsp;")
1733 (catch 'next-line
1734 (if (string-match "^[ \t]*\\+-" line)
1735 (progn
1736 (if field-buffer
1737 (progn
1738 (setq
1739 html
1740 (concat
1741 html
1742 "<tr>"
1743 (mapconcat
1744 (lambda (x)
1745 (if (equal x "") (setq x empty))
1746 (if head
1747 (concat
1748 (format (car org-export-table-header-tags) "col")
1750 (cdr org-export-table-header-tags))
1751 (concat (car org-export-table-data-tags) x
1752 (cdr org-export-table-data-tags))))
1753 field-buffer "\n")
1754 "</tr>\n"))
1755 (setq head nil)
1756 (setq field-buffer nil)))
1757 ;; Ignore this line
1758 (throw 'next-line t)))
1759 ;; Break the line into fields and store the fields
1760 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
1761 (if field-buffer
1762 (setq field-buffer (mapcar
1763 (lambda (x)
1764 (concat x "<br/>" (pop fields)))
1765 field-buffer))
1766 (setq field-buffer fields))))
1767 (setq html (concat html "</table>\n"))
1768 html))
1770 (defun org-format-table-table-html-using-table-generate-source (lines)
1771 "Format a table into html, using `table-generate-source' from table.el.
1772 This has the advantage that cell- or row-spanning is allowed.
1773 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
1774 (require 'table)
1775 (with-current-buffer (get-buffer-create " org-tmp1 ")
1776 (erase-buffer)
1777 (insert (mapconcat 'identity lines "\n"))
1778 (goto-char (point-min))
1779 (if (not (re-search-forward "|[^+]" nil t))
1780 (error "Error processing table"))
1781 (table-recognize-table)
1782 (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
1783 (table-generate-source 'html " org-tmp2 ")
1784 (set-buffer " org-tmp2 ")
1785 (buffer-substring (point-min) (point-max))))
1787 (defun org-export-splice-style (style extra)
1788 "Splice EXTRA into STYLE, just before \"</style>\"."
1789 (if (and (stringp extra)
1790 (string-match "\\S-" extra)
1791 (string-match "</style>" style))
1792 (concat (substring style 0 (match-beginning 0))
1793 "\n" extra "\n"
1794 (substring style (match-beginning 0)))
1795 style))
1797 (defun org-html-handle-time-stamps (s)
1798 "Format time stamps in string S, or remove them."
1799 (catch 'exit
1800 (let (r b)
1801 (while (string-match org-maybe-keyword-time-regexp s)
1802 (or b (setq b (substring s 0 (match-beginning 0))))
1803 (setq r (concat
1804 r (substring s 0 (match-beginning 0))
1805 " @<span class=\"timestamp-wrapper\">"
1806 (if (match-end 1)
1807 (format "@<span class=\"timestamp-kwd\">%s @</span>"
1808 (match-string 1 s)))
1809 (format " @<span class=\"timestamp\">%s@</span>"
1810 (substring
1811 (org-translate-time (match-string 3 s)) 1 -1))
1812 "@</span>")
1813 s (substring s (match-end 0))))
1814 ;; Line break if line started and ended with time stamp stuff
1815 (if (not r)
1817 (setq r (concat r s))
1818 (unless (string-match "\\S-" (concat b s))
1819 (setq r (concat r "@<br/>")))
1820 r))))
1822 (defvar htmlize-buffer-places) ; from htmlize.el
1823 (defun org-export-htmlize-region-for-paste (beg end)
1824 "Convert the region to HTML, using htmlize.el.
1825 This is much like `htmlize-region-for-paste', only that it uses
1826 the settings define in the org-... variables."
1827 (let* ((htmlize-output-type org-export-htmlize-output-type)
1828 (htmlize-css-name-prefix org-export-htmlize-css-font-prefix)
1829 (htmlbuf (htmlize-region beg end)))
1830 (unwind-protect
1831 (with-current-buffer htmlbuf
1832 (buffer-substring (plist-get htmlize-buffer-places 'content-start)
1833 (plist-get htmlize-buffer-places 'content-end)))
1834 (kill-buffer htmlbuf))))
1836 ;;;###autoload
1837 (defun org-export-htmlize-generate-css ()
1838 "Create the CSS for all font definitions in the current Emacs session.
1839 Use this to create face definitions in your CSS style file that can then
1840 be used by code snippets transformed by htmlize.
1841 This command just produces a buffer that contains class definitions for all
1842 faces used in the current Emacs session. You can copy and paste the ones you
1843 need into your CSS file.
1845 If you then set `org-export-htmlize-output-type' to `css', calls to
1846 the function `org-export-htmlize-region-for-paste' will produce code
1847 that uses these same face definitions."
1848 (interactive)
1849 (require 'htmlize)
1850 (and (get-buffer "*html*") (kill-buffer "*html*"))
1851 (with-temp-buffer
1852 (let ((fl (face-list))
1853 (htmlize-css-name-prefix "org-")
1854 (htmlize-output-type 'css)
1855 f i)
1856 (while (setq f (pop fl)
1857 i (and f (face-attribute f :inherit)))
1858 (when (and (symbolp f) (or (not i) (not (listp i))))
1859 (insert (org-add-props (copy-sequence "1") nil 'face f))))
1860 (htmlize-region (point-min) (point-max))))
1861 (switch-to-buffer "*html*")
1862 (goto-char (point-min))
1863 (if (re-search-forward "<style" nil t)
1864 (delete-region (point-min) (match-beginning 0)))
1865 (if (re-search-forward "</style>" nil t)
1866 (delete-region (1+ (match-end 0)) (point-max)))
1867 (beginning-of-line 1)
1868 (if (looking-at " +") (replace-match ""))
1869 (goto-char (point-min)))
1871 (defun org-html-protect (s)
1872 ;; convert & to &amp;, < to &lt; and > to &gt;
1873 (let ((start 0))
1874 (while (string-match "&" s start)
1875 (setq s (replace-match "&amp;" t t s)
1876 start (1+ (match-beginning 0))))
1877 (while (string-match "<" s)
1878 (setq s (replace-match "&lt;" t t s)))
1879 (while (string-match ">" s)
1880 (setq s (replace-match "&gt;" t t s)))
1881 ; (while (string-match "\"" s)
1882 ; (setq s (replace-match "&quot;" t t s)))
1886 (defun org-html-expand (string)
1887 "Prepare STRING for HTML export. Applies all active conversions.
1888 If there are links in the string, don't modify these."
1889 (let* ((re (concat org-bracket-link-regexp "\\|"
1890 (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$")))
1891 m s l res)
1892 (if (string-match "^[ \t]*\\+-[-+]*\\+[ \t]*$" string)
1893 string
1894 (while (setq m (string-match re string))
1895 (setq s (substring string 0 m)
1896 l (match-string 0 string)
1897 string (substring string (match-end 0)))
1898 (push (org-html-do-expand s) res)
1899 (push l res))
1900 (push (org-html-do-expand string) res)
1901 (apply 'concat (nreverse res)))))
1903 (defun org-html-do-expand (s)
1904 "Apply all active conversions to translate special ASCII to HTML."
1905 (setq s (org-html-protect s))
1906 (if org-export-html-expand
1907 (while (string-match "@&lt;\\([^&]*\\)&gt;" s)
1908 (setq s (replace-match "<\\1>" t nil s))))
1909 (if org-export-with-emphasize
1910 (setq s (org-export-html-convert-emphasize s)))
1911 (if org-export-with-special-strings
1912 (setq s (org-export-html-convert-special-strings s)))
1913 (if org-export-with-sub-superscripts
1914 (setq s (org-export-html-convert-sub-super s)))
1915 (if org-export-with-TeX-macros
1916 (let ((start 0) wd rep)
1917 (while (setq start (string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
1918 s start))
1919 (if (get-text-property (match-beginning 0) 'org-protected s)
1920 (setq start (match-end 0))
1921 (setq wd (match-string 1 s))
1922 (if (setq rep (org-entity-get-representation wd 'html))
1923 (setq s (replace-match rep t t s))
1924 (setq start (+ start (length wd))))))))
1927 (defun org-export-html-convert-special-strings (string)
1928 "Convert special characters in STRING to HTML."
1929 (let ((all org-export-html-special-string-regexps)
1930 e a re rpl start)
1931 (while (setq a (pop all))
1932 (setq re (car a) rpl (cdr a) start 0)
1933 (while (string-match re string start)
1934 (if (get-text-property (match-beginning 0) 'org-protected string)
1935 (setq start (match-end 0))
1936 (setq string (replace-match rpl t nil string)))))
1937 string))
1939 (defun org-export-html-convert-sub-super (string)
1940 "Convert sub- and superscripts in STRING to HTML."
1941 (let (key c (s 0) (requireb (eq org-export-with-sub-superscripts '{})))
1942 (while (string-match org-match-substring-regexp string s)
1943 (cond
1944 ((and requireb (match-end 8)) (setq s (match-end 2)))
1945 ((get-text-property (match-beginning 2) 'org-protected string)
1946 (setq s (match-end 2)))
1948 (setq s (match-end 1)
1949 key (if (string= (match-string 2 string) "_") "sub" "sup")
1950 c (or (match-string 8 string)
1951 (match-string 6 string)
1952 (match-string 5 string))
1953 string (replace-match
1954 (concat (match-string 1 string)
1955 "<" key ">" c "</" key ">")
1956 t t string)))))
1957 (while (string-match "\\\\\\([_^]\\)" string)
1958 (setq string (replace-match (match-string 1 string) t t string)))
1959 string))
1961 (defun org-export-html-convert-emphasize (string)
1962 "Apply emphasis."
1963 (let ((s 0) rpl)
1964 (while (string-match org-emph-re string s)
1965 (if (not (equal
1966 (substring string (match-beginning 3) (1+ (match-beginning 3)))
1967 (substring string (match-beginning 4) (1+ (match-beginning 4)))))
1968 (setq s (match-beginning 0)
1970 (concat
1971 (match-string 1 string)
1972 (nth 2 (assoc (match-string 3 string) org-emphasis-alist))
1973 (match-string 4 string)
1974 (nth 3 (assoc (match-string 3 string)
1975 org-emphasis-alist))
1976 (match-string 5 string))
1977 string (replace-match rpl t t string)
1978 s (+ s (- (length rpl) 2)))
1979 (setq s (1+ s))))
1980 string))
1982 (defun org-open-par ()
1983 "Insert <p>, but first close previous paragraph if any."
1984 (org-close-par-maybe)
1985 (insert "\n<p>")
1986 (setq org-par-open t))
1987 (defun org-close-par-maybe ()
1988 "Close paragraph if there is one open."
1989 (when org-par-open
1990 (insert "</p>")
1991 (setq org-par-open nil)))
1992 (defun org-close-li (&optional type)
1993 "Close <li> if necessary."
1994 (org-close-par-maybe)
1995 (insert (if (equal type "d") "</dd>\n" "</li>\n")))
1997 (defvar in-local-list)
1998 (defvar local-list-indent)
1999 (defvar local-list-type)
2000 (defun org-export-html-close-lists-maybe (line)
2001 (let* ((rawhtml (and in-local-list
2002 (get-text-property 0 'org-protected line)))
2003 (ind (if rawhtml
2004 (org-get-indentation line)
2005 (or (get-text-property 0 'original-indentation line))))
2006 didclose)
2007 (when ind
2008 (while (and in-local-list
2009 (<= ind (car local-list-indent)))
2010 (setq didclose t)
2011 (org-close-li (car local-list-type))
2012 (insert (format "</%sl>\n" (car local-list-type)))
2013 (pop local-list-type) (pop local-list-indent)
2014 (setq in-local-list local-list-indent))
2015 (and didclose (org-open-par)))))
2017 (defvar body-only) ; dynamically scoped into this.
2018 (defun org-html-level-start (level title umax with-toc head-count)
2019 "Insert a new level in HTML export.
2020 When TITLE is nil, just close all open levels."
2021 (org-close-par-maybe)
2022 (let* ((target (and title (org-get-text-property-any 0 'target title)))
2023 (extra-targets (and target
2024 (assoc target org-export-target-aliases)))
2025 (extra-class (and title (org-get-text-property-any 0 'html-container-class title)))
2026 (preferred (and target
2027 (cdr (assoc target org-export-preferred-target-alist))))
2028 (remove (or preferred target))
2029 (l org-level-max)
2030 snumber href suffix)
2031 (setq extra-targets (remove remove extra-targets))
2032 (setq extra-targets
2033 (mapconcat (lambda (x)
2034 (if (org-uuidgen-p x) (setq x (concat "ID-" x)))
2035 (format "<a name=\"%s\" id=\"%s\"></a>"
2036 x x))
2037 extra-targets
2038 ""))
2039 (while (>= l level)
2040 (if (aref org-levels-open (1- l))
2041 (progn
2042 (org-html-level-close l umax)
2043 (aset org-levels-open (1- l) nil)))
2044 (setq l (1- l)))
2045 (when title
2046 ;; If title is nil, this means this function is called to close
2047 ;; all levels, so the rest is done only if title is given
2048 (when (string-match (org-re "\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title)
2049 (setq title (replace-match
2050 (if org-export-with-tags
2051 (save-match-data
2052 (concat
2053 "&nbsp;&nbsp;&nbsp;<span class=\"tag\">"
2054 (mapconcat
2055 (lambda (x)
2056 (format "<span class=\"%s\">%s</span>"
2057 (org-export-html-get-tag-class-name x)
2059 (org-split-string (match-string 1 title) ":")
2060 "&nbsp;")
2061 "</span>"))
2063 t t title)))
2064 (if (> level umax)
2065 (progn
2066 (if (aref org-levels-open (1- level))
2067 (progn
2068 (org-close-li)
2069 (if target
2070 (insert (format "<li id=\"%s\">" target) extra-targets title "<br/>\n")
2071 (insert "<li>" title "<br/>\n")))
2072 (aset org-levels-open (1- level) t)
2073 (org-close-par-maybe)
2074 (if target
2075 (insert (format "<ul>\n<li id=\"%s\">" target)
2076 extra-targets title "<br/>\n")
2077 (insert "<ul>\n<li>" title "<br/>\n"))))
2078 (aset org-levels-open (1- level) t)
2079 (setq snumber (org-section-number level))
2080 (setq level (+ level org-export-html-toplevel-hlevel -1))
2081 (if (and org-export-with-section-numbers (not body-only))
2082 (setq title (concat
2083 (format "<span class=\"section-number-%d\">%s</span>"
2084 level snumber)
2085 " " title)))
2086 (unless (= head-count 1) (insert "\n</div>\n"))
2087 (setq href (cdr (assoc (concat "sec-" snumber) org-export-preferred-target-alist)))
2088 (setq suffix (or href snumber))
2089 (setq href (or href (concat "sec-" snumber)))
2090 (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"
2091 suffix level (if extra-class (concat " " extra-class) "")
2092 level href
2093 extra-targets
2094 title level level suffix))
2095 (org-open-par)))))
2097 (defun org-export-html-get-tag-class-name (tag)
2098 "Turn tag into a valid class name.
2099 Replaces invalid characters with \"_\" and then prepends a prefix."
2100 (save-match-data
2101 (while (string-match "[^a-zA-Z0-9_]" tag)
2102 (setq tag (replace-match "_" t t tag))))
2103 (concat org-export-html-tag-class-prefix tag))
2105 (defun org-export-html-get-todo-kwd-class-name (kwd)
2106 "Turn todo keyword into a valid class name.
2107 Replaces invalid characters with \"_\" and then prepends a prefix."
2108 (save-match-data
2109 (while (string-match "[^a-zA-Z0-9_]" kwd)
2110 (setq kwd (replace-match "_" t t kwd))))
2111 (concat org-export-html-todo-kwd-class-prefix kwd))
2113 (defun org-html-level-close (level max-outline-level)
2114 "Terminate one level in HTML export."
2115 (if (<= level max-outline-level)
2116 (insert "</div>\n")
2117 (org-close-li)
2118 (insert "</ul>\n")))
2120 (provide 'org-html)
2122 ;; arch-tag: 8109d84d-eb8f-460b-b1a8-f45f3a6c7ea1
2123 ;;; org-html.el ends here