Fix docstring for org-export-html-{pre, post}amble
[org-mode.git] / lisp / org-html.el
blobe78b7974139a3ba0a93699391e98f970f0f0e4ab
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.36trans
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 after <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 before </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)
537 ;;; org-html-cvt-link-fn
538 (defconst org-html-cvt-link-fn
540 "Function to convert link URLs to exportable URLs.
541 Takes two arguments, TYPE and PATH.
542 Returns exportable url as (TYPE PATH), or `nil' to signal that it
543 didn't handle this case.
544 Intended to be locally bound around a call to `org-export-as-html'." )
546 (defun org-html-cvt-org-as-html (opt-plist type path)
547 "Convert and org filename to an equivalent html filename.
548 If TYPE is not file, just return `nil'.
549 See variable `org-export-html-link-org-files-as-html'"
551 (save-match-data
552 (and
553 org-export-html-link-org-files-as-html
554 (string= type "file")
555 (string-match "\\.org$" path)
556 (progn
557 (list
558 "http"
559 (concat
560 (substring path 0 (match-beginning 0))
561 "."
562 (plist-get opt-plist :html-extension)))))))
565 ;;; org-html-should-inline-p
566 (defun org-html-should-inline-p (filename descp)
567 "Return non-nil if link FILENAME should be inlined, according to
568 current settings.
569 DESCP is the boolean of whether there was a link description.
570 See variables `org-export-html-inline-images' and
571 `org-export-html-inline-image-extensions'."
572 (declare (special
573 org-export-html-inline-images
574 org-export-html-inline-image-extensions))
575 (or
576 (eq t org-export-html-inline-images)
577 (and
578 org-export-html-inline-images
579 (not descp)))
580 (org-file-image-p
581 filename org-export-html-inline-image-extensions))
583 ;;; org-html-make-link
584 (defun org-html-make-link (opt-plist type path fragment desc attr
585 may-inline-p)
586 "Make an HTML link.
587 OPT-PLIST is an options list.
588 TYPE is the device-type of the link (THIS://foo.html)
589 PATH is the path of the link (http://THIS#locationx)
590 FRAGMENT is the fragment part of the link, if any (foo.html#THIS)
591 DESC is the link description, if any.
592 ATTR is a string of other attributes of the a element.
593 MAY-INLINE-P allows inlining it as an image."
595 (declare (special org-par-open))
596 (save-match-data
597 (let* ((filename path)
598 ;;First pass. Just sanity stuff.
599 (components-1
600 (cond
601 ((string= type "file")
602 (list
603 type
604 ;;Substitute just if original path was absolute.
605 ;;(Otherwise path must remain relative)
606 (if (file-name-absolute-p path)
607 (expand-file-name path)
608 path)))
609 ((string= type "")
610 (list nil path))
611 (t (list type path))))
613 ;;Second pass. Components converted so they can refer
614 ;;to a remote site.
615 (components-2
617 (and org-html-cvt-link-fn
618 (apply org-html-cvt-link-fn
619 opt-plist components-1))
620 (apply #'org-html-cvt-org-as-html
621 opt-plist components-1)
622 components-1))
623 (type (first components-2))
624 (thefile (second components-2)))
627 ;;Third pass. Build final link except for leading type
628 ;;spec.
629 (cond
630 ((or
631 (not type)
632 (string= type "http")
633 (string= type "https"))
634 (if fragment
635 (setq thefile (concat thefile "#" fragment))))
637 (t))
639 ;;Final URL-build, for all types.
640 (setq thefile
641 (let
642 ((str (org-export-html-format-href thefile)))
643 (if (and type (string-match "^//" str))
644 (concat type ":" str)
645 str)))
647 (if (and
648 may-inline-p
649 ;;Can't inline a URL with a fragment.
650 (not fragment))
651 (progn
652 (message "image %s %s" thefile org-par-open)
653 (org-export-html-format-image thefile org-par-open))
654 (concat
655 "<a href=\"" thefile "\"" attr ">"
656 (org-export-html-format-desc desc)
657 "</a>")))))
659 ;;; org-export-as-html
660 ;;;###autoload
661 (defun org-export-as-html (arg &optional hidden ext-plist
662 to-buffer body-only pub-dir)
663 "Export the outline as a pretty HTML file.
664 If there is an active region, export only the region. The prefix
665 ARG specifies how many levels of the outline should become
666 headlines. The default is 3. Lower levels will become bulleted
667 lists. HIDDEN is obsolete and does nothing.
668 EXT-PLIST is a property list with external parameters overriding
669 org-mode's default settings, but still inferior to file-local
670 settings. When TO-BUFFER is non-nil, create a buffer with that
671 name and export to that buffer. If TO-BUFFER is the symbol
672 `string', don't leave any buffer behind but just return the
673 resulting HTML as a string. When BODY-ONLY is set, don't produce
674 the file header and footer, simply return the content of
675 <body>...</body>, without even the body tags themselves. When
676 PUB-DIR is set, use this as the publishing directory."
677 (interactive "P")
678 (run-hooks 'org-export-first-hook)
680 ;; Make sure we have a file name when we need it.
681 (when (and (not (or to-buffer body-only))
682 (not buffer-file-name))
683 (if (buffer-base-buffer)
684 (org-set-local 'buffer-file-name
685 (with-current-buffer (buffer-base-buffer)
686 buffer-file-name))
687 (error "Need a file name to be able to export")))
689 (message "Exporting...")
690 (setq-default org-todo-line-regexp org-todo-line-regexp)
691 (setq-default org-deadline-line-regexp org-deadline-line-regexp)
692 (setq-default org-done-keywords org-done-keywords)
693 (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp)
694 (let* ((opt-plist
695 (org-export-process-option-filters
696 (org-combine-plists (org-default-export-plist)
697 ext-plist
698 (org-infile-export-plist))))
699 (body-only (or body-only (plist-get opt-plist :body-only)))
700 (style (concat (if (plist-get opt-plist :style-include-default)
701 org-export-html-style-default)
702 (plist-get opt-plist :style)
703 (plist-get opt-plist :style-extra)
704 "\n"
705 (if (plist-get opt-plist :style-include-scripts)
706 org-export-html-scripts)))
707 (html-extension (plist-get opt-plist :html-extension))
708 (link-validate (plist-get opt-plist :link-validation-function))
709 valid thetoc have-headings first-heading-pos
710 (odd org-odd-levels-only)
711 (region-p (org-region-active-p))
712 (rbeg (and region-p (region-beginning)))
713 (rend (and region-p (region-end)))
714 (subtree-p
715 (if (plist-get opt-plist :ignore-subtree-p)
717 (when region-p
718 (save-excursion
719 (goto-char rbeg)
720 (and (org-at-heading-p)
721 (>= (org-end-of-subtree t t) rend))))))
722 (level-offset (if subtree-p
723 (save-excursion
724 (goto-char rbeg)
725 (+ (funcall outline-level)
726 (if org-odd-levels-only 1 0)))
728 (opt-plist (setq org-export-opt-plist
729 (if subtree-p
730 (org-export-add-subtree-options opt-plist rbeg)
731 opt-plist)))
732 ;; The following two are dynamically scoped into other
733 ;; routines below.
734 (org-current-export-dir
735 (or pub-dir (org-export-directory :html opt-plist)))
736 (org-current-export-file buffer-file-name)
737 (level 0) (line "") (origline "") txt todo
738 (umax nil)
739 (umax-toc nil)
740 (filename (if to-buffer nil
741 (expand-file-name
742 (concat
743 (file-name-sans-extension
744 (or (and subtree-p
745 (org-entry-get (region-beginning)
746 "EXPORT_FILE_NAME" t))
747 (file-name-nondirectory buffer-file-name)))
748 "." html-extension)
749 (file-name-as-directory
750 (or pub-dir (org-export-directory :html opt-plist))))))
751 (current-dir (if buffer-file-name
752 (file-name-directory buffer-file-name)
753 default-directory))
754 (buffer (if to-buffer
755 (cond
756 ((eq to-buffer 'string) (get-buffer-create "*Org HTML Export*"))
757 (t (get-buffer-create to-buffer)))
758 (find-file-noselect filename)))
759 (org-levels-open (make-vector org-level-max nil))
760 (date (plist-get opt-plist :date))
761 (author (plist-get opt-plist :author))
762 (title (or (and subtree-p (org-export-get-title-from-subtree))
763 (plist-get opt-plist :title)
764 (and (not body-only)
765 (not
766 (plist-get opt-plist :skip-before-1st-heading))
767 (org-export-grab-title-from-buffer))
768 (and buffer-file-name
769 (file-name-sans-extension
770 (file-name-nondirectory buffer-file-name)))
771 "UNTITLED"))
772 (link-up (and (plist-get opt-plist :link-up)
773 (string-match "\\S-" (plist-get opt-plist :link-up))
774 (plist-get opt-plist :link-up)))
775 (link-home (and (plist-get opt-plist :link-home)
776 (string-match "\\S-" (plist-get opt-plist :link-home))
777 (plist-get opt-plist :link-home)))
778 (dummy (setq opt-plist (plist-put opt-plist :title title)))
779 (html-table-tag (plist-get opt-plist :html-table-tag))
780 (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
781 (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string "\\>\\)"))
782 (inquote nil)
783 (infixed nil)
784 (inverse nil)
785 (in-local-list nil)
786 (local-list-type nil)
787 (local-list-indent nil)
788 (llt org-plain-list-ordered-item-terminator)
789 (email (plist-get opt-plist :email))
790 (language (plist-get opt-plist :language))
791 (keywords (plist-get opt-plist :keywords))
792 (description (plist-get opt-plist :description))
793 (lang-words nil)
794 (head-count 0) cnt
795 (start 0)
796 (coding-system (and (boundp 'buffer-file-coding-system)
797 buffer-file-coding-system))
798 (coding-system-for-write (or org-export-html-coding-system
799 coding-system))
800 (save-buffer-coding-system (or org-export-html-coding-system
801 coding-system))
802 (charset (and coding-system-for-write
803 (fboundp 'coding-system-get)
804 (coding-system-get coding-system-for-write
805 'mime-charset)))
806 (region
807 (buffer-substring
808 (if region-p (region-beginning) (point-min))
809 (if region-p (region-end) (point-max))))
810 (lines
811 (org-split-string
812 (org-export-preprocess-string
813 region
814 :emph-multiline t
815 :for-html t
816 :skip-before-1st-heading
817 (plist-get opt-plist :skip-before-1st-heading)
818 :drawers (plist-get opt-plist :drawers)
819 :todo-keywords (plist-get opt-plist :todo-keywords)
820 :tags (plist-get opt-plist :tags)
821 :priority (plist-get opt-plist :priority)
822 :footnotes (plist-get opt-plist :footnotes)
823 :timestamps (plist-get opt-plist :timestamps)
824 :archived-trees
825 (plist-get opt-plist :archived-trees)
826 :select-tags (plist-get opt-plist :select-tags)
827 :exclude-tags (plist-get opt-plist :exclude-tags)
828 :add-text
829 (plist-get opt-plist :text)
830 :LaTeX-fragments
831 (plist-get opt-plist :LaTeX-fragments))
832 "[\r\n]"))
833 table-open type
834 table-buffer table-orig-buffer
835 ind item-type starter didclose
836 rpl path attr desc descp desc1 desc2 link
837 snumber fnc item-tag initial-number
838 footnotes footref-seen
839 id-file href
842 (let ((inhibit-read-only t))
843 (org-unmodified
844 (remove-text-properties (point-min) (point-max)
845 '(:org-license-to-kill t))))
847 (message "Exporting...")
849 (setq org-min-level (org-get-min-level lines level-offset))
850 (setq org-last-level org-min-level)
851 (org-init-section-numbers)
853 (cond
854 ((and date (string-match "%" date))
855 (setq date (format-time-string date)))
856 (date)
857 (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
859 ;; Get the language-dependent settings
860 (setq lang-words (or (assoc language org-export-language-setup)
861 (assoc "en" org-export-language-setup)))
863 ;; Switch to the output buffer
864 (set-buffer buffer)
865 (let ((inhibit-read-only t)) (erase-buffer))
866 (fundamental-mode)
867 (org-install-letbind)
869 (and (fboundp 'set-buffer-file-coding-system)
870 (set-buffer-file-coding-system coding-system-for-write))
872 (let ((case-fold-search nil)
873 (org-odd-levels-only odd))
874 ;; create local variables for all options, to make sure all called
875 ;; functions get the correct information
876 (mapc (lambda (x)
877 (set (make-local-variable (nth 2 x))
878 (plist-get opt-plist (car x))))
879 org-export-plist-vars)
880 (setq umax (if arg (prefix-numeric-value arg)
881 org-export-headline-levels))
882 (setq umax-toc (if (integerp org-export-with-toc)
883 (min org-export-with-toc umax)
884 umax))
885 (unless body-only
886 ;; File header
887 (insert (format
889 <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
890 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
891 <html xmlns=\"http://www.w3.org/1999/xhtml\"
892 lang=\"%s\" xml:lang=\"%s\">
893 <head>
894 <title>%s</title>
895 <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
896 <meta name=\"generator\" content=\"Org-mode\"/>
897 <meta name=\"generated\" content=\"%s\"/>
898 <meta name=\"author\" content=\"%s\"/>
899 <meta name=\"description\" content=\"%s\"/>
900 <meta name=\"keywords\" content=\"%s\"/>
902 </head>
903 <body>
904 <div id=\"content\">
907 (format
908 (or (and (stringp org-export-html-xml-declaration)
909 org-export-html-xml-declaration)
910 (cdr (assoc html-extension org-export-html-xml-declaration))
911 (cdr (assoc "html" org-export-html-xml-declaration))
914 (or charset "iso-8859-1"))
915 language language
916 (org-html-expand title)
917 (or charset "iso-8859-1")
918 date author description keywords
919 style
920 (if (or link-up link-home)
921 (concat
922 (format org-export-html-home/up-format
923 (or link-up link-home)
924 (or link-home link-up))
925 "\n")
926 "")))
928 (org-export-html-insert-plist-item opt-plist :preamble opt-plist)
930 (when (plist-get opt-plist :auto-preamble)
931 (if title (insert (format org-export-html-title-format
932 (org-html-expand title))))))
934 (if (and org-export-with-toc (not body-only))
935 (progn
936 (push (format "<h%d>%s</h%d>\n"
937 org-export-html-toplevel-hlevel
938 (nth 3 lang-words)
939 org-export-html-toplevel-hlevel)
940 thetoc)
941 (push "<div id=\"text-table-of-contents\">\n" thetoc)
942 (push "<ul>\n<li>" thetoc)
943 (setq lines
944 (mapcar '(lambda (line)
945 (if (and (string-match org-todo-line-regexp line)
946 (not (get-text-property 0 'org-protected line)))
947 ;; This is a headline
948 (progn
949 (setq have-headings t)
950 (setq level (- (match-end 1) (match-beginning 1)
951 level-offset)
952 level (org-tr-level level)
953 txt (save-match-data
954 (org-html-expand
955 (org-export-cleanup-toc-line
956 (match-string 3 line))))
957 todo
958 (or (and org-export-mark-todo-in-toc
959 (match-beginning 2)
960 (not (member (match-string 2 line)
961 org-done-keywords)))
962 ; TODO, not DONE
963 (and org-export-mark-todo-in-toc
964 (= level umax-toc)
965 (org-search-todo-below
966 line lines level))))
967 (if (string-match
968 (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt)
969 (setq txt (replace-match "&nbsp;&nbsp;&nbsp;<span class=\"tag\"> \\1</span>" t nil txt)))
970 (if (string-match quote-re0 txt)
971 (setq txt (replace-match "" t t txt)))
972 (setq snumber (org-section-number level))
973 (if org-export-with-section-numbers
974 (setq txt (concat snumber " " txt)))
975 (if (<= level (max umax umax-toc))
976 (setq head-count (+ head-count 1)))
977 (if (<= level umax-toc)
978 (progn
979 (if (> level org-last-level)
980 (progn
981 (setq cnt (- level org-last-level))
982 (while (>= (setq cnt (1- cnt)) 0)
983 (push "\n<ul>\n<li>" thetoc))
984 (push "\n" thetoc)))
985 (if (< level org-last-level)
986 (progn
987 (setq cnt (- org-last-level level))
988 (while (>= (setq cnt (1- cnt)) 0)
989 (push "</li>\n</ul>" thetoc))
990 (push "\n" thetoc)))
991 ;; Check for targets
992 (while (string-match org-any-target-regexp line)
993 (setq line (replace-match
994 (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
995 t t line)))
996 (while (string-match "&lt;\\(&lt;\\)+\\|&gt;\\(&gt;\\)+" txt)
997 (setq txt (replace-match "" t t txt)))
998 (setq href
999 (replace-regexp-in-string
1000 "\\." "_" (format "sec-%s" snumber)))
1001 (setq href (or (cdr (assoc href org-export-preferred-target-alist)) href))
1002 (push
1003 (format
1004 (if todo
1005 "</li>\n<li><a href=\"#%s\"><span class=\"todo\">%s</span></a>"
1006 "</li>\n<li><a href=\"#%s\">%s</a>")
1007 href txt) thetoc)
1009 (setq org-last-level level))
1011 line)
1012 lines))
1013 (while (> org-last-level (1- org-min-level))
1014 (setq org-last-level (1- org-last-level))
1015 (push "</li>\n</ul>\n" thetoc))
1016 (push "</div>\n" thetoc)
1017 (setq thetoc (if have-headings (nreverse thetoc) nil))))
1019 (setq head-count 0)
1020 (org-init-section-numbers)
1022 (org-open-par)
1024 (while (setq line (pop lines) origline line)
1025 (catch 'nextline
1027 ;; end of quote section?
1028 (when (and inquote (string-match "^\\*+ " line))
1029 (insert "</pre>\n")
1030 (org-open-par)
1031 (setq inquote nil))
1032 ;; inside a quote section?
1033 (when inquote
1034 (insert (org-html-protect line) "\n")
1035 (throw 'nextline nil))
1037 ;; Fixed-width, verbatim lines (examples)
1038 (when (and org-export-with-fixed-width
1039 (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line))
1040 (when (not infixed)
1041 (setq infixed t)
1042 (org-close-par-maybe)
1044 (insert "<pre class=\"example\">\n"))
1045 (insert (org-html-protect (match-string 3 line)) "\n")
1046 (when (or (not lines)
1047 (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
1048 (car lines))))
1049 (setq infixed nil)
1050 (insert "</pre>\n")
1051 (org-open-par))
1052 (throw 'nextline nil))
1054 (org-export-html-close-lists-maybe line)
1056 ;; Protected HTML
1057 (when (get-text-property 0 'org-protected line)
1058 (let (par (ind (get-text-property 0 'original-indentation line)))
1059 (when (re-search-backward
1060 "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t)
1061 (setq par (match-string 1))
1062 (replace-match "\\2\n"))
1063 (insert line "\n")
1064 (while (and lines
1065 (or (= (length (car lines)) 0)
1066 (not ind)
1067 (equal ind (get-text-property 0 'original-indentation (car lines))))
1068 (or (= (length (car lines)) 0)
1069 (get-text-property 0 'org-protected (car lines))))
1070 (insert (pop lines) "\n"))
1071 (and par (insert "<p>\n")))
1072 (throw 'nextline nil))
1074 ;; Blockquotes, verse, and center
1075 (when (equal "ORG-BLOCKQUOTE-START" line)
1076 (org-close-par-maybe)
1077 (insert "<blockquote>\n")
1078 (org-open-par)
1079 (throw 'nextline nil))
1080 (when (equal "ORG-BLOCKQUOTE-END" line)
1081 (org-close-par-maybe)
1082 (insert "\n</blockquote>\n")
1083 (org-open-par)
1084 (throw 'nextline nil))
1085 (when (equal "ORG-VERSE-START" line)
1086 (org-close-par-maybe)
1087 (insert "\n<p class=\"verse\">\n")
1088 (setq org-par-open t)
1089 (setq inverse t)
1090 (throw 'nextline nil))
1091 (when (equal "ORG-VERSE-END" line)
1092 (insert "</p>\n")
1093 (setq org-par-open nil)
1094 (org-open-par)
1095 (setq inverse nil)
1096 (throw 'nextline nil))
1097 (when (equal "ORG-CENTER-START" line)
1098 (org-close-par-maybe)
1099 (insert "\n<div style=\"text-align: center\">")
1100 (org-open-par)
1101 (throw 'nextline nil))
1102 (when (equal "ORG-CENTER-END" line)
1103 (org-close-par-maybe)
1104 (insert "\n</div>")
1105 (org-open-par)
1106 (throw 'nextline nil))
1107 (run-hooks 'org-export-html-after-blockquotes-hook)
1108 (when inverse
1109 (let ((i (org-get-string-indentation line)))
1110 (if (> i 0)
1111 (setq line (concat (mapconcat 'identity
1112 (make-list (* 2 i) "\\nbsp") "")
1113 " " (org-trim line))))
1114 (unless (string-match "\\\\\\\\[ \t]*$" line)
1115 (setq line (concat line "\\\\")))))
1117 ;; make targets to anchors
1118 (setq start 0)
1119 (while (string-match
1120 "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start)
1121 (cond
1122 ((get-text-property (match-beginning 1) 'org-protected line)
1123 (setq start (match-end 1)))
1124 ((match-end 2)
1125 (setq line (replace-match
1126 (format
1127 "@<a name=\"%s\" id=\"%s\">@</a>"
1128 (org-solidify-link-text (match-string 1 line))
1129 (org-solidify-link-text (match-string 1 line)))
1130 t t line)))
1131 ((and org-export-with-toc (equal (string-to-char line) ?*))
1132 ;; FIXME: NOT DEPENDENT on TOC?????????????????????
1133 (setq line (replace-match
1134 (concat "@<span class=\"target\">"
1135 (match-string 1 line) "@</span> ")
1136 ;; (concat "@<i>" (match-string 1 line) "@</i> ")
1137 t t line)))
1139 (setq line (replace-match
1140 (concat "@<a name=\""
1141 (org-solidify-link-text (match-string 1 line))
1142 "\" class=\"target\">" (match-string 1 line)
1143 "@</a> ")
1144 t t line)))))
1146 (setq line (org-html-handle-time-stamps line))
1148 ;; replace "&" by "&amp;", "<" and ">" by "&lt;" and "&gt;"
1149 ;; handle @<..> HTML tags (replace "@&gt;..&lt;" by "<..>")
1150 ;; Also handle sub_superscripts and checkboxes
1151 (or (string-match org-table-hline-regexp line)
1152 (setq line (org-html-expand line)))
1154 ;; Format the links
1155 (setq start 0)
1156 (while (string-match org-bracket-link-analytic-regexp++ line start)
1157 (setq start (match-beginning 0))
1158 (setq path (save-match-data (org-link-unescape
1159 (match-string 3 line))))
1160 (setq type (cond
1161 ((match-end 2) (match-string 2 line))
1162 ((save-match-data
1163 (or (file-name-absolute-p path)
1164 (string-match "^\\.\\.?/" path)))
1165 "file")
1166 (t "internal")))
1167 (setq path (org-extract-attributes (org-link-unescape path)))
1168 (setq attr (get-text-property 0 'org-attributes path))
1169 (setq desc1 (if (match-end 5) (match-string 5 line))
1170 desc2 (if (match-end 2) (concat type ":" path) path)
1171 descp (and desc1 (not (equal desc1 desc2)))
1172 desc (or desc1 desc2))
1173 (cond
1174 ((equal type "internal")
1175 (let
1176 ((frag-0
1177 (if (= (string-to-char path) ?#)
1178 (substring path 1)
1179 path)))
1180 (setq rpl
1181 (org-html-make-link
1182 opt-plist
1185 (org-solidify-link-text
1186 (save-match-data (org-link-unescape frag-0))
1187 nil)
1188 desc attr nil))))
1189 ((and (equal type "id")
1190 (setq id-file (org-id-find-id-file path)))
1191 ;; This is an id: link to another file (if it was the same file,
1192 ;; it would have become an internal link...)
1193 (save-match-data
1194 (setq id-file (file-relative-name
1195 id-file
1196 (file-name-directory org-current-export-file)))
1197 (setq rpl
1198 (org-html-make-link opt-plist
1199 "file" id-file
1200 (concat (if (org-uuidgen-p path) "ID-") path)
1201 desc
1202 attr
1203 nil))))
1204 ((member type '("http" "https"))
1205 ;; standard URL, can inline as image
1206 (setq rpl
1207 (org-html-make-link opt-plist
1208 type path nil
1209 desc
1210 attr
1211 (org-html-should-inline-p path descp))))
1212 ((member type '("ftp" "mailto" "news"))
1213 ;; standard URL, can't inline as image
1214 (setq rpl
1215 (org-html-make-link opt-plist
1216 type path nil
1217 desc
1218 attr
1219 nil)))
1221 ((string= type "coderef")
1222 (let*
1223 ((coderef-str (format "coderef-%s" path))
1224 (attr-1
1225 (format "class=\"coderef\" onmouseover=\"CodeHighlightOn(this, '%s');\" onmouseout=\"CodeHighlightOff(this, '%s');\""
1226 coderef-str coderef-str)))
1227 (setq rpl
1228 (org-html-make-link opt-plist
1229 type "" coderef-str
1230 (format
1231 (org-export-get-coderef-format
1232 path
1233 (and descp desc))
1234 (cdr (assoc path org-export-code-refs)))
1235 attr-1
1236 nil))))
1238 ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
1239 ;; The link protocol has a function for format the link
1240 (setq rpl
1241 (save-match-data
1242 (funcall fnc (org-link-unescape path) desc1 'html))))
1244 ((string= type "file")
1245 ;; FILE link
1246 (save-match-data
1247 (let*
1248 ((components
1250 (string-match "::\\(.*\\)" path)
1251 (list
1252 (replace-match "" t nil path)
1253 (match-string 1 path))
1254 (list path nil)))
1256 ;;The proper path, without a fragment
1257 (path-1
1258 (first components))
1260 ;;The raw fragment
1261 (fragment-0
1262 (second components))
1264 ;;Check the fragment. If it can't be used as
1265 ;;target fragment we'll pass nil instead.
1266 (fragment-1
1268 (and fragment-0
1269 (not (string-match "^[0-9]*$" fragment-0))
1270 (not (string-match "^\\*" fragment-0))
1271 (not (string-match "^/.*/$" fragment-0)))
1272 (org-solidify-link-text
1273 (org-link-unescape fragment-0))
1274 nil))
1275 (desc-2
1276 ;;Description minus "file:" and ".org"
1277 (if (string-match "^file:" desc)
1278 (let
1279 ((desc-1 (replace-match "" t t desc)))
1280 (if (string-match "\\.org$" desc-1)
1281 (replace-match "" t t desc-1)
1282 desc-1))
1283 desc)))
1285 (setq rpl
1287 (and
1288 (functionp link-validate)
1289 (not (funcall link-validate path-1 current-dir)))
1290 desc
1291 (org-html-make-link opt-plist
1292 "file" path-1 fragment-1 desc-2 attr
1293 (org-html-should-inline-p path-1 descp)))))))
1296 ;; just publish the path, as default
1297 (setq rpl (concat "<i>&lt;" type ":"
1298 (save-match-data (org-link-unescape path))
1299 "&gt;</i>"))))
1300 (setq line (replace-match rpl t t line)
1301 start (+ start (length rpl))))
1303 ;; TODO items
1304 (if (and (string-match org-todo-line-regexp line)
1305 (match-beginning 2))
1307 (setq line
1308 (concat (substring line 0 (match-beginning 2))
1309 "<span class=\""
1310 (if (member (match-string 2 line)
1311 org-done-keywords)
1312 "done" "todo")
1313 " " (match-string 2 line)
1314 "\"> " (org-export-html-get-todo-kwd-class-name
1315 (match-string 2 line))
1316 "</span>" (substring line (match-end 2)))))
1318 ;; Does this contain a reference to a footnote?
1319 (when org-export-with-footnotes
1320 (setq start 0)
1321 (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start)
1322 (if (get-text-property (match-beginning 2) 'org-protected line)
1323 (setq start (match-end 2))
1324 (let ((n (match-string 2 line)) extra a)
1325 (if (setq a (assoc n footref-seen))
1326 (progn
1327 (setcdr a (1+ (cdr a)))
1328 (setq extra (format ".%d" (cdr a))))
1329 (setq extra "")
1330 (push (cons n 1) footref-seen))
1331 (setq line
1332 (replace-match
1333 (format
1334 (concat "%s"
1335 (format org-export-html-footnote-format
1336 "<a class=\"footref\" name=\"fnr.%s%s\" href=\"#fn.%s\">%s</a>"))
1337 (or (match-string 1 line) "") n extra n n)
1338 t t line))))))
1340 (cond
1341 ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
1342 ;; This is a headline
1343 (setq level (org-tr-level (- (match-end 1) (match-beginning 1)
1344 level-offset))
1345 txt (match-string 2 line))
1346 (if (string-match quote-re0 txt)
1347 (setq txt (replace-match "" t t txt)))
1348 (if (<= level (max umax umax-toc))
1349 (setq head-count (+ head-count 1)))
1350 (when in-local-list
1351 ;; Close any local lists before inserting a new header line
1352 (while local-list-type
1353 (org-close-li (car local-list-type))
1354 (insert (format "</%sl>\n" (car local-list-type)))
1355 (pop local-list-type))
1356 (setq local-list-indent nil
1357 in-local-list nil))
1358 (setq first-heading-pos (or first-heading-pos (point)))
1359 (org-html-level-start level txt umax
1360 (and org-export-with-toc (<= level umax))
1361 head-count)
1363 ;; QUOTES
1364 (when (string-match quote-re line)
1365 (org-close-par-maybe)
1366 (insert "<pre>")
1367 (setq inquote t)))
1369 ((string-match "^[ \t]*- __+[ \t]*$" line)
1370 ;; Explicit list closure
1371 (when local-list-type
1372 (let ((ind (org-get-indentation line)))
1373 (while (and local-list-indent
1374 (<= ind (car local-list-indent)))
1375 (org-close-li (car local-list-type))
1376 (insert (format "</%sl>\n" (car local-list-type)))
1377 (pop local-list-type)
1378 (pop local-list-indent))
1379 (or local-list-indent (setq in-local-list nil))))
1380 (throw 'nextline nil))
1382 ((and org-export-with-tables
1383 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
1384 (when (not table-open)
1385 ;; New table starts
1386 (setq table-open t table-buffer nil table-orig-buffer nil))
1388 ;; Accumulate lines
1389 (setq table-buffer (cons line table-buffer)
1390 table-orig-buffer (cons origline table-orig-buffer))
1391 (when (or (not lines)
1392 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
1393 (car lines))))
1394 (setq table-open nil
1395 table-buffer (nreverse table-buffer)
1396 table-orig-buffer (nreverse table-orig-buffer))
1397 (org-close-par-maybe)
1398 (insert (org-format-table-html table-buffer table-orig-buffer))))
1400 ;; Normal lines
1401 (when (string-match
1402 (cond
1403 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
1404 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
1405 ((= llt ?\)) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+)\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
1406 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))
1407 line)
1408 (setq ind (or (get-text-property 0 'original-indentation line)
1409 (org-get-string-indentation line))
1410 item-type (if (match-beginning 4) "o" "u")
1411 starter (if (match-beginning 2)
1412 (substring (match-string 2 line) 0 -1))
1413 line (substring line (match-beginning 5))
1414 initial-number nil
1415 item-tag nil)
1416 (if (string-match "\\`\\[@start:\\([0-9]+\\)\\][ \t]?" line)
1417 (setq initial-number (match-string 1 line)
1418 line (replace-match "" t t line)))
1419 (if (and starter (string-match "\\(.*?\\) ::[ \t]*" line))
1420 (setq item-type "d"
1421 item-tag (match-string 1 line)
1422 line (substring line (match-end 0))))
1423 (when (and (not (equal item-type "d"))
1424 (not (string-match "[^ \t]" line)))
1425 ;; empty line. Pretend indentation is large.
1426 (setq ind (if org-empty-line-terminates-plain-lists
1428 (1+ (or (car local-list-indent) 1)))))
1429 (setq didclose nil)
1430 (while (and in-local-list
1431 (or (and (= ind (car local-list-indent))
1432 (not starter))
1433 (< ind (car local-list-indent))))
1434 (setq didclose t)
1435 (org-close-li (car local-list-type))
1436 (insert (format "</%sl>\n" (car local-list-type)))
1437 (pop local-list-type) (pop local-list-indent)
1438 (setq in-local-list local-list-indent))
1439 (cond
1440 ((and starter
1441 (or (not in-local-list)
1442 (> ind (car local-list-indent))))
1443 ;; check for a specified start number
1444 ;; Start new (level of) list
1445 (org-close-par-maybe)
1446 (insert (cond
1447 ((equal item-type "u") "<ul>\n<li>\n")
1448 ((equal item-type "o")
1449 (if initial-number
1450 (format "<ol start=%s>\n<li>\n" initial-number)
1451 "<ol>\n<li>\n"))
1452 ((equal item-type "d")
1453 (format "<dl>\n<dt>%s</dt><dd>\n" item-tag))))
1454 (push item-type local-list-type)
1455 (push ind local-list-indent)
1456 (setq in-local-list t))
1457 (starter
1458 ;; continue current list
1459 (org-close-li (car local-list-type))
1460 (insert (cond
1461 ((equal (car local-list-type) "d")
1462 (format "<dt>%s</dt><dd>\n" (or item-tag "???")))
1463 (t "<li>\n"))))
1464 (didclose
1465 ;; we did close a list, normal text follows: need <p>
1466 (org-open-par)))
1467 (if (string-match "^[ \t]*\\[\\([X ]\\)\\]" line)
1468 (setq line
1469 (replace-match
1470 (if (equal (match-string 1 line) "X")
1471 "<b>[X]</b>"
1472 "<b>[<span style=\"visibility:hidden;\">X</span>]</b>")
1473 t t line))))
1475 ;; Horizontal line
1476 (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line)
1477 (if org-par-open
1478 (insert "\n</p>\n<hr/>\n<p>\n")
1479 (insert "\n<hr/>\n"))
1480 (throw 'nextline nil))
1482 ;; Empty lines start a new paragraph. If hand-formatted lists
1483 ;; are not fully interpreted, lines starting with "-", "+", "*"
1484 ;; also start a new paragraph.
1485 (if (string-match "^ [-+*]-\\|^[ \t]*$" line) (org-open-par))
1487 ;; Is this the start of a footnote?
1488 (when org-export-with-footnotes
1489 (when (and (boundp 'footnote-section-tag-regexp)
1490 (string-match (concat "^" footnote-section-tag-regexp)
1491 line))
1492 ;; ignore this line
1493 (throw 'nextline nil))
1494 (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line)
1495 (org-close-par-maybe)
1496 (let ((n (match-string 1 line)))
1497 (setq org-par-open t
1498 line (replace-match
1499 (format
1500 (concat "<p class=\"footnote\">"
1501 (format org-export-html-footnote-format
1502 "<a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a>"))
1503 n n n) t t line)))))
1504 ;; Check if the line break needs to be conserved
1505 (cond
1506 ((string-match "\\\\\\\\[ \t]*$" line)
1507 (setq line (replace-match "<br/>" t t line)))
1508 (org-export-preserve-breaks
1509 (setq line (concat line "<br/>"))))
1511 ;; Check if a paragraph should be started
1512 (let ((start 0))
1513 (while (and org-par-open
1514 (string-match "\\\\par\\>" line start))
1515 ;; Leave a space in the </p> so that the footnote matcher
1516 ;; does not see this.
1517 (if (not (get-text-property (match-beginning 0)
1518 'org-protected line))
1519 (setq line (replace-match "</p ><p >" t t line)))
1520 (setq start (match-end 0))))
1522 (insert line "\n")))))
1524 ;; Properly close all local lists and other lists
1525 (when inquote
1526 (insert "</pre>\n")
1527 (org-open-par))
1528 (when in-local-list
1529 ;; Close any local lists before inserting a new header line
1530 (while local-list-type
1531 (org-close-li (car local-list-type))
1532 (insert (format "</%sl>\n" (car local-list-type)))
1533 (pop local-list-type))
1534 (setq local-list-indent nil
1535 in-local-list nil))
1536 (org-html-level-start 1 nil umax
1537 (and org-export-with-toc (<= level umax))
1538 head-count)
1539 ;; the </div> to close the last text-... div.
1540 (when (and (> umax 0) first-heading-pos) (insert "</div>\n"))
1542 (save-excursion
1543 (goto-char (point-min))
1544 (while (re-search-forward "<p class=\"footnote\">[^\000]*?\\(</p>\\|\\'\\)" nil t)
1545 (push (match-string 0) footnotes)
1546 (replace-match "" t t)))
1547 (when footnotes
1548 (insert (format org-export-html-footnotes-section
1549 (nth 4 lang-words)
1550 (mapconcat 'identity (nreverse footnotes) "\n"))
1551 "\n"))
1552 (let ((bib (org-export-html-get-bibliography)))
1553 (when bib
1554 (insert "\n" bib "\n")))
1555 (unless body-only
1556 (when (plist-get opt-plist :auto-postamble)
1557 (insert "<div id=\"postamble\">\n")
1558 (when (and org-export-author-info author)
1559 (insert "<p class=\"author\"> "
1560 (nth 1 lang-words) ": " author "\n")
1561 (when (and org-export-email-info email (string-match "\\S-" email))
1562 (if (listp (split-string email ",+ *"))
1563 (mapc (lambda(e)
1564 (insert "<a href=\"mailto:" e "\">&lt;"
1565 e "&gt;</a>\n"))
1566 (split-string email ",+ *"))
1567 (insert "<a href=\"mailto:" email "\">&lt;"
1568 email "&gt;</a>\n")))
1569 (insert "</p>\n"))
1570 (when (and date org-export-time-stamp-file)
1571 (insert "<p class=\"date\"> "
1572 (nth 2 lang-words) ": "
1573 date "</p>\n"))
1574 (when org-export-creator-info
1575 (insert (format "<p class=\"creator\">HTML generated by org-mode %s in emacs %s</p>\n"
1576 org-version emacs-major-version)))
1577 (when org-export-html-validation-link
1578 (insert org-export-html-validation-link "\n"))
1579 (insert "</div>"))
1581 (if org-export-html-with-timestamp
1582 (insert org-export-html-html-helper-timestamp))
1583 (org-export-html-insert-plist-item opt-plist :postamble opt-plist)
1584 (insert "\n</div>\n</body>\n</html>\n"))
1586 (unless (plist-get opt-plist :buffer-will-be-killed)
1587 (normal-mode)
1588 (if (eq major-mode (default-value 'major-mode))
1589 (html-mode)))
1591 ;; insert the table of contents
1592 (goto-char (point-min))
1593 (when thetoc
1594 (if (or (re-search-forward
1595 "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t)
1596 (re-search-forward
1597 "\\[TABLE-OF-CONTENTS\\]" nil t))
1598 (progn
1599 (goto-char (match-beginning 0))
1600 (replace-match ""))
1601 (goto-char first-heading-pos)
1602 (when (looking-at "\\s-*</p>")
1603 (goto-char (match-end 0))
1604 (insert "\n")))
1605 (insert "<div id=\"table-of-contents\">\n")
1606 (mapc 'insert thetoc)
1607 (insert "</div>\n"))
1608 ;; remove empty paragraphs and lists
1609 (goto-char (point-min))
1610 (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t)
1611 (replace-match ""))
1612 (goto-char (point-min))
1613 (while (re-search-forward "<li>[ \r\n\t]*</li>\n?" nil t)
1614 (replace-match ""))
1615 (goto-char (point-min))
1616 (while (re-search-forward "</ul>\\s-*<ul>\n?" nil t)
1617 (replace-match ""))
1618 ;; Convert whitespace place holders
1619 (goto-char (point-min))
1620 (let (beg end n)
1621 (while (setq beg (next-single-property-change (point) 'org-whitespace))
1622 (setq n (get-text-property beg 'org-whitespace)
1623 end (next-single-property-change beg 'org-whitespace))
1624 (goto-char beg)
1625 (delete-region beg end)
1626 (insert (format "<span style=\"visibility:hidden;\">%s</span>"
1627 (make-string n ?x)))))
1628 ;; Remove empty lines at the beginning of the file.
1629 (goto-char (point-min))
1630 (when (looking-at "\\s-+\n") (replace-match ""))
1631 ;; Remove display properties
1632 (remove-text-properties (point-min) (point-max) '(display t))
1633 ;; Run the hook
1634 (run-hooks 'org-export-html-final-hook)
1635 (or to-buffer (save-buffer))
1636 (goto-char (point-min))
1637 (or (org-export-push-to-kill-ring "HTML")
1638 (message "Exporting... done"))
1639 (if (eq to-buffer 'string)
1640 (prog1 (buffer-substring (point-min) (point-max))
1641 (kill-buffer (current-buffer)))
1642 (current-buffer)))))
1644 (defun org-export-html-insert-plist-item (plist key &rest args)
1645 (let ((item (plist-get plist key)))
1646 (cond ((functionp item)
1647 (apply item args))
1648 (item
1649 (insert item)))))
1651 (defun org-export-html-format-href (s)
1652 "Make sure the S is valid as a href reference in an XHTML document."
1653 (save-match-data
1654 (let ((start 0))
1655 (while (string-match "&" s start)
1656 (setq start (+ (match-beginning 0) 3)
1657 s (replace-match "&amp;" t t s)))))
1660 (defun org-export-html-format-desc (s)
1661 "Make sure the S is valid as a description in a link."
1662 (if (and s (not (get-text-property 1 'org-protected s)))
1663 (save-match-data
1664 (org-html-do-expand s))
1667 (defun org-export-html-format-image (src par-open)
1668 "Create image tag with source and attributes."
1669 (save-match-data
1670 (if (string-match "^ltxpng/" src)
1671 (format "<img src=\"%s\" alt=\"%s\"/>"
1672 src (org-find-text-property-in-string 'org-latex-src src))
1673 (let* ((caption (org-find-text-property-in-string 'org-caption src))
1674 (attr (org-find-text-property-in-string 'org-attributes src))
1675 (label (org-find-text-property-in-string 'org-label src)))
1676 (setq caption (and caption (org-html-do-expand caption)))
1677 (concat
1678 (if caption
1679 (format "%s<div %sclass=\"figure\">
1680 <p>"
1681 (if org-par-open "</p>\n" "")
1682 (if label (format "id=\"%s\" " label) "")))
1683 (format "<img src=\"%s\"%s />"
1685 (if (string-match "\\<alt=" (or attr ""))
1686 (concat " " attr )
1687 (concat " " attr " alt=\"" src "\"")))
1688 (if caption
1689 (format "</p>%s
1690 </div>%s"
1691 (concat "\n<p>" caption "</p>")
1692 (if org-par-open "\n<p>" ""))))))))
1694 (defun org-export-html-get-bibliography ()
1695 "Find bibliography, cut it out and return it."
1696 (catch 'exit
1697 (let (beg end (cnt 1) bib)
1698 (save-excursion
1699 (goto-char (point-min))
1700 (when (re-search-forward "^[ \t]*<div \\(id\\|class\\)=\"bibliography\"" nil t)
1701 (setq beg (match-beginning 0))
1702 (while (re-search-forward "</?div\\>" nil t)
1703 (setq cnt (+ cnt (if (string= (match-string 0) "<div") +1 -1)))
1704 (when (= cnt 0)
1705 (and (looking-at ">") (forward-char 1))
1706 (setq bib (buffer-substring beg (point)))
1707 (delete-region beg (point))
1708 (throw 'exit bib))))
1709 nil))))
1711 (defvar org-table-number-regexp) ; defined in org-table.el
1712 (defun org-format-table-html (lines olines)
1713 "Find out which HTML converter to use and return the HTML code."
1714 (if (stringp lines)
1715 (setq lines (org-split-string lines "\n")))
1716 (if (string-match "^[ \t]*|" (car lines))
1717 ;; A normal org table
1718 (org-format-org-table-html lines)
1719 ;; Table made by table.el - test for spanning
1720 (let* ((hlines (delq nil (mapcar
1721 (lambda (x)
1722 (if (string-match "^[ \t]*\\+-" x) x
1723 nil))
1724 lines)))
1725 (first (car hlines))
1726 (ll (and (string-match "\\S-+" first)
1727 (match-string 0 first)))
1728 (re (concat "^[ \t]*" (regexp-quote ll)))
1729 (spanning (delq nil (mapcar (lambda (x) (not (string-match re x)))
1730 hlines))))
1731 (if (and (not spanning)
1732 (not org-export-prefer-native-exporter-for-tables))
1733 ;; We can use my own converter with HTML conversions
1734 (org-format-table-table-html lines)
1735 ;; Need to use the code generator in table.el, with the original text.
1736 (org-format-table-table-html-using-table-generate-source olines)))))
1738 (defvar org-table-number-fraction) ; defined in org-table.el
1739 (defun org-format-org-table-html (lines &optional splice)
1740 "Format a table into HTML."
1741 (require 'org-table)
1742 ;; Get rid of hlines at beginning and end
1743 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
1744 (setq lines (nreverse lines))
1745 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
1746 (setq lines (nreverse lines))
1747 (when org-export-table-remove-special-lines
1748 ;; Check if the table has a marking column. If yes remove the
1749 ;; column and the special lines
1750 (setq lines (org-table-clean-before-export lines)))
1752 (let* ((caption (org-find-text-property-in-string 'org-caption (car lines)))
1753 (label (org-find-text-property-in-string 'org-label (car lines)))
1754 (attributes (org-find-text-property-in-string 'org-attributes
1755 (car lines)))
1756 (html-table-tag (org-export-splice-attributes
1757 html-table-tag attributes))
1758 (head (and org-export-highlight-first-table-line
1759 (delq nil (mapcar
1760 (lambda (x) (string-match "^[ \t]*|-" x))
1761 (cdr lines)))))
1763 (nline 0) fnum nfields i
1764 tbopen line fields html gr colgropen rowstart rowend)
1765 (setq caption (and caption (org-html-do-expand caption)))
1766 (if splice (setq head nil))
1767 (unless splice (push (if head "<thead>" "<tbody>") html))
1768 (setq tbopen t)
1769 (while (setq line (pop lines))
1770 (catch 'next-line
1771 (if (string-match "^[ \t]*|-" line)
1772 (progn
1773 (unless splice
1774 (push (if head "</thead>" "</tbody>") html)
1775 (if lines (push "<tbody>" html) (setq tbopen nil)))
1776 (setq head nil) ;; head ends here, first time around
1777 ;; ignore this line
1778 (throw 'next-line t)))
1779 ;; Break the line into fields
1780 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
1781 (unless fnum (setq fnum (make-vector (length fields) 0)
1782 nfields (length fnum)))
1783 (setq nline (1+ nline) i -1
1784 rowstart (eval (car org-export-table-row-tags))
1785 rowend (eval (cdr org-export-table-row-tags)))
1786 (push (concat rowstart
1787 (mapconcat
1788 (lambda (x)
1789 (setq i (1+ i))
1790 (if (and (< i nfields) ; make sure no rogue line causes an error here
1791 (string-match org-table-number-regexp x))
1792 (incf (aref fnum i)))
1793 (cond
1794 (head
1795 (concat
1796 (format (car org-export-table-header-tags) "col")
1798 (cdr org-export-table-header-tags)))
1799 ((and (= i 0) org-export-html-table-use-header-tags-for-first-column)
1800 (concat
1801 (format (car org-export-table-header-tags) "row")
1803 (cdr org-export-table-header-tags)))
1805 (concat (car org-export-table-data-tags) x
1806 (cdr org-export-table-data-tags)))))
1807 fields "")
1808 rowend)
1809 html)))
1810 (unless splice (if tbopen (push "</tbody>" html)))
1811 (unless splice (push "</table>\n" html))
1812 (setq html (nreverse html))
1813 (unless splice
1814 ;; Put in col tags with the alignment (unfortunately often ignored...)
1815 (unless (car org-table-colgroup-info)
1816 (setq org-table-colgroup-info
1817 (cons :start (cdr org-table-colgroup-info))))
1818 (push (mapconcat
1819 (lambda (x)
1820 (setq gr (pop org-table-colgroup-info))
1821 (format "%s<col align=\"%s\" />%s"
1822 (if (memq gr '(:start :startend))
1823 (prog1
1824 (if colgropen "</colgroup>\n<colgroup>" "<colgroup>")
1825 (setq colgropen t))
1827 (if (> (/ (float x) nline) org-table-number-fraction)
1828 "right" "left")
1829 (if (memq gr '(:end :startend))
1830 (progn (setq colgropen nil) "</colgroup>")
1831 "")))
1832 fnum "")
1833 html)
1834 (if colgropen (setq html (cons (car html) (cons "</colgroup>" (cdr html)))))
1835 ;; Since the output of HTML table formatter can also be used in
1836 ;; DocBook document, we want to always include the caption to make
1837 ;; DocBook XML file valid.
1838 (push (format "<caption>%s</caption>" (or caption "")) html)
1839 (when label (push (format "<a name=\"%s\" id=\"%s\"></a>" label label)
1840 html))
1841 (push html-table-tag html))
1842 (concat (mapconcat 'identity html "\n") "\n")))
1844 (defun org-export-splice-attributes (tag attributes)
1845 "Read attributes in string ATTRIBUTES, add and replace in HTML tag TAG."
1846 (if (not attributes)
1848 (let (oldatt newatt)
1849 (setq oldatt (org-extract-attributes-from-string tag)
1850 tag (pop oldatt)
1851 newatt (cdr (org-extract-attributes-from-string attributes)))
1852 (while newatt
1853 (setq oldatt (plist-put oldatt (pop newatt) (pop newatt))))
1854 (if (string-match ">" tag)
1855 (setq tag
1856 (replace-match (concat (org-attributes-to-string oldatt) ">")
1857 t t tag)))
1858 tag)))
1860 (defun org-format-table-table-html (lines)
1861 "Format a table generated by table.el into HTML.
1862 This conversion does *not* use `table-generate-source' from table.el.
1863 This has the advantage that Org-mode's HTML conversions can be used.
1864 But it has the disadvantage, that no cell- or row-spanning is allowed."
1865 (let (line field-buffer
1866 (head org-export-highlight-first-table-line)
1867 fields html empty i)
1868 (setq html (concat html-table-tag "\n"))
1869 (while (setq line (pop lines))
1870 (setq empty "&nbsp;")
1871 (catch 'next-line
1872 (if (string-match "^[ \t]*\\+-" line)
1873 (progn
1874 (if field-buffer
1875 (progn
1876 (setq
1877 html
1878 (concat
1879 html
1880 "<tr>"
1881 (mapconcat
1882 (lambda (x)
1883 (if (equal x "") (setq x empty))
1884 (if head
1885 (concat
1886 (format (car org-export-table-header-tags) "col")
1888 (cdr org-export-table-header-tags))
1889 (concat (car org-export-table-data-tags) x
1890 (cdr org-export-table-data-tags))))
1891 field-buffer "\n")
1892 "</tr>\n"))
1893 (setq head nil)
1894 (setq field-buffer nil)))
1895 ;; Ignore this line
1896 (throw 'next-line t)))
1897 ;; Break the line into fields and store the fields
1898 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
1899 (if field-buffer
1900 (setq field-buffer (mapcar
1901 (lambda (x)
1902 (concat x "<br/>" (pop fields)))
1903 field-buffer))
1904 (setq field-buffer fields))))
1905 (setq html (concat html "</table>\n"))
1906 html))
1908 (defun org-format-table-table-html-using-table-generate-source (lines)
1909 "Format a table into html, using `table-generate-source' from table.el.
1910 This has the advantage that cell- or row-spanning is allowed.
1911 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
1912 (require 'table)
1913 (with-current-buffer (get-buffer-create " org-tmp1 ")
1914 (erase-buffer)
1915 (insert (mapconcat 'identity lines "\n"))
1916 (goto-char (point-min))
1917 (if (not (re-search-forward "|[^+]" nil t))
1918 (error "Error processing table"))
1919 (table-recognize-table)
1920 (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
1921 (table-generate-source 'html " org-tmp2 ")
1922 (set-buffer " org-tmp2 ")
1923 (buffer-substring (point-min) (point-max))))
1925 (defun org-export-splice-style (style extra)
1926 "Splice EXTRA into STYLE, just before \"</style>\"."
1927 (if (and (stringp extra)
1928 (string-match "\\S-" extra)
1929 (string-match "</style>" style))
1930 (concat (substring style 0 (match-beginning 0))
1931 "\n" extra "\n"
1932 (substring style (match-beginning 0)))
1933 style))
1935 (defun org-html-handle-time-stamps (s)
1936 "Format time stamps in string S, or remove them."
1937 (catch 'exit
1938 (let (r b)
1939 (while (string-match org-maybe-keyword-time-regexp s)
1940 (or b (setq b (substring s 0 (match-beginning 0))))
1941 (setq r (concat
1942 r (substring s 0 (match-beginning 0))
1943 " @<span class=\"timestamp-wrapper\">"
1944 (if (match-end 1)
1945 (format "@<span class=\"timestamp-kwd\">%s @</span>"
1946 (match-string 1 s)))
1947 (format " @<span class=\"timestamp\">%s@</span>"
1948 (substring
1949 (org-translate-time (match-string 3 s)) 1 -1))
1950 "@</span>")
1951 s (substring s (match-end 0))))
1952 ;; Line break if line started and ended with time stamp stuff
1953 (if (not r)
1955 (setq r (concat r s))
1956 (unless (string-match "\\S-" (concat b s))
1957 (setq r (concat r "@<br/>")))
1958 r))))
1960 (defvar htmlize-buffer-places) ; from htmlize.el
1961 (defun org-export-htmlize-region-for-paste (beg end)
1962 "Convert the region to HTML, using htmlize.el.
1963 This is much like `htmlize-region-for-paste', only that it uses
1964 the settings define in the org-... variables."
1965 (let* ((htmlize-output-type org-export-htmlize-output-type)
1966 (htmlize-css-name-prefix org-export-htmlize-css-font-prefix)
1967 (htmlbuf (htmlize-region beg end)))
1968 (unwind-protect
1969 (with-current-buffer htmlbuf
1970 (buffer-substring (plist-get htmlize-buffer-places 'content-start)
1971 (plist-get htmlize-buffer-places 'content-end)))
1972 (kill-buffer htmlbuf))))
1974 ;;;###autoload
1975 (defun org-export-htmlize-generate-css ()
1976 "Create the CSS for all font definitions in the current Emacs session.
1977 Use this to create face definitions in your CSS style file that can then
1978 be used by code snippets transformed by htmlize.
1979 This command just produces a buffer that contains class definitions for all
1980 faces used in the current Emacs session. You can copy and paste the ones you
1981 need into your CSS file.
1983 If you then set `org-export-htmlize-output-type' to `css', calls to
1984 the function `org-export-htmlize-region-for-paste' will produce code
1985 that uses these same face definitions."
1986 (interactive)
1987 (require 'htmlize)
1988 (and (get-buffer "*html*") (kill-buffer "*html*"))
1989 (with-temp-buffer
1990 (let ((fl (face-list))
1991 (htmlize-css-name-prefix "org-")
1992 (htmlize-output-type 'css)
1993 f i)
1994 (while (setq f (pop fl)
1995 i (and f (face-attribute f :inherit)))
1996 (when (and (symbolp f) (or (not i) (not (listp i))))
1997 (insert (org-add-props (copy-sequence "1") nil 'face f))))
1998 (htmlize-region (point-min) (point-max))))
1999 (switch-to-buffer "*html*")
2000 (goto-char (point-min))
2001 (if (re-search-forward "<style" nil t)
2002 (delete-region (point-min) (match-beginning 0)))
2003 (if (re-search-forward "</style>" nil t)
2004 (delete-region (1+ (match-end 0)) (point-max)))
2005 (beginning-of-line 1)
2006 (if (looking-at " +") (replace-match ""))
2007 (goto-char (point-min)))
2009 (defun org-html-protect (s)
2010 ;; convert & to &amp;, < to &lt; and > to &gt;
2011 (let ((start 0))
2012 (while (string-match "&" s start)
2013 (setq s (replace-match "&amp;" t t s)
2014 start (1+ (match-beginning 0))))
2015 (while (string-match "<" s)
2016 (setq s (replace-match "&lt;" t t s)))
2017 (while (string-match ">" s)
2018 (setq s (replace-match "&gt;" t t s)))
2019 ; (while (string-match "\"" s)
2020 ; (setq s (replace-match "&quot;" t t s)))
2024 (defun org-html-expand (string)
2025 "Prepare STRING for HTML export. Applies all active conversions.
2026 If there are links in the string, don't modify these."
2027 (let* ((re (concat org-bracket-link-regexp "\\|"
2028 (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$")))
2029 m s l res)
2030 (if (string-match "^[ \t]*\\+-[-+]*\\+[ \t]*$" string)
2031 string
2032 (while (setq m (string-match re string))
2033 (setq s (substring string 0 m)
2034 l (match-string 0 string)
2035 string (substring string (match-end 0)))
2036 (push (org-html-do-expand s) res)
2037 (push l res))
2038 (push (org-html-do-expand string) res)
2039 (apply 'concat (nreverse res)))))
2041 (defun org-html-do-expand (s)
2042 "Apply all active conversions to translate special ASCII to HTML."
2043 (setq s (org-html-protect s))
2044 (if org-export-html-expand
2045 (while (string-match "@&lt;\\([^&]*\\)&gt;" s)
2046 (setq s (replace-match "<\\1>" t nil s))))
2047 (if org-export-with-emphasize
2048 (setq s (org-export-html-convert-emphasize s)))
2049 (if org-export-with-special-strings
2050 (setq s (org-export-html-convert-special-strings s)))
2051 (if org-export-with-sub-superscripts
2052 (setq s (org-export-html-convert-sub-super s)))
2053 (if org-export-with-TeX-macros
2054 (let ((start 0) wd rep)
2055 (while (setq start (string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
2056 s start))
2057 (if (get-text-property (match-beginning 0) 'org-protected s)
2058 (setq start (match-end 0))
2059 (setq wd (match-string 1 s))
2060 (if (setq rep (org-entity-get-representation wd 'html))
2061 (setq s (replace-match rep t t s))
2062 (setq start (+ start (length wd))))))))
2065 (defun org-export-html-convert-special-strings (string)
2066 "Convert special characters in STRING to HTML."
2067 (let ((all org-export-html-special-string-regexps)
2068 e a re rpl start)
2069 (while (setq a (pop all))
2070 (setq re (car a) rpl (cdr a) start 0)
2071 (while (string-match re string start)
2072 (if (get-text-property (match-beginning 0) 'org-protected string)
2073 (setq start (match-end 0))
2074 (setq string (replace-match rpl t nil string)))))
2075 string))
2077 (defun org-export-html-convert-sub-super (string)
2078 "Convert sub- and superscripts in STRING to HTML."
2079 (let (key c (s 0) (requireb (eq org-export-with-sub-superscripts '{})))
2080 (while (string-match org-match-substring-regexp string s)
2081 (cond
2082 ((and requireb (match-end 8)) (setq s (match-end 2)))
2083 ((get-text-property (match-beginning 2) 'org-protected string)
2084 (setq s (match-end 2)))
2086 (setq s (match-end 1)
2087 key (if (string= (match-string 2 string) "_") "sub" "sup")
2088 c (or (match-string 8 string)
2089 (match-string 6 string)
2090 (match-string 5 string))
2091 string (replace-match
2092 (concat (match-string 1 string)
2093 "<" key ">" c "</" key ">")
2094 t t string)))))
2095 (while (string-match "\\\\\\([_^]\\)" string)
2096 (setq string (replace-match (match-string 1 string) t t string)))
2097 string))
2099 (defun org-export-html-convert-emphasize (string)
2100 "Apply emphasis."
2101 (let ((s 0) rpl)
2102 (while (string-match org-emph-re string s)
2103 (if (not (equal
2104 (substring string (match-beginning 3) (1+ (match-beginning 3)))
2105 (substring string (match-beginning 4) (1+ (match-beginning 4)))))
2106 (setq s (match-beginning 0)
2108 (concat
2109 (match-string 1 string)
2110 (nth 2 (assoc (match-string 3 string) org-emphasis-alist))
2111 (match-string 4 string)
2112 (nth 3 (assoc (match-string 3 string)
2113 org-emphasis-alist))
2114 (match-string 5 string))
2115 string (replace-match rpl t t string)
2116 s (+ s (- (length rpl) 2)))
2117 (setq s (1+ s))))
2118 string))
2120 (defun org-open-par ()
2121 "Insert <p>, but first close previous paragraph if any."
2122 (org-close-par-maybe)
2123 (insert "\n<p>")
2124 (setq org-par-open t))
2125 (defun org-close-par-maybe ()
2126 "Close paragraph if there is one open."
2127 (when org-par-open
2128 (insert "</p>")
2129 (setq org-par-open nil)))
2130 (defun org-close-li (&optional type)
2131 "Close <li> if necessary."
2132 (org-close-par-maybe)
2133 (insert (if (equal type "d") "</dd>\n" "</li>\n")))
2135 (defvar in-local-list)
2136 (defvar local-list-indent)
2137 (defvar local-list-type)
2138 (defun org-export-html-close-lists-maybe (line)
2139 (let* ((rawhtml (and in-local-list
2140 (get-text-property 0 'org-protected line)))
2141 (ind (if rawhtml
2142 (org-get-indentation line)
2143 (or (get-text-property 0 'original-indentation line))))
2144 didclose)
2145 (when ind
2146 (while (and in-local-list
2147 (<= ind (car local-list-indent)))
2148 (setq didclose t)
2149 (org-close-li (car local-list-type))
2150 (insert (format "</%sl>\n" (car local-list-type)))
2151 (pop local-list-type) (pop local-list-indent)
2152 (setq in-local-list local-list-indent))
2153 (and didclose (org-open-par)))))
2155 (defvar body-only) ; dynamically scoped into this.
2156 (defun org-html-level-start (level title umax with-toc head-count)
2157 "Insert a new level in HTML export.
2158 When TITLE is nil, just close all open levels."
2159 (org-close-par-maybe)
2160 (let* ((target (and title (org-get-text-property-any 0 'target title)))
2161 (extra-targets (and target
2162 (assoc target org-export-target-aliases)))
2163 (extra-class (and title (org-get-text-property-any 0 'html-container-class title)))
2164 (preferred (and target
2165 (cdr (assoc target org-export-preferred-target-alist))))
2166 (remove (or preferred target))
2167 (l org-level-max)
2168 snumber snu href suffix)
2169 (setq extra-targets (remove remove extra-targets))
2170 (setq extra-targets
2171 (mapconcat (lambda (x)
2172 (if (org-uuidgen-p x) (setq x (concat "ID-" x)))
2173 (format "<a name=\"%s\" id=\"%s\"></a>"
2174 x x))
2175 extra-targets
2176 ""))
2177 (while (>= l level)
2178 (if (aref org-levels-open (1- l))
2179 (progn
2180 (org-html-level-close l umax)
2181 (aset org-levels-open (1- l) nil)))
2182 (setq l (1- l)))
2183 (when title
2184 ;; If title is nil, this means this function is called to close
2185 ;; all levels, so the rest is done only if title is given
2186 (when (string-match (org-re "\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title)
2187 (setq title (replace-match
2188 (if org-export-with-tags
2189 (save-match-data
2190 (concat
2191 "&nbsp;&nbsp;&nbsp;<span class=\"tag\">"
2192 (mapconcat
2193 (lambda (x)
2194 (format "<span class=\"%s\">%s</span>"
2195 (org-export-html-get-tag-class-name x)
2197 (org-split-string (match-string 1 title) ":")
2198 "&nbsp;")
2199 "</span>"))
2201 t t title)))
2202 (if (> level umax)
2203 (progn
2204 (if (aref org-levels-open (1- level))
2205 (progn
2206 (org-close-li)
2207 (if target
2208 (insert (format "<li id=\"%s\">" target) extra-targets title "<br/>\n")
2209 (insert "<li>" title "<br/>\n")))
2210 (aset org-levels-open (1- level) t)
2211 (org-close-par-maybe)
2212 (if target
2213 (insert (format "<ul>\n<li id=\"%s\">" target)
2214 extra-targets title "<br/>\n")
2215 (insert "<ul>\n<li>" title "<br/>\n"))))
2216 (aset org-levels-open (1- level) t)
2217 (setq snumber (org-section-number level)
2218 snu (replace-regexp-in-string "\\." "_" snumber))
2219 (setq level (+ level org-export-html-toplevel-hlevel -1))
2220 (if (and org-export-with-section-numbers (not body-only))
2221 (setq title (concat
2222 (format "<span class=\"section-number-%d\">%s</span>"
2223 level snumber)
2224 " " title)))
2225 (unless (= head-count 1) (insert "\n</div>\n"))
2226 (setq href (cdr (assoc (concat "sec-" snu) org-export-preferred-target-alist)))
2227 (setq suffix (or href snu))
2228 (setq href (or href (concat "sec-" snu)))
2229 (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"
2230 suffix level (if extra-class (concat " " extra-class) "")
2231 level href
2232 extra-targets
2233 title level level suffix))
2234 (org-open-par)))))
2236 (defun org-export-html-get-tag-class-name (tag)
2237 "Turn tag into a valid class name.
2238 Replaces invalid characters with \"_\" and then prepends a prefix."
2239 (save-match-data
2240 (while (string-match "[^a-zA-Z0-9_]" tag)
2241 (setq tag (replace-match "_" t t tag))))
2242 (concat org-export-html-tag-class-prefix tag))
2244 (defun org-export-html-get-todo-kwd-class-name (kwd)
2245 "Turn todo keyword into a valid class name.
2246 Replaces invalid characters with \"_\" and then prepends a prefix."
2247 (save-match-data
2248 (while (string-match "[^a-zA-Z0-9_]" kwd)
2249 (setq kwd (replace-match "_" t t kwd))))
2250 (concat org-export-html-todo-kwd-class-prefix kwd))
2252 (defun org-html-level-close (level max-outline-level)
2253 "Terminate one level in HTML export."
2254 (if (<= level max-outline-level)
2255 (insert "</div>\n")
2256 (org-close-li)
2257 (insert "</ul>\n")))
2259 (provide 'org-html)
2261 ;; arch-tag: 8109d84d-eb8f-460b-b1a8-f45f3a6c7ea1
2262 ;;; org-html.el ends here