1 ;;; org-export.el --- Generic Export Engine For Org
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
26 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; - The communication channel consists in a property list, which is
30 ;; created and updated during the process. Its use is to offer
31 ;; every piece of information, would it be about initial environment
32 ;; or contextual data, all in a single place. The exhaustive list
33 ;; of properties is given in "The Communication Channel" section of
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders.
46 ;; The core function is `org-export-as'. It returns the transcoded
47 ;; buffer as a string.
49 ;; In order to derive an exporter out of this generic implementation,
50 ;; one can define a transcode function for each element or object.
51 ;; Such function should return a string for the corresponding element,
52 ;; without any trailing space, or nil. It must accept three
54 ;; 1. the element or object itself,
55 ;; 2. its contents, or nil when it isn't recursive,
56 ;; 3. the property list used as a communication channel.
58 ;; If no such function is found, that element or object type will
59 ;; simply be ignored, along with any separating blank line. The same
60 ;; will happen if the function returns the nil value. If that
61 ;; function returns the empty string, the type will be ignored, but
62 ;; the blank lines will be kept.
64 ;; Contents, when not nil, are stripped from any global indentation
65 ;; (although the relative one is preserved). They also always end
66 ;; with a single newline character.
68 ;; These functions must follow a strict naming convention:
69 ;; `org-BACKEND-TYPE' where, obviously, BACKEND is the name of the
70 ;; export back-end and TYPE the type of the element or object handled.
72 ;; Moreover, two additional functions can be defined. On the one
73 ;; hand, `org-BACKEND-template' returns the final transcoded string,
74 ;; and can be used to add a preamble and a postamble to document's
75 ;; body. It must accept two arguments: the transcoded string and the
76 ;; property list containing export options. On the other hand,
77 ;; `org-BACKEND-plain-text', when defined, is to be called on every
78 ;; text not recognized as an element or an object. It must accept two
79 ;; arguments: the text string and the information channel.
81 ;; Any back-end can define its own variables. Among them, those
82 ;; customizables should belong to the `org-export-BACKEND' group.
83 ;; Also, a special variable, `org-BACKEND-option-alist', allows to
84 ;; define buffer keywords and "#+options:" items specific to that
85 ;; back-end. See `org-export-option-alist' for supported defaults and
88 ;; Tools for common tasks across back-ends are implemented in the
89 ;; penultimate part of this file. A dispatcher for standard back-ends
90 ;; is provided in the last one.
93 (eval-when-compile (require 'cl
))
94 (require 'org-element
)
95 ;; Require major back-ends and publishing tools
96 (require 'org-e-ascii
"../../EXPERIMENTAL/org-e-ascii.el")
97 (require 'org-e-html
"../../EXPERIMENTAL/org-e-html.el")
98 (require 'org-e-latex
"../../EXPERIMENTAL/org-e-latex.el")
99 (require 'org-e-odt
"../../EXPERIMENTAL/org-e-odt.el")
100 (require 'org-e-publish
"../../EXPERIMENTAL/org-e-publish.el")
104 ;;; Internal Variables
106 ;; Among internal variables, the most important is
107 ;; `org-export-option-alist'. This variable define the global export
108 ;; options, shared between every exporter, and how they are acquired.
110 (defconst org-export-max-depth
19
111 "Maximum nesting depth for headlines, counting from 0.")
113 (defconst org-export-option-alist
114 '((:author
"AUTHOR" nil user-full-name t
)
115 (:creator
"CREATOR" nil org-export-creator-string
)
116 (:date
"DATE" nil nil t
)
117 (:description
"DESCRIPTION" nil nil newline
)
118 (:email
"EMAIL" nil user-mail-address t
)
119 (:exclude-tags
"EXPORT_EXCLUDE_TAGS" nil org-export-exclude-tags split
)
120 (:headline-levels nil
"H" org-export-headline-levels
)
121 (:keywords
"KEYWORDS" nil nil space
)
122 (:language
"LANGUAGE" nil org-export-default-language t
)
123 (:preserve-breaks nil
"\\n" org-export-preserve-breaks
)
124 (:section-numbers nil
"num" org-export-with-section-numbers
)
125 (:select-tags
"EXPORT_SELECT_TAGS" nil org-export-select-tags split
)
126 (:time-stamp-file nil
"timestamp" org-export-time-stamp-file
)
127 (:title
"TITLE" nil nil space
)
128 (:with-archived-trees nil
"arch" org-export-with-archived-trees
)
129 (:with-author nil
"author" org-export-with-author
)
130 (:with-creator nil
"creator" org-export-with-creator
)
131 (:with-drawers nil
"d" org-export-with-drawers
)
132 (:with-email nil
"email" org-export-with-email
)
133 (:with-emphasize nil
"*" org-export-with-emphasize
)
134 (:with-entities nil
"e" org-export-with-entities
)
135 (:with-fixed-width nil
":" org-export-with-fixed-width
)
136 (:with-footnotes nil
"f" org-export-with-footnotes
)
137 (:with-priority nil
"pri" org-export-with-priority
)
138 (:with-special-strings nil
"-" org-export-with-special-strings
)
139 (:with-sub-superscript nil
"^" org-export-with-sub-superscripts
)
140 (:with-toc nil
"toc" org-export-with-toc
)
141 (:with-tables nil
"|" org-export-with-tables
)
142 (:with-tags nil
"tags" org-export-with-tags
)
143 (:with-tasks nil
"tasks" org-export-with-tasks
)
144 (:with-timestamps nil
"<" org-export-with-timestamps
)
145 (:with-todo-keywords nil
"todo" org-export-with-todo-keywords
))
146 "Alist between export properties and ways to set them.
148 The car of the alist is the property name, and the cdr is a list
149 like \(KEYWORD OPTION DEFAULT BEHAVIOUR\) where:
151 KEYWORD is a string representing a buffer keyword, or nil.
152 OPTION is a string that could be found in an #+OPTIONS: line.
153 DEFAULT is the default value for the property.
154 BEHAVIOUR determine how Org should handle multiple keywords for
155 the same property. It is a symbol among:
156 nil Keep old value and discard the new one.
157 t Replace old value with the new one.
158 `space' Concatenate the values, separating them with a space.
159 `newline' Concatenate the values, separating them with
161 `split' Split values at white spaces, and cons them to the
164 KEYWORD and OPTION have precedence over DEFAULT.
166 All these properties should be back-end agnostic. For back-end
167 specific properties, define a similar variable named
168 `org-BACKEND-option-alist', replacing BACKEND with the name of
169 the appropriate back-end. You can also redefine properties
170 there, as they have precedence over these.")
172 (defconst org-export-special-keywords
173 '("SETUP_FILE" "OPTIONS" "MACRO")
174 "List of in-buffer keywords that require special treatment.
175 These keywords are not directly associated to a property. The
176 way they are handled must be hard-coded into
177 `org-export-get-inbuffer-options' function.")
179 (defconst org-export-filters-alist
180 '((:filter-babel-call . org-export-filter-babel-call-functions
)
181 (:filter-center-block . org-export-filter-center-block-functions
)
182 (:filter-comment . org-export-filter-comment-functions
)
183 (:filter-comment-block . org-export-filter-comment-block-functions
)
184 (:filter-drawer . org-export-filter-drawer-functions
)
185 (:filter-dynamic-block . org-export-filter-dynamic-block-functions
)
186 (:filter-emphasis . org-export-filter-emphasis-functions
)
187 (:filter-entity . org-export-filter-entity-functions
)
188 (:filter-example-block . org-export-filter-example-block-functions
)
189 (:filter-export-block . org-export-filter-export-block-functions
)
190 (:filter-export-snippet . org-export-filter-export-snippet-functions
)
191 (:filter-final-output . org-export-filter-final-output-functions
)
192 (:filter-fixed-width . org-export-filter-fixed-width-functions
)
193 (:filter-footnote-definition . org-export-filter-footnote-definition-functions
)
194 (:filter-footnote-reference . org-export-filter-footnote-reference-functions
)
195 (:filter-headline . org-export-filter-headline-functions
)
196 (:filter-horizontal-rule . org-export-filter-horizontal-rule-functions
)
197 (:filter-inline-babel-call . org-export-filter-inline-babel-call-functions
)
198 (:filter-inline-src-block . org-export-filter-inline-src-block-functions
)
199 (:filter-inlinetask . org-export-filter-inlinetask-functions
)
200 (:filter-item . org-export-filter-item-functions
)
201 (:filter-keyword . org-export-filter-keyword-functions
)
202 (:filter-latex-environment . org-export-filter-latex-environment-functions
)
203 (:filter-latex-fragment . org-export-filter-latex-fragment-functions
)
204 (:filter-line-break . org-export-filter-line-break-functions
)
205 (:filter-link . org-export-filter-link-functions
)
206 (:filter-macro . org-export-filter-macro-functions
)
207 (:filter-paragraph . org-export-filter-paragraph-functions
)
208 (:filter-parse-tree . org-export-filter-parse-tree-functions
)
209 (:filter-plain-list . org-export-filter-plain-list-functions
)
210 (:filter-plain-text . org-export-filter-plain-text-functions
)
211 (:filter-property-drawer . org-export-filter-property-drawer-functions
)
212 (:filter-quote-block . org-export-filter-quote-block-functions
)
213 (:filter-quote-section . org-export-filter-quote-section-functions
)
214 (:filter-radio-target . org-export-filter-radio-target-functions
)
215 (:filter-section . org-export-filter-section-functions
)
216 (:filter-special-block . org-export-filter-special-block-functions
)
217 (:filter-src-block . org-export-filter-src-block-functions
)
218 (:filter-statistics-cookie . org-export-filter-statistics-cookie-functions
)
219 (:filter-subscript . org-export-filter-subscript-functions
)
220 (:filter-superscript . org-export-filter-superscript-functions
)
221 (:filter-table . org-export-filter-table-functions
)
222 (:filter-target . org-export-filter-target-functions
)
223 (:filter-time-stamp . org-export-filter-time-stamp-functions
)
224 (:filter-verbatim . org-export-filter-verbatim-functions
)
225 (:filter-verse-block . org-export-filter-verse-block-functions
))
226 "Alist between filters properties and initial values.
228 The key of each association is a property name accessible through
229 the communication channel its value is a configurable global
230 variable defining initial filters.
232 This list is meant to install user specified filters. Back-end
233 developers may install their own filters using
234 `org-BACKEND-filters-alist', where BACKEND is the name of the
235 considered back-end. Filters defined there will always be
236 prepended to the current list, so they always get applied
239 (defconst org-export-default-inline-image-rule
243 '("png" "jpeg" "jpg" "gif" "tiff" "tif" "xbm"
244 "xpm" "pbm" "pgm" "ppm") t
))))
245 "Default rule for link matching an inline image.
246 This rule applies to links with no description. By default, it
247 will be considered as an inline image if it targets a local file
248 whose extension is either \"png\", \"jpeg\", \"jpg\", \"gif\",
249 \"tiff\", \"tif\", \"xbm\", \"xpm\", \"pbm\", \"pgm\" or \"ppm\".
250 See `org-export-inline-image-p' for more information about
255 ;;; User-configurable Variables
257 ;; Configuration for the masses.
259 ;; They should never be evaled directly, as their value is to be
260 ;; stored in a property list (cf. `org-export-option-alist').
262 (defgroup org-export nil
263 "Options for exporting Org mode files."
267 (defgroup org-export-general nil
268 "General options for export engine."
269 :tag
"Org Export General"
272 (defcustom org-export-with-archived-trees
'headline
273 "Whether sub-trees with the ARCHIVE tag should be exported.
275 This can have three different values:
276 nil Do not export, pretend this tree is not present.
277 t Do export the entire tree.
278 `headline' Only export the headline, but skip the tree below it.
280 This option can also be set with the #+OPTIONS line,
282 :group
'org-export-general
284 (const :tag
"Not at all" nil
)
285 (const :tag
"Headline only" 'headline
)
286 (const :tag
"Entirely" t
)))
288 (defcustom org-export-with-author t
289 "Non-nil means insert author name into the exported file.
290 This option can also be set with the #+OPTIONS line,
291 e.g. \"author:nil\"."
292 :group
'org-export-general
295 (defcustom org-export-with-creator
'comment
296 "Non-nil means the postamble should contain a creator sentence.
298 The sentence can be set in `org-export-creator-string' and
299 defaults to \"Generated by Org mode XX in Emacs XXX.\".
301 If the value is `comment' insert it as a comment."
302 :group
'org-export-general
304 (const :tag
"No creator sentence" nil
)
305 (const :tag
"Sentence as a comment" 'comment
)
306 (const :tag
"Insert the sentence" t
)))
308 (defcustom org-export-creator-string
309 (format "Generated by Org mode %s in Emacs %s." org-version emacs-version
)
310 "String to insert at the end of the generated document."
311 :group
'org-export-general
312 :type
'(string :tag
"Creator string"))
314 (defcustom org-export-with-drawers t
315 "Non-nil means export contents of standard drawers.
317 When t, all drawers are exported. This may also be a list of
318 drawer names to export. This variable doesn't apply to
321 This option can also be set with the #+OPTIONS line,
323 :group
'org-export-general
325 (const :tag
"All drawers" t
)
326 (const :tag
"None" nil
)
327 (repeat :tag
"Selected drawers"
328 (string :tag
"Drawer name"))))
330 (defcustom org-export-with-email nil
331 "Non-nil means insert author email into the exported file.
332 This option can also be set with the #+OPTIONS line,
334 :group
'org-export-general
337 (defcustom org-export-with-emphasize t
338 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
340 If the export target supports emphasizing text, the word will be
341 typeset in bold, italic, or underlined, respectively. Not all
342 export backends support this.
344 This option can also be set with the #+OPTIONS line, e.g. \"*:nil\"."
345 :group
'org-export-general
348 (defcustom org-export-exclude-tags
'("noexport")
349 "Tags that exclude a tree from export.
351 All trees carrying any of these tags will be excluded from
352 export. This is without condition, so even subtrees inside that
353 carry one of the `org-export-select-tags' will be removed.
355 This option can also be set with the #+EXPORT_EXCLUDE_TAGS:
357 :group
'org-export-general
358 :type
'(repeat (string :tag
"Tag")))
360 (defcustom org-export-with-fixed-width t
361 "Non-nil means lines starting with \":\" will be in fixed width font.
363 This can be used to have pre-formatted text, fragments of code
365 : ;; Some Lisp examples
368 will be looking just like this in also HTML. See also the QUOTE
369 keyword. Not all export backends support this.
371 This option can also be set with the #+OPTIONS line, e.g. \"::nil\"."
372 :group
'org-export-translation
375 (defcustom org-export-with-footnotes t
376 "Non-nil means Org footnotes should be exported.
377 This option can also be set with the #+OPTIONS line,
379 :group
'org-export-general
382 (defcustom org-export-headline-levels
3
383 "The last level which is still exported as a headline.
385 Inferior levels will produce itemize lists when exported. Note
386 that a numeric prefix argument to an exporter function overrides
389 This option can also be set with the #+OPTIONS line, e.g. \"H:2\"."
390 :group
'org-export-general
393 (defcustom org-export-default-language
"en"
394 "The default language for export and clocktable translations, as a string.
395 This may have an association in
396 `org-clock-clocktable-language-setup'."
397 :group
'org-export-general
398 :type
'(string :tag
"Language"))
400 (defcustom org-export-preserve-breaks nil
401 "Non-nil means preserve all line breaks when exporting.
403 Normally, in HTML output paragraphs will be reformatted.
405 This option can also be set with the #+OPTIONS line,
407 :group
'org-export-general
410 (defcustom org-export-with-entities t
411 "Non-nil means interpret entities when exporting.
413 For example, HTML export converts \\alpha to α and \\AA to
416 For a list of supported names, see the constant `org-entities'
417 and the user option `org-entities-user'.
419 This option can also be set with the #+OPTIONS line,
421 :group
'org-export-general
424 (defcustom org-export-with-priority nil
425 "Non-nil means include priority cookies in export.
427 When nil, remove priority cookies for export.
429 This option can also be set with the #+OPTIONS line,
431 :group
'org-export-general
434 (defcustom org-export-with-section-numbers t
435 "Non-nil means add section numbers to headlines when exporting.
437 When set to an integer n, numbering will only happen for
438 headlines whose relative level is higher or equal to n.
440 This option can also be set with the #+OPTIONS line,
442 :group
'org-export-general
445 (defcustom org-export-select-tags
'("export")
446 "Tags that select a tree for export.
448 If any such tag is found in a buffer, all trees that do not carry
449 one of these tags will be ignored during export. Inside trees
450 that are selected like this, you can still deselect a subtree by
451 tagging it with one of the `org-export-exclude-tags'.
453 This option can also be set with the #+EXPORT_SELECT_TAGS:
455 :group
'org-export-general
456 :type
'(repeat (string :tag
"Tag")))
458 (defcustom org-export-with-special-strings t
459 "Non-nil means interpret \"\-\", \"--\" and \"---\" for export.
461 When this option is turned on, these strings will be exported as:
464 -----+----------+--------
470 This option can also be set with the #+OPTIONS line,
472 :group
'org-export-general
475 (defcustom org-export-with-sub-superscripts t
476 "Non-nil means interpret \"_\" and \"^\" for export.
478 When this option is turned on, you can use TeX-like syntax for
479 sub- and superscripts. Several characters after \"_\" or \"^\"
480 will be considered as a single item - so grouping with {} is
481 normally not needed. For example, the following things will be
482 parsed as single sub- or superscripts.
484 10^24 or 10^tau several digits will be considered 1 item.
485 10^-12 or 10^-tau a leading sign with digits or a word
486 x^2-y^3 will be read as x^2 - y^3, because items are
487 terminated by almost any nonword/nondigit char.
488 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
490 Still, ambiguity is possible - so when in doubt use {} to enclose
491 the sub/superscript. If you set this variable to the symbol
492 `{}', the braces are *required* in order to trigger
493 interpretations as sub/superscript. This can be helpful in
494 documents that need \"_\" frequently in plain text.
496 This option can also be set with the #+OPTIONS line,
498 :group
'org-export-general
500 (const :tag
"Interpret them" t
)
501 (const :tag
"Curly brackets only" {})
502 (const :tag
"Do not interpret them" nil
)))
504 (defcustom org-export-with-toc t
505 "Non-nil means create a table of contents in exported files.
507 The TOC contains headlines with levels up
508 to`org-export-headline-levels'. When an integer, include levels
509 up to N in the toc, this may then be different from
510 `org-export-headline-levels', but it will not be allowed to be
511 larger than the number of headline levels. When nil, no table of
514 This option can also be set with the #+OPTIONS line,
515 e.g. \"toc:nil\" or \"toc:3\"."
516 :group
'org-export-general
518 (const :tag
"No Table of Contents" nil
)
519 (const :tag
"Full Table of Contents" t
)
520 (integer :tag
"TOC to level")))
522 (defcustom org-export-with-tables t
523 "If non-nil, lines starting with \"|\" define a table.
526 | Name | Address | Birthday |
527 |-------------+----------+-----------|
528 | Arthur Dent | England | 29.2.2100 |
530 This option can also be set with the #+OPTIONS line, e.g. \"|:nil\"."
531 :group
'org-export-general
534 (defcustom org-export-with-tags t
535 "If nil, do not export tags, just remove them from headlines.
537 If this is the symbol `not-in-toc', tags will be removed from
538 table of contents entries, but still be shown in the headlines of
541 This option can also be set with the #+OPTIONS line,
543 :group
'org-export-general
545 (const :tag
"Off" nil
)
546 (const :tag
"Not in TOC" not-in-toc
)
547 (const :tag
"On" t
)))
549 (defcustom org-export-with-tasks t
550 "Non-nil means include TODO items for export.
551 This may have the following values:
552 t include tasks independent of state.
553 todo include only tasks that are not yet done.
554 done include only tasks that are already done.
555 nil remove all tasks before export
556 list of keywords keep only tasks with these keywords"
557 :group
'org-export-general
559 (const :tag
"All tasks" t
)
560 (const :tag
"No tasks" nil
)
561 (const :tag
"Not-done tasks" todo
)
562 (const :tag
"Only done tasks" done
)
563 (repeat :tag
"Specific TODO keywords"
564 (string :tag
"Keyword"))))
566 (defcustom org-export-time-stamp-file t
567 "Non-nil means insert a time stamp into the exported file.
568 The time stamp shows when the file was created.
570 This option can also be set with the #+OPTIONS line,
571 e.g. \"timestamp:nil\"."
572 :group
'org-export-general
575 (defcustom org-export-with-timestamps t
576 "If nil, do not export time stamps and associated keywords."
577 :group
'org-export-general
580 (defcustom org-export-with-todo-keywords t
581 "Non-nil means include TODO keywords in export.
582 When nil, remove all these keywords from the export.")
584 (defcustom org-export-allow-BIND
'confirm
585 "Non-nil means allow #+BIND to define local variable values for export.
586 This is a potential security risk, which is why the user must
587 confirm the use of these lines."
588 :group
'org-export-general
590 (const :tag
"Never" nil
)
591 (const :tag
"Always" t
)
592 (const :tag
"Ask a confirmation for each file" confirm
)))
594 (defcustom org-export-snippet-translation-alist nil
595 "Alist between export snippets back-ends and exporter back-ends.
597 This variable allows to provide shortcuts for export snippets.
599 For example, with a value of '\(\(\"h\" . \"html\"\)\), the HTML
600 back-end will recognize the contents of \"@h{<b>}\" as HTML code
601 while every other back-end will ignore it."
602 :group
'org-export-general
605 (string :tag
"Shortcut")
606 (string :tag
"Back-end"))))
608 (defcustom org-export-coding-system nil
609 "Coding system for the exported file."
610 :group
'org-export-general
611 :type
'coding-system
)
613 (defcustom org-export-copy-to-kill-ring t
614 "Non-nil means exported stuff will also be pushed onto the kill ring."
615 :group
'org-export-general
618 (defcustom org-export-initial-scope
'buffer
619 "The initial scope when exporting with `org-export-dispatch'.
620 This variable can be either set to `buffer' or `subtree'."
621 :group
'org-export-general
623 (const :tag
"Export current buffer" 'buffer
)
624 (const :tag
"Export current subtree" 'subtree
)))
626 (defcustom org-export-show-temporary-export-buffer t
627 "Non-nil means show buffer after exporting to temp buffer.
628 When Org exports to a file, the buffer visiting that file is ever
629 shown, but remains buried. However, when exporting to a temporary
630 buffer, that buffer is popped up in a second window. When this variable
631 is nil, the buffer remains buried also in these cases."
632 :group
'org-export-general
635 (defcustom org-export-dispatch-use-expert-ui nil
636 "Non-nil means using a non-intrusive `org-export-dispatch'.
637 In that case, no help buffer is displayed. Though, an indicator
638 for current export scope is added to the prompt \(i.e. \"b\" when
639 output is restricted to body only, \"s\" when it is restricted to
640 the current subtree and \"v\" when only visible elements are
641 considered for export\). Also, \[?] allows to switch back to
643 :group
'org-export-general
648 ;;; The Communication Channel
650 ;; During export process, every function has access to a number of
651 ;; properties. They are of three types:
653 ;; 1. Environment options are collected once at the very beginning of
654 ;; the process, out of the original buffer and configuration.
655 ;; Associated to the parse tree, they make an Org closure.
656 ;; Collecting them is handled by `org-export-get-environment'
659 ;; Most environment options are defined through the
660 ;; `org-export-option-alist' variable.
662 ;; 2. Tree properties are extracted directly from the parsed tree,
663 ;; just before export, by `org-export-collect-tree-properties'.
665 ;; 3. Local options are updated during parsing, and their value
666 ;; depends on the level of recursion. For now, only `:ignore-list'
667 ;; belongs to that category.
669 ;; Here is the full list of properties available during transcode
670 ;; process, with their category (option, tree or local) and their
673 ;; + `:author' :: Author's name.
674 ;; - category :: option
677 ;; + `:back-end' :: Current back-end used for transcoding.
678 ;; - category :: tree
681 ;; + `:creator' :: String to write as creation information.
682 ;; - category :: option
685 ;; + `:date' :: String to use as date.
686 ;; - category :: option
689 ;; + `:description' :: Description text for the current data.
690 ;; - category :: option
693 ;; + `:email' :: Author's email.
694 ;; - category :: option
697 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
699 ;; - category :: option
700 ;; - type :: list of strings
702 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
703 ;; their definition, as parsed data. Only non-inlined footnotes
704 ;; are represented in this alist. Also, every definition isn't
705 ;; guaranteed to be referenced in the parse tree. The purpose of
706 ;; this property is to preserve definitions from oblivion
707 ;; (i.e. when the parse tree comes from a part of the original
708 ;; buffer), it isn't meant for direct use in a back-end. To
709 ;; retrieve a definition relative to a reference, use
710 ;; `org-export-get-footnote-definition' instead.
711 ;; - category :: option
712 ;; - type :: alist (STRING . LIST)
714 ;; + `:headline-levels' :: Maximum level being exported as an
715 ;; headline. Comparison is done with the relative level of
716 ;; headlines in the parse tree, not necessarily with their
718 ;; - category :: option
721 ;; + `:headline-offset' :: Difference between relative and real level
722 ;; of headlines in the parse tree. For example, a value of -1
723 ;; means a level 2 headline should be considered as level
724 ;; 1 (cf. `org-export-get-relative-level').
725 ;; - category :: tree
728 ;; + `:headline-numbering' :: Alist between headlines and their
729 ;; numbering, as a list of numbers
730 ;; (cf. `org-export-get-headline-number').
731 ;; - category :: tree
732 ;; - type :: alist (INTEGER . LIST)
734 ;; + `:ignore-list' :: List of elements and objects that should be
735 ;; ignored during export.
736 ;; - category :: local
737 ;; - type :: list of elements and objects
739 ;; + `:input-file' :: Full path to input file, if any.
740 ;; - category :: option
741 ;; - type :: string or nil
743 ;; + `:keywords' :: List of keywords attached to data.
744 ;; - category :: option
747 ;; + `:language' :: Default language used for translations.
748 ;; - category :: option
751 ;; + `:macro-input-file' :: Macro returning file name of input file,
753 ;; - category :: option
754 ;; - type :: string or nil
756 ;; + `:parse-tree' :: Whole parse tree, available at any time during
758 ;; - category :: global
759 ;; - type :: list (as returned by `org-element-parse-buffer')
761 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
763 ;; - category :: option
764 ;; - type :: symbol (nil, t)
766 ;; + `:section-numbers' :: Non-nil means transcoding should add
767 ;; section numbers to headlines.
768 ;; - category :: option
769 ;; - type :: symbol (nil, t)
771 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
772 ;; in transcoding. When such a tag is present,
773 ;; subtrees without it are de facto excluded from
774 ;; the process. See `use-select-tags'.
775 ;; - category :: option
776 ;; - type :: list of strings
778 ;; + `:target-list' :: List of targets encountered in the parse tree.
779 ;; This is used to partly resolve "fuzzy" links
780 ;; (cf. `org-export-resolve-fuzzy-link').
781 ;; - category :: tree
782 ;; - type :: list of strings
784 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
785 ;; a time stamp in the output.
786 ;; - category :: option
787 ;; - type :: symbol (nil, t)
789 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
790 ;; also be transcoded. If it is set to the `headline' symbol,
791 ;; only the archived headline's name is retained.
792 ;; - category :: option
793 ;; - type :: symbol (nil, t, `headline')
795 ;; + `:with-author' :: Non-nil means author's name should be included
797 ;; - category :: option
798 ;; - type :: symbol (nil, t)
800 ;; + `:with-creator' :: Non-nild means a creation sentence should be
801 ;; inserted at the end of the transcoded string. If the value
802 ;; is `comment', it should be commented.
803 ;; - category :: option
804 ;; - type :: symbol (`comment', nil, t)
806 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
807 ;; its value is a list of names, only drawers with such names
808 ;; will be transcoded.
809 ;; - category :: option
810 ;; - type :: symbol (nil, t) or list of strings
812 ;; + `:with-email' :: Non-nil means output should contain author's
814 ;; - category :: option
815 ;; - type :: symbol (nil, t)
817 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
819 ;; - category :: option
820 ;; - type :: symbol (nil, t)
822 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
823 ;; strings starting with a colon as a fixed-with (verbatim) area.
824 ;; - category :: option
825 ;; - type :: symbol (nil, t)
827 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
829 ;; - category :: option
830 ;; - type :: symbol (nil, t)
832 ;; + `:with-priority' :: Non-nil means transcoding should include
834 ;; - category :: option
835 ;; - type :: symbol (nil, t)
837 ;; + `:with-special-strings' :: Non-nil means transcoding should
838 ;; interpret special strings in plain text.
839 ;; - category :: option
840 ;; - type :: symbol (nil, t)
842 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
843 ;; interpret subscript and superscript. With a value of "{}",
844 ;; only interpret those using curly brackets.
845 ;; - category :: option
846 ;; - type :: symbol (nil, {}, t)
848 ;; + `:with-tables' :: Non-nil means transcoding should interpret
850 ;; - category :: option
851 ;; - type :: symbol (nil, t)
853 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
854 ;; headlines. A `not-in-toc' value will remove them
855 ;; from the table of contents, if any, nonetheless.
856 ;; - category :: option
857 ;; - type :: symbol (nil, t, `not-in-toc')
859 ;; + `:with-tasks' :: Non-nil means transcoding should include
860 ;; headlines with a TODO keyword. A `todo' value
861 ;; will only include headlines with a todo type
862 ;; keyword while a `done' value will do the
863 ;; contrary. If a list of strings is provided, only
864 ;; tasks with keywords belonging to that list will
866 ;; - category :: option
867 ;; - type :: symbol (t, todo, done, nil) or list of strings
869 ;; + `:with-timestamps' :: Non-nil means transcoding should include
870 ;; time stamps and associated keywords. Otherwise, completely
872 ;; - category :: option
873 ;; - type :: symbol: (t, nil)
875 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
876 ;; added to the output. An integer value limits its
878 ;; - category :: option
879 ;; - type :: symbol (nil, t or integer)
881 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
882 ;; include TODO keywords.
883 ;; - category :: option
884 ;; - type :: symbol (nil, t)
887 ;;;; Environment Options
889 ;; Environment options encompass all parameters defined outside the
890 ;; scope of the parsed data. They come from five sources, in
891 ;; increasing precedence order:
893 ;; - Global variables,
894 ;; - Options keyword symbols,
895 ;; - Buffer keywords,
896 ;; - Subtree properties.
898 ;; The central internal function with regards to environment options
899 ;; is `org-export-get-environment'. It updates global variables with
900 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
901 ;; the different sources.
903 ;; The internal functions doing the retrieval are:
904 ;; `org-export-parse-option-keyword' ,
905 ;; `org-export-get-subtree-options' ,
906 ;; `org-export-get-inbuffer-options' and
907 ;; `org-export-get-global-options'.
909 ;; Some properties, which do not rely on the previous sources but
910 ;; still depend on the original buffer, are taken care of with
911 ;; `org-export-initial-options'.
913 ;; Also, `org-export-confirm-letbind' and `org-export-install-letbind'
914 ;; take care of the part relative to "#+BIND:" keywords.
916 (defun org-export-get-environment (&optional backend subtreep ext-plist
)
917 "Collect export options from the current buffer.
919 Optional argument BACKEND is a symbol specifying which back-end
920 specific options to read, if any.
922 When optional argument SUBTREEP is non-nil, assume the export is
923 done against the current sub-tree.
925 Third optional argument EXT-PLIST is a property list with
926 external parameters overriding Org default settings, but still
927 inferior to file-local settings."
928 ;; First install #+BIND variables.
929 (org-export-install-letbind-maybe)
930 ;; Get and prioritize export options...
931 (let ((options (org-combine-plists
932 ;; ... from global variables...
933 (org-export-get-global-options backend
)
934 ;; ... from buffer's name (default title)...
936 ,(or (let ((file (buffer-file-name (buffer-base-buffer))))
938 (file-name-sans-extension
939 (file-name-nondirectory file
))))
940 (buffer-name (buffer-base-buffer))))
941 ;; ... from an external property list...
943 ;; ... from in-buffer settings...
944 (org-export-get-inbuffer-options
946 (and buffer-file-name
947 (org-remove-double-quotes buffer-file-name
)))
948 ;; ... and from subtree, when appropriate.
949 (and subtreep
(org-export-get-subtree-options)))))
950 ;; Add initial options.
951 (setq options
(append (org-export-initial-options) options
))
955 (defun org-export-parse-option-keyword (options &optional backend
)
956 "Parse an OPTIONS line and return values as a plist.
957 Optional argument BACKEND is a symbol specifying which back-end
958 specific items to read, if any."
960 (append org-export-option-alist
963 (format "org-%s-option-alist" backend
))))
964 (and (boundp var
) (eval var
))))))
965 ;; Build an alist between #+OPTION: item and property-name.
968 (when (nth 2 e
) (cons (regexp-quote (nth 2 e
))
973 (when (string-match (concat "\\(\\`\\|[ \t]\\)"
975 ":\\(([^)\n]+)\\|[^ \t\n\r;,.]*\\)")
977 (setq plist
(plist-put plist
979 (car (read-from-string
980 (match-string 2 options
)))))))
984 (defun org-export-get-subtree-options ()
985 "Get export options in subtree at point.
987 Assume point is at subtree's beginning.
989 Return options as a plist."
991 (when (setq prop
(progn (looking-at org-todo-line-regexp
)
993 (org-entry-get (point) "EXPORT_TITLE"))
994 (org-match-string-no-properties 3))))
998 (org-element-parse-secondary-string
1000 (cdr (assq 'keyword org-element-string-restrictions
))))))
1001 (when (setq prop
(org-entry-get (point) "EXPORT_TEXT"))
1002 (setq plist
(plist-put plist
:text prop
)))
1003 (when (setq prop
(org-entry-get (point) "EXPORT_AUTHOR"))
1004 (setq plist
(plist-put plist
:author prop
)))
1005 (when (setq prop
(org-entry-get (point) "EXPORT_DATE"))
1006 (setq plist
(plist-put plist
:date prop
)))
1007 (when (setq prop
(org-entry-get (point) "EXPORT_OPTIONS"))
1008 (setq plist
(org-export-add-options-to-plist plist prop
)))
1011 (defun org-export-get-inbuffer-options (&optional backend files
)
1012 "Return current buffer export options, as a plist.
1014 Optional argument BACKEND, when non-nil, is a symbol specifying
1015 which back-end specific options should also be read in the
1018 Optional argument FILES is a list of setup files names read so
1019 far, used to avoid circular dependencies.
1021 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1022 (org-with-wide-buffer
1023 (goto-char (point-min))
1024 (let ((case-fold-search t
) plist
)
1025 ;; 1. Special keywords, as in `org-export-special-keywords'.
1026 (let ((special-re (org-make-options-regexp org-export-special-keywords
)))
1027 (while (re-search-forward special-re nil t
)
1028 (let ((element (org-element-at-point)))
1029 (when (eq (org-element-type element
) 'keyword
)
1030 (let* ((key (upcase (org-element-property :key element
)))
1031 (val (org-element-property :value element
))
1034 ((string= key
"SETUP_FILE")
1037 (org-remove-double-quotes (org-trim val
)))))
1038 ;; Avoid circular dependencies.
1039 (unless (member file files
)
1041 (insert (org-file-contents file
'noerror
))
1043 (org-export-get-inbuffer-options
1044 backend
(cons file files
))))))
1045 ((string= key
"OPTIONS")
1046 (org-export-parse-option-keyword val backend
))
1047 ((string= key
"MACRO")
1049 "^\\([-a-zA-Z0-9_]+\\)\\(?:[ \t]+\\(.*?\\)[ \t]*$\\)?"
1054 (downcase (match-string 1 val
)))))
1055 (value (org-match-string-no-properties 2 val
)))
1058 ;; Value will be evaled. Leave it as-is.
1059 ((string-match "\\`(eval\\>" value
)
1061 ;; Value has to be parsed for nested
1069 org-element-object-restrictions
))))
1070 (org-element-parse-secondary-string
1071 ;; If user explicitly asks for
1072 ;; a newline, be sure to preserve it
1073 ;; from further filling with
1074 ;; `hard-newline'. Also replace
1075 ;; "\\n" with "\n", "\\\n" with "\\n"
1077 (replace-regexp-in-string
1078 "\\(\\\\\\\\\\)n" "\\\\"
1079 (replace-regexp-in-string
1080 "\\(?:^\\|[^\\\\]\\)\\(\\\\n\\)"
1081 hard-newline value nil nil
1)
1084 (setq plist
(org-combine-plists plist prop
)))))))
1085 ;; 2. Standard options, as in `org-export-option-alist'.
1086 (let* ((all (append org-export-option-alist
1087 ;; Also look for back-end specific options
1088 ;; if BACKEND is defined.
1092 (format "org-%s-option-alist" backend
))))
1093 (and (boundp var
) (eval var
))))))
1094 ;; Build alist between keyword name and property name.
1097 (lambda (e) (when (nth 1 e
) (cons (nth 1 e
) (car e
))))
1099 ;; Build regexp matching all keywords associated to export
1100 ;; options. Note: the search is case insensitive.
1101 (opt-re (org-make-options-regexp
1102 (delq nil
(mapcar (lambda (e) (nth 1 e
)) all
)))))
1103 (goto-char (point-min))
1104 (while (re-search-forward opt-re nil t
)
1105 (let ((element (org-element-at-point)))
1106 (when (eq (org-element-type element
) 'keyword
)
1107 (let* ((key (upcase (org-element-property :key element
)))
1108 (val (org-element-property :value element
))
1109 (prop (cdr (assoc key alist
)))
1110 (behaviour (nth 4 (assq prop all
))))
1114 ;; Handle value depending on specified BEHAVIOUR.
1117 (if (not (plist-get plist prop
)) (org-trim val
)
1118 (concat (plist-get plist prop
) " " (org-trim val
))))
1121 (concat (plist-get plist prop
) "\n" (org-trim val
))))
1123 `(,@(plist-get plist prop
) ,@(org-split-string val
)))
1125 (otherwise (if (not (plist-member plist prop
)) val
1126 (plist-get plist prop
))))))))))
1127 ;; Parse keywords specified in `org-element-parsed-keywords'.
1130 (let* ((prop (cdr (assoc key alist
)))
1131 (value (and prop
(plist-get plist prop
))))
1132 (when (stringp value
)
1136 (org-element-parse-secondary-string
1138 (cdr (assq 'keyword org-element-string-restrictions
))))))))
1139 org-element-parsed-keywords
))
1140 ;; 3. Return final value.
1143 (defun org-export-get-global-options (&optional backend
)
1144 "Return global export options as a plist.
1146 Optional argument BACKEND, if non-nil, is a symbol specifying
1147 which back-end specific export options should also be read in the
1149 (let ((all (append org-export-option-alist
1152 (format "org-%s-option-alist" backend
))))
1153 (and (boundp var
) (eval var
))))))
1156 (mapc (lambda (cell)
1157 (setq plist
(plist-put plist
(car cell
) (eval (nth 3 cell
)))))
1162 (defun org-export-initial-options ()
1163 "Return a plist with properties related to input buffer."
1164 (let ((visited-file (buffer-file-name (buffer-base-buffer))))
1166 ;; Store full path of input file name, or nil. For internal use.
1167 :input-file visited-file
1168 ;; `:macro-date', `:macro-time' and `:macro-property' could as well
1169 ;; be initialized as tree properties, since they don't depend on
1170 ;; initial environment. Though, it may be more logical to keep
1171 ;; them close to other ":macro-" properties.
1172 :macro-date
"(eval (format-time-string \"$1\"))"
1173 :macro-time
"(eval (format-time-string \"$1\"))"
1174 :macro-property
"(eval (org-entry-get nil \"$1\" 'selective))"
1175 :macro-modification-time
1177 (file-exists-p visited-file
)
1178 (concat "(eval (format-time-string \"$1\" '"
1179 (prin1-to-string (nth 5 (file-attributes visited-file
)))
1181 ;; Store input file name as a macro.
1182 :macro-input-file
(and visited-file
(file-name-nondirectory visited-file
))
1183 ;; Footnotes definitions must be collected in the original buffer,
1184 ;; as there's no insurance that they will still be in the parse
1185 ;; tree, due to some narrowing.
1186 :footnote-definition-alist
1188 (org-with-wide-buffer
1189 (goto-char (point-min))
1190 (while (re-search-forward org-footnote-definition-re nil t
)
1191 (let ((def (org-footnote-at-definition-p)))
1193 (org-skip-whitespace)
1194 (push (cons (car def
)
1196 (narrow-to-region (point) (nth 2 def
))
1197 ;; Like `org-element-parse-buffer', but
1198 ;; makes sure the definition doesn't start
1199 ;; with a section element.
1201 (list 'org-data nil
)
1202 (org-element-parse-elements
1203 (point-min) (point-max) nil nil nil nil nil
))))
1207 (defvar org-export-allow-BIND-local nil
)
1208 (defun org-export-confirm-letbind ()
1209 "Can we use #+BIND values during export?
1210 By default this will ask for confirmation by the user, to divert
1211 possible security risks."
1213 ((not org-export-allow-BIND
) nil
)
1214 ((eq org-export-allow-BIND t
) t
)
1215 ((local-variable-p 'org-export-allow-BIND-local
) org-export-allow-BIND-local
)
1216 (t (org-set-local 'org-export-allow-BIND-local
1217 (yes-or-no-p "Allow BIND values in this buffer? ")))))
1219 (defun org-export-install-letbind-maybe ()
1220 "Install the values from #+BIND lines as local variables.
1221 Variables must be installed before in-buffer options are
1224 (org-with-wide-buffer
1225 (goto-char (point-min))
1226 (while (re-search-forward (org-make-options-regexp '("BIND")) nil t
)
1227 (when (org-export-confirm-letbind)
1228 (push (read (concat "(" (org-match-string-no-properties 2) ")"))
1230 (while (setq pair
(pop letbind
))
1231 (org-set-local (car pair
) (nth 1 pair
)))))
1234 ;;;; Tree Properties
1236 ;; Tree properties are infromation extracted from parse tree. They
1237 ;; are initialized at the beginning of the transcoding process by
1238 ;; `org-export-collect-tree-properties'.
1240 ;; Dedicated functions focus on computing the value of specific tree
1241 ;; properties during initialization. Thus,
1242 ;; `org-export-populate-ignore-list' lists elements and objects that
1243 ;; should be skipped during export, `org-export-get-min-level' gets
1244 ;; the minimal exportable level, used as a basis to compute relative
1245 ;; level for headlines. Eventually
1246 ;; `org-export-collect-headline-numbering' builds an alist between
1247 ;; headlines and their numbering.
1249 (defun org-export-collect-tree-properties (data info backend
)
1250 "Extract tree properties from parse tree.
1252 DATA is the parse tree from which information is retrieved. INFO
1253 is a list holding export options. BACKEND is the back-end called
1254 for transcoding, as a symbol.
1256 Following tree properties are set:
1257 `:back-end' Back-end used for transcoding.
1259 `:headline-offset' Offset between true level of headlines and
1260 local level. An offset of -1 means an headline
1261 of level 2 should be considered as a level
1262 1 headline in the context.
1264 `:headline-numbering' Alist of all headlines as key an the
1265 associated numbering as value.
1267 `:ignore-list' List of elements that should be ignored during
1270 `:parse-tree' Whole parse tree.
1272 `:target-list' List of all targets in the parse tree."
1273 ;; First, get the list of elements and objects to ignore, and put it
1274 ;; into `:ignore-list'. Do not overwrite any user ignore that might
1275 ;; have been done during parse tree filtering.
1279 (append (org-export-populate-ignore-list data info
)
1280 (plist-get info
:ignore-list
))))
1281 ;; Then compute `:headline-offset' in order to be able to use
1282 ;; `org-export-get-relative-level'.
1285 :headline-offset
(- 1 (org-export-get-min-level data info
))))
1286 ;; Now, properties order doesn't matter: get the rest of the tree
1292 ,(org-element-map data
'target
'identity info
)
1293 :headline-numbering
,(org-export-collect-headline-numbering data info
)
1297 (defun org-export-get-min-level (data options
)
1298 "Return minimum exportable headline's level in DATA.
1299 DATA is parsed tree as returned by `org-element-parse-buffer'.
1300 OPTIONS is a plist holding export options."
1302 (let ((min-level 10000))
1305 (when (and (eq (org-element-type blob
) 'headline
)
1306 (not (member blob
(plist-get options
:ignore-list
))))
1308 (min (org-element-property :level blob
) min-level
)))
1309 (when (= min-level
1) (throw 'exit
1)))
1310 (org-element-contents data
))
1311 ;; If no headline was found, for the sake of consistency, set
1312 ;; minimum level to 1 nonetheless.
1313 (if (= min-level
10000) 1 min-level
))))
1315 (defun org-export-collect-headline-numbering (data options
)
1316 "Return numbering of all exportable headlines in a parse tree.
1318 DATA is the parse tree. OPTIONS is the plist holding export
1321 Return an alist whose key is an headline and value is its
1322 associated numbering \(in the shape of a list of numbers\)."
1323 (let ((numbering (make-vector org-export-max-depth
0)))
1328 (let ((relative-level
1329 (1- (org-export-get-relative-level headline options
))))
1332 (loop for n across numbering
1333 for idx from
0 to org-export-max-depth
1334 when
(< idx relative-level
) collect n
1335 when
(= idx relative-level
) collect
(aset numbering idx
(1+ n
))
1336 when
(> idx relative-level
) do
(aset numbering idx
0)))))
1339 (defun org-export-populate-ignore-list (data options
)
1340 "Return list of elements and objects to ignore during export.
1342 DATA is the parse tree to traverse. OPTIONS is the plist holding
1345 Return elements or objects to ignore as a list."
1349 (lambda (data options selected
)
1350 ;; Collect ignored elements or objects into IGNORE-LIST.
1353 (if (org-export--skip-p el options selected
) (push el ignore
)
1354 (let ((type (org-element-type el
)))
1355 (if (and (eq (plist-get info
:with-archived-trees
) 'headline
)
1356 (eq (org-element-type el
) 'headline
)
1357 (org-element-property :archivedp el
))
1358 ;; If headline is archived but tree below has
1359 ;; to be skipped, add it to ignore list.
1360 (mapc (lambda (e) (push e ignore
))
1361 (org-element-contents el
))
1362 ;; Move into recursive objects/elements.
1363 (when (or (eq type
'org-data
)
1364 (memq type org-element-greater-elements
)
1365 (memq type org-element-recursive-objects
)
1366 (eq type
'paragraph
))
1367 (funcall walk-data el options selected
))))))
1368 (org-element-contents data
))))))
1369 ;; Main call. First find trees containing a select tag, if any.
1370 (funcall walk-data data options
(org-export--selected-trees data options
))
1374 (defun org-export--selected-trees (data info
)
1375 "Return list of headlines containing a select tag in their tree.
1376 DATA is parsed data as returned by `org-element-parse-buffer'.
1377 INFO is a plist holding export options."
1378 (let (selected-trees
1381 (lambda (data genealogy
)
1382 (case (org-element-type data
)
1384 (funcall walk-data
(org-element-contents data
) genealogy
))
1386 (let ((tags (org-element-property :tags headline
)))
1388 (loop for tag in
(plist-get info
:select-tags
)
1389 thereis
(string-match
1390 (format ":%s:" tag
) tags
)))
1391 ;; When a select tag is found, mark as acceptable
1392 ;; full genealogy and every headline within the
1394 (setq selected-trees
1396 (cons data genealogy
)
1397 (org-element-map data
'headline
'identity
)
1399 ;; Else, continue searching in tree, recursively.
1400 (funcall walk-data data
(cons data genealogy
))))))))))
1401 (funcall walk-data data nil
) selected-trees
))
1403 (defun org-export--skip-p (blob options select-tags
)
1404 "Non-nil when element or object BLOB should be skipped during export.
1405 OPTIONS is the plist holding export options."
1406 (case (org-element-type blob
)
1409 (let ((with-tasks (plist-get options
:with-tasks
))
1410 (todo (org-element-property :todo-keyword blob
))
1411 (todo-type (org-element-property :todo-type blob
))
1412 (archived (plist-get options
:with-archived-trees
))
1413 (tag-list (let ((tags (org-element-property :tags blob
)))
1414 (and tags
(org-split-string tags
":")))))
1416 ;; Ignore subtrees with an exclude tag.
1417 (loop for k in
(plist-get options
:exclude-tags
)
1418 thereis
(member k tag-list
))
1419 ;; Ignore subtrees without a select tag, when such tag is
1420 ;; found in the buffer.
1421 (member blob select-tags
)
1422 ;; Ignore commented sub-trees.
1423 (org-element-property :commentedp blob
)
1424 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1425 (and (not archived
) (org-element-property :archivedp blob
))
1426 ;; Ignore tasks, if specified by `:with-tasks' property.
1428 (or (not with-tasks
)
1429 (and (memq with-tasks
'(todo done
))
1430 (not (eq todo-type with-tasks
)))
1431 (and (consp with-tasks
) (not (member todo with-tasks
))))))))
1432 ;; Check time-stamp.
1433 (time-stamp (not (plist-get options
:with-timestamps
)))
1436 (or (not (plist-get options
:with-drawers
))
1437 (and (consp (plist-get options
:with-drawers
))
1438 (not (member (org-element-property :drawer-name blob
)
1439 (plist-get options
:with-drawers
))))))))
1445 ;; This function reads Org data (obtained with, i.e.
1446 ;; `org-element-parse-buffer') and transcodes it into a specified
1447 ;; back-end output. It takes care of updating local properties,
1448 ;; filtering out elements or objects according to export options and
1449 ;; organizing the output blank lines and white space are preserved.
1451 ;; Though, this function is inapropriate for secondary strings, which
1452 ;; require a fresh copy of the plist passed as INFO argument. Thus,
1453 ;; `org-export-secondary-string' is provided for that specific task.
1455 ;; Internally, three functions handle the filtering of objects and
1456 ;; elements during the export. In particular,
1457 ;; `org-export-ignore-element' mark an element or object so future
1458 ;; parse tree traversals skip it, `org-export-interpret-p' tells which
1459 ;; elements or objects should be seen as real Org syntax and
1460 ;; `org-export-expand' transforms the others back into their original
1463 (defun org-export-data (data backend info
)
1464 "Convert DATA to a string into BACKEND format.
1466 DATA is a nested list as returned by `org-element-parse-buffer'.
1468 BACKEND is a symbol among supported exporters.
1470 INFO is a plist holding export options and also used as
1471 a communication channel between elements when walking the nested
1472 list. See `org-export-update-info' function for more
1475 Return transcoded string."
1477 ;; BLOB can be an element, an object, a string, or nil.
1481 ;; BLOB is a string. Check if the optional transcoder for plain
1482 ;; text exists, and call it in that case. Otherwise, simply
1483 ;; return string. Also update INFO and call
1484 ;; `org-export-filter-plain-text-functions'.
1486 (let ((transcoder (intern (format "org-%s-plain-text" backend
))))
1487 (org-export-filter-apply-functions
1488 (plist-get info
:filter-plain-text
)
1489 (if (fboundp transcoder
) (funcall transcoder blob info
) blob
)
1491 ;; BLOB is an element or an object.
1493 (let* ((type (org-element-type blob
))
1494 ;; 1. Determine the appropriate TRANSCODER.
1497 ;; 1.0 A full Org document is inserted.
1498 ((eq type
'org-data
) 'identity
)
1499 ;; 1.1. BLOB should be ignored.
1500 ((member blob
(plist-get info
:ignore-list
)) nil
)
1501 ;; 1.2. BLOB shouldn't be transcoded. Interpret it
1502 ;; back into Org syntax.
1503 ((not (org-export-interpret-p blob info
)) 'org-export-expand
)
1504 ;; 1.3. Else apply naming convention.
1505 (t (let ((trans (intern (format "org-%s-%s" backend type
))))
1506 (and (fboundp trans
) trans
)))))
1507 ;; 2. Compute CONTENTS of BLOB.
1510 ;; Case 0. No transcoder defined: ignore BLOB.
1511 ((not transcoder
) nil
)
1512 ;; Case 1. Transparently export an Org document.
1513 ((eq type
'org-data
) (org-export-data blob backend info
))
1514 ;; Case 2. For a recursive object.
1515 ((memq type org-element-recursive-objects
)
1516 (org-export-data blob backend info
))
1517 ;; Case 3. For a recursive element.
1518 ((memq type org-element-greater-elements
)
1519 ;; Ignore contents of an archived tree
1520 ;; when `:with-archived-trees' is `headline'.
1523 (eq (plist-get info
:with-archived-trees
) 'headline
)
1524 (org-element-property :archivedp blob
))
1525 (org-element-normalize-string
1526 (org-export-data blob backend info
))))
1527 ;; Case 4. For a paragraph.
1528 ((eq type
'paragraph
)
1530 (org-element-normalize-contents
1532 ;; When normalizing contents of an item or
1533 ;; a footnote definition, ignore first line's
1534 ;; indentation: there is none and it might be
1536 (and (not (org-export-get-previous-element blob info
))
1537 (let ((parent (org-export-get-parent blob info
)))
1538 (memq (org-element-type parent
)
1539 '(footnote-definition item
)))))))
1540 (org-export-data paragraph backend info
)))))
1541 ;; 3. Transcode BLOB into RESULTS string.
1543 ((not transcoder
) nil
)
1544 ((eq transcoder
'org-export-expand
)
1546 `(org-data nil
,(funcall transcoder blob contents
))
1548 (t (funcall transcoder blob contents info
)))))
1549 ;; 4. Return results.
1552 ;; No filter for a full document.
1553 ((eq type
'org-data
) results
)
1554 ;; Otherwise, update INFO, append the same white space
1555 ;; between elements or objects as in the original buffer,
1556 ;; and call appropriate filters.
1559 (org-export-filter-apply-functions
1560 (plist-get info
(intern (format ":filter-%s" type
)))
1561 (let ((post-blank (org-element-property :post-blank blob
)))
1562 (if (memq type org-element-all-elements
)
1563 (concat (org-element-normalize-string results
)
1564 (make-string post-blank ?
\n))
1565 (concat results
(make-string post-blank ?
))))
1567 ;; Eventually return string.
1569 (org-element-contents data
) ""))
1571 (defun org-export-secondary-string (secondary backend info
)
1572 "Convert SECONDARY string into BACKEND format.
1574 SECONDARY is a nested list as returned by
1575 `org-element-parse-secondary-string'.
1577 BACKEND is a symbol among supported exporters. INFO is a plist
1578 used as a communication channel.
1580 Return transcoded string."
1581 ;; Make SECONDARY acceptable for `org-export-data'.
1582 (let ((s (if (listp secondary
) secondary
(list secondary
))))
1583 (org-export-data `(org-data nil
,@s
) backend
(copy-sequence info
))))
1585 (defun org-export-interpret-p (blob info
)
1586 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1587 Check is done according to export options INFO, stored as
1589 (case (org-element-type blob
)
1591 (entity (plist-get info
:with-entities
))
1593 (emphasis (plist-get info
:with-emphasize
))
1594 ;; ... fixed-width areas.
1595 (fixed-width (plist-get info
:with-fixed-width
))
1597 ((footnote-definition footnote-reference
)
1598 (plist-get info
:with-footnotes
))
1599 ;; ... sub/superscripts...
1600 ((subscript superscript
)
1601 (let ((sub/super-p
(plist-get info
:with-sub-superscript
)))
1602 (if (eq sub
/super-p
'{})
1603 (org-element-property :use-brackets-p blob
)
1606 (table (plist-get info
:with-tables
))
1609 (defsubst org-export-expand
(blob contents
)
1610 "Expand a parsed element or object to its original state.
1611 BLOB is either an element or an object. CONTENTS is its
1612 contents, as a string or nil."
1613 (funcall (intern (format "org-element-%s-interpreter" (org-element-type blob
)))
1616 (defun org-export-ignore-element (element info
)
1617 "Add ELEMENT to `:ignore-list' in INFO.
1619 Any element in `:ignore-list' will be skipped when using
1620 `org-element-map'. INFO is modified by side effects."
1621 (plist-put info
:ignore-list
(cons element
(plist-get info
:ignore-list
))))
1625 ;;; The Filter System
1627 ;; Filters allow end-users to tweak easily the transcoded output.
1628 ;; They are the functional counterpart of hooks, as every filter in
1629 ;; a set is applied to the return value of the previous one.
1631 ;; Every set is back-end agnostic. Although, a filter is always
1632 ;; called, in addition to the string it applies to, with the back-end
1633 ;; used as argument, so it's easy enough for the end-user to add
1634 ;; back-end specific filters in the set. The communication channel,
1635 ;; as a plist, is required as the third argument.
1637 ;; Filters sets are defined below. There are of four types:
1639 ;; - `org-export-filter-parse-tree-functions' applies directly on the
1640 ;; complete parsed tree. It's the only filters set that doesn't
1641 ;; apply to a string.
1642 ;; - `org-export-filter-final-output-functions' applies to the final
1643 ;; transcoded string.
1644 ;; - `org-export-filter-plain-text-functions' applies to any string
1645 ;; not recognized as Org syntax.
1646 ;; - `org-export-filter-TYPE-functions' applies on the string returned
1647 ;; after an element or object of type TYPE has been transcoded.
1649 ;; All filters sets are applied through
1650 ;; `org-export-filter-apply-functions' function. Filters in a set are
1651 ;; applied in a LIFO fashion. It allows developers to be sure that
1652 ;; their filters will be applied first.
1654 ;; Filters properties are installed in communication channel just
1655 ;; before parsing, with `org-export-install-filters' function.
1657 ;;;; Special Filters
1658 (defvar org-export-filter-parse-tree-functions nil
1659 "Filter, or list of filters, applied to the parsed tree.
1660 Each filter is called with three arguments: the parse tree, as
1661 returned by `org-element-parse-buffer', the back-end, as
1662 a symbol, and the communication channel, as a plist. It must
1663 return the modified parse tree to transcode.")
1665 (defvar org-export-filter-final-output-functions nil
1666 "Filter, or list of filters, applied to the transcoded string.
1667 Each filter is called with three arguments: the full transcoded
1668 string, the back-end, as a symbol, and the communication channel,
1669 as a plist. It must return a string that will be used as the
1670 final export output.")
1672 (defvar org-export-filter-plain-text-functions nil
1673 "Filter, or list of filters, applied to plain text.
1674 Each filter is called with three arguments: a string which
1675 contains no Org syntax, the back-end, as a symbol, and the
1676 communication channel, as a plist. It must return a string or
1680 ;;;; Elements Filters
1682 (defvar org-export-filter-center-block-functions nil
1683 "List of functions applied to a transcoded center block.
1684 Each filter is called with three arguments: the transcoded center
1685 block, as a string, the back-end, as a symbol, and the
1686 communication channel, as a plist. It must return a string or
1689 (defvar org-export-filter-drawer-functions nil
1690 "List of functions applied to a transcoded drawer.
1691 Each filter is called with three arguments: the transcoded
1692 drawer, as a string, the back-end, as a symbol, and the
1693 communication channel, as a plist. It must return a string or
1696 (defvar org-export-filter-dynamic-block-functions nil
1697 "List of functions applied to a transcoded dynamic-block.
1698 Each filter is called with three arguments: the transcoded
1699 dynamic-block, as a string, the back-end, as a symbol, and the
1700 communication channel, as a plist. It must return a string or
1703 (defvar org-export-filter-headline-functions nil
1704 "List of functions applied to a transcoded headline.
1705 Each filter is called with three arguments: the transcoded
1706 headline, as a string, the back-end, as a symbol, and the
1707 communication channel, as a plist. It must return a string or
1710 (defvar org-export-filter-inlinetask-functions nil
1711 "List of functions applied to a transcoded inlinetask.
1712 Each filter is called with three arguments: the transcoded
1713 inlinetask, as a string, the back-end, as a symbol, and the
1714 communication channel, as a plist. It must return a string or
1717 (defvar org-export-filter-plain-list-functions nil
1718 "List of functions applied to a transcoded plain-list.
1719 Each filter is called with three arguments: the transcoded
1720 plain-list, as a string, the back-end, as a symbol, and the
1721 communication channel, as a plist. It must return a string or
1724 (defvar org-export-filter-item-functions nil
1725 "List of functions applied to a transcoded item.
1726 Each filter is called with three arguments: the transcoded item,
1727 as a string, the back-end, as a symbol, and the communication
1728 channel, as a plist. It must return a string or nil.")
1730 (defvar org-export-filter-comment-functions nil
1731 "List of functions applied to a transcoded comment.
1732 Each filter is called with three arguments: the transcoded
1733 comment, as a string, the back-end, as a symbol, and the
1734 communication channel, as a plist. It must return a string or
1737 (defvar org-export-filter-comment-block-functions nil
1738 "List of functions applied to a transcoded comment-comment.
1739 Each filter is called with three arguments: the transcoded
1740 comment-block, as a string, the back-end, as a symbol, and the
1741 communication channel, as a plist. It must return a string or
1744 (defvar org-export-filter-example-block-functions nil
1745 "List of functions applied to a transcoded example-block.
1746 Each filter is called with three arguments: the transcoded
1747 example-block, as a string, the back-end, as a symbol, and the
1748 communication channel, as a plist. It must return a string or
1751 (defvar org-export-filter-export-block-functions nil
1752 "List of functions applied to a transcoded export-block.
1753 Each filter is called with three arguments: the transcoded
1754 export-block, as a string, the back-end, as a symbol, and the
1755 communication channel, as a plist. It must return a string or
1758 (defvar org-export-filter-fixed-width-functions nil
1759 "List of functions applied to a transcoded fixed-width.
1760 Each filter is called with three arguments: the transcoded
1761 fixed-width, as a string, the back-end, as a symbol, and the
1762 communication channel, as a plist. It must return a string or
1765 (defvar org-export-filter-footnote-definition-functions nil
1766 "List of functions applied to a transcoded footnote-definition.
1767 Each filter is called with three arguments: the transcoded
1768 footnote-definition, as a string, the back-end, as a symbol, and
1769 the communication channel, as a plist. It must return a string
1772 (defvar org-export-filter-horizontal-rule-functions nil
1773 "List of functions applied to a transcoded horizontal-rule.
1774 Each filter is called with three arguments: the transcoded
1775 horizontal-rule, as a string, the back-end, as a symbol, and the
1776 communication channel, as a plist. It must return a string or
1779 (defvar org-export-filter-keyword-functions nil
1780 "List of functions applied to a transcoded keyword.
1781 Each filter is called with three arguments: the transcoded
1782 keyword, as a string, the back-end, as a symbol, and the
1783 communication channel, as a plist. It must return a string or
1786 (defvar org-export-filter-latex-environment-functions nil
1787 "List of functions applied to a transcoded latex-environment.
1788 Each filter is called with three arguments: the transcoded
1789 latex-environment, as a string, the back-end, as a symbol, and
1790 the communication channel, as a plist. It must return a string
1793 (defvar org-export-filter-babel-call-functions nil
1794 "List of functions applied to a transcoded babel-call.
1795 Each filter is called with three arguments: the transcoded
1796 babel-call, as a string, the back-end, as a symbol, and the
1797 communication channel, as a plist. It must return a string or
1800 (defvar org-export-filter-paragraph-functions nil
1801 "List of functions applied to a transcoded paragraph.
1802 Each filter is called with three arguments: the transcoded
1803 paragraph, as a string, the back-end, as a symbol, and the
1804 communication channel, as a plist. It must return a string or
1807 (defvar org-export-filter-property-drawer-functions nil
1808 "List of functions applied to a transcoded property-drawer.
1809 Each filter is called with three arguments: the transcoded
1810 property-drawer, as a string, the back-end, as a symbol, and the
1811 communication channel, as a plist. It must return a string or
1814 (defvar org-export-filter-quote-block-functions nil
1815 "List of functions applied to a transcoded quote block.
1816 Each filter is called with three arguments: the transcoded quote
1817 block, as a string, the back-end, as a symbol, and the
1818 communication channel, as a plist. It must return a string or
1821 (defvar org-export-filter-quote-section-functions nil
1822 "List of functions applied to a transcoded quote-section.
1823 Each filter is called with three arguments: the transcoded
1824 quote-section, as a string, the back-end, as a symbol, and the
1825 communication channel, as a plist. It must return a string or
1828 (defvar org-export-filter-section-functions nil
1829 "List of functions applied to a transcoded section.
1830 Each filter is called with three arguments: the transcoded
1831 section, as a string, the back-end, as a symbol, and the
1832 communication channel, as a plist. It must return a string or
1835 (defvar org-export-filter-special-block-functions nil
1836 "List of functions applied to a transcoded special block.
1837 Each filter is called with three arguments: the transcoded
1838 special block, as a string, the back-end, as a symbol, and the
1839 communication channel, as a plist. It must return a string or
1842 (defvar org-export-filter-src-block-functions nil
1843 "List of functions applied to a transcoded src-block.
1844 Each filter is called with three arguments: the transcoded
1845 src-block, as a string, the back-end, as a symbol, and the
1846 communication channel, as a plist. It must return a string or
1849 (defvar org-export-filter-table-functions nil
1850 "List of functions applied to a transcoded table.
1851 Each filter is called with three arguments: the transcoded table,
1852 as a string, the back-end, as a symbol, and the communication
1853 channel, as a plist. It must return a string or nil.")
1855 (defvar org-export-filter-verse-block-functions nil
1856 "List of functions applied to a transcoded verse block.
1857 Each filter is called with three arguments: the transcoded verse
1858 block, as a string, the back-end, as a symbol, and the
1859 communication channel, as a plist. It must return a string or
1863 ;;;; Objects Filters
1865 (defvar org-export-filter-emphasis-functions nil
1866 "List of functions applied to a transcoded emphasis.
1867 Each filter is called with three arguments: the transcoded
1868 emphasis, as a string, the back-end, as a symbol, and the
1869 communication channel, as a plist. It must return a string or
1872 (defvar org-export-filter-entity-functions nil
1873 "List of functions applied to a transcoded entity.
1874 Each filter is called with three arguments: the transcoded
1875 entity, as a string, the back-end, as a symbol, and the
1876 communication channel, as a plist. It must return a string or
1879 (defvar org-export-filter-export-snippet-functions nil
1880 "List of functions applied to a transcoded export-snippet.
1881 Each filter is called with three arguments: the transcoded
1882 export-snippet, as a string, the back-end, as a symbol, and the
1883 communication channel, as a plist. It must return a string or
1886 (defvar org-export-filter-footnote-reference-functions nil
1887 "List of functions applied to a transcoded footnote-reference.
1888 Each filter is called with three arguments: the transcoded
1889 footnote-reference, as a string, the back-end, as a symbol, and
1890 the communication channel, as a plist. It must return a string
1893 (defvar org-export-filter-inline-babel-call-functions nil
1894 "List of functions applied to a transcoded inline-babel-call.
1895 Each filter is called with three arguments: the transcoded
1896 inline-babel-call, as a string, the back-end, as a symbol, and
1897 the communication channel, as a plist. It must return a string
1900 (defvar org-export-filter-inline-src-block-functions nil
1901 "List of functions applied to a transcoded inline-src-block.
1902 Each filter is called with three arguments: the transcoded
1903 inline-src-block, as a string, the back-end, as a symbol, and the
1904 communication channel, as a plist. It must return a string or
1907 (defvar org-export-filter-latex-fragment-functions nil
1908 "List of functions applied to a transcoded latex-fragment.
1909 Each filter is called with three arguments: the transcoded
1910 latex-fragment, as a string, the back-end, as a symbol, and the
1911 communication channel, as a plist. It must return a string or
1914 (defvar org-export-filter-line-break-functions nil
1915 "List of functions applied to a transcoded line-break.
1916 Each filter is called with three arguments: the transcoded
1917 line-break, as a string, the back-end, as a symbol, and the
1918 communication channel, as a plist. It must return a string or
1921 (defvar org-export-filter-link-functions nil
1922 "List of functions applied to a transcoded link.
1923 Each filter is called with three arguments: the transcoded link,
1924 as a string, the back-end, as a symbol, and the communication
1925 channel, as a plist. It must return a string or nil.")
1927 (defvar org-export-filter-macro-functions nil
1928 "List of functions applied to a transcoded macro.
1929 Each filter is called with three arguments: the transcoded macro,
1930 as a string, the back-end, as a symbol, and the communication
1931 channel, as a plist. It must return a string or nil.")
1933 (defvar org-export-filter-radio-target-functions nil
1934 "List of functions applied to a transcoded radio-target.
1935 Each filter is called with three arguments: the transcoded
1936 radio-target, as a string, the back-end, as a symbol, and the
1937 communication channel, as a plist. It must return a string or
1940 (defvar org-export-filter-statistics-cookie-functions nil
1941 "List of functions applied to a transcoded statistics-cookie.
1942 Each filter is called with three arguments: the transcoded
1943 statistics-cookie, as a string, the back-end, as a symbol, and
1944 the communication channel, as a plist. It must return a string
1947 (defvar org-export-filter-subscript-functions nil
1948 "List of functions applied to a transcoded subscript.
1949 Each filter is called with three arguments: the transcoded
1950 subscript, as a string, the back-end, as a symbol, and the
1951 communication channel, as a plist. It must return a string or
1954 (defvar org-export-filter-superscript-functions nil
1955 "List of functions applied to a transcoded superscript.
1956 Each filter is called with three arguments: the transcoded
1957 superscript, as a string, the back-end, as a symbol, and the
1958 communication channel, as a plist. It must return a string or
1961 (defvar org-export-filter-target-functions nil
1962 "List of functions applied to a transcoded target.
1963 Each filter is called with three arguments: the transcoded
1964 target, as a string, the back-end, as a symbol, and the
1965 communication channel, as a plist. It must return a string or
1968 (defvar org-export-filter-time-stamp-functions nil
1969 "List of functions applied to a transcoded time-stamp.
1970 Each filter is called with three arguments: the transcoded
1971 time-stamp, as a string, the back-end, as a symbol, and the
1972 communication channel, as a plist. It must return a string or
1975 (defvar org-export-filter-verbatim-functions nil
1976 "List of functions applied to a transcoded verbatim.
1977 Each filter is called with three arguments: the transcoded
1978 verbatim, as a string, the back-end, as a symbol, and the
1979 communication channel, as a plist. It must return a string or
1982 (defun org-export-filter-apply-functions (filters value backend info
)
1983 "Call every function in FILTERS with arguments VALUE, BACKEND and INFO.
1984 Functions are called in a LIFO fashion, to be sure that developer
1985 specified filters, if any, are called first."
1986 (loop for filter in filters
1987 if
(not value
) return nil else
1988 do
(setq value
(funcall filter value backend info
)))
1991 (defun org-export-install-filters (backend info
)
1992 "Install filters properties in communication channel.
1994 BACKEND is a symbol specifying which back-end specific filters to
1995 install, if any. INFO is a plist containing the current
1996 communication channel.
1998 Return the updated communication channel."
2000 ;; Install user defined filters with `org-export-filters-alist'.
2002 (setq plist
(plist-put plist
(car p
) (eval (cdr p
)))))
2003 org-export-filters-alist
)
2004 ;; Prepend back-end specific filters to that list.
2005 (let ((back-end-filters (intern (format "org-%s-filters-alist" backend
))))
2006 (when (boundp back-end-filters
)
2008 ;; Single values get consed, lists are prepended.
2009 (let ((key (car p
)) (value (cdr p
)))
2014 (if (atom value
) (cons value
(plist-get plist key
))
2015 (append value
(plist-get plist key
))))))))
2016 (eval back-end-filters
))))
2017 ;; Return new communication channel.
2018 (org-combine-plists info plist
)))
2024 ;; This is the room for the main function, `org-export-as', along with
2025 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2026 ;; They differ only by the way they output the resulting code.
2028 ;; `org-export-output-file-name' is an auxiliary function meant to be
2029 ;; used with `org-export-to-file'. With a given extension, it tries
2030 ;; to provide a canonical file name to write export output to.
2032 ;; Note that `org-export-as' doesn't really parse the current buffer,
2033 ;; but a copy of it (with the same buffer-local variables and
2034 ;; visibility), where include keywords are expanded and Babel blocks
2035 ;; are executed, if appropriate.
2036 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2038 ;; File inclusion is taken care of by
2039 ;; `org-export-expand-include-keyword' and
2040 ;; `org-export-prepare-file-contents'. Structure wise, including
2041 ;; a whole Org file in a buffer often makes little sense. For
2042 ;; example, if the file contains an headline and the include keyword
2043 ;; was within an item, the item should contain the headline. That's
2044 ;; why file inclusion should be done before any structure can be
2045 ;; associated to the file, that is before parsing.
2047 (defun org-export-as
2048 (backend &optional subtreep visible-only body-only ext-plist noexpand
)
2049 "Transcode current Org buffer into BACKEND code.
2051 If narrowing is active in the current buffer, only transcode its
2054 If a region is active, transcode that region.
2056 When optional argument SUBTREEP is non-nil, transcode the
2057 sub-tree at point, extracting information from the headline
2060 When optional argument VISIBLE-ONLY is non-nil, don't export
2061 contents of hidden elements.
2063 When optional argument BODY-ONLY is non-nil, only return body
2064 code, without preamble nor postamble.
2066 Optional argument EXT-PLIST, when provided, is a property list
2067 with external parameters overriding Org default settings, but
2068 still inferior to file-local settings.
2070 Optional argument NOEXPAND, when non-nil, prevents included files
2071 to be expanded and Babel code to be executed.
2073 Return code as a string."
2076 ;; Narrow buffer to an appropriate region for parsing.
2077 (cond ((org-region-active-p)
2078 (narrow-to-region (region-beginning) (region-end)))
2079 (subtreep (org-narrow-to-subtree)))
2080 ;; Retrieve export options (INFO) and parsed tree (RAW-DATA),
2081 ;; Then options can be completed with tree properties. Note:
2082 ;; Buffer isn't parsed directly. Instead, a temporary copy is
2083 ;; created, where include keywords are expanded and code blocks
2084 ;; are evaluated. RAW-DATA is the parsed tree of the buffer
2085 ;; resulting from that process. Eventually call
2086 ;; `org-export-filter-parse-tree-functions'.
2087 (goto-char (point-min))
2088 (let ((info (org-export-get-environment backend subtreep ext-plist
)))
2089 ;; Remove subtree's headline from contents if subtree mode is
2091 (when subtreep
(forward-line) (narrow-to-region (point) (point-max)))
2092 ;; Install filters in communication channel.
2093 (setq info
(org-export-install-filters backend info
))
2095 (org-export-filter-apply-functions
2096 (plist-get info
:filter-parse-tree
)
2097 ;; If NOEXPAND is non-nil, simply parse current
2098 ;; visible part of buffer.
2099 (if noexpand
(org-element-parse-buffer nil visible-only
)
2100 (org-export-with-current-buffer-copy
2101 (org-export-expand-include-keyword)
2102 (let ((org-current-export-file (current-buffer)))
2103 (org-export-blocks-preprocess))
2104 (org-element-parse-buffer nil visible-only
)))
2106 ;; Complete communication channel with tree properties.
2110 (org-export-collect-tree-properties raw-data info backend
)))
2111 ;; Transcode RAW-DATA. Also call
2112 ;; `org-export-filter-final-output-functions'.
2113 (let* ((body (org-element-normalize-string
2114 (org-export-data raw-data backend info
)))
2115 (template (intern (format "org-%s-template" backend
)))
2116 (output (org-export-filter-apply-functions
2117 (plist-get info
:filter-final-output
)
2118 (if (or (not (fboundp template
)) body-only
) body
2119 (funcall template body info
))
2121 ;; Maybe add final OUTPUT to kill ring before returning it.
2122 (when org-export-copy-to-kill-ring
(org-kill-new output
))
2125 (defun org-export-to-buffer
2126 (backend buffer
&optional subtreep visible-only body-only ext-plist noexpand
)
2127 "Call `org-export-as' with output to a specified buffer.
2129 BACKEND is the back-end used for transcoding, as a symbol.
2131 BUFFER is the output buffer. If it already exists, it will be
2132 erased first, otherwise, it will be created.
2134 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2135 and NOEXPAND are similar to those used in `org-export-as', which
2139 (let ((out (org-export-as
2140 backend subtreep visible-only body-only ext-plist noexpand
))
2141 (buffer (get-buffer-create buffer
)))
2142 (with-current-buffer buffer
2145 (goto-char (point-min)))
2148 (defun org-export-to-file
2149 (backend file
&optional subtreep visible-only body-only ext-plist noexpand
)
2150 "Call `org-export-as' with output to a specified file.
2152 BACKEND is the back-end used for transcoding, as a symbol. FILE
2153 is the name of the output file, as a string.
2155 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2156 and NOEXPAND are similar to those used in `org-export-as', which
2159 Return output file's name."
2160 ;; Checks for FILE permissions. `write-file' would do the same, but
2161 ;; we'd rather avoid needless transcoding of parse tree.
2162 (unless (file-writable-p file
) (error "Output file not writable"))
2163 ;; Insert contents to a temporary buffer and write it to FILE.
2164 (let ((out (org-export-as
2165 backend subtreep visible-only body-only ext-plist noexpand
)))
2168 (let ((coding-system-for-write org-export-coding-system
))
2169 (write-file file
))))
2170 ;; Return full path.
2173 (defun org-export-output-file-name (extension &optional subtreep pub-dir
)
2174 "Return output file's name according to buffer specifications.
2176 EXTENSION is a string representing the output file extension,
2177 with the leading dot.
2179 With a non-nil optional argument SUBTREEP, try to determine
2180 output file's name by looking for \"EXPORT_FILE_NAME\" property
2181 of subtree at point.
2183 When optional argument PUB-DIR is set, use it as the publishing
2186 Return file name as a string, or nil if it couldn't be
2189 ;; File name may come from EXPORT_FILE_NAME subtree property,
2190 ;; assuming point is at beginning of said sub-tree.
2191 (file-name-sans-extension
2196 (org-back-to-heading (not visible-only
)) (point)))
2197 "EXPORT_FILE_NAME" t
))
2198 ;; File name may be extracted from buffer's associated
2200 (buffer-file-name (buffer-base-buffer))
2201 ;; Can't determine file name on our own: Ask user.
2202 (let ((read-file-name-function
2203 (and org-completion-use-ido
'ido-read-file-name
)))
2205 "Output file: " pub-dir nil nil nil
2207 (string= (file-name-extension name t
) extension
))))))))
2208 ;; Build file name. Enforce EXTENSION over whatever user may have
2209 ;; come up with. PUB-DIR, if defined, always has precedence over
2210 ;; any provided path.
2213 (concat (file-name-as-directory pub-dir
)
2214 (file-name-nondirectory base-name
)
2216 ((string= (file-name-nondirectory base-name
) base-name
)
2217 (concat (file-name-as-directory ".") base-name extension
))
2218 (t (concat base-name extension
)))))
2220 (defmacro org-export-with-current-buffer-copy
(&rest body
)
2221 "Apply BODY in a copy of the current buffer.
2223 The copy preserves local variables and visibility of the original
2226 Point is at buffer's beginning when BODY is applied."
2227 (org-with-gensyms (original-buffer offset buffer-string overlays
)
2228 `(let ((,original-buffer
,(current-buffer))
2229 (,offset
,(1- (point-min)))
2230 (,buffer-string
,(buffer-string))
2232 'copy-overlay
(overlays-in (point-min) (point-max)))))
2234 (let ((buffer-invisibility-spec nil
))
2235 (org-clone-local-variables
2237 "^\\(org-\\|orgtbl-\\|major-mode$\\|outline-\\(regexp\\|level\\)$\\)")
2238 (insert ,buffer-string
)
2242 (- (overlay-start ov
) ,offset
)
2243 (- (overlay-end ov
) ,offset
)
2246 (goto-char (point-min))
2248 (def-edebug-spec org-export-with-current-buffer-copy
(body))
2250 (defun org-export-expand-include-keyword (&optional included dir
)
2251 "Expand every include keyword in buffer.
2252 Optional argument INCLUDED is a list of included file names along
2253 with their line restriction, when appropriate. It is used to
2254 avoid infinite recursion. Optional argument DIR is the current
2255 working directory. It is used to properly resolve relative
2257 (let ((case-fold-search t
))
2258 (goto-char (point-min))
2259 (while (re-search-forward "^[ \t]*#\\+INCLUDE: \\(.*\\)" nil t
)
2260 (when (eq (org-element-type (save-match-data (org-element-at-point)))
2263 ;; Extract arguments from keyword's value.
2264 (let* ((value (match-string 1))
2265 (ind (org-get-indentation))
2266 (file (and (string-match "^\"\\(\\S-+\\)\"" value
)
2267 (prog1 (expand-file-name (match-string 1 value
) dir
)
2268 (setq value
(replace-match "" nil nil value
)))))
2271 ":lines +\"\\(\\(?:[0-9]+\\)?-\\(?:[0-9]+\\)?\\)\"" value
)
2272 (prog1 (match-string 1 value
)
2273 (setq value
(replace-match "" nil nil value
)))))
2274 (env (cond ((string-match "\\<example\\>" value
) 'example
)
2275 ((string-match "\\<src\\(?: +\\(.*\\)\\)?" value
)
2276 (match-string 1 value
))))
2277 ;; Minimal level of included file defaults to the child
2278 ;; level of the current headline, if any, or one. It
2279 ;; only applies is the file is meant to be included as
2283 (if (string-match ":minlevel +\\([0-9]+\\)" value
)
2284 (prog1 (string-to-number (match-string 1 value
))
2285 (setq value
(replace-match "" nil nil value
)))
2286 (let ((cur (org-current-level)))
2287 (if cur
(1+ (org-reduced-level cur
)) 1))))))
2289 (delete-region (point) (progn (forward-line) (point)))
2291 ((not (file-readable-p file
)) (error "Cannot include file %s" file
))
2292 ;; Check if files has already been parsed. Look after
2293 ;; inclusion lines too, as different parts of the same file
2294 ;; can be included too.
2295 ((member (list file lines
) included
)
2296 (error "Recursive file inclusion: %s" file
))
2301 (let ((ind-str (make-string ind ?
))
2303 ;; Protect sensitive contents with commas.
2304 (replace-regexp-in-string
2305 "\\(^\\)\\([*]\\|[ \t]*#\\+\\)" ","
2306 (org-export-prepare-file-contents file lines
)
2308 (format "%s#+BEGIN_EXAMPLE\n%s%s#+END_EXAMPLE\n"
2309 ind-str contents ind-str
))))
2312 (let ((ind-str (make-string ind ?
))
2314 ;; Protect sensitive contents with commas.
2315 (replace-regexp-in-string
2316 (if (string= env
"org") "\\(^\\)\\(.\\)"
2317 "\\(^\\)\\([*]\\|[ \t]*#\\+\\)") ","
2318 (org-export-prepare-file-contents file lines
)
2320 (format "%s#+BEGIN_SRC %s\n%s%s#+END_SRC\n"
2321 ind-str env contents ind-str
))))
2327 (org-export-prepare-file-contents file lines ind minlevel
))
2328 (org-export-expand-include-keyword
2329 (cons (list file lines
) included
)
2330 (file-name-directory file
))
2331 (buffer-string))))))))))))
2333 (defun org-export-prepare-file-contents (file &optional lines ind minlevel
)
2334 "Prepare the contents of FILE for inclusion and return them as a string.
2336 When optional argument LINES is a string specifying a range of
2337 lines, include only those lines.
2339 Optional argument IND, when non-nil, is an integer specifying the
2340 global indentation of returned contents. Since its purpose is to
2341 allow an included file to stay in the same environment it was
2342 created \(i.e. a list item), it doesn't apply past the first
2343 headline encountered.
2345 Optional argument MINLEVEL, when non-nil, is an integer
2346 specifying the level that any top-level headline in the included
2349 (insert-file-contents file
)
2351 (let* ((lines (split-string lines
"-"))
2352 (lbeg (string-to-number (car lines
)))
2353 (lend (string-to-number (cadr lines
)))
2354 (beg (if (zerop lbeg
) (point-min)
2355 (goto-char (point-min))
2356 (forward-line (1- lbeg
))
2358 (end (if (zerop lend
) (point-max)
2359 (goto-char (point-min))
2360 (forward-line (1- lend
))
2362 (narrow-to-region beg end
)))
2363 ;; Remove blank lines at beginning and end of contents. The logic
2364 ;; behind that removal is that blank lines around include keyword
2365 ;; override blank lines in included file.
2366 (goto-char (point-min))
2367 (org-skip-whitespace)
2369 (delete-region (point-min) (point))
2370 (goto-char (point-max))
2371 (skip-chars-backward " \r\t\n")
2373 (delete-region (point) (point-max))
2374 ;; If IND is set, preserve indentation of include keyword until
2375 ;; the first headline encountered.
2377 (unless (eq major-mode
'org-mode
) (org-mode))
2378 (goto-char (point-min))
2379 (let ((ind-str (make-string ind ?
)))
2380 (while (not (or (eobp) (looking-at org-outline-regexp-bol
)))
2381 ;; Do not move footnote definitions out of column 0.
2382 (unless (and (looking-at org-footnote-definition-re
)
2383 (eq (org-element-type (org-element-at-point))
2384 'footnote-definition
))
2387 ;; When MINLEVEL is specified, compute minimal level for headlines
2388 ;; in the file (CUR-MIN), and remove stars to each headline so
2389 ;; that headlines with minimal level have a level of MINLEVEL.
2391 (unless (eq major-mode
'org-mode
) (org-mode))
2392 (let ((levels (org-map-entries
2393 (lambda () (org-reduced-level (org-current-level))))))
2395 (let ((offset (- minlevel
(apply 'min levels
))))
2396 (unless (zerop offset
)
2397 (when org-odd-levels-only
(setq offset
(* offset
2)))
2398 ;; Only change stars, don't bother moving whole
2401 (lambda () (if (< offset
0) (delete-char (abs offset
))
2402 (insert (make-string offset ?
*))))))))))
2406 ;;; Tools For Back-Ends
2408 ;; A whole set of tools is available to help build new exporters. Any
2409 ;; function general enough to have its use across many back-ends
2410 ;; should be added here.
2412 ;; As of now, functions operating on footnotes, headlines, links,
2413 ;; macros, references, src-blocks, tables and tables of contents are
2416 ;;;; For Export Snippets
2418 ;; Every export snippet is transmitted to the back-end. Though, the
2419 ;; latter will only retain one type of export-snippet, ignoring
2420 ;; others, based on the former's target back-end. The function
2421 ;; `org-export-snippet-backend' returns that back-end for a given
2424 (defun org-export-snippet-backend (export-snippet)
2425 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2426 Translation, with `org-export-snippet-translation-alist', is
2428 (let ((back-end (org-element-property :back-end export-snippet
)))
2430 (or (cdr (assoc back-end org-export-snippet-translation-alist
))
2436 ;; `org-export-collect-footnote-definitions' is a tool to list
2437 ;; actually used footnotes definitions in the whole parse tree, or in
2438 ;; an headline, in order to add footnote listings throughout the
2441 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2442 ;; back-ends, when they need to attach the footnote definition only to
2443 ;; the first occurrence of the corresponding label.
2445 ;; `org-export-get-footnote-definition' and
2446 ;; `org-export-get-footnote-number' provide easier access to
2447 ;; additional information relative to a footnote reference.
2449 (defun org-export-collect-footnote-definitions (data info
)
2450 "Return an alist between footnote numbers, labels and definitions.
2452 DATA is the parse tree from which definitions are collected.
2453 INFO is the plist used as a communication channel.
2455 Definitions are sorted by order of references. They either
2456 appear as Org data \(transcoded with `org-export-data'\) or as
2457 a secondary string for inlined footnotes \(transcoded with
2458 `org-export-secondary-string'\). Unreferenced definitions are
2461 ;; Collect seen references in REFS.
2463 data
'footnote-reference
2465 (when (org-export-footnote-first-reference-p footnote info
)
2466 (list (org-export-get-footnote-number footnote info
)
2467 (org-element-property :label footnote
)
2468 (org-export-get-footnote-definition footnote info
))))
2471 (defun org-export-footnote-first-reference-p (footnote-reference info
)
2472 "Non-nil when a footnote reference is the first one for its label.
2474 FOOTNOTE-REFERENCE is the footnote reference being considered.
2475 INFO is the plist used as a communication channel."
2476 (let ((label (org-element-property :label footnote-reference
)))
2481 (plist-get info
:parse-tree
) 'footnote-reference
2483 (when (string= (org-element-property :label footnote
) label
)
2485 info
'first-match
)))))
2487 (defun org-export-get-footnote-definition (footnote-reference info
)
2488 "Return definition of FOOTNOTE-REFERENCE as parsed data.
2489 INFO is the plist used as a communication channel."
2490 (let ((label (org-element-property :label footnote-reference
)))
2491 (or (org-element-property :inline-definition footnote-reference
)
2492 (cdr (assoc label
(plist-get info
:footnote-definition-alist
))))))
2494 (defun org-export-get-footnote-number (footnote info
)
2495 "Return number associated to a footnote.
2497 FOOTNOTE is either a footnote reference or a footnote definition.
2498 INFO is the plist used as a communication channel."
2499 (let ((label (org-element-property :label footnote
)) seen-refs
)
2501 (plist-get info
:parse-tree
) 'footnote-reference
2503 (let ((fn-lbl (org-element-property :label fn
)))
2505 ((and (not fn-lbl
) (equal fn footnote
)) (1+ (length seen-refs
)))
2506 ((and label
(string= label fn-lbl
)) (1+ (length seen-refs
)))
2507 ;; Anonymous footnote: it's always a new one. Also, be sure
2508 ;; to return nil from the `cond' so `first-match' doesn't
2509 ;; get us out of the loop.
2510 ((not fn-lbl
) (push 'inline seen-refs
) nil
)
2511 ;; Label not seen so far: add it so SEEN-REFS. Again,
2512 ;; return nil to stay in the loop.
2513 ((not (member fn-lbl seen-refs
)) (push fn-lbl seen-refs
) nil
))))
2514 info
'first-match
)))
2519 ;; `org-export-get-relative-level' is a shortcut to get headline
2520 ;; level, relatively to the lower headline level in the parsed tree.
2522 ;; `org-export-get-headline-number' returns the section number of an
2523 ;; headline, while `org-export-number-to-roman' allows to convert it
2524 ;; to roman numbers.
2526 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
2527 ;; `org-export-last-sibling-p' are three useful predicates when it
2528 ;; comes to fulfill the `:headline-levels' property.
2530 (defun org-export-get-relative-level (headline info
)
2531 "Return HEADLINE relative level within current parsed tree.
2532 INFO is a plist holding contextual information."
2533 (+ (org-element-property :level headline
)
2534 (or (plist-get info
:headline-offset
) 0)))
2536 (defun org-export-low-level-p (headline info
)
2537 "Non-nil when HEADLINE is considered as low level.
2539 INFO is a plist used as a communication channel.
2541 A low level headlines has a relative level greater than
2542 `:headline-levels' property value.
2544 Return value is the difference between HEADLINE relative level
2545 and the last level being considered as high enough, or nil."
2546 (let ((limit (plist-get info
:headline-levels
)))
2547 (when (wholenump limit
)
2548 (let ((level (org-export-get-relative-level headline info
)))
2549 (and (> level limit
) (- level limit
))))))
2551 (defun org-export-get-headline-number (headline info
)
2552 "Return HEADLINE numbering as a list of numbers.
2553 INFO is a plist holding contextual information."
2554 (cdr (assoc headline
(plist-get info
:headline-numbering
))))
2556 (defun org-export-number-to-roman (n)
2557 "Convert integer N into a roman numeral."
2558 (let ((roman '((1000 .
"M") (900 .
"CM") (500 .
"D") (400 .
"CD")
2559 ( 100 .
"C") ( 90 .
"XC") ( 50 .
"L") ( 40 .
"XL")
2560 ( 10 .
"X") ( 9 .
"IX") ( 5 .
"V") ( 4 .
"IV")
2564 (number-to-string n
)
2566 (if (>= n
(caar roman
))
2567 (setq n
(- n
(caar roman
))
2568 res
(concat res
(cdar roman
)))
2572 (defun org-export-first-sibling-p (headline info
)
2573 "Non-nil when HEADLINE is the first sibling in its sub-tree.
2574 INFO is the plist used as a communication channel."
2575 (not (eq (org-element-type (org-export-get-previous-element headline info
))
2578 (defun org-export-last-sibling-p (headline info
)
2579 "Non-nil when HEADLINE is the last sibling in its sub-tree.
2580 INFO is the plist used as a communication channel."
2581 (not (org-export-get-next-element headline info
)))
2586 ;; `org-export-solidify-link-text' turns a string into a safer version
2587 ;; for links, replacing most non-standard characters with hyphens.
2589 ;; `org-export-get-coderef-format' returns an appropriate format
2590 ;; string for coderefs.
2592 ;; `org-export-inline-image-p' returns a non-nil value when the link
2593 ;; provided should be considered as an inline image.
2595 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
2596 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
2597 ;; returns an appropriate unique identifier when found, or nil.
2599 ;; `org-export-resolve-id-link' returns the first headline with
2600 ;; specified id or custom-id in parse tree, or nil when none was
2603 ;; `org-export-resolve-coderef' associates a reference to a line
2604 ;; number in the element it belongs, or returns the reference itself
2605 ;; when the element isn't numbered.
2607 (defun org-export-solidify-link-text (s)
2608 "Take link text S and make a safe target out of it."
2610 (mapconcat 'identity
(org-split-string s
"[^a-zA-Z0-9_.-]+") "-")))
2612 (defun org-export-get-coderef-format (path desc
)
2613 "Return format string for code reference link.
2614 PATH is the link path. DESC is its description."
2616 (cond ((string-match (regexp-quote (concat "(" path
")")) desc
)
2617 (replace-match "%s" t t desc
))
2618 ((string= desc
"") "%s")
2621 (defun org-export-inline-image-p (link &optional rules
)
2622 "Non-nil if LINK object points to an inline image.
2624 Optional argument is a set of RULES defining inline images. It
2625 is an alist where associations have the following shape:
2629 Applying a rule means apply REGEXP against LINK's path when its
2630 type is TYPE. The function will return a non-nil value if any of
2631 the provided rules is non-nil. The default rule is
2632 `org-export-default-inline-image-rule'.
2634 This only applies to links without a description."
2635 (and (not (org-element-contents link
))
2636 (let ((case-fold-search t
)
2637 (rules (or rules org-export-default-inline-image-rule
)))
2640 (and (string= (org-element-property :type link
) (car rule
))
2641 (string-match (cdr rule
)
2642 (org-element-property :path link
))))
2645 (defun org-export-resolve-fuzzy-link (link info
)
2646 "Return LINK destination.
2648 INFO is a plist holding contextual information.
2650 Return value can be an object, an element, or nil:
2652 - If LINK path exactly matches any target, return the target
2655 - If LINK path exactly matches any headline name, return that
2656 element. If more than one headline share that name, priority
2657 will be given to the one with the closest common ancestor, if
2658 any, or the first one in the parse tree otherwise.
2660 - Otherwise, return nil.
2662 Assume LINK type is \"fuzzy\"."
2663 (let ((path (org-element-property :path link
)))
2664 ;; Link points to a target: return it.
2665 (or (loop for target in
(plist-get info
:target-list
)
2666 when
(string= (org-element-property :raw-value target
) path
)
2668 ;; Link either points to an headline or nothing. Try to find
2669 ;; the source, with priority given to headlines with the closest
2670 ;; common ancestor. If such candidate is found, return its
2671 ;; beginning position as an unique identifier, otherwise return
2673 (let ((find-headline
2675 ;; Return first headline whose `:raw-value' property
2676 ;; is NAME in parse tree DATA, or nil.
2682 (org-element-property :raw-value headline
)
2685 info
'first-match
)))))
2686 ;; Search among headlines sharing an ancestor with link,
2687 ;; from closest to farthest.
2691 (when (eq (org-element-type parent
) 'headline
)
2692 (let ((foundp (funcall find-headline path parent
)))
2693 (when foundp
(throw 'exit foundp
)))))
2694 (org-export-get-genealogy link info
)) nil
)
2695 ;; No match with a common ancestor: try the full parse-tree.
2696 (funcall find-headline path
(plist-get info
:parse-tree
)))))))
2698 (defun org-export-resolve-id-link (link info
)
2699 "Return headline referenced as LINK destination.
2701 INFO is a plist used as a communication channel.
2703 Return value can be an headline element or nil. Assume LINK type
2704 is either \"id\" or \"custom-id\"."
2705 (let ((id (org-element-property :path link
)))
2707 (plist-get info
:parse-tree
) 'headline
2709 (when (or (string= (org-element-property :id headline
) id
)
2710 (string= (org-element-property :custom-id headline
) id
))
2712 info
'first-match
)))
2714 (defun org-export-resolve-ref-link (link info
)
2715 "Return element referenced as LINK destination.
2717 INFO is a plist used as a communication channel.
2719 Assume LINK type is \"ref\" and. Return value is the first
2720 element whose `:name' property matches LINK's `:path', or nil."
2721 (let ((name (org-element-property :path link
)))
2723 (plist-get info
:parse-tree
) org-element-all-elements
2725 (when (string= (org-element-property :name el
) name
) el
))
2726 info
'first-match
)))
2728 (defun org-export-resolve-coderef (ref info
)
2729 "Resolve a code reference REF.
2731 INFO is a plist used as a communication channel.
2733 Return associated line number in source code, or REF itself,
2734 depending on src-block or example element's switches."
2736 (plist-get info
:parse-tree
) '(src-block example
)
2738 (let ((switches (or (org-element-property :switches el
) "")))
2740 (insert (org-trim (org-element-property :value el
)))
2741 ;; Build reference regexp.
2743 (or (and (string-match "-l +\"\\([^\"\n]+\\)\"" switches
)
2744 (match-string 1 switches
))
2745 org-coderef-label-format
))
2747 (format "^.*?\\S-.*?\\([ \t]*\\(%s\\)\\)[ \t]*$"
2748 (replace-regexp-in-string "%s" ref label nil t
))))
2749 ;; Element containing REF is found. Only associate REF to
2750 ;; a line number if element has "+n" or "-n" and "-k" or
2751 ;; "-r" as switches. When it has "+n", count accumulated
2752 ;; locs before, too.
2753 (when (re-search-backward ref-re nil t
)
2755 ((not (string-match "-[kr]\\>" switches
)) ref
)
2756 ((string-match "-n\\>" switches
) (line-number-at-pos))
2757 ((string-match "\\+n\\>" switches
)
2758 (+ (org-export-get-loc el info
) (line-number-at-pos)))
2765 ;; `org-export-expand-macro' simply takes care of expanding macros.
2767 (defun org-export-expand-macro (macro info
)
2768 "Expand MACRO and return it as a string.
2769 INFO is a plist holding export options."
2770 (let* ((key (org-element-property :key macro
))
2771 (args (org-element-property :args macro
))
2772 ;; User's macros are stored in the communication channel with
2773 ;; a ":macro-" prefix. If it's a string leave it as-is.
2774 ;; Otherwise, it's a secondary string that needs to be
2775 ;; expanded recursively.
2777 (let ((val (plist-get info
(intern (format ":macro-%s" key
)))))
2778 (if (stringp val
) val
2779 (org-export-secondary-string
2780 val
(plist-get info
:back-end
) info
)))))
2781 ;; Replace arguments in VALUE.
2783 (while (string-match "\\$\\([0-9]+\\)" value s
)
2784 (setq s
(1+ (match-beginning 0))
2785 n
(string-to-number (match-string 1 value
)))
2786 (and (>= (length args
) n
)
2787 (setq value
(replace-match (nth (1- n
) args
) t t value
)))))
2788 ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
2789 (when (string-match "\\`(eval\\>" value
)
2790 (setq value
(eval (read value
))))
2792 (format "%s" (or value
""))))
2797 ;; `org-export-get-ordinal' associates a sequence number to any object
2800 (defun org-export-get-ordinal
2801 (element info
&optional types within-section predicate
)
2802 "Return ordinal number of an element or object.
2804 ELEMENT is the element or object considered. INFO is the plist
2805 used as a communication channel.
2807 Optional argument TYPES, when non-nil, is a list of element or
2808 object types, as symbols, that should also be counted in.
2809 Otherwise, only provided element's type is considered.
2811 When optional argument WITHIN-SECTION is non-nil, narrow counting
2812 to the section containing ELEMENT.
2814 Optional argument PREDICATE is a function returning a non-nil
2815 value if the current element or object should be counted in. It
2816 accepts one argument: the element or object being considered.
2817 This argument allows to count only a certain type of objects,
2818 like inline images, which are a subset of links \(in that case,
2819 `org-export-inline-image-p' might be an useful predicate\)."
2821 ;; Determine if search should apply to current section, in
2822 ;; which case it should be retrieved first, or to full parse
2823 ;; tree. As a special case, an element or object without
2824 ;; a parent headline will also trigger a full search,
2825 ;; notwithstanding WITHIN-SECTION value.
2827 (if (not within-section
) (plist-get info
:parse-tree
)
2828 (or (org-export-get-parent-headline element info
)
2829 (plist-get info
:parse-tree
)))))
2830 ;; Increment counter until ELEMENT is found again.
2832 data
(or types
(org-element-type element
))
2835 ((equal element el
) (1+ counter
))
2836 ((not predicate
) (incf counter
) nil
)
2837 ((funcall predicate el
) (incf counter
) nil
)))
2838 info
'first-match
)))
2843 ;; `org-export-get-loc' counts number of code lines accumulated in
2844 ;; src-block or example-block elements with a "+n" switch until
2845 ;; a given element, excluded. Note: "-n" switches reset that count.
2847 ;; `org-export-handle-code' takes care of line numbering and reference
2848 ;; cleaning in source code, when appropriate.
2850 (defun org-export-get-loc (element info
)
2851 "Return accumulated lines of code up to ELEMENT.
2853 INFO is the plist used as a communication channel.
2855 ELEMENT is excluded from count."
2858 (plist-get info
:parse-tree
)
2859 `(src-block example-block
,(org-element-type element
))
2862 ;; ELEMENT is reached: Quit the loop.
2863 ((equal el element
) t
)
2864 ;; Only count lines from src-block and example-block elements
2865 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
2866 ((not (memq (org-element-type el
) '(src-block example-block
))) nil
)
2867 ((let ((switches (org-element-property :switches el
)))
2868 (when (and switches
(string-match "\\([-+]\\)n\\>" switches
))
2869 ;; Accumulate locs or reset them.
2870 (let ((accumulatep (string= (match-string 1 switches
) "-"))
2871 (lines (org-count-lines
2872 (org-trim (org-element-property :value el
)))))
2873 (setq loc
(if accumulatep lines
(+ loc lines
))))))
2874 ;; Return nil to stay in the loop.
2880 (defun org-export-handle-code (element info
&optional num-fmt ref-fmt delayed
)
2881 "Handle line numbers and code references in ELEMENT.
2883 ELEMENT has either a `src-block' an `example-block' type. INFO
2884 is a plist used as a communication channel.
2886 If optional argument NUM-FMT is a string, it will be used as
2887 a format string for numbers at beginning of each line.
2889 If optional argument REF-FMT is a string, it will be used as
2890 a format string for each line of code containing a reference.
2892 When optional argument DELAYED is non-nil, `org-loc' and
2893 `org-coderef' properties, set to an adequate value, are applied
2894 to, respectively, numbered lines and lines with a reference. No
2895 line numbering is done and all references are stripped from the
2896 resulting string. Both NUM-FMT and REF-FMT arguments are ignored
2899 Return new code as a string."
2900 (let* ((switches (or (org-element-property :switches element
) ""))
2901 (code (org-element-property :value element
))
2902 (numberp (string-match "[-+]n\\>" switches
))
2903 (accumulatep (string-match "\\+n\\>" switches
))
2904 ;; Initialize loc counter when any kind of numbering is
2907 (accumulatep (org-export-get-loc element info
))
2909 ;; Get code and clean it. Remove blank lines at its
2910 ;; beginning and end. Also remove protective commas.
2911 (preserve-indent-p (or org-src-preserve-indentation
2912 (string-match "-i\\>" switches
)))
2913 (replace-labels (when (string-match "-r\\>" switches
)
2914 (if (string-match "-k\\>" switches
) 'keep t
)))
2915 (code (let ((c (replace-regexp-in-string
2916 "\\`\\([ \t]*\n\\)+" ""
2917 (replace-regexp-in-string
2918 "\\(:?[ \t]*\n\\)*[ \t]*\\'" "\n" code
))))
2919 ;; If appropriate, remove global indentation.
2920 (unless preserve-indent-p
(setq c
(org-remove-indentation c
)))
2921 ;; Free up the protected lines. Note: Org blocks
2922 ;; have commas at the beginning or every line.
2924 (or (org-element-property :language element
) "")
2926 (replace-regexp-in-string "^," "" c
)
2927 (replace-regexp-in-string
2928 "^\\(,\\)\\(:?\\*\\|[ \t]*#\\+\\)" "" c nil nil
1))))
2929 ;; Split code to process it line by line.
2930 (code-lines (org-split-string code
"\n"))
2931 ;; If numbering is active, ensure line numbers will be
2932 ;; correctly padded before applying the format string.
2934 (when (and (not delayed
) numberp
)
2935 (format (if (stringp num-fmt
) num-fmt
"%s: ")
2937 (length (number-to-string
2938 (+ (length code-lines
) total-LOC
)))))))
2939 ;; Get format used for references.
2940 (label-fmt (or (and (string-match "-l +\"\\([^\"\n]+\\)\"" switches
)
2941 (match-string 1 switches
))
2942 org-coderef-label-format
))
2943 ;; Build a regexp matching a loc with a reference.
2944 (with-ref-re (format "^.*?\\S-.*?\\([ \t]*\\(%s\\)\\)[ \t]*$"
2945 (replace-regexp-in-string
2946 "%s" "\\([-a-zA-Z0-9_ ]+\\)" label-fmt nil t
))))
2947 (org-element-normalize-string
2950 ;; Maybe add line number to current line of code (LOC).
2953 (setq loc
(if delayed
(org-add-props loc nil
'org-loc total-LOC
)
2954 (concat (format num-fmt total-LOC
) loc
))))
2955 ;; Take action if at a ref line.
2956 (when (string-match with-ref-re loc
)
2957 (let ((ref (match-string 3 loc
)))
2959 ;; Option "-r" without "-k" removes labels.
2960 ;; A non-nil DELAYED removes labels unconditionally.
2962 (and replace-labels
(not (eq replace-labels
'keep
))))
2963 (replace-match "" nil nil loc
1)
2964 (replace-match (format "(%s)" ref
) nil nil loc
2)))
2965 ;; Store REF in `org-coderef' property if DELAYED asks to.
2966 (cond (delayed (setq loc
(org-add-props loc nil
'org-coderef ref
)))
2967 ;; If REF-FMT is defined, apply it to current LOC.
2968 ((stringp ref-fmt
) (setq loc
(format ref-fmt loc
))))))
2969 ;; Return updated LOC for concatenation.
2976 ;; `org-export-table-format-info' extracts formatting information
2977 ;; (alignment, column groups and presence of a special column) from
2978 ;; a raw table and returns it as a property list.
2980 ;; `org-export-clean-table' cleans the raw table from any Org
2981 ;; table-specific syntax.
2983 (defun org-export-table-format-info (table)
2984 "Extract info from TABLE.
2985 Return a plist whose properties and values are:
2986 `:alignment' vector of strings among \"r\", \"l\" and \"c\",
2987 `:column-groups' vector of symbols among `start', `end', `start-end',
2988 `:row-groups' list of integers representing row groups.
2989 `:special-column-p' non-nil if table has a special column.
2990 `:width' vector of integers representing desired width of
2991 current column, or nil."
2996 (let ((align (vconcat (mapcar (lambda (c) (if c
"r" "l"))
2997 org-table-last-alignment
)))
2998 (width (make-vector (length org-table-last-alignment
) nil
))
2999 (colgroups (make-vector (length org-table-last-alignment
) nil
))
3002 (special-column-p 'empty
))
3004 (if (string-match "^[ \t]*|[-+]+|[ \t]*$" row
)
3006 ;; Determine if a special column is present by looking
3007 ;; for special markers in the first column. More
3008 ;; accurately, the first column is considered special
3009 ;; if it only contains special markers and, maybe,
3011 (setq special-column-p
3013 ((not special-column-p
) nil
)
3014 ((string-match "^[ \t]*| *\\\\?\\([/#!$*_^]\\) *|" row
)
3016 ((string-match "^[ \t]*| +|" row
) special-column-p
))))
3018 ;; Read forced alignment and width information, if any,
3019 ;; and determine final alignment for the table.
3020 ((org-table-cookie-line-p row
)
3022 (mapc (lambda (field)
3024 "<\\([lrc]\\)?\\([0-9]+\\)?>" field
)
3025 (let ((align-data (match-string 1 field
)))
3026 (when align-data
(aset align col align-data
)))
3027 (let ((w-data (match-string 2 field
)))
3029 (aset width col
(string-to-number w-data
)))))
3031 (org-split-string row
"[ \t]*|[ \t]*"))))
3032 ;; Read column groups information.
3033 ((org-table-colgroup-line-p row
)
3035 (mapc (lambda (field)
3037 (cond ((string= "<" field
) 'start
)
3038 ((string= ">" field
) 'end
)
3039 ((string= "<>" field
) 'start-end
)))
3041 (org-split-string row
"[ \t]*|[ \t]*"))))
3043 (t (push row-group rowgroups
))))
3044 (org-split-string table
"\n"))
3046 (list :alignment align
3047 :column-groups colgroups
3048 :row-groups
(reverse rowgroups
)
3049 :special-column-p
(eq special-column-p
'special
)
3052 (defun org-export-clean-table (table specialp
)
3053 "Clean string TABLE from its formatting elements.
3054 Remove any row containing column groups or formatting cookies and
3055 rows starting with a special marker. If SPECIALP is non-nil,
3056 assume the table contains a special formatting column and remove
3058 (let ((rows (org-split-string table
"\n")))
3059 (mapconcat 'identity
3064 ((org-table-colgroup-line-p row
) nil
)
3065 ((org-table-cookie-line-p row
) nil
)
3066 ;; Ignore rows starting with a special marker.
3067 ((string-match "^[ \t]*| *[!_^/$] *|" row
) nil
)
3068 ;; Remove special column.
3070 (or (string-match "^\\([ \t]*\\)|-+\\+" row
)
3071 (string-match "^\\([ \t]*\\)|[^|]*|" row
)))
3072 (replace-match "\\1|" t nil row
))
3078 ;;;; For Tables Of Contents
3080 ;; `org-export-collect-headlines' builds a list of all exportable
3081 ;; headline elements, maybe limited to a certain depth. One can then
3082 ;; easily parse it and transcode it.
3084 ;; Building lists of tables, figures or listings is quite similar.
3085 ;; Once the generic function `org-export-collect-elements' is defined,
3086 ;; `org-export-collect-tables', `org-export-collect-figures' and
3087 ;; `org-export-collect-listings' can be derived from it.
3089 (defun org-export-collect-headlines (info &optional n
)
3090 "Collect headlines in order to build a table of contents.
3092 INFO is a plist used as a communication channel.
3094 When non-nil, optional argument N must be an integer. It
3095 specifies the depth of the table of contents.
3097 Return a list of all exportable headlines as parsed elements."
3099 (plist-get info
:parse-tree
)
3102 ;; Strip contents from HEADLINE.
3103 (let ((relative-level (org-export-get-relative-level headline info
)))
3104 (unless (and n
(> relative-level n
)) headline
)))
3107 (defun org-export-collect-elements (type info
&optional predicate
)
3108 "Collect referenceable elements of a determined type.
3110 TYPE can be a symbol or a list of symbols specifying element
3111 types to search. Only elements with a caption or a name are
3114 INFO is a plist used as a communication channel.
3116 When non-nil, optional argument PREDICATE is a function accepting
3117 one argument, an element of type TYPE. It returns a non-nil
3118 value when that element should be collected.
3120 Return a list of all elements found, in order of appearance."
3122 (plist-get info
:parse-tree
) type
3124 (and (or (org-element-property :caption element
)
3125 (org-element-property :name element
))
3126 (or (not predicate
) (funcall predicate element
))
3129 (defun org-export-collect-tables (info)
3130 "Build a list of tables.
3132 INFO is a plist used as a communication channel.
3134 Return a list of table elements with a caption or a name
3135 affiliated keyword."
3136 (org-export-collect-elements 'table info
))
3138 (defun org-export-collect-figures (info predicate
)
3139 "Build a list of figures.
3141 INFO is a plist used as a communication channel. PREDICATE is
3142 a function which accepts one argument: a paragraph element and
3143 whose return value is non-nil when that element should be
3146 A figure is a paragraph type element, with a caption or a name,
3147 verifying PREDICATE. The latter has to be provided since
3148 a \"figure\" is a vague concept that may depend on back-end.
3150 Return a list of elements recognized as figures."
3151 (org-export-collect-elements 'paragraph info predicate
))
3153 (defun org-export-collect-listings (info)
3154 "Build a list of src blocks.
3156 INFO is a plist used as a communication channel.
3158 Return a list of src-block elements with a caption or a name
3159 affiliated keyword."
3160 (org-export-collect-elements 'src-block info
))
3165 ;; Here are various functions to retrieve information about the
3166 ;; neighbourhood of a given element or object. Neighbours of interest
3167 ;; are direct parent (`org-export-get-parent'), parent headline
3168 ;; (`org-export-get-parent-headline'), parent paragraph
3169 ;; (`org-export-get-parent-paragraph'), previous element or object
3170 ;; (`org-export-get-previous-element') and next element or object
3171 ;; (`org-export-get-next-element').
3173 ;; All of these functions are just a specific use of the more generic
3174 ;; `org-export-get-genealogy', which returns the genealogy relative to
3175 ;; the element or object.
3177 (defun org-export-get-genealogy (blob info
)
3178 "Return genealogy relative to a given element or object.
3179 BLOB is the element or object being considered. INFO is a plist
3180 used as a communication channel."
3181 (let* ((end (org-element-property :end blob
))
3183 (lambda (data genealogy
)
3188 ((equal el blob
) (throw 'exit genealogy
))
3189 ((>= (org-element-property :end el
) end
)
3190 (funcall walk-data el
(cons el genealogy
)))))
3191 (org-element-contents data
)))))
3192 (catch 'exit
(funcall walk-data
(plist-get info
:parse-tree
) nil
) nil
)))
3194 (defun org-export-get-parent (blob info
)
3195 "Return BLOB parent or nil.
3196 BLOB is the element or object considered. INFO is a plist used
3197 as a communication channel."
3198 (car (org-export-get-genealogy blob info
)))
3200 (defun org-export-get-parent-headline (blob info
)
3201 "Return closest parent headline or nil.
3203 BLOB is the element or object being considered. INFO is a plist
3204 used as a communication channel."
3207 (lambda (el) (when (eq (org-element-type el
) 'headline
) (throw 'exit el
)))
3208 (org-export-get-genealogy blob info
))
3211 (defun org-export-get-parent-paragraph (object info
)
3212 "Return parent paragraph or nil.
3214 INFO is a plist used as a communication channel.
3216 Optional argument OBJECT, when provided, is the object to consider.
3217 Otherwise, return the paragraph containing current object.
3219 This is useful for objects, which share attributes with the
3220 paragraph containing them."
3223 (lambda (el) (when (eq (org-element-type el
) 'paragraph
) (throw 'exit el
)))
3224 (org-export-get-genealogy object info
))
3227 (defun org-export-get-previous-element (blob info
)
3228 "Return previous element or object.
3230 BLOB is an element or object. INFO is a plist used as
3231 a communication channel.
3233 Return previous element or object, a string, or nil."
3234 (let ((parent (org-export-get-parent blob info
)))
3235 (cadr (member blob
(reverse (org-element-contents parent
))))))
3237 (defun org-export-get-next-element (blob info
)
3238 "Return next element or object.
3240 BLOB is an element or object. INFO is a plist used as
3241 a communication channel.
3243 Return next element or object, a string, or nil."
3244 (let ((parent (org-export-get-parent blob info
)))
3245 (cadr (member blob
(org-element-contents parent
)))))
3251 ;; `org-export-dispatch' is the standard interactive way to start an
3252 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
3253 ;; for its interface. Most commons back-ends should have an entry in
3256 (defun org-export-dispatch ()
3257 "Export dispatcher for Org mode.
3259 It provides an access to common export related tasks in a buffer.
3260 Its interface comes in two flavours: standard and expert. While
3261 both share the same set of bindings, only the former displays the
3262 valid keys associations. Set `org-export-dispatch-use-expert-ui'
3263 to switch to one or the other.
3265 Return an error if key pressed has no associated command."
3267 (let* ((input (org-export-dispatch-ui
3268 (if (listp org-export-initial-scope
) org-export-initial-scope
3269 (list org-export-initial-scope
))
3270 org-export-dispatch-use-expert-ui
))
3271 (raw-key (car input
))
3272 (optns (cdr input
)))
3273 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
3274 ;; depending on user's key pressed.
3275 (case (if (< raw-key
27) (+ raw-key
96) raw-key
)
3276 ;; Allow to quit with "q" key.
3278 ;; Export with `e-ascii' back-end.
3281 (org-export-to-buffer
3282 'e-ascii
"*Org E-ASCII Export*"
3283 (memq 'subtree optns
) (memq 'visible optns
) (memq 'body optns
)
3285 ,(case raw-key
(?A
'ascii
) (?N
'latin1
) (t 'utf-8
))))))
3286 (with-current-buffer outbuf
(text-mode))
3287 (when org-export-show-temporary-export-buffer
3288 (switch-to-buffer-other-window outbuf
))))
3290 (org-e-ascii-export-to-ascii
3291 (memq 'subtree optns
) (memq 'visible optns
) (memq 'body optns
)
3292 `(:ascii-charset
,(case raw-key
(?a
'ascii
) (?n
'latin1
) (t 'utf-8
)))))
3293 ;; Export with `e-latex' back-end.
3296 (org-export-to-buffer
3297 'e-latex
"*Org E-LaTeX Export*"
3298 (memq 'subtree optns
) (memq 'visible optns
) (memq 'body optns
))))
3299 (with-current-buffer outbuf
(latex-mode))
3300 (when org-export-show-temporary-export-buffer
3301 (switch-to-buffer-other-window outbuf
))))
3302 (?l
(org-e-latex-export-to-latex
3303 (memq 'subtree optns
) (memq 'visible optns
) (memq 'body optns
)))
3304 (?p
(org-e-latex-export-to-pdf
3305 (memq 'subtree optns
) (memq 'visible optns
) (memq 'body optns
)))
3307 (org-e-latex-export-to-pdf
3308 (memq 'subtree optns
) (memq 'visible optns
) (memq 'body optns
))))
3309 ;; Export with `e-html' back-end.
3312 (org-export-to-buffer
3313 'e-html
"*Org E-HTML Export*"
3314 (memq 'subtree optns
) (memq 'visible optns
) (memq 'body optns
))))
3316 (with-current-buffer outbuf
3317 (if (featurep 'nxhtml-mode
) (nxhtml-mode) (nxml-mode)))
3318 (when org-export-show-temporary-export-buffer
3319 (switch-to-buffer-other-window outbuf
))))
3320 (?h
(org-e-html-export-to-html
3321 (memq 'subtree optns
) (memq 'visible optns
) (memq 'body optns
)))
3323 (org-e-html-export-to-html
3324 (memq 'subtree optns
) (memq 'visible optns
) (memq 'body optns
))))
3325 ;; Export with `e-odt' back-end.
3326 (?o
(org-e-odt-export-to-odt
3327 (memq 'subtree optns
) (memq 'visible optns
) (memq 'body optns
)))
3329 (org-e-odt-export-to-odt
3330 (memq 'subtree optns
) (memq 'visible optns
) (memq 'body optns
))))
3331 ;; Publishing facilities
3332 (?F
(org-e-publish-current-file (memq 'force optns
)))
3333 (?P
(org-e-publish-current-project (memq 'force optns
)))
3335 (assoc (org-icompleting-read
3336 "Publish project: " org-e-publish-project-alist nil t
)
3337 org-e-publish-project-alist
)))
3338 (org-e-publish project
(memq 'force optns
))))
3339 (?E
(org-e-publish-all (memq 'force optns
)))
3340 ;; Undefined command.
3341 (t (error "No command associated with key %s"
3342 (char-to-string raw-key
))))))
3344 (defun org-export-dispatch-ui (options expertp
)
3345 "Handle interface for `org-export-dispatch'.
3347 OPTIONS is a list containing current interactive options set for
3348 export. It can contain any of the following symbols:
3349 `body' toggles a body-only export
3350 `subtree' restricts export to current subtree
3351 `visible' restricts export to visible part of buffer.
3352 `force' force publishing files.
3354 EXPERTP, when non-nil, triggers expert UI. In that case, no help
3355 buffer is provided, but indications about currently active
3356 options are given in the prompt. Moreover, \[?] allows to switch
3357 back to standard interface.
3359 Return value is a list with key pressed as CAR and a list of
3360 final interactive export options as CDR."
3362 (format "---- (Options) -------------------------------------------
3364 \[1] Body only: %s [2] Export scope: %s
3365 \[3] Visible only: %s [4] Force publishing: %s
3368 --- (ASCII/Latin-1/UTF-8 Export) -------------------------
3370 \[a/n/u] to TXT file [A/N/U] to temporary buffer
3372 --- (HTML Export) ----------------------------------------
3374 \[h] to HTML file [b] ... and open it
3375 \[H] to temporary buffer
3377 --- (LaTeX Export) ---------------------------------------
3379 \[l] to TEX file [L] to temporary buffer
3380 \[p] to PDF file [d] ... and open it
3382 --- (ODF Export) -----------------------------------------
3384 \[o] to ODT file [O] ... and open it
3386 --- (Publish) --------------------------------------------
3388 \[F] current file [P] current project
3389 \[X] a project [E] every project"
3390 (if (memq 'body options
) "On " "Off")
3391 (if (memq 'subtree options
) "Subtree" "Buffer ")
3392 (if (memq 'visible options
) "On " "Off")
3393 (if (memq 'force options
) "On " "Off")))
3394 (standard-prompt "Export command: ")
3395 (expert-prompt (format "Export command (%s%s%s%s): "
3396 (if (memq 'body options
) "b" "-")
3397 (if (memq 'subtree options
) "s" "-")
3398 (if (memq 'visible options
) "v" "-")
3399 (if (memq 'force options
) "f" "-")))
3402 ;; Read a character from command input, toggling interactive
3403 ;; options when applicable. PROMPT is the displayed prompt,
3406 (let ((key (read-char-exclusive prompt
)))
3408 ;; Ignore non-standard characters (i.e. "M-a").
3409 ((not (characterp key
)) (org-export-dispatch-ui options expertp
))
3410 ;; Help key: Switch back to standard interface if
3411 ;; expert UI was active.
3412 ((eq key ??
) (org-export-dispatch-ui options nil
))
3413 ;; Toggle export options.
3414 ((memq key
'(?
1 ?
2 ?
3 ?
4))
3415 (org-export-dispatch-ui
3416 (let ((option (case key
(?
1 'body
) (?
2 'subtree
) (?
3 'visible
)
3418 (if (memq option options
) (remq option options
)
3419 (cons option options
)))
3421 ;; Action selected: Send key and options back to
3422 ;; `org-export-dispatch'.
3423 (t (cons key options
))))))))
3424 ;; With expert UI, just read key with a fancy prompt. In standard
3425 ;; UI, display an intrusive help buffer.
3426 (if expertp
(funcall handle-keypress expert-prompt
)
3427 (save-window-excursion
3428 (delete-other-windows)
3429 (with-output-to-temp-buffer "*Org Export/Publishing Help*" (princ help
))
3430 (org-fit-window-to-buffer
3431 (get-buffer-window "*Org Export/Publishing Help*"))
3432 (funcall handle-keypress standard-prompt
)))))
3435 (provide 'org-export
)
3436 ;;; org-export.el ends here