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
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
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."
44 (defgroup org-export-general nil
45 "General options for exporting Org-mode files."
46 :tag
"Org Export General"
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
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:
72 -----+----------+--------
78 This option can also be set with the +OPTIONS line, e.g. \"-:nil\"."
79 :group
'org-export-translation
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
101 (string :tag
"HTML language tag")
102 (string :tag
"Author")
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
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
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
124 This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
125 :group
'org-export-general
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
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
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
147 :group
'org-export-general
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\"
171 :group
'org-export-general
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
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
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
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
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
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
227 (defcustom org-export-with-timestamps t
228 "If nil, do not export time stamps and associated keywords."
229 :group
'org-export-general
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
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
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
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"
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
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
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
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:
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
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 α and \\AA to Å.
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
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
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
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
360 : ;; Some Lisp examples
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
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
376 (defgroup org-export-tables nil
377 "Options for exporting tables in Org-mode."
378 :tag
"Org Export Tables"
381 (defcustom org-export-with-tables t
382 "If non-nil, lines starting with \"|\" define a table.
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
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
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
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
421 :group
'org-export-tables
424 (defgroup org-export-ascii nil
425 "Options specific for ASCII export of Org-mode files."
426 :tag
"Org Export ASCII"
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
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"
450 (defgroup org-export-html nil
451 "Options specific for HTML export of Org-mode files."
452 :tag
"Org Export HTML"
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
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 }
483 .timestamp { color: grey }
484 .timestamp-kwd { color: CadetBlue }
485 p.verse { margin-left: 3% }
487 border: 1pt solid #AEBDCC;
488 background-color: #F3F5F7;
490 font-family: courier, monospace;
493 table { border-collapse: collapse; }
494 td, th { vertical-align: top; }
495 dt { font-weight: bold; }
497 "The default style specification for exported HTML files.
498 Please use the variables `org-export-html-style' and
499 `org-export-html-style-extra' to add to this style.")
501 (defcustom org-export-html-style
""
502 "Org-wide style definitions for exported HTML files.
504 This variable needs to contain the full HTML structure to provide a style,
505 including the surrounding HTML tags. If you set the value of this variable,
506 you should consider to include definitions for the following classes:
507 title, todo, done, timestamp, timestamp-kwd, tag, target.
509 For example, a valid value would be:
511 <style type=\"text/css\">
512 p { font-weight: normal; color: gray; }
514 .title { text-align: center; }
515 .todo, .timestamp-kwd { color: red; }
516 .done { color: green; }
519 If you'd like to refer to en external style file, use something like
521 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
523 As the value of this option simply gets inserted into the HTML <head> header,
524 you can \"misuse\" it to add arbitrary text to the header.
525 See also the variable `org-export-html-style-extra'."
526 :group
'org-export-html
529 (defcustom org-export-html-style-extra
""
530 "Additional style information for HTML export.
531 The value of this variable is inserted into the HTML buffer right after
532 the value of `org-export-html-style'. Use this variable for per-file
533 settings of style information, and do not forget to surround the style
534 settings with <style>...</style> tags."
535 :group
'org-export-html
538 (defcustom org-export-html-title-format
"<h1 class=\"title\">%s</h1>\n"
539 "Format for typesetting the document title in HTML export."
540 :group
'org-export-html
543 (defcustom org-export-html-toplevel-hlevel
2
544 "The <H> level for level 1 headings in HTML export."
545 :group
'org-export-html
548 (defcustom org-export-html-link-org-files-as-html t
549 "Non-nil means, make file links to `file.org' point to `file.html'.
550 When org-mode is exporting an org-mode file to HTML, links to
551 non-html files are directly put into a href tag in HTML.
552 However, links to other Org-mode files (recognized by the
553 extension `.org.) should become links to the corresponding html
554 file, assuming that the linked org-mode file will also be
556 When nil, the links still point to the plain `.org' file."
557 :group
'org-export-html
560 (defcustom org-export-html-inline-images
'maybe
561 "Non-nil means, inline images into exported HTML pages.
562 This is done using an <img> tag. When nil, an anchor with href is used to
563 link to the image. If this option is `maybe', then images in links with
564 an empty description will be inlined, while images with a description will
566 :group
'org-export-html
567 :type
'(choice (const :tag
"Never" nil
)
568 (const :tag
"Always" t
)
569 (const :tag
"When there is no description" maybe
)))
572 (defcustom org-export-html-expand t
573 "Non-nil means, for HTML export, treat @<...> as HTML tag.
574 When nil, these tags will be exported as plain text and therefore
575 not be interpreted by a browser.
577 This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
578 :group
'org-export-html
581 (defcustom org-export-html-table-tag
582 "<table border=\"2\" cellspacing=\"0\" cellpadding=\"6\" rules=\"groups\" frame=\"hsides\">"
583 "The HTML tag that is used to start a table.
584 This must be a <table> tag, but you may change the options like
585 borders and spacing."
586 :group
'org-export-html
589 (defcustom org-export-table-header-tags
'("<th>" .
"</th>")
590 "The opening tag for table header fields.
591 This is customizable so that alignment options can be specified."
592 :group
'org-export-tables
593 :type
'(cons (string :tag
"Opening tag") (string :tag
"Closing tag")))
595 (defcustom org-export-table-data-tags
'("<td>" .
"</td>")
596 "The opening tag for table data fields.
597 This is customizable so that alignment options can be specified."
598 :group
'org-export-tables
599 :type
'(cons (string :tag
"Opening tag") (string :tag
"Closing tag")))
601 (defcustom org-export-html-with-timestamp nil
602 "If non-nil, write `org-export-html-html-helper-timestamp'
603 into the exported HTML text. Otherwise, the buffer will just be saved
605 :group
'org-export-html
608 (defcustom org-export-html-html-helper-timestamp
609 "<br/><br/><hr><p><!-- hhmts start --> <!-- hhmts end --></p>\n"
610 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
611 :group
'org-export-html
614 (defgroup org-export-htmlize nil
615 "Options for processing examples with htmlize.el."
616 :tag
"Org Export Htmlize"
617 :group
'org-export-html
)
619 (defcustom org-export-htmlize-output-type
'inline-css
620 "Output type to be used by htmlize when formatting code snippets.
621 Normally this is `inline-css', but if you have defined to appropriate
622 classes in your css style file, setting this to `css' means that the
623 fontification will use the class names.
624 See also the function `org-export-htmlize-generate-css'."
625 :group
'org-export-htmlize
626 :type
'(choice (const css
) (const inline-css
)))
628 (defcustom org-export-htmlize-css-font-prefix
"org-"
629 "The prefix for CSS class names for htmlize font specifications."
630 :group
'org-export-htmlize
633 (defgroup org-export-icalendar nil
634 "Options specific for iCalendar export of Org-mode files."
635 :tag
"Org Export iCalendar"
638 (defcustom org-combined-agenda-icalendar-file
"~/org.ics"
639 "The file name for the iCalendar file covering all agenda files.
640 This file is created with the command \\[org-export-icalendar-all-agenda-files].
641 The file name should be absolute, the file will be overwritten without warning."
642 :group
'org-export-icalendar
645 (defcustom org-icalendar-combined-name
"OrgMode"
646 "Calendar name for the combined iCalendar representing all agenda files."
647 :group
'org-export-icalendar
650 (defcustom org-icalendar-use-deadline
'(event-if-not-todo todo-due
)
651 "Contexts where iCalendar export should use a deadline time stamp.
652 This is a list with several symbols in it. Valid symbol are:
654 event-if-todo Deadlines in TODO entries become calendar events.
655 event-if-not-todo Deadlines in non-TODO entries become calendar events.
656 todo-due Use deadlines in TODO entries as due-dates"
657 :group
'org-export-icalendar
658 :type
'(set :greedy t
659 (const :tag
"Deadlines in non-TODO entries become events"
661 (const :tag
"Deadline in TODO entries become events"
663 (const :tag
"Deadlines in TODO entries become due-dates"
666 (defcustom org-icalendar-use-scheduled
'(todo-start)
667 "Contexts where iCalendar export should use a scheduling time stamp.
668 This is a list with several symbols in it. Valid symbol are:
670 event-if-todo Scheduling time stamps in TODO entries become an event.
671 event-if-not-todo Scheduling time stamps in non-TODO entries become an event.
672 todo-start Scheduling time stamps in TODO entries become start date.
673 Some calendar applications show TODO entries only after
675 :group
'org-export-icalendar
676 :type
'(set :greedy t
678 "SCHEDULED timestamps in non-TODO entries become events"
680 (const :tag
"SCHEDULED timestamps in TODO entries become events"
682 (const :tag
"SCHEDULED in TODO entries become start date"
685 (defcustom org-icalendar-include-todo nil
686 "Non-nil means, export to iCalendar files should also cover TODO items."
687 :group
'org-export-icalendar
689 (const :tag
"None" nil
)
690 (const :tag
"Unfinished" t
)
691 (const :tag
"All" all
)))
693 (defcustom org-icalendar-include-sexps t
694 "Non-nil means, export to iCalendar files should also cover sexp entries.
695 These are entries like in the diary, but directly in an Org-mode file."
696 :group
'org-export-icalendar
699 (defcustom org-icalendar-include-body
100
700 "Amount of text below headline to be included in iCalendar export.
701 This is a number of characters that should maximally be included.
702 Properties, scheduling and clocking lines will always be removed.
703 The text will be inserted into the DESCRIPTION field."
704 :group
'org-export-icalendar
706 (const :tag
"Nothing" nil
)
707 (const :tag
"Everything" t
)
708 (integer :tag
"Max characters")))
710 (defcustom org-icalendar-store-UID nil
711 "Non-nil means, store any created UIDs in properties.
712 The iCalendar standard requires that all entries have a unique identifyer.
713 Org will create these identifiers as needed. When this variable is non-nil,
714 the created UIDs will be stored in the ID property of the entry. Then the
715 next time this entry is exported, it will be exported with the same UID,
716 superceeding the previous form of it. This is essential for
717 synchronization services.
718 This variable is not turned on by default because we want to avoid creating
719 a property drawer in every entry if people are only playing with this feature,
720 or if they are only using it locally."
721 :group
'org-export-icalendar
726 ;;; Variables, constants, and parameter plists
728 (defconst org-level-max
20)
730 (defvar org-export-html-preamble nil
731 "Preamble, to be inserted just after <body>. Set by publishing functions.")
732 (defvar org-export-html-postamble nil
733 "Preamble, to be inserted just before </body>. Set by publishing functions.")
734 (defvar org-export-html-auto-preamble t
735 "Should default preamble be inserted? Set by publishing functions.")
736 (defvar org-export-html-auto-postamble t
737 "Should default postamble be inserted? Set by publishing functions.")
738 (defvar org-current-export-file nil
) ; dynamically scoped parameter
739 (defvar org-current-export-dir nil
) ; dynamically scoped parameter
741 (defconst org-export-plist-vars
742 '((:link-up . org-export-html-link-up
)
743 (:link-home . org-export-html-link-home
)
744 (:language . org-export-default-language
)
745 (:customtime . org-display-custom-times
)
746 (:headline-levels . org-export-headline-levels
)
747 (:section-numbers . org-export-with-section-numbers
)
748 (:section-number-format . org-export-section-number-format
)
749 (:table-of-contents . org-export-with-toc
)
750 (:preserve-breaks . org-export-preserve-breaks
)
751 (:archived-trees . org-export-with-archived-trees
)
752 (:emphasize . org-export-with-emphasize
)
753 (:sub-superscript . org-export-with-sub-superscripts
)
754 (:special-strings . org-export-with-special-strings
)
755 (:footnotes . org-export-with-footnotes
)
756 (:drawers . org-export-with-drawers
)
757 (:tags . org-export-with-tags
)
758 (:TeX-macros . org-export-with-TeX-macros
)
759 (:LaTeX-fragments . org-export-with-LaTeX-fragments
)
760 (:skip-before-1st-heading . org-export-skip-text-before-1st-heading
)
761 (:fixed-width . org-export-with-fixed-width
)
762 (:timestamps . org-export-with-timestamps
)
763 (:author-info . org-export-author-info
)
764 (:creator-info . org-export-creator-info
)
765 (:time-stamp-file . org-export-time-stamp-file
)
766 (:tables . org-export-with-tables
)
767 (:table-auto-headline . org-export-highlight-first-table-line
)
768 (:style . org-export-html-style
)
769 (:style-extra . org-export-html-style-extra
)
770 (:agenda-style . org-agenda-export-html-style
)
771 (:convert-org-links . org-export-html-link-org-files-as-html
)
772 (:inline-images . org-export-html-inline-images
)
773 (:html-extension . org-export-html-extension
)
774 (:html-table-tag . org-export-html-table-tag
)
775 (:expand-quoted-html . org-export-html-expand
)
776 (:timestamp . org-export-html-with-timestamp
)
777 (:publishing-directory . org-export-publishing-directory
)
778 (:preamble . org-export-html-preamble
)
779 (:postamble . org-export-html-postamble
)
780 (:auto-preamble . org-export-html-auto-preamble
)
781 (:auto-postamble . org-export-html-auto-postamble
)
782 (:author . user-full-name
)
783 (:email . user-mail-address
)))
785 (defun org-default-export-plist ()
786 "Return the property list with default settings for the export variables."
787 (let ((l org-export-plist-vars
) rtn e
)
788 (while (setq e
(pop l
))
789 (setq rtn
(cons (car e
) (cons (symbol-value (cdr e
)) rtn
))))
792 (defvar org-export-inbuffer-options-extra nil
793 "List of additional in-buffer options that should be detected.
794 Just before export, the buffer is scanned for options like #+TITLE, #+EMAIL,
795 etc. Extensions can add to this list to get their options detected, and they
796 can then add a function to `org-export-options-filters' to process these
798 Each element in this list must be a list, with the in-buffer keyword as car,
799 and a property (a symbol) as the next element. All occurences of the
800 keyword will be found, the values concatenated with a space character
801 in between, and the result stored in the export options property list.")
803 (defvar org-export-options-filters nil
804 "Functions to be called to finalize the export/publishing options.
805 All these options are stored in a property list, and each of the functions
806 in this hook gets a chance to modify this property list. Each function
807 must accept the property list as an argument, and must return the (possibly
810 (defun org-infile-export-plist ()
811 "Return the property list with file-local settings for export."
815 (goto-char (point-min))
816 (let ((re (org-make-options-regexp
818 '("TITLE" "AUTHOR" "DATE" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"
819 "LINK_UP" "LINK_HOME" "SETUPFILE")
820 (mapcar 'car org-export-inbuffer-options-extra
))))
821 p key val text options js-up js-main js-css js-opt a pr
822 ext-setup-or-nil setup-contents
(start 0))
823 (while (or (and ext-setup-or-nil
824 (string-match re ext-setup-or-nil start
)
825 (setq start
(match-end 0)))
826 (and (setq ext-setup-or-nil nil start
0)
827 (re-search-forward re nil t
)))
828 (setq key
(upcase (org-match-string-no-properties 1 ext-setup-or-nil
))
829 val
(org-match-string-no-properties 2 ext-setup-or-nil
))
831 ((setq a
(assoc key org-export-inbuffer-options-extra
))
833 (setq p
(plist-put p pr
(concat (plist-get p pr
) " " val
))))
834 ((string-equal key
"TITLE") (setq p
(plist-put p
:title val
)))
835 ((string-equal key
"AUTHOR")(setq p
(plist-put p
:author val
)))
836 ((string-equal key
"EMAIL") (setq p
(plist-put p
:email val
)))
837 ((string-equal key
"DATE") (setq p
(plist-put p
:date val
)))
838 ((string-equal key
"LANGUAGE") (setq p
(plist-put p
:language val
)))
839 ((string-equal key
"TEXT")
840 (setq text
(if text
(concat text
"\n" val
) val
)))
841 ((string-equal key
"OPTIONS")
842 (setq options
(concat val
" " options
)))
843 ((string-equal key
"LINK_UP")
844 (setq p
(plist-put p
:link-up val
)))
845 ((string-equal key
"LINK_HOME")
846 (setq p
(plist-put p
:link-home val
)))
847 ((equal key
"SETUPFILE")
848 (setq setup-contents
(org-file-contents
850 (org-remove-double-quotes
853 (if (not ext-setup-or-nil
)
854 (setq ext-setup-or-nil setup-contents start
0)
855 (setq ext-setup-or-nil
856 (concat (substring ext-setup-or-nil
0 start
)
857 "\n" setup-contents
"\n"
858 (substring ext-setup-or-nil start
)))))))
859 (setq p
(plist-put p
:text text
))
861 (setq p
(org-export-add-options-to-plist p options
)))
864 (defun org-export-add-options-to-plist (p options
)
865 "Parse an OPTONS line and set values in the property list P."
868 (let ((op '(("H" .
:headline-levels
)
869 ("num" .
:section-numbers
)
870 ("toc" .
:table-of-contents
)
871 ("\\n" .
:preserve-breaks
)
872 ("@" .
:expand-quoted-html
)
875 ("^" .
:sub-superscript
)
876 ("-" .
:special-strings
)
881 ("TeX" .
:TeX-macros
)
882 ("LaTeX" .
:LaTeX-fragments
)
883 ("skip" .
:skip-before-1st-heading
)
884 ("author" .
:author-info
)
885 ("timestamp" .
:time-stamp-file
)))
887 (while (setq o
(pop op
))
888 (if (string-match (concat (regexp-quote (car o
))
889 ":\\([^ \t\n\r;,.]*\\)")
891 (setq p
(plist-put p
(cdr o
)
892 (car (read-from-string
893 (match-string 1 options
))))))))))
896 (defun org-export-add-subtree-options (p pos
)
897 "Add options in subtree at position POS to property list P."
900 (when (org-at-heading-p)
902 ;; This is actually read in `org-export-get-title-from-subtree'
903 ;; (when (setq a (org-entry-get pos "EXPORT_TITLE"))
904 ;; (setq p (plist-put p :title a)))
905 (when (setq a
(org-entry-get pos
"EXPORT_TEXT"))
906 (setq p
(plist-put p
:text a
)))
907 (when (setq a
(org-entry-get pos
"EXPORT_OPTIONS"))
908 (setq p
(org-export-add-options-to-plist p a
)))))
911 (defun org-export-directory (type plist
)
912 (let* ((val (plist-get plist
:publishing-directory
))
914 (or (cdr (assoc type val
)) ".")
918 (defun org-export-process-option-filters (plist)
919 (let ((functions org-export-options-filters
) f
)
920 (while (setq f
(pop functions
))
921 (setq plist
(funcall f plist
))))
925 (defun org-export (&optional arg
)
926 "Export dispatcher for Org-mode.
927 When `org-export-run-in-background' is non-nil, try to run the command
928 in the background. This will be done only for commands that write
929 to a file. For details see the docstring of `org-export-run-in-background'.
931 The prefix argument ARG will be passed to the exporter. However, if
932 ARG is a double universal prefix `C-u C-u', that means to inverse the
933 value of `org-export-run-in-background'."
935 (let* ((bg (org-xor (equal arg
'(16)) org-export-run-in-background
))
936 (help "[t] insert the export option template
937 \[v] limit export to visible part of outline tree
942 \[H] export as HTML to temporary buffer
943 \[R] export region as HTML
944 \[b] export as HTML and browse immediately
948 \[L] export as LaTeX to temporary buffer
950 \[i] export current file as iCalendar file
951 \[I] export all agenda files as iCalendar files
952 \[c] export agenda files into combined iCalendar file
954 \[F] publish current file
955 \[P] publish current project
956 \[X] publish... (project will be prompted for)
957 \[A] publish all projects")
959 '((?t org-insert-export-options-template nil
)
960 (?v org-export-visible nil
)
961 (?a org-export-as-ascii t
)
962 (?h org-export-as-html t
)
963 (?b org-export-as-html-and-open t
)
964 (?H org-export-as-html-to-buffer nil
)
965 (?R org-export-region-as-html nil
)
966 (?x org-export-as-xoxo t
)
967 (?l org-export-as-latex t
)
968 (?L org-export-as-latex-to-buffer nil
)
969 (?i org-export-icalendar-this-file t
)
970 (?I org-export-icalendar-all-agenda-files t
)
971 (?c org-export-icalendar-combine-agenda-files t
)
972 (?F org-publish-current-file t
)
973 (?P org-publish-current-project t
)
975 (?A org-publish-all t
)))
977 (save-window-excursion
978 (delete-other-windows)
979 (with-output-to-temp-buffer "*Org Export/Publishing Help*"
981 (message "Select command: ")
982 (setq r1
(read-char-exclusive)))
983 (setq r2
(if (< r1
27) (+ r1
96) r1
))
984 (unless (setq ass
(assq r2 cmds
))
985 (error "No command associated with key %c" r1
))
986 (if (and bg
(nth 2 ass
))
987 ;; execute in background
988 (let ((p (start-process
989 (concat "Exporting " (file-name-nondirectory (buffer-file-name)))
991 (expand-file-name invocation-name invocation-directory
)
994 "--eval" "(require 'org-exp)"
995 "--eval" "(setq org-wait .2)"
997 "-f" (symbol-name (nth 1 ass
)))))
998 (set-process-sentinel p
'org-export-process-sentinel
)
999 (message "Background process \"%s\": started" p
))
1000 ;; background processing not requested, or not possible
1001 (call-interactively (nth 1 ass
)))))
1003 (defun org-export-process-sentinel (process status
)
1004 (if (string-match "\n+\\'" status
)
1005 (setq status
(substring status
0 -
1)))
1006 (message "Background process \"%s\": %s" process status
))
1008 (defconst org-html-entities
1049 ("Aring") ("AA".
"Å")
1138 ("varepsilon".
"ε")
1151 ("sigmaf") ("varsigma".
"ς")
1159 ("thetasym") ("vartheta".
"ϑ")
1162 ("bull") ("bullet".
"•")
1163 ("hellip") ("dots".
"…")
1173 ("larr") ("leftarrow".
"←") ("gets".
"←")
1174 ("uarr") ("uparrow".
"↑")
1175 ("rarr") ("to".
"→") ("rightarrow".
"→")
1176 ("darr")("downarrow".
"↓")
1177 ("harr") ("leftrightarrow".
"↔")
1178 ("crarr") ("hookleftarrow".
"↵") ; has round hook, not quite CR
1179 ("lArr") ("Leftarrow".
"⇐")
1180 ("uArr") ("Uparrow".
"⇑")
1181 ("rArr") ("Rightarrow".
"⇒")
1182 ("dArr") ("Downarrow".
"⇓")
1183 ("hArr") ("Leftrightarrow".
"⇔")
1185 ("part") ("partial".
"∂")
1186 ("exist") ("exists".
"∃")
1187 ("empty") ("emptyset".
"∅")
1189 ("isin") ("in".
"∈")
1195 ("lowast") ("ast".
"∗")
1197 ("prop") ("proptp".
"∝")
1198 ("infin") ("infty".
"∞")
1199 ("ang") ("angle".
"∠")
1200 ("and") ("wedge".
"∧")
1201 ("or") ("vee".
"∨")
1207 ("cong") ("simeq".
"≅")
1208 ("asymp")("approx".
"≈")
1209 ("ne") ("neq".
"≠")
1213 ("sub") ("subset".
"⊂")
1214 ("sup") ("supset".
"⊃")
1221 ("sdot") ("cdot".
"⋅")
1228 ("loz") ("Diamond".
"◊")
1229 ("spades") ("spadesuit".
"♠")
1230 ("clubs") ("clubsuit".
"♣")
1231 ("hearts") ("diamondsuit".
"♥")
1232 ("diams") ("diamondsuit".
"♦")
1233 ("smile".
"☺") ("blacksmile".
"☻") ("sad".
"☹")
1300 "Entities for TeX->HTML translation.
1301 Entries can be like (\"ent\"), in which case \"\\ent\" will be translated to
1302 \"&ent;\". An entry can also be a dotted pair like (\"ent\".\"&other;\").
1303 In that case, \"\\ent\" will be translated to \"&other;\".
1304 The list contains HTML entities for Latin-1, Greek and other symbols.
1305 It is supplemented by a number of commonly used TeX macros with appropriate
1306 translations. There is currently no way for users to extend this.")
1308 ;;; General functions for all backends
1310 (defun org-export-preprocess-string (string &rest parameters
)
1311 "Cleanup STRING so that that the true exported has a more consistent source.
1312 This function takes STRING, which should be a buffer-string of an org-file
1313 to export. It then creates a temporary buffer where it does its job.
1314 The result is then again returned as a string, and the exporter works
1315 on this string to produce the exported version."
1317 (let* ((htmlp (plist-get parameters
:for-html
))
1318 (asciip (plist-get parameters
:for-ascii
))
1319 (latexp (plist-get parameters
:for-LaTeX
))
1320 (archived-trees (plist-get parameters
:archived-trees
))
1321 (inhibit-read-only t
)
1322 (drawers org-drawers
)
1323 (outline-regexp "\\*+ ")
1326 (with-current-buffer (get-buffer-create " org-mode-tmp")
1329 (setq case-fold-search t
)
1331 (run-hooks 'org-export-preprocess-hook
)
1333 ;; Remove license-to-kill stuff
1334 ;; The caller markes some stuff fo killing, stuff that has been
1335 ;; used to create the page title, for example.
1336 (org-export-kill-licensed-text)
1338 (let ((org-inhibit-startup t
)) (org-mode))
1339 (setq case-fold-search t
)
1340 (untabify (point-min) (point-max))
1342 ;; Handle incude files
1343 (org-export-handle-include-files)
1345 ;; Handle source code snippets
1346 (org-export-replace-src-segments)
1348 ;; Get rid of drawers
1349 (org-export-remove-or-extract-drawers drawers
1350 (plist-get parameters
:drawers
))
1352 ;; Get the correct stuff before the first headline
1353 (when (plist-get parameters
:skip-before-1st-heading
)
1354 (goto-char (point-min))
1355 (when (re-search-forward "^\\*+[ \t]" nil t
)
1356 (delete-region (point-min) (match-beginning 0))
1357 (goto-char (point-min))
1359 (when (plist-get parameters
:add-text
)
1360 (goto-char (point-min))
1361 (insert (plist-get parameters
:add-text
) "\n"))
1363 ;; Get rid of archived trees
1364 (org-export-remove-archived-trees archived-trees
)
1366 ;; Find all headings and compute the targets for them
1367 (setq target-alist
(org-export-define-heading-targets target-alist
))
1369 ;; Find targets in comments and move them out of comments,
1370 ;; but mark them as targets that should be invisible
1371 (setq target-alist
(org-export-handle-invisible-targets target-alist
))
1374 (org-export-protect-examples)
1376 ;; Protect backend specific stuff, throw away the others.
1377 (org-export-select-backend-specific-text
1378 (cond (htmlp 'html
) (latexp 'latex
) (asciip 'ascii
)))
1380 ;; Protect quoted subtrees
1381 (org-export-protect-quoted-subtrees)
1383 ;; Protect verbatim elements
1384 (org-export-protect-verbatim)
1386 ;; Blockquotes and verse
1387 (org-export-mark-blockquote-and-verse)
1389 ;; Remove comment environment and comment subtrees
1390 (org-export-remove-comment-blocks-and-subtrees)
1392 ;; Remove special table lines
1393 (when org-export-table-remove-special-lines
1394 (org-export-remove-special-table-lines))
1396 ;; Specific LaTeX stuff
1398 (require 'org-export-latex nil
)
1399 (org-export-latex-preprocess))
1401 ;; Specific ASCII stuff
1403 (org-export-ascii-preprocess))
1405 ;; Specific HTML stuff
1407 (org-export-html-preprocess parameters
))
1409 ;; Remove or replace comments
1410 (org-export-handle-comments (plist-get parameters
:comments
))
1412 ;; Find matches for radio targets and turn them into internal links
1413 (org-export-mark-radio-links)
1415 ;; Find all links that contain a newline and put them into a single line
1416 (org-export-concatenate-multiline-links)
1418 ;; Find all internal links. If they have a fuzzy match (i.e. not
1419 ;; a *dedicated* target match, let the link point to the
1420 ;; corresponding section.
1421 (org-export-target-internal-links target-alist
)
1423 ;; Normalize links: Convert angle and plain links into bracket links
1424 ;; and expand link abbreviations
1425 (org-export-normalize-links)
1427 ;; Find multiline emphasis and put them into single line
1428 (when (plist-get parameters
:emph-multiline
)
1429 (org-export-concatenate-multiline-emphasis))
1431 (setq rtn
(buffer-string)))
1432 (kill-buffer " org-mode-tmp")
1435 (defun org-export-kill-licensed-text ()
1436 "Remove all text that is marked with a :org-license-to-kill property."
1438 (while (setq p
(text-property-any (point-min) (point-max)
1439 :org-license-to-kill t
))
1441 p
(or (next-single-property-change p
:org-license-to-kill
)
1444 (defun org-export-define-heading-targets (target-alist)
1445 "Find all headings and define the targets for them.
1446 The new targets are added to TARGET-ALIST, which is also returned."
1447 (goto-char (point-min))
1448 (org-init-section-numbers)
1449 (let ((re (concat "^" org-outline-regexp
))
1451 (while (re-search-forward re nil t
)
1452 (setq level
(org-reduced-level
1453 (save-excursion (goto-char (point-at-bol))
1454 (org-outline-level))))
1455 (setq target
(org-solidify-link-text
1456 (format "sec-%s" (org-section-number level
))))
1457 (push (cons target target
) target-alist
)
1458 (add-text-properties
1459 (point-at-bol) (point-at-eol)
1460 (list 'target target
))))
1463 (defun org-export-handle-invisible-targets (target-alist)
1464 "Find targets in comments and move them out of comments.
1465 Mark them as invisible targets."
1467 (goto-char (point-min))
1468 (while (re-search-forward "^#.*?\\(<<<?\\([^>\r\n]+\\)>>>?\\).*" nil t
)
1469 ;; Check if the line before or after is a headline with a target
1470 (if (setq target
(or (get-text-property (point-at-bol 0) 'target
)
1471 (get-text-property (point-at-bol 2) 'target
)))
1473 ;; use the existing target in a neighboring line
1474 (setq tmp
(match-string 2))
1476 (and (looking-at "\n") (delete-char 1))
1477 (push (cons (org-solidify-link-text tmp
) target
)
1479 ;; Make an invisible target
1480 (replace-match "\\1(INVISIBLE)"))))
1483 (defun org-export-target-internal-links (target-alist)
1484 "Find all internal links and assign target to them.
1485 If a link has a fuzzy match (i.e. not a *dedicated* target match),
1486 let the link point to the corresponding section."
1487 (goto-char (point-min))
1488 (while (re-search-forward org-bracket-link-regexp nil t
)
1490 (let* ((md (match-data))
1491 (desc (match-end 2))
1492 (link (org-link-unescape (match-string 1)))
1493 (slink (org-solidify-link-text link
))
1497 ((cdr (assoc slink target-alist
)))
1498 ((string-match org-link-types-re link
) nil
)
1499 ((or (file-name-absolute-p link
)
1500 (string-match "^\\." link
))
1504 (setq found
(condition-case nil
(org-link-search link
)
1507 (or (org-on-heading-p)
1508 (not (eq found
'dedicated
))))
1509 (or (get-text-property (point) 'target
)
1512 (1- (previous-single-property-change
1517 (goto-char (match-beginning 1))
1518 (setq props
(text-properties-at (point)))
1519 (delete-region (match-beginning 1) (match-end 1))
1522 (unless desc
(insert "][" link
))
1523 (add-text-properties pos
(point) props
))))))
1525 (defun org-export-remove-or-extract-drawers (all-drawers exp-drawers
)
1526 "Remove drawers, or extract the content.
1527 ALL-DRAWERS is a list of all drawer names valid in the current buffer.
1528 EXP-DRAWERS can be t to keep all drawer contents, or a list of drawers
1529 whose content to keep."
1530 (unless (eq t exp-drawers
)
1531 (goto-char (point-min))
1532 (let ((re (concat "^[ \t]*:\\("
1535 (org-delete-all exp-drawers
1536 (copy-sequence all-drawers
))
1538 "\\):[ \t]*\n\\([^@]*?\n\\)?[ \t]*:END:[ \t]*\n")))
1539 (while (re-search-forward re nil t
)
1540 (replace-match "")))))
1542 (defun org-export-remove-archived-trees (export-archived-trees)
1543 "Remove archived trees.
1544 When EXPORT-ARCHIVED-TREES is `headline;, only the headline will be exported.
1545 When it is t, the entire archived tree will be exported.
1546 When it is nil the entire tree including the headline will be removed
1548 (let ((re-archive (concat ":" org-archive-tag
":"))
1550 (when (not (eq export-archived-trees t
))
1551 (goto-char (point-min))
1552 (while (re-search-forward re-archive nil t
)
1553 (if (not (org-on-heading-p t
))
1554 (org-end-of-subtree t
)
1555 (beginning-of-line 1)
1556 (setq a
(if export-archived-trees
1557 (1+ (point-at-eol)) (point))
1558 b
(org-end-of-subtree t
))
1559 (if (> b a
) (delete-region a b
)))))))
1561 (defun org-export-protect-quoted-subtrees ()
1562 "Mark quoted subtrees with the protection property."
1563 (let ((re-quote (concat "^\\*+[ \t]+" org-quote-string
"\\>")))
1564 (goto-char (point-min))
1565 (while (re-search-forward re-quote nil t
)
1566 (goto-char (match-beginning 0))
1568 (add-text-properties (point) (org-end-of-subtree t
)
1569 '(org-protected t
)))))
1571 (defun org-export-protect-verbatim ()
1572 "Mark verbatim snippets with the protection property."
1573 (goto-char (point-min))
1574 (while (re-search-forward org-verbatim-re nil t
)
1575 (add-text-properties (match-beginning 4) (match-end 4)
1577 (goto-char (1+ (match-end 4)))))
1579 (defun org-export-protect-examples ()
1580 "Protect code that should be exported as monospaced examples."
1581 (goto-char (point-min))
1582 (while (re-search-forward "^#\\+BEGIN_EXAMPLE[ \t]*\n" nil t
)
1583 (goto-char (match-end 0))
1584 (while (and (not (looking-at "#\\+END_EXAMPLE")) (not (eobp)))
1586 (beginning-of-line 2)))
1587 (goto-char (point-min))
1588 (while (re-search-forward "^[ \t]*:.*\\(\n[ \t]*:.*\\)*" nil t
)
1589 (add-text-properties (match-beginning 0) (match-end 0)
1590 '(org-protected t
))))
1592 (defun org-export-select-backend-specific-text (backend)
1594 '((html "HTML" "BEGIN_HTML" "END_HTML")
1595 (ascii "ASCII" "BEGIN_ASCII" "END_ASCII")
1596 (latex "LaTeX" "BEGIN_LaTeX" "END_LaTeX")))
1600 (setq fmt
(pop formatters
))
1601 (when (eq (car fmt
) backend
)
1602 ;; This is selected code, put it into the file for real
1603 (goto-char (point-min))
1604 (while (re-search-forward (concat "^#\\+" (cadr fmt
)
1605 ":[ \t]*\\(.*\\)") nil t
)
1606 (replace-match "\\1" t
)
1607 (add-text-properties
1608 (point-at-bol) (min (1+ (point-at-eol)) (point-max))
1609 '(org-protected t
))))
1610 (goto-char (point-min))
1611 (while (re-search-forward
1613 (caddr fmt
) "\\>.*\\(\\(\n.*\\)*?\n\\)#\\+"
1614 (cadddr fmt
) "\\>.*\n?") nil t
)
1615 (if (eq (car fmt
) backend
)
1617 (add-text-properties (match-beginning 1) (1+ (match-end 1))
1619 ;; No, this is for a different backend, kill it
1620 (delete-region (match-beginning 0) (match-end 0)))))))
1622 (defun org-export-mark-blockquote-and-verse ()
1623 "Mark block quote and verse environments with special cookies.
1624 These special cookies will later be interpreted by the backend."
1626 (goto-char (point-min))
1627 (while (re-search-forward "^#\\+\\(begin\\|end\\)_\\(block\\)?quote\\>.*"
1629 (replace-match (if (equal (downcase (match-string 1)) "end")
1630 "ORG-BLOCKQUOTE-END" "ORG-BLOCKQUOTE-START")
1633 (goto-char (point-min))
1634 (while (re-search-forward "^#\\+\\(begin\\|end\\)_verse\\>.*" nil t
)
1635 (replace-match (if (equal (downcase (match-string 1)) "end")
1636 "ORG-VERSE-END" "ORG-VERSE-START")
1639 (defun org-export-remove-comment-blocks-and-subtrees ()
1640 "Remove the comment environment, and also commented subtrees."
1641 (let ((re-commented (concat "^\\*+[ \t]+" org-comment-string
"\\>")))
1642 ;; Remove comment environment
1643 (goto-char (point-min))
1644 (while (re-search-forward
1645 "^#\\+BEGIN_COMMENT[ \t]*\n[^\000]*?^#\\+END_COMMENT\\>.*" nil t
)
1646 (replace-match "" t t
))
1647 ;; Remove subtrees that are commented
1648 (goto-char (point-min))
1649 (while (re-search-forward re-commented nil t
)
1650 (goto-char (match-beginning 0))
1651 (delete-region (point) (org-end-of-subtree t
)))))
1653 (defun org-export-handle-comments (commentsp)
1654 "Remove comments, or convert to backend-specific format.
1655 COMMENTSP can be a format string for publishing comments.
1656 When it is nil, all comments will be removed."
1657 (let ((re "^#\\(.*\n?\\)")
1659 (goto-char (point-min))
1660 (while (or (looking-at re
)
1661 (re-search-forward re nil t
))
1662 (setq pos
(match-beginning 0))
1664 (progn (add-text-properties
1665 (match-beginning 0) (match-end 0) '(org-protected t
))
1666 (replace-match (format commentsp
(match-string 1)) t t
))
1667 (goto-char (1+ pos
))
1670 (goto-char (max (point-min) (1- pos
))))))))
1672 (defun org-export-mark-radio-links ()
1673 "Find all matches for radio targets and turn them into internal links."
1674 (let ((re-radio (and org-target-link-regexp
1675 (concat "\\([^<]\\)\\(" org-target-link-regexp
"\\)"))))
1676 (goto-char (point-min))
1678 (while (re-search-forward re-radio nil t
)
1680 (replace-match "\\1[[\\2]]"))))))
1682 (defun org-export-remove-special-table-lines ()
1683 "Remove tables lines that are used for internal purposes."
1684 (goto-char (point-min))
1685 (while (re-search-forward "^[ \t]*|" nil t
)
1686 (beginning-of-line 1)
1687 (if (or (looking-at "[ \t]*| *[!_^] *|")
1688 (and (looking-at ".*?| *<[0-9]+> *|")
1689 (not (looking-at ".*?| *[^ <|]"))))
1690 (delete-region (max (point-min) (1- (point-at-bol)))
1694 (defun org-export-normalize-links ()
1695 "Convert all links to bracket links, and expand link abbreviations."
1696 (let ((re-plain-link (concat "\\([^[<]\\)" org-plain-link-re
))
1697 (re-angle-link (concat "\\([^[]\\)" org-angle-link-re
)))
1698 (goto-char (point-min))
1699 (while (re-search-forward re-plain-link nil t
)
1700 (goto-char (1- (match-end 0)))
1702 (let* ((s (concat (match-string 1) "[[" (match-string 2)
1703 ":" (match-string 3) "]]")))
1704 ;; added 'org-link face to links
1705 (put-text-property 0 (length s
) 'face
'org-link s
)
1706 (replace-match s t t
))))
1707 (goto-char (point-min))
1708 (while (re-search-forward re-angle-link nil t
)
1709 (goto-char (1- (match-end 0)))
1711 (let* ((s (concat (match-string 1) "[[" (match-string 2)
1712 ":" (match-string 3) "]]")))
1713 (put-text-property 0 (length s
) 'face
'org-link s
)
1714 (replace-match s t t
))))
1715 (goto-char (point-min))
1716 (while (re-search-forward org-bracket-link-regexp nil t
)
1718 (let* ((xx (save-match-data
1719 (org-link-expand-abbrev (match-string 1))))
1724 (concat "[" xx
"]"))
1726 (put-text-property 0 (length s
) 'face
'org-link s
)
1727 (replace-match s t t
))))))
1729 (defun org-export-concatenate-multiline-links ()
1730 "Find multi-line links and put it all into a single line.
1731 This is to make sure that the line-processing export backends
1732 can work correctly."
1733 (goto-char (point-min))
1734 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t
)
1736 (replace-match "\\1 \\3")
1737 (goto-char (match-beginning 0)))))
1739 (defun org-export-concatenate-multiline-emphasis ()
1740 "Find multi-line emphasis and put it all into a single line.
1741 This is to make sure that the line-processing export backends
1742 can work correctly."
1743 (goto-char (point-min))
1744 (while (re-search-forward org-emph-re nil t
)
1745 (if (not (= (char-after (match-beginning 3))
1746 (char-after (match-beginning 4))))
1748 (subst-char-in-region (match-beginning 0) (match-end 0)
1750 (goto-char (1- (match-end 0))))
1751 (goto-char (1+ (match-beginning 0))))))
1753 (defun org-export-grab-title-from-buffer ()
1754 "Get a title for the current document, from looking at the buffer."
1755 (let ((inhibit-read-only t
))
1757 (goto-char (point-min))
1758 (let ((end (save-excursion (outline-next-heading) (point))))
1759 (when (re-search-forward "^[ \t]*[^|# \t\r\n].*\n" end t
)
1760 ;; Mark the line so that it will not be exported as normal text.
1762 (add-text-properties (match-beginning 0) (match-end 0)
1763 (list :org-license-to-kill t
)))
1764 ;; Return the title string
1765 (org-trim (match-string 0)))))))
1767 (defun org-export-get-title-from-subtree ()
1768 "Return subtree title and exclude it from export."
1769 (let (title (m (mark)) (rbeg (region-beginning)) (rend (region-end)))
1772 (when (and (org-at-heading-p)
1773 (>= (org-end-of-subtree t t
) rend
))
1774 ;; This is a subtree, we take the title from the first heading
1776 (looking-at org-todo-line-regexp
)
1777 (setq title
(match-string 3))
1779 (add-text-properties (point) (1+ (point-at-eol))
1780 (list :org-license-to-kill t
)))
1781 (setq title
(or (org-entry-get nil
"EXPORT_TITLE") title
))))
1784 (defun org-solidify-link-text (s &optional alist
)
1785 "Take link text and make a safe target out of it."
1790 (org-split-string s
"[ \t\r\n]+") "=="))
1791 (a (assoc rtn alist
)))
1794 (defun org-get-min-level (lines)
1795 "Get the minimum level in LINES."
1796 (let ((re "^\\(\\*+\\) ") l min
)
1798 (while (setq l
(pop lines
))
1799 (if (string-match re l
)
1800 (throw 'exit
(org-tr-level (length (match-string 1 l
))))))
1803 ;; Variable holding the vector with section numbers
1804 (defvar org-section-numbers
(make-vector org-level-max
0))
1806 (defun org-init-section-numbers ()
1807 "Initialize the vector for the section numbers."
1809 (numbers (nreverse (org-split-string "" "\\.")))
1810 (depth (1- (length org-section-numbers
)))
1811 (i depth
) number-string
)
1814 (aset org-section-numbers i
0)
1815 (setq number-string
(or (car numbers
) "0"))
1816 (if (string-match "\\`[A-Z]\\'" number-string
)
1817 (aset org-section-numbers i
1818 (- (string-to-char number-string
) ?A -
1))
1819 (aset org-section-numbers i
(string-to-number number-string
)))
1823 (defun org-section-number (&optional level
)
1824 "Return a string with the current section number.
1825 When LEVEL is non-nil, increase section numbers on that level."
1826 (let* ((depth (1- (length org-section-numbers
)))
1828 (fmts (car org-export-section-number-format
))
1829 (term (cdr org-export-section-number-format
))
1834 (aset org-section-numbers
1835 level
(1+ (aref org-section-numbers level
))))
1836 (setq idx
(1+ level
))
1837 (while (<= idx depth
)
1839 (aset org-section-numbers idx
0))
1840 (setq idx
(1+ idx
))))
1842 (while (<= idx depth
)
1843 (when (> (aref org-section-numbers idx
) 0)
1844 (setq fmt
(or (pop fmts
) fmt
)
1846 n
(aref org-section-numbers idx
)
1848 (concat string sep
(org-number-to-counter n ctype
))
1849 (concat string
".0"))
1851 (setq idx
(1+ idx
)))
1853 (if (string-match "\\`\\([@0]\\.\\)+" string
)
1854 (setq string
(replace-match "" t nil string
)))
1855 (if (string-match "\\(\\.0\\)+\\'" string
)
1856 (setq string
(replace-match "" t nil string
))))
1857 (concat string term
)))
1859 (defun org-number-to-counter (n type
)
1860 "Concert number N to a string counter, according to TYPE.
1861 TYPE must be a string, any of:
1865 I uppper case roman numeral
1866 i lower case roman numeral"
1868 ((equal type
"1") (number-to-string n
))
1869 ((equal type
"A") (char-to-string (+ ?A n -
1)))
1870 ((equal type
"a") (char-to-string (+ ?a n -
1)))
1871 ((equal type
"I") (org-number-to-roman n
))
1872 ((equal type
"i") (downcase (org-number-to-roman n
)))
1873 (t (error "Invalid counter type `%s'" type
))))
1875 (defun org-number-to-roman (n)
1876 "Convert integer N into a roman numeral."
1877 (let ((roman '((1000 .
"M") (900 .
"CM") (500 .
"D") (400 .
"CD")
1878 ( 100 .
"C") ( 90 .
"XC") ( 50 .
"L") ( 40 .
"XL")
1879 ( 10 .
"X") ( 9 .
"IX") ( 5 .
"V") ( 4 .
"IV")
1883 (number-to-string n
)
1885 (if (>= n
(caar roman
))
1886 (setq n
(- n
(caar roman
))
1887 res
(concat res
(cdar roman
)))
1891 (org-number-to-roman 1961)
1896 (defun org-export-handle-include-files ()
1897 "Include the contents of include files, with proper formatting."
1898 (let ((case-fold-search t
)
1899 params file markup lang start end prefix prefix1
)
1900 (goto-char (point-min))
1901 (while (re-search-forward "^#\\+INCLUDE:?[ \t]+\\(.*\\)" nil t
)
1902 (setq params
(read (concat "(" (match-string 1) ")"))
1903 prefix
(org-get-and-remove-property 'params
:prefix
)
1904 prefix1
(org-get-and-remove-property 'params
:prefix1
)
1905 file
(org-symname-or-string (pop params
))
1906 markup
(org-symname-or-string (pop params
))
1907 lang
(org-symname-or-string (pop params
)))
1908 (delete-region (match-beginning 0) (match-end 0))
1910 (not (file-exists-p file
))
1911 (not (file-readable-p file
)))
1912 (insert (format "CANNOT INCLUDE FILE %s" file
))
1914 (if (equal (downcase markup
) "src")
1915 (setq start
(format "#+begin_src %s\n" (or lang
"fundamental"))
1917 (setq start
(format "#+begin_%s\n" markup
)
1918 end
(format "#+end_%s" markup
))))
1919 (insert (or start
""))
1920 (insert (org-get-file-contents (expand-file-name file
) prefix prefix1
))
1921 (or (bolp) (newline))
1922 (insert (or end
""))))))
1924 (defun org-get-file-contents (file &optional prefix prefix1
)
1925 "Get the contents of FILE and return them as a string.
1926 If PREFIX is a string, prepend it to each line. If PREFIX1
1927 is a string, prepend it to the first line instead of PREFIX."
1929 (insert-file-contents file
)
1930 (when (or prefix prefix1
)
1931 (goto-char (point-min))
1933 (insert (or prefix1 prefix
))
1935 (beginning-of-line 2)))
1938 (defun org-get-and-remove-property (listvar prop
)
1939 "Check if the value of LISTVAR contains PROP as a property.
1940 If yes, return the value of that property (i.e. the element following
1941 in the list) and remove property and value from the list in LISTVAR."
1942 (let ((list (symbol-value listvar
)) m v
)
1943 (when (setq m
(member prop list
))
1945 (if (equal (car list
) prop
)
1946 (set listvar
(cddr list
))
1947 (setcdr (nthcdr (- (length list
) (length m
) 1) list
)
1949 (set listvar list
)))
1952 (defun org-symname-or-string (s)
1954 (if s
(symbol-name s
) s
)
1957 ;;; Fontification of code
1958 ;; Currently only for the HTML backend, but who knows....
1959 (defun org-export-replace-src-segments ()
1960 "Replace source code segments with special code for export."
1961 (let ((case-fold-search t
)
1963 (goto-char (point-min))
1964 (while (re-search-forward
1965 "^#\\+BEGIN_SRC:?[ \t]+\\([^ \t\n]+\\)[ \t]*\n\\([^\000]+?\n\\)#\\+END_SRC.*"
1967 (setq lang
(match-string 1) code
(match-string 2)
1968 trans
(org-export-format-source-code lang code
))
1969 (replace-match trans t t
))))
1971 (defvar htmlp
) ;; dynamically scoped from org-exp.el
1973 (defun org-export-format-source-code (lang code
)
1974 "Format CODE from language LANG and return it formatted for export.
1975 Currently, this only does something for HTML export, for all other
1976 backends, it converts the segment into an EXAMPLE segment."
1980 ;; We are exporting to HTML
1981 (condition-case nil
(require 'htmlize
) (nil t
))
1982 (if (not (fboundp 'htmlize-region-for-paste
))
1984 ;; we do not have htmlize.el, or an old version of it
1986 "htmlize.el 1.34 or later is needed for source code formatting")
1987 (concat "#+BEGIN_EXAMPLE\n" code
1988 (if (string-match "\n\\'" code
) "" "\n")
1990 ;; ok, we are good to go
1991 (let* ((mode (and lang
(intern (concat lang
"-mode"))))
1992 (org-inhibit-startup t
)
1993 (org-startup-folded nil
)
1997 ;; Free up the protected stuff
1998 (goto-char (point-min))
1999 (while (re-search-forward "^," nil t
)
2002 (if (functionp mode
)
2005 (font-lock-fontify-buffer)
2006 (org-export-htmlize-region-for-paste
2007 (point-min) (point-max)))))
2008 (if (string-match "<pre\\([^>]*\\)>\n?" htmltext
)
2009 (setq htmltext
(replace-match "<pre class=\"src\">"
2011 (concat "#+BEGIN_HTML\n" htmltext
"\n#+END_HTML\n"))))
2013 ;; This is not HTML, so just make it an example.
2014 (when (equal lang
"org")
2015 (while (string-match "^," code
)
2016 (setq code
(replace-match "" t t code
))))
2017 (concat "#+BEGIN_EXAMPLE\n" code
2018 (if (string-match "\n\\'" code
) "" "\n")
2019 "#+END_EXAMPLE\n")))))
2023 (defvar org-last-level nil
) ; dynamically scoped variable
2024 (defvar org-min-level nil
) ; dynamically scoped variable
2025 (defvar org-levels-open nil
) ; dynamically scoped parameter
2026 (defvar org-ascii-current-indentation nil
) ; For communication
2029 (defun org-export-as-ascii (arg)
2030 "Export the outline as a pretty ASCII file.
2031 If there is an active region, export only the region.
2032 The prefix ARG specifies how many levels of the outline should become
2033 underlined headlines. The default is 3."
2035 (setq-default org-todo-line-regexp org-todo-line-regexp
)
2036 (let* ((opt-plist (org-combine-plists (org-default-export-plist)
2037 (org-infile-export-plist)))
2038 (region-p (org-region-active-p))
2039 (rbeg (and region-p
(region-beginning)))
2040 (rend (and region-p
(region-end)))
2045 (and (org-at-heading-p)
2046 (>= (org-end-of-subtree t t
) rend
)))))
2047 (opt-plist (if subtree-p
2048 (org-export-add-subtree-options opt-plist rbeg
)
2050 (custom-times org-display-custom-times
)
2051 (org-ascii-current-indentation '(0 .
0))
2055 (case-fold-search nil
)
2056 (filename (concat (file-name-as-directory
2057 (org-export-directory :ascii opt-plist
))
2058 (file-name-sans-extension
2060 (org-entry-get (region-beginning)
2061 "EXPORT_FILE_NAME" t
))
2062 (file-name-nondirectory buffer-file-name
)))
2064 (filename (if (equal (file-truename filename
)
2065 (file-truename buffer-file-name
))
2066 (concat filename
".txt")
2068 (buffer (find-file-noselect filename
))
2069 (org-levels-open (make-vector org-level-max nil
))
2070 (odd org-odd-levels-only
)
2071 (date (plist-get opt-plist
:date
))
2072 (author (plist-get opt-plist
:author
))
2073 (title (or (and subtree-p
(org-export-get-title-from-subtree))
2074 (plist-get opt-plist
:title
)
2076 (plist-get opt-plist
:skip-before-1st-heading
))
2077 (org-export-grab-title-from-buffer))
2078 (file-name-sans-extension
2079 (file-name-nondirectory buffer-file-name
))))
2080 (email (plist-get opt-plist
:email
))
2081 (language (plist-get opt-plist
:language
))
2082 (quote-re0 (concat "^[ \t]*" org-quote-string
"\\>"))
2083 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
2088 (if (org-region-active-p) (region-beginning) (point-min))
2089 (if (org-region-active-p) (region-end) (point-max))))
2090 (lines (org-split-string
2091 (org-export-preprocess-string
2094 :skip-before-1st-heading
2095 (plist-get opt-plist
:skip-before-1st-heading
)
2096 :drawers
(plist-get opt-plist
:drawers
)
2097 :verbatim-multiline t
2099 (plist-get opt-plist
:archived-trees
)
2100 :add-text
(plist-get opt-plist
:text
))
2102 thetoc have-headings first-heading-pos
2103 table-open table-buffer
)
2105 (let ((inhibit-read-only t
))
2107 (remove-text-properties (point-min) (point-max)
2108 '(:org-license-to-kill t
))))
2110 (setq org-min-level
(org-get-min-level lines
))
2111 (setq org-last-level org-min-level
)
2112 (org-init-section-numbers)
2114 (find-file-noselect filename
)
2116 (setq lang-words
(or (assoc language org-export-language-setup
)
2117 (assoc "en" org-export-language-setup
)))
2118 (switch-to-buffer-other-window buffer
)
2121 ;; create local variables for all options, to make sure all called
2122 ;; functions get the correct information
2124 (set (make-local-variable (cdr x
))
2125 (plist-get opt-plist
(car x
))))
2126 org-export-plist-vars
)
2127 (org-set-local 'org-odd-levels-only odd
)
2128 (setq umax
(if arg
(prefix-numeric-value arg
)
2129 org-export-headline-levels
))
2130 (setq umax-toc
(if (integerp org-export-with-toc
)
2131 (min org-export-with-toc umax
)
2135 (if title
(org-insert-centered title ?
=))
2137 (if (and (or author email
)
2138 org-export-author-info
)
2139 (insert (concat (nth 1 lang-words
) ": " (or author
"")
2140 (if email
(concat " <" email
">") "")
2144 ((and date
(string-match "%" date
))
2145 (setq date
(format-time-string date
)))
2147 (t (setq date
(format-time-string "%Y/%m/%d %X"))))
2149 (if (and date org-export-time-stamp-file
)
2150 (insert (concat (nth 2 lang-words
) ": " date
"\n")))
2154 (if org-export-with-toc
2156 (push (concat (nth 3 lang-words
) "\n") thetoc
)
2157 (push (concat (make-string (string-width (nth 3 lang-words
)) ?
=)
2159 (mapc '(lambda (line)
2160 (if (string-match org-todo-line-regexp
2162 ;; This is a headline
2164 (setq have-headings t
)
2165 (setq level
(- (match-end 1) (match-beginning 1))
2166 level
(org-tr-level level
)
2167 txt
(match-string 3 line
)
2169 (or (and org-export-mark-todo-in-toc
2171 (not (member (match-string 2 line
)
2172 org-done-keywords
)))
2174 (and org-export-mark-todo-in-toc
2176 (org-search-todo-below
2177 line lines level
))))
2178 (setq txt
(org-html-expand-for-ascii txt
))
2180 (while (string-match org-bracket-link-regexp txt
)
2183 (match-string (if (match-end 2) 3 1) txt
)
2186 (if (and (memq org-export-with-tags
'(not-in-toc nil
))
2188 (org-re "[ \t]+:[[:alnum:]_@:]+:[ \t]*$")
2190 (setq txt
(replace-match "" t t txt
)))
2191 (if (string-match quote-re0 txt
)
2192 (setq txt
(replace-match "" t t txt
)))
2194 (if org-export-with-section-numbers
2195 (setq txt
(concat (org-section-number level
)
2197 (if (<= level umax-toc
)
2202 (* (max 0 (- level org-min-level
)) 4) ?\
)
2203 (format (if todo
"%s (*)\n" "%s\n") txt
))
2205 (setq org-last-level level
))
2208 (setq thetoc
(if have-headings
(nreverse thetoc
) nil
))))
2210 (org-init-section-numbers)
2211 (while (setq line
(pop lines
))
2212 ;; Remove the quoted HTML tags.
2213 (setq line
(org-html-expand-for-ascii line
))
2215 (while (string-match "<<<?[^<>]*>>>?[ \t]*\n?" line
)
2216 (setq line
(replace-match "" t t line
)))
2217 ;; Replace internal links
2218 (while (string-match org-bracket-link-regexp line
)
2219 (setq line
(replace-match
2220 (if (match-end 3) "[\\3]" "[\\1]")
2223 (setq line
(org-translate-time line
)))
2225 ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line
)
2227 (setq first-heading-pos
(or first-heading-pos
(point)))
2228 (setq level
(org-tr-level (- (match-end 1) (match-beginning 1)))
2229 txt
(match-string 2 line
))
2230 (org-ascii-level-start level txt umax lines
))
2232 ((and org-export-with-tables
2233 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line
))
2234 (if (not table-open
)
2236 (setq table-open t table-buffer nil
))
2238 (setq table-buffer
(cons line table-buffer
))
2239 (when (or (not lines
)
2240 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
2242 (setq table-open nil
2243 table-buffer
(nreverse table-buffer
))
2246 (org-fix-indentation x org-ascii-current-indentation
))
2247 (org-format-table-ascii table-buffer
)
2250 (setq line
(org-fix-indentation line org-ascii-current-indentation
))
2251 (if (and org-export-with-fixed-width
2252 (string-match "^\\([ \t]*\\)\\(:\\)" line
))
2253 (setq line
(replace-match "\\1" nil nil line
)))
2254 (insert line
"\n"))))
2258 ;; insert the table of contents
2260 (goto-char (point-min))
2261 (if (re-search-forward "^[ \t]*\\[TABLE-OF-CONTENTS\\][ \t]*$" nil t
)
2263 (goto-char (match-beginning 0))
2265 (goto-char first-heading-pos
))
2266 (mapc 'insert thetoc
)
2267 (or (looking-at "[ \t]*\n[ \t]*\n")
2270 ;; Convert whitespace place holders
2271 (goto-char (point-min))
2273 (while (setq beg
(next-single-property-change (point) 'org-whitespace
))
2274 (setq end
(next-single-property-change beg
'org-whitespace
))
2276 (delete-region beg end
)
2277 (insert (make-string (- end beg
) ?\
))))
2280 ;; remove display and invisible chars
2282 (goto-char (point-min))
2283 (while (setq beg
(next-single-property-change (point) 'display
))
2284 (setq end
(next-single-property-change beg
'display
))
2285 (delete-region beg end
)
2288 (goto-char (point-min))
2289 (while (setq beg
(next-single-property-change (point) 'org-cwidth
))
2290 (setq end
(next-single-property-change beg
'org-cwidth
))
2291 (delete-region beg end
)
2293 (goto-char (point-min))))
2295 (defun org-export-ascii-preprocess ()
2296 "Do extra work for ASCII export"
2297 (goto-char (point-min))
2298 (while (re-search-forward org-verbatim-re nil t
)
2299 (goto-char (match-end 2))
2300 (backward-delete-char 1) (insert "'")
2301 (goto-char (match-beginning 2))
2302 (delete-char 1) (insert "`")
2303 (goto-char (match-end 2))))
2305 (defun org-search-todo-below (line lines level
)
2306 "Search the subtree below LINE for any TODO entries."
2307 (let ((rest (cdr (memq line lines
)))
2308 (re org-todo-line-regexp
)
2311 (while (setq line
(pop rest
))
2312 (if (string-match re line
)
2314 (setq lv
(- (match-end 1) (match-beginning 1))
2315 todo
(and (match-beginning 2)
2316 (not (member (match-string 2 line
)
2317 org-done-keywords
))))
2319 (if (<= lv level
) (throw 'exit nil
))
2320 (if todo
(throw 'exit t
))))))))
2322 (defun org-html-expand-for-ascii (line)
2323 "Handle quoted HTML for ASCII export."
2324 (if org-export-html-expand
2325 (while (string-match "@<[^<>\n]*>" line
)
2326 ;; We just remove the tags for now.
2327 (setq line
(replace-match "" nil nil line
))))
2330 (defun org-insert-centered (s &optional underline
)
2331 "Insert the string S centered and underline it with character UNDERLINE."
2332 (let ((ind (max (/ (- fill-column
(string-width s
)) 2) 0)))
2333 (insert (make-string ind ?\
) s
"\n")
2335 (insert (make-string ind ?\
)
2336 (make-string (string-width s
) underline
)
2339 (defun org-ascii-level-start (level title umax
&optional lines
)
2340 "Insert a new level in ASCII export."
2341 (let (char (n (- level umax
1)) (ind 0))
2344 (insert (make-string (* 2 n
) ?\
)
2345 (char-to-string (nth (% n
(length org-export-ascii-bullets
))
2346 org-export-ascii-bullets
))
2348 ;; find the indentation of the next non-empty line
2351 (if (string-match "^\\* " (car lines
)) (throw 'stop nil
))
2352 (if (string-match "^\\([ \t]*\\)\\S-" (car lines
))
2353 (throw 'stop
(setq ind
(org-get-indentation (car lines
)))))
2355 (setq org-ascii-current-indentation
(cons (* 2 (1+ n
)) ind
)))
2356 (if (or (not (equal (char-before) ?
\n))
2357 (not (equal (char-before (1- (point))) ?
\n)))
2359 (setq char
(nth (- umax level
) (reverse org-export-ascii-underline
)))
2360 (unless org-export-with-tags
2361 (if (string-match (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title
)
2362 (setq title
(replace-match "" t t title
))))
2363 (if org-export-with-section-numbers
2364 (setq title
(concat (org-section-number level
) " " title
)))
2365 (insert title
"\n" (make-string (string-width title
) char
) "\n")
2366 (setq org-ascii-current-indentation
'(0 .
0)))))
2369 (defun org-export-visible (type arg
)
2370 "Create a copy of the visible part of the current buffer, and export it.
2371 The copy is created in a temporary buffer and removed after use.
2372 TYPE is the final key (as a string) that also select the export command in
2373 the `C-c C-e' export dispatcher.
2374 As a special case, if the you type SPC at the prompt, the temporary
2375 org-mode file will not be removed but presented to you so that you can
2376 continue to use it. The prefix arg ARG is passed through to the exporting
2380 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
2381 (read-char-exclusive))
2382 current-prefix-arg
))
2383 (if (not (member type
'(?a ?\C-a ?b ?\C-b ?h ?x ?\
)))
2384 (error "Invalid export key"))
2385 (let* ((binding (cdr (assoc type
2386 '((?a . org-export-as-ascii
)
2387 (?\C-a . org-export-as-ascii
)
2388 (?b . org-export-as-html-and-open
)
2389 (?\C-b . org-export-as-html-and-open
)
2390 (?h . org-export-as-html
)
2391 (?H . org-export-as-html-to-buffer
)
2392 (?R . org-export-region-as-html
)
2393 (?x . org-export-as-xoxo
)))))
2394 (keepp (equal type ?\
))
2395 (file buffer-file-name
)
2396 (buffer (get-buffer-create "*Org Export Visible*"))
2398 ;; Need to hack the drawers here.
2400 (goto-char (point-min))
2401 (while (re-search-forward org-drawer-regexp nil t
)
2402 (goto-char (match-beginning 1))
2403 (or (org-invisible-p) (org-flag-drawer nil
))))
2404 (with-current-buffer buffer
(erase-buffer))
2406 (setq s
(goto-char (point-min)))
2407 (while (not (= (point) (point-max)))
2408 (goto-char (org-find-invisible))
2409 (append-to-buffer buffer s
(point))
2410 (setq s
(goto-char (org-find-visible))))
2411 (org-cycle-hide-drawers 'all
)
2412 (goto-char (point-min))
2414 ;; Copy all comment lines to the end, to make sure #+ settings are
2415 ;; still available for the second export step. Kind of a hack, but
2416 ;; does do the trick.
2417 (if (looking-at "#[^\r\n]*")
2418 (append-to-buffer buffer
(match-beginning 0) (1+ (match-end 0))))
2419 (while (re-search-forward "[\n\r]#[^\n\r]*" nil t
)
2420 (append-to-buffer buffer
(1+ (match-beginning 0))
2421 (min (point-max) (1+ (match-end 0))))))
2423 (let ((buffer-file-name file
)
2424 (org-inhibit-startup t
))
2427 (unless keepp
(funcall binding arg
))))
2429 (kill-buffer buffer
)
2430 (switch-to-buffer-other-window buffer
)
2431 (goto-char (point-min)))))
2433 (defun org-find-visible ()
2435 (while (and (not (= (point-max) (setq s
(next-overlay-change s
))))
2436 (get-char-property s
'invisible
)))
2438 (defun org-find-invisible ()
2440 (while (and (not (= (point-max) (setq s
(next-overlay-change s
))))
2441 (not (get-char-property s
'invisible
))))
2446 (defvar org-archive-location
) ;; gets loades with the org-archive require.
2447 (defun org-get-current-options ()
2448 "Return a string with current options as keyword options.
2449 Does include HTML export options as well as TODO and CATEGORY stuff."
2450 (require 'org-archive
)
2457 #+TEXT: Some descriptive text to be emitted. Several lines OK.
2458 #+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
2465 #+PRIORITIES: %c %c %c
2467 #+STARTUP: %s %s %s %s %s
2473 (buffer-name) (user-full-name) user-mail-address
2474 (format-time-string (car org-time-stamp-formats
))
2475 org-export-default-language
2476 org-export-headline-levels
2477 org-export-with-section-numbers
2479 org-export-preserve-breaks
2480 org-export-html-expand
2481 org-export-with-fixed-width
2482 org-export-with-tables
2483 org-export-with-sub-superscripts
2484 org-export-with-special-strings
2485 org-export-with-footnotes
2486 org-export-with-emphasize
2487 org-export-with-TeX-macros
2488 org-export-with-LaTeX-fragments
2489 org-export-skip-text-before-1st-heading
2490 org-export-with-drawers
2491 org-export-with-tags
2492 (if (featurep 'org-jsinfo
) (org-infojs-options-inbuffer-template) "")
2493 org-export-html-link-up
2494 org-export-html-link-home
2495 (file-name-nondirectory buffer-file-name
)
2496 "TODO FEEDBACK VERIFY DONE"
2497 "Me Jason Marie DONE"
2498 org-highest-priority org-lowest-priority org-default-priority
2499 (mapconcat 'identity org-drawers
" ")
2500 (cdr (assoc org-startup-folded
2501 '((nil .
"showall") (t .
"overview") (content .
"content"))))
2502 (if org-odd-levels-only
"odd" "oddeven")
2503 (if org-hide-leading-stars
"hidestars" "showstars")
2504 (if org-startup-align-all-tables
"align" "noalign")
2505 (cond ((eq org-log-done t
) "logdone")
2506 ((equal org-log-done
'note
) "lognotedone")
2507 ((not org-log-done
) "nologdone"))
2508 (or (mapconcat (lambda (x)
2510 ((equal '(:startgroup
) x
) "{")
2511 ((equal '(:endgroup
) x
) "}")
2512 ((cdr x
) (format "%s(%c)" (car x
) (cdr x
)))
2514 (or org-tag-alist
(org-get-buffer-tags)) " ") "")
2515 (mapconcat 'identity org-file-tags
" ")
2516 org-archive-location
2517 "org file:~/org/%s.org"
2520 (defun org-export-html-preprocess (parameters)
2521 ;; Convert LaTeX fragments to images
2522 (when (plist-get parameters
:LaTeX-fragments
)
2524 (concat "ltxpng/" (file-name-sans-extension
2525 (file-name-nondirectory
2526 org-current-export-file
)))
2527 org-current-export-dir nil
"Creating LaTeX image %s"))
2528 (message "Exporting..."))
2531 (defun org-insert-export-options-template ()
2532 "Insert into the buffer a template with information for exporting."
2534 (if (not (bolp)) (newline))
2535 (let ((s (org-get-current-options)))
2536 (and (string-match "#\\+CATEGORY" s
)
2537 (setq s
(substring s
0 (match-beginning 0))))
2541 (defun org-export-as-html-and-open (arg)
2542 "Export the outline as HTML and immediately open it with a browser.
2543 If there is an active region, export only the region.
2544 The prefix ARG specifies how many levels of the outline should become
2545 headlines. The default is 3. Lower levels will become bulleted lists."
2547 (org-export-as-html arg
'hidden
)
2548 (org-open-file buffer-file-name
))
2551 (defun org-export-as-html-batch ()
2552 "Call `org-export-as-html', may be used in batch processing as
2554 --load=$HOME/lib/emacs/org.el
2555 --eval \"(setq org-export-headline-levels 2)\"
2556 --visit=MyFile --funcall org-export-as-html-batch"
2557 (org-export-as-html org-export-headline-levels
'hidden
))
2560 (defun org-export-as-html-to-buffer (arg)
2561 "Call `org-exort-as-html` with output to a temporary buffer.
2562 No file is created. The prefix ARG is passed through to `org-export-as-html'."
2564 (org-export-as-html arg nil nil
"*Org HTML Export*")
2565 (switch-to-buffer-other-window "*Org HTML Export*"))
2568 (defun org-replace-region-by-html (beg end
)
2569 "Assume the current region has org-mode syntax, and convert it to HTML.
2570 This can be used in any buffer. For example, you could write an
2571 itemized list in org-mode syntax in an HTML buffer and then use this
2572 command to convert it."
2574 (let (reg html buf pop-up-frames
)
2575 (save-window-excursion
2577 (setq html
(org-export-region-as-html
2579 (setq reg
(buffer-substring beg end
)
2580 buf
(get-buffer-create "*Org tmp*"))
2581 (with-current-buffer buf
2585 (setq html
(org-export-region-as-html
2586 (point-min) (point-max) t
'string
)))
2588 (delete-region beg end
)
2592 (defun org-export-region-as-html (beg end
&optional body-only buffer
)
2593 "Convert region from BEG to END in org-mode buffer to HTML.
2594 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
2595 contents, and only produce the region of converted text, useful for
2596 cut-and-paste operations.
2597 If BUFFER is a buffer or a string, use/create that buffer as a target
2598 of the converted HTML. If BUFFER is the symbol `string', return the
2599 produced HTML as a string and leave not buffer behind. For example,
2600 a Lisp program could call this function in the following way:
2602 (setq html (org-export-region-as-html beg end t 'string))
2604 When called interactively, the output buffer is selected, and shown
2605 in a window. A non-interactive call will only return the buffer."
2606 (interactive "r\nP")
2607 (when (interactive-p)
2608 (setq buffer
"*Org HTML Export*"))
2609 (let ((transient-mark-mode t
) (zmacs-regions t
)
2612 (set-mark (point)) ;; to activate the region
2614 (setq rtn
(org-export-as-html
2617 (if (fboundp 'deactivate-mark
) (deactivate-mark))
2618 (if (and (interactive-p) (bufferp rtn
))
2619 (switch-to-buffer-other-window rtn
)
2622 (defvar html-table-tag nil
) ; dynamically scoped into this.
2624 (defun org-export-as-html (arg &optional hidden ext-plist
2625 to-buffer body-only pub-dir
)
2626 "Export the outline as a pretty HTML file.
2627 If there is an active region, export only the region. The prefix
2628 ARG specifies how many levels of the outline should become
2629 headlines. The default is 3. Lower levels will become bulleted
2630 lists. When HIDDEN is non-nil, don't display the HTML buffer.
2631 EXT-PLIST is a property list with external parameters overriding
2632 org-mode's default settings, but still inferior to file-local
2633 settings. When TO-BUFFER is non-nil, create a buffer with that
2634 name and export to that buffer. If TO-BUFFER is the symbol
2635 `string', don't leave any buffer behind but just return the
2636 resulting HTML as a string. When BODY-ONLY is set, don't produce
2637 the file header and footer, simply return the content of
2638 <body>...</body>, without even the body tags themselves. When
2639 PUB-DIR is set, use this as the publishing directory."
2642 ;; Make sure we have a file name when we need it.
2643 (when (and (not (or to-buffer body-only
))
2644 (not buffer-file-name
))
2645 (if (buffer-base-buffer)
2646 (org-set-local 'buffer-file-name
2647 (with-current-buffer (buffer-base-buffer)
2649 (error "Need a file name to be able to export.")))
2651 (message "Exporting...")
2652 (setq-default org-todo-line-regexp org-todo-line-regexp
)
2653 (setq-default org-deadline-line-regexp org-deadline-line-regexp
)
2654 (setq-default org-done-keywords org-done-keywords
)
2655 (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp
)
2657 (org-export-process-option-filters
2658 (org-combine-plists (org-default-export-plist)
2660 (org-infile-export-plist))))
2662 (style (concat org-export-html-style-default
2663 (plist-get opt-plist
:style
)
2664 (plist-get opt-plist
:style-extra
)))
2665 (html-extension (plist-get opt-plist
:html-extension
))
2666 (link-validate (plist-get opt-plist
:link-validation-function
))
2667 valid thetoc have-headings first-heading-pos
2668 (odd org-odd-levels-only
)
2669 (region-p (org-region-active-p))
2670 (rbeg (and region-p
(region-beginning)))
2671 (rend (and region-p
(region-end)))
2676 (and (org-at-heading-p)
2677 (>= (org-end-of-subtree t t
) rend
)))))
2678 (opt-plist (if subtree-p
2679 (org-export-add-subtree-options opt-plist rbeg
)
2681 ;; The following two are dynamically scoped into other
2683 (org-current-export-dir
2684 (or pub-dir
(org-export-directory :html opt-plist
)))
2685 (org-current-export-file buffer-file-name
)
2686 (level 0) (line "") (origline "") txt todo
2689 (filename (if to-buffer nil
2692 (file-name-sans-extension
2694 (org-entry-get (region-beginning)
2695 "EXPORT_FILE_NAME" t
))
2696 (file-name-nondirectory buffer-file-name
)))
2698 (file-name-as-directory
2699 (or pub-dir
(org-export-directory :html opt-plist
))))))
2700 (current-dir (if buffer-file-name
2701 (file-name-directory buffer-file-name
)
2703 (buffer (if to-buffer
2705 ((eq to-buffer
'string
) (get-buffer-create "*Org HTML Export*"))
2706 (t (get-buffer-create to-buffer
)))
2707 (find-file-noselect filename
)))
2708 (org-levels-open (make-vector org-level-max nil
))
2709 (date (plist-get opt-plist
:date
))
2710 (author (plist-get opt-plist
:author
))
2711 (title (or (and subtree-p
(org-export-get-title-from-subtree))
2712 (plist-get opt-plist
:title
)
2714 (plist-get opt-plist
:skip-before-1st-heading
))
2715 (org-export-grab-title-from-buffer))
2716 (and buffer-file-name
2717 (file-name-sans-extension
2718 (file-name-nondirectory buffer-file-name
)))
2720 (html-table-tag (plist-get opt-plist
:html-table-tag
))
2721 (quote-re0 (concat "^[ \t]*" org-quote-string
"\\>"))
2722 (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string
"\\>\\)"))
2727 (local-list-type nil
)
2728 (local-list-indent nil
)
2729 (llt org-plain-list-ordered-item-terminator
)
2730 (email (plist-get opt-plist
:email
))
2731 (language (plist-get opt-plist
:language
))
2735 (coding-system (and (boundp 'buffer-file-coding-system
)
2736 buffer-file-coding-system
))
2737 (coding-system-for-write (or org-export-html-coding-system
2739 (save-buffer-coding-system (or org-export-html-coding-system
2741 (charset (and coding-system-for-write
2742 (fboundp 'coding-system-get
)
2743 (coding-system-get coding-system-for-write
2747 (if region-p
(region-beginning) (point-min))
2748 (if region-p
(region-end) (point-max))))
2751 (org-export-preprocess-string
2755 :skip-before-1st-heading
2756 (plist-get opt-plist
:skip-before-1st-heading
)
2757 :drawers
(plist-get opt-plist
:drawers
)
2759 (plist-get opt-plist
:archived-trees
)
2761 (plist-get opt-plist
:text
)
2763 (plist-get opt-plist
:LaTeX-fragments
))
2766 table-buffer table-orig-buffer
2767 ind item-type starter didclose
2768 rpl path desc descp desc1 desc2 link
2769 snumber fnc item-tag
2772 (let ((inhibit-read-only t
))
2774 (remove-text-properties (point-min) (point-max)
2775 '(:org-license-to-kill t
))))
2777 (message "Exporting...")
2779 (setq org-min-level
(org-get-min-level lines
))
2780 (setq org-last-level org-min-level
)
2781 (org-init-section-numbers)
2784 ((and date
(string-match "%" date
))
2785 (setq date
(format-time-string date
)))
2787 (t (setq date
(format-time-string "%Y/%m/%d %X"))))
2789 ;; Get the language-dependent settings
2790 (setq lang-words
(or (assoc language org-export-language-setup
)
2791 (assoc "en" org-export-language-setup
)))
2793 ;; Switch to the output buffer
2795 (let ((inhibit-read-only t
)) (erase-buffer))
2798 (and (fboundp 'set-buffer-file-coding-system
)
2799 (set-buffer-file-coding-system coding-system-for-write
))
2801 (let ((case-fold-search nil
)
2802 (org-odd-levels-only odd
))
2803 ;; create local variables for all options, to make sure all called
2804 ;; functions get the correct information
2806 (set (make-local-variable (cdr x
))
2807 (plist-get opt-plist
(car x
))))
2808 org-export-plist-vars
)
2809 (setq umax
(if arg
(prefix-numeric-value arg
)
2810 org-export-headline-levels
))
2811 (setq umax-toc
(if (integerp org-export-with-toc
)
2812 (min org-export-with-toc umax
)
2817 "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
2818 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
2819 <html xmlns=\"http://www.w3.org/1999/xhtml\"
2820 lang=\"%s\" xml:lang=\"%s\">
2823 <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
2824 <meta name=\"generator\" content=\"Org-mode\"/>
2825 <meta name=\"generated\" content=\"%s\"/>
2826 <meta name=\"author\" content=\"%s\"/>
2830 language language
(org-html-expand title
)
2831 (or charset
"iso-8859-1") date author style
))
2833 (insert (or (plist-get opt-plist
:preamble
) ""))
2835 (when (plist-get opt-plist
:auto-preamble
)
2836 (if title
(insert (format org-export-html-title-format
2837 (org-html-expand title
))))))
2839 (if (and org-export-with-toc
(not body-only
))
2841 (push (format "<h%d>%s</h%d>\n"
2842 org-export-html-toplevel-hlevel
2844 org-export-html-toplevel-hlevel
)
2846 (push "<div id=\"text-table-of-contents\">\n" thetoc
)
2847 (push "<ul>\n<li>" thetoc
)
2849 (mapcar '(lambda (line)
2850 (if (string-match org-todo-line-regexp line
)
2851 ;; This is a headline
2853 (setq have-headings t
)
2854 (setq level
(- (match-end 1) (match-beginning 1))
2855 level
(org-tr-level level
)
2856 txt
(save-match-data
2858 (org-export-cleanup-toc-line
2859 (match-string 3 line
))))
2861 (or (and org-export-mark-todo-in-toc
2863 (not (member (match-string 2 line
)
2864 org-done-keywords
)))
2866 (and org-export-mark-todo-in-toc
2868 (org-search-todo-below
2869 line lines level
))))
2871 (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt
)
2872 (setq txt
(replace-match " <span class=\"tag\"> \\1</span>" t nil txt
)))
2873 (if (string-match quote-re0 txt
)
2874 (setq txt
(replace-match "" t t txt
)))
2875 (setq snumber
(org-section-number level
))
2876 (if org-export-with-section-numbers
2877 (setq txt
(concat snumber
" " txt
)))
2878 (if (<= level
(max umax umax-toc
))
2879 (setq head-count
(+ head-count
1)))
2880 (if (<= level umax-toc
)
2882 (if (> level org-last-level
)
2884 (setq cnt
(- level org-last-level
))
2885 (while (>= (setq cnt
(1- cnt
)) 0)
2886 (push "\n<ul>\n<li>" thetoc
))
2887 (push "\n" thetoc
)))
2888 (if (< level org-last-level
)
2890 (setq cnt
(- org-last-level level
))
2891 (while (>= (setq cnt
(1- cnt
)) 0)
2892 (push "</li>\n</ul>" thetoc
))
2893 (push "\n" thetoc
)))
2894 ;; Check for targets
2895 (while (string-match org-any-target-regexp line
)
2896 (setq line
(replace-match
2897 (concat "@<span class=\"target\">" (match-string 1 line
) "@</span> ")
2899 (while (string-match "<\\(<\\)+\\|>\\(>\\)+" txt
)
2900 (setq txt
(replace-match "" t t txt
)))
2904 "</li>\n<li><a href=\"#sec-%s\"><span class=\"todo\">%s</span></a>"
2905 "</li>\n<li><a href=\"#sec-%s\">%s</a>")
2906 snumber txt
) thetoc
)
2908 (setq org-last-level level
))
2912 (while (> org-last-level
(1- org-min-level
))
2913 (setq org-last-level
(1- org-last-level
))
2914 (push "</li>\n</ul>\n" thetoc
))
2915 (push "</div>\n" thetoc
)
2916 (setq thetoc
(if have-headings
(nreverse thetoc
) nil
))))
2919 (org-init-section-numbers)
2921 (while (setq line
(pop lines
) origline line
)
2924 ;; end of quote section?
2925 (when (and inquote
(string-match "^\\*+ " line
))
2928 ;; inside a quote section?
2930 (insert (org-html-protect line
) "\n")
2931 (throw 'nextline nil
))
2934 (when (and org-export-with-fixed-width
2935 (string-match "^[ \t]*:\\(.*\\)" line
))
2939 (insert (org-html-protect (match-string 1 line
)) "\n")
2940 (when (or (not lines
)
2941 (not (string-match "^[ \t]*\\(:.*\\)"
2944 (insert "</pre>\n"))
2945 (throw 'nextline nil
))
2948 (when (get-text-property 0 'org-protected line
)
2950 (when (re-search-backward
2951 "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t
)
2952 (setq par
(match-string 1))
2953 (replace-match "\\2\n"))
2956 (not (string-match "^[ \t]*:" (car lines
)))
2957 (or (= (length (car lines
)) 0)
2958 (get-text-property 0 'org-protected
(car lines
))))
2959 (insert (pop lines
) "\n"))
2960 (and par
(insert "<p>\n")))
2961 (throw 'nextline nil
))
2964 (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line
)
2965 (insert "\n<hr/>\n")
2966 (throw 'nextline nil
))
2968 ;; Blockquotes and verse
2969 (when (equal "ORG-BLOCKQUOTE-START" line
)
2970 (insert "<blockquote>\n<p>\n")
2971 (throw 'nextline nil
))
2972 (when (equal "ORG-BLOCKQUOTE-END" line
)
2973 (insert "</p>\n</blockquote>\n")
2974 (throw 'nextline nil
))
2975 (when (equal "ORG-VERSE-START" line
)
2976 (insert "\n<p class=\"verse\">\n")
2978 (throw 'nextline nil
))
2979 (when (equal "ORG-VERSE-END" line
)
2982 (throw 'nextline nil
))
2984 (setq i
(org-get-string-indentation line
))
2986 (setq line
(concat (mapconcat 'identity
2987 (make-list (* 2 i
) "\\nbsp") "")
2988 " " (org-trim line
))))
2989 (setq line
(concat line
" \\\\")))
2991 ;; make targets to anchors
2992 (while (string-match "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line
)
2995 (setq line
(replace-match
2996 (concat "@<a name=\""
2997 (org-solidify-link-text (match-string 1 line
))
3000 ((and org-export-with-toc
(equal (string-to-char line
) ?
*))
3001 ;; FIXME: NOT DEPENDENT on TOC?????????????????????
3002 (setq line
(replace-match
3003 (concat "@<span class=\"target\">" (match-string 1 line
) "@</span> ")
3004 ; (concat "@<i>" (match-string 1 line) "@</i> ")
3007 (setq line
(replace-match
3008 (concat "@<a name=\""
3009 (org-solidify-link-text (match-string 1 line
))
3010 "\" class=\"target\">" (match-string 1 line
) "@</a> ")
3013 (setq line
(org-html-handle-time-stamps line
))
3015 ;; replace "&" by "&", "<" and ">" by "<" and ">"
3016 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
3017 ;; Also handle sub_superscripts and checkboxes
3018 (or (string-match org-table-hline-regexp line
)
3019 (setq line
(org-html-expand line
)))
3023 (while (string-match org-bracket-link-analytic-regexp line start
)
3024 (setq start
(match-beginning 0))
3025 (setq path
(match-string 3 line
))
3027 ((match-end 2) (match-string 2 line
))
3029 (or (file-name-absolute-p path
)
3030 (string-match "^\\.\\.?/" path
)))
3033 (setq desc1
(if (match-end 5) (match-string 5 line
))
3034 desc2
(if (match-end 2) (concat type
":" path
) path
)
3035 descp
(and desc1
(not (equal desc1 desc2
)))
3036 desc
(or desc1 desc2
))
3037 ;; Make an image out of the description if that is so wanted
3038 (when (and descp
(org-file-image-p desc
))
3040 (if (string-match "^file:" desc
)
3041 (setq desc
(substring desc
(match-end 0)))))
3042 (setq desc
(concat "<img src=\"" desc
"\"/>")))
3043 ;; FIXME: do we need to unescape here somewhere?
3045 ((equal type
"internal")
3049 (org-solidify-link-text
3050 (save-match-data (org-link-unescape path
)) nil
)
3051 "\">" desc
"</a>")))
3052 ((member type
'("http" "https"))
3053 ;; standard URL, just check if we need to inline an image
3054 (if (and (or (eq t org-export-html-inline-images
)
3055 (and org-export-html-inline-images
(not descp
)))
3056 (org-file-image-p path
))
3057 (setq rpl
(concat "<img src=\"" type
":" path
"\"/>"))
3058 (setq link
(concat type
":" path
))
3059 (setq rpl
(concat "<a href=\"" link
"\">" desc
"</a>"))))
3060 ((member type
'("ftp" "mailto" "news"))
3062 (setq link
(concat type
":" path
))
3063 (setq rpl
(concat "<a href=\"" link
"\">" desc
"</a>")))
3065 ((functionp (setq fnc
(nth 2 (assoc type org-link-protocols
))))
3066 ;; The link protocol has a function for format the link
3069 (funcall fnc
(org-link-unescape path
) desc1
'html
))))
3071 ((string= type
"file")
3073 (let* ((filename path
)
3074 (abs-p (file-name-absolute-p filename
))
3075 thefile file-is-image-p search
)
3077 (if (string-match "::\\(.*\\)" filename
)
3078 (setq search
(match-string 1 filename
)
3079 filename
(replace-match "" t nil filename
)))
3081 (if (functionp link-validate
)
3082 (funcall link-validate filename current-dir
)
3084 (setq file-is-image-p
(org-file-image-p filename
))
3085 (setq thefile
(if abs-p
(expand-file-name filename
) filename
))
3086 (when (and org-export-html-link-org-files-as-html
3087 (string-match "\\.org$" thefile
))
3088 (setq thefile
(concat (substring thefile
0
3089 (match-beginning 0))
3090 "." html-extension
))
3092 ;; make sure this is can be used as target search
3093 (not (string-match "^[0-9]*$" search
))
3094 (not (string-match "^\\*" search
))
3095 (not (string-match "^/.*/$" search
)))
3096 (setq thefile
(concat thefile
"#"
3097 (org-solidify-link-text
3098 (org-link-unescape search
)))))
3099 (when (string-match "^file:" desc
)
3100 (setq desc
(replace-match "" t t desc
))
3101 (if (string-match "\\.org$" desc
)
3102 (setq desc
(replace-match "" t t desc
))))))
3103 (setq rpl
(if (and file-is-image-p
3104 (or (eq t org-export-html-inline-images
)
3105 (and org-export-html-inline-images
3107 (concat "<img src=\"" thefile
"\"/>")
3108 (concat "<a href=\"" thefile
"\">" desc
"</a>")))
3109 (if (not valid
) (setq rpl desc
))))
3112 ;; just publish the path, as default
3113 (setq rpl
(concat "<i><" type
":"
3114 (save-match-data (org-link-unescape path
))
3116 (setq line
(replace-match rpl t t line
)
3117 start
(+ start
(length rpl
))))
3120 (if (and (string-match org-todo-line-regexp line
)
3121 (match-beginning 2))
3124 (concat (substring line
0 (match-beginning 2))
3126 (if (member (match-string 2 line
)
3129 "\">" (match-string 2 line
)
3130 "</span>" (substring line
(match-end 2)))))
3132 ;; Does this contain a reference to a footnote?
3133 (when org-export-with-footnotes
3135 (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start
)
3136 (if (get-text-property (match-beginning 2) 'org-protected line
)
3137 (setq start
(match-end 2))
3138 (let ((n (match-string 2 line
)))
3142 "%s<sup><a class=\"footref\" name=\"fnr.%s\" href=\"#fn.%s\">%s</a></sup>"
3143 (match-string 1 line
) n n n
)
3147 ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line
)
3148 ;; This is a headline
3149 (setq level
(org-tr-level (- (match-end 1) (match-beginning 1)))
3150 txt
(match-string 2 line
))
3151 (if (string-match quote-re0 txt
)
3152 (setq txt
(replace-match "" t t txt
)))
3153 (if (<= level
(max umax umax-toc
))
3154 (setq head-count
(+ head-count
1)))
3156 ;; Close any local lists before inserting a new header line
3157 (while local-list-type
3158 (org-close-li (car local-list-type
))
3159 (insert (format "</%sl>\n" (car local-list-type
)))
3160 (pop local-list-type
))
3161 (setq local-list-indent nil
3163 (setq first-heading-pos
(or first-heading-pos
(point)))
3164 (org-html-level-start level txt umax
3165 (and org-export-with-toc
(<= level umax
))
3168 (when (string-match quote-re line
)
3172 ((and org-export-with-tables
3173 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line
))
3174 (if (not table-open
)
3176 (setq table-open t table-buffer nil table-orig-buffer nil
))
3178 (setq table-buffer
(cons line table-buffer
)
3179 table-orig-buffer
(cons origline table-orig-buffer
))
3180 (when (or (not lines
)
3181 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
3183 (setq table-open nil
3184 table-buffer
(nreverse table-buffer
)
3185 table-orig-buffer
(nreverse table-orig-buffer
))
3186 (org-close-par-maybe)
3187 (insert (org-format-table-html table-buffer table-orig-buffer
))))
3192 ((eq llt t
) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
3193 ((= llt ?.
) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
3194 ((= llt ?\
)) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+)\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
3195 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))
3197 (setq ind
(org-get-string-indentation line
)
3198 item-type
(if (match-beginning 4) "o" "u")
3199 starter
(if (match-beginning 2)
3200 (substring (match-string 2 line
) 0 -
1))
3201 line
(substring line
(match-beginning 5))
3203 (if (and starter
(string-match "\\(.*?\\) ::[ \t]*" line
))
3205 item-tag
(match-string 1 line
)
3206 line
(substring line
(match-end 0))))
3207 (when (and (not (equal item-type
"d"))
3208 (not (string-match "[^ \t]" line
)))
3209 ;; empty line. Pretend indentation is large.
3210 (setq ind
(if org-empty-line-terminates-plain-lists
3212 (1+ (or (car local-list-indent
) 1)))))
3214 (while (and in-local-list
3215 (or (and (= ind
(car local-list-indent
))
3217 (< ind
(car local-list-indent
))))
3219 (org-close-li (car local-list-type
))
3220 (insert (format "</%sl>\n" (car local-list-type
)))
3221 (pop local-list-type
) (pop local-list-indent
)
3222 (setq in-local-list local-list-indent
))
3225 (or (not in-local-list
)
3226 (> ind
(car local-list-indent
))))
3227 ;; Start new (level of) list
3228 (org-close-par-maybe)
3230 ((equal item-type
"u") "<ul>\n<li>\n")
3231 ((equal item-type
"o") "<ol>\n<li>\n")
3232 ((equal item-type
"d")
3233 (format "<dl>\n<dt>%s</dt><dd>\n" item-tag
))))
3234 (push item-type local-list-type
)
3235 (push ind local-list-indent
)
3236 (setq in-local-list t
))
3238 ;; continue current list
3239 (org-close-li (car local-list-type
))
3241 ((equal (car local-list-type
) "d")
3242 (format "<dt>%s</dt><dd>\n" (or item-tag
"???")))
3245 ;; we did close a list, normal text follows: need <p>
3247 (if (string-match "^[ \t]*\\[\\([X ]\\)\\]" line
)
3250 (if (equal (match-string 1 line
) "X")
3252 "<b>[<span style=\"visibility:hidden;\">X</span>]</b>")
3255 ;; Empty lines start a new paragraph. If hand-formatted lists
3256 ;; are not fully interpreted, lines starting with "-", "+", "*"
3257 ;; also start a new paragraph.
3258 (if (string-match "^ [-+*]-\\|^[ \t]*$" line
) (org-open-par))
3260 ;; Is this the start of a footnote?
3261 (when org-export-with-footnotes
3262 (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line
)
3263 (org-close-par-maybe)
3264 (let ((n (match-string 1 line
)))
3265 (setq line
(replace-match
3266 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n
) t t line
))
3267 (setq line
(concat line
"</p>")))))
3269 ;; Check if the line break needs to be conserved
3271 ((string-match "\\\\\\\\[ \t]*$" line
)
3272 (setq line
(replace-match "<br/>" t t line
)))
3273 (org-export-preserve-breaks
3274 (setq line
(concat line
"<br/>"))))
3276 (insert line
"\n")))))
3278 ;; Properly close all local lists and other lists
3279 (when inquote
(insert "</pre>\n"))
3281 ;; Close any local lists before inserting a new header line
3282 (while local-list-type
3283 (org-close-li (car local-list-type
))
3284 (insert (format "</%sl>\n" (car local-list-type
)))
3285 (pop local-list-type
))
3286 (setq local-list-indent nil
3288 (org-html-level-start 1 nil umax
3289 (and org-export-with-toc
(<= level umax
))
3291 ;; the </div> to lose the last text-... div.
3295 (when (plist-get opt-plist
:auto-postamble
)
3296 (insert "<div id=\"postamble\">")
3297 (when (and org-export-author-info author
)
3298 (insert "<p class=\"author\"> "
3299 (nth 1 lang-words
) ": " author
"\n")
3301 (if (listp (split-string email
",+ *"))
3303 (insert "<a href=\"mailto:" e
"\"><"
3305 (split-string email
",+ *"))
3306 (insert "<a href=\"mailto:" email
"\"><"
3307 email
"></a>\n")))
3309 (when (and date org-export-time-stamp-file
)
3310 (insert "<p class=\"date\"> "
3311 (nth 2 lang-words
) ": "
3313 (when org-export-creator-info
3314 (insert (format "<p>HTML generated by org-mode %s in emacs %s<\p>\n"
3315 org-version emacs-major-version
)))
3318 (if org-export-html-with-timestamp
3319 (insert org-export-html-html-helper-timestamp
))
3320 (insert (or (plist-get opt-plist
:postamble
) ""))
3321 (insert "</body>\n</html>\n"))
3324 (if (eq major-mode default-major-mode
) (html-mode))
3326 ;; insert the table of contents
3327 (goto-char (point-min))
3329 (if (or (re-search-forward
3330 "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t
)
3332 "\\[TABLE-OF-CONTENTS\\]" nil t
))
3334 (goto-char (match-beginning 0))
3336 (goto-char first-heading-pos
)
3337 (when (looking-at "\\s-*</p>")
3338 (goto-char (match-end 0))
3340 (insert "<div id=\"table-of-contents\">\n")
3341 (mapc 'insert thetoc
)
3342 (insert "</div>\n"))
3343 ;; remove empty paragraphs and lists
3344 (goto-char (point-min))
3345 (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t
)
3347 (goto-char (point-min))
3348 (while (re-search-forward "<li>[ \r\n\t]*</li>\n?" nil t
)
3350 (goto-char (point-min))
3351 (while (re-search-forward "</ul>\\s-*<ul>\n?" nil t
)
3353 ;; Convert whitespace place holders
3354 (goto-char (point-min))
3356 (while (setq beg
(next-single-property-change (point) 'org-whitespace
))
3357 (setq n
(get-text-property beg
'org-whitespace
)
3358 end
(next-single-property-change beg
'org-whitespace
))
3360 (delete-region beg end
)
3361 (insert (format "<span style=\"visibility:hidden;\">%s</span>"
3362 (make-string n ?x
)))))
3363 (or to-buffer
(save-buffer))
3364 (goto-char (point-min))
3365 (message "Exporting... done")
3366 (if (eq to-buffer
'string
)
3367 (prog1 (buffer-substring (point-min) (point-max))
3368 (kill-buffer (current-buffer)))
3369 (current-buffer)))))
3371 (defvar org-table-colgroup-info nil
)
3372 (defun org-format-table-ascii (lines)
3373 "Format a table for ascii export."
3375 (setq lines
(org-split-string lines
"\n")))
3376 (if (not (string-match "^[ \t]*|" (car lines
)))
3377 ;; Table made by table.el - test for spanning
3380 ;; A normal org table
3381 ;; Get rid of hlines at beginning and end
3382 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
3383 (setq lines
(nreverse lines
))
3384 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
3385 (setq lines
(nreverse lines
))
3386 (when org-export-table-remove-special-lines
3387 ;; Check if the table has a marking column. If yes remove the
3388 ;; column and the special lines
3389 (setq lines
(org-table-clean-before-export lines
)))
3390 ;; Get rid of the vertical lines except for grouping
3391 (let ((vl (org-colgroup-info-to-vline-list org-table-colgroup-info
))
3393 (while (setq line
(pop lines
))
3394 (if (string-match org-table-hline-regexp line
)
3395 (and (string-match "|\\(.*\\)|" line
)
3396 (setq line
(replace-match " \\1" t nil line
)))
3397 (setq start
0 vl1 vl
)
3398 (while (string-match "|" line start
)
3399 (setq start
(match-end 0))
3400 (or (pop vl1
) (setq line
(replace-match " " t t line
)))))
3404 (defun org-colgroup-info-to-vline-list (info)
3407 (setq last new new
(pop info
))
3408 (if (or (memq last
'(:end
:startend
))
3409 (memq new
'(:start
:startend
)))
3412 (setq vl
(nreverse vl
))
3413 (and vl
(setcar vl nil
))
3416 (defvar org-table-number-regexp
) ; defined in org-table.el
3417 (defun org-format-table-html (lines olines
)
3418 "Find out which HTML converter to use and return the HTML code."
3420 (setq lines
(org-split-string lines
"\n")))
3421 (if (string-match "^[ \t]*|" (car lines
))
3422 ;; A normal org table
3423 (org-format-org-table-html lines
)
3424 ;; Table made by table.el - test for spanning
3425 (let* ((hlines (delq nil
(mapcar
3427 (if (string-match "^[ \t]*\\+-" x
) x
3430 (first (car hlines
))
3431 (ll (and (string-match "\\S-+" first
)
3432 (match-string 0 first
)))
3433 (re (concat "^[ \t]*" (regexp-quote ll
)))
3434 (spanning (delq nil
(mapcar (lambda (x) (not (string-match re x
)))
3436 (if (and (not spanning
)
3437 (not org-export-prefer-native-exporter-for-tables
))
3438 ;; We can use my own converter with HTML conversions
3439 (org-format-table-table-html lines
)
3440 ;; Need to use the code generator in table.el, with the original text.
3441 (org-format-table-table-html-using-table-generate-source olines
)))))
3443 (defvar org-table-number-fraction
) ; defined in org-table.el
3444 (defun org-format-org-table-html (lines &optional splice
)
3445 "Format a table into HTML."
3446 (require 'org-table
)
3447 ;; Get rid of hlines at beginning and end
3448 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
3449 (setq lines
(nreverse lines
))
3450 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
3451 (setq lines
(nreverse lines
))
3452 (when org-export-table-remove-special-lines
3453 ;; Check if the table has a marking column. If yes remove the
3454 ;; column and the special lines
3455 (setq lines
(org-table-clean-before-export lines
)))
3457 (let ((head (and org-export-highlight-first-table-line
3459 (lambda (x) (string-match "^[ \t]*|-" x
))
3462 tbopen line fields html gr colgropen
)
3463 (if splice
(setq head nil
))
3464 (unless splice
(push (if head
"<thead>" "<tbody>") html
))
3466 (while (setq line
(pop lines
))
3468 (if (string-match "^[ \t]*|-" line
)
3471 (push (if head
"</thead>" "</tbody>") html
)
3472 (if lines
(push "<tbody>" html
) (setq tbopen nil
)))
3473 (setq head nil
) ;; head ends here, first time around
3475 (throw 'next-line t
)))
3476 ;; Break the line into fields
3477 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
3478 (unless fnum
(setq fnum
(make-vector (length fields
) 0)))
3479 (setq nlines
(1+ nlines
) i -
1)
3480 (push (concat "<tr>"
3484 (if (and (< i nlines
)
3485 (string-match org-table-number-regexp x
))
3486 (incf (aref fnum i
)))
3488 (concat (car org-export-table-header-tags
) x
3489 (cdr org-export-table-header-tags
))
3490 (concat (car org-export-table-data-tags
) x
3491 (cdr org-export-table-data-tags
))))
3495 (unless splice
(if tbopen
(push "</tbody>" html
)))
3496 (unless splice
(push "</table>\n" html
))
3497 (setq html
(nreverse html
))
3499 ;; Put in col tags with the alignment (unfortuntely often ignored...)
3502 (setq gr
(pop org-table-colgroup-info
))
3503 (format "%s<col align=\"%s\"></col>%s"
3504 (if (memq gr
'(:start
:startend
))
3506 (if colgropen
"</colgroup>\n<colgroup>" "<colgroup>")
3509 (if (> (/ (float x
) nlines
) org-table-number-fraction
)
3511 (if (memq gr
'(:end
:startend
))
3512 (progn (setq colgropen nil
) "</colgroup>")
3516 (if colgropen
(setq html
(cons (car html
) (cons "</colgroup>" (cdr html
)))))
3517 (push html-table-tag html
))
3518 (concat (mapconcat 'identity html
"\n") "\n")))
3520 (defun org-table-clean-before-export (lines)
3521 "Check if the table has a marking column.
3522 If yes remove the column and the special lines."
3523 (setq org-table-colgroup-info nil
)
3526 (lambda (x) (or (string-match "^[ \t]*|-" x
)
3527 (string-match "^[ \t]*| *\\([#!$*_^ /]\\) *|" x
)))
3530 (setq org-table-clean-did-remove-column nil
)
3535 ((string-match "^[ \t]*| */ *|" x
)
3536 (setq org-table-colgroup-info
3538 (cond ((member x
'("<" "<")) :start
)
3539 ((member x
'(">" ">")) :end
)
3540 ((member x
'("<>" "<>")) :startend
)
3542 (org-split-string x
"[ \t]*|[ \t]*")))
3546 (setq org-table-clean-did-remove-column t
)
3551 ((string-match "^[ \t]*| */ *|" x
)
3552 (setq org-table-colgroup-info
3554 (cond ((member x
'("<" "<")) :start
)
3555 ((member x
'(">" ">")) :end
)
3556 ((member x
'("<>" "<>")) :startend
)
3558 (cdr (org-split-string x
"[ \t]*|[ \t]*"))))
3560 ((string-match "^[ \t]*| *[!_^/] *|" x
)
3561 nil
) ; ignore this line
3562 ((or (string-match "^\\([ \t]*\\)|-+\\+" x
)
3563 (string-match "^\\([ \t]*\\)|[^|]*|" x
))
3564 ;; remove the first column
3565 (replace-match "\\1|" t nil x
))))
3568 (defun org-format-table-table-html (lines)
3569 "Format a table generated by table.el into HTML.
3570 This conversion does *not* use `table-generate-source' from table.el.
3571 This has the advantage that Org-mode's HTML conversions can be used.
3572 But it has the disadvantage, that no cell- or row-spanning is allowed."
3573 (let (line field-buffer
3574 (head org-export-highlight-first-table-line
)
3576 (setq html
(concat html-table-tag
"\n"))
3577 (while (setq line
(pop lines
))
3578 (setq empty
" ")
3580 (if (string-match "^[ \t]*\\+-" line
)
3591 (if (equal x
"") (setq x empty
))
3593 (concat (car org-export-table-header-tags
) x
3594 (cdr org-export-table-header-tags
))
3595 (concat (car org-export-table-data-tags
) x
3596 (cdr org-export-table-data-tags
))))
3600 (setq field-buffer nil
)))
3602 (throw 'next-line t
)))
3603 ;; Break the line into fields and store the fields
3604 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
3606 (setq field-buffer
(mapcar
3608 (concat x
"<br/>" (pop fields
)))
3610 (setq field-buffer fields
))))
3611 (setq html
(concat html
"</table>\n"))
3614 (defun org-format-table-table-html-using-table-generate-source (lines)
3615 "Format a table into html, using `table-generate-source' from table.el.
3616 This has the advantage that cell- or row-spanning is allowed.
3617 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
3619 (with-current-buffer (get-buffer-create " org-tmp1 ")
3621 (insert (mapconcat 'identity lines
"\n"))
3622 (goto-char (point-min))
3623 (if (not (re-search-forward "|[^+]" nil t
))
3624 (error "Error processing table"))
3625 (table-recognize-table)
3626 (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
3627 (table-generate-source 'html
" org-tmp2 ")
3628 (set-buffer " org-tmp2 ")
3629 (buffer-substring (point-min) (point-max))))
3631 (defun org-export-splice-style (style extra
)
3632 "Splice EXTRA into STYLE, just before \"</style>\"."
3633 (if (and (stringp extra
)
3634 (string-match "\\S-" extra
)
3635 (string-match "</style>" style
))
3636 (concat (substring style
0 (match-beginning 0))
3638 (substring style
(match-beginning 0)))
3641 (defun org-html-handle-time-stamps (s)
3642 "Format time stamps in string S, or remove them."
3645 (while (string-match org-maybe-keyword-time-regexp s
)
3646 (if (and (match-end 1) (equal (match-string 1 s
) org-clock-string
))
3647 ;; never export CLOCK
3649 (or b
(setq b
(substring s
0 (match-beginning 0))))
3650 (if (not org-export-with-timestamps
)
3651 (setq r
(concat r
(substring s
0 (match-beginning 0)))
3652 s
(substring s
(match-end 0)))
3654 r
(substring s
0 (match-beginning 0))
3656 (format "@<span class=\"timestamp-kwd\">%s @</span>"
3657 (match-string 1 s
)))
3658 (format " @<span class=\"timestamp\">%s@</span>"
3660 (org-translate-time (match-string 3 s
)) 1 -
1)))
3661 s
(substring s
(match-end 0)))))
3662 ;; Line break if line started and ended with time stamp stuff
3665 (setq r
(concat r s
))
3666 (unless (string-match "\\S-" (concat b s
))
3667 (setq r
(concat r
"@<br/>")))
3670 (defun org-export-htmlize-region-for-paste (beg end
)
3671 "Convert the region to HTML, using htmlize.el.
3672 This is much like `htmlize-region-for-paste', only that it uses
3673 the settings define in the org-... variables."
3674 (let* ((htmlize-output-type org-export-htmlize-output-type
)
3675 (htmlize-css-name-prefix org-export-htmlize-css-font-prefix
)
3676 (htmlbuf (htmlize-region beg end
)))
3678 (with-current-buffer htmlbuf
3679 (buffer-substring (plist-get htmlize-buffer-places
'content-start
)
3680 (plist-get htmlize-buffer-places
'content-end
)))
3681 (kill-buffer htmlbuf
))))
3684 (defun org-export-htmlize-generate-css ()
3685 "Create the CSS for all font definitions in the current Emacs session.
3686 Use this to create face definitions in your CSS style file that can then
3687 be used by code snippets transformed by htmlize.
3688 This command just produces a buffer that contains class definitions for all
3689 faces used in the current Emacs session. You can copy and paste the ones you
3690 need into your CSS file.
3692 If you then set `org-export-htmlize-output-type' to `css', calls to
3693 the function `org-export-htmlize-region-for-paste' will produce code
3694 that uses these same face definitions."
3697 (and (get-buffer "*html*") (kill-buffer "*html*"))
3699 (let ((fl (face-list))
3700 (htmlize-css-name-prefix "org-")
3701 (htmlize-output-type 'css
)
3703 (while (setq f
(pop fl
)
3704 i
(and f
(face-attribute f
:inherit
)))
3705 (when (and (symbolp f
) (or (not i
) (not (listp i
))))
3706 (insert (org-add-props (copy-sequence "1") nil
'face f
))))
3707 (htmlize-region (point-min) (point-max))))
3708 (switch-to-buffer "*html*")
3709 (goto-char (point-min))
3710 (if (re-search-forward "<style" nil t
)
3711 (delete-region (point-min) (match-beginning 0)))
3712 (if (re-search-forward "</style>" nil t
)
3713 (delete-region (1+ (match-end 0)) (point-max)))
3714 (beginning-of-line 1)
3715 (if (looking-at " +") (replace-match ""))
3716 (goto-char (point-min)))
3718 (defun org-html-protect (s)
3719 ;; convert & to &, < to < and > to >
3721 (while (string-match "&" s start
)
3722 (setq s
(replace-match "&" t t s
)
3723 start
(1+ (match-beginning 0))))
3724 (while (string-match "<" s
)
3725 (setq s
(replace-match "<" t t s
)))
3726 (while (string-match ">" s
)
3727 (setq s
(replace-match ">" t t s
))))
3730 (defun org-export-cleanup-toc-line (s)
3731 "Remove tags and time staps from lines going into the toc."
3732 (when (memq org-export-with-tags
'(not-in-toc nil
))
3733 (if (string-match (org-re " +:[[:alnum:]_@:]+: *$") s
)
3734 (setq s
(replace-match "" t t s
))))
3735 (when org-export-remove-timestamps-from-toc
3736 (while (string-match org-maybe-keyword-time-regexp s
)
3737 (setq s
(replace-match "" t t s
))))
3738 (while (string-match org-bracket-link-regexp s
)
3739 (setq s
(replace-match (match-string (if (match-end 3) 3 1) s
)
3743 (defun org-html-expand (string)
3744 "Prepare STRING for HTML export. Applies all active conversions.
3745 If there are links in the string, don't modify these."
3746 (let* ((re (concat org-bracket-link-regexp
"\\|"
3747 (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$")))
3749 (while (setq m
(string-match re string
))
3750 (setq s
(substring string
0 m
)
3751 l
(match-string 0 string
)
3752 string
(substring string
(match-end 0)))
3753 (push (org-html-do-expand s
) res
)
3755 (push (org-html-do-expand string
) res
)
3756 (apply 'concat
(nreverse res
))))
3758 (defun org-html-do-expand (s)
3759 "Apply all active conversions to translate special ASCII to HTML."
3760 (setq s
(org-html-protect s
))
3761 (if org-export-html-expand
3763 (while (string-match "@<\\([^&]*\\)>" s
)
3764 (setq s
(replace-match "<\\1>" t nil s
)))))
3765 (if org-export-with-emphasize
3766 (setq s
(org-export-html-convert-emphasize s
)))
3767 (if org-export-with-special-strings
3768 (setq s
(org-export-html-convert-special-strings s
)))
3769 (if org-export-with-sub-superscripts
3770 (setq s
(org-export-html-convert-sub-super s
)))
3771 (if org-export-with-TeX-macros
3772 (let ((start 0) wd ass
)
3773 (while (setq start
(string-match "\\\\\\([a-zA-Z]+\\)" s start
))
3774 (if (get-text-property (match-beginning 0) 'org-protected s
)
3775 (setq start
(match-end 0))
3776 (setq wd
(match-string 1 s
))
3777 (if (setq ass
(assoc wd org-html-entities
))
3778 (setq s
(replace-match (or (cdr ass
)
3779 (concat "&" (car ass
) ";"))
3781 (setq start
(+ start
(length wd
))))))))
3784 (defun org-create-multibrace-regexp (left right n
)
3785 "Create a regular expression which will match a balanced sexp.
3786 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
3787 as single character strings.
3788 The regexp returned will match the entire expression including the
3789 delimiters. It will also define a single group which contains the
3790 match except for the outermost delimiters. The maximum depth of
3791 stacked delimiters is N. Escaping delimiters is not possible."
3792 (let* ((nothing (concat "[^" "\\" left
"\\" right
"]*?"))
3795 (next (concat "\\(?:" nothing left nothing right
"\\)+" nothing
)))
3798 re
(concat re or next
)
3799 next
(concat "\\(?:" nothing left next right
"\\)+" nothing
)))
3800 (concat left
"\\(" re
"\\)" right
)))
3802 (defvar org-match-substring-regexp
3804 "\\([^\\]\\)\\([_^]\\)\\("
3805 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
3807 "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth
) "\\)"
3809 "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
3810 "The regular expression matching a sub- or superscript.")
3812 (defvar org-match-substring-with-braces-regexp
3814 "\\([^\\]\\)\\([_^]\\)\\("
3815 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
3817 "The regular expression matching a sub- or superscript, forcing braces.")
3819 (defconst org-export-html-special-string-regexps
3820 '(("\\\\-" .
"­")
3821 ("---\\([^-]\\)" .
"—\\1")
3822 ("--\\([^-]\\)" .
"–\\1")
3823 ("\\.\\.\\." .
"…"))
3824 "Regular expressions for special string conversion.")
3826 (defun org-export-html-convert-special-strings (string)
3827 "Convert special characters in STRING to HTML."
3828 (let ((all org-export-html-special-string-regexps
)
3830 (while (setq a
(pop all
))
3831 (setq re
(car a
) rpl
(cdr a
) start
0)
3832 (while (string-match re string start
)
3833 (if (get-text-property (match-beginning 0) 'org-protected string
)
3834 (setq start
(match-end 0))
3835 (setq string
(replace-match rpl t nil string
)))))
3838 (defun org-export-html-convert-sub-super (string)
3839 "Convert sub- and superscripts in STRING to HTML."
3840 (let (key c
(s 0) (requireb (eq org-export-with-sub-superscripts
'{})))
3841 (while (string-match org-match-substring-regexp string s
)
3843 ((and requireb
(match-end 8)) (setq s
(match-end 2)))
3844 ((get-text-property (match-beginning 2) 'org-protected string
)
3845 (setq s
(match-end 2)))
3847 (setq s
(match-end 1)
3848 key
(if (string= (match-string 2 string
) "_") "sub" "sup")
3849 c
(or (match-string 8 string
)
3850 (match-string 6 string
)
3851 (match-string 5 string
))
3852 string
(replace-match
3853 (concat (match-string 1 string
)
3854 "<" key
">" c
"</" key
">")
3856 (while (string-match "\\\\\\([_^]\\)" string
)
3857 (setq string
(replace-match (match-string 1 string
) t t string
)))
3860 (defun org-export-html-convert-emphasize (string)
3863 (while (string-match org-emph-re string s
)
3865 (substring string
(match-beginning 3) (1+ (match-beginning 3)))
3866 (substring string
(match-beginning 4) (1+ (match-beginning 4)))))
3867 (setq s
(match-beginning 0)
3870 (match-string 1 string
)
3871 (nth 2 (assoc (match-string 3 string
) org-emphasis-alist
))
3872 (match-string 4 string
)
3873 (nth 3 (assoc (match-string 3 string
)
3874 org-emphasis-alist
))
3875 (match-string 5 string
))
3876 string
(replace-match rpl t t string
)
3877 s
(+ s
(- (length rpl
) 2)))
3881 (defvar org-par-open nil
)
3882 (defun org-open-par ()
3883 "Insert <p>, but first close previous paragraph if any."
3884 (org-close-par-maybe)
3886 (setq org-par-open t
))
3887 (defun org-close-par-maybe ()
3888 "Close paragraph if there is one open."
3891 (setq org-par-open nil
)))
3892 (defun org-close-li (&optional type
)
3893 "Close <li> if necessary."
3894 (org-close-par-maybe)
3895 (insert (if (equal type
"d") "</dd>\n" "</li>\n")))
3897 (defvar body-only
) ; dynamically scoped into this.
3898 (defun org-html-level-start (level title umax with-toc head-count
)
3899 "Insert a new level in HTML export.
3900 When TITLE is nil, just close all open levels."
3901 (org-close-par-maybe)
3902 (let ((target (and title
(org-get-text-property-any 0 'target title
)))
3906 (if (aref org-levels-open
(1- l
))
3908 (org-html-level-close l umax
)
3909 (aset org-levels-open
(1- l
) nil
)))
3912 ;; If title is nil, this means this function is called to close
3913 ;; all levels, so the rest is done only if title is given
3914 (when (string-match (org-re "\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title
)
3915 (setq title
(replace-match
3916 (if org-export-with-tags
3919 " <span class=\"tag\">"
3920 (mapconcat 'identity
(org-split-string
3921 (match-string 1 title
) ":")
3928 (if (aref org-levels-open
(1- level
))
3932 (insert (format "<li id=\"%s\">" target
) title
"<br/>\n")
3933 (insert "<li>" title
"<br/>\n")))
3934 (aset org-levels-open
(1- level
) t
)
3935 (org-close-par-maybe)
3937 (insert (format "<ul>\n<li id=\"%s\">" target
)
3939 (insert "<ul>\n<li>" title
"<br/>\n"))))
3940 (aset org-levels-open
(1- level
) t
)
3941 (setq snumber
(org-section-number level
))
3942 (if (and org-export-with-section-numbers
(not body-only
))
3943 (setq title
(concat snumber
" " title
)))
3944 (setq level
(+ level org-export-html-toplevel-hlevel -
1))
3945 (unless (= head-count
1) (insert "\n</div>\n"))
3946 (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"
3947 snumber level level snumber title level snumber
))
3950 (defun org-get-text-property-any (pos prop
&optional object
)
3951 (or (get-text-property pos prop object
)
3952 (and (setq pos
(next-single-property-change pos prop object
))
3953 (get-text-property pos prop object
))))
3955 (defun org-html-level-close (level max-outline-level
)
3956 "Terminate one level in HTML export."
3957 (if (<= level max-outline-level
)
3960 (insert "</ul>\n")))
3962 ;;; iCalendar export
3965 (defun org-export-icalendar-this-file ()
3966 "Export current file as an iCalendar file.
3967 The iCalendar file will be located in the same directory as the Org-mode
3968 file, but with extension `.ics'."
3970 (org-export-icalendar nil buffer-file-name
))
3973 (defun org-export-icalendar-all-agenda-files ()
3974 "Export all files in `org-agenda-files' to iCalendar .ics files.
3975 Each iCalendar file will be located in the same directory as the Org-mode
3976 file, but with extension `.ics'."
3978 (apply 'org-export-icalendar nil
(org-agenda-files t
)))
3981 (defun org-export-icalendar-combine-agenda-files ()
3982 "Export all files in `org-agenda-files' to a single combined iCalendar file.
3983 The file is stored under the name `org-combined-agenda-icalendar-file'."
3985 (apply 'org-export-icalendar t
(org-agenda-files t
)))
3987 (defun org-export-icalendar (combine &rest files
)
3988 "Create iCalendar files for all elements of FILES.
3989 If COMBINE is non-nil, combine all calendar entries into a single large
3990 file and store it under the name `org-combined-agenda-icalendar-file'."
3992 (org-prepare-agenda-buffers files
)
3993 (let* ((dir (org-export-directory
3994 :ical
(list :publishing-directory
3995 org-export-publishing-directory
)))
3996 file ical-file ical-buffer category started org-agenda-new-buffers
)
3997 (and (get-buffer "*ical-tmp*") (kill-buffer "*ical-tmp*"))
4000 (if (file-name-absolute-p org-combined-agenda-icalendar-file
)
4001 org-combined-agenda-icalendar-file
4002 (expand-file-name org-combined-agenda-icalendar-file dir
))
4003 ical-buffer
(org-get-agenda-file-buffer ical-file
))
4004 (set-buffer ical-buffer
) (erase-buffer))
4005 (while (setq file
(pop files
))
4007 (org-check-agenda-file file
)
4008 (set-buffer (org-get-agenda-file-buffer file
))
4010 (setq ical-file
(concat (file-name-as-directory dir
)
4011 (file-name-sans-extension
4012 (file-name-nondirectory buffer-file-name
))
4014 (setq ical-buffer
(org-get-agenda-file-buffer ical-file
))
4015 (with-current-buffer ical-buffer
(erase-buffer)))
4016 (setq category
(or org-category
4017 (file-name-sans-extension
4018 (file-name-nondirectory buffer-file-name
))))
4019 (if (symbolp category
) (setq category
(symbol-name category
)))
4020 (let ((standard-output ical-buffer
))
4022 (and (not started
) (setq started t
)
4023 (org-start-icalendar-file org-icalendar-combined-name
))
4024 (org-start-icalendar-file category
))
4025 (org-print-icalendar-entries combine
)
4026 (when (or (and combine
(not files
)) (not combine
))
4027 (org-finish-icalendar-file)
4028 (set-buffer ical-buffer
)
4029 (run-hooks 'org-before-save-iCalendar-file-hook
)
4031 (run-hooks 'org-after-save-iCalendar-file-hook
)
4032 (and (boundp 'org-wait
) (numberp org-wait
) (sit-for org-wait
))
4034 (org-release-buffers org-agenda-new-buffers
))))
4036 (defvar org-before-save-iCalendar-file-hook nil
4037 "Hook run before an iCalendar file has been saved.
4038 This can be used to modify the result of the export.")
4040 (defvar org-after-save-iCalendar-file-hook nil
4041 "Hook run after an iCalendar file has been saved.
4042 The iCalendar buffer is still current when this hook is run.
4043 A good way to use this is to tell a desktop calenndar application to re-read
4044 the iCalendar file.")
4046 (defvar org-agenda-default-appointment-duration
) ; defined in org-agenda.el
4047 (defun org-print-icalendar-entries (&optional combine
)
4048 "Print iCalendar entries for the current Org-mode file to `standard-output'.
4049 When COMBINE is non nil, add the category to each line."
4050 (require 'org-agenda
)
4051 (let ((re1 (concat org-ts-regexp
"\\|<%%([^>\n]+>"))
4052 (re2 (concat "--?-?\\(" org-ts-regexp
"\\)"))
4053 (dts (org-ical-ts-to-string
4054 (format-time-string (cdr org-time-stamp-formats
) (current-time))
4056 hd ts ts2 state status
(inc t
) pos b sexp rrule
4057 scheduledp deadlinep todo prefix due start
4058 tmp pri category entry location summary desc uid
4059 (sexp-buffer (get-buffer-create "*ical-tmp*")))
4060 (org-refresh-category-properties)
4062 (goto-char (point-min))
4063 (while (re-search-forward re1 nil t
)
4066 (when (boundp 'org-icalendar-verify-function
)
4067 (unless (funcall org-icalendar-verify-function
)
4068 (outline-next-heading)
4071 (setq pos
(match-beginning 0)
4074 hd
(condition-case nil
4075 (org-icalendar-cleanup-string
4077 (error (throw :skip nil
)))
4078 summary
(org-icalendar-cleanup-string
4079 (org-entry-get nil
"SUMMARY"))
4080 desc
(org-icalendar-cleanup-string
4081 (or (org-entry-get nil
"DESCRIPTION")
4082 (and org-icalendar-include-body
(org-get-entry)))
4083 t org-icalendar-include-body
)
4084 location
(org-icalendar-cleanup-string
4085 (org-entry-get nil
"LOCATION"))
4086 uid
(if org-icalendar-store-UID
4088 (or (org-id-get) (org-id-new)))
4089 category
(org-get-category)
4090 deadlinep nil scheduledp nil
)
4091 (if (looking-at re2
)
4093 (goto-char (match-end 0))
4094 (setq ts2
(match-string 1)
4095 inc
(not (string-match "[0-9]\\{1,2\\}:[0-9][0-9]" ts2
))))
4096 (setq tmp
(buffer-substring (max (point-min)
4097 (- pos org-ds-keyword-length
))
4099 ts2
(if (string-match "[0-9]\\{1,2\\}:[0-9][0-9]-\\([0-9]\\{1,2\\}:[0-9][0-9]\\)" ts
)
4102 (replace-match "\\1" t nil ts
))
4104 deadlinep
(string-match org-deadline-regexp tmp
)
4105 scheduledp
(string-match org-scheduled-regexp tmp
)
4106 todo
(org-get-todo-state)
4107 ;; donep (org-entry-is-done-p)
4112 (not (memq 'event-if-todo org-icalendar-use-deadline
))
4113 (not (memq 'event-if-not-todo org-icalendar-use-deadline
))))
4118 (not (memq 'event-if-todo org-icalendar-use-scheduled
))
4119 (not (memq 'event-if-not-todo org-icalendar-use-scheduled
))))
4121 (setq prefix
(if deadlinep
"DL-" (if scheduledp
"SC-" "TS-")))
4122 (if (or (string-match org-tr-regexp hd
)
4123 (string-match org-ts-regexp hd
))
4124 (setq hd
(replace-match "" t t hd
)))
4125 (if (string-match "\\+\\([0-9]+\\)\\([dwmy]\\)>" ts
)
4127 (concat "\nRRULE:FREQ="
4130 '(("d" .
"DAILY")("w" .
"WEEKLY")
4131 ("m" .
"MONTHLY")("y" .
"YEARLY"))))
4132 ";INTERVAL=" (match-string 1 ts
)))
4134 (setq summary
(or summary hd
))
4135 (if (string-match org-bracket-link-regexp summary
)
4137 (replace-match (if (match-end 3)
4138 (match-string 3 summary
)
4139 (match-string 1 summary
))
4141 (if deadlinep
(setq summary
(concat "DL: " summary
)))
4142 (if scheduledp
(setq summary
(concat "S: " summary
)))
4143 (if (string-match "\\`<%%" ts
)
4144 (with-current-buffer sexp-buffer
4145 (insert (substring ts
1 -
1) " " summary
"\n"))
4146 (princ (format "BEGIN:VEVENT
4154 (org-ical-ts-to-string ts
"DTSTART")
4155 (org-ical-ts-to-string ts2
"DTEND" inc
)
4157 (if (and desc
(string-match "\\S-" desc
))
4158 (concat "\nDESCRIPTION: " desc
) "")
4159 (if (and location
(string-match "\\S-" location
))
4160 (concat "\nLOCATION: " location
) "")
4162 (when (and org-icalendar-include-sexps
4163 (condition-case nil
(require 'icalendar
) (error nil
))
4164 (fboundp 'icalendar-export-region
))
4165 ;; Get all the literal sexps
4166 (goto-char (point-min))
4167 (while (re-search-forward "^&?%%(" nil t
)
4170 (setq b
(match-beginning 0))
4171 (goto-char (1- (match-end 0)))
4174 (setq sexp
(buffer-substring b
(point)))
4175 (with-current-buffer sexp-buffer
4176 (insert sexp
"\n"))))
4177 (princ (org-diary-to-ical-string sexp-buffer
))
4178 (kill-buffer sexp-buffer
))
4180 (when org-icalendar-include-todo
4181 (setq prefix
"TODO-")
4182 (goto-char (point-min))
4183 (while (re-search-forward org-todo-line-regexp nil t
)
4186 (when (boundp 'org-icalendar-verify-function
)
4187 (unless (funcall org-icalendar-verify-function
)
4188 (outline-next-heading)
4191 (setq state
(match-string 2))
4192 (setq status
(if (member state org-done-keywords
)
4193 "COMPLETED" "NEEDS-ACTION"))
4195 (or (not (member state org-done-keywords
))
4196 (eq org-icalendar-include-todo
'all
))
4197 (not (member org-archive-tag
(org-get-tags-at)))
4199 (setq hd
(match-string 3)
4200 summary
(org-icalendar-cleanup-string
4201 (org-entry-get nil
"SUMMARY"))
4202 desc
(org-icalendar-cleanup-string
4203 (or (org-entry-get nil
"DESCRIPTION")
4204 (and org-icalendar-include-body
(org-get-entry)))
4205 t org-icalendar-include-body
)
4206 location
(org-icalendar-cleanup-string
4207 (org-entry-get nil
"LOCATION"))
4208 due
(and (member 'todo-due org-icalendar-use-deadline
)
4209 (org-entry-get nil
"DEADLINE"))
4210 start
(and (member 'todo-start org-icalendar-use-scheduled
)
4211 (org-entry-get nil
"SCHEDULED"))
4212 uid
(if org-icalendar-store-UID
4214 (or (org-id-get) (org-id-new))))
4215 (and due
(setq due
(org-ical-ts-to-string due
"DUE")))
4216 (and start
(setq start
(org-ical-ts-to-string start
"DTSTART")))
4218 (if (string-match org-bracket-link-regexp hd
)
4219 (setq hd
(replace-match (if (match-end 3) (match-string 3 hd
)
4220 (match-string 1 hd
))
4222 (if (string-match org-priority-regexp hd
)
4223 (setq pri
(string-to-char (match-string 2 hd
))
4224 hd
(concat (substring hd
0 (match-beginning 1))
4225 (substring hd
(match-end 1))))
4226 (setq pri org-default-priority
))
4227 (setq pri
(floor (1+ (* 8.
(/ (float (- org-lowest-priority pri
))
4228 (- org-lowest-priority org-highest-priority
))))))
4230 (princ (format "BEGIN:VTODO
4242 (if (and location
(string-match "\\S-" location
))
4243 (concat "\nLOCATION: " location
) "")
4244 (if (and desc
(string-match "\\S-" desc
))
4245 (concat "\nDESCRIPTION: " desc
) "")
4246 (if due
(concat "\n" due
) "")
4250 (defun org-icalendar-cleanup-string (s &optional is-body maxlength
)
4251 "Take out stuff and quote what needs to be quoted.
4252 When IS-BODY is non-nil, assume that this is the body of an item, clean up
4253 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
4258 (let ((re (concat "\\(" org-drawer-regexp
"\\)[^\000]*?:END:.*\n?"))
4259 (re2 (concat "^[ \t]*" org-keyword-time-regexp
".*\n?")))
4260 (while (string-match re s
) (setq s
(replace-match "" t t s
)))
4261 (while (string-match re2 s
) (setq s
(replace-match "" t t s
)))))
4263 (while (string-match "\\([,;]\\)" s start
)
4264 (setq start
(+ (match-beginning 0) 2)
4265 s
(replace-match "\\\\\\1" nil nil s
))))
4267 (while (string-match "[ \t]*\n[ \t]*" s
)
4268 (setq s
(replace-match "\\n" t t s
))))
4269 (setq s
(org-trim s
))
4272 (if (and (numberp maxlength
)
4273 (> (length s
) maxlength
))
4274 (setq s
(substring s
0 maxlength
)))))
4277 (defun org-get-entry ()
4278 "Clean-up description string."
4280 (org-back-to-heading t
)
4281 (buffer-substring (point-at-bol 2) (org-end-of-subtree t
))))
4283 (defun org-start-icalendar-file (name)
4284 "Start an iCalendar file by inserting the header."
4285 (let ((user user-full-name
)
4286 (name (or name
"unknown"))
4287 (timezone (cadr (current-time-zone))))
4289 (format "BEGIN:VCALENDAR
4292 PRODID:-//%s//Emacs with Org-mode//EN
4294 CALSCALE:GREGORIAN\n" name user timezone
))))
4296 (defun org-finish-icalendar-file ()
4297 "Finish an iCalendar file by inserting the END statement."
4298 (princ "END:VCALENDAR\n"))
4300 (defun org-ical-ts-to-string (s keyword
&optional inc
)
4301 "Take a time string S and convert it to iCalendar format.
4302 KEYWORD is added in front, to make a complete line like DTSTART....
4303 When INC is non-nil, increase the hour by two (if time string contains
4304 a time), or the day by one (if it does not contain a time)."
4305 (let ((t1 (org-parse-time-string s
'nodefault
))
4306 t2 fmt have-time time
)
4307 (if (and (car t1
) (nth 1 t1
) (nth 2 t1
))
4308 (setq t2 t1 have-time t
)
4309 (setq t2
(org-parse-time-string s
)))
4310 (let ((s (car t2
)) (mi (nth 1 t2
)) (h (nth 2 t2
))
4311 (d (nth 3 t2
)) (m (nth 4 t2
)) (y (nth 5 t2
)))
4314 (if org-agenda-default-appointment-duration
4315 (setq mi
(+ org-agenda-default-appointment-duration mi
))
4318 (setq time
(encode-time s mi h d m y
)))
4319 (setq fmt
(if have-time
":%Y%m%dT%H%M%S" ";VALUE=DATE:%Y%m%d"))
4320 (concat keyword
(format-time-string fmt time
))))
4324 (defun org-export-as-xoxo-insert-into (buffer &rest output
)
4325 (with-current-buffer buffer
4326 (apply 'insert output
)))
4327 (put 'org-export-as-xoxo-insert-into
'lisp-indent-function
1)
4330 (defun org-export-as-xoxo (&optional buffer
)
4331 "Export the org buffer as XOXO.
4332 The XOXO buffer is named *xoxo-<source buffer name>*"
4333 (interactive (list (current-buffer)))
4334 ;; A quickie abstraction
4336 ;; Output everything as XOXO
4337 (with-current-buffer (get-buffer buffer
)
4338 (let* ((pos (point))
4339 (opt-plist (org-combine-plists (org-default-export-plist)
4340 (org-infile-export-plist)))
4341 (filename (concat (file-name-as-directory
4342 (org-export-directory :xoxo opt-plist
))
4343 (file-name-sans-extension
4344 (file-name-nondirectory buffer-file-name
))
4346 (out (find-file-noselect filename
))
4349 (goto-char (point-min)) ;; CD: beginning-of-buffer is not allowed.
4350 ;; Check the output buffer is empty.
4351 (with-current-buffer out
(erase-buffer))
4352 ;; Kick off the output
4353 (org-export-as-xoxo-insert-into out
"<ol class='xoxo'>\n")
4354 (while (re-search-forward "^\\(\\*+\\)[ \t]+\\(.+\\)" (point-max) 't
)
4355 (let* ((hd (match-string-no-properties 1))
4358 (match-string-no-properties 2)
4360 (goto-char (match-end 0))
4365 (if (looking-at "^[ \t]\\(.*\\)")
4366 (setq str
(concat str
(match-string-no-properties 1)))
4367 (throw 'loop str
)))))))))
4369 ;; Handle level rendering
4371 ((> level last-level
)
4372 (org-export-as-xoxo-insert-into out
"\n<ol>\n"))
4374 ((< level last-level
)
4375 (dotimes (- (- last-level level
) 1)
4377 (org-export-as-xoxo-insert-into out
"</li>\n"))
4378 (org-export-as-xoxo-insert-into out
"</ol>\n"))
4380 (org-export-as-xoxo-insert-into out
"</li>\n")
4381 (setq hanging-li nil
)))
4383 ((equal level last-level
)
4385 (org-export-as-xoxo-insert-into out
"</li>\n")))
4388 (setq last-level level
)
4390 ;; And output the new li
4391 (setq hanging-li
't
)
4392 (if (equal ?
+ (elt text
0))
4393 (org-export-as-xoxo-insert-into out
"<li class='" (substring text
1) "'>")
4394 (org-export-as-xoxo-insert-into out
"<li>" text
))))
4396 ;; Finally finish off the ol
4397 (dotimes (- last-level
1)
4399 (org-export-as-xoxo-insert-into out
"</li>\n"))
4400 (org-export-as-xoxo-insert-into out
"</ol>\n"))
4403 ;; Finish the buffer off and clean it up.
4404 (switch-to-buffer-other-window out
)
4405 (indent-region (point-min) (point-max) nil
)
4407 (goto-char (point-min))
4412 ;; arch-tag: 65985fe9-095c-49c7-a7b6-cb4ee15c0a95
4414 ;;; org-exp.el ends here