Added default styles for org-info.js
[org-mode.git] / lisp / org-exp.el
blob7657e9581f25b8780e67eada585c9bb91f2c7de3
1 ;;; org-exp.el --- ASCII, HTML, XOXO and iCalendar export for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;; Version: 6.06b
9 ;;
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;; Commentary:
28 (require 'org)
29 (require 'org-agenda)
30 (eval-and-compile
31 (require 'cl))
33 (declare-function org-export-latex-preprocess "org-export-latex" ())
34 (declare-function org-agenda-skip "org-agenda" ())
35 (declare-function org-infojs-options-inbuffer-template "org-jsinfo" ())
36 (declare-function htmlize-region "ext:htmlize" (beg end))
37 (defvar htmlize-buffer-places) ; from htmlize.el
39 (defgroup org-export nil
40 "Options for exporting org-listings."
41 :tag "Org Export"
42 :group 'org)
44 (defgroup org-export-general nil
45 "General options for exporting Org-mode files."
46 :tag "Org Export General"
47 :group 'org-export)
49 ;; FIXME
50 (defvar org-export-publishing-directory nil)
52 (defcustom org-export-run-in-background nil
53 "Non-nil means export and publishing commands will run in background.
54 This works by starting up a separate Emacs process visiting the same file
55 and doing the export from there.
56 Not all export commands are affected by this - only the ones which
57 actually write to a file, and that do not depend on the buffer state.
59 If this option is nil, you can still get background export by calling
60 `org-export' with a double prefix arg: `C-u C-u C-c C-e'.
62 If this option is t, the double prefix can be used to exceptionally
63 force an export command into the current process."
64 :group 'org-export-general
65 :type 'boolean)
67 (defcustom org-export-with-special-strings t
68 "Non-nil means, interpret \"\-\", \"--\" and \"---\" for export.
69 When this option is turned on, these strings will be exported as:
71 Org HTML LaTeX
72 -----+----------+--------
73 \\- &shy; \\-
74 -- &ndash; --
75 --- &mdash; ---
76 ... &hellip; \ldots
78 This option can also be set with the +OPTIONS line, e.g. \"-:nil\"."
79 :group 'org-export-translation
80 :type 'boolean)
82 (defcustom org-export-language-setup
83 '(("en" "Author" "Date" "Table of Contents")
84 ("cs" "Autor" "Datum" "Obsah")
85 ("da" "Ophavsmand" "Dato" "Indhold")
86 ("de" "Autor" "Datum" "Inhaltsverzeichnis")
87 ("es" "Autor" "Fecha" "\xcdndice")
88 ("fr" "Auteur" "Date" "Table des mati\xe8res")
89 ("it" "Autore" "Data" "Indice")
90 ("nl" "Auteur" "Datum" "Inhoudsopgave")
91 ("no" "Forfatter" "Dato" "Innhold")
92 ("nb" "Forfatter" "Dato" "Innhold") ;; nb = Norsk (bokm.l)
93 ("nn" "Forfattar" "Dato" "Innhald") ;; nn = Norsk (nynorsk)
94 ("sv" "F\xf6rfattarens" "Datum" "Inneh\xe5ll"))
95 "Terms used in export text, translated to different languages.
96 Use the variable `org-export-default-language' to set the language,
97 or use the +OPTION lines for a per-file setting."
98 :group 'org-export-general
99 :type '(repeat
100 (list
101 (string :tag "HTML language tag")
102 (string :tag "Author")
103 (string :tag "Date")
104 (string :tag "Table of Contents"))))
106 (defcustom org-export-default-language "en"
107 "The default language of HTML export, as a string.
108 This should have an association in `org-export-language-setup'."
109 :group 'org-export-general
110 :type 'string)
112 (defcustom org-export-skip-text-before-1st-heading nil
113 "Non-nil means, skip all text before the first headline when exporting.
114 When nil, that text is exported as well."
115 :group 'org-export-general
116 :type 'boolean)
118 (defcustom org-export-headline-levels 3
119 "The last level which is still exported as a headline.
120 Inferior levels will produce itemize lists when exported.
121 Note that a numeric prefix argument to an exporter function overrides
122 this setting.
124 This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
125 :group 'org-export-general
126 :type 'number)
128 (defcustom org-export-with-section-numbers t
129 "Non-nil means, add section numbers to headlines when exporting.
131 This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
132 :group 'org-export-general
133 :type 'boolean)
135 (defcustom org-export-section-number-format '((("1" ".")) . "")
136 "Format of section numbers for export.
137 The variable has two components.
138 1. A list of lists, each indicating a counter type and a separator.
139 The counter type can be any of \"1\", \"A\", \"a\", \"I\", or \"a\".
140 It causes causes numeric, alphabetic, or roman counters, respectively.
141 The separator is only used if another counter for a subsection is being
142 added.
143 If there are more numbered section levels than entries in this lists,
144 then the last entry will be reused.
145 2. A terminator string that will be added after the entire
146 section number."
147 :group 'org-export-general
148 :type '(cons
149 (repeat
150 (list
151 (string :tag "Counter Type")
152 (string :tag "Separator ")))
153 (string :tag "Terminator")))
155 (defcustom org-export-with-toc t
156 "Non-nil means, create a table of contents in exported files.
157 The TOC contains headlines with levels up to`org-export-headline-levels'.
158 When an integer, include levels up to N in the toc, this may then be
159 different from `org-export-headline-levels', but it will not be allowed
160 to be larger than the number of headline levels.
161 When nil, no table of contents is made.
163 Headlines which contain any TODO items will be marked with \"(*)\" in
164 ASCII export, and with red color in HTML output, if the option
165 `org-export-mark-todo-in-toc' is set.
167 In HTML output, the TOC will be clickable.
169 This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"
170 or \"toc:3\"."
171 :group 'org-export-general
172 :type '(choice
173 (const :tag "No Table of Contents" nil)
174 (const :tag "Full Table of Contents" t)
175 (integer :tag "TOC to level")))
177 (defcustom org-export-mark-todo-in-toc nil
178 "Non-nil means, mark TOC lines that contain any open TODO items."
179 :group 'org-export-general
180 :type 'boolean)
182 (defcustom org-export-preserve-breaks nil
183 "Non-nil means, preserve all line breaks when exporting.
184 Normally, in HTML output paragraphs will be reformatted. In ASCII
185 export, line breaks will always be preserved, regardless of this variable.
187 This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
188 :group 'org-export-general
189 :type 'boolean)
191 (defcustom org-export-with-archived-trees 'headline
192 "Whether subtrees with the ARCHIVE tag should be exported.
193 This can have three different values
194 nil Do not export, pretend this tree is not present
195 t Do export the entire tree
196 headline Only export the headline, but skip the tree below it."
197 :group 'org-export-general
198 :group 'org-archive
199 :type '(choice
200 (const :tag "not at all" nil)
201 (const :tag "headline only" 'headline)
202 (const :tag "entirely" t)))
204 (defcustom org-export-author-info t
205 "Non-nil means, insert author name and email into the exported file.
207 This option can also be set with the +OPTIONS line,
208 e.g. \"author-info:nil\"."
209 :group 'org-export-general
210 :type 'boolean)
212 (defcustom org-export-creator-info t
213 "Non-nil means, the postamle should contain a creator sentence.
214 This sentence is \"HTML generated by org-mode XX in emacs XXX\"."
215 :group 'org-export-general
216 :type 'boolean)
218 (defcustom org-export-time-stamp-file t
219 "Non-nil means, insert a time stamp into the exported file.
220 The time stamp shows when the file was created.
222 This option can also be set with the +OPTIONS line,
223 e.g. \"timestamp:nil\"."
224 :group 'org-export-general
225 :type 'boolean)
227 (defcustom org-export-with-timestamps t
228 "If nil, do not export time stamps and associated keywords."
229 :group 'org-export-general
230 :type 'boolean)
232 (defcustom org-export-remove-timestamps-from-toc t
233 "If nil, remove timestamps from the table of contents entries."
234 :group 'org-export-general
235 :type 'boolean)
237 (defcustom org-export-with-tags 'not-in-toc
238 "If nil, do not export tags, just remove them from headlines.
239 If this is the symbol `not-in-toc', tags will be removed from table of
240 contents entries, but still be shown in the headlines of the document.
242 This option can also be set with the +OPTIONS line, e.g. \"tags:nil\"."
243 :group 'org-export-general
244 :type '(choice
245 (const :tag "Off" nil)
246 (const :tag "Not in TOC" not-in-toc)
247 (const :tag "On" t)))
249 (defcustom org-export-with-drawers nil
250 "Non-nil means, export with drawers like the property drawer.
251 When t, all drawers are exported. This may also be a list of
252 drawer names to export."
253 :group 'org-export-general
254 :type '(choice
255 (const :tag "All drawers" t)
256 (const :tag "None" nil)
257 (repeat :tag "Selected drawers"
258 (string :tag "Drawer name"))))
260 (defvar org-export-preprocess-hook nil
261 "Hook for preprocessing an export buffer.
262 Pretty much the first thing when exporting is running this hook.")
264 (defgroup org-export-translation nil
265 "Options for translating special ascii sequences for the export backends."
266 :tag "Org Export Translation"
267 :group 'org-export)
269 (defcustom org-export-with-emphasize t
270 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
271 If the export target supports emphasizing text, the word will be
272 typeset in bold, italic, or underlined, respectively. Works only for
273 single words, but you can say: I *really* *mean* *this*.
274 Not all export backends support this.
276 This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
277 :group 'org-export-translation
278 :type 'boolean)
280 (defcustom org-export-with-footnotes t
281 "If nil, export [1] as a footnote marker.
282 Lines starting with [1] will be formatted as footnotes.
284 This option can also be set with the +OPTIONS line, e.g. \"f:nil\"."
285 :group 'org-export-translation
286 :type 'boolean)
288 (defcustom org-export-with-sub-superscripts t
289 "Non-nil means, interpret \"_\" and \"^\" for export.
290 When this option is turned on, you can use TeX-like syntax for sub- and
291 superscripts. Several characters after \"_\" or \"^\" will be
292 considered as a single item - so grouping with {} is normally not
293 needed. For example, the following things will be parsed as single
294 sub- or superscripts.
296 10^24 or 10^tau several digits will be considered 1 item.
297 10^-12 or 10^-tau a leading sign with digits or a word
298 x^2-y^3 will be read as x^2 - y^3, because items are
299 terminated by almost any nonword/nondigit char.
300 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
302 Still, ambiguity is possible - so when in doubt use {} to enclose the
303 sub/superscript. If you set this variable to the symbol `{}',
304 the braces are *required* in order to trigger interpretations as
305 sub/superscript. This can be helpful in documents that need \"_\"
306 frequently in plain text.
308 Not all export backends support this, but HTML does.
310 This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
311 :group 'org-export-translation
312 :type '(choice
313 (const :tag "Always interpret" t)
314 (const :tag "Only with braces" {})
315 (const :tag "Never interpret" nil)))
317 (defcustom org-export-with-special-strings t
318 "Non-nil means, interpret \"\-\", \"--\" and \"---\" for export.
319 When this option is turned on, these strings will be exported as:
321 \\- : &shy;
322 -- : &ndash;
323 --- : &mdash;
325 Not all export backends support this, but HTML does.
327 This option can also be set with the +OPTIONS line, e.g. \"-:nil\"."
328 :group 'org-export-translation
329 :type 'boolean)
331 (defcustom org-export-with-TeX-macros t
332 "Non-nil means, interpret simple TeX-like macros when exporting.
333 For example, HTML export converts \\alpha to &alpha; and \\AA to &Aring;.
334 No only real TeX macros will work here, but the standard HTML entities
335 for math can be used as macro names as well. For a list of supported
336 names in HTML export, see the constant `org-html-entities'.
337 Not all export backends support this.
339 This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
340 :group 'org-export-translation
341 :group 'org-export-latex
342 :type 'boolean)
344 (defcustom org-export-with-LaTeX-fragments nil
345 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
346 When set, the exporter will find LaTeX environments if the \\begin line is
347 the first non-white thing on a line. It will also find the math delimiters
348 like $a=b$ and \\( a=b \\) for inline math, $$a=b$$ and \\[ a=b \\] for
349 display math.
351 This option can also be set with the +OPTIONS line, e.g. \"LaTeX:t\"."
352 :group 'org-export-translation
353 :group 'org-export-latex
354 :type 'boolean)
356 (defcustom org-export-with-fixed-width t
357 "Non-nil means, lines starting with \":\" will be in fixed width font.
358 This can be used to have pre-formatted text, fragments of code etc. For
359 example:
360 : ;; Some Lisp examples
361 : (while (defc cnt)
362 : (ding))
363 will be looking just like this in also HTML. See also the QUOTE keyword.
364 Not all export backends support this.
366 This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
367 :group 'org-export-translation
368 :type 'boolean)
370 (defcustom org-match-sexp-depth 3
371 "Number of stacked braces for sub/superscript matching.
372 This has to be set before loading org.el to be effective."
373 :group 'org-export-translation
374 :type 'integer)
376 (defgroup org-export-tables nil
377 "Options for exporting tables in Org-mode."
378 :tag "Org Export Tables"
379 :group 'org-export)
381 (defcustom org-export-with-tables t
382 "If non-nil, lines starting with \"|\" define a table.
383 For example:
385 | Name | Address | Birthday |
386 |-------------+----------+-----------|
387 | Arthur Dent | England | 29.2.2100 |
389 Not all export backends support this.
391 This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
392 :group 'org-export-tables
393 :type 'boolean)
395 (defcustom org-export-highlight-first-table-line t
396 "Non-nil means, highlight the first table line.
397 In HTML export, this means use <th> instead of <td>.
398 In tables created with table.el, this applies to the first table line.
399 In Org-mode tables, all lines before the first horizontal separator
400 line will be formatted with <th> tags."
401 :group 'org-export-tables
402 :type 'boolean)
404 (defcustom org-export-table-remove-special-lines t
405 "Remove special lines and marking characters in calculating tables.
406 This removes the special marking character column from tables that are set
407 up for spreadsheet calculations. It also removes the entire lines
408 marked with `!', `_', or `^'. The lines with `$' are kept, because
409 the values of constants may be useful to have."
410 :group 'org-export-tables
411 :type 'boolean)
413 (defcustom org-export-prefer-native-exporter-for-tables nil
414 "Non-nil means, always export tables created with table.el natively.
415 Natively means, use the HTML code generator in table.el.
416 When nil, Org-mode's own HTML generator is used when possible (i.e. if
417 the table does not use row- or column-spanning). This has the
418 advantage, that the automatic HTML conversions for math symbols and
419 sub/superscripts can be applied. Org-mode's HTML generator is also
420 much faster."
421 :group 'org-export-tables
422 :type 'boolean)
424 (defgroup org-export-ascii nil
425 "Options specific for ASCII export of Org-mode files."
426 :tag "Org Export ASCII"
427 :group 'org-export)
429 (defcustom org-export-ascii-underline '(?\$ ?\# ?^ ?\~ ?\= ?\-)
430 "Characters for underlining headings in ASCII export.
431 In the given sequence, these characters will be used for level 1, 2, ..."
432 :group 'org-export-ascii
433 :type '(repeat character))
435 (defcustom org-export-ascii-bullets '(?* ?+ ?-)
436 "Bullet characters for headlines converted to lists in ASCII export.
437 The first character is used for the first lest level generated in this
438 way, and so on. If there are more levels than characters given here,
439 the list will be repeated.
440 Note that plain lists will keep the same bullets as the have in the
441 Org-mode file."
442 :group 'org-export-ascii
443 :type '(repeat character))
445 (defgroup org-export-xml nil
446 "Options specific for XML export of Org-mode files."
447 :tag "Org Export XML"
448 :group 'org-export)
450 (defgroup org-export-html nil
451 "Options specific for HTML export of Org-mode files."
452 :tag "Org Export HTML"
453 :group 'org-export)
455 (defcustom org-export-html-coding-system nil
456 "Coding system for HTML export, defaults to buffer-file-coding-system."
457 :group 'org-export-html
458 :type 'coding-system)
460 (defcustom org-export-html-extension "html"
461 "The extension for exported HTML files."
462 :group 'org-export-html
463 :type 'string)
465 (defcustom org-export-html-link-up ""
466 "Where should the \"UP\" link of exported HTML pages lead?"
467 :group 'org-export-html
468 :type '(string :tag "File or URL"))
470 (defcustom org-export-html-link-home ""
471 "Where should the \"HOME\" link of exported HTML pages lead?"
472 :group 'org-export-html
473 :type '(string :tag "File or URL"))
475 (defconst org-export-html-style-default
476 "<style type=\"text/css\">
477 html { font-family: Times, serif; font-size: 12pt; }
478 .title { text-align: center; }
479 .todo { color: red; }
480 .done { color: green; }
481 .tag { background-color:lightblue; font-weight:normal }
482 .target { }
483 .timestamp { color: grey }
484 .timestamp-kwd { color: CadetBlue }
485 p.verse { margin-left: 3% }
486 pre {
487 border: 1pt solid #AEBDCC;
488 background-color: #F3F5F7;
489 padding: 5pt;
490 font-family: courier, monospace;
491 font-size: 90%;
492 overflow:auto;
494 table { border-collapse: collapse; }
495 td, th { vertical-align: top; }
496 dt { font-weight: bold; }
498 .org-info-js_info-navigation { border-style:none; }
499 #org-info-js_console-label { font-size:10px; font-weight:bold;
500 white-space:nowrap; }
501 .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
502 font-weight:bold; }
504 </style>"
505 "The default style specification for exported HTML files.
506 Please use the variables `org-export-html-style' and
507 `org-export-html-style-extra' to add to this style.")
509 (defcustom org-export-html-style ""
510 "Org-wide style definitions for exported HTML files.
512 This variable needs to contain the full HTML structure to provide a style,
513 including the surrounding HTML tags. If you set the value of this variable,
514 you should consider to include definitions for the following classes:
515 title, todo, done, timestamp, timestamp-kwd, tag, target.
517 For example, a valid value would be:
519 <style type=\"text/css\">
520 p { font-weight: normal; color: gray; }
521 h1 { color: black; }
522 .title { text-align: center; }
523 .todo, .timestamp-kwd { color: red; }
524 .done { color: green; }
525 </style>
527 If you'd like to refer to en external style file, use something like
529 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
531 As the value of this option simply gets inserted into the HTML <head> header,
532 you can \"misuse\" it to add arbitrary text to the header.
533 See also the variable `org-export-html-style-extra'."
534 :group 'org-export-html
535 :type 'string)
536 ;;;###autoload
537 (put 'org-export-html-style 'safe-local-variable 'stringp)
539 (defcustom org-export-html-style-extra ""
540 "Additional style information for HTML export.
541 The value of this variable is inserted into the HTML buffer right after
542 the value of `org-export-html-style'. Use this variable for per-file
543 settings of style information, and do not forget to surround the style
544 settings with <style>...</style> tags."
545 :group 'org-export-html
546 :type 'string)
547 ;;;###autoload
548 (put 'org-export-html-style-extra 'safe-local-variable 'stringp)
551 (defcustom org-export-html-title-format "<h1 class=\"title\">%s</h1>\n"
552 "Format for typesetting the document title in HTML export."
553 :group 'org-export-html
554 :type 'string)
556 (defcustom org-export-html-toplevel-hlevel 2
557 "The <H> level for level 1 headings in HTML export."
558 :group 'org-export-html
559 :type 'string)
561 (defcustom org-export-html-link-org-files-as-html t
562 "Non-nil means, make file links to `file.org' point to `file.html'.
563 When org-mode is exporting an org-mode file to HTML, links to
564 non-html files are directly put into a href tag in HTML.
565 However, links to other Org-mode files (recognized by the
566 extension `.org.) should become links to the corresponding html
567 file, assuming that the linked org-mode file will also be
568 converted to HTML.
569 When nil, the links still point to the plain `.org' file."
570 :group 'org-export-html
571 :type 'boolean)
573 (defcustom org-export-html-inline-images 'maybe
574 "Non-nil means, inline images into exported HTML pages.
575 This is done using an <img> tag. When nil, an anchor with href is used to
576 link to the image. If this option is `maybe', then images in links with
577 an empty description will be inlined, while images with a description will
578 be linked only."
579 :group 'org-export-html
580 :type '(choice (const :tag "Never" nil)
581 (const :tag "Always" t)
582 (const :tag "When there is no description" maybe)))
584 ;; FIXME: rename
585 (defcustom org-export-html-expand t
586 "Non-nil means, for HTML export, treat @<...> as HTML tag.
587 When nil, these tags will be exported as plain text and therefore
588 not be interpreted by a browser.
590 This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
591 :group 'org-export-html
592 :type 'boolean)
594 (defcustom org-export-html-table-tag
595 "<table border=\"2\" cellspacing=\"0\" cellpadding=\"6\" rules=\"groups\" frame=\"hsides\">"
596 "The HTML tag that is used to start a table.
597 This must be a <table> tag, but you may change the options like
598 borders and spacing."
599 :group 'org-export-html
600 :type 'string)
602 (defcustom org-export-table-header-tags '("<th>" . "</th>")
603 "The opening tag for table header fields.
604 This is customizable so that alignment options can be specified."
605 :group 'org-export-tables
606 :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
608 (defcustom org-export-table-data-tags '("<td>" . "</td>")
609 "The opening tag for table data fields.
610 This is customizable so that alignment options can be specified."
611 :group 'org-export-tables
612 :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
614 (defcustom org-export-html-with-timestamp nil
615 "If non-nil, write `org-export-html-html-helper-timestamp'
616 into the exported HTML text. Otherwise, the buffer will just be saved
617 to a file."
618 :group 'org-export-html
619 :type 'boolean)
621 (defcustom org-export-html-html-helper-timestamp
622 "<br/><br/><hr><p><!-- hhmts start --> <!-- hhmts end --></p>\n"
623 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
624 :group 'org-export-html
625 :type 'string)
627 (defgroup org-export-htmlize nil
628 "Options for processing examples with htmlize.el."
629 :tag "Org Export Htmlize"
630 :group 'org-export-html)
632 (defcustom org-export-htmlize-output-type 'inline-css
633 "Output type to be used by htmlize when formatting code snippets.
634 Normally this is `inline-css', but if you have defined to appropriate
635 classes in your css style file, setting this to `css' means that the
636 fontification will use the class names.
637 See also the function `org-export-htmlize-generate-css'."
638 :group 'org-export-htmlize
639 :type '(choice (const css) (const inline-css)))
641 (defcustom org-export-htmlize-css-font-prefix "org-"
642 "The prefix for CSS class names for htmlize font specifications."
643 :group 'org-export-htmlize
644 :type 'string)
646 (defgroup org-export-icalendar nil
647 "Options specific for iCalendar export of Org-mode files."
648 :tag "Org Export iCalendar"
649 :group 'org-export)
651 (defcustom org-combined-agenda-icalendar-file "~/org.ics"
652 "The file name for the iCalendar file covering all agenda files.
653 This file is created with the command \\[org-export-icalendar-all-agenda-files].
654 The file name should be absolute, the file will be overwritten without warning."
655 :group 'org-export-icalendar
656 :type 'file)
658 (defcustom org-icalendar-combined-name "OrgMode"
659 "Calendar name for the combined iCalendar representing all agenda files."
660 :group 'org-export-icalendar
661 :type 'string)
663 (defcustom org-icalendar-use-deadline '(event-if-not-todo todo-due)
664 "Contexts where iCalendar export should use a deadline time stamp.
665 This is a list with several symbols in it. Valid symbol are:
667 event-if-todo Deadlines in TODO entries become calendar events.
668 event-if-not-todo Deadlines in non-TODO entries become calendar events.
669 todo-due Use deadlines in TODO entries as due-dates"
670 :group 'org-export-icalendar
671 :type '(set :greedy t
672 (const :tag "Deadlines in non-TODO entries become events"
673 event-if-not-todo)
674 (const :tag "Deadline in TODO entries become events"
675 event-if-todo)
676 (const :tag "Deadlines in TODO entries become due-dates"
677 todo-due)))
679 (defcustom org-icalendar-use-scheduled '(todo-start)
680 "Contexts where iCalendar export should use a scheduling time stamp.
681 This is a list with several symbols in it. Valid symbol are:
683 event-if-todo Scheduling time stamps in TODO entries become an event.
684 event-if-not-todo Scheduling time stamps in non-TODO entries become an event.
685 todo-start Scheduling time stamps in TODO entries become start date.
686 Some calendar applications show TODO entries only after
687 that date."
688 :group 'org-export-icalendar
689 :type '(set :greedy t
690 (const :tag
691 "SCHEDULED timestamps in non-TODO entries become events"
692 event-if-not-todo)
693 (const :tag "SCHEDULED timestamps in TODO entries become events"
694 event-if-todo)
695 (const :tag "SCHEDULED in TODO entries become start date"
696 todo-start)))
698 (defcustom org-icalendar-include-todo nil
699 "Non-nil means, export to iCalendar files should also cover TODO items."
700 :group 'org-export-icalendar
701 :type '(choice
702 (const :tag "None" nil)
703 (const :tag "Unfinished" t)
704 (const :tag "All" all)))
706 (defcustom org-icalendar-include-sexps t
707 "Non-nil means, export to iCalendar files should also cover sexp entries.
708 These are entries like in the diary, but directly in an Org-mode file."
709 :group 'org-export-icalendar
710 :type 'boolean)
712 (defcustom org-icalendar-include-body 100
713 "Amount of text below headline to be included in iCalendar export.
714 This is a number of characters that should maximally be included.
715 Properties, scheduling and clocking lines will always be removed.
716 The text will be inserted into the DESCRIPTION field."
717 :group 'org-export-icalendar
718 :type '(choice
719 (const :tag "Nothing" nil)
720 (const :tag "Everything" t)
721 (integer :tag "Max characters")))
723 (defcustom org-icalendar-store-UID nil
724 "Non-nil means, store any created UIDs in properties.
725 The iCalendar standard requires that all entries have a unique identifyer.
726 Org will create these identifiers as needed. When this variable is non-nil,
727 the created UIDs will be stored in the ID property of the entry. Then the
728 next time this entry is exported, it will be exported with the same UID,
729 superceeding the previous form of it. This is essential for
730 synchronization services.
731 This variable is not turned on by default because we want to avoid creating
732 a property drawer in every entry if people are only playing with this feature,
733 or if they are only using it locally."
734 :group 'org-export-icalendar
735 :type 'boolean)
737 ;;;; Exporting
739 ;;; Variables, constants, and parameter plists
741 (defconst org-level-max 20)
743 (defvar org-export-html-preamble nil
744 "Preamble, to be inserted just after <body>. Set by publishing functions.")
745 (defvar org-export-html-postamble nil
746 "Preamble, to be inserted just before </body>. Set by publishing functions.")
747 (defvar org-export-html-auto-preamble t
748 "Should default preamble be inserted? Set by publishing functions.")
749 (defvar org-export-html-auto-postamble t
750 "Should default postamble be inserted? Set by publishing functions.")
751 (defvar org-current-export-file nil) ; dynamically scoped parameter
752 (defvar org-current-export-dir nil) ; dynamically scoped parameter
754 (defconst org-export-plist-vars
755 '((:link-up . org-export-html-link-up)
756 (:link-home . org-export-html-link-home)
757 (:language . org-export-default-language)
758 (:customtime . org-display-custom-times)
759 (:headline-levels . org-export-headline-levels)
760 (:section-numbers . org-export-with-section-numbers)
761 (:section-number-format . org-export-section-number-format)
762 (:table-of-contents . org-export-with-toc)
763 (:preserve-breaks . org-export-preserve-breaks)
764 (:archived-trees . org-export-with-archived-trees)
765 (:emphasize . org-export-with-emphasize)
766 (:sub-superscript . org-export-with-sub-superscripts)
767 (:special-strings . org-export-with-special-strings)
768 (:footnotes . org-export-with-footnotes)
769 (:drawers . org-export-with-drawers)
770 (:tags . org-export-with-tags)
771 (:TeX-macros . org-export-with-TeX-macros)
772 (:LaTeX-fragments . org-export-with-LaTeX-fragments)
773 (:skip-before-1st-heading . org-export-skip-text-before-1st-heading)
774 (:fixed-width . org-export-with-fixed-width)
775 (:timestamps . org-export-with-timestamps)
776 (:author-info . org-export-author-info)
777 (:creator-info . org-export-creator-info)
778 (:time-stamp-file . org-export-time-stamp-file)
779 (:tables . org-export-with-tables)
780 (:table-auto-headline . org-export-highlight-first-table-line)
781 (:style . org-export-html-style)
782 (:style-extra . org-export-html-style-extra)
783 (:agenda-style . org-agenda-export-html-style)
784 (:convert-org-links . org-export-html-link-org-files-as-html)
785 (:inline-images . org-export-html-inline-images)
786 (:html-extension . org-export-html-extension)
787 (:html-table-tag . org-export-html-table-tag)
788 (:expand-quoted-html . org-export-html-expand)
789 (:timestamp . org-export-html-with-timestamp)
790 (:publishing-directory . org-export-publishing-directory)
791 (:preamble . org-export-html-preamble)
792 (:postamble . org-export-html-postamble)
793 (:auto-preamble . org-export-html-auto-preamble)
794 (:auto-postamble . org-export-html-auto-postamble)
795 (:author . user-full-name)
796 (:email . user-mail-address)))
798 (defun org-default-export-plist ()
799 "Return the property list with default settings for the export variables."
800 (let ((l org-export-plist-vars) rtn e)
801 (while (setq e (pop l))
802 (setq rtn (cons (car e) (cons (symbol-value (cdr e)) rtn))))
803 rtn))
805 (defvar org-export-inbuffer-options-extra nil
806 "List of additional in-buffer options that should be detected.
807 Just before export, the buffer is scanned for options like #+TITLE, #+EMAIL,
808 etc. Extensions can add to this list to get their options detected, and they
809 can then add a function to `org-export-options-filters' to process these
810 options.
811 Each element in this list must be a list, with the in-buffer keyword as car,
812 and a property (a symbol) as the next element. All occurences of the
813 keyword will be found, the values concatenated with a space character
814 in between, and the result stored in the export options property list.")
816 (defvar org-export-options-filters nil
817 "Functions to be called to finalize the export/publishing options.
818 All these options are stored in a property list, and each of the functions
819 in this hook gets a chance to modify this property list. Each function
820 must accept the property list as an argument, and must return the (possibly
821 modified) list.")
823 (defun org-infile-export-plist ()
824 "Return the property list with file-local settings for export."
825 (save-excursion
826 (save-restriction
827 (widen)
828 (goto-char (point-min))
829 (let ((re (org-make-options-regexp
830 (append
831 '("TITLE" "AUTHOR" "DATE" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"
832 "LINK_UP" "LINK_HOME" "SETUPFILE" "STYLE")
833 (mapcar 'car org-export-inbuffer-options-extra))))
834 p key val text options js-up js-main js-css js-opt a pr
835 ext-setup-or-nil setup-contents (start 0))
836 (while (or (and ext-setup-or-nil
837 (string-match re ext-setup-or-nil start)
838 (setq start (match-end 0)))
839 (and (setq ext-setup-or-nil nil start 0)
840 (re-search-forward re nil t)))
841 (setq key (upcase (org-match-string-no-properties 1 ext-setup-or-nil))
842 val (org-match-string-no-properties 2 ext-setup-or-nil))
843 (cond
844 ((setq a (assoc key org-export-inbuffer-options-extra))
845 (setq pr (nth 1 a))
846 (setq p (plist-put p pr (concat (plist-get p pr) " " val))))
847 ((string-equal key "TITLE") (setq p (plist-put p :title val)))
848 ((string-equal key "AUTHOR")(setq p (plist-put p :author val)))
849 ((string-equal key "EMAIL") (setq p (plist-put p :email val)))
850 ((string-equal key "DATE") (setq p (plist-put p :date val)))
851 ((string-equal key "LANGUAGE") (setq p (plist-put p :language val)))
852 ((string-equal key "STYLE") (setq p (plist-put p :style-extra val)))
853 ((string-equal key "TEXT")
854 (setq text (if text (concat text "\n" val) val)))
855 ((string-equal key "OPTIONS")
856 (setq options (concat val " " options)))
857 ((string-equal key "LINK_UP")
858 (setq p (plist-put p :link-up val)))
859 ((string-equal key "LINK_HOME")
860 (setq p (plist-put p :link-home val)))
861 ((equal key "SETUPFILE")
862 (setq setup-contents (org-file-contents
863 (expand-file-name
864 (org-remove-double-quotes
865 (org-trim val)))
866 'noerror))
867 (if (not ext-setup-or-nil)
868 (setq ext-setup-or-nil setup-contents start 0)
869 (setq ext-setup-or-nil
870 (concat (substring ext-setup-or-nil 0 start)
871 "\n" setup-contents "\n"
872 (substring ext-setup-or-nil start)))))))
873 (setq p (plist-put p :text text))
874 (when options
875 (setq p (org-export-add-options-to-plist p options)))
876 p))))
878 (defun org-export-add-options-to-plist (p options)
879 "Parse an OPTONS line and set values in the property list P."
880 (let (o)
881 (when options
882 (let ((op '(("H" . :headline-levels)
883 ("num" . :section-numbers)
884 ("toc" . :table-of-contents)
885 ("\\n" . :preserve-breaks)
886 ("@" . :expand-quoted-html)
887 (":" . :fixed-width)
888 ("|" . :tables)
889 ("^" . :sub-superscript)
890 ("-" . :special-strings)
891 ("f" . :footnotes)
892 ("d" . :drawers)
893 ("tags" . :tags)
894 ("*" . :emphasize)
895 ("TeX" . :TeX-macros)
896 ("LaTeX" . :LaTeX-fragments)
897 ("skip" . :skip-before-1st-heading)
898 ("author" . :author-info)
899 ("creator" . :creator-info)
900 ("timestamp" . :time-stamp-file)))
902 (while (setq o (pop op))
903 (if (string-match (concat (regexp-quote (car o))
904 ":\\([^ \t\n\r;,.]*\\)")
905 options)
906 (setq p (plist-put p (cdr o)
907 (car (read-from-string
908 (match-string 1 options))))))))))
911 (defun org-export-add-subtree-options (p pos)
912 "Add options in subtree at position POS to property list P."
913 (save-excursion
914 (goto-char pos)
915 (when (org-at-heading-p)
916 (let (a)
917 ;; This is actually read in `org-export-get-title-from-subtree'
918 ;; (when (setq a (org-entry-get pos "EXPORT_TITLE"))
919 ;; (setq p (plist-put p :title a)))
920 (when (setq a (org-entry-get pos "EXPORT_TEXT"))
921 (setq p (plist-put p :text a)))
922 (when (setq a (org-entry-get pos "EXPORT_OPTIONS"))
923 (setq p (org-export-add-options-to-plist p a)))))
926 (defun org-export-directory (type plist)
927 (let* ((val (plist-get plist :publishing-directory))
928 (dir (if (listp val)
929 (or (cdr (assoc type val)) ".")
930 val)))
931 dir))
933 (defun org-export-process-option-filters (plist)
934 (let ((functions org-export-options-filters) f)
935 (while (setq f (pop functions))
936 (setq plist (funcall f plist))))
937 plist)
939 ;;;###autoload
940 (defun org-export (&optional arg)
941 "Export dispatcher for Org-mode.
942 When `org-export-run-in-background' is non-nil, try to run the command
943 in the background. This will be done only for commands that write
944 to a file. For details see the docstring of `org-export-run-in-background'.
946 The prefix argument ARG will be passed to the exporter. However, if
947 ARG is a double universal prefix `C-u C-u', that means to inverse the
948 value of `org-export-run-in-background'."
949 (interactive "P")
950 (let* ((bg (org-xor (equal arg '(16)) org-export-run-in-background))
951 (help "[t] insert the export option template
952 \[v] limit export to visible part of outline tree
954 \[a] export as ASCII
956 \[h] export as HTML
957 \[H] export as HTML to temporary buffer
958 \[R] export region as HTML
959 \[b] export as HTML and browse immediately
960 \[x] export as XOXO
962 \[l] export as LaTeX
963 \[L] export as LaTeX to temporary buffer
965 \[i] export current file as iCalendar file
966 \[I] export all agenda files as iCalendar files
967 \[c] export agenda files into combined iCalendar file
969 \[F] publish current file
970 \[P] publish current project
971 \[X] publish... (project will be prompted for)
972 \[A] publish all projects")
973 (cmds
974 '((?t org-insert-export-options-template nil)
975 (?v org-export-visible nil)
976 (?a org-export-as-ascii t)
977 (?h org-export-as-html t)
978 (?b org-export-as-html-and-open t)
979 (?H org-export-as-html-to-buffer nil)
980 (?R org-export-region-as-html nil)
981 (?x org-export-as-xoxo t)
982 (?l org-export-as-latex t)
983 (?L org-export-as-latex-to-buffer nil)
984 (?i org-export-icalendar-this-file t)
985 (?I org-export-icalendar-all-agenda-files t)
986 (?c org-export-icalendar-combine-agenda-files t)
987 (?F org-publish-current-file t)
988 (?P org-publish-current-project t)
989 (?X org-publish t)
990 (?A org-publish-all t)))
991 r1 r2 ass)
992 (save-window-excursion
993 (delete-other-windows)
994 (with-output-to-temp-buffer "*Org Export/Publishing Help*"
995 (princ help))
996 (message "Select command: ")
997 (setq r1 (read-char-exclusive)))
998 (setq r2 (if (< r1 27) (+ r1 96) r1))
999 (unless (setq ass (assq r2 cmds))
1000 (error "No command associated with key %c" r1))
1001 (if (and bg (nth 2 ass))
1002 ;; execute in background
1003 (let ((p (start-process
1004 (concat "Exporting " (file-name-nondirectory (buffer-file-name)))
1005 "*Org Processes*"
1006 (expand-file-name invocation-name invocation-directory)
1007 "-batch"
1008 "-l" user-init-file
1009 "--eval" "(require 'org-exp)"
1010 "--eval" "(setq org-wait .2)"
1011 (buffer-file-name)
1012 "-f" (symbol-name (nth 1 ass)))))
1013 (set-process-sentinel p 'org-export-process-sentinel)
1014 (message "Background process \"%s\": started" p))
1015 ;; background processing not requested, or not possible
1016 (call-interactively (nth 1 ass)))))
1018 (defun org-export-process-sentinel (process status)
1019 (if (string-match "\n+\\'" status)
1020 (setq status (substring status 0 -1)))
1021 (message "Background process \"%s\": %s" process status))
1023 (defconst org-html-entities
1024 '(("nbsp")
1025 ("iexcl")
1026 ("cent")
1027 ("pound")
1028 ("curren")
1029 ("yen")
1030 ("brvbar")
1031 ("vert" . "&#124;")
1032 ("sect")
1033 ("uml")
1034 ("copy")
1035 ("ordf")
1036 ("laquo")
1037 ("not")
1038 ("shy")
1039 ("reg")
1040 ("macr")
1041 ("deg")
1042 ("plusmn")
1043 ("sup2")
1044 ("sup3")
1045 ("acute")
1046 ("micro")
1047 ("para")
1048 ("middot")
1049 ("odot"."o")
1050 ("star"."*")
1051 ("cedil")
1052 ("sup1")
1053 ("ordm")
1054 ("raquo")
1055 ("frac14")
1056 ("frac12")
1057 ("frac34")
1058 ("iquest")
1059 ("Agrave")
1060 ("Aacute")
1061 ("Acirc")
1062 ("Atilde")
1063 ("Auml")
1064 ("Aring") ("AA"."&Aring;")
1065 ("AElig")
1066 ("Ccedil")
1067 ("Egrave")
1068 ("Eacute")
1069 ("Ecirc")
1070 ("Euml")
1071 ("Igrave")
1072 ("Iacute")
1073 ("Icirc")
1074 ("Iuml")
1075 ("ETH")
1076 ("Ntilde")
1077 ("Ograve")
1078 ("Oacute")
1079 ("Ocirc")
1080 ("Otilde")
1081 ("Ouml")
1082 ("times")
1083 ("Oslash")
1084 ("Ugrave")
1085 ("Uacute")
1086 ("Ucirc")
1087 ("Uuml")
1088 ("Yacute")
1089 ("THORN")
1090 ("szlig")
1091 ("agrave")
1092 ("aacute")
1093 ("acirc")
1094 ("atilde")
1095 ("auml")
1096 ("aring")
1097 ("aelig")
1098 ("ccedil")
1099 ("egrave")
1100 ("eacute")
1101 ("ecirc")
1102 ("euml")
1103 ("igrave")
1104 ("iacute")
1105 ("icirc")
1106 ("iuml")
1107 ("eth")
1108 ("ntilde")
1109 ("ograve")
1110 ("oacute")
1111 ("ocirc")
1112 ("otilde")
1113 ("ouml")
1114 ("divide")
1115 ("oslash")
1116 ("ugrave")
1117 ("uacute")
1118 ("ucirc")
1119 ("uuml")
1120 ("yacute")
1121 ("thorn")
1122 ("yuml")
1123 ("fnof")
1124 ("Alpha")
1125 ("Beta")
1126 ("Gamma")
1127 ("Delta")
1128 ("Epsilon")
1129 ("Zeta")
1130 ("Eta")
1131 ("Theta")
1132 ("Iota")
1133 ("Kappa")
1134 ("Lambda")
1135 ("Mu")
1136 ("Nu")
1137 ("Xi")
1138 ("Omicron")
1139 ("Pi")
1140 ("Rho")
1141 ("Sigma")
1142 ("Tau")
1143 ("Upsilon")
1144 ("Phi")
1145 ("Chi")
1146 ("Psi")
1147 ("Omega")
1148 ("alpha")
1149 ("beta")
1150 ("gamma")
1151 ("delta")
1152 ("epsilon")
1153 ("varepsilon"."&epsilon;")
1154 ("zeta")
1155 ("eta")
1156 ("theta")
1157 ("iota")
1158 ("kappa")
1159 ("lambda")
1160 ("mu")
1161 ("nu")
1162 ("xi")
1163 ("omicron")
1164 ("pi")
1165 ("rho")
1166 ("sigmaf") ("varsigma"."&sigmaf;")
1167 ("sigma")
1168 ("tau")
1169 ("upsilon")
1170 ("phi")
1171 ("chi")
1172 ("psi")
1173 ("omega")
1174 ("thetasym") ("vartheta"."&thetasym;")
1175 ("upsih")
1176 ("piv")
1177 ("bull") ("bullet"."&bull;")
1178 ("hellip") ("dots"."&hellip;")
1179 ("prime")
1180 ("Prime")
1181 ("oline")
1182 ("frasl")
1183 ("weierp")
1184 ("image")
1185 ("real")
1186 ("trade")
1187 ("alefsym")
1188 ("larr") ("leftarrow"."&larr;") ("gets"."&larr;")
1189 ("uarr") ("uparrow"."&uarr;")
1190 ("rarr") ("to"."&rarr;") ("rightarrow"."&rarr;")
1191 ("darr")("downarrow"."&darr;")
1192 ("harr") ("leftrightarrow"."&harr;")
1193 ("crarr") ("hookleftarrow"."&crarr;") ; has round hook, not quite CR
1194 ("lArr") ("Leftarrow"."&lArr;")
1195 ("uArr") ("Uparrow"."&uArr;")
1196 ("rArr") ("Rightarrow"."&rArr;")
1197 ("dArr") ("Downarrow"."&dArr;")
1198 ("hArr") ("Leftrightarrow"."&hArr;")
1199 ("forall")
1200 ("part") ("partial"."&part;")
1201 ("exist") ("exists"."&exist;")
1202 ("empty") ("emptyset"."&empty;")
1203 ("nabla")
1204 ("isin") ("in"."&isin;")
1205 ("notin")
1206 ("ni")
1207 ("prod")
1208 ("sum")
1209 ("minus")
1210 ("lowast") ("ast"."&lowast;")
1211 ("radic")
1212 ("prop") ("proptp"."&prop;")
1213 ("infin") ("infty"."&infin;")
1214 ("ang") ("angle"."&ang;")
1215 ("and") ("wedge"."&and;")
1216 ("or") ("vee"."&or;")
1217 ("cap")
1218 ("cup")
1219 ("int")
1220 ("there4")
1221 ("sim")
1222 ("cong") ("simeq"."&cong;")
1223 ("asymp")("approx"."&asymp;")
1224 ("ne") ("neq"."&ne;")
1225 ("equiv")
1226 ("le")
1227 ("ge")
1228 ("sub") ("subset"."&sub;")
1229 ("sup") ("supset"."&sup;")
1230 ("nsub")
1231 ("sube")
1232 ("supe")
1233 ("oplus")
1234 ("otimes")
1235 ("perp")
1236 ("sdot") ("cdot"."&sdot;")
1237 ("lceil")
1238 ("rceil")
1239 ("lfloor")
1240 ("rfloor")
1241 ("lang")
1242 ("rang")
1243 ("loz") ("Diamond"."&loz;")
1244 ("spades") ("spadesuit"."&spades;")
1245 ("clubs") ("clubsuit"."&clubs;")
1246 ("hearts") ("diamondsuit"."&hearts;")
1247 ("diams") ("diamondsuit"."&diams;")
1248 ("smile"."&#9786;") ("blacksmile"."&#9787;") ("sad"."&#9785;")
1249 ("quot")
1250 ("amp")
1251 ("lt")
1252 ("gt")
1253 ("OElig")
1254 ("oelig")
1255 ("Scaron")
1256 ("scaron")
1257 ("Yuml")
1258 ("circ")
1259 ("tilde")
1260 ("ensp")
1261 ("emsp")
1262 ("thinsp")
1263 ("zwnj")
1264 ("zwj")
1265 ("lrm")
1266 ("rlm")
1267 ("ndash")
1268 ("mdash")
1269 ("lsquo")
1270 ("rsquo")
1271 ("sbquo")
1272 ("ldquo")
1273 ("rdquo")
1274 ("bdquo")
1275 ("dagger")
1276 ("Dagger")
1277 ("permil")
1278 ("lsaquo")
1279 ("rsaquo")
1280 ("euro")
1282 ("arccos"."arccos")
1283 ("arcsin"."arcsin")
1284 ("arctan"."arctan")
1285 ("arg"."arg")
1286 ("cos"."cos")
1287 ("cosh"."cosh")
1288 ("cot"."cot")
1289 ("coth"."coth")
1290 ("csc"."csc")
1291 ("deg"."deg")
1292 ("det"."det")
1293 ("dim"."dim")
1294 ("exp"."exp")
1295 ("gcd"."gcd")
1296 ("hom"."hom")
1297 ("inf"."inf")
1298 ("ker"."ker")
1299 ("lg"."lg")
1300 ("lim"."lim")
1301 ("liminf"."liminf")
1302 ("limsup"."limsup")
1303 ("ln"."ln")
1304 ("log"."log")
1305 ("max"."max")
1306 ("min"."min")
1307 ("Pr"."Pr")
1308 ("sec"."sec")
1309 ("sin"."sin")
1310 ("sinh"."sinh")
1311 ("sup"."sup")
1312 ("tan"."tan")
1313 ("tanh"."tanh")
1315 "Entities for TeX->HTML translation.
1316 Entries can be like (\"ent\"), in which case \"\\ent\" will be translated to
1317 \"&ent;\". An entry can also be a dotted pair like (\"ent\".\"&other;\").
1318 In that case, \"\\ent\" will be translated to \"&other;\".
1319 The list contains HTML entities for Latin-1, Greek and other symbols.
1320 It is supplemented by a number of commonly used TeX macros with appropriate
1321 translations. There is currently no way for users to extend this.")
1323 ;;; General functions for all backends
1325 (defun org-export-preprocess-string (string &rest parameters)
1326 "Cleanup STRING so that that the true exported has a more consistent source.
1327 This function takes STRING, which should be a buffer-string of an org-file
1328 to export. It then creates a temporary buffer where it does its job.
1329 The result is then again returned as a string, and the exporter works
1330 on this string to produce the exported version."
1331 (interactive)
1332 (let* ((htmlp (plist-get parameters :for-html))
1333 (asciip (plist-get parameters :for-ascii))
1334 (latexp (plist-get parameters :for-LaTeX))
1335 (archived-trees (plist-get parameters :archived-trees))
1336 (inhibit-read-only t)
1337 (drawers org-drawers)
1338 (outline-regexp "\\*+ ")
1339 target-alist rtn)
1341 (with-current-buffer (get-buffer-create " org-mode-tmp")
1342 (erase-buffer)
1343 (insert string)
1344 (setq case-fold-search t)
1345 ;; Call the hook
1346 (run-hooks 'org-export-preprocess-hook)
1348 ;; Remove license-to-kill stuff
1349 ;; The caller markes some stuff fo killing, stuff that has been
1350 ;; used to create the page title, for example.
1351 (org-export-kill-licensed-text)
1353 (let ((org-inhibit-startup t)) (org-mode))
1354 (setq case-fold-search t)
1355 (untabify (point-min) (point-max))
1357 ;; Handle incude files
1358 (org-export-handle-include-files)
1360 ;; Handle source code snippets
1361 (org-export-replace-src-segments)
1363 ;; Get rid of drawers
1364 (org-export-remove-or-extract-drawers drawers
1365 (plist-get parameters :drawers))
1367 ;; Get the correct stuff before the first headline
1368 (when (plist-get parameters :skip-before-1st-heading)
1369 (goto-char (point-min))
1370 (when (re-search-forward "^\\*+[ \t]" nil t)
1371 (delete-region (point-min) (match-beginning 0))
1372 (goto-char (point-min))
1373 (insert "\n")))
1374 (when (plist-get parameters :add-text)
1375 (goto-char (point-min))
1376 (insert (plist-get parameters :add-text) "\n"))
1378 ;; Get rid of archived trees
1379 (org-export-remove-archived-trees archived-trees)
1381 ;; Find all headings and compute the targets for them
1382 (setq target-alist (org-export-define-heading-targets target-alist))
1384 ;; Find targets in comments and move them out of comments,
1385 ;; but mark them as targets that should be invisible
1386 (setq target-alist (org-export-handle-invisible-targets target-alist))
1388 ;; Protect examples
1389 (org-export-protect-examples)
1391 ;; Protect backend specific stuff, throw away the others.
1392 (org-export-select-backend-specific-text
1393 (cond (htmlp 'html) (latexp 'latex) (asciip 'ascii)))
1395 ;; Protect quoted subtrees
1396 (org-export-protect-quoted-subtrees)
1398 ;; Protect verbatim elements
1399 (org-export-protect-verbatim)
1401 ;; Blockquotes and verse
1402 (org-export-mark-blockquote-and-verse)
1404 ;; Remove comment environment and comment subtrees
1405 (org-export-remove-comment-blocks-and-subtrees)
1407 ;; Remove special table lines
1408 (when org-export-table-remove-special-lines
1409 (org-export-remove-special-table-lines))
1411 ;; Specific LaTeX stuff
1412 (when latexp
1413 (require 'org-export-latex nil)
1414 (org-export-latex-preprocess))
1416 ;; Specific ASCII stuff
1417 (when asciip
1418 (org-export-ascii-preprocess))
1420 ;; Specific HTML stuff
1421 (when htmlp
1422 (org-export-html-preprocess parameters))
1424 ;; Remove or replace comments
1425 (org-export-handle-comments (plist-get parameters :comments))
1427 ;; Find matches for radio targets and turn them into internal links
1428 (org-export-mark-radio-links)
1430 ;; Find all links that contain a newline and put them into a single line
1431 (org-export-concatenate-multiline-links)
1433 ;; Normalize links: Convert angle and plain links into bracket links
1434 ;; and expand link abbreviations
1435 (org-export-normalize-links)
1437 ;; Find all internal links. If they have a fuzzy match (i.e. not
1438 ;; a *dedicated* target match, let the link point to the
1439 ;; corresponding section.
1440 (org-export-target-internal-links target-alist)
1442 ;; Find multiline emphasis and put them into single line
1443 (when (plist-get parameters :emph-multiline)
1444 (org-export-concatenate-multiline-emphasis))
1446 (setq rtn (buffer-string)))
1447 (kill-buffer " org-mode-tmp")
1448 rtn))
1450 (defun org-export-kill-licensed-text ()
1451 "Remove all text that is marked with a :org-license-to-kill property."
1452 (let (p q)
1453 (while (setq p (text-property-any (point-min) (point-max)
1454 :org-license-to-kill t))
1455 (delete-region
1456 p (or (next-single-property-change p :org-license-to-kill)
1457 (point-max))))))
1459 (defun org-export-define-heading-targets (target-alist)
1460 "Find all headings and define the targets for them.
1461 The new targets are added to TARGET-ALIST, which is also returned."
1462 (goto-char (point-min))
1463 (org-init-section-numbers)
1464 (let ((re (concat "^" org-outline-regexp))
1465 level target)
1466 (while (re-search-forward re nil t)
1467 (setq level (org-reduced-level
1468 (save-excursion (goto-char (point-at-bol))
1469 (org-outline-level))))
1470 (setq target (org-solidify-link-text
1471 (format "sec-%s" (org-section-number level))))
1472 (push (cons target target) target-alist)
1473 (add-text-properties
1474 (point-at-bol) (point-at-eol)
1475 (list 'target target))))
1476 target-alist)
1478 (defun org-export-handle-invisible-targets (target-alist)
1479 "Find targets in comments and move them out of comments.
1480 Mark them as invisible targets."
1481 (let (target tmp)
1482 (goto-char (point-min))
1483 (while (re-search-forward "^#.*?\\(<<<?\\([^>\r\n]+\\)>>>?\\).*" nil t)
1484 ;; Check if the line before or after is a headline with a target
1485 (if (setq target (or (get-text-property (point-at-bol 0) 'target)
1486 (get-text-property (point-at-bol 2) 'target)))
1487 (progn
1488 ;; use the existing target in a neighboring line
1489 (setq tmp (match-string 2))
1490 (replace-match "")
1491 (and (looking-at "\n") (delete-char 1))
1492 (push (cons (org-solidify-link-text tmp) target)
1493 target-alist))
1494 ;; Make an invisible target
1495 (replace-match "\\1(INVISIBLE)"))))
1496 target-alist)
1498 (defun org-export-target-internal-links (target-alist)
1499 "Find all internal links and assign target to them.
1500 If a link has a fuzzy match (i.e. not a *dedicated* target match),
1501 let the link point to the corresponding section."
1502 (goto-char (point-min))
1503 (while (re-search-forward org-bracket-link-regexp nil t)
1504 (org-if-unprotected
1505 (let* ((md (match-data))
1506 (desc (match-end 2))
1507 (link (org-link-unescape (match-string 1)))
1508 (slink (org-solidify-link-text link))
1509 found props pos
1510 (target
1511 (cond
1512 ((cdr (assoc slink target-alist)))
1513 ((string-match org-link-types-re link) nil)
1514 ((or (file-name-absolute-p link)
1515 (string-match "^\\." link))
1516 nil)
1518 (save-excursion
1519 (setq found (condition-case nil (org-link-search link)
1520 (error nil)))
1521 (when (and found
1522 (or (org-on-heading-p)
1523 (not (eq found 'dedicated))))
1524 (or (get-text-property (point) 'target)
1525 (get-text-property
1526 (max (point-min)
1527 (1- (previous-single-property-change
1528 (point) 'target)))
1529 'target))))))))
1530 (when target
1531 (set-match-data md)
1532 (goto-char (match-beginning 1))
1533 (setq props (text-properties-at (point)))
1534 (delete-region (match-beginning 1) (match-end 1))
1535 (setq pos (point))
1536 (insert target)
1537 (unless desc (insert "][" link))
1538 (add-text-properties pos (point) props))))))
1540 (defun org-export-remove-or-extract-drawers (all-drawers exp-drawers)
1541 "Remove drawers, or extract the content.
1542 ALL-DRAWERS is a list of all drawer names valid in the current buffer.
1543 EXP-DRAWERS can be t to keep all drawer contents, or a list of drawers
1544 whose content to keep."
1545 (unless (eq t exp-drawers)
1546 (goto-char (point-min))
1547 (let ((re (concat "^[ \t]*:\\("
1548 (mapconcat
1549 'identity
1550 (org-delete-all exp-drawers
1551 (copy-sequence all-drawers))
1552 "\\|")
1553 "\\):[ \t]*\n\\([^@]*?\n\\)?[ \t]*:END:[ \t]*\n")))
1554 (while (re-search-forward re nil t)
1555 (replace-match "")))))
1557 (defun org-export-remove-archived-trees (export-archived-trees)
1558 "Remove archived trees.
1559 When EXPORT-ARCHIVED-TREES is `headline;, only the headline will be exported.
1560 When it is t, the entire archived tree will be exported.
1561 When it is nil the entire tree including the headline will be removed
1562 from the buffer."
1563 (let ((re-archive (concat ":" org-archive-tag ":"))
1564 a b)
1565 (when (not (eq export-archived-trees t))
1566 (goto-char (point-min))
1567 (while (re-search-forward re-archive nil t)
1568 (if (not (org-on-heading-p t))
1569 (org-end-of-subtree t)
1570 (beginning-of-line 1)
1571 (setq a (if export-archived-trees
1572 (1+ (point-at-eol)) (point))
1573 b (org-end-of-subtree t))
1574 (if (> b a) (delete-region a b)))))))
1576 (defun org-export-protect-quoted-subtrees ()
1577 "Mark quoted subtrees with the protection property."
1578 (let ((re-quote (concat "^\\*+[ \t]+" org-quote-string "\\>")))
1579 (goto-char (point-min))
1580 (while (re-search-forward re-quote nil t)
1581 (goto-char (match-beginning 0))
1582 (end-of-line 1)
1583 (add-text-properties (point) (org-end-of-subtree t)
1584 '(org-protected t)))))
1586 (defun org-export-protect-verbatim ()
1587 "Mark verbatim snippets with the protection property."
1588 (goto-char (point-min))
1589 (while (re-search-forward org-verbatim-re nil t)
1590 (add-text-properties (match-beginning 4) (match-end 4)
1591 '(org-protected t))
1592 (goto-char (1+ (match-end 4)))))
1594 (defun org-export-protect-examples ()
1595 "Protect code that should be exported as monospaced examples."
1596 (goto-char (point-min))
1597 (while (re-search-forward "^#\\+BEGIN_EXAMPLE[ \t]*\n" nil t)
1598 (goto-char (match-end 0))
1599 (while (and (not (looking-at "#\\+END_EXAMPLE")) (not (eobp)))
1600 (insert ": ")
1601 (beginning-of-line 2)))
1602 (goto-char (point-min))
1603 (while (re-search-forward "^[ \t]*:.*\\(\n[ \t]*:.*\\)*" nil t)
1604 (add-text-properties (match-beginning 0) (match-end 0)
1605 '(org-protected t))))
1607 (defun org-export-select-backend-specific-text (backend)
1608 (let ((formatters
1609 '((html "HTML" "BEGIN_HTML" "END_HTML")
1610 (ascii "ASCII" "BEGIN_ASCII" "END_ASCII")
1611 (latex "LaTeX" "BEGIN_LaTeX" "END_LaTeX")))
1612 fmt)
1614 (while formatters
1615 (setq fmt (pop formatters))
1616 (when (eq (car fmt) backend)
1617 ;; This is selected code, put it into the file for real
1618 (goto-char (point-min))
1619 (while (re-search-forward (concat "^#\\+" (cadr fmt)
1620 ":[ \t]*\\(.*\\)") nil t)
1621 (replace-match "\\1" t)
1622 (add-text-properties
1623 (point-at-bol) (min (1+ (point-at-eol)) (point-max))
1624 '(org-protected t))))
1625 (goto-char (point-min))
1626 (while (re-search-forward
1627 (concat "^#\\+"
1628 (caddr fmt) "\\>.*\\(\\(\n.*\\)*?\n\\)#\\+"
1629 (cadddr fmt) "\\>.*\n?") nil t)
1630 (if (eq (car fmt) backend)
1631 ;; yes, keep this
1632 (add-text-properties (match-beginning 1) (1+ (match-end 1))
1633 '(org-protected t))
1634 ;; No, this is for a different backend, kill it
1635 (delete-region (match-beginning 0) (match-end 0)))))))
1637 (defun org-export-mark-blockquote-and-verse ()
1638 "Mark block quote and verse environments with special cookies.
1639 These special cookies will later be interpreted by the backend."
1640 ;; Blockquotes
1641 (goto-char (point-min))
1642 (while (re-search-forward "^#\\+\\(begin\\|end\\)_\\(block\\)?quote\\>.*"
1643 nil t)
1644 (replace-match (if (equal (downcase (match-string 1)) "end")
1645 "ORG-BLOCKQUOTE-END" "ORG-BLOCKQUOTE-START")
1646 t t))
1647 ;; Verse
1648 (goto-char (point-min))
1649 (while (re-search-forward "^#\\+\\(begin\\|end\\)_verse\\>.*" nil t)
1650 (replace-match (if (equal (downcase (match-string 1)) "end")
1651 "ORG-VERSE-END" "ORG-VERSE-START")
1652 t t)))
1654 (defun org-export-remove-comment-blocks-and-subtrees ()
1655 "Remove the comment environment, and also commented subtrees."
1656 (let ((re-commented (concat "^\\*+[ \t]+" org-comment-string "\\>"))
1657 (case-fold-search nil))
1658 ;; Remove comment environment
1659 (goto-char (point-min))
1660 (while (re-search-forward
1661 "^#\\+BEGIN_COMMENT[ \t]*\n[^\000]*?^#\\+END_COMMENT\\>.*" nil t)
1662 (replace-match "" t t))
1663 ;; Remove subtrees that are commented
1664 (goto-char (point-min))
1665 (while (re-search-forward re-commented nil t)
1666 (goto-char (match-beginning 0))
1667 (delete-region (point) (org-end-of-subtree t)))))
1669 (defun org-export-handle-comments (commentsp)
1670 "Remove comments, or convert to backend-specific format.
1671 COMMENTSP can be a format string for publishing comments.
1672 When it is nil, all comments will be removed."
1673 (let ((re "^#\\(.*\n?\\)")
1674 pos)
1675 (goto-char (point-min))
1676 (while (or (looking-at re)
1677 (re-search-forward re nil t))
1678 (setq pos (match-beginning 0))
1679 (if commentsp
1680 (progn (add-text-properties
1681 (match-beginning 0) (match-end 0) '(org-protected t))
1682 (replace-match (format commentsp (match-string 1)) t t))
1683 (goto-char (1+ pos))
1684 (org-if-unprotected
1685 (replace-match "")
1686 (goto-char (max (point-min) (1- pos))))))))
1688 (defun org-export-mark-radio-links ()
1689 "Find all matches for radio targets and turn them into internal links."
1690 (let ((re-radio (and org-target-link-regexp
1691 (concat "\\([^<]\\)\\(" org-target-link-regexp "\\)"))))
1692 (goto-char (point-min))
1693 (when re-radio
1694 (while (re-search-forward re-radio nil t)
1695 (org-if-unprotected
1696 (replace-match "\\1[[\\2]]"))))))
1698 (defun org-export-remove-special-table-lines ()
1699 "Remove tables lines that are used for internal purposes."
1700 (goto-char (point-min))
1701 (while (re-search-forward "^[ \t]*|" nil t)
1702 (beginning-of-line 1)
1703 (if (or (looking-at "[ \t]*| *[!_^] *|")
1704 (and (looking-at ".*?| *<[0-9]+> *|")
1705 (not (looking-at ".*?| *[^ <|]"))))
1706 (delete-region (max (point-min) (1- (point-at-bol)))
1707 (point-at-eol))
1708 (end-of-line 1))))
1710 (defun org-export-normalize-links ()
1711 "Convert all links to bracket links, and expand link abbreviations."
1712 (let ((re-plain-link (concat "\\([^[<]\\)" org-plain-link-re))
1713 (re-angle-link (concat "\\([^[]\\)" org-angle-link-re)))
1714 (goto-char (point-min))
1715 (while (re-search-forward re-plain-link nil t)
1716 (goto-char (1- (match-end 0)))
1717 (org-if-unprotected
1718 (let* ((s (concat (match-string 1) "[[" (match-string 2)
1719 ":" (match-string 3) "]]")))
1720 ;; added 'org-link face to links
1721 (put-text-property 0 (length s) 'face 'org-link s)
1722 (replace-match s t t))))
1723 (goto-char (point-min))
1724 (while (re-search-forward re-angle-link nil t)
1725 (goto-char (1- (match-end 0)))
1726 (org-if-unprotected
1727 (let* ((s (concat (match-string 1) "[[" (match-string 2)
1728 ":" (match-string 3) "]]")))
1729 (put-text-property 0 (length s) 'face 'org-link s)
1730 (replace-match s t t))))
1731 (goto-char (point-min))
1732 (while (re-search-forward org-bracket-link-regexp nil t)
1733 (goto-char (1- (match-end 0)))
1734 (org-if-unprotected
1735 (let* ((xx (save-match-data
1736 (org-link-expand-abbrev (match-string 1))))
1737 (s (concat
1738 "[[" xx "]"
1739 (if (match-end 3)
1740 (match-string 2)
1741 (concat "[" xx "]"))
1742 "]")))
1743 (put-text-property 0 (length s) 'face 'org-link s)
1744 (replace-match s t t))))))
1746 (defun org-export-concatenate-multiline-links ()
1747 "Find multi-line links and put it all into a single line.
1748 This is to make sure that the line-processing export backends
1749 can work correctly."
1750 (goto-char (point-min))
1751 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
1752 (org-if-unprotected
1753 (replace-match "\\1 \\3")
1754 (goto-char (match-beginning 0)))))
1756 (defun org-export-concatenate-multiline-emphasis ()
1757 "Find multi-line emphasis and put it all into a single line.
1758 This is to make sure that the line-processing export backends
1759 can work correctly."
1760 (goto-char (point-min))
1761 (while (re-search-forward org-emph-re nil t)
1762 (if (not (= (char-after (match-beginning 3))
1763 (char-after (match-beginning 4))))
1764 (org-if-unprotected
1765 (subst-char-in-region (match-beginning 0) (match-end 0)
1766 ?\n ?\ t)
1767 (goto-char (1- (match-end 0))))
1768 (goto-char (1+ (match-beginning 0))))))
1770 (defun org-export-grab-title-from-buffer ()
1771 "Get a title for the current document, from looking at the buffer."
1772 (let ((inhibit-read-only t))
1773 (save-excursion
1774 (goto-char (point-min))
1775 (let ((end (save-excursion (outline-next-heading) (point))))
1776 (when (re-search-forward "^[ \t]*[^|# \t\r\n].*\n" end t)
1777 ;; Mark the line so that it will not be exported as normal text.
1778 (org-unmodified
1779 (add-text-properties (match-beginning 0) (match-end 0)
1780 (list :org-license-to-kill t)))
1781 ;; Return the title string
1782 (org-trim (match-string 0)))))))
1784 (defun org-export-get-title-from-subtree ()
1785 "Return subtree title and exclude it from export."
1786 (let (title (m (mark)) (rbeg (region-beginning)) (rend (region-end)))
1787 (save-excursion
1788 (goto-char rbeg)
1789 (when (and (org-at-heading-p)
1790 (>= (org-end-of-subtree t t) rend))
1791 ;; This is a subtree, we take the title from the first heading
1792 (goto-char rbeg)
1793 (looking-at org-todo-line-regexp)
1794 (setq title (match-string 3))
1795 (org-unmodified
1796 (add-text-properties (point) (1+ (point-at-eol))
1797 (list :org-license-to-kill t)))
1798 (setq title (or (org-entry-get nil "EXPORT_TITLE") title))))
1799 title))
1801 (defun org-solidify-link-text (s &optional alist)
1802 "Take link text and make a safe target out of it."
1803 (save-match-data
1804 (let* ((rtn
1805 (mapconcat
1806 'identity
1807 (org-split-string s "[ \t\r\n]+") "=="))
1808 (a (assoc rtn alist)))
1809 (or (cdr a) rtn))))
1811 (defun org-get-min-level (lines)
1812 "Get the minimum level in LINES."
1813 (let ((re "^\\(\\*+\\) ") l min)
1814 (catch 'exit
1815 (while (setq l (pop lines))
1816 (if (string-match re l)
1817 (throw 'exit (org-tr-level (length (match-string 1 l))))))
1818 1)))
1820 ;; Variable holding the vector with section numbers
1821 (defvar org-section-numbers (make-vector org-level-max 0))
1823 (defun org-init-section-numbers ()
1824 "Initialize the vector for the section numbers."
1825 (let* ((level -1)
1826 (numbers (nreverse (org-split-string "" "\\.")))
1827 (depth (1- (length org-section-numbers)))
1828 (i depth) number-string)
1829 (while (>= i 0)
1830 (if (> i level)
1831 (aset org-section-numbers i 0)
1832 (setq number-string (or (car numbers) "0"))
1833 (if (string-match "\\`[A-Z]\\'" number-string)
1834 (aset org-section-numbers i
1835 (- (string-to-char number-string) ?A -1))
1836 (aset org-section-numbers i (string-to-number number-string)))
1837 (pop numbers))
1838 (setq i (1- i)))))
1840 (defun org-section-number (&optional level)
1841 "Return a string with the current section number.
1842 When LEVEL is non-nil, increase section numbers on that level."
1843 (let* ((depth (1- (length org-section-numbers)))
1844 (string "")
1845 (fmts (car org-export-section-number-format))
1846 (term (cdr org-export-section-number-format))
1847 (sep "")
1848 ctype fmt idx n)
1849 (when level
1850 (when (> level -1)
1851 (aset org-section-numbers
1852 level (1+ (aref org-section-numbers level))))
1853 (setq idx (1+ level))
1854 (while (<= idx depth)
1855 (if (not (= idx 1))
1856 (aset org-section-numbers idx 0))
1857 (setq idx (1+ idx))))
1858 (setq idx 0)
1859 (while (<= idx depth)
1860 (when (> (aref org-section-numbers idx) 0)
1861 (setq fmt (or (pop fmts) fmt)
1862 ctype (car fmt)
1863 n (aref org-section-numbers idx)
1864 string (if (> n 0)
1865 (concat string sep (org-number-to-counter n ctype))
1866 (concat string ".0"))
1867 sep (nth 1 fmt)))
1868 (setq idx (1+ idx)))
1869 (save-match-data
1870 (if (string-match "\\`\\([@0]\\.\\)+" string)
1871 (setq string (replace-match "" t nil string)))
1872 (if (string-match "\\(\\.0\\)+\\'" string)
1873 (setq string (replace-match "" t nil string))))
1874 (concat string term)))
1876 (defun org-number-to-counter (n type)
1877 "Concert number N to a string counter, according to TYPE.
1878 TYPE must be a string, any of:
1879 1 number
1880 A A,B,....
1881 a a,b,....
1882 I uppper case roman numeral
1883 i lower case roman numeral"
1884 (cond
1885 ((equal type "1") (number-to-string n))
1886 ((equal type "A") (char-to-string (+ ?A n -1)))
1887 ((equal type "a") (char-to-string (+ ?a n -1)))
1888 ((equal type "I") (org-number-to-roman n))
1889 ((equal type "i") (downcase (org-number-to-roman n)))
1890 (t (error "Invalid counter type `%s'" type))))
1892 (defun org-number-to-roman (n)
1893 "Convert integer N into a roman numeral."
1894 (let ((roman '((1000 . "M") (900 . "CM") (500 . "D") (400 . "CD")
1895 ( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
1896 ( 10 . "X") ( 9 . "IX") ( 5 . "V") ( 4 . "IV")
1897 ( 1 . "I")))
1898 (res ""))
1899 (if (<= n 0)
1900 (number-to-string n)
1901 (while roman
1902 (if (>= n (caar roman))
1903 (setq n (- n (caar roman))
1904 res (concat res (cdar roman)))
1905 (pop roman)))
1906 res)))
1908 (org-number-to-roman 1961)
1911 ;;; Include files
1913 (defun org-export-handle-include-files ()
1914 "Include the contents of include files, with proper formatting."
1915 (let ((case-fold-search t)
1916 params file markup lang start end prefix prefix1)
1917 (goto-char (point-min))
1918 (while (re-search-forward "^#\\+INCLUDE:?[ \t]+\\(.*\\)" nil t)
1919 (setq params (read (concat "(" (match-string 1) ")"))
1920 prefix (org-get-and-remove-property 'params :prefix)
1921 prefix1 (org-get-and-remove-property 'params :prefix1)
1922 file (org-symname-or-string (pop params))
1923 markup (org-symname-or-string (pop params))
1924 lang (org-symname-or-string (pop params)))
1925 (delete-region (match-beginning 0) (match-end 0))
1926 (if (or (not file)
1927 (not (file-exists-p file))
1928 (not (file-readable-p file)))
1929 (insert (format "CANNOT INCLUDE FILE %s" file))
1930 (when markup
1931 (if (equal (downcase markup) "src")
1932 (setq start (format "#+begin_src %s\n" (or lang "fundamental"))
1933 end "#+end_src")
1934 (setq start (format "#+begin_%s\n" markup)
1935 end (format "#+end_%s" markup))))
1936 (insert (or start ""))
1937 (insert (org-get-file-contents (expand-file-name file) prefix prefix1))
1938 (or (bolp) (newline))
1939 (insert (or end ""))))))
1941 (defun org-get-file-contents (file &optional prefix prefix1)
1942 "Get the contents of FILE and return them as a string.
1943 If PREFIX is a string, prepend it to each line. If PREFIX1
1944 is a string, prepend it to the first line instead of PREFIX."
1945 (with-temp-buffer
1946 (insert-file-contents file)
1947 (when (or prefix prefix1)
1948 (goto-char (point-min))
1949 (while (not (eobp))
1950 (insert (or prefix1 prefix))
1951 (setq prefix1 nil)
1952 (beginning-of-line 2)))
1953 (buffer-string)))
1955 (defun org-get-and-remove-property (listvar prop)
1956 "Check if the value of LISTVAR contains PROP as a property.
1957 If yes, return the value of that property (i.e. the element following
1958 in the list) and remove property and value from the list in LISTVAR."
1959 (let ((list (symbol-value listvar)) m v)
1960 (when (setq m (member prop list))
1961 (setq v (nth 1 m))
1962 (if (equal (car list) prop)
1963 (set listvar (cddr list))
1964 (setcdr (nthcdr (- (length list) (length m) 1) list)
1965 (cddr m))
1966 (set listvar list)))
1969 (defun org-symname-or-string (s)
1970 (if (symbolp s)
1971 (if s (symbol-name s) s)
1974 ;;; Fontification of code
1975 ;; Currently only for the HTML backend, but who knows....
1976 (defun org-export-replace-src-segments ()
1977 "Replace source code segments with special code for export."
1978 (let ((case-fold-search t)
1979 lang code trans)
1980 (goto-char (point-min))
1981 (while (re-search-forward
1982 "^#\\+BEGIN_SRC:?[ \t]+\\([^ \t\n]+\\)[ \t]*\n\\([^\000]+?\n\\)#\\+END_SRC.*"
1983 nil t)
1984 (setq lang (match-string 1) code (match-string 2)
1985 trans (org-export-format-source-code lang code))
1986 (replace-match trans t t))))
1988 (defvar htmlp) ;; dynamically scoped from org-exp.el
1990 (defun org-export-format-source-code (lang code)
1991 "Format CODE from language LANG and return it formatted for export.
1992 Currently, this only does something for HTML export, for all other
1993 backends, it converts the segment into an EXAMPLE segment."
1994 (save-match-data
1995 (cond
1996 (htmlp
1997 ;; We are exporting to HTML
1998 (condition-case nil (require 'htmlize) (nil t))
1999 (if (not (fboundp 'htmlize-region-for-paste))
2000 (progn
2001 ;; we do not have htmlize.el, or an old version of it
2002 (message
2003 "htmlize.el 1.34 or later is needed for source code formatting")
2004 (concat "#+BEGIN_EXAMPLE\n" code
2005 (if (string-match "\n\\'" code) "" "\n")
2006 "#+END_EXAMPLE\n"))
2007 ;; ok, we are good to go
2008 (let* ((mode (and lang (intern (concat lang "-mode"))))
2009 (org-inhibit-startup t)
2010 (org-startup-folded nil)
2011 (htmltext
2012 (with-temp-buffer
2013 (insert code)
2014 ;; Free up the protected stuff
2015 (goto-char (point-min))
2016 (while (re-search-forward "^," nil t)
2017 (replace-match "")
2018 (end-of-line 1))
2019 (if (functionp mode)
2020 (funcall mode)
2021 (fundamental-mode))
2022 (font-lock-fontify-buffer)
2023 (org-export-htmlize-region-for-paste
2024 (point-min) (point-max)))))
2025 (if (string-match "<pre\\([^>]*\\)>\n?" htmltext)
2026 (setq htmltext (replace-match
2027 (format "<pre class=\"src src-%s\">" lang)
2028 t t htmltext)))
2029 (concat "#+BEGIN_HTML\n" htmltext "\n#+END_HTML\n"))))
2031 ;; This is not HTML, so just make it an example.
2032 (when (equal lang "org")
2033 (while (string-match "^," code)
2034 (setq code (replace-match "" t t code))))
2035 (concat "#+BEGIN_EXAMPLE\n" code
2036 (if (string-match "\n\\'" code) "" "\n")
2037 "#+END_EXAMPLE\n")))))
2039 ;;; ASCII export
2041 (defvar org-last-level nil) ; dynamically scoped variable
2042 (defvar org-min-level nil) ; dynamically scoped variable
2043 (defvar org-levels-open nil) ; dynamically scoped parameter
2044 (defvar org-ascii-current-indentation nil) ; For communication
2046 ;;;###autoload
2047 (defun org-export-as-ascii (arg)
2048 "Export the outline as a pretty ASCII file.
2049 If there is an active region, export only the region.
2050 The prefix ARG specifies how many levels of the outline should become
2051 underlined headlines. The default is 3."
2052 (interactive "P")
2053 (setq-default org-todo-line-regexp org-todo-line-regexp)
2054 (let* ((opt-plist (org-combine-plists (org-default-export-plist)
2055 (org-infile-export-plist)))
2056 (region-p (org-region-active-p))
2057 (rbeg (and region-p (region-beginning)))
2058 (rend (and region-p (region-end)))
2059 (subtree-p
2060 (when region-p
2061 (save-excursion
2062 (goto-char rbeg)
2063 (and (org-at-heading-p)
2064 (>= (org-end-of-subtree t t) rend)))))
2065 (opt-plist (if subtree-p
2066 (org-export-add-subtree-options opt-plist rbeg)
2067 opt-plist))
2068 (custom-times org-display-custom-times)
2069 (org-ascii-current-indentation '(0 . 0))
2070 (level 0) line txt
2071 (umax nil)
2072 (umax-toc nil)
2073 (case-fold-search nil)
2074 (filename (concat (file-name-as-directory
2075 (org-export-directory :ascii opt-plist))
2076 (file-name-sans-extension
2077 (or (and subtree-p
2078 (org-entry-get (region-beginning)
2079 "EXPORT_FILE_NAME" t))
2080 (file-name-nondirectory buffer-file-name)))
2081 ".txt"))
2082 (filename (if (equal (file-truename filename)
2083 (file-truename buffer-file-name))
2084 (concat filename ".txt")
2085 filename))
2086 (buffer (find-file-noselect filename))
2087 (org-levels-open (make-vector org-level-max nil))
2088 (odd org-odd-levels-only)
2089 (date (plist-get opt-plist :date))
2090 (author (plist-get opt-plist :author))
2091 (title (or (and subtree-p (org-export-get-title-from-subtree))
2092 (plist-get opt-plist :title)
2093 (and (not
2094 (plist-get opt-plist :skip-before-1st-heading))
2095 (org-export-grab-title-from-buffer))
2096 (file-name-sans-extension
2097 (file-name-nondirectory buffer-file-name))))
2098 (email (plist-get opt-plist :email))
2099 (language (plist-get opt-plist :language))
2100 (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
2101 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
2102 (todo nil)
2103 (lang-words nil)
2104 (region
2105 (buffer-substring
2106 (if (org-region-active-p) (region-beginning) (point-min))
2107 (if (org-region-active-p) (region-end) (point-max))))
2108 (lines (org-split-string
2109 (org-export-preprocess-string
2110 region
2111 :for-ascii t
2112 :skip-before-1st-heading
2113 (plist-get opt-plist :skip-before-1st-heading)
2114 :drawers (plist-get opt-plist :drawers)
2115 :verbatim-multiline t
2116 :archived-trees
2117 (plist-get opt-plist :archived-trees)
2118 :add-text (plist-get opt-plist :text))
2119 "\n"))
2120 thetoc have-headings first-heading-pos
2121 table-open table-buffer)
2123 (let ((inhibit-read-only t))
2124 (org-unmodified
2125 (remove-text-properties (point-min) (point-max)
2126 '(:org-license-to-kill t))))
2128 (setq org-min-level (org-get-min-level lines))
2129 (setq org-last-level org-min-level)
2130 (org-init-section-numbers)
2132 (find-file-noselect filename)
2134 (setq lang-words (or (assoc language org-export-language-setup)
2135 (assoc "en" org-export-language-setup)))
2136 (switch-to-buffer-other-window buffer)
2137 (erase-buffer)
2138 (fundamental-mode)
2139 ;; create local variables for all options, to make sure all called
2140 ;; functions get the correct information
2141 (mapc (lambda (x)
2142 (set (make-local-variable (cdr x))
2143 (plist-get opt-plist (car x))))
2144 org-export-plist-vars)
2145 (org-set-local 'org-odd-levels-only odd)
2146 (setq umax (if arg (prefix-numeric-value arg)
2147 org-export-headline-levels))
2148 (setq umax-toc (if (integerp org-export-with-toc)
2149 (min org-export-with-toc umax)
2150 umax))
2152 ;; File header
2153 (if title (org-insert-centered title ?=))
2154 (insert "\n")
2155 (if (and (or author email)
2156 org-export-author-info)
2157 (insert (concat (nth 1 lang-words) ": " (or author "")
2158 (if email (concat " <" email ">") "")
2159 "\n")))
2161 (cond
2162 ((and date (string-match "%" date))
2163 (setq date (format-time-string date)))
2164 (date)
2165 (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
2167 (if (and date org-export-time-stamp-file)
2168 (insert (concat (nth 2 lang-words) ": " date"\n")))
2170 (insert "\n\n")
2172 (if org-export-with-toc
2173 (progn
2174 (push (concat (nth 3 lang-words) "\n") thetoc)
2175 (push (concat (make-string (string-width (nth 3 lang-words)) ?=)
2176 "\n") thetoc)
2177 (mapc '(lambda (line)
2178 (if (string-match org-todo-line-regexp
2179 line)
2180 ;; This is a headline
2181 (progn
2182 (setq have-headings t)
2183 (setq level (- (match-end 1) (match-beginning 1))
2184 level (org-tr-level level)
2185 txt (match-string 3 line)
2186 todo
2187 (or (and org-export-mark-todo-in-toc
2188 (match-beginning 2)
2189 (not (member (match-string 2 line)
2190 org-done-keywords)))
2191 ; TODO, not DONE
2192 (and org-export-mark-todo-in-toc
2193 (= level umax-toc)
2194 (org-search-todo-below
2195 line lines level))))
2196 (setq txt (org-html-expand-for-ascii txt))
2198 (while (string-match org-bracket-link-regexp txt)
2199 (setq txt
2200 (replace-match
2201 (match-string (if (match-end 2) 3 1) txt)
2202 t t txt)))
2204 (if (and (memq org-export-with-tags '(not-in-toc nil))
2205 (string-match
2206 (org-re "[ \t]+:[[:alnum:]_@:]+:[ \t]*$")
2207 txt))
2208 (setq txt (replace-match "" t t txt)))
2209 (if (string-match quote-re0 txt)
2210 (setq txt (replace-match "" t t txt)))
2212 (if org-export-with-section-numbers
2213 (setq txt (concat (org-section-number level)
2214 " " txt)))
2215 (if (<= level umax-toc)
2216 (progn
2217 (push
2218 (concat
2219 (make-string
2220 (* (max 0 (- level org-min-level)) 4) ?\ )
2221 (format (if todo "%s (*)\n" "%s\n") txt))
2222 thetoc)
2223 (setq org-last-level level))
2224 ))))
2225 lines)
2226 (setq thetoc (if have-headings (nreverse thetoc) nil))))
2228 (org-init-section-numbers)
2229 (while (setq line (pop lines))
2230 ;; Remove the quoted HTML tags.
2231 (setq line (org-html-expand-for-ascii line))
2232 ;; Remove targets
2233 (while (string-match "<<<?[^<>]*>>>?[ \t]*\n?" line)
2234 (setq line (replace-match "" t t line)))
2235 ;; Replace internal links
2236 (while (string-match org-bracket-link-regexp line)
2237 (setq line (replace-match
2238 (if (match-end 3) "[\\3]" "[\\1]")
2239 t nil line)))
2240 (when custom-times
2241 (setq line (org-translate-time line)))
2242 (cond
2243 ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
2244 ;; a Headline
2245 (setq first-heading-pos (or first-heading-pos (point)))
2246 (setq level (org-tr-level (- (match-end 1) (match-beginning 1)))
2247 txt (match-string 2 line))
2248 (org-ascii-level-start level txt umax lines))
2250 ((and org-export-with-tables
2251 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
2252 (if (not table-open)
2253 ;; New table starts
2254 (setq table-open t table-buffer nil))
2255 ;; Accumulate lines
2256 (setq table-buffer (cons line table-buffer))
2257 (when (or (not lines)
2258 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
2259 (car lines))))
2260 (setq table-open nil
2261 table-buffer (nreverse table-buffer))
2262 (insert (mapconcat
2263 (lambda (x)
2264 (org-fix-indentation x org-ascii-current-indentation))
2265 (org-format-table-ascii table-buffer)
2266 "\n") "\n")))
2268 (setq line (org-fix-indentation line org-ascii-current-indentation))
2269 (if (and org-export-with-fixed-width
2270 (string-match "^\\([ \t]*\\)\\(:\\)" line))
2271 (setq line (replace-match "\\1" nil nil line)))
2272 (insert line "\n"))))
2274 (normal-mode)
2276 ;; insert the table of contents
2277 (when thetoc
2278 (goto-char (point-min))
2279 (if (re-search-forward "^[ \t]*\\[TABLE-OF-CONTENTS\\][ \t]*$" nil t)
2280 (progn
2281 (goto-char (match-beginning 0))
2282 (replace-match ""))
2283 (goto-char first-heading-pos))
2284 (mapc 'insert thetoc)
2285 (or (looking-at "[ \t]*\n[ \t]*\n")
2286 (insert "\n\n")))
2288 ;; Convert whitespace place holders
2289 (goto-char (point-min))
2290 (let (beg end)
2291 (while (setq beg (next-single-property-change (point) 'org-whitespace))
2292 (setq end (next-single-property-change beg 'org-whitespace))
2293 (goto-char beg)
2294 (delete-region beg end)
2295 (insert (make-string (- end beg) ?\ ))))
2297 (save-buffer)
2298 ;; remove display and invisible chars
2299 (let (beg end)
2300 (goto-char (point-min))
2301 (while (setq beg (next-single-property-change (point) 'display))
2302 (setq end (next-single-property-change beg 'display))
2303 (delete-region beg end)
2304 (goto-char beg)
2305 (insert "=>"))
2306 (goto-char (point-min))
2307 (while (setq beg (next-single-property-change (point) 'org-cwidth))
2308 (setq end (next-single-property-change beg 'org-cwidth))
2309 (delete-region beg end)
2310 (goto-char beg)))
2311 (goto-char (point-min))))
2313 (defun org-export-ascii-preprocess ()
2314 "Do extra work for ASCII export"
2315 (goto-char (point-min))
2316 (while (re-search-forward org-verbatim-re nil t)
2317 (goto-char (match-end 2))
2318 (backward-delete-char 1) (insert "'")
2319 (goto-char (match-beginning 2))
2320 (delete-char 1) (insert "`")
2321 (goto-char (match-end 2))))
2323 (defun org-search-todo-below (line lines level)
2324 "Search the subtree below LINE for any TODO entries."
2325 (let ((rest (cdr (memq line lines)))
2326 (re org-todo-line-regexp)
2327 line lv todo)
2328 (catch 'exit
2329 (while (setq line (pop rest))
2330 (if (string-match re line)
2331 (progn
2332 (setq lv (- (match-end 1) (match-beginning 1))
2333 todo (and (match-beginning 2)
2334 (not (member (match-string 2 line)
2335 org-done-keywords))))
2336 ; TODO, not DONE
2337 (if (<= lv level) (throw 'exit nil))
2338 (if todo (throw 'exit t))))))))
2340 (defun org-html-expand-for-ascii (line)
2341 "Handle quoted HTML for ASCII export."
2342 (if org-export-html-expand
2343 (while (string-match "@<[^<>\n]*>" line)
2344 ;; We just remove the tags for now.
2345 (setq line (replace-match "" nil nil line))))
2346 line)
2348 (defun org-insert-centered (s &optional underline)
2349 "Insert the string S centered and underline it with character UNDERLINE."
2350 (let ((ind (max (/ (- fill-column (string-width s)) 2) 0)))
2351 (insert (make-string ind ?\ ) s "\n")
2352 (if underline
2353 (insert (make-string ind ?\ )
2354 (make-string (string-width s) underline)
2355 "\n"))))
2357 (defun org-ascii-level-start (level title umax &optional lines)
2358 "Insert a new level in ASCII export."
2359 (let (char (n (- level umax 1)) (ind 0))
2360 (if (> level umax)
2361 (progn
2362 (insert (make-string (* 2 n) ?\ )
2363 (char-to-string (nth (% n (length org-export-ascii-bullets))
2364 org-export-ascii-bullets))
2365 " " title "\n")
2366 ;; find the indentation of the next non-empty line
2367 (catch 'stop
2368 (while lines
2369 (if (string-match "^\\* " (car lines)) (throw 'stop nil))
2370 (if (string-match "^\\([ \t]*\\)\\S-" (car lines))
2371 (throw 'stop (setq ind (org-get-indentation (car lines)))))
2372 (pop lines)))
2373 (setq org-ascii-current-indentation (cons (* 2 (1+ n)) ind)))
2374 (if (or (not (equal (char-before) ?\n))
2375 (not (equal (char-before (1- (point))) ?\n)))
2376 (insert "\n"))
2377 (setq char (nth (- umax level) (reverse org-export-ascii-underline)))
2378 (unless org-export-with-tags
2379 (if (string-match (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title)
2380 (setq title (replace-match "" t t title))))
2381 (if org-export-with-section-numbers
2382 (setq title (concat (org-section-number level) " " title)))
2383 (insert title "\n" (make-string (string-width title) char) "\n")
2384 (setq org-ascii-current-indentation '(0 . 0)))))
2386 ;;;###autoload
2387 (defun org-export-visible (type arg)
2388 "Create a copy of the visible part of the current buffer, and export it.
2389 The copy is created in a temporary buffer and removed after use.
2390 TYPE is the final key (as a string) that also select the export command in
2391 the `C-c C-e' export dispatcher.
2392 As a special case, if the you type SPC at the prompt, the temporary
2393 org-mode file will not be removed but presented to you so that you can
2394 continue to use it. The prefix arg ARG is passed through to the exporting
2395 command."
2396 (interactive
2397 (list (progn
2398 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
2399 (read-char-exclusive))
2400 current-prefix-arg))
2401 (if (not (member type '(?a ?\C-a ?b ?\C-b ?h ?x ?\ )))
2402 (error "Invalid export key"))
2403 (let* ((binding (cdr (assoc type
2404 '((?a . org-export-as-ascii)
2405 (?\C-a . org-export-as-ascii)
2406 (?b . org-export-as-html-and-open)
2407 (?\C-b . org-export-as-html-and-open)
2408 (?h . org-export-as-html)
2409 (?H . org-export-as-html-to-buffer)
2410 (?R . org-export-region-as-html)
2411 (?x . org-export-as-xoxo)))))
2412 (keepp (equal type ?\ ))
2413 (file buffer-file-name)
2414 (buffer (get-buffer-create "*Org Export Visible*"))
2415 s e)
2416 ;; Need to hack the drawers here.
2417 (save-excursion
2418 (goto-char (point-min))
2419 (while (re-search-forward org-drawer-regexp nil t)
2420 (goto-char (match-beginning 1))
2421 (or (org-invisible-p) (org-flag-drawer nil))))
2422 (with-current-buffer buffer (erase-buffer))
2423 (save-excursion
2424 (setq s (goto-char (point-min)))
2425 (while (not (= (point) (point-max)))
2426 (goto-char (org-find-invisible))
2427 (append-to-buffer buffer s (point))
2428 (setq s (goto-char (org-find-visible))))
2429 (org-cycle-hide-drawers 'all)
2430 (goto-char (point-min))
2431 (unless keepp
2432 ;; Copy all comment lines to the end, to make sure #+ settings are
2433 ;; still available for the second export step. Kind of a hack, but
2434 ;; does do the trick.
2435 (if (looking-at "#[^\r\n]*")
2436 (append-to-buffer buffer (match-beginning 0) (1+ (match-end 0))))
2437 (while (re-search-forward "[\n\r]#[^\n\r]*" nil t)
2438 (append-to-buffer buffer (1+ (match-beginning 0))
2439 (min (point-max) (1+ (match-end 0))))))
2440 (set-buffer buffer)
2441 (let ((buffer-file-name file)
2442 (org-inhibit-startup t))
2443 (org-mode)
2444 (show-all)
2445 (unless keepp (funcall binding arg))))
2446 (if (not keepp)
2447 (kill-buffer buffer)
2448 (switch-to-buffer-other-window buffer)
2449 (goto-char (point-min)))))
2451 (defun org-find-visible ()
2452 (let ((s (point)))
2453 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
2454 (get-char-property s 'invisible)))
2456 (defun org-find-invisible ()
2457 (let ((s (point)))
2458 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
2459 (not (get-char-property s 'invisible))))
2462 ;;; HTML export
2464 (defvar org-archive-location) ;; gets loades with the org-archive require.
2465 (defun org-get-current-options ()
2466 "Return a string with current options as keyword options.
2467 Does include HTML export options as well as TODO and CATEGORY stuff."
2468 (require 'org-archive)
2469 (format
2470 "#+TITLE: %s
2471 #+AUTHOR: %s
2472 #+EMAIL: %s
2473 #+DATE: %s
2474 #+LANGUAGE: %s
2475 #+TEXT: Some descriptive text to be emitted. Several lines OK.
2476 #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s -:%s f:%s *:%s TeX:%s LaTeX:%s skip:%s d:%s tags:%s
2478 #+LINK_UP: %s
2479 #+LINK_HOME: %s
2480 #+CATEGORY: %s
2481 #+SEQ_TODO: %s
2482 #+TYP_TODO: %s
2483 #+PRIORITIES: %c %c %c
2484 #+DRAWERS: %s
2485 #+STARTUP: %s %s %s %s %s
2486 #+TAGS: %s
2487 #+FILETAGS: %s
2488 #+ARCHIVE: %s
2489 #+LINK: %s
2491 (buffer-name) (user-full-name) user-mail-address
2492 (format-time-string (car org-time-stamp-formats))
2493 org-export-default-language
2494 org-export-headline-levels
2495 org-export-with-section-numbers
2496 org-export-with-toc
2497 org-export-preserve-breaks
2498 org-export-html-expand
2499 org-export-with-fixed-width
2500 org-export-with-tables
2501 org-export-with-sub-superscripts
2502 org-export-with-special-strings
2503 org-export-with-footnotes
2504 org-export-with-emphasize
2505 org-export-with-TeX-macros
2506 org-export-with-LaTeX-fragments
2507 org-export-skip-text-before-1st-heading
2508 org-export-with-drawers
2509 org-export-with-tags
2510 (if (featurep 'org-jsinfo) (org-infojs-options-inbuffer-template) "")
2511 org-export-html-link-up
2512 org-export-html-link-home
2513 (file-name-nondirectory buffer-file-name)
2514 "TODO FEEDBACK VERIFY DONE"
2515 "Me Jason Marie DONE"
2516 org-highest-priority org-lowest-priority org-default-priority
2517 (mapconcat 'identity org-drawers " ")
2518 (cdr (assoc org-startup-folded
2519 '((nil . "showall") (t . "overview") (content . "content"))))
2520 (if org-odd-levels-only "odd" "oddeven")
2521 (if org-hide-leading-stars "hidestars" "showstars")
2522 (if org-startup-align-all-tables "align" "noalign")
2523 (cond ((eq org-log-done t) "logdone")
2524 ((equal org-log-done 'note) "lognotedone")
2525 ((not org-log-done) "nologdone"))
2526 (or (mapconcat (lambda (x)
2527 (cond
2528 ((equal '(:startgroup) x) "{")
2529 ((equal '(:endgroup) x) "}")
2530 ((cdr x) (format "%s(%c)" (car x) (cdr x)))
2531 (t (car x))))
2532 (or org-tag-alist (org-get-buffer-tags)) " ") "")
2533 (mapconcat 'identity org-file-tags " ")
2534 org-archive-location
2535 "org file:~/org/%s.org"
2538 (defun org-export-html-preprocess (parameters)
2539 ;; Convert LaTeX fragments to images
2540 (when (plist-get parameters :LaTeX-fragments)
2541 (org-format-latex
2542 (concat "ltxpng/" (file-name-sans-extension
2543 (file-name-nondirectory
2544 org-current-export-file)))
2545 org-current-export-dir nil "Creating LaTeX image %s"))
2546 (message "Exporting..."))
2548 ;;;###autoload
2549 (defun org-insert-export-options-template ()
2550 "Insert into the buffer a template with information for exporting."
2551 (interactive)
2552 (if (not (bolp)) (newline))
2553 (let ((s (org-get-current-options)))
2554 (and (string-match "#\\+CATEGORY" s)
2555 (setq s (substring s 0 (match-beginning 0))))
2556 (insert s)))
2558 ;;;###autoload
2559 (defun org-export-as-html-and-open (arg)
2560 "Export the outline as HTML and immediately open it with a browser.
2561 If there is an active region, export only the region.
2562 The prefix ARG specifies how many levels of the outline should become
2563 headlines. The default is 3. Lower levels will become bulleted lists."
2564 (interactive "P")
2565 (org-export-as-html arg 'hidden)
2566 (org-open-file buffer-file-name))
2568 ;;;###autoload
2569 (defun org-export-as-html-batch ()
2570 "Call `org-export-as-html', may be used in batch processing as
2571 emacs --batch
2572 --load=$HOME/lib/emacs/org.el
2573 --eval \"(setq org-export-headline-levels 2)\"
2574 --visit=MyFile --funcall org-export-as-html-batch"
2575 (org-export-as-html org-export-headline-levels 'hidden))
2577 ;;;###autoload
2578 (defun org-export-as-html-to-buffer (arg)
2579 "Call `org-exort-as-html` with output to a temporary buffer.
2580 No file is created. The prefix ARG is passed through to `org-export-as-html'."
2581 (interactive "P")
2582 (org-export-as-html arg nil nil "*Org HTML Export*")
2583 (switch-to-buffer-other-window "*Org HTML Export*"))
2585 ;;;###autoload
2586 (defun org-replace-region-by-html (beg end)
2587 "Assume the current region has org-mode syntax, and convert it to HTML.
2588 This can be used in any buffer. For example, you could write an
2589 itemized list in org-mode syntax in an HTML buffer and then use this
2590 command to convert it."
2591 (interactive "r")
2592 (let (reg html buf pop-up-frames)
2593 (save-window-excursion
2594 (if (org-mode-p)
2595 (setq html (org-export-region-as-html
2596 beg end t 'string))
2597 (setq reg (buffer-substring beg end)
2598 buf (get-buffer-create "*Org tmp*"))
2599 (with-current-buffer buf
2600 (erase-buffer)
2601 (insert reg)
2602 (org-mode)
2603 (setq html (org-export-region-as-html
2604 (point-min) (point-max) t 'string)))
2605 (kill-buffer buf)))
2606 (delete-region beg end)
2607 (insert html)))
2609 ;;;###autoload
2610 (defun org-export-region-as-html (beg end &optional body-only buffer)
2611 "Convert region from BEG to END in org-mode buffer to HTML.
2612 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
2613 contents, and only produce the region of converted text, useful for
2614 cut-and-paste operations.
2615 If BUFFER is a buffer or a string, use/create that buffer as a target
2616 of the converted HTML. If BUFFER is the symbol `string', return the
2617 produced HTML as a string and leave not buffer behind. For example,
2618 a Lisp program could call this function in the following way:
2620 (setq html (org-export-region-as-html beg end t 'string))
2622 When called interactively, the output buffer is selected, and shown
2623 in a window. A non-interactive call will only return the buffer."
2624 (interactive "r\nP")
2625 (when (interactive-p)
2626 (setq buffer "*Org HTML Export*"))
2627 (let ((transient-mark-mode t) (zmacs-regions t)
2628 ext-plist rtn)
2629 (setq ext-plist (plist-put ext-plist :ignore-subree-p t))
2630 (goto-char end)
2631 (set-mark (point)) ;; to activate the region
2632 (goto-char beg)
2633 (setq rtn (org-export-as-html
2634 nil nil ext-plist
2635 buffer body-only))
2636 (if (fboundp 'deactivate-mark) (deactivate-mark))
2637 (if (and (interactive-p) (bufferp rtn))
2638 (switch-to-buffer-other-window rtn)
2639 rtn)))
2641 (defvar html-table-tag nil) ; dynamically scoped into this.
2642 ;;;###autoload
2643 (defun org-export-as-html (arg &optional hidden ext-plist
2644 to-buffer body-only pub-dir)
2645 "Export the outline as a pretty HTML file.
2646 If there is an active region, export only the region. The prefix
2647 ARG specifies how many levels of the outline should become
2648 headlines. The default is 3. Lower levels will become bulleted
2649 lists. When HIDDEN is non-nil, don't display the HTML buffer.
2650 EXT-PLIST is a property list with external parameters overriding
2651 org-mode's default settings, but still inferior to file-local
2652 settings. When TO-BUFFER is non-nil, create a buffer with that
2653 name and export to that buffer. If TO-BUFFER is the symbol
2654 `string', don't leave any buffer behind but just return the
2655 resulting HTML as a string. When BODY-ONLY is set, don't produce
2656 the file header and footer, simply return the content of
2657 <body>...</body>, without even the body tags themselves. When
2658 PUB-DIR is set, use this as the publishing directory."
2659 (interactive "P")
2661 ;; Make sure we have a file name when we need it.
2662 (when (and (not (or to-buffer body-only))
2663 (not buffer-file-name))
2664 (if (buffer-base-buffer)
2665 (org-set-local 'buffer-file-name
2666 (with-current-buffer (buffer-base-buffer)
2667 buffer-file-name))
2668 (error "Need a file name to be able to export.")))
2670 (message "Exporting...")
2671 (setq-default org-todo-line-regexp org-todo-line-regexp)
2672 (setq-default org-deadline-line-regexp org-deadline-line-regexp)
2673 (setq-default org-done-keywords org-done-keywords)
2674 (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp)
2675 (let* ((opt-plist
2676 (org-export-process-option-filters
2677 (org-combine-plists (org-default-export-plist)
2678 ext-plist
2679 (org-infile-export-plist))))
2681 (style (concat org-export-html-style-default
2682 (plist-get opt-plist :style)
2683 (plist-get opt-plist :style-extra)))
2684 (html-extension (plist-get opt-plist :html-extension))
2685 (link-validate (plist-get opt-plist :link-validation-function))
2686 valid thetoc have-headings first-heading-pos
2687 (odd org-odd-levels-only)
2688 (region-p (org-region-active-p))
2689 (rbeg (and region-p (region-beginning)))
2690 (rend (and region-p (region-end)))
2691 (subtree-p
2692 (if (plist-get opt-plist :ignore-subree-p)
2694 (when region-p
2695 (save-excursion
2696 (goto-char rbeg)
2697 (and (org-at-heading-p)
2698 (>= (org-end-of-subtree t t) rend))))))
2699 (opt-plist (if subtree-p
2700 (org-export-add-subtree-options opt-plist rbeg)
2701 opt-plist))
2702 ;; The following two are dynamically scoped into other
2703 ;; routines below.
2704 (org-current-export-dir
2705 (or pub-dir (org-export-directory :html opt-plist)))
2706 (org-current-export-file buffer-file-name)
2707 (level 0) (line "") (origline "") txt todo
2708 (umax nil)
2709 (umax-toc nil)
2710 (filename (if to-buffer nil
2711 (expand-file-name
2712 (concat
2713 (file-name-sans-extension
2714 (or (and subtree-p
2715 (org-entry-get (region-beginning)
2716 "EXPORT_FILE_NAME" t))
2717 (file-name-nondirectory buffer-file-name)))
2718 "." html-extension)
2719 (file-name-as-directory
2720 (or pub-dir (org-export-directory :html opt-plist))))))
2721 (current-dir (if buffer-file-name
2722 (file-name-directory buffer-file-name)
2723 default-directory))
2724 (buffer (if to-buffer
2725 (cond
2726 ((eq to-buffer 'string) (get-buffer-create "*Org HTML Export*"))
2727 (t (get-buffer-create to-buffer)))
2728 (find-file-noselect filename)))
2729 (org-levels-open (make-vector org-level-max nil))
2730 (date (plist-get opt-plist :date))
2731 (author (plist-get opt-plist :author))
2732 (title (or (and subtree-p (org-export-get-title-from-subtree))
2733 (plist-get opt-plist :title)
2734 (and (not
2735 (plist-get opt-plist :skip-before-1st-heading))
2736 (org-export-grab-title-from-buffer))
2737 (and buffer-file-name
2738 (file-name-sans-extension
2739 (file-name-nondirectory buffer-file-name)))
2740 "UNTITLED"))
2741 (html-table-tag (plist-get opt-plist :html-table-tag))
2742 (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
2743 (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string "\\>\\)"))
2744 (inquote nil)
2745 (infixed nil)
2746 (inverse nil)
2747 (in-local-list nil)
2748 (local-list-type nil)
2749 (local-list-indent nil)
2750 (llt org-plain-list-ordered-item-terminator)
2751 (email (plist-get opt-plist :email))
2752 (language (plist-get opt-plist :language))
2753 (lang-words nil)
2754 (head-count 0) cnt
2755 (start 0)
2756 (coding-system (and (boundp 'buffer-file-coding-system)
2757 buffer-file-coding-system))
2758 (coding-system-for-write (or org-export-html-coding-system
2759 coding-system))
2760 (save-buffer-coding-system (or org-export-html-coding-system
2761 coding-system))
2762 (charset (and coding-system-for-write
2763 (fboundp 'coding-system-get)
2764 (coding-system-get coding-system-for-write
2765 'mime-charset)))
2766 (region
2767 (buffer-substring
2768 (if region-p (region-beginning) (point-min))
2769 (if region-p (region-end) (point-max))))
2770 (lines
2771 (org-split-string
2772 (org-export-preprocess-string
2773 region
2774 :emph-multiline t
2775 :for-html t
2776 :skip-before-1st-heading
2777 (plist-get opt-plist :skip-before-1st-heading)
2778 :drawers (plist-get opt-plist :drawers)
2779 :archived-trees
2780 (plist-get opt-plist :archived-trees)
2781 :add-text
2782 (plist-get opt-plist :text)
2783 :LaTeX-fragments
2784 (plist-get opt-plist :LaTeX-fragments))
2785 "[\r\n]"))
2786 table-open type
2787 table-buffer table-orig-buffer
2788 ind item-type starter didclose
2789 rpl path attr desc descp desc1 desc2 link
2790 snumber fnc item-tag
2793 (let ((inhibit-read-only t))
2794 (org-unmodified
2795 (remove-text-properties (point-min) (point-max)
2796 '(:org-license-to-kill t))))
2798 (message "Exporting...")
2800 (setq org-min-level (org-get-min-level lines))
2801 (setq org-last-level org-min-level)
2802 (org-init-section-numbers)
2804 (cond
2805 ((and date (string-match "%" date))
2806 (setq date (format-time-string date)))
2807 (date)
2808 (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
2810 ;; Get the language-dependent settings
2811 (setq lang-words (or (assoc language org-export-language-setup)
2812 (assoc "en" org-export-language-setup)))
2814 ;; Switch to the output buffer
2815 (set-buffer buffer)
2816 (let ((inhibit-read-only t)) (erase-buffer))
2817 (fundamental-mode)
2819 (and (fboundp 'set-buffer-file-coding-system)
2820 (set-buffer-file-coding-system coding-system-for-write))
2822 (let ((case-fold-search nil)
2823 (org-odd-levels-only odd))
2824 ;; create local variables for all options, to make sure all called
2825 ;; functions get the correct information
2826 (mapc (lambda (x)
2827 (set (make-local-variable (cdr x))
2828 (plist-get opt-plist (car x))))
2829 org-export-plist-vars)
2830 (setq umax (if arg (prefix-numeric-value arg)
2831 org-export-headline-levels))
2832 (setq umax-toc (if (integerp org-export-with-toc)
2833 (min org-export-with-toc umax)
2834 umax))
2835 (unless body-only
2836 ;; File header
2837 (insert (format
2838 "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
2839 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
2840 <html xmlns=\"http://www.w3.org/1999/xhtml\"
2841 lang=\"%s\" xml:lang=\"%s\">
2842 <head>
2843 <title>%s</title>
2844 <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
2845 <meta name=\"generator\" content=\"Org-mode\"/>
2846 <meta name=\"generated\" content=\"%s\"/>
2847 <meta name=\"author\" content=\"%s\"/>
2849 </head><body>
2851 language language (org-html-expand title)
2852 (or charset "iso-8859-1") date author style))
2854 (insert (or (plist-get opt-plist :preamble) ""))
2856 (when (plist-get opt-plist :auto-preamble)
2857 (if title (insert (format org-export-html-title-format
2858 (org-html-expand title))))))
2860 (if (and org-export-with-toc (not body-only))
2861 (progn
2862 (push (format "<h%d>%s</h%d>\n"
2863 org-export-html-toplevel-hlevel
2864 (nth 3 lang-words)
2865 org-export-html-toplevel-hlevel)
2866 thetoc)
2867 (push "<div id=\"text-table-of-contents\">\n" thetoc)
2868 (push "<ul>\n<li>" thetoc)
2869 (setq lines
2870 (mapcar '(lambda (line)
2871 (if (string-match org-todo-line-regexp line)
2872 ;; This is a headline
2873 (progn
2874 (setq have-headings t)
2875 (setq level (- (match-end 1) (match-beginning 1))
2876 level (org-tr-level level)
2877 txt (save-match-data
2878 (org-html-expand
2879 (org-export-cleanup-toc-line
2880 (match-string 3 line))))
2881 todo
2882 (or (and org-export-mark-todo-in-toc
2883 (match-beginning 2)
2884 (not (member (match-string 2 line)
2885 org-done-keywords)))
2886 ; TODO, not DONE
2887 (and org-export-mark-todo-in-toc
2888 (= level umax-toc)
2889 (org-search-todo-below
2890 line lines level))))
2891 (if (string-match
2892 (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt)
2893 (setq txt (replace-match "&nbsp;&nbsp;&nbsp;<span class=\"tag\"> \\1</span>" t nil txt)))
2894 (if (string-match quote-re0 txt)
2895 (setq txt (replace-match "" t t txt)))
2896 (setq snumber (org-section-number level))
2897 (if org-export-with-section-numbers
2898 (setq txt (concat snumber " " txt)))
2899 (if (<= level (max umax umax-toc))
2900 (setq head-count (+ head-count 1)))
2901 (if (<= level umax-toc)
2902 (progn
2903 (if (> level org-last-level)
2904 (progn
2905 (setq cnt (- level org-last-level))
2906 (while (>= (setq cnt (1- cnt)) 0)
2907 (push "\n<ul>\n<li>" thetoc))
2908 (push "\n" thetoc)))
2909 (if (< level org-last-level)
2910 (progn
2911 (setq cnt (- org-last-level level))
2912 (while (>= (setq cnt (1- cnt)) 0)
2913 (push "</li>\n</ul>" thetoc))
2914 (push "\n" thetoc)))
2915 ;; Check for targets
2916 (while (string-match org-any-target-regexp line)
2917 (setq line (replace-match
2918 (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
2919 t t line)))
2920 (while (string-match "&lt;\\(&lt;\\)+\\|&gt;\\(&gt;\\)+" txt)
2921 (setq txt (replace-match "" t t txt)))
2922 (push
2923 (format
2924 (if todo
2925 "</li>\n<li><a href=\"#sec-%s\"><span class=\"todo\">%s</span></a>"
2926 "</li>\n<li><a href=\"#sec-%s\">%s</a>")
2927 snumber txt) thetoc)
2929 (setq org-last-level level))
2931 line)
2932 lines))
2933 (while (> org-last-level (1- org-min-level))
2934 (setq org-last-level (1- org-last-level))
2935 (push "</li>\n</ul>\n" thetoc))
2936 (push "</div>\n" thetoc)
2937 (setq thetoc (if have-headings (nreverse thetoc) nil))))
2939 (setq head-count 0)
2940 (org-init-section-numbers)
2942 (while (setq line (pop lines) origline line)
2943 (catch 'nextline
2945 ;; end of quote section?
2946 (when (and inquote (string-match "^\\*+ " line))
2947 (insert "</pre>\n")
2948 (setq inquote nil))
2949 ;; inside a quote section?
2950 (when inquote
2951 (insert (org-html-protect line) "\n")
2952 (throw 'nextline nil))
2954 ;; Fixed-width, verbatim lines (examples)
2955 (when (and org-export-with-fixed-width
2956 (string-match "^[ \t]*:\\(.*\\)" line))
2957 (when (not infixed)
2958 (setq infixed t)
2959 (insert "<pre class=\"example\">\n"))
2960 (insert (org-html-protect (match-string 1 line)) "\n")
2961 (when (or (not lines)
2962 (not (string-match "^[ \t]*\\(:.*\\)"
2963 (car lines))))
2964 (setq infixed nil)
2965 (insert "</pre>\n"))
2966 (throw 'nextline nil))
2968 ;; Protected HTML
2969 (when (get-text-property 0 'org-protected line)
2970 (let (par)
2971 (when (re-search-backward
2972 "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t)
2973 (setq par (match-string 1))
2974 (replace-match "\\2\n"))
2975 (insert line "\n")
2976 (while (and lines
2977 (not (string-match "^[ \t]*:" (car lines)))
2978 (or (= (length (car lines)) 0)
2979 (get-text-property 0 'org-protected (car lines))))
2980 (insert (pop lines) "\n"))
2981 (and par (insert "<p>\n")))
2982 (throw 'nextline nil))
2984 ;; Horizontal line
2985 (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line)
2986 (insert "\n<hr/>\n")
2987 (throw 'nextline nil))
2989 ;; Blockquotes and verse
2990 (when (equal "ORG-BLOCKQUOTE-START" line)
2991 (insert "<blockquote>\n<p>\n")
2992 (throw 'nextline nil))
2993 (when (equal "ORG-BLOCKQUOTE-END" line)
2994 (insert "</p>\n</blockquote>\n")
2995 (throw 'nextline nil))
2996 (when (equal "ORG-VERSE-START" line)
2997 (insert "\n<p class=\"verse\">\n")
2998 (setq inverse t)
2999 (throw 'nextline nil))
3000 (when (equal "ORG-VERSE-END" line)
3001 (insert "</p>\n")
3002 (setq inverse nil)
3003 (throw 'nextline nil))
3004 (when inverse
3005 (setq i (org-get-string-indentation line))
3006 (if (> i 0)
3007 (setq line (concat (mapconcat 'identity
3008 (make-list (* 2 i) "\\nbsp") "")
3009 " " (org-trim line))))
3010 (setq line (concat line " \\\\")))
3012 ;; make targets to anchors
3013 (while (string-match "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line)
3014 (cond
3015 ((match-end 2)
3016 (setq line (replace-match
3017 (concat "@<a name=\""
3018 (org-solidify-link-text (match-string 1 line))
3019 "\">\\nbsp@</a>")
3020 t t line)))
3021 ((and org-export-with-toc (equal (string-to-char line) ?*))
3022 ;; FIXME: NOT DEPENDENT on TOC?????????????????????
3023 (setq line (replace-match
3024 (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
3025 ; (concat "@<i>" (match-string 1 line) "@</i> ")
3026 t t line)))
3028 (setq line (replace-match
3029 (concat "@<a name=\""
3030 (org-solidify-link-text (match-string 1 line))
3031 "\" class=\"target\">" (match-string 1 line) "@</a> ")
3032 t t line)))))
3034 (setq line (org-html-handle-time-stamps line))
3036 ;; replace "&" by "&amp;", "<" and ">" by "&lt;" and "&gt;"
3037 ;; handle @<..> HTML tags (replace "@&gt;..&lt;" by "<..>")
3038 ;; Also handle sub_superscripts and checkboxes
3039 (or (string-match org-table-hline-regexp line)
3040 (setq line (org-html-expand line)))
3042 ;; Format the links
3043 (setq start 0)
3044 (while (string-match org-bracket-link-analytic-regexp line start)
3045 (setq start (match-beginning 0))
3046 (setq path (save-match-data (org-link-unescape
3047 (match-string 3 line))))
3048 (setq type (cond
3049 ((match-end 2) (match-string 2 line))
3050 ((save-match-data
3051 (or (file-name-absolute-p path)
3052 (string-match "^\\.\\.?/" path)))
3053 "file")
3054 (t "internal")))
3055 (setq path (org-extract-attributes path))
3056 (setq attr (org-attributes-to-string
3057 (get-text-property 0 'org-attributes path)))
3058 (setq desc1 (if (match-end 5) (match-string 5 line))
3059 desc2 (if (match-end 2) (concat type ":" path) path)
3060 descp (and desc1 (not (equal desc1 desc2)))
3061 desc (or desc1 desc2))
3062 ;; Make an image out of the description if that is so wanted
3063 (when (and descp (org-file-image-p desc))
3064 (save-match-data
3065 (if (string-match "^file:" desc)
3066 (setq desc (substring desc (match-end 0)))))
3067 (setq desc (concat "<img src=\"" desc "\"/>")))
3068 ;; FIXME: do we need to unescape here somewhere?
3069 (cond
3070 ((equal type "internal")
3071 (setq rpl
3072 (concat
3073 "<a href=\"#"
3074 (org-solidify-link-text
3075 (save-match-data (org-link-unescape path)) nil)
3076 "\"" attr ">" desc "</a>")))
3077 ((member type '("http" "https"))
3078 ;; standard URL, just check if we need to inline an image
3079 (if (and (or (eq t org-export-html-inline-images)
3080 (and org-export-html-inline-images (not descp)))
3081 (org-file-image-p path))
3082 (setq rpl (concat "<img src=\"" type ":" path "\"" attr "/>"))
3083 (setq link (concat type ":" path))
3084 (setq rpl (concat "<a href=\"" link "\"" attr ">"
3085 desc "</a>"))))
3086 ((member type '("ftp" "mailto" "news"))
3087 ;; standard URL
3088 (setq link (concat type ":" path))
3089 (setq rpl (concat "<a href=\"" link "\"" attr ">" desc "</a>")))
3091 ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
3092 ;; The link protocol has a function for format the link
3093 (setq rpl
3094 (save-match-data
3095 (funcall fnc (org-link-unescape path) desc1 'html))))
3097 ((string= type "file")
3098 ;; FILE link
3099 (let* ((filename path)
3100 (abs-p (file-name-absolute-p filename))
3101 thefile file-is-image-p search)
3102 (save-match-data
3103 (if (string-match "::\\(.*\\)" filename)
3104 (setq search (match-string 1 filename)
3105 filename (replace-match "" t nil filename)))
3106 (setq valid
3107 (if (functionp link-validate)
3108 (funcall link-validate filename current-dir)
3110 (setq file-is-image-p (org-file-image-p filename))
3111 (setq thefile (if abs-p (expand-file-name filename) filename))
3112 (when (and org-export-html-link-org-files-as-html
3113 (string-match "\\.org$" thefile))
3114 (setq thefile (concat (substring thefile 0
3115 (match-beginning 0))
3116 "." html-extension))
3117 (if (and search
3118 ;; make sure this is can be used as target search
3119 (not (string-match "^[0-9]*$" search))
3120 (not (string-match "^\\*" search))
3121 (not (string-match "^/.*/$" search)))
3122 (setq thefile (concat thefile "#"
3123 (org-solidify-link-text
3124 (org-link-unescape search)))))
3125 (when (string-match "^file:" desc)
3126 (setq desc (replace-match "" t t desc))
3127 (if (string-match "\\.org$" desc)
3128 (setq desc (replace-match "" t t desc))))))
3129 (setq rpl (if (and file-is-image-p
3130 (or (eq t org-export-html-inline-images)
3131 (and org-export-html-inline-images
3132 (not descp))))
3133 (concat "<img src=\"" thefile "\"" attr "/>")
3134 (concat "<a href=\"" thefile "\"" attr ">"
3135 desc "</a>")))
3136 (if (not valid) (setq rpl desc))))
3139 ;; just publish the path, as default
3140 (setq rpl (concat "<i>&lt;" type ":"
3141 (save-match-data (org-link-unescape path))
3142 "&gt;</i>"))))
3143 (setq line (replace-match rpl t t line)
3144 start (+ start (length rpl))))
3146 ;; TODO items
3147 (if (and (string-match org-todo-line-regexp line)
3148 (match-beginning 2))
3150 (setq line
3151 (concat (substring line 0 (match-beginning 2))
3152 "<span class=\""
3153 (if (member (match-string 2 line)
3154 org-done-keywords)
3155 "done" "todo")
3156 "\">" (match-string 2 line)
3157 "</span>" (substring line (match-end 2)))))
3159 ;; Does this contain a reference to a footnote?
3160 (when org-export-with-footnotes
3161 (setq start 0)
3162 (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start)
3163 (if (get-text-property (match-beginning 2) 'org-protected line)
3164 (setq start (match-end 2))
3165 (let ((n (match-string 2 line)))
3166 (setq line
3167 (replace-match
3168 (format
3169 "%s<sup><a class=\"footref\" name=\"fnr.%s\" href=\"#fn.%s\">%s</a></sup>"
3170 (match-string 1 line) n n n)
3171 t t line))))))
3173 (cond
3174 ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
3175 ;; This is a headline
3176 (setq level (org-tr-level (- (match-end 1) (match-beginning 1)))
3177 txt (match-string 2 line))
3178 (if (string-match quote-re0 txt)
3179 (setq txt (replace-match "" t t txt)))
3180 (if (<= level (max umax umax-toc))
3181 (setq head-count (+ head-count 1)))
3182 (when in-local-list
3183 ;; Close any local lists before inserting a new header line
3184 (while local-list-type
3185 (org-close-li (car local-list-type))
3186 (insert (format "</%sl>\n" (car local-list-type)))
3187 (pop local-list-type))
3188 (setq local-list-indent nil
3189 in-local-list nil))
3190 (setq first-heading-pos (or first-heading-pos (point)))
3191 (org-html-level-start level txt umax
3192 (and org-export-with-toc (<= level umax))
3193 head-count)
3194 ;; QUOTES
3195 (when (string-match quote-re line)
3196 (insert "<pre>")
3197 (setq inquote t)))
3199 ((and org-export-with-tables
3200 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
3201 (if (not table-open)
3202 ;; New table starts
3203 (setq table-open t table-buffer nil table-orig-buffer nil))
3204 ;; Accumulate lines
3205 (setq table-buffer (cons line table-buffer)
3206 table-orig-buffer (cons origline table-orig-buffer))
3207 (when (or (not lines)
3208 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
3209 (car lines))))
3210 (setq table-open nil
3211 table-buffer (nreverse table-buffer)
3212 table-orig-buffer (nreverse table-orig-buffer))
3213 (org-close-par-maybe)
3214 (insert (org-format-table-html table-buffer table-orig-buffer))))
3216 ;; Normal lines
3217 (when (string-match
3218 (cond
3219 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
3220 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
3221 ((= llt ?\)) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+)\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
3222 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))
3223 line)
3224 (setq ind (org-get-string-indentation line)
3225 item-type (if (match-beginning 4) "o" "u")
3226 starter (if (match-beginning 2)
3227 (substring (match-string 2 line) 0 -1))
3228 line (substring line (match-beginning 5))
3229 item-tag nil)
3230 (if (and starter (string-match "\\(.*?\\) ::[ \t]*" line))
3231 (setq item-type "d"
3232 item-tag (match-string 1 line)
3233 line (substring line (match-end 0))))
3234 (when (and (not (equal item-type "d"))
3235 (not (string-match "[^ \t]" line)))
3236 ;; empty line. Pretend indentation is large.
3237 (setq ind (if org-empty-line-terminates-plain-lists
3239 (1+ (or (car local-list-indent) 1)))))
3240 (setq didclose nil)
3241 (while (and in-local-list
3242 (or (and (= ind (car local-list-indent))
3243 (not starter))
3244 (< ind (car local-list-indent))))
3245 (setq didclose t)
3246 (org-close-li (car local-list-type))
3247 (insert (format "</%sl>\n" (car local-list-type)))
3248 (pop local-list-type) (pop local-list-indent)
3249 (setq in-local-list local-list-indent))
3250 (cond
3251 ((and starter
3252 (or (not in-local-list)
3253 (> ind (car local-list-indent))))
3254 ;; Start new (level of) list
3255 (org-close-par-maybe)
3256 (insert (cond
3257 ((equal item-type "u") "<ul>\n<li>\n")
3258 ((equal item-type "o") "<ol>\n<li>\n")
3259 ((equal item-type "d")
3260 (format "<dl>\n<dt>%s</dt><dd>\n" item-tag))))
3261 (push item-type local-list-type)
3262 (push ind local-list-indent)
3263 (setq in-local-list t))
3264 (starter
3265 ;; continue current list
3266 (org-close-li (car local-list-type))
3267 (insert (cond
3268 ((equal (car local-list-type) "d")
3269 (format "<dt>%s</dt><dd>\n" (or item-tag "???")))
3270 (t "<li>\n"))))
3271 (didclose
3272 ;; we did close a list, normal text follows: need <p>
3273 (org-open-par)))
3274 (if (string-match "^[ \t]*\\[\\([X ]\\)\\]" line)
3275 (setq line
3276 (replace-match
3277 (if (equal (match-string 1 line) "X")
3278 "<b>[X]</b>"
3279 "<b>[<span style=\"visibility:hidden;\">X</span>]</b>")
3280 t t line))))
3282 ;; Empty lines start a new paragraph. If hand-formatted lists
3283 ;; are not fully interpreted, lines starting with "-", "+", "*"
3284 ;; also start a new paragraph.
3285 (if (string-match "^ [-+*]-\\|^[ \t]*$" line) (org-open-par))
3287 ;; Is this the start of a footnote?
3288 (when org-export-with-footnotes
3289 (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line)
3290 (org-close-par-maybe)
3291 (let ((n (match-string 1 line)))
3292 (setq line (replace-match
3293 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line))
3294 (setq line (concat line "</p>")))))
3296 ;; Check if the line break needs to be conserved
3297 (cond
3298 ((string-match "\\\\\\\\[ \t]*$" line)
3299 (setq line (replace-match "<br/>" t t line)))
3300 (org-export-preserve-breaks
3301 (setq line (concat line "<br/>"))))
3303 (insert line "\n")))))
3305 ;; Properly close all local lists and other lists
3306 (when inquote (insert "</pre>\n"))
3307 (when in-local-list
3308 ;; Close any local lists before inserting a new header line
3309 (while local-list-type
3310 (org-close-li (car local-list-type))
3311 (insert (format "</%sl>\n" (car local-list-type)))
3312 (pop local-list-type))
3313 (setq local-list-indent nil
3314 in-local-list nil))
3315 (org-html-level-start 1 nil umax
3316 (and org-export-with-toc (<= level umax))
3317 head-count)
3318 ;; the </div> to lose the last text-... div.
3319 (insert "</div>\n")
3321 (unless body-only
3322 (when (plist-get opt-plist :auto-postamble)
3323 (insert "<div id=\"postamble\">")
3324 (when (and org-export-author-info author)
3325 (insert "<p class=\"author\"> "
3326 (nth 1 lang-words) ": " author "\n")
3327 (when email
3328 (if (listp (split-string email ",+ *"))
3329 (mapc (lambda(e)
3330 (insert "<a href=\"mailto:" e "\">&lt;"
3331 e "&gt;</a>\n"))
3332 (split-string email ",+ *"))
3333 (insert "<a href=\"mailto:" email "\">&lt;"
3334 email "&gt;</a>\n")))
3335 (insert "</p>\n"))
3336 (when (and date org-export-time-stamp-file)
3337 (insert "<p class=\"date\"> "
3338 (nth 2 lang-words) ": "
3339 date "</p>\n"))
3340 (when org-export-creator-info
3341 (insert (format "<p>HTML generated by org-mode %s in emacs %s<\p>\n"
3342 org-version emacs-major-version)))
3343 (insert "</div>"))
3345 (if org-export-html-with-timestamp
3346 (insert org-export-html-html-helper-timestamp))
3347 (insert (or (plist-get opt-plist :postamble) ""))
3348 (insert "</body>\n</html>\n"))
3350 (normal-mode)
3351 (if (eq major-mode default-major-mode) (html-mode))
3353 ;; insert the table of contents
3354 (goto-char (point-min))
3355 (when thetoc
3356 (if (or (re-search-forward
3357 "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t)
3358 (re-search-forward
3359 "\\[TABLE-OF-CONTENTS\\]" nil t))
3360 (progn
3361 (goto-char (match-beginning 0))
3362 (replace-match ""))
3363 (goto-char first-heading-pos)
3364 (when (looking-at "\\s-*</p>")
3365 (goto-char (match-end 0))
3366 (insert "\n")))
3367 (insert "<div id=\"table-of-contents\">\n")
3368 (mapc 'insert thetoc)
3369 (insert "</div>\n"))
3370 ;; remove empty paragraphs and lists
3371 (goto-char (point-min))
3372 (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t)
3373 (replace-match ""))
3374 (goto-char (point-min))
3375 (while (re-search-forward "<li>[ \r\n\t]*</li>\n?" nil t)
3376 (replace-match ""))
3377 (goto-char (point-min))
3378 (while (re-search-forward "</ul>\\s-*<ul>\n?" nil t)
3379 (replace-match ""))
3380 ;; Convert whitespace place holders
3381 (goto-char (point-min))
3382 (let (beg end n)
3383 (while (setq beg (next-single-property-change (point) 'org-whitespace))
3384 (setq n (get-text-property beg 'org-whitespace)
3385 end (next-single-property-change beg 'org-whitespace))
3386 (goto-char beg)
3387 (delete-region beg end)
3388 (insert (format "<span style=\"visibility:hidden;\">%s</span>"
3389 (make-string n ?x)))))
3390 (or to-buffer (save-buffer))
3391 (goto-char (point-min))
3392 (message "Exporting... done")
3393 (if (eq to-buffer 'string)
3394 (prog1 (buffer-substring (point-min) (point-max))
3395 (kill-buffer (current-buffer)))
3396 (current-buffer)))))
3399 (defvar org-table-colgroup-info nil)
3400 (defun org-format-table-ascii (lines)
3401 "Format a table for ascii export."
3402 (if (stringp lines)
3403 (setq lines (org-split-string lines "\n")))
3404 (if (not (string-match "^[ \t]*|" (car lines)))
3405 ;; Table made by table.el - test for spanning
3406 lines
3408 ;; A normal org table
3409 ;; Get rid of hlines at beginning and end
3410 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
3411 (setq lines (nreverse lines))
3412 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
3413 (setq lines (nreverse lines))
3414 (when org-export-table-remove-special-lines
3415 ;; Check if the table has a marking column. If yes remove the
3416 ;; column and the special lines
3417 (setq lines (org-table-clean-before-export lines)))
3418 ;; Get rid of the vertical lines except for grouping
3419 (let ((vl (org-colgroup-info-to-vline-list org-table-colgroup-info))
3420 rtn line vl1 start)
3421 (while (setq line (pop lines))
3422 (if (string-match org-table-hline-regexp line)
3423 (and (string-match "|\\(.*\\)|" line)
3424 (setq line (replace-match " \\1" t nil line)))
3425 (setq start 0 vl1 vl)
3426 (while (string-match "|" line start)
3427 (setq start (match-end 0))
3428 (or (pop vl1) (setq line (replace-match " " t t line)))))
3429 (push line rtn))
3430 (nreverse rtn))))
3432 (defun org-colgroup-info-to-vline-list (info)
3433 (let (vl new last)
3434 (while info
3435 (setq last new new (pop info))
3436 (if (or (memq last '(:end :startend))
3437 (memq new '(:start :startend)))
3438 (push t vl)
3439 (push nil vl)))
3440 (setq vl (nreverse vl))
3441 (and vl (setcar vl nil))
3442 vl))
3444 (defvar org-table-number-regexp) ; defined in org-table.el
3445 (defun org-format-table-html (lines olines)
3446 "Find out which HTML converter to use and return the HTML code."
3447 (if (stringp lines)
3448 (setq lines (org-split-string lines "\n")))
3449 (if (string-match "^[ \t]*|" (car lines))
3450 ;; A normal org table
3451 (org-format-org-table-html lines)
3452 ;; Table made by table.el - test for spanning
3453 (let* ((hlines (delq nil (mapcar
3454 (lambda (x)
3455 (if (string-match "^[ \t]*\\+-" x) x
3456 nil))
3457 lines)))
3458 (first (car hlines))
3459 (ll (and (string-match "\\S-+" first)
3460 (match-string 0 first)))
3461 (re (concat "^[ \t]*" (regexp-quote ll)))
3462 (spanning (delq nil (mapcar (lambda (x) (not (string-match re x)))
3463 hlines))))
3464 (if (and (not spanning)
3465 (not org-export-prefer-native-exporter-for-tables))
3466 ;; We can use my own converter with HTML conversions
3467 (org-format-table-table-html lines)
3468 ;; Need to use the code generator in table.el, with the original text.
3469 (org-format-table-table-html-using-table-generate-source olines)))))
3471 (defvar org-table-number-fraction) ; defined in org-table.el
3472 (defun org-format-org-table-html (lines &optional splice)
3473 "Format a table into HTML."
3474 (require 'org-table)
3475 ;; Get rid of hlines at beginning and end
3476 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
3477 (setq lines (nreverse lines))
3478 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
3479 (setq lines (nreverse lines))
3480 (when org-export-table-remove-special-lines
3481 ;; Check if the table has a marking column. If yes remove the
3482 ;; column and the special lines
3483 (setq lines (org-table-clean-before-export lines)))
3485 (let ((head (and org-export-highlight-first-table-line
3486 (delq nil (mapcar
3487 (lambda (x) (string-match "^[ \t]*|-" x))
3488 (cdr lines)))))
3489 (nlines 0) fnum i
3490 tbopen line fields html gr colgropen)
3491 (if splice (setq head nil))
3492 (unless splice (push (if head "<thead>" "<tbody>") html))
3493 (setq tbopen t)
3494 (while (setq line (pop lines))
3495 (catch 'next-line
3496 (if (string-match "^[ \t]*|-" line)
3497 (progn
3498 (unless splice
3499 (push (if head "</thead>" "</tbody>") html)
3500 (if lines (push "<tbody>" html) (setq tbopen nil)))
3501 (setq head nil) ;; head ends here, first time around
3502 ;; ignore this line
3503 (throw 'next-line t)))
3504 ;; Break the line into fields
3505 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
3506 (unless fnum (setq fnum (make-vector (length fields) 0)))
3507 (setq nlines (1+ nlines) i -1)
3508 (push (concat "<tr>"
3509 (mapconcat
3510 (lambda (x)
3511 (setq i (1+ i))
3512 (if (and (< i nlines)
3513 (string-match org-table-number-regexp x))
3514 (incf (aref fnum i)))
3515 (if head
3516 (concat (car org-export-table-header-tags) x
3517 (cdr org-export-table-header-tags))
3518 (concat (car org-export-table-data-tags) x
3519 (cdr org-export-table-data-tags))))
3520 fields "")
3521 "</tr>")
3522 html)))
3523 (unless splice (if tbopen (push "</tbody>" html)))
3524 (unless splice (push "</table>\n" html))
3525 (setq html (nreverse html))
3526 (unless splice
3527 ;; Put in col tags with the alignment (unfortuntely often ignored...)
3528 (push (mapconcat
3529 (lambda (x)
3530 (setq gr (pop org-table-colgroup-info))
3531 (format "%s<col align=\"%s\"></col>%s"
3532 (if (memq gr '(:start :startend))
3533 (prog1
3534 (if colgropen "</colgroup>\n<colgroup>" "<colgroup>")
3535 (setq colgropen t))
3537 (if (> (/ (float x) nlines) org-table-number-fraction)
3538 "right" "left")
3539 (if (memq gr '(:end :startend))
3540 (progn (setq colgropen nil) "</colgroup>")
3541 "")))
3542 fnum "")
3543 html)
3544 (if colgropen (setq html (cons (car html) (cons "</colgroup>" (cdr html)))))
3545 (push html-table-tag html))
3546 (concat (mapconcat 'identity html "\n") "\n")))
3548 (defun org-table-clean-before-export (lines)
3549 "Check if the table has a marking column.
3550 If yes remove the column and the special lines."
3551 (setq org-table-colgroup-info nil)
3552 (if (memq nil
3553 (mapcar
3554 (lambda (x) (or (string-match "^[ \t]*|-" x)
3555 (string-match "^[ \t]*| *\\([#!$*_^ /]\\) *|" x)))
3556 lines))
3557 (progn
3558 (setq org-table-clean-did-remove-column nil)
3559 (delq nil
3560 (mapcar
3561 (lambda (x)
3562 (cond
3563 ((string-match "^[ \t]*| */ *|" x)
3564 (setq org-table-colgroup-info
3565 (mapcar (lambda (x)
3566 (cond ((member x '("<" "&lt;")) :start)
3567 ((member x '(">" "&gt;")) :end)
3568 ((member x '("<>" "&lt;&gt;")) :startend)
3569 (t nil)))
3570 (org-split-string x "[ \t]*|[ \t]*")))
3571 nil)
3572 (t x)))
3573 lines)))
3574 (setq org-table-clean-did-remove-column t)
3575 (delq nil
3576 (mapcar
3577 (lambda (x)
3578 (cond
3579 ((string-match "^[ \t]*| */ *|" x)
3580 (setq org-table-colgroup-info
3581 (mapcar (lambda (x)
3582 (cond ((member x '("<" "&lt;")) :start)
3583 ((member x '(">" "&gt;")) :end)
3584 ((member x '("<>" "&lt;&gt;")) :startend)
3585 (t nil)))
3586 (cdr (org-split-string x "[ \t]*|[ \t]*"))))
3587 nil)
3588 ((string-match "^[ \t]*| *[!_^/] *|" x)
3589 nil) ; ignore this line
3590 ((or (string-match "^\\([ \t]*\\)|-+\\+" x)
3591 (string-match "^\\([ \t]*\\)|[^|]*|" x))
3592 ;; remove the first column
3593 (replace-match "\\1|" t nil x))))
3594 lines))))
3596 (defun org-format-table-table-html (lines)
3597 "Format a table generated by table.el into HTML.
3598 This conversion does *not* use `table-generate-source' from table.el.
3599 This has the advantage that Org-mode's HTML conversions can be used.
3600 But it has the disadvantage, that no cell- or row-spanning is allowed."
3601 (let (line field-buffer
3602 (head org-export-highlight-first-table-line)
3603 fields html empty)
3604 (setq html (concat html-table-tag "\n"))
3605 (while (setq line (pop lines))
3606 (setq empty "&nbsp;")
3607 (catch 'next-line
3608 (if (string-match "^[ \t]*\\+-" line)
3609 (progn
3610 (if field-buffer
3611 (progn
3612 (setq
3613 html
3614 (concat
3615 html
3616 "<tr>"
3617 (mapconcat
3618 (lambda (x)
3619 (if (equal x "") (setq x empty))
3620 (if head
3621 (concat (car org-export-table-header-tags) x
3622 (cdr org-export-table-header-tags))
3623 (concat (car org-export-table-data-tags) x
3624 (cdr org-export-table-data-tags))))
3625 field-buffer "\n")
3626 "</tr>\n"))
3627 (setq head nil)
3628 (setq field-buffer nil)))
3629 ;; Ignore this line
3630 (throw 'next-line t)))
3631 ;; Break the line into fields and store the fields
3632 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
3633 (if field-buffer
3634 (setq field-buffer (mapcar
3635 (lambda (x)
3636 (concat x "<br/>" (pop fields)))
3637 field-buffer))
3638 (setq field-buffer fields))))
3639 (setq html (concat html "</table>\n"))
3640 html))
3642 (defun org-format-table-table-html-using-table-generate-source (lines)
3643 "Format a table into html, using `table-generate-source' from table.el.
3644 This has the advantage that cell- or row-spanning is allowed.
3645 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
3646 (require 'table)
3647 (with-current-buffer (get-buffer-create " org-tmp1 ")
3648 (erase-buffer)
3649 (insert (mapconcat 'identity lines "\n"))
3650 (goto-char (point-min))
3651 (if (not (re-search-forward "|[^+]" nil t))
3652 (error "Error processing table"))
3653 (table-recognize-table)
3654 (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
3655 (table-generate-source 'html " org-tmp2 ")
3656 (set-buffer " org-tmp2 ")
3657 (buffer-substring (point-min) (point-max))))
3659 (defun org-export-splice-style (style extra)
3660 "Splice EXTRA into STYLE, just before \"</style>\"."
3661 (if (and (stringp extra)
3662 (string-match "\\S-" extra)
3663 (string-match "</style>" style))
3664 (concat (substring style 0 (match-beginning 0))
3665 "\n" extra "\n"
3666 (substring style (match-beginning 0)))
3667 style))
3669 (defun org-html-handle-time-stamps (s)
3670 "Format time stamps in string S, or remove them."
3671 (catch 'exit
3672 (let (r b)
3673 (while (string-match org-maybe-keyword-time-regexp s)
3674 (if (and (match-end 1) (equal (match-string 1 s) org-clock-string))
3675 ;; never export CLOCK
3676 (throw 'exit ""))
3677 (or b (setq b (substring s 0 (match-beginning 0))))
3678 (if (not org-export-with-timestamps)
3679 (setq r (concat r (substring s 0 (match-beginning 0)))
3680 s (substring s (match-end 0)))
3681 (setq r (concat
3682 r (substring s 0 (match-beginning 0))
3683 (if (match-end 1)
3684 (format "@<span class=\"timestamp-kwd\">%s @</span>"
3685 (match-string 1 s)))
3686 (format " @<span class=\"timestamp\">%s@</span>"
3687 (substring
3688 (org-translate-time (match-string 3 s)) 1 -1)))
3689 s (substring s (match-end 0)))))
3690 ;; Line break if line started and ended with time stamp stuff
3691 (if (not r)
3693 (setq r (concat r s))
3694 (unless (string-match "\\S-" (concat b s))
3695 (setq r (concat r "@<br/>")))
3696 r))))
3698 (defun org-export-htmlize-region-for-paste (beg end)
3699 "Convert the region to HTML, using htmlize.el.
3700 This is much like `htmlize-region-for-paste', only that it uses
3701 the settings define in the org-... variables."
3702 (let* ((htmlize-output-type org-export-htmlize-output-type)
3703 (htmlize-css-name-prefix org-export-htmlize-css-font-prefix)
3704 (htmlbuf (htmlize-region beg end)))
3705 (unwind-protect
3706 (with-current-buffer htmlbuf
3707 (buffer-substring (plist-get htmlize-buffer-places 'content-start)
3708 (plist-get htmlize-buffer-places 'content-end)))
3709 (kill-buffer htmlbuf))))
3711 ;;;###autoload
3712 (defun org-export-htmlize-generate-css ()
3713 "Create the CSS for all font definitions in the current Emacs session.
3714 Use this to create face definitions in your CSS style file that can then
3715 be used by code snippets transformed by htmlize.
3716 This command just produces a buffer that contains class definitions for all
3717 faces used in the current Emacs session. You can copy and paste the ones you
3718 need into your CSS file.
3720 If you then set `org-export-htmlize-output-type' to `css', calls to
3721 the function `org-export-htmlize-region-for-paste' will produce code
3722 that uses these same face definitions."
3723 (interactive)
3724 (require 'htmlize)
3725 (and (get-buffer "*html*") (kill-buffer "*html*"))
3726 (with-temp-buffer
3727 (let ((fl (face-list))
3728 (htmlize-css-name-prefix "org-")
3729 (htmlize-output-type 'css)
3730 f i)
3731 (while (setq f (pop fl)
3732 i (and f (face-attribute f :inherit)))
3733 (when (and (symbolp f) (or (not i) (not (listp i))))
3734 (insert (org-add-props (copy-sequence "1") nil 'face f))))
3735 (htmlize-region (point-min) (point-max))))
3736 (switch-to-buffer "*html*")
3737 (goto-char (point-min))
3738 (if (re-search-forward "<style" nil t)
3739 (delete-region (point-min) (match-beginning 0)))
3740 (if (re-search-forward "</style>" nil t)
3741 (delete-region (1+ (match-end 0)) (point-max)))
3742 (beginning-of-line 1)
3743 (if (looking-at " +") (replace-match ""))
3744 (goto-char (point-min)))
3746 (defun org-html-protect (s)
3747 ;; convert & to &amp;, < to &lt; and > to &gt;
3748 (let ((start 0))
3749 (while (string-match "&" s start)
3750 (setq s (replace-match "&amp;" t t s)
3751 start (1+ (match-beginning 0))))
3752 (while (string-match "<" s)
3753 (setq s (replace-match "&lt;" t t s)))
3754 (while (string-match ">" s)
3755 (setq s (replace-match "&gt;" t t s))))
3758 (defun org-export-cleanup-toc-line (s)
3759 "Remove tags and time staps from lines going into the toc."
3760 (when (memq org-export-with-tags '(not-in-toc nil))
3761 (if (string-match (org-re " +:[[:alnum:]_@:]+: *$") s)
3762 (setq s (replace-match "" t t s))))
3763 (when org-export-remove-timestamps-from-toc
3764 (while (string-match org-maybe-keyword-time-regexp s)
3765 (setq s (replace-match "" t t s))))
3766 (while (string-match org-bracket-link-regexp s)
3767 (setq s (replace-match (match-string (if (match-end 3) 3 1) s)
3768 t t s)))
3771 (defun org-html-expand (string)
3772 "Prepare STRING for HTML export. Applies all active conversions.
3773 If there are links in the string, don't modify these."
3774 (let* ((re (concat org-bracket-link-regexp "\\|"
3775 (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$")))
3776 m s l res)
3777 (while (setq m (string-match re string))
3778 (setq s (substring string 0 m)
3779 l (match-string 0 string)
3780 string (substring string (match-end 0)))
3781 (push (org-html-do-expand s) res)
3782 (push l res))
3783 (push (org-html-do-expand string) res)
3784 (apply 'concat (nreverse res))))
3786 (defun org-html-do-expand (s)
3787 "Apply all active conversions to translate special ASCII to HTML."
3788 (setq s (org-html-protect s))
3789 (if org-export-html-expand
3790 (let ((start 0))
3791 (while (string-match "@&lt;\\([^&]*\\)&gt;" s)
3792 (setq s (replace-match "<\\1>" t nil s)))))
3793 (if org-export-with-emphasize
3794 (setq s (org-export-html-convert-emphasize s)))
3795 (if org-export-with-special-strings
3796 (setq s (org-export-html-convert-special-strings s)))
3797 (if org-export-with-sub-superscripts
3798 (setq s (org-export-html-convert-sub-super s)))
3799 (if org-export-with-TeX-macros
3800 (let ((start 0) wd ass)
3801 (while (setq start (string-match "\\\\\\([a-zA-Z]+\\)" s start))
3802 (if (get-text-property (match-beginning 0) 'org-protected s)
3803 (setq start (match-end 0))
3804 (setq wd (match-string 1 s))
3805 (if (setq ass (assoc wd org-html-entities))
3806 (setq s (replace-match (or (cdr ass)
3807 (concat "&" (car ass) ";"))
3808 t t s))
3809 (setq start (+ start (length wd))))))))
3812 (defun org-create-multibrace-regexp (left right n)
3813 "Create a regular expression which will match a balanced sexp.
3814 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
3815 as single character strings.
3816 The regexp returned will match the entire expression including the
3817 delimiters. It will also define a single group which contains the
3818 match except for the outermost delimiters. The maximum depth of
3819 stacked delimiters is N. Escaping delimiters is not possible."
3820 (let* ((nothing (concat "[^" "\\" left "\\" right "]*?"))
3821 (or "\\|")
3822 (re nothing)
3823 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
3824 (while (> n 1)
3825 (setq n (1- n)
3826 re (concat re or next)
3827 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
3828 (concat left "\\(" re "\\)" right)))
3830 (defvar org-match-substring-regexp
3831 (concat
3832 "\\([^\\]\\)\\([_^]\\)\\("
3833 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
3834 "\\|"
3835 "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
3836 "\\|"
3837 "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
3838 "The regular expression matching a sub- or superscript.")
3840 (defvar org-match-substring-with-braces-regexp
3841 (concat
3842 "\\([^\\]\\)\\([_^]\\)\\("
3843 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
3844 "\\)")
3845 "The regular expression matching a sub- or superscript, forcing braces.")
3847 (defconst org-export-html-special-string-regexps
3848 '(("\\\\-" . "&shy;")
3849 ("---\\([^-]\\)" . "&mdash;\\1")
3850 ("--\\([^-]\\)" . "&ndash;\\1")
3851 ("\\.\\.\\." . "&hellip;"))
3852 "Regular expressions for special string conversion.")
3854 (defun org-export-html-convert-special-strings (string)
3855 "Convert special characters in STRING to HTML."
3856 (let ((all org-export-html-special-string-regexps)
3857 e a re rpl start)
3858 (while (setq a (pop all))
3859 (setq re (car a) rpl (cdr a) start 0)
3860 (while (string-match re string start)
3861 (if (get-text-property (match-beginning 0) 'org-protected string)
3862 (setq start (match-end 0))
3863 (setq string (replace-match rpl t nil string)))))
3864 string))
3866 (defun org-export-html-convert-sub-super (string)
3867 "Convert sub- and superscripts in STRING to HTML."
3868 (let (key c (s 0) (requireb (eq org-export-with-sub-superscripts '{})))
3869 (while (string-match org-match-substring-regexp string s)
3870 (cond
3871 ((and requireb (match-end 8)) (setq s (match-end 2)))
3872 ((get-text-property (match-beginning 2) 'org-protected string)
3873 (setq s (match-end 2)))
3875 (setq s (match-end 1)
3876 key (if (string= (match-string 2 string) "_") "sub" "sup")
3877 c (or (match-string 8 string)
3878 (match-string 6 string)
3879 (match-string 5 string))
3880 string (replace-match
3881 (concat (match-string 1 string)
3882 "<" key ">" c "</" key ">")
3883 t t string)))))
3884 (while (string-match "\\\\\\([_^]\\)" string)
3885 (setq string (replace-match (match-string 1 string) t t string)))
3886 string))
3888 (defun org-export-html-convert-emphasize (string)
3889 "Apply emphasis."
3890 (let ((s 0) rpl)
3891 (while (string-match org-emph-re string s)
3892 (if (not (equal
3893 (substring string (match-beginning 3) (1+ (match-beginning 3)))
3894 (substring string (match-beginning 4) (1+ (match-beginning 4)))))
3895 (setq s (match-beginning 0)
3897 (concat
3898 (match-string 1 string)
3899 (nth 2 (assoc (match-string 3 string) org-emphasis-alist))
3900 (match-string 4 string)
3901 (nth 3 (assoc (match-string 3 string)
3902 org-emphasis-alist))
3903 (match-string 5 string))
3904 string (replace-match rpl t t string)
3905 s (+ s (- (length rpl) 2)))
3906 (setq s (1+ s))))
3907 string))
3909 (defvar org-par-open nil)
3910 (defun org-open-par ()
3911 "Insert <p>, but first close previous paragraph if any."
3912 (org-close-par-maybe)
3913 (insert "\n<p>")
3914 (setq org-par-open t))
3915 (defun org-close-par-maybe ()
3916 "Close paragraph if there is one open."
3917 (when org-par-open
3918 (insert "</p>")
3919 (setq org-par-open nil)))
3920 (defun org-close-li (&optional type)
3921 "Close <li> if necessary."
3922 (org-close-par-maybe)
3923 (insert (if (equal type "d") "</dd>\n" "</li>\n")))
3925 (defvar body-only) ; dynamically scoped into this.
3926 (defun org-html-level-start (level title umax with-toc head-count)
3927 "Insert a new level in HTML export.
3928 When TITLE is nil, just close all open levels."
3929 (org-close-par-maybe)
3930 (let ((target (and title (org-get-text-property-any 0 'target title)))
3931 (l org-level-max)
3932 snumber)
3933 (while (>= l level)
3934 (if (aref org-levels-open (1- l))
3935 (progn
3936 (org-html-level-close l umax)
3937 (aset org-levels-open (1- l) nil)))
3938 (setq l (1- l)))
3939 (when title
3940 ;; If title is nil, this means this function is called to close
3941 ;; all levels, so the rest is done only if title is given
3942 (when (string-match (org-re "\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title)
3943 (setq title (replace-match
3944 (if org-export-with-tags
3945 (save-match-data
3946 (concat
3947 "&nbsp;&nbsp;&nbsp;<span class=\"tag\">"
3948 (mapconcat 'identity (org-split-string
3949 (match-string 1 title) ":")
3950 "&nbsp;")
3951 "</span>"))
3953 t t title)))
3954 (if (> level umax)
3955 (progn
3956 (if (aref org-levels-open (1- level))
3957 (progn
3958 (org-close-li)
3959 (if target
3960 (insert (format "<li id=\"%s\">" target) title "<br/>\n")
3961 (insert "<li>" title "<br/>\n")))
3962 (aset org-levels-open (1- level) t)
3963 (org-close-par-maybe)
3964 (if target
3965 (insert (format "<ul>\n<li id=\"%s\">" target)
3966 title "<br/>\n")
3967 (insert "<ul>\n<li>" title "<br/>\n"))))
3968 (aset org-levels-open (1- level) t)
3969 (setq snumber (org-section-number level))
3970 (if (and org-export-with-section-numbers (not body-only))
3971 (setq title (concat snumber " " title)))
3972 (setq level (+ level org-export-html-toplevel-hlevel -1))
3973 (unless (= head-count 1) (insert "\n</div>\n"))
3974 (insert (format "\n<div id=\"outline-container-%s\" class=\"outline-%d\">\n<h%d id=\"sec-%s\">%s</h%d>\n<div id=\"text-%s\">\n"
3975 snumber level level snumber title level snumber))
3976 (org-open-par)))))
3978 (defun org-get-text-property-any (pos prop &optional object)
3979 (or (get-text-property pos prop object)
3980 (and (setq pos (next-single-property-change pos prop object))
3981 (get-text-property pos prop object))))
3983 (defun org-html-level-close (level max-outline-level)
3984 "Terminate one level in HTML export."
3985 (if (<= level max-outline-level)
3986 (insert "</div>\n")
3987 (org-close-li)
3988 (insert "</ul>\n")))
3990 ;;; iCalendar export
3992 ;;;###autoload
3993 (defun org-export-icalendar-this-file ()
3994 "Export current file as an iCalendar file.
3995 The iCalendar file will be located in the same directory as the Org-mode
3996 file, but with extension `.ics'."
3997 (interactive)
3998 (org-export-icalendar nil buffer-file-name))
4000 ;;;###autoload
4001 (defun org-export-icalendar-all-agenda-files ()
4002 "Export all files in `org-agenda-files' to iCalendar .ics files.
4003 Each iCalendar file will be located in the same directory as the Org-mode
4004 file, but with extension `.ics'."
4005 (interactive)
4006 (apply 'org-export-icalendar nil (org-agenda-files t)))
4008 ;;;###autoload
4009 (defun org-export-icalendar-combine-agenda-files ()
4010 "Export all files in `org-agenda-files' to a single combined iCalendar file.
4011 The file is stored under the name `org-combined-agenda-icalendar-file'."
4012 (interactive)
4013 (apply 'org-export-icalendar t (org-agenda-files t)))
4015 (defun org-export-icalendar (combine &rest files)
4016 "Create iCalendar files for all elements of FILES.
4017 If COMBINE is non-nil, combine all calendar entries into a single large
4018 file and store it under the name `org-combined-agenda-icalendar-file'."
4019 (save-excursion
4020 (org-prepare-agenda-buffers files)
4021 (let* ((dir (org-export-directory
4022 :ical (list :publishing-directory
4023 org-export-publishing-directory)))
4024 file ical-file ical-buffer category started org-agenda-new-buffers)
4025 (and (get-buffer "*ical-tmp*") (kill-buffer "*ical-tmp*"))
4026 (when combine
4027 (setq ical-file
4028 (if (file-name-absolute-p org-combined-agenda-icalendar-file)
4029 org-combined-agenda-icalendar-file
4030 (expand-file-name org-combined-agenda-icalendar-file dir))
4031 ical-buffer (org-get-agenda-file-buffer ical-file))
4032 (set-buffer ical-buffer) (erase-buffer))
4033 (while (setq file (pop files))
4034 (catch 'nextfile
4035 (org-check-agenda-file file)
4036 (set-buffer (org-get-agenda-file-buffer file))
4037 (unless combine
4038 (setq ical-file (concat (file-name-as-directory dir)
4039 (file-name-sans-extension
4040 (file-name-nondirectory buffer-file-name))
4041 ".ics"))
4042 (setq ical-buffer (org-get-agenda-file-buffer ical-file))
4043 (with-current-buffer ical-buffer (erase-buffer)))
4044 (setq category (or org-category
4045 (file-name-sans-extension
4046 (file-name-nondirectory buffer-file-name))))
4047 (if (symbolp category) (setq category (symbol-name category)))
4048 (let ((standard-output ical-buffer))
4049 (if combine
4050 (and (not started) (setq started t)
4051 (org-start-icalendar-file org-icalendar-combined-name))
4052 (org-start-icalendar-file category))
4053 (org-print-icalendar-entries combine)
4054 (when (or (and combine (not files)) (not combine))
4055 (org-finish-icalendar-file)
4056 (set-buffer ical-buffer)
4057 (run-hooks 'org-before-save-iCalendar-file-hook)
4058 (save-buffer)
4059 (run-hooks 'org-after-save-iCalendar-file-hook)
4060 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
4061 ))))
4062 (org-release-buffers org-agenda-new-buffers))))
4064 (defvar org-before-save-iCalendar-file-hook nil
4065 "Hook run before an iCalendar file has been saved.
4066 This can be used to modify the result of the export.")
4068 (defvar org-after-save-iCalendar-file-hook nil
4069 "Hook run after an iCalendar file has been saved.
4070 The iCalendar buffer is still current when this hook is run.
4071 A good way to use this is to tell a desktop calenndar application to re-read
4072 the iCalendar file.")
4074 (defvar org-agenda-default-appointment-duration) ; defined in org-agenda.el
4075 (defun org-print-icalendar-entries (&optional combine)
4076 "Print iCalendar entries for the current Org-mode file to `standard-output'.
4077 When COMBINE is non nil, add the category to each line."
4078 (require 'org-agenda)
4079 (let ((re1 (concat org-ts-regexp "\\|<%%([^>\n]+>"))
4080 (re2 (concat "--?-?\\(" org-ts-regexp "\\)"))
4081 (dts (org-ical-ts-to-string
4082 (format-time-string (cdr org-time-stamp-formats) (current-time))
4083 "DTSTART"))
4084 hd ts ts2 state status (inc t) pos b sexp rrule
4085 scheduledp deadlinep todo prefix due start
4086 tmp pri category entry location summary desc uid
4087 (sexp-buffer (get-buffer-create "*ical-tmp*")))
4088 (org-refresh-category-properties)
4089 (save-excursion
4090 (goto-char (point-min))
4091 (while (re-search-forward re1 nil t)
4092 (catch :skip
4093 (org-agenda-skip)
4094 (when (boundp 'org-icalendar-verify-function)
4095 (unless (funcall org-icalendar-verify-function)
4096 (outline-next-heading)
4097 (backward-char 1)
4098 (throw :skip nil)))
4099 (setq pos (match-beginning 0)
4100 ts (match-string 0)
4101 inc t
4102 hd (condition-case nil
4103 (org-icalendar-cleanup-string
4104 (org-get-heading))
4105 (error (throw :skip nil)))
4106 summary (org-icalendar-cleanup-string
4107 (org-entry-get nil "SUMMARY"))
4108 desc (org-icalendar-cleanup-string
4109 (or (org-entry-get nil "DESCRIPTION")
4110 (and org-icalendar-include-body (org-get-entry)))
4111 t org-icalendar-include-body)
4112 location (org-icalendar-cleanup-string
4113 (org-entry-get nil "LOCATION"))
4114 uid (if org-icalendar-store-UID
4115 (org-id-get-create)
4116 (or (org-id-get) (org-id-new)))
4117 category (org-get-category)
4118 deadlinep nil scheduledp nil)
4119 (if (looking-at re2)
4120 (progn
4121 (goto-char (match-end 0))
4122 (setq ts2 (match-string 1)
4123 inc (not (string-match "[0-9]\\{1,2\\}:[0-9][0-9]" ts2))))
4124 (setq tmp (buffer-substring (max (point-min)
4125 (- pos org-ds-keyword-length))
4126 pos)
4127 ts2 (if (string-match "[0-9]\\{1,2\\}:[0-9][0-9]-\\([0-9]\\{1,2\\}:[0-9][0-9]\\)" ts)
4128 (progn
4129 (setq inc nil)
4130 (replace-match "\\1" t nil ts))
4132 deadlinep (string-match org-deadline-regexp tmp)
4133 scheduledp (string-match org-scheduled-regexp tmp)
4134 todo (org-get-todo-state)
4135 ;; donep (org-entry-is-done-p)
4137 (when (and
4138 deadlinep
4139 (if todo
4140 (not (memq 'event-if-todo org-icalendar-use-deadline))
4141 (not (memq 'event-if-not-todo org-icalendar-use-deadline))))
4142 (throw :skip t))
4143 (when (and
4144 scheduledp
4145 (if todo
4146 (not (memq 'event-if-todo org-icalendar-use-scheduled))
4147 (not (memq 'event-if-not-todo org-icalendar-use-scheduled))))
4148 (throw :skip t))
4149 (setq prefix (if deadlinep "DL-" (if scheduledp "SC-" "TS-")))
4150 (if (or (string-match org-tr-regexp hd)
4151 (string-match org-ts-regexp hd))
4152 (setq hd (replace-match "" t t hd)))
4153 (if (string-match "\\+\\([0-9]+\\)\\([dwmy]\\)>" ts)
4154 (setq rrule
4155 (concat "\nRRULE:FREQ="
4156 (cdr (assoc
4157 (match-string 2 ts)
4158 '(("d" . "DAILY")("w" . "WEEKLY")
4159 ("m" . "MONTHLY")("y" . "YEARLY"))))
4160 ";INTERVAL=" (match-string 1 ts)))
4161 (setq rrule ""))
4162 (setq summary (or summary hd))
4163 (if (string-match org-bracket-link-regexp summary)
4164 (setq summary
4165 (replace-match (if (match-end 3)
4166 (match-string 3 summary)
4167 (match-string 1 summary))
4168 t t summary)))
4169 (if deadlinep (setq summary (concat "DL: " summary)))
4170 (if scheduledp (setq summary (concat "S: " summary)))
4171 (if (string-match "\\`<%%" ts)
4172 (with-current-buffer sexp-buffer
4173 (insert (substring ts 1 -1) " " summary "\n"))
4174 (princ (format "BEGIN:VEVENT
4175 UID: %s
4177 %s%s
4178 SUMMARY:%s%s%s
4179 CATEGORIES:%s
4180 END:VEVENT\n"
4181 (concat prefix uid)
4182 (org-ical-ts-to-string ts "DTSTART")
4183 (org-ical-ts-to-string ts2 "DTEND" inc)
4184 rrule summary
4185 (if (and desc (string-match "\\S-" desc))
4186 (concat "\nDESCRIPTION: " desc) "")
4187 (if (and location (string-match "\\S-" location))
4188 (concat "\nLOCATION: " location) "")
4189 category)))))
4190 (when (and org-icalendar-include-sexps
4191 (condition-case nil (require 'icalendar) (error nil))
4192 (fboundp 'icalendar-export-region))
4193 ;; Get all the literal sexps
4194 (goto-char (point-min))
4195 (while (re-search-forward "^&?%%(" nil t)
4196 (catch :skip
4197 (org-agenda-skip)
4198 (setq b (match-beginning 0))
4199 (goto-char (1- (match-end 0)))
4200 (forward-sexp 1)
4201 (end-of-line 1)
4202 (setq sexp (buffer-substring b (point)))
4203 (with-current-buffer sexp-buffer
4204 (insert sexp "\n"))))
4205 (princ (org-diary-to-ical-string sexp-buffer))
4206 (kill-buffer sexp-buffer))
4208 (when org-icalendar-include-todo
4209 (setq prefix "TODO-")
4210 (goto-char (point-min))
4211 (while (re-search-forward org-todo-line-regexp nil t)
4212 (catch :skip
4213 (org-agenda-skip)
4214 (when (boundp 'org-icalendar-verify-function)
4215 (unless (funcall org-icalendar-verify-function)
4216 (outline-next-heading)
4217 (backward-char 1)
4218 (throw :skip nil)))
4219 (setq state (match-string 2))
4220 (setq status (if (member state org-done-keywords)
4221 "COMPLETED" "NEEDS-ACTION"))
4222 (when (and state
4223 (or (not (member state org-done-keywords))
4224 (eq org-icalendar-include-todo 'all))
4225 (not (member org-archive-tag (org-get-tags-at)))
4227 (setq hd (match-string 3)
4228 summary (org-icalendar-cleanup-string
4229 (org-entry-get nil "SUMMARY"))
4230 desc (org-icalendar-cleanup-string
4231 (or (org-entry-get nil "DESCRIPTION")
4232 (and org-icalendar-include-body (org-get-entry)))
4233 t org-icalendar-include-body)
4234 location (org-icalendar-cleanup-string
4235 (org-entry-get nil "LOCATION"))
4236 due (and (member 'todo-due org-icalendar-use-deadline)
4237 (org-entry-get nil "DEADLINE"))
4238 start (and (member 'todo-start org-icalendar-use-scheduled)
4239 (org-entry-get nil "SCHEDULED"))
4240 uid (if org-icalendar-store-UID
4241 (org-id-get-create)
4242 (or (org-id-get) (org-id-new))))
4243 (and due (setq due (org-ical-ts-to-string due "DUE")))
4244 (and start (setq start (org-ical-ts-to-string start "DTSTART")))
4246 (if (string-match org-bracket-link-regexp hd)
4247 (setq hd (replace-match (if (match-end 3) (match-string 3 hd)
4248 (match-string 1 hd))
4249 t t hd)))
4250 (if (string-match org-priority-regexp hd)
4251 (setq pri (string-to-char (match-string 2 hd))
4252 hd (concat (substring hd 0 (match-beginning 1))
4253 (substring hd (match-end 1))))
4254 (setq pri org-default-priority))
4255 (setq pri (floor (1+ (* 8. (/ (float (- org-lowest-priority pri))
4256 (- org-lowest-priority org-highest-priority))))))
4258 (princ (format "BEGIN:VTODO
4259 UID: %s
4261 SUMMARY:%s%s%s%s
4262 CATEGORIES:%s
4263 SEQUENCE:1
4264 PRIORITY:%d
4265 STATUS:%s
4266 END:VTODO\n"
4267 (concat prefix uid)
4268 (or start dts)
4269 (or summary hd)
4270 (if (and location (string-match "\\S-" location))
4271 (concat "\nLOCATION: " location) "")
4272 (if (and desc (string-match "\\S-" desc))
4273 (concat "\nDESCRIPTION: " desc) "")
4274 (if due (concat "\n" due) "")
4275 category
4276 pri status)))))))))
4278 (defun org-icalendar-cleanup-string (s &optional is-body maxlength)
4279 "Take out stuff and quote what needs to be quoted.
4280 When IS-BODY is non-nil, assume that this is the body of an item, clean up
4281 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
4282 characters."
4283 (if (not s)
4285 (when is-body
4286 (let ((re (concat "\\(" org-drawer-regexp "\\)[^\000]*?:END:.*\n?"))
4287 (re2 (concat "^[ \t]*" org-keyword-time-regexp ".*\n?")))
4288 (while (string-match re s) (setq s (replace-match "" t t s)))
4289 (while (string-match re2 s) (setq s (replace-match "" t t s)))))
4290 (let ((start 0))
4291 (while (string-match "\\([,;]\\)" s start)
4292 (setq start (+ (match-beginning 0) 2)
4293 s (replace-match "\\\\\\1" nil nil s))))
4294 (when is-body
4295 (while (string-match "[ \t]*\n[ \t]*" s)
4296 (setq s (replace-match "\\n" t t s))))
4297 (setq s (org-trim s))
4298 (if is-body
4299 (if maxlength
4300 (if (and (numberp maxlength)
4301 (> (length s) maxlength))
4302 (setq s (substring s 0 maxlength)))))
4305 (defun org-get-entry ()
4306 "Clean-up description string."
4307 (save-excursion
4308 (org-back-to-heading t)
4309 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
4311 (defun org-start-icalendar-file (name)
4312 "Start an iCalendar file by inserting the header."
4313 (let ((user user-full-name)
4314 (name (or name "unknown"))
4315 (timezone (cadr (current-time-zone))))
4316 (princ
4317 (format "BEGIN:VCALENDAR
4318 VERSION:2.0
4319 X-WR-CALNAME:%s
4320 PRODID:-//%s//Emacs with Org-mode//EN
4321 X-WR-TIMEZONE:%s
4322 CALSCALE:GREGORIAN\n" name user timezone))))
4324 (defun org-finish-icalendar-file ()
4325 "Finish an iCalendar file by inserting the END statement."
4326 (princ "END:VCALENDAR\n"))
4328 (defun org-ical-ts-to-string (s keyword &optional inc)
4329 "Take a time string S and convert it to iCalendar format.
4330 KEYWORD is added in front, to make a complete line like DTSTART....
4331 When INC is non-nil, increase the hour by two (if time string contains
4332 a time), or the day by one (if it does not contain a time)."
4333 (let ((t1 (org-parse-time-string s 'nodefault))
4334 t2 fmt have-time time)
4335 (if (and (car t1) (nth 1 t1) (nth 2 t1))
4336 (setq t2 t1 have-time t)
4337 (setq t2 (org-parse-time-string s)))
4338 (let ((s (car t2)) (mi (nth 1 t2)) (h (nth 2 t2))
4339 (d (nth 3 t2)) (m (nth 4 t2)) (y (nth 5 t2)))
4340 (when inc
4341 (if have-time
4342 (if org-agenda-default-appointment-duration
4343 (setq mi (+ org-agenda-default-appointment-duration mi))
4344 (setq h (+ 2 h)))
4345 (setq d (1+ d))))
4346 (setq time (encode-time s mi h d m y)))
4347 (setq fmt (if have-time ":%Y%m%dT%H%M%S" ";VALUE=DATE:%Y%m%d"))
4348 (concat keyword (format-time-string fmt time))))
4350 ;;; XOXO export
4352 (defun org-export-as-xoxo-insert-into (buffer &rest output)
4353 (with-current-buffer buffer
4354 (apply 'insert output)))
4355 (put 'org-export-as-xoxo-insert-into 'lisp-indent-function 1)
4357 ;;;###autoload
4358 (defun org-export-as-xoxo (&optional buffer)
4359 "Export the org buffer as XOXO.
4360 The XOXO buffer is named *xoxo-<source buffer name>*"
4361 (interactive (list (current-buffer)))
4362 ;; A quickie abstraction
4364 ;; Output everything as XOXO
4365 (with-current-buffer (get-buffer buffer)
4366 (let* ((pos (point))
4367 (opt-plist (org-combine-plists (org-default-export-plist)
4368 (org-infile-export-plist)))
4369 (filename (concat (file-name-as-directory
4370 (org-export-directory :xoxo opt-plist))
4371 (file-name-sans-extension
4372 (file-name-nondirectory buffer-file-name))
4373 ".html"))
4374 (out (find-file-noselect filename))
4375 (last-level 1)
4376 (hanging-li nil))
4377 (goto-char (point-min)) ;; CD: beginning-of-buffer is not allowed.
4378 ;; Check the output buffer is empty.
4379 (with-current-buffer out (erase-buffer))
4380 ;; Kick off the output
4381 (org-export-as-xoxo-insert-into out "<ol class='xoxo'>\n")
4382 (while (re-search-forward "^\\(\\*+\\)[ \t]+\\(.+\\)" (point-max) 't)
4383 (let* ((hd (match-string-no-properties 1))
4384 (level (length hd))
4385 (text (concat
4386 (match-string-no-properties 2)
4387 (save-excursion
4388 (goto-char (match-end 0))
4389 (let ((str ""))
4390 (catch 'loop
4391 (while 't
4392 (forward-line)
4393 (if (looking-at "^[ \t]\\(.*\\)")
4394 (setq str (concat str (match-string-no-properties 1)))
4395 (throw 'loop str)))))))))
4397 ;; Handle level rendering
4398 (cond
4399 ((> level last-level)
4400 (org-export-as-xoxo-insert-into out "\n<ol>\n"))
4402 ((< level last-level)
4403 (dotimes (- (- last-level level) 1)
4404 (if hanging-li
4405 (org-export-as-xoxo-insert-into out "</li>\n"))
4406 (org-export-as-xoxo-insert-into out "</ol>\n"))
4407 (when hanging-li
4408 (org-export-as-xoxo-insert-into out "</li>\n")
4409 (setq hanging-li nil)))
4411 ((equal level last-level)
4412 (if hanging-li
4413 (org-export-as-xoxo-insert-into out "</li>\n")))
4416 (setq last-level level)
4418 ;; And output the new li
4419 (setq hanging-li 't)
4420 (if (equal ?+ (elt text 0))
4421 (org-export-as-xoxo-insert-into out "<li class='" (substring text 1) "'>")
4422 (org-export-as-xoxo-insert-into out "<li>" text))))
4424 ;; Finally finish off the ol
4425 (dotimes (- last-level 1)
4426 (if hanging-li
4427 (org-export-as-xoxo-insert-into out "</li>\n"))
4428 (org-export-as-xoxo-insert-into out "</ol>\n"))
4430 (goto-char pos)
4431 ;; Finish the buffer off and clean it up.
4432 (switch-to-buffer-other-window out)
4433 (indent-region (point-min) (point-max) nil)
4434 (save-buffer)
4435 (goto-char (point-min))
4438 (provide 'org-exp)
4440 ;; arch-tag: 65985fe9-095c-49c7-a7b6-cb4ee15c0a95
4442 ;;; org-exp.el ends here