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
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
32 (require 'format-spec
)
34 (eval-when-compile (require 'cl
))
36 (declare-function org-id-find-id-file
"org-id" (id))
37 (declare-function htmlize-region
"ext:htmlize" (beg end
))
39 (defgroup org-export-html nil
40 "Options specific for HTML export of Org-mode files."
41 :tag
"Org Export HTML"
44 (defcustom org-export-html-footnotes-section
"<div id=\"footnotes\">
45 <h2 class=\"footnotes\">%s: </h2>
46 <div id=\"text-footnotes\">
50 "Format for the footnotes section.
51 Should contain a two instances of %s. The first will be replaced with the
52 language-specific word for \"Footnotes\", the second one will be replaced
53 by the footnotes themselves."
54 :group
'org-export-html
57 (defcustom org-export-html-footnote-format
"<sup>%s</sup>"
58 "The format for the footnote reference.
59 %s will be replaced by the footnote reference itself."
60 :group
'org-export-html
63 (defcustom org-export-html-coding-system nil
64 "Coding system for HTML export, defaults to `buffer-file-coding-system'."
65 :group
'org-export-html
68 (defcustom org-export-html-extension
"html"
69 "The extension for exported HTML files."
70 :group
'org-export-html
73 (defcustom org-export-html-xml-declaration
74 '(("html" .
"<?xml version=\"1.0\" encoding=\"%s\"?>")
75 ("php" .
"<?php echo \"<?xml version=\\\"1.0\\\" encoding=\\\"%s\\\" ?>\"; ?>"))
76 "The extension for exported HTML files.
77 %s will be replaced with the charset of the exported file.
78 This may be a string, or an alist with export extensions
79 and corresponding declarations."
80 :group
'org-export-html
82 (string :tag
"Single declaration")
83 (repeat :tag
"Dependent on extension"
84 (cons (string :tag
"Extension")
85 (string :tag
"Declaration")))))
87 (defcustom org-export-html-style-include-scripts t
88 "Non-nil means include the JavaScript snippets in exported HTML files.
89 The actual script is defined in `org-export-html-scripts' and should
91 :group
'org-export-html
94 (defconst org-export-html-scripts
95 "<script type=\"text/javascript\">
96 <!--/*--><![CDATA[/*><!--*/
97 function CodeHighlightOn(elem, id)
99 var target = document.getElementById(id);
101 elem.cacheClassElem = elem.className;
102 elem.cacheClassTarget = target.className;
103 target.className = \"code-highlighted\";
104 elem.className = \"code-highlighted\";
107 function CodeHighlightOff(elem, id)
109 var target = document.getElementById(id);
110 if(elem.cacheClassElem)
111 elem.className = elem.cacheClassElem;
112 if(elem.cacheClassTarget)
113 target.className = elem.cacheClassTarget;
117 "Basic JavaScript that is needed by HTML files produced by Org-mode.")
119 (defconst org-export-html-style-default
120 "<style type=\"text/css\">
121 <!--/*--><![CDATA[/*><!--*/
122 html { font-family: Times, serif; font-size: 12pt; }
123 .title { text-align: center; }
124 .todo { color: red; }
125 .done { color: green; }
126 .tag { background-color: #add8e6; font-weight:normal }
128 .timestamp { color: #bebebe; }
129 .timestamp-kwd { color: #5f9ea0; }
130 .right {margin-left:auto; margin-right:0px; text-align:right;}
131 .left {margin-left:0px; margin-right:auto; text-align:left;}
132 .center {margin-left:auto; margin-right:auto; text-align:center;}
133 p.verse { margin-left: 3% }
135 border: 1pt solid #AEBDCC;
136 background-color: #F3F5F7;
138 font-family: courier, monospace;
142 table { border-collapse: collapse; }
143 td, th { vertical-align: top; }
144 th.right { text-align:center; }
145 th.left { text-align:center; }
146 th.center { text-align:center; }
147 td.right { text-align:right; }
148 td.left { text-align:left; }
149 td.center { text-align:center; }
150 dt { font-weight: bold; }
151 div.figure { padding: 0.5em; }
152 div.figure p { text-align: center; }
153 textarea { overflow-x: auto; }
154 .linenr { font-size:smaller }
155 .code-highlighted {background-color:#ffff00;}
156 .org-info-js_info-navigation { border-style:none; }
157 #org-info-js_console-label { font-size:10px; font-weight:bold;
158 white-space:nowrap; }
159 .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
163 "The default style specification for exported HTML files.
164 Please use the variables `org-export-html-style' and
165 `org-export-html-style-extra' to add to this style. If you wish to not
166 have the default style included, customize the variable
167 `org-export-html-style-include-default'.")
169 (defcustom org-export-html-style-include-default t
170 "Non-nil means include the default style in exported HTML files.
171 The actual style is defined in `org-export-html-style-default' and should
172 not be modified. Use the variables `org-export-html-style' to add
173 your own style information."
174 :group
'org-export-html
177 (put 'org-export-html-style-include-default
'safe-local-variable
'booleanp
)
179 (defcustom org-export-html-style
""
180 "Org-wide style definitions for exported HTML files.
182 This variable needs to contain the full HTML structure to provide a style,
183 including the surrounding HTML tags. If you set the value of this variable,
184 you should consider to include definitions for the following classes:
185 title, todo, done, timestamp, timestamp-kwd, tag, target.
187 For example, a valid value would be:
189 <style type=\"text/css\">
191 p { font-weight: normal; color: gray; }
193 .title { text-align: center; }
194 .todo, .timestamp-kwd { color: red; }
195 .done { color: green; }
199 If you'd like to refer to en external style file, use something like
201 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
203 As the value of this option simply gets inserted into the HTML <head> header,
204 you can \"misuse\" it to add arbitrary text to the header.
205 See also the variable `org-export-html-style-extra'."
206 :group
'org-export-html
209 (put 'org-export-html-style
'safe-local-variable
'stringp
)
211 (defcustom org-export-html-style-extra
""
212 "Additional style information for HTML export.
213 The value of this variable is inserted into the HTML buffer right after
214 the value of `org-export-html-style'. Use this variable for per-file
215 settings of style information, and do not forget to surround the style
216 settings with <style>...</style> tags."
217 :group
'org-export-html
220 (put 'org-export-html-style-extra
'safe-local-variable
'stringp
)
222 (defcustom org-export-html-mathjax-options
223 '((path "http://orgmode.org/mathjax/MathJax.js")
228 "Options for MathJax setup.
230 path The path where to find MathJax
231 scale Scaling for the HTML-CSS backend, usually between 100 and 133
232 align How to align display math: left, center, or right
233 indent If align is not center, how far from the left/right side?
234 mathml Should a MathML player be used if available?
235 This is faster and reduces bandwidth use, but currently
236 sometimes has lower spacing quality. Therefore, the default is
237 nil. When browsers get better, this switch can be flipped.
239 You can also customize this for each buffer, using something like
241 #+MATHJAX: scale:\"133\" align:\"right\" mathml:t path:\"/MathJax/\""
242 :group
'org-export-html
243 :type
'(list :greedy t
244 (list :tag
"path (the path from where to load MathJax.js)"
245 (const :format
" " path
) (string))
246 (list :tag
"scale (scaling for the displayed math)"
247 (const :format
" " scale
) (string))
248 (list :tag
"align (alignment of displayed equations)"
249 (const :format
" " align
) (string))
250 (list :tag
"indent (indentation with left or right alignment)"
251 (const :format
" " indent
) (string))
252 (list :tag
"mathml (should MathML display be used is possible)"
253 (const :format
" " mathml
) (boolean))))
255 (defun org-export-html-mathjax-config (template options in-buffer
)
256 "Insert the user setup into the matchjax template."
257 (let (name val
(yes " ") (no "// ") x
)
260 (setq name
(car e
) val
(nth 1 e
))
261 (if (string-match (concat "\\<" (symbol-name name
) ":") in-buffer
)
262 (setq val
(car (read-from-string
263 (substring in-buffer
(match-end 0))))))
264 (if (not (stringp val
)) (setq val
(format "%s" val
)))
265 (if (string-match (concat "%" (upcase (symbol-name name
))) template
)
266 (setq template
(replace-match val t t template
))))
268 (setq val
(nth 1 (assq 'mathml options
)))
269 (if (string-match (concat "\\<mathml:") in-buffer
)
270 (setq val
(car (read-from-string
271 (substring in-buffer
(match-end 0))))))
272 ;; Exchange prefixes depending on mathml setting
273 (if (not val
) (setq x yes yes no no x
))
274 ;; Replace cookies to turn on or off the config/jax lines
275 (if (string-match ":MMLYES:" template
)
276 (setq template
(replace-match yes t t template
)))
277 (if (string-match ":MMLNO:" template
)
278 (setq template
(replace-match no t t template
)))
279 ;; Return the modified template
282 (defcustom org-export-html-mathjax-template
283 "<script type=\"text/javascript\" src=\"%PATH\">
284 <!--/*--><![CDATA[/*><!--*/
286 // Only one of the two following lines, depending on user settings
287 // First allows browser-native MathML display, second forces HTML/CSS
288 :MMLYES: config: [\"MMLorHTML.js\"], jax: [\"input/TeX\"],
289 :MMLNO: jax: [\"input/TeX\", \"output/HTML-CSS\"],
290 extensions: [\"tex2jax.js\",\"TeX/AMSmath.js\",\"TeX/AMSsymbols.js\",
291 \"TeX/noUndefined.js\"],
293 inlineMath: [ [\"\\\\(\",\"\\\\)\"] ],
294 displayMath: [ ['$$','$$'], [\"\\\\[\",\"\\\\]\"], [\"\\\\begin{displaymath}\",\"\\\\end{displaymath}\"] ],
295 skipTags: [\"script\",\"noscript\",\"style\",\"textarea\",\"pre\",\"code\"],
296 ignoreClass: \"tex2jax_ignore\",
297 processEscapes: false,
298 processEnvironments: true,
301 showProcessingMessages: true,
302 displayAlign: \"%ALIGN\",
303 displayIndent: \"%INDENT\",
307 availableFonts: [\"STIX\",\"TeX\"],
308 preferredFont: \"TeX\",
324 "The MathJax setup for XHTML files."
325 :group
'org-export-html
328 (defcustom org-export-html-tag-class-prefix
""
329 "Prefix to class names for TODO keywords.
330 Each tag gets a class given by the tag itself, with this prefix.
331 The default prefix is empty because it is nice to just use the keyword
332 as a class name. But if you get into conflicts with other, existing
333 CSS classes, then this prefix can be very useful."
334 :group
'org-export-html
337 (defcustom org-export-html-todo-kwd-class-prefix
""
338 "Prefix to class names for TODO keywords.
339 Each TODO keyword gets a class given by the keyword itself, with this prefix.
340 The default prefix is empty because it is nice to just use the keyword
341 as a class name. But if you get into conflicts with other, existing
342 CSS classes, then this prefix can be very useful."
343 :group
'org-export-html
346 (defcustom org-export-html-preamble nil
347 "Non-nil means insert a preamble in HTML export.
348 If this is a string, use it as a formatting string it instead of
349 `org-export-html-preamble-format'. Setting :html-preamble in
350 publishing projects will override this."
351 :group
'org-export-html
354 (defcustom org-export-html-preamble-format
355 '(("en" "<h1 class=\"title\">%t</h1>"))
356 "The format for the HTML preamble.
358 %t stands for the title.
360 If you need to use a \"%\" character, you need to escape it
362 :group
'org-export-html
365 (defcustom org-export-html-postamble nil
366 "Non-nil means insert a postamble in HTML export.
367 If this is a string, use it as a formatting string it instead of
368 `org-export-html-postamble-format'. Setting :html-postamble in
369 publishing projects will override this."
370 :group
'org-export-html
373 (defcustom org-export-html-postamble-format
374 '(("en" "<p class=\"author\">Author: %a (%e)</p>
375 <p class=\"date\">Date: %d</p>
376 <p class=\"creator\">Generated by %c</p>
377 <p class=\"xhtml-validation\">%v</p>
379 "The format for the HTML postamble.
381 %a stands for the author.
382 %e stands for the email(s).
383 %d stands for the date.
384 %c will be replaced by information about Org/Emacs.
385 %v will be replaced by `org-export-html-validation-link'.
387 If you need to use a \"%\" character, you need to escape it
389 :group
'org-export-html
392 (defcustom org-export-html-home
/up-format
393 "<div id=\"org-div-home-and-up\" style=\"text-align:right;font-size:70%%;white-space:nowrap;\">
394 <a accesskey=\"h\" href=\"%s\"> UP </a>
396 <a accesskey=\"H\" href=\"%s\"> HOME </a>
398 "Snippet used to insert the HOME and UP links.
399 This is a format string, the first %s will receive the UP link,
400 the second the HOME link. If both `org-export-html-link-up' and
401 `org-export-html-link-home' are empty, the entire snippet will be
403 :group
'org-export-html
406 (defcustom org-export-html-toplevel-hlevel
2
407 "The <H> level for level 1 headings in HTML export.
408 This is also important for the classes that will be wrapped around headlines
409 and outline structure. If this variable is 1, the top-level headlines will
410 be <h1>, and the corresponding classes will be outline-1, section-number-1,
411 and outline-text-1. If this is 2, all of these will get a 2 instead.
412 The default for this variable is 2, because we use <h1> for formatting the
414 :group
'org-export-html
417 (defcustom org-export-html-link-org-files-as-html t
418 "Non-nil means make file links to `file.org' point to `file.html'.
419 When org-mode is exporting an org-mode file to HTML, links to
420 non-html files are directly put into a href tag in HTML.
421 However, links to other Org-mode files (recognized by the
422 extension `.org.) should become links to the corresponding html
423 file, assuming that the linked org-mode file will also be
425 When nil, the links still point to the plain `.org' file."
426 :group
'org-export-html
429 (defcustom org-export-html-inline-images
'maybe
430 "Non-nil means inline images into exported HTML pages.
431 This is done using an <img> tag. When nil, an anchor with href is used to
432 link to the image. If this option is `maybe', then images in links with
433 an empty description will be inlined, while images with a description will
435 :group
'org-export-html
436 :type
'(choice (const :tag
"Never" nil
)
437 (const :tag
"Always" t
)
438 (const :tag
"When there is no description" maybe
)))
440 (defcustom org-export-html-inline-image-extensions
441 '("png" "jpeg" "jpg" "gif" "svg")
442 "Extensions of image files that can be inlined into HTML."
443 :group
'org-export-html
444 :type
'(repeat (string :tag
"Extension")))
446 (defcustom org-export-html-table-tag
447 "<table border=\"2\" cellspacing=\"0\" cellpadding=\"6\" rules=\"groups\" frame=\"hsides\">"
448 "The HTML tag that is used to start a table.
449 This must be a <table> tag, but you may change the options like
450 borders and spacing."
451 :group
'org-export-html
454 (defcustom org-export-table-header-tags
'("<th scope=\"%s\"%s>" .
"</th>")
455 "The opening tag for table header fields.
456 This is customizable so that alignment options can be specified.
457 The first %s will be filled with the scope of the field, either row or col.
458 The second %s will be replaced by a style entry to align the field.
459 See also the variable `org-export-html-table-use-header-tags-for-first-column'.
460 See also the variable `org-export-html-table-align-individual-fields'."
461 :group
'org-export-tables
462 :type
'(cons (string :tag
"Opening tag") (string :tag
"Closing tag")))
464 (defcustom org-export-table-data-tags
'("<td%s>" .
"</td>")
465 "The opening tag for table data fields.
466 This is customizable so that alignment options can be specified.
467 The first %s will be filled with the scope of the field, either row or col.
468 The second %s will be replaced by a style entry to align the field.
469 See also the variable `org-export-html-table-align-individual-fields'."
470 :group
'org-export-tables
471 :type
'(cons (string :tag
"Opening tag") (string :tag
"Closing tag")))
473 (defcustom org-export-table-row-tags
'("<tr>" .
"</tr>")
474 "The opening tag for table data fields.
475 This is customizable so that alignment options can be specified.
476 Instead of strings, these can be Lisp forms that will be evaluated
477 for each row in order to construct the table row tags. During evaluation,
478 the variable `head' will be true when this is a header line, nil when this
479 is a body line. And the variable `nline' will contain the line number,
480 starting from 1 in the first header line. For example
482 (setq org-export-table-row-tags
485 (if (= (mod nline 2) 1)
486 \"<tr class=\\\"tr-odd\\\">\"
487 \"<tr class=\\\"tr-even\\\">\"))
490 will give even lines the class \"tr-even\" and odd lines the class \"tr-odd\"."
491 :group
'org-export-tables
493 (choice :tag
"Opening tag"
494 (string :tag
"Specify")
496 (choice :tag
"Closing tag"
497 (string :tag
"Specify")
500 (defcustom org-export-html-table-align-individual-fields t
501 "Non-nil means attach style attributes for alignment to each table field.
502 When nil, alignment will only be specified in the column tags, but this
503 is ignored by some browsers (like Firefox, Safari). Opera does it right
505 :group
'org-export-tables
508 (defcustom org-export-html-table-use-header-tags-for-first-column nil
509 "Non-nil means format column one in tables with header tags.
510 When nil, also column one will use data tags."
511 :group
'org-export-tables
514 (defcustom org-export-html-validation-link
515 "<a href=\"http://validator.w3.org/check?uri=referer\">Validate XHTML 1.0</a>"
516 "Link to HTML validation service."
517 :group
'org-export-html
520 (defcustom org-export-html-with-timestamp nil
521 "If non-nil, write timestamp into the exported HTML text.
522 If non-nil Write `org-export-html-html-helper-timestamp' into the
523 exported HTML text. Otherwise, the buffer will just be saved to
525 :group
'org-export-html
528 (defcustom org-export-html-html-helper-timestamp
529 "<br/><br/><hr/><p><!-- hhmts start --> <!-- hhmts end --></p>\n"
530 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
531 :group
'org-export-html
535 (defcustom org-export-html-protect-char-alist
539 "Alist of characters to be converted by `org-html-protect'."
540 :type
'((repeat (cons (string :tag
"Character")
541 (string :tag
"HTML equivalent")))))
543 (defgroup org-export-htmlize nil
544 "Options for processing examples with htmlize.el."
545 :tag
"Org Export Htmlize"
546 :group
'org-export-html
)
548 (defcustom org-export-htmlize-output-type
'inline-css
549 "Output type to be used by htmlize when formatting code snippets.
550 Choices are `css', to export the CSS selectors only, or `inline-css', to
551 export the CSS attribute values inline in the HTML. We use as default
552 `inline-css', in order to make the resulting HTML self-containing.
554 However, this will fail when using Emacs in batch mode for export, because
555 then no rich font definitions are in place. It will also not be good if
556 people with different Emacs setup contribute HTML files to a website,
557 because the fonts will represent the individual setups. In these cases,
558 it is much better to let Org/Htmlize assign classes only, and to use
559 a style file to define the look of these classes.
560 To get a start for your css file, start Emacs session and make sure that
561 all the faces you are interested in are defined, for example by loading files
562 in all modes you want. Then, use the command
563 \\[org-export-htmlize-generate-css] to extract class definitions."
564 :group
'org-export-htmlize
565 :type
'(choice (const css
) (const inline-css
)))
567 (defcustom org-export-htmlize-css-font-prefix
"org-"
568 "The prefix for CSS class names for htmlize font specifications."
569 :group
'org-export-htmlize
572 (defcustom org-export-htmlized-org-css-url nil
573 "URL pointing to a CSS file defining text colors for htmlized Emacs buffers.
574 Normally when creating an htmlized version of an Org buffer, htmlize will
575 create CSS to define the font colors. However, this does not work when
576 converting in batch mode, and it also can look bad if different people
577 with different fontification setup work on the same website.
578 When this variable is non-nil, creating an htmlized version of an Org buffer
579 using `org-export-as-org' will remove the internal CSS section and replace it
580 with a link to this URL."
581 :group
'org-export-htmlize
583 (const :tag
"Keep internal css" nil
)
584 (string :tag
"URL or local href")))
588 (defvar org-export-html-after-blockquotes-hook nil
589 "Hook run during HTML export, after blockquote, verse, center are done.")
591 (defvar org-export-html-final-hook nil
592 "Hook run at the end of HTML export, in the new buffer.")
596 (defun org-export-html-preprocess (parameters)
597 "Convert LaTeX fragments to images."
598 (when (and org-current-export-file
599 (plist-get parameters
:LaTeX-fragments
))
601 (concat "ltxpng/" (file-name-sans-extension
602 (file-name-nondirectory
603 org-current-export-file
)))
604 org-current-export-dir nil
"Creating LaTeX image %s"
607 ((eq (plist-get parameters
:LaTeX-fragments
) 'verbatim
) 'verbatim
)
608 ((eq (plist-get parameters
:LaTeX-fragments
) 'mathjax
) 'mathjax
)
609 ((eq (plist-get parameters
:LaTeX-fragments
) t
) 'mathjax
)
610 ((eq (plist-get parameters
:LaTeX-fragments
) 'dvipng
) 'dvipng
)
612 (goto-char (point-min))
614 (while (re-search-forward "\\\\ref{\\([^{}\n]+\\)}" nil t
)
615 (org-if-unprotected-at (match-beginning 1)
616 (setq label
(match-string 1))
618 (if (string-match "\\`[a-z]\\{1,10\\}:\\(.+\\)" label
)
619 (setq l1
(substring label
(match-beginning 1)))
621 (replace-match (format "[[#%s][%s]]" label l1
) t t
)))))
624 (defun org-export-as-html-and-open (arg)
625 "Export the outline as HTML and immediately open it with a browser.
626 If there is an active region, export only the region.
627 The prefix ARG specifies how many levels of the outline should become
628 headlines. The default is 3. Lower levels will become bulleted lists."
630 (org-export-as-html arg
'hidden
)
631 (org-open-file buffer-file-name
)
632 (when org-export-kill-product-buffer-when-displayed
633 (kill-buffer (current-buffer))))
636 (defun org-export-as-html-batch ()
637 "Call the function `org-export-as-html'.
638 This function can be used in batch processing as:
640 --load=$HOME/lib/emacs/org.el
641 --eval \"(setq org-export-headline-levels 2)\"
642 --visit=MyFile --funcall org-export-as-html-batch"
643 (org-export-as-html org-export-headline-levels
'hidden
))
646 (defun org-export-as-html-to-buffer (arg)
647 "Call `org-export-as-html` with output to a temporary buffer.
648 No file is created. The prefix ARG is passed through to `org-export-as-html'."
650 (org-export-as-html arg nil nil
"*Org HTML Export*")
651 (when org-export-show-temporary-export-buffer
652 (switch-to-buffer-other-window "*Org HTML Export*")))
655 (defun org-replace-region-by-html (beg end
)
656 "Assume the current region has org-mode syntax, and convert it to HTML.
657 This can be used in any buffer. For example, you could write an
658 itemized list in org-mode syntax in an HTML buffer and then use this
659 command to convert it."
661 (let (reg html buf pop-up-frames
)
662 (save-window-excursion
664 (setq html
(org-export-region-as-html
666 (setq reg
(buffer-substring beg end
)
667 buf
(get-buffer-create "*Org tmp*"))
668 (with-current-buffer buf
672 (setq html
(org-export-region-as-html
673 (point-min) (point-max) t
'string
)))
675 (delete-region beg end
)
679 (defun org-export-region-as-html (beg end
&optional body-only buffer
)
680 "Convert region from BEG to END in org-mode buffer to HTML.
681 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
682 contents, and only produce the region of converted text, useful for
683 cut-and-paste operations.
684 If BUFFER is a buffer or a string, use/create that buffer as a target
685 of the converted HTML. If BUFFER is the symbol `string', return the
686 produced HTML as a string and leave not buffer behind. For example,
687 a Lisp program could call this function in the following way:
689 (setq html (org-export-region-as-html beg end t 'string))
691 When called interactively, the output buffer is selected, and shown
692 in a window. A non-interactive call will only return the buffer."
694 (when (interactive-p)
695 (setq buffer
"*Org HTML Export*"))
696 (let ((transient-mark-mode t
) (zmacs-regions t
)
698 (setq ext-plist
(plist-put ext-plist
:ignore-subtree-p t
))
700 (set-mark (point)) ;; to activate the region
702 (setq rtn
(org-export-as-html
705 (if (fboundp 'deactivate-mark
) (deactivate-mark))
706 (if (and (interactive-p) (bufferp rtn
))
707 (switch-to-buffer-other-window rtn
)
710 (defvar html-table-tag nil
) ; dynamically scoped into this.
711 (defvar org-par-open nil
)
713 ;;; org-html-cvt-link-fn
714 (defconst org-html-cvt-link-fn
716 "Function to convert link URLs to exportable URLs.
717 Takes two arguments, TYPE and PATH.
718 Returns exportable url as (TYPE PATH), or nil to signal that it
719 didn't handle this case.
720 Intended to be locally bound around a call to `org-export-as-html'." )
722 (defun org-html-cvt-org-as-html (opt-plist type path
)
723 "Convert an org filename to an equivalent html filename.
724 If TYPE is not file, just return `nil'.
725 See variable `org-export-html-link-org-files-as-html'"
729 org-export-html-link-org-files-as-html
730 (string= type
"file")
731 (string-match "\\.org$" path
)
736 (substring path
0 (match-beginning 0))
738 (plist-get opt-plist
:html-extension
)))))))
741 ;;; org-html-should-inline-p
742 (defun org-html-should-inline-p (filename descp
)
743 "Return non-nil if link FILENAME should be inlined.
744 The decision to inline the FILENAME link is based on the current
745 settings. DESCP is the boolean of whether there was a link
746 description. See variables `org-export-html-inline-images' and
747 `org-export-html-inline-image-extensions'."
749 org-export-html-inline-images
750 org-export-html-inline-image-extensions
))
751 (and (or (eq t org-export-html-inline-images
)
752 (and org-export-html-inline-images
(not descp
)))
754 filename org-export-html-inline-image-extensions
)))
756 ;;; org-html-make-link
757 (defun org-html-make-link (opt-plist type path fragment desc attr
760 OPT-PLIST is an options list.
761 TYPE is the device-type of the link (THIS://foo.html)
762 PATH is the path of the link (http://THIS#locationx)
763 FRAGMENT is the fragment part of the link, if any (foo.html#THIS)
764 DESC is the link description, if any.
765 ATTR is a string of other attributes of the a element.
766 MAY-INLINE-P allows inlining it as an image."
768 (declare (special org-par-open
))
770 (let* ((filename path
)
771 ;;First pass. Just sanity stuff.
774 ((string= type
"file")
777 ;;Substitute just if original path was absolute.
778 ;;(Otherwise path must remain relative)
779 (if (file-name-absolute-p path
)
780 (concat "file://" (expand-file-name path
))
784 (t (list type path
))))
786 ;;Second pass. Components converted so they can refer
790 (and org-html-cvt-link-fn
791 (apply org-html-cvt-link-fn
792 opt-plist components-1
))
793 (apply #'org-html-cvt-org-as-html
794 opt-plist components-1
)
796 (type (first components-2
))
797 (thefile (second components-2
)))
800 ;;Third pass. Build final link except for leading type
805 (string= type
"http")
806 (string= type
"https")
807 (string= type
"file"))
809 (setq thefile
(concat thefile
"#" fragment
))))
813 ;;Final URL-build, for all types.
816 ((str (org-export-html-format-href thefile
)))
817 (if (and type
(not (string= "file" type
)))
818 (concat type
":" str
)
823 ;;Can't inline a URL with a fragment.
826 (message "image %s %s" thefile org-par-open
)
827 (org-export-html-format-image thefile org-par-open
))
829 "@<a href=\"" thefile
"\"" (if attr
(concat " " attr
)) ">"
830 (org-export-html-format-desc desc
)
833 (defun org-html-handle-links (line opt-plist
)
834 "Return LINE with markup of Org mode links.
835 OPT-PLIST is the export options list."
837 (current-dir (if buffer-file-name
838 (file-name-directory buffer-file-name
)
840 (link-validate (plist-get opt-plist
:link-validation-function
))
842 rpl path attr desc descp desc1 desc2 link
)
843 (while (string-match org-bracket-link-analytic-regexp
++ line start
)
844 (setq start
(match-beginning 0))
845 (setq path
(save-match-data (org-link-unescape
846 (match-string 3 line
))))
848 ((match-end 2) (match-string 2 line
))
850 (or (file-name-absolute-p path
)
851 (string-match "^\\.\\.?/" path
)))
854 (setq path
(org-extract-attributes (org-link-unescape path
)))
855 (setq attr
(get-text-property 0 'org-attributes path
))
856 (setq desc1
(if (match-end 5) (match-string 5 line
))
857 desc2
(if (match-end 2) (concat type
":" path
) path
)
858 descp
(and desc1
(not (equal desc1 desc2
)))
859 desc
(or desc1 desc2
))
860 ;; Make an image out of the description if that is so wanted
861 (when (and descp
(org-file-image-p
862 desc org-export-html-inline-image-extensions
))
864 (if (string-match "^file:" desc
)
865 (setq desc
(substring desc
(match-end 0)))))
866 (setq desc
(org-add-props
867 (concat "@<img src=\"" desc
"\"/>")
868 '(org-protected t
))))
870 ((equal type
"internal")
873 (if (= (string-to-char path
) ?
#)
881 (org-solidify-link-text
882 (save-match-data (org-link-unescape frag-0
))
885 ((and (equal type
"id")
886 (setq id-file
(org-id-find-id-file path
)))
887 ;; This is an id: link to another file (if it was the same file,
888 ;; it would have become an internal link...)
890 (setq id-file
(file-relative-name
892 (file-name-directory org-current-export-file
)))
894 (org-html-make-link opt-plist
896 (concat (if (org-uuidgen-p path
) "ID-") path
)
900 ((member type
'("http" "https"))
901 ;; standard URL, can inline as image
903 (org-html-make-link opt-plist
907 (org-html-should-inline-p path descp
))))
908 ((member type
'("ftp" "mailto" "news"))
909 ;; standard URL, can't inline as image
911 (org-html-make-link opt-plist
917 ((string= type
"coderef")
919 ((coderef-str (format "coderef-%s" path
))
921 (format "class=\"coderef\" onmouseover=\"CodeHighlightOn(this, '%s');\" onmouseout=\"CodeHighlightOff(this, '%s');\""
922 coderef-str coderef-str
)))
924 (org-html-make-link opt-plist
927 (org-export-get-coderef-format
930 (cdr (assoc path org-export-code-refs
)))
934 ((functionp (setq fnc
(nth 2 (assoc type org-link-protocols
))))
935 ;; The link protocol has a function for format the link
938 (funcall fnc
(org-link-unescape path
) desc1
'html
))))
940 ((string= type
"file")
946 (string-match "::\\(.*\\)" path
)
948 (replace-match "" t nil path
)
949 (match-string 1 path
))
952 ;;The proper path, without a fragment
960 ;;Check the fragment. If it can't be used as
961 ;;target fragment we'll pass nil instead.
965 (not (string-match "^[0-9]*$" fragment-0
))
966 (not (string-match "^\\*" fragment-0
))
967 (not (string-match "^/.*/$" fragment-0
)))
968 (org-solidify-link-text
969 (org-link-unescape fragment-0
))
972 ;;Description minus "file:" and ".org"
973 (if (string-match "^file:" desc
)
975 ((desc-1 (replace-match "" t t desc
)))
976 (if (string-match "\\.org$" desc-1
)
977 (replace-match "" t t desc-1
)
984 (functionp link-validate
)
985 (not (funcall link-validate path-1 current-dir
)))
987 (org-html-make-link opt-plist
988 "file" path-1 fragment-1 desc-2 attr
989 (org-html-should-inline-p path-1 descp
)))))))
992 ;; just publish the path, as default
993 (setq rpl
(concat "@<i><" type
":"
994 (save-match-data (org-link-unescape path
))
996 (setq line
(replace-match rpl t t line
)
997 start
(+ start
(length rpl
))))
1000 ;;; org-export-as-html
1002 (defun org-export-as-html (arg &optional hidden ext-plist
1003 to-buffer body-only pub-dir
)
1004 "Export the outline as a pretty HTML file.
1005 If there is an active region, export only the region. The prefix
1006 ARG specifies how many levels of the outline should become
1007 headlines. The default is 3. Lower levels will become bulleted
1008 lists. HIDDEN is obsolete and does nothing.
1009 EXT-PLIST is a property list with external parameters overriding
1010 org-mode's default settings, but still inferior to file-local
1011 settings. When TO-BUFFER is non-nil, create a buffer with that
1012 name and export to that buffer. If TO-BUFFER is the symbol
1013 `string', don't leave any buffer behind but just return the
1014 resulting HTML as a string. When BODY-ONLY is set, don't produce
1015 the file header and footer, simply return the content of
1016 <body>...</body>, without even the body tags themselves. When
1017 PUB-DIR is set, use this as the publishing directory."
1019 (run-hooks 'org-export-first-hook
)
1021 ;; Make sure we have a file name when we need it.
1022 (when (and (not (or to-buffer body-only
))
1023 (not buffer-file-name
))
1024 (if (buffer-base-buffer)
1025 (org-set-local 'buffer-file-name
1026 (with-current-buffer (buffer-base-buffer)
1028 (error "Need a file name to be able to export")))
1030 (message "Exporting...")
1031 (setq-default org-todo-line-regexp org-todo-line-regexp
)
1032 (setq-default org-deadline-line-regexp org-deadline-line-regexp
)
1033 (setq-default org-done-keywords org-done-keywords
)
1034 (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp
)
1036 (org-export-process-option-filters
1037 (org-combine-plists (org-default-export-plist)
1039 (org-infile-export-plist))))
1040 (body-only (or body-only
(plist-get opt-plist
:body-only
)))
1041 (style (concat (if (plist-get opt-plist
:style-include-default
)
1042 org-export-html-style-default
)
1043 (plist-get opt-plist
:style
)
1044 (plist-get opt-plist
:style-extra
)
1046 (if (plist-get opt-plist
:style-include-scripts
)
1047 org-export-html-scripts
)))
1048 (html-extension (plist-get opt-plist
:html-extension
))
1049 valid thetoc have-headings first-heading-pos
1050 (odd org-odd-levels-only
)
1051 (region-p (org-region-active-p))
1052 (rbeg (and region-p
(region-beginning)))
1053 (rend (and region-p
(region-end)))
1055 (if (plist-get opt-plist
:ignore-subtree-p
)
1060 (and (org-at-heading-p)
1061 (>= (org-end-of-subtree t t
) rend
))))))
1062 (level-offset (if subtree-p
1065 (+ (funcall outline-level
)
1066 (if org-odd-levels-only
1 0)))
1068 (opt-plist (setq org-export-opt-plist
1070 (org-export-add-subtree-options opt-plist rbeg
)
1072 ;; The following two are dynamically scoped into other
1074 (org-current-export-dir
1075 (or pub-dir
(org-export-directory :html opt-plist
)))
1076 (org-current-export-file buffer-file-name
)
1077 (level 0) (line "") (origline "") txt todo
1080 (filename (if to-buffer nil
1083 (file-name-sans-extension
1085 (org-entry-get (region-beginning)
1086 "EXPORT_FILE_NAME" t
))
1087 (file-name-nondirectory buffer-file-name
)))
1089 (file-name-as-directory
1090 (or pub-dir
(org-export-directory :html opt-plist
))))))
1091 (current-dir (if buffer-file-name
1092 (file-name-directory buffer-file-name
)
1094 (buffer (if to-buffer
1096 ((eq to-buffer
'string
) (get-buffer-create "*Org HTML Export*"))
1097 (t (get-buffer-create to-buffer
)))
1098 (find-file-noselect filename
)))
1099 (org-levels-open (make-vector org-level-max nil
))
1100 (date (plist-get opt-plist
:date
))
1101 (author (plist-get opt-plist
:author
))
1102 (html-validation-link (or org-export-html-validation-link
""))
1103 (title (org-html-expand
1104 (or (and subtree-p
(org-export-get-title-from-subtree))
1105 (plist-get opt-plist
:title
)
1106 (and (not body-only
)
1108 (plist-get opt-plist
:skip-before-1st-heading
))
1109 (org-export-grab-title-from-buffer))
1110 (and buffer-file-name
1111 (file-name-sans-extension
1112 (file-name-nondirectory buffer-file-name
)))
1114 (link-up (and (plist-get opt-plist
:link-up
)
1115 (string-match "\\S-" (plist-get opt-plist
:link-up
))
1116 (plist-get opt-plist
:link-up
)))
1117 (link-home (and (plist-get opt-plist
:link-home
)
1118 (string-match "\\S-" (plist-get opt-plist
:link-home
))
1119 (plist-get opt-plist
:link-home
)))
1120 (dummy (setq opt-plist
(plist-put opt-plist
:title title
)))
1121 (html-table-tag (plist-get opt-plist
:html-table-tag
))
1122 (quote-re0 (concat "^[ \t]*" org-quote-string
"\\>"))
1123 (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string
"\\>\\)"))
1127 (email (plist-get opt-plist
:email
))
1128 (language (plist-get opt-plist
:language
))
1129 (keywords (plist-get opt-plist
:keywords
))
1130 (description (plist-get opt-plist
:description
))
1134 (coding-system (and (boundp 'buffer-file-coding-system
)
1135 buffer-file-coding-system
))
1136 (coding-system-for-write (or org-export-html-coding-system
1138 (save-buffer-coding-system (or org-export-html-coding-system
1140 (charset (and coding-system-for-write
1141 (fboundp 'coding-system-get
)
1142 (coding-system-get coding-system-for-write
1146 (if region-p
(region-beginning) (point-min))
1147 (if region-p
(region-end) (point-max))))
1148 (org-export-have-math nil
)
1151 (org-export-preprocess-string
1155 :skip-before-1st-heading
1156 (plist-get opt-plist
:skip-before-1st-heading
)
1157 :drawers
(plist-get opt-plist
:drawers
)
1158 :todo-keywords
(plist-get opt-plist
:todo-keywords
)
1159 :tags
(plist-get opt-plist
:tags
)
1160 :priority
(plist-get opt-plist
:priority
)
1161 :footnotes
(plist-get opt-plist
:footnotes
)
1162 :timestamps
(plist-get opt-plist
:timestamps
)
1164 (plist-get opt-plist
:archived-trees
)
1165 :select-tags
(plist-get opt-plist
:select-tags
)
1166 :exclude-tags
(plist-get opt-plist
:exclude-tags
)
1168 (plist-get opt-plist
:text
)
1170 (plist-get opt-plist
:LaTeX-fragments
))
1173 (if (or (eq (plist-get opt-plist
:LaTeX-fragments
) 'mathjax
)
1174 (and org-export-have-math
1175 (eq (plist-get opt-plist
:LaTeX-fragments
) t
)))
1177 (org-export-html-mathjax-config
1178 org-export-html-mathjax-template
1179 org-export-html-mathjax-options
1180 (or (plist-get opt-plist
:mathjax
) ""))
1183 table-buffer table-orig-buffer
1185 rpl path attr desc descp desc1 desc2 link
1187 footnotes footref-seen
1191 (let ((inhibit-read-only t
))
1193 (remove-text-properties (point-min) (point-max)
1194 '(:org-license-to-kill t
))))
1196 (message "Exporting...")
1198 (setq org-min-level
(org-get-min-level lines level-offset
))
1199 (setq org-last-level org-min-level
)
1200 (org-init-section-numbers)
1203 ((and date
(string-match "%" date
))
1204 (setq date
(format-time-string date
)))
1206 (t (setq date
(format-time-string "%Y-%m-%d %T %Z"))))
1208 ;; Get the language-dependent settings
1209 (setq lang-words
(or (assoc language org-export-language-setup
)
1210 (assoc "en" org-export-language-setup
)))
1212 ;; Switch to the output buffer
1214 (let ((inhibit-read-only t
)) (erase-buffer))
1216 (org-install-letbind)
1218 (and (fboundp 'set-buffer-file-coding-system
)
1219 (set-buffer-file-coding-system coding-system-for-write
))
1221 (let ((case-fold-search nil
)
1222 (org-odd-levels-only odd
))
1223 ;; create local variables for all options, to make sure all called
1224 ;; functions get the correct information
1226 (set (make-local-variable (nth 2 x
))
1227 (plist-get opt-plist
(car x
))))
1228 org-export-plist-vars
)
1229 (setq umax
(if arg
(prefix-numeric-value arg
)
1230 org-export-headline-levels
))
1231 (setq umax-toc
(if (integerp org-export-with-toc
)
1232 (min org-export-with-toc umax
)
1238 <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
1239 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
1240 <html xmlns=\"http://www.w3.org/1999/xhtml\"
1241 lang=\"%s\" xml:lang=\"%s\">
1244 <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
1245 <meta name=\"generator\" content=\"Org-mode\"/>
1246 <meta name=\"generated\" content=\"%s\"/>
1247 <meta name=\"author\" content=\"%s\"/>
1248 <meta name=\"description\" content=\"%s\"/>
1249 <meta name=\"keywords\" content=\"%s\"/>
1254 <div id=\"content\">
1258 (or (and (stringp org-export-html-xml-declaration
)
1259 org-export-html-xml-declaration
)
1260 (cdr (assoc html-extension org-export-html-xml-declaration
))
1261 (cdr (assoc "html" org-export-html-xml-declaration
))
1264 (or charset
"iso-8859-1"))
1267 (or charset
"iso-8859-1")
1268 date author description keywords
1271 (if (or link-up link-home
)
1273 (format org-export-html-home
/up-format
1274 (or link-up link-home
)
1275 (or link-home link-up
))
1279 ;; insert html preamble
1280 (if (plist-get opt-plist
:html-preamble
)
1281 (let* ((html-preamble (plist-get opt-plist
:html-preamble
))
1282 (html-preamble-format
1283 (if (stringp html-preamble
)
1285 (cadr (or (assoc (nth 0 lang-words
)
1286 org-export-html-preamble-format
)
1287 (assoc "en" org-export-html-preamble-format
))))))
1288 (insert (format-spec html-preamble-format
1290 (?a .
,author
) (?d .
,date
) (?e .
,email
)))))
1291 (insert "<h1 class=\"title\">" title
"</h1>")))
1293 (if (and org-export-with-toc
(not body-only
))
1295 (push (format "<h%d>%s</h%d>\n"
1296 org-export-html-toplevel-hlevel
1298 org-export-html-toplevel-hlevel
)
1300 (push "<div id=\"text-table-of-contents\">\n" thetoc
)
1301 (push "<ul>\n<li>" thetoc
)
1303 (mapcar '(lambda (line)
1304 (if (and (string-match org-todo-line-regexp line
)
1305 (not (get-text-property 0 'org-protected line
)))
1306 ;; This is a headline
1308 (setq have-headings t
)
1309 (setq level
(- (match-end 1) (match-beginning 1)
1311 level
(org-tr-level level
)
1312 txt
(save-match-data
1314 (org-export-cleanup-toc-line
1315 (match-string 3 line
))))
1317 (or (and org-export-mark-todo-in-toc
1319 (not (member (match-string 2 line
)
1320 org-done-keywords
)))
1322 (and org-export-mark-todo-in-toc
1324 (org-search-todo-below
1325 line lines level
))))
1327 (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt
)
1328 (setq txt
(replace-match " <span class=\"tag\"> \\1</span>" t nil txt
)))
1329 (if (string-match quote-re0 txt
)
1330 (setq txt
(replace-match "" t t txt
)))
1331 (setq snumber
(org-section-number level
))
1332 (if org-export-with-section-numbers
1333 (setq txt
(concat snumber
" " txt
)))
1334 (if (<= level
(max umax umax-toc
))
1335 (setq head-count
(+ head-count
1)))
1336 (if (<= level umax-toc
)
1338 (if (> level org-last-level
)
1340 (setq cnt
(- level org-last-level
))
1341 (while (>= (setq cnt
(1- cnt
)) 0)
1342 (push "\n<ul>\n<li>" thetoc
))
1343 (push "\n" thetoc
)))
1344 (if (< level org-last-level
)
1346 (setq cnt
(- org-last-level level
))
1347 (while (>= (setq cnt
(1- cnt
)) 0)
1348 (push "</li>\n</ul>" thetoc
))
1349 (push "\n" thetoc
)))
1350 ;; Check for targets
1351 (while (string-match org-any-target-regexp line
)
1352 (setq line
(replace-match
1353 (concat "@<span class=\"target\">" (match-string 1 line
) "@</span> ")
1355 (while (string-match "<\\(<\\)+\\|>\\(>\\)+" txt
)
1356 (setq txt
(replace-match "" t t txt
)))
1358 (replace-regexp-in-string
1359 "\\." "_" (format "sec-%s" snumber
)))
1360 (setq href
(org-solidify-link-text (or (cdr (assoc href org-export-preferred-target-alist
)) href
)))
1364 "</li>\n<li><a href=\"#%s\"><span class=\"todo\">%s</span></a>"
1365 "</li>\n<li><a href=\"#%s\">%s</a>")
1368 (setq org-last-level level
))
1372 (while (> org-last-level
(1- org-min-level
))
1373 (setq org-last-level
(1- org-last-level
))
1374 (push "</li>\n</ul>\n" thetoc
))
1375 (push "</div>\n" thetoc
)
1376 (setq thetoc
(if have-headings
(nreverse thetoc
) nil
))))
1379 (org-init-section-numbers)
1383 (while (setq line
(pop lines
) origline line
)
1386 ;; end of quote section?
1387 (when (and inquote
(string-match "^\\*+ " line
))
1391 ;; inside a quote section?
1393 (insert (org-html-protect line
) "\n")
1394 (throw 'nextline nil
))
1396 ;; Fixed-width, verbatim lines (examples)
1397 (when (and org-export-with-fixed-width
1398 (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line
))
1401 (org-close-par-maybe)
1403 (insert "<pre class=\"example\">\n"))
1404 (insert (org-html-protect (match-string 3 line
)) "\n")
1405 (when (or (not lines
)
1406 (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
1411 (throw 'nextline nil
))
1414 (when (and (get-text-property 0 'org-protected line
)
1415 ;; Make sure it is the entire line that is protected
1416 (not (< (or (next-single-property-change
1417 0 'org-protected line
) 10000)
1419 (let (par (ind (get-text-property 0 'original-indentation line
)))
1420 (when (re-search-backward
1421 "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t
)
1422 (setq par
(match-string 1))
1423 (replace-match "\\2\n"))
1426 (or (= (length (car lines
)) 0)
1428 (equal ind
(get-text-property 0 'original-indentation
(car lines
))))
1429 (or (= (length (car lines
)) 0)
1430 (get-text-property 0 'org-protected
(car lines
))))
1431 (insert (pop lines
) "\n"))
1432 (and par
(insert "<p>\n")))
1433 (throw 'nextline nil
))
1435 ;; Blockquotes, verse, and center
1436 (when (equal "ORG-BLOCKQUOTE-START" line
)
1437 (org-close-par-maybe)
1438 (insert "<blockquote>\n")
1440 (throw 'nextline nil
))
1441 (when (equal "ORG-BLOCKQUOTE-END" line
)
1442 (org-close-par-maybe)
1443 (insert "\n</blockquote>\n")
1445 (throw 'nextline nil
))
1446 (when (equal "ORG-VERSE-START" line
)
1447 (org-close-par-maybe)
1448 (insert "\n<p class=\"verse\">\n")
1449 (setq org-par-open t
)
1451 (throw 'nextline nil
))
1452 (when (equal "ORG-VERSE-END" line
)
1454 (setq org-par-open nil
)
1457 (throw 'nextline nil
))
1458 (when (equal "ORG-CENTER-START" line
)
1459 (org-close-par-maybe)
1460 (insert "\n<div style=\"text-align: center\">")
1462 (throw 'nextline nil
))
1463 (when (equal "ORG-CENTER-END" line
)
1464 (org-close-par-maybe)
1467 (throw 'nextline nil
))
1468 (run-hooks 'org-export-html-after-blockquotes-hook
)
1470 (let ((i (org-get-string-indentation line
)))
1472 (setq line
(concat (mapconcat 'identity
1473 (make-list (* 2 i
) "\\nbsp") "")
1474 " " (org-trim line
))))
1475 (unless (string-match "\\\\\\\\[ \t]*$" line
)
1476 (setq line
(concat line
"\\\\")))))
1478 ;; make targets to anchors
1480 (while (string-match
1481 "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start
)
1483 ((get-text-property (match-beginning 1) 'org-protected line
)
1484 (setq start
(match-end 1)))
1486 (setq line
(replace-match
1488 "@<a name=\"%s\" id=\"%s\">@</a>"
1489 (org-solidify-link-text (match-string 1 line
))
1490 (org-solidify-link-text (match-string 1 line
)))
1492 ((and org-export-with-toc
(equal (string-to-char line
) ?
*))
1493 ;; FIXME: NOT DEPENDENT on TOC?????????????????????
1494 (setq line
(replace-match
1495 (concat "@<span class=\"target\">"
1496 (match-string 1 line
) "@</span> ")
1497 ;; (concat "@<i>" (match-string 1 line) "@</i> ")
1500 (setq line
(replace-match
1501 (concat "@<a name=\""
1502 (org-solidify-link-text (match-string 1 line
))
1503 "\" class=\"target\">" (match-string 1 line
)
1508 (setq line
(org-html-handle-links line opt-plist
))
1510 (setq line
(org-html-handle-time-stamps line
))
1512 ;; replace "&" by "&", "<" and ">" by "<" and ">"
1513 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
1514 ;; Also handle sub_superscripts and checkboxes
1515 (or (string-match org-table-hline-regexp line
)
1516 (setq line
(org-html-expand line
)))
1519 (if (and (string-match org-todo-line-regexp line
)
1520 (match-beginning 2))
1523 (concat (substring line
0 (match-beginning 2))
1525 (if (member (match-string 2 line
)
1528 " " (match-string 2 line
)
1529 "\"> " (org-export-html-get-todo-kwd-class-name
1530 (match-string 2 line
))
1531 "</span>" (substring line
(match-end 2)))))
1533 ;; Does this contain a reference to a footnote?
1534 (when org-export-with-footnotes
1536 (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start
)
1537 (if (get-text-property (match-beginning 2) 'org-protected line
)
1538 (setq start
(match-end 2))
1539 (let ((n (match-string 2 line
)) extra a
)
1540 (if (setq a
(assoc n footref-seen
))
1542 (setcdr a
(1+ (cdr a
)))
1543 (setq extra
(format ".%d" (cdr a
))))
1545 (push (cons n
1) footref-seen
))
1550 (format org-export-html-footnote-format
1551 "<a class=\"footref\" name=\"fnr.%s%s\" href=\"#fn.%s\">%s</a>"))
1552 (or (match-string 1 line
) "") n extra n n
)
1556 ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line
)
1557 ;; This is a headline
1558 (setq level
(org-tr-level (- (match-end 1) (match-beginning 1)
1560 txt
(match-string 2 line
))
1561 (if (string-match quote-re0 txt
)
1562 (setq txt
(replace-match "" t t txt
)))
1563 (if (<= level
(max umax umax-toc
))
1564 (setq head-count
(+ head-count
1)))
1565 (setq first-heading-pos
(or first-heading-pos
(point)))
1566 (org-html-level-start level txt umax
1567 (and org-export-with-toc
(<= level umax
))
1571 (when (string-match quote-re line
)
1572 (org-close-par-maybe)
1576 ((and org-export-with-tables
1577 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line
))
1578 (when (not table-open
)
1580 (setq table-open t table-buffer nil table-orig-buffer nil
))
1583 (setq table-buffer
(cons line table-buffer
)
1584 table-orig-buffer
(cons origline table-orig-buffer
))
1585 (when (or (not lines
)
1586 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
1588 (setq table-open nil
1589 table-buffer
(nreverse table-buffer
)
1590 table-orig-buffer
(nreverse table-orig-buffer
))
1591 (org-close-par-maybe)
1592 (insert (org-format-table-html table-buffer table-orig-buffer
))))
1597 ;; This line either is list item or end a list.
1598 (when (get-text-property 0 'list-item line
)
1599 (setq line
(org-html-export-list-line
1601 (get-text-property 0 'list-item line
)
1602 (get-text-property 0 'list-struct line
)
1603 (get-text-property 0 'list-prevs line
))))
1606 (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line
)
1608 (insert "\n</p>\n<hr/>\n<p>\n")
1609 (insert "\n<hr/>\n"))
1610 (throw 'nextline nil
))
1612 ;; Empty lines start a new paragraph. If hand-formatted lists
1613 ;; are not fully interpreted, lines starting with "-", "+", "*"
1614 ;; also start a new paragraph.
1615 (if (string-match "^ [-+*]-\\|^[ \t]*$" line
) (org-open-par))
1617 ;; Is this the start of a footnote?
1618 (when org-export-with-footnotes
1619 (when (and (boundp 'footnote-section-tag-regexp
)
1620 (string-match (concat "^" footnote-section-tag-regexp
)
1623 (throw 'nextline nil
))
1624 (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line
)
1625 (org-close-par-maybe)
1626 (let ((n (match-string 1 line
)))
1627 (setq org-par-open t
1630 (concat "<p class=\"footnote\">"
1631 (format org-export-html-footnote-format
1632 "<a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a>"))
1633 n n n
) t t line
)))))
1634 ;; Check if the line break needs to be conserved
1636 ((string-match "\\\\\\\\[ \t]*$" line
)
1637 (setq line
(replace-match "<br/>" t t line
)))
1638 (org-export-preserve-breaks
1639 (setq line
(concat line
"<br/>"))))
1641 ;; Check if a paragraph should be started
1643 (while (and org-par-open
1644 (string-match "\\\\par\\>" line start
))
1645 ;; Leave a space in the </p> so that the footnote matcher
1646 ;; does not see this.
1647 (if (not (get-text-property (match-beginning 0)
1648 'org-protected line
))
1649 (setq line
(replace-match "</p ><p >" t t line
)))
1650 (setq start
(match-end 0))))
1652 (insert line
"\n")))))
1654 ;; Properly close all local lists and other lists
1659 (org-html-level-start 1 nil umax
1660 (and org-export-with-toc
(<= level umax
))
1662 ;; the </div> to close the last text-... div.
1663 (when (and (> umax
0) first-heading-pos
) (insert "</div>\n"))
1666 (goto-char (point-min))
1667 (while (re-search-forward "<p class=\"footnote\">[^\000]*?\\(</p>\\|\\'\\)" nil t
)
1668 (push (match-string 0) footnotes
)
1669 (replace-match "" t t
)))
1671 (insert (format org-export-html-footnotes-section
1673 (mapconcat 'identity
(nreverse footnotes
) "\n"))
1675 (let ((bib (org-export-html-get-bibliography)))
1677 (insert "\n" bib
"\n")))
1679 ;; export html postamble
1681 (if (plist-get opt-plist
:html-postamble
)
1682 (let* ((html-postamble (plist-get opt-plist
:html-postamble
))
1683 (html-postamble-format
1684 (if (stringp html-postamble
)
1686 (or (cadr (assoc (nth 0 lang-words
)
1687 org-export-html-postamble-format
))
1688 (cadr (assoc "en" org-export-html-postamble-format
)))))
1690 (mapconcat (lambda(e)
1691 (format "<a href=\"mailto:%s\">%s</a>" e e
))
1692 (split-string email
",+ *")
1695 (concat "Org version " org-version
" with Emacs version "
1696 (number-to-string emacs-major-version
))))
1697 (insert "<div id=\"postamble\">\n")
1698 (insert (format-spec html-postamble-format
1699 `((?a .
,author
) (?e .
,email
)
1700 (?d .
,date
) (?c .
,creator-info
)
1701 (?v .
,html-validation-link
))))
1703 ;; fall back on default postamble
1704 (insert "<div id=\"postamble\">\n")
1705 (when (and (plist-get opt-plist
:author-info
) author
)
1706 (insert "<p class=\"author\">" (nth 1 lang-words
) ": " author
"</p>\n"))
1707 (when (and (plist-get opt-plist
:email-info
) email
)
1708 (insert "<p class=\"email\"><a href=\"mailto:"
1709 email
"\"><" email
"></a></p>\n"))
1710 (when (plist-get opt-plist
:creator-info
)
1711 (insert "<p class=\"creator\">"
1712 (concat "Org version " org-version
" with Emacs version "
1713 (number-to-string emacs-major-version
) "</p>\n")))
1714 (insert html-validation-link
"\n</div>")))
1716 (if org-export-html-with-timestamp
1717 (insert org-export-html-html-helper-timestamp
))
1719 (unless body-only
(insert "\n</div>\n</body>\n</html>\n"))
1721 (unless (plist-get opt-plist
:buffer-will-be-killed
)
1723 (if (eq major-mode
(default-value 'major-mode
))
1726 ;; insert the table of contents
1727 (goto-char (point-min))
1729 (if (or (re-search-forward
1730 "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t
)
1732 "\\[TABLE-OF-CONTENTS\\]" nil t
))
1734 (goto-char (match-beginning 0))
1736 (goto-char first-heading-pos
)
1737 (when (looking-at "\\s-*</p>")
1738 (goto-char (match-end 0))
1740 (insert "<div id=\"table-of-contents\">\n")
1741 (let ((beg (point)))
1742 (mapc 'insert thetoc
)
1744 (while (re-search-backward "<li>[ \r\n\t]*</li>\n?" beg t
)
1745 (replace-match ""))))
1746 ;; remove empty paragraphs
1747 (goto-char (point-min))
1748 (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t
)
1750 (goto-char (point-min))
1751 ;; Convert whitespace place holders
1752 (goto-char (point-min))
1754 (while (setq beg
(next-single-property-change (point) 'org-whitespace
))
1755 (setq n
(get-text-property beg
'org-whitespace
)
1756 end
(next-single-property-change beg
'org-whitespace
))
1758 (delete-region beg end
)
1759 (insert (format "<span style=\"visibility:hidden;\">%s</span>"
1760 (make-string n ?x
)))))
1761 ;; Remove empty lines at the beginning of the file.
1762 (goto-char (point-min))
1763 (when (looking-at "\\s-+\n") (replace-match ""))
1764 ;; Remove display properties
1765 (remove-text-properties (point-min) (point-max) '(display t
))
1767 (run-hooks 'org-export-html-final-hook
)
1768 (or to-buffer
(save-buffer))
1769 (goto-char (point-min))
1770 (or (org-export-push-to-kill-ring "HTML")
1771 (message "Exporting... done"))
1772 (if (eq to-buffer
'string
)
1773 (prog1 (buffer-substring (point-min) (point-max))
1774 (kill-buffer (current-buffer)))
1775 (current-buffer)))))
1777 (defun org-export-html-insert-plist-item (plist key
&rest args
)
1778 (let ((item (plist-get plist key
)))
1779 (cond ((functionp item
)
1784 (defun org-export-html-format-href (s)
1785 "Make sure the S is valid as a href reference in an XHTML document."
1788 (while (string-match "&" s start
)
1789 (setq start
(+ (match-beginning 0) 3)
1790 s
(replace-match "&" t t s
)))))
1793 (defun org-export-html-format-desc (s)
1794 "Make sure the S is valid as a description in a link."
1795 (if (and s
(not (get-text-property 1 'org-protected s
)))
1797 (org-html-do-expand s
))
1800 (defun org-export-html-format-image (src par-open
)
1801 "Create image tag with source and attributes."
1803 (if (string-match "^ltxpng/" src
)
1804 (format "@<img src=\"%s\" alt=\"%s\"/>"
1805 src
(org-find-text-property-in-string 'org-latex-src src
))
1806 (let* ((caption (org-find-text-property-in-string 'org-caption src
))
1807 (attr (org-find-text-property-in-string 'org-attributes src
))
1808 (label (org-find-text-property-in-string 'org-label src
)))
1809 (setq caption
(and caption
(org-html-do-expand caption
)))
1812 (format "%s@<div %sclass=\"figure\">
1814 (if org-par-open
"@</p>\n" "")
1815 (if label
(format "id=\"%s\" " (org-solidify-link-text label
)) "")))
1816 (format "@<img src=\"%s\"%s />"
1818 (if (string-match "\\<alt=" (or attr
""))
1820 (concat " " attr
" alt=\"" src
"\"")))
1824 (concat "\n@<p>" caption
"@</p>")
1825 (if org-par-open
"\n@<p>" ""))))))))
1827 (defun org-export-html-get-bibliography ()
1828 "Find bibliography, cut it out and return it."
1830 (let (beg end
(cnt 1) bib
)
1832 (goto-char (point-min))
1833 (when (re-search-forward "^[ \t]*<div \\(id\\|class\\)=\"bibliography\"" nil t
)
1834 (setq beg
(match-beginning 0))
1835 (while (re-search-forward "</?div\\>" nil t
)
1836 (setq cnt
(+ cnt
(if (string= (match-string 0) "<div") +1 -
1)))
1838 (and (looking-at ">") (forward-char 1))
1839 (setq bib
(buffer-substring beg
(point)))
1840 (delete-region beg
(point))
1841 (throw 'exit bib
))))
1844 (defvar org-table-number-regexp
) ; defined in org-table.el
1845 (defun org-format-table-html (lines olines
&optional no-css
)
1846 "Find out which HTML converter to use and return the HTML code.
1847 NO-CSS is passed to the exporter."
1849 (setq lines
(org-split-string lines
"\n")))
1850 (if (string-match "^[ \t]*|" (car lines
))
1851 ;; A normal org table
1852 (org-format-org-table-html lines nil no-css
)
1853 ;; Table made by table.el - test for spanning
1854 (let* ((hlines (delq nil
(mapcar
1856 (if (string-match "^[ \t]*\\+-" x
) x
1859 (first (car hlines
))
1860 (ll (and (string-match "\\S-+" first
)
1861 (match-string 0 first
)))
1862 (re (concat "^[ \t]*" (regexp-quote ll
)))
1863 (spanning (delq nil
(mapcar (lambda (x) (not (string-match re x
)))
1865 (if (and (not spanning
)
1866 (not org-export-prefer-native-exporter-for-tables
))
1867 ;; We can use my own converter with HTML conversions
1868 (org-format-table-table-html lines
)
1869 ;; Need to use the code generator in table.el, with the original text.
1870 (org-format-table-table-html-using-table-generate-source olines
)))))
1872 (defvar org-table-number-fraction
) ; defined in org-table.el
1873 (defun org-format-org-table-html (lines &optional splice no-css
)
1874 "Format a table into HTML.
1875 LINES is a list of lines. Optional argument SPLICE means, do not
1876 insert header and surrounding <table> tags, just format the lines.
1877 Optional argument NO-CSS means use XHTML attributes instead of CSS
1878 for formatting. This is required for the DocBook exporter."
1879 (require 'org-table
)
1880 ;; Get rid of hlines at beginning and end
1881 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1882 (setq lines
(nreverse lines
))
1883 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1884 (setq lines
(nreverse lines
))
1885 (when org-export-table-remove-special-lines
1886 ;; Check if the table has a marking column. If yes remove the
1887 ;; column and the special lines
1888 (setq lines
(org-table-clean-before-export lines
)))
1890 (let* ((caption (org-find-text-property-in-string 'org-caption
(car lines
)))
1891 (label (org-find-text-property-in-string 'org-label
(car lines
)))
1892 (forced-aligns (org-find-text-property-in-string 'org-forced-aligns
1894 (attributes (org-find-text-property-in-string 'org-attributes
1896 (html-table-tag (org-export-splice-attributes
1897 html-table-tag attributes
))
1898 (head (and org-export-highlight-first-table-line
1900 (lambda (x) (string-match "^[ \t]*|-" x
))
1902 (nline 0) fnum nfields i
(cnt 0)
1903 tbopen line fields html gr colgropen rowstart rowend
1905 (setq caption
(and caption
(org-html-do-expand caption
)))
1906 (when (and forced-aligns org-table-clean-did-remove-column
)
1908 (mapcar (lambda (x) (cons (1- (car x
)) (cdr x
))) forced-aligns
)))
1909 (if splice
(setq head nil
))
1910 (unless splice
(push (if head
"<thead>" "<tbody>") html
))
1912 (while (setq line
(pop lines
))
1914 (if (string-match "^[ \t]*|-" line
)
1917 (push (if head
"</thead>" "</tbody>") html
)
1918 (if lines
(push "<tbody>" html
) (setq tbopen nil
)))
1919 (setq head nil
) ;; head ends here, first time around
1921 (throw 'next-line t
)))
1922 ;; Break the line into fields
1923 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
1924 (unless fnum
(setq fnum
(make-vector (length fields
) 0)
1925 nfields
(length fnum
)))
1926 (setq nline
(1+ nline
) i -
1
1927 rowstart
(eval (car org-export-table-row-tags
))
1928 rowend
(eval (cdr org-export-table-row-tags
)))
1929 (push (concat rowstart
1932 (setq i
(1+ i
) ali
(format "@@class%03d@@" i
))
1933 (if (and (< i nfields
) ; make sure no rogue line causes an error here
1934 (string-match org-table-number-regexp x
))
1935 (incf (aref fnum i
)))
1939 (format (car org-export-table-header-tags
)
1942 (cdr org-export-table-header-tags
)))
1943 ((and (= i
0) org-export-html-table-use-header-tags-for-first-column
)
1945 (format (car org-export-table-header-tags
)
1948 (cdr org-export-table-header-tags
)))
1950 (concat (format (car org-export-table-data-tags
) ali
)
1952 (cdr org-export-table-data-tags
)))))
1956 (unless splice
(if tbopen
(push "</tbody>" html
)))
1957 (unless splice
(push "</table>\n" html
))
1958 (setq html
(nreverse html
))
1960 ;; Put in col tags with the alignment (unfortunately often ignored...)
1961 (unless (car org-table-colgroup-info
)
1962 (setq org-table-colgroup-info
1963 (cons :start
(cdr org-table-colgroup-info
))))
1967 (setq gr
(pop org-table-colgroup-info
)
1969 align
(if (assoc i forced-aligns
)
1970 (cdr (assoc (cdr (assoc i forced-aligns
))
1971 '(("l" .
"left") ("r" .
"right")
1973 (if (> (/ (float x
) nline
)
1974 org-table-number-fraction
)
1978 "%s<col align=\"%s\" />%s"
1979 "%s<col class=\"%s\" />%s")
1980 (if (memq gr
'(:start
:startend
))
1983 "</colgroup>\n<colgroup>"
1988 (if (memq gr
'(:end
:startend
))
1989 (progn (setq colgropen nil
) "</colgroup>")
1993 (setq aligns
(nreverse aligns
))
1994 (if colgropen
(setq html
(cons (car html
)
1995 (cons "</colgroup>" (cdr html
)))))
1996 ;; Since the output of HTML table formatter can also be used in
1997 ;; DocBook document, we want to always include the caption to make
1998 ;; DocBook XML file valid.
1999 (push (format "<caption>%s</caption>" (or caption
"")) html
)
2001 (setq html-table-tag
(org-export-splice-attributes html-table-tag
(format "id=\"%s\"" (org-solidify-link-text label
)))))
2002 (push html-table-tag html
))
2005 (replace-regexp-in-string
2006 "@@class\\([0-9]+\\)@@"
2008 (if (not org-export-html-table-align-individual-fields
)
2010 (setq n
(string-to-number (match-string 1 txt
)))
2011 (format (if no-css
" align=\"%s\"" " class=\"%s\"")
2012 (or (nth n aligns
) "left"))))
2015 (concat (mapconcat 'identity html
"\n") "\n")))
2017 (defun org-export-splice-attributes (tag attributes
)
2018 "Read attributes in string ATTRIBUTES, add and replace in HTML tag TAG."
2019 (if (not attributes
)
2021 (let (oldatt newatt
)
2022 (setq oldatt
(org-extract-attributes-from-string tag
)
2024 newatt
(cdr (org-extract-attributes-from-string attributes
)))
2026 (setq oldatt
(plist-put oldatt
(pop newatt
) (pop newatt
))))
2027 (if (string-match ">" tag
)
2029 (replace-match (concat (org-attributes-to-string oldatt
) ">")
2033 (defun org-format-table-table-html (lines)
2034 "Format a table generated by table.el into HTML.
2035 This conversion does *not* use `table-generate-source' from table.el.
2036 This has the advantage that Org-mode's HTML conversions can be used.
2037 But it has the disadvantage, that no cell- or row-spanning is allowed."
2038 (let (line field-buffer
2039 (head org-export-highlight-first-table-line
)
2040 fields html empty i
)
2041 (setq html
(concat html-table-tag
"\n"))
2042 (while (setq line
(pop lines
))
2043 (setq empty
" ")
2045 (if (string-match "^[ \t]*\\+-" line
)
2056 (if (equal x
"") (setq x empty
))
2059 (format (car org-export-table-header-tags
) "col" "")
2061 (cdr org-export-table-header-tags
))
2062 (concat (format (car org-export-table-data-tags
) "") x
2063 (cdr org-export-table-data-tags
))))
2067 (setq field-buffer nil
)))
2069 (throw 'next-line t
)))
2070 ;; Break the line into fields and store the fields
2071 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
2073 (setq field-buffer
(mapcar
2075 (concat x
"<br/>" (pop fields
)))
2077 (setq field-buffer fields
))))
2078 (setq html
(concat html
"</table>\n"))
2081 (defun org-format-table-table-html-using-table-generate-source (lines)
2082 "Format a table into html, using `table-generate-source' from table.el.
2083 This has the advantage that cell- or row-spanning is allowed.
2084 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
2086 (with-current-buffer (get-buffer-create " org-tmp1 ")
2088 (insert (mapconcat 'identity lines
"\n"))
2089 (goto-char (point-min))
2090 (if (not (re-search-forward "|[^+]" nil t
))
2091 (error "Error processing table"))
2092 (table-recognize-table)
2093 (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
2094 (table-generate-source 'html
" org-tmp2 ")
2095 (set-buffer " org-tmp2 ")
2096 (buffer-substring (point-min) (point-max))))
2098 (defun org-export-splice-style (style extra
)
2099 "Splice EXTRA into STYLE, just before \"</style>\"."
2100 (if (and (stringp extra
)
2101 (string-match "\\S-" extra
)
2102 (string-match "</style>" style
))
2103 (concat (substring style
0 (match-beginning 0))
2105 (substring style
(match-beginning 0)))
2108 (defun org-html-handle-time-stamps (s)
2109 "Format time stamps in string S, or remove them."
2112 (while (string-match org-maybe-keyword-time-regexp s
)
2113 (or b
(setq b
(substring s
0 (match-beginning 0))))
2115 r
(substring s
0 (match-beginning 0))
2116 " @<span class=\"timestamp-wrapper\">"
2118 (format "@<span class=\"timestamp-kwd\">%s @</span>"
2119 (match-string 1 s
)))
2120 (format " @<span class=\"timestamp\">%s@</span>"
2122 (org-translate-time (match-string 3 s
)) 1 -
1))
2124 s
(substring s
(match-end 0))))
2125 ;; Line break if line started and ended with time stamp stuff
2128 (setq r
(concat r s
))
2129 (unless (string-match "\\S-" (concat b s
))
2130 (setq r
(concat r
"<br/>")))
2133 (defvar htmlize-buffer-places
) ; from htmlize.el
2134 (defun org-export-htmlize-region-for-paste (beg end
)
2135 "Convert the region to HTML, using htmlize.el.
2136 This is much like `htmlize-region-for-paste', only that it uses
2137 the settings define in the org-... variables."
2138 (let* ((htmlize-output-type org-export-htmlize-output-type
)
2139 (htmlize-css-name-prefix org-export-htmlize-css-font-prefix
)
2140 (htmlbuf (htmlize-region beg end
)))
2142 (with-current-buffer htmlbuf
2143 (buffer-substring (plist-get htmlize-buffer-places
'content-start
)
2144 (plist-get htmlize-buffer-places
'content-end
)))
2145 (kill-buffer htmlbuf
))))
2148 (defun org-export-htmlize-generate-css ()
2149 "Create the CSS for all font definitions in the current Emacs session.
2150 Use this to create face definitions in your CSS style file that can then
2151 be used by code snippets transformed by htmlize.
2152 This command just produces a buffer that contains class definitions for all
2153 faces used in the current Emacs session. You can copy and paste the ones you
2154 need into your CSS file.
2156 If you then set `org-export-htmlize-output-type' to `css', calls to
2157 the function `org-export-htmlize-region-for-paste' will produce code
2158 that uses these same face definitions."
2161 (and (get-buffer "*html*") (kill-buffer "*html*"))
2163 (let ((fl (face-list))
2164 (htmlize-css-name-prefix "org-")
2165 (htmlize-output-type 'css
)
2167 (while (setq f
(pop fl
)
2168 i
(and f
(face-attribute f
:inherit
)))
2169 (when (and (symbolp f
) (or (not i
) (not (listp i
))))
2170 (insert (org-add-props (copy-sequence "1") nil
'face f
))))
2171 (htmlize-region (point-min) (point-max))))
2172 (switch-to-buffer "*html*")
2173 (goto-char (point-min))
2174 (if (re-search-forward "<style" nil t
)
2175 (delete-region (point-min) (match-beginning 0)))
2176 (if (re-search-forward "</style>" nil t
)
2177 (delete-region (1+ (match-end 0)) (point-max)))
2178 (beginning-of-line 1)
2179 (if (looking-at " +") (replace-match ""))
2180 (goto-char (point-min)))
2182 (defun org-html-protect (s)
2183 "Convert characters to HTML equivalent.
2184 Possible conversions are set in `org-export-html-protect-char-alist'."
2185 (let ((cl org-export-html-protect-char-alist
) c
)
2186 (while (setq c
(pop cl
))
2188 (while (string-match (car c
) s start
)
2189 (setq s
(replace-match (cdr c
) t t s
)
2190 start
(1+ (match-beginning 0))))))
2193 (defun org-html-expand (string)
2194 "Prepare STRING for HTML export. Apply all active conversions.
2195 If there are links in the string, don't modify these."
2196 (let* ((re (concat org-bracket-link-regexp
"\\|"
2197 (org-re "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")))
2199 (if (string-match "^[ \t]*\\+-[-+]*\\+[ \t]*$" string
)
2201 (while (setq m
(string-match re string
))
2202 (setq s
(substring string
0 m
)
2203 l
(match-string 0 string
)
2204 string
(substring string
(match-end 0)))
2205 (push (org-html-do-expand s
) res
)
2207 (push (org-html-do-expand string
) res
)
2208 (apply 'concat
(nreverse res
)))))
2210 (defun org-html-do-expand (s)
2211 "Apply all active conversions to translate special ASCII to HTML."
2212 (setq s
(org-html-protect s
))
2213 (if org-export-html-expand
2214 (while (string-match "@<\\([^&]*\\)>" s
)
2215 (setq s
(replace-match "<\\1>" t nil s
))))
2216 (if org-export-with-emphasize
2217 (setq s
(org-export-html-convert-emphasize s
)))
2218 (if org-export-with-special-strings
2219 (setq s
(org-export-html-convert-special-strings s
)))
2220 (if org-export-with-sub-superscripts
2221 (setq s
(org-export-html-convert-sub-super s
)))
2222 (if org-export-with-TeX-macros
2223 (let ((start 0) wd rep
)
2224 (while (setq start
(string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
2226 (if (get-text-property (match-beginning 0) 'org-protected s
)
2227 (setq start
(match-end 0))
2228 (setq wd
(match-string 1 s
))
2229 (if (setq rep
(org-entity-get-representation wd
'html
))
2230 (setq s
(replace-match rep t t s
))
2231 (setq start
(+ start
(length wd
))))))))
2234 (defun org-export-html-convert-special-strings (string)
2235 "Convert special characters in STRING to HTML."
2236 (let ((all org-export-html-special-string-regexps
)
2238 (while (setq a
(pop all
))
2239 (setq re
(car a
) rpl
(cdr a
) start
0)
2240 (while (string-match re string start
)
2241 (if (get-text-property (match-beginning 0) 'org-protected string
)
2242 (setq start
(match-end 0))
2243 (setq string
(replace-match rpl t nil string
)))))
2246 (defun org-export-html-convert-sub-super (string)
2247 "Convert sub- and superscripts in STRING to HTML."
2248 (let (key c
(s 0) (requireb (eq org-export-with-sub-superscripts
'{})))
2249 (while (string-match org-match-substring-regexp string s
)
2251 ((and requireb
(match-end 8)) (setq s
(match-end 2)))
2252 ((get-text-property (match-beginning 2) 'org-protected string
)
2253 (setq s
(match-end 2)))
2255 (setq s
(match-end 1)
2256 key
(if (string= (match-string 2 string
) "_") "sub" "sup")
2257 c
(or (match-string 8 string
)
2258 (match-string 6 string
)
2259 (match-string 5 string
))
2260 string
(replace-match
2261 (concat (match-string 1 string
)
2262 "<" key
">" c
"</" key
">")
2264 (while (string-match "\\\\\\([_^]\\)" string
)
2265 (setq string
(replace-match (match-string 1 string
) t t string
)))
2268 (defun org-export-html-convert-emphasize (string)
2271 (while (string-match org-emph-re string s
)
2273 (substring string
(match-beginning 3) (1+ (match-beginning 3)))
2274 (substring string
(match-beginning 4) (1+ (match-beginning 4)))))
2275 (setq s
(match-beginning 0)
2278 (match-string 1 string
)
2279 (nth 2 (assoc (match-string 3 string
) org-emphasis-alist
))
2280 (match-string 4 string
)
2281 (nth 3 (assoc (match-string 3 string
)
2282 org-emphasis-alist
))
2283 (match-string 5 string
))
2284 string
(replace-match rpl t t string
)
2285 s
(+ s
(- (length rpl
) 2)))
2289 (defun org-open-par ()
2290 "Insert <p>, but first close previous paragraph if any."
2291 (org-close-par-maybe)
2293 (setq org-par-open t
))
2294 (defun org-close-par-maybe ()
2295 "Close paragraph if there is one open."
2298 (setq org-par-open nil
)))
2299 (defun org-close-li (&optional type
)
2300 "Close <li> if necessary."
2301 (org-close-par-maybe)
2302 (insert (if (equal type
"d") "</dd>\n" "</li>\n")))
2304 (defvar body-only
) ; dynamically scoped into this.
2305 (defun org-html-level-start (level title umax with-toc head-count
)
2306 "Insert a new level in HTML export.
2307 When TITLE is nil, just close all open levels."
2308 (org-close-par-maybe)
2309 (let* ((target (and title
(org-get-text-property-any 0 'target title
)))
2310 (extra-targets (and target
2311 (assoc target org-export-target-aliases
)))
2312 (extra-class (and title
(org-get-text-property-any 0 'html-container-class title
)))
2313 (preferred (and target
2314 (cdr (assoc target org-export-preferred-target-alist
))))
2316 snumber snu href suffix
)
2317 (setq extra-targets
(remove (or preferred target
) extra-targets
))
2319 (mapconcat (lambda (x)
2320 (setq x
(org-solidify-link-text
2321 (if (org-uuidgen-p x
) (concat "ID-" x
) x
)))
2322 (format "<a name=\"%s\" id=\"%s\"></a>"
2327 (if (aref org-levels-open
(1- l
))
2329 (org-html-level-close l umax
)
2330 (aset org-levels-open
(1- l
) nil
)))
2333 ;; If title is nil, this means this function is called to close
2334 ;; all levels, so the rest is done only if title is given
2335 (when (string-match (org-re "\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") title
)
2336 (setq title
(replace-match
2337 (if org-export-with-tags
2340 " <span class=\"tag\">"
2343 (format "<span class=\"%s\">%s</span>"
2344 (org-export-html-get-tag-class-name x
)
2346 (org-split-string (match-string 1 title
) ":")
2353 (if (aref org-levels-open
(1- level
))
2357 (insert (format "<li id=\"%s\">" (org-solidify-link-text (or preferred target
)))
2358 extra-targets title
"<br/>\n")
2359 (insert "<li>" title
"<br/>\n")))
2360 (aset org-levels-open
(1- level
) t
)
2361 (org-close-par-maybe)
2363 (insert (format "<ul>\n<li id=\"%s\">" (org-solidify-link-text (or preferred target
)))
2364 extra-targets title
"<br/>\n")
2365 (insert "<ul>\n<li>" title
"<br/>\n"))))
2366 (aset org-levels-open
(1- level
) t
)
2367 (setq snumber
(org-section-number level
)
2368 snu
(replace-regexp-in-string "\\." "_" snumber
))
2369 (setq level
(+ level org-export-html-toplevel-hlevel -
1))
2370 (if (and org-export-with-section-numbers
(not body-only
))
2372 (format "<span class=\"section-number-%d\">%s</span>"
2375 (unless (= head-count
1) (insert "\n</div>\n"))
2376 (setq href
(cdr (assoc (concat "sec-" snu
) org-export-preferred-target-alist
)))
2377 (setq suffix
(org-solidify-link-text (or href snu
)))
2378 (setq href
(org-solidify-link-text (or href
(concat "sec-" snu
))))
2379 (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"
2380 suffix level
(if extra-class
(concat " " extra-class
) "")
2383 title level level suffix
))
2386 (defun org-export-html-get-tag-class-name (tag)
2387 "Turn tag into a valid class name.
2388 Replaces invalid characters with \"_\" and then prepends a prefix."
2390 (while (string-match "[^a-zA-Z0-9_]" tag
)
2391 (setq tag
(replace-match "_" t t tag
))))
2392 (concat org-export-html-tag-class-prefix tag
))
2394 (defun org-export-html-get-todo-kwd-class-name (kwd)
2395 "Turn todo keyword into a valid class name.
2396 Replaces invalid characters with \"_\" and then prepends a prefix."
2398 (while (string-match "[^a-zA-Z0-9_]" kwd
)
2399 (setq kwd
(replace-match "_" t t kwd
))))
2400 (concat org-export-html-todo-kwd-class-prefix kwd
))
2402 (defun org-html-level-close (level max-outline-level
)
2403 "Terminate one level in HTML export."
2404 (if (<= level max-outline-level
)
2407 (insert "</ul>\n")))
2409 (defun org-html-export-list-line (line pos struct prevs
)
2410 "Insert list syntax in export buffer. Return LINE, maybe modified.
2412 POS is the item position or line position the line had before
2413 modifications to buffer. STRUCT is the list structure. PREVS is
2414 the alist of previous items."
2417 ;; Translate type of list containing POS to "d", "o" or
2419 (lambda (pos struct prevs
)
2420 (let ((type (org-list-get-list-type pos struct prevs
)))
2422 ((eq 'ordered type
) "o")
2423 ((eq 'descriptive type
) "d")
2427 ;; Return list of all items and sublists ending at POS, in
2433 (let ((end (nth 6 e
))
2436 ((= end pos
) (push item out
))
2437 ((>= item pos
) (throw 'exit nil
)))))
2440 ;; First close any previous item, or list, ending at POS.
2442 (let* ((lastp (= (org-list-get-last-item e struct prevs
) e
))
2443 (first-item (org-list-get-list-begin e struct prevs
))
2444 (type (funcall get-type first-item struct prevs
)))
2445 (org-close-par-maybe)
2446 ;; Ending for every item
2448 ;; We're ending last item of the list: end list.
2449 (when lastp
(insert (format "</%sl>\n" type
)))))
2450 (funcall get-closings pos
))
2452 ;; At an item: insert appropriate tags in export buffer.
2455 (concat "[ \t]*\\(\\S-+[ \t]+\\)"
2456 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\]\\)?"
2457 "\\(?:\\(\\[[ X-]\\]\\)[ \t]+\\)?"
2458 "\\(?:\\(.*\\)[ \t]+::[ \t]+\\)?"
2460 (let* ((checkbox (match-string 3 line
))
2461 (desc-tag (or (match-string 4 line
) "???"))
2462 (body (or (match-string 5 line
) ""))
2463 (list-beg (org-list-get-list-begin pos struct prevs
))
2464 (firstp (= list-beg pos
))
2465 ;; Always refer to first item to determine list type, in
2466 ;; case list is ill-formed.
2467 (type (funcall get-type list-beg struct prevs
))
2468 (counter (let ((count-tmp (org-list-get-counter pos struct
)))
2470 ((not count-tmp
) nil
)
2471 ((string-match "[A-Za-z]" count-tmp
)
2472 (- (string-to-char (upcase count-tmp
)) 64))
2473 ((string-match "[0-9]+" count-tmp
)
2476 (org-close-par-maybe)
2477 (insert (format "<%sl>\n" type
)))
2480 (format "<dt>%s</dt><dd>" desc-tag
))
2481 ((and (equal type
"o") counter
)
2482 (format "<li value=\"%s\">" counter
))
2484 ;; If line had a checkbox, some additional modification is required.
2489 ((string-match "X" checkbox
) "<code>[X]</code> ")
2490 ((string-match " " checkbox
) "<code>[ ]</code> ")
2491 (t "<code>[-]</code> "))
2493 ;; Return modified line
2495 ;; At a list ender: go to next line (side-effects only).
2496 ((equal "ORG-LIST-END-MARKER" line
) (throw 'nextline nil
))
2497 ;; Not at an item: return line unchanged (side-effects only).
2502 ;; arch-tag: 8109d84d-eb8f-460b-b1a8-f45f3a6c7ea1
2503 ;;; org-html.el ends here