Use LATEX_HEADER stuff also when previewing fragments
[org-mode.git] / lisp / org-exp.el
blobe8eb91f9f21ccf908b5ac9877b7175237fac8d43
1 ;;; org-exp.el --- ASCII, HTML, XOXO and iCalendar export for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 6.33trans
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;; Commentary:
29 (require 'org)
30 (require 'org-macs)
31 (require 'org-agenda)
32 (require 'org-exp-blocks)
33 (require 'org-src)
34 (eval-when-compile
35 (require 'cl))
37 (declare-function org-export-latex-preprocess "org-latex" (parameters))
38 (declare-function org-export-ascii-preprocess "org-ascii" (parameters))
39 (declare-function org-export-html-preprocess "org-html" (parameters))
40 (declare-function org-export-docbook-preprocess "org-docbook" (parameters))
41 (declare-function org-infojs-options-inbuffer-template "org-jsinfo" ())
42 (declare-function org-export-htmlize-region-for-paste "org-html" (beg end))
43 (declare-function htmlize-buffer "ext:htmlize" (&optional buffer))
44 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
45 (autoload 'org-export-generic "org-export-generic" "Export using the generic exporter" t)
46 (defgroup org-export nil
47 "Options for exporting org-listings."
48 :tag "Org Export"
49 :group 'org)
51 (defgroup org-export-general nil
52 "General options for exporting Org-mode files."
53 :tag "Org Export General"
54 :group 'org-export)
56 (defcustom org-export-allow-BIND 'confirm
57 "Non-nil means, allow #+BIND to define local variable values for export.
58 This is a potential security risk, which is why the user must confirm the
59 use of these lines."
60 :group 'org-export-general
61 :type '(choice
62 (const :tag "Never" nil)
63 (const :tag "Always" t)
64 (const :tag "Make the user confirm for each file" confirm)))
66 ;; FIXME
67 (defvar org-export-publishing-directory nil)
69 (defcustom org-export-show-temporary-export-buffer t
70 "Non-nil means, show buffer after exporting to temp buffer.
71 When Org exports to a file, the buffer visiting that file is ever
72 shown, but remains buried. However, when exporting to a temporary
73 buffer, that buffer is popped up in a second window. When this variable
74 is nil, the buffer remains buried also in these cases."
75 :group 'org-export-general
76 :type 'boolean)
78 (defcustom org-export-copy-to-kill-ring t
79 "Non-nil means, exported stuff will also be pushed onto the kill ring."
80 :group 'org-export-general
81 :type 'boolean)
83 (defcustom org-export-run-in-background nil
84 "Non-nil means export and publishing commands will run in background.
85 This works by starting up a separate Emacs process visiting the same file
86 and doing the export from there.
87 Not all export commands are affected by this - only the ones which
88 actually write to a file, and that do not depend on the buffer state.
90 If this option is nil, you can still get background export by calling
91 `org-export' with a double prefix arg: `C-u C-u C-c C-e'.
93 If this option is t, the double prefix can be used to exceptionally
94 force an export command into the current process."
95 :group 'org-export-general
96 :type 'boolean)
98 (defcustom org-export-select-tags '("export")
99 "Tags that select a tree for export.
100 If any such tag is found in a buffer, all trees that do not carry one
101 of these tags will be deleted before export.
102 Inside trees that are selected like this, you can still deselect a
103 subtree by tagging it with one of the `org-export-exclude-tags'."
104 :group 'org-export-general
105 :type '(repeat (string :tag "Tag")))
107 (defcustom org-export-exclude-tags '("noexport")
108 "Tags that exclude a tree from export.
109 All trees carrying any of these tags will be excluded from export.
110 This is without condition, so even subtrees inside that carry one of the
111 `org-export-select-tags' will be removed."
112 :group 'org-export-general
113 :type '(repeat (string :tag "Tag")))
115 ;; FIXME: rename, this is a general variable
116 (defcustom org-export-html-expand t
117 "Non-nil means, for HTML export, treat @<...> as HTML tag.
118 When nil, these tags will be exported as plain text and therefore
119 not be interpreted by a browser.
121 This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
122 :group 'org-export-html
123 :group 'org-export-general
124 :type 'boolean)
126 (defcustom org-export-with-special-strings t
127 "Non-nil means, interpret \"\-\", \"--\" and \"---\" for export.
128 When this option is turned on, these strings will be exported as:
130 Org HTML LaTeX
131 -----+----------+--------
132 \\- &shy; \\-
133 -- &ndash; --
134 --- &mdash; ---
135 ... &hellip; \ldots
137 This option can also be set with the +OPTIONS line, e.g. \"-:nil\"."
138 :group 'org-export-translation
139 :type 'boolean)
141 (defcustom org-export-html-link-up ""
142 "Where should the \"UP\" link of exported HTML pages lead?"
143 :group 'org-export-html
144 :group 'org-export-general
145 :type '(string :tag "File or URL"))
147 (defcustom org-export-html-link-home ""
148 "Where should the \"HOME\" link of exported HTML pages lead?"
149 :group 'org-export-html
150 :group 'org-export-general
151 :type '(string :tag "File or URL"))
153 (defcustom org-export-language-setup
154 '(("en" "Author" "Date" "Table of Contents" "Footnotes")
155 ("ca" "Autor" "Data" "&Iacute;ndex" "Peus de p&agrave;gina")
156 ("cs" "Autor" "Datum" "Obsah" "Pozn\xe1mky pod carou")
157 ("da" "Ophavsmand" "Dato" "Indhold" "Fodnoter")
158 ("de" "Autor" "Datum" "Inhaltsverzeichnis" "Fu&szlig;noten")
159 ("eo" "A&#365;toro" "Dato" "Enhavo" "Piednotoj")
160 ("es" "Autor" "Fecha" "&Iacute;ndice" "Pies de p&aacute;gina")
161 ("fi" "Tekij&auml;" "P&auml;iv&auml;m&auml;&auml;r&auml;" "Sis&auml;llysluettelo" "Alaviitteet")
162 ("fr" "Auteur" "Date" "Table des mati&egrave;res" "Notes de bas de page")
163 ("hu" "Szerz&otilde;" "D&aacute;tum" "Tartalomjegyz&eacute;k" "L&aacute;bjegyzet")
164 ("is" "H&ouml;fundur" "Dagsetning" "Efnisyfirlit" "Aftanm&aacute;lsgreinar")
165 ("it" "Autore" "Data" "Indice" "Note a pi&egrave; di pagina")
166 ("nl" "Auteur" "Datum" "Inhoudsopgave" "Voetnoten")
167 ("no" "Forfatter" "Dato" "Innhold" "Fotnoter")
168 ("nb" "Forfatter" "Dato" "Innhold" "Fotnoter") ;; nb = Norsk (bokm.l)
169 ("nn" "Forfattar" "Dato" "Innhald" "Fotnotar") ;; nn = Norsk (nynorsk)
170 ("pl" "Autor" "Data" "Spis tre&sacute;ci" "Przypis")
171 ("sv" "F&ouml;rfattare" "Datum" "Inneh&aring;ll" "Fotnoter"))
172 "Terms used in export text, translated to different languages.
173 Use the variable `org-export-default-language' to set the language,
174 or use the +OPTION lines for a per-file setting."
175 :group 'org-export-general
176 :type '(repeat
177 (list
178 (string :tag "HTML language tag")
179 (string :tag "Author")
180 (string :tag "Date")
181 (string :tag "Table of Contents")
182 (string :tag "Footnotes"))))
184 (defcustom org-export-default-language "en"
185 "The default language of HTML export, as a string.
186 This should have an association in `org-export-language-setup'."
187 :group 'org-export-general
188 :type 'string)
190 (defvar org-export-page-description ""
191 "The page description, for the XHTML meta tag.
192 This is best set with the #+DESCRIPTION line in a file, it does not make
193 sense to set this globally.")
195 (defvar org-export-page-keywords ""
196 "The page description, for the XHTML meta tag.
197 This is best set with the #+KEYWORDS line in a file, it does not make
198 sense to set this globally.")
200 (defcustom org-export-skip-text-before-1st-heading nil
201 "Non-nil means, skip all text before the first headline when exporting.
202 When nil, that text is exported as well."
203 :group 'org-export-general
204 :type 'boolean)
206 (defcustom org-export-headline-levels 3
207 "The last level which is still exported as a headline.
208 Inferior levels will produce itemize lists when exported.
209 Note that a numeric prefix argument to an exporter function overrides
210 this setting.
212 This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
213 :group 'org-export-general
214 :type 'integer)
216 (defcustom org-export-with-section-numbers t
217 "Non-nil means, add section numbers to headlines when exporting.
219 This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
220 :group 'org-export-general
221 :type 'boolean)
223 (defcustom org-export-section-number-format '((("1" ".")) . "")
224 "Format of section numbers for export.
225 The variable has two components.
226 1. A list of lists, each indicating a counter type and a separator.
227 The counter type can be any of \"1\", \"A\", \"a\", \"I\", or \"a\".
228 It causes causes numeric, alphabetic, or roman counters, respectively.
229 The separator is only used if another counter for a subsection is being
230 added.
231 If there are more numbered section levels than entries in this lists,
232 then the last entry will be reused.
233 2. A terminator string that will be added after the entire
234 section number."
235 :group 'org-export-general
236 :type '(cons
237 (repeat
238 (list
239 (string :tag "Counter Type")
240 (string :tag "Separator ")))
241 (string :tag "Terminator")))
243 (defcustom org-export-with-toc t
244 "Non-nil means, create a table of contents in exported files.
245 The TOC contains headlines with levels up to`org-export-headline-levels'.
246 When an integer, include levels up to N in the toc, this may then be
247 different from `org-export-headline-levels', but it will not be allowed
248 to be larger than the number of headline levels.
249 When nil, no table of contents is made.
251 Headlines which contain any TODO items will be marked with \"(*)\" in
252 ASCII export, and with red color in HTML output, if the option
253 `org-export-mark-todo-in-toc' is set.
255 In HTML output, the TOC will be clickable.
257 This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"
258 or \"toc:3\"."
259 :group 'org-export-general
260 :type '(choice
261 (const :tag "No Table of Contents" nil)
262 (const :tag "Full Table of Contents" t)
263 (integer :tag "TOC to level")))
265 (defcustom org-export-mark-todo-in-toc nil
266 "Non-nil means, mark TOC lines that contain any open TODO items."
267 :group 'org-export-general
268 :type 'boolean)
270 (defcustom org-export-with-todo-keywords t
271 "Non-nil means, include TODO keywords in export.
272 When nil, remove all these keywords from the export."
273 :group 'org-export-general
274 :type 'boolean)
276 (defcustom org-export-with-priority nil
277 "Non-nil means, include priority cookies in export.
278 When nil, remove priority cookies for export."
279 :group 'org-export-general
280 :type 'boolean)
282 (defcustom org-export-preserve-breaks nil
283 "Non-nil means, preserve all line breaks when exporting.
284 Normally, in HTML output paragraphs will be reformatted. In ASCII
285 export, line breaks will always be preserved, regardless of this variable.
287 This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
288 :group 'org-export-general
289 :type 'boolean)
291 (defcustom org-export-with-archived-trees 'headline
292 "Whether subtrees with the ARCHIVE tag should be exported.
293 This can have three different values
294 nil Do not export, pretend this tree is not present
295 t Do export the entire tree
296 headline Only export the headline, but skip the tree below it."
297 :group 'org-export-general
298 :group 'org-archive
299 :type '(choice
300 (const :tag "not at all" nil)
301 (const :tag "headline only" 'headline)
302 (const :tag "entirely" t)))
304 (defcustom org-export-author-info t
305 "Non-nil means, insert author name and email into the exported file.
307 This option can also be set with the +OPTIONS line,
308 e.g. \"author-info:nil\"."
309 :group 'org-export-general
310 :type 'boolean)
312 (defcustom org-export-creator-info t
313 "Non-nil means, the postamble should contain a creator sentence.
314 This sentence is \"HTML generated by org-mode XX in emacs XXX\"."
315 :group 'org-export-general
316 :type 'boolean)
318 (defcustom org-export-time-stamp-file t
319 "Non-nil means, insert a time stamp into the exported file.
320 The time stamp shows when the file was created.
322 This option can also be set with the +OPTIONS line,
323 e.g. \"timestamp:nil\"."
324 :group 'org-export-general
325 :type 'boolean)
327 (defcustom org-export-with-timestamps t
328 "If nil, do not export time stamps and associated keywords."
329 :group 'org-export-general
330 :type 'boolean)
332 (defcustom org-export-remove-timestamps-from-toc t
333 "If t, remove timestamps from the table of contents entries."
334 :group 'org-export-general
335 :type 'boolean)
337 (defcustom org-export-with-tags 'not-in-toc
338 "If nil, do not export tags, just remove them from headlines.
339 If this is the symbol `not-in-toc', tags will be removed from table of
340 contents entries, but still be shown in the headlines of the document.
342 This option can also be set with the +OPTIONS line, e.g. \"tags:nil\"."
343 :group 'org-export-general
344 :type '(choice
345 (const :tag "Off" nil)
346 (const :tag "Not in TOC" not-in-toc)
347 (const :tag "On" t)))
349 (defcustom org-export-with-drawers nil
350 "Non-nil means, export with drawers like the property drawer.
351 When t, all drawers are exported. This may also be a list of
352 drawer names to export."
353 :group 'org-export-general
354 :type '(choice
355 (const :tag "All drawers" t)
356 (const :tag "None" nil)
357 (repeat :tag "Selected drawers"
358 (string :tag "Drawer name"))))
360 (defvar org-export-first-hook nil
361 "Hook called as the first thing in each exporter.
362 Good for general initialization")
364 (defvar org-export-preprocess-hook nil
365 "Hook for preprocessing an export buffer.
366 Pretty much the first thing when exporting is running this hook.")
368 (defvar org-export-preprocess-after-include-files-hook nil
369 "Hook for preprocessing an export buffer.
370 This is run after the contents of included files have been inserted.")
372 (defvar org-export-preprocess-after-tree-selection-hook nil
373 "Hook for preprocessing an export buffer.
374 This is run after selection of trees to be exported has happened.
375 This selection includes tags-based selection, as well as removal
376 of commented and archived trees.")
378 (defvar org-export-preprocess-before-selecting-backend-code-hook nil
379 "Hook for preprocessing an export buffer.
380 This is run just before backend-specific blocks get selected.")
382 (defvar org-export-preprocess-after-blockquote-hook nil
383 "Hook for preprocessing an export buffer.
384 This is run after blockquote/quote/verse/center have been marked
385 with cookies.")
387 (defvar org-export-preprocess-before-backend-specifics-hook nil
388 "Hook run before backend-specific functions are called during preprocessing.")
390 (defvar org-export-preprocess-final-hook nil
391 "Hook for preprocessing an export buffer.
392 This is run as the last thing in the preprocessing buffer, just before
393 returning the buffer string to the backend.")
395 (defgroup org-export-translation nil
396 "Options for translating special ascii sequences for the export backends."
397 :tag "Org Export Translation"
398 :group 'org-export)
400 (defcustom org-export-with-emphasize t
401 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
402 If the export target supports emphasizing text, the word will be
403 typeset in bold, italic, or underlined, respectively. Works only for
404 single words, but you can say: I *really* *mean* *this*.
405 Not all export backends support this.
407 This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
408 :group 'org-export-translation
409 :type 'boolean)
411 (defcustom org-export-with-footnotes t
412 "If nil, export [1] as a footnote marker.
413 Lines starting with [1] will be formatted as footnotes.
415 This option can also be set with the +OPTIONS line, e.g. \"f:nil\"."
416 :group 'org-export-translation
417 :type 'boolean)
419 (defcustom org-export-with-sub-superscripts t
420 "Non-nil means, interpret \"_\" and \"^\" for export.
421 When this option is turned on, you can use TeX-like syntax for sub- and
422 superscripts. Several characters after \"_\" or \"^\" will be
423 considered as a single item - so grouping with {} is normally not
424 needed. For example, the following things will be parsed as single
425 sub- or superscripts.
427 10^24 or 10^tau several digits will be considered 1 item.
428 10^-12 or 10^-tau a leading sign with digits or a word
429 x^2-y^3 will be read as x^2 - y^3, because items are
430 terminated by almost any nonword/nondigit char.
431 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
433 Still, ambiguity is possible - so when in doubt use {} to enclose the
434 sub/superscript. If you set this variable to the symbol `{}',
435 the braces are *required* in order to trigger interpretations as
436 sub/superscript. This can be helpful in documents that need \"_\"
437 frequently in plain text.
439 Not all export backends support this, but HTML does.
441 This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
442 :group 'org-export-translation
443 :type '(choice
444 (const :tag "Always interpret" t)
445 (const :tag "Only with braces" {})
446 (const :tag "Never interpret" nil)))
448 (defcustom org-export-with-TeX-macros t
449 "Non-nil means, interpret simple TeX-like macros when exporting.
450 For example, HTML export converts \\alpha to &alpha; and \\AA to &Aring;.
451 Not only real TeX macros will work here, but the standard HTML entities
452 for math can be used as macro names as well. For a list of supported
453 names in HTML export, see the constant `org-html-entities'.
454 Not all export backends support this.
456 This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
457 :group 'org-export-translation
458 :group 'org-export-latex
459 :type 'boolean)
461 (defcustom org-export-with-LaTeX-fragments nil
462 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
463 When set, the exporter will find LaTeX environments if the \\begin line is
464 the first non-white thing on a line. It will also find the math delimiters
465 like $a=b$ and \\( a=b \\) for inline math, $$a=b$$ and \\[ a=b \\] for
466 display math.
468 This option can also be set with the +OPTIONS line, e.g. \"LaTeX:t\".
470 The default is nil, because this option needs the `dvipng' program which
471 is not available on all systems."
472 :group 'org-export-translation
473 :group 'org-export-latex
474 :type 'boolean)
476 (defcustom org-export-with-fixed-width t
477 "Non-nil means, lines starting with \":\" will be in fixed width font.
478 This can be used to have pre-formatted text, fragments of code etc. For
479 example:
480 : ;; Some Lisp examples
481 : (while (defc cnt)
482 : (ding))
483 will be looking just like this in also HTML. See also the QUOTE keyword.
484 Not all export backends support this.
486 This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
487 :group 'org-export-translation
488 :type 'boolean)
490 (defcustom org-match-sexp-depth 3
491 "Number of stacked braces for sub/superscript matching.
492 This has to be set before loading org.el to be effective."
493 :group 'org-export-translation
494 :type 'integer)
496 (defgroup org-export-tables nil
497 "Options for exporting tables in Org-mode."
498 :tag "Org Export Tables"
499 :group 'org-export)
501 (defcustom org-export-with-tables t
502 "If non-nil, lines starting with \"|\" define a table.
503 For example:
505 | Name | Address | Birthday |
506 |-------------+----------+-----------|
507 | Arthur Dent | England | 29.2.2100 |
509 Not all export backends support this.
511 This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
512 :group 'org-export-tables
513 :type 'boolean)
515 (defcustom org-export-highlight-first-table-line t
516 "Non-nil means, highlight the first table line.
517 In HTML export, this means use <th> instead of <td>.
518 In tables created with table.el, this applies to the first table line.
519 In Org-mode tables, all lines before the first horizontal separator
520 line will be formatted with <th> tags."
521 :group 'org-export-tables
522 :type 'boolean)
524 (defcustom org-export-table-remove-special-lines t
525 "Remove special lines and marking characters in calculating tables.
526 This removes the special marking character column from tables that are set
527 up for spreadsheet calculations. It also removes the entire lines
528 marked with `!', `_', or `^'. The lines with `$' are kept, because
529 the values of constants may be useful to have."
530 :group 'org-export-tables
531 :type 'boolean)
533 (defcustom org-export-prefer-native-exporter-for-tables nil
534 "Non-nil means, always export tables created with table.el natively.
535 Natively means, use the HTML code generator in table.el.
536 When nil, Org-mode's own HTML generator is used when possible (i.e. if
537 the table does not use row- or column-spanning). This has the
538 advantage, that the automatic HTML conversions for math symbols and
539 sub/superscripts can be applied. Org-mode's HTML generator is also
540 much faster."
541 :group 'org-export-tables
542 :type 'boolean)
545 (defgroup org-export-xml nil
546 "Options specific for XML export of Org-mode files."
547 :tag "Org Export XML"
548 :group 'org-export)
550 ;;;; Exporting
552 ;;; Variables, constants, and parameter plists
554 (defconst org-level-max 20)
556 (defvar org-current-export-file nil) ; dynamically scoped parameter
557 (defvar org-current-export-dir nil) ; dynamically scoped parameter
558 (defvar org-export-opt-plist nil
559 "Contains the current option plist.")
560 (defvar org-last-level nil) ; dynamically scoped variable
561 (defvar org-min-level nil) ; dynamically scoped variable
562 (defvar org-levels-open nil) ; dynamically scoped parameter
564 (defconst org-export-plist-vars
565 '((:link-up nil org-export-html-link-up)
566 (:link-home nil org-export-html-link-home)
567 (:language nil org-export-default-language)
568 (:keywords nil org-export-page-keywords)
569 (:description nil org-export-page-description)
570 (:customtime nil org-display-custom-times)
571 (:headline-levels "H" org-export-headline-levels)
572 (:section-numbers "num" org-export-with-section-numbers)
573 (:section-number-format nil org-export-section-number-format)
574 (:table-of-contents "toc" org-export-with-toc)
575 (:preserve-breaks "\\n" org-export-preserve-breaks)
576 (:archived-trees nil org-export-with-archived-trees)
577 (:emphasize "*" org-export-with-emphasize)
578 (:sub-superscript "^" org-export-with-sub-superscripts)
579 (:special-strings "-" org-export-with-special-strings)
580 (:footnotes "f" org-export-with-footnotes)
581 (:drawers "d" org-export-with-drawers)
582 (:tags "tags" org-export-with-tags)
583 (:todo-keywords "todo" org-export-with-todo-keywords)
584 (:priority "pri" org-export-with-priority)
585 (:TeX-macros "TeX" org-export-with-TeX-macros)
586 (:LaTeX-fragments "LaTeX" org-export-with-LaTeX-fragments)
587 (:latex-listings nil org-export-latex-listings)
588 (:skip-before-1st-heading "skip" org-export-skip-text-before-1st-heading)
589 (:fixed-width ":" org-export-with-fixed-width)
590 (:timestamps "<" org-export-with-timestamps)
591 (:author-info "author" org-export-author-info)
592 (:creator-info "creator" org-export-creator-info)
593 (:time-stamp-file "timestamp" org-export-time-stamp-file)
594 (:tables "|" org-export-with-tables)
595 (:table-auto-headline nil org-export-highlight-first-table-line)
596 (:style-include-default nil org-export-html-style-include-default)
597 (:style-include-scripts nil org-export-html-style-include-scripts)
598 (:style nil org-export-html-style)
599 (:style-extra nil org-export-html-style-extra)
600 (:agenda-style nil org-agenda-export-html-style)
601 (:convert-org-links nil org-export-html-link-org-files-as-html)
602 (:inline-images nil org-export-html-inline-images)
603 (:html-extension nil org-export-html-extension)
604 (:xml-declaration nil org-export-html-xml-declaration)
605 (:html-table-tag nil org-export-html-table-tag)
606 (:expand-quoted-html "@" org-export-html-expand)
607 (:timestamp nil org-export-html-with-timestamp)
608 (:publishing-directory nil org-export-publishing-directory)
609 (:preamble nil org-export-html-preamble)
610 (:postamble nil org-export-html-postamble)
611 (:auto-preamble nil org-export-html-auto-preamble)
612 (:auto-postamble nil org-export-html-auto-postamble)
613 (:author nil user-full-name)
614 (:email nil user-mail-address)
615 (:select-tags nil org-export-select-tags)
616 (:exclude-tags nil org-export-exclude-tags)
618 (:latex-image-options nil org-export-latex-image-default-option))
619 "List of properties that represent export/publishing variables.
620 Each element is a list of 3 items:
621 1. The property that is used internally, and also for org-publish-project-alist
622 2. The string that can be used in the OPTION lines to set this option,
623 or nil if this option cannot be changed in this way
624 3. The customization variable that sets the default for this option."
627 (defun org-default-export-plist ()
628 "Return the property list with default settings for the export variables."
629 (let* ((infile (org-infile-export-plist))
630 (letbind (plist-get infile :let-bind))
631 (l org-export-plist-vars) rtn e s v)
632 (while (setq e (pop l))
633 (setq s (nth 2 e)
634 v (cond
635 ((assq s letbind) (nth 1 (assq s letbind)))
636 ((boundp s) (symbol-value s))
637 (t nil))
638 rtn (cons (car e) (cons v rtn))))
639 rtn))
641 (defvar org-export-inbuffer-options-extra nil
642 "List of additional in-buffer options that should be detected.
643 Just before export, the buffer is scanned for options like #+TITLE, #+EMAIL,
644 etc. Extensions can add to this list to get their options detected, and they
645 can then add a function to `org-export-options-filters' to process these
646 options.
647 Each element in this list must be a list, with the in-buffer keyword as car,
648 and a property (a symbol) as the next element. All occurrences of the
649 keyword will be found, the values concatenated with a space character
650 in between, and the result stored in the export options property list.")
652 (defvar org-export-options-filters nil
653 "Functions to be called to finalize the export/publishing options.
654 All these options are stored in a property list, and each of the functions
655 in this hook gets a chance to modify this property list. Each function
656 must accept the property list as an argument, and must return the (possibly
657 modified) list.")
659 ;; FIXME: should we fold case here?
660 (defun org-infile-export-plist ()
661 "Return the property list with file-local settings for export."
662 (save-excursion
663 (save-restriction
664 (widen)
665 (goto-char (point-min))
666 (let ((re (org-make-options-regexp
667 (append
668 '("TITLE" "AUTHOR" "DATE" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"
669 "LINK_UP" "LINK_HOME" "SETUPFILE" "STYLE"
670 "LATEX_HEADER" "LATEX_CLASS"
671 "EXPORT_SELECT_TAGS" "EXPORT_EXCLUDE_TAGS"
672 "KEYWORDS" "DESCRIPTION" "MACRO" "BIND")
673 (mapcar 'car org-export-inbuffer-options-extra))))
674 p key val text options a pr style
675 latex-header latex-class macros letbind
676 ext-setup-or-nil setup-contents (start 0))
677 (while (or (and ext-setup-or-nil
678 (string-match re ext-setup-or-nil start)
679 (setq start (match-end 0)))
680 (and (setq ext-setup-or-nil nil start 0)
681 (re-search-forward re nil t)))
682 (setq key (upcase (org-match-string-no-properties 1 ext-setup-or-nil))
683 val (org-match-string-no-properties 2 ext-setup-or-nil))
684 (cond
685 ((setq a (assoc key org-export-inbuffer-options-extra))
686 (setq pr (nth 1 a))
687 (setq p (plist-put p pr (concat (plist-get p pr) " " val))))
688 ((string-equal key "TITLE") (setq p (plist-put p :title val)))
689 ((string-equal key "AUTHOR")(setq p (plist-put p :author val)))
690 ((string-equal key "EMAIL") (setq p (plist-put p :email val)))
691 ((string-equal key "DATE") (setq p (plist-put p :date val)))
692 ((string-equal key "KEYWORDS") (setq p (plist-put p :keywords val)))
693 ((string-equal key "DESCRIPTION")
694 (setq p (plist-put p :description val)))
695 ((string-equal key "LANGUAGE") (setq p (plist-put p :language val)))
696 ((string-equal key "STYLE")
697 (setq style (concat style "\n" val)))
698 ((string-equal key "LATEX_HEADER")
699 (setq latex-header (concat latex-header "\n" val)))
700 ((string-equal key "LATEX_CLASS")
701 (setq latex-class val))
702 ((string-equal key "TEXT")
703 (setq text (if text (concat text "\n" val) val)))
704 ((string-equal key "OPTIONS")
705 (setq options (concat val " " options)))
706 ((string-equal key "BIND")
707 (push (read (concat "(" val ")")) letbind))
708 ((string-equal key "LINK_UP")
709 (setq p (plist-put p :link-up val)))
710 ((string-equal key "LINK_HOME")
711 (setq p (plist-put p :link-home val)))
712 ((string-equal key "EXPORT_SELECT_TAGS")
713 (setq p (plist-put p :select-tags (org-split-string val))))
714 ((string-equal key "EXPORT_EXCLUDE_TAGS")
715 (setq p (plist-put p :exclude-tags (org-split-string val))))
716 ((string-equal key "MACRO")
717 (push val macros))
718 ((equal key "SETUPFILE")
719 (setq setup-contents (org-file-contents
720 (expand-file-name
721 (org-remove-double-quotes
722 (org-trim val)))
723 'noerror))
724 (if (not ext-setup-or-nil)
725 (setq ext-setup-or-nil setup-contents start 0)
726 (setq ext-setup-or-nil
727 (concat (substring ext-setup-or-nil 0 start)
728 "\n" setup-contents "\n"
729 (substring ext-setup-or-nil start)))))))
730 (setq p (plist-put p :text text))
731 (when (and letbind (org-export-confirm-letbind))
732 (setq p (plist-put p :let-bind letbind)))
733 (when style (setq p (plist-put p :style-extra style)))
734 (when latex-header
735 (setq p (plist-put p :latex-header-extra (substring latex-header 1))))
736 (when latex-class
737 (setq p (plist-put p :latex-class latex-class)))
738 (when options
739 (setq p (org-export-add-options-to-plist p options)))
740 ;; Add macro definitions
741 (setq p (plist-put p :macro-date "(eval (format-time-string \"$1\"))"))
742 (setq p (plist-put p :macro-time "(eval (format-time-string \"$1\"))"))
743 (setq p (plist-put
744 p :macro-modification-time
745 (and (buffer-file-name)
746 (file-exists-p (buffer-file-name))
747 (concat
748 "(eval (format-time-string \"$1\" '"
749 (prin1-to-string (nth 5 (file-attributes
750 (buffer-file-name))))
751 "))"))))
752 (setq p (plist-put p :macro-input-file (and (buffer-file-name)
753 (file-name-nondirectory
754 (buffer-file-name)))))
755 (while (setq val (pop macros))
756 (when (string-match "^\\([-a-zA-Z0-9_]+\\)[ \t]+\\(.*?[ \t]*$\\)" val)
757 (setq p (plist-put
758 p (intern
759 (concat ":macro-" (downcase (match-string 1 val))))
760 (org-export-interpolate-newlines (match-string 2 val))))))
761 p))))
763 (defun org-export-interpolate-newlines (s)
764 (while (string-match "\\\\n" s)
765 (setq s (replace-match "\n" t t s)))
768 (defvar org-export-allow-BIND-local nil)
769 (defun org-export-confirm-letbind ()
770 "Can we use #+BIND values during export?
771 By default this will ask fro confirmation by the user, to divert possible
772 security risks."
773 (cond
774 ((not org-export-allow-BIND) nil)
775 ((eq org-export-allow-BIND t) t)
776 ((local-variable-p 'org-export-allow-BIND-local (current-buffer))
777 org-export-allow-BIND-local)
778 (t (org-set-local 'org-export-allow-BIND-local
779 (yes-or-no-p "Allow BIND values in this buffer? ")))))
781 (defun org-install-letbind ()
782 "Install the values from #+BIND lines as local variables."
783 (let ((letbind (plist-get org-export-opt-plist :let-bind)))
784 (while letbind
785 (org-set-local (caar letbind) (nth 1 (pop letbind))))))
787 (defun org-export-add-options-to-plist (p options)
788 "Parse an OPTIONS line and set values in the property list P."
789 (let (o)
790 (when options
791 (let ((op org-export-plist-vars))
792 (while (setq o (pop op))
793 (if (and (nth 1 o)
794 (string-match (concat (regexp-quote (nth 1 o))
795 ":\\([^ \t\n\r;,.]*\\)")
796 options))
797 (setq p (plist-put p (car o)
798 (car (read-from-string
799 (match-string 1 options))))))))))
802 (defun org-export-add-subtree-options (p pos)
803 "Add options in subtree at position POS to property list P."
804 (save-excursion
805 (goto-char pos)
806 (when (org-at-heading-p)
807 (let (a)
808 ;; This is actually read in `org-export-get-title-from-subtree'
809 ;; (when (setq a (org-entry-get pos "EXPORT_TITLE"))
810 ;; (setq p (plist-put p :title a)))
811 (when (setq a (org-entry-get pos "EXPORT_TEXT"))
812 (setq p (plist-put p :text a)))
813 (when (setq a (org-entry-get pos "EXPORT_AUTHOR"))
814 (setq p (plist-put p :author a)))
815 (when (setq a (org-entry-get pos "EXPORT_DATE"))
816 (setq p (plist-put p :date a)))
817 (when (setq a (org-entry-get pos "EXPORT_OPTIONS"))
818 (setq p (org-export-add-options-to-plist p a)))))
821 (defun org-export-directory (type plist)
822 (let* ((val (plist-get plist :publishing-directory))
823 (dir (if (listp val)
824 (or (cdr (assoc type val)) ".")
825 val)))
826 dir))
828 (defun org-export-process-option-filters (plist)
829 (let ((functions org-export-options-filters) f)
830 (while (setq f (pop functions))
831 (setq plist (funcall f plist))))
832 plist)
834 ;;;###autoload
835 (defun org-export (&optional arg)
836 "Export dispatcher for Org-mode.
837 When `org-export-run-in-background' is non-nil, try to run the command
838 in the background. This will be done only for commands that write
839 to a file. For details see the docstring of `org-export-run-in-background'.
841 The prefix argument ARG will be passed to the exporter. However, if
842 ARG is a double universal prefix `C-u C-u', that means to inverse the
843 value of `org-export-run-in-background'."
844 (interactive "P")
845 (let* ((bg (org-xor (equal arg '(16)) org-export-run-in-background))
846 subtree-p
847 (help "[t] insert the export option template
848 \[v] limit export to visible part of outline tree
849 \[1] only export the current subtree
851 \[a] export as ASCII [A] to temporary buffer
853 \[h] export as HTML [H] to temporary buffer [R] export region
854 \[b] export as HTML and open in browser
856 \[l] export as LaTeX [L] to temporary buffer
857 \[p] export as LaTeX and process to PDF
858 \[d] export as LaTeX, process to PDF, and open the resulting PDF document
860 \[D] export as DocBook
861 \[V] export as DocBook, process to PDF, and open the resulting PDF document
863 \[m] export as Freemind mind map
865 \[x] export as XOXO
866 \[g] export using Wes Hardaker's generic exporter
868 \[i] export current file as iCalendar file
869 \[I] export all agenda files as iCalendar files
870 \[c] export agenda files into combined iCalendar file
872 \[F] publish current file [P] publish current project
873 \[X] publish a project... [E] publish every projects")
874 (cmds
875 '((?t org-insert-export-options-template nil)
876 (?v org-export-visible nil)
877 (?a org-export-as-ascii t)
878 (?A org-export-as-ascii-to-buffer t)
879 (?h org-export-as-html t)
880 (?b org-export-as-html-and-open t)
881 (?H org-export-as-html-to-buffer nil)
882 (?R org-export-region-as-html nil)
883 (?x org-export-as-xoxo t)
884 (?g org-export-generic t)
885 (?D org-export-as-docbook t)
886 (?V org-export-as-docbook-pdf-and-open t)
887 (?m org-export-as-freemind t)
888 (?l org-export-as-latex t)
889 (?p org-export-as-pdf t)
890 (?d org-export-as-pdf-and-open t)
891 (?L org-export-as-latex-to-buffer nil)
892 (?i org-export-icalendar-this-file t)
893 (?I org-export-icalendar-all-agenda-files t)
894 (?c org-export-icalendar-combine-agenda-files t)
895 (?F org-publish-current-file t)
896 (?P org-publish-current-project t)
897 (?X org-publish t)
898 (?E org-publish-all t)))
899 r1 r2 ass)
900 (save-excursion
901 (save-window-excursion
902 (delete-other-windows)
903 (with-output-to-temp-buffer "*Org Export/Publishing Help*"
904 (princ help))
905 (org-fit-window-to-buffer (get-buffer-window
906 "*Org Export/Publishing Help*"))
907 (message "Select command: ")
908 (setq r1 (read-char-exclusive))
909 (when (eq r1 ?1)
910 (setq subtree-p t)
911 (message "Select command (for subtree): ")
912 (setq r1 (read-char-exclusive)))))
913 (setq r2 (if (< r1 27) (+ r1 96) r1))
914 (unless (setq ass (assq r2 cmds))
915 (error "No command associated with key %c" r1))
916 (if (and bg (nth 2 ass)
917 (not (buffer-base-buffer))
918 (not (org-region-active-p)))
919 ;; execute in background
920 (let ((p (start-process
921 (concat "Exporting " (file-name-nondirectory (buffer-file-name)))
922 "*Org Processes*"
923 (expand-file-name invocation-name invocation-directory)
924 "-batch"
925 "-l" user-init-file
926 "--eval" "(require 'org-exp)"
927 "--eval" "(setq org-wait .2)"
928 (buffer-file-name)
929 "-f" (symbol-name (nth 1 ass)))))
930 (set-process-sentinel p 'org-export-process-sentinel)
931 (message "Background process \"%s\": started" p))
932 ;; background processing not requested, or not possible
933 (if subtree-p (outline-mark-subtree))
934 (call-interactively (nth 1 ass)))))
936 (defun org-export-process-sentinel (process status)
937 (if (string-match "\n+\\'" status)
938 (setq status (substring status 0 -1)))
939 (message "Background process \"%s\": %s" process status))
941 (defconst org-html-entities
942 '(("nbsp")
943 ("iexcl")
944 ("cent")
945 ("pound")
946 ("curren")
947 ("yen")
948 ("brvbar")
949 ("vert" . "&#124;")
950 ("sect")
951 ("uml")
952 ("copy")
953 ("ordf")
954 ("laquo")
955 ("not")
956 ("shy")
957 ("reg")
958 ("macr")
959 ("deg")
960 ("pm" . "&plusmn;")
961 ("plusmn")
962 ("sup2")
963 ("sup3")
964 ("acute")
965 ("micro")
966 ("para")
967 ("middot")
968 ("odot"."o")
969 ("star"."*")
970 ("cedil")
971 ("sup1")
972 ("ordm")
973 ("raquo")
974 ("frac14")
975 ("frac12")
976 ("frac34")
977 ("iquest")
978 ("Agrave")
979 ("Aacute")
980 ("Acirc")
981 ("Atilde")
982 ("Auml")
983 ("Aring") ("AA"."&Aring;")
984 ("AElig")
985 ("Ccedil")
986 ("Egrave")
987 ("Eacute")
988 ("Ecirc")
989 ("Euml")
990 ("Igrave")
991 ("Iacute")
992 ("Icirc")
993 ("Iuml")
994 ("ETH")
995 ("Ntilde")
996 ("Ograve")
997 ("Oacute")
998 ("Ocirc")
999 ("Otilde")
1000 ("Ouml")
1001 ("times")
1002 ("Oslash")
1003 ("Ugrave")
1004 ("Uacute")
1005 ("Ucirc")
1006 ("Uuml")
1007 ("Yacute")
1008 ("THORN")
1009 ("szlig")
1010 ("agrave")
1011 ("aacute")
1012 ("acirc")
1013 ("atilde")
1014 ("auml")
1015 ("aring")
1016 ("aelig")
1017 ("ccedil")
1018 ("egrave")
1019 ("eacute")
1020 ("ecirc")
1021 ("euml")
1022 ("igrave")
1023 ("iacute")
1024 ("icirc")
1025 ("iuml")
1026 ("eth")
1027 ("ntilde")
1028 ("ograve")
1029 ("oacute")
1030 ("ocirc")
1031 ("otilde")
1032 ("ouml")
1033 ("divide")
1034 ("oslash")
1035 ("ugrave")
1036 ("uacute")
1037 ("ucirc")
1038 ("uuml")
1039 ("yacute")
1040 ("thorn")
1041 ("yuml")
1042 ("fnof")
1043 ("Alpha")
1044 ("Beta")
1045 ("Gamma")
1046 ("Delta")
1047 ("Epsilon")
1048 ("Zeta")
1049 ("Eta")
1050 ("Theta")
1051 ("Iota")
1052 ("Kappa")
1053 ("Lambda")
1054 ("Mu")
1055 ("Nu")
1056 ("Xi")
1057 ("Omicron")
1058 ("Pi")
1059 ("Rho")
1060 ("Sigma")
1061 ("Tau")
1062 ("Upsilon")
1063 ("Phi")
1064 ("Chi")
1065 ("Psi")
1066 ("Omega")
1067 ("alpha")
1068 ("beta")
1069 ("gamma")
1070 ("delta")
1071 ("epsilon")
1072 ("varepsilon"."&epsilon;")
1073 ("zeta")
1074 ("eta")
1075 ("theta")
1076 ("iota")
1077 ("kappa")
1078 ("lambda")
1079 ("mu")
1080 ("nu")
1081 ("xi")
1082 ("omicron")
1083 ("pi")
1084 ("rho")
1085 ("sigmaf") ("varsigma"."&sigmaf;")
1086 ("sigma")
1087 ("tau")
1088 ("upsilon")
1089 ("phi")
1090 ("chi")
1091 ("psi")
1092 ("omega")
1093 ("thetasym") ("vartheta"."&thetasym;")
1094 ("upsih")
1095 ("piv")
1096 ("bull") ("bullet"."&bull;")
1097 ("hellip") ("dots"."&hellip;")
1098 ("prime")
1099 ("Prime")
1100 ("oline")
1101 ("frasl")
1102 ("weierp")
1103 ("image")
1104 ("real")
1105 ("trade")
1106 ("alefsym")
1107 ("larr") ("leftarrow"."&larr;") ("gets"."&larr;")
1108 ("uarr") ("uparrow"."&uarr;")
1109 ("rarr") ("to"."&rarr;") ("rightarrow"."&rarr;")
1110 ("darr")("downarrow"."&darr;")
1111 ("harr") ("leftrightarrow"."&harr;")
1112 ("crarr") ("hookleftarrow"."&crarr;") ; has round hook, not quite CR
1113 ("lArr") ("Leftarrow"."&lArr;")
1114 ("uArr") ("Uparrow"."&uArr;")
1115 ("rArr") ("Rightarrow"."&rArr;")
1116 ("dArr") ("Downarrow"."&dArr;")
1117 ("hArr") ("Leftrightarrow"."&hArr;")
1118 ("forall")
1119 ("part") ("partial"."&part;")
1120 ("exist") ("exists"."&exist;")
1121 ("empty") ("emptyset"."&empty;")
1122 ("nabla")
1123 ("isin") ("in"."&isin;")
1124 ("notin")
1125 ("ni")
1126 ("prod")
1127 ("sum")
1128 ("minus")
1129 ("lowast") ("ast"."&lowast;")
1130 ("radic")
1131 ("prop") ("proptp"."&prop;")
1132 ("infin") ("infty"."&infin;")
1133 ("ang") ("angle"."&ang;")
1134 ("and") ("wedge"."&and;")
1135 ("or") ("vee"."&or;")
1136 ("cap")
1137 ("cup")
1138 ("int")
1139 ("there4")
1140 ("sim")
1141 ("cong") ("simeq"."&cong;")
1142 ("asymp")("approx"."&asymp;")
1143 ("ne") ("neq"."&ne;")
1144 ("equiv")
1145 ("le")
1146 ("ge")
1147 ("sub") ("subset"."&sub;")
1148 ("sup") ("supset"."&sup;")
1149 ("nsub")
1150 ("sube")
1151 ("supe")
1152 ("oplus")
1153 ("otimes")
1154 ("perp")
1155 ("sdot") ("cdot"."&sdot;")
1156 ("lceil")
1157 ("rceil")
1158 ("lfloor")
1159 ("rfloor")
1160 ("lang")
1161 ("rang")
1162 ("loz") ("Diamond"."&loz;")
1163 ("spades") ("spadesuit"."&spades;")
1164 ("clubs") ("clubsuit"."&clubs;")
1165 ("hearts") ("diamondsuit"."&hearts;")
1166 ("diams") ("diamondsuit"."&diams;")
1167 ("smile"."&#9786;") ("blacksmile"."&#9787;") ("sad"."&#9785;")
1168 ("quot")
1169 ("amp")
1170 ("lt")
1171 ("gt")
1172 ("OElig")
1173 ("oelig")
1174 ("Scaron")
1175 ("scaron")
1176 ("Yuml")
1177 ("circ")
1178 ("tilde")
1179 ("ensp")
1180 ("emsp")
1181 ("thinsp")
1182 ("zwnj")
1183 ("zwj")
1184 ("lrm")
1185 ("rlm")
1186 ("ndash")
1187 ("mdash")
1188 ("lsquo")
1189 ("rsquo")
1190 ("sbquo")
1191 ("ldquo")
1192 ("rdquo")
1193 ("bdquo")
1194 ("dagger")
1195 ("Dagger")
1196 ("permil")
1197 ("lsaquo")
1198 ("rsaquo")
1199 ("euro")
1200 ("EUR"."&euro;")
1201 ("EURdig"."&euro;")
1202 ("EURhv"."&euro;")
1203 ("EURcr"."&euro;")
1204 ("EURtm"."&euro;")
1205 ("arccos"."arccos")
1206 ("arcsin"."arcsin")
1207 ("arctan"."arctan")
1208 ("arg"."arg")
1209 ("cos"."cos")
1210 ("cosh"."cosh")
1211 ("cot"."cot")
1212 ("coth"."coth")
1213 ("csc"."csc")
1214 ("deg"."deg")
1215 ("det"."det")
1216 ("dim"."dim")
1217 ("exp"."exp")
1218 ("gcd"."gcd")
1219 ("hom"."hom")
1220 ("inf"."inf")
1221 ("ker"."ker")
1222 ("lg"."lg")
1223 ("lim"."lim")
1224 ("liminf"."liminf")
1225 ("limsup"."limsup")
1226 ("ln"."ln")
1227 ("log"."log")
1228 ("max"."max")
1229 ("min"."min")
1230 ("Pr"."Pr")
1231 ("sec"."sec")
1232 ("sin"."sin")
1233 ("sinh"."sinh")
1234 ("sup"."sup")
1235 ("tan"."tan")
1236 ("tanh"."tanh")
1238 "Entities for TeX->HTML translation.
1239 Entries can be like (\"ent\"), in which case \"\\ent\" will be translated to
1240 \"&ent;\". An entry can also be a dotted pair like (\"ent\".\"&other;\").
1241 In that case, \"\\ent\" will be translated to \"&other;\".
1242 The list contains HTML entities for Latin-1, Greek and other symbols.
1243 It is supplemented by a number of commonly used TeX macros with appropriate
1244 translations. There is currently no way for users to extend this.")
1246 ;;; General functions for all backends
1248 (defvar org-export-target-aliases nil
1249 "Alist of targets with invisible aliases.")
1250 (defvar org-export-preferred-target-alist nil
1251 "Alist of section id's with preferred aliases.")
1252 (defvar org-export-code-refs nil
1253 "Alist of code references and line numbers")
1255 (defun org-export-preprocess-string (string &rest parameters)
1256 "Cleanup STRING so that that the true exported has a more consistent source.
1257 This function takes STRING, which should be a buffer-string of an org-file
1258 to export. It then creates a temporary buffer where it does its job.
1259 The result is then again returned as a string, and the exporter works
1260 on this string to produce the exported version."
1261 (interactive)
1262 (let* ((htmlp (plist-get parameters :for-html))
1263 (asciip (plist-get parameters :for-ascii))
1264 (latexp (plist-get parameters :for-LaTeX))
1265 (docbookp (plist-get parameters :for-docbook))
1266 (backend (cond (htmlp 'html)
1267 (latexp 'latex)
1268 (asciip 'ascii)
1269 (docbookp 'docbook)))
1270 (archived-trees (plist-get parameters :archived-trees))
1271 (inhibit-read-only t)
1272 (drawers org-drawers)
1273 (outline-regexp "\\*+ ")
1274 target-alist rtn)
1276 (setq org-export-target-aliases nil)
1277 (setq org-export-preferred-target-alist nil)
1278 (setq org-export-code-refs nil)
1280 (with-current-buffer (get-buffer-create " org-mode-tmp")
1281 (erase-buffer)
1282 (insert string)
1283 (setq case-fold-search t)
1285 (let ((inhibit-read-only t))
1286 (remove-text-properties (point-min) (point-max)
1287 '(read-only t)))
1289 ;; Remove license-to-kill stuff
1290 ;; The caller marks some stuff for killing, stuff that has been
1291 ;; used to create the page title, for example.
1292 (org-export-kill-licensed-text)
1294 (let ((org-inhibit-startup t)) (org-mode))
1295 (setq case-fold-search t)
1296 (org-install-letbind)
1298 ;; Call the hook
1299 (run-hooks 'org-export-preprocess-hook)
1301 ;; Process the macros
1302 (org-export-preprocess-apply-macros)
1303 (run-hooks 'org-export-preprocess-after-macros-hook)
1305 (untabify (point-min) (point-max))
1307 ;; Handle include files, and call a hook
1308 (org-export-handle-include-files)
1309 (run-hooks 'org-export-preprocess-after-include-files-hook)
1311 ;; Get rid of archived trees
1312 (org-export-remove-archived-trees archived-trees)
1314 ;; Remove comment environment and comment subtrees
1315 (org-export-remove-comment-blocks-and-subtrees)
1317 ;; Get rid of excluded trees, and call a hook
1318 (org-export-handle-export-tags (plist-get parameters :select-tags)
1319 (plist-get parameters :exclude-tags))
1320 (run-hooks 'org-export-preprocess-after-tree-selection-hook)
1322 ;; Handle source code snippets
1323 (org-export-replace-src-segments-and-examples backend)
1325 ;; Protect short examples marked by a leading colon
1326 (org-export-protect-colon-examples)
1328 ;; Normalize footnotes
1329 (when (plist-get parameters :footnotes)
1330 (org-footnote-normalize nil t))
1332 ;; Find all headings and compute the targets for them
1333 (setq target-alist (org-export-define-heading-targets target-alist))
1335 ;; Get rid of drawers
1336 (org-export-remove-or-extract-drawers
1337 drawers (plist-get parameters :drawers) backend)
1339 ;; Get the correct stuff before the first headline
1340 (when (plist-get parameters :skip-before-1st-heading)
1341 (goto-char (point-min))
1342 (when (re-search-forward "^\\(#.*\n\\)?\\*+[ \t]" nil t)
1343 (delete-region (point-min) (match-beginning 0))
1344 (goto-char (point-min))
1345 (insert "\n")))
1346 (when (plist-get parameters :add-text)
1347 (goto-char (point-min))
1348 (insert (plist-get parameters :add-text) "\n"))
1350 ;; Remove todo-keywords before exporting, if the user has requested so
1351 (org-export-remove-headline-metadata parameters)
1353 ;; Find targets in comments and move them out of comments,
1354 ;; but mark them as targets that should be invisible
1355 (setq target-alist (org-export-handle-invisible-targets target-alist))
1357 ;; Select and protect backend specific stuff, throw away stuff
1358 ;; that is specific for other backends
1359 (run-hooks 'org-export-preprocess-before-selecting-backend-code-hook)
1360 (org-export-select-backend-specific-text backend)
1362 ;; Protect quoted subtrees
1363 (org-export-protect-quoted-subtrees)
1365 ;; Remove clock lines
1366 (org-export-remove-clock-lines)
1368 ;; Protect verbatim elements
1369 (org-export-protect-verbatim)
1371 ;; Blockquotes, verse, and center
1372 (org-export-mark-blockquote-verse-center)
1373 (run-hooks 'org-export-preprocess-after-blockquote-hook)
1375 ;; Remove timestamps, if the user has requested so
1376 (unless (plist-get parameters :timestamps)
1377 (org-export-remove-timestamps))
1379 ;; Attach captions to the correct object
1380 (setq target-alist (org-export-attach-captions-and-attributes
1381 backend target-alist))
1383 ;; Find matches for radio targets and turn them into internal links
1384 (org-export-mark-radio-links)
1386 ;; Find all links that contain a newline and put them into a single line
1387 (org-export-concatenate-multiline-links)
1389 ;; Normalize links: Convert angle and plain links into bracket links
1390 ;; and expand link abbreviations
1391 (org-export-normalize-links)
1393 ;; Find all internal links. If they have a fuzzy match (i.e. not
1394 ;; a *dedicated* target match, let the link point to the
1395 ;; corresponding section.
1396 (org-export-target-internal-links target-alist)
1398 ;; Find multiline emphasis and put them into single line
1399 (when (plist-get parameters :emph-multiline)
1400 (org-export-concatenate-multiline-emphasis))
1402 ;; Remove special table lines
1403 (when org-export-table-remove-special-lines
1404 (org-export-remove-special-table-lines))
1406 ;; Another hook
1407 (run-hooks 'org-export-preprocess-before-backend-specifics-hook)
1409 ;; LaTeX-specific preprocessing
1410 (when latexp
1411 (require 'org-latex nil)
1412 (org-export-latex-preprocess parameters))
1414 ;; ASCII-specific preprocessing
1415 (when asciip
1416 (org-export-ascii-preprocess parameters))
1418 ;; HTML-specific preprocessing
1419 (when htmlp
1420 (org-export-html-preprocess parameters))
1422 ;; DocBook-specific preprocessing
1423 (when docbookp
1424 (require 'org-docbook nil)
1425 (org-export-docbook-preprocess parameters))
1427 ;; Remove or replace comments
1428 (org-export-handle-comments (plist-get parameters :comments))
1430 ;; Run the final hook
1431 (run-hooks 'org-export-preprocess-final-hook)
1433 (setq rtn (buffer-string)))
1434 (kill-buffer " org-mode-tmp")
1435 rtn))
1437 (defun org-export-kill-licensed-text ()
1438 "Remove all text that is marked with a :org-license-to-kill property."
1439 (let (p)
1440 (while (setq p (text-property-any (point-min) (point-max)
1441 :org-license-to-kill t))
1442 (delete-region
1443 p (or (next-single-property-change p :org-license-to-kill)
1444 (point-max))))))
1446 (defun org-export-define-heading-targets (target-alist)
1447 "Find all headings and define the targets for them.
1448 The new targets are added to TARGET-ALIST, which is also returned."
1449 (goto-char (point-min))
1450 (org-init-section-numbers)
1451 (let ((re (concat "^" org-outline-regexp
1452 "\\| [ \t]*:\\(ID\\|CUSTOM_ID\\):[ \t]*\\([^ \t\r\n]+\\)"))
1453 level target last-section-target a id)
1454 (while (re-search-forward re nil t)
1455 (if (match-end 2)
1456 (progn
1457 (setq id (org-match-string-no-properties 2))
1458 (push (cons id target) target-alist)
1459 (setq a (or (assoc last-section-target org-export-target-aliases)
1460 (progn
1461 (push (list last-section-target)
1462 org-export-target-aliases)
1463 (car org-export-target-aliases))))
1464 (push (caar target-alist) (cdr a))
1465 (when (equal (match-string 1) "CUSTOM_ID")
1466 (if (not (assoc last-section-target
1467 org-export-preferred-target-alist))
1468 (push (cons last-section-target id)
1469 org-export-preferred-target-alist))))
1470 (setq level (org-reduced-level
1471 (save-excursion (goto-char (point-at-bol))
1472 (org-outline-level))))
1473 (setq target (org-solidify-link-text
1474 (format "sec-%s" (org-section-number level))))
1475 (setq last-section-target target)
1476 (push (cons target target) target-alist)
1477 (add-text-properties
1478 (point-at-bol) (point-at-eol)
1479 (list 'target target)))))
1480 target-alist)
1482 (defun org-export-handle-invisible-targets (target-alist)
1483 "Find targets in comments and move them out of comments.
1484 Mark them as invisible targets."
1485 (let (target tmp a)
1486 (goto-char (point-min))
1487 (while (re-search-forward "^#.*?\\(<<<?\\([^>\r\n]+\\)>>>?\\).*" nil t)
1488 ;; Check if the line before or after is a headline with a target
1489 (if (setq target (or (get-text-property (point-at-bol 0) 'target)
1490 (get-text-property (point-at-bol 2) 'target)))
1491 (progn
1492 ;; use the existing target in a neighboring line
1493 (setq tmp (match-string 2))
1494 (replace-match "")
1495 (and (looking-at "\n") (delete-char 1))
1496 (push (cons (setq tmp (org-solidify-link-text tmp)) target)
1497 target-alist)
1498 (setq a (or (assoc target org-export-target-aliases)
1499 (progn
1500 (push (list target) org-export-target-aliases)
1501 (car org-export-target-aliases))))
1502 (push tmp (cdr a)))
1503 ;; Make an invisible target
1504 (replace-match "\\1(INVISIBLE)"))))
1505 target-alist)
1507 (defun org-export-target-internal-links (target-alist)
1508 "Find all internal links and assign targets to them.
1509 If a link has a fuzzy match (i.e. not a *dedicated* target match),
1510 let the link point to the corresponding section.
1511 This function also handles the id links, if they have a match in
1512 the current file."
1513 (goto-char (point-min))
1514 (while (re-search-forward org-bracket-link-regexp nil t)
1515 (org-if-unprotected-at (match-beginning 1)
1516 (let* ((md (match-data))
1517 (desc (match-end 2))
1518 (link (org-link-unescape (match-string 1)))
1519 (slink (org-solidify-link-text link))
1520 found props pos cref
1521 (target
1522 (cond
1523 ((= (string-to-char link) ?#)
1524 ;; user wants exactly this link
1525 link)
1526 ((cdr (assoc slink target-alist))
1527 (or (cdr (assoc (assoc slink target-alist)
1528 org-export-preferred-target-alist))
1529 (cdr (assoc slink target-alist))))
1530 ((and (string-match "^id:" link)
1531 (cdr (assoc (substring link 3) target-alist))))
1532 ((string-match "^(\\(.*\\))$" link)
1533 (setq cref (match-string 1 link))
1534 (concat "coderef:" cref))
1535 ((string-match org-link-types-re link) nil)
1536 ((or (file-name-absolute-p link)
1537 (string-match "^\\." link))
1538 nil)
1540 (save-excursion
1541 (setq found (condition-case nil (org-link-search link)
1542 (error nil)))
1543 (when (and found
1544 (or (org-on-heading-p)
1545 (not (eq found 'dedicated))))
1546 (or (get-text-property (point) 'target)
1547 (get-text-property
1548 (max (point-min)
1549 (1- (or (previous-single-property-change
1550 (point) 'target) 0)))
1551 'target))))))))
1552 (when target
1553 (set-match-data md)
1554 (goto-char (match-beginning 1))
1555 (setq props (text-properties-at (point)))
1556 (delete-region (match-beginning 1) (match-end 1))
1557 (setq pos (point))
1558 (insert target)
1559 (unless desc (insert "][" link))
1560 (add-text-properties pos (point) props))))))
1562 (defvar org-export-format-drawer-function nil
1563 "Function to be called to format the contents of a drawer.
1564 The function must accept three parameters:
1565 BACKEND one of the symbols html, docbook, latex, ascii, xoxo
1566 NAME the drawer name, like \"PROPERTIES\"
1567 CONTENT the content of the drawer.
1568 The function should return the text to be inserted into the buffer.
1569 If this is nil, `org-export-format-drawer' is used as a default.")
1571 (defun org-export-remove-or-extract-drawers (all-drawers exp-drawers backend)
1572 "Remove drawers, or extract and format the content.
1573 ALL-DRAWERS is a list of all drawer names valid in the current buffer.
1574 EXP-DRAWERS can be t to keep all drawer contents, or a list of drawers
1575 whose content to keep. Any drawers that are in ALL-DRAWERS but not in
1576 EXP-DRAWERS will be removed.
1577 BACKEND is the current export backend."
1578 (goto-char (point-min))
1579 (let ((re (concat "^[ \t]*:\\("
1580 (mapconcat 'identity all-drawers "\\|")
1581 "\\):[ \t]*$"))
1582 name beg beg-content eol content)
1583 (while (re-search-forward re nil t)
1584 (org-if-unprotected
1585 (setq name (match-string 1))
1586 (setq beg (match-beginning 0)
1587 beg-content (1+ (point-at-eol))
1588 eol (point-at-eol))
1589 (if (not (and (re-search-forward
1590 "^\\([ \t]*:END:[ \t]*\n?\\)\\|^\\*+[ \t]" nil t)
1591 (match-end 1)))
1592 (goto-char eol)
1593 (goto-char (match-beginning 0))
1594 (and (looking-at ".*\n?") (replace-match ""))
1595 (setq content (buffer-substring beg-content (point)))
1596 (delete-region beg (point))
1597 (when (or (eq exp-drawers t)
1598 (member name exp-drawers))
1599 (setq content (funcall (or org-export-format-drawer-function
1600 'org-export-format-drawer)
1601 name content backend))
1602 (insert content)))))))
1604 (defun org-export-format-drawer (name content backend)
1605 "Format the content of a drawer as a colon example."
1606 (if (string-match "[ \t]+\\'" content)
1607 (setq content (substring content (match-beginning 0))))
1608 (while (string-match "\\`[ \t]*\n" content)
1609 (setq content (substring content (match-end 0))))
1610 (setq content (org-remove-indentation content))
1611 (setq content (concat ": " (mapconcat 'identity
1612 (org-split-string content "\n")
1613 "\n: ")
1614 "\n"))
1615 (setq content (concat " : " (upcase name) "\n" content))
1616 (org-add-props content nil 'org-protected t))
1618 (defun org-export-handle-export-tags (select-tags exclude-tags)
1619 "Modify the buffer, honoring SELECT-TAGS and EXCLUDE-TAGS.
1620 Both arguments are lists of tags.
1621 If any of SELECT-TAGS is found, all trees not marked by a SELECT-TAG
1622 will be removed.
1623 After that, all subtrees that are marked by EXCLUDE-TAGS will be
1624 removed as well."
1625 (remove-text-properties (point-min) (point-max) '(:org-delete t))
1626 (let* ((re-sel (concat ":\\(" (mapconcat 'regexp-quote
1627 select-tags "\\|")
1628 "\\):"))
1629 (re-excl (concat ":\\(" (mapconcat 'regexp-quote
1630 exclude-tags "\\|")
1631 "\\):"))
1632 beg end cont)
1633 (goto-char (point-min))
1634 (when (and select-tags
1635 (re-search-forward
1636 (concat "^\\*+[ \t].*" re-sel "[^ \t\n]*[ \t]*$") nil t))
1637 ;; At least one tree is marked for export, this means
1638 ;; all the unmarked stuff needs to go.
1639 ;; Dig out the trees that should be exported
1640 (goto-char (point-min))
1641 (outline-next-heading)
1642 (setq beg (point))
1643 (put-text-property beg (point-max) :org-delete t)
1644 (while (re-search-forward re-sel nil t)
1645 (when (org-on-heading-p)
1646 (org-back-to-heading)
1647 (remove-text-properties
1648 (max (1- (point)) (point-min))
1649 (setq cont (save-excursion (org-end-of-subtree t t)))
1650 '(:org-delete t))
1651 (while (and (org-up-heading-safe)
1652 (get-text-property (point) :org-delete))
1653 (remove-text-properties (max (1- (point)) (point-min))
1654 (point-at-eol) '(:org-delete t)))
1655 (goto-char cont))))
1656 ;; Remove the trees explicitly marked for noexport
1657 (when exclude-tags
1658 (goto-char (point-min))
1659 (while (re-search-forward re-excl nil t)
1660 (when (org-at-heading-p)
1661 (org-back-to-heading t)
1662 (setq beg (point))
1663 (org-end-of-subtree t t)
1664 (delete-region beg (point))
1665 (when (featurep 'org-inlinetask)
1666 (org-inlinetask-remove-END-maybe)))))
1667 ;; Remove everything that is now still marked for deletion
1668 (goto-char (point-min))
1669 (while (setq beg (text-property-any (point-min) (point-max) :org-delete t))
1670 (setq end (or (next-single-property-change beg :org-delete)
1671 (point-max)))
1672 (delete-region beg end))))
1674 (defun org-export-remove-archived-trees (export-archived-trees)
1675 "Remove archived trees.
1676 When EXPORT-ARCHIVED-TREES is `headline;, only the headline will be exported.
1677 When it is t, the entire archived tree will be exported.
1678 When it is nil the entire tree including the headline will be removed
1679 from the buffer."
1680 (let ((re-archive (concat ":" org-archive-tag ":"))
1681 a b)
1682 (when (not (eq export-archived-trees t))
1683 (goto-char (point-min))
1684 (while (re-search-forward re-archive nil t)
1685 (if (not (org-on-heading-p t))
1686 (org-end-of-subtree t)
1687 (beginning-of-line 1)
1688 (setq a (if export-archived-trees
1689 (1+ (point-at-eol)) (point))
1690 b (org-end-of-subtree t))
1691 (if (> b a) (delete-region a b)))))))
1693 (defun org-export-remove-headline-metadata (opts)
1694 "Remove meta data from the headline, according to user options."
1695 (let ((re org-complex-heading-regexp)
1696 (todo (plist-get opts :todo-keywords))
1697 (tags (plist-get opts :tags))
1698 (pri (plist-get opts :priority))
1699 (elts '(1 2 3 4 5))
1700 rpl)
1701 (setq elts (delq nil (list 1 (if todo 2) (if pri 3) 4 (if tags 5))))
1702 (when (or (not todo) (not tags) (not pri))
1703 (goto-char (point-min))
1704 (while (re-search-forward re nil t)
1705 (org-if-unprotected
1706 (setq rpl (mapconcat (lambda (i) (if (match-end i) (match-string i) ""))
1707 elts " "))
1708 (replace-match rpl t t))))))
1710 (defun org-export-remove-timestamps ()
1711 "Remove timestamps and keywords for export."
1712 (goto-char (point-min))
1713 (while (re-search-forward org-maybe-keyword-time-regexp nil t)
1714 (backward-char 1)
1715 (org-if-unprotected
1716 (unless (save-match-data (org-at-table-p))
1717 (replace-match "")
1718 (beginning-of-line 1)
1719 (if (looking-at "[- \t]*\\(=>[- \t0-9:]*\\)?[ \t]*\n")
1720 (replace-match ""))))))
1722 (defun org-export-remove-clock-lines ()
1723 "Remove clock lines for export."
1724 (goto-char (point-min))
1725 (let ((re (concat "^[ \t]*" org-clock-string ".*\n?")))
1726 (while (re-search-forward re nil t)
1727 (org-if-unprotected
1728 (replace-match "")))))
1730 (defun org-export-protect-quoted-subtrees ()
1731 "Mark quoted subtrees with the protection property."
1732 (let ((re-quote (concat "^\\*+[ \t]+" org-quote-string "\\>")))
1733 (goto-char (point-min))
1734 (while (re-search-forward re-quote nil t)
1735 (goto-char (match-beginning 0))
1736 (end-of-line 1)
1737 (add-text-properties (point) (org-end-of-subtree t)
1738 '(org-protected t)))))
1740 (defun org-export-protect-verbatim ()
1741 "Mark verbatim snippets with the protection property."
1742 (goto-char (point-min))
1743 (while (re-search-forward org-verbatim-re nil t)
1744 (org-if-unprotected
1745 (add-text-properties (match-beginning 4) (match-end 4)
1746 '(org-protected t org-verbatim-emph t))
1747 (goto-char (1+ (match-end 4))))))
1749 (defun org-export-protect-colon-examples ()
1750 "Protect lines starting with a colon."
1751 (goto-char (point-min))
1752 (let ((re "^[ \t]*:\\([ \t]\\|$\\)") beg)
1753 (while (re-search-forward re nil t)
1754 (beginning-of-line 1)
1755 (setq beg (point))
1756 (while (looking-at re)
1757 (end-of-line 1)
1758 (or (eobp) (forward-char 1)))
1759 (add-text-properties beg (if (bolp) (1- (point)) (point))
1760 '(org-protected t)))))
1762 (defun org-export-select-backend-specific-text (backend)
1763 (let ((formatters
1764 '((docbook "DOCBOOK" "BEGIN_DOCBOOK" "END_DOCBOOK")
1765 (html "HTML" "BEGIN_HTML" "END_HTML")
1766 (beamer "BEAMER" "BEGIN_BEAMER" "END_BEAMER")
1767 (ascii "ASCII" "BEGIN_ASCII" "END_ASCII")
1768 (latex "LaTeX" "BEGIN_LaTeX" "END_LaTeX")))
1769 (case-fold-search t)
1770 fmt beg beg-content end end-content)
1772 (while formatters
1773 (setq fmt (pop formatters))
1774 (when (eq (car fmt) backend)
1775 ;; This is selected code, put it into the file for real
1776 (goto-char (point-min))
1777 (while (re-search-forward (concat "^\\([ \t]*\\)#\\+" (cadr fmt)
1778 ":[ \t]*\\(.*\\)") nil t)
1779 (replace-match "\\1\\2" t)
1780 (add-text-properties
1781 (point-at-bol) (min (1+ (point-at-eol)) (point-max))
1782 '(org-protected t))))
1783 (goto-char (point-min))
1784 (while (re-search-forward (concat "^[ \t]*#\\+" (caddr fmt) "\\>.*\n?")
1785 nil t)
1786 (setq beg (match-beginning 0) beg-content (match-end 0))
1787 (when (re-search-forward (concat "^[ \t]*#\\+" (cadddr fmt) "\\>.*\n?")
1788 nil t)
1789 (setq end (match-end 0) end-content (match-beginning 0))
1790 (if (eq (car fmt) backend)
1791 ;; yes, keep this
1792 (progn
1793 (add-text-properties beg-content end-content '(org-protected t))
1794 (delete-region (match-beginning 0) (match-end 0))
1795 (save-excursion
1796 (goto-char beg)
1797 (delete-region (point) (1+ (point-at-eol)))))
1798 ;; No, this is for a different backend, kill it
1799 (delete-region beg end)))))))
1801 (defun org-export-mark-blockquote-verse-center ()
1802 "Mark block quote and verse environments with special cookies.
1803 These special cookies will later be interpreted by the backend."
1804 ;; Blockquotes
1805 (let (type t1 ind beg end beg1 end1 content)
1806 (goto-char (point-min))
1807 (while (re-search-forward
1808 "^\\([ \t]*\\)#\\+\\(begin_\\(\\(block\\)?quote\\|verse\\|center\\)\\>.*\\)"
1809 nil t)
1810 (setq ind (length (match-string 1))
1811 type (downcase (match-string 3))
1812 t1 (if (equal type "quote") "blockquote" type))
1813 (setq beg (match-beginning 0)
1814 beg1 (1+ (match-end 0)))
1815 (when (re-search-forward (concat "^[ \t]*#\\+end_" type "\\>.*") nil t)
1816 (setq end (1+ (point-at-eol))
1817 end1 (1- (match-beginning 0)))
1818 (setq content (org-remove-indentation (buffer-substring beg1 end1)))
1819 (setq content (concat "ORG-" (upcase t1) "-START\n"
1820 content "\n"
1821 "ORG-" (upcase t1) "-END\n"))
1822 (delete-region beg end)
1823 (insert (org-add-props content nil 'original-indentation ind))))))
1825 (defun org-export-attach-captions-and-attributes (backend target-alist)
1826 "Move #+CAPTION, #+ATTR_BACKEND, and #+LABEL text into text properties.
1827 If the next thing following is a table, add the text properties to the first
1828 table line. If it is a link, add it to the line containing the link."
1829 (goto-char (point-min))
1830 (remove-text-properties (point-min) (point-max)
1831 '(org-caption nil org-attributes nil))
1832 (let ((case-fold-search t)
1833 (re (concat "^[ \t]*#\\+caption:[ \t]+\\(.*\\)"
1834 "\\|"
1835 "^[ \t]*#\\+attr_" (symbol-name backend) ":[ \t]+\\(.*\\)"
1836 "\\|"
1837 "^[ \t]*#\\+label:[ \t]+\\(.*\\)"
1838 "\\|"
1839 "^[ \t]*|[^-]"
1840 "\\|"
1841 "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
1842 cap attr label)
1843 (while (re-search-forward re nil t)
1844 (cond
1845 ((match-end 1)
1846 (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))))
1847 ((match-end 2)
1848 (setq attr (concat attr (if attr " " "") (org-trim (match-string 2)))))
1849 ((match-end 3)
1850 (setq label (org-trim (match-string 3))))
1852 (add-text-properties (point-at-bol) (point-at-eol)
1853 (list 'org-caption cap
1854 'org-attributes attr
1855 'org-label label))
1856 (if label (push (cons label label) target-alist))
1857 (setq cap nil attr nil label nil)))))
1858 target-alist)
1860 (defun org-export-remove-comment-blocks-and-subtrees ()
1861 "Remove the comment environment, and also commented subtrees."
1862 (let ((re-commented (concat "^\\*+[ \t]+" org-comment-string "\\>"))
1863 (case-fold-search nil))
1864 ;; Remove comment environment
1865 (goto-char (point-min))
1866 (while (re-search-forward
1867 "^#\\+BEGIN_COMMENT[ \t]*\n[^\000]*?^#\\+END_COMMENT\\>.*" nil t)
1868 (replace-match "" t t))
1869 ;; Remove subtrees that are commented
1870 (goto-char (point-min))
1871 (while (re-search-forward re-commented nil t)
1872 (goto-char (match-beginning 0))
1873 (delete-region (point) (org-end-of-subtree t)))))
1875 (defun org-export-handle-comments (commentsp)
1876 "Remove comments, or convert to backend-specific format.
1877 COMMENTSP can be a format string for publishing comments.
1878 When it is nil, all comments will be removed."
1879 (let ((re "^\\(#\\|[ \t]*#\\+\\)\\(.*\n?\\)")
1880 pos)
1881 (goto-char (point-min))
1882 (while (or (looking-at re)
1883 (re-search-forward re nil t))
1884 (setq pos (match-beginning 0))
1885 (if (and commentsp
1886 (not (equal (char-before (match-end 1)) ?+)))
1887 (progn (add-text-properties
1888 (match-beginning 0) (match-end 0) '(org-protected t))
1889 (replace-match (format commentsp (match-string 2)) t t))
1890 (goto-char (1+ pos))
1891 (org-if-unprotected
1892 (replace-match "")
1893 (goto-char (max (point-min) (1- pos))))))))
1895 (defun org-export-mark-radio-links ()
1896 "Find all matches for radio targets and turn them into internal links."
1897 (let ((re-radio (and org-target-link-regexp
1898 (concat "\\([^<]\\)\\(" org-target-link-regexp "\\)"))))
1899 (goto-char (point-min))
1900 (when re-radio
1901 (while (re-search-forward re-radio nil t)
1902 (unless
1903 (save-match-data
1904 (or (org-in-regexp org-bracket-link-regexp)
1905 (org-in-regexp org-plain-link-re)))
1906 (org-if-unprotected
1907 (replace-match "\\1[[\\2]]")))))))
1909 (defun org-export-remove-special-table-lines ()
1910 "Remove tables lines that are used for internal purposes."
1911 (goto-char (point-min))
1912 (while (re-search-forward "^[ \t]*|" nil t)
1913 (beginning-of-line 1)
1914 (if (or (looking-at "[ \t]*| *[!_^] *|")
1915 (not
1916 (memq
1918 (mapcar
1919 (lambda (f)
1920 (or (= (length f) 0)
1921 (string-match
1922 "\\`<\\([0-9]\\|[rl]\\|[rl][0-9]+\\)>\\'" f)))
1923 (org-split-string ;; FIXME, can't we do this without splitting???
1924 (buffer-substring (point-at-bol) (point-at-eol))
1925 "[ \t]*|[ \t]*")))))
1926 (delete-region (max (point-min) (1- (point-at-bol)))
1927 (point-at-eol))
1928 (end-of-line 1))))
1930 (defun org-export-protect-sub-super (s)
1931 (save-match-data
1932 (while (string-match "\\([^\\\\]\\)\\([_^]\\)" s)
1933 (setq s (replace-match "\\1\\\\\\2" nil nil s)))
1936 (defun org-export-normalize-links ()
1937 "Convert all links to bracket links, and expand link abbreviations."
1938 (let ((re-plain-link (concat "\\([^[<]\\)" org-plain-link-re))
1939 (re-angle-link (concat "\\([^[]\\)" org-angle-link-re))
1940 nodesc)
1941 (goto-char (point-min))
1942 (while (re-search-forward re-plain-link nil t)
1943 (goto-char (1- (match-end 0)))
1944 (org-if-unprotected-at (1+ (match-beginning 0))
1945 (let* ((s (concat (match-string 1)
1946 "[[" (match-string 2) ":" (match-string 3)
1947 "][" (match-string 2) ":" (org-export-protect-sub-super
1948 (match-string 3))
1949 "]]")))
1950 ;; added 'org-link face to links
1951 (put-text-property 0 (length s) 'face 'org-link s)
1952 (replace-match s t t))))
1953 (goto-char (point-min))
1954 (while (re-search-forward re-angle-link nil t)
1955 (goto-char (1- (match-end 0)))
1956 (org-if-unprotected
1957 (let* ((s (concat (match-string 1)
1958 "[[" (match-string 2) ":" (match-string 3)
1959 "][" (match-string 2) ":" (org-export-protect-sub-super
1960 (match-string 3))
1961 "]]")))
1962 (put-text-property 0 (length s) 'face 'org-link s)
1963 (replace-match s t t))))
1964 (goto-char (point-min))
1965 (while (re-search-forward org-bracket-link-regexp nil t)
1966 (goto-char (1- (match-end 0)))
1967 (setq nodesc (not (match-end 3)))
1968 (org-if-unprotected
1969 (let* ((xx (save-match-data
1970 (org-translate-link
1971 (org-link-expand-abbrev (match-string 1)))))
1972 (s (concat
1973 "[[" (org-add-props (copy-sequence xx)
1974 nil 'org-protected t 'org-no-description nodesc)
1976 (if (match-end 3)
1977 (match-string 2)
1978 (concat "[" (copy-sequence xx)
1979 "]"))
1980 "]")))
1981 (put-text-property 0 (length s) 'face 'org-link s)
1982 (replace-match s t t))))))
1984 (defun org-export-concatenate-multiline-links ()
1985 "Find multi-line links and put it all into a single line.
1986 This is to make sure that the line-processing export backends
1987 can work correctly."
1988 (goto-char (point-min))
1989 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
1990 (org-if-unprotected
1991 (replace-match "\\1 \\3")
1992 (goto-char (match-beginning 0)))))
1994 (defun org-export-concatenate-multiline-emphasis ()
1995 "Find multi-line emphasis and put it all into a single line.
1996 This is to make sure that the line-processing export backends
1997 can work correctly."
1998 (goto-char (point-min))
1999 (while (re-search-forward org-emph-re nil t)
2000 (if (and (not (= (char-after (match-beginning 3))
2001 (char-after (match-beginning 4))))
2002 (save-excursion (goto-char (match-beginning 0))
2003 (save-match-data (not (org-at-table-p)))))
2004 (org-if-unprotected
2005 (subst-char-in-region (match-beginning 0) (match-end 0)
2006 ?\n ?\ t)
2007 (goto-char (1- (match-end 0))))
2008 (goto-char (1+ (match-beginning 0))))))
2010 (defun org-export-grab-title-from-buffer ()
2011 "Get a title for the current document, from looking at the buffer."
2012 (let ((inhibit-read-only t))
2013 (save-excursion
2014 (goto-char (point-min))
2015 (let ((end (if (looking-at org-outline-regexp)
2016 (point)
2017 (save-excursion (outline-next-heading) (point)))))
2018 (when (re-search-forward "^[ \t]*[^|# \t\r\n].*\n" end t)
2019 ;; Mark the line so that it will not be exported as normal text.
2020 (org-unmodified
2021 (add-text-properties (match-beginning 0) (match-end 0)
2022 (list :org-license-to-kill t)))
2023 ;; Return the title string
2024 (org-trim (match-string 0)))))))
2026 (defun org-export-get-title-from-subtree ()
2027 "Return subtree title and exclude it from export."
2028 (let (title (rbeg (region-beginning)) (rend (region-end)))
2029 (save-excursion
2030 (goto-char rbeg)
2031 (when (and (org-at-heading-p)
2032 (>= (org-end-of-subtree t t) rend))
2033 ;; This is a subtree, we take the title from the first heading
2034 (goto-char rbeg)
2035 (looking-at org-todo-line-regexp)
2036 (setq title (match-string 3))
2037 (org-unmodified
2038 (add-text-properties (point) (1+ (point-at-eol))
2039 (list :org-license-to-kill t)))
2040 (setq title (or (org-entry-get nil "EXPORT_TITLE") title))))
2041 title))
2043 (defun org-solidify-link-text (s &optional alist)
2044 "Take link text and make a safe target out of it."
2045 (save-match-data
2046 (let* ((rtn
2047 (mapconcat
2048 'identity
2049 (org-split-string s "[ \t\r\n]+") "=="))
2050 (a (assoc rtn alist)))
2051 (or (cdr a) rtn))))
2053 (defun org-get-min-level (lines &optional offset)
2054 "Get the minimum level in LINES."
2055 (let ((re "^\\(\\*+\\) ") l)
2056 (catch 'exit
2057 (while (setq l (pop lines))
2058 (if (string-match re l)
2059 (throw 'exit (org-tr-level (- (length (match-string 1 l))
2060 (or offset 0))))))
2061 1)))
2063 ;; Variable holding the vector with section numbers
2064 (defvar org-section-numbers (make-vector org-level-max 0))
2066 (defun org-init-section-numbers ()
2067 "Initialize the vector for the section numbers."
2068 (let* ((level -1)
2069 (numbers (nreverse (org-split-string "" "\\.")))
2070 (depth (1- (length org-section-numbers)))
2071 (i depth) number-string)
2072 (while (>= i 0)
2073 (if (> i level)
2074 (aset org-section-numbers i 0)
2075 (setq number-string (or (car numbers) "0"))
2076 (if (string-match "\\`[A-Z]\\'" number-string)
2077 (aset org-section-numbers i
2078 (- (string-to-char number-string) ?A -1))
2079 (aset org-section-numbers i (string-to-number number-string)))
2080 (pop numbers))
2081 (setq i (1- i)))))
2083 (defun org-section-number (&optional level)
2084 "Return a string with the current section number.
2085 When LEVEL is non-nil, increase section numbers on that level."
2086 (let* ((depth (1- (length org-section-numbers)))
2087 (string "")
2088 (fmts (car org-export-section-number-format))
2089 (term (cdr org-export-section-number-format))
2090 (sep "")
2091 ctype fmt idx n)
2092 (when level
2093 (when (> level -1)
2094 (aset org-section-numbers
2095 level (1+ (aref org-section-numbers level))))
2096 (setq idx (1+ level))
2097 (while (<= idx depth)
2098 (if (not (= idx 1))
2099 (aset org-section-numbers idx 0))
2100 (setq idx (1+ idx))))
2101 (setq idx 0)
2102 (while (<= idx depth)
2103 (when (> (aref org-section-numbers idx) 0)
2104 (setq fmt (or (pop fmts) fmt)
2105 ctype (car fmt)
2106 n (aref org-section-numbers idx)
2107 string (if (> n 0)
2108 (concat string sep (org-number-to-counter n ctype))
2109 (concat string ".0"))
2110 sep (nth 1 fmt)))
2111 (setq idx (1+ idx)))
2112 (save-match-data
2113 (if (string-match "\\`\\([@0]\\.\\)+" string)
2114 (setq string (replace-match "" t nil string)))
2115 (if (string-match "\\(\\.0\\)+\\'" string)
2116 (setq string (replace-match "" t nil string))))
2117 (concat string term)))
2119 (defun org-number-to-counter (n type)
2120 "Concert number N to a string counter, according to TYPE.
2121 TYPE must be a string, any of:
2122 1 number
2123 A A,B,....
2124 a a,b,....
2125 I upper case roman numeral
2126 i lower case roman numeral"
2127 (cond
2128 ((equal type "1") (number-to-string n))
2129 ((equal type "A") (char-to-string (+ ?A n -1)))
2130 ((equal type "a") (char-to-string (+ ?a n -1)))
2131 ((equal type "I") (org-number-to-roman n))
2132 ((equal type "i") (downcase (org-number-to-roman n)))
2133 (t (error "Invalid counter type `%s'" type))))
2135 (defun org-number-to-roman (n)
2136 "Convert integer N into a roman numeral."
2137 (let ((roman '((1000 . "M") (900 . "CM") (500 . "D") (400 . "CD")
2138 ( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
2139 ( 10 . "X") ( 9 . "IX") ( 5 . "V") ( 4 . "IV")
2140 ( 1 . "I")))
2141 (res ""))
2142 (if (<= n 0)
2143 (number-to-string n)
2144 (while roman
2145 (if (>= n (caar roman))
2146 (setq n (- n (caar roman))
2147 res (concat res (cdar roman)))
2148 (pop roman)))
2149 res)))
2151 ;;; Macros
2153 (defun org-export-preprocess-apply-macros ()
2154 "Replace macro references."
2155 (goto-char (point-min))
2156 (let (sy val key args args2 s n)
2157 (while (re-search-forward
2158 "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}"
2159 nil t)
2160 (unless (save-match-data
2161 (save-excursion
2162 (goto-char (point-at-bol))
2163 (looking-at "[ \t]*#\\+macro")))
2164 (setq key (downcase (match-string 1))
2165 args (match-string 3))
2166 (when (setq val (or (plist-get org-export-opt-plist
2167 (intern (concat ":macro-" key)))
2168 (plist-get org-export-opt-plist
2169 (intern (concat ":" key)))))
2170 (save-match-data
2171 (when args
2172 (setq args (org-split-string args ",[ \t\n]*") args2 nil)
2173 (setq args (mapcar 'org-trim args))
2174 (while args
2175 (while (string-match "\\\\\\'" (car args))
2176 ;; repair bad splits
2177 (setcar (cdr args) (concat (substring (car args) 0 -1)
2178 ";" (nth 1 args)))
2179 (pop args))
2180 (push (pop args) args2))
2181 (setq args (nreverse args2))
2182 (setq s 0)
2183 (while (string-match "\\$\\([0-9]+\\)" val s)
2184 (setq s (1+ (match-beginning 0))
2185 n (string-to-number (match-string 1 val)))
2186 (and (>= (length args) n)
2187 (setq val (replace-match (nth (1- n) args) t t val)))))
2188 (when (string-match "\\`(eval\\>" val)
2189 (setq val (eval (read val))))
2190 (if (and val (not (stringp val)))
2191 (setq val (format "%s" val))))
2192 (and (stringp val)
2193 (prog1 (replace-match val t t)
2194 (goto-char (match-beginning 0)))))))))
2196 (defun org-export-apply-macros-in-string (s)
2197 "Apply the macros in string S."
2198 (when s
2199 (with-temp-buffer
2200 (insert s)
2201 (org-export-preprocess-apply-macros)
2202 (buffer-string))))
2204 ;;; Include files
2206 (defun org-export-handle-include-files ()
2207 "Include the contents of include files, with proper formatting."
2208 (let ((case-fold-search t)
2209 params file markup lang start end prefix prefix1 switches)
2210 (goto-char (point-min))
2211 (while (re-search-forward "^#\\+INCLUDE:?[ \t]+\\(.*\\)" nil t)
2212 (setq params (read (concat "(" (match-string 1) ")"))
2213 prefix (org-get-and-remove-property 'params :prefix)
2214 prefix1 (org-get-and-remove-property 'params :prefix1)
2215 file (org-symname-or-string (pop params))
2216 markup (org-symname-or-string (pop params))
2217 lang (and (member markup '("src" "SRC"))
2218 (org-symname-or-string (pop params)))
2219 switches (mapconcat '(lambda (x) (format "%s" x)) params " ")
2220 start nil end nil)
2221 (delete-region (match-beginning 0) (match-end 0))
2222 (if (or (not file)
2223 (not (file-exists-p file))
2224 (not (file-readable-p file)))
2225 (insert (format "CANNOT INCLUDE FILE %s" file))
2226 (when markup
2227 (if (equal (downcase markup) "src")
2228 (setq start (format "#+begin_src %s %s\n"
2229 (or lang "fundamental")
2230 (or switches ""))
2231 end "#+end_src")
2232 (setq start (format "#+begin_%s %s\n" markup switches)
2233 end (format "#+end_%s" markup))))
2234 (insert (or start ""))
2235 (insert (org-get-file-contents (expand-file-name file)
2236 prefix prefix1 markup))
2237 (or (bolp) (newline))
2238 (insert (or end ""))))))
2240 (defun org-get-file-contents (file &optional prefix prefix1 markup)
2241 "Get the contents of FILE and return them as a string.
2242 If PREFIX is a string, prepend it to each line. If PREFIX1
2243 is a string, prepend it to the first line instead of PREFIX.
2244 If MARKUP, don't protect org-like lines, the exporter will
2245 take care of the block they are in."
2246 (if (stringp markup) (setq markup (downcase markup)))
2247 (with-temp-buffer
2248 (insert-file-contents file)
2249 (when (or prefix prefix1)
2250 (goto-char (point-min))
2251 (while (not (eobp))
2252 (insert (or prefix1 prefix))
2253 (setq prefix1 nil)
2254 (beginning-of-line 2)))
2255 (buffer-string)
2256 (when (member markup '("src" "example"))
2257 (goto-char (point-min))
2258 (while (re-search-forward "^\\([*#]\\|[ \t]*#\\+\\)" nil t)
2259 (goto-char (match-beginning 0))
2260 (insert ",")
2261 (end-of-line 1)))
2262 (buffer-string)))
2264 (defun org-get-and-remove-property (listvar prop)
2265 "Check if the value of LISTVAR contains PROP as a property.
2266 If yes, return the value of that property (i.e. the element following
2267 in the list) and remove property and value from the list in LISTVAR."
2268 (let ((list (symbol-value listvar)) m v)
2269 (when (setq m (member prop list))
2270 (setq v (nth 1 m))
2271 (if (equal (car list) prop)
2272 (set listvar (cddr list))
2273 (setcdr (nthcdr (- (length list) (length m) 1) list)
2274 (cddr m))
2275 (set listvar list)))
2278 (defun org-symname-or-string (s)
2279 (if (symbolp s)
2280 (if s (symbol-name s) s)
2283 ;;; Fontification and line numbers for code examples
2285 (defvar org-export-last-code-line-counter-value 0)
2287 (defun org-export-replace-src-segments-and-examples (backend)
2288 "Replace source code segments with special code for export."
2289 (setq org-export-last-code-line-counter-value 0)
2290 (let ((case-fold-search t)
2291 lang code trans opts indent)
2292 (goto-char (point-min))
2293 (while (re-search-forward
2294 "\\(^\\([ \t]*\\)#\\+BEGIN_SRC:?[ \t]+\\([^ \t\n]+\\)\\(.*\\)\n\\([^\000]+?\n\\)[ \t]*#\\+END_SRC.*\n?\\)\\|\\(^\\([ \t]*\\)#\\+BEGIN_EXAMPLE:?\\(?:[ \t]+\\(.*\\)\\)?\n\\([^\000]+?\n\\)[ \t]*#\\+END_EXAMPLE.*\n?\\)"
2295 nil t)
2296 (if (match-end 1)
2297 ;; src segments
2298 (setq lang (match-string 3)
2299 opts (match-string 4)
2300 code (match-string 5)
2301 indent (length (match-string 2)))
2302 (setq lang nil
2303 opts (match-string 8)
2304 code (match-string 9)
2305 indent (length (match-string 7))))
2307 (setq trans (org-export-format-source-code-or-example
2308 backend lang code opts indent))
2309 (replace-match trans t t))))
2311 (defvar htmlp) ;; dynamically scoped
2312 (defvar latexp) ;; dynamically scoped
2313 (defvar org-export-latex-verbatim-wrap) ;; defined in org-latex.el
2314 (defvar org-export-latex-listings) ;; defined in org-latex.el
2315 (defvar org-export-latex-listings-langs) ;; defined in org-latex.el
2317 (defun org-export-format-source-code-or-example
2318 (backend lang code &optional opts indent)
2319 "Format CODE from language LANG and return it formatted for export.
2320 If LANG is nil, do not add any fontification.
2321 OPTS contains formatting options, like `-n' for triggering numbering lines,
2322 and `+n' for continuing previous numbering.
2323 Code formatting according to language currently only works for HTML.
2324 Numbering lines works for all three major backends (html, latex, and ascii).
2325 INDENT was the original indentation of the block."
2326 (save-match-data
2327 (let (num cont rtn rpllbl keepp textareap preserve-indentp cols rows fmt)
2328 (setq opts (or opts "")
2329 num (string-match "[-+]n\\>" opts)
2330 cont (string-match "\\+n\\>" opts)
2331 rpllbl (string-match "-r\\>" opts)
2332 keepp (string-match "-k\\>" opts)
2333 textareap (string-match "-t\\>" opts)
2334 preserve-indentp (or org-src-preserve-indentation
2335 (string-match "-i\\>" opts))
2336 cols (if (string-match "-w[ \t]+\\([0-9]+\\)" opts)
2337 (string-to-number (match-string 1 opts))
2339 rows (if (string-match "-h[ \t]+\\([0-9]+\\)" opts)
2340 (string-to-number (match-string 1 opts))
2341 (org-count-lines code))
2342 fmt (if (string-match "-l[ \t]+\"\\([^\"\n]+\\)\"" opts)
2343 (match-string 1 opts)))
2344 (when (and textareap (eq backend 'html))
2345 ;; we cannot use numbering or highlighting.
2346 (setq num nil cont nil lang nil))
2347 (if keepp (setq rpllbl 'keep))
2348 (setq rtn (if preserve-indentp code (org-remove-indentation code)))
2349 (when (string-match "^," rtn)
2350 (setq rtn (with-temp-buffer
2351 (insert rtn)
2352 ;; Free up the protected lines
2353 (goto-char (point-min))
2354 (while (re-search-forward "^," nil t)
2355 (if (or (equal lang "org")
2356 (save-match-data
2357 (looking-at "\\([*#]\\|[ \t]*#\\+\\)")))
2358 (replace-match ""))
2359 (end-of-line 1))
2360 (buffer-string))))
2361 ;; Now backend-specific coding
2362 (setq rtn
2363 (cond
2364 ((eq backend 'docbook)
2365 (setq rtn (org-export-number-lines rtn 'docbook 0 0 num cont rpllbl fmt))
2366 (concat "\n#+BEGIN_DOCBOOK\n"
2367 (org-add-props (concat "<programlisting><![CDATA["
2369 "]]>\n</programlisting>\n")
2370 '(org-protected t))
2371 "#+END_DOCBOOK\n"))
2372 ((eq backend 'html)
2373 ;; We are exporting to HTML
2374 (when lang
2375 (require 'htmlize nil t)
2376 (when (not (fboundp 'htmlize-region-for-paste))
2377 ;; we do not have htmlize.el, or an old version of it
2378 (setq lang nil)
2379 (message
2380 "htmlize.el 1.34 or later is needed for source code formatting")))
2382 (if lang
2383 (let* ((lang-m (when lang
2384 (or (cdr (assoc lang org-src-lang-modes))
2385 lang)))
2386 (mode (and lang-m (intern
2387 (concat
2388 (if (symbolp lang-m)
2389 (symbol-name lang-m)
2390 lang-m)
2391 "-mode"))))
2392 (org-inhibit-startup t)
2393 (org-startup-folded nil))
2394 (setq rtn
2395 (with-temp-buffer
2396 (insert rtn)
2397 (if (functionp mode)
2398 (funcall mode)
2399 (fundamental-mode))
2400 (font-lock-fontify-buffer)
2401 (org-src-mode)
2402 (set-buffer-modified-p nil)
2403 (org-export-htmlize-region-for-paste
2404 (point-min) (point-max))))
2405 (if (string-match "<pre\\([^>]*\\)>\n*" rtn)
2406 (setq rtn (replace-match
2407 (format "<pre class=\"src src-%s\">\n" lang)
2408 t t rtn))))
2409 (if textareap
2410 (setq rtn (concat
2411 (format "<p>\n<textarea cols=\"%d\" rows=\"%d\" overflow-x:scroll >\n"
2412 cols rows)
2413 rtn "</textarea>\n</p>\n"))
2414 (with-temp-buffer
2415 (insert rtn)
2416 (goto-char (point-min))
2417 (while (re-search-forward "[<>&]" nil t)
2418 (replace-match (cdr (assq (char-before)
2419 '((?&."&amp;")(?<."&lt;")(?>."&gt;"))))
2420 t t))
2421 (setq rtn (buffer-string)))
2422 (setq rtn (concat "<pre class=\"example\">\n" rtn "</pre>\n"))))
2423 (unless textareap
2424 (setq rtn (org-export-number-lines rtn 'html 1 1 num
2425 cont rpllbl fmt)))
2426 (if (string-match "\\(\\`<[^>]*>\\)\n" rtn)
2427 (setq rtn (replace-match "\\1" t nil rtn)))
2428 (concat "\n#+BEGIN_HTML\n" (org-add-props rtn '(org-protected t)) "\n#+END_HTML\n\n"))
2429 ((eq backend 'latex)
2430 (setq rtn (org-export-number-lines rtn 'latex 0 0 num cont rpllbl fmt))
2431 (concat "#+BEGIN_LaTeX\n"
2432 (org-add-props
2433 (if org-export-latex-listings
2434 (concat
2435 (if lang
2436 (let*
2437 ((lang-sym (intern lang))
2438 (lstlang
2439 (or (cadr
2440 (assq
2441 lang-sym
2442 org-export-latex-listings-langs))
2443 lang)))
2444 (format "\\lstset{language=%s}\n" lstlang))
2446 "\\begin{lstlisting}\n"
2447 rtn "\\end{lstlisting}\n")
2448 (concat (car org-export-latex-verbatim-wrap)
2449 rtn (cdr org-export-latex-verbatim-wrap)))
2450 '(org-protected t))
2451 "#+END_LaTeX\n"))
2452 ((eq backend 'ascii)
2453 ;; This is not HTML or LaTeX, so just make it an example.
2454 (setq rtn (org-export-number-lines rtn 'ascii 0 0 num cont rpllbl fmt))
2455 (concat "#+BEGIN_ASCII\n"
2456 (org-add-props
2457 (concat
2458 (mapconcat
2459 (lambda (l) (concat " " l))
2460 (org-split-string rtn "\n")
2461 "\n")
2462 "\n")
2463 '(org-protected t))
2464 "#+END_ASCII\n"))))
2465 (org-add-props rtn nil 'original-indentation indent))))
2467 (defun org-export-number-lines (text backend
2468 &optional skip1 skip2 number cont
2469 replace-labels label-format)
2470 (setq skip1 (or skip1 0) skip2 (or skip2 0))
2471 (if (not cont) (setq org-export-last-code-line-counter-value 0))
2472 (with-temp-buffer
2473 (insert text)
2474 (goto-char (point-max))
2475 (skip-chars-backward " \t\n\r")
2476 (delete-region (point) (point-max))
2477 (beginning-of-line (- 1 skip2))
2478 (let* ((last (org-current-line))
2479 (n org-export-last-code-line-counter-value)
2480 (nmax (+ n (- last skip1)))
2481 (fmt (format "%%%dd: " (length (number-to-string nmax))))
2483 (cond
2484 ((eq backend 'html) (format "<span class=\"linenr\">%s</span>"
2485 fmt))
2486 ((eq backend 'ascii) fmt)
2487 ((eq backend 'latex) fmt)
2488 ((eq backend 'docbook) fmt)
2489 (t "")))
2490 (label-format (or label-format org-coderef-label-format))
2491 (label-pre (if (string-match "%s" label-format)
2492 (substring label-format 0 (match-beginning 0))
2493 label-format))
2494 (label-post (if (string-match "%s" label-format)
2495 (substring label-format (match-end 0))
2496 ""))
2497 (lbl-re
2498 (concat
2499 ".*?\\S-.*?\\([ \t]*\\("
2500 (regexp-quote label-pre)
2501 "\\([-a-zA-Z0-9_ ]+\\)"
2502 (regexp-quote label-post)
2503 "\\)\\)"))
2504 ref)
2506 (org-goto-line (1+ skip1))
2507 (while (and (re-search-forward "^" nil t) (not (eobp)) (< n nmax))
2508 (if number
2509 (insert (format fm (incf n)))
2510 (forward-char 1))
2511 (when (looking-at lbl-re)
2512 (setq ref (match-string 3))
2513 (cond ((numberp replace-labels)
2514 ;; remove labels; use numbers for references when lines
2515 ;; are numbered, use labels otherwise
2516 (delete-region (match-beginning 1) (match-end 1))
2517 (push (cons ref (if (> n 0) n ref)) org-export-code-refs))
2518 ((eq replace-labels 'keep)
2519 ;; don't remove labels; use numbers for references when
2520 ;; lines are numbered, use labels otherwise
2521 (goto-char (match-beginning 2))
2522 (delete-region (match-beginning 2) (match-end 2))
2523 (insert "(" ref ")")
2524 (push (cons ref (if (> n 0) n (concat "(" ref ")")))
2525 org-export-code-refs))
2527 ;; don't remove labels and don't use numbers for
2528 ;; references
2529 (goto-char (match-beginning 2))
2530 (delete-region (match-beginning 2) (match-end 2))
2531 (insert "(" ref ")")
2532 (push (cons ref (concat "(" ref ")")) org-export-code-refs)))
2533 (when (eq backend 'html)
2534 (save-excursion
2535 (beginning-of-line 1)
2536 (insert (format "<span id=\"coderef-%s\" class=\"coderef-off\">"
2537 ref))
2538 (end-of-line 1)
2539 (insert "</span>")))))
2540 (setq org-export-last-code-line-counter-value n)
2541 (goto-char (point-max))
2542 (newline)
2543 (buffer-string))))
2545 (defun org-search-todo-below (line lines level)
2546 "Search the subtree below LINE for any TODO entries."
2547 (let ((rest (cdr (memq line lines)))
2548 (re org-todo-line-regexp)
2549 line lv todo)
2550 (catch 'exit
2551 (while (setq line (pop rest))
2552 (if (string-match re line)
2553 (progn
2554 (setq lv (- (match-end 1) (match-beginning 1))
2555 todo (and (match-beginning 2)
2556 (not (member (match-string 2 line)
2557 org-done-keywords))))
2558 ; TODO, not DONE
2559 (if (<= lv level) (throw 'exit nil))
2560 (if todo (throw 'exit t))))))))
2562 ;;;###autoload
2563 (defun org-export-visible (type arg)
2564 "Create a copy of the visible part of the current buffer, and export it.
2565 The copy is created in a temporary buffer and removed after use.
2566 TYPE is the final key (as a string) that also select the export command in
2567 the `C-c C-e' export dispatcher.
2568 As a special case, if the you type SPC at the prompt, the temporary
2569 org-mode file will not be removed but presented to you so that you can
2570 continue to use it. The prefix arg ARG is passed through to the exporting
2571 command."
2572 (interactive
2573 (list (progn
2574 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]buffer with HTML [D]ocBook [l]atex [p]df [d]view pdf [L]atex buffer [x]OXO [ ]keep buffer")
2575 (read-char-exclusive))
2576 current-prefix-arg))
2577 (if (not (member type '(?a ?\C-a ?b ?\C-b ?h ?D ?x ?\ ?l ?p ?d ?L)))
2578 (error "Invalid export key"))
2579 (let* ((binding (cdr (assoc type
2580 '((?a . org-export-as-ascii)
2581 (?A . org-export-as-ascii-to-buffer)
2582 (?\C-a . org-export-as-ascii)
2583 (?b . org-export-as-html-and-open)
2584 (?\C-b . org-export-as-html-and-open)
2585 (?h . org-export-as-html)
2586 (?H . org-export-as-html-to-buffer)
2587 (?R . org-export-region-as-html)
2588 (?D . org-export-as-docbook)
2590 (?l . org-export-as-latex)
2591 (?p . org-export-as-pdf)
2592 (?d . org-export-as-pdf-and-open)
2593 (?L . org-export-as-latex-to-buffer)
2595 (?x . org-export-as-xoxo)))))
2596 (keepp (equal type ?\ ))
2597 (file buffer-file-name)
2598 (buffer (get-buffer-create "*Org Export Visible*"))
2599 s e)
2600 ;; Need to hack the drawers here.
2601 (save-excursion
2602 (goto-char (point-min))
2603 (while (re-search-forward org-drawer-regexp nil t)
2604 (goto-char (match-beginning 1))
2605 (or (org-invisible-p) (org-flag-drawer nil))))
2606 (with-current-buffer buffer (erase-buffer))
2607 (save-excursion
2608 (setq s (goto-char (point-min)))
2609 (while (not (= (point) (point-max)))
2610 (goto-char (org-find-invisible))
2611 (append-to-buffer buffer s (point))
2612 (setq s (goto-char (org-find-visible))))
2613 (org-cycle-hide-drawers 'all)
2614 (goto-char (point-min))
2615 (unless keepp
2616 ;; Copy all comment lines to the end, to make sure #+ settings are
2617 ;; still available for the second export step. Kind of a hack, but
2618 ;; does do the trick.
2619 (if (looking-at "#[^\r\n]*")
2620 (append-to-buffer buffer (match-beginning 0) (1+ (match-end 0))))
2621 (while (re-search-forward "[\n\r]#[^\n\r]*" nil t)
2622 (append-to-buffer buffer (1+ (match-beginning 0))
2623 (min (point-max) (1+ (match-end 0))))))
2624 (set-buffer buffer)
2625 (let ((buffer-file-name file)
2626 (org-inhibit-startup t))
2627 (org-mode)
2628 (show-all)
2629 (unless keepp (funcall binding arg))))
2630 (if (not keepp)
2631 (kill-buffer buffer)
2632 (switch-to-buffer-other-window buffer)
2633 (goto-char (point-min)))))
2635 (defun org-find-visible ()
2636 (let ((s (point)))
2637 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
2638 (get-char-property s 'invisible)))
2640 (defun org-find-invisible ()
2641 (let ((s (point)))
2642 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
2643 (not (get-char-property s 'invisible))))
2646 (defvar org-export-htmlized-org-css-url) ;; defined in org-html.el
2648 ;;;###autoload
2649 (defun org-export-as-org (arg &optional hidden ext-plist
2650 to-buffer body-only pub-dir)
2651 "Make a copy with not-exporting stuff removed.
2652 The purpose of this function is to provide a way to export the source
2653 Org file of a webpage in Org format, but with sensitive and/or irrelevant
2654 stuff removed. This command will remove the following:
2656 - archived trees (if the variable `org-export-with-archived-trees' is nil)
2657 - comment blocks and trees starting with the COMMENT keyword
2658 - only trees that are consistent with `org-export-select-tags'
2659 and `org-export-exclude-tags'.
2661 The only arguments that will be used are EXT-PLIST and PUB-DIR,
2662 all the others will be ignored (but are present so that the general
2663 mechanism to call publishing functions will work).
2665 EXT-PLIST is a property list with external parameters overriding
2666 org-mode's default settings, but still inferior to file-local
2667 settings. When PUB-DIR is set, use this as the publishing
2668 directory."
2669 (interactive "P")
2670 (let* ((opt-plist (org-combine-plists (org-default-export-plist)
2671 ext-plist
2672 (org-infile-export-plist)))
2673 (bfname (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
2674 (filename (concat (file-name-as-directory
2675 (or pub-dir
2676 (org-export-directory :org opt-plist)))
2677 (file-name-sans-extension
2678 (file-name-nondirectory bfname))
2679 ".org"))
2680 (filename (and filename
2681 (if (equal (file-truename filename)
2682 (file-truename bfname))
2683 (concat (file-name-sans-extension filename)
2684 "-source."
2685 (file-name-extension filename))
2686 filename)))
2687 (backup-inhibited t)
2688 (buffer (find-file-noselect filename))
2689 (region (buffer-string)))
2690 (save-excursion
2691 (switch-to-buffer buffer)
2692 (erase-buffer)
2693 (insert region)
2694 (let ((org-inhibit-startup t)) (org-mode))
2695 (org-install-letbind)
2697 ;; Get rid of archived trees
2698 (org-export-remove-archived-trees (plist-get opt-plist :archived-trees))
2700 ;; Remove comment environment and comment subtrees
2701 (org-export-remove-comment-blocks-and-subtrees)
2703 ;; Get rid of excluded trees
2704 (org-export-handle-export-tags (plist-get opt-plist :select-tags)
2705 (plist-get opt-plist :exclude-tags))
2707 (when (or (plist-get opt-plist :plain-source)
2708 (not (or (plist-get opt-plist :plain-source)
2709 (plist-get opt-plist :htmlized-source))))
2710 ;; Either nothing special is requested (default call)
2711 ;; or the plain source is explicitly requested
2712 ;; so: save it
2713 (save-buffer))
2714 (when (plist-get opt-plist :htmlized-source)
2715 ;; Make the htmlized version
2716 (require 'htmlize)
2717 (require 'org-html)
2718 (font-lock-fontify-buffer)
2719 (let* ((htmlize-output-type 'css)
2720 (newbuf (htmlize-buffer)))
2721 (with-current-buffer newbuf
2722 (when org-export-htmlized-org-css-url
2723 (goto-char (point-min))
2724 (and (re-search-forward
2725 "<style type=\"text/css\">[^\000]*?\n[ \t]*</style>.*"
2726 nil t)
2727 (replace-match
2728 (format
2729 "<link rel=\"stylesheet\" type=\"text/css\" href=\"%s\">"
2730 org-export-htmlized-org-css-url)
2731 t t)))
2732 (write-file (concat filename ".html")))
2733 (kill-buffer newbuf)))
2734 (set-buffer-modified-p nil)
2735 (kill-buffer (current-buffer)))))
2737 (defvar org-archive-location) ;; gets loaded with the org-archive require.
2738 (defun org-get-current-options ()
2739 "Return a string with current options as keyword options.
2740 Does include HTML export options as well as TODO and CATEGORY stuff."
2741 (require 'org-archive)
2742 (format
2743 "#+TITLE: %s
2744 #+AUTHOR: %s
2745 #+EMAIL: %s
2746 #+DATE: %s
2747 #+DESCRIPTION:
2748 #+KEYWORDS:
2749 #+LANGUAGE: %s
2750 #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s -:%s f:%s *:%s <:%s
2751 #+OPTIONS: TeX:%s LaTeX:%s skip:%s d:%s todo:%s pri:%s tags:%s
2753 #+EXPORT_SELECT_TAGS: %s
2754 #+EXPORT_EXCLUDE_TAGS: %s
2755 #+LINK_UP: %s
2756 #+LINK_HOME: %s
2757 #+CATEGORY: %s
2758 #+SEQ_TODO: %s
2759 #+TYP_TODO: %s
2760 #+PRIORITIES: %c %c %c
2761 #+DRAWERS: %s
2762 #+STARTUP: %s %s %s %s %s
2763 #+TAGS: %s
2764 #+FILETAGS: %s
2765 #+ARCHIVE: %s
2766 #+LINK: %s
2768 (buffer-name) (user-full-name) user-mail-address
2769 (format-time-string (substring (car org-time-stamp-formats) 1 -1))
2770 org-export-default-language
2771 org-export-headline-levels
2772 org-export-with-section-numbers
2773 org-export-with-toc
2774 org-export-preserve-breaks
2775 org-export-html-expand
2776 org-export-with-fixed-width
2777 org-export-with-tables
2778 org-export-with-sub-superscripts
2779 org-export-with-special-strings
2780 org-export-with-footnotes
2781 org-export-with-emphasize
2782 org-export-with-timestamps
2783 org-export-with-TeX-macros
2784 org-export-with-LaTeX-fragments
2785 org-export-skip-text-before-1st-heading
2786 org-export-with-drawers
2787 org-export-with-todo-keywords
2788 org-export-with-priority
2789 org-export-with-tags
2790 (if (featurep 'org-jsinfo) (org-infojs-options-inbuffer-template) "")
2791 (mapconcat 'identity org-export-select-tags " ")
2792 (mapconcat 'identity org-export-exclude-tags " ")
2793 org-export-html-link-up
2794 org-export-html-link-home
2795 (or (ignore-errors
2796 (file-name-sans-extension
2797 (file-name-nondirectory (buffer-file-name (buffer-base-buffer)))))
2798 "NOFILENAME")
2799 "TODO FEEDBACK VERIFY DONE"
2800 "Me Jason Marie DONE"
2801 org-highest-priority org-lowest-priority org-default-priority
2802 (mapconcat 'identity org-drawers " ")
2803 (cdr (assoc org-startup-folded
2804 '((nil . "showall") (t . "overview") (content . "content"))))
2805 (if org-odd-levels-only "odd" "oddeven")
2806 (if org-hide-leading-stars "hidestars" "showstars")
2807 (if org-startup-align-all-tables "align" "noalign")
2808 (cond ((eq org-log-done t) "logdone")
2809 ((equal org-log-done 'note) "lognotedone")
2810 ((not org-log-done) "nologdone"))
2811 (or (mapconcat (lambda (x)
2812 (cond
2813 ((equal :startgroup (car x)) "{")
2814 ((equal :endgroup (car x)) "}")
2815 ((equal :newline (car x)) "")
2816 ((cdr x) (format "%s(%c)" (car x) (cdr x)))
2817 (t (car x))))
2818 (or org-tag-alist (org-get-buffer-tags)) " ") "")
2819 (mapconcat 'identity org-file-tags " ")
2820 org-archive-location
2821 "org file:~/org/%s.org"
2824 ;;;###autoload
2825 (defun org-insert-export-options-template ()
2826 "Insert into the buffer a template with information for exporting."
2827 (interactive)
2828 (if (not (bolp)) (newline))
2829 (let ((s (org-get-current-options)))
2830 (and (string-match "#\\+CATEGORY" s)
2831 (setq s (substring s 0 (match-beginning 0))))
2832 (insert s)))
2834 (defvar org-table-colgroup-info nil)
2836 (defun org-table-clean-before-export (lines &optional maybe-quoted)
2837 "Check if the table has a marking column.
2838 If yes remove the column and the special lines."
2839 (setq org-table-colgroup-info nil)
2840 (if (memq nil
2841 (mapcar
2842 (lambda (x) (or (string-match "^[ \t]*|-" x)
2843 (string-match
2844 (if maybe-quoted
2845 "^[ \t]*| *\\\\?\\([\#!$*_^ /]\\) *|"
2846 "^[ \t]*| *\\([\#!$*_^ /]\\) *|")
2847 x)))
2848 lines))
2849 (progn
2850 (setq org-table-clean-did-remove-column nil)
2851 (delq nil
2852 (mapcar
2853 (lambda (x)
2854 (cond
2855 ((string-match "^[ \t]*| */ *|" x)
2856 (setq org-table-colgroup-info
2857 (mapcar (lambda (x)
2858 (cond ((member x '("<" "&lt;")) :start)
2859 ((member x '(">" "&gt;")) :end)
2860 ((member x '("<>" "&lt;&gt;")) :startend)
2861 (t nil)))
2862 (org-split-string x "[ \t]*|[ \t]*")))
2863 nil)
2864 (t x)))
2865 lines)))
2866 (setq org-table-clean-did-remove-column t)
2867 (delq nil
2868 (mapcar
2869 (lambda (x)
2870 (cond
2871 ((string-match "^[ \t]*| */ *|" x)
2872 (setq org-table-colgroup-info
2873 (mapcar (lambda (x)
2874 (cond ((member x '("<" "&lt;")) :start)
2875 ((member x '(">" "&gt;")) :end)
2876 ((member x '("<>" "&lt;&gt;")) :startend)
2877 (t nil)))
2878 (cdr (org-split-string x "[ \t]*|[ \t]*"))))
2879 nil)
2880 ((string-match "^[ \t]*| *[!_^/] *|" x)
2881 nil) ; ignore this line
2882 ((or (string-match "^\\([ \t]*\\)|-+\\+" x)
2883 (string-match "^\\([ \t]*\\)|[^|]*|" x))
2884 ;; remove the first column
2885 (replace-match "\\1|" t nil x))))
2886 lines))))
2888 (defun org-export-cleanup-toc-line (s)
2889 "Remove tags and timestamps from lines going into the toc."
2890 (when (memq org-export-with-tags '(not-in-toc nil))
2891 (if (string-match (org-re " +:[[:alnum:]_@:]+: *$") s)
2892 (setq s (replace-match "" t t s))))
2893 (when org-export-remove-timestamps-from-toc
2894 (while (string-match org-maybe-keyword-time-regexp s)
2895 (setq s (replace-match "" t t s))))
2896 (while (string-match org-bracket-link-regexp s)
2897 (setq s (replace-match (match-string (if (match-end 3) 3 1) s)
2898 t t s)))
2899 (while (string-match "\\[\\([0-9]\\|fn:[^]]*\\)\\]" s)
2900 (setq s (replace-match "" t t s)))
2903 (defun org-create-multibrace-regexp (left right n)
2904 "Create a regular expression which will match a balanced sexp.
2905 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
2906 as single character strings.
2907 The regexp returned will match the entire expression including the
2908 delimiters. It will also define a single group which contains the
2909 match except for the outermost delimiters. The maximum depth of
2910 stacked delimiters is N. Escaping delimiters is not possible."
2911 (let* ((nothing (concat "[^" left right "]*?"))
2912 (or "\\|")
2913 (re nothing)
2914 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
2915 (while (> n 1)
2916 (setq n (1- n)
2917 re (concat re or next)
2918 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
2919 (concat left "\\(" re "\\)" right)))
2921 (defvar org-match-substring-regexp
2922 (concat
2923 "\\([^\\]\\)\\([_^]\\)\\("
2924 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
2925 "\\|"
2926 "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
2927 "\\|"
2928 "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
2929 "The regular expression matching a sub- or superscript.")
2931 (defvar org-match-substring-with-braces-regexp
2932 (concat
2933 "\\([^\\]\\)\\([_^]\\)\\("
2934 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
2935 "\\)")
2936 "The regular expression matching a sub- or superscript, forcing braces.")
2939 (defun org-get-text-property-any (pos prop &optional object)
2940 (or (get-text-property pos prop object)
2941 (and (setq pos (next-single-property-change pos prop object))
2942 (get-text-property pos prop object))))
2944 (defun org-export-get-coderef-format (path desc)
2945 (save-match-data
2946 (if (and desc (string-match
2947 (regexp-quote (concat "(" path ")"))
2948 desc))
2949 (replace-match "%s" t t desc)
2950 (or desc "%s"))))
2952 (defun org-export-push-to-kill-ring (format)
2953 "Push buffer content to kill ring.
2954 The depends on the variable `org-export-copy-to-kill'."
2955 (when org-export-copy-to-kill-ring
2956 (org-kill-new (buffer-string))
2957 (when (fboundp 'x-set-selection)
2958 (ignore-errors (x-set-selection 'PRIMARY (buffer-string)))
2959 (ignore-errors (x-set-selection 'CLIPBOARD (buffer-string))))
2960 (message "%s export done, pushed to kill ring and clipboard" format)))
2962 (provide 'org-exp)
2964 ;; arch-tag: 65985fe9-095c-49c7-a7b6-cb4ee15c0a95
2966 ;;; org-exp.el ends here