1 ;;; org-exp.el --- ASCII, HTML, XOXO and iCalendar export for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
32 (require 'org-exp-blocks
)
37 (declare-function org-export-latex-preprocess
"org-latex" (parameters))
38 (declare-function org-export-ascii-preprocess
"org-ascii" (parameters))
39 (declare-function org-export-html-preprocess
"org-html" (parameters))
40 (declare-function org-export-docbook-preprocess
"org-docbook" (parameters))
41 (declare-function org-infojs-options-inbuffer-template
"org-jsinfo" ())
42 (declare-function org-export-htmlize-region-for-paste
"org-html" (beg end
))
43 (declare-function htmlize-buffer
"ext:htmlize" (&optional buffer
))
44 (declare-function org-inlinetask-remove-END-maybe
"org-inlinetask" ())
45 (autoload 'org-export-generic
"org-export-generic" "Export using the generic exporter" t
)
46 (defgroup org-export nil
47 "Options for exporting org-listings."
51 (defgroup org-export-general nil
52 "General options for exporting Org-mode files."
53 :tag
"Org Export General"
56 (defcustom org-export-allow-BIND
'confirm
57 "Non-nil means, allow #+BIND to define local variable values for export.
58 This is a potential security risk, which is why the user must confirm the
60 :group
'org-export-general
62 (const :tag
"Never" nil
)
63 (const :tag
"Always" t
)
64 (const :tag
"Make the user confirm for each file" confirm
)))
67 (defvar org-export-publishing-directory nil
)
69 (defcustom org-export-show-temporary-export-buffer t
70 "Non-nil means, show buffer after exporting to temp buffer.
71 When Org exports to a file, the buffer visiting that file is ever
72 shown, but remains buried. However, when exporting to a temporary
73 buffer, that buffer is popped up in a second window. When this variable
74 is nil, the buffer remains buried also in these cases."
75 :group
'org-export-general
78 (defcustom org-export-copy-to-kill-ring t
79 "Non-nil means, exported stuff will also be pushed onto the kill ring."
80 :group
'org-export-general
83 (defcustom org-export-run-in-background nil
84 "Non-nil means export and publishing commands will run in background.
85 This works by starting up a separate Emacs process visiting the same file
86 and doing the export from there.
87 Not all export commands are affected by this - only the ones which
88 actually write to a file, and that do not depend on the buffer state.
90 If this option is nil, you can still get background export by calling
91 `org-export' with a double prefix arg: `C-u C-u C-c C-e'.
93 If this option is t, the double prefix can be used to exceptionally
94 force an export command into the current process."
95 :group
'org-export-general
98 (defcustom org-export-select-tags
'("export")
99 "Tags that select a tree for export.
100 If any such tag is found in a buffer, all trees that do not carry one
101 of these tags will be deleted before export.
102 Inside trees that are selected like this, you can still deselect a
103 subtree by tagging it with one of the `org-export-exclude-tags'."
104 :group
'org-export-general
105 :type
'(repeat (string :tag
"Tag")))
107 (defcustom org-export-exclude-tags
'("noexport")
108 "Tags that exclude a tree from export.
109 All trees carrying any of these tags will be excluded from export.
110 This is without condition, so even subtrees inside that carry one of the
111 `org-export-select-tags' will be removed."
112 :group
'org-export-general
113 :type
'(repeat (string :tag
"Tag")))
115 ;; FIXME: rename, this is a general variable
116 (defcustom org-export-html-expand t
117 "Non-nil means, for HTML export, treat @<...> as HTML tag.
118 When nil, these tags will be exported as plain text and therefore
119 not be interpreted by a browser.
121 This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
122 :group
'org-export-html
123 :group
'org-export-general
126 (defcustom org-export-with-special-strings t
127 "Non-nil means, interpret \"\-\", \"--\" and \"---\" for export.
128 When this option is turned on, these strings will be exported as:
131 -----+----------+--------
137 This option can also be set with the +OPTIONS line, e.g. \"-:nil\"."
138 :group
'org-export-translation
141 (defcustom org-export-html-link-up
""
142 "Where should the \"UP\" link of exported HTML pages lead?"
143 :group
'org-export-html
144 :group
'org-export-general
145 :type
'(string :tag
"File or URL"))
147 (defcustom org-export-html-link-home
""
148 "Where should the \"HOME\" link of exported HTML pages lead?"
149 :group
'org-export-html
150 :group
'org-export-general
151 :type
'(string :tag
"File or URL"))
153 (defcustom org-export-language-setup
154 '(("en" "Author" "Date" "Table of Contents" "Footnotes")
155 ("ca" "Autor" "Data" "Índex" "Peus de pàgina")
156 ("cs" "Autor" "Datum" "Obsah" "Pozn\xe1mky pod carou")
157 ("da" "Ophavsmand" "Dato" "Indhold" "Fodnoter")
158 ("de" "Autor" "Datum" "Inhaltsverzeichnis" "Fußnoten")
159 ("eo" "Aŭtoro" "Dato" "Enhavo" "Piednotoj")
160 ("es" "Autor" "Fecha" "Índice" "Pies de página")
161 ("fi" "Tekijä" "Päivämäärä" "Sisällysluettelo" "Alaviitteet")
162 ("fr" "Auteur" "Date" "Table des matières" "Notes de bas de page")
163 ("hu" "Szerzõ" "Dátum" "Tartalomjegyzék" "Lábjegyzet")
164 ("is" "Höfundur" "Dagsetning" "Efnisyfirlit" "Aftanmálsgreinar")
165 ("it" "Autore" "Data" "Indice" "Note a piè di pagina")
166 ("nl" "Auteur" "Datum" "Inhoudsopgave" "Voetnoten")
167 ("no" "Forfatter" "Dato" "Innhold" "Fotnoter")
168 ("nb" "Forfatter" "Dato" "Innhold" "Fotnoter") ;; nb = Norsk (bokm.l)
169 ("nn" "Forfattar" "Dato" "Innhald" "Fotnotar") ;; nn = Norsk (nynorsk)
170 ("pl" "Autor" "Data" "Spis treści" "Przypis")
171 ("sv" "Författare" "Datum" "Innehåll" "Fotnoter"))
172 "Terms used in export text, translated to different languages.
173 Use the variable `org-export-default-language' to set the language,
174 or use the +OPTION lines for a per-file setting."
175 :group
'org-export-general
178 (string :tag
"HTML language tag")
179 (string :tag
"Author")
181 (string :tag
"Table of Contents")
182 (string :tag
"Footnotes"))))
184 (defcustom org-export-default-language
"en"
185 "The default language of HTML export, as a string.
186 This should have an association in `org-export-language-setup'."
187 :group
'org-export-general
190 (defvar org-export-page-description
""
191 "The page description, for the XHTML meta tag.
192 This is best set with the #+DESCRIPTION line in a file, it does not make
193 sense to set this globally.")
195 (defvar org-export-page-keywords
""
196 "The page description, for the XHTML meta tag.
197 This is best set with the #+KEYWORDS line in a file, it does not make
198 sense to set this globally.")
200 (defcustom org-export-skip-text-before-1st-heading nil
201 "Non-nil means, skip all text before the first headline when exporting.
202 When nil, that text is exported as well."
203 :group
'org-export-general
206 (defcustom org-export-headline-levels
3
207 "The last level which is still exported as a headline.
208 Inferior levels will produce itemize lists when exported.
209 Note that a numeric prefix argument to an exporter function overrides
212 This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
213 :group
'org-export-general
216 (defcustom org-export-with-section-numbers t
217 "Non-nil means, add section numbers to headlines when exporting.
219 This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
220 :group
'org-export-general
223 (defcustom org-export-section-number-format
'((("1" ".")) .
"")
224 "Format of section numbers for export.
225 The variable has two components.
226 1. A list of lists, each indicating a counter type and a separator.
227 The counter type can be any of \"1\", \"A\", \"a\", \"I\", or \"a\".
228 It causes causes numeric, alphabetic, or roman counters, respectively.
229 The separator is only used if another counter for a subsection is being
231 If there are more numbered section levels than entries in this lists,
232 then the last entry will be reused.
233 2. A terminator string that will be added after the entire
235 :group
'org-export-general
239 (string :tag
"Counter Type")
240 (string :tag
"Separator ")))
241 (string :tag
"Terminator")))
243 (defcustom org-export-with-toc t
244 "Non-nil means, create a table of contents in exported files.
245 The TOC contains headlines with levels up to`org-export-headline-levels'.
246 When an integer, include levels up to N in the toc, this may then be
247 different from `org-export-headline-levels', but it will not be allowed
248 to be larger than the number of headline levels.
249 When nil, no table of contents is made.
251 Headlines which contain any TODO items will be marked with \"(*)\" in
252 ASCII export, and with red color in HTML output, if the option
253 `org-export-mark-todo-in-toc' is set.
255 In HTML output, the TOC will be clickable.
257 This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"
259 :group
'org-export-general
261 (const :tag
"No Table of Contents" nil
)
262 (const :tag
"Full Table of Contents" t
)
263 (integer :tag
"TOC to level")))
265 (defcustom org-export-mark-todo-in-toc nil
266 "Non-nil means, mark TOC lines that contain any open TODO items."
267 :group
'org-export-general
270 (defcustom org-export-with-todo-keywords t
271 "Non-nil means, include TODO keywords in export.
272 When nil, remove all these keywords from the export."
273 :group
'org-export-general
276 (defcustom org-export-with-priority nil
277 "Non-nil means, include priority cookies in export.
278 When nil, remove priority cookies for export."
279 :group
'org-export-general
282 (defcustom org-export-preserve-breaks nil
283 "Non-nil means, preserve all line breaks when exporting.
284 Normally, in HTML output paragraphs will be reformatted. In ASCII
285 export, line breaks will always be preserved, regardless of this variable.
287 This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
288 :group
'org-export-general
291 (defcustom org-export-with-archived-trees
'headline
292 "Whether subtrees with the ARCHIVE tag should be exported.
293 This can have three different values
294 nil Do not export, pretend this tree is not present
295 t Do export the entire tree
296 headline Only export the headline, but skip the tree below it."
297 :group
'org-export-general
300 (const :tag
"not at all" nil
)
301 (const :tag
"headline only" 'headline
)
302 (const :tag
"entirely" t
)))
304 (defcustom org-export-author-info t
305 "Non-nil means, insert author name and email into the exported file.
307 This option can also be set with the +OPTIONS line,
308 e.g. \"author-info:nil\"."
309 :group
'org-export-general
312 (defcustom org-export-creator-info t
313 "Non-nil means, the postamble should contain a creator sentence.
314 This sentence is \"HTML generated by org-mode XX in emacs XXX\"."
315 :group
'org-export-general
318 (defcustom org-export-time-stamp-file t
319 "Non-nil means, insert a time stamp into the exported file.
320 The time stamp shows when the file was created.
322 This option can also be set with the +OPTIONS line,
323 e.g. \"timestamp:nil\"."
324 :group
'org-export-general
327 (defcustom org-export-with-timestamps t
328 "If nil, do not export time stamps and associated keywords."
329 :group
'org-export-general
332 (defcustom org-export-remove-timestamps-from-toc t
333 "If t, remove timestamps from the table of contents entries."
334 :group
'org-export-general
337 (defcustom org-export-with-tags
'not-in-toc
338 "If nil, do not export tags, just remove them from headlines.
339 If this is the symbol `not-in-toc', tags will be removed from table of
340 contents entries, but still be shown in the headlines of the document.
342 This option can also be set with the +OPTIONS line, e.g. \"tags:nil\"."
343 :group
'org-export-general
345 (const :tag
"Off" nil
)
346 (const :tag
"Not in TOC" not-in-toc
)
347 (const :tag
"On" t
)))
349 (defcustom org-export-with-drawers nil
350 "Non-nil means, export with drawers like the property drawer.
351 When t, all drawers are exported. This may also be a list of
352 drawer names to export."
353 :group
'org-export-general
355 (const :tag
"All drawers" t
)
356 (const :tag
"None" nil
)
357 (repeat :tag
"Selected drawers"
358 (string :tag
"Drawer name"))))
360 (defvar org-export-preprocess-hook nil
361 "Hook for preprocessing an export buffer.
362 Pretty much the first thing when exporting is running this hook.")
364 (defvar org-export-preprocess-after-include-files-hook nil
365 "Hook for preprocessing an export buffer.
366 This is run after the contents of included files have been inserted.")
368 (defvar org-export-preprocess-after-tree-selection-hook nil
369 "Hook for preprocessing an export buffer.
370 This is run after selection of trees to be exported has happened.
371 This selection includes tags-based selection, as well as removal
372 of commented and archived trees.")
374 (defvar org-export-preprocess-after-blockquote-hook nil
375 "Hook for preprocessing an export buffer.
376 This is run after blockquote/quote/verse/center have been marked
379 (defvar org-export-preprocess-before-backend-specifics-hook nil
380 "Hook run before backend-specific functions are called during preprocessing.")
382 (defvar org-export-preprocess-final-hook nil
383 "Hook for preprocessing an export buffer.
384 This is run as the last thing in the preprocessing buffer, just before
385 returning the buffer string to the backend.")
387 (defgroup org-export-translation nil
388 "Options for translating special ascii sequences for the export backends."
389 :tag
"Org Export Translation"
392 (defcustom org-export-with-emphasize t
393 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
394 If the export target supports emphasizing text, the word will be
395 typeset in bold, italic, or underlined, respectively. Works only for
396 single words, but you can say: I *really* *mean* *this*.
397 Not all export backends support this.
399 This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
400 :group
'org-export-translation
403 (defcustom org-export-with-footnotes t
404 "If nil, export [1] as a footnote marker.
405 Lines starting with [1] will be formatted as footnotes.
407 This option can also be set with the +OPTIONS line, e.g. \"f:nil\"."
408 :group
'org-export-translation
411 (defcustom org-export-with-sub-superscripts t
412 "Non-nil means, interpret \"_\" and \"^\" for export.
413 When this option is turned on, you can use TeX-like syntax for sub- and
414 superscripts. Several characters after \"_\" or \"^\" will be
415 considered as a single item - so grouping with {} is normally not
416 needed. For example, the following things will be parsed as single
417 sub- or superscripts.
419 10^24 or 10^tau several digits will be considered 1 item.
420 10^-12 or 10^-tau a leading sign with digits or a word
421 x^2-y^3 will be read as x^2 - y^3, because items are
422 terminated by almost any nonword/nondigit char.
423 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
425 Still, ambiguity is possible - so when in doubt use {} to enclose the
426 sub/superscript. If you set this variable to the symbol `{}',
427 the braces are *required* in order to trigger interpretations as
428 sub/superscript. This can be helpful in documents that need \"_\"
429 frequently in plain text.
431 Not all export backends support this, but HTML does.
433 This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
434 :group
'org-export-translation
436 (const :tag
"Always interpret" t
)
437 (const :tag
"Only with braces" {})
438 (const :tag
"Never interpret" nil
)))
440 (defcustom org-export-with-TeX-macros t
441 "Non-nil means, interpret simple TeX-like macros when exporting.
442 For example, HTML export converts \\alpha to α and \\AA to Å.
443 Not only real TeX macros will work here, but the standard HTML entities
444 for math can be used as macro names as well. For a list of supported
445 names in HTML export, see the constant `org-html-entities'.
446 Not all export backends support this.
448 This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
449 :group
'org-export-translation
450 :group
'org-export-latex
453 (defcustom org-export-with-LaTeX-fragments nil
454 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
455 When set, the exporter will find LaTeX environments if the \\begin line is
456 the first non-white thing on a line. It will also find the math delimiters
457 like $a=b$ and \\( a=b \\) for inline math, $$a=b$$ and \\[ a=b \\] for
460 This option can also be set with the +OPTIONS line, e.g. \"LaTeX:t\".
462 The default is nil, because this option needs the `dvipng' program which
463 is not available on all systems."
464 :group
'org-export-translation
465 :group
'org-export-latex
468 (defcustom org-export-with-fixed-width t
469 "Non-nil means, lines starting with \":\" will be in fixed width font.
470 This can be used to have pre-formatted text, fragments of code etc. For
472 : ;; Some Lisp examples
475 will be looking just like this in also HTML. See also the QUOTE keyword.
476 Not all export backends support this.
478 This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
479 :group
'org-export-translation
482 (defcustom org-match-sexp-depth
3
483 "Number of stacked braces for sub/superscript matching.
484 This has to be set before loading org.el to be effective."
485 :group
'org-export-translation
488 (defgroup org-export-tables nil
489 "Options for exporting tables in Org-mode."
490 :tag
"Org Export Tables"
493 (defcustom org-export-with-tables t
494 "If non-nil, lines starting with \"|\" define a table.
497 | Name | Address | Birthday |
498 |-------------+----------+-----------|
499 | Arthur Dent | England | 29.2.2100 |
501 Not all export backends support this.
503 This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
504 :group
'org-export-tables
507 (defcustom org-export-highlight-first-table-line t
508 "Non-nil means, highlight the first table line.
509 In HTML export, this means use <th> instead of <td>.
510 In tables created with table.el, this applies to the first table line.
511 In Org-mode tables, all lines before the first horizontal separator
512 line will be formatted with <th> tags."
513 :group
'org-export-tables
516 (defcustom org-export-table-remove-special-lines t
517 "Remove special lines and marking characters in calculating tables.
518 This removes the special marking character column from tables that are set
519 up for spreadsheet calculations. It also removes the entire lines
520 marked with `!', `_', or `^'. The lines with `$' are kept, because
521 the values of constants may be useful to have."
522 :group
'org-export-tables
525 (defcustom org-export-prefer-native-exporter-for-tables nil
526 "Non-nil means, always export tables created with table.el natively.
527 Natively means, use the HTML code generator in table.el.
528 When nil, Org-mode's own HTML generator is used when possible (i.e. if
529 the table does not use row- or column-spanning). This has the
530 advantage, that the automatic HTML conversions for math symbols and
531 sub/superscripts can be applied. Org-mode's HTML generator is also
533 :group
'org-export-tables
537 (defgroup org-export-xml nil
538 "Options specific for XML export of Org-mode files."
539 :tag
"Org Export XML"
544 ;;; Variables, constants, and parameter plists
546 (defconst org-level-max
20)
548 (defvar org-current-export-file nil
) ; dynamically scoped parameter
549 (defvar org-current-export-dir nil
) ; dynamically scoped parameter
550 (defvar org-export-opt-plist nil
551 "Contains the current option plist.")
552 (defvar org-last-level nil
) ; dynamically scoped variable
553 (defvar org-min-level nil
) ; dynamically scoped variable
554 (defvar org-levels-open nil
) ; dynamically scoped parameter
556 (defconst org-export-plist-vars
557 '((:link-up nil org-export-html-link-up
)
558 (:link-home nil org-export-html-link-home
)
559 (:language nil org-export-default-language
)
560 (:keywords nil org-export-page-keywords
)
561 (:description nil org-export-page-description
)
562 (:customtime nil org-display-custom-times
)
563 (:headline-levels
"H" org-export-headline-levels
)
564 (:section-numbers
"num" org-export-with-section-numbers
)
565 (:section-number-format nil org-export-section-number-format
)
566 (:table-of-contents
"toc" org-export-with-toc
)
567 (:preserve-breaks
"\\n" org-export-preserve-breaks
)
568 (:archived-trees nil org-export-with-archived-trees
)
569 (:emphasize
"*" org-export-with-emphasize
)
570 (:sub-superscript
"^" org-export-with-sub-superscripts
)
571 (:special-strings
"-" org-export-with-special-strings
)
572 (:footnotes
"f" org-export-with-footnotes
)
573 (:drawers
"d" org-export-with-drawers
)
574 (:tags
"tags" org-export-with-tags
)
575 (:todo-keywords
"todo" org-export-with-todo-keywords
)
576 (:priority
"pri" org-export-with-priority
)
577 (:TeX-macros
"TeX" org-export-with-TeX-macros
)
578 (:LaTeX-fragments
"LaTeX" org-export-with-LaTeX-fragments
)
579 (:latex-listings nil org-export-latex-listings
)
580 (:skip-before-1st-heading
"skip" org-export-skip-text-before-1st-heading
)
581 (:fixed-width
":" org-export-with-fixed-width
)
582 (:timestamps
"<" org-export-with-timestamps
)
583 (:author-info
"author" org-export-author-info
)
584 (:creator-info
"creator" org-export-creator-info
)
585 (:time-stamp-file
"timestamp" org-export-time-stamp-file
)
586 (:tables
"|" org-export-with-tables
)
587 (:table-auto-headline nil org-export-highlight-first-table-line
)
588 (:style-include-default nil org-export-html-style-include-default
)
589 (:style-include-scripts nil org-export-html-style-include-scripts
)
590 (:style nil org-export-html-style
)
591 (:style-extra nil org-export-html-style-extra
)
592 (:agenda-style nil org-agenda-export-html-style
)
593 (:convert-org-links nil org-export-html-link-org-files-as-html
)
594 (:inline-images nil org-export-html-inline-images
)
595 (:html-extension nil org-export-html-extension
)
596 (:xml-declaration nil org-export-html-xml-declaration
)
597 (:html-table-tag nil org-export-html-table-tag
)
598 (:expand-quoted-html
"@" org-export-html-expand
)
599 (:timestamp nil org-export-html-with-timestamp
)
600 (:publishing-directory nil org-export-publishing-directory
)
601 (:preamble nil org-export-html-preamble
)
602 (:postamble nil org-export-html-postamble
)
603 (:auto-preamble nil org-export-html-auto-preamble
)
604 (:auto-postamble nil org-export-html-auto-postamble
)
605 (:author nil user-full-name
)
606 (:email nil user-mail-address
)
607 (:select-tags nil org-export-select-tags
)
608 (:exclude-tags nil org-export-exclude-tags
)
610 (:latex-image-options nil org-export-latex-image-default-option
))
611 "List of properties that represent export/publishing variables.
612 Each element is a list of 3 items:
613 1. The property that is used internally, and also for org-publish-project-alist
614 2. The string that can be used in the OPTION lines to set this option,
615 or nil if this option cannot be changed in this way
616 3. The customization variable that sets the default for this option."
619 (defun org-default-export-plist ()
620 "Return the property list with default settings for the export variables."
621 (let* ((infile (org-infile-export-plist))
622 (letbind (plist-get infile
:let-bind
))
623 (l org-export-plist-vars
) rtn e s v
)
624 (while (setq e
(pop l
))
627 ((assq s letbind
) (nth 1 (assq s letbind
)))
628 ((boundp s
) (symbol-value s
))
630 rtn
(cons (car e
) (cons v rtn
))))
633 (defvar org-export-inbuffer-options-extra nil
634 "List of additional in-buffer options that should be detected.
635 Just before export, the buffer is scanned for options like #+TITLE, #+EMAIL,
636 etc. Extensions can add to this list to get their options detected, and they
637 can then add a function to `org-export-options-filters' to process these
639 Each element in this list must be a list, with the in-buffer keyword as car,
640 and a property (a symbol) as the next element. All occurrences of the
641 keyword will be found, the values concatenated with a space character
642 in between, and the result stored in the export options property list.")
644 (defvar org-export-options-filters nil
645 "Functions to be called to finalize the export/publishing options.
646 All these options are stored in a property list, and each of the functions
647 in this hook gets a chance to modify this property list. Each function
648 must accept the property list as an argument, and must return the (possibly
651 ;; FIXME: should we fold case here?
652 (defun org-infile-export-plist ()
653 "Return the property list with file-local settings for export."
657 (goto-char (point-min))
658 (let ((re (org-make-options-regexp
660 '("TITLE" "AUTHOR" "DATE" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"
661 "LINK_UP" "LINK_HOME" "SETUPFILE" "STYLE"
662 "LATEX_HEADER" "LATEX_CLASS"
663 "EXPORT_SELECT_TAGS" "EXPORT_EXCLUDE_TAGS"
664 "KEYWORDS" "DESCRIPTION" "MACRO" "BIND")
665 (mapcar 'car org-export-inbuffer-options-extra
))))
666 p key val text options a pr style
667 latex-header latex-class macros letbind
668 ext-setup-or-nil setup-contents
(start 0))
669 (while (or (and ext-setup-or-nil
670 (string-match re ext-setup-or-nil start
)
671 (setq start
(match-end 0)))
672 (and (setq ext-setup-or-nil nil start
0)
673 (re-search-forward re nil t
)))
674 (setq key
(upcase (org-match-string-no-properties 1 ext-setup-or-nil
))
675 val
(org-match-string-no-properties 2 ext-setup-or-nil
))
677 ((setq a
(assoc key org-export-inbuffer-options-extra
))
679 (setq p
(plist-put p pr
(concat (plist-get p pr
) " " val
))))
680 ((string-equal key
"TITLE") (setq p
(plist-put p
:title val
)))
681 ((string-equal key
"AUTHOR")(setq p
(plist-put p
:author val
)))
682 ((string-equal key
"EMAIL") (setq p
(plist-put p
:email val
)))
683 ((string-equal key
"DATE") (setq p
(plist-put p
:date val
)))
684 ((string-equal key
"KEYWORDS") (setq p
(plist-put p
:keywords val
)))
685 ((string-equal key
"DESCRIPTION")
686 (setq p
(plist-put p
:description val
)))
687 ((string-equal key
"LANGUAGE") (setq p
(plist-put p
:language val
)))
688 ((string-equal key
"STYLE")
689 (setq style
(concat style
"\n" val
)))
690 ((string-equal key
"LATEX_HEADER")
691 (setq latex-header
(concat latex-header
"\n" val
)))
692 ((string-equal key
"LATEX_CLASS")
693 (setq latex-class val
))
694 ((string-equal key
"TEXT")
695 (setq text
(if text
(concat text
"\n" val
) val
)))
696 ((string-equal key
"OPTIONS")
697 (setq options
(concat val
" " options
)))
698 ((string-equal key
"BIND")
699 (push (read (concat "(" val
")")) letbind
))
700 ((string-equal key
"LINK_UP")
701 (setq p
(plist-put p
:link-up val
)))
702 ((string-equal key
"LINK_HOME")
703 (setq p
(plist-put p
:link-home val
)))
704 ((string-equal key
"EXPORT_SELECT_TAGS")
705 (setq p
(plist-put p
:select-tags
(org-split-string val
))))
706 ((string-equal key
"EXPORT_EXCLUDE_TAGS")
707 (setq p
(plist-put p
:exclude-tags
(org-split-string val
))))
708 ((string-equal key
"MACRO")
710 ((equal key
"SETUPFILE")
711 (setq setup-contents
(org-file-contents
713 (org-remove-double-quotes
716 (if (not ext-setup-or-nil
)
717 (setq ext-setup-or-nil setup-contents start
0)
718 (setq ext-setup-or-nil
719 (concat (substring ext-setup-or-nil
0 start
)
720 "\n" setup-contents
"\n"
721 (substring ext-setup-or-nil start
)))))))
722 (setq p
(plist-put p
:text text
))
723 (when (and letbind
(org-export-confirm-letbind))
724 (setq p
(plist-put p
:let-bind letbind
)))
725 (when style
(setq p
(plist-put p
:style-extra style
)))
727 (setq p
(plist-put p
:latex-header-extra
(substring latex-header
1))))
729 (setq p
(plist-put p
:latex-class latex-class
)))
731 (setq p
(org-export-add-options-to-plist p options
)))
732 ;; Add macro definitions
733 (setq p
(plist-put p
:macro-date
"(eval (format-time-string \"$1\"))"))
734 (setq p
(plist-put p
:macro-time
"(eval (format-time-string \"$1\"))"))
736 p
:macro-modification-time
737 (and (buffer-file-name)
738 (file-exists-p (buffer-file-name))
740 "(eval (format-time-string \"$1\" '"
741 (prin1-to-string (nth 5 (file-attributes
742 (buffer-file-name))))
744 (setq p
(plist-put p
:macro-input-file
(and (buffer-file-name)
745 (file-name-nondirectory
746 (buffer-file-name)))))
747 (while (setq val
(pop macros
))
748 (when (string-match "^\\([-a-zA-Z0-9_]+\\)[ \t]+\\(.*?[ \t]*$\\)" val
)
751 (concat ":macro-" (downcase (match-string 1 val
))))
752 (org-export-interpolate-newlines (match-string 2 val
))))))
755 (defun org-export-interpolate-newlines (s)
756 (while (string-match "\\\\n" s
)
757 (setq s
(replace-match "\n" t t s
)))
760 (defvar org-export-allow-BIND-local nil
)
761 (defun org-export-confirm-letbind ()
762 "Can we use #+BIND values during export?
763 By default this will ask fro confirmation by the user, to divert possible
766 ((not org-export-allow-BIND
) nil
)
767 ((eq org-export-allow-BIND t
) t
)
768 ((local-variable-p 'org-export-allow-BIND-local
(current-buffer))
769 org-export-allow-BIND-local
)
770 (t (org-set-local 'org-export-allow-BIND-local
771 (yes-or-no-p "Allow BIND values in this buffer? ")))))
773 (defun org-install-letbind ()
774 "Install the values from #+BIND lines as local variables."
775 (let ((letbind (plist-get org-export-opt-plist
:let-bind
)))
777 (org-set-local (caar letbind
) (nth 1 (pop letbind
))))))
779 (defun org-export-add-options-to-plist (p options
)
780 "Parse an OPTIONS line and set values in the property list P."
783 (let ((op org-export-plist-vars
))
784 (while (setq o
(pop op
))
786 (string-match (concat (regexp-quote (nth 1 o
))
787 ":\\([^ \t\n\r;,.]*\\)")
789 (setq p
(plist-put p
(car o
)
790 (car (read-from-string
791 (match-string 1 options
))))))))))
794 (defun org-export-add-subtree-options (p pos
)
795 "Add options in subtree at position POS to property list P."
798 (when (org-at-heading-p)
800 ;; This is actually read in `org-export-get-title-from-subtree'
801 ;; (when (setq a (org-entry-get pos "EXPORT_TITLE"))
802 ;; (setq p (plist-put p :title a)))
803 (when (setq a
(org-entry-get pos
"EXPORT_TEXT"))
804 (setq p
(plist-put p
:text a
)))
805 (when (setq a
(org-entry-get pos
"EXPORT_AUTHOR"))
806 (setq p
(plist-put p
:author a
)))
807 (when (setq a
(org-entry-get pos
"EXPORT_DATE"))
808 (setq p
(plist-put p
:date a
)))
809 (when (setq a
(org-entry-get pos
"EXPORT_OPTIONS"))
810 (setq p
(org-export-add-options-to-plist p a
)))))
813 (defun org-export-directory (type plist
)
814 (let* ((val (plist-get plist
:publishing-directory
))
816 (or (cdr (assoc type val
)) ".")
820 (defun org-export-process-option-filters (plist)
821 (let ((functions org-export-options-filters
) f
)
822 (while (setq f
(pop functions
))
823 (setq plist
(funcall f plist
))))
827 (defun org-export (&optional arg
)
828 "Export dispatcher for Org-mode.
829 When `org-export-run-in-background' is non-nil, try to run the command
830 in the background. This will be done only for commands that write
831 to a file. For details see the docstring of `org-export-run-in-background'.
833 The prefix argument ARG will be passed to the exporter. However, if
834 ARG is a double universal prefix `C-u C-u', that means to inverse the
835 value of `org-export-run-in-background'."
837 (let* ((bg (org-xor (equal arg
'(16)) org-export-run-in-background
))
838 (help "[t] insert the export option template
839 \[v] limit export to visible part of outline tree
841 \[a] export as ASCII [A] to temporary buffer
843 \[h] export as HTML [H] to temporary buffer [R] export region
844 \[b] export as HTML and open in browser
846 \[l] export as LaTeX [L] to temporary buffer
847 \[p] export as LaTeX and process to PDF
848 \[d] export as LaTeX, process to PDF, and open the resulting PDF document
850 \[D] export as DocBook
851 \[V] export as DocBook, process to PDF, and open the resulting PDF document
853 \[m] export as Freemind mind map
856 \[g] export using Wes Hardaker's generic exporter
858 \[i] export current file as iCalendar file
859 \[I] export all agenda files as iCalendar files
860 \[c] export agenda files into combined iCalendar file
862 \[F] publish current file [P] publish current project
863 \[X] publish a project... [E] publish every projects")
865 '((?t org-insert-export-options-template nil
)
866 (?v org-export-visible nil
)
867 (?a org-export-as-ascii t
)
868 (?A org-export-as-ascii-to-buffer t
)
869 (?h org-export-as-html t
)
870 (?b org-export-as-html-and-open t
)
871 (?H org-export-as-html-to-buffer nil
)
872 (?R org-export-region-as-html nil
)
873 (?x org-export-as-xoxo t
)
874 (?g org-export-generic t
)
875 (?D org-export-as-docbook t
)
876 (?V org-export-as-docbook-pdf-and-open t
)
877 (?m org-export-as-freemind t
)
878 (?l org-export-as-latex t
)
879 (?p org-export-as-pdf t
)
880 (?d org-export-as-pdf-and-open t
)
881 (?L org-export-as-latex-to-buffer nil
)
882 (?i org-export-icalendar-this-file t
)
883 (?I org-export-icalendar-all-agenda-files t
)
884 (?c org-export-icalendar-combine-agenda-files t
)
885 (?F org-publish-current-file t
)
886 (?P org-publish-current-project t
)
888 (?E org-publish-all t
)))
891 (save-window-excursion
892 (delete-other-windows)
893 (with-output-to-temp-buffer "*Org Export/Publishing Help*"
895 (org-fit-window-to-buffer (get-buffer-window
896 "*Org Export/Publishing Help*"))
897 (message "Select command: ")
898 (setq r1
(read-char-exclusive))))
899 (setq r2
(if (< r1
27) (+ r1
96) r1
))
900 (unless (setq ass
(assq r2 cmds
))
901 (error "No command associated with key %c" r1
))
902 (if (and bg
(nth 2 ass
)
903 (not (buffer-base-buffer))
904 (not (org-region-active-p)))
905 ;; execute in background
906 (let ((p (start-process
907 (concat "Exporting " (file-name-nondirectory (buffer-file-name)))
909 (expand-file-name invocation-name invocation-directory
)
912 "--eval" "(require 'org-exp)"
913 "--eval" "(setq org-wait .2)"
915 "-f" (symbol-name (nth 1 ass
)))))
916 (set-process-sentinel p
'org-export-process-sentinel
)
917 (message "Background process \"%s\": started" p
))
918 ;; background processing not requested, or not possible
919 (call-interactively (nth 1 ass
)))))
921 (defun org-export-process-sentinel (process status
)
922 (if (string-match "\n+\\'" status
)
923 (setq status
(substring status
0 -
1)))
924 (message "Background process \"%s\": %s" process status
))
926 (defconst org-html-entities
968 ("Aring") ("AA".
"Å")
1057 ("varepsilon".
"ε")
1070 ("sigmaf") ("varsigma".
"ς")
1078 ("thetasym") ("vartheta".
"ϑ")
1081 ("bull") ("bullet".
"•")
1082 ("hellip") ("dots".
"…")
1092 ("larr") ("leftarrow".
"←") ("gets".
"←")
1093 ("uarr") ("uparrow".
"↑")
1094 ("rarr") ("to".
"→") ("rightarrow".
"→")
1095 ("darr")("downarrow".
"↓")
1096 ("harr") ("leftrightarrow".
"↔")
1097 ("crarr") ("hookleftarrow".
"↵") ; has round hook, not quite CR
1098 ("lArr") ("Leftarrow".
"⇐")
1099 ("uArr") ("Uparrow".
"⇑")
1100 ("rArr") ("Rightarrow".
"⇒")
1101 ("dArr") ("Downarrow".
"⇓")
1102 ("hArr") ("Leftrightarrow".
"⇔")
1104 ("part") ("partial".
"∂")
1105 ("exist") ("exists".
"∃")
1106 ("empty") ("emptyset".
"∅")
1108 ("isin") ("in".
"∈")
1114 ("lowast") ("ast".
"∗")
1116 ("prop") ("proptp".
"∝")
1117 ("infin") ("infty".
"∞")
1118 ("ang") ("angle".
"∠")
1119 ("and") ("wedge".
"∧")
1120 ("or") ("vee".
"∨")
1126 ("cong") ("simeq".
"≅")
1127 ("asymp")("approx".
"≈")
1128 ("ne") ("neq".
"≠")
1132 ("sub") ("subset".
"⊂")
1133 ("sup") ("supset".
"⊃")
1140 ("sdot") ("cdot".
"⋅")
1147 ("loz") ("Diamond".
"◊")
1148 ("spades") ("spadesuit".
"♠")
1149 ("clubs") ("clubsuit".
"♣")
1150 ("hearts") ("diamondsuit".
"♥")
1151 ("diams") ("diamondsuit".
"♦")
1152 ("smile".
"☺") ("blacksmile".
"☻") ("sad".
"☹")
1219 "Entities for TeX->HTML translation.
1220 Entries can be like (\"ent\"), in which case \"\\ent\" will be translated to
1221 \"&ent;\". An entry can also be a dotted pair like (\"ent\".\"&other;\").
1222 In that case, \"\\ent\" will be translated to \"&other;\".
1223 The list contains HTML entities for Latin-1, Greek and other symbols.
1224 It is supplemented by a number of commonly used TeX macros with appropriate
1225 translations. There is currently no way for users to extend this.")
1227 ;;; General functions for all backends
1229 (defvar org-export-target-aliases nil
1230 "Alist of targets with invisible aliases.")
1231 (defvar org-export-preferred-target-alist nil
1232 "Alist of section id's with preferred aliases.")
1233 (defvar org-export-code-refs nil
1234 "Alist of code references and line numbers")
1236 (defun org-export-preprocess-string (string &rest parameters
)
1237 "Cleanup STRING so that that the true exported has a more consistent source.
1238 This function takes STRING, which should be a buffer-string of an org-file
1239 to export. It then creates a temporary buffer where it does its job.
1240 The result is then again returned as a string, and the exporter works
1241 on this string to produce the exported version."
1243 (let* ((htmlp (plist-get parameters
:for-html
))
1244 (asciip (plist-get parameters
:for-ascii
))
1245 (latexp (plist-get parameters
:for-LaTeX
))
1246 (docbookp (plist-get parameters
:for-docbook
))
1247 (backend (cond (htmlp 'html
)
1250 (docbookp 'docbook
)))
1251 (archived-trees (plist-get parameters
:archived-trees
))
1252 (inhibit-read-only t
)
1253 (drawers org-drawers
)
1254 (outline-regexp "\\*+ ")
1257 (setq org-export-target-aliases nil
)
1258 (setq org-export-preferred-target-alist nil
)
1259 (setq org-export-code-refs nil
)
1261 (with-current-buffer (get-buffer-create " org-mode-tmp")
1264 (setq case-fold-search t
)
1266 ;; Remove license-to-kill stuff
1267 ;; The caller marks some stuff for killing, stuff that has been
1268 ;; used to create the page title, for example.
1269 (org-export-kill-licensed-text)
1271 (let ((org-inhibit-startup t
)) (org-mode))
1272 (setq case-fold-search t
)
1273 (org-install-letbind)
1276 (run-hooks 'org-export-preprocess-hook
)
1278 ;; Process the macros
1279 (org-export-preprocess-apply-macros)
1280 (run-hooks 'org-export-preprocess-after-macros-hook
)
1282 (untabify (point-min) (point-max))
1284 ;; Handle include files, and call a hook
1285 (org-export-handle-include-files)
1286 (run-hooks 'org-export-preprocess-after-include-files-hook
)
1288 ;; Get rid of archived trees
1289 (org-export-remove-archived-trees archived-trees
)
1291 ;; Remove comment environment and comment subtrees
1292 (org-export-remove-comment-blocks-and-subtrees)
1294 ;; Get rid of excluded trees, and call a hook
1295 (org-export-handle-export-tags (plist-get parameters
:select-tags
)
1296 (plist-get parameters
:exclude-tags
))
1297 (run-hooks 'org-export-preprocess-after-tree-selection-hook
)
1299 ;; Handle source code snippets
1300 (org-export-replace-src-segments-and-examples backend
)
1302 ;; Protect short examples marked by a leading colon
1303 (org-export-protect-colon-examples)
1305 ;; Normalize footnotes
1306 (when (plist-get parameters
:footnotes
)
1307 (org-footnote-normalize nil t
))
1309 ;; Find all headings and compute the targets for them
1310 (setq target-alist
(org-export-define-heading-targets target-alist
))
1312 ;; Get rid of drawers
1313 (org-export-remove-or-extract-drawers drawers
1314 (plist-get parameters
:drawers
))
1316 ;; Get the correct stuff before the first headline
1317 (when (plist-get parameters
:skip-before-1st-heading
)
1318 (goto-char (point-min))
1319 (when (re-search-forward "^\\(#.*\n\\)?\\*+[ \t]" nil t
)
1320 (delete-region (point-min) (match-beginning 0))
1321 (goto-char (point-min))
1323 (when (plist-get parameters
:add-text
)
1324 (goto-char (point-min))
1325 (insert (plist-get parameters
:add-text
) "\n"))
1327 ;; Remove todo-keywords before exporting, if the user has requested so
1328 (org-export-remove-headline-metadata parameters
)
1330 ;; Find targets in comments and move them out of comments,
1331 ;; but mark them as targets that should be invisible
1332 (setq target-alist
(org-export-handle-invisible-targets target-alist
))
1334 ;; Select and protect backend specific stuff, throw away stuff
1335 ;; that is specific for other backends
1336 (org-export-select-backend-specific-text backend
)
1338 ;; Protect quoted subtrees
1339 (org-export-protect-quoted-subtrees)
1341 ;; Remove clock lines
1342 (org-export-remove-clock-lines)
1344 ;; Protect verbatim elements
1345 (org-export-protect-verbatim)
1347 ;; Blockquotes, verse, and center
1348 (org-export-mark-blockquote-verse-center)
1349 (run-hooks 'org-export-preprocess-after-blockquote-hook
)
1351 ;; Remove timestamps, if the user has requested so
1352 (unless (plist-get parameters
:timestamps
)
1353 (org-export-remove-timestamps))
1355 ;; Attach captions to the correct object
1356 (setq target-alist
(org-export-attach-captions-and-attributes
1357 backend target-alist
))
1359 ;; Find matches for radio targets and turn them into internal links
1360 (org-export-mark-radio-links)
1362 ;; Find all links that contain a newline and put them into a single line
1363 (org-export-concatenate-multiline-links)
1365 ;; Normalize links: Convert angle and plain links into bracket links
1366 ;; and expand link abbreviations
1367 (org-export-normalize-links)
1369 ;; Find all internal links. If they have a fuzzy match (i.e. not
1370 ;; a *dedicated* target match, let the link point to the
1371 ;; corresponding section.
1372 (org-export-target-internal-links target-alist
)
1374 ;; Find multiline emphasis and put them into single line
1375 (when (plist-get parameters
:emph-multiline
)
1376 (org-export-concatenate-multiline-emphasis))
1378 ;; Remove special table lines
1379 (when org-export-table-remove-special-lines
1380 (org-export-remove-special-table-lines))
1383 (run-hooks 'org-export-preprocess-before-backend-specifics-hook
)
1385 ;; LaTeX-specific preprocessing
1387 (require 'org-latex nil
)
1388 (org-export-latex-preprocess parameters
))
1390 ;; ASCII-specific preprocessing
1392 (org-export-ascii-preprocess parameters
))
1394 ;; HTML-specific preprocessing
1396 (org-export-html-preprocess parameters
))
1398 ;; DocBook-specific preprocessing
1400 (require 'org-docbook nil
)
1401 (org-export-docbook-preprocess parameters
))
1403 ;; Remove or replace comments
1404 (org-export-handle-comments (plist-get parameters
:comments
))
1406 ;; Run the final hook
1407 (run-hooks 'org-export-preprocess-final-hook
)
1409 (setq rtn
(buffer-string)))
1410 (kill-buffer " org-mode-tmp")
1413 (defun org-export-kill-licensed-text ()
1414 "Remove all text that is marked with a :org-license-to-kill property."
1416 (while (setq p
(text-property-any (point-min) (point-max)
1417 :org-license-to-kill t
))
1419 p
(or (next-single-property-change p
:org-license-to-kill
)
1422 (defun org-export-define-heading-targets (target-alist)
1423 "Find all headings and define the targets for them.
1424 The new targets are added to TARGET-ALIST, which is also returned."
1425 (goto-char (point-min))
1426 (org-init-section-numbers)
1427 (let ((re (concat "^" org-outline-regexp
1428 "\\| [ \t]*:\\(ID\\|CUSTOM_ID\\):[ \t]*\\([^ \t\r\n]+\\)"))
1429 level target last-section-target a id
)
1430 (while (re-search-forward re nil t
)
1433 (setq id
(org-match-string-no-properties 2))
1434 (push (cons id target
) target-alist
)
1435 (setq a
(or (assoc last-section-target org-export-target-aliases
)
1437 (push (list last-section-target
)
1438 org-export-target-aliases
)
1439 (car org-export-target-aliases
))))
1440 (push (caar target-alist
) (cdr a
))
1441 (when (equal (match-string 1) "CUSTOM_ID")
1442 (if (not (assoc last-section-target
1443 org-export-preferred-target-alist
))
1444 (push (cons last-section-target id
)
1445 org-export-preferred-target-alist
))))
1446 (setq level
(org-reduced-level
1447 (save-excursion (goto-char (point-at-bol))
1448 (org-outline-level))))
1449 (setq target
(org-solidify-link-text
1450 (format "sec-%s" (org-section-number level
))))
1451 (setq last-section-target target
)
1452 (push (cons target target
) target-alist
)
1453 (add-text-properties
1454 (point-at-bol) (point-at-eol)
1455 (list 'target target
)))))
1458 (defun org-export-handle-invisible-targets (target-alist)
1459 "Find targets in comments and move them out of comments.
1460 Mark them as invisible targets."
1462 (goto-char (point-min))
1463 (while (re-search-forward "^#.*?\\(<<<?\\([^>\r\n]+\\)>>>?\\).*" nil t
)
1464 ;; Check if the line before or after is a headline with a target
1465 (if (setq target
(or (get-text-property (point-at-bol 0) 'target
)
1466 (get-text-property (point-at-bol 2) 'target
)))
1468 ;; use the existing target in a neighboring line
1469 (setq tmp
(match-string 2))
1471 (and (looking-at "\n") (delete-char 1))
1472 (push (cons (setq tmp
(org-solidify-link-text tmp
)) target
)
1474 (setq a
(or (assoc target org-export-target-aliases
)
1476 (push (list target
) org-export-target-aliases
)
1477 (car org-export-target-aliases
))))
1479 ;; Make an invisible target
1480 (replace-match "\\1(INVISIBLE)"))))
1483 (defun org-export-target-internal-links (target-alist)
1484 "Find all internal links and assign targets to them.
1485 If a link has a fuzzy match (i.e. not a *dedicated* target match),
1486 let the link point to the corresponding section.
1487 This function also handles the id links, if they have a match in
1489 (goto-char (point-min))
1490 (while (re-search-forward org-bracket-link-regexp nil t
)
1492 (let* ((md (match-data))
1493 (desc (match-end 2))
1494 (link (org-link-unescape (match-string 1)))
1495 (slink (org-solidify-link-text link
))
1496 found props pos cref
1499 ((= (string-to-char link
) ?
#)
1500 ;; user wants exactly this link
1502 ((cdr (assoc slink target-alist
))
1503 (or (cdr (assoc (assoc slink target-alist
)
1504 org-export-preferred-target-alist
))
1505 (cdr (assoc slink target-alist
))))
1506 ((and (string-match "^id:" link
)
1507 (cdr (assoc (substring link
3) target-alist
))))
1508 ((string-match "^(\\(.*\\))$" link
)
1509 (setq cref
(match-string 1 link
))
1510 (concat "coderef:" cref
))
1511 ((string-match org-link-types-re link
) nil
)
1512 ((or (file-name-absolute-p link
)
1513 (string-match "^\\." link
))
1517 (setq found
(condition-case nil
(org-link-search link
)
1520 (or (org-on-heading-p)
1521 (not (eq found
'dedicated
))))
1522 (or (get-text-property (point) 'target
)
1525 (1- (or (previous-single-property-change
1526 (point) 'target
) 0)))
1530 (goto-char (match-beginning 1))
1531 (setq props
(text-properties-at (point)))
1532 (delete-region (match-beginning 1) (match-end 1))
1535 (unless desc
(insert "][" link
))
1536 (add-text-properties pos
(point) props
))))))
1538 (defun org-export-remove-or-extract-drawers (all-drawers exp-drawers
)
1539 "Remove drawers, or extract the content.
1540 ALL-DRAWERS is a list of all drawer names valid in the current buffer.
1541 EXP-DRAWERS can be t to keep all drawer contents, or a list of drawers
1542 whose content to keep."
1543 (unless (eq t exp-drawers
)
1544 (goto-char (point-min))
1545 (let ((re (concat "^[ \t]*:\\("
1548 (org-delete-all exp-drawers
1549 (copy-sequence all-drawers
))
1553 (while (re-search-forward re nil t
)
1555 (setq beg
(match-beginning 0)
1557 (if (re-search-forward "^\\([ \t]*:END:[ \t]*\n?\\)\\|^\\*+[ \t]"
1560 ;; terminated in this entry
1562 (delete-region beg
(match-end 1))
1564 (goto-char eol
))))))))
1566 (defun org-export-handle-export-tags (select-tags exclude-tags
)
1567 "Modify the buffer, honoring SELECT-TAGS and EXCLUDE-TAGS.
1568 Both arguments are lists of tags.
1569 If any of SELECT-TAGS is found, all trees not marked by a SELECT-TAG
1571 After that, all subtrees that are marked by EXCLUDE-TAGS will be
1573 (remove-text-properties (point-min) (point-max) '(:org-delete t
))
1574 (let* ((re-sel (concat ":\\(" (mapconcat 'regexp-quote
1577 (re-excl (concat ":\\(" (mapconcat 'regexp-quote
1581 (goto-char (point-min))
1582 (when (and select-tags
1584 (concat "^\\*+[ \t].*" re-sel
"[^ \t\n]*[ \t]*$") nil t
))
1585 ;; At least one tree is marked for export, this means
1586 ;; all the unmarked stuff needs to go.
1587 ;; Dig out the trees that should be exported
1588 (goto-char (point-min))
1589 (outline-next-heading)
1591 (put-text-property beg
(point-max) :org-delete t
)
1592 (while (re-search-forward re-sel nil t
)
1593 (when (org-on-heading-p)
1594 (org-back-to-heading)
1595 (remove-text-properties
1596 (max (1- (point)) (point-min))
1597 (setq cont
(save-excursion (org-end-of-subtree t t
)))
1599 (while (and (org-up-heading-safe)
1600 (get-text-property (point) :org-delete
))
1601 (remove-text-properties (max (1- (point)) (point-min))
1602 (point-at-eol) '(:org-delete t
)))
1604 ;; Remove the trees explicitly marked for noexport
1606 (goto-char (point-min))
1607 (while (re-search-forward re-excl nil t
)
1608 (when (org-at-heading-p)
1609 (org-back-to-heading t
)
1611 (org-end-of-subtree t t
)
1612 (delete-region beg
(point))
1613 (when (featurep 'org-inlinetask
)
1614 (org-inlinetask-remove-END-maybe)))))
1615 ;; Remove everything that is now still marked for deletion
1616 (goto-char (point-min))
1617 (while (setq beg
(text-property-any (point-min) (point-max) :org-delete t
))
1618 (setq end
(or (next-single-property-change beg
:org-delete
)
1620 (delete-region beg end
))))
1622 (defun org-export-remove-archived-trees (export-archived-trees)
1623 "Remove archived trees.
1624 When EXPORT-ARCHIVED-TREES is `headline;, only the headline will be exported.
1625 When it is t, the entire archived tree will be exported.
1626 When it is nil the entire tree including the headline will be removed
1628 (let ((re-archive (concat ":" org-archive-tag
":"))
1630 (when (not (eq export-archived-trees t
))
1631 (goto-char (point-min))
1632 (while (re-search-forward re-archive nil t
)
1633 (if (not (org-on-heading-p t
))
1634 (org-end-of-subtree t
)
1635 (beginning-of-line 1)
1636 (setq a
(if export-archived-trees
1637 (1+ (point-at-eol)) (point))
1638 b
(org-end-of-subtree t
))
1639 (if (> b a
) (delete-region a b
)))))))
1641 (defun org-export-remove-headline-metadata (opts)
1642 "Remove meta data from the headline, according to user options."
1643 (let ((re org-complex-heading-regexp
)
1644 (todo (plist-get opts
:todo-keywords
))
1645 (tags (plist-get opts
:tags
))
1646 (pri (plist-get opts
:priority
))
1649 (setq elts
(delq nil
(list 1 (if todo
2) (if pri
3) 4 (if tags
5))))
1650 (when (or (not todo
) (not tags
) (not pri
))
1651 (goto-char (point-min))
1652 (while (re-search-forward re nil t
)
1654 (setq rpl
(mapconcat (lambda (i) (if (match-end i
) (match-string i
) ""))
1656 (replace-match rpl t t
))))))
1658 (defun org-export-remove-timestamps ()
1659 "Remove timestamps and keywords for export."
1660 (goto-char (point-min))
1661 (while (re-search-forward org-maybe-keyword-time-regexp nil t
)
1664 (unless (save-match-data (org-at-table-p))
1666 (beginning-of-line 1)
1667 (if (looking-at "[- \t]*\\(=>[- \t0-9:]*\\)?[ \t]*\n")
1668 (replace-match ""))))))
1670 (defun org-export-remove-clock-lines ()
1671 "Remove clock lines for export."
1672 (goto-char (point-min))
1673 (let ((re (concat "^[ \t]*" org-clock-string
".*\n?")))
1674 (while (re-search-forward re nil t
)
1676 (replace-match "")))))
1678 (defun org-export-protect-quoted-subtrees ()
1679 "Mark quoted subtrees with the protection property."
1680 (let ((re-quote (concat "^\\*+[ \t]+" org-quote-string
"\\>")))
1681 (goto-char (point-min))
1682 (while (re-search-forward re-quote nil t
)
1683 (goto-char (match-beginning 0))
1685 (add-text-properties (point) (org-end-of-subtree t
)
1686 '(org-protected t
)))))
1688 (defun org-export-protect-verbatim ()
1689 "Mark verbatim snippets with the protection property."
1690 (goto-char (point-min))
1691 (while (re-search-forward org-verbatim-re nil t
)
1693 (add-text-properties (match-beginning 4) (match-end 4)
1694 '(org-protected t org-verbatim-emph t
))
1695 (goto-char (1+ (match-end 4))))))
1697 (defun org-export-protect-colon-examples ()
1698 "Protect lines starting with a colon."
1699 (goto-char (point-min))
1700 (let ((re "^[ \t]*:\\([ \t]\\|$\\)") beg
)
1701 (while (re-search-forward re nil t
)
1702 (beginning-of-line 1)
1704 (while (looking-at re
)
1706 (or (eobp) (forward-char 1)))
1707 (add-text-properties beg
(if (bolp) (1- (point)) (point))
1708 '(org-protected t
)))))
1710 (defun org-export-select-backend-specific-text (backend)
1712 '((docbook "DOCBOOK" "BEGIN_DOCBOOK" "END_DOCBOOK")
1713 (html "HTML" "BEGIN_HTML" "END_HTML")
1714 (ascii "ASCII" "BEGIN_ASCII" "END_ASCII")
1715 (latex "LaTeX" "BEGIN_LaTeX" "END_LaTeX")))
1716 (case-fold-search t
)
1717 fmt beg beg-content end end-content
)
1720 (setq fmt
(pop formatters
))
1721 (when (eq (car fmt
) backend
)
1722 ;; This is selected code, put it into the file for real
1723 (goto-char (point-min))
1724 (while (re-search-forward (concat "^\\([ \t]*\\)#\\+" (cadr fmt
)
1725 ":[ \t]*\\(.*\\)") nil t
)
1726 (replace-match "\\1\\2" t
)
1727 (add-text-properties
1728 (point-at-bol) (min (1+ (point-at-eol)) (point-max))
1729 '(org-protected t
))))
1730 (goto-char (point-min))
1731 (while (re-search-forward (concat "^[ \t]*#\\+" (caddr fmt
) "\\>.*\n?")
1733 (setq beg
(match-beginning 0) beg-content
(match-end 0))
1734 (when (re-search-forward (concat "^[ \t]*#\\+" (cadddr fmt
) "\\>.*\n?")
1736 (setq end
(match-end 0) end-content
(match-beginning 0))
1737 (if (eq (car fmt
) backend
)
1740 (add-text-properties beg-content end-content
'(org-protected t
))
1741 (delete-region (match-beginning 0) (match-end 0))
1744 (delete-region (point) (1+ (point-at-eol)))))
1745 ;; No, this is for a different backend, kill it
1746 (delete-region beg end
)))))))
1748 (defun org-export-mark-blockquote-verse-center ()
1749 "Mark block quote and verse environments with special cookies.
1750 These special cookies will later be interpreted by the backend."
1752 (let (type t1 ind beg end beg1 end1 content
)
1753 (goto-char (point-min))
1754 (while (re-search-forward
1755 "^\\([ \t]*\\)#\\+\\(begin_\\(\\(block\\)?quote\\|verse\\|center\\)\\>.*\\)"
1757 (setq ind
(length (match-string 1))
1758 type
(downcase (match-string 3))
1759 t1
(if (equal type
"quote") "blockquote" type
))
1760 (setq beg
(match-beginning 0)
1761 beg1
(1+ (match-end 0)))
1762 (when (re-search-forward (concat "^[ \t]*#\\+end_" type
"\\>.*") nil t
)
1763 (setq end
(1+ (point-at-eol))
1764 end1
(1- (match-beginning 0)))
1765 (setq content
(org-remove-indentation (buffer-substring beg1 end1
)))
1766 (setq content
(concat "ORG-" (upcase t1
) "-START\n"
1768 "ORG-" (upcase t1
) "-END\n"))
1769 (delete-region beg end
)
1770 (insert (org-add-props content nil
'original-indentation ind
))))))
1772 (defun org-export-attach-captions-and-attributes (backend target-alist
)
1773 "Move #+CAPTION, #+ATTR_BACKEND, and #+LABEL text into text properties.
1774 If the next thing following is a table, add the text properties to the first
1775 table line. If it is a link, add it to the line containing the link."
1776 (goto-char (point-min))
1777 (remove-text-properties (point-min) (point-max)
1778 '(org-caption nil org-attributes nil
))
1779 (let ((case-fold-search t
)
1780 (re (concat "^[ \t]*#\\+caption:[ \t]+\\(.*\\)"
1782 "^[ \t]*#\\+attr_" (symbol-name backend
) ":[ \t]+\\(.*\\)"
1784 "^[ \t]*#\\+label:[ \t]+\\(.*\\)"
1788 "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
1790 (while (re-search-forward re nil t
)
1793 (setq cap
(concat cap
(if cap
" " "") (org-trim (match-string 1)))))
1795 (setq attr
(concat attr
(if attr
" " "") (org-trim (match-string 2)))))
1797 (setq label
(org-trim (match-string 3))))
1799 (add-text-properties (point-at-bol) (point-at-eol)
1800 (list 'org-caption cap
1801 'org-attributes attr
1803 (if label
(push (cons label label
) target-alist
))
1804 (setq cap nil attr nil label nil
)))))
1807 (defun org-export-remove-comment-blocks-and-subtrees ()
1808 "Remove the comment environment, and also commented subtrees."
1809 (let ((re-commented (concat "^\\*+[ \t]+" org-comment-string
"\\>"))
1810 (case-fold-search nil
))
1811 ;; Remove comment environment
1812 (goto-char (point-min))
1813 (while (re-search-forward
1814 "^#\\+BEGIN_COMMENT[ \t]*\n[^\000]*?^#\\+END_COMMENT\\>.*" nil t
)
1815 (replace-match "" t t
))
1816 ;; Remove subtrees that are commented
1817 (goto-char (point-min))
1818 (while (re-search-forward re-commented nil t
)
1819 (goto-char (match-beginning 0))
1820 (delete-region (point) (org-end-of-subtree t
)))))
1822 (defun org-export-handle-comments (commentsp)
1823 "Remove comments, or convert to backend-specific format.
1824 COMMENTSP can be a format string for publishing comments.
1825 When it is nil, all comments will be removed."
1826 (let ((re "^\\(#\\|[ \t]*#\\+\\)\\(.*\n?\\)")
1828 (goto-char (point-min))
1829 (while (or (looking-at re
)
1830 (re-search-forward re nil t
))
1831 (setq pos
(match-beginning 0))
1833 (not (equal (char-before (match-end 1)) ?
+)))
1834 (progn (add-text-properties
1835 (match-beginning 0) (match-end 0) '(org-protected t
))
1836 (replace-match (format commentsp
(match-string 2)) t t
))
1837 (goto-char (1+ pos
))
1840 (goto-char (max (point-min) (1- pos
))))))))
1842 (defun org-export-mark-radio-links ()
1843 "Find all matches for radio targets and turn them into internal links."
1844 (let ((re-radio (and org-target-link-regexp
1845 (concat "\\([^<]\\)\\(" org-target-link-regexp
"\\)"))))
1846 (goto-char (point-min))
1848 (while (re-search-forward re-radio nil t
)
1851 (or (org-in-regexp org-bracket-link-regexp
)
1852 (org-in-regexp org-plain-link-re
)))
1854 (replace-match "\\1[[\\2]]")))))))
1856 (defun org-export-remove-special-table-lines ()
1857 "Remove tables lines that are used for internal purposes."
1858 (goto-char (point-min))
1859 (while (re-search-forward "^[ \t]*|" nil t
)
1860 (beginning-of-line 1)
1861 (if (or (looking-at "[ \t]*| *[!_^] *|")
1867 (or (= (length f
) 0)
1869 "\\`<\\([0-9]\\|[rl]\\|[rl][0-9]+\\)>\\'" f
)))
1870 (org-split-string ;; FIXME, can't we do this without splitting???
1871 (buffer-substring (point-at-bol) (point-at-eol))
1872 "[ \t]*|[ \t]*")))))
1873 (delete-region (max (point-min) (1- (point-at-bol)))
1877 (defun org-export-protect-sub-super (s)
1879 (while (string-match "\\([^\\\\]\\)\\([_^]\\)" s
)
1880 (setq s
(replace-match "\\1\\\\\\2" nil nil s
)))
1883 (defun org-export-normalize-links ()
1884 "Convert all links to bracket links, and expand link abbreviations."
1885 (let ((re-plain-link (concat "\\([^[<]\\)" org-plain-link-re
))
1886 (re-angle-link (concat "\\([^[]\\)" org-angle-link-re
))
1888 (goto-char (point-min))
1889 (while (re-search-forward re-plain-link nil t
)
1890 (goto-char (1- (match-end 0)))
1891 (org-if-unprotected-at (1+ (match-beginning 0))
1892 (let* ((s (concat (match-string 1)
1893 "[[" (match-string 2) ":" (match-string 3)
1894 "][" (match-string 2) ":" (org-export-protect-sub-super
1897 ;; added 'org-link face to links
1898 (put-text-property 0 (length s
) 'face
'org-link s
)
1899 (replace-match s t t
))))
1900 (goto-char (point-min))
1901 (while (re-search-forward re-angle-link nil t
)
1902 (goto-char (1- (match-end 0)))
1904 (let* ((s (concat (match-string 1)
1905 "[[" (match-string 2) ":" (match-string 3)
1906 "][" (match-string 2) ":" (org-export-protect-sub-super
1909 (put-text-property 0 (length s
) 'face
'org-link s
)
1910 (replace-match s t t
))))
1911 (goto-char (point-min))
1912 (while (re-search-forward org-bracket-link-regexp nil t
)
1913 (goto-char (1- (match-end 0)))
1914 (setq nodesc
(not (match-end 3)))
1916 (let* ((xx (save-match-data
1918 (org-link-expand-abbrev (match-string 1)))))
1920 "[[" (org-add-props (copy-sequence xx
)
1921 nil
'org-protected t
'org-no-description nodesc
)
1925 (concat "[" (copy-sequence xx
)
1928 (put-text-property 0 (length s
) 'face
'org-link s
)
1929 (replace-match s t t
))))))
1931 (defun org-export-concatenate-multiline-links ()
1932 "Find multi-line links and put it all into a single line.
1933 This is to make sure that the line-processing export backends
1934 can work correctly."
1935 (goto-char (point-min))
1936 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t
)
1938 (replace-match "\\1 \\3")
1939 (goto-char (match-beginning 0)))))
1941 (defun org-export-concatenate-multiline-emphasis ()
1942 "Find multi-line emphasis and put it all into a single line.
1943 This is to make sure that the line-processing export backends
1944 can work correctly."
1945 (goto-char (point-min))
1946 (while (re-search-forward org-emph-re nil t
)
1947 (if (and (not (= (char-after (match-beginning 3))
1948 (char-after (match-beginning 4))))
1949 (save-excursion (goto-char (match-beginning 0))
1950 (save-match-data (not (org-at-table-p)))))
1952 (subst-char-in-region (match-beginning 0) (match-end 0)
1954 (goto-char (1- (match-end 0))))
1955 (goto-char (1+ (match-beginning 0))))))
1957 (defun org-export-grab-title-from-buffer ()
1958 "Get a title for the current document, from looking at the buffer."
1959 (let ((inhibit-read-only t
))
1961 (goto-char (point-min))
1962 (let ((end (if (looking-at org-outline-regexp
)
1964 (save-excursion (outline-next-heading) (point)))))
1965 (when (re-search-forward "^[ \t]*[^|# \t\r\n].*\n" end t
)
1966 ;; Mark the line so that it will not be exported as normal text.
1968 (add-text-properties (match-beginning 0) (match-end 0)
1969 (list :org-license-to-kill t
)))
1970 ;; Return the title string
1971 (org-trim (match-string 0)))))))
1973 (defun org-export-get-title-from-subtree ()
1974 "Return subtree title and exclude it from export."
1975 (let (title (rbeg (region-beginning)) (rend (region-end)))
1978 (when (and (org-at-heading-p)
1979 (>= (org-end-of-subtree t t
) rend
))
1980 ;; This is a subtree, we take the title from the first heading
1982 (looking-at org-todo-line-regexp
)
1983 (setq title
(match-string 3))
1985 (add-text-properties (point) (1+ (point-at-eol))
1986 (list :org-license-to-kill t
)))
1987 (setq title
(or (org-entry-get nil
"EXPORT_TITLE") title
))))
1990 (defun org-solidify-link-text (s &optional alist
)
1991 "Take link text and make a safe target out of it."
1996 (org-split-string s
"[ \t\r\n]+") "=="))
1997 (a (assoc rtn alist
)))
2000 (defun org-get-min-level (lines &optional offset
)
2001 "Get the minimum level in LINES."
2002 (let ((re "^\\(\\*+\\) ") l
)
2004 (while (setq l
(pop lines
))
2005 (if (string-match re l
)
2006 (throw 'exit
(org-tr-level (- (length (match-string 1 l
))
2010 ;; Variable holding the vector with section numbers
2011 (defvar org-section-numbers
(make-vector org-level-max
0))
2013 (defun org-init-section-numbers ()
2014 "Initialize the vector for the section numbers."
2016 (numbers (nreverse (org-split-string "" "\\.")))
2017 (depth (1- (length org-section-numbers
)))
2018 (i depth
) number-string
)
2021 (aset org-section-numbers i
0)
2022 (setq number-string
(or (car numbers
) "0"))
2023 (if (string-match "\\`[A-Z]\\'" number-string
)
2024 (aset org-section-numbers i
2025 (- (string-to-char number-string
) ?A -
1))
2026 (aset org-section-numbers i
(string-to-number number-string
)))
2030 (defun org-section-number (&optional level
)
2031 "Return a string with the current section number.
2032 When LEVEL is non-nil, increase section numbers on that level."
2033 (let* ((depth (1- (length org-section-numbers
)))
2035 (fmts (car org-export-section-number-format
))
2036 (term (cdr org-export-section-number-format
))
2041 (aset org-section-numbers
2042 level
(1+ (aref org-section-numbers level
))))
2043 (setq idx
(1+ level
))
2044 (while (<= idx depth
)
2046 (aset org-section-numbers idx
0))
2047 (setq idx
(1+ idx
))))
2049 (while (<= idx depth
)
2050 (when (> (aref org-section-numbers idx
) 0)
2051 (setq fmt
(or (pop fmts
) fmt
)
2053 n
(aref org-section-numbers idx
)
2055 (concat string sep
(org-number-to-counter n ctype
))
2056 (concat string
".0"))
2058 (setq idx
(1+ idx
)))
2060 (if (string-match "\\`\\([@0]\\.\\)+" string
)
2061 (setq string
(replace-match "" t nil string
)))
2062 (if (string-match "\\(\\.0\\)+\\'" string
)
2063 (setq string
(replace-match "" t nil string
))))
2064 (concat string term
)))
2066 (defun org-number-to-counter (n type
)
2067 "Concert number N to a string counter, according to TYPE.
2068 TYPE must be a string, any of:
2072 I upper case roman numeral
2073 i lower case roman numeral"
2075 ((equal type
"1") (number-to-string n
))
2076 ((equal type
"A") (char-to-string (+ ?A n -
1)))
2077 ((equal type
"a") (char-to-string (+ ?a n -
1)))
2078 ((equal type
"I") (org-number-to-roman n
))
2079 ((equal type
"i") (downcase (org-number-to-roman n
)))
2080 (t (error "Invalid counter type `%s'" type
))))
2082 (defun org-number-to-roman (n)
2083 "Convert integer N into a roman numeral."
2084 (let ((roman '((1000 .
"M") (900 .
"CM") (500 .
"D") (400 .
"CD")
2085 ( 100 .
"C") ( 90 .
"XC") ( 50 .
"L") ( 40 .
"XL")
2086 ( 10 .
"X") ( 9 .
"IX") ( 5 .
"V") ( 4 .
"IV")
2090 (number-to-string n
)
2092 (if (>= n
(caar roman
))
2093 (setq n
(- n
(caar roman
))
2094 res
(concat res
(cdar roman
)))
2100 (defun org-export-preprocess-apply-macros ()
2101 "Replace macro references."
2102 (goto-char (point-min))
2103 (let (sy val key args args2 s n
)
2104 (while (re-search-forward
2105 "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}"
2107 (unless (save-match-data
2109 (goto-char (point-at-bol))
2110 (looking-at "[ \t]*#\\+macro")))
2111 (setq key
(downcase (match-string 1))
2112 args
(match-string 3))
2113 (when (setq val
(or (plist-get org-export-opt-plist
2114 (intern (concat ":macro-" key
)))
2115 (plist-get org-export-opt-plist
2116 (intern (concat ":" key
)))))
2119 (setq args
(org-split-string args
",[ \t\n]*") args2 nil
)
2120 (setq args
(mapcar 'org-trim args
))
2122 (while (string-match "\\\\\\'" (car args
))
2123 ;; repair bad splits
2124 (setcar (cdr args
) (concat (substring (car args
) 0 -
1)
2127 (push (pop args
) args2
))
2128 (setq args
(nreverse args2
))
2130 (while (string-match "\\$\\([0-9]+\\)" val s
)
2131 (setq s
(1+ (match-beginning 0))
2132 n
(string-to-number (match-string 1 val
)))
2133 (and (>= (length args
) n
)
2134 (setq val
(replace-match (nth (1- n
) args
) t t val
)))))
2135 (when (string-match "\\`(eval\\>" val
)
2136 (setq val
(eval (read val
))))
2137 (if (and val
(not (stringp val
)))
2138 (setq val
(format "%s" val
))))
2140 (prog1 (replace-match val t t
)
2141 (goto-char (match-beginning 0)))))))))
2143 (defun org-export-apply-macros-in-string (s)
2144 "Apply the macros in string S."
2148 (org-export-preprocess-apply-macros)
2153 (defun org-export-handle-include-files ()
2154 "Include the contents of include files, with proper formatting."
2155 (let ((case-fold-search t
)
2156 params file markup lang start end prefix prefix1 switches
)
2157 (goto-char (point-min))
2158 (while (re-search-forward "^#\\+INCLUDE:?[ \t]+\\(.*\\)" nil t
)
2159 (setq params
(read (concat "(" (match-string 1) ")"))
2160 prefix
(org-get-and-remove-property 'params
:prefix
)
2161 prefix1
(org-get-and-remove-property 'params
:prefix1
)
2162 file
(org-symname-or-string (pop params
))
2163 markup
(org-symname-or-string (pop params
))
2164 lang
(and (member markup
'("src" "SRC"))
2165 (org-symname-or-string (pop params
)))
2166 switches
(mapconcat '(lambda (x) (format "%s" x
)) params
" ")
2168 (delete-region (match-beginning 0) (match-end 0))
2170 (not (file-exists-p file
))
2171 (not (file-readable-p file
)))
2172 (insert (format "CANNOT INCLUDE FILE %s" file
))
2174 (if (equal (downcase markup
) "src")
2175 (setq start
(format "#+begin_src %s %s\n"
2176 (or lang
"fundamental")
2179 (setq start
(format "#+begin_%s %s\n" markup switches
)
2180 end
(format "#+end_%s" markup
))))
2181 (insert (or start
""))
2182 (insert (org-get-file-contents (expand-file-name file
)
2183 prefix prefix1 markup
))
2184 (or (bolp) (newline))
2185 (insert (or end
""))))))
2187 (defun org-get-file-contents (file &optional prefix prefix1 markup
)
2188 "Get the contents of FILE and return them as a string.
2189 If PREFIX is a string, prepend it to each line. If PREFIX1
2190 is a string, prepend it to the first line instead of PREFIX.
2191 If MARKUP, don't protect org-like lines, the exporter will
2192 take care of the block they are in."
2193 (if (stringp markup
) (setq markup
(downcase markup
)))
2195 (insert-file-contents file
)
2196 (when (or prefix prefix1
)
2197 (goto-char (point-min))
2199 (insert (or prefix1 prefix
))
2201 (beginning-of-line 2)))
2203 (when (member markup
'("src" "example"))
2204 (goto-char (point-min))
2205 (while (re-search-forward "^\\([*#]\\|[ \t]*#\\+\\)" nil t
)
2206 (goto-char (match-beginning 0))
2211 (defun org-get-and-remove-property (listvar prop
)
2212 "Check if the value of LISTVAR contains PROP as a property.
2213 If yes, return the value of that property (i.e. the element following
2214 in the list) and remove property and value from the list in LISTVAR."
2215 (let ((list (symbol-value listvar
)) m v
)
2216 (when (setq m
(member prop list
))
2218 (if (equal (car list
) prop
)
2219 (set listvar
(cddr list
))
2220 (setcdr (nthcdr (- (length list
) (length m
) 1) list
)
2222 (set listvar list
)))
2225 (defun org-symname-or-string (s)
2227 (if s
(symbol-name s
) s
)
2230 ;;; Fontification and line numbers for code examples
2232 (defvar org-export-last-code-line-counter-value
0)
2234 (defun org-export-replace-src-segments-and-examples (backend)
2235 "Replace source code segments with special code for export."
2236 (setq org-export-last-code-line-counter-value
0)
2237 (let ((case-fold-search t
)
2238 lang code trans opts indent
)
2239 (goto-char (point-min))
2240 (while (re-search-forward
2241 "\\(^\\([ \t]*\\)#\\+BEGIN_SRC:?[ \t]+\\([^ \t\n]+\\)\\(.*\\)\n\\([^\000]+?\n\\)[ \t]*#\\+END_SRC.*\\)\\|\\(^\\([ \t]*\\)#\\+BEGIN_EXAMPLE:?\\(?:[ \t]+\\(.*\\)\\)?\n\\([^\000]+?\n\\)[ \t]*#\\+END_EXAMPLE.*\\)"
2245 (setq lang
(match-string 3)
2246 opts
(match-string 4)
2247 code
(match-string 5)
2248 indent
(length (match-string 2)))
2250 opts
(match-string 8)
2251 code
(match-string 9)
2252 indent
(length (match-string 7))))
2254 (setq trans
(org-export-format-source-code-or-example
2255 backend lang code opts indent
))
2256 (replace-match trans t t
))))
2258 (defvar htmlp
) ;; dynamically scoped
2259 (defvar latexp
) ;; dynamically scoped
2260 (defvar org-export-latex-verbatim-wrap
) ;; defined in org-latex.el
2261 (defvar org-export-latex-listings
) ;; defined in org-latex.el
2262 (defvar org-export-latex-listings-langs
) ;; defined in org-latex.el
2264 (defun org-export-format-source-code-or-example
2265 (backend lang code
&optional opts indent
)
2266 "Format CODE from language LANG and return it formatted for export.
2267 If LANG is nil, do not add any fontification.
2268 OPTS contains formatting optons, like `-n' for triggering numbering lines,
2269 and `+n' for continuing previous numering.
2270 Code formatting according to language currently only works for HTML.
2271 Numbering lines works for all three major backends (html, latex, and ascii).
2272 INDENT was the original indentation of the block."
2274 (let (num cont rtn rpllbl keepp textareap preserve-indentp cols rows fmt
)
2275 (setq opts
(or opts
"")
2276 num
(string-match "[-+]n\\>" opts
)
2277 cont
(string-match "\\+n\\>" opts
)
2278 rpllbl
(string-match "-r\\>" opts
)
2279 keepp
(string-match "-k\\>" opts
)
2280 textareap
(string-match "-t\\>" opts
)
2281 preserve-indentp
(or org-src-preserve-indentation
2282 (string-match "-i\\>" opts
))
2283 cols
(if (string-match "-w[ \t]+\\([0-9]+\\)" opts
)
2284 (string-to-number (match-string 1 opts
))
2286 rows
(if (string-match "-h[ \t]+\\([0-9]+\\)" opts
)
2287 (string-to-number (match-string 1 opts
))
2288 (org-count-lines code
))
2289 fmt
(if (string-match "-l[ \t]+\"\\([^\"\n]+\\)\"" opts
)
2290 (match-string 1 opts
)))
2291 (when (and textareap
(eq backend
'html
))
2292 ;; we cannot use numbering or highlighting.
2293 (setq num nil cont nil lang nil
))
2294 (if keepp
(setq rpllbl
'keep
))
2295 (setq rtn
(if preserve-indentp code
(org-remove-indentation code
)))
2296 (when (string-match "^," rtn
)
2297 (setq rtn
(with-temp-buffer
2299 ;; Free up the protected lines
2300 (goto-char (point-min))
2301 (while (re-search-forward "^," nil t
)
2302 (if (or (equal lang
"org")
2304 (looking-at "\\([*#]\\|[ \t]*#\\+\\)")))
2308 ;; Now backend-specific coding
2311 ((eq backend
'docbook
)
2312 (setq rtn
(org-export-number-lines rtn
'docbook
0 0 num cont rpllbl fmt
))
2313 (concat "\n#+BEGIN_DOCBOOK\n"
2314 (org-add-props (concat "<programlisting><![CDATA["
2316 "]]>\n</programlisting>\n")
2320 ;; We are exporting to HTML
2322 (require 'htmlize nil t
)
2323 (when (not (fboundp 'htmlize-region-for-paste
))
2324 ;; we do not have htmlize.el, or an old version of it
2327 "htmlize.el 1.34 or later is needed for source code formatting")))
2330 (let* ((lang-m (when lang
2331 (or (cdr (assoc lang org-src-lang-modes
))
2333 (mode (and lang-m
(intern
2335 (if (symbolp lang-m
)
2336 (symbol-name lang-m
)
2339 (org-inhibit-startup t
)
2340 (org-startup-folded nil
))
2344 (if (functionp mode
)
2347 (font-lock-fontify-buffer)
2349 (set-buffer-modified-p nil
)
2350 (org-export-htmlize-region-for-paste
2351 (point-min) (point-max))))
2352 (if (string-match "<pre\\([^>]*\\)>\n*" rtn
)
2353 (setq rtn
(replace-match
2354 (format "<pre class=\"src src-%s\">\n" lang
)
2358 (format "<p>\n<textarea cols=\"%d\" rows=\"%d\" overflow-x:scroll >\n"
2360 rtn
"</textarea>\n</p>\n"))
2363 (goto-char (point-min))
2364 (while (re-search-forward "[<>&]" nil t
)
2365 (replace-match (cdr (assq (char-before)
2366 '((?
&.
"&")(?
<.
"<")(?
>.
">"))))
2368 (setq rtn
(buffer-string)))
2369 (setq rtn
(concat "<pre class=\"example\">\n" rtn
"</pre>\n"))))
2371 (setq rtn
(org-export-number-lines rtn
'html
1 1 num
2373 (if (string-match "\\(\\`<[^>]*>\\)\n" rtn
)
2374 (setq rtn
(replace-match "\\1" t nil rtn
)))
2375 (concat "\n#+BEGIN_HTML\n" (org-add-props rtn
'(org-protected t
)) "\n#+END_HTML\n\n"))
2376 ((eq backend
'latex
)
2377 (setq rtn
(org-export-number-lines rtn
'latex
0 0 num cont rpllbl fmt
))
2378 (concat "\n#+BEGIN_LaTeX\n"
2380 (if org-export-latex-listings
2384 ((lang-sym (intern lang
))
2389 org-export-latex-listings-langs
))
2391 (format "\\lstset{language=%s}\n" lstlang
))
2393 "\\begin{lstlisting}\n"
2394 rtn
"\\end{lstlisting}\n")
2395 (concat (car org-export-latex-verbatim-wrap
)
2396 rtn
(cdr org-export-latex-verbatim-wrap
)))
2399 ((eq backend
'ascii
)
2400 ;; This is not HTML or LaTeX, so just make it an example.
2401 (setq rtn
(org-export-number-lines rtn
'ascii
0 0 num cont rpllbl fmt
))
2402 (concat "#+BEGIN_ASCII\n"
2406 (lambda (l) (concat " " l
))
2407 (org-split-string rtn
"\n")
2412 (org-add-props rtn nil
'original-indentation indent
))))
2414 (defun org-export-number-lines (text backend
2415 &optional skip1 skip2 number cont
2416 replace-labels label-format
)
2417 (setq skip1
(or skip1
0) skip2
(or skip2
0))
2418 (if (not cont
) (setq org-export-last-code-line-counter-value
0))
2421 (goto-char (point-max))
2422 (skip-chars-backward " \t\n\r")
2423 (delete-region (point) (point-max))
2424 (beginning-of-line (- 1 skip2
))
2425 (let* ((last (org-current-line))
2426 (n org-export-last-code-line-counter-value
)
2427 (nmax (+ n
(- last skip1
)))
2428 (fmt (format "%%%dd: " (length (number-to-string nmax
))))
2431 ((eq backend
'html
) (format "<span class=\"linenr\">%s</span>"
2433 ((eq backend
'ascii
) fmt
)
2434 ((eq backend
'latex
) fmt
)
2435 ((eq backend
'docbook
) fmt
)
2437 (label-format (or label-format org-coderef-label-format
))
2438 (label-pre (if (string-match "%s" label-format
)
2439 (substring label-format
0 (match-beginning 0))
2441 (label-post (if (string-match "%s" label-format
)
2442 (substring label-format
(match-end 0))
2446 ".*?\\S-.*?\\([ \t]*\\("
2447 (regexp-quote label-pre
)
2448 "\\([-a-zA-Z0-9_ ]+\\)"
2449 (regexp-quote label-post
)
2453 (org-goto-line (1+ skip1
))
2454 (while (and (re-search-forward "^" nil t
) (not (eobp)) (< n nmax
))
2456 (insert (format fm
(incf n
)))
2458 (when (looking-at lbl-re
)
2459 (setq ref
(match-string 3))
2460 (cond ((numberp replace-labels
)
2461 ;; remove labels; use numbers for references when lines
2462 ;; are numbered, use labels otherwise
2463 (delete-region (match-beginning 1) (match-end 1))
2464 (push (cons ref
(if (> n
0) n ref
)) org-export-code-refs
))
2465 ((eq replace-labels
'keep
)
2466 ;; don't remove labels; use numbers for references when
2467 ;; lines are numbered, use labels otherwise
2468 (goto-char (match-beginning 2))
2469 (delete-region (match-beginning 2) (match-end 2))
2470 (insert "(" ref
")")
2471 (push (cons ref
(if (> n
0) n
(concat "(" ref
")")))
2472 org-export-code-refs
))
2474 ;; don't remove labels and don't use numbers for
2476 (goto-char (match-beginning 2))
2477 (delete-region (match-beginning 2) (match-end 2))
2478 (insert "(" ref
")")
2479 (push (cons ref
(concat "(" ref
")")) org-export-code-refs
)))
2480 (when (eq backend
'html
)
2482 (beginning-of-line 1)
2483 (insert (format "<span id=\"coderef-%s\" class=\"coderef-off\">"
2486 (insert "</span>")))))
2487 (setq org-export-last-code-line-counter-value n
)
2488 (goto-char (point-max))
2492 (defun org-search-todo-below (line lines level
)
2493 "Search the subtree below LINE for any TODO entries."
2494 (let ((rest (cdr (memq line lines
)))
2495 (re org-todo-line-regexp
)
2498 (while (setq line
(pop rest
))
2499 (if (string-match re line
)
2501 (setq lv
(- (match-end 1) (match-beginning 1))
2502 todo
(and (match-beginning 2)
2503 (not (member (match-string 2 line
)
2504 org-done-keywords
))))
2506 (if (<= lv level
) (throw 'exit nil
))
2507 (if todo
(throw 'exit t
))))))))
2510 (defun org-export-visible (type arg
)
2511 "Create a copy of the visible part of the current buffer, and export it.
2512 The copy is created in a temporary buffer and removed after use.
2513 TYPE is the final key (as a string) that also select the export command in
2514 the `C-c C-e' export dispatcher.
2515 As a special case, if the you type SPC at the prompt, the temporary
2516 org-mode file will not be removed but presented to you so that you can
2517 continue to use it. The prefix arg ARG is passed through to the exporting
2521 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [D]ocBook [x]OXO [ ]keep buffer")
2522 (read-char-exclusive))
2523 current-prefix-arg
))
2524 (if (not (member type
'(?a ?\C-a ?b ?\C-b ?h ?D ?x ?\
)))
2525 (error "Invalid export key"))
2526 (let* ((binding (cdr (assoc type
2527 '((?a . org-export-as-ascii
)
2528 (?A . org-export-as-ascii-to-buffer
)
2529 (?\C-a . org-export-as-ascii
)
2530 (?b . org-export-as-html-and-open
)
2531 (?\C-b . org-export-as-html-and-open
)
2532 (?h . org-export-as-html
)
2533 (?H . org-export-as-html-to-buffer
)
2534 (?R . org-export-region-as-html
)
2535 (?D . org-export-as-docbook
)
2536 (?x . org-export-as-xoxo
)))))
2537 (keepp (equal type ?\
))
2538 (file buffer-file-name
)
2539 (buffer (get-buffer-create "*Org Export Visible*"))
2541 ;; Need to hack the drawers here.
2543 (goto-char (point-min))
2544 (while (re-search-forward org-drawer-regexp nil t
)
2545 (goto-char (match-beginning 1))
2546 (or (org-invisible-p) (org-flag-drawer nil
))))
2547 (with-current-buffer buffer
(erase-buffer))
2549 (setq s
(goto-char (point-min)))
2550 (while (not (= (point) (point-max)))
2551 (goto-char (org-find-invisible))
2552 (append-to-buffer buffer s
(point))
2553 (setq s
(goto-char (org-find-visible))))
2554 (org-cycle-hide-drawers 'all
)
2555 (goto-char (point-min))
2557 ;; Copy all comment lines to the end, to make sure #+ settings are
2558 ;; still available for the second export step. Kind of a hack, but
2559 ;; does do the trick.
2560 (if (looking-at "#[^\r\n]*")
2561 (append-to-buffer buffer
(match-beginning 0) (1+ (match-end 0))))
2562 (while (re-search-forward "[\n\r]#[^\n\r]*" nil t
)
2563 (append-to-buffer buffer
(1+ (match-beginning 0))
2564 (min (point-max) (1+ (match-end 0))))))
2566 (let ((buffer-file-name file
)
2567 (org-inhibit-startup t
))
2570 (unless keepp
(funcall binding arg
))))
2572 (kill-buffer buffer
)
2573 (switch-to-buffer-other-window buffer
)
2574 (goto-char (point-min)))))
2576 (defun org-find-visible ()
2578 (while (and (not (= (point-max) (setq s
(next-overlay-change s
))))
2579 (get-char-property s
'invisible
)))
2581 (defun org-find-invisible ()
2583 (while (and (not (= (point-max) (setq s
(next-overlay-change s
))))
2584 (not (get-char-property s
'invisible
))))
2587 (defvar org-export-htmlized-org-css-url
) ;; defined in org-html.el
2590 (defun org-export-as-org (arg &optional hidden ext-plist
2591 to-buffer body-only pub-dir
)
2592 "Make a copy with not-exporting stuff removed.
2593 The purpose of this function is to provide a way to export the source
2594 Org file of a webpage in Org format, but with sensitive and/or irrelevant
2595 stuff removed. This command will remove the following:
2597 - archived trees (if the variable `org-export-with-archived-trees' is nil)
2598 - comment blocks and trees starting with the COMMENT keyword
2599 - only trees that are consistent with `org-export-select-tags'
2600 and `org-export-exclude-tags'.
2602 The only arguments that will be used are EXT-PLIST and PUB-DIR,
2603 all the others will be ignored (but are present so that the general
2604 mechanism to call publishing functions will work).
2606 EXT-PLIST is a property list with external parameters overriding
2607 org-mode's default settings, but still inferior to file-local
2608 settings. When PUB-DIR is set, use this as the publishing
2611 (let* ((opt-plist (org-combine-plists (org-default-export-plist)
2613 (org-infile-export-plist)))
2614 (bfname (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
2615 (filename (concat (file-name-as-directory
2617 (org-export-directory :org opt-plist
)))
2618 (file-name-sans-extension
2619 (file-name-nondirectory bfname
))
2621 (filename (and filename
2622 (if (equal (file-truename filename
)
2623 (file-truename bfname
))
2624 (concat (file-name-sans-extension filename
)
2626 (file-name-extension filename
))
2628 (backup-inhibited t
)
2629 (buffer (find-file-noselect filename
))
2630 (region (buffer-string)))
2632 (switch-to-buffer buffer
)
2635 (let ((org-inhibit-startup t
)) (org-mode))
2636 (org-install-letbind)
2638 ;; Get rid of archived trees
2639 (org-export-remove-archived-trees (plist-get opt-plist
:archived-trees
))
2641 ;; Remove comment environment and comment subtrees
2642 (org-export-remove-comment-blocks-and-subtrees)
2644 ;; Get rid of excluded trees
2645 (org-export-handle-export-tags (plist-get opt-plist
:select-tags
)
2646 (plist-get opt-plist
:exclude-tags
))
2648 (when (or (plist-get opt-plist
:plain-source
)
2649 (not (or (plist-get opt-plist
:plain-source
)
2650 (plist-get opt-plist
:htmlized-source
))))
2651 ;; Either nothing special is requested (default call)
2652 ;; or the plain source is explicitly requested
2655 (when (plist-get opt-plist
:htmlized-source
)
2656 ;; Make the htmlized version
2659 (font-lock-fontify-buffer)
2660 (let* ((htmlize-output-type 'css
)
2661 (newbuf (htmlize-buffer)))
2662 (with-current-buffer newbuf
2663 (when org-export-htmlized-org-css-url
2664 (goto-char (point-min))
2665 (and (re-search-forward
2666 "<style type=\"text/css\">[^\000]*?\n[ \t]*</style>.*"
2670 "<link rel=\"stylesheet\" type=\"text/css\" href=\"%s\">"
2671 org-export-htmlized-org-css-url
)
2673 (write-file (concat filename
".html")))
2674 (kill-buffer newbuf
)))
2675 (set-buffer-modified-p nil
)
2676 (kill-buffer (current-buffer)))))
2678 (defvar org-archive-location
) ;; gets loaded with the org-archive require.
2679 (defun org-get-current-options ()
2680 "Return a string with current options as keyword options.
2681 Does include HTML export options as well as TODO and CATEGORY stuff."
2682 (require 'org-archive
)
2691 #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s -:%s f:%s *:%s <:%s
2692 #+OPTIONS: TeX:%s LaTeX:%s skip:%s d:%s todo:%s pri:%s tags:%s
2694 #+EXPORT_SELECT_TAGS: %s
2695 #+EXPORT_EXCLUDE_TAGS: %s
2701 #+PRIORITIES: %c %c %c
2703 #+STARTUP: %s %s %s %s %s
2709 (buffer-name) (user-full-name) user-mail-address
2710 (format-time-string (substring (car org-time-stamp-formats
) 1 -
1))
2711 org-export-default-language
2712 org-export-headline-levels
2713 org-export-with-section-numbers
2715 org-export-preserve-breaks
2716 org-export-html-expand
2717 org-export-with-fixed-width
2718 org-export-with-tables
2719 org-export-with-sub-superscripts
2720 org-export-with-special-strings
2721 org-export-with-footnotes
2722 org-export-with-emphasize
2723 org-export-with-timestamps
2724 org-export-with-TeX-macros
2725 org-export-with-LaTeX-fragments
2726 org-export-skip-text-before-1st-heading
2727 org-export-with-drawers
2728 org-export-with-todo-keywords
2729 org-export-with-priority
2730 org-export-with-tags
2731 (if (featurep 'org-jsinfo
) (org-infojs-options-inbuffer-template) "")
2732 (mapconcat 'identity org-export-select-tags
" ")
2733 (mapconcat 'identity org-export-exclude-tags
" ")
2734 org-export-html-link-up
2735 org-export-html-link-home
2737 (file-name-sans-extension
2738 (file-name-nondirectory (buffer-file-name (buffer-base-buffer)))))
2740 "TODO FEEDBACK VERIFY DONE"
2741 "Me Jason Marie DONE"
2742 org-highest-priority org-lowest-priority org-default-priority
2743 (mapconcat 'identity org-drawers
" ")
2744 (cdr (assoc org-startup-folded
2745 '((nil .
"showall") (t .
"overview") (content .
"content"))))
2746 (if org-odd-levels-only
"odd" "oddeven")
2747 (if org-hide-leading-stars
"hidestars" "showstars")
2748 (if org-startup-align-all-tables
"align" "noalign")
2749 (cond ((eq org-log-done t
) "logdone")
2750 ((equal org-log-done
'note
) "lognotedone")
2751 ((not org-log-done
) "nologdone"))
2752 (or (mapconcat (lambda (x)
2754 ((equal :startgroup
(car x
)) "{")
2755 ((equal :endgroup
(car x
)) "}")
2756 ((equal :newline
(car x
)) "")
2757 ((cdr x
) (format "%s(%c)" (car x
) (cdr x
)))
2759 (or org-tag-alist
(org-get-buffer-tags)) " ") "")
2760 (mapconcat 'identity org-file-tags
" ")
2761 org-archive-location
2762 "org file:~/org/%s.org"
2766 (defun org-insert-export-options-template ()
2767 "Insert into the buffer a template with information for exporting."
2769 (if (not (bolp)) (newline))
2770 (let ((s (org-get-current-options)))
2771 (and (string-match "#\\+CATEGORY" s
)
2772 (setq s
(substring s
0 (match-beginning 0))))
2775 (defvar org-table-colgroup-info nil
)
2777 (defun org-table-clean-before-export (lines &optional maybe-quoted
)
2778 "Check if the table has a marking column.
2779 If yes remove the column and the special lines."
2780 (setq org-table-colgroup-info nil
)
2783 (lambda (x) (or (string-match "^[ \t]*|-" x
)
2786 "^[ \t]*| *\\\\?\\([\#!$*_^ /]\\) *|"
2787 "^[ \t]*| *\\([\#!$*_^ /]\\) *|")
2791 (setq org-table-clean-did-remove-column nil
)
2796 ((string-match "^[ \t]*| */ *|" x
)
2797 (setq org-table-colgroup-info
2799 (cond ((member x
'("<" "<")) :start
)
2800 ((member x
'(">" ">")) :end
)
2801 ((member x
'("<>" "<>")) :startend
)
2803 (org-split-string x
"[ \t]*|[ \t]*")))
2807 (setq org-table-clean-did-remove-column t
)
2812 ((string-match "^[ \t]*| */ *|" x
)
2813 (setq org-table-colgroup-info
2815 (cond ((member x
'("<" "<")) :start
)
2816 ((member x
'(">" ">")) :end
)
2817 ((member x
'("<>" "<>")) :startend
)
2819 (cdr (org-split-string x
"[ \t]*|[ \t]*"))))
2821 ((string-match "^[ \t]*| *[!_^/] *|" x
)
2822 nil
) ; ignore this line
2823 ((or (string-match "^\\([ \t]*\\)|-+\\+" x
)
2824 (string-match "^\\([ \t]*\\)|[^|]*|" x
))
2825 ;; remove the first column
2826 (replace-match "\\1|" t nil x
))))
2829 (defun org-export-cleanup-toc-line (s)
2830 "Remove tags and timestamps from lines going into the toc."
2831 (when (memq org-export-with-tags
'(not-in-toc nil
))
2832 (if (string-match (org-re " +:[[:alnum:]_@:]+: *$") s
)
2833 (setq s
(replace-match "" t t s
))))
2834 (when org-export-remove-timestamps-from-toc
2835 (while (string-match org-maybe-keyword-time-regexp s
)
2836 (setq s
(replace-match "" t t s
))))
2837 (while (string-match org-bracket-link-regexp s
)
2838 (setq s
(replace-match (match-string (if (match-end 3) 3 1) s
)
2840 (while (string-match "\\[\\([0-9]\\|fn:[^]]*\\)\\]" s
)
2841 (setq s
(replace-match "" t t s
)))
2844 (defun org-create-multibrace-regexp (left right n
)
2845 "Create a regular expression which will match a balanced sexp.
2846 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
2847 as single character strings.
2848 The regexp returned will match the entire expression including the
2849 delimiters. It will also define a single group which contains the
2850 match except for the outermost delimiters. The maximum depth of
2851 stacked delimiters is N. Escaping delimiters is not possible."
2852 (let* ((nothing (concat "[^" left right
"]*?"))
2855 (next (concat "\\(?:" nothing left nothing right
"\\)+" nothing
)))
2858 re
(concat re or next
)
2859 next
(concat "\\(?:" nothing left next right
"\\)+" nothing
)))
2860 (concat left
"\\(" re
"\\)" right
)))
2862 (defvar org-match-substring-regexp
2864 "\\([^\\]\\)\\([_^]\\)\\("
2865 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
2867 "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth
) "\\)"
2869 "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
2870 "The regular expression matching a sub- or superscript.")
2872 (defvar org-match-substring-with-braces-regexp
2874 "\\([^\\]\\)\\([_^]\\)\\("
2875 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
2877 "The regular expression matching a sub- or superscript, forcing braces.")
2880 (defun org-get-text-property-any (pos prop
&optional object
)
2881 (or (get-text-property pos prop object
)
2882 (and (setq pos
(next-single-property-change pos prop object
))
2883 (get-text-property pos prop object
))))
2885 (defun org-export-get-coderef-format (path desc
)
2887 (if (and desc
(string-match
2888 (regexp-quote (concat "(" path
")"))
2890 (replace-match "%s" t t desc
)
2893 (defun org-export-push-to-kill-ring (format)
2894 "Push buffer content to kill ring.
2895 The depends on the variable `org-export-copy-to-kill'."
2896 (when org-export-copy-to-kill-ring
2897 (org-kill-new (buffer-string))
2898 (when (fboundp 'x-set-selection
)
2899 (ignore-errors (x-set-selection 'PRIMARY
(buffer-string)))
2900 (ignore-errors (x-set-selection 'CLIPBOARD
(buffer-string))))
2901 (message "%s export done, pushed to kill ring and clipboard" format
)))
2905 ;; arch-tag: 65985fe9-095c-49c7-a7b6-cb4ee15c0a95
2907 ;;; org-exp.el ends here
