1 ;;; org-html.el --- HTML export for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
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 t
347 "Non-nil means insert a preamble in HTML export.
349 When `t', insert a string as defined by one of the formatting
350 strings in `org-export-html-preamble-format'. When set to a
351 string, this string overrides `org-export-html-preamble-format'.
352 When set to a function, apply this function and insert the
353 returned string. The function takes the property list of export
354 options as its only argument.
356 Setting :html-preamble in publishing projects will take
357 precedence over this variable."
358 :group
'org-export-html
359 :type
'(choice (const :tag
"No preamble" nil
)
360 (const :tag
"Default preamble" t
)
361 (string :tag
"Custom formatting string")
362 (function :tag
"Function (must return a string)")))
364 (defcustom org-export-html-preamble-format
365 '(("en" "<h1 class=\"title\">%t</h1>"))
366 "The format for the HTML preamble.
368 %t stands for the title.
370 If you need to use a \"%\" character, you need to escape it
372 :group
'org-export-html
375 (defcustom org-export-html-postamble
'auto
376 "Non-nil means insert a postamble in HTML export.
378 When `t', insert a string as defined by the formatting string in
379 `org-export-html-postamble-format'. When set to a string, this
380 string overrides `org-export-html-postamble-format'. When set to
381 'auto, discard `org-export-html-postamble-format' and honor
382 `org-export-author/email/creator-info' variables. When set to a
383 function, apply this function and insert the returned string.
384 The function takes the property list of export options as its
387 Setting :html-postamble in publishing projects will take
388 precedence over this variable."
389 :group
'org-export-html
390 :type
'(choice (const :tag
"No postamble" nil
)
391 (const :tag
"Auto preamble" 'auto
)
392 (const :tag
"Default formatting string" t
)
393 (string :tag
"Custom formatting string")
394 (function :tag
"Function (must return a string)")))
396 (defcustom org-export-html-postamble-format
397 '(("en" "<p class=\"author\">Author: %a (%e)</p>
398 <p class=\"date\">Date: %d</p>
399 <p class=\"creator\">Generated by %c</p>
400 <p class=\"xhtml-validation\">%v</p>
402 "The format for the HTML postamble.
404 %a stands for the author.
405 %e stands for the email(s).
406 %d stands for the date.
407 %c will be replaced by information about Org/Emacs.
408 %v will be replaced by `org-export-html-validation-link'.
410 If you need to use a \"%\" character, you need to escape it
412 :group
'org-export-html
415 (defcustom org-export-html-home
/up-format
416 "<div id=\"org-div-home-and-up\" style=\"text-align:right;font-size:70%%;white-space:nowrap;\">
417 <a accesskey=\"h\" href=\"%s\"> UP </a>
419 <a accesskey=\"H\" href=\"%s\"> HOME </a>
421 "Snippet used to insert the HOME and UP links.
422 This is a format string, the first %s will receive the UP link,
423 the second the HOME link. If both `org-export-html-link-up' and
424 `org-export-html-link-home' are empty, the entire snippet will be
426 :group
'org-export-html
429 (defcustom org-export-html-toplevel-hlevel
2
430 "The <H> level for level 1 headings in HTML export.
431 This is also important for the classes that will be wrapped around headlines
432 and outline structure. If this variable is 1, the top-level headlines will
433 be <h1>, and the corresponding classes will be outline-1, section-number-1,
434 and outline-text-1. If this is 2, all of these will get a 2 instead.
435 The default for this variable is 2, because we use <h1> for formatting the
437 :group
'org-export-html
440 (defcustom org-export-html-link-org-files-as-html t
441 "Non-nil means make file links to `file.org' point to `file.html'.
442 When org-mode is exporting an org-mode file to HTML, links to
443 non-html files are directly put into a href tag in HTML.
444 However, links to other Org-mode files (recognized by the
445 extension `.org.) should become links to the corresponding html
446 file, assuming that the linked org-mode file will also be
448 When nil, the links still point to the plain `.org' file."
449 :group
'org-export-html
452 (defcustom org-export-html-inline-images
'maybe
453 "Non-nil means inline images into exported HTML pages.
454 This is done using an <img> tag. When nil, an anchor with href is used to
455 link to the image. If this option is `maybe', then images in links with
456 an empty description will be inlined, while images with a description will
458 :group
'org-export-html
459 :type
'(choice (const :tag
"Never" nil
)
460 (const :tag
"Always" t
)
461 (const :tag
"When there is no description" maybe
)))
463 (defcustom org-export-html-inline-image-extensions
464 '("png" "jpeg" "jpg" "gif" "svg")
465 "Extensions of image files that can be inlined into HTML."
466 :group
'org-export-html
467 :type
'(repeat (string :tag
"Extension")))
469 (defcustom org-export-html-table-tag
470 "<table border=\"2\" cellspacing=\"0\" cellpadding=\"6\" rules=\"groups\" frame=\"hsides\">"
471 "The HTML tag that is used to start a table.
472 This must be a <table> tag, but you may change the options like
473 borders and spacing."
474 :group
'org-export-html
477 (defcustom org-export-table-header-tags
'("<th scope=\"%s\"%s>" .
"</th>")
478 "The opening tag for table header fields.
479 This is customizable so that alignment options can be specified.
480 The first %s will be filled with the scope of the field, either row or col.
481 The second %s will be replaced by a style entry to align the field.
482 See also the variable `org-export-html-table-use-header-tags-for-first-column'.
483 See also the variable `org-export-html-table-align-individual-fields'."
484 :group
'org-export-tables
485 :type
'(cons (string :tag
"Opening tag") (string :tag
"Closing tag")))
487 (defcustom org-export-table-data-tags
'("<td%s>" .
"</td>")
488 "The opening tag for table data fields.
489 This is customizable so that alignment options can be specified.
490 The first %s will be filled with the scope of the field, either row or col.
491 The second %s will be replaced by a style entry to align the field.
492 See also the variable `org-export-html-table-align-individual-fields'."
493 :group
'org-export-tables
494 :type
'(cons (string :tag
"Opening tag") (string :tag
"Closing tag")))
496 (defcustom org-export-table-row-tags
'("<tr>" .
"</tr>")
497 "The opening tag for table data fields.
498 This is customizable so that alignment options can be specified.
499 Instead of strings, these can be Lisp forms that will be evaluated
500 for each row in order to construct the table row tags. During evaluation,
501 the variable `head' will be true when this is a header line, nil when this
502 is a body line. And the variable `nline' will contain the line number,
503 starting from 1 in the first header line. For example
505 (setq org-export-table-row-tags
508 (if (= (mod nline 2) 1)
509 \"<tr class=\\\"tr-odd\\\">\"
510 \"<tr class=\\\"tr-even\\\">\"))
513 will give even lines the class \"tr-even\" and odd lines the class \"tr-odd\"."
514 :group
'org-export-tables
516 (choice :tag
"Opening tag"
517 (string :tag
"Specify")
519 (choice :tag
"Closing tag"
520 (string :tag
"Specify")
523 (defcustom org-export-html-table-align-individual-fields t
524 "Non-nil means attach style attributes for alignment to each table field.
525 When nil, alignment will only be specified in the column tags, but this
526 is ignored by some browsers (like Firefox, Safari). Opera does it right
528 :group
'org-export-tables
531 (defcustom org-export-html-table-use-header-tags-for-first-column nil
532 "Non-nil means format column one in tables with header tags.
533 When nil, also column one will use data tags."
534 :group
'org-export-tables
537 (defcustom org-export-html-validation-link
538 "<a href=\"http://validator.w3.org/check?uri=referer\">Validate XHTML 1.0</a>"
539 "Link to HTML validation service."
540 :group
'org-export-html
543 (defcustom org-export-html-with-timestamp nil
544 "If non-nil, write timestamp into the exported HTML text.
545 If non-nil, write `org-export-html-html-helper-timestamp' into the
546 exported HTML text. Otherwise, the buffer will just be saved to
548 :group
'org-export-html
551 (defcustom org-export-html-html-helper-timestamp
552 "<br/><br/><hr/><p><!-- hhmts start --> <!-- hhmts end --></p>\n"
553 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
554 :group
'org-export-html
557 (defcustom org-export-html-protect-char-alist
561 "Alist of characters to be converted by `org-html-protect'."
562 :type
'(repeat (cons (string :tag
"Character")
563 (string :tag
"HTML equivalent"))))
565 (defgroup org-export-htmlize nil
566 "Options for processing examples with htmlize.el."
567 :tag
"Org Export Htmlize"
568 :group
'org-export-html
)
570 (defcustom org-export-htmlize-output-type
'inline-css
571 "Output type to be used by htmlize when formatting code snippets.
572 Choices are `css', to export the CSS selectors only, or `inline-css', to
573 export the CSS attribute values inline in the HTML. We use as default
574 `inline-css', in order to make the resulting HTML self-containing.
576 However, this will fail when using Emacs in batch mode for export, because
577 then no rich font definitions are in place. It will also not be good if
578 people with different Emacs setup contribute HTML files to a website,
579 because the fonts will represent the individual setups. In these cases,
580 it is much better to let Org/Htmlize assign classes only, and to use
581 a style file to define the look of these classes.
582 To get a start for your css file, start Emacs session and make sure that
583 all the faces you are interested in are defined, for example by loading files
584 in all modes you want. Then, use the command
585 \\[org-export-htmlize-generate-css] to extract class definitions."
586 :group
'org-export-htmlize
587 :type
'(choice (const css
) (const inline-css
)))
589 (defcustom org-export-htmlize-css-font-prefix
"org-"
590 "The prefix for CSS class names for htmlize font specifications."
591 :group
'org-export-htmlize
594 (defcustom org-export-htmlized-org-css-url nil
595 "URL pointing to a CSS file defining text colors for htmlized Emacs buffers.
596 Normally when creating an htmlized version of an Org buffer, htmlize will
597 create CSS to define the font colors. However, this does not work when
598 converting in batch mode, and it also can look bad if different people
599 with different fontification setup work on the same website.
600 When this variable is non-nil, creating an htmlized version of an Org buffer
601 using `org-export-as-org' will remove the internal CSS section and replace it
602 with a link to this URL."
603 :group
'org-export-htmlize
605 (const :tag
"Keep internal css" nil
)
606 (string :tag
"URL or local href")))
608 (defcustom org-export-content-div
"content"
609 "The name of the container DIV that holds all the page contents."
610 :group
'org-export-htmlize
615 (defvar org-export-html-after-blockquotes-hook nil
616 "Hook run during HTML export, after blockquote, verse, center are done.")
618 (defvar org-export-html-final-hook nil
619 "Hook run at the end of HTML export, in the new buffer.")
623 (defun org-export-html-preprocess (parameters)
624 "Convert LaTeX fragments to images."
625 (when (and org-current-export-file
626 (plist-get parameters
:LaTeX-fragments
))
628 (concat "ltxpng/" (file-name-sans-extension
629 (file-name-nondirectory
630 org-current-export-file
)))
631 org-current-export-dir nil
"Creating LaTeX image %s"
634 ((eq (plist-get parameters
:LaTeX-fragments
) 'verbatim
) 'verbatim
)
635 ((eq (plist-get parameters
:LaTeX-fragments
) 'mathjax
) 'mathjax
)
636 ((eq (plist-get parameters
:LaTeX-fragments
) t
) 'mathjax
)
637 ((eq (plist-get parameters
:LaTeX-fragments
) 'dvipng
) 'dvipng
)
639 (goto-char (point-min))
641 (while (re-search-forward "\\\\ref{\\([^{}\n]+\\)}" nil t
)
642 (org-if-unprotected-at (match-beginning 1)
643 (setq label
(match-string 1))
645 (if (string-match "\\`[a-z]\\{1,10\\}:\\(.+\\)" label
)
646 (setq l1
(substring label
(match-beginning 1)))
648 (replace-match (format "[[#%s][%s]]" label l1
) t t
)))))
651 (defun org-export-as-html-and-open (arg)
652 "Export the outline as HTML and immediately open it with a browser.
653 If there is an active region, export only the region.
654 The prefix ARG specifies how many levels of the outline should become
655 headlines. The default is 3. Lower levels will become bulleted lists."
657 (org-export-as-html arg
'hidden
)
658 (org-open-file buffer-file-name
)
659 (when org-export-kill-product-buffer-when-displayed
660 (kill-buffer (current-buffer))))
663 (defun org-export-as-html-batch ()
664 "Call the function `org-export-as-html'.
665 This function can be used in batch processing as:
667 --load=$HOME/lib/emacs/org.el
668 --eval \"(setq org-export-headline-levels 2)\"
669 --visit=MyFile --funcall org-export-as-html-batch"
670 (org-export-as-html org-export-headline-levels
'hidden
))
673 (defun org-export-as-html-to-buffer (arg)
674 "Call `org-export-as-html` with output to a temporary buffer.
675 No file is created. The prefix ARG is passed through to `org-export-as-html'."
677 (org-export-as-html arg nil nil
"*Org HTML Export*")
678 (when org-export-show-temporary-export-buffer
679 (switch-to-buffer-other-window "*Org HTML Export*")))
682 (defun org-replace-region-by-html (beg end
)
683 "Assume the current region has org-mode syntax, and convert it to HTML.
684 This can be used in any buffer. For example, you could write an
685 itemized list in org-mode syntax in an HTML buffer and then use this
686 command to convert it."
688 (let (reg html buf pop-up-frames
)
689 (save-window-excursion
691 (setq html
(org-export-region-as-html
693 (setq reg
(buffer-substring beg end
)
694 buf
(get-buffer-create "*Org tmp*"))
695 (with-current-buffer buf
699 (setq html
(org-export-region-as-html
700 (point-min) (point-max) t
'string
)))
702 (delete-region beg end
)
706 (defun org-export-region-as-html (beg end
&optional body-only buffer
)
707 "Convert region from BEG to END in org-mode buffer to HTML.
708 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
709 contents, and only produce the region of converted text, useful for
710 cut-and-paste operations.
711 If BUFFER is a buffer or a string, use/create that buffer as a target
712 of the converted HTML. If BUFFER is the symbol `string', return the
713 produced HTML as a string and leave not buffer behind. For example,
714 a Lisp program could call this function in the following way:
716 (setq html (org-export-region-as-html beg end t 'string))
718 When called interactively, the output buffer is selected, and shown
719 in a window. A non-interactive call will only return the buffer."
721 (when (interactive-p)
722 (setq buffer
"*Org HTML Export*"))
723 (let ((transient-mark-mode t
) (zmacs-regions t
)
725 (setq ext-plist
(plist-put ext-plist
:ignore-subtree-p t
))
727 (set-mark (point)) ;; to activate the region
729 (setq rtn
(org-export-as-html
732 (if (fboundp 'deactivate-mark
) (deactivate-mark))
733 (if (and (interactive-p) (bufferp rtn
))
734 (switch-to-buffer-other-window rtn
)
737 (defvar html-table-tag nil
) ; dynamically scoped into this.
738 (defvar org-par-open nil
)
740 ;;; org-html-cvt-link-fn
741 (defconst org-html-cvt-link-fn
743 "Function to convert link URLs to exportable URLs.
744 Takes two arguments, TYPE and PATH.
745 Returns exportable url as (TYPE PATH), or nil to signal that it
746 didn't handle this case.
747 Intended to be locally bound around a call to `org-export-as-html'." )
749 (defun org-html-cvt-org-as-html (opt-plist type path
)
750 "Convert an org filename to an equivalent html filename.
751 If TYPE is not file, just return `nil'.
752 See variable `org-export-html-link-org-files-as-html'"
756 org-export-html-link-org-files-as-html
757 (string= type
"file")
758 (string-match "\\.org$" path
)
763 (substring path
0 (match-beginning 0))
765 (plist-get opt-plist
:html-extension
)))))))
768 ;;; org-html-should-inline-p
769 (defun org-html-should-inline-p (filename descp
)
770 "Return non-nil if link FILENAME should be inlined.
771 The decision to inline the FILENAME link is based on the current
772 settings. DESCP is the boolean of whether there was a link
773 description. See variables `org-export-html-inline-images' and
774 `org-export-html-inline-image-extensions'."
776 org-export-html-inline-images
777 org-export-html-inline-image-extensions
))
778 (and (or (eq t org-export-html-inline-images
)
779 (and org-export-html-inline-images
(not descp
)))
781 filename org-export-html-inline-image-extensions
)))
783 ;;; org-html-make-link
784 (defun org-html-make-link (opt-plist type path fragment desc attr
787 OPT-PLIST is an options list.
788 TYPE is the device-type of the link (THIS://foo.html)
789 PATH is the path of the link (http://THIS#locationx)
790 FRAGMENT is the fragment part of the link, if any (foo.html#THIS)
791 DESC is the link description, if any.
792 ATTR is a string of other attributes of the a element.
793 MAY-INLINE-P allows inlining it as an image."
795 (declare (special org-par-open
))
797 (let* ((filename path
)
798 ;;First pass. Just sanity stuff.
801 ((string= type
"file")
804 ;;Substitute just if original path was absolute.
805 ;;(Otherwise path must remain relative)
806 (if (file-name-absolute-p path
)
807 (concat "file://" (expand-file-name path
))
811 (t (list type path
))))
813 ;;Second pass. Components converted so they can refer
817 (and org-html-cvt-link-fn
818 (apply org-html-cvt-link-fn
819 opt-plist components-1
))
820 (apply #'org-html-cvt-org-as-html
821 opt-plist components-1
)
823 (type (first components-2
))
824 (thefile (second components-2
)))
827 ;;Third pass. Build final link except for leading type
832 (string= type
"http")
833 (string= type
"https")
834 (string= type
"file"))
836 (setq thefile
(concat thefile
"#" fragment
))))
840 ;;Final URL-build, for all types.
843 ((str (org-export-html-format-href thefile
)))
844 (if (and type
(not (string= "file" type
)))
845 (concat type
":" str
)
850 ;;Can't inline a URL with a fragment.
853 (message "image %s %s" thefile org-par-open
)
854 (org-export-html-format-image thefile org-par-open
))
856 "<a href=\"" thefile
"\"" (if attr
(concat " " attr
)) ">"
857 (org-export-html-format-desc desc
)
860 (defun org-html-handle-links (line opt-plist
)
861 "Return LINE with markup of Org mode links.
862 OPT-PLIST is the export options list."
864 (current-dir (if buffer-file-name
865 (file-name-directory buffer-file-name
)
867 (link-validate (plist-get opt-plist
:link-validation-function
))
869 rpl path attr desc descp desc1 desc2 link
)
870 (while (string-match org-bracket-link-analytic-regexp
++ line start
)
871 (setq start
(match-beginning 0))
872 (setq path
(save-match-data (org-link-unescape
873 (match-string 3 line
))))
875 ((match-end 2) (match-string 2 line
))
877 (or (file-name-absolute-p path
)
878 (string-match "^\\.\\.?/" path
)))
881 (setq path
(org-extract-attributes (org-link-unescape path
)))
882 (setq attr
(get-text-property 0 'org-attributes path
))
883 (setq desc1
(if (match-end 5) (match-string 5 line
))
884 desc2
(if (match-end 2) (concat type
":" path
) path
)
885 descp
(and desc1
(not (equal desc1 desc2
)))
886 desc
(or desc1 desc2
))
887 ;; Make an image out of the description if that is so wanted
888 (when (and descp
(org-file-image-p
889 desc org-export-html-inline-image-extensions
))
891 (if (string-match "^file:" desc
)
892 (setq desc
(substring desc
(match-end 0)))))
893 (setq desc
(org-add-props
894 (concat "@<img src=\"" desc
"\"/>")
895 '(org-protected t
))))
897 ((equal type
"internal")
900 (if (= (string-to-char path
) ?
#)
908 (org-solidify-link-text
909 (save-match-data (org-link-unescape frag-0
))
912 ((and (equal type
"id")
913 (setq id-file
(org-id-find-id-file path
)))
914 ;; This is an id: link to another file (if it was the same file,
915 ;; it would have become an internal link...)
917 (setq id-file
(file-relative-name
919 (file-name-directory org-current-export-file
)))
921 (org-html-make-link opt-plist
923 (concat (if (org-uuidgen-p path
) "ID-") path
)
927 ((member type
'("http" "https"))
928 ;; standard URL, can inline as image
930 (org-html-make-link opt-plist
934 (org-html-should-inline-p path descp
))))
935 ((member type
'("ftp" "mailto" "news"))
936 ;; standard URL, can't inline as image
938 (org-html-make-link opt-plist
944 ((string= type
"coderef")
946 ((coderef-str (format "coderef-%s" path
))
948 (format "class=\"coderef\" onmouseover=\"CodeHighlightOn(this, '%s');\" onmouseout=\"CodeHighlightOff(this, '%s');\""
949 coderef-str coderef-str
)))
951 (org-html-make-link opt-plist
954 (org-export-get-coderef-format
957 (cdr (assoc path org-export-code-refs
)))
961 ((functionp (setq fnc
(nth 2 (assoc type org-link-protocols
))))
962 ;; The link protocol has a function for format the link
965 (funcall fnc
(org-link-unescape path
) desc1
'html
))))
967 ((string= type
"file")
973 (string-match "::\\(.*\\)" path
)
975 (replace-match "" t nil path
)
976 (match-string 1 path
))
979 ;;The proper path, without a fragment
987 ;;Check the fragment. If it can't be used as
988 ;;target fragment we'll pass nil instead.
992 (not (string-match "^[0-9]*$" fragment-0
))
993 (not (string-match "^\\*" fragment-0
))
994 (not (string-match "^/.*/$" fragment-0
)))
995 (org-solidify-link-text
996 (org-link-unescape fragment-0
))
999 ;;Description minus "file:" and ".org"
1000 (if (string-match "^file:" desc
)
1002 ((desc-1 (replace-match "" t t desc
)))
1003 (if (string-match "\\.org$" desc-1
)
1004 (replace-match "" t t desc-1
)
1011 (functionp link-validate
)
1012 (not (funcall link-validate path-1 current-dir
)))
1014 (org-html-make-link opt-plist
1015 "file" path-1 fragment-1 desc-2 attr
1016 (org-html-should-inline-p path-1 descp
)))))))
1019 ;; just publish the path, as default
1020 (setq rpl
(concat "@<i><" type
":"
1021 (save-match-data (org-link-unescape path
))
1023 (setq line
(replace-match rpl t t line
)
1024 start
(+ start
(length rpl
))))
1027 ;;; org-export-as-html
1029 (defun org-export-as-html (arg &optional hidden ext-plist
1030 to-buffer body-only pub-dir
)
1031 "Export the outline as a pretty HTML file.
1032 If there is an active region, export only the region. The prefix
1033 ARG specifies how many levels of the outline should become
1034 headlines. The default is 3. Lower levels will become bulleted
1035 lists. HIDDEN is obsolete and does nothing.
1036 EXT-PLIST is a property list with external parameters overriding
1037 org-mode's default settings, but still inferior to file-local
1038 settings. When TO-BUFFER is non-nil, create a buffer with that
1039 name and export to that buffer. If TO-BUFFER is the symbol
1040 `string', don't leave any buffer behind but just return the
1041 resulting HTML as a string. When BODY-ONLY is set, don't produce
1042 the file header and footer, simply return the content of
1043 <body>...</body>, without even the body tags themselves. When
1044 PUB-DIR is set, use this as the publishing directory."
1046 (run-hooks 'org-export-first-hook
)
1048 ;; Make sure we have a file name when we need it.
1049 (when (and (not (or to-buffer body-only
))
1050 (not buffer-file-name
))
1051 (if (buffer-base-buffer)
1052 (org-set-local 'buffer-file-name
1053 (with-current-buffer (buffer-base-buffer)
1055 (error "Need a file name to be able to export")))
1057 (message "Exporting...")
1058 (setq-default org-todo-line-regexp org-todo-line-regexp
)
1059 (setq-default org-deadline-line-regexp org-deadline-line-regexp
)
1060 (setq-default org-done-keywords org-done-keywords
)
1061 (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp
)
1063 (org-export-process-option-filters
1064 (org-combine-plists (org-default-export-plist)
1066 (org-infile-export-plist))))
1067 (body-only (or body-only
(plist-get opt-plist
:body-only
)))
1068 (style (concat (if (plist-get opt-plist
:style-include-default
)
1069 org-export-html-style-default
)
1070 (plist-get opt-plist
:style
)
1071 (plist-get opt-plist
:style-extra
)
1073 (if (plist-get opt-plist
:style-include-scripts
)
1074 org-export-html-scripts
)))
1075 (html-extension (plist-get opt-plist
:html-extension
))
1076 valid thetoc have-headings first-heading-pos
1077 (odd org-odd-levels-only
)
1078 (region-p (org-region-active-p))
1079 (rbeg (and region-p
(region-beginning)))
1080 (rend (and region-p
(region-end)))
1082 (if (plist-get opt-plist
:ignore-subtree-p
)
1087 (and (org-at-heading-p)
1088 (>= (org-end-of-subtree t t
) rend
))))))
1089 (level-offset (if subtree-p
1092 (+ (funcall outline-level
)
1093 (if org-odd-levels-only
1 0)))
1095 (opt-plist (setq org-export-opt-plist
1097 (org-export-add-subtree-options opt-plist rbeg
)
1099 ;; The following two are dynamically scoped into other
1101 (org-current-export-dir
1102 (or pub-dir
(org-export-directory :html opt-plist
)))
1103 (org-current-export-file buffer-file-name
)
1104 (level 0) (line "") (origline "") txt todo
1107 (filename (if to-buffer nil
1110 (file-name-sans-extension
1112 (org-entry-get (region-beginning)
1113 "EXPORT_FILE_NAME" t
))
1114 (file-name-nondirectory buffer-file-name
)))
1116 (file-name-as-directory
1117 (or pub-dir
(org-export-directory :html opt-plist
))))))
1118 (current-dir (if buffer-file-name
1119 (file-name-directory buffer-file-name
)
1121 (buffer (if to-buffer
1123 ((eq to-buffer
'string
) (get-buffer-create "*Org HTML Export*"))
1124 (t (get-buffer-create to-buffer
)))
1125 (find-file-noselect filename
)))
1126 (org-levels-open (make-vector org-level-max nil
))
1127 (date (plist-get opt-plist
:date
))
1128 (author (plist-get opt-plist
:author
))
1129 (html-validation-link (or org-export-html-validation-link
""))
1130 (title (org-html-expand
1131 (or (and subtree-p
(org-export-get-title-from-subtree))
1132 (plist-get opt-plist
:title
)
1133 (and (not body-only
)
1135 (plist-get opt-plist
:skip-before-1st-heading
))
1136 (org-export-grab-title-from-buffer))
1137 (and buffer-file-name
1138 (file-name-sans-extension
1139 (file-name-nondirectory buffer-file-name
)))
1141 (link-up (and (plist-get opt-plist
:link-up
)
1142 (string-match "\\S-" (plist-get opt-plist
:link-up
))
1143 (plist-get opt-plist
:link-up
)))
1144 (link-home (and (plist-get opt-plist
:link-home
)
1145 (string-match "\\S-" (plist-get opt-plist
:link-home
))
1146 (plist-get opt-plist
:link-home
)))
1147 (dummy (setq opt-plist
(plist-put opt-plist
:title title
)))
1148 (html-table-tag (plist-get opt-plist
:html-table-tag
))
1149 (quote-re0 (concat "^[ \t]*" org-quote-string
"\\>"))
1150 (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string
"\\>\\)"))
1154 (email (plist-get opt-plist
:email
))
1155 (language (plist-get opt-plist
:language
))
1156 (keywords (plist-get opt-plist
:keywords
))
1157 (description (plist-get opt-plist
:description
))
1161 (coding-system (and (boundp 'buffer-file-coding-system
)
1162 buffer-file-coding-system
))
1163 (coding-system-for-write (or org-export-html-coding-system
1165 (save-buffer-coding-system (or org-export-html-coding-system
1167 (charset (and coding-system-for-write
1168 (fboundp 'coding-system-get
)
1169 (coding-system-get coding-system-for-write
1173 (if region-p
(region-beginning) (point-min))
1174 (if region-p
(region-end) (point-max))))
1175 (org-export-have-math nil
)
1178 (org-export-preprocess-string
1182 :skip-before-1st-heading
1183 (plist-get opt-plist
:skip-before-1st-heading
)
1184 :drawers
(plist-get opt-plist
:drawers
)
1185 :todo-keywords
(plist-get opt-plist
:todo-keywords
)
1186 :tasks
(plist-get opt-plist
:tasks
)
1187 :tags
(plist-get opt-plist
:tags
)
1188 :priority
(plist-get opt-plist
:priority
)
1189 :footnotes
(plist-get opt-plist
:footnotes
)
1190 :timestamps
(plist-get opt-plist
:timestamps
)
1192 (plist-get opt-plist
:archived-trees
)
1193 :select-tags
(plist-get opt-plist
:select-tags
)
1194 :exclude-tags
(plist-get opt-plist
:exclude-tags
)
1196 (plist-get opt-plist
:text
)
1198 (plist-get opt-plist
:LaTeX-fragments
))
1201 (if (or (eq (plist-get opt-plist
:LaTeX-fragments
) 'mathjax
)
1202 (and org-export-have-math
1203 (eq (plist-get opt-plist
:LaTeX-fragments
) t
)))
1205 (org-export-html-mathjax-config
1206 org-export-html-mathjax-template
1207 org-export-html-mathjax-options
1208 (or (plist-get opt-plist
:mathjax
) ""))
1211 table-buffer table-orig-buffer
1213 rpl path attr desc descp desc1 desc2 link
1215 footnotes footref-seen
1219 (let ((inhibit-read-only t
))
1221 (remove-text-properties (point-min) (point-max)
1222 '(:org-license-to-kill t
))))
1224 (message "Exporting...")
1226 (setq org-min-level
(org-get-min-level lines level-offset
))
1227 (setq org-last-level org-min-level
)
1228 (org-init-section-numbers)
1231 ((and date
(string-match "%" date
))
1232 (setq date
(format-time-string date
)))
1234 (t (setq date
(format-time-string "%Y-%m-%d %T %Z"))))
1236 ;; Get the language-dependent settings
1237 (setq lang-words
(or (assoc language org-export-language-setup
)
1238 (assoc "en" org-export-language-setup
)))
1240 ;; Switch to the output buffer
1242 (let ((inhibit-read-only t
)) (erase-buffer))
1244 (org-install-letbind)
1246 (and (fboundp 'set-buffer-file-coding-system
)
1247 (set-buffer-file-coding-system coding-system-for-write
))
1249 (let ((case-fold-search nil
)
1250 (org-odd-levels-only odd
))
1251 ;; create local variables for all options, to make sure all called
1252 ;; functions get the correct information
1254 (set (make-local-variable (nth 2 x
))
1255 (plist-get opt-plist
(car x
))))
1256 org-export-plist-vars
)
1257 (setq umax
(if arg
(prefix-numeric-value arg
)
1258 org-export-headline-levels
))
1259 (setq umax-toc
(if (integerp org-export-with-toc
)
1260 (min org-export-with-toc umax
)
1266 <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
1267 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
1268 <html xmlns=\"http://www.w3.org/1999/xhtml\"
1269 lang=\"%s\" xml:lang=\"%s\">
1272 <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
1273 <meta name=\"generator\" content=\"Org-mode\"/>
1274 <meta name=\"generated\" content=\"%s\"/>
1275 <meta name=\"author\" content=\"%s\"/>
1276 <meta name=\"description\" content=\"%s\"/>
1277 <meta name=\"keywords\" content=\"%s\"/>
1286 (or (and (stringp org-export-html-xml-declaration
)
1287 org-export-html-xml-declaration
)
1288 (cdr (assoc html-extension org-export-html-xml-declaration
))
1289 (cdr (assoc "html" org-export-html-xml-declaration
))
1292 (or charset
"iso-8859-1"))
1295 (or charset
"iso-8859-1")
1296 date author description keywords
1299 org-export-content-div
1300 (if (or link-up link-home
)
1302 (format org-export-html-home
/up-format
1303 (or link-up link-home
)
1304 (or link-home link-up
))
1308 ;; insert html preamble
1309 (when (plist-get opt-plist
:html-preamble
)
1310 (let ((html-pre (plist-get opt-plist
:html-preamble
)))
1311 (cond ((stringp html-pre
)
1313 (format-spec html-pre
`((?t .
,title
) (?a .
,author
)
1314 (?d .
,date
) (?e .
,email
)))))
1315 ((functionp html-pre
)
1316 (funcall html-pre opt-plist
))
1320 (or (cadr (assoc (nth 0 lang-words
)
1321 org-export-html-preamble-format
))
1322 (cadr (assoc "en" org-export-html-preamble-format
)))
1323 `((?t .
,title
) (?a .
,author
)
1324 (?d .
,date
) (?e .
,email
)))))))))
1326 (if (and org-export-with-toc
(not body-only
))
1328 (push (format "<h%d>%s</h%d>\n"
1329 org-export-html-toplevel-hlevel
1331 org-export-html-toplevel-hlevel
)
1333 (push "<div id=\"text-table-of-contents\">\n" thetoc
)
1334 (push "<ul>\n<li>" thetoc
)
1336 (mapcar '(lambda (line)
1337 (if (and (string-match org-todo-line-regexp line
)
1338 (not (get-text-property 0 'org-protected line
)))
1339 ;; This is a headline
1341 (setq have-headings t
)
1342 (setq level
(- (match-end 1) (match-beginning 1)
1344 level
(org-tr-level level
)
1345 txt
(save-match-data
1347 (org-export-cleanup-toc-line
1348 (match-string 3 line
))))
1350 (or (and org-export-mark-todo-in-toc
1352 (not (member (match-string 2 line
)
1353 org-done-keywords
)))
1355 (and org-export-mark-todo-in-toc
1357 (org-search-todo-below
1358 line lines level
))))
1360 (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt
)
1361 (setq txt
(replace-match " <span class=\"tag\"> \\1</span>" t nil txt
)))
1362 (if (string-match quote-re0 txt
)
1363 (setq txt
(replace-match "" t t txt
)))
1364 (setq snumber
(org-section-number level
))
1365 (if org-export-with-section-numbers
1366 (setq txt
(concat snumber
" " txt
)))
1367 (if (<= level
(max umax umax-toc
))
1368 (setq head-count
(+ head-count
1)))
1369 (if (<= level umax-toc
)
1371 (if (> level org-last-level
)
1373 (setq cnt
(- level org-last-level
))
1374 (while (>= (setq cnt
(1- cnt
)) 0)
1375 (push "\n<ul>\n<li>" thetoc
))
1376 (push "\n" thetoc
)))
1377 (if (< level org-last-level
)
1379 (setq cnt
(- org-last-level level
))
1380 (while (>= (setq cnt
(1- cnt
)) 0)
1381 (push "</li>\n</ul>" thetoc
))
1382 (push "\n" thetoc
)))
1383 ;; Check for targets
1384 (while (string-match org-any-target-regexp line
)
1385 (setq line
(replace-match
1386 (concat "@<span class=\"target\">" (match-string 1 line
) "@</span> ")
1388 (while (string-match "<\\(<\\)+\\|>\\(>\\)+" txt
)
1389 (setq txt
(replace-match "" t t txt
)))
1391 (replace-regexp-in-string
1392 "\\." "_" (format "sec-%s" snumber
)))
1393 (setq href
(org-solidify-link-text (or (cdr (assoc href org-export-preferred-target-alist
)) href
)))
1397 "</li>\n<li><a href=\"#%s\"><span class=\"todo\">%s</span></a>"
1398 "</li>\n<li><a href=\"#%s\">%s</a>")
1401 (setq org-last-level level
))
1405 (while (> org-last-level
(1- org-min-level
))
1406 (setq org-last-level
(1- org-last-level
))
1407 (push "</li>\n</ul>\n" thetoc
))
1408 (push "</div>\n" thetoc
)
1409 (setq thetoc
(if have-headings
(nreverse thetoc
) nil
))))
1412 (org-init-section-numbers)
1416 (while (setq line
(pop lines
) origline line
)
1419 ;; end of quote section?
1420 (when (and inquote
(string-match "^\\*+ " line
))
1424 ;; inside a quote section?
1426 (insert (org-html-protect line
) "\n")
1427 (throw 'nextline nil
))
1429 ;; Fixed-width, verbatim lines (examples)
1430 (when (and org-export-with-fixed-width
1431 (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line
))
1434 (org-close-par-maybe)
1436 (insert "<pre class=\"example\">\n"))
1437 (insert (org-html-protect (match-string 3 line
)) "\n")
1438 (when (or (not lines
)
1439 (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
1444 (throw 'nextline nil
))
1447 (when (and (get-text-property 0 'org-protected line
)
1448 ;; Make sure it is the entire line that is protected
1449 (not (< (or (next-single-property-change
1450 0 'org-protected line
) 10000)
1452 (let (par (ind (get-text-property 0 'original-indentation line
)))
1453 (when (re-search-backward
1454 "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t
)
1455 (setq par
(match-string 1))
1456 (replace-match "\\2\n"))
1459 (or (= (length (car lines
)) 0)
1461 (equal ind
(get-text-property 0 'original-indentation
(car lines
))))
1462 (or (= (length (car lines
)) 0)
1463 (get-text-property 0 'org-protected
(car lines
))))
1464 (insert (pop lines
) "\n"))
1465 (and par
(insert "<p>\n")))
1466 (throw 'nextline nil
))
1468 ;; Blockquotes, verse, and center
1469 (when (equal "ORG-BLOCKQUOTE-START" line
)
1470 (org-close-par-maybe)
1471 (insert "<blockquote>\n")
1473 (throw 'nextline nil
))
1474 (when (equal "ORG-BLOCKQUOTE-END" line
)
1475 (org-close-par-maybe)
1476 (insert "\n</blockquote>\n")
1478 (throw 'nextline nil
))
1479 (when (equal "ORG-VERSE-START" line
)
1480 (org-close-par-maybe)
1481 (insert "\n<p class=\"verse\">\n")
1482 (setq org-par-open t
)
1484 (throw 'nextline nil
))
1485 (when (equal "ORG-VERSE-END" line
)
1487 (setq org-par-open nil
)
1490 (throw 'nextline nil
))
1491 (when (equal "ORG-CENTER-START" line
)
1492 (org-close-par-maybe)
1493 (insert "\n<div style=\"text-align: center\">")
1495 (throw 'nextline nil
))
1496 (when (equal "ORG-CENTER-END" line
)
1497 (org-close-par-maybe)
1500 (throw 'nextline nil
))
1501 (run-hooks 'org-export-html-after-blockquotes-hook
)
1503 (let ((i (org-get-string-indentation line
)))
1505 (setq line
(concat (mapconcat 'identity
1506 (make-list (* 2 i
) "\\nbsp") "")
1507 " " (org-trim line
))))
1508 (unless (string-match "\\\\\\\\[ \t]*$" line
)
1509 (setq line
(concat line
"\\\\")))))
1511 ;; make targets to anchors
1513 (while (string-match
1514 "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start
)
1516 ((get-text-property (match-beginning 1) 'org-protected line
)
1517 (setq start
(match-end 1)))
1519 (setq line
(replace-match
1521 "@<a name=\"%s\" id=\"%s\">@</a>"
1522 (org-solidify-link-text (match-string 1 line
))
1523 (org-solidify-link-text (match-string 1 line
)))
1525 ((and org-export-with-toc
(equal (string-to-char line
) ?
*))
1526 ;; FIXME: NOT DEPENDENT on TOC?????????????????????
1527 (setq line
(replace-match
1528 (concat "@<span class=\"target\">"
1529 (match-string 1 line
) "@</span> ")
1530 ;; (concat "@<i>" (match-string 1 line) "@</i> ")
1533 (setq line
(replace-match
1534 (concat "@<a name=\""
1535 (org-solidify-link-text (match-string 1 line
))
1536 "\" class=\"target\">" (match-string 1 line
)
1540 (setq line
(org-html-handle-time-stamps line
))
1542 ;; replace "&" by "&", "<" and ">" by "<" and ">"
1543 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
1544 ;; Also handle sub_superscripts and checkboxes
1545 (or (string-match org-table-hline-regexp line
)
1546 (string-match "^[ \t]*\\([+]-\\||[ ]\\)[-+ |]*[+|][ \t]*$" line
)
1547 (setq line
(org-html-expand line
)))
1550 (setq line
(org-html-handle-links line opt-plist
))
1553 (if (and (string-match org-todo-line-regexp line
)
1554 (match-beginning 2))
1557 (concat (substring line
0 (match-beginning 2))
1559 (if (member (match-string 2 line
)
1562 " " (match-string 2 line
)
1563 "\"> " (org-export-html-get-todo-kwd-class-name
1564 (match-string 2 line
))
1565 "</span>" (substring line
(match-end 2)))))
1567 ;; Does this contain a reference to a footnote?
1568 (when org-export-with-footnotes
1570 (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start
)
1571 (if (get-text-property (match-beginning 2) 'org-protected line
)
1572 (setq start
(match-end 2))
1573 (let ((n (match-string 2 line
)) extra a
)
1574 (if (setq a
(assoc n footref-seen
))
1576 (setcdr a
(1+ (cdr a
)))
1577 (setq extra
(format ".%d" (cdr a
))))
1579 (push (cons n
1) footref-seen
))
1584 (format org-export-html-footnote-format
1585 "<a class=\"footref\" name=\"fnr.%s%s\" href=\"#fn.%s\">%s</a>"))
1586 (or (match-string 1 line
) "") n extra n n
)
1590 ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line
)
1591 ;; This is a headline
1592 (setq level
(org-tr-level (- (match-end 1) (match-beginning 1)
1594 txt
(match-string 2 line
))
1595 (if (string-match quote-re0 txt
)
1596 (setq txt
(replace-match "" t t txt
)))
1597 (if (<= level
(max umax umax-toc
))
1598 (setq head-count
(+ head-count
1)))
1599 (setq first-heading-pos
(or first-heading-pos
(point)))
1600 (org-html-level-start level txt umax
1601 (and org-export-with-toc
(<= level umax
))
1605 (when (string-match quote-re line
)
1606 (org-close-par-maybe)
1610 ((and org-export-with-tables
1611 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line
))
1612 (when (not table-open
)
1614 (setq table-open t table-buffer nil table-orig-buffer nil
))
1617 (setq table-buffer
(cons line table-buffer
)
1618 table-orig-buffer
(cons origline table-orig-buffer
))
1619 (when (or (not lines
)
1620 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
1622 (setq table-open nil
1623 table-buffer
(nreverse table-buffer
)
1624 table-orig-buffer
(nreverse table-orig-buffer
))
1625 (org-close-par-maybe)
1626 (insert (org-format-table-html table-buffer table-orig-buffer
))))
1631 ;; This line either is list item or end a list.
1632 (when (get-text-property 0 'list-item line
)
1633 (setq line
(org-html-export-list-line
1635 (get-text-property 0 'list-item line
)
1636 (get-text-property 0 'list-struct line
)
1637 (get-text-property 0 'list-prevs line
))))
1640 (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line
)
1642 (insert "\n</p>\n<hr/>\n<p>\n")
1643 (insert "\n<hr/>\n"))
1644 (throw 'nextline nil
))
1646 ;; Empty lines start a new paragraph. If hand-formatted lists
1647 ;; are not fully interpreted, lines starting with "-", "+", "*"
1648 ;; also start a new paragraph.
1649 (if (string-match "^ [-+*]-\\|^[ \t]*$" line
) (org-open-par))
1651 ;; Is this the start of a footnote?
1652 (when org-export-with-footnotes
1653 (when (and (boundp 'footnote-section-tag-regexp
)
1654 (string-match (concat "^" footnote-section-tag-regexp
)
1657 (throw 'nextline nil
))
1658 (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line
)
1659 (org-close-par-maybe)
1660 (let ((n (match-string 1 line
)))
1661 (setq org-par-open t
1664 (concat "<p class=\"footnote\">"
1665 (format org-export-html-footnote-format
1666 "<a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a>"))
1667 n n n
) t t line
)))))
1668 ;; Check if the line break needs to be conserved
1670 ((string-match "\\\\\\\\[ \t]*$" line
)
1671 (setq line
(replace-match "<br/>" t t line
)))
1672 (org-export-preserve-breaks
1673 (setq line
(concat line
"<br/>"))))
1675 ;; Check if a paragraph should be started
1677 (while (and org-par-open
1678 (string-match "\\\\par\\>" line start
))
1679 ;; Leave a space in the </p> so that the footnote matcher
1680 ;; does not see this.
1681 (if (not (get-text-property (match-beginning 0)
1682 'org-protected line
))
1683 (setq line
(replace-match "</p ><p >" t t line
)))
1684 (setq start
(match-end 0))))
1686 (insert line
"\n")))))
1688 ;; Properly close all local lists and other lists
1693 (org-html-level-start 1 nil umax
1694 (and org-export-with-toc
(<= level umax
))
1696 ;; the </div> to close the last text-... div.
1697 (when (and (> umax
0) first-heading-pos
) (insert "</div>\n"))
1700 (goto-char (point-min))
1701 (while (re-search-forward "<p class=\"footnote\">[^\000]*?\\(</p>\\|\\'\\)" nil t
)
1702 (push (match-string 0) footnotes
)
1703 (replace-match "" t t
)))
1705 (insert (format org-export-html-footnotes-section
1707 (mapconcat 'identity
(nreverse footnotes
) "\n"))
1709 (let ((bib (org-export-html-get-bibliography)))
1711 (insert "\n" bib
"\n")))
1713 ;; export html postamble
1715 (let ((html-post (plist-get opt-plist
:html-postamble
))
1717 (mapconcat (lambda(e)
1718 (format "<a href=\"mailto:%s\">%s</a>" e e
))
1719 (split-string email
",+ *")
1722 (concat "Org version " org-version
" with Emacs version "
1723 (number-to-string emacs-major-version
))))
1724 (when (plist-get opt-plist
:html-postamble
)
1725 (cond ((stringp html-post
)
1726 (insert "<div id=\"postamble\">\n")
1727 (insert (format-spec html-post
1728 `((?a .
,author
) (?e .
,email
)
1729 (?d .
,date
) (?c .
,creator-info
)
1730 (?v .
,html-validation-link
))))
1732 ((functionp html-post
)
1733 (funcall html-post opt-plist
))
1734 ((eq html-post
'auto
)
1735 ;; fall back on default postamble
1736 (insert "<div id=\"postamble\">\n")
1737 (when (plist-get opt-plist
:time-stamp-file
)
1738 (insert "<p class=\"date\">" (nth 2 lang-words
) ": " date
"</p>\n"))
1739 (when (and (plist-get opt-plist
:author-info
) author
)
1740 (insert "<p class=\"author\">" (nth 1 lang-words
) ": " author
"</p>\n"))
1741 (when (and (plist-get opt-plist
:email-info
) email
)
1742 (insert "<p class=\"email\">" email
"</p>\n"))
1743 (when (plist-get opt-plist
:creator-info
)
1744 (insert "<p class=\"creator\">"
1745 (concat "Org version " org-version
" with Emacs version "
1746 (number-to-string emacs-major-version
) "</p>\n")))
1747 (insert html-validation-link
"\n</div>"))
1749 (insert "<div id=\"postamble\">\n")
1750 (insert (format-spec
1751 (or (cadr (assoc (nth 0 lang-words
)
1752 org-export-html-postamble-format
))
1753 (cadr (assoc "en" org-export-html-postamble-format
)))
1754 `((?a .
,author
) (?e .
,email
)
1755 (?d .
,date
) (?c .
,creator-info
)
1756 (?v .
,html-validation-link
))))
1757 (insert "</div>"))))))
1759 (if org-export-html-with-timestamp
1760 (insert org-export-html-html-helper-timestamp
))
1762 (unless body-only
(insert "\n</div>\n</body>\n</html>\n"))
1764 (unless (plist-get opt-plist
:buffer-will-be-killed
)
1766 (if (eq major-mode
(default-value 'major-mode
))
1769 ;; insert the table of contents
1770 (goto-char (point-min))
1772 (if (or (re-search-forward
1773 "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t
)
1775 "\\[TABLE-OF-CONTENTS\\]" nil t
))
1777 (goto-char (match-beginning 0))
1779 (goto-char first-heading-pos
)
1780 (when (looking-at "\\s-*</p>")
1781 (goto-char (match-end 0))
1783 (insert "<div id=\"table-of-contents\">\n")
1784 (let ((beg (point)))
1785 (mapc 'insert thetoc
)
1787 (while (re-search-backward "<li>[ \r\n\t]*</li>\n?" beg t
)
1788 (replace-match ""))))
1789 ;; remove empty paragraphs
1790 (goto-char (point-min))
1791 (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t
)
1793 (goto-char (point-min))
1794 ;; Convert whitespace place holders
1795 (goto-char (point-min))
1797 (while (setq beg
(next-single-property-change (point) 'org-whitespace
))
1798 (setq n
(get-text-property beg
'org-whitespace
)
1799 end
(next-single-property-change beg
'org-whitespace
))
1801 (delete-region beg end
)
1802 (insert (format "<span style=\"visibility:hidden;\">%s</span>"
1803 (make-string n ?x
)))))
1804 ;; Remove empty lines at the beginning of the file.
1805 (goto-char (point-min))
1806 (when (looking-at "\\s-+\n") (replace-match ""))
1807 ;; Remove display properties
1808 (remove-text-properties (point-min) (point-max) '(display t
))
1810 (run-hooks 'org-export-html-final-hook
)
1811 (or to-buffer
(save-buffer))
1812 (goto-char (point-min))
1813 (or (org-export-push-to-kill-ring "HTML")
1814 (message "Exporting... done"))
1815 (if (eq to-buffer
'string
)
1816 (prog1 (buffer-substring (point-min) (point-max))
1817 (kill-buffer (current-buffer)))
1818 (current-buffer)))))
1820 (defun org-export-html-format-href (s)
1821 "Make sure the S is valid as a href reference in an XHTML document."
1824 (while (string-match "&" s start
)
1825 (setq start
(+ (match-beginning 0) 3)
1826 s
(replace-match "&" t t s
)))))
1829 (defun org-export-html-format-desc (s)
1830 "Make sure the S is valid as a description in a link."
1831 (if (and s
(not (get-text-property 1 'org-protected s
)))
1833 (org-html-do-expand s
))
1836 (defun org-export-html-format-image (src par-open
)
1837 "Create image tag with source and attributes."
1839 (if (string-match "^ltxpng/" src
)
1840 (format "<img src=\"%s\" alt=\"%s\"/>"
1841 src
(org-find-text-property-in-string 'org-latex-src src
))
1842 (let* ((caption (org-find-text-property-in-string 'org-caption src
))
1843 (attr (org-find-text-property-in-string 'org-attributes src
))
1844 (label (org-find-text-property-in-string 'org-label src
)))
1845 (setq caption
(and caption
(org-html-do-expand caption
)))
1848 (format "%s<div %sclass=\"figure\">
1850 (if org-par-open
"</p>\n" "")
1851 (if label
(format "id=\"%s\" " (org-solidify-link-text label
)) "")))
1852 (format "<img src=\"%s\"%s />"
1854 (if (string-match "\\<alt=" (or attr
""))
1856 (concat " " attr
" alt=\"" src
"\"")))
1860 (concat "\n<p>" caption
"</p>")
1861 (if org-par-open
"\n<p>" ""))))))))
1863 (defun org-export-html-get-bibliography ()
1864 "Find bibliography, cut it out and return it."
1866 (let (beg end
(cnt 1) bib
)
1868 (goto-char (point-min))
1869 (when (re-search-forward "^[ \t]*<div \\(id\\|class\\)=\"bibliography\"" nil t
)
1870 (setq beg
(match-beginning 0))
1871 (while (re-search-forward "</?div\\>" nil t
)
1872 (setq cnt
(+ cnt
(if (string= (match-string 0) "<div") +1 -
1)))
1874 (and (looking-at ">") (forward-char 1))
1875 (setq bib
(buffer-substring beg
(point)))
1876 (delete-region beg
(point))
1877 (throw 'exit bib
))))
1880 (defvar org-table-number-regexp
) ; defined in org-table.el
1881 (defun org-format-table-html (lines olines
&optional no-css
)
1882 "Find out which HTML converter to use and return the HTML code.
1883 NO-CSS is passed to the exporter."
1885 (setq lines
(org-split-string lines
"\n")))
1886 (if (string-match "^[ \t]*|" (car lines
))
1887 ;; A normal org table
1888 (org-format-org-table-html lines nil no-css
)
1889 ;; Table made by table.el
1890 (or (org-format-table-table-html-using-table-generate-source
1891 olines
(not org-export-prefer-native-exporter-for-tables
))
1892 ;; We are here only when table.el table has NO col or row
1893 ;; spanning and the user prefers using org's own converter for
1894 ;; exporting of such simple table.el tables.
1895 (org-format-table-table-html lines
))))
1897 (defvar org-table-number-fraction
) ; defined in org-table.el
1898 (defun org-format-org-table-html (lines &optional splice no-css
)
1899 "Format a table into HTML.
1900 LINES is a list of lines. Optional argument SPLICE means, do not
1901 insert header and surrounding <table> tags, just format the lines.
1902 Optional argument NO-CSS means use XHTML attributes instead of CSS
1903 for formatting. This is required for the DocBook exporter."
1904 (require 'org-table
)
1905 ;; Get rid of hlines at beginning and end
1906 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1907 (setq lines
(nreverse lines
))
1908 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1909 (setq lines
(nreverse lines
))
1910 (when org-export-table-remove-special-lines
1911 ;; Check if the table has a marking column. If yes remove the
1912 ;; column and the special lines
1913 (setq lines
(org-table-clean-before-export lines
)))
1915 (let* ((caption (org-find-text-property-in-string 'org-caption
(car lines
)))
1916 (label (org-find-text-property-in-string 'org-label
(car lines
)))
1917 (forced-aligns (org-find-text-property-in-string 'org-forced-aligns
1919 (attributes (org-find-text-property-in-string 'org-attributes
1921 (html-table-tag (org-export-splice-attributes
1922 html-table-tag attributes
))
1923 (head (and org-export-highlight-first-table-line
1925 (lambda (x) (string-match "^[ \t]*|-" x
))
1927 (nline 0) fnum nfields i
(cnt 0)
1928 tbopen line fields html gr colgropen rowstart rowend
1930 (setq caption
(and caption
(org-html-do-expand caption
)))
1931 (when (and forced-aligns org-table-clean-did-remove-column
)
1933 (mapcar (lambda (x) (cons (1- (car x
)) (cdr x
))) forced-aligns
)))
1934 (if splice
(setq head nil
))
1935 (unless splice
(push (if head
"<thead>" "<tbody>") html
))
1937 (while (setq line
(pop lines
))
1939 (if (string-match "^[ \t]*|-" line
)
1942 (push (if head
"</thead>" "</tbody>") html
)
1943 (if lines
(push "<tbody>" html
) (setq tbopen nil
)))
1944 (setq head nil
) ;; head ends here, first time around
1946 (throw 'next-line t
)))
1947 ;; Break the line into fields
1948 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
1949 (unless fnum
(setq fnum
(make-vector (length fields
) 0)
1950 nfields
(length fnum
)))
1951 (setq nline
(1+ nline
) i -
1
1952 rowstart
(eval (car org-export-table-row-tags
))
1953 rowend
(eval (cdr org-export-table-row-tags
)))
1954 (push (concat rowstart
1957 (setq i
(1+ i
) ali
(format "@@class%03d@@" i
))
1958 (if (and (< i nfields
) ; make sure no rogue line causes an error here
1959 (string-match org-table-number-regexp x
))
1960 (incf (aref fnum i
)))
1964 (format (car org-export-table-header-tags
)
1967 (cdr org-export-table-header-tags
)))
1968 ((and (= i
0) org-export-html-table-use-header-tags-for-first-column
)
1970 (format (car org-export-table-header-tags
)
1973 (cdr org-export-table-header-tags
)))
1975 (concat (format (car org-export-table-data-tags
) ali
)
1977 (cdr org-export-table-data-tags
)))))
1981 (unless splice
(if tbopen
(push "</tbody>" html
)))
1982 (unless splice
(push "</table>\n" html
))
1983 (setq html
(nreverse html
))
1985 ;; Put in col tags with the alignment (unfortunately often ignored...)
1986 (unless (car org-table-colgroup-info
)
1987 (setq org-table-colgroup-info
1988 (cons :start
(cdr org-table-colgroup-info
))))
1992 (setq gr
(pop org-table-colgroup-info
)
1994 align
(if (assoc i forced-aligns
)
1995 (cdr (assoc (cdr (assoc i forced-aligns
))
1996 '(("l" .
"left") ("r" .
"right")
1998 (if (> (/ (float x
) nline
)
1999 org-table-number-fraction
)
2003 "%s<col align=\"%s\" />%s"
2004 "%s<col class=\"%s\" />%s")
2005 (if (memq gr
'(:start
:startend
))
2008 "</colgroup>\n<colgroup>"
2013 (if (memq gr
'(:end
:startend
))
2014 (progn (setq colgropen nil
) "</colgroup>")
2018 (setq aligns
(nreverse aligns
))
2019 (if colgropen
(setq html
(cons (car html
)
2020 (cons "</colgroup>" (cdr html
)))))
2021 ;; Since the output of HTML table formatter can also be used in
2022 ;; DocBook document, we want to always include the caption to make
2023 ;; DocBook XML file valid.
2024 (push (format "<caption>%s</caption>" (or caption
"")) html
)
2026 (setq html-table-tag
(org-export-splice-attributes html-table-tag
(format "id=\"%s\"" (org-solidify-link-text label
)))))
2027 (push html-table-tag html
))
2030 (replace-regexp-in-string
2031 "@@class\\([0-9]+\\)@@"
2033 (if (not org-export-html-table-align-individual-fields
)
2035 (setq n
(string-to-number (match-string 1 txt
)))
2036 (format (if no-css
" align=\"%s\"" " class=\"%s\"")
2037 (or (nth n aligns
) "left"))))
2040 (concat (mapconcat 'identity html
"\n") "\n")))
2042 (defun org-export-splice-attributes (tag attributes
)
2043 "Read attributes in string ATTRIBUTES, add and replace in HTML tag TAG."
2044 (if (not attributes
)
2046 (let (oldatt newatt
)
2047 (setq oldatt
(org-extract-attributes-from-string tag
)
2049 newatt
(cdr (org-extract-attributes-from-string attributes
)))
2051 (setq oldatt
(plist-put oldatt
(pop newatt
) (pop newatt
))))
2052 (if (string-match ">" tag
)
2054 (replace-match (concat (org-attributes-to-string oldatt
) ">")
2058 (defun org-format-table-table-html (lines)
2059 "Format a table generated by table.el into HTML.
2060 This conversion does *not* use `table-generate-source' from table.el.
2061 This has the advantage that Org-mode's HTML conversions can be used.
2062 But it has the disadvantage, that no cell- or row-spanning is allowed."
2063 (let (line field-buffer
2064 (head org-export-highlight-first-table-line
)
2065 fields html empty i
)
2066 (setq html
(concat html-table-tag
"\n"))
2067 (while (setq line
(pop lines
))
2068 (setq empty
" ")
2070 (if (string-match "^[ \t]*\\+-" line
)
2081 (if (equal x
"") (setq x empty
))
2084 (format (car org-export-table-header-tags
) "col" "")
2086 (cdr org-export-table-header-tags
))
2087 (concat (format (car org-export-table-data-tags
) "") x
2088 (cdr org-export-table-data-tags
))))
2092 (setq field-buffer nil
)))
2094 (throw 'next-line t
)))
2095 ;; Break the line into fields and store the fields
2096 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
2098 (setq field-buffer
(mapcar
2100 (concat x
"<br/>" (pop fields
)))
2102 (setq field-buffer fields
))))
2103 (setq html
(concat html
"</table>\n"))
2106 (defun org-format-table-table-html-using-table-generate-source (lines
2109 "Format a table into html, using `table-generate-source' from table.el.
2110 Use SPANNED-ONLY to suppress exporting of simple table.el tables.
2112 When SPANNED-ONLY is nil, all table.el tables are exported. When
2113 SPANNED-ONLY is non-nil, only tables with either row or column
2116 This routine returns the generated source or nil as appropriate.
2118 Refer docstring of `org-export-prefer-native-exporter-for-tables'
2119 for further information."
2121 (with-current-buffer (get-buffer-create " org-tmp1 ")
2123 (insert (mapconcat 'identity lines
"\n"))
2124 (goto-char (point-min))
2125 (if (not (re-search-forward "|[^+]" nil t
))
2126 (error "Error processing table"))
2127 (table-recognize-table)
2128 (when (or (not spanned-only
)
2129 (let* ((dim (table-query-dimension))
2130 (c (nth 4 dim
)) (r (nth 5 dim
)) (cells (nth 6 dim
)))
2131 (not (= (* c r
) cells
))))
2132 (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
2133 (table-generate-source 'html
" org-tmp2 ")
2134 (set-buffer " org-tmp2 ")
2135 (buffer-substring (point-min) (point-max)))))
2137 (defun org-export-splice-style (style extra
)
2138 "Splice EXTRA into STYLE, just before \"</style>\"."
2139 (if (and (stringp extra
)
2140 (string-match "\\S-" extra
)
2141 (string-match "</style>" style
))
2142 (concat (substring style
0 (match-beginning 0))
2144 (substring style
(match-beginning 0)))
2147 (defun org-html-handle-time-stamps (s)
2148 "Format time stamps in string S, or remove them."
2151 (while (string-match org-maybe-keyword-time-regexp s
)
2152 (or b
(setq b
(substring s
0 (match-beginning 0))))
2154 r
(substring s
0 (match-beginning 0))
2155 " @<span class=\"timestamp-wrapper\">"
2157 (format "@<span class=\"timestamp-kwd\">%s @</span>"
2158 (match-string 1 s
)))
2159 (format " @<span class=\"timestamp\">%s@</span>"
2161 (org-translate-time (match-string 3 s
)) 1 -
1))
2163 s
(substring s
(match-end 0))))
2164 ;; Line break if line started and ended with time stamp stuff
2167 (setq r
(concat r s
))
2168 (unless (string-match "\\S-" (concat b s
))
2169 (setq r
(concat r
"<br/>")))
2172 (defvar htmlize-buffer-places
) ; from htmlize.el
2173 (defun org-export-htmlize-region-for-paste (beg end
)
2174 "Convert the region to HTML, using htmlize.el.
2175 This is much like `htmlize-region-for-paste', only that it uses
2176 the settings define in the org-... variables."
2177 (let* ((htmlize-output-type org-export-htmlize-output-type
)
2178 (htmlize-css-name-prefix org-export-htmlize-css-font-prefix
)
2179 (htmlbuf (htmlize-region beg end
)))
2181 (with-current-buffer htmlbuf
2182 (buffer-substring (plist-get htmlize-buffer-places
'content-start
)
2183 (plist-get htmlize-buffer-places
'content-end
)))
2184 (kill-buffer htmlbuf
))))
2187 (defun org-export-htmlize-generate-css ()
2188 "Create the CSS for all font definitions in the current Emacs session.
2189 Use this to create face definitions in your CSS style file that can then
2190 be used by code snippets transformed by htmlize.
2191 This command just produces a buffer that contains class definitions for all
2192 faces used in the current Emacs session. You can copy and paste the ones you
2193 need into your CSS file.
2195 If you then set `org-export-htmlize-output-type' to `css', calls to
2196 the function `org-export-htmlize-region-for-paste' will produce code
2197 that uses these same face definitions."
2200 (and (get-buffer "*html*") (kill-buffer "*html*"))
2202 (let ((fl (face-list))
2203 (htmlize-css-name-prefix "org-")
2204 (htmlize-output-type 'css
)
2206 (while (setq f
(pop fl
)
2207 i
(and f
(face-attribute f
:inherit
)))
2208 (when (and (symbolp f
) (or (not i
) (not (listp i
))))
2209 (insert (org-add-props (copy-sequence "1") nil
'face f
))))
2210 (htmlize-region (point-min) (point-max))))
2211 (switch-to-buffer "*html*")
2212 (goto-char (point-min))
2213 (if (re-search-forward "<style" nil t
)
2214 (delete-region (point-min) (match-beginning 0)))
2215 (if (re-search-forward "</style>" nil t
)
2216 (delete-region (1+ (match-end 0)) (point-max)))
2217 (beginning-of-line 1)
2218 (if (looking-at " +") (replace-match ""))
2219 (goto-char (point-min)))
2221 (defun org-html-protect (s)
2222 "Convert characters to HTML equivalent.
2223 Possible conversions are set in `org-export-html-protect-char-alist'."
2224 (let ((cl org-export-html-protect-char-alist
) c
)
2225 (while (setq c
(pop cl
))
2227 (while (string-match (car c
) s start
)
2228 (setq s
(replace-match (cdr c
) t t s
)
2229 start
(1+ (match-beginning 0))))))
2232 (defun org-html-expand (string)
2233 "Prepare STRING for HTML export. Apply all active conversions.
2234 If there are links in the string, don't modify these."
2235 (let* ((re (concat org-bracket-link-regexp
"\\|"
2236 (org-re "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")))
2238 (while (setq m
(string-match re string
))
2239 (setq s
(substring string
0 m
)
2240 l
(match-string 0 string
)
2241 string
(substring string
(match-end 0)))
2242 (push (org-html-do-expand s
) res
)
2244 (push (org-html-do-expand string
) res
)
2245 (apply 'concat
(nreverse res
))))
2247 (defun org-html-do-expand (s)
2248 "Apply all active conversions to translate special ASCII to HTML."
2249 (setq s
(org-html-protect s
))
2250 (if org-export-html-expand
2251 (while (string-match "@<\\([^&]*\\)>" s
)
2252 (setq s
(replace-match "<\\1>" t nil s
))))
2253 (if org-export-with-emphasize
2254 (setq s
(org-export-html-convert-emphasize s
)))
2255 (if org-export-with-special-strings
2256 (setq s
(org-export-html-convert-special-strings s
)))
2257 (if org-export-with-sub-superscripts
2258 (setq s
(org-export-html-convert-sub-super s
)))
2259 (if org-export-with-TeX-macros
2260 (let ((start 0) wd rep
)
2261 (while (setq start
(string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
2263 (if (get-text-property (match-beginning 0) 'org-protected s
)
2264 (setq start
(match-end 0))
2265 (setq wd
(match-string 1 s
))
2266 (if (setq rep
(org-entity-get-representation wd
'html
))
2267 (setq s
(replace-match rep t t s
))
2268 (setq start
(+ start
(length wd
))))))))
2271 (defun org-export-html-convert-special-strings (string)
2272 "Convert special characters in STRING to HTML."
2273 (let ((all org-export-html-special-string-regexps
)
2275 (while (setq a
(pop all
))
2276 (setq re
(car a
) rpl
(cdr a
) start
0)
2277 (while (string-match re string start
)
2278 (if (get-text-property (match-beginning 0) 'org-protected string
)
2279 (setq start
(match-end 0))
2280 (setq string
(replace-match rpl t nil string
)))))
2283 (defun org-export-html-convert-sub-super (string)
2284 "Convert sub- and superscripts in STRING to HTML."
2285 (let (key c
(s 0) (requireb (eq org-export-with-sub-superscripts
'{})))
2286 (while (string-match org-match-substring-regexp string s
)
2288 ((and requireb
(match-end 8)) (setq s
(match-end 2)))
2289 ((get-text-property (match-beginning 2) 'org-protected string
)
2290 (setq s
(match-end 2)))
2292 (setq s
(match-end 1)
2293 key
(if (string= (match-string 2 string
) "_") "sub" "sup")
2294 c
(or (match-string 8 string
)
2295 (match-string 6 string
)
2296 (match-string 5 string
))
2297 string
(replace-match
2298 (concat (match-string 1 string
)
2299 "<" key
">" c
"</" key
">")
2301 (while (string-match "\\\\\\([_^]\\)" string
)
2302 (setq string
(replace-match (match-string 1 string
) t t string
)))
2305 (defun org-export-html-convert-emphasize (string)
2308 (while (string-match org-emph-re string s
)
2310 (substring string
(match-beginning 3) (1+ (match-beginning 3)))
2311 (substring string
(match-beginning 4) (1+ (match-beginning 4)))))
2312 (setq s
(match-beginning 0)
2315 (match-string 1 string
)
2316 (nth 2 (assoc (match-string 3 string
) org-emphasis-alist
))
2317 (match-string 4 string
)
2318 (nth 3 (assoc (match-string 3 string
)
2319 org-emphasis-alist
))
2320 (match-string 5 string
))
2321 string
(replace-match rpl t t string
)
2322 s
(+ s
(- (length rpl
) 2)))
2326 (defun org-open-par ()
2327 "Insert <p>, but first close previous paragraph if any."
2328 (org-close-par-maybe)
2330 (setq org-par-open t
))
2331 (defun org-close-par-maybe ()
2332 "Close paragraph if there is one open."
2335 (setq org-par-open nil
)))
2336 (defun org-close-li (&optional type
)
2337 "Close <li> if necessary."
2338 (org-close-par-maybe)
2339 (insert (if (equal type
"d") "</dd>\n" "</li>\n")))
2341 (defvar body-only
) ; dynamically scoped into this.
2342 (defun org-html-level-start (level title umax with-toc head-count
)
2343 "Insert a new level in HTML export.
2344 When TITLE is nil, just close all open levels."
2345 (org-close-par-maybe)
2346 (let* ((target (and title
(org-get-text-property-any 0 'target title
)))
2347 (extra-targets (and target
2348 (assoc target org-export-target-aliases
)))
2349 (extra-class (and title
(org-get-text-property-any 0 'html-container-class title
)))
2350 (preferred (and target
2351 (cdr (assoc target org-export-preferred-target-alist
))))
2353 snumber snu href suffix
)
2354 (setq extra-targets
(remove (or preferred target
) extra-targets
))
2356 (mapconcat (lambda (x)
2357 (setq x
(org-solidify-link-text
2358 (if (org-uuidgen-p x
) (concat "ID-" x
) x
)))
2359 (format "<a name=\"%s\" id=\"%s\"></a>"
2364 (if (aref org-levels-open
(1- l
))
2366 (org-html-level-close l umax
)
2367 (aset org-levels-open
(1- l
) nil
)))
2370 ;; If title is nil, this means this function is called to close
2371 ;; all levels, so the rest is done only if title is given
2372 (when (string-match (org-re "\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") title
)
2373 (setq title
(replace-match
2374 (if org-export-with-tags
2377 " <span class=\"tag\">"
2380 (format "<span class=\"%s\">%s</span>"
2381 (org-export-html-get-tag-class-name x
)
2383 (org-split-string (match-string 1 title
) ":")
2390 (if (aref org-levels-open
(1- level
))
2394 (insert (format "<li id=\"%s\">" (org-solidify-link-text (or preferred target
)))
2395 extra-targets title
"<br/>\n")
2396 (insert "<li>" title
"<br/>\n")))
2397 (aset org-levels-open
(1- level
) t
)
2398 (org-close-par-maybe)
2400 (insert (format "<ul>\n<li id=\"%s\">" (org-solidify-link-text (or preferred target
)))
2401 extra-targets title
"<br/>\n")
2402 (insert "<ul>\n<li>" title
"<br/>\n"))))
2403 (aset org-levels-open
(1- level
) t
)
2404 (setq snumber
(org-section-number level
)
2405 snu
(replace-regexp-in-string "\\." "_" snumber
))
2406 (setq level
(+ level org-export-html-toplevel-hlevel -
1))
2407 (if (and org-export-with-section-numbers
(not body-only
))
2409 (format "<span class=\"section-number-%d\">%s</span>"
2412 (unless (= head-count
1) (insert "\n</div>\n"))
2413 (setq href
(cdr (assoc (concat "sec-" snu
) org-export-preferred-target-alist
)))
2414 (setq suffix
(org-solidify-link-text (or href snu
)))
2415 (setq href
(org-solidify-link-text (or href
(concat "sec-" snu
))))
2416 (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"
2417 suffix level
(if extra-class
(concat " " extra-class
) "")
2420 title level level suffix
))
2423 (defun org-export-html-get-tag-class-name (tag)
2424 "Turn tag into a valid class name.
2425 Replaces invalid characters with \"_\" and then prepends a prefix."
2427 (while (string-match "[^a-zA-Z0-9_]" tag
)
2428 (setq tag
(replace-match "_" t t tag
))))
2429 (concat org-export-html-tag-class-prefix tag
))
2431 (defun org-export-html-get-todo-kwd-class-name (kwd)
2432 "Turn todo keyword into a valid class name.
2433 Replaces invalid characters with \"_\" and then prepends a prefix."
2435 (while (string-match "[^a-zA-Z0-9_]" kwd
)
2436 (setq kwd
(replace-match "_" t t kwd
))))
2437 (concat org-export-html-todo-kwd-class-prefix kwd
))
2439 (defun org-html-level-close (level max-outline-level
)
2440 "Terminate one level in HTML export."
2441 (if (<= level max-outline-level
)
2444 (insert "</ul>\n")))
2446 (defun org-html-export-list-line (line pos struct prevs
)
2447 "Insert list syntax in export buffer. Return LINE, maybe modified.
2449 POS is the item position or line position the line had before
2450 modifications to buffer. STRUCT is the list structure. PREVS is
2451 the alist of previous items."
2454 ;; Translate type of list containing POS to "d", "o" or
2456 (lambda (pos struct prevs
)
2457 (let ((type (org-list-get-list-type pos struct prevs
)))
2459 ((eq 'ordered type
) "o")
2460 ((eq 'descriptive type
) "d")
2464 ;; Return list of all items and sublists ending at POS, in
2470 (let ((end (nth 6 e
))
2473 ((= end pos
) (push item out
))
2474 ((>= item pos
) (throw 'exit nil
)))))
2477 ;; First close any previous item, or list, ending at POS.
2479 (let* ((lastp (= (org-list-get-last-item e struct prevs
) e
))
2480 (first-item (org-list-get-list-begin e struct prevs
))
2481 (type (funcall get-type first-item struct prevs
)))
2482 (org-close-par-maybe)
2483 ;; Ending for every item
2485 ;; We're ending last item of the list: end list.
2487 (insert (format "</%sl>\n" type
))
2489 (funcall get-closings pos
))
2491 ;; At an item: insert appropriate tags in export buffer.
2494 (concat "[ \t]*\\(\\S-+[ \t]*\\)"
2495 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\]\\)?"
2496 "\\(?:\\(\\[[ X-]\\]\\)[ \t]+\\)?"
2497 "\\(?:\\(.*\\)[ \t]+::[ \t]+\\)?"
2499 (let* ((checkbox (match-string 3 line
))
2500 (desc-tag (or (match-string 4 line
) "???"))
2501 (body (or (match-string 5 line
) ""))
2502 (list-beg (org-list-get-list-begin pos struct prevs
))
2503 (firstp (= list-beg pos
))
2504 ;; Always refer to first item to determine list type, in
2505 ;; case list is ill-formed.
2506 (type (funcall get-type list-beg struct prevs
))
2507 (counter (let ((count-tmp (org-list-get-counter pos struct
)))
2509 ((not count-tmp
) nil
)
2510 ((string-match "[A-Za-z]" count-tmp
)
2511 (- (string-to-char (upcase count-tmp
)) 64))
2512 ((string-match "[0-9]+" count-tmp
)
2515 (org-close-par-maybe)
2516 (insert (format "<%sl>\n" type
)))
2519 (format "<dt>%s</dt><dd>" desc-tag
))
2520 ((and (equal type
"o") counter
)
2521 (format "<li value=\"%s\">" counter
))
2523 ;; If line had a checkbox, some additional modification is required.
2528 ((string-match "X" checkbox
) "<code>[X]</code> ")
2529 ((string-match " " checkbox
) "<code>[ ]</code> ")
2530 (t "<code>[-]</code> "))
2532 ;; Return modified line
2534 ;; At a list ender: go to next line (side-effects only).
2535 ((equal "ORG-LIST-END-MARKER" line
) (throw 'nextline nil
))
2536 ;; Not at an item: return line unchanged (side-effects only).
2541 ;; arch-tag: 8109d84d-eb8f-460b-b1a8-f45f3a6c7ea1
2542 ;;; org-html.el ends here