1 ;;; org-html.el --- HTML export for Org-mode
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
30 (require 'format-spec
)
32 (eval-when-compile (require 'cl
))
34 (declare-function org-id-find-id-file
"org-id" (id))
35 (declare-function htmlize-region
"ext:htmlize" (beg end
))
36 (declare-function org-pop-to-buffer-same-window
37 "org-compat" (&optional buffer-or-name norecord label
))
39 (defgroup org-export-html nil
40 "Options specific for HTML export of Org-mode files."
41 :tag
"Org Export HTML"
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
64 (defcustom org-export-html-footnote-separator
"<sup>, </sup>"
65 "Text used to separate footnotes."
66 :group
'org-export-html
69 (defcustom org-export-html-coding-system nil
70 "Coding system for HTML export, defaults to `buffer-file-coding-system'."
71 :group
'org-export-html
74 (defcustom org-export-html-extension
"html"
75 "The extension for exported HTML files."
76 :group
'org-export-html
79 (defcustom org-export-html-xml-declaration
80 '(("html" .
"<?xml version=\"1.0\" encoding=\"%s\"?>")
81 ("php" .
"<?php echo \"<?xml version=\\\"1.0\\\" encoding=\\\"%s\\\" ?>\"; ?>"))
82 "The extension for exported HTML files.
83 %s will be replaced with the charset of the exported file.
84 This may be a string, or an alist with export extensions
85 and corresponding declarations."
86 :group
'org-export-html
88 (string :tag
"Single declaration")
89 (repeat :tag
"Dependent on extension"
90 (cons (string :tag
"Extension")
91 (string :tag
"Declaration")))))
93 (defcustom org-export-html-style-include-scripts t
94 "Non-nil means include the JavaScript snippets in exported HTML files.
95 The actual script is defined in `org-export-html-scripts' and should
97 :group
'org-export-html
100 (defconst org-export-html-scripts
101 "<script type=\"text/javascript\">
102 <!--/*--><![CDATA[/*><!--*/
103 function CodeHighlightOn(elem, id)
105 var target = document.getElementById(id);
107 elem.cacheClassElem = elem.className;
108 elem.cacheClassTarget = target.className;
109 target.className = \"code-highlighted\";
110 elem.className = \"code-highlighted\";
113 function CodeHighlightOff(elem, id)
115 var target = document.getElementById(id);
116 if(elem.cacheClassElem)
117 elem.className = elem.cacheClassElem;
118 if(elem.cacheClassTarget)
119 target.className = elem.cacheClassTarget;
123 "Basic JavaScript that is needed by HTML files produced by Org-mode.")
125 (defconst org-export-html-style-default
126 "<style type=\"text/css\">
127 <!--/*--><![CDATA[/*><!--*/
128 html { font-family: Times, serif; font-size: 12pt; }
129 .title { text-align: center; }
130 .todo { color: red; }
131 .done { color: green; }
132 .tag { background-color: #add8e6; font-weight:normal }
134 .timestamp { color: #bebebe; }
135 .timestamp-kwd { color: #5f9ea0; }
136 .right {margin-left:auto; margin-right:0px; text-align:right;}
137 .left {margin-left:0px; margin-right:auto; text-align:left;}
138 .center {margin-left:auto; margin-right:auto; text-align:center;}
139 p.verse { margin-left: 3% }
141 border: 1pt solid #AEBDCC;
142 background-color: #F3F5F7;
144 font-family: courier, monospace;
148 table { border-collapse: collapse; }
149 td, th { vertical-align: top; }
150 th.right { text-align:center; }
151 th.left { text-align:center; }
152 th.center { text-align:center; }
153 td.right { text-align:right; }
154 td.left { text-align:left; }
155 td.center { text-align:center; }
156 dt { font-weight: bold; }
157 div.figure { padding: 0.5em; }
158 div.figure p { text-align: center; }
161 border:2px solid gray;
165 textarea { overflow-x: auto; }
166 .linenr { font-size:smaller }
167 .code-highlighted {background-color:#ffff00;}
168 .org-info-js_info-navigation { border-style:none; }
169 #org-info-js_console-label { font-size:10px; font-weight:bold;
170 white-space:nowrap; }
171 .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
175 "The default style specification for exported HTML files.
176 Please use the variables `org-export-html-style' and
177 `org-export-html-style-extra' to add to this style. If you wish to not
178 have the default style included, customize the variable
179 `org-export-html-style-include-default'.")
181 (defcustom org-export-html-style-include-default t
182 "Non-nil means include the default style in exported HTML files.
183 The actual style is defined in `org-export-html-style-default' and should
184 not be modified. Use the variables `org-export-html-style' to add
185 your own style information."
186 :group
'org-export-html
189 (put 'org-export-html-style-include-default
'safe-local-variable
'booleanp
)
191 (defcustom org-export-html-style
""
192 "Org-wide style definitions for exported HTML files.
194 This variable needs to contain the full HTML structure to provide a style,
195 including the surrounding HTML tags. If you set the value of this variable,
196 you should consider to include definitions for the following classes:
197 title, todo, done, timestamp, timestamp-kwd, tag, target.
199 For example, a valid value would be:
201 <style type=\"text/css\">
203 p { font-weight: normal; color: gray; }
205 .title { text-align: center; }
206 .todo, .timestamp-kwd { color: red; }
207 .done { color: green; }
211 If you'd like to refer to an external style file, use something like
213 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
215 As the value of this option simply gets inserted into the HTML <head> header,
216 you can \"misuse\" it to add arbitrary text to the header.
217 See also the variable `org-export-html-style-extra'."
218 :group
'org-export-html
221 (put 'org-export-html-style
'safe-local-variable
'stringp
)
223 (defcustom org-export-html-style-extra
""
224 "Additional style information for HTML export.
225 The value of this variable is inserted into the HTML buffer right after
226 the value of `org-export-html-style'. Use this variable for per-file
227 settings of style information, and do not forget to surround the style
228 settings with <style>...</style> tags."
229 :group
'org-export-html
232 (put 'org-export-html-style-extra
'safe-local-variable
'stringp
)
234 (defcustom org-export-html-mathjax-options
235 '((path "http://orgmode.org/mathjax/MathJax.js")
240 "Options for MathJax setup.
242 path The path where to find MathJax
243 scale Scaling for the HTML-CSS backend, usually between 100 and 133
244 align How to align display math: left, center, or right
245 indent If align is not center, how far from the left/right side?
246 mathml Should a MathML player be used if available?
247 This is faster and reduces bandwidth use, but currently
248 sometimes has lower spacing quality. Therefore, the default is
249 nil. When browsers get better, this switch can be flipped.
251 You can also customize this for each buffer, using something like
253 #+MATHJAX: scale:\"133\" align:\"right\" mathml:t path:\"/MathJax/\""
254 :group
'org-export-html
255 :type
'(list :greedy t
256 (list :tag
"path (the path from where to load MathJax.js)"
257 (const :format
" " path
) (string))
258 (list :tag
"scale (scaling for the displayed math)"
259 (const :format
" " scale
) (string))
260 (list :tag
"align (alignment of displayed equations)"
261 (const :format
" " align
) (string))
262 (list :tag
"indent (indentation with left or right alignment)"
263 (const :format
" " indent
) (string))
264 (list :tag
"mathml (should MathML display be used is possible)"
265 (const :format
" " mathml
) (boolean))))
267 (defun org-export-html-mathjax-config (template options in-buffer
)
268 "Insert the user setup into the matchjax template."
269 (let (name val
(yes " ") (no "// ") x
)
272 (setq name
(car e
) val
(nth 1 e
))
273 (if (string-match (concat "\\<" (symbol-name name
) ":") in-buffer
)
274 (setq val
(car (read-from-string
275 (substring in-buffer
(match-end 0))))))
276 (if (not (stringp val
)) (setq val
(format "%s" val
)))
277 (if (string-match (concat "%" (upcase (symbol-name name
))) template
)
278 (setq template
(replace-match val t t template
))))
280 (setq val
(nth 1 (assq 'mathml options
)))
281 (if (string-match (concat "\\<mathml:") in-buffer
)
282 (setq val
(car (read-from-string
283 (substring in-buffer
(match-end 0))))))
284 ;; Exchange prefixes depending on mathml setting
285 (if (not val
) (setq x yes yes no no x
))
286 ;; Replace cookies to turn on or off the config/jax lines
287 (if (string-match ":MMLYES:" template
)
288 (setq template
(replace-match yes t t template
)))
289 (if (string-match ":MMLNO:" template
)
290 (setq template
(replace-match no t t template
)))
291 ;; Return the modified template
294 (defcustom org-export-html-mathjax-template
295 "<script type=\"text/javascript\" src=\"%PATH\">
296 <!--/*--><![CDATA[/*><!--*/
298 // Only one of the two following lines, depending on user settings
299 // First allows browser-native MathML display, second forces HTML/CSS
300 :MMLYES: config: [\"MMLorHTML.js\"], jax: [\"input/TeX\"],
301 :MMLNO: jax: [\"input/TeX\", \"output/HTML-CSS\"],
302 extensions: [\"tex2jax.js\",\"TeX/AMSmath.js\",\"TeX/AMSsymbols.js\",
303 \"TeX/noUndefined.js\"],
305 inlineMath: [ [\"\\\\(\",\"\\\\)\"] ],
306 displayMath: [ ['$$','$$'], [\"\\\\[\",\"\\\\]\"], [\"\\\\begin{displaymath}\",\"\\\\end{displaymath}\"] ],
307 skipTags: [\"script\",\"noscript\",\"style\",\"textarea\",\"pre\",\"code\"],
308 ignoreClass: \"tex2jax_ignore\",
309 processEscapes: false,
310 processEnvironments: true,
313 showProcessingMessages: true,
314 displayAlign: \"%ALIGN\",
315 displayIndent: \"%INDENT\",
319 availableFonts: [\"STIX\",\"TeX\"],
320 preferredFont: \"TeX\",
336 "The MathJax setup for XHTML files."
337 :group
'org-export-html
340 (defcustom org-export-html-tag-class-prefix
""
341 "Prefix to class names for TODO keywords.
342 Each tag gets a class given by the tag itself, with this prefix.
343 The default prefix is empty because it is nice to just use the keyword
344 as a class name. But if you get into conflicts with other, existing
345 CSS classes, then this prefix can be very useful."
346 :group
'org-export-html
349 (defcustom org-export-html-todo-kwd-class-prefix
""
350 "Prefix to class names for TODO keywords.
351 Each TODO keyword gets a class given by the keyword itself, with this prefix.
352 The default prefix is empty because it is nice to just use the keyword
353 as a class name. But if you get into conflicts with other, existing
354 CSS classes, then this prefix can be very useful."
355 :group
'org-export-html
358 (defcustom org-export-html-preamble t
359 "Non-nil means insert a preamble in HTML export.
361 When `t', insert a string as defined by one of the formatting
362 strings in `org-export-html-preamble-format'. When set to a
363 string, this string overrides `org-export-html-preamble-format'.
364 When set to a function, apply this function and insert the
365 returned string. The function takes the property list of export
366 options as its only argument.
368 Setting :html-preamble in publishing projects will take
369 precedence over this variable."
370 :group
'org-export-html
371 :type
'(choice (const :tag
"No preamble" nil
)
372 (const :tag
"Default preamble" t
)
373 (string :tag
"Custom formatting string")
374 (function :tag
"Function (must return a string)")))
376 (defcustom org-export-html-preamble-format
'(("en" ""))
377 "The format for the HTML preamble.
379 %t stands for the title.
380 %a stands for the author's name.
381 %e stands for the author's email.
382 %d stands for the date.
384 If you need to use a \"%\" character, you need to escape it
386 :group
'org-export-html
389 (defcustom org-export-html-postamble
'auto
390 "Non-nil means insert a postamble in HTML export.
392 When `t', insert a string as defined by the formatting string in
393 `org-export-html-postamble-format'. When set to a string, this
394 string overrides `org-export-html-postamble-format'. When set to
395 'auto, discard `org-export-html-postamble-format' and honor
396 `org-export-author/email/creator-info' variables. When set to a
397 function, apply this function and insert the returned string.
398 The function takes the property list of export options as its
401 Setting :html-postamble in publishing projects will take
402 precedence over this variable."
403 :group
'org-export-html
404 :type
'(choice (const :tag
"No postamble" nil
)
405 (const :tag
"Auto preamble" 'auto
)
406 (const :tag
"Default formatting string" t
)
407 (string :tag
"Custom formatting string")
408 (function :tag
"Function (must return a string)")))
410 (defcustom org-export-html-postamble-format
411 '(("en" "<p class=\"author\">Author: %a (%e)</p>
412 <p class=\"date\">Date: %d</p>
413 <p class=\"creator\">Generated by %c</p>
414 <p class=\"xhtml-validation\">%v</p>
416 "The format for the HTML postamble.
418 %a stands for the author's name.
419 %e stands for the author's email.
420 %d stands for the date.
421 %c will be replaced by information about Org/Emacs versions.
422 %v will be replaced by `org-export-html-validation-link'.
424 If you need to use a \"%\" character, you need to escape it
426 :group
'org-export-html
429 (defcustom org-export-html-home
/up-format
430 "<div id=\"org-div-home-and-up\" style=\"text-align:right;font-size:70%%;white-space:nowrap;\">
431 <a accesskey=\"h\" href=\"%s\"> UP </a>
433 <a accesskey=\"H\" href=\"%s\"> HOME </a>
435 "Snippet used to insert the HOME and UP links.
436 This is a format string, the first %s will receive the UP link,
437 the second the HOME link. If both `org-export-html-link-up' and
438 `org-export-html-link-home' are empty, the entire snippet will be
440 :group
'org-export-html
443 (defcustom org-export-html-toplevel-hlevel
2
444 "The <H> level for level 1 headings in HTML export.
445 This is also important for the classes that will be wrapped around headlines
446 and outline structure. If this variable is 1, the top-level headlines will
447 be <h1>, and the corresponding classes will be outline-1, section-number-1,
448 and outline-text-1. If this is 2, all of these will get a 2 instead.
449 The default for this variable is 2, because we use <h1> for formatting the
451 :group
'org-export-html
454 (defcustom org-export-html-link-org-files-as-html t
455 "Non-nil means make file links to `file.org' point to `file.html'.
456 When org-mode is exporting an org-mode file to HTML, links to
457 non-html files are directly put into a href tag in HTML.
458 However, links to other Org-mode files (recognized by the
459 extension `.org.) should become links to the corresponding html
460 file, assuming that the linked org-mode file will also be
462 When nil, the links still point to the plain `.org' file."
463 :group
'org-export-html
466 (defcustom org-export-html-inline-images
'maybe
467 "Non-nil means inline images into exported HTML pages.
468 This is done using an <img> tag. When nil, an anchor with href is used to
469 link to the image. If this option is `maybe', then images in links with
470 an empty description will be inlined, while images with a description will
472 :group
'org-export-html
473 :type
'(choice (const :tag
"Never" nil
)
474 (const :tag
"Always" t
)
475 (const :tag
"When there is no description" maybe
)))
477 (defcustom org-export-html-inline-image-extensions
478 '("png" "jpeg" "jpg" "gif" "svg")
479 "Extensions of image files that can be inlined into HTML."
480 :group
'org-export-html
481 :type
'(repeat (string :tag
"Extension")))
483 (defcustom org-export-html-table-tag
484 "<table border=\"2\" cellspacing=\"0\" cellpadding=\"6\" rules=\"groups\" frame=\"hsides\">"
485 "The HTML tag that is used to start a table.
486 This must be a <table> tag, but you may change the options like
487 borders and spacing."
488 :group
'org-export-html
491 (defcustom org-export-table-header-tags
'("<th scope=\"%s\"%s>" .
"</th>")
492 "The opening tag for table header fields.
493 This is customizable so that alignment options can be specified.
494 The first %s will be filled with the scope of the field, either row or col.
495 The second %s will be replaced by a style entry to align the field.
496 See also the variable `org-export-html-table-use-header-tags-for-first-column'.
497 See also the variable `org-export-html-table-align-individual-fields'."
498 :group
'org-export-tables
499 :type
'(cons (string :tag
"Opening tag") (string :tag
"Closing tag")))
501 (defcustom org-export-table-data-tags
'("<td%s>" .
"</td>")
502 "The opening tag for table data fields.
503 This is customizable so that alignment options can be specified.
504 The first %s will be filled with the scope of the field, either row or col.
505 The second %s will be replaced by a style entry to align the field.
506 See also the variable `org-export-html-table-align-individual-fields'."
507 :group
'org-export-tables
508 :type
'(cons (string :tag
"Opening tag") (string :tag
"Closing tag")))
510 (defcustom org-export-table-row-tags
'("<tr>" .
"</tr>")
511 "The opening tag for table data fields.
512 This is customizable so that alignment options can be specified.
513 Instead of strings, these can be Lisp forms that will be evaluated
514 for each row in order to construct the table row tags. During evaluation,
515 the variable `head' will be true when this is a header line, nil when this
516 is a body line. And the variable `nline' will contain the line number,
517 starting from 1 in the first header line. For example
519 (setq org-export-table-row-tags
522 (if (= (mod nline 2) 1)
523 \"<tr class=\\\"tr-odd\\\">\"
524 \"<tr class=\\\"tr-even\\\">\"))
527 will give even lines the class \"tr-even\" and odd lines the class \"tr-odd\"."
528 :group
'org-export-tables
530 (choice :tag
"Opening tag"
531 (string :tag
"Specify")
533 (choice :tag
"Closing tag"
534 (string :tag
"Specify")
537 (defcustom org-export-html-table-align-individual-fields t
538 "Non-nil means attach style attributes for alignment to each table field.
539 When nil, alignment will only be specified in the column tags, but this
540 is ignored by some browsers (like Firefox, Safari). Opera does it right
542 :group
'org-export-tables
545 (defcustom org-export-html-table-use-header-tags-for-first-column nil
546 "Non-nil means format column one in tables with header tags.
547 When nil, also column one will use data tags."
548 :group
'org-export-tables
551 (defcustom org-export-html-validation-link
552 "<a href=\"http://validator.w3.org/check?uri=referer\">Validate XHTML 1.0</a>"
553 "Link to HTML validation service."
554 :group
'org-export-html
557 ;; FIXME Obsolete since Org 7.7
558 ;; Use the :timestamp option or `org-export-time-stamp-file' instead
559 (defvar org-export-html-with-timestamp nil
560 "If non-nil, write container for HTML-helper-mode timestamp.")
562 ;; FIXME Obsolete since Org 7.7
563 (defvar org-export-html-html-helper-timestamp
564 "\n<p><br/><br/>\n<!-- hhmts start --> <!-- hhmts end --></p>\n"
565 "The HTML tag used as timestamp delimiter for HTML-helper-mode.")
567 (defcustom org-export-html-protect-char-alist
571 "Alist of characters to be converted by `org-html-protect'."
572 :group
'org-export-html
573 :type
'(repeat (cons (string :tag
"Character")
574 (string :tag
"HTML equivalent"))))
576 (defgroup org-export-htmlize nil
577 "Options for processing examples with htmlize.el."
578 :tag
"Org Export Htmlize"
579 :group
'org-export-html
)
581 (defcustom org-export-htmlize-output-type
'inline-css
582 "Output type to be used by htmlize when formatting code snippets.
583 Choices are `css', to export the CSS selectors only, or `inline-css', to
584 export the CSS attribute values inline in the HTML. We use as default
585 `inline-css', in order to make the resulting HTML self-containing.
587 However, this will fail when using Emacs in batch mode for export, because
588 then no rich font definitions are in place. It will also not be good if
589 people with different Emacs setup contribute HTML files to a website,
590 because the fonts will represent the individual setups. In these cases,
591 it is much better to let Org/Htmlize assign classes only, and to use
592 a style file to define the look of these classes.
593 To get a start for your css file, start Emacs session and make sure that
594 all the faces you are interested in are defined, for example by loading files
595 in all modes you want. Then, use the command
596 \\[org-export-htmlize-generate-css] to extract class definitions."
597 :group
'org-export-htmlize
598 :type
'(choice (const css
) (const inline-css
)))
600 (defcustom org-export-htmlize-css-font-prefix
"org-"
601 "The prefix for CSS class names for htmlize font specifications."
602 :group
'org-export-htmlize
605 (defcustom org-export-htmlized-org-css-url nil
606 "URL pointing to a CSS file defining text colors for htmlized Emacs buffers.
607 Normally when creating an htmlized version of an Org buffer, htmlize will
608 create CSS to define the font colors. However, this does not work when
609 converting in batch mode, and it also can look bad if different people
610 with different fontification setup work on the same website.
611 When this variable is non-nil, creating an htmlized version of an Org buffer
612 using `org-export-as-org' will remove the internal CSS section and replace it
613 with a link to this URL."
614 :group
'org-export-htmlize
616 (const :tag
"Keep internal css" nil
)
617 (string :tag
"URL or local href")))
619 ;; FIXME: The following variable is obsolete since Org 7.7 but is
620 ;; still declared and checked within code for compatibility reasons.
621 ;; Use the custom variables `org-export-html-divs' instead.
622 (defvar org-export-html-content-div
"content"
623 "The name of the container DIV that holds all the page contents.
625 This variable is obsolete since Org version 7.7.
626 Please set `org-export-html-divs' instead.")
628 (defcustom org-export-html-divs
'("preamble" "content" "postamble")
629 "The name of the main divs for HTML export."
630 :group
'org-export-html
632 (string :tag
" Div for the preamble:")
633 (string :tag
" Div for the content:")
634 (string :tag
"Div for the postamble:")))
638 (defvar org-export-html-after-blockquotes-hook nil
639 "Hook run during HTML export, after blockquote, verse, center are done.")
641 (defvar org-export-html-final-hook nil
642 "Hook run at the end of HTML export, in the new buffer.")
646 (defun org-export-html-preprocess (parameters)
647 "Convert LaTeX fragments to images."
648 (when (and org-current-export-file
649 (plist-get parameters
:LaTeX-fragments
))
651 (concat "ltxpng/" (file-name-sans-extension
652 (file-name-nondirectory
653 org-current-export-file
)))
654 org-current-export-dir nil
"Creating LaTeX image %s"
657 ((eq (plist-get parameters
:LaTeX-fragments
) 'verbatim
) 'verbatim
)
658 ((eq (plist-get parameters
:LaTeX-fragments
) 'mathjax
) 'mathjax
)
659 ((eq (plist-get parameters
:LaTeX-fragments
) t
) 'mathjax
)
660 ((eq (plist-get parameters
:LaTeX-fragments
) 'dvipng
) 'dvipng
)
662 (goto-char (point-min))
664 (while (re-search-forward "\\\\ref{\\([^{}\n]+\\)}" nil t
)
665 (org-if-unprotected-at (match-beginning 1)
666 (setq label
(match-string 1))
668 (if (string-match "\\`[a-z]\\{1,10\\}:\\(.+\\)" label
)
669 (setq l1
(substring label
(match-beginning 1)))
671 (replace-match (format "[[#%s][%s]]" label l1
) t t
)))))
674 (defun org-export-as-html-and-open (arg)
675 "Export the outline as HTML and immediately open it with a browser.
676 If there is an active region, export only the region.
677 The prefix ARG specifies how many levels of the outline should become
678 headlines. The default is 3. Lower levels will become bulleted lists."
680 (org-export-as-html arg
'hidden
)
681 (org-open-file buffer-file-name
)
682 (when org-export-kill-product-buffer-when-displayed
683 (kill-buffer (current-buffer))))
686 (defun org-export-as-html-batch ()
687 "Call the function `org-export-as-html'.
688 This function can be used in batch processing as:
690 --load=$HOME/lib/emacs/org.el
691 --eval \"(setq org-export-headline-levels 2)\"
692 --visit=MyFile --funcall org-export-as-html-batch"
693 (org-export-as-html org-export-headline-levels
'hidden
))
696 (defun org-export-as-html-to-buffer (arg)
697 "Call `org-export-as-html` with output to a temporary buffer.
698 No file is created. The prefix ARG is passed through to `org-export-as-html'."
700 (org-export-as-html arg nil nil
"*Org HTML Export*")
701 (when org-export-show-temporary-export-buffer
702 (switch-to-buffer-other-window "*Org HTML Export*")))
705 (defun org-replace-region-by-html (beg end
)
706 "Assume the current region has org-mode syntax, and convert it to HTML.
707 This can be used in any buffer. For example, you could write an
708 itemized list in org-mode syntax in an HTML buffer and then use this
709 command to convert it."
711 (let (reg html buf pop-up-frames
)
712 (save-window-excursion
714 (setq html
(org-export-region-as-html
716 (setq reg
(buffer-substring beg end
)
717 buf
(get-buffer-create "*Org tmp*"))
718 (with-current-buffer buf
722 (setq html
(org-export-region-as-html
723 (point-min) (point-max) t
'string
)))
725 (delete-region beg end
)
729 (defun org-export-region-as-html (beg end
&optional body-only buffer
)
730 "Convert region from BEG to END in org-mode buffer to HTML.
731 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
732 contents, and only produce the region of converted text, useful for
733 cut-and-paste operations.
734 If BUFFER is a buffer or a string, use/create that buffer as a target
735 of the converted HTML. If BUFFER is the symbol `string', return the
736 produced HTML as a string and leave not buffer behind. For example,
737 a Lisp program could call this function in the following way:
739 (setq html (org-export-region-as-html beg end t 'string))
741 When called interactively, the output buffer is selected, and shown
742 in a window. A non-interactive call will only return the buffer."
744 (when (org-called-interactively-p 'any
)
745 (setq buffer
"*Org HTML Export*"))
746 (let ((transient-mark-mode t
) (zmacs-regions t
)
748 (setq ext-plist
(plist-put ext-plist
:ignore-subtree-p t
))
750 (set-mark (point)) ;; to activate the region
752 (setq rtn
(org-export-as-html
755 (if (fboundp 'deactivate-mark
) (deactivate-mark))
756 (if (and (org-called-interactively-p 'any
) (bufferp rtn
))
757 (switch-to-buffer-other-window rtn
)
760 (defvar html-table-tag nil
) ; dynamically scoped into this.
761 (defvar org-par-open nil
)
763 ;;; org-html-cvt-link-fn
764 (defconst org-html-cvt-link-fn
766 "Function to convert link URLs to exportable URLs.
767 Takes two arguments, TYPE and PATH.
768 Returns exportable url as (TYPE PATH), or nil to signal that it
769 didn't handle this case.
770 Intended to be locally bound around a call to `org-export-as-html'." )
772 (defun org-html-cvt-org-as-html (opt-plist type path
)
773 "Convert an org filename to an equivalent html filename.
774 If TYPE is not file, just return `nil'.
775 See variable `org-export-html-link-org-files-as-html'"
779 org-export-html-link-org-files-as-html
780 (string= type
"file")
781 (string-match "\\.org$" path
)
786 (substring path
0 (match-beginning 0))
788 (plist-get opt-plist
:html-extension
)))))))
791 ;;; org-html-should-inline-p
792 (defun org-html-should-inline-p (filename descp
)
793 "Return non-nil if link FILENAME should be inlined.
794 The decision to inline the FILENAME link is based on the current
795 settings. DESCP is the boolean of whether there was a link
796 description. See variables `org-export-html-inline-images' and
797 `org-export-html-inline-image-extensions'."
799 org-export-html-inline-images
800 org-export-html-inline-image-extensions
))
801 (and (or (eq t org-export-html-inline-images
)
802 (and org-export-html-inline-images
(not descp
)))
804 filename org-export-html-inline-image-extensions
)))
806 ;;; org-html-make-link
807 (defun org-html-make-link (opt-plist type path fragment desc attr
810 OPT-PLIST is an options list.
811 TYPE is the device-type of the link (THIS://foo.html)
812 PATH is the path of the link (http://THIS#locationx)
813 FRAGMENT is the fragment part of the link, if any (foo.html#THIS)
814 DESC is the link description, if any.
815 ATTR is a string of other attributes of the a element.
816 MAY-INLINE-P allows inlining it as an image."
818 (declare (special org-par-open
))
820 (let* ((filename path
)
821 ;;First pass. Just sanity stuff.
824 ((string= type
"file")
827 ;;Substitute just if original path was absolute.
828 ;;(Otherwise path must remain relative)
829 (if (file-name-absolute-p path
)
830 (concat "file://" (expand-file-name path
))
834 (t (list type path
))))
836 ;;Second pass. Components converted so they can refer
840 (and org-html-cvt-link-fn
841 (apply org-html-cvt-link-fn
842 opt-plist components-1
))
843 (apply #'org-html-cvt-org-as-html
844 opt-plist components-1
)
846 (type (first components-2
))
847 (thefile (second components-2
)))
850 ;;Third pass. Build final link except for leading type
855 (string= type
"http")
856 (string= type
"https")
857 (string= type
"file")
858 (string= type
"coderef"))
860 (setq thefile
(concat thefile
"#" fragment
))))
864 ;;Final URL-build, for all types.
867 ((str (org-export-html-format-href thefile
)))
868 (if (and type
(not (or (string= "file" type
)
869 (string= "coderef" type
))))
870 (concat type
":" str
)
875 ;;Can't inline a URL with a fragment.
878 (message "image %s %s" thefile org-par-open
)
879 (org-export-html-format-image thefile org-par-open
))
881 "<a href=\"" thefile
"\"" (if attr
(concat " " attr
)) ">"
882 (org-export-html-format-desc desc
)
885 (defun org-html-handle-links (line opt-plist
)
886 "Return LINE with markup of Org mode links.
887 OPT-PLIST is the export options list."
889 (current-dir (if buffer-file-name
890 (file-name-directory buffer-file-name
)
892 (link-validate (plist-get opt-plist
:link-validation-function
))
894 rpl path attr desc descp desc1 desc2 link
)
895 (while (string-match org-bracket-link-analytic-regexp
++ line start
)
896 (setq start
(match-beginning 0))
897 (setq path
(save-match-data (org-link-unescape
898 (match-string 3 line
))))
900 ((match-end 2) (match-string 2 line
))
902 (or (file-name-absolute-p path
)
903 (string-match "^\\.\\.?/" path
)))
906 (setq path
(org-extract-attributes (org-link-unescape path
)))
907 (setq attr
(get-text-property 0 'org-attributes path
))
908 (setq desc1
(if (match-end 5) (match-string 5 line
))
909 desc2
(if (match-end 2) (concat type
":" path
) path
)
910 descp
(and desc1
(not (equal desc1 desc2
)))
911 desc
(or desc1 desc2
))
912 ;; Make an image out of the description if that is so wanted
913 (when (and descp
(org-file-image-p
914 desc org-export-html-inline-image-extensions
))
916 (if (string-match "^file:" desc
)
917 (setq desc
(substring desc
(match-end 0)))))
918 (setq desc
(org-add-props
919 (concat "<img src=\"" desc
"\" alt=\""
920 (file-name-nondirectory desc
) "\"/>")
921 '(org-protected t
))))
923 ((equal type
"internal")
926 (if (= (string-to-char path
) ?
#)
934 (org-solidify-link-text
935 (save-match-data (org-link-unescape frag-0
))
938 ((and (equal type
"id")
939 (setq id-file
(org-id-find-id-file path
)))
940 ;; This is an id: link to another file (if it was the same file,
941 ;; it would have become an internal link...)
943 (setq id-file
(file-relative-name
945 (file-name-directory org-current-export-file
)))
947 (org-html-make-link opt-plist
949 (concat (if (org-uuidgen-p path
) "ID-") path
)
953 ((member type
'("http" "https"))
954 ;; standard URL, can inline as image
956 (org-html-make-link opt-plist
960 (org-html-should-inline-p path descp
))))
961 ((member type
'("ftp" "mailto" "news"))
962 ;; standard URL, can't inline as image
964 (org-html-make-link opt-plist
970 ((string= type
"coderef")
972 ((coderef-str (format "coderef-%s" path
))
974 (format "class=\"coderef\" onmouseover=\"CodeHighlightOn(this, '%s');\" onmouseout=\"CodeHighlightOff(this, '%s');\""
975 coderef-str coderef-str
)))
977 (org-html-make-link opt-plist
980 (org-export-get-coderef-format
983 (cdr (assoc path org-export-code-refs
)))
987 ((functionp (setq fnc
(nth 2 (assoc type org-link-protocols
))))
988 ;; The link protocol has a function for format the link
991 (funcall fnc
(org-link-unescape path
) desc1
'html
))))
993 ((string= type
"file")
999 (string-match "::\\(.*\\)" path
)
1001 (replace-match "" t nil path
)
1002 (match-string 1 path
))
1005 ;;The proper path, without a fragment
1011 (second components
))
1013 ;;Check the fragment. If it can't be used as
1014 ;;target fragment we'll pass nil instead.
1018 (not (string-match "^[0-9]*$" fragment-0
))
1019 (not (string-match "^\\*" fragment-0
))
1020 (not (string-match "^/.*/$" fragment-0
)))
1021 (org-solidify-link-text
1022 (org-link-unescape fragment-0
))
1025 ;;Description minus "file:" and ".org"
1026 (if (string-match "^file:" desc
)
1028 ((desc-1 (replace-match "" t t desc
)))
1029 (if (string-match "\\.org$" desc-1
)
1030 (replace-match "" t t desc-1
)
1037 (functionp link-validate
)
1038 (not (funcall link-validate path-1 current-dir
)))
1040 (org-html-make-link opt-plist
1041 "file" path-1 fragment-1 desc-2 attr
1042 (org-html-should-inline-p path-1 descp
)))))))
1045 ;; just publish the path, as default
1046 (setq rpl
(concat "@<i><" type
":"
1047 (save-match-data (org-link-unescape path
))
1049 (setq line
(replace-match rpl t t line
)
1050 start
(+ start
(length rpl
))))
1053 ;;; org-export-as-html
1055 (defun org-export-as-html (arg &optional hidden ext-plist
1056 to-buffer body-only pub-dir
)
1057 "Export the outline as a pretty HTML file.
1058 If there is an active region, export only the region. The prefix
1059 ARG specifies how many levels of the outline should become
1060 headlines. The default is 3. Lower levels will become bulleted
1061 lists. HIDDEN is obsolete and does nothing.
1062 EXT-PLIST is a property list with external parameters overriding
1063 org-mode's default settings, but still inferior to file-local
1064 settings. When TO-BUFFER is non-nil, create a buffer with that
1065 name and export to that buffer. If TO-BUFFER is the symbol
1066 `string', don't leave any buffer behind but just return the
1067 resulting HTML as a string. When BODY-ONLY is set, don't produce
1068 the file header and footer, simply return the content of
1069 <body>...</body>, without even the body tags themselves. When
1070 PUB-DIR is set, use this as the publishing directory."
1072 (run-hooks 'org-export-first-hook
)
1074 ;; Make sure we have a file name when we need it.
1075 (when (and (not (or to-buffer body-only
))
1076 (not buffer-file-name
))
1077 (if (buffer-base-buffer)
1078 (org-set-local 'buffer-file-name
1079 (with-current-buffer (buffer-base-buffer)
1081 (error "Need a file name to be able to export")))
1083 (message "Exporting...")
1084 (setq-default org-todo-line-regexp org-todo-line-regexp
)
1085 (setq-default org-deadline-line-regexp org-deadline-line-regexp
)
1086 (setq-default org-done-keywords org-done-keywords
)
1087 (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp
)
1089 (org-export-process-option-filters
1090 (org-combine-plists (org-default-export-plist)
1092 (org-infile-export-plist))))
1093 (body-only (or body-only
(plist-get opt-plist
:body-only
)))
1094 (style (concat (if (plist-get opt-plist
:style-include-default
)
1095 org-export-html-style-default
)
1096 (plist-get opt-plist
:style
)
1097 (plist-get opt-plist
:style-extra
)
1099 (if (plist-get opt-plist
:style-include-scripts
)
1100 org-export-html-scripts
)))
1101 (html-extension (plist-get opt-plist
:html-extension
))
1102 valid thetoc have-headings first-heading-pos
1103 (odd org-odd-levels-only
)
1104 (region-p (org-region-active-p))
1105 (rbeg (and region-p
(region-beginning)))
1106 (rend (and region-p
(region-end)))
1108 (if (plist-get opt-plist
:ignore-subtree-p
)
1113 (and (org-at-heading-p)
1114 (>= (org-end-of-subtree t t
) rend
))))))
1115 (level-offset (if subtree-p
1118 (+ (funcall outline-level
)
1119 (if org-odd-levels-only
1 0)))
1121 (opt-plist (setq org-export-opt-plist
1123 (org-export-add-subtree-options opt-plist rbeg
)
1125 ;; The following two are dynamically scoped into other
1127 (org-current-export-dir
1128 (or pub-dir
(org-export-directory :html opt-plist
)))
1129 (org-current-export-file buffer-file-name
)
1130 (level 0) (line "") (origline "") txt todo
1133 (filename (if to-buffer nil
1136 (file-name-sans-extension
1138 (org-entry-get (region-beginning)
1139 "EXPORT_FILE_NAME" t
))
1140 (file-name-nondirectory buffer-file-name
)))
1142 (file-name-as-directory
1143 (or pub-dir
(org-export-directory :html opt-plist
))))))
1144 (current-dir (if buffer-file-name
1145 (file-name-directory buffer-file-name
)
1147 (buffer (if to-buffer
1149 ((eq to-buffer
'string
) (get-buffer-create "*Org HTML Export*"))
1150 (t (get-buffer-create to-buffer
)))
1151 (find-file-noselect filename
)))
1152 (org-levels-open (make-vector org-level-max nil
))
1153 (date (plist-get opt-plist
:date
))
1154 (author (plist-get opt-plist
:author
))
1155 (html-validation-link (or org-export-html-validation-link
""))
1156 (title (org-html-expand
1157 (or (and subtree-p
(org-export-get-title-from-subtree))
1158 (plist-get opt-plist
:title
)
1159 (and (not body-only
)
1161 (plist-get opt-plist
:skip-before-1st-heading
))
1162 (org-export-grab-title-from-buffer))
1163 (and buffer-file-name
1164 (file-name-sans-extension
1165 (file-name-nondirectory buffer-file-name
)))
1167 (link-up (and (plist-get opt-plist
:link-up
)
1168 (string-match "\\S-" (plist-get opt-plist
:link-up
))
1169 (plist-get opt-plist
:link-up
)))
1170 (link-home (and (plist-get opt-plist
:link-home
)
1171 (string-match "\\S-" (plist-get opt-plist
:link-home
))
1172 (plist-get opt-plist
:link-home
)))
1173 (dummy (setq opt-plist
(plist-put opt-plist
:title title
)))
1174 (html-table-tag (plist-get opt-plist
:html-table-tag
))
1175 (quote-re0 (concat "^[ \t]*" org-quote-string
"\\>"))
1176 (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string
"\\>\\)"))
1180 (email (plist-get opt-plist
:email
))
1181 (language (plist-get opt-plist
:language
))
1182 (keywords (plist-get opt-plist
:keywords
))
1183 (description (plist-get opt-plist
:description
))
1184 (num (plist-get opt-plist
:section-numbers
))
1188 (coding-system (and (boundp 'buffer-file-coding-system
)
1189 buffer-file-coding-system
))
1190 (coding-system-for-write (or org-export-html-coding-system
1192 (save-buffer-coding-system (or org-export-html-coding-system
1194 (charset (and coding-system-for-write
1195 (fboundp 'coding-system-get
)
1196 (coding-system-get coding-system-for-write
1200 (if region-p
(region-beginning) (point-min))
1201 (if region-p
(region-end) (point-max))))
1202 (org-export-have-math nil
)
1203 (org-export-footnotes-seen nil
)
1204 (org-export-footnotes-data (org-footnote-all-labels 'with-defs
))
1207 (org-export-preprocess-string
1211 :skip-before-1st-heading
1212 (plist-get opt-plist
:skip-before-1st-heading
)
1213 :drawers
(plist-get opt-plist
:drawers
)
1214 :todo-keywords
(plist-get opt-plist
:todo-keywords
)
1215 :tasks
(plist-get opt-plist
:tasks
)
1216 :tags
(plist-get opt-plist
:tags
)
1217 :priority
(plist-get opt-plist
:priority
)
1218 :footnotes
(plist-get opt-plist
:footnotes
)
1219 :timestamps
(plist-get opt-plist
:timestamps
)
1221 (plist-get opt-plist
:archived-trees
)
1222 :select-tags
(plist-get opt-plist
:select-tags
)
1223 :exclude-tags
(plist-get opt-plist
:exclude-tags
)
1225 (plist-get opt-plist
:text
)
1227 (plist-get opt-plist
:LaTeX-fragments
))
1230 (if (or (eq (plist-get opt-plist
:LaTeX-fragments
) 'mathjax
)
1231 (and org-export-have-math
1232 (eq (plist-get opt-plist
:LaTeX-fragments
) t
)))
1234 (org-export-html-mathjax-config
1235 org-export-html-mathjax-template
1236 org-export-html-mathjax-options
1237 (or (plist-get opt-plist
:mathjax
) ""))
1240 table-buffer table-orig-buffer
1242 rpl path attr desc descp desc1 desc2 link
1244 footnotes footref-seen
1248 (let ((inhibit-read-only t
))
1250 (remove-text-properties (point-min) (point-max)
1251 '(:org-license-to-kill t
))))
1253 (message "Exporting...")
1255 (setq org-min-level
(org-get-min-level lines level-offset
))
1256 (setq org-last-level org-min-level
)
1257 (org-init-section-numbers)
1260 ((and date
(string-match "%" date
))
1261 (setq date
(format-time-string date
)))
1263 (t (setq date
(format-time-string "%Y-%m-%d %T %Z"))))
1265 ;; Get the language-dependent settings
1266 (setq lang-words
(or (assoc language org-export-language-setup
)
1267 (assoc "en" org-export-language-setup
)))
1269 ;; Switch to the output buffer
1271 (let ((inhibit-read-only t
)) (erase-buffer))
1273 (org-install-letbind)
1275 (and (fboundp 'set-buffer-file-coding-system
)
1276 (set-buffer-file-coding-system coding-system-for-write
))
1278 (let ((case-fold-search nil
)
1279 (org-odd-levels-only odd
))
1280 ;; create local variables for all options, to make sure all called
1281 ;; functions get the correct information
1283 (set (make-local-variable (nth 2 x
))
1284 (plist-get opt-plist
(car x
))))
1285 org-export-plist-vars
)
1286 (setq umax
(if arg
(prefix-numeric-value arg
)
1287 org-export-headline-levels
))
1288 (setq umax-toc
(if (integerp org-export-with-toc
)
1289 (min org-export-with-toc umax
)
1295 <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
1296 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
1297 <html xmlns=\"http://www.w3.org/1999/xhtml\"
1298 lang=\"%s\" xml:lang=\"%s\">
1301 <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
1302 <meta name=\"generator\" content=\"Org-mode\"/>
1303 <meta name=\"generated\" content=\"%s\"/>
1304 <meta name=\"author\" content=\"%s\"/>
1305 <meta name=\"description\" content=\"%s\"/>
1306 <meta name=\"keywords\" content=\"%s\"/>
1314 (or (and (stringp org-export-html-xml-declaration
)
1315 org-export-html-xml-declaration
)
1316 (cdr (assoc html-extension org-export-html-xml-declaration
))
1317 (cdr (assoc "html" org-export-html-xml-declaration
))
1320 (or charset
"iso-8859-1"))
1323 (or charset
"iso-8859-1")
1324 date author description keywords
1327 (if (or link-up link-home
)
1329 (format org-export-html-home
/up-format
1330 (or link-up link-home
)
1331 (or link-home link-up
))
1335 ;; insert html preamble
1336 (when (plist-get opt-plist
:html-preamble
)
1337 (let ((html-pre (plist-get opt-plist
:html-preamble
)))
1338 (insert "<div id=\"" (nth 0 org-export-html-divs
) "\">\n")
1339 (cond ((stringp html-pre
)
1341 (format-spec html-pre
`((?t .
,title
) (?a .
,author
)
1342 (?d .
,date
) (?e .
,email
)))))
1343 ((functionp html-pre
)
1348 (or (cadr (assoc (nth 0 lang-words
)
1349 org-export-html-preamble-format
))
1350 (cadr (assoc "en" org-export-html-preamble-format
)))
1351 `((?t .
,title
) (?a .
,author
)
1352 (?d .
,date
) (?e .
,email
))))))
1353 (insert "\n</div>\n")))
1355 ;; begin wrap around body
1356 (insert (format "\n<div id=\"%s\">"
1357 ;; FIXME org-export-html-content-div is obsolete since 7.7
1358 (or org-export-html-content-div
1359 (nth 1 org-export-html-divs
)))
1360 ;; FIXME this should go in the preamble but is here so
1361 ;; that org-infojs can still find it
1362 "\n<h1 class=\"title\">" title
"</h1>\n"))
1365 (if (and org-export-with-toc
(not body-only
))
1367 (push (format "<h%d>%s</h%d>\n"
1368 org-export-html-toplevel-hlevel
1370 org-export-html-toplevel-hlevel
)
1372 (push "<div id=\"text-table-of-contents\">\n" thetoc
)
1373 (push "<ul>\n<li>" thetoc
)
1377 (if (and (string-match org-todo-line-regexp line
)
1378 (not (get-text-property 0 'org-protected line
)))
1379 ;; This is a headline
1381 (setq have-headings t
)
1382 (setq level
(- (match-end 1) (match-beginning 1)
1384 level
(org-tr-level level
)
1385 txt
(save-match-data
1387 (org-export-cleanup-toc-line
1388 (match-string 3 line
))))
1390 (or (and org-export-mark-todo-in-toc
1392 (not (member (match-string 2 line
)
1393 org-done-keywords
)))
1395 (and org-export-mark-todo-in-toc
1397 (org-search-todo-below
1398 line lines level
))))
1400 (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt
)
1401 (setq txt
(replace-match
1402 " <span class=\"tag\"> \\1</span>" t nil txt
)))
1403 (if (string-match quote-re0 txt
)
1404 (setq txt
(replace-match "" t t txt
)))
1405 (setq snumber
(org-section-number level
))
1406 (if (and num
(if (integerp num
)
1409 (setq txt
(concat snumber
" " txt
)))
1410 (if (<= level
(max umax umax-toc
))
1411 (setq head-count
(+ head-count
1)))
1412 (if (<= level umax-toc
)
1414 (if (> level org-last-level
)
1416 (setq cnt
(- level org-last-level
))
1417 (while (>= (setq cnt
(1- cnt
)) 0)
1418 (push "\n<ul>\n<li>" thetoc
))
1419 (push "\n" thetoc
)))
1420 (if (< level org-last-level
)
1422 (setq cnt
(- org-last-level level
))
1423 (while (>= (setq cnt
(1- cnt
)) 0)
1424 (push "</li>\n</ul>" thetoc
))
1425 (push "\n" thetoc
)))
1426 ;; Check for targets
1427 (while (string-match org-any-target-regexp line
)
1428 (setq line
(replace-match
1429 (concat "@<span class=\"target\">"
1430 (match-string 1 line
) "@</span> ")
1432 (while (string-match "<\\(<\\)+\\|>\\(>\\)+" txt
)
1433 (setq txt
(replace-match "" t t txt
)))
1435 (replace-regexp-in-string
1436 "\\." "-" (format "sec-%s" snumber
)))
1437 (setq href
(org-solidify-link-text
1438 (or (cdr (assoc href
1439 org-export-preferred-target-alist
)) href
)))
1443 "</li>\n<li><a href=\"#%s\"><span class=\"todo\">%s</span></a>"
1444 "</li>\n<li><a href=\"#%s\">%s</a>")
1447 (setq org-last-level level
)))))
1450 (while (> org-last-level
(1- org-min-level
))
1451 (setq org-last-level
(1- org-last-level
))
1452 (push "</li>\n</ul>\n" thetoc
))
1453 (push "</div>\n" thetoc
)
1454 (setq thetoc
(if have-headings
(nreverse thetoc
) nil
))))
1457 (org-init-section-numbers)
1461 (while (setq line
(pop lines
) origline line
)
1464 ;; end of quote section?
1465 (when (and inquote
(string-match org-outline-regexp-bol line
))
1469 ;; inside a quote section?
1471 (insert (org-html-protect line
) "\n")
1472 (throw 'nextline nil
))
1474 ;; Fixed-width, verbatim lines (examples)
1475 (when (and org-export-with-fixed-width
1476 (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line
))
1479 (org-close-par-maybe)
1481 (insert "<pre class=\"example\">\n"))
1482 (insert (org-html-protect (match-string 3 line
)) "\n")
1483 (when (or (not lines
)
1484 (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
1489 (throw 'nextline nil
))
1492 (when (and (get-text-property 0 'org-protected line
)
1493 ;; Make sure it is the entire line that is protected
1494 (not (< (or (next-single-property-change
1495 0 'org-protected line
) 10000)
1497 (let (par (ind (get-text-property 0 'original-indentation line
)))
1498 (when (re-search-backward
1499 "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t
)
1500 (setq par
(match-string 1))
1501 (replace-match "\\2\n"))
1504 (or (= (length (car lines
)) 0)
1506 (equal ind
(get-text-property 0 'original-indentation
(car lines
))))
1507 (or (= (length (car lines
)) 0)
1508 (get-text-property 0 'org-protected
(car lines
))))
1509 (insert (pop lines
) "\n"))
1510 (and par
(insert "<p>\n")))
1511 (throw 'nextline nil
))
1513 ;; Blockquotes, verse, and center
1514 (when (equal "ORG-BLOCKQUOTE-START" line
)
1515 (org-close-par-maybe)
1516 (insert "<blockquote>\n")
1518 (throw 'nextline nil
))
1519 (when (equal "ORG-BLOCKQUOTE-END" line
)
1520 (org-close-par-maybe)
1521 (insert "\n</blockquote>\n")
1523 (throw 'nextline nil
))
1524 (when (equal "ORG-VERSE-START" line
)
1525 (org-close-par-maybe)
1526 (insert "\n<p class=\"verse\">\n")
1527 (setq org-par-open t
)
1529 (throw 'nextline nil
))
1530 (when (equal "ORG-VERSE-END" line
)
1532 (setq org-par-open nil
)
1535 (throw 'nextline nil
))
1536 (when (equal "ORG-CENTER-START" line
)
1537 (org-close-par-maybe)
1538 (insert "\n<div style=\"text-align: center\">")
1540 (throw 'nextline nil
))
1541 (when (equal "ORG-CENTER-END" line
)
1542 (org-close-par-maybe)
1545 (throw 'nextline nil
))
1546 (run-hooks 'org-export-html-after-blockquotes-hook
)
1548 (let ((i (org-get-string-indentation line
)))
1550 (setq line
(concat (mapconcat 'identity
1551 (make-list (* 2 i
) "\\nbsp") "")
1552 " " (org-trim line
))))
1553 (unless (string-match "\\\\\\\\[ \t]*$" line
)
1554 (setq line
(concat line
"\\\\")))))
1556 ;; make targets to anchors
1558 (while (string-match
1559 "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start
)
1561 ((get-text-property (match-beginning 1) 'org-protected line
)
1562 (setq start
(match-end 1)))
1564 (setq line
(replace-match
1566 "@<a name=\"%s\" id=\"%s\">@</a>"
1567 (org-solidify-link-text (match-string 1 line
))
1568 (org-solidify-link-text (match-string 1 line
)))
1570 ((and org-export-with-toc
(equal (string-to-char line
) ?
*))
1571 ;; FIXME: NOT DEPENDENT on TOC?????????????????????
1572 (setq line
(replace-match
1573 (concat "@<span class=\"target\">"
1574 (match-string 1 line
) "@</span> ")
1575 ;; (concat "@<i>" (match-string 1 line) "@</i> ")
1578 (setq line
(replace-match
1579 (concat "@<a name=\""
1580 (org-solidify-link-text (match-string 1 line
))
1581 "\" class=\"target\">" (match-string 1 line
)
1585 (setq line
(org-html-handle-time-stamps line
))
1587 ;; replace "&" by "&", "<" and ">" by "<" and ">"
1588 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
1589 ;; Also handle sub_superscripts and checkboxes
1590 (or (string-match org-table-hline-regexp line
)
1591 (string-match "^[ \t]*\\([+]-\\||[ ]\\)[-+ |]*[+|][ \t]*$" line
)
1592 (setq line
(org-html-expand line
)))
1595 (setq line
(org-html-handle-links line opt-plist
))
1598 (if (and (string-match org-todo-line-regexp line
)
1599 (match-beginning 2))
1602 (concat (substring line
0 (match-beginning 2))
1604 (if (member (match-string 2 line
)
1607 " " (match-string 2 line
)
1608 "\"> " (org-export-html-get-todo-kwd-class-name
1609 (match-string 2 line
))
1610 "</span>" (substring line
(match-end 2)))))
1612 ;; Does this contain a reference to a footnote?
1613 (when org-export-with-footnotes
1615 (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start
)
1616 ;; Discard protected matches not clearly identified as
1617 ;; footnote markers.
1618 (if (or (get-text-property (match-beginning 2) 'org-protected line
)
1619 (not (get-text-property (match-beginning 2) 'org-footnote line
)))
1620 (setq start
(match-end 2))
1621 (let ((n (match-string 2 line
)) extra a
)
1622 (if (setq a
(assoc n footref-seen
))
1624 (setcdr a
(1+ (cdr a
)))
1625 (setq extra
(format ".%d" (cdr a
))))
1627 (push (cons n
1) footref-seen
))
1633 (format org-export-html-footnote-format
1634 (concat "<a class=\"footref\" name=\"fnr.%s%s\" href=\"#fn.%s\">%s</a>")))
1635 (or (match-string 1 line
) "") n extra n n
)
1636 ;; If another footnote is following the
1637 ;; current one, add a separator.
1638 (if (save-match-data
1639 (string-match "\\`\\[[0-9]+\\]"
1640 (substring line
(match-end 0))))
1641 org-export-html-footnote-separator
1646 ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line
)
1647 ;; This is a headline
1648 (setq level
(org-tr-level (- (match-end 1) (match-beginning 1)
1650 txt
(match-string 2 line
))
1651 (if (string-match quote-re0 txt
)
1652 (setq txt
(replace-match "" t t txt
)))
1653 (if (<= level
(max umax umax-toc
))
1654 (setq head-count
(+ head-count
1)))
1655 (setq first-heading-pos
(or first-heading-pos
(point)))
1656 (org-html-level-start level txt umax
1657 (and org-export-with-toc
(<= level umax
))
1658 head-count opt-plist
)
1661 (when (string-match quote-re line
)
1662 (org-close-par-maybe)
1666 ((and org-export-with-tables
1667 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line
))
1668 (when (not table-open
)
1670 (setq table-open t table-buffer nil table-orig-buffer nil
))
1673 (setq table-buffer
(cons line table-buffer
)
1674 table-orig-buffer
(cons origline table-orig-buffer
))
1675 (when (or (not lines
)
1676 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
1678 (setq table-open nil
1679 table-buffer
(nreverse table-buffer
)
1680 table-orig-buffer
(nreverse table-orig-buffer
))
1681 (org-close-par-maybe)
1682 (insert (org-format-table-html table-buffer table-orig-buffer
))))
1687 ;; This line either is list item or end a list.
1688 (when (get-text-property 0 'list-item line
)
1689 (setq line
(org-html-export-list-line
1691 (get-text-property 0 'list-item line
)
1692 (get-text-property 0 'list-struct line
)
1693 (get-text-property 0 'list-prevs line
))))
1696 (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line
)
1698 (insert "\n</p>\n<hr/>\n<p>\n")
1699 (insert "\n<hr/>\n"))
1700 (throw 'nextline nil
))
1702 ;; Empty lines start a new paragraph. If hand-formatted lists
1703 ;; are not fully interpreted, lines starting with "-", "+", "*"
1704 ;; also start a new paragraph.
1705 (if (string-match "^ [-+*]-\\|^[ \t]*$" line
) (org-open-par))
1707 ;; Is this the start of a footnote?
1708 (when org-export-with-footnotes
1709 (when (and (boundp 'footnote-section-tag-regexp
)
1710 (string-match (concat "^" footnote-section-tag-regexp
)
1713 (throw 'nextline nil
))
1714 (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line
)
1715 (org-close-par-maybe)
1716 (let ((n (match-string 1 line
)))
1717 (setq org-par-open t
1720 (concat "<p class=\"footnote\">"
1721 (format org-export-html-footnote-format
1722 "<a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a>"))
1723 n n n
) t t line
)))))
1724 ;; Check if the line break needs to be conserved
1726 ((string-match "\\\\\\\\[ \t]*$" line
)
1727 (setq line
(replace-match "<br/>" t t line
)))
1728 (org-export-preserve-breaks
1729 (setq line
(concat line
"<br/>"))))
1731 ;; Check if a paragraph should be started
1733 (while (and org-par-open
1734 (string-match "\\\\par\\>" line start
))
1735 ;; Leave a space in the </p> so that the footnote matcher
1736 ;; does not see this.
1737 (if (not (get-text-property (match-beginning 0)
1738 'org-protected line
))
1739 (setq line
(replace-match "</p ><p >" t t line
)))
1740 (setq start
(match-end 0))))
1742 (insert line
"\n")))))
1744 ;; Properly close all local lists and other lists
1749 (org-html-level-start 1 nil umax
1750 (and org-export-with-toc
(<= level umax
))
1751 head-count opt-plist
)
1752 ;; the </div> to close the last text-... div.
1753 (when (and (> umax
0) first-heading-pos
) (insert "</div>\n"))
1756 (goto-char (point-min))
1757 (while (re-search-forward
1758 "\\(\\(<p class=\"footnote\">\\)[^\000]*?\\)\\(\\(\\2\\)\\|\\'\\)"
1760 (push (match-string 1) footnotes
)
1761 (replace-match "\\4" t nil
)
1762 (goto-char (match-beginning 0))))
1764 (insert (format org-export-html-footnotes-section
1766 (mapconcat 'identity
(nreverse footnotes
) "\n"))
1768 (let ((bib (org-export-html-get-bibliography)))
1770 (insert "\n" bib
"\n")))
1773 ;; end wrap around body
1776 ;; export html postamble
1777 (let ((html-post (plist-get opt-plist
:html-postamble
))
1779 (mapconcat (lambda(e)
1780 (format "<a href=\"mailto:%s\">%s</a>" e e
))
1781 (split-string email
",+ *")
1784 (concat "Org version " org-version
" with Emacs version "
1785 (number-to-string emacs-major-version
))))
1787 (when (plist-get opt-plist
:html-postamble
)
1788 (insert "\n<div id=\"" (nth 2 org-export-html-divs
) "\">\n")
1789 (cond ((stringp html-post
)
1790 (insert (format-spec html-post
1791 `((?a .
,author
) (?e .
,email
)
1792 (?d .
,date
) (?c .
,creator-info
)
1793 (?v .
,html-validation-link
)))))
1794 ((functionp html-post
)
1795 (funcall html-post
))
1796 ((eq html-post
'auto
)
1797 ;; fall back on default postamble
1798 (when (plist-get opt-plist
:time-stamp-file
)
1799 (insert "<p class=\"date\">" (nth 2 lang-words
) ": " date
"</p>\n"))
1800 (when (and (plist-get opt-plist
:author-info
) author
)
1801 (insert "<p class=\"author\">" (nth 1 lang-words
) ": " author
"</p>\n"))
1802 (when (and (plist-get opt-plist
:email-info
) email
)
1803 (insert "<p class=\"email\">" email
"</p>\n"))
1804 (when (plist-get opt-plist
:creator-info
)
1805 (insert "<p class=\"creator\">"
1806 (concat "Org version " org-version
" with Emacs version "
1807 (number-to-string emacs-major-version
) "</p>\n")))
1808 (insert html-validation-link
"\n"))
1810 (insert (format-spec
1811 (or (cadr (assoc (nth 0 lang-words
)
1812 org-export-html-postamble-format
))
1813 (cadr (assoc "en" org-export-html-postamble-format
)))
1814 `((?a .
,author
) (?e .
,email
)
1815 (?d .
,date
) (?c .
,creator-info
)
1816 (?v .
,html-validation-link
))))))
1817 (insert "\n</div>"))))
1819 ;; FIXME `org-export-html-with-timestamp' has been declared
1820 ;; obsolete since Org 7.7 -- don't forget to remove this.
1821 (if org-export-html-with-timestamp
1822 (insert org-export-html-html-helper-timestamp
))
1824 (unless body-only
(insert "\n</body>\n</html>\n"))
1826 (unless (plist-get opt-plist
:buffer-will-be-killed
)
1828 (if (eq major-mode
(default-value 'major-mode
))
1831 ;; insert the table of contents
1832 (goto-char (point-min))
1834 (if (or (re-search-forward
1835 "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t
)
1837 "\\[TABLE-OF-CONTENTS\\]" nil t
))
1839 (goto-char (match-beginning 0))
1841 (goto-char first-heading-pos
)
1842 (when (looking-at "\\s-*</p>")
1843 (goto-char (match-end 0))
1845 (insert "<div id=\"table-of-contents\">\n")
1846 (let ((beg (point)))
1847 (mapc 'insert thetoc
)
1849 (while (re-search-backward "<li>[ \r\n\t]*</li>\n?" beg t
)
1850 (replace-match ""))))
1851 ;; remove empty paragraphs
1852 (goto-char (point-min))
1853 (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t
)
1855 (goto-char (point-min))
1856 ;; Convert whitespace place holders
1857 (goto-char (point-min))
1859 (while (setq beg
(next-single-property-change (point) 'org-whitespace
))
1860 (setq n
(get-text-property beg
'org-whitespace
)
1861 end
(next-single-property-change beg
'org-whitespace
))
1863 (delete-region beg end
)
1864 (insert (format "<span style=\"visibility:hidden;\">%s</span>"
1865 (make-string n ?x
)))))
1866 ;; Remove empty lines at the beginning of the file.
1867 (goto-char (point-min))
1868 (when (looking-at "\\s-+\n") (replace-match ""))
1869 ;; Remove display properties
1870 (remove-text-properties (point-min) (point-max) '(display t
))
1872 (run-hooks 'org-export-html-final-hook
)
1873 (or to-buffer
(save-buffer))
1874 (goto-char (point-min))
1875 (or (org-export-push-to-kill-ring "HTML")
1876 (message "Exporting... done"))
1877 (if (eq to-buffer
'string
)
1878 (prog1 (buffer-substring (point-min) (point-max))
1879 (kill-buffer (current-buffer)))
1880 (current-buffer)))))
1882 (defun org-export-html-format-href (s)
1883 "Make sure the S is valid as a href reference in an XHTML document."
1886 (while (string-match "&" s start
)
1887 (setq start
(+ (match-beginning 0) 3)
1888 s
(replace-match "&" t t s
)))))
1891 (defun org-export-html-format-desc (s)
1892 "Make sure the S is valid as a description in a link."
1893 (if (and s
(not (get-text-property 1 'org-protected s
)))
1895 (org-html-do-expand s
))
1898 (defun org-export-html-format-image (src par-open
)
1899 "Create image tag with source and attributes."
1901 (if (string-match "^ltxpng/" src
)
1902 (format "<img src=\"%s\" alt=\"%s\"/>"
1903 src
(org-find-text-property-in-string 'org-latex-src src
))
1904 (let* ((caption (org-find-text-property-in-string 'org-caption src
))
1905 (attr (org-find-text-property-in-string 'org-attributes src
))
1906 (label (org-find-text-property-in-string 'org-label src
)))
1907 (setq caption
(and caption
(org-html-do-expand caption
)))
1910 (format "%s<div %sclass=\"figure\">
1912 (if org-par-open
"</p>\n" "")
1913 (if label
(format "id=\"%s\" " (org-solidify-link-text label
)) "")))
1914 (format "<img src=\"%s\"%s />"
1916 (if (string-match "\\<alt=" (or attr
""))
1918 (concat " " attr
" alt=\"" src
"\"")))
1922 (concat "\n<p>" caption
"</p>")
1923 (if org-par-open
"\n<p>" ""))))))))
1925 (defun org-export-html-get-bibliography ()
1926 "Find bibliography, cut it out and return it."
1928 (let (beg end
(cnt 1) bib
)
1930 (goto-char (point-min))
1931 (when (re-search-forward "^[ \t]*<div \\(id\\|class\\)=\"bibliography\"" nil t
)
1932 (setq beg
(match-beginning 0))
1933 (while (re-search-forward "</?div\\>" nil t
)
1934 (setq cnt
(+ cnt
(if (string= (match-string 0) "<div") +1 -
1)))
1936 (and (looking-at ">") (forward-char 1))
1937 (setq bib
(buffer-substring beg
(point)))
1938 (delete-region beg
(point))
1939 (throw 'exit bib
))))
1942 (defvar org-table-number-regexp
) ; defined in org-table.el
1943 (defun org-format-table-html (lines olines
&optional no-css
)
1944 "Find out which HTML converter to use and return the HTML code.
1945 NO-CSS is passed to the exporter."
1947 (setq lines
(org-split-string lines
"\n")))
1948 (if (string-match "^[ \t]*|" (car lines
))
1949 ;; A normal org table
1950 (org-format-org-table-html lines nil no-css
)
1951 ;; Table made by table.el
1952 (or (org-format-table-table-html-using-table-generate-source
1953 olines
(not org-export-prefer-native-exporter-for-tables
))
1954 ;; We are here only when table.el table has NO col or row
1955 ;; spanning and the user prefers using org's own converter for
1956 ;; exporting of such simple table.el tables.
1957 (org-format-table-table-html lines
))))
1959 (defvar org-table-number-fraction
) ; defined in org-table.el
1960 (defun org-format-org-table-html (lines &optional splice no-css
)
1961 "Format a table into HTML.
1962 LINES is a list of lines. Optional argument SPLICE means, do not
1963 insert header and surrounding <table> tags, just format the lines.
1964 Optional argument NO-CSS means use XHTML attributes instead of CSS
1965 for formatting. This is required for the DocBook exporter."
1966 (require 'org-table
)
1967 ;; Get rid of hlines at beginning and end
1968 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1969 (setq lines
(nreverse lines
))
1970 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1971 (setq lines
(nreverse lines
))
1972 (when org-export-table-remove-special-lines
1973 ;; Check if the table has a marking column. If yes remove the
1974 ;; column and the special lines
1975 (setq lines
(org-table-clean-before-export lines
)))
1977 (let* ((caption (org-find-text-property-in-string 'org-caption
(car lines
)))
1978 (label (org-find-text-property-in-string 'org-label
(car lines
)))
1979 (forced-aligns (org-find-text-property-in-string 'org-forced-aligns
1981 (attributes (org-find-text-property-in-string 'org-attributes
1983 (html-table-tag (org-export-splice-attributes
1984 html-table-tag attributes
))
1985 (head (and org-export-highlight-first-table-line
1987 (lambda (x) (string-match "^[ \t]*|-" x
))
1989 (nline 0) fnum nfields i
(cnt 0)
1990 tbopen line fields html gr colgropen rowstart rowend
1992 (setq caption
(and caption
(org-html-do-expand caption
)))
1993 (when (and forced-aligns org-table-clean-did-remove-column
)
1995 (mapcar (lambda (x) (cons (1- (car x
)) (cdr x
))) forced-aligns
)))
1996 (if splice
(setq head nil
))
1997 (unless splice
(push (if head
"<thead>" "<tbody>") html
))
1999 (while (setq line
(pop lines
))
2001 (if (string-match "^[ \t]*|-" line
)
2004 (push (if head
"</thead>" "</tbody>") html
)
2005 (if lines
(push "<tbody>" html
) (setq tbopen nil
)))
2006 (setq head nil
) ;; head ends here, first time around
2008 (throw 'next-line t
)))
2009 ;; Break the line into fields
2010 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
2011 (unless fnum
(setq fnum
(make-vector (length fields
) 0)
2012 nfields
(length fnum
)))
2013 (setq nline
(1+ nline
) i -
1
2014 rowstart
(eval (car org-export-table-row-tags
))
2015 rowend
(eval (cdr org-export-table-row-tags
)))
2016 (push (concat rowstart
2019 (setq i
(1+ i
) ali
(format "@@class%03d@@" i
))
2020 (if (and (< i nfields
) ; make sure no rogue line causes an error here
2021 (string-match org-table-number-regexp x
))
2022 (incf (aref fnum i
)))
2026 (format (car org-export-table-header-tags
)
2029 (cdr org-export-table-header-tags
)))
2030 ((and (= i
0) org-export-html-table-use-header-tags-for-first-column
)
2032 (format (car org-export-table-header-tags
)
2035 (cdr org-export-table-header-tags
)))
2037 (concat (format (car org-export-table-data-tags
) ali
)
2039 (cdr org-export-table-data-tags
)))))
2043 (unless splice
(if tbopen
(push "</tbody>" html
)))
2044 (unless splice
(push "</table>\n" html
))
2045 (setq html
(nreverse html
))
2047 ;; Put in col tags with the alignment (unfortunately often ignored...)
2048 (unless (car org-table-colgroup-info
)
2049 (setq org-table-colgroup-info
2050 (cons :start
(cdr org-table-colgroup-info
))))
2054 (setq gr
(pop org-table-colgroup-info
)
2056 align
(if (assoc i forced-aligns
)
2057 (cdr (assoc (cdr (assoc i forced-aligns
))
2058 '(("l" .
"left") ("r" .
"right")
2060 (if (> (/ (float x
) nline
)
2061 org-table-number-fraction
)
2065 "%s<col align=\"%s\" />%s"
2066 "%s<col class=\"%s\" />%s")
2067 (if (memq gr
'(:start
:startend
))
2070 "</colgroup>\n<colgroup>"
2075 (if (memq gr
'(:end
:startend
))
2076 (progn (setq colgropen nil
) "</colgroup>")
2080 (setq aligns
(nreverse aligns
))
2081 (if colgropen
(setq html
(cons (car html
)
2082 (cons "</colgroup>" (cdr html
)))))
2083 ;; Since the output of HTML table formatter can also be used in
2084 ;; DocBook document, we want to always include the caption to make
2085 ;; DocBook XML file valid.
2086 (push (format "<caption>%s</caption>" (or caption
"")) html
)
2088 (setq html-table-tag
(org-export-splice-attributes html-table-tag
(format "id=\"%s\"" (org-solidify-link-text label
)))))
2089 (push html-table-tag html
))
2092 (replace-regexp-in-string
2093 "@@class\\([0-9]+\\)@@"
2095 (if (not org-export-html-table-align-individual-fields
)
2097 (setq n
(string-to-number (match-string 1 txt
)))
2098 (format (if no-css
" align=\"%s\"" " class=\"%s\"")
2099 (or (nth n aligns
) "left"))))
2102 (concat (mapconcat 'identity html
"\n") "\n")))
2104 (defun org-export-splice-attributes (tag attributes
)
2105 "Read attributes in string ATTRIBUTES, add and replace in HTML tag TAG."
2106 (if (not attributes
)
2108 (let (oldatt newatt
)
2109 (setq oldatt
(org-extract-attributes-from-string tag
)
2111 newatt
(cdr (org-extract-attributes-from-string attributes
)))
2113 (setq oldatt
(plist-put oldatt
(pop newatt
) (pop newatt
))))
2114 (if (string-match ">" tag
)
2116 (replace-match (concat (org-attributes-to-string oldatt
) ">")
2120 (defun org-format-table-table-html (lines)
2121 "Format a table generated by table.el into HTML.
2122 This conversion does *not* use `table-generate-source' from table.el.
2123 This has the advantage that Org-mode's HTML conversions can be used.
2124 But it has the disadvantage, that no cell- or row-spanning is allowed."
2125 (let (line field-buffer
2126 (head org-export-highlight-first-table-line
)
2127 fields html empty i
)
2128 (setq html
(concat html-table-tag
"\n"))
2129 (while (setq line
(pop lines
))
2130 (setq empty
" ")
2132 (if (string-match "^[ \t]*\\+-" line
)
2143 (if (equal x
"") (setq x empty
))
2146 (format (car org-export-table-header-tags
) "col" "")
2148 (cdr org-export-table-header-tags
))
2149 (concat (format (car org-export-table-data-tags
) "") x
2150 (cdr org-export-table-data-tags
))))
2154 (setq field-buffer nil
)))
2156 (throw 'next-line t
)))
2157 ;; Break the line into fields and store the fields
2158 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
2160 (setq field-buffer
(mapcar
2162 (concat x
"<br/>" (pop fields
)))
2164 (setq field-buffer fields
))))
2165 (setq html
(concat html
"</table>\n"))
2168 (defun org-format-table-table-html-using-table-generate-source (lines
2171 "Format a table into html, using `table-generate-source' from table.el.
2172 Use SPANNED-ONLY to suppress exporting of simple table.el tables.
2174 When SPANNED-ONLY is nil, all table.el tables are exported. When
2175 SPANNED-ONLY is non-nil, only tables with either row or column
2178 This routine returns the generated source or nil as appropriate.
2180 Refer docstring of `org-export-prefer-native-exporter-for-tables'
2181 for further information."
2183 (with-current-buffer (get-buffer-create " org-tmp1 ")
2185 (insert (mapconcat 'identity lines
"\n"))
2186 (goto-char (point-min))
2187 (if (not (re-search-forward "|[^+]" nil t
))
2188 (error "Error processing table"))
2189 (table-recognize-table)
2190 (when (or (not spanned-only
)
2191 (let* ((dim (table-query-dimension))
2192 (c (nth 4 dim
)) (r (nth 5 dim
)) (cells (nth 6 dim
)))
2193 (not (= (* c r
) cells
))))
2194 (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
2195 (table-generate-source 'html
" org-tmp2 ")
2196 (set-buffer " org-tmp2 ")
2197 (buffer-substring (point-min) (point-max)))))
2199 (defun org-export-splice-style (style extra
)
2200 "Splice EXTRA into STYLE, just before \"</style>\"."
2201 (if (and (stringp extra
)
2202 (string-match "\\S-" extra
)
2203 (string-match "</style>" style
))
2204 (concat (substring style
0 (match-beginning 0))
2206 (substring style
(match-beginning 0)))
2209 (defun org-html-handle-time-stamps (s)
2210 "Format time stamps in string S, or remove them."
2213 (while (string-match org-maybe-keyword-time-regexp s
)
2214 (or b
(setq b
(substring s
0 (match-beginning 0))))
2216 r
(substring s
0 (match-beginning 0))
2217 " @<span class=\"timestamp-wrapper\">"
2219 (format "@<span class=\"timestamp-kwd\">%s @</span>"
2220 (match-string 1 s
)))
2221 (format " @<span class=\"timestamp\">%s@</span>"
2223 (org-translate-time (match-string 3 s
)) 1 -
1))
2225 s
(substring s
(match-end 0))))
2226 ;; Line break if line started and ended with time stamp stuff
2229 (setq r
(concat r s
))
2230 (unless (string-match "\\S-" (concat b s
))
2231 (setq r
(concat r
"@<br/>")))
2234 (defvar htmlize-buffer-places
) ; from htmlize.el
2235 (defun org-export-htmlize-region-for-paste (beg end
)
2236 "Convert the region to HTML, using htmlize.el.
2237 This is much like `htmlize-region-for-paste', only that it uses
2238 the settings define in the org-... variables."
2239 (let* ((htmlize-output-type org-export-htmlize-output-type
)
2240 (htmlize-css-name-prefix org-export-htmlize-css-font-prefix
)
2241 (htmlbuf (htmlize-region beg end
)))
2243 (with-current-buffer htmlbuf
2244 (buffer-substring (plist-get htmlize-buffer-places
'content-start
)
2245 (plist-get htmlize-buffer-places
'content-end
)))
2246 (kill-buffer htmlbuf
))))
2249 (defun org-export-htmlize-generate-css ()
2250 "Create the CSS for all font definitions in the current Emacs session.
2251 Use this to create face definitions in your CSS style file that can then
2252 be used by code snippets transformed by htmlize.
2253 This command just produces a buffer that contains class definitions for all
2254 faces used in the current Emacs session. You can copy and paste the ones you
2255 need into your CSS file.
2257 If you then set `org-export-htmlize-output-type' to `css', calls to
2258 the function `org-export-htmlize-region-for-paste' will produce code
2259 that uses these same face definitions."
2262 (and (get-buffer "*html*") (kill-buffer "*html*"))
2264 (let ((fl (face-list))
2265 (htmlize-css-name-prefix "org-")
2266 (htmlize-output-type 'css
)
2268 (while (setq f
(pop fl
)
2269 i
(and f
(face-attribute f
:inherit
)))
2270 (when (and (symbolp f
) (or (not i
) (not (listp i
))))
2271 (insert (org-add-props (copy-sequence "1") nil
'face f
))))
2272 (htmlize-region (point-min) (point-max))))
2273 (org-pop-to-buffer-same-window "*html*")
2274 (goto-char (point-min))
2275 (if (re-search-forward "<style" nil t
)
2276 (delete-region (point-min) (match-beginning 0)))
2277 (if (re-search-forward "</style>" nil t
)
2278 (delete-region (1+ (match-end 0)) (point-max)))
2279 (beginning-of-line 1)
2280 (if (looking-at " +") (replace-match ""))
2281 (goto-char (point-min)))
2283 (defun org-html-protect (s)
2284 "Convert characters to HTML equivalent.
2285 Possible conversions are set in `org-export-html-protect-char-alist'."
2286 (let ((cl org-export-html-protect-char-alist
) c
)
2287 (while (setq c
(pop cl
))
2289 (while (string-match (car c
) s start
)
2290 (setq s
(replace-match (cdr c
) t t s
)
2291 start
(1+ (match-beginning 0))))))
2294 (defun org-html-expand (string)
2295 "Prepare STRING for HTML export. Apply all active conversions.
2296 If there are links in the string, don't modify these."
2297 (let* ((re (concat org-bracket-link-regexp
"\\|"
2298 (org-re "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")))
2300 (while (setq m
(string-match re string
))
2301 (setq s
(substring string
0 m
)
2302 l
(match-string 0 string
)
2303 string
(substring string
(match-end 0)))
2304 (push (org-html-do-expand s
) res
)
2306 (push (org-html-do-expand string
) res
)
2307 (apply 'concat
(nreverse res
))))
2309 (defun org-html-do-expand (s)
2310 "Apply all active conversions to translate special ASCII to HTML."
2311 (setq s
(org-html-protect s
))
2312 (if org-export-html-expand
2313 (while (string-match "@<\\([^&]*\\)>" s
)
2314 (setq s
(replace-match "<\\1>" t nil s
))))
2315 (if org-export-with-emphasize
2316 (setq s
(org-export-html-convert-emphasize s
)))
2317 (if org-export-with-special-strings
2318 (setq s
(org-export-html-convert-special-strings s
)))
2319 (if org-export-with-sub-superscripts
2320 (setq s
(org-export-html-convert-sub-super s
)))
2321 (if org-export-with-TeX-macros
2322 (let ((start 0) wd rep
)
2323 (while (setq start
(string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
2325 (if (get-text-property (match-beginning 0) 'org-protected s
)
2326 (setq start
(match-end 0))
2327 (setq wd
(match-string 1 s
))
2328 (if (setq rep
(org-entity-get-representation wd
'html
))
2329 (setq s
(replace-match rep t t s
))
2330 (setq start
(+ start
(length wd
))))))))
2333 (defun org-export-html-convert-special-strings (string)
2334 "Convert special characters in STRING to HTML."
2335 (let ((all org-export-html-special-string-regexps
)
2337 (while (setq a
(pop all
))
2338 (setq re
(car a
) rpl
(cdr a
) start
0)
2339 (while (string-match re string start
)
2340 (if (get-text-property (match-beginning 0) 'org-protected string
)
2341 (setq start
(match-end 0))
2342 (setq string
(replace-match rpl t nil string
)))))
2345 (defun org-export-html-convert-sub-super (string)
2346 "Convert sub- and superscripts in STRING to HTML."
2347 (let (key c
(s 0) (requireb (eq org-export-with-sub-superscripts
'{})))
2348 (while (string-match org-match-substring-regexp string s
)
2350 ((and requireb
(match-end 8)) (setq s
(match-end 2)))
2351 ((get-text-property (match-beginning 2) 'org-protected string
)
2352 (setq s
(match-end 2)))
2354 (setq s
(match-end 1)
2355 key
(if (string= (match-string 2 string
) "_") "sub" "sup")
2356 c
(or (match-string 8 string
)
2357 (match-string 6 string
)
2358 (match-string 5 string
))
2359 string
(replace-match
2360 (concat (match-string 1 string
)
2361 "<" key
">" c
"</" key
">")
2363 (while (string-match "\\\\\\([_^]\\)" string
)
2364 (setq string
(replace-match (match-string 1 string
) t t string
)))
2367 (defun org-export-html-convert-emphasize (string)
2370 (while (string-match org-emph-re string s
)
2372 (substring string
(match-beginning 3) (1+ (match-beginning 3)))
2373 (substring string
(match-beginning 4) (1+ (match-beginning 4)))))
2374 (setq s
(match-beginning 0)
2377 (match-string 1 string
)
2378 (nth 2 (assoc (match-string 3 string
) org-emphasis-alist
))
2379 (match-string 4 string
)
2380 (nth 3 (assoc (match-string 3 string
)
2381 org-emphasis-alist
))
2382 (match-string 5 string
))
2383 string
(replace-match rpl t t string
)
2384 s
(+ s
(- (length rpl
) 2)))
2388 (defun org-open-par ()
2389 "Insert <p>, but first close previous paragraph if any."
2390 (org-close-par-maybe)
2392 (setq org-par-open t
))
2393 (defun org-close-par-maybe ()
2394 "Close paragraph if there is one open."
2397 (setq org-par-open nil
)))
2398 (defun org-close-li (&optional type
)
2399 "Close <li> if necessary."
2400 (org-close-par-maybe)
2401 (insert (if (equal type
"d") "</dd>\n" "</li>\n")))
2403 (defvar body-only
) ; dynamically scoped into this.
2404 (defun org-html-level-start (level title umax with-toc head-count
&optional opt-plist
)
2405 "Insert a new level in HTML export.
2406 When TITLE is nil, just close all open levels."
2407 (org-close-par-maybe)
2408 (let* ((target (and title
(org-get-text-property-any 0 'target title
)))
2409 (extra-targets (and target
2410 (assoc target org-export-target-aliases
)))
2411 (extra-class (and title
(org-get-text-property-any 0 'html-container-class title
)))
2412 (preferred (and target
2413 (cdr (assoc target org-export-preferred-target-alist
))))
2415 (num (plist-get opt-plist
:section-numbers
))
2416 snumber snu href suffix
)
2417 (setq extra-targets
(remove (or preferred target
) extra-targets
))
2419 (mapconcat (lambda (x)
2420 (setq x
(org-solidify-link-text
2421 (if (org-uuidgen-p x
) (concat "ID-" x
) x
)))
2422 (format "<a name=\"%s\" id=\"%s\"></a>"
2427 (if (aref org-levels-open
(1- l
))
2429 (org-html-level-close l umax
)
2430 (aset org-levels-open
(1- l
) nil
)))
2433 ;; If title is nil, this means this function is called to close
2434 ;; all levels, so the rest is done only if title is given
2435 (when (string-match (org-re "\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") title
)
2436 (setq title
(replace-match
2437 (if org-export-with-tags
2440 " <span class=\"tag\">"
2443 (format "<span class=\"%s\">%s</span>"
2444 (org-export-html-get-tag-class-name x
)
2446 (org-split-string (match-string 1 title
) ":")
2453 (if (aref org-levels-open
(1- level
))
2457 (insert (format "<li id=\"%s\">" (org-solidify-link-text (or preferred target
)))
2458 extra-targets title
"<br/>\n")
2459 (insert "<li>" title
"<br/>\n")))
2460 (aset org-levels-open
(1- level
) t
)
2461 (org-close-par-maybe)
2463 (insert (format "<ul>\n<li id=\"%s\">" (org-solidify-link-text (or preferred target
)))
2464 extra-targets title
"<br/>\n")
2465 (insert "<ul>\n<li>" title
"<br/>\n"))))
2466 (aset org-levels-open
(1- level
) t
)
2467 (setq snumber
(org-section-number level
)
2468 snu
(replace-regexp-in-string "\\." "-" snumber
))
2469 (setq level
(+ level org-export-html-toplevel-hlevel -
1))
2470 (if (and num
(not body-only
))
2472 (format "<span class=\"section-number-%d\">%s</span>"
2476 ;; fix up num to take into
2477 ;; account the top-level
2479 (>= (+ num org-export-html-toplevel-hlevel -
1)
2485 (unless (= head-count
1) (insert "\n</div>\n"))
2486 (setq href
(cdr (assoc (concat "sec-" snu
) org-export-preferred-target-alist
)))
2487 (setq suffix
(org-solidify-link-text (or href snu
)))
2488 (setq href
(org-solidify-link-text (or href
(concat "sec-" snu
))))
2489 (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"
2490 suffix level
(if extra-class
(concat " " extra-class
) "")
2493 title level level suffix
))
2496 (defun org-export-html-get-tag-class-name (tag)
2497 "Turn tag into a valid class name.
2498 Replaces invalid characters with \"_\" and then prepends a prefix."
2500 (while (string-match "[^a-zA-Z0-9_]" tag
)
2501 (setq tag
(replace-match "_" t t tag
))))
2502 (concat org-export-html-tag-class-prefix tag
))
2504 (defun org-export-html-get-todo-kwd-class-name (kwd)
2505 "Turn todo keyword into a valid class name.
2506 Replaces invalid characters with \"_\" and then prepends a prefix."
2508 (while (string-match "[^a-zA-Z0-9_]" kwd
)
2509 (setq kwd
(replace-match "_" t t kwd
))))
2510 (concat org-export-html-todo-kwd-class-prefix kwd
))
2512 (defun org-html-level-close (level max-outline-level
)
2513 "Terminate one level in HTML export."
2514 (if (<= level max-outline-level
)
2517 (insert "</ul>\n")))
2519 (defun org-html-export-list-line (line pos struct prevs
)
2520 "Insert list syntax in export buffer. Return LINE, maybe modified.
2522 POS is the item position or line position the line had before
2523 modifications to buffer. STRUCT is the list structure. PREVS is
2524 the alist of previous items."
2527 ;; Translate type of list containing POS to "d", "o" or
2529 (lambda (pos struct prevs
)
2530 (let ((type (org-list-get-list-type pos struct prevs
)))
2532 ((eq 'ordered type
) "o")
2533 ((eq 'descriptive type
) "d")
2537 ;; Return list of all items and sublists ending at POS, in
2543 (let ((end (nth 6 e
))
2546 ((= end pos
) (push item out
))
2547 ((>= item pos
) (throw 'exit nil
)))))
2550 ;; First close any previous item, or list, ending at POS.
2552 (let* ((lastp (= (org-list-get-last-item e struct prevs
) e
))
2553 (first-item (org-list-get-list-begin e struct prevs
))
2554 (type (funcall get-type first-item struct prevs
)))
2555 (org-close-par-maybe)
2556 ;; Ending for every item
2558 ;; We're ending last item of the list: end list.
2560 (insert (format "</%sl>\n" type
))
2562 (funcall get-closings pos
))
2564 ;; At an item: insert appropriate tags in export buffer.
2567 (concat "[ \t]*\\(\\S-+[ \t]*\\)"
2568 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
2569 "\\(?:\\(\\[[ X-]\\]\\)[ \t]+\\)?"
2570 "\\(?:\\(.*\\)[ \t]+::\\(?:[ \t]+\\|$\\)\\)?"
2572 (let* ((checkbox (match-string 3 line
))
2573 (desc-tag (or (match-string 4 line
) "???"))
2574 (body (or (match-string 5 line
) ""))
2575 (list-beg (org-list-get-list-begin pos struct prevs
))
2576 (firstp (= list-beg pos
))
2577 ;; Always refer to first item to determine list type, in
2578 ;; case list is ill-formed.
2579 (type (funcall get-type list-beg struct prevs
))
2580 (counter (let ((count-tmp (org-list-get-counter pos struct
)))
2582 ((not count-tmp
) nil
)
2583 ((string-match "[A-Za-z]" count-tmp
)
2584 (- (string-to-char (upcase count-tmp
)) 64))
2585 ((string-match "[0-9]+" count-tmp
)
2588 (org-close-par-maybe)
2589 (insert (format "<%sl>\n" type
)))
2592 (format "<dt>%s</dt><dd>" desc-tag
))
2593 ((and (equal type
"o") counter
)
2594 (format "<li value=\"%s\">" counter
))
2596 ;; If line had a checkbox, some additional modification is required.
2601 ((string-match "X" checkbox
) "<code>[X]</code> ")
2602 ((string-match " " checkbox
) "<code>[ ]</code> ")
2603 (t "<code>[-]</code> "))
2605 ;; Return modified line
2607 ;; At a list ender: go to next line (side-effects only).
2608 ((equal "ORG-LIST-END-MARKER" line
) (throw 'nextline nil
))
2609 ;; Not at an item: return line unchanged (side-effects only).
2614 ;;; org-html.el ends here