1 ;;; org-html.el --- HTML export for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
30 (eval-when-compile (require 'cl
))
32 (declare-function org-id-find-id-file
"org-id" (id))
33 (declare-function htmlize-region
"ext:htmlize" (beg end
))
35 (defgroup org-export-html nil
36 "Options specific for HTML export of Org-mode files."
37 :tag
"Org Export HTML"
40 (defcustom org-export-html-footnotes-section
"<div id=\"footnotes\">
41 <h2 class=\"footnotes\">%s: </h2>
42 <div id=\"text-footnotes\">
46 "Format for the footnotes section.
47 Should contain a two instances of %s. The first will be replaced with the
48 language-specific word for \"Footnotes\", the second one will be replaced
49 by the footnotes themselves."
50 :group
'org-export-html
53 (defcustom org-export-html-footnote-format
"<sup>%s</sup>"
54 "The format for the footnote reference.
55 %s will be replaced by the footnote reference itself."
56 :group
'org-export-html
59 (defcustom org-export-html-coding-system nil
60 "Coding system for HTML export, defaults to buffer-file-coding-system."
61 :group
'org-export-html
64 (defcustom org-export-html-extension
"html"
65 "The extension for exported HTML files."
66 :group
'org-export-html
69 (defcustom org-export-html-xml-declaration
70 '(("html" .
"<?xml version=\"1.0\" encoding=\"%s\"?>")
71 ("php" .
"<?php echo \"<?xml version=\\\"1.0\\\" encoding=\\\"%s\\\" ?>\"; ?>"))
72 "The extension for exported HTML files.
73 %s will be replaced with the charset of the exported file.
74 This may be a string, or an alist with export extensions
75 and corresponding declarations."
76 :group
'org-export-html
78 (string :tag
"Single declaration")
79 (repeat :tag
"Dependent on extension"
80 (cons (string :tag
"Extension")
81 (string :tag
"Declaration")))))
83 (defcustom org-export-html-style-include-scripts t
84 "Non-nil means include the javascript snippets in exported HTML files.
85 The actual script is defined in `org-export-html-scripts' and should
87 :group
'org-export-html
90 (defconst org-export-html-scripts
91 "<script type=\"text/javascript\">
92 <!--/*--><![CDATA[/*><!--*/
93 function CodeHighlightOn(elem, id)
95 var target = document.getElementById(id);
97 elem.cacheClassElem = elem.className;
98 elem.cacheClassTarget = target.className;
99 target.className = \"code-highlighted\";
100 elem.className = \"code-highlighted\";
103 function CodeHighlightOff(elem, id)
105 var target = document.getElementById(id);
106 if(elem.cacheClassElem)
107 elem.className = elem.cacheClassElem;
108 if(elem.cacheClassTarget)
109 target.className = elem.cacheClassTarget;
113 "Basic javascript that is needed by HTML files produced by Org-mode.")
115 (defconst org-export-html-style-default
116 "<style type=\"text/css\">
117 <!--/*--><![CDATA[/*><!--*/
118 html { font-family: Times, serif; font-size: 12pt; }
119 .title { text-align: center; }
120 .todo { color: red; }
121 .done { color: green; }
122 .tag { background-color: #add8e6; font-weight:normal }
124 .timestamp { color: #bebebe; }
125 .timestamp-kwd { color: #5f9ea0; }
126 p.verse { margin-left: 3% }
128 border: 1pt solid #AEBDCC;
129 background-color: #F3F5F7;
131 font-family: courier, monospace;
135 table { border-collapse: collapse; }
136 td, th { vertical-align: top; }
137 dt { font-weight: bold; }
138 div.figure { padding: 0.5em; }
139 div.figure p { text-align: center; }
140 textarea { overflow-x: auto; }
141 .linenr { font-size:smaller }
142 .code-highlighted {background-color:#ffff00;}
143 .org-info-js_info-navigation { border-style:none; }
144 #org-info-js_console-label { font-size:10px; font-weight:bold;
145 white-space:nowrap; }
146 .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
150 "The default style specification for exported HTML files.
151 Please use the variables `org-export-html-style' and
152 `org-export-html-style-extra' to add to this style. If you wish to not
153 have the default style included, customize the variable
154 `org-export-html-style-include-default'.")
156 (defcustom org-export-html-style-include-default t
157 "Non-nil means include the default style in exported HTML files.
158 The actual style is defined in `org-export-html-style-default' and should
159 not be modified. Use the variables `org-export-html-style' to add
160 your own style information."
161 :group
'org-export-html
164 (put 'org-export-html-style-include-default
'safe-local-variable
'booleanp
)
166 (defcustom org-export-html-style
""
167 "Org-wide style definitions for exported HTML files.
169 This variable needs to contain the full HTML structure to provide a style,
170 including the surrounding HTML tags. If you set the value of this variable,
171 you should consider to include definitions for the following classes:
172 title, todo, done, timestamp, timestamp-kwd, tag, target.
174 For example, a valid value would be:
176 <style type=\"text/css\">
178 p { font-weight: normal; color: gray; }
180 .title { text-align: center; }
181 .todo, .timestamp-kwd { color: red; }
182 .done { color: green; }
186 If you'd like to refer to en external style file, use something like
188 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
190 As the value of this option simply gets inserted into the HTML <head> header,
191 you can \"misuse\" it to add arbitrary text to the header.
192 See also the variable `org-export-html-style-extra'."
193 :group
'org-export-html
196 (put 'org-export-html-style
'safe-local-variable
'stringp
)
198 (defcustom org-export-html-style-extra
""
199 "Additional style information for HTML export.
200 The value of this variable is inserted into the HTML buffer right after
201 the value of `org-export-html-style'. Use this variable for per-file
202 settings of style information, and do not forget to surround the style
203 settings with <style>...</style> tags."
204 :group
'org-export-html
207 (put 'org-export-html-style-extra
'safe-local-variable
'stringp
)
209 (defcustom org-export-html-tag-class-prefix
""
210 "Prefix to clas names for TODO keywords.
211 Each tag gets a class given by the tag itself, with this prefix.
212 The default prefix is empty because it is nice to just use the keyword
213 as a class name. But if you get into conflicts with other, existing
214 CSS classes, then this prefic can be very useful."
215 :group
'org-export-html
218 (defcustom org-export-html-todo-kwd-class-prefix
""
219 "Prefix to clas names for TODO keywords.
220 Each TODO keyword gets a class given by the keyword itself, with this prefix.
221 The default prefix is empty because it is nice to just use the keyword
222 as a class name. But if you get into conflicts with other, existing
223 CSS classes, then this prefic can be very useful."
224 :group
'org-export-html
227 (defcustom org-export-html-title-format
"<h1 class=\"title\">%s</h1>\n"
228 "Format for typesetting the document title in HTML export."
229 :group
'org-export-html
232 (defcustom org-export-html-home
/up-format
233 "<div id=\"org-div-home-and-up\" style=\"text-align:right;font-size:70%%;white-space:nowrap;\">
234 <a accesskey=\"h\" href=\"%s\"> UP </a>
236 <a accesskey=\"H\" href=\"%s\"> HOME </a>
238 "Snippet used to insert the HOME and UP links. This is a format,
239 the first %s will receive the UP link, the second the HOME link.
240 If both `org-export-html-link-up' and `org-export-html-link-home' are
241 empty, the entire snippet will be ignored."
242 :group
'org-export-html
245 (defcustom org-export-html-toplevel-hlevel
2
246 "The <H> level for level 1 headings in HTML export.
247 This is also important for the classes that will be wrapped around headlines
248 and outline structure. If this variable is 1, the top-level headlines will
249 be <h1>, and the corresponding classes will be outline-1, section-number-1,
250 and outline-text-1. If this is 2, all of these will get a 2 instead.
251 The default for this variable is 2, because we use <h1> for formatting the
253 :group
'org-export-html
256 (defcustom org-export-html-link-org-files-as-html t
257 "Non-nil means make file links to `file.org' point to `file.html'.
258 When org-mode is exporting an org-mode file to HTML, links to
259 non-html files are directly put into a href tag in HTML.
260 However, links to other Org-mode files (recognized by the
261 extension `.org.) should become links to the corresponding html
262 file, assuming that the linked org-mode file will also be
264 When nil, the links still point to the plain `.org' file."
265 :group
'org-export-html
268 (defcustom org-export-html-inline-images
'maybe
269 "Non-nil means inline images into exported HTML pages.
270 This is done using an <img> tag. When nil, an anchor with href is used to
271 link to the image. If this option is `maybe', then images in links with
272 an empty description will be inlined, while images with a description will
274 :group
'org-export-html
275 :type
'(choice (const :tag
"Never" nil
)
276 (const :tag
"Always" t
)
277 (const :tag
"When there is no description" maybe
)))
279 (defcustom org-export-html-inline-image-extensions
280 '("png" "jpeg" "jpg" "gif")
281 "Extensions of image files that can be inlined into HTML."
282 :group
'org-export-html
283 :type
'(repeat (string :tag
"Extension")))
285 (defcustom org-export-html-table-tag
286 "<table border=\"2\" cellspacing=\"0\" cellpadding=\"6\" rules=\"groups\" frame=\"hsides\">"
287 "The HTML tag that is used to start a table.
288 This must be a <table> tag, but you may change the options like
289 borders and spacing."
290 :group
'org-export-html
293 (defcustom org-export-table-header-tags
'("<th scope=\"%s\">" .
"</th>")
294 "The opening tag for table header fields.
295 This is customizable so that alignment options can be specified.
296 %s will be filled with the scope of the field, either row or col.
297 See also the variable `org-export-html-table-use-header-tags-for-first-column'."
298 :group
'org-export-tables
299 :type
'(cons (string :tag
"Opening tag") (string :tag
"Closing tag")))
301 (defcustom org-export-table-data-tags
'("<td>" .
"</td>")
302 "The opening tag for table data fields.
303 This is customizable so that alignment options can be specified."
304 :group
'org-export-tables
305 :type
'(cons (string :tag
"Opening tag") (string :tag
"Closing tag")))
307 (defcustom org-export-table-row-tags
'("<tr>" .
"</tr>")
308 "The opening tag for table data fields.
309 This is customizable so that alignment options can be specified.
310 Instead of strings, these can be Lisp forms that will be evaluated
311 for each row in order to construct the table row tags. During evaluation,
312 the variable `head' will be true when this is a header line, nil when this
313 is a body line. And the variable `nline' will contain the line number,
314 starting from 1 in the first header line. For example
316 (setq org-export-table-row-tags
319 (if (= (mod nline 2) 1)
320 \"<tr class=\\\"tr-odd\\\">\"
321 \"<tr class=\\\"tr-even\\\">\"))
324 will give even lines the class \"tr-even\" and odd lines the class \"tr-odd\"."
325 :group
'org-export-tables
327 (choice :tag
"Opening tag"
328 (string :tag
"Specify")
330 (choice :tag
"Closing tag"
331 (string :tag
"Specify")
336 (defcustom org-export-html-table-use-header-tags-for-first-column nil
337 "Non-nil means format column one in tables with header tags.
338 When nil, also column one will use data tags."
339 :group
'org-export-tables
342 (defcustom org-export-html-validation-link nil
343 "Non-nil means add validationlink to postamble of HTML exported files."
344 :group
'org-export-html
346 (const :tag
"Nothing" nil
)
347 (const :tag
"XHTML 1.0" "<p class=\"xhtml-validation\"><a href=\"http://validator.w3.org/check?uri=referer\">Validate XHTML 1.0</a></p>")
348 (string :tag
"Specify full HTML")))
351 (defcustom org-export-html-with-timestamp nil
352 "If non-nil, write `org-export-html-html-helper-timestamp'
353 into the exported HTML text. Otherwise, the buffer will just be saved
355 :group
'org-export-html
358 (defcustom org-export-html-html-helper-timestamp
359 "<br/><br/><hr><p><!-- hhmts start --> <!-- hhmts end --></p>\n"
360 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
361 :group
'org-export-html
364 (defgroup org-export-htmlize nil
365 "Options for processing examples with htmlize.el."
366 :tag
"Org Export Htmlize"
367 :group
'org-export-html
)
369 (defcustom org-export-htmlize-output-type
'inline-css
370 "Output type to be used by htmlize when formatting code snippets.
371 We use as default `inline-css', in order to make the resulting
372 HTML self-containing.
373 However, this will fail when using Emacs in batch mode for export, because
374 then no rich font definitions are in place. It will also not be good if
375 people with different Emacs setup contribute HTML files to a website,
376 because the fonts will represent the individual setups. In these cases,
377 it is much better to let Org/Htmlize assign classes only, and to use
378 a style file to define the look of these classes.
379 To get a start for your css file, start Emacs session and make sure that
380 all the faces you are interested in are defined, for example by loading files
381 in all modes you want. Then, use the command
382 \\[org-export-htmlize-generate-css] to extract class definitions."
383 :group
'org-export-htmlize
384 :type
'(choice (const css
) (const inline-css
)))
386 (defcustom org-export-htmlize-css-font-prefix
"org-"
387 "The prefix for CSS class names for htmlize font specifications."
388 :group
'org-export-htmlize
391 (defcustom org-export-htmlized-org-css-url nil
392 "URL pointing to a CSS file defining text colors for htmlized Emacs buffers.
393 Normally when creating an htmlized version of an Org buffer, htmlize will
394 create CSS to define the font colors. However, this does not work when
395 converting in batch mode, and it also can look bad if different people
396 with different fontification setup work on the same website.
397 When this variable is non-nil, creating an htmlized version of an Org buffer
398 using `org-export-as-org' will remove the internal CSS section and replace it
399 with a link to this URL."
400 :group
'org-export-htmlize
402 (const :tag
"Keep internal css" nil
)
403 (string :tag
"URL or local href")))
405 ;;; Variables, constants, and parameter plists
407 (defvar org-export-html-preamble nil
408 "Preamble, to be inserted just before <body>. Set by publishing functions.
409 This may also be a function, building and inserting the preamble.")
410 (defvar org-export-html-postamble nil
411 "Preamble, to be inserted just after </body>. Set by publishing functions.
412 This may also be a function, building and inserting the postamble.")
413 (defvar org-export-html-auto-preamble t
414 "Should default preamble be inserted? Set by publishing functions.")
415 (defvar org-export-html-auto-postamble t
416 "Should default postamble be inserted? Set by publishing functions.")
420 (defvar org-export-html-after-blockquotes-hook nil
421 "Hook run during HTML export, after blockquote, verse, center are done.")
423 (defvar org-export-html-final-hook nil
424 "Hook run at the end of HTML export, in the new buffer.")
428 (defun org-export-html-preprocess (parameters)
429 ;; Convert LaTeX fragments to images
430 (when (and org-current-export-file
431 (plist-get parameters
:LaTeX-fragments
))
433 (concat "ltxpng/" (file-name-sans-extension
434 (file-name-nondirectory
435 org-current-export-file
)))
436 org-current-export-dir nil
"Creating LaTeX image %s"))
437 (goto-char (point-min))
439 (while (re-search-forward "\\\\ref{\\([^{}\n]+\\)}" nil t
)
440 (org-if-unprotected-at (match-beginning 1)
441 (setq label
(match-string 1))
443 (if (string-match "\\`[a-z]\\{1,10\\}:\\(.+\\)" label
)
444 (setq l1
(substring label
(match-beginning 1)))
446 (replace-match (format "[[#%s][l1]]" label l1
) t t
)))))
449 (defun org-export-as-html-and-open (arg)
450 "Export the outline as HTML and immediately open it with a browser.
451 If there is an active region, export only the region.
452 The prefix ARG specifies how many levels of the outline should become
453 headlines. The default is 3. Lower levels will become bulleted lists."
455 (org-export-as-html arg
'hidden
)
456 (org-open-file buffer-file-name
)
457 (when org-export-kill-product-buffer-when-displayed
461 (defun org-export-as-html-batch ()
462 "Call `org-export-as-html', may be used in batch processing as
464 --load=$HOME/lib/emacs/org.el
465 --eval \"(setq org-export-headline-levels 2)\"
466 --visit=MyFile --funcall org-export-as-html-batch"
467 (org-export-as-html org-export-headline-levels
'hidden
))
470 (defun org-export-as-html-to-buffer (arg)
471 "Call `org-export-as-html` with output to a temporary buffer.
472 No file is created. The prefix ARG is passed through to `org-export-as-html'."
474 (org-export-as-html arg nil nil
"*Org HTML Export*")
475 (when org-export-show-temporary-export-buffer
476 (switch-to-buffer-other-window "*Org HTML Export*")))
479 (defun org-replace-region-by-html (beg end
)
480 "Assume the current region has org-mode syntax, and convert it to HTML.
481 This can be used in any buffer. For example, you could write an
482 itemized list in org-mode syntax in an HTML buffer and then use this
483 command to convert it."
485 (let (reg html buf pop-up-frames
)
486 (save-window-excursion
488 (setq html
(org-export-region-as-html
490 (setq reg
(buffer-substring beg end
)
491 buf
(get-buffer-create "*Org tmp*"))
492 (with-current-buffer buf
496 (setq html
(org-export-region-as-html
497 (point-min) (point-max) t
'string
)))
499 (delete-region beg end
)
503 (defun org-export-region-as-html (beg end
&optional body-only buffer
)
504 "Convert region from BEG to END in org-mode buffer to HTML.
505 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
506 contents, and only produce the region of converted text, useful for
507 cut-and-paste operations.
508 If BUFFER is a buffer or a string, use/create that buffer as a target
509 of the converted HTML. If BUFFER is the symbol `string', return the
510 produced HTML as a string and leave not buffer behind. For example,
511 a Lisp program could call this function in the following way:
513 (setq html (org-export-region-as-html beg end t 'string))
515 When called interactively, the output buffer is selected, and shown
516 in a window. A non-interactive call will only return the buffer."
518 (when (interactive-p)
519 (setq buffer
"*Org HTML Export*"))
520 (let ((transient-mark-mode t
) (zmacs-regions t
)
522 (setq ext-plist
(plist-put ext-plist
:ignore-subtree-p t
))
524 (set-mark (point)) ;; to activate the region
526 (setq rtn
(org-export-as-html
529 (if (fboundp 'deactivate-mark
) (deactivate-mark))
530 (if (and (interactive-p) (bufferp rtn
))
531 (switch-to-buffer-other-window rtn
)
534 (defvar html-table-tag nil
) ; dynamically scoped into this.
535 (defvar org-par-open nil
)
537 (defun org-export-as-html (arg &optional hidden ext-plist
538 to-buffer body-only pub-dir
)
539 "Export the outline as a pretty HTML file.
540 If there is an active region, export only the region. The prefix
541 ARG specifies how many levels of the outline should become
542 headlines. The default is 3. Lower levels will become bulleted
543 lists. HIDDEN is obsolete and does nothing.
544 EXT-PLIST is a property list with external parameters overriding
545 org-mode's default settings, but still inferior to file-local
546 settings. When TO-BUFFER is non-nil, create a buffer with that
547 name and export to that buffer. If TO-BUFFER is the symbol
548 `string', don't leave any buffer behind but just return the
549 resulting HTML as a string. When BODY-ONLY is set, don't produce
550 the file header and footer, simply return the content of
551 <body>...</body>, without even the body tags themselves. When
552 PUB-DIR is set, use this as the publishing directory."
554 (run-hooks 'org-export-first-hook
)
556 ;; Make sure we have a file name when we need it.
557 (when (and (not (or to-buffer body-only
))
558 (not buffer-file-name
))
559 (if (buffer-base-buffer)
560 (org-set-local 'buffer-file-name
561 (with-current-buffer (buffer-base-buffer)
563 (error "Need a file name to be able to export")))
565 (message "Exporting...")
566 (setq-default org-todo-line-regexp org-todo-line-regexp
)
567 (setq-default org-deadline-line-regexp org-deadline-line-regexp
)
568 (setq-default org-done-keywords org-done-keywords
)
569 (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp
)
571 (org-export-process-option-filters
572 (org-combine-plists (org-default-export-plist)
574 (org-infile-export-plist))))
575 (body-only (or body-only
(plist-get opt-plist
:body-only
)))
576 (style (concat (if (plist-get opt-plist
:style-include-default
)
577 org-export-html-style-default
)
578 (plist-get opt-plist
:style
)
579 (plist-get opt-plist
:style-extra
)
581 (if (plist-get opt-plist
:style-include-scripts
)
582 org-export-html-scripts
)))
583 (html-extension (plist-get opt-plist
:html-extension
))
584 (link-validate (plist-get opt-plist
:link-validation-function
))
585 valid thetoc have-headings first-heading-pos
586 (odd org-odd-levels-only
)
587 (region-p (org-region-active-p))
588 (rbeg (and region-p
(region-beginning)))
589 (rend (and region-p
(region-end)))
591 (if (plist-get opt-plist
:ignore-subtree-p
)
596 (and (org-at-heading-p)
597 (>= (org-end-of-subtree t t
) rend
))))))
598 (level-offset (if subtree-p
601 (+ (funcall outline-level
)
602 (if org-odd-levels-only
1 0)))
604 (opt-plist (setq org-export-opt-plist
606 (org-export-add-subtree-options opt-plist rbeg
)
608 ;; The following two are dynamically scoped into other
610 (org-current-export-dir
611 (or pub-dir
(org-export-directory :html opt-plist
)))
612 (org-current-export-file buffer-file-name
)
613 (level 0) (line "") (origline "") txt todo
616 (filename (if to-buffer nil
619 (file-name-sans-extension
621 (org-entry-get (region-beginning)
622 "EXPORT_FILE_NAME" t
))
623 (file-name-nondirectory buffer-file-name
)))
625 (file-name-as-directory
626 (or pub-dir
(org-export-directory :html opt-plist
))))))
627 (current-dir (if buffer-file-name
628 (file-name-directory buffer-file-name
)
630 (buffer (if to-buffer
632 ((eq to-buffer
'string
) (get-buffer-create "*Org HTML Export*"))
633 (t (get-buffer-create to-buffer
)))
634 (find-file-noselect filename
)))
635 (org-levels-open (make-vector org-level-max nil
))
636 (date (plist-get opt-plist
:date
))
637 (author (plist-get opt-plist
:author
))
638 (title (or (and subtree-p
(org-export-get-title-from-subtree))
639 (plist-get opt-plist
:title
)
642 (plist-get opt-plist
:skip-before-1st-heading
))
643 (org-export-grab-title-from-buffer))
644 (and buffer-file-name
645 (file-name-sans-extension
646 (file-name-nondirectory buffer-file-name
)))
648 (link-up (and (plist-get opt-plist
:link-up
)
649 (string-match "\\S-" (plist-get opt-plist
:link-up
))
650 (plist-get opt-plist
:link-up
)))
651 (link-home (and (plist-get opt-plist
:link-home
)
652 (string-match "\\S-" (plist-get opt-plist
:link-home
))
653 (plist-get opt-plist
:link-home
)))
654 (dummy (setq opt-plist
(plist-put opt-plist
:title title
)))
655 (html-table-tag (plist-get opt-plist
:html-table-tag
))
656 (quote-re0 (concat "^[ \t]*" org-quote-string
"\\>"))
657 (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string
"\\>\\)"))
662 (local-list-type nil
)
663 (local-list-indent nil
)
664 (llt org-plain-list-ordered-item-terminator
)
665 (email (plist-get opt-plist
:email
))
666 (language (plist-get opt-plist
:language
))
667 (keywords (plist-get opt-plist
:keywords
))
668 (description (plist-get opt-plist
:description
))
672 (coding-system (and (boundp 'buffer-file-coding-system
)
673 buffer-file-coding-system
))
674 (coding-system-for-write (or org-export-html-coding-system
676 (save-buffer-coding-system (or org-export-html-coding-system
678 (charset (and coding-system-for-write
679 (fboundp 'coding-system-get
)
680 (coding-system-get coding-system-for-write
684 (if region-p
(region-beginning) (point-min))
685 (if region-p
(region-end) (point-max))))
688 (org-export-preprocess-string
692 :skip-before-1st-heading
693 (plist-get opt-plist
:skip-before-1st-heading
)
694 :drawers
(plist-get opt-plist
:drawers
)
695 :todo-keywords
(plist-get opt-plist
:todo-keywords
)
696 :tags
(plist-get opt-plist
:tags
)
697 :priority
(plist-get opt-plist
:priority
)
698 :footnotes
(plist-get opt-plist
:footnotes
)
699 :timestamps
(plist-get opt-plist
:timestamps
)
701 (plist-get opt-plist
:archived-trees
)
702 :select-tags
(plist-get opt-plist
:select-tags
)
703 :exclude-tags
(plist-get opt-plist
:exclude-tags
)
705 (plist-get opt-plist
:text
)
707 (plist-get opt-plist
:LaTeX-fragments
))
710 table-buffer table-orig-buffer
711 ind item-type starter didclose
712 rpl path attr desc descp desc1 desc2 link
714 footnotes footref-seen
718 (let ((inhibit-read-only t
))
720 (remove-text-properties (point-min) (point-max)
721 '(:org-license-to-kill t
))))
723 (message "Exporting...")
725 (setq org-min-level
(org-get-min-level lines level-offset
))
726 (setq org-last-level org-min-level
)
727 (org-init-section-numbers)
730 ((and date
(string-match "%" date
))
731 (setq date
(format-time-string date
)))
733 (t (setq date
(format-time-string "%Y-%m-%d %T %Z"))))
735 ;; Get the language-dependent settings
736 (setq lang-words
(or (assoc language org-export-language-setup
)
737 (assoc "en" org-export-language-setup
)))
739 ;; Switch to the output buffer
741 (let ((inhibit-read-only t
)) (erase-buffer))
743 (org-install-letbind)
745 (and (fboundp 'set-buffer-file-coding-system
)
746 (set-buffer-file-coding-system coding-system-for-write
))
748 (let ((case-fold-search nil
)
749 (org-odd-levels-only odd
))
750 ;; create local variables for all options, to make sure all called
751 ;; functions get the correct information
753 (set (make-local-variable (nth 2 x
))
754 (plist-get opt-plist
(car x
))))
755 org-export-plist-vars
)
756 (setq umax
(if arg
(prefix-numeric-value arg
)
757 org-export-headline-levels
))
758 (setq umax-toc
(if (integerp org-export-with-toc
)
759 (min org-export-with-toc umax
)
765 <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
766 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
767 <html xmlns=\"http://www.w3.org/1999/xhtml\"
768 lang=\"%s\" xml:lang=\"%s\">
771 <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
772 <meta name=\"generator\" content=\"Org-mode\"/>
773 <meta name=\"generated\" content=\"%s\"/>
774 <meta name=\"author\" content=\"%s\"/>
775 <meta name=\"description\" content=\"%s\"/>
776 <meta name=\"keywords\" content=\"%s\"/>
784 (or (and (stringp org-export-html-xml-declaration
)
785 org-export-html-xml-declaration
)
786 (cdr (assoc html-extension org-export-html-xml-declaration
))
787 (cdr (assoc "html" org-export-html-xml-declaration
))
790 (or charset
"iso-8859-1"))
792 (org-html-expand title
)
793 (or charset
"iso-8859-1")
794 date author description keywords
796 (if (or link-up link-home
)
798 (format org-export-html-home
/up-format
799 (or link-up link-home
)
800 (or link-home link-up
))
804 (org-export-html-insert-plist-item opt-plist
:preamble opt-plist
)
806 (when (plist-get opt-plist
:auto-preamble
)
807 (if title
(insert (format org-export-html-title-format
808 (org-html-expand title
))))))
810 (if (and org-export-with-toc
(not body-only
))
812 (push (format "<h%d>%s</h%d>\n"
813 org-export-html-toplevel-hlevel
815 org-export-html-toplevel-hlevel
)
817 (push "<div id=\"text-table-of-contents\">\n" thetoc
)
818 (push "<ul>\n<li>" thetoc
)
820 (mapcar '(lambda (line)
821 (if (and (string-match org-todo-line-regexp line
)
822 (not (get-text-property 0 'org-protected line
)))
823 ;; This is a headline
825 (setq have-headings t
)
826 (setq level
(- (match-end 1) (match-beginning 1)
828 level
(org-tr-level level
)
831 (org-export-cleanup-toc-line
832 (match-string 3 line
))))
834 (or (and org-export-mark-todo-in-toc
836 (not (member (match-string 2 line
)
839 (and org-export-mark-todo-in-toc
841 (org-search-todo-below
844 (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt
)
845 (setq txt
(replace-match " <span class=\"tag\"> \\1</span>" t nil txt
)))
846 (if (string-match quote-re0 txt
)
847 (setq txt
(replace-match "" t t txt
)))
848 (setq snumber
(org-section-number level
))
849 (if org-export-with-section-numbers
850 (setq txt
(concat snumber
" " txt
)))
851 (if (<= level
(max umax umax-toc
))
852 (setq head-count
(+ head-count
1)))
853 (if (<= level umax-toc
)
855 (if (> level org-last-level
)
857 (setq cnt
(- level org-last-level
))
858 (while (>= (setq cnt
(1- cnt
)) 0)
859 (push "\n<ul>\n<li>" thetoc
))
861 (if (< level org-last-level
)
863 (setq cnt
(- org-last-level level
))
864 (while (>= (setq cnt
(1- cnt
)) 0)
865 (push "</li>\n</ul>" thetoc
))
868 (while (string-match org-any-target-regexp line
)
869 (setq line
(replace-match
870 (concat "@<span class=\"target\">" (match-string 1 line
) "@</span> ")
872 (while (string-match "<\\(<\\)+\\|>\\(>\\)+" txt
)
873 (setq txt
(replace-match "" t t txt
)))
874 (setq href
(format "sec-%s" snumber
))
875 (setq href
(or (cdr (assoc href org-export-preferred-target-alist
)) href
))
879 "</li>\n<li><a href=\"#%s\"><span class=\"todo\">%s</span></a>"
880 "</li>\n<li><a href=\"#%s\">%s</a>")
883 (setq org-last-level level
))
887 (while (> org-last-level
(1- org-min-level
))
888 (setq org-last-level
(1- org-last-level
))
889 (push "</li>\n</ul>\n" thetoc
))
890 (push "</div>\n" thetoc
)
891 (setq thetoc
(if have-headings
(nreverse thetoc
) nil
))))
894 (org-init-section-numbers)
898 (while (setq line
(pop lines
) origline line
)
901 ;; end of quote section?
902 (when (and inquote
(string-match "^\\*+ " line
))
906 ;; inside a quote section?
908 (insert (org-html-protect line
) "\n")
909 (throw 'nextline nil
))
911 ;; Fixed-width, verbatim lines (examples)
912 (when (and org-export-with-fixed-width
913 (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line
))
916 (org-close-par-maybe)
918 (insert "<pre class=\"example\">\n"))
919 (insert (org-html-protect (match-string 3 line
)) "\n")
920 (when (or (not lines
)
921 (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
926 (throw 'nextline nil
))
928 (org-export-html-close-lists-maybe line
)
931 (when (get-text-property 0 'org-protected line
)
932 (let (par (ind (get-text-property 0 'original-indentation line
)))
933 (when (re-search-backward
934 "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t
)
935 (setq par
(match-string 1))
936 (replace-match "\\2\n"))
939 (or (= (length (car lines
)) 0)
941 (equal ind
(get-text-property 0 'original-indentation
(car lines
))))
942 (or (= (length (car lines
)) 0)
943 (get-text-property 0 'org-protected
(car lines
))))
944 (insert (pop lines
) "\n"))
945 (and par
(insert "<p>\n")))
946 (throw 'nextline nil
))
948 ;; Blockquotes, verse, and center
949 (when (equal "ORG-BLOCKQUOTE-START" line
)
950 (org-close-par-maybe)
951 (insert "<blockquote>\n")
953 (throw 'nextline nil
))
954 (when (equal "ORG-BLOCKQUOTE-END" line
)
955 (org-close-par-maybe)
956 (insert "\n</blockquote>\n")
958 (throw 'nextline nil
))
959 (when (equal "ORG-VERSE-START" line
)
960 (org-close-par-maybe)
961 (insert "\n<p class=\"verse\">\n")
963 (throw 'nextline nil
))
964 (when (equal "ORG-VERSE-END" line
)
968 (throw 'nextline nil
))
969 (when (equal "ORG-CENTER-START" line
)
970 (org-close-par-maybe)
971 (insert "\n<div style=\"text-align: center\">")
973 (throw 'nextline nil
))
974 (when (equal "ORG-CENTER-END" line
)
975 (org-close-par-maybe)
978 (throw 'nextline nil
))
979 (run-hooks 'org-export-html-after-blockquotes-hook
)
981 (let ((i (org-get-string-indentation line
)))
983 (setq line
(concat (mapconcat 'identity
984 (make-list (* 2 i
) "\\nbsp") "")
985 " " (org-trim line
))))
986 (unless (string-match "\\\\\\\\[ \t]*$" line
)
987 (setq line
(concat line
"\\\\")))))
989 ;; make targets to anchors
992 "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start
)
994 ((get-text-property (match-beginning 1) 'org-protected line
)
995 (setq start
(match-end 1)))
997 (setq line
(replace-match
999 "@<a name=\"%s\" id=\"%s\">@</a>"
1000 (org-solidify-link-text (match-string 1 line
))
1001 (org-solidify-link-text (match-string 1 line
)))
1003 ((and org-export-with-toc
(equal (string-to-char line
) ?
*))
1004 ;; FIXME: NOT DEPENDENT on TOC?????????????????????
1005 (setq line
(replace-match
1006 (concat "@<span class=\"target\">"
1007 (match-string 1 line
) "@</span> ")
1008 ;; (concat "@<i>" (match-string 1 line) "@</i> ")
1011 (setq line
(replace-match
1012 (concat "@<a name=\""
1013 (org-solidify-link-text (match-string 1 line
))
1014 "\" class=\"target\">" (match-string 1 line
)
1018 (setq line
(org-html-handle-time-stamps line
))
1020 ;; replace "&" by "&", "<" and ">" by "<" and ">"
1021 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
1022 ;; Also handle sub_superscripts and checkboxes
1023 (or (string-match org-table-hline-regexp line
)
1024 (setq line
(org-html-expand line
)))
1028 (while (string-match org-bracket-link-analytic-regexp
++ line start
)
1029 (setq start
(match-beginning 0))
1030 (setq path
(save-match-data (org-link-unescape
1031 (match-string 3 line
))))
1033 ((match-end 2) (match-string 2 line
))
1035 (or (file-name-absolute-p path
)
1036 (string-match "^\\.\\.?/" path
)))
1039 (setq path
(org-extract-attributes (org-link-unescape path
)))
1040 (setq attr
(get-text-property 0 'org-attributes path
))
1041 (setq desc1
(if (match-end 5) (match-string 5 line
))
1042 desc2
(if (match-end 2) (concat type
":" path
) path
)
1043 descp
(and desc1
(not (equal desc1 desc2
)))
1044 desc
(or desc1 desc2
))
1045 ;; Make an image out of the description if that is so wanted
1046 (when (and descp
(org-file-image-p
1047 desc org-export-html-inline-image-extensions
))
1049 (if (string-match "^file:" desc
)
1050 (setq desc
(substring desc
(match-end 0)))))
1051 (setq desc
(org-add-props
1052 (concat "<img src=\"" desc
"\"/>")
1053 '(org-protected t
))))
1054 ;; FIXME: do we need to unescape here somewhere?
1056 ((equal type
"internal")
1060 (if (= (string-to-char path
) ?
#) "" "#")
1061 (org-solidify-link-text
1062 (save-match-data (org-link-unescape path
)) nil
)
1064 (org-export-html-format-desc desc
)
1066 ((and (equal type
"id")
1067 (setq id-file
(org-id-find-id-file path
)))
1068 ;; This is an id: link to another file (if it was the same file,
1069 ;; it would have become an internal link...)
1071 (setq id-file
(file-relative-name
1072 id-file
(file-name-directory org-current-export-file
)))
1073 (setq id-file
(concat (file-name-sans-extension id-file
)
1074 "." html-extension
))
1075 (setq rpl
(concat "<a href=\"" id-file
"#"
1076 (if (org-uuidgen-p path
) "ID-")
1079 (org-export-html-format-desc desc
)
1081 ((member type
'("http" "https"))
1082 ;; standard URL, just check if we need to inline an image
1083 (if (and (or (eq t org-export-html-inline-images
)
1084 (and org-export-html-inline-images
(not descp
)))
1086 path org-export-html-inline-image-extensions
))
1087 (setq rpl
(org-export-html-format-image
1088 (concat type
":" path
) org-par-open
))
1089 (setq link
(concat type
":" path
))
1090 (setq rpl
(concat "<a href=\""
1091 (org-export-html-format-href link
)
1093 (org-export-html-format-desc desc
)
1095 ((member type
'("ftp" "mailto" "news"))
1097 (setq link
(concat type
":" path
))
1098 (setq rpl
(concat "<a href=\""
1099 (org-export-html-format-href link
)
1101 (org-export-html-format-desc desc
)
1104 ((string= type
"coderef")
1105 (setq rpl
(format "<a href=\"#coderef-%s\" class=\"coderef\" onmouseover=\"CodeHighlightOn(this, 'coderef-%s');\" onmouseout=\"CodeHighlightOff(this, 'coderef-%s');\">%s</a>"
1107 (format (org-export-get-coderef-format path
(and descp desc
))
1108 (cdr (assoc path org-export-code-refs
))))))
1110 ((functionp (setq fnc
(nth 2 (assoc type org-link-protocols
))))
1111 ;; The link protocol has a function for format the link
1114 (funcall fnc
(org-link-unescape path
) desc1
'html
))))
1116 ((string= type
"file")
1118 (let* ((filename path
)
1119 (abs-p (file-name-absolute-p filename
))
1120 thefile file-is-image-p search
)
1122 (if (string-match "::\\(.*\\)" filename
)
1123 (setq search
(match-string 1 filename
)
1124 filename
(replace-match "" t nil filename
)))
1126 (if (functionp link-validate
)
1127 (funcall link-validate filename current-dir
)
1129 (setq file-is-image-p
1131 filename org-export-html-inline-image-extensions
))
1132 (setq thefile
(if abs-p
(expand-file-name filename
) filename
))
1133 (when (and org-export-html-link-org-files-as-html
1134 (string-match "\\.org$" thefile
))
1135 (setq thefile
(concat (substring thefile
0
1136 (match-beginning 0))
1137 "." html-extension
))
1139 ;; make sure this is can be used as target search
1140 (not (string-match "^[0-9]*$" search
))
1141 (not (string-match "^\\*" search
))
1142 (not (string-match "^/.*/$" search
)))
1145 (if (= (string-to-char search
) ?
#) "" "#")
1146 (org-solidify-link-text
1147 (org-link-unescape search
)))))
1148 (when (string-match "^file:" desc
)
1149 (setq desc
(replace-match "" t t desc
))
1150 (if (string-match "\\.org$" desc
)
1151 (setq desc
(replace-match "" t t desc
))))))
1152 (setq rpl
(if (and file-is-image-p
1153 (or (eq t org-export-html-inline-images
)
1154 (and org-export-html-inline-images
1157 (message "image %s %s" thefile org-par-open
)
1158 (org-export-html-format-image thefile org-par-open
))
1159 (concat "<a href=\"" thefile
"\"" attr
">"
1160 (org-export-html-format-desc desc
)
1162 (if (not valid
) (setq rpl desc
))))
1165 ;; just publish the path, as default
1166 (setq rpl
(concat "<i><" type
":"
1167 (save-match-data (org-link-unescape path
))
1169 (setq line
(replace-match rpl t t line
)
1170 start
(+ start
(length rpl
))))
1173 (if (and (string-match org-todo-line-regexp line
)
1174 (match-beginning 2))
1177 (concat (substring line
0 (match-beginning 2))
1179 (if (member (match-string 2 line
)
1182 " " (match-string 2 line
)
1183 "\"> " (org-export-html-get-todo-kwd-class-name
1184 (match-string 2 line
))
1185 "</span>" (substring line
(match-end 2)))))
1187 ;; Does this contain a reference to a footnote?
1188 (when org-export-with-footnotes
1190 (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start
)
1191 (if (get-text-property (match-beginning 2) 'org-protected line
)
1192 (setq start
(match-end 2))
1193 (let ((n (match-string 2 line
)) extra a
)
1194 (if (setq a
(assoc n footref-seen
))
1196 (setcdr a
(1+ (cdr a
)))
1197 (setq extra
(format ".%d" (cdr a
))))
1199 (push (cons n
1) footref-seen
))
1204 (format org-export-html-footnote-format
1205 "<a class=\"footref\" name=\"fnr.%s%s\" href=\"#fn.%s\">%s</a>"))
1206 (or (match-string 1 line
) "") n extra n n
)
1210 ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line
)
1211 ;; This is a headline
1212 (setq level
(org-tr-level (- (match-end 1) (match-beginning 1)
1214 txt
(match-string 2 line
))
1215 (if (string-match quote-re0 txt
)
1216 (setq txt
(replace-match "" t t txt
)))
1217 (if (<= level
(max umax umax-toc
))
1218 (setq head-count
(+ head-count
1)))
1220 ;; Close any local lists before inserting a new header line
1221 (while local-list-type
1222 (org-close-li (car local-list-type
))
1223 (insert (format "</%sl>\n" (car local-list-type
)))
1224 (pop local-list-type
))
1225 (setq local-list-indent nil
1227 (setq first-heading-pos
(or first-heading-pos
(point)))
1228 (org-html-level-start level txt umax
1229 (and org-export-with-toc
(<= level umax
))
1233 (when (string-match quote-re line
)
1234 (org-close-par-maybe)
1238 ((string-match "^[ \t]*- __+[ \t]*$" line
)
1239 ;; Explicit list closure
1240 (when local-list-type
1241 (let ((ind (org-get-indentation line
)))
1242 (while (and local-list-indent
1243 (<= ind
(car local-list-indent
)))
1244 (org-close-li (car local-list-type
))
1245 (insert (format "</%sl>\n" (car local-list-type
)))
1246 (pop local-list-type
)
1247 (pop local-list-indent
))
1248 (or local-list-indent
(setq in-local-list nil
))))
1249 (throw 'nextline nil
))
1251 ((and org-export-with-tables
1252 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line
))
1253 (when (not table-open
)
1255 (setq table-open t table-buffer nil table-orig-buffer nil
))
1258 (setq table-buffer
(cons line table-buffer
)
1259 table-orig-buffer
(cons origline table-orig-buffer
))
1260 (when (or (not lines
)
1261 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
1263 (setq table-open nil
1264 table-buffer
(nreverse table-buffer
)
1265 table-orig-buffer
(nreverse table-orig-buffer
))
1266 (org-close-par-maybe)
1267 (insert (org-format-table-html table-buffer table-orig-buffer
))))
1272 ((eq llt t
) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
1273 ((= llt ?.
) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
1274 ((= llt ?\
)) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+)\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
1275 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))
1277 (setq ind
(or (get-text-property 0 'original-indentation line
)
1278 (org-get-string-indentation line
))
1279 item-type
(if (match-beginning 4) "o" "u")
1280 starter
(if (match-beginning 2)
1281 (substring (match-string 2 line
) 0 -
1))
1282 line
(substring line
(match-beginning 5))
1284 (if (and starter
(string-match "\\(.*?\\) ::[ \t]*" line
))
1286 item-tag
(match-string 1 line
)
1287 line
(substring line
(match-end 0))))
1288 (when (and (not (equal item-type
"d"))
1289 (not (string-match "[^ \t]" line
)))
1290 ;; empty line. Pretend indentation is large.
1291 (setq ind
(if org-empty-line-terminates-plain-lists
1293 (1+ (or (car local-list-indent
) 1)))))
1295 (while (and in-local-list
1296 (or (and (= ind
(car local-list-indent
))
1298 (< ind
(car local-list-indent
))))
1300 (org-close-li (car local-list-type
))
1301 (insert (format "</%sl>\n" (car local-list-type
)))
1302 (pop local-list-type
) (pop local-list-indent
)
1303 (setq in-local-list local-list-indent
))
1306 (or (not in-local-list
)
1307 (> ind
(car local-list-indent
))))
1308 ;; Start new (level of) list
1309 (org-close-par-maybe)
1311 ((equal item-type
"u") "<ul>\n<li>\n")
1312 ((equal item-type
"o") "<ol>\n<li>\n")
1313 ((equal item-type
"d")
1314 (format "<dl>\n<dt>%s</dt><dd>\n" item-tag
))))
1315 (push item-type local-list-type
)
1316 (push ind local-list-indent
)
1317 (setq in-local-list t
))
1319 ;; continue current list
1320 (org-close-li (car local-list-type
))
1322 ((equal (car local-list-type
) "d")
1323 (format "<dt>%s</dt><dd>\n" (or item-tag
"???")))
1326 ;; we did close a list, normal text follows: need <p>
1328 (if (string-match "^[ \t]*\\[\\([X ]\\)\\]" line
)
1331 (if (equal (match-string 1 line
) "X")
1333 "<b>[<span style=\"visibility:hidden;\">X</span>]</b>")
1337 (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line
)
1339 (insert "\n</p>\n<hr/>\n<p>\n")
1340 (insert "\n<hr/>\n"))
1341 (throw 'nextline nil
))
1343 ;; Empty lines start a new paragraph. If hand-formatted lists
1344 ;; are not fully interpreted, lines starting with "-", "+", "*"
1345 ;; also start a new paragraph.
1346 (if (string-match "^ [-+*]-\\|^[ \t]*$" line
) (org-open-par))
1348 ;; Is this the start of a footnote?
1349 (when org-export-with-footnotes
1350 (when (and (boundp 'footnote-section-tag-regexp
)
1351 (string-match (concat "^" footnote-section-tag-regexp
)
1354 (throw 'nextline nil
))
1355 (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line
)
1356 (org-close-par-maybe)
1357 (let ((n (match-string 1 line
)))
1358 (setq org-par-open t
1361 (concat "<p class=\"footnote\">"
1362 (format org-export-html-footnote-format
1363 "<a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a>"))
1364 n n n
) t t line
)))))
1365 ;; Check if the line break needs to be conserved
1367 ((string-match "\\\\\\\\[ \t]*$" line
)
1368 (setq line
(replace-match "<br/>" t t line
)))
1369 (org-export-preserve-breaks
1370 (setq line
(concat line
"<br/>"))))
1372 ;; Check if a paragraph should be started
1374 (while (and org-par-open
1375 (string-match "\\\\par\\>" line start
))
1376 ;; Leave a space in the </p> so that the footnote matcher
1377 ;; does not see this.
1378 (if (not (get-text-property (match-beginning 0)
1379 'org-protected line
))
1380 (setq line
(replace-match "</p ><p >" t t line
)))
1381 (setq start
(match-end 0))))
1383 (insert line
"\n")))))
1385 ;; Properly close all local lists and other lists
1390 ;; Close any local lists before inserting a new header line
1391 (while local-list-type
1392 (org-close-li (car local-list-type
))
1393 (insert (format "</%sl>\n" (car local-list-type
)))
1394 (pop local-list-type
))
1395 (setq local-list-indent nil
1397 (org-html-level-start 1 nil umax
1398 (and org-export-with-toc
(<= level umax
))
1400 ;; the </div> to close the last text-... div.
1401 (when (and (> umax
0) first-heading-pos
) (insert "</div>\n"))
1404 (goto-char (point-min))
1405 (while (re-search-forward "<p class=\"footnote\">[^\000]*?\\(</p>\\|\\'\\)" nil t
)
1406 (push (match-string 0) footnotes
)
1407 (replace-match "" t t
)))
1409 (insert (format org-export-html-footnotes-section
1411 (mapconcat 'identity
(nreverse footnotes
) "\n"))
1413 (let ((bib (org-export-html-get-bibliography)))
1415 (insert "\n" bib
"\n")))
1417 (when (plist-get opt-plist
:auto-postamble
)
1418 (insert "<div id=\"postamble\">\n")
1419 (when (and org-export-author-info author
)
1420 (insert "<p class=\"author\"> "
1421 (nth 1 lang-words
) ": " author
"\n")
1422 (when (and org-export-email-info email
(string-match "\\S-" email
))
1423 (if (listp (split-string email
",+ *"))
1425 (insert "<a href=\"mailto:" e
"\"><"
1427 (split-string email
",+ *"))
1428 (insert "<a href=\"mailto:" email
"\"><"
1429 email
"></a>\n")))
1431 (when (and date org-export-time-stamp-file
)
1432 (insert "<p class=\"date\"> "
1433 (nth 2 lang-words
) ": "
1435 (when org-export-creator-info
1436 (insert (format "<p class=\"creator\">HTML generated by org-mode %s in emacs %s</p>\n"
1437 org-version emacs-major-version
)))
1438 (when org-export-html-validation-link
1439 (insert org-export-html-validation-link
"\n"))
1442 (if org-export-html-with-timestamp
1443 (insert org-export-html-html-helper-timestamp
))
1444 (org-export-html-insert-plist-item opt-plist
:postamble opt-plist
)
1445 (insert "\n</div>\n</body>\n</html>\n"))
1447 (unless (plist-get opt-plist
:buffer-will-be-killed
)
1449 (if (eq major-mode
(default-value 'major-mode
))
1452 ;; insert the table of contents
1453 (goto-char (point-min))
1455 (if (or (re-search-forward
1456 "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t
)
1458 "\\[TABLE-OF-CONTENTS\\]" nil t
))
1460 (goto-char (match-beginning 0))
1462 (goto-char first-heading-pos
)
1463 (when (looking-at "\\s-*</p>")
1464 (goto-char (match-end 0))
1466 (insert "<div id=\"table-of-contents\">\n")
1467 (mapc 'insert thetoc
)
1468 (insert "</div>\n"))
1469 ;; remove empty paragraphs and lists
1470 (goto-char (point-min))
1471 (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t
)
1473 (goto-char (point-min))
1474 (while (re-search-forward "<li>[ \r\n\t]*</li>\n?" nil t
)
1476 (goto-char (point-min))
1477 (while (re-search-forward "</ul>\\s-*<ul>\n?" nil t
)
1479 ;; Convert whitespace place holders
1480 (goto-char (point-min))
1482 (while (setq beg
(next-single-property-change (point) 'org-whitespace
))
1483 (setq n
(get-text-property beg
'org-whitespace
)
1484 end
(next-single-property-change beg
'org-whitespace
))
1486 (delete-region beg end
)
1487 (insert (format "<span style=\"visibility:hidden;\">%s</span>"
1488 (make-string n ?x
)))))
1489 ;; Remove empty lines at the beginning of the file.
1490 (goto-char (point-min))
1491 (when (looking-at "\\s-+\n") (replace-match ""))
1492 ;; Remove display properties
1493 (remove-text-properties (point-min) (point-max) '(display t
))
1495 (run-hooks 'org-export-html-final-hook
)
1496 (or to-buffer
(save-buffer))
1497 (goto-char (point-min))
1498 (or (org-export-push-to-kill-ring "HTML")
1499 (message "Exporting... done"))
1500 (if (eq to-buffer
'string
)
1501 (prog1 (buffer-substring (point-min) (point-max))
1502 (kill-buffer (current-buffer)))
1503 (current-buffer)))))
1505 (defun org-export-html-insert-plist-item (plist key
&rest args
)
1506 (let ((item (plist-get plist key
)))
1507 (cond ((functionp item
)
1512 (defun org-export-html-format-href (s)
1513 "Make sure the S is valid as a href reference in an XHTML document."
1516 (while (string-match "&" s start
)
1517 (setq start
(+ (match-beginning 0) 3)
1518 s
(replace-match "&" t t s
)))))
1521 (defun org-export-html-format-desc (s)
1522 "Make sure the S is valid as a description in a link."
1523 (if (and s
(not (get-text-property 1 'org-protected s
)))
1525 (org-html-do-expand s
))
1528 (defun org-export-html-format-image (src par-open
)
1529 "Create image tag with source and attributes."
1531 (if (string-match "^ltxpng/" src
)
1532 (format "<img src=\"%s\" alt=\"%s\"/>"
1533 src
(org-find-text-property-in-string 'org-latex-src src
))
1534 (let* ((caption (org-find-text-property-in-string 'org-caption src
))
1535 (attr (org-find-text-property-in-string 'org-attributes src
))
1536 (label (org-find-text-property-in-string 'org-label src
)))
1537 (setq caption
(and caption
(org-html-do-expand caption
)))
1540 (format "%s<div %sclass=\"figure\">
1542 (if org-par-open
"</p>\n" "")
1543 (if label
(format "id=\"%s\" " label
) "")))
1544 (format "<img src=\"%s\"%s />"
1546 (if (string-match "\\<alt=" (or attr
""))
1548 (concat " " attr
" alt=\"" src
"\"")))
1552 (concat "\n<p>" caption
"</p>")
1553 (if org-par-open
"\n<p>" ""))))))))
1555 (defun org-export-html-get-bibliography ()
1556 "Find bibliography, cut it out and return it."
1558 (let (beg end
(cnt 1) bib
)
1560 (goto-char (point-min))
1561 (when (re-search-forward "^[ \t]*<div \\(id\\|class\\)=\"bibliography\"" nil t
)
1562 (setq beg
(match-beginning 0))
1563 (while (re-search-forward "</?div\\>" nil t
)
1564 (setq cnt
(+ cnt
(if (string= (match-string 0) "<div") +1 -
1)))
1566 (and (looking-at ">") (forward-char 1))
1567 (setq bib
(buffer-substring beg
(point)))
1568 (delete-region beg
(point))
1569 (throw 'exit bib
))))
1572 (defvar org-table-number-regexp
) ; defined in org-table.el
1573 (defun org-format-table-html (lines olines
)
1574 "Find out which HTML converter to use and return the HTML code."
1576 (setq lines
(org-split-string lines
"\n")))
1577 (if (string-match "^[ \t]*|" (car lines
))
1578 ;; A normal org table
1579 (org-format-org-table-html lines
)
1580 ;; Table made by table.el - test for spanning
1581 (let* ((hlines (delq nil
(mapcar
1583 (if (string-match "^[ \t]*\\+-" x
) x
1586 (first (car hlines
))
1587 (ll (and (string-match "\\S-+" first
)
1588 (match-string 0 first
)))
1589 (re (concat "^[ \t]*" (regexp-quote ll
)))
1590 (spanning (delq nil
(mapcar (lambda (x) (not (string-match re x
)))
1592 (if (and (not spanning
)
1593 (not org-export-prefer-native-exporter-for-tables
))
1594 ;; We can use my own converter with HTML conversions
1595 (org-format-table-table-html lines
)
1596 ;; Need to use the code generator in table.el, with the original text.
1597 (org-format-table-table-html-using-table-generate-source olines
)))))
1599 (defvar org-table-number-fraction
) ; defined in org-table.el
1600 (defun org-format-org-table-html (lines &optional splice
)
1601 "Format a table into HTML."
1602 (require 'org-table
)
1603 ;; Get rid of hlines at beginning and end
1604 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1605 (setq lines
(nreverse lines
))
1606 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1607 (setq lines
(nreverse lines
))
1608 (when org-export-table-remove-special-lines
1609 ;; Check if the table has a marking column. If yes remove the
1610 ;; column and the special lines
1611 (setq lines
(org-table-clean-before-export lines
)))
1613 (let* ((caption (org-find-text-property-in-string 'org-caption
(car lines
)))
1614 (label (org-find-text-property-in-string 'org-label
(car lines
)))
1615 (attributes (org-find-text-property-in-string 'org-attributes
1617 (html-table-tag (org-export-splice-attributes
1618 html-table-tag attributes
))
1619 (head (and org-export-highlight-first-table-line
1621 (lambda (x) (string-match "^[ \t]*|-" x
))
1625 tbopen line fields html gr colgropen rowstart rowend
)
1626 (setq caption
(and caption
(org-html-do-expand caption
)))
1627 (if splice
(setq head nil
))
1628 (unless splice
(push (if head
"<thead>" "<tbody>") html
))
1630 (while (setq line
(pop lines
))
1632 (if (string-match "^[ \t]*|-" line
)
1635 (push (if head
"</thead>" "</tbody>") html
)
1636 (if lines
(push "<tbody>" html
) (setq tbopen nil
)))
1637 (setq head nil
) ;; head ends here, first time around
1639 (throw 'next-line t
)))
1640 ;; Break the line into fields
1641 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
1642 (unless fnum
(setq fnum
(make-vector (length fields
) 0)))
1643 (setq nline
(1+ nline
) i -
1
1644 rowstart
(eval (car org-export-table-row-tags
))
1645 rowend
(eval (cdr org-export-table-row-tags
)))
1646 (push (concat rowstart
1650 (if (and (< i nline
)
1651 (string-match org-table-number-regexp x
))
1652 (incf (aref fnum i
)))
1656 (format (car org-export-table-header-tags
) "col")
1658 (cdr org-export-table-header-tags
)))
1659 ((and (= i
0) org-export-html-table-use-header-tags-for-first-column
)
1661 (format (car org-export-table-header-tags
) "row")
1663 (cdr org-export-table-header-tags
)))
1665 (concat (car org-export-table-data-tags
) x
1666 (cdr org-export-table-data-tags
)))))
1670 (unless splice
(if tbopen
(push "</tbody>" html
)))
1671 (unless splice
(push "</table>\n" html
))
1672 (setq html
(nreverse html
))
1674 ;; Put in col tags with the alignment (unfortunately often ignored...)
1675 (unless (car org-table-colgroup-info
)
1676 (setq org-table-colgroup-info
1677 (cons :start
(cdr org-table-colgroup-info
))))
1680 (setq gr
(pop org-table-colgroup-info
))
1681 (format "%s<col align=\"%s\" />%s"
1682 (if (memq gr
'(:start
:startend
))
1684 (if colgropen
"</colgroup>\n<colgroup>" "<colgroup>")
1687 (if (> (/ (float x
) nline
) org-table-number-fraction
)
1689 (if (memq gr
'(:end
:startend
))
1690 (progn (setq colgropen nil
) "</colgroup>")
1694 (if colgropen
(setq html
(cons (car html
) (cons "</colgroup>" (cdr html
)))))
1695 ;; Since the output of HTML table formatter can also be used in
1696 ;; DocBook document, we want to always include the caption to make
1697 ;; DocBook XML file valid.
1698 (push (format "<caption>%s</caption>" (or caption
"")) html
)
1699 (when label
(push (format "<a name=\"%s\" id=\"%s\"></a>" label label
)
1701 (push html-table-tag html
))
1702 (concat (mapconcat 'identity html
"\n") "\n")))
1704 (defun org-export-splice-attributes (tag attributes
)
1705 "Read attributes in string ATTRIBUTES, add and replace in HTML tag TAG."
1706 (if (not attributes
)
1708 (let (oldatt newatt
)
1709 (setq oldatt
(org-extract-attributes-from-string tag
)
1711 newatt
(cdr (org-extract-attributes-from-string attributes
)))
1713 (setq oldatt
(plist-put oldatt
(pop newatt
) (pop newatt
))))
1714 (if (string-match ">" tag
)
1716 (replace-match (concat (org-attributes-to-string oldatt
) ">")
1720 (defun org-format-table-table-html (lines)
1721 "Format a table generated by table.el into HTML.
1722 This conversion does *not* use `table-generate-source' from table.el.
1723 This has the advantage that Org-mode's HTML conversions can be used.
1724 But it has the disadvantage, that no cell- or row-spanning is allowed."
1725 (let (line field-buffer
1726 (head org-export-highlight-first-table-line
)
1727 fields html empty i
)
1728 (setq html
(concat html-table-tag
"\n"))
1729 (while (setq line
(pop lines
))
1730 (setq empty
" ")
1732 (if (string-match "^[ \t]*\\+-" line
)
1743 (if (equal x
"") (setq x empty
))
1746 (format (car org-export-table-header-tags
) "col")
1748 (cdr org-export-table-header-tags
))
1749 (concat (car org-export-table-data-tags
) x
1750 (cdr org-export-table-data-tags
))))
1754 (setq field-buffer nil
)))
1756 (throw 'next-line t
)))
1757 ;; Break the line into fields and store the fields
1758 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
1760 (setq field-buffer
(mapcar
1762 (concat x
"<br/>" (pop fields
)))
1764 (setq field-buffer fields
))))
1765 (setq html
(concat html
"</table>\n"))
1768 (defun org-format-table-table-html-using-table-generate-source (lines)
1769 "Format a table into html, using `table-generate-source' from table.el.
1770 This has the advantage that cell- or row-spanning is allowed.
1771 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
1773 (with-current-buffer (get-buffer-create " org-tmp1 ")
1775 (insert (mapconcat 'identity lines
"\n"))
1776 (goto-char (point-min))
1777 (if (not (re-search-forward "|[^+]" nil t
))
1778 (error "Error processing table"))
1779 (table-recognize-table)
1780 (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
1781 (table-generate-source 'html
" org-tmp2 ")
1782 (set-buffer " org-tmp2 ")
1783 (buffer-substring (point-min) (point-max))))
1785 (defun org-export-splice-style (style extra
)
1786 "Splice EXTRA into STYLE, just before \"</style>\"."
1787 (if (and (stringp extra
)
1788 (string-match "\\S-" extra
)
1789 (string-match "</style>" style
))
1790 (concat (substring style
0 (match-beginning 0))
1792 (substring style
(match-beginning 0)))
1795 (defun org-html-handle-time-stamps (s)
1796 "Format time stamps in string S, or remove them."
1799 (while (string-match org-maybe-keyword-time-regexp s
)
1800 (or b
(setq b
(substring s
0 (match-beginning 0))))
1802 r
(substring s
0 (match-beginning 0))
1803 " @<span class=\"timestamp-wrapper\">"
1805 (format "@<span class=\"timestamp-kwd\">%s @</span>"
1806 (match-string 1 s
)))
1807 (format " @<span class=\"timestamp\">%s@</span>"
1809 (org-translate-time (match-string 3 s
)) 1 -
1))
1811 s
(substring s
(match-end 0))))
1812 ;; Line break if line started and ended with time stamp stuff
1815 (setq r
(concat r s
))
1816 (unless (string-match "\\S-" (concat b s
))
1817 (setq r
(concat r
"@<br/>")))
1820 (defvar htmlize-buffer-places
) ; from htmlize.el
1821 (defun org-export-htmlize-region-for-paste (beg end
)
1822 "Convert the region to HTML, using htmlize.el.
1823 This is much like `htmlize-region-for-paste', only that it uses
1824 the settings define in the org-... variables."
1825 (let* ((htmlize-output-type org-export-htmlize-output-type
)
1826 (htmlize-css-name-prefix org-export-htmlize-css-font-prefix
)
1827 (htmlbuf (htmlize-region beg end
)))
1829 (with-current-buffer htmlbuf
1830 (buffer-substring (plist-get htmlize-buffer-places
'content-start
)
1831 (plist-get htmlize-buffer-places
'content-end
)))
1832 (kill-buffer htmlbuf
))))
1835 (defun org-export-htmlize-generate-css ()
1836 "Create the CSS for all font definitions in the current Emacs session.
1837 Use this to create face definitions in your CSS style file that can then
1838 be used by code snippets transformed by htmlize.
1839 This command just produces a buffer that contains class definitions for all
1840 faces used in the current Emacs session. You can copy and paste the ones you
1841 need into your CSS file.
1843 If you then set `org-export-htmlize-output-type' to `css', calls to
1844 the function `org-export-htmlize-region-for-paste' will produce code
1845 that uses these same face definitions."
1848 (and (get-buffer "*html*") (kill-buffer "*html*"))
1850 (let ((fl (face-list))
1851 (htmlize-css-name-prefix "org-")
1852 (htmlize-output-type 'css
)
1854 (while (setq f
(pop fl
)
1855 i
(and f
(face-attribute f
:inherit
)))
1856 (when (and (symbolp f
) (or (not i
) (not (listp i
))))
1857 (insert (org-add-props (copy-sequence "1") nil
'face f
))))
1858 (htmlize-region (point-min) (point-max))))
1859 (switch-to-buffer "*html*")
1860 (goto-char (point-min))
1861 (if (re-search-forward "<style" nil t
)
1862 (delete-region (point-min) (match-beginning 0)))
1863 (if (re-search-forward "</style>" nil t
)
1864 (delete-region (1+ (match-end 0)) (point-max)))
1865 (beginning-of-line 1)
1866 (if (looking-at " +") (replace-match ""))
1867 (goto-char (point-min)))
1869 (defun org-html-protect (s)
1870 ;; convert & to &, < to < and > to >
1872 (while (string-match "&" s start
)
1873 (setq s
(replace-match "&" t t s
)
1874 start
(1+ (match-beginning 0))))
1875 (while (string-match "<" s
)
1876 (setq s
(replace-match "<" t t s
)))
1877 (while (string-match ">" s
)
1878 (setq s
(replace-match ">" t t s
)))
1879 ; (while (string-match "\"" s)
1880 ; (setq s (replace-match """ t t s)))
1884 (defun org-html-expand (string)
1885 "Prepare STRING for HTML export. Applies all active conversions.
1886 If there are links in the string, don't modify these."
1887 (let* ((re (concat org-bracket-link-regexp
"\\|"
1888 (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$")))
1890 (if (string-match "^[ \t]*\\+-[-+]*\\+[ \t]*$" string
)
1892 (while (setq m
(string-match re string
))
1893 (setq s
(substring string
0 m
)
1894 l
(match-string 0 string
)
1895 string
(substring string
(match-end 0)))
1896 (push (org-html-do-expand s
) res
)
1898 (push (org-html-do-expand string
) res
)
1899 (apply 'concat
(nreverse res
)))))
1901 (defun org-html-do-expand (s)
1902 "Apply all active conversions to translate special ASCII to HTML."
1903 (setq s
(org-html-protect s
))
1904 (if org-export-html-expand
1905 (while (string-match "@<\\([^&]*\\)>" s
)
1906 (setq s
(replace-match "<\\1>" t nil s
))))
1907 (if org-export-with-emphasize
1908 (setq s
(org-export-html-convert-emphasize s
)))
1909 (if org-export-with-special-strings
1910 (setq s
(org-export-html-convert-special-strings s
)))
1911 (if org-export-with-sub-superscripts
1912 (setq s
(org-export-html-convert-sub-super s
)))
1913 (if org-export-with-TeX-macros
1914 (let ((start 0) wd ass
)
1915 (while (setq start
(string-match "\\\\\\([a-zA-Z]+\\)\\({}\\)?"
1917 (if (get-text-property (match-beginning 0) 'org-protected s
)
1918 (setq start
(match-end 0))
1919 (setq wd
(match-string 1 s
))
1920 (if (setq ass
(assoc wd org-html-entities
))
1921 (setq s
(replace-match (or (cdr ass
)
1922 (concat "&" (car ass
) ";"))
1924 (setq start
(+ start
(length wd
))))))))
1927 (defun org-export-html-convert-special-strings (string)
1928 "Convert special characters in STRING to HTML."
1929 (let ((all org-export-html-special-string-regexps
)
1931 (while (setq a
(pop all
))
1932 (setq re
(car a
) rpl
(cdr a
) start
0)
1933 (while (string-match re string start
)
1934 (if (get-text-property (match-beginning 0) 'org-protected string
)
1935 (setq start
(match-end 0))
1936 (setq string
(replace-match rpl t nil string
)))))
1939 (defun org-export-html-convert-sub-super (string)
1940 "Convert sub- and superscripts in STRING to HTML."
1941 (let (key c
(s 0) (requireb (eq org-export-with-sub-superscripts
'{})))
1942 (while (string-match org-match-substring-regexp string s
)
1944 ((and requireb
(match-end 8)) (setq s
(match-end 2)))
1945 ((get-text-property (match-beginning 2) 'org-protected string
)
1946 (setq s
(match-end 2)))
1948 (setq s
(match-end 1)
1949 key
(if (string= (match-string 2 string
) "_") "sub" "sup")
1950 c
(or (match-string 8 string
)
1951 (match-string 6 string
)
1952 (match-string 5 string
))
1953 string
(replace-match
1954 (concat (match-string 1 string
)
1955 "<" key
">" c
"</" key
">")
1957 (while (string-match "\\\\\\([_^]\\)" string
)
1958 (setq string
(replace-match (match-string 1 string
) t t string
)))
1961 (defun org-export-html-convert-emphasize (string)
1964 (while (string-match org-emph-re string s
)
1966 (substring string
(match-beginning 3) (1+ (match-beginning 3)))
1967 (substring string
(match-beginning 4) (1+ (match-beginning 4)))))
1968 (setq s
(match-beginning 0)
1971 (match-string 1 string
)
1972 (nth 2 (assoc (match-string 3 string
) org-emphasis-alist
))
1973 (match-string 4 string
)
1974 (nth 3 (assoc (match-string 3 string
)
1975 org-emphasis-alist
))
1976 (match-string 5 string
))
1977 string
(replace-match rpl t t string
)
1978 s
(+ s
(- (length rpl
) 2)))
1982 (defun org-open-par ()
1983 "Insert <p>, but first close previous paragraph if any."
1984 (org-close-par-maybe)
1986 (setq org-par-open t
))
1987 (defun org-close-par-maybe ()
1988 "Close paragraph if there is one open."
1991 (setq org-par-open nil
)))
1992 (defun org-close-li (&optional type
)
1993 "Close <li> if necessary."
1994 (org-close-par-maybe)
1995 (insert (if (equal type
"d") "</dd>\n" "</li>\n")))
1997 (defvar in-local-list
)
1998 (defvar local-list-indent
)
1999 (defvar local-list-type
)
2000 (defun org-export-html-close-lists-maybe (line)
2001 (let ((ind (or (get-text-property 0 'original-indentation line
)))
2002 ; (and (string-match "\\S-" line)
2003 ; (org-get-indentation line))))
2006 (while (and in-local-list
2007 (<= ind
(car local-list-indent
)))
2009 (org-close-li (car local-list-type
))
2010 (insert (format "</%sl>\n" (car local-list-type
)))
2011 (pop local-list-type
) (pop local-list-indent
)
2012 (setq in-local-list local-list-indent
))
2013 (and didclose
(org-open-par)))))
2015 (defvar body-only
) ; dynamically scoped into this.
2016 (defun org-html-level-start (level title umax with-toc head-count
)
2017 "Insert a new level in HTML export.
2018 When TITLE is nil, just close all open levels."
2019 (org-close-par-maybe)
2020 (let* ((target (and title
(org-get-text-property-any 0 'target title
)))
2021 (extra-targets (assoc target org-export-target-aliases
))
2022 (extra-class (and title
(org-get-text-property-any 0 'html-container-class title
)))
2023 (preferred (cdr (assoc target org-export-preferred-target-alist
)))
2024 (remove (or preferred target
))
2026 snumber href suffix
)
2027 (setq extra-targets
(remove remove extra-targets
))
2029 (mapconcat (lambda (x)
2030 (if (org-uuidgen-p x
) (setq x
(concat "ID-" x
)))
2031 (format "<a name=\"%s\" id=\"%s\"></a>"
2036 (if (aref org-levels-open
(1- l
))
2038 (org-html-level-close l umax
)
2039 (aset org-levels-open
(1- l
) nil
)))
2042 ;; If title is nil, this means this function is called to close
2043 ;; all levels, so the rest is done only if title is given
2044 (when (string-match (org-re "\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title
)
2045 (setq title
(replace-match
2046 (if org-export-with-tags
2049 " <span class=\"tag\">"
2052 (format "<span class=\"%s\">%s</span>"
2053 (org-export-html-get-tag-class-name x
)
2055 (org-split-string (match-string 1 title
) ":")
2062 (if (aref org-levels-open
(1- level
))
2066 (insert (format "<li id=\"%s\">" target
) extra-targets title
"<br/>\n")
2067 (insert "<li>" title
"<br/>\n")))
2068 (aset org-levels-open
(1- level
) t
)
2069 (org-close-par-maybe)
2071 (insert (format "<ul>\n<li id=\"%s\">" target
)
2072 extra-targets title
"<br/>\n")
2073 (insert "<ul>\n<li>" title
"<br/>\n"))))
2074 (aset org-levels-open
(1- level
) t
)
2075 (setq snumber
(org-section-number level
))
2076 (setq level
(+ level org-export-html-toplevel-hlevel -
1))
2077 (if (and org-export-with-section-numbers
(not body-only
))
2079 (format "<span class=\"section-number-%d\">%s</span>"
2082 (unless (= head-count
1) (insert "\n</div>\n"))
2083 (setq href
(cdr (assoc (concat "sec-" snumber
) org-export-preferred-target-alist
)))
2084 (setq suffix
(or href snumber
))
2085 (setq href
(or href
(concat "sec-" snumber
)))
2086 (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"
2087 suffix level
(if extra-class
(concat " " extra-class
) "")
2090 title level level suffix
))
2093 (defun org-export-html-get-tag-class-name (tag)
2094 "Turn tag into a valid class name.
2095 Replaces invalid characters with \"_\" and then prepends a prefix."
2097 (while (string-match "[^a-zA-Z0-9_]" tag
)
2098 (setq tag
(replace-match "_" t t tag
))))
2099 (concat org-export-html-tag-class-prefix tag
))
2101 (defun org-export-html-get-todo-kwd-class-name (kwd)
2102 "Turn todo keyword into a valid class name.
2103 Replaces invalid characters with \"_\" and then prepends a prefix."
2105 (while (string-match "[^a-zA-Z0-9_]" kwd
)
2106 (setq kwd
(replace-match "_" t t kwd
))))
2107 (concat org-export-html-todo-kwd-class-prefix kwd
))
2109 (defun org-html-level-close (level max-outline-level
)
2110 "Terminate one level in HTML export."
2111 (if (<= level max-outline-level
)
2114 (insert "</ul>\n")))
2118 ;; arch-tag: 8109d84d-eb8f-460b-b1a8-f45f3a6c7ea1
2119 ;;; org-html.el ends here