1 ;;; org-exp.el --- ASCII, HTML, XOXO and iCalendar export for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
34 (require 'org-exp-blocks
)
41 (declare-function org-export-latex-preprocess
"org-latex" (parameters))
42 (declare-function org-export-ascii-preprocess
"org-ascii" (parameters))
43 (declare-function org-export-html-preprocess
"org-html" (parameters))
44 (declare-function org-export-docbook-preprocess
"org-docbook" (parameters))
45 (declare-function org-infojs-options-inbuffer-template
"org-jsinfo" ())
46 (declare-function org-export-htmlize-region-for-paste
"org-html" (beg end
))
47 (declare-function htmlize-buffer
"ext:htmlize" (&optional buffer
))
48 (declare-function org-inlinetask-remove-END-maybe
"org-inlinetask" ())
49 (declare-function org-table-cookie-line-p
"org-table" (line))
50 (declare-function org-table-colgroup-line-p
"org-table" (line))
51 (autoload 'org-export-generic
"org-export-generic" "Export using the generic exporter" t
)
53 (autoload 'org-export-as-odt
"org-odt"
54 "Export the outline to a OpenDocumentText file." t
)
55 (autoload 'org-export-as-odt-and-open
"org-odt"
56 "Export the outline to a OpenDocumentText file and open it." t
)
58 (defgroup org-export nil
59 "Options for exporting org-listings."
63 (defgroup org-export-general nil
64 "General options for exporting Org-mode files."
65 :tag
"Org Export General"
68 (defcustom org-export-allow-BIND
'confirm
69 "Non-nil means allow #+BIND to define local variable values for export.
70 This is a potential security risk, which is why the user must confirm the
72 :group
'org-export-general
74 (const :tag
"Never" nil
)
75 (const :tag
"Always" t
)
76 (const :tag
"Make the user confirm for each file" confirm
)))
79 (defvar org-export-publishing-directory nil
)
81 (defcustom org-export-show-temporary-export-buffer t
82 "Non-nil means show buffer after exporting to temp buffer.
83 When Org exports to a file, the buffer visiting that file is ever
84 shown, but remains buried. However, when exporting to a temporary
85 buffer, that buffer is popped up in a second window. When this variable
86 is nil, the buffer remains buried also in these cases."
87 :group
'org-export-general
90 (defcustom org-export-copy-to-kill-ring t
91 "Non-nil means exported stuff will also be pushed onto the kill ring."
92 :group
'org-export-general
95 (defcustom org-export-kill-product-buffer-when-displayed nil
96 "Non-nil means kill the product buffer if it is displayed immediately.
97 This applied to the commands `org-export-as-html-and-open' and
98 `org-export-as-pdf-and-open'."
99 :group
'org-export-general
102 (defcustom org-export-run-in-background nil
103 "Non-nil means export and publishing commands will run in background.
104 This works by starting up a separate Emacs process visiting the same file
105 and doing the export from there.
106 Not all export commands are affected by this - only the ones which
107 actually write to a file, and that do not depend on the buffer state.
109 If this option is nil, you can still get background export by calling
110 `org-export' with a double prefix arg: \
111 \\[universal-argument] \\[universal-argument] \\[org-export].
113 If this option is t, the double prefix can be used to exceptionally
114 force an export command into the current process."
115 :group
'org-export-general
118 (defcustom org-export-initial-scope
'buffer
119 "The initial scope when exporting with `org-export'.
120 This variable can be either set to 'buffer or 'subtree."
121 :group
'org-export-general
123 (const :tag
"Export current buffer" 'buffer
)
124 (const :tag
"Export current subtree" 'subtree
)))
126 (defcustom org-export-select-tags
'("export")
127 "Tags that select a tree for export.
128 If any such tag is found in a buffer, all trees that do not carry one
129 of these tags will be deleted before export.
130 Inside trees that are selected like this, you can still deselect a
131 subtree by tagging it with one of the `org-export-exclude-tags'."
132 :group
'org-export-general
133 :type
'(repeat (string :tag
"Tag")))
135 (defcustom org-export-exclude-tags
'("noexport")
136 "Tags that exclude a tree from export.
137 All trees carrying any of these tags will be excluded from export.
138 This is without condition, so even subtrees inside that carry one of the
139 `org-export-select-tags' will be removed."
140 :group
'org-export-general
141 :type
'(repeat (string :tag
"Tag")))
143 ;; FIXME: rename, this is a general variable
144 (defcustom org-export-html-expand t
145 "Non-nil means for HTML export, treat @<...> as HTML tag.
146 When nil, these tags will be exported as plain text and therefore
147 not be interpreted by a browser.
149 This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
150 :group
'org-export-html
151 :group
'org-export-general
154 (defcustom org-export-with-special-strings t
155 "Non-nil means interpret \"\-\", \"--\" and \"---\" for export.
156 When this option is turned on, these strings will be exported as:
159 -----+----------+--------
165 This option can also be set with the +OPTIONS line, e.g. \"-:nil\"."
166 :group
'org-export-translation
169 (defcustom org-export-html-link-up
""
170 "Where should the \"UP\" link of exported HTML pages lead?"
171 :group
'org-export-html
172 :group
'org-export-general
173 :type
'(string :tag
"File or URL"))
175 (defcustom org-export-html-link-home
""
176 "Where should the \"HOME\" link of exported HTML pages lead?"
177 :group
'org-export-html
178 :group
'org-export-general
179 :type
'(string :tag
"File or URL"))
181 (defcustom org-export-language-setup
182 '(("en" "Author" "Date" "Table of Contents" "Footnotes")
183 ("ca" "Autor" "Data" "Índex" "Peus de pàgina")
184 ("cs" "Autor" "Datum" "Obsah" "Pozn\xe1mky pod carou")
185 ("da" "Ophavsmand" "Dato" "Indhold" "Fodnoter")
186 ("de" "Autor" "Datum" "Inhaltsverzeichnis" "Fußnoten")
187 ("eo" "Aŭtoro" "Dato" "Enhavo" "Piednotoj")
188 ("es" "Autor" "Fecha" "Índice" "Pies de página")
189 ("fi" "Tekijä" "Päivämäärä" "Sisällysluettelo" "Alaviitteet")
190 ("fr" "Auteur" "Date" "Table des matières" "Notes de bas de page")
191 ("hu" "Szerzõ" "Dátum" "Tartalomjegyzék" "Lábjegyzet")
192 ("is" "Höfundur" "Dagsetning" "Efnisyfirlit" "Aftanmálsgreinar")
193 ("it" "Autore" "Data" "Indice" "Note a piè di pagina")
194 ("nl" "Auteur" "Datum" "Inhoudsopgave" "Voetnoten")
195 ("no" "Forfatter" "Dato" "Innhold" "Fotnoter")
196 ("nb" "Forfatter" "Dato" "Innhold" "Fotnoter") ;; nb = Norsk (bokm.l)
197 ("nn" "Forfattar" "Dato" "Innhald" "Fotnotar") ;; nn = Norsk (nynorsk)
198 ("pl" "Autor" "Data" "Spis treści" "Przypis")
199 ("sv" "Författare" "Datum" "Innehåll" "Fotnoter"))
200 "Terms used in export text, translated to different languages.
201 Use the variable `org-export-default-language' to set the language,
202 or use the +OPTION lines for a per-file setting."
203 :group
'org-export-general
206 (string :tag
"HTML language tag")
207 (string :tag
"Author")
209 (string :tag
"Table of Contents")
210 (string :tag
"Footnotes"))))
212 (defcustom org-export-default-language
"en"
213 "The default language for export and clocktable translations, as a string.
214 This should have an association in `org-export-language-setup'
215 and in `org-clock-clocktable-language-setup'."
216 :group
'org-export-general
219 (defvar org-export-page-description
""
220 "The page description, for the XHTML meta tag.
221 This is best set with the #+DESCRIPTION line in a file, it does not make
222 sense to set this globally.")
224 (defvar org-export-page-keywords
""
225 "The page description, for the XHTML meta tag.
226 This is best set with the #+KEYWORDS line in a file, it does not make
227 sense to set this globally.")
229 (defcustom org-export-skip-text-before-1st-heading nil
230 "Non-nil means skip all text before the first headline when exporting.
231 When nil, that text is exported as well."
232 :group
'org-export-general
235 (defcustom org-export-headline-levels
3
236 "The last level which is still exported as a headline.
237 Inferior levels will produce itemize lists when exported.
238 Note that a numeric prefix argument to an exporter function overrides
241 This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
242 :group
'org-export-general
245 (defcustom org-export-with-section-numbers t
246 "Non-nil means add section numbers to headlines when exporting.
248 This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
249 :group
'org-export-general
252 (defcustom org-export-section-number-format
'((("1" ".")) .
"")
253 "Format of section numbers for export.
254 The variable has two components.
255 1. A list of lists, each indicating a counter type and a separator.
256 The counter type can be any of \"1\", \"A\", \"a\", \"I\", or \"i\".
257 It causes causes numeric, alphabetic, or roman counters, respectively.
258 The separator is only used if another counter for a subsection is being
260 If there are more numbered section levels than entries in this lists,
261 then the last entry will be reused.
262 2. A terminator string that will be added after the entire
264 :group
'org-export-general
268 (string :tag
"Counter Type")
269 (string :tag
"Separator ")))
270 (string :tag
"Terminator")))
272 (defcustom org-export-with-toc t
273 "Non-nil means create a table of contents in exported files.
274 The TOC contains headlines with levels up to`org-export-headline-levels'.
275 When an integer, include levels up to N in the toc, this may then be
276 different from `org-export-headline-levels', but it will not be allowed
277 to be larger than the number of headline levels.
278 When nil, no table of contents is made.
280 Headlines which contain any TODO items will be marked with \"(*)\" in
281 ASCII export, and with red color in HTML output, if the option
282 `org-export-mark-todo-in-toc' is set.
284 In HTML output, the TOC will be clickable.
286 This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"
288 :group
'org-export-general
290 (const :tag
"No Table of Contents" nil
)
291 (const :tag
"Full Table of Contents" t
)
292 (integer :tag
"TOC to level")))
294 (defcustom org-export-mark-todo-in-toc nil
295 "Non-nil means mark TOC lines that contain any open TODO items."
296 :group
'org-export-general
299 (defcustom org-export-with-todo-keywords t
300 "Non-nil means include TODO keywords in export.
301 When nil, remove all these keywords from the export."
302 :group
'org-export-general
305 (defcustom org-export-with-tasks t
306 "Non-nil means include TODO items for export.
307 This may have the following values:
308 t include tasks independent of state.
309 todo include only tasks that are not yet done.
310 done include only tasks that are already done.
311 nil remove all tasks before export
312 list of TODO kwds keep only tasks with these keywords"
313 :group
'org-export-general
315 (const :tag
"All tasks" t
)
316 (const :tag
"No tasks" nil
)
317 (const :tag
"Not-done tasks" todo
)
318 (const :tag
"Only done tasks" done
)
319 (repeat :tag
"Specific TODO keywords"
320 (string :tag
"Keyword"))))
322 (defcustom org-export-with-priority nil
323 "Non-nil means include priority cookies in export.
324 When nil, remove priority cookies for export."
325 :group
'org-export-general
328 (defcustom org-export-preserve-breaks nil
329 "Non-nil means preserve all line breaks when exporting.
330 Normally, in HTML output paragraphs will be reformatted. In ASCII
331 export, line breaks will always be preserved, regardless of this variable.
333 This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
334 :group
'org-export-general
337 (defcustom org-export-with-archived-trees
'headline
338 "Whether subtrees with the ARCHIVE tag should be exported.
339 This can have three different values
340 nil Do not export, pretend this tree is not present
341 t Do export the entire tree
342 headline Only export the headline, but skip the tree below it."
343 :group
'org-export-general
346 (const :tag
"not at all" nil
)
347 (const :tag
"headline only" 'headline
)
348 (const :tag
"entirely" t
)))
350 (defcustom org-export-author-info t
351 "Non-nil means insert author name and email into the exported file.
353 This option can also be set with the +OPTIONS line,
354 e.g. \"author:nil\"."
355 :group
'org-export-general
358 (defcustom org-export-email-info nil
359 "Non-nil means insert author name and email into the exported file.
361 This option can also be set with the +OPTIONS line,
363 :group
'org-export-general
366 (defcustom org-export-creator-info t
367 "Non-nil means the postamble should contain a creator sentence.
368 This sentence is \"HTML generated by org-mode XX in emacs XXX\"."
369 :group
'org-export-general
372 (defcustom org-export-time-stamp-file t
373 "Non-nil means insert a time stamp into the exported file.
374 The time stamp shows when the file was created.
376 This option can also be set with the +OPTIONS line,
377 e.g. \"timestamp:nil\"."
378 :group
'org-export-general
381 (defcustom org-export-with-timestamps t
382 "If nil, do not export time stamps and associated keywords."
383 :group
'org-export-general
386 (defcustom org-export-remove-timestamps-from-toc t
387 "If t, remove timestamps from the table of contents entries."
388 :group
'org-export-general
391 (defcustom org-export-with-tags
'not-in-toc
392 "If nil, do not export tags, just remove them from headlines.
393 If this is the symbol `not-in-toc', tags will be removed from table of
394 contents entries, but still be shown in the headlines of the document.
396 This option can also be set with the +OPTIONS line, e.g. \"tags:nil\"."
397 :group
'org-export-general
399 (const :tag
"Off" nil
)
400 (const :tag
"Not in TOC" not-in-toc
)
401 (const :tag
"On" t
)))
403 (defcustom org-export-with-drawers nil
404 "Non-nil means export with drawers like the property drawer.
405 When t, all drawers are exported. This may also be a list of
406 drawer names to export."
407 :group
'org-export-general
409 (const :tag
"All drawers" t
)
410 (const :tag
"None" nil
)
411 (repeat :tag
"Selected drawers"
412 (string :tag
"Drawer name"))))
414 (defvar org-export-first-hook nil
415 "Hook called as the first thing in each exporter.
416 Point will be still in the original buffer.
417 Good for general initialization")
419 (defvar org-export-preprocess-hook nil
420 "Hook for preprocessing an export buffer.
421 Pretty much the first thing when exporting is running this hook.
422 Point will be in a temporary buffer that contains a copy of
423 the original buffer, or of the section that is being exported.
424 All the other hooks in the org-export-preprocess... category
425 also work in that temporary buffer, already modified by various
426 stages of the processing.")
428 (defvar org-export-preprocess-after-include-files-hook nil
429 "Hook for preprocessing an export buffer.
430 This is run after the contents of included files have been inserted.")
432 (defvar org-export-preprocess-after-tree-selection-hook nil
433 "Hook for preprocessing an export buffer.
434 This is run after selection of trees to be exported has happened.
435 This selection includes tags-based selection, as well as removal
436 of commented and archived trees.")
438 (defvar org-export-preprocess-after-headline-targets-hook nil
439 "Hook for preprocessing export buffer.
440 This is run just after the headline targets have been defined and
441 the target-alist has been set up.")
443 (defvar org-export-preprocess-before-selecting-backend-code-hook nil
444 "Hook for preprocessing an export buffer.
445 This is run just before backend-specific blocks get selected.")
447 (defvar org-export-preprocess-after-blockquote-hook nil
448 "Hook for preprocessing an export buffer.
449 This is run after blockquote/quote/verse/center have been marked
452 (defvar org-export-preprocess-after-radio-targets-hook nil
453 "Hook for preprocessing an export buffer.
454 This is run after radio target processing.")
456 (defvar org-export-preprocess-before-normalizing-links-hook nil
457 "Hook for preprocessing an export buffer.
458 This hook is run before links are normalized.")
460 (defvar org-export-preprocess-before-backend-specifics-hook nil
461 "Hook run before backend-specific functions are called during preprocessing.")
463 (defvar org-export-preprocess-final-hook nil
464 "Hook for preprocessing an export buffer.
465 This is run as the last thing in the preprocessing buffer, just before
466 returning the buffer string to the backend.")
468 (defgroup org-export-translation nil
469 "Options for translating special ascii sequences for the export backends."
470 :tag
"Org Export Translation"
473 (defcustom org-export-with-emphasize t
474 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
475 If the export target supports emphasizing text, the word will be
476 typeset in bold, italic, or underlined, respectively. Works only for
477 single words, but you can say: I *really* *mean* *this*.
478 Not all export backends support this.
480 This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
481 :group
'org-export-translation
484 (defcustom org-export-with-footnotes t
485 "If nil, export [1] as a footnote marker.
486 Lines starting with [1] will be formatted as footnotes.
488 This option can also be set with the +OPTIONS line, e.g. \"f:nil\"."
489 :group
'org-export-translation
492 (defcustom org-export-with-TeX-macros t
493 "Non-nil means interpret simple TeX-like macros when exporting.
494 For example, HTML export converts \\alpha to α and \\AA to Å.
495 Not only real TeX macros will work here, but the standard HTML entities
496 for math can be used as macro names as well. For a list of supported
497 names in HTML export, see the constant `org-entities' and the user option
499 Not all export backends support this.
501 This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
502 :group
'org-export-translation
503 :group
'org-export-latex
506 (defcustom org-export-with-LaTeX-fragments t
507 "Non-nil means process LaTeX math fragments for HTML display.
508 When set, the exporter will find and process LaTeX environments if the
509 \\begin line is the first non-white thing on a line. It will also find
510 and process the math delimiters like $a=b$ and \\( a=b \\) for inline math,
511 $$a=b$$ and \\=\\[ a=b \\] for display math.
513 This option can also be set with the +OPTIONS line, e.g. \"LaTeX:mathjax\".
517 nil Don't do anything.
518 verbatim Keep everything in verbatim
519 dvipng Process the LaTeX fragments to images.
520 This will also include processing of non-math environments.
521 t Do MathJax preprocessing if there is at least on math snippet,
522 and arrange for MathJax.js to be loaded.
524 The default is nil, because this option needs the `dvipng' program which
525 is not available on all systems."
526 :group
'org-export-translation
527 :group
'org-export-latex
529 (const :tag
"Do not process math in any way" nil
)
530 (const :tag
"Obsolete, use dvipng setting" t
)
531 (const :tag
"Use dvipng to make images" dvipng
)
532 (const :tag
"Use MathJax to display math" mathjax
)
533 (const :tag
"Leave math verbatim" verbatim
)))
535 (defcustom org-export-with-fixed-width t
536 "Non-nil means lines starting with \":\" will be in fixed width font.
537 This can be used to have pre-formatted text, fragments of code etc. For
539 : ;; Some Lisp examples
542 will be looking just like this in also HTML. See also the QUOTE keyword.
543 Not all export backends support this.
545 This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
546 :group
'org-export-translation
549 (defgroup org-export-tables nil
550 "Options for exporting tables in Org-mode."
551 :tag
"Org Export Tables"
554 (defcustom org-export-with-tables t
555 "If non-nil, lines starting with \"|\" define a table.
558 | Name | Address | Birthday |
559 |-------------+----------+-----------|
560 | Arthur Dent | England | 29.2.2100 |
562 Not all export backends support this.
564 This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
565 :group
'org-export-tables
568 (defcustom org-export-highlight-first-table-line t
569 "Non-nil means highlight the first table line.
570 In HTML export, this means use <th> instead of <td>.
571 In tables created with table.el, this applies to the first table line.
572 In Org-mode tables, all lines before the first horizontal separator
573 line will be formatted with <th> tags."
574 :group
'org-export-tables
577 (defcustom org-export-table-remove-special-lines t
578 "Remove special lines and marking characters in calculating tables.
579 This removes the special marking character column from tables that are set
580 up for spreadsheet calculations. It also removes the entire lines
581 marked with `!', `_', or `^'. The lines with `$' are kept, because
582 the values of constants may be useful to have."
583 :group
'org-export-tables
586 (defcustom org-export-table-remove-empty-lines t
587 "Remove empty lines when exporting tables.
588 This is the global equivalent of the :remove-nil-lines option
589 when locally sending a table with #+ORGTBL."
590 :group
'org-export-tables
593 (defcustom org-export-prefer-native-exporter-for-tables nil
594 "Non-nil means always export tables created with table.el natively.
595 Natively means use the HTML code generator in table.el.
596 When nil, Org-mode's own HTML generator is used when possible (i.e. if
597 the table does not use row- or column-spanning). This has the
598 advantage, that the automatic HTML conversions for math symbols and
599 sub/superscripts can be applied. Org-mode's HTML generator is also
600 much faster. The LaTeX exporter always use the native exporter for
602 :group
'org-export-tables
607 ;;; Variables, constants, and parameter plists
609 (defconst org-level-max
20)
611 (defvar org-export-current-backend nil
612 "During export, this will be bound to a symbol such as 'html,
613 'latex, 'docbook, 'ascii, etc, indicating which of the export
614 backends is in use. Otherwise it has the value nil. Users
615 should not attempt to change the value of this variable
616 directly, but it can be used in code to test whether export is
617 in progress, and if so, what the backend is.")
619 (defvar org-current-export-file nil
) ; dynamically scoped parameter
620 (defvar org-current-export-dir nil
) ; dynamically scoped parameter
621 (defvar org-export-opt-plist nil
622 "Contains the current option plist.")
623 (defvar org-last-level nil
) ; dynamically scoped variable
624 (defvar org-min-level nil
) ; dynamically scoped variable
625 (defvar org-levels-open nil
) ; dynamically scoped parameter
626 (defvar org-export-footnotes-data nil
627 "Alist of labels used in buffers, along with their definition.")
628 (defvar org-export-footnotes-seen nil
629 "Alist of labels encountered so far by the exporter, along with their definition.")
632 (defconst org-export-plist-vars
633 '((:link-up nil org-export-html-link-up
)
634 (:link-home nil org-export-html-link-home
)
635 (:language nil org-export-default-language
)
636 (:keywords nil org-export-page-keywords
)
637 (:description nil org-export-page-description
)
638 (:customtime nil org-display-custom-times
)
639 (:headline-levels
"H" org-export-headline-levels
)
640 (:section-numbers
"num" org-export-with-section-numbers
)
641 (:section-number-format nil org-export-section-number-format
)
642 (:table-of-contents
"toc" org-export-with-toc
)
643 (:preserve-breaks
"\\n" org-export-preserve-breaks
)
644 (:archived-trees nil org-export-with-archived-trees
)
645 (:emphasize
"*" org-export-with-emphasize
)
646 (:sub-superscript
"^" org-export-with-sub-superscripts
)
647 (:special-strings
"-" org-export-with-special-strings
)
648 (:footnotes
"f" org-export-with-footnotes
)
649 (:drawers
"d" org-export-with-drawers
)
650 (:tags
"tags" org-export-with-tags
)
651 (:todo-keywords
"todo" org-export-with-todo-keywords
)
652 (:tasks
"tasks" org-export-with-tasks
)
653 (:priority
"pri" org-export-with-priority
)
654 (:TeX-macros
"TeX" org-export-with-TeX-macros
)
655 (:LaTeX-fragments
"LaTeX" org-export-with-LaTeX-fragments
)
656 (:latex-listings nil org-export-latex-listings
)
657 (:skip-before-1st-heading
"skip" org-export-skip-text-before-1st-heading
)
658 (:fixed-width
":" org-export-with-fixed-width
)
659 (:timestamps
"<" org-export-with-timestamps
)
660 (:author nil user-full-name
)
661 (:email nil user-mail-address
)
662 (:author-info
"author" org-export-author-info
)
663 (:email-info
"email" org-export-email-info
)
664 (:creator-info
"creator" org-export-creator-info
)
665 (:time-stamp-file
"timestamp" org-export-time-stamp-file
)
666 (:tables
"|" org-export-with-tables
)
667 (:table-auto-headline nil org-export-highlight-first-table-line
)
668 (:style-include-default nil org-export-html-style-include-default
)
669 (:style-include-scripts nil org-export-html-style-include-scripts
)
670 (:style nil org-export-html-style
)
671 (:style-extra nil org-export-html-style-extra
)
672 (:agenda-style nil org-agenda-export-html-style
)
673 (:convert-org-links nil org-export-html-link-org-files-as-html
)
674 (:inline-images nil org-export-html-inline-images
)
675 (:html-extension nil org-export-html-extension
)
676 (:html-preamble nil org-export-html-preamble
)
677 (:html-postamble nil org-export-html-postamble
)
678 (:xml-declaration nil org-export-html-xml-declaration
)
679 (:html-table-tag nil org-export-html-table-tag
)
680 (:expand-quoted-html
"@" org-export-html-expand
)
681 (:timestamp nil org-export-html-with-timestamp
)
682 (:publishing-directory nil org-export-publishing-directory
)
683 (:select-tags nil org-export-select-tags
)
684 (:exclude-tags nil org-export-exclude-tags
)
686 (:latex-image-options nil org-export-latex-image-default-option
))
687 "List of properties that represent export/publishing variables.
688 Each element is a list of 3 items:
689 1. The property that is used internally, and also for org-publish-project-alist
690 2. The string that can be used in the OPTION lines to set this option,
691 or nil if this option cannot be changed in this way
692 3. The customization variable that sets the default for this option."
695 (defun org-default-export-plist ()
696 "Return the property list with default settings for the export variables."
697 (let* ((infile (org-infile-export-plist))
698 (letbind (plist-get infile
:let-bind
))
699 (l org-export-plist-vars
) rtn e s v
)
700 (while (setq e
(pop l
))
703 ((assq s letbind
) (nth 1 (assq s letbind
)))
704 ((boundp s
) (symbol-value s
))
706 rtn
(cons (car e
) (cons v rtn
))))
709 (defvar org-export-inbuffer-options-extra nil
710 "List of additional in-buffer options that should be detected.
711 Just before export, the buffer is scanned for options like #+TITLE, #+EMAIL,
712 etc. Extensions can add to this list to get their options detected, and they
713 can then add a function to `org-export-options-filters' to process these
715 Each element in this list must be a list, with the in-buffer keyword as car,
716 and a property (a symbol) as the next element. All occurrences of the
717 keyword will be found, the values concatenated with a space character
718 in between, and the result stored in the export options property list.")
720 (defvar org-export-options-filters nil
721 "Functions to be called to finalize the export/publishing options.
722 All these options are stored in a property list, and each of the functions
723 in this hook gets a chance to modify this property list. Each function
724 must accept the property list as an argument, and must return the (possibly
727 ;; FIXME: should we fold case here?
728 (defun org-infile-export-plist ()
729 "Return the property list with file-local settings for export."
733 (goto-char (point-min))
734 (let ((re (org-make-options-regexp
736 '("TITLE" "AUTHOR" "DATE" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"
738 "LINK_UP" "LINK_HOME" "SETUPFILE" "STYLE"
739 "LATEX_HEADER" "LATEX_CLASS"
740 "EXPORT_SELECT_TAGS" "EXPORT_EXCLUDE_TAGS"
741 "KEYWORDS" "DESCRIPTION" "MACRO" "BIND" "XSLT")
742 (mapcar 'car org-export-inbuffer-options-extra
))))
744 p key val text options mathjax a pr style
745 latex-header latex-class macros letbind
746 ext-setup-or-nil setup-contents
(start 0))
747 (while (or (and ext-setup-or-nil
748 (string-match re ext-setup-or-nil start
)
749 (setq start
(match-end 0)))
750 (and (setq ext-setup-or-nil nil start
0)
751 (re-search-forward re nil t
)))
752 (setq key
(upcase (org-match-string-no-properties 1 ext-setup-or-nil
))
753 val
(org-match-string-no-properties 2 ext-setup-or-nil
))
755 ((setq a
(assoc key org-export-inbuffer-options-extra
))
757 (setq p
(plist-put p pr
(concat (plist-get p pr
) " " val
))))
758 ((string-equal key
"TITLE") (setq p
(plist-put p
:title val
)))
759 ((string-equal key
"AUTHOR")(setq p
(plist-put p
:author val
)))
760 ((string-equal key
"EMAIL") (setq p
(plist-put p
:email val
)))
761 ((string-equal key
"DATE") (setq p
(plist-put p
:date val
)))
762 ((string-equal key
"KEYWORDS") (setq p
(plist-put p
:keywords val
)))
763 ((string-equal key
"DESCRIPTION")
764 (setq p
(plist-put p
:description val
)))
765 ((string-equal key
"LANGUAGE") (setq p
(plist-put p
:language val
)))
766 ((string-equal key
"STYLE")
767 (setq style
(concat style
"\n" val
)))
768 ((string-equal key
"LATEX_HEADER")
769 (setq latex-header
(concat latex-header
"\n" val
)))
770 ((string-equal key
"LATEX_CLASS")
771 (setq latex-class val
))
772 ((string-equal key
"TEXT")
773 (setq text
(if text
(concat text
"\n" val
) val
)))
774 ((string-equal key
"OPTIONS")
775 (setq options
(concat val
" " options
)))
776 ((string-equal key
"MATHJAX")
777 (setq mathjax
(concat val
" " mathjax
)))
778 ((string-equal key
"BIND")
779 (push (read (concat "(" val
")")) letbind
))
780 ((string-equal key
"XSLT")
781 (setq p
(plist-put p
:xslt val
)))
782 ((string-equal key
"LINK_UP")
783 (setq p
(plist-put p
:link-up val
)))
784 ((string-equal key
"LINK_HOME")
785 (setq p
(plist-put p
:link-home val
)))
786 ((string-equal key
"EXPORT_SELECT_TAGS")
787 (setq p
(plist-put p
:select-tags
(org-split-string val
))))
788 ((string-equal key
"EXPORT_EXCLUDE_TAGS")
789 (setq p
(plist-put p
:exclude-tags
(org-split-string val
))))
790 ((string-equal key
"MACRO")
792 ((equal key
"SETUPFILE")
793 (setq setup-contents
(org-file-contents
795 (org-remove-double-quotes
798 (if (not ext-setup-or-nil
)
799 (setq ext-setup-or-nil setup-contents start
0)
800 (setq ext-setup-or-nil
801 (concat (substring ext-setup-or-nil
0 start
)
802 "\n" setup-contents
"\n"
803 (substring ext-setup-or-nil start
)))))))
804 (setq p
(plist-put p
:text text
))
805 (when (and letbind
(org-export-confirm-letbind))
806 (setq p
(plist-put p
:let-bind letbind
)))
807 (when style
(setq p
(plist-put p
:style-extra style
)))
809 (setq p
(plist-put p
:latex-header-extra
(substring latex-header
1))))
811 (setq p
(plist-put p
:latex-class latex-class
)))
813 (setq p
(org-export-add-options-to-plist p options
)))
815 (setq p
(plist-put p
:mathjax mathjax
)))
816 ;; Add macro definitions
817 (setq p
(plist-put p
:macro-date
"(eval (format-time-string \"$1\"))"))
818 (setq p
(plist-put p
:macro-time
"(eval (format-time-string \"$1\"))"))
819 (setq p
(plist-put p
:macro-property
"(eval (org-entry-get nil \"$1\" 'selective))"))
821 p
:macro-modification-time
822 (and (buffer-file-name)
823 (file-exists-p (buffer-file-name))
825 "(eval (format-time-string \"$1\" '"
826 (prin1-to-string (nth 5 (file-attributes
827 (buffer-file-name))))
829 (setq p
(plist-put p
:macro-input-file
(and (buffer-file-name)
830 (file-name-nondirectory
831 (buffer-file-name)))))
832 (while (setq val
(pop macros
))
833 (when (string-match "^\\([-a-zA-Z0-9_]+\\)[ \t]+\\(.*?[ \t]*$\\)" val
)
836 (concat ":macro-" (downcase (match-string 1 val
))))
837 (org-export-interpolate-newlines (match-string 2 val
))))))
840 (defun org-export-interpolate-newlines (s)
841 (while (string-match "\\\\n" s
)
842 (setq s
(replace-match "\n" t t s
)))
845 (defvar org-export-allow-BIND-local nil
)
846 (defun org-export-confirm-letbind ()
847 "Can we use #+BIND values during export?
848 By default this will ask for confirmation by the user, to divert possible
851 ((not org-export-allow-BIND
) nil
)
852 ((eq org-export-allow-BIND t
) t
)
853 ((local-variable-p 'org-export-allow-BIND-local
(current-buffer))
854 org-export-allow-BIND-local
)
855 (t (org-set-local 'org-export-allow-BIND-local
856 (yes-or-no-p "Allow BIND values in this buffer? ")))))
858 (defun org-install-letbind ()
859 "Install the values from #+BIND lines as local variables."
860 (let ((letbind (plist-get org-export-opt-plist
:let-bind
))
862 (while (setq pair
(pop letbind
))
863 (org-set-local (car pair
) (nth 1 pair
)))))
865 (defun org-export-add-options-to-plist (p options
)
866 "Parse an OPTIONS line and set values in the property list P."
869 (let ((op org-export-plist-vars
))
870 (while (setq o
(pop op
))
872 (string-match (concat "\\(\\`\\|[ \t]\\)"
873 (regexp-quote (nth 1 o
))
874 ":\\(([^)\n]+)\\|[^ \t\n\r;,.]*\\)")
876 (setq p
(plist-put p
(car o
)
877 (car (read-from-string
878 (match-string 2 options
))))))))))
881 (defun org-export-add-subtree-options (p pos
)
882 "Add options in subtree at position POS to property list P."
885 (when (org-at-heading-p)
887 ;; This is actually read in `org-export-get-title-from-subtree'
888 ;; (when (setq a (org-entry-get pos "EXPORT_TITLE"))
889 ;; (setq p (plist-put p :title a)))
890 (when (setq a
(org-entry-get pos
"EXPORT_TEXT"))
891 (setq p
(plist-put p
:text a
)))
892 (when (setq a
(org-entry-get pos
"EXPORT_AUTHOR"))
893 (setq p
(plist-put p
:author a
)))
894 (when (setq a
(org-entry-get pos
"EXPORT_DATE"))
895 (setq p
(plist-put p
:date a
)))
896 (when (setq a
(org-entry-get pos
"EXPORT_OPTIONS"))
897 (setq p
(org-export-add-options-to-plist p a
)))))
900 (defun org-export-directory (type plist
)
901 (let* ((val (plist-get plist
:publishing-directory
))
903 (or (cdr (assoc type val
)) ".")
907 (defun org-export-process-option-filters (plist)
908 (let ((functions org-export-options-filters
) f
)
909 (while (setq f
(pop functions
))
910 (setq plist
(funcall f plist
))))
914 (defun org-export (&optional arg
)
915 "Export dispatcher for Org-mode.
916 When `org-export-run-in-background' is non-nil, try to run the command
917 in the background. This will be done only for commands that write
918 to a file. For details see the docstring of `org-export-run-in-background'.
920 The prefix argument ARG will be passed to the exporter. However, if
921 ARG is a double universal prefix \\[universal-argument] \\[universal-argument], \
922 that means to inverse the
923 value of `org-export-run-in-background'.
925 If `org-export-initial-scope' is set to 'subtree, try to export
926 the current subtree, otherwise try to export the whole buffer.
927 Pressing `1' will switch between these two options."
929 (let* ((bg (org-xor (equal arg
'(16)) org-export-run-in-background
))
930 (subtree-p (or (org-region-active-p)
931 (eq org-export-initial-scope
'subtree
)))
932 (help "[t] insert the export option template
933 \[v] limit export to visible part of outline tree
934 \[1] switch buffer/subtree export
935 \[SPC] publish enclosing subtree (with LaTeX_CLASS or EXPORT_FILE_NAME prop)
937 \[a/n/u] export as ASCII/Latin-1/UTF-8 [A/N/U] to temporary buffer
939 \[h] export as HTML [H] to temporary buffer [R] export region
940 \[b] export as HTML and open in browser
942 \[l] export as LaTeX [L] to temporary buffer
943 \[p] export as LaTeX and process to PDF [d] ... and open PDF file
945 \[D] export as DocBook [V] export as DocBook, process to PDF, and open
947 \[o] export as OpenDocumentText [O] ... and open
949 \[j] export as TaskJuggler [J] ... and open
951 \[m] export as Freemind mind map
953 \[g] export using Wes Hardaker's generic exporter
955 \[i] export current file as iCalendar file
956 \[I] export all agenda files as iCalendar files [c] ...as one combined file
958 \[F] publish current file [P] publish current project
959 \[X] publish a project... [E] publish every projects")
961 '((?t org-insert-export-options-template nil
)
962 (?v org-export-visible nil
)
963 (?a org-export-as-ascii t
)
964 (?A org-export-as-ascii-to-buffer t
)
965 (?n org-export-as-latin1 t
)
966 (?N org-export-as-latin1-to-buffer t
)
967 (?u org-export-as-utf8 t
)
968 (?U org-export-as-utf8-to-buffer t
)
969 (?h org-export-as-html t
)
970 (?b org-export-as-html-and-open t
)
971 (?H org-export-as-html-to-buffer nil
)
972 (?R org-export-region-as-html nil
)
973 (?x org-export-as-xoxo t
)
974 (?g org-export-generic t
)
975 (?D org-export-as-docbook t
)
976 (?V org-export-as-docbook-pdf-and-open t
)
977 (?o org-export-as-odt t
)
978 (?O org-export-as-odt-and-open t
)
979 (?j org-export-as-taskjuggler t
)
980 (?J org-export-as-taskjuggler-and-open t
)
981 (?m org-export-as-freemind t
)
982 (?l org-export-as-latex t
)
983 (?p org-export-as-pdf t
)
984 (?d org-export-as-pdf-and-open t
)
985 (?L org-export-as-latex-to-buffer nil
)
986 (?i org-export-icalendar-this-file t
)
987 (?I org-export-icalendar-all-agenda-files t
)
988 (?c org-export-icalendar-combine-agenda-files t
)
989 (?F org-publish-current-file t
)
990 (?P org-publish-current-project t
)
992 (?E org-publish-all t
)))
994 (cpos (point)) (cbuf (current-buffer)) bpos
)
996 (save-window-excursion
998 (message "Export subtree: ")
999 (message "Export buffer: "))
1000 (delete-other-windows)
1001 (with-output-to-temp-buffer "*Org Export/Publishing Help*"
1003 (org-fit-window-to-buffer (get-buffer-window
1004 "*Org Export/Publishing Help*"))
1005 (while (eq (setq r1
(read-char-exclusive)) ?
1)
1007 (setq subtree-p nil
)
1008 (message "Export buffer: "))
1011 (message "Export subtree: "))))
1013 (let ((case-fold-search t
)
1014 (end (save-excursion (while (org-up-heading-safe)) (point))))
1015 (outline-next-heading)
1016 (if (re-search-backward
1017 "^[ \t]+\\(:latex_class:\\|:export_title:\\|:export_file_name:\\)[ \t]+\\S-"
1020 (org-back-to-heading t
)
1023 (message "Select command (for subtree): ")
1024 (setq r1
(read-char-exclusive)))
1025 (error "No enclosing node with LaTeX_CLASS or EXPORT_TITLE or EXPORT_FILE_NAME")
1028 (and bpos
(goto-char bpos
))
1029 (setq r2
(if (< r1
27) (+ r1
96) r1
))
1030 (unless (setq ass
(assq r2 cmds
))
1031 (error "No command associated with key %c" r1
))
1032 (if (and bg
(nth 2 ass
)
1033 (not (buffer-base-buffer))
1034 (not (org-region-active-p)))
1035 ;; execute in background
1036 (let ((p (start-process
1037 (concat "Exporting " (file-name-nondirectory (buffer-file-name)))
1039 (expand-file-name invocation-name invocation-directory
)
1042 "--eval" "(require 'org-exp)"
1043 "--eval" "(setq org-wait .2)"
1045 "-f" (symbol-name (nth 1 ass
)))))
1046 (set-process-sentinel p
'org-export-process-sentinel
)
1047 (message "Background process \"%s\": started" p
))
1048 ;; background processing not requested, or not possible
1049 (if subtree-p
(progn (org-mark-subtree) (org-activate-mark)))
1050 (call-interactively (nth 1 ass
))
1051 (when (and bpos
(get-buffer-window cbuf
))
1052 (let ((cw (selected-window)))
1053 (select-window (get-buffer-window cbuf
))
1056 (select-window cw
))))))
1058 (defun org-export-process-sentinel (process status
)
1059 (if (string-match "\n+\\'" status
)
1060 (setq status
(substring status
0 -
1)))
1061 (message "Background process \"%s\": %s" process status
))
1063 ;;; General functions for all backends
1065 (defvar org-export-target-aliases nil
1066 "Alist of targets with invisible aliases.")
1067 (defvar org-export-preferred-target-alist nil
1068 "Alist of section id's with preferred aliases.")
1069 (defvar org-export-id-target-alist nil
1070 "Alist of section id's with preferred aliases.")
1071 (defvar org-export-code-refs nil
1072 "Alist of code references and line numbers.")
1074 (defun org-export-preprocess-string (string &rest parameters
)
1075 "Cleanup STRING so that the true exported has a more consistent source.
1076 This function takes STRING, which should be a buffer-string of an org-file
1077 to export. It then creates a temporary buffer where it does its job.
1078 The result is then again returned as a string, and the exporter works
1079 on this string to produce the exported version."
1081 (let* ((org-export-current-backend (plist-get parameters
:for-backend
))
1082 (archived-trees (plist-get parameters
:archived-trees
))
1083 (inhibit-read-only t
)
1084 (drawers org-drawers
)
1085 (outline-regexp "\\*+ ")
1086 (source-buffer (current-buffer))
1089 (setq org-export-target-aliases nil
1090 org-export-preferred-target-alist nil
1091 org-export-id-target-alist nil
1092 org-export-code-refs nil
)
1094 (with-current-buffer (get-buffer-create " org-mode-tmp")
1097 (setq case-fold-search t
)
1099 (let ((inhibit-read-only t
))
1100 (remove-text-properties (point-min) (point-max)
1103 ;; Remove license-to-kill stuff
1104 ;; The caller marks some stuff for killing, stuff that has been
1105 ;; used to create the page title, for example.
1106 (org-export-kill-licensed-text)
1108 (let ((org-inhibit-startup t
)) (org-mode))
1109 (setq case-fold-search t
)
1110 (org-clone-local-variables source-buffer
"^\\(org-\\|orgtbl-\\)")
1111 (org-install-letbind)
1114 (run-hooks 'org-export-preprocess-hook
)
1116 (untabify (point-min) (point-max))
1118 ;; Handle include files, and call a hook
1119 (org-export-handle-include-files-recurse)
1120 (run-hooks 'org-export-preprocess-after-include-files-hook
)
1122 ;; Normalize footnotes
1123 (when (plist-get parameters
:footnotes
)
1124 (org-footnote-normalize nil
'pre-process-p
))
1126 ;; Change lists ending. Other parts of export may insert blank
1127 ;; lines and lists' structure could be altered.
1128 (org-export-mark-list-end)
1130 ;; Process the macros
1131 (org-export-preprocess-apply-macros)
1132 (run-hooks 'org-export-preprocess-after-macros-hook
)
1134 ;; Get rid of archived trees
1135 (org-export-remove-archived-trees archived-trees
)
1137 ;; Remove comment environment and comment subtrees
1138 (org-export-remove-comment-blocks-and-subtrees)
1140 ;; Get rid of excluded trees, and call a hook
1141 (org-export-handle-export-tags (plist-get parameters
:select-tags
)
1142 (plist-get parameters
:exclude-tags
))
1143 (run-hooks 'org-export-preprocess-after-tree-selection-hook
)
1145 ;; Get rid of tasks, depending on configuration
1146 (org-export-remove-tasks (plist-get parameters
:tasks
))
1148 ;; Export code blocks
1149 (org-export-blocks-preprocess)
1151 ;; Mark lists with properties
1152 (org-export-mark-list-properties)
1154 ;; Handle source code snippets
1155 (org-export-replace-src-segments-and-examples)
1157 ;; Protect short examples marked by a leading colon
1158 (org-export-protect-colon-examples)
1161 (org-export-convert-protected-spaces)
1163 ;; Find all headings and compute the targets for them
1164 (setq target-alist
(org-export-define-heading-targets target-alist
))
1166 (run-hooks 'org-export-preprocess-after-headline-targets-hook
)
1168 ;; Find HTML special classes for headlines
1169 (org-export-remember-html-container-classes)
1171 ;; Get rid of drawers
1172 (org-export-remove-or-extract-drawers
1173 drawers
(plist-get parameters
:drawers
))
1175 ;; Get the correct stuff before the first headline
1176 (when (plist-get parameters
:skip-before-1st-heading
)
1177 (goto-char (point-min))
1178 (when (re-search-forward "^\\(#.*\n\\)?\\*+[ \t]" nil t
)
1179 (delete-region (point-min) (match-beginning 0))
1180 (goto-char (point-min))
1182 (when (plist-get parameters
:add-text
)
1183 (goto-char (point-min))
1184 (insert (plist-get parameters
:add-text
) "\n"))
1186 ;; Remove todo-keywords before exporting, if the user has requested so
1187 (org-export-remove-headline-metadata parameters
)
1189 ;; Find targets in comments and move them out of comments,
1190 ;; but mark them as targets that should be invisible
1191 (setq target-alist
(org-export-handle-invisible-targets target-alist
))
1193 ;; Select and protect backend specific stuff, throw away stuff
1194 ;; that is specific for other backends
1195 (run-hooks 'org-export-preprocess-before-selecting-backend-code-hook
)
1196 (org-export-select-backend-specific-text)
1198 ;; Protect quoted subtrees
1199 (org-export-protect-quoted-subtrees)
1201 ;; Remove clock lines
1202 (org-export-remove-clock-lines)
1204 ;; Protect verbatim elements
1205 (org-export-protect-verbatim)
1207 ;; Blockquotes, verse, and center
1208 (org-export-mark-blockquote-verse-center)
1209 (run-hooks 'org-export-preprocess-after-blockquote-hook
)
1211 ;; Remove timestamps, if the user has requested so
1212 (unless (plist-get parameters
:timestamps
)
1213 (org-export-remove-timestamps))
1215 ;; Attach captions to the correct object
1216 (setq target-alist
(org-export-attach-captions-and-attributes target-alist
))
1218 ;; Find matches for radio targets and turn them into internal links
1219 (org-export-mark-radio-links)
1220 (run-hooks 'org-export-preprocess-after-radio-targets-hook
)
1222 ;; Find all links that contain a newline and put them into a single line
1223 (org-export-concatenate-multiline-links)
1225 ;; Normalize links: Convert angle and plain links into bracket links
1226 ;; and expand link abbreviations
1227 (run-hooks 'org-export-preprocess-before-normalizing-links-hook
)
1228 (org-export-normalize-links)
1230 ;; Find all internal links. If they have a fuzzy match (i.e. not
1231 ;; a *dedicated* target match, let the link point to the
1232 ;; corresponding section.
1233 (org-export-target-internal-links target-alist
)
1235 ;; Find multiline emphasis and put them into single line
1236 (when (plist-get parameters
:emph-multiline
)
1237 (org-export-concatenate-multiline-emphasis))
1239 ;; Remove special table lines, and store alignment information
1240 (org-store-forced-table-alignment)
1241 (when org-export-table-remove-special-lines
1242 (org-export-remove-special-table-lines))
1245 (run-hooks 'org-export-preprocess-before-backend-specifics-hook
)
1247 ;; Backend-specific preprocessing
1248 (let* ((backend-name (symbol-name org-export-current-backend
))
1249 (f (intern (format "org-export-%s-preprocess" backend-name
))))
1250 (require (intern (concat "org-" backend-name
)) nil
)
1251 (funcall f parameters
))
1253 ;; Remove or replace comments
1254 (org-export-handle-comments (plist-get parameters
:comments
))
1256 ;; Remove #+TBLFM and #+TBLNAME lines
1257 (org-export-handle-table-metalines)
1259 ;; Run the final hook
1260 (run-hooks 'org-export-preprocess-final-hook
)
1262 (setq rtn
(buffer-string)))
1263 (kill-buffer " org-mode-tmp")
1266 (defun org-export-kill-licensed-text ()
1267 "Remove all text that is marked with a :org-license-to-kill property."
1269 (while (setq p
(text-property-any (point-min) (point-max)
1270 :org-license-to-kill t
))
1272 p
(or (next-single-property-change p
:org-license-to-kill
)
1275 (defvar org-export-define-heading-targets-headline-hook nil
1276 "Hook that is run when a headline was matched during target search.
1277 This is part of the preprocessing for export.")
1279 (defun org-export-define-heading-targets (target-alist)
1280 "Find all headings and define the targets for them.
1281 The new targets are added to TARGET-ALIST, which is also returned.
1282 Also find all ID and CUSTOM_ID properties and store them."
1283 (goto-char (point-min))
1284 (org-init-section-numbers)
1285 (let ((re (concat "^" org-outline-regexp
1287 "^[ \t]*:\\(ID\\|CUSTOM_ID\\):[ \t]*\\([^ \t\r\n]+\\)"))
1288 level target last-section-target a id
)
1289 (while (re-search-forward re nil t
)
1290 (org-if-unprotected-at (match-beginning 0)
1293 (setq id
(org-match-string-no-properties 2))
1294 (push (cons id target
) target-alist
)
1295 (setq a
(or (assoc last-section-target org-export-target-aliases
)
1297 (push (list last-section-target
)
1298 org-export-target-aliases
)
1299 (car org-export-target-aliases
))))
1300 (push (caar target-alist
) (cdr a
))
1301 (when (equal (match-string 1) "CUSTOM_ID")
1302 (if (not (assoc last-section-target
1303 org-export-preferred-target-alist
))
1304 (push (cons last-section-target id
)
1305 org-export-preferred-target-alist
)))
1306 (when (equal (match-string 1) "ID")
1307 (if (not (assoc last-section-target
1308 org-export-id-target-alist
))
1309 (push (cons last-section-target
(concat "ID-" id
))
1310 org-export-id-target-alist
))))
1311 (setq level
(org-reduced-level
1312 (save-excursion (goto-char (point-at-bol))
1313 (org-outline-level))))
1314 (setq target
(org-solidify-link-text
1315 (format "sec-%s" (replace-regexp-in-string
1317 (org-section-number level
)))))
1318 (setq last-section-target target
)
1319 (push (cons target target
) target-alist
)
1320 (add-text-properties
1321 (point-at-bol) (point-at-eol)
1322 (list 'target target
))
1323 (run-hooks 'org-export-define-heading-targets-headline-hook
)))))
1326 (defun org-export-handle-invisible-targets (target-alist)
1327 "Find targets in comments and move them out of comments.
1328 Mark them as invisible targets."
1330 (goto-char (point-min))
1331 (while (re-search-forward "^#.*?\\(<<<?\\([^>\r\n]+\\)>>>?\\).*" nil t
)
1332 ;; Check if the line before or after is a headline with a target
1333 (if (setq target
(or (get-text-property (point-at-bol 0) 'target
)
1334 (get-text-property (point-at-bol 2) 'target
)))
1336 ;; use the existing target in a neighboring line
1337 (setq tmp
(match-string 2))
1339 (and (looking-at "\n") (delete-char 1))
1340 (push (cons (setq tmp
(org-solidify-link-text tmp
)) target
)
1342 (setq a
(or (assoc target org-export-target-aliases
)
1344 (push (list target
) org-export-target-aliases
)
1345 (car org-export-target-aliases
))))
1347 ;; Make an invisible target
1348 (replace-match "\\1(INVISIBLE)"))))
1351 (defun org-export-target-internal-links (target-alist)
1352 "Find all internal links and assign targets to them.
1353 If a link has a fuzzy match (i.e. not a *dedicated* target match),
1354 let the link point to the corresponding section.
1355 This function also handles the id links, if they have a match in
1357 (goto-char (point-min))
1358 (while (re-search-forward org-bracket-link-regexp nil t
)
1359 (org-if-unprotected-at (1+ (match-beginning 0))
1360 (let* ((org-link-search-must-match-exact-headline t
)
1362 (desc (match-end 2))
1363 (link (org-link-unescape (match-string 1)))
1364 (slink (org-solidify-link-text link
))
1365 found props pos cref
1368 ((= (string-to-char link
) ?
#)
1369 ;; user wants exactly this link
1371 ((cdr (assoc slink target-alist
))
1372 (or (cdr (assoc (assoc slink target-alist
)
1373 org-export-preferred-target-alist
))
1374 (cdr (assoc slink target-alist
))))
1375 ((and (string-match "^id:" link
)
1376 (cdr (assoc (substring link
3) target-alist
))))
1377 ((string-match "^(\\(.*\\))$" link
)
1378 (setq cref
(match-string 1 link
))
1379 (concat "coderef:" cref
))
1380 ((string-match org-link-types-re link
) nil
)
1381 ((or (file-name-absolute-p link
)
1382 (string-match "^\\." link
))
1385 (let ((org-link-search-inhibit-query t
))
1387 (setq found
(condition-case nil
(org-link-search link
)
1390 (or (org-on-heading-p)
1391 (not (eq found
'dedicated
))))
1392 (or (get-text-property (point) 'target
)
1395 (1- (or (previous-single-property-change
1396 (point) 'target
) 0)))
1400 (goto-char (match-beginning 1))
1401 (setq props
(text-properties-at (point)))
1402 (delete-region (match-beginning 1) (match-end 1))
1405 (unless desc
(insert "][" link
))
1406 (add-text-properties pos
(point) props
))))))
1408 (defun org-export-remember-html-container-classes ()
1409 "Store the HTML_CONTAINER_CLASS properties in a text property."
1410 (goto-char (point-min))
1412 (while (re-search-forward
1413 "^[ \t]*:HTML_CONTAINER_CLASS:[ \t]+\\(.+\\)$" nil t
)
1414 (setq class
(match-string 1))
1416 (org-back-to-heading t
)
1417 (put-text-property (point-at-bol) (point-at-eol) 'html-container-class class
)))))
1419 (defvar org-export-format-drawer-function nil
1420 "Function to be called to format the contents of a drawer.
1421 The function must accept three parameters:
1422 NAME the drawer name, like \"PROPERTIES\"
1423 CONTENT the content of the drawer.
1424 You can check the export backend through `org-export-current-backend'.
1425 The function should return the text to be inserted into the buffer.
1426 If this is nil, `org-export-format-drawer' is used as a default.")
1428 (defun org-export-remove-or-extract-drawers (all-drawers exp-drawers
)
1429 "Remove drawers, or extract and format the content.
1430 ALL-DRAWERS is a list of all drawer names valid in the current buffer.
1431 EXP-DRAWERS can be t to keep all drawer contents, or a list of drawers
1432 whose content to keep. Any drawers that are in ALL-DRAWERS but not in
1433 EXP-DRAWERS will be removed."
1434 (goto-char (point-min))
1435 (let ((re (concat "^[ \t]*:\\("
1436 (mapconcat 'identity all-drawers
"\\|")
1438 name beg beg-content eol content
)
1439 (while (re-search-forward re nil t
)
1441 (setq name
(match-string 1))
1442 (setq beg
(match-beginning 0)
1443 beg-content
(1+ (point-at-eol))
1445 (if (not (and (re-search-forward
1446 "^\\([ \t]*:END:[ \t]*\n?\\)\\|^\\*+[ \t]" nil t
)
1449 (goto-char (match-beginning 0))
1450 (and (looking-at ".*\n?") (replace-match ""))
1451 (setq content
(buffer-substring beg-content
(point)))
1452 (delete-region beg
(point))
1453 (when (or (eq exp-drawers t
)
1454 (member name exp-drawers
))
1455 (setq content
(funcall (or org-export-format-drawer-function
1456 'org-export-format-drawer
)
1458 (insert content
)))))))
1460 (defun org-export-format-drawer (name content
)
1461 "Format the content of a drawer as a colon example."
1462 (if (string-match "[ \t]+\\'" content
)
1463 (setq content
(substring content
(match-beginning 0))))
1464 (while (string-match "\\`[ \t]*\n" content
)
1465 (setq content
(substring content
(match-end 0))))
1466 (setq content
(org-remove-indentation content
))
1467 (setq content
(concat ": " (mapconcat 'identity
1468 (org-split-string content
"\n")
1471 (setq content
(concat " : " (upcase name
) "\n" content
))
1472 (org-add-props content nil
'org-protected t
))
1474 (defun org-export-handle-export-tags (select-tags exclude-tags
)
1475 "Modify the buffer, honoring SELECT-TAGS and EXCLUDE-TAGS.
1476 Both arguments are lists of tags.
1477 If any of SELECT-TAGS is found, all trees not marked by a SELECT-TAG
1479 After that, all subtrees that are marked by EXCLUDE-TAGS will be
1481 (remove-text-properties (point-min) (point-max) '(:org-delete t
))
1482 (let* ((re-sel (concat ":\\(" (mapconcat 'regexp-quote
1485 (re-excl (concat ":\\(" (mapconcat 'regexp-quote
1489 (goto-char (point-min))
1490 (when (and select-tags
1492 (concat "^\\*+[ \t].*" re-sel
"[^ \t\n]*[ \t]*$") nil t
))
1493 ;; At least one tree is marked for export, this means
1494 ;; all the unmarked stuff needs to go.
1495 ;; Dig out the trees that should be exported
1496 (goto-char (point-min))
1497 (outline-next-heading)
1499 (put-text-property beg
(point-max) :org-delete t
)
1500 (while (re-search-forward re-sel nil t
)
1501 (when (org-on-heading-p)
1502 (org-back-to-heading)
1503 (remove-text-properties
1504 (max (1- (point)) (point-min))
1505 (setq cont
(save-excursion (org-end-of-subtree t t
)))
1507 (while (and (org-up-heading-safe)
1508 (get-text-property (point) :org-delete
))
1509 (remove-text-properties (max (1- (point)) (point-min))
1510 (point-at-eol) '(:org-delete t
)))
1512 ;; Remove the trees explicitly marked for noexport
1514 (goto-char (point-min))
1515 (while (re-search-forward re-excl nil t
)
1516 (when (org-at-heading-p)
1517 (org-back-to-heading t
)
1519 (org-end-of-subtree t t
)
1520 (delete-region beg
(point))
1521 (when (featurep 'org-inlinetask
)
1522 (org-inlinetask-remove-END-maybe)))))
1523 ;; Remove everything that is now still marked for deletion
1524 (goto-char (point-min))
1525 (while (setq beg
(text-property-any (point-min) (point-max) :org-delete t
))
1526 (setq end
(or (next-single-property-change beg
:org-delete
)
1528 (delete-region beg end
))))
1530 (defun org-export-remove-tasks (keep)
1531 "Remove tasks depending on configuration.
1532 When KEEP is nil, remove all tasks.
1533 When KEEP is `todo', remove the tasks that are DONE.
1534 When KEEP is `done', remove the tasks that are not yet done.
1535 When it is a list of strings, keep only tasks with these TODO keywords."
1536 (when (or (listp keep
) (memq keep
'(todo done nil
)))
1537 (let ((re (concat "^\\*+[ \t]+\\("
1540 (cond ((not keep
) org-todo-keywords-1
)
1541 ((eq keep
'todo
) org-done-keywords
)
1542 ((eq keep
'done
) org-not-done-keywords
)
1544 (org-delete-all keep
(copy-sequence
1545 org-todo-keywords-1
))))
1547 "\\)\\($\\|[ \t]\\)"))
1548 (case-fold-search nil
)
1550 (goto-char (point-min))
1551 (while (re-search-forward re nil t
)
1553 (setq beg
(match-beginning 0))
1554 (org-end-of-subtree t t
)
1555 (if (looking-at "^\\*+[ \t]+END[ \t]*$")
1556 ;; Kill the END line of the inline task
1557 (goto-char (min (point-max) (1+ (match-end 0)))))
1558 (delete-region beg
(point)))))))
1560 (defun org-export-remove-archived-trees (export-archived-trees)
1561 "Remove archived trees.
1562 When EXPORT-ARCHIVED-TREES is `headline;, only the headline will be exported.
1563 When it is t, the entire archived tree will be exported.
1564 When it is nil the entire tree including the headline will be removed
1566 (let ((re-archive (concat ":" org-archive-tag
":"))
1568 (when (not (eq export-archived-trees t
))
1569 (goto-char (point-min))
1570 (while (re-search-forward re-archive nil t
)
1571 (if (not (org-on-heading-p t
))
1572 (goto-char (point-at-eol))
1573 (beginning-of-line 1)
1574 (setq a
(if export-archived-trees
1575 (1+ (point-at-eol)) (point))
1576 b
(org-end-of-subtree t
))
1577 (if (> b a
) (delete-region a b
)))))))
1579 (defun org-export-remove-headline-metadata (opts)
1580 "Remove meta data from the headline, according to user options."
1581 (let ((re org-complex-heading-regexp
)
1582 (todo (plist-get opts
:todo-keywords
))
1583 (tags (plist-get opts
:tags
))
1584 (pri (plist-get opts
:priority
))
1586 (case-fold-search nil
)
1588 (setq elts
(delq nil
(list 1 (if todo
2) (if pri
3) 4 (if tags
5))))
1589 (when (or (not todo
) (not tags
) (not pri
))
1590 (goto-char (point-min))
1591 (while (re-search-forward re nil t
)
1593 (setq rpl
(mapconcat (lambda (i) (if (match-end i
) (match-string i
) ""))
1595 (replace-match rpl t t
))))))
1597 (defun org-export-remove-timestamps ()
1598 "Remove timestamps and keywords for export."
1599 (goto-char (point-min))
1600 (while (re-search-forward org-maybe-keyword-time-regexp nil t
)
1603 (unless (save-match-data (org-at-table-p))
1605 (beginning-of-line 1)
1606 (if (looking-at "[- \t]*\\(=>[- \t0-9:]*\\)?[ \t]*\n")
1607 (replace-match ""))))))
1609 (defun org-export-remove-clock-lines ()
1610 "Remove clock lines for export."
1611 (goto-char (point-min))
1612 (let ((re (concat "^[ \t]*" org-clock-string
".*\n?")))
1613 (while (re-search-forward re nil t
)
1615 (replace-match "")))))
1617 (defun org-export-protect-quoted-subtrees ()
1618 "Mark quoted subtrees with the protection property."
1619 (let ((re-quote (concat "^\\*+[ \t]+" org-quote-string
"\\>")))
1620 (goto-char (point-min))
1621 (while (re-search-forward re-quote nil t
)
1622 (goto-char (match-beginning 0))
1624 (add-text-properties (point) (org-end-of-subtree t
)
1625 '(org-protected t
)))))
1627 (defun org-export-convert-protected-spaces ()
1628 "Convert strings like \\____ to protected spaces in all backends."
1629 (goto-char (point-min))
1630 (while (re-search-forward "\\\\__+" nil t
)
1631 (org-if-unprotected-1
1635 ((eq org-export-current-backend
'latex
)
1636 (format "\\hspace{%dex}" (- (match-end 0) (match-beginning 0))))
1637 ((eq org-export-current-backend
'html
)
1638 (org-add-props (match-string 0) nil
1639 'org-whitespace
(- (match-end 0) (match-beginning 0))))
1640 ;; ((eq org-export-current-backend 'docbook))
1641 ((eq org-export-current-backend
'ascii
)
1642 (org-add-props (match-string 0) '(org-whitespace t
)))
1643 (t (make-string (- (match-end 0) (match-beginning 0)) ?\
)))
1647 (defun org-export-protect-verbatim ()
1648 "Mark verbatim snippets with the protection property."
1649 (goto-char (point-min))
1650 (while (re-search-forward org-verbatim-re nil t
)
1652 (add-text-properties (match-beginning 4) (match-end 4)
1653 '(org-protected t org-verbatim-emph t
))
1654 (goto-char (1+ (match-end 4))))))
1656 (defun org-export-protect-colon-examples ()
1657 "Protect lines starting with a colon."
1658 (goto-char (point-min))
1659 (let ((re "^[ \t]*:\\([ \t]\\|$\\)") beg
)
1660 (while (re-search-forward re nil t
)
1661 (beginning-of-line 1)
1663 (while (looking-at re
)
1665 (or (eobp) (forward-char 1)))
1666 (add-text-properties beg
(if (bolp) (1- (point)) (point))
1667 '(org-protected t
)))))
1669 (defvar org-export-backends
1670 '(docbook html beamer ascii latex
)
1671 "List of Org supported export backends.")
1673 (defun org-export-select-backend-specific-text ()
1674 (let ((formatters org-export-backends
)
1675 (case-fold-search t
)
1676 backend backend-name beg beg-content end end-content ind
)
1679 (setq backend
(pop formatters
)
1680 backend-name
(symbol-name backend
))
1682 ;; Handle #+BACKEND: stuff
1683 (goto-char (point-min))
1684 (while (re-search-forward (concat "^\\([ \t]*\\)#\\+" backend-name
1685 ":[ \t]*\\(.*\\)") nil t
)
1686 (if (not (eq backend org-export-current-backend
))
1687 (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
1688 (replace-match "\\1\\2" t
)
1689 (add-text-properties
1690 (point-at-bol) (min (1+ (point-at-eol)) (point-max))
1691 `(org-protected t original-indentation
,ind org-native-text t
))))
1692 ;; Delete #+ATTR_BACKEND: stuff of another backend. Those
1693 ;; matching the current backend will be taken care of by
1694 ;; `org-export-attach-captions-and-attributes'
1695 (goto-char (point-min))
1696 (while (re-search-forward (concat "^\\([ \t]*\\)#\\+ATTR_" backend-name
1697 ":[ \t]*\\(.*\\)") nil t
)
1698 (setq ind
(org-get-indentation))
1699 (when (not (eq backend org-export-current-backend
))
1700 (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
1701 ;; Handle #+BEGIN_BACKEND and #+END_BACKEND stuff
1702 (goto-char (point-min))
1703 (while (re-search-forward (concat "^[ \t]*#\\+BEGIN_" backend-name
"\\>.*\n?")
1705 (setq beg
(match-beginning 0) beg-content
(match-end 0))
1706 (setq ind
(save-excursion (goto-char beg
) (org-get-indentation)))
1707 (when (re-search-forward (concat "^[ \t]*#\\+END_" backend-name
"\\>.*\n?")
1709 (setq end
(match-end 0) end-content
(match-beginning 0))
1710 (if (eq backend org-export-current-backend
)
1713 (add-text-properties
1714 beg-content end-content
1715 `(org-protected t original-indentation
,ind org-native-text t
))
1716 ;; strip protective commas
1719 (goto-char beg-content
)
1720 (while (re-search-forward "^[ \t]*\\(,\\)" end-content t
)
1721 (replace-match "" nil nil nil
1))))
1722 (delete-region (match-beginning 0) (match-end 0))
1725 (delete-region (point) (1+ (point-at-eol)))))
1726 ;; No, this is for a different backend, kill it
1727 (delete-region beg end
)))))))
1729 (defun org-export-mark-blockquote-verse-center ()
1730 "Mark block quote and verse environments with special cookies.
1731 These special cookies will later be interpreted by the backend."
1733 (let (type t1 ind beg end beg1 end1 content
)
1734 (goto-char (point-min))
1735 (while (re-search-forward
1736 "^\\([ \t]*\\)#\\+\\(begin_\\(\\(block\\)?quote\\|verse\\|center\\)\\>.*\\)"
1738 (setq ind
(length (match-string 1))
1739 type
(downcase (match-string 3))
1740 t1
(if (equal type
"quote") "blockquote" type
))
1741 (setq beg
(match-beginning 0)
1742 beg1
(1+ (match-end 0)))
1743 (when (re-search-forward (concat "^[ \t]*#\\+end_" type
"\\>.*") nil t
)
1744 (setq end1
(1- (match-beginning 0))
1745 end
(+ (point-at-eol) (if (looking-at "\n$") 1 0)))
1746 (setq content
(org-remove-indentation (buffer-substring beg1 end1
)))
1747 (setq content
(concat "ORG-" (upcase t1
) "-START\n"
1749 "ORG-" (upcase t1
) "-END\n"))
1750 (delete-region beg end
)
1751 (insert (org-add-props content nil
'original-indentation ind
))))))
1753 (defun org-export-mark-list-end ()
1754 "Mark all list endings with a special string."
1755 (unless (eq org-export-current-backend
'ascii
)
1758 ;; For each type allowing list export, find every list, remove
1759 ;; ending regexp if needed, and insert org-list-end.
1760 (goto-char (point-min))
1761 (while (re-search-forward (org-item-beginning-re) nil t
)
1762 (when (eq (nth 2 (org-list-context)) e
)
1763 (let* ((struct (org-list-struct))
1764 (bottom (org-list-get-bottom-point struct
))
1765 (top (point-at-bol))
1766 (top-ind (org-list-get-ind top struct
)))
1768 (when (and (not (eq org-list-ending-method
'indent
))
1769 (looking-at org-list-end-re
))
1771 (unless (bolp) (insert "\n"))
1772 ;; As org-list-end is inserted at column 0, it would end
1773 ;; by indentation any list. It can be problematic when
1774 ;; there are lists within lists: the inner list end would
1775 ;; also become the outer list end. To avoid this, text
1776 ;; property `original-indentation' is added, as
1777 ;; `org-list-struct' pays attention to it when reading a
1779 (insert (org-add-props
1780 "ORG-LIST-END-MARKER\n"
1781 (list 'original-indentation top-ind
)))))))
1782 (cons nil org-list-export-context
))))
1784 (defun org-export-mark-list-properties ()
1785 "Mark list with special properties.
1786 These special properties will later be interpreted by the backend."
1789 ;; Mark a list with 3 properties: `list-item' which is
1790 ;; position at beginning of line, `list-struct' which is
1791 ;; list structure, and `list-prevs' which is the alist of
1792 ;; item and its predecessor. Leave point at list ending.
1794 (let* ((struct (org-list-struct))
1795 (top (org-list-get-top-point struct
))
1796 (bottom (org-list-get-bottom-point struct
))
1797 (prevs (org-list-prevs-alist struct
))
1799 ;; Get every item and ending position, without dups and
1800 ;; without bottom point of list.
1804 (unless (memq pos poi
)
1806 (unless (or (= end bottom
) (memq end poi
))
1809 (setq poi
(sort poi
'<))
1810 ;; For every point of interest, mark the whole line with
1811 ;; its position in list.
1815 (add-text-properties (point-at-bol) (point-at-eol)
1816 (list 'list-item
(point-at-bol)
1818 'list-prevs prevs
)))
1820 ;; Take care of bottom point. As babel may have inserted
1821 ;; a new list in buffer, list ending isn't always
1822 ;; marked. Now mark every list ending and add properties
1823 ;; useful to line processing exporters.
1825 (when (or (looking-at "^ORG-LIST-END-MARKER\n")
1826 (and (not (eq org-list-ending-method
'indent
))
1827 (looking-at org-list-end-re
)))
1829 (unless (bolp) (insert "\n"))
1831 (org-add-props "ORG-LIST-END-MARKER\n" (list 'list-item bottom
1833 'list-prevs prevs
)))
1834 ;; Following property is used by LaTeX exporter.
1835 (add-text-properties top
(point) (list 'list-context ctxt
)))))))
1836 ;; Mark lists except for backends not interpreting them.
1837 (unless (eq org-export-current-backend
'ascii
)
1838 (let ((org-list-end-re "^ORG-LIST-END-MARKER\n"))
1841 (goto-char (point-min))
1842 (while (re-search-forward (org-item-beginning-re) nil t
)
1843 (let ((context (nth 2 (org-list-context))))
1845 (funcall mark-list e
)
1846 (put-text-property (point-at-bol) (point-at-eol)
1847 'list-context context
)))))
1848 (cons nil org-list-export-context
))))))
1850 (defun org-export-attach-captions-and-attributes (target-alist)
1851 "Move #+CAPTION, #+ATTR_BACKEND, and #+LABEL text into text properties.
1852 If the next thing following is a table, add the text properties to the first
1853 table line. If it is a link, add it to the line containing the link."
1854 (goto-char (point-min))
1855 (remove-text-properties (point-min) (point-max)
1856 '(org-caption nil org-attributes nil
))
1857 (let ((case-fold-search t
)
1858 (re (concat "^[ \t]*#\\+caption:[ \t]+\\(.*\\)"
1860 "^[ \t]*#\\+attr_" (symbol-name org-export-current-backend
) ":[ \t]+\\(.*\\)"
1862 "^[ \t]*#\\+label:[ \t]+\\(.*\\)"
1864 "^[ \t]*\\(|[^-]\\)"
1866 "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
1867 cap shortn attr label end
)
1868 (while (re-search-forward re nil t
)
1870 ;; there is a caption
1873 (setq cap
(concat cap
(if cap
" " "") (org-trim (match-string 1))))
1874 (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap
)
1875 (setq shortn
(match-string 1 cap
)
1876 cap
(match-string 2 cap
)))
1877 (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
1878 ;; there is an attribute
1881 (setq attr
(concat attr
(if attr
" " "") (org-trim (match-string 2))))
1882 (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
1886 (setq label
(org-trim (match-string 3)))
1887 (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
1889 (setq end
(if (match-end 4)
1890 (let ((ee (org-table-end)))
1891 (prog1 (1- (marker-position ee
)) (move-marker ee nil
)))
1893 (add-text-properties (point-at-bol) end
1894 (list 'org-caption cap
1895 'org-caption-shortn shortn
1896 'org-attributes attr
1898 (if label
(push (cons label label
) target-alist
))
1900 (setq cap nil shortn nil attr nil label nil
)))))
1903 (defun org-export-remove-comment-blocks-and-subtrees ()
1904 "Remove the comment environment, and also commented subtrees."
1905 (let ((re-commented (concat "^\\*+[ \t]+" org-comment-string
"\\>"))
1907 ;; Remove comment environment
1908 (goto-char (point-min))
1909 (setq case-fold-search t
)
1910 (while (re-search-forward
1911 "^#\\+begin_comment[ \t]*\n[^\000]*?\n#\\+end_comment\\>.*" nil t
)
1912 (replace-match "" t t
))
1913 ;; Remove subtrees that are commented
1914 (goto-char (point-min))
1915 (setq case-fold-search nil
)
1916 (while (re-search-forward re-commented nil t
)
1917 (goto-char (match-beginning 0))
1918 (delete-region (point) (org-end-of-subtree t
)))))
1920 (defun org-export-handle-comments (commentsp)
1921 "Remove comments, or convert to backend-specific format.
1922 COMMENTSP can be a format string for publishing comments.
1923 When it is nil, all comments will be removed."
1924 (let ((re "^\\(#\\|[ \t]*#\\+ \\)\\(.*\n?\\)")
1926 (goto-char (point-min))
1927 (while (or (looking-at re
)
1928 (re-search-forward re nil t
))
1929 (setq pos
(match-beginning 0))
1930 (if (get-text-property pos
'org-protected
)
1931 (goto-char (1+ pos
))
1933 (not (equal (char-before (match-end 1)) ?
+)))
1934 (progn (add-text-properties
1935 (match-beginning 0) (match-end 0) '(org-protected t
))
1936 (replace-match (org-add-props
1937 (format commentsp
(match-string 2))
1938 nil
'org-protected t
)
1940 (goto-char (1+ pos
))
1942 (goto-char (max (point-min) (1- pos
))))))))
1944 (defun org-export-handle-table-metalines ()
1945 "Remove table specific metalines #+TBLNAME: and #+TBLFM:."
1946 (let ((re "^[ \t]*#\\+TBL\\(NAME\\|FM\\):\\(.*\n?\\)")
1948 (goto-char (point-min))
1949 (while (or (looking-at re
)
1950 (re-search-forward re nil t
))
1951 (setq pos
(match-beginning 0))
1952 (if (get-text-property (match-beginning 1) 'org-protected
)
1953 (goto-char (1+ pos
))
1954 (goto-char (1+ pos
))
1956 (goto-char (max (point-min) (1- pos
)))))))
1958 (defun org-export-mark-radio-links ()
1959 "Find all matches for radio targets and turn them into internal links."
1960 (let ((re-radio (and org-target-link-regexp
1961 (concat "\\([^<]\\)\\(" org-target-link-regexp
"\\)"))))
1962 (goto-char (point-min))
1964 (while (re-search-forward re-radio nil t
)
1967 (or (org-in-regexp org-bracket-link-regexp
)
1968 (org-in-regexp org-plain-link-re
)
1969 (org-in-regexp "<<[^<>]+>>")))
1971 (replace-match "\\1[[\\2]]")))))))
1973 (defun org-store-forced-table-alignment ()
1974 "Find table lines which force alignment, store the results in properties."
1975 (let (line cnt aligns
)
1976 (goto-char (point-min))
1977 (while (re-search-forward "|[ \t]*<[lrc][0-9]*>[ \t]*|" nil t
)
1978 ;; OK, this looks like a table line with an alignment cookie
1980 (setq line
(buffer-substring (point-at-bol) (point-at-eol)))
1981 (when (and (org-at-table-p)
1982 (org-table-cookie-line-p line
))
1983 (setq cnt
0 aligns nil
)
1987 (if (string-match "\\`<\\([lrc]\\)" x
)
1988 (push (cons cnt
(downcase (match-string 1 x
))) aligns
)))
1989 (org-split-string line
"[ \t]*|[ \t]*"))
1990 (add-text-properties (org-table-begin) (org-table-end)
1991 (list 'org-forced-aligns aligns
))))
1992 (goto-char (point-at-eol)))))
1994 (defun org-export-remove-special-table-lines ()
1995 "Remove tables lines that are used for internal purposes.
1996 Also, store forced alignment information found in such lines."
1997 (goto-char (point-min))
1998 (while (re-search-forward "^[ \t]*|" nil t
)
1999 (org-if-unprotected-at (1- (point))
2000 (beginning-of-line 1)
2001 (if (or (looking-at "[ \t]*| *[!_^] *|")
2007 (or (and org-export-table-remove-empty-lines
(= (length f
) 0))
2009 "\\`<\\([0-9]\\|[lrc]\\|[lrc][0-9]+\\)>\\'" f
)))
2010 (org-split-string ;; FIXME, can't we do without splitting???
2011 (buffer-substring (point-at-bol) (point-at-eol))
2012 "[ \t]*|[ \t]*")))))
2013 (delete-region (max (point-min) (1- (point-at-bol)))
2017 (defun org-export-protect-sub-super (s)
2019 (while (string-match "\\([^\\\\]\\)\\([_^]\\)" s
)
2020 (setq s
(replace-match "\\1\\\\\\2" nil nil s
)))
2023 (defun org-export-normalize-links ()
2024 "Convert all links to bracket links, and expand link abbreviations."
2025 (let ((re-plain-link (concat "\\([^[<]\\)" org-plain-link-re
))
2026 (re-angle-link (concat "\\([^[]\\)" org-angle-link-re
))
2028 (goto-char (point-min))
2029 (while (re-search-forward re-plain-link nil t
)
2030 (unless (org-string-match-p
2031 "\\[\\[\\S-+:\\S-*?\\<"
2032 (buffer-substring (point-at-bol) (match-beginning 0)))
2033 (goto-char (1- (match-end 0)))
2034 (org-if-unprotected-at (1+ (match-beginning 0))
2035 (let* ((s (concat (match-string 1)
2036 "[[" (match-string 2) ":" (match-string 3)
2037 "][" (match-string 2) ":" (org-export-protect-sub-super
2040 ;; added 'org-link face to links
2041 (put-text-property 0 (length s
) 'face
'org-link s
)
2042 (replace-match s t t
)))))
2043 (goto-char (point-min))
2044 (while (re-search-forward re-angle-link nil t
)
2045 (goto-char (1- (match-end 0)))
2047 (let* ((s (concat (match-string 1)
2048 "[[" (match-string 2) ":" (match-string 3)
2049 "][" (match-string 2) ":" (org-export-protect-sub-super
2052 (put-text-property 0 (length s
) 'face
'org-link s
)
2053 (replace-match s t t
))))
2054 (goto-char (point-min))
2055 (while (re-search-forward org-bracket-link-regexp nil t
)
2056 (goto-char (1- (match-end 0)))
2057 (setq nodesc
(not (match-end 3)))
2059 (let* ((xx (save-match-data
2061 (org-link-expand-abbrev (match-string 1)))))
2063 "[[" (org-add-props (copy-sequence xx
)
2064 nil
'org-protected t
'org-no-description nodesc
)
2068 (concat "[" (copy-sequence xx
)
2071 (put-text-property 0 (length s
) 'face
'org-link s
)
2072 (replace-match s t t
))))))
2074 (defun org-export-concatenate-multiline-links ()
2075 "Find multi-line links and put it all into a single line.
2076 This is to make sure that the line-processing export backends
2077 can work correctly."
2078 (goto-char (point-min))
2079 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t
)
2080 (org-if-unprotected-at (match-beginning 1)
2081 (replace-match "\\1 \\3")
2082 (goto-char (match-beginning 0)))))
2084 (defun org-export-concatenate-multiline-emphasis ()
2085 "Find multi-line emphasis and put it all into a single line.
2086 This is to make sure that the line-processing export backends
2087 can work correctly."
2088 (goto-char (point-min))
2089 (while (re-search-forward org-emph-re nil t
)
2090 (if (and (not (= (char-after (match-beginning 3))
2091 (char-after (match-beginning 4))))
2092 (save-excursion (goto-char (match-beginning 0))
2094 (and (not (org-at-table-p))
2095 (not (org-at-heading-p))))))
2097 (subst-char-in-region (match-beginning 0) (match-end 0)
2099 (goto-char (1- (match-end 0))))
2100 (goto-char (1+ (match-beginning 0))))))
2102 (defun org-export-grab-title-from-buffer ()
2103 "Get a title for the current document, from looking at the buffer."
2104 (let ((inhibit-read-only t
))
2106 (goto-char (point-min))
2107 (let ((end (if (looking-at org-outline-regexp
)
2109 (save-excursion (outline-next-heading) (point)))))
2110 (when (re-search-forward "^[ \t]*[^|# \t\r\n].*\n" end t
)
2111 ;; Mark the line so that it will not be exported as normal text.
2113 (add-text-properties (match-beginning 0) (match-end 0)
2114 (list :org-license-to-kill t
)))
2115 ;; Return the title string
2116 (org-trim (match-string 0)))))))
2118 (defun org-export-get-title-from-subtree ()
2119 "Return subtree title and exclude it from export."
2120 (let ((rbeg (region-beginning)) (rend (region-end))
2121 (inhibit-read-only t
) title
)
2124 (when (and (org-at-heading-p)
2125 (>= (org-end-of-subtree t t
) rend
))
2126 ;; This is a subtree, we take the title from the first heading
2128 (looking-at org-todo-line-regexp
)
2129 (setq title
(match-string 3))
2131 (add-text-properties (point) (1+ (point-at-eol))
2132 (list :org-license-to-kill t
)))
2133 (setq title
(or (org-entry-get nil
"EXPORT_TITLE") title
))))
2136 (defun org-solidify-link-text (s &optional alist
)
2137 "Take link text and make a safe target out of it."
2142 (org-split-string s
"[^a-zA-Z0-9_\\.-]+") "-"))
2143 (a (assoc rtn alist
)))
2146 (defun org-get-min-level (lines &optional offset
)
2147 "Get the minimum level in LINES."
2148 (let ((re "^\\(\\*+\\) ") l
)
2150 (while (setq l
(pop lines
))
2151 (if (string-match re l
)
2152 (throw 'exit
(org-tr-level (- (length (match-string 1 l
))
2156 ;; Variable holding the vector with section numbers
2157 (defvar org-section-numbers
(make-vector org-level-max
0))
2159 (defun org-init-section-numbers ()
2160 "Initialize the vector for the section numbers."
2162 (numbers (nreverse (org-split-string "" "\\.")))
2163 (depth (1- (length org-section-numbers
)))
2164 (i depth
) number-string
)
2167 (aset org-section-numbers i
0)
2168 (setq number-string
(or (car numbers
) "0"))
2169 (if (string-match "\\`[A-Z]\\'" number-string
)
2170 (aset org-section-numbers i
2171 (- (string-to-char number-string
) ?A -
1))
2172 (aset org-section-numbers i
(string-to-number number-string
)))
2176 (defun org-section-number (&optional level
)
2177 "Return a string with the current section number.
2178 When LEVEL is non-nil, increase section numbers on that level."
2179 (let* ((depth (1- (length org-section-numbers
)))
2181 (fmts (car org-export-section-number-format
))
2182 (term (cdr org-export-section-number-format
))
2187 (aset org-section-numbers
2188 level
(1+ (aref org-section-numbers level
))))
2189 (setq idx
(1+ level
))
2190 (while (<= idx depth
)
2192 (aset org-section-numbers idx
0))
2193 (setq idx
(1+ idx
))))
2195 (while (<= idx depth
)
2196 (when (> (aref org-section-numbers idx
) 0)
2197 (setq fmt
(or (pop fmts
) fmt
)
2199 n
(aref org-section-numbers idx
)
2201 (concat string sep
(org-number-to-counter n ctype
))
2202 (concat string
".0"))
2204 (setq idx
(1+ idx
)))
2206 (if (string-match "\\`\\([@0]\\.\\)+" string
)
2207 (setq string
(replace-match "" t nil string
)))
2208 (if (string-match "\\(\\.0\\)+\\'" string
)
2209 (setq string
(replace-match "" t nil string
))))
2210 (concat string term
)))
2212 (defun org-number-to-counter (n type
)
2213 "Concert number N to a string counter, according to TYPE.
2214 TYPE must be a string, any of:
2218 I upper case roman numeral
2219 i lower case roman numeral"
2221 ((equal type
"1") (number-to-string n
))
2222 ((equal type
"A") (char-to-string (+ ?A n -
1)))
2223 ((equal type
"a") (char-to-string (+ ?a n -
1)))
2224 ((equal type
"I") (org-number-to-roman n
))
2225 ((equal type
"i") (downcase (org-number-to-roman n
)))
2226 (t (error "Invalid counter type `%s'" type
))))
2228 (defun org-number-to-roman (n)
2229 "Convert integer N into a roman numeral."
2230 (let ((roman '((1000 .
"M") (900 .
"CM") (500 .
"D") (400 .
"CD")
2231 ( 100 .
"C") ( 90 .
"XC") ( 50 .
"L") ( 40 .
"XL")
2232 ( 10 .
"X") ( 9 .
"IX") ( 5 .
"V") ( 4 .
"IV")
2236 (number-to-string n
)
2238 (if (>= n
(caar roman
))
2239 (setq n
(- n
(caar roman
))
2240 res
(concat res
(cdar roman
)))
2246 (defun org-export-preprocess-apply-macros ()
2247 "Replace macro references."
2248 (goto-char (point-min))
2249 (let (sy val key args args2 ind-str s n
)
2250 (while (re-search-forward
2251 "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}"
2253 (unless (save-match-data (save-excursion
2254 (goto-char (point-at-bol))
2255 (looking-at "[ \t]*#\\+macro")))
2256 ;; Get macro name (KEY), arguments (ARGS), and indentation of
2257 ;; current line (IND-STR) as strings.
2258 (setq key
(downcase (match-string 1))
2259 args
(match-string 3)
2260 ind-str
(save-match-data (save-excursion
2262 (looking-at "^\\([ \t]*\\).*")
2264 ;; When macro is defined, retrieve replacement text in VAL,
2265 ;; and proceed with expansion.
2266 (when (setq val
(or (plist-get org-export-opt-plist
2267 (intern (concat ":macro-" key
)))
2268 (plist-get org-export-opt-plist
2269 (intern (concat ":" key
)))))
2271 ;; If arguments are provided, first retreive them properly
2272 ;; (in ARGS, as a list), then replace them in VAL.
2274 (setq args
(org-split-string args
",") args2 nil
)
2276 (while (string-match "\\\\\\'" (car args
))
2277 ;; Repair bad splits.
2278 (setcar (cdr args
) (concat (substring (car args
) 0 -
1)
2281 (push (pop args
) args2
))
2282 (setq args
(mapcar 'org-trim
(nreverse args2
)))
2284 (while (string-match "\\$\\([0-9]+\\)" val s
)
2285 (setq s
(1+ (match-beginning 0))
2286 n
(string-to-number (match-string 1 val
)))
2287 (and (>= (length args
) n
)
2288 (setq val
(replace-match (nth (1- n
) args
) t t val
)))))
2289 ;; VAL starts with "(eval": it is a sexp, `eval' it.
2290 (when (string-match "\\`(eval\\>" val
)
2291 (setq val
(eval (read val
))))
2292 ;; Ensure VAL is a string (or nil) and that each new line
2293 ;; is indented as the first one.
2295 (mapconcat 'identity
2297 (if (stringp val
) val
(format "%s" val
))
2299 (concat "\n" ind-str
)))))
2300 ;; Eventually do the replacement, if VAL isn't nil. Move
2301 ;; point at beginning of macro for recursive expansions.
2303 (replace-match val t t
)
2304 (goto-char (match-beginning 0))))))))
2306 (defun org-export-apply-macros-in-string (s)
2307 "Apply the macros in string S."
2311 (org-export-preprocess-apply-macros)
2316 (defun org-export-handle-include-files ()
2317 "Include the contents of include files, with proper formatting."
2318 (let ((case-fold-search t
)
2319 params file markup lang start end prefix prefix1 switches all minlevel lines
)
2320 (goto-char (point-min))
2321 (while (re-search-forward "^#\\+INCLUDE:?[ \t]+\\(.*\\)" nil t
)
2322 (setq params
(read (concat "(" (match-string 1) ")"))
2323 prefix
(org-get-and-remove-property 'params
:prefix
)
2324 prefix1
(org-get-and-remove-property 'params
:prefix1
)
2325 minlevel
(org-get-and-remove-property 'params
:minlevel
)
2326 lines
(org-get-and-remove-property 'params
:lines
)
2327 file
(org-symname-or-string (pop params
))
2328 markup
(org-symname-or-string (pop params
))
2329 lang
(and (member markup
'("src" "SRC"))
2330 (org-symname-or-string (pop params
)))
2331 switches
(mapconcat #'(lambda (x) (format "%s" x
)) params
" ")
2333 (delete-region (match-beginning 0) (match-end 0))
2335 (not (file-exists-p file
))
2336 (not (file-readable-p file
)))
2337 (insert (format "CANNOT INCLUDE FILE %s" file
))
2338 (setq all
(cons file all
))
2340 (if (equal (downcase markup
) "src")
2341 (setq start
(format "#+begin_src %s %s\n"
2342 (or lang
"fundamental")
2345 (setq start
(format "#+begin_%s %s\n" markup switches
)
2346 end
(format "#+end_%s" markup
))))
2347 (insert (or start
""))
2348 (insert (org-get-file-contents (expand-file-name file
)
2349 prefix prefix1 markup minlevel lines
))
2350 (or (bolp) (newline))
2351 (insert (or end
""))))
2354 (defun org-export-handle-include-files-recurse ()
2355 "Recursively include files aborting on circular inclusion."
2356 (let ((now (list org-current-export-file
)) all
)
2358 (setq all
(append now all
))
2359 (setq now
(org-export-handle-include-files))
2362 (mapcar (lambda (el) (when (member el all
) el
)) now
))))
2364 (error "Recursive #+INCLUDE: %S" intersection
))))))
2366 (defun org-get-file-contents (file &optional prefix prefix1 markup minlevel lines
)
2367 "Get the contents of FILE and return them as a string.
2368 If PREFIX is a string, prepend it to each line. If PREFIX1
2369 is a string, prepend it to the first line instead of PREFIX.
2370 If MARKUP, don't protect org-like lines, the exporter will
2371 take care of the block they are in. If LINES is a string
2372 specifying a range of lines, include only those lines ."
2373 (if (stringp markup
) (setq markup
(downcase markup
)))
2375 (insert-file-contents file
)
2377 (let* ((lines (split-string lines
"-"))
2378 (lbeg (string-to-number (car lines
)))
2379 (lend (string-to-number (cadr lines
)))
2380 (beg (if (zerop lbeg
) (point-min)
2381 (goto-char (point-min))
2382 (forward-line (1- lbeg
))
2384 (end (if (zerop lend
) (point-max)
2385 (goto-char (point-min))
2386 (forward-line (1- lend
))
2388 (narrow-to-region beg end
)))
2389 (when (or prefix prefix1
)
2390 (goto-char (point-min))
2392 (insert (or prefix1 prefix
))
2394 (beginning-of-line 2)))
2396 (when (member markup
'("src" "example"))
2397 (goto-char (point-min))
2398 (while (re-search-forward "^\\([*#]\\|[ \t]*#\\+\\)" nil t
)
2399 (goto-char (match-beginning 0))
2403 (dotimes (lvl minlevel
)
2404 (org-map-region 'org-demote
(point-min) (point-max))))
2407 (defun org-get-and-remove-property (listvar prop
)
2408 "Check if the value of LISTVAR contains PROP as a property.
2409 If yes, return the value of that property (i.e. the element following
2410 in the list) and remove property and value from the list in LISTVAR."
2411 (let ((list (symbol-value listvar
)) m v
)
2412 (when (setq m
(member prop list
))
2414 (if (equal (car list
) prop
)
2415 (set listvar
(cddr list
))
2416 (setcdr (nthcdr (- (length list
) (length m
) 1) list
)
2418 (set listvar list
)))
2421 (defun org-symname-or-string (s)
2423 (if s
(symbol-name s
) s
)
2426 ;;; Fontification and line numbers for code examples
2428 (defvar org-export-last-code-line-counter-value
0)
2430 (defun org-export-replace-src-segments-and-examples ()
2431 "Replace source code segments with special code for export."
2432 (setq org-export-last-code-line-counter-value
0)
2433 (let ((case-fold-search t
)
2434 lang code trans opts indent caption
)
2435 (goto-char (point-min))
2436 (while (re-search-forward
2437 "\\(^\\([ \t]*\\)#\\+BEGIN_SRC:?\\([ \t]+\\([^ \t\n]+\\)\\)?\\(.*\\)\n\\([^\000]+?\n\\)[ \t]*#\\+END_SRC.*\n?\\)\\|\\(^\\([ \t]*\\)#\\+BEGIN_EXAMPLE:?\\(?:[ \t]+\\(.*\\)\\)?\n\\([^\000]+?\n\\)[ \t]*#\\+END_EXAMPLE.*\n?\\)"
2440 (if (not (match-string 4))
2441 (error "Source block missing language specification: %s"
2442 (let* ((body (match-string 6))
2443 (nothing (message "body:%s" body
))
2444 (preview (or (and (string-match
2445 "^[ \t]*\\([^\n\r]*\\)" body
)
2446 (match-string 1 body
)) body
)))
2447 (if (> (length preview
) 35)
2448 (concat (substring preview
0 32) "...")
2451 (setq lang
(match-string 4)
2452 opts
(match-string 5)
2453 code
(match-string 6)
2454 indent
(length (match-string 2))
2455 caption
(get-text-property 0 'org-caption
(match-string 0))))
2457 opts
(match-string 9)
2458 code
(match-string 10)
2459 indent
(length (match-string 8))
2460 caption
(get-text-property 0 'org-caption
(match-string 0))))
2462 (setq trans
(org-export-format-source-code-or-example
2463 lang code opts indent caption
))
2464 (replace-match trans t t
))))
2466 (defvar org-export-latex-verbatim-wrap
) ;; defined in org-latex.el
2467 (defvar org-export-latex-listings
) ;; defined in org-latex.el
2468 (defvar org-export-latex-listings-langs
) ;; defined in org-latex.el
2469 (defvar org-export-latex-listings-w-names
) ;; defined in org-latex.el
2470 (defvar org-export-latex-minted-langs
) ;; defined in org-latex.el
2471 (defvar org-export-latex-custom-lang-environments
) ;; defined in org-latex.el
2472 (defvar org-export-latex-listings-options
) ;; defined in org-latex.el
2473 (defvar org-export-latex-minted-options
) ;; defined in org-latex.el
2475 (defun org-remove-formatting-on-newlines-in-region (beg end
)
2476 "Remove formatting on newline characters"
2480 (while (progn (end-of-line) (< (point) end
))
2481 (put-text-property (point) (1+ (point)) 'face nil
)
2484 (defun org-export-format-source-code-or-example
2485 (lang code
&optional opts indent caption
)
2486 "Format CODE from language LANG and return it formatted for export.
2487 The CODE is marked up in `org-export-current-backend' format.
2489 Check if a function by name
2490 \"org-<backend>-format-source-code-or-example\" is bound. If yes,
2491 use it as the custom formatter. Otherwise, use the default
2492 formatter. Default formatters are provided for docbook, html,
2493 latex and ascii backends. For example, use
2494 `org-html-format-source-code-or-example' to provide a custom
2495 formatter for export to \"html\".
2497 If LANG is nil, do not add any fontification.
2498 OPTS contains formatting options, like `-n' for triggering numbering lines,
2499 and `+n' for continuing previous numbering.
2500 Code formatting according to language currently only works for HTML.
2501 Numbering lines works for all three major backends (html, latex, and ascii).
2502 INDENT was the original indentation of the block."
2504 (let* ((backend-name (symbol-name org-export-current-backend
))
2506 (intern (format "org-%s-format-source-code-or-example"
2508 (backend-feature (intern (concat "org-" backend-name
)))
2510 (and (require (intern (concat "org-" backend-name
)) nil
)
2511 (fboundp backend-formatter
) backend-formatter
))
2512 num cont rtn rpllbl keepp textareap preserve-indentp cols rows fmt
)
2513 (setq opts
(or opts
"")
2514 num
(string-match "[-+]n\\>" opts
)
2515 cont
(string-match "\\+n\\>" opts
)
2516 rpllbl
(string-match "-r\\>" opts
)
2517 keepp
(string-match "-k\\>" opts
)
2518 textareap
(string-match "-t\\>" opts
)
2519 preserve-indentp
(or org-src-preserve-indentation
2520 (string-match "-i\\>" opts
))
2521 cols
(if (string-match "-w[ \t]+\\([0-9]+\\)" opts
)
2522 (string-to-number (match-string 1 opts
))
2524 rows
(if (string-match "-h[ \t]+\\([0-9]+\\)" opts
)
2525 (string-to-number (match-string 1 opts
))
2526 (org-count-lines code
))
2527 fmt
(if (string-match "-l[ \t]+\"\\([^\"\n]+\\)\"" opts
)
2528 (match-string 1 opts
)))
2529 (when (and textareap
(eq org-export-current-backend
'html
))
2530 ;; we cannot use numbering or highlighting.
2531 (setq num nil cont nil lang nil
))
2532 (if keepp
(setq rpllbl
'keep
))
2533 (setq rtn
(if preserve-indentp code
(org-remove-indentation code
)))
2534 (when (string-match "^," rtn
)
2535 (setq rtn
(with-temp-buffer
2537 ;; Free up the protected lines
2538 (goto-char (point-min))
2539 (while (re-search-forward "^," nil t
)
2540 (if (or (equal lang
"org")
2542 (looking-at "\\([*#]\\|[ \t]*#\\+\\)")))
2546 ;; Now backend-specific coding
2550 (funcall backend-formatter rtn lang caption textareap cols rows num
2552 ((eq org-export-current-backend
'docbook
)
2553 (setq rtn
(org-export-number-lines rtn
0 0 num cont rpllbl fmt
))
2554 (concat "<programlisting><![CDATA["
2556 "]]></programlisting>\n"))
2557 ((eq org-export-current-backend
'html
)
2558 ;; We are exporting to HTML
2560 (if (featurep 'xemacs
)
2562 (require 'htmlize nil t
))
2563 (when (not (fboundp 'htmlize-region-for-paste
))
2564 ;; we do not have htmlize.el, or an old version of it
2567 "htmlize.el 1.34 or later is needed for source code formatting")))
2570 (let* ((lang-m (when lang
2571 (or (cdr (assoc lang org-src-lang-modes
))
2573 (mode (and lang-m
(intern
2575 (if (symbolp lang-m
)
2576 (symbol-name lang-m
)
2579 (org-inhibit-startup t
)
2580 (org-startup-folded nil
))
2584 (if (functionp mode
)
2587 (font-lock-fontify-buffer)
2588 ;; markup each line separately
2589 (org-remove-formatting-on-newlines-in-region (point-min) (point-max))
2591 (set-buffer-modified-p nil
)
2592 (org-export-htmlize-region-for-paste
2593 (point-min) (point-max))))
2594 (if (string-match "<pre\\([^>]*\\)>\n*" rtn
)
2599 "<div class=\"org-src-container\">"
2601 "<label class=\"org-src-name\">%s</label>"
2605 (format "<pre class=\"src src-%s\">\n" lang
)
2607 (if caption
"</div>" "")))))
2610 (format "<p>\n<textarea cols=\"%d\" rows=\"%d\">"
2612 rtn
"</textarea>\n</p>\n"))
2615 (goto-char (point-min))
2616 (while (re-search-forward "[<>&]" nil t
)
2617 (replace-match (cdr (assq (char-before)
2618 '((?
&.
"&")(?
<.
"<")(?
>.
">"))))
2620 (setq rtn
(buffer-string)))
2621 (setq rtn
(concat "<pre class=\"example\">\n" rtn
"</pre>\n"))))
2623 (setq rtn
(org-export-number-lines rtn
1 1 num cont rpllbl fmt
)))
2624 (if (string-match "\\(\\`<[^>]*>\\)\n" rtn
)
2625 (setq rtn
(replace-match "\\1" t nil rtn
)))
2627 ((eq org-export-current-backend
'latex
)
2628 (setq rtn
(org-export-number-lines rtn
0 0 num cont rpllbl fmt
))
2630 ((and lang org-export-latex-listings
)
2631 (flet ((make-option-string
2633 (concat (first pair
)
2634 (if (> (length (second pair
)) 0)
2635 (concat "=" (second pair
))))))
2636 (let* ((lang-sym (intern lang
))
2637 (minted-p (eq org-export-latex-listings
'minted
))
2638 (listings-p (not minted-p
))
2644 (minted-p org-export-latex-minted-langs
)
2645 (listings-p org-export-latex-listings-langs
))))
2651 org-export-latex-custom-lang-environments
))))
2653 (when (and listings-p
(not custom-environment
))
2657 #'make-option-string
2658 (append org-export-latex-listings-options
2659 `(("language" ,backend-lang
))) ",")))
2660 (when (and caption org-export-latex-listings-w-names
)
2663 (replace-regexp-in-string "_" "\\\\_" caption
)))
2666 (format "\\begin{%s}\n%s\\end{%s}\n"
2667 custom-environment rtn custom-environment
))
2669 (format "\\begin{%s}\n%s\\end{%s}\n"
2670 "lstlisting" rtn
"lstlisting"))
2673 "\\begin{minted}[%s]{%s}\n%s\\end{minted}\n"
2674 (mapconcat #'make-option-string
2675 org-export-latex-minted-options
",")
2676 backend-lang rtn
)))))))
2677 (t (concat (car org-export-latex-verbatim-wrap
)
2678 rtn
(cdr org-export-latex-verbatim-wrap
)))))
2679 ((eq org-export-current-backend
'ascii
)
2680 ;; This is not HTML or LaTeX, so just make it an example.
2681 (setq rtn
(org-export-number-lines rtn
0 0 num cont rpllbl fmt
))
2682 (concat caption
"\n"
2685 (lambda (l) (concat " " l
))
2686 (org-split-string rtn
"\n")
2691 (error "Don't know how to markup source or example block in %s"
2692 (upcase backend-name
)))))
2695 "\n#+BEGIN_" backend-name
"\n"
2697 '(org-protected t org-example t org-native-text t
))
2698 "\n#+END_" backend-name
"\n\n"))
2699 (org-add-props rtn nil
'original-indentation indent
))))
2701 (defun org-export-number-lines (text &optional skip1 skip2 number cont
2702 replace-labels label-format
)
2703 (setq skip1
(or skip1
0) skip2
(or skip2
0))
2704 (if (not cont
) (setq org-export-last-code-line-counter-value
0))
2707 (goto-char (point-max))
2708 (skip-chars-backward " \t\n\r")
2709 (delete-region (point) (point-max))
2710 (beginning-of-line (- 1 skip2
))
2711 (let* ((last (org-current-line))
2712 (n org-export-last-code-line-counter-value
)
2713 (nmax (+ n
(- last skip1
)))
2714 (fmt (format "%%%dd: " (length (number-to-string nmax
))))
2717 ((eq org-export-current-backend
'html
) (format "<span class=\"linenr\">%s</span>"
2719 ((eq org-export-current-backend
'ascii
) fmt
)
2720 ((eq org-export-current-backend
'latex
) fmt
)
2721 ((eq org-export-current-backend
'docbook
) fmt
)
2723 (label-format (or label-format org-coderef-label-format
))
2724 (label-pre (if (string-match "%s" label-format
)
2725 (substring label-format
0 (match-beginning 0))
2727 (label-post (if (string-match "%s" label-format
)
2728 (substring label-format
(match-end 0))
2732 ".*?\\S-.*?\\([ \t]*\\("
2733 (regexp-quote label-pre
)
2734 "\\([-a-zA-Z0-9_ ]+\\)"
2735 (regexp-quote label-post
)
2739 (org-goto-line (1+ skip1
))
2740 (while (and (re-search-forward "^" nil t
) (not (eobp)) (< n nmax
))
2742 (insert (format fm
(incf n
)))
2744 (when (looking-at lbl-re
)
2745 (setq ref
(match-string 3))
2746 (cond ((numberp replace-labels
)
2747 ;; remove labels; use numbers for references when lines
2748 ;; are numbered, use labels otherwise
2749 (delete-region (match-beginning 1) (match-end 1))
2750 (push (cons ref
(if (> n
0) n ref
)) org-export-code-refs
))
2751 ((eq replace-labels
'keep
)
2752 ;; don't remove labels; use numbers for references when
2753 ;; lines are numbered, use labels otherwise
2754 (goto-char (match-beginning 2))
2755 (delete-region (match-beginning 2) (match-end 2))
2756 (insert "(" ref
")")
2757 (push (cons ref
(if (> n
0) n
(concat "(" ref
")")))
2758 org-export-code-refs
))
2760 ;; don't remove labels and don't use numbers for
2762 (goto-char (match-beginning 2))
2763 (delete-region (match-beginning 2) (match-end 2))
2764 (insert "(" ref
")")
2765 (push (cons ref
(concat "(" ref
")")) org-export-code-refs
)))
2766 (when (eq org-export-current-backend
'html
)
2768 (beginning-of-line 1)
2769 (insert (format "<span id=\"coderef-%s\" class=\"coderef-off\">"
2772 (insert "</span>")))))
2773 (setq org-export-last-code-line-counter-value n
)
2774 (goto-char (point-max))
2778 (defun org-search-todo-below (line lines level
)
2779 "Search the subtree below LINE for any TODO entries."
2780 (let ((rest (cdr (memq line lines
)))
2781 (re org-todo-line-regexp
)
2784 (while (setq line
(pop rest
))
2785 (if (string-match re line
)
2787 (setq lv
(- (match-end 1) (match-beginning 1))
2788 todo
(and (match-beginning 2)
2789 (not (member (match-string 2 line
)
2790 org-done-keywords
))))
2792 (if (<= lv level
) (throw 'exit nil
))
2793 (if todo
(throw 'exit t
))))))))
2796 (defun org-export-visible (type arg
)
2797 "Create a copy of the visible part of the current buffer, and export it.
2798 The copy is created in a temporary buffer and removed after use.
2799 TYPE is the final key (as a string) that also selects the export command in
2800 the \\<org-mode-map>\\[org-export] export dispatcher.
2801 As a special case, if the you type SPC at the prompt, the temporary
2802 org-mode file will not be removed but presented to you so that you can
2803 continue to use it. The prefix arg ARG is passed through to the exporting
2807 (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")
2808 (read-char-exclusive))
2809 current-prefix-arg
))
2810 (if (not (member type
'(?a ?n ?u ?\C-a ?b ?\C-b ?h ?D ?x ?\ ?l ?p ?d ?L ?H ?R
)))
2811 (error "Invalid export key"))
2812 (let* ((binding (cdr (assoc type
2814 (?a . org-export-as-ascii
)
2815 (?A . org-export-as-ascii-to-buffer
)
2816 (?n . org-export-as-latin1
)
2817 (?N . org-export-as-latin1-to-buffer
)
2818 (?u . org-export-as-utf8
)
2819 (?U . org-export-as-utf8-to-buffer
)
2820 (?\C-a . org-export-as-ascii
)
2821 (?b . org-export-as-html-and-open
)
2822 (?\C-b . org-export-as-html-and-open
)
2823 (?h . org-export-as-html
)
2824 (?H . org-export-as-html-to-buffer
)
2825 (?R . org-export-region-as-html
)
2826 (?D . org-export-as-docbook
)
2828 (?l . org-export-as-latex
)
2829 (?p . org-export-as-pdf
)
2830 (?d . org-export-as-pdf-and-open
)
2831 (?L . org-export-as-latex-to-buffer
)
2833 (?x . org-export-as-xoxo
)))))
2834 (keepp (equal type ?\
))
2835 (file buffer-file-name
)
2836 (buffer (get-buffer-create "*Org Export Visible*"))
2838 ;; Need to hack the drawers here.
2840 (goto-char (point-min))
2841 (while (re-search-forward org-drawer-regexp nil t
)
2842 (goto-char (match-beginning 1))
2843 (or (outline-invisible-p) (org-flag-drawer nil
))))
2844 (with-current-buffer buffer
(erase-buffer))
2846 (setq s
(goto-char (point-min)))
2847 (while (not (= (point) (point-max)))
2848 (goto-char (org-find-invisible))
2849 (append-to-buffer buffer s
(point))
2850 (setq s
(goto-char (org-find-visible))))
2851 (org-cycle-hide-drawers 'all
)
2852 (goto-char (point-min))
2854 ;; Copy all comment lines to the end, to make sure #+ settings are
2855 ;; still available for the second export step. Kind of a hack, but
2856 ;; does do the trick.
2857 (if (looking-at "#[^\r\n]*")
2858 (append-to-buffer buffer
(match-beginning 0) (1+ (match-end 0))))
2859 (when (re-search-forward "^\\*+[ \t]+" nil t
)
2860 (while (re-search-backward "[\n\r]#[^\n\r]*" nil t
)
2861 (append-to-buffer buffer
(1+ (match-beginning 0))
2862 (min (point-max) (1+ (match-end 0)))))))
2864 (let ((buffer-file-name file
)
2865 (org-inhibit-startup t
))
2868 (unless keepp
(funcall binding arg
))))
2870 (kill-buffer buffer
)
2871 (switch-to-buffer-other-window buffer
)
2872 (goto-char (point-min)))))
2874 (defun org-find-visible ()
2876 (while (and (not (= (point-max) (setq s
(next-overlay-change s
))))
2877 (get-char-property s
'invisible
)))
2879 (defun org-find-invisible ()
2881 (while (and (not (= (point-max) (setq s
(next-overlay-change s
))))
2882 (not (get-char-property s
'invisible
))))
2885 (defvar org-export-htmlized-org-css-url
) ;; defined in org-html.el
2887 (defun org-export-string (string fmt
&optional dir
)
2888 "Export STRING to FMT using existing export facilities.
2889 During export STRING is saved to a temporary file whose location
2890 could vary. Optional argument DIR can be used to force the
2891 directory in which the temporary file is created during export
2892 which can be useful for resolving relative paths. Dir defaults
2893 to the value of `temporary-file-directory'."
2894 (let ((temporary-file-directory (or dir temporary-file-directory
))
2895 (tmp-file (make-temp-file "org-")))
2899 (write-file tmp-file
)
2900 (org-load-modules-maybe)
2901 (unless org-local-vars
2902 (setq org-local-vars
(org-get-local-variables)))
2903 (eval ;; convert to fmt -- mimicing `org-run-like-in-org-mode'
2904 (list 'let org-local-vars
2905 (list (intern (format "org-export-as-%s" fmt
))
2906 nil nil nil
''string t
))))
2907 (delete-file tmp-file
))))
2910 (defun org-export-as-org (arg &optional hidden ext-plist
2911 to-buffer body-only pub-dir
)
2912 "Make a copy with not-exporting stuff removed.
2913 The purpose of this function is to provide a way to export the source
2914 Org file of a webpage in Org format, but with sensitive and/or irrelevant
2915 stuff removed. This command will remove the following:
2917 - archived trees (if the variable `org-export-with-archived-trees' is nil)
2918 - comment blocks and trees starting with the COMMENT keyword
2919 - only trees that are consistent with `org-export-select-tags'
2920 and `org-export-exclude-tags'.
2922 The only arguments that will be used are EXT-PLIST and PUB-DIR,
2923 all the others will be ignored (but are present so that the general
2924 mechanism to call publishing functions will work).
2926 EXT-PLIST is a property list with external parameters overriding
2927 org-mode's default settings, but still inferior to file-local
2928 settings. When PUB-DIR is set, use this as the publishing
2931 (let* ((opt-plist (org-combine-plists (org-default-export-plist)
2933 (org-infile-export-plist)))
2934 (bfname (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
2935 (filename (concat (file-name-as-directory
2937 (org-export-directory :org opt-plist
)))
2938 (file-name-sans-extension
2939 (file-name-nondirectory bfname
))
2941 (filename (and filename
2942 (if (equal (file-truename filename
)
2943 (file-truename bfname
))
2944 (concat (file-name-sans-extension filename
)
2946 (file-name-extension filename
))
2948 (backup-inhibited t
)
2949 (buffer (find-file-noselect filename
))
2950 (region (buffer-string))
2953 (switch-to-buffer buffer
)
2956 (let ((org-inhibit-startup t
)) (org-mode))
2957 (org-install-letbind)
2959 ;; Get rid of archived trees
2960 (org-export-remove-archived-trees (plist-get opt-plist
:archived-trees
))
2962 ;; Remove comment environment and comment subtrees
2963 (org-export-remove-comment-blocks-and-subtrees)
2965 ;; Get rid of excluded trees
2966 (org-export-handle-export-tags (plist-get opt-plist
:select-tags
)
2967 (plist-get opt-plist
:exclude-tags
))
2969 (when (or (plist-get opt-plist
:plain-source
)
2970 (not (or (plist-get opt-plist
:plain-source
)
2971 (plist-get opt-plist
:htmlized-source
))))
2972 ;; Either nothing special is requested (default call)
2973 ;; or the plain source is explicitly requested
2976 (when (plist-get opt-plist
:htmlized-source
)
2977 ;; Make the htmlized version
2980 (font-lock-fontify-buffer)
2981 (let* ((htmlize-output-type 'css
)
2982 (newbuf (htmlize-buffer)))
2983 (with-current-buffer newbuf
2984 (when org-export-htmlized-org-css-url
2985 (goto-char (point-min))
2986 (and (re-search-forward
2987 "<style type=\"text/css\">[^\000]*?\n[ \t]*</style>.*"
2991 "<link rel=\"stylesheet\" type=\"text/css\" href=\"%s\">"
2992 org-export-htmlized-org-css-url
)
2994 (write-file (concat filename
".html")))
2995 (kill-buffer newbuf
)))
2996 (set-buffer-modified-p nil
)
2997 (if (equal to-buffer
'string
)
2998 (progn (setq str-ret
(buffer-string))
2999 (kill-buffer (current-buffer))
3001 (kill-buffer (current-buffer))))))
3003 (defvar org-archive-location
) ;; gets loaded with the org-archive require.
3004 (defun org-get-current-options ()
3005 "Return a string with current options as keyword options.
3006 Does include HTML export options as well as TODO and CATEGORY stuff."
3007 (require 'org-archive
)
3016 #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s -:%s f:%s *:%s <:%s
3017 #+OPTIONS: TeX:%s LaTeX:%s skip:%s d:%s todo:%s pri:%s tags:%s
3019 #+EXPORT_SELECT_TAGS: %s
3020 #+EXPORT_EXCLUDE_TAGS: %s
3027 #+PRIORITIES: %c %c %c
3029 #+STARTUP: %s %s %s %s %s
3035 (buffer-name) (user-full-name) user-mail-address
3036 (format-time-string (substring (car org-time-stamp-formats
) 1 -
1))
3037 org-export-default-language
3038 org-export-headline-levels
3039 org-export-with-section-numbers
3041 org-export-preserve-breaks
3042 org-export-html-expand
3043 org-export-with-fixed-width
3044 org-export-with-tables
3045 org-export-with-sub-superscripts
3046 org-export-with-special-strings
3047 org-export-with-footnotes
3048 org-export-with-emphasize
3049 org-export-with-timestamps
3050 org-export-with-TeX-macros
3051 org-export-with-LaTeX-fragments
3052 org-export-skip-text-before-1st-heading
3053 org-export-with-drawers
3054 org-export-with-todo-keywords
3055 org-export-with-priority
3056 org-export-with-tags
3057 (if (featurep 'org-jsinfo
) (org-infojs-options-inbuffer-template) "")
3058 (mapconcat 'identity org-export-select-tags
" ")
3059 (mapconcat 'identity org-export-exclude-tags
" ")
3060 org-export-html-link-up
3061 org-export-html-link-home
3063 (file-name-sans-extension
3064 (file-name-nondirectory (buffer-file-name (buffer-base-buffer)))))
3066 "TODO FEEDBACK VERIFY DONE"
3067 "Me Jason Marie DONE"
3068 org-highest-priority org-lowest-priority org-default-priority
3069 (mapconcat 'identity org-drawers
" ")
3070 (cdr (assoc org-startup-folded
3071 '((nil .
"showall") (t .
"overview") (content .
"content"))))
3072 (if org-odd-levels-only
"odd" "oddeven")
3073 (if org-hide-leading-stars
"hidestars" "showstars")
3074 (if org-startup-align-all-tables
"align" "noalign")
3075 (cond ((eq org-log-done t
) "logdone")
3076 ((equal org-log-done
'note
) "lognotedone")
3077 ((not org-log-done
) "nologdone"))
3078 (or (mapconcat (lambda (x)
3080 ((equal :startgroup
(car x
)) "{")
3081 ((equal :endgroup
(car x
)) "}")
3082 ((equal :newline
(car x
)) "")
3083 ((cdr x
) (format "%s(%c)" (car x
) (cdr x
)))
3085 (or org-tag-alist
(org-get-buffer-tags)) " ") "")
3086 (mapconcat 'identity org-file-tags
" ")
3087 org-archive-location
3088 "org file:~/org/%s.org"
3092 (defun org-insert-export-options-template ()
3093 "Insert into the buffer a template with information for exporting."
3095 (if (not (bolp)) (newline))
3096 (let ((s (org-get-current-options)))
3097 (and (string-match "#\\+CATEGORY" s
)
3098 (setq s
(substring s
0 (match-beginning 0))))
3101 (defvar org-table-colgroup-info nil
)
3103 (defun org-table-clean-before-export (lines &optional maybe-quoted
)
3104 "Check if the table has a marking column.
3105 If yes remove the column and the special lines."
3106 (setq org-table-colgroup-info nil
)
3109 (lambda (x) (or (string-match "^[ \t]*|-" x
)
3112 "^[ \t]*| *\\\\?\\([\#!$*_^ /]\\) *|"
3113 "^[ \t]*| *\\([\#!$*_^ /]\\) *|")
3116 ;; No special marking column
3118 (setq org-table-clean-did-remove-column nil
)
3123 ((org-table-colgroup-line-p x
)
3124 ;; This line contains colgroup info, extract it
3125 ;; and then discard the line
3126 (setq org-table-colgroup-info
3128 (cond ((member x
'("<" "<")) :start
)
3129 ((member x
'(">" ">")) :end
)
3130 ((member x
'("<>" "<>")) :startend
)
3132 (org-split-string x
"[ \t]*|[ \t]*")))
3134 ((org-table-cookie-line-p x
)
3135 ;; This line contains formatting cookies, discard it
3139 ;; there is a special marking column
3140 (setq org-table-clean-did-remove-column t
)
3145 ((org-table-colgroup-line-p x
)
3146 ;; This line contains colgroup info, extract it
3147 ;; and then discard the line
3148 (setq org-table-colgroup-info
3150 (cond ((member x
'("<" "<")) :start
)
3151 ((member x
'(">" ">")) :end
)
3152 ((member x
'("<>" "<>")) :startend
)
3154 (cdr (org-split-string x
"[ \t]*|[ \t]*"))))
3156 ((org-table-cookie-line-p x
)
3157 ;; This line contains formatting cookies, discard it
3159 ((string-match "^[ \t]*| *[!_^/] *|" x
)
3162 ((or (string-match "^\\([ \t]*\\)|-+\\+" x
)
3163 (string-match "^\\([ \t]*\\)|[^|]*|" x
))
3164 ;; remove the first column
3165 (replace-match "\\1|" t nil x
))))
3168 (defun org-export-cleanup-toc-line (s)
3169 "Remove tags and timestamps from lines going into the toc."
3170 (when (memq org-export-with-tags
'(not-in-toc nil
))
3171 (if (string-match (org-re " +:[[:alnum:]_@#%:]+: *$") s
)
3172 (setq s
(replace-match "" t t s
))))
3173 (when org-export-remove-timestamps-from-toc
3174 (while (string-match org-maybe-keyword-time-regexp s
)
3175 (setq s
(replace-match "" t t s
))))
3176 (while (string-match org-bracket-link-regexp s
)
3177 (setq s
(replace-match (match-string (if (match-end 3) 3 1) s
)
3179 (while (string-match "\\[\\([0-9]\\|fn:[^]]*\\)\\]" s
)
3180 (setq s
(replace-match "" t t s
)))
3184 (defun org-get-text-property-any (pos prop
&optional object
)
3185 (or (get-text-property pos prop object
)
3186 (and (setq pos
(next-single-property-change pos prop object
))
3187 (get-text-property pos prop object
))))
3189 (defun org-export-get-coderef-format (path desc
)
3191 (if (and desc
(string-match
3192 (regexp-quote (concat "(" path
")"))
3194 (replace-match "%s" t t desc
)
3197 (defun org-export-push-to-kill-ring (format)
3198 "Push buffer content to kill ring.
3199 The depends on the variable `org-export-copy-to-kill'."
3200 (when org-export-copy-to-kill-ring
3201 (org-kill-new (buffer-string))
3202 (when (fboundp 'x-set-selection
)
3203 (ignore-errors (x-set-selection 'PRIMARY
(buffer-string)))
3204 (ignore-errors (x-set-selection 'CLIPBOARD
(buffer-string))))
3205 (message "%s export done, pushed to kill ring and clipboard" format
)))
3209 ;; arch-tag: 65985fe9-095c-49c7-a7b6-cb4ee15c0a95
3211 ;;; org-exp.el ends here
