| blob | c44b1c38db93314a78503fadbb047f6d6d35a886 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012, 2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; GNU Emacs 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 ;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
22 ;;
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
25 ;;
26 ;; Besides that parser, the generic exporter is made of three distinct
27 ;; parts:
28 ;;
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
34 ;; this file.
35 ;;
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.
40 ;;
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. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core function is `org-export-as'. It returns the transcoded
48 ;; buffer as a string.
49 ;;
50 ;; An export back-end is defined with `org-export-define-backend',
51 ;; which defines one mandatory information: his translation table.
52 ;; Its value is an alist whose keys are elements and objects types and
53 ;; values translator functions. See function's docstring for more
54 ;; information about translators.
55 ;;
56 ;; Optionally, `org-export-define-backend' can also support specific
57 ;; buffer keywords, OPTION keyword's items and filters. Also refer to
58 ;; function documentation for more information.
59 ;;
60 ;; If the new back-end shares most properties with another one,
61 ;; `org-export-define-derived-backend' can be used to simplify the
62 ;; process.
63 ;;
64 ;; Any back-end can define its own variables. Among them, those
65 ;; customizable should belong to the `org-export-BACKEND' group.
66 ;;
67 ;; Tools for common tasks across back-ends are implemented in the
68 ;; following part of then file.
69 ;;
70 ;; Then, a wrapper macro for asynchronous export,
71 ;; `org-export-async-start', along with tools to display results. are
72 ;; given in the penultimate part.
73 ;;
74 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
75 ;; back-ends is provided in the last one.
77 ;;; Code:
96 \f
97 ;;; Internal Variables
98 ;;
99 ;; Among internal variables, the most important is
100 ;; `org-export-options-alist'. This variable define the global export
101 ;; options, shared between every exporter, and how they are acquired.
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. Each
152 property defined this way can also be set, during subtree
153 export, through a headline property named after the keyword
155 property).
156 OPTION is a string that could be found in an #+OPTIONS: line.
157 DEFAULT is the default value for the property.
158 BEHAVIOUR determines how Org should handle multiple keywords for
159 the same property. It is a symbol among:
160 nil Keep old value and discard the new one.
161 t Replace old value with the new one.
162 `space' Concatenate the values, separating them with a space.
163 `newline' Concatenate the values, separating them with
164 a newline.
165 `split' Split values at white spaces, and cons them to the
166 previous list.
168 Values set through KEYWORD and OPTION have precedence over
169 DEFAULT.
171 All these properties should be back-end agnostic. Back-end
172 specific properties are set through `org-export-define-backend'.
176 "List of in-buffer keywords that require special treatment.
177 These keywords are not directly associated to a property. The
178 way they are handled must be hard-coded into
239 "Alist between filters properties and initial values.
241 The key of each association is a property name accessible through
242 the communication channel. Its value is a configurable global
243 variable defining initial filters.
245 This list is meant to install user specified filters. Back-end
246 developers may install their own filters using
247 `org-export-define-backend'. Filters defined there will always
248 be prepended to the current list, so they always get applied
257 "Default rule for link matching an inline image.
258 This rule applies to links with no description. By default, it
259 will be considered as an inline image if it targets a local file
262 See `org-export-inline-image-p' for more information about
266 "Non-nil means asynchronous export process should leave data behind.
270 located in `temporary-file-directory'.
272 When non-nil, it will also set `debug-on-error' to a non-nil
276 "Record asynchronously generated export results and processes.
277 This is an alist: its CAR is the source of the
278 result (destination file or buffer for a finished process,
279 original buffer for a running one) and its CDR is a list
280 containing the back-end used, as a symbol, and either a process
281 or the time at which it finished. It is used to build the menu
285 "List of backends currently available in the exporter.
287 A backend is stored as a list where CAR is its name, as a symbol,
288 and CDR is a plist with the following properties:
289 `:filters-alist', `:menu-entry', `:options-alist' and
290 `:translate-alist'.
292 This variable is set with `org-export-define-backend' and
296 "Last command called from the dispatcher.
297 The value should be a list. Its CAR is the action, as a symbol,
301 "The position where the last export command was created using the dispatcher.
302 This marker will be used with `C-u C-c C-e' to make sure export repetition
305 \f
306 ;;; User-configurable Variables
307 ;;
308 ;; Configuration for the masses.
309 ;;
310 ;; They should never be accessed directly, as their value is to be
311 ;; stored in a property list (cf. `org-export-options-alist').
312 ;; Back-ends will read their value from there instead.
315 "Options for exporting Org mode files."
320 "General options for export engine."
325 "Whether sub-trees with the ARCHIVE tag should be exported.
327 This can have three different values:
328 nil Do not export, pretend this tree is not present.
329 t Do export the entire tree.
330 `headline' Only export the headline, but skip the tree below it.
332 This option can also be set with the #+OPTIONS line,
341 "Non-nil means insert author name into the exported file.
342 This option can also be set with the #+OPTIONS line,
348 "Non-nil means export CLOCK keywords.
349 This option can also be set with the #+OPTIONS line,
355 "Non-nil means the postamble should contain a creator sentence.
357 The sentence can be set in `org-export-creator-string' and
360 If the value is `comment' insert it as a comment."
368 "Non-nil means insert date in the exported document.
369 This options can also be set with the OPTIONS keyword,
375 emacs-version)
376 "String to insert at the end of the generated document."
381 "Non-nil means export contents of standard drawers.
383 When t, all drawers are exported. This may also be a list of
384 drawer names to export. If that list starts with `not', only
385 drawers with such names will be ignored.
387 This variable doesn't apply to properties drawers.
389 This option can also be set with the #+OPTIONS line,
400 :inline t
404 "Non-nil means insert author email into the exported file.
405 This option can also be set with the #+OPTIONS line,
411 "Non-nil means interpret *word*, /word/, _word_ and +word+.
413 If the export target supports emphasizing text, the word will be
414 typeset in bold, italic, with an underline or strike-through,
415 respectively.
422 "Tags that exclude a tree from export.
424 All trees carrying any of these tags will be excluded from
425 export. This is without condition, so even subtrees inside that
426 carry one of the `org-export-select-tags' will be removed.
428 This option can also be set with the #+EXCLUDE_TAGS: keyword."
435 This can be used to have pre-formatted text, fragments of code
436 etc. For example:
437 : ;; Some Lisp examples
438 : (while (defc cnt)
439 : (ding))
440 will be looking just like this in also HTML. See also the QUOTE
441 keyword. Not all export backends support this.
448 "Non-nil means Org footnotes should be exported.
449 This option can also be set with the #+OPTIONS line,
455 "Non-nil means process LaTeX environments and fragments.
457 This option can also be set with the +OPTIONS line,
460 nil Ignore math snippets.
461 `verbatim' Keep everything in verbatim.
462 t Allow export of math snippets."
470 "The last level which is still exported as a headline.
472 Inferior levels will produce itemize or enumerate lists when
473 exported.
480 "The default language for export and clocktable translations, as a string.
481 This may have an association in
482 `org-clock-clocktable-language-setup'."
487 "Non-nil means preserve all line breaks when exporting.
488 This option can also be set with the #+OPTIONS line,
494 "Non-nil means interpret entities when exporting.
497 Å.
499 For a list of supported names, see the constant `org-entities'
500 and the user option `org-entities-user'.
502 This option can also be set with the #+OPTIONS line,
508 "Non-nil means inlinetasks should be exported.
509 This option can also be set with the #+OPTIONS line,
515 "Non-nil means include planning info in export.
516 This option can also be set with the #+OPTIONS: line,
522 "Non-nil means include priority cookies in export.
523 This option can also be set with the #+OPTIONS line,
529 "Non-nil means add section numbers to headlines when exporting.
531 When set to an integer n, numbering will only happen for
532 headlines whose relative level is higher or equal to n.
534 This option can also be set with the #+OPTIONS line,
540 "Tags that select a tree for export.
542 If any such tag is found in a buffer, all trees that do not carry
543 one of these tags will be ignored during export. Inside trees
544 that are selected like this, you can still deselect a subtree by
545 tagging it with one of the `org-export-exclude-tags'.
547 This option can also be set with the #+SELECT_TAGS: keyword."
552 "Non-nil means activate smart quotes during export.
553 This option can also be set with the #+OPTIONS: line,
561 When this option is turned on, these strings will be exported as:
563 Org HTML LaTeX UTF-8
564 -----+----------+--------+-------
566 -- – -- –
567 --- — --- —
570 This option can also be set with the #+OPTIONS line,
576 "Non-nil means include statistics cookies in export.
577 This option can also be set with the #+OPTIONS: line,
585 When this option is turned on, you can use TeX-like syntax for
587 will be considered as a single item - so grouping with {} is
588 normally not needed. For example, the following things will be
589 parsed as single sub- or superscripts.
591 10^24 or 10^tau several digits will be considered 1 item.
592 10^-12 or 10^-tau a leading sign with digits or a word
593 x^2-y^3 will be read as x^2 - y^3, because items are
594 terminated by almost any nonword/nondigit char.
595 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
597 Still, ambiguity is possible - so when in doubt use {} to enclose
598 the sub/superscript. If you set this variable to the symbol
599 `{}', the braces are *required* in order to trigger
600 interpretations as sub/superscript. This can be helpful in
603 This option can also be set with the #+OPTIONS line,
612 "Non-nil means create a table of contents in exported files.
614 The TOC contains headlines with levels up
615 to`org-export-headline-levels'. When an integer, include levels
616 up to N in the toc, this may then be different from
617 `org-export-headline-levels', but it will not be allowed to be
618 larger than the number of headline levels. When nil, no table of
619 contents is made.
621 This option can also be set with the #+OPTIONS line,
631 For example:
633 | Name | Address | Birthday |
634 |-------------+----------+-----------|
635 | Arthur Dent | England | 29.2.2100 |
642 "If nil, do not export tags, just remove them from headlines.
644 If this is the symbol `not-in-toc', tags will be removed from
645 table of contents entries, but still be shown in the headlines of
646 the document.
648 This option can also be set with the #+OPTIONS line,
657 "Non-nil means include TODO items for export.
659 This may have the following values:
660 t include tasks independent of state.
661 `todo' include only tasks that are not yet done.
662 `done' include only tasks that are already done.
663 nil ignore all tasks.
664 list of keywords include tasks with these keywords.
666 This option can also be set with the #+OPTIONS line,
678 "Non-nil means insert a time stamp into the exported file.
679 The time stamp shows when the file was created.
681 This option can also be set with the #+OPTIONS line,
687 "Non nil means allow timestamps in export.
689 It can be set to `active', `inactive', t or nil, in order to
690 export, respectively, only active timestamps, only inactive ones,
691 all of them or none.
693 This option can also be set with the #+OPTIONS line, e.g.
703 "Non-nil means include TODO keywords in export.
704 When nil, remove all these keywords from the export."
709 "Non-nil means BIND keywords can define local variable values.
710 This is a potential security risk, which is why the default value
711 is nil. You can also allow them through local buffer variables."
716 "Alist between export snippets back-ends and exporter back-ends.
718 This variable allows to provide shortcuts for export snippets.
722 HTML code while every other back-end will ignore it."
729 "Coding system for the exported file."
734 "Non-nil means exported stuff will also be pushed onto the kill ring."
739 "The initial scope when exporting with `org-export-dispatch'.
740 This variable can be either set to `buffer' or `subtree'."
747 "Non-nil means show buffer after exporting to temp buffer.
748 When Org exports to a file, the buffer visiting that file is ever
749 shown, but remains buried. However, when exporting to
750 a temporary buffer, that buffer is popped up in a second window.
751 When this variable is nil, the buffer remains buried also in
752 these cases."
757 "Non-nil means export and publishing commands will run in background.
758 Results from an asynchronous export are never displayed
764 "File used to initialize external export process.
765 Value must be an absolute file name. It defaults to user's
766 initialization file. Though, a specific configuration makes the
767 process faster and the export more portable."
772 "List of back-ends that shouldn't appear in the dispatcher.
774 Any back-end belonging to this list or derived from a back-end
775 belonging to it will not appear in the dispatcher menu.
777 Indeed, Org may require some export back-ends without notice. If
778 these modules are never to be used interactively, adding them
779 here will avoid cluttering the dispatcher menu."
784 "Non-nil means using a non-intrusive `org-export-dispatch'.
785 In that case, no help buffer is displayed. Though, an indicator
791 asynchronous). Also, \[?] allows to switch back to standard
792 mode."
797 \f
798 ;;; Defining Back-ends
799 ;;
800 ;; `org-export-define-backend' is the standard way to define an export
801 ;; back-end. It allows to specify translators, filters, buffer
802 ;; options and a menu entry. If the new back-end shares translators
803 ;; with another back-end, `org-export-define-derived-backend' may be
804 ;; used instead.
805 ;;
806 ;; Internally, a back-end is stored as a list, of which CAR is the
807 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
808 ;; properties of a given back-end are: `org-export-backend-filters',
809 ;; `org-export-backend-menu', `org-export-backend-options' and
810 ;; `org-export-backend-translate-table'.
811 ;;
812 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
813 ;; when a given back-end hasn't been registered yet.
816 "Define a new back-end BACKEND.
818 TRANSLATORS is an alist between object or element types and
819 functions handling them.
821 These functions should return a string without any trailing
822 space, or nil. They must accept three arguments: the object or
823 element itself, its contents or nil when it isn't recursive and
824 the property list used as a communication channel.
826 Contents, when not nil, are stripped from any global indentation
827 \(although the relative one is preserved). They also always end
828 with a single newline character.
830 If, for a given type, no function is found, that element or
831 object type will simply be ignored, along with any blank line or
832 white space at its end. The same will happen if the function
833 returns the nil value. If that function returns the empty
834 string, the type will be ignored, but the blank lines or white
835 spaces will be kept.
837 In addition to element and object types, one function can be
838 associated to the `template' (or `inner-template') symbol and
839 another one to the `plain-text' symbol.
841 The former returns the final transcoded string, and can be used
842 to add a preamble and a postamble to document's body. It must
843 accept two arguments: the transcoded string and the property list
844 containing export options. A function associated to `template'
846 A function associated to `inner-template' is always applied.
848 The latter, when defined, is to be called on every text not
849 recognized as an element or an object. It must accept two
850 arguments: the text string and the information channel. It is an
851 appropriate place to protect special chars relative to the
852 back-end.
854 BODY can start with pre-defined keyword arguments. The following
855 keywords are understood:
857 :export-block
859 String, or list of strings, representing block names that
860 will not be parsed. This is used to specify blocks that will
861 contain raw code specific to the back-end. These blocks
862 still have to be handled by the relative `export-block' type
863 translator.
865 :filters-alist
867 Alist between filters and function, or list of functions,
868 specific to the back-end. See `org-export-filters-alist' for
869 a list of all allowed filters. Filters defined here
870 shouldn't make a back-end test, as it may prevent back-ends
871 derived from this one to behave properly.
873 :menu-entry
875 Menu entry for the export dispatcher. It should be a list
876 like:
878 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
880 where :
882 KEY is a free character selecting the back-end.
884 DESCRIPTION-OR-ORDINAL is either a string or a number.
886 If it is a string, is will be used to name the back-end in
887 its menu entry. If it is a number, the following menu will
888 be displayed as a sub-menu of the back-end with the same
889 KEY. Also, the number will be used to determine in which
890 order such sub-menus will appear (lowest first).
892 ACTION-OR-MENU is either a function or an alist.
894 If it is an action, it will be called with four
895 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
896 BODY-ONLY. See `org-export-as' for further explanations on
897 some of them.
899 If it is an alist, associations should follow the
900 pattern:
902 \(KEY DESCRIPTION ACTION)
904 where KEY, DESCRIPTION and ACTION are described above.
906 Valid values include:
910 or
915 \(lambda (a s v b)
916 \(if a (org-latex-export-to-pdf t s v b)
917 \(org-open-file
918 \(org-latex-export-to-pdf nil s v b)))))))
920 or the following, which will be added to the previous
921 sub-menu,
923 \(?l 1
927 :options-alist
929 Alist between back-end specific properties introduced in
930 communication channel and how their value are acquired. See
931 `org-export-options-alist' for more information about
932 structure of the values."
951 ;; Register back-end.
955 ;; Tell parser to not parse EXPORT-BLOCK blocks.
962 ;; Splice in the body, if any.
966 "Create a new back-end as a variant of an existing one.
968 CHILD is the name of the derived back-end. PARENT is the name of
969 the parent back-end.
971 BODY can start with pre-defined keyword arguments. The following
972 keywords are understood:
974 :export-block
976 String, or list of strings, representing block names that
977 will not be parsed. This is used to specify blocks that will
978 contain raw code specific to the back-end. These blocks
979 still have to be handled by the relative `export-block' type
980 translator.
982 :filters-alist
984 Alist of filters that will overwrite or complete filters
985 defined in PARENT back-end. See `org-export-filters-alist'
986 for a list of allowed filters.
988 :menu-entry
990 Menu entry for the export dispatcher. See
991 `org-export-define-backend' for more information about the
992 expected value.
994 :options-alist
996 Alist of back-end specific properties that will overwrite or
997 complete those defined in PARENT back-end. Refer to
998 `org-export-options-alist' for more information about
999 structure of the values.
1001 :translate-alist
1003 Alist of element and object types and transcoders that will
1004 overwrite or complete transcode table from PARENT back-end.
1005 Refer to `org-export-define-backend' for detailed information
1006 about transcoders.
1009 as a variant of `latex' back-end with a custom template function:
1011 \(org-export-define-derived-backend my-latex latex
1012 :translate-alist ((template . my-latex-template-fun)))
1014 The back-end could then be called with, for example:
1042 ;; Register back-end.
1046 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1053 ;; Splice in the body, if any.
1057 "Return back-end from which BACKEND is derived, or nil."
1061 "Return filters for BACKEND."
1066 "Return menu entry for BACKEND."
1071 "Return export options for BACKEND."
1076 "Return translate table for BACKEND."
1081 "Signal an error if BACKEND isn't defined."
1086 "Non-nil if BACKEND is derived from one of BACKENDS."
1090 parent))
1093 \f
1094 ;;; The Communication Channel
1095 ;;
1096 ;; During export process, every function has access to a number of
1097 ;; properties. They are of two types:
1098 ;;
1099 ;; 1. Environment options are collected once at the very beginning of
1100 ;; the process, out of the original buffer and configuration.
1101 ;; Collecting them is handled by `org-export-get-environment'
1102 ;; function.
1103 ;;
1104 ;; Most environment options are defined through the
1105 ;; `org-export-options-alist' variable.
1106 ;;
1107 ;; 2. Tree properties are extracted directly from the parsed tree,
1108 ;; just before export, by `org-export-collect-tree-properties'.
1109 ;;
1110 ;; Here is the full list of properties available during transcode
1111 ;; process, with their category and their value type.
1112 ;;
1113 ;; + `:author' :: Author's name.
1114 ;; - category :: option
1115 ;; - type :: string
1116 ;;
1117 ;; + `:back-end' :: Current back-end used for transcoding.
1118 ;; - category :: tree
1119 ;; - type :: symbol
1120 ;;
1121 ;; + `:creator' :: String to write as creation information.
1122 ;; - category :: option
1123 ;; - type :: string
1124 ;;
1125 ;; + `:date' :: String to use as date.
1126 ;; - category :: option
1127 ;; - type :: string
1128 ;;
1129 ;; + `:description' :: Description text for the current data.
1130 ;; - category :: option
1131 ;; - type :: string
1132 ;;
1133 ;; + `:email' :: Author's email.
1134 ;; - category :: option
1135 ;; - type :: string
1136 ;;
1137 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1138 ;; process.
1139 ;; - category :: option
1140 ;; - type :: list of strings
1141 ;;
1142 ;; + `:exported-data' :: Hash table used for memoizing
1143 ;; `org-export-data'.
1144 ;; - category :: tree
1145 ;; - type :: hash table
1146 ;;
1147 ;; + `:filetags' :: List of global tags for buffer. Used by
1148 ;; `org-export-get-tags' to get tags with inheritance.
1149 ;; - category :: option
1150 ;; - type :: list of strings
1151 ;;
1152 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1153 ;; their definition, as parsed data. Only non-inlined footnotes
1154 ;; are represented in this alist. Also, every definition isn't
1155 ;; guaranteed to be referenced in the parse tree. The purpose of
1156 ;; this property is to preserve definitions from oblivion
1157 ;; (i.e. when the parse tree comes from a part of the original
1158 ;; buffer), it isn't meant for direct use in a back-end. To
1159 ;; retrieve a definition relative to a reference, use
1160 ;; `org-export-get-footnote-definition' instead.
1161 ;; - category :: option
1162 ;; - type :: alist (STRING . LIST)
1163 ;;
1164 ;; + `:headline-levels' :: Maximum level being exported as an
1165 ;; headline. Comparison is done with the relative level of
1166 ;; headlines in the parse tree, not necessarily with their
1167 ;; actual level.
1168 ;; - category :: option
1169 ;; - type :: integer
1170 ;;
1171 ;; + `:headline-offset' :: Difference between relative and real level
1172 ;; of headlines in the parse tree. For example, a value of -1
1173 ;; means a level 2 headline should be considered as level
1174 ;; 1 (cf. `org-export-get-relative-level').
1175 ;; - category :: tree
1176 ;; - type :: integer
1177 ;;
1178 ;; + `:headline-numbering' :: Alist between headlines and their
1179 ;; numbering, as a list of numbers
1180 ;; (cf. `org-export-get-headline-number').
1181 ;; - category :: tree
1182 ;; - type :: alist (INTEGER . LIST)
1183 ;;
1184 ;; + `:id-alist' :: Alist between ID strings and destination file's
1185 ;; path, relative to current directory. It is used by
1186 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1187 ;; external file.
1188 ;; - category :: option
1189 ;; - type :: alist (STRING . STRING)
1190 ;;
1191 ;; + `:ignore-list' :: List of elements and objects that should be
1192 ;; ignored during export.
1193 ;; - category :: tree
1194 ;; - type :: list of elements and objects
1195 ;;
1196 ;; + `:input-file' :: Full path to input file, if any.
1197 ;; - category :: option
1198 ;; - type :: string or nil
1199 ;;
1200 ;; + `:keywords' :: List of keywords attached to data.
1201 ;; - category :: option
1202 ;; - type :: string
1203 ;;
1204 ;; + `:language' :: Default language used for translations.
1205 ;; - category :: option
1206 ;; - type :: string
1207 ;;
1208 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1209 ;; transcoding.
1210 ;; - category :: option
1211 ;; - type :: list (as returned by `org-element-parse-buffer')
1212 ;;
1213 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1214 ;; all line breaks.
1215 ;; - category :: option
1216 ;; - type :: symbol (nil, t)
1217 ;;
1218 ;; + `:section-numbers' :: Non-nil means transcoding should add
1219 ;; section numbers to headlines.
1220 ;; - category :: option
1221 ;; - type :: symbol (nil, t)
1222 ;;
1223 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1224 ;; in transcoding. When such a tag is present, subtrees without
1225 ;; it are de facto excluded from the process. See
1226 ;; `use-select-tags'.
1227 ;; - category :: option
1228 ;; - type :: list of strings
1229 ;;
1230 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1231 ;; a time stamp in the output.
1232 ;; - category :: option
1233 ;; - type :: symbol (nil, t)
1234 ;;
1235 ;; + `:translate-alist' :: Alist between element and object types and
1236 ;; transcoding functions relative to the current back-end.
1237 ;; Special keys `inner-template', `template' and `plain-text' are
1238 ;; also possible.
1239 ;; - category :: option
1240 ;; - type :: alist (SYMBOL . FUNCTION)
1241 ;;
1242 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1243 ;; also be transcoded. If it is set to the `headline' symbol,
1244 ;; only the archived headline's name is retained.
1245 ;; - category :: option
1246 ;; - type :: symbol (nil, t, `headline')
1247 ;;
1248 ;; + `:with-author' :: Non-nil means author's name should be included
1249 ;; in the output.
1250 ;; - category :: option
1251 ;; - type :: symbol (nil, t)
1252 ;;
1253 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1254 ;; - category :: option
1255 ;; - type :: symbol (nil, t)
1256 ;;
1257 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1258 ;; inserted at the end of the transcoded string. If the value
1259 ;; is `comment', it should be commented.
1260 ;; - category :: option
1261 ;; - type :: symbol (`comment', nil, t)
1262 ;;
1263 ;; + `:with-date' :: Non-nil means output should contain a date.
1264 ;; - category :: option
1265 ;; - type :. symbol (nil, t)
1266 ;;
1267 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1268 ;; its value is a list of names, only drawers with such names
1269 ;; will be transcoded. If that list starts with `not', drawer
1270 ;; with these names will be skipped.
1271 ;; - category :: option
1272 ;; - type :: symbol (nil, t) or list of strings
1273 ;;
1274 ;; + `:with-email' :: Non-nil means output should contain author's
1275 ;; email.
1276 ;; - category :: option
1277 ;; - type :: symbol (nil, t)
1278 ;;
1279 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1280 ;; interpreted.
1281 ;; - category :: option
1282 ;; - type :: symbol (nil, t)
1283 ;;
1284 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1285 ;; strings starting with a colon as a fixed-with (verbatim) area.
1286 ;; - category :: option
1287 ;; - type :: symbol (nil, t)
1288 ;;
1289 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1290 ;; footnotes.
1291 ;; - category :: option
1292 ;; - type :: symbol (nil, t)
1293 ;;
1294 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1295 ;; `latex-fragment' objects should appear in export output. When
1296 ;; this property is set to `verbatim', they will be left as-is.
1297 ;; - category :: option
1298 ;; - type :: symbol (`verbatim', nil, t)
1299 ;;
1300 ;; + `:with-plannings' :: Non-nil means transcoding should include
1301 ;; planning info.
1302 ;; - category :: option
1303 ;; - type :: symbol (nil, t)
1304 ;;
1305 ;; + `:with-priority' :: Non-nil means transcoding should include
1306 ;; priority cookies.
1307 ;; - category :: option
1308 ;; - type :: symbol (nil, t)
1309 ;;
1310 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1311 ;; plain text.
1312 ;; - category :: option
1313 ;; - type :: symbol (nil, t)
1314 ;;
1315 ;; + `:with-special-strings' :: Non-nil means transcoding should
1316 ;; interpret special strings in plain text.
1317 ;; - category :: option
1318 ;; - type :: symbol (nil, t)
1319 ;;
1320 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1321 ;; interpret subscript and superscript. With a value of "{}",
1322 ;; only interpret those using curly brackets.
1323 ;; - category :: option
1324 ;; - type :: symbol (nil, {}, t)
1325 ;;
1326 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1327 ;; tables.
1328 ;; - category :: option
1329 ;; - type :: symbol (nil, t)
1330 ;;
1331 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1332 ;; headlines. A `not-in-toc' value will remove them from the
1333 ;; table of contents, if any, nonetheless.
1334 ;; - category :: option
1335 ;; - type :: symbol (nil, t, `not-in-toc')
1336 ;;
1337 ;; + `:with-tasks' :: Non-nil means transcoding should include
1338 ;; headlines with a TODO keyword. A `todo' value will only
1339 ;; include headlines with a todo type keyword while a `done'
1340 ;; value will do the contrary. If a list of strings is provided,
1341 ;; only tasks with keywords belonging to that list will be kept.
1342 ;; - category :: option
1343 ;; - type :: symbol (t, todo, done, nil) or list of strings
1344 ;;
1345 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1346 ;; time stamps. Special value `active' (resp. `inactive') ask to
1347 ;; export only active (resp. inactive) timestamps. Otherwise,
1348 ;; completely remove them.
1349 ;; - category :: option
1350 ;; - type :: symbol: (`active', `inactive', t, nil)
1351 ;;
1352 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1353 ;; added to the output. An integer value limits its depth.
1354 ;; - category :: option
1355 ;; - type :: symbol (nil, t or integer)
1356 ;;
1357 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1358 ;; include TODO keywords.
1359 ;; - category :: option
1360 ;; - type :: symbol (nil, t)
1363 ;;;; Environment Options
1364 ;;
1365 ;; Environment options encompass all parameters defined outside the
1366 ;; scope of the parsed data. They come from five sources, in
1367 ;; increasing precedence order:
1368 ;;
1369 ;; - Global variables,
1370 ;; - Buffer's attributes,
1371 ;; - Options keyword symbols,
1372 ;; - Buffer keywords,
1373 ;; - Subtree properties.
1374 ;;
1375 ;; The central internal function with regards to environment options
1376 ;; is `org-export-get-environment'. It updates global variables with
1377 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1378 ;; the different sources.
1379 ;;
1380 ;; The internal functions doing the retrieval are:
1381 ;; `org-export--get-global-options',
1382 ;; `org-export--get-buffer-attributes',
1383 ;; `org-export--parse-option-keyword',
1384 ;; `org-export--get-subtree-options' and
1385 ;; `org-export--get-inbuffer-options'
1386 ;;
1387 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1388 ;; relative to "#+BIND:" keywords.
1391 "Collect export options from the current buffer.
1393 Optional argument BACKEND is a symbol specifying which back-end
1394 specific options to read, if any.
1396 When optional argument SUBTREEP is non-nil, assume the export is
1397 done against the current sub-tree.
1399 Third optional argument EXT-PLIST is a property list with
1400 external parameters overriding Org default settings, but still
1401 inferior to file-local settings."
1402 ;; First install #+BIND variables.
1404 ;; Get and prioritize export options...
1406 ;; ... from global variables...
1408 ;; ... from an external property list...
1409 ext-plist
1410 ;; ... from in-buffer settings...
1412 ;; ... and from subtree, when appropriate.
1414 ;; Eventually add misc. properties.
1416 :back-end
1417 backend
1418 :translate-alist
1420 :footnote-definition-alist
1421 ;; Footnotes definitions must be collected in the original
1422 ;; buffer, as there's no insurance that they will still be in
1423 ;; the parse tree, due to possible narrowing.
1437 alist))))
1438 alist))
1439 :id-alist
1440 ;; Collect id references.
1451 alist))))
1454 "Parse an OPTIONS line and return values as a plist.
1455 Optional argument BACKEND is a symbol specifying which back-end
1456 specific items to read, if any."
1458 ;; Priority is given to back-end specific options.
1460 org-export-options-alist))
1461 plist)
1470 options))
1472 property
1475 plist))
1478 "Get export options in subtree at point.
1479 Optional argument BACKEND is a symbol specifying back-end used
1480 for export. Return options as a plist."
1481 ;; For each buffer keyword, create a headline property setting the
1482 ;; same property in communication channel. The name for the property
1483 ;; is the keyword with "EXPORT_" appended to it.
1486 ;; Make sure point is at an heading.
1488 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1489 ;; title as its fallback value.
1495 plist :title
1498 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1502 ;; Handle other keywords. TITLE keyword is excluded as it has
1503 ;; been handled already.
1511 ;; Export properties are not case-sensitive.
1518 plist
1519 property
1521 ;; Parse VALUE if required.
1525 ;; If BEHAVIOUR is `split' expected value is
1526 ;; a list of strings, not a string.
1529 ;; Look for both general keywords and back-end specific
1530 ;; options, with priority given to the latter.
1532 org-export-options-alist)))
1533 ;; Return value.
1534 plist)))
1537 "Return current buffer export options, as a plist.
1539 Optional argument BACKEND, when non-nil, is a symbol specifying
1540 which back-end specific options should also be read in the
1541 process.
1543 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1545 get-options ; For byte-compiler.
1548 ;; Priority is given to back-end specific options.
1550 org-export-options-alist))
1553 org-export-special-keywords))))
1556 ;; Return property name associated to KEYWORD.
1561 options))))
1564 ;; Recursively read keywords in buffer. FILES is a list
1565 ;; of files read so far. PLIST is the current property
1566 ;; list obtained.
1575 ;; Options in `org-export-special-keywords'.
1579 ;; Avoid circular dependencies.
1589 plist
1594 plist
1600 ;; Options in `org-export-options-alist'.
1605 plist prop
1606 ;; Handle value depending on specified
1607 ;; BEHAVIOUR.
1613 " "
1625 ;; Return final value.
1626 plist))))
1627 ;; Read options in the current buffer.
1629 ;; Parse keywords specified in `org-element-document-properties'.
1631 ;; Find the property associated to the keyword.
1639 org-element-document-properties)
1640 ;; Return value.
1641 plist))
1644 "Return properties related to buffer attributes, as a plist."
1647 ;; Store full path of input file name, or nil. For internal use.
1648 :input-file visited-file
1655 "Return global export options as a plist.
1657 Optional argument BACKEND, if non-nil, is a symbol specifying
1658 which back-end specific export options should also be read in the
1659 process."
1661 ;; Priority is given to back-end specific options.
1663 org-export-options-alist))
1664 plist)
1671 plist
1672 prop
1673 ;; Eval default value provided. If keyword is a member
1674 ;; of `org-element-document-properties', parse it as
1675 ;; a secondary string before storing it.
1680 value
1683 all)
1684 ;; Return value.
1685 plist))
1688 "Install the values from #+BIND lines as local variables.
1689 Variables must be installed before in-buffer options are
1690 retrieved."
1705 ;;;; Tree Properties
1706 ;;
1707 ;; Tree properties are information extracted from parse tree. They
1708 ;; are initialized at the beginning of the transcoding process by
1709 ;; `org-export-collect-tree-properties'.
1710 ;;
1711 ;; Dedicated functions focus on computing the value of specific tree
1712 ;; properties during initialization. Thus,
1713 ;; `org-export--populate-ignore-list' lists elements and objects that
1714 ;; should be skipped during export, `org-export--get-min-level' gets
1715 ;; the minimal exportable level, used as a basis to compute relative
1716 ;; level for headlines. Eventually
1717 ;; `org-export--collect-headline-numbering' builds an alist between
1718 ;; headlines and their numbering.
1721 "Extract tree properties from parse tree.
1723 DATA is the parse tree from which information is retrieved. INFO
1724 is a list holding export options.
1726 Following tree properties are set or updated:
1728 `:exported-data' Hash table used to memoize results from
1729 `org-export-data'.
1731 `:footnote-definition-alist' List of footnotes definitions in
1732 original buffer and current parse tree.
1734 `:headline-offset' Offset between true level of headlines and
1735 local level. An offset of -1 means a headline
1736 of level 2 should be considered as a level
1737 1 headline in the context.
1739 `:headline-numbering' Alist of all headlines as key an the
1740 associated numbering as value.
1742 `:ignore-list' List of elements that should be ignored during
1743 export.
1745 Return updated plist."
1746 ;; Install the parse tree in the communication channel, in order to
1747 ;; use `org-export-get-genealogy' and al.
1749 ;; Get the list of elements and objects to ignore, and put it into
1750 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1751 ;; been done during parse tree filtering.
1754 :ignore-list
1757 ;; Compute `:headline-offset' in order to be able to use
1758 ;; `org-export-get-relative-level'.
1761 :headline-offset
1763 ;; Update footnotes definitions list with definitions in parse tree.
1764 ;; This is required since buffer expansion might have modified
1765 ;; boundaries of footnote definitions contained in the parse tree.
1766 ;; This way, definitions in `footnote-definition-alist' are bound to
1767 ;; match those in the parse tree.
1773 defs)))
1775 ;; Properties order doesn't matter: get the rest of the tree
1776 ;; properties.
1780 info))
1783 "Return minimum exportable headline's level in DATA.
1784 DATA is parsed tree as returned by `org-element-parse-buffer'.
1785 OPTIONS is a plist holding export options."
1796 ;; If no headline was found, for the sake of consistency, set
1797 ;; minimum level to 1 nonetheless.
1801 "Return numbering of all exportable headlines in a parse tree.
1803 DATA is the parse tree. OPTIONS is the plist holding export
1804 options.
1806 Return an alist whose key is a headline and value is its
1807 associated numbering \(in the shape of a list of numbers\) or nil
1808 for a footnotes section."
1816 headline
1818 for idx from 0 to org-export-max-depth
1822 options)))
1825 "Return list of elements and objects to ignore during export.
1826 DATA is the parse tree to traverse. OPTIONS is the plist holding
1827 export options."
1829 walk-data
1830 ;; First find trees containing a select tag, if any.
1834 ;; Collect ignored elements or objects into IGNORE-LIST.
1840 ;; If headline is archived but tree below has
1841 ;; to be skipped, add it to ignore list.
1844 ;; Move into secondary string, if any.
1849 ;; Move into recursive objects/elements.
1851 ;; Main call.
1853 ;; Return value.
1854 ignore))
1857 "Return list of headlines and inlinetasks with a select tag in their tree.
1858 DATA is parsed data as returned by `org-element-parse-buffer'.
1859 INFO is a plist holding export options."
1861 walk-data ; For byte-compiler.
1871 ;; When a select tag is found, mark full
1872 ;; genealogy and every headline within the tree
1873 ;; as acceptable.
1876 genealogy
1879 selected-trees))
1880 ;; If at a headline, continue searching in tree,
1881 ;; recursively.
1891 selected-trees))
1894 "Non-nil when element or object BLOB should be skipped during export.
1895 OPTIONS is the plist holding export options. SELECTED, when
1896 non-nil, is a list of headlines or inlinetasks belonging to
1897 a tree with a select tag."
1904 ;; If `:with-drawers' value starts with `not', ignore
1905 ;; every drawer whose name belong to that list.
1906 ;; Otherwise, ignore drawers whose name isn't in that
1907 ;; list.
1921 ;; Ignore subtrees with an exclude tag.
1924 ;; When a select tag is present in the buffer, ignore any tree
1925 ;; without it.
1927 ;; Ignore commented sub-trees.
1929 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1931 ;; Ignore tasks, if specified by `:with-tasks' property.
1947 ;; No timestamp allowed.
1949 ;; Only active timestamps allowed and the current one isn't
1950 ;; active.
1954 ;; Only inactive timestamps allowed and the current one isn't
1955 ;; inactive.
1961 \f
1962 ;;; The Transcoder
1963 ;;
1964 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1965 ;; `org-element-parse-buffer') and transcodes it into a specified
1966 ;; back-end output. It takes care of filtering out elements or
1967 ;; objects according to export options and organizing the output blank
1968 ;; lines and white space are preserved. The function memoizes its
1969 ;; results, so it is cheap to call it within translators.
1970 ;;
1971 ;; It is possible to modify locally the back-end used by
1972 ;; `org-export-data' or even use a temporary back-end by using
1973 ;; `org-export-data-with-translations' and
1974 ;; `org-export-data-with-backend'.
1975 ;;
1976 ;; Internally, three functions handle the filtering of objects and
1977 ;; elements during the export. In particular,
1978 ;; `org-export-ignore-element' marks an element or object so future
1979 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1980 ;; elements or objects should be seen as real Org syntax and
1981 ;; `org-export-expand' transforms the others back into their original
1982 ;; shape
1983 ;;
1984 ;; `org-export-transcoder' is an accessor returning appropriate
1985 ;; translator function for a given element or object.
1988 "Return appropriate transcoder for BLOB.
1989 INFO is a plist containing export directives."
1991 ;; Return contents only for complete parse trees.
1997 "Convert DATA into current back-end format.
1999 DATA is a parse tree, an element or an object or a secondary
2000 string. INFO is a plist holding export options.
2002 Return transcoded string."
2008 ;; Ignored element/object.
2010 ;; Plain text.
2016 info))
2017 ;; Uninterpreted element/object: change it back to Org
2018 ;; syntax and export again resulting raw string.
2022 data
2026 info))
2027 ;; Secondary string.
2030 ;; Element/Object without contents or, as a special case,
2031 ;; headline with archive tag and archived trees restricted
2032 ;; to title only.
2040 ;; Element/Object with contents.
2053 ;; Elements directly containing objects
2054 ;; must have their indentation normalized
2055 ;; first.
2057 data
2058 ;; When normalizing contents of the first
2059 ;; paragraph in an item or a footnote
2060 ;; definition, ignore first line's
2061 ;; indentation: there is none and it
2062 ;; might be misleading.
2067 data)
2074 info))))))))
2075 ;; Final result will be memoized before being returned.
2077 data
2081 ;; Append the same white space between elements or objects as in
2082 ;; the original buffer, and call appropriate filters.
2093 info)))
2094 results)))
2098 "Convert DATA into another format using a given translation table.
2099 DATA is an element, an object, a secondary string or a string.
2100 TRANSLATIONS is an alist between element or object types and
2101 a functions handling them. See `org-export-define-backend' for
2102 more information. INFO is a plist used as a communication
2103 channel."
2105 data
2106 ;; Set-up a new communication channel with TRANSLATIONS as the
2107 ;; translate table and a new hash table for memoization.
2109 info
2111 ;; Size of the hash table is reduced since this function
2112 ;; will probably be used on short trees.
2116 "Convert DATA into BACKEND format.
2118 DATA is an element, an object, a secondary string or a string.
2119 BACKEND is a symbol. INFO is a plist used as a communication
2120 channel.
2122 Unlike to `org-export-with-backend', this function will
2123 recursively convert DATA using BACKEND translation table."
2129 "Non-nil if element or object BLOB should be interpreted during export.
2130 If nil, BLOB will appear as raw Org syntax. Check is done
2131 according to export options INFO, stored as a plist."
2133 ;; ... entities...
2135 ;; ... emphasis...
2138 ;; ... fixed-width areas.
2140 ;; ... footnotes...
2143 ;; ... LaTeX environments and fragments...
2147 ;; ... sub/superscripts...
2153 ;; ... tables...
2158 "Expand a parsed element or object to its original state.
2159 BLOB is either an element or an object. CONTENTS is its
2160 contents, as a string or nil."
2163 blob contents))
2166 "Add ELEMENT to `:ignore-list' in INFO.
2168 Any element in `:ignore-list' will be skipped when using
2169 `org-element-map'. INFO is modified by side effects."
2173 \f
2174 ;;; The Filter System
2175 ;;
2176 ;; Filters allow end-users to tweak easily the transcoded output.
2177 ;; They are the functional counterpart of hooks, as every filter in
2178 ;; a set is applied to the return value of the previous one.
2179 ;;
2180 ;; Every set is back-end agnostic. Although, a filter is always
2181 ;; called, in addition to the string it applies to, with the back-end
2182 ;; used as argument, so it's easy for the end-user to add back-end
2183 ;; specific filters in the set. The communication channel, as
2184 ;; a plist, is required as the third argument.
2185 ;;
2186 ;; From the developer side, filters sets can be installed in the
2187 ;; process with the help of `org-export-define-backend', which
2188 ;; internally stores filters as an alist. Each association has a key
2189 ;; among the following symbols and a function or a list of functions
2190 ;; as value.
2191 ;;
2192 ;; - `:filter-options' applies to the property list containing export
2193 ;; options. Unlike to other filters, functions in this list accept
2194 ;; two arguments instead of three: the property list containing
2195 ;; export options and the back-end. Users can set its value through
2196 ;; `org-export-filter-options-functions' variable.
2197 ;;
2198 ;; - `:filter-parse-tree' applies directly to the complete parsed
2199 ;; tree. Users can set it through
2200 ;; `org-export-filter-parse-tree-functions' variable.
2201 ;;
2202 ;; - `:filter-final-output' applies to the final transcoded string.
2203 ;; Users can set it with `org-export-filter-final-output-functions'
2204 ;; variable
2205 ;;
2206 ;; - `:filter-plain-text' applies to any string not recognized as Org
2207 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2208 ;; configure it.
2209 ;;
2210 ;; - `:filter-TYPE' applies on the string returned after an element or
2211 ;; object of type TYPE has been transcoded. An user can modify
2212 ;; `org-export-filter-TYPE-functions'
2213 ;;
2214 ;; All filters sets are applied with
2215 ;; `org-export-filter-apply-functions' function. Filters in a set are
2216 ;; applied in a LIFO fashion. It allows developers to be sure that
2217 ;; their filters will be applied first.
2218 ;;
2219 ;; Filters properties are installed in communication channel with
2220 ;; `org-export-install-filters' function.
2221 ;;
2222 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2223 ;; `org-export-before-parsing-hook') are run at the beginning of the
2224 ;; export process and just before parsing to allow for heavy structure
2225 ;; modifications.
2228 ;;;; Hooks
2231 "Hook run at the beginning of the export process.
2233 This is run before include keywords and macros are expanded and
2234 Babel code blocks executed, on a copy of the original buffer
2235 being exported. Visibility and narrowing are preserved. Point
2236 is at the beginning of the buffer.
2238 Every function in this hook will be called with one argument: the
2242 "Hook run before parsing an export buffer.
2244 This is run after include keywords and macros have been expanded
2245 and Babel code blocks executed, on a copy of the original buffer
2246 being exported. Visibility and narrowing are preserved. Point
2247 is at the beginning of the buffer.
2249 Every function in this hook will be called with one argument: the
2253 ;;;; Special Filters
2256 "List of functions applied to the export options.
2257 Each filter is called with two arguments: the export options, as
2258 a plist, and the back-end, as a symbol. It must return
2262 "List of functions applied to the parsed tree.
2263 Each filter is called with three arguments: the parse tree, as
2264 returned by `org-element-parse-buffer', the back-end, as
2265 a symbol, and the communication channel, as a plist. It must
2269 "List of functions applied to plain text.
2270 Each filter is called with three arguments: a string which
2271 contains no Org syntax, the back-end, as a symbol, and the
2272 communication channel, as a plist. It must return a string or
2276 "List of functions applied to the transcoded string.
2277 Each filter is called with three arguments: the full transcoded
2278 string, the back-end, as a symbol, and the communication channel,
2279 as a plist. It must return a string that will be used as the
2283 ;;;; Elements Filters
2286 "List of functions applied to a transcoded babel-call.
2287 Each filter is called with three arguments: the transcoded data,
2288 as a string, the back-end, as a symbol, and the communication
2292 "List of functions applied to a transcoded center block.
2293 Each filter is called with three arguments: the transcoded data,
2294 as a string, the back-end, as a symbol, and the communication
2298 "List of functions applied to a transcoded clock.
2299 Each filter is called with three arguments: the transcoded data,
2300 as a string, the back-end, as a symbol, and the communication
2304 "List of functions applied to a transcoded comment.
2305 Each filter is called with three arguments: the transcoded data,
2306 as a string, the back-end, as a symbol, and the communication
2310 "List of functions applied to a transcoded comment-block.
2311 Each filter is called with three arguments: the transcoded data,
2312 as a string, the back-end, as a symbol, and the communication
2316 "List of functions applied to a transcoded diary-sexp.
2317 Each filter is called with three arguments: the transcoded data,
2318 as a string, the back-end, as a symbol, and the communication
2322 "List of functions applied to a transcoded drawer.
2323 Each filter is called with three arguments: the transcoded data,
2324 as a string, the back-end, as a symbol, and the communication
2328 "List of functions applied to a transcoded dynamic-block.
2329 Each filter is called with three arguments: the transcoded data,
2330 as a string, the back-end, as a symbol, and the communication
2334 "List of functions applied to a transcoded example-block.
2335 Each filter is called with three arguments: the transcoded data,
2336 as a string, the back-end, as a symbol, and the communication
2340 "List of functions applied to a transcoded export-block.
2341 Each filter is called with three arguments: the transcoded data,
2342 as a string, the back-end, as a symbol, and the communication
2346 "List of functions applied to a transcoded fixed-width.
2347 Each filter is called with three arguments: the transcoded data,
2348 as a string, the back-end, as a symbol, and the communication
2352 "List of functions applied to a transcoded footnote-definition.
2353 Each filter is called with three arguments: the transcoded data,
2354 as a string, the back-end, as a symbol, and the communication
2358 "List of functions applied to a transcoded headline.
2359 Each filter is called with three arguments: the transcoded data,
2360 as a string, the back-end, as a symbol, and the communication
2364 "List of functions applied to a transcoded horizontal-rule.
2365 Each filter is called with three arguments: the transcoded data,
2366 as a string, the back-end, as a symbol, and the communication
2370 "List of functions applied to a transcoded inlinetask.
2371 Each filter is called with three arguments: the transcoded data,
2372 as a string, the back-end, as a symbol, and the communication
2376 "List of functions applied to a transcoded item.
2377 Each filter is called with three arguments: the transcoded data,
2378 as a string, the back-end, as a symbol, and the communication
2382 "List of functions applied to a transcoded keyword.
2383 Each filter is called with three arguments: the transcoded data,
2384 as a string, the back-end, as a symbol, and the communication
2388 "List of functions applied to a transcoded latex-environment.
2389 Each filter is called with three arguments: the transcoded data,
2390 as a string, the back-end, as a symbol, and the communication
2394 "List of functions applied to a transcoded node-property.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2400 "List of functions applied to a transcoded paragraph.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2406 "List of functions applied to a transcoded plain-list.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2412 "List of functions applied to a transcoded planning.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2418 "List of functions applied to a transcoded property-drawer.
2419 Each filter is called with three arguments: the transcoded data,
2420 as a string, the back-end, as a symbol, and the communication
2424 "List of functions applied to a transcoded quote block.
2425 Each filter is called with three arguments: the transcoded quote
2426 data, as a string, the back-end, as a symbol, and the
2427 communication channel, as a plist. It must return a string or
2431 "List of functions applied to a transcoded quote-section.
2432 Each filter is called with three arguments: the transcoded data,
2433 as a string, the back-end, as a symbol, and the communication
2437 "List of functions applied to a transcoded section.
2438 Each filter is called with three arguments: the transcoded data,
2439 as a string, the back-end, as a symbol, and the communication
2443 "List of functions applied to a transcoded special block.
2444 Each filter is called with three arguments: the transcoded data,
2445 as a string, the back-end, as a symbol, and the communication
2449 "List of functions applied to a transcoded src-block.
2450 Each filter is called with three arguments: the transcoded data,
2451 as a string, the back-end, as a symbol, and the communication
2455 "List of functions applied to a transcoded table.
2456 Each filter is called with three arguments: the transcoded data,
2457 as a string, the back-end, as a symbol, and the communication
2461 "List of functions applied to a transcoded table-cell.
2462 Each filter is called with three arguments: the transcoded data,
2463 as a string, the back-end, as a symbol, and the communication
2467 "List of functions applied to a transcoded table-row.
2468 Each filter is called with three arguments: the transcoded data,
2469 as a string, the back-end, as a symbol, and the communication
2473 "List of functions applied to a transcoded verse block.
2474 Each filter is called with three arguments: the transcoded data,
2475 as a string, the back-end, as a symbol, and the communication
2479 ;;;; Objects Filters
2482 "List of functions applied to transcoded bold text.
2483 Each filter is called with three arguments: the transcoded data,
2484 as a string, the back-end, as a symbol, and the communication
2488 "List of functions applied to transcoded code text.
2489 Each filter is called with three arguments: the transcoded data,
2490 as a string, the back-end, as a symbol, and the communication
2494 "List of functions applied to a transcoded entity.
2495 Each filter is called with three arguments: the transcoded data,
2496 as a string, the back-end, as a symbol, and the communication
2500 "List of functions applied to a transcoded export-snippet.
2501 Each filter is called with three arguments: the transcoded data,
2502 as a string, the back-end, as a symbol, and the communication
2506 "List of functions applied to a transcoded footnote-reference.
2507 Each filter is called with three arguments: the transcoded data,
2508 as a string, the back-end, as a symbol, and the communication
2512 "List of functions applied to a transcoded inline-babel-call.
2513 Each filter is called with three arguments: the transcoded data,
2514 as a string, the back-end, as a symbol, and the communication
2518 "List of functions applied to a transcoded inline-src-block.
2519 Each filter is called with three arguments: the transcoded data,
2520 as a string, the back-end, as a symbol, and the communication
2524 "List of functions applied to transcoded italic text.
2525 Each filter is called with three arguments: the transcoded data,
2526 as a string, the back-end, as a symbol, and the communication
2530 "List of functions applied to a transcoded latex-fragment.
2531 Each filter is called with three arguments: the transcoded data,
2532 as a string, the back-end, as a symbol, and the communication
2536 "List of functions applied to a transcoded line-break.
2537 Each filter is called with three arguments: the transcoded data,
2538 as a string, the back-end, as a symbol, and the communication
2542 "List of functions applied to a transcoded link.
2543 Each filter is called with three arguments: the transcoded data,
2544 as a string, the back-end, as a symbol, and the communication
2548 "List of functions applied to a transcoded macro.
2549 Each filter is called with three arguments: the transcoded data,
2550 as a string, the back-end, as a symbol, and the communication
2554 "List of functions applied to a transcoded radio-target.
2555 Each filter is called with three arguments: the transcoded data,
2556 as a string, the back-end, as a symbol, and the communication
2560 "List of functions applied to a transcoded statistics-cookie.
2561 Each filter is called with three arguments: the transcoded data,
2562 as a string, the back-end, as a symbol, and the communication
2566 "List of functions applied to transcoded strike-through text.
2567 Each filter is called with three arguments: the transcoded data,
2568 as a string, the back-end, as a symbol, and the communication
2572 "List of functions applied to a transcoded subscript.
2573 Each filter is called with three arguments: the transcoded data,
2574 as a string, the back-end, as a symbol, and the communication
2578 "List of functions applied to a transcoded superscript.
2579 Each filter is called with three arguments: the transcoded data,
2580 as a string, the back-end, as a symbol, and the communication
2584 "List of functions applied to a transcoded target.
2585 Each filter is called with three arguments: the transcoded data,
2586 as a string, the back-end, as a symbol, and the communication
2590 "List of functions applied to a transcoded timestamp.
2591 Each filter is called with three arguments: the transcoded data,
2592 as a string, the back-end, as a symbol, and the communication
2596 "List of functions applied to transcoded underline text.
2597 Each filter is called with three arguments: the transcoded data,
2598 as a string, the back-end, as a symbol, and the communication
2602 "List of functions applied to transcoded verbatim text.
2603 Each filter is called with three arguments: the transcoded data,
2604 as a string, the back-end, as a symbol, and the communication
2608 ;;;; Filters Tools
2609 ;;
2610 ;; Internal function `org-export-install-filters' installs filters
2611 ;; hard-coded in back-ends (developer filters) and filters from global
2612 ;; variables (user filters) in the communication channel.
2613 ;;
2614 ;; Internal function `org-export-filter-apply-functions' takes care
2615 ;; about applying each filter in order to a given data. It ignores
2616 ;; filters returning a nil value but stops whenever a filter returns
2617 ;; an empty string.
2620 "Call every function in FILTERS.
2622 Functions are called with arguments VALUE, current export
2623 back-end and INFO. A function returning a nil value will be
2624 skipped. If it returns the empty string, the process ends and
2625 VALUE is ignored.
2627 Call is done in a LIFO fashion, to be sure that developer
2628 specified filters, if any, are called first."
2637 "Install filters properties in communication channel.
2638 INFO is a plist containing the current communication channel.
2639 Return the updated communication channel."
2641 ;; Install user-defined filters with `org-export-filters-alist'
2642 ;; and filters already in INFO (through ext-plist mechanism).
2649 ;; Filters in INFO will be called
2650 ;; before those user provided.
2653 default-value)))))
2654 org-export-filters-alist)
2655 ;; Prepend back-end specific filters to that list.
2657 ;; Single values get consed, lists are appended.
2662 plist key
2666 ;; Return new communication channel.
2670 \f
2671 ;;; Core functions
2672 ;;
2673 ;; This is the room for the main function, `org-export-as', along with
2674 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2675 ;; `org-export-string-as'. They differ either by the way they output
2676 ;; the resulting code (for the first two) or by the input type (for
2677 ;; the latter).
2678 ;;
2679 ;; `org-export-output-file-name' is an auxiliary function meant to be
2680 ;; used with `org-export-to-file'. With a given extension, it tries
2681 ;; to provide a canonical file name to write export output to.
2682 ;;
2683 ;; Note that `org-export-as' doesn't really parse the current buffer,
2684 ;; but a copy of it (with the same buffer-local variables and
2685 ;; visibility), where macros and include keywords are expanded and
2686 ;; Babel blocks are executed, if appropriate.
2687 ;; `org-export-with-buffer-copy' macro prepares that copy.
2688 ;;
2689 ;; File inclusion is taken care of by
2690 ;; `org-export-expand-include-keyword' and
2691 ;; `org-export--prepare-file-contents'. Structure wise, including
2692 ;; a whole Org file in a buffer often makes little sense. For
2693 ;; example, if the file contains a headline and the include keyword
2694 ;; was within an item, the item should contain the headline. That's
2695 ;; why file inclusion should be done before any structure can be
2696 ;; associated to the file, that is before parsing.
2699 "Return a copy of the current buffer.
2700 The copy preserves Org buffer-local variables, visibility and
2701 narrowing."
2707 new-buf))
2710 "Apply BODY in a copy of the current buffer.
2711 The copy preserves local variables, visibility and contents of
2712 the original buffer. Point is at the beginning of the buffer
2713 when BODY is applied."
2722 ;; Kill copy without confirmation.
2728 "Generate a function duplicating BUFFER.
2730 The copy will preserve local variables, visibility, contents and
2731 narrowing of the original buffer. If a region was active in
2732 BUFFER, contents will be narrowed to that region instead.
2734 The resulting function can be eval'ed at a later time, from
2735 another buffer, effectively cloning the original buffer there."
2739 ;; Buffer local variables.
2749 default-directory
2750 buffer-file-name
2751 buffer-file-coding-system
2752 outline-level
2753 outline-regexp
2754 buffer-invisibility-spec))
2757 ;; Skip unreadable values, as they cannot be
2758 ;; sent to external process.
2762 local-vars)))))
2764 local-vars)
2765 ;; Whole buffer contents.
2770 ;; Narrowing.
2774 ;; Current position of point.
2776 ;; Overlays with invisible property.
2786 ov-set))))
2788 ov-set)))))
2790 ;;;###autoload
2793 "Transcode current Org buffer into BACKEND code.
2795 If narrowing is active in the current buffer, only transcode its
2796 narrowed part.
2798 If a region is active, transcode that region.
2800 When optional argument SUBTREEP is non-nil, transcode the
2801 sub-tree at point, extracting information from the headline
2802 properties first.
2804 When optional argument VISIBLE-ONLY is non-nil, don't export
2805 contents of hidden elements.
2807 When optional argument BODY-ONLY is non-nil, only return body
2808 code, without surrounding template.
2810 Optional argument EXT-PLIST, when provided, is a property list
2811 with external parameters overriding Org default settings, but
2812 still inferior to file-local settings.
2814 Return code as a string."
2818 ;; Narrow buffer to an appropriate region or subtree for
2819 ;; parsing. If parsing subtree, be sure to remove main headline
2820 ;; too.
2828 ;; Initialize communication channel with original buffer
2829 ;; attributes, unavailable in its copy.
2831 ;; Update communication channel and get parse tree. Buffer
2832 ;; isn't parsed directly. Instead, a temporary copy is
2833 ;; created, where include keywords, macros are expanded and
2834 ;; code blocks are evaluated.
2836 ;; Run first hook with current back-end as argument.
2839 ;; Update macro templates since #+INCLUDE keywords might have
2840 ;; added some new ones.
2844 ;; Update radio targets since keyword inclusion might have
2845 ;; added some more.
2847 ;; Run last hook with current back-end as argument.
2850 ;; Update communication channel with environment. Also
2851 ;; install user's and developer's filters.
2856 ;; Expand export-specific set of macros: {{{author}}},
2857 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2858 ;; once regular macros have been expanded, since document
2859 ;; keywords may contain one of them.
2865 ;; EMAIL is not a parsed keyword: store it as-is.
2869 ;; Call options filters and update export options. We do not
2870 ;; use `org-export-filter-apply-functions' here since the
2871 ;; arity of such filters is different.
2875 ;; Parse buffer and call parse-tree filter on it.
2880 ;; Now tree is complete, compute its properties and add them
2881 ;; to communication channel.
2885 ;; Eventually transcode TREE. Wrap the resulting string into
2886 ;; a template.
2895 ;; Remove all text properties since they cannot be
2896 ;; retrieved from an external process. Finally call
2897 ;; final-output filter and return result.
2903 info))))))))
2905 ;;;###autoload
2908 "Call `org-export-as' with output to a specified buffer.
2910 BACKEND is the back-end used for transcoding, as a symbol.
2912 BUFFER is the output buffer. If it already exists, it will be
2913 erased first, otherwise, it will be created.
2915 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2916 EXT-PLIST are similar to those used in `org-export-as', which
2917 see.
2919 If `org-export-copy-to-kill-ring' is non-nil, add buffer contents
2920 to kill ring. Return buffer."
2927 ;; Maybe add buffer contents to kill ring.
2930 ;; Return buffer.
2931 buffer))
2933 ;;;###autoload
2936 "Call `org-export-as' with output to a specified file.
2938 BACKEND is the back-end used for transcoding, as a symbol. FILE
2939 is the name of the output file, as a string.
2941 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2942 EXT-PLIST are similar to those used in `org-export-as', which
2943 see.
2945 If `org-export-copy-to-kill-ring' is non-nil, add file contents
2946 to kill ring. Return output file's name."
2947 ;; Checks for FILE permissions. `write-file' would do the same, but
2948 ;; we'd rather avoid needless transcoding of parse tree.
2950 ;; Insert contents to a temporary buffer and write it to FILE.
2956 ;; Maybe add file contents to kill ring.
2959 ;; Return full path.
2960 file)
2962 ;;;###autoload
2964 "Transcode STRING into BACKEND code.
2966 When optional argument BODY-ONLY is non-nil, only return body
2967 code, without preamble nor postamble.
2969 Optional argument EXT-PLIST, when provided, is a property list
2970 with external parameters overriding Org default settings, but
2971 still inferior to file-local settings.
2973 Return code as a string."
2980 "Return output file's name according to buffer specifications.
2982 EXTENSION is a string representing the output file extension,
2983 with the leading dot.
2985 With a non-nil optional argument SUBTREEP, try to determine
2987 of subtree at point.
2989 When optional argument PUB-DIR is set, use it as the publishing
2990 directory.
2992 When optional argument VISIBLE-ONLY is non-nil, don't export
2993 contents of hidden elements.
2995 Return file name as a string."
2998 ;; File name may come from EXPORT_FILE_NAME subtree
2999 ;; property, assuming point is at beginning of said
3000 ;; sub-tree.
3007 ;; File name may be extracted from buffer's associated
3008 ;; file, if any.
3010 ;; Can't determine file name on our own: Ask user.
3014 "Output file: " pub-dir nil nil nil
3018 ;; Build file name. Enforce EXTENSION over whatever user
3019 ;; may have come up with. PUB-DIR, if defined, always has
3020 ;; precedence over any provided path.
3025 extension))
3028 ;; If writing to OUTPUT-FILE would overwrite original file, append
3029 ;; EXTENSION another time to final name.
3032 output-file)))
3035 "Expand every include keyword in buffer.
3036 Optional argument INCLUDED is a list of included file names along
3037 with their line restriction, when appropriate. It is used to
3038 avoid infinite recursion. Optional argument DIR is the current
3039 working directory. It is used to properly resolve relative
3040 paths."
3047 ;; Extract arguments from keyword's value.
3061 ;; Minimal level of included file defaults to the child
3062 ;; level of the current headline, if any, or one. It
3063 ;; only applies is the file is meant to be included as
3064 ;; an Org one.
3072 ;; Remove keyword.
3077 ;; Check if files has already been parsed. Look after
3078 ;; inclusion lines too, as different parts of the same file
3079 ;; can be included too.
3091 ind-str contents ind-str))))
3099 ind-str env contents ind-str))))
3112 "Prepare the contents of FILE for inclusion and return them as a string.
3114 When optional argument LINES is a string specifying a range of
3115 lines, include only those lines.
3117 Optional argument IND, when non-nil, is an integer specifying the
3118 global indentation of returned contents. Since its purpose is to
3119 allow an included file to stay in the same environment it was
3120 created \(i.e. a list item), it doesn't apply past the first
3121 headline encountered.
3123 Optional argument MINLEVEL, when non-nil, is an integer
3124 specifying the level that any top-level headline in the included
3125 file should have."
3141 ;; Remove blank lines at beginning and end of contents. The logic
3142 ;; behind that removal is that blank lines around include keyword
3143 ;; override blank lines in included file.
3152 ;; If IND is set, preserve indentation of include keyword until
3153 ;; the first headline encountered.
3159 ;; Do not move footnote definitions out of column 0.
3165 ;; When MINLEVEL is specified, compute minimal level for headlines
3166 ;; in the file (CUR-MIN), and remove stars to each headline so
3167 ;; that headlines with minimal level have a level of MINLEVEL.
3177 ;; Only change stars, don't bother moving whole
3178 ;; sections.
3185 "Execute every Babel code in the visible part of current buffer."
3186 ;; Get a pristine copy of current buffer so Babel references can be
3187 ;; properly resolved.
3194 \f
3195 ;;; Tools For Back-Ends
3196 ;;
3197 ;; A whole set of tools is available to help build new exporters. Any
3198 ;; function general enough to have its use across many back-ends
3199 ;; should be added here.
3201 ;;;; For Affiliated Keywords
3202 ;;
3203 ;; `org-export-read-attribute' reads a property from a given element
3204 ;; as a plist. It can be used to normalize affiliated keywords'
3205 ;; syntax.
3206 ;;
3207 ;; Since captions can span over multiple lines and accept dual values,
3208 ;; their internal representation is a bit tricky. Therefore,
3209 ;; `org-export-get-caption' transparently returns a given element's
3210 ;; caption as a secondary string.
3213 "Turn ATTRIBUTE property from ELEMENT into a plist.
3215 When optional argument PROPERTY is non-nil, return the value of
3216 that property within attributes.
3220 properties."
3228 "Return caption from ELEMENT as a secondary string.
3230 When optional argument SHORTP is non-nil, return short caption,
3231 as a secondary string, instead.
3233 Caption lines are separated by a white space."
3241 ;;;; For Derived Back-ends
3242 ;;
3243 ;; `org-export-with-backend' is a function allowing to locally use
3244 ;; another back-end to transcode some object or element. In a derived
3245 ;; back-end, it may be used as a fall-back function once all specific
3246 ;; cases have been treated.
3249 "Call a transcoder from BACK-END on DATA.
3250 CONTENTS, when non-nil, is the transcoded contents of DATA
3251 element, as a string. INFO, when non-nil, is the communication
3252 channel used for export, as a plist.."
3262 ;;;; For Export Snippets
3263 ;;
3264 ;; Every export snippet is transmitted to the back-end. Though, the
3265 ;; latter will only retain one type of export-snippet, ignoring
3266 ;; others, based on the former's target back-end. The function
3267 ;; `org-export-snippet-backend' returns that back-end for a given
3268 ;; export-snippet.
3271 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3272 Translation, with `org-export-snippet-translation-alist', is
3273 applied."
3277 back-end))))
3280 ;;;; For Footnotes
3281 ;;
3282 ;; `org-export-collect-footnote-definitions' is a tool to list
3283 ;; actually used footnotes definitions in the whole parse tree, or in
3284 ;; a headline, in order to add footnote listings throughout the
3285 ;; transcoded data.
3286 ;;
3287 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3288 ;; back-ends, when they need to attach the footnote definition only to
3289 ;; the first occurrence of the corresponding label.
3290 ;;
3291 ;; `org-export-get-footnote-definition' and
3292 ;; `org-export-get-footnote-number' provide easier access to
3293 ;; additional information relative to a footnote reference.
3296 "Return an alist between footnote numbers, labels and definitions.
3298 DATA is the parse tree from which definitions are collected.
3299 INFO is the plist used as a communication channel.
3301 Definitions are sorted by order of references. They either
3302 appear as Org data or as a secondary string for inlined
3303 footnotes. Unreferenced definitions are ignored."
3305 collect-fn ; for byte-compiler.
3309 ;; Collect footnote number, label and definition in DATA.
3317 def)
3318 num-alist)
3319 ;; Also search in definition for nested footnotes.
3322 ;; Don't enter footnote definitions since it will happen
3323 ;; when their first reference is found.
3329 "Non-nil when a footnote reference is the first one for its label.
3331 FOOTNOTE-REFERENCE is the footnote reference being considered.
3332 INFO is the plist used as a communication channel."
3334 ;; Anonymous footnotes are always a first reference.
3336 ;; Otherwise, return the first footnote with the same LABEL and
3337 ;; test if it is equal to FOOTNOTE-REFERENCE.
3347 ;; If FN isn't inlined, be sure to traverse its
3348 ;; definition before resuming search. See
3349 ;; comments in `org-export-get-footnote-number'
3350 ;; for more information.
3354 ;; Don't enter footnote definitions since it will
3355 ;; happen when their first reference is found.
3358 footnote-reference)))))
3361 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3362 INFO is the plist used as a communication channel. If no such
3364 string."
3371 "Return number associated to a footnote.
3373 FOOTNOTE is either a footnote reference or a footnote definition.
3374 INFO is the plist used as a communication channel."
3376 seen-refs
3377 search-ref ; For byte-compiler.
3381 ;; Search footnote references through DATA, filling
3382 ;; SEEN-REFS along the way.
3387 ;; Anonymous footnote match: return number.
3390 ;; Labels match: return number.
3393 ;; Anonymous footnote: it's always a new one.
3394 ;; Also, be sure to return nil from the `cond' so
3395 ;; `first-match' doesn't get us out of the loop.
3397 ;; Label not seen so far: add it so SEEN-REFS.
3398 ;;
3399 ;; Also search for subsequent references in
3400 ;; footnote definition so numbering follows
3401 ;; reading logic. Note that we don't have to care
3402 ;; about inline definitions, since
3403 ;; `org-element-map' already traverses them at the
3404 ;; right time.
3405 ;;
3406 ;; Once again, return nil to stay in the loop.
3411 nil))))
3412 ;; Don't enter footnote definitions since it will
3413 ;; happen when their first reference is found.
3418 ;;;; For Headlines
3419 ;;
3420 ;; `org-export-get-relative-level' is a shortcut to get headline
3421 ;; level, relatively to the lower headline level in the parsed tree.
3422 ;;
3423 ;; `org-export-get-headline-number' returns the section number of an
3424 ;; headline, while `org-export-number-to-roman' allows to convert it
3425 ;; to roman numbers.
3426 ;;
3427 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3428 ;; `org-export-last-sibling-p' are three useful predicates when it
3429 ;; comes to fulfill the `:headline-levels' property.
3430 ;;
3431 ;; `org-export-get-tags', `org-export-get-category' and
3432 ;; `org-export-get-node-property' extract useful information from an
3433 ;; headline or a parent headline. They all handle inheritance.
3434 ;;
3435 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3436 ;; as a secondary string, suitable for table of contents. It falls
3437 ;; back onto default title.
3440 "Return HEADLINE relative level within current parsed tree.
3441 INFO is a plist holding contextual information."
3446 "Non-nil when HEADLINE is considered as low level.
3448 INFO is a plist used as a communication channel.
3450 A low level headlines has a relative level greater than
3451 `:headline-levels' property value.
3453 Return value is the difference between HEADLINE relative level
3454 and the last level being considered as high enough, or nil."
3461 "Return HEADLINE numbering as a list of numbers.
3462 INFO is a plist holding contextual information."
3466 "Return a non-nil value if HEADLINE element should be numbered.
3467 INFO is a plist used as a communication channel."
3473 "Convert integer N into a roman numeral."
3486 res)))
3489 "Return list of tags associated to ELEMENT.
3491 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3492 is a plist used as a communication channel.
3494 Select tags (see `org-export-select-tags') and exclude tags (see
3495 `org-export-exclude-tags') are removed from the list.
3497 When non-nil, optional argument TAGS should be a list of strings.
3498 Any tag belonging to this list will also be removed.
3500 When optional argument INHERITED is non-nil, tags can also be
3501 inherited from parent headlines and FILETAGS keywords."
3507 ;; Build complete list of inherited tags.
3518 ;; Add FILETAGS keywords and return results.
3522 "Return node PROPERTY value for BLOB.
3524 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3525 element or object.
3527 If optional argument INHERITED is non-nil, the value can be
3528 inherited from a parent headline.
3530 Return value is a string or nil."
3542 "Return category for element or object BLOB.
3544 INFO is a plist used as a communication channel.
3546 CATEGORY is automatically inherited from a parent headline, from
3547 #+CATEGORY: keyword or created out of original file name. If all
3551 ;; Almost like `org-export-node-property', but we cannot trust
3552 ;; `plist-member' as every headline has a `:CATEGORY'
3553 ;; property, would it be nil or equal to "???" (which has the
3554 ;; same meaning).
3572 "Return alternative title for HEADLINE, as a secondary string.
3573 INFO is a plist used as a communication channel. If no optional
3574 title is defined, fall-back to the regular title."
3579 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3580 INFO is a plist used as a communication channel."
3585 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3586 INFO is a plist used as a communication channel."
3590 ;;;; For Links
3591 ;;
3592 ;; `org-export-solidify-link-text' turns a string into a safer version
3593 ;; for links, replacing most non-standard characters with hyphens.
3594 ;;
3595 ;; `org-export-get-coderef-format' returns an appropriate format
3596 ;; string for coderefs.
3597 ;;
3598 ;; `org-export-inline-image-p' returns a non-nil value when the link
3599 ;; provided should be considered as an inline image.
3600 ;;
3601 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3602 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3603 ;; returns an appropriate unique identifier when found, or nil.
3604 ;;
3605 ;; `org-export-resolve-id-link' returns the first headline with
3606 ;; specified id or custom-id in parse tree, the path to the external
3607 ;; file with the id or nil when neither was found.
3608 ;;
3609 ;; `org-export-resolve-coderef' associates a reference to a line
3610 ;; number in the element it belongs, or returns the reference itself
3611 ;; when the element isn't numbered.
3614 "Take link text S and make a safe target out of it."
3619 "Return format string for code reference link.
3620 PATH is the link path. DESC is its description."
3628 "Non-nil if LINK object points to an inline image.
3630 Optional argument is a set of RULES defining inline images. It
3631 is an alist where associations have the following shape:
3633 \(TYPE . REGEXP)
3635 Applying a rule means apply REGEXP against LINK's path when its
3636 type is TYPE. The function will return a non-nil value if any of
3637 the provided rules is non-nil. The default rule is
3638 `org-export-default-inline-image-rule'.
3640 This only applies to links without a description."
3651 rules)
3652 ;; Return nil if no rule matched.
3653 nil))))
3656 "Resolve a code reference REF.
3658 INFO is a plist used as a communication channel.
3660 Return associated line number in source code, or REF itself,
3661 depending on src-block or example element's switches."
3668 org-coderef-label-format)))
3672 ;; Element containing REF is found. Resolve it to either
3673 ;; a label or a line number, as needed.
3683 "Return LINK destination.
3685 INFO is a plist holding contextual information.
3687 Return value can be an object, an element, or nil:
3689 - If LINK path matches a target object (i.e. <<path>>) or
3692 - If LINK path exactly matches the name affiliated keyword
3693 \(i.e. #+NAME: path) of an element, return that element.
3695 - If LINK path exactly matches any headline name, return that
3696 element. If more than one headline share that name, priority
3697 will be given to the one with the closest common ancestor, if
3698 any, or the first one in the parse tree otherwise.
3700 - Otherwise, return nil.
3703 significant."
3706 ;; Split PATH at white spaces so matches are space
3707 ;; insensitive.
3711 ;; First try to find a matching "<<path>>" unless user specified
3712 ;; he was looking for a headline (path starts with a *
3713 ;; character).
3720 path)
3721 blob))
3722 info t)))
3723 ;; Then try to find an element with a matching "#+NAME: path"
3724 ;; affiliated keyword.
3727 org-element-all-elements
3732 ;; Last case: link either points to a headline or to
3733 ;; nothingness. Try to find the source, with priority given to
3734 ;; headlines with the closest common ancestor. If such candidate
3735 ;; is found, return it, otherwise return nil.
3739 ;; Return first headline whose `:raw-value' property is
3740 ;; NAME in parse tree DATA, or nil. Statistics cookies
3741 ;; are ignored.
3749 name)
3750 headline))
3752 ;; Search among headlines sharing an ancestor with link, from
3753 ;; closest to farthest.
3761 ;; No match with a common ancestor: try full parse-tree.
3765 "Return headline referenced as LINK destination.
3767 INFO is a plist used as a communication channel.
3769 Return value can be the headline element matched in current parse
3773 ;; First check if id is within the current parse tree.
3778 headline))
3780 ;; Otherwise, look for external files.
3784 "Return radio-target object referenced as LINK destination.
3786 INFO is a plist used as a communication channel.
3788 Return value can be a radio-target object or nil. Assume LINK
3795 radio))
3799 ;;;; For References
3800 ;;
3801 ;; `org-export-get-ordinal' associates a sequence number to any object
3802 ;; or element.
3805 "Return ordinal number of an element or object.
3807 ELEMENT is the element or object considered. INFO is the plist
3808 used as a communication channel.
3810 Optional argument TYPES, when non-nil, is a list of element or
3811 object types, as symbols, that should also be counted in.
3812 Otherwise, only provided element's type is considered.
3814 Optional argument PREDICATE is a function returning a non-nil
3815 value if the current element or object should be counted in. It
3816 accepts two arguments: the element or object being considered and
3817 the plist used as a communication channel. This allows to count
3818 only a certain type of objects (i.e. inline images).
3820 Return value is a list of numbers if ELEMENT is a headline or an
3821 item. It is nil for keywords. It represents the footnote number
3822 for footnote definitions and footnote references. If ELEMENT is
3823 a target, return the same value as if ELEMENT was the closest
3824 table, item or headline containing the target. In any other
3825 case, return the sequence number of ELEMENT among elements or
3826 objects of the same type."
3827 ;; A target keyword, representing an invisible target, never has
3828 ;; a sequence number.
3830 ;; Ordinal of a target object refer to the ordinal of the closest
3831 ;; table, item, or headline containing the object.
3835 when
3839 table))
3840 return parent)))
3842 ;; Special case 1: A headline returns its number as a list.
3844 ;; Special case 2: An item returns its number as a list.
3848 struct
3855 ;; Increment counter until ELEMENT is found again.
3866 ;;;; For Src-Blocks
3867 ;;
3868 ;; `org-export-get-loc' counts number of code lines accumulated in
3869 ;; src-block or example-block elements with a "+n" switch until
3870 ;; a given element, excluded. Note: "-n" switches reset that count.
3871 ;;
3872 ;; `org-export-unravel-code' extracts source code (along with a code
3873 ;; references alist) from an `element-block' or `src-block' type
3874 ;; element.
3875 ;;
3876 ;; `org-export-format-code' applies a formatting function to each line
3877 ;; of code, providing relative line number and code reference when
3878 ;; appropriate. Since it doesn't access the original element from
3879 ;; which the source code is coming, it expects from the code calling
3880 ;; it to know if lines should be numbered and if code references
3881 ;; should appear.
3882 ;;
3883 ;; Eventually, `org-export-format-code-default' is a higher-level
3884 ;; function (it makes use of the two previous functions) which handles
3885 ;; line numbering and code references inclusion, and returns source
3886 ;; code in a format suitable for plain text or verbatim output.
3889 "Return accumulated lines of code up to ELEMENT.
3891 INFO is the plist used as a communication channel.
3893 ELEMENT is excluded from count."
3899 ;; ELEMENT is reached: Quit the loop.
3901 ;; Only count lines from src-block and example-block elements
3902 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3906 ;; Accumulate locs or reset them.
3910 ;; Return nil to stay in the loop.
3911 nil)))
3913 ;; Return value.
3914 loc))
3917 "Clean source code and extract references out of it.
3919 ELEMENT has either a `src-block' an `example-block' type.
3921 Return a cons cell whose CAR is the source code, cleaned from any
3922 reference and protective comma and CDR is an alist between
3923 relative line number (integer) and name of code reference on that
3924 line (string)."
3926 ;; Get code and clean it. Remove blank lines at its
3927 ;; beginning and end.
3933 ;; If appropriate, remove global indentation.
3936 c
3938 ;; Get format used for references.
3941 org-coderef-label-format)))
3942 ;; Build a regexp matching a loc with a reference.
3947 ;; Return value.
3949 ;; Code with references removed.
3955 ;; Ref line: remove ref, and signal its position in REFS.
3959 ;; Reference alist.
3960 refs)))
3963 "Format CODE by applying FUN line-wise and return it.
3965 CODE is a string representing the code to format. FUN is
3966 a function. It must accept three arguments: a line of
3967 code (string), the current line number (integer) or nil and the
3968 reference associated to the current line (string) or nil.
3970 Optional argument NUM-LINES can be an integer representing the
3971 number of code lines accumulated until the current code. Line
3972 numbers passed to FUN will take it into account. If it is nil,
3973 FUN's second argument will always be nil. This number can be
3974 obtained with `org-export-get-loc' function.
3976 Optional argument REF-ALIST can be an alist between relative line
3977 number (i.e. ignoring NUM-LINES) and the name of the code
3978 reference on it. If it is nil, FUN's third argument will always
3979 be nil. It can be obtained through the use of
3980 `org-export-unravel-code' function."
3992 "Return source code from ELEMENT, formatted in a standard way.
3994 ELEMENT is either a `src-block' or `example-block' element. INFO
3995 is a plist used as a communication channel.
3997 This function takes care of line numbering and code references
3998 inclusion. Line numbers, when applicable, appear at the
3999 beginning of the line, separated from the code by two white
4000 spaces. Code references, on the other hand, appear flushed to
4001 the right, separated by six white spaces from the widest line of
4002 code."
4003 ;; Extract code and references.
4009 ;; Handle line numbering.
4018 ;; Prepare references display, if required. Any reference
4019 ;; should start six columns after the widest line of code,
4020 ;; wrapped with parenthesis.
4025 code
4029 number-str
4030 loc
4036 num-start refs)))
4039 ;;;; For Tables
4040 ;;
4041 ;; `org-export-table-has-special-column-p' and and
4042 ;; `org-export-table-row-is-special-p' are predicates used to look for
4043 ;; meta-information about the table structure.
4044 ;;
4045 ;; `org-table-has-header-p' tells when the rows before the first rule
4046 ;; should be considered as table's header.
4047 ;;
4048 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4049 ;; and `org-export-table-cell-borders' extract information from
4050 ;; a table-cell element.
4051 ;;
4052 ;; `org-export-table-dimensions' gives the number on rows and columns
4053 ;; in the table, ignoring horizontal rules and special columns.
4054 ;; `org-export-table-cell-address', given a table-cell object, returns
4055 ;; the absolute address of a cell. On the other hand,
4056 ;; `org-export-get-table-cell-at' does the contrary.
4057 ;;
4058 ;; `org-export-table-cell-starts-colgroup-p',
4059 ;; `org-export-table-cell-ends-colgroup-p',
4060 ;; `org-export-table-row-starts-rowgroup-p',
4061 ;; `org-export-table-row-ends-rowgroup-p',
4062 ;; `org-export-table-row-starts-header-p' and
4063 ;; `org-export-table-row-ends-header-p' indicate position of current
4064 ;; row or cell within the table.
4067 "Non-nil when TABLE has a special column.
4068 All special columns will be ignored during export."
4069 ;; The table has a special column when every first cell of every row
4070 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4071 ;; "*" "_" and "^". Though, do not consider a first row containing
4072 ;; only empty cells as special.
4088 "Non-nil when TABLE has an header.
4090 INFO is a plist used as a communication channel.
4092 A table has an header when it contains at least two row groups."
4102 info)))
4105 "Non-nil if TABLE-ROW is considered special.
4107 INFO is a plist used as the communication channel.
4109 All special rows will be ignored during export."
4113 ;; A row is special either when...
4115 ;; ... it starts with a field only containing "/",
4117 ;; ... the table contains a special column and the row start
4118 ;; with a marking character among, "^", "_", "$" or "!",
4122 ;; ... it contains only alignment cookies and empty cells.
4128 ;; Since VALUE is a secondary string, the following
4129 ;; checks avoid expanding it with `org-export-data'.
4141 "Return TABLE-ROW's group.
4143 INFO is a plist used as the communication channel.
4145 Return value is the group number, as an integer, or nil special
4146 rows and table rules. Group 1 is also table's header."
4163 "Return TABLE-CELL contents width.
4165 INFO is a plist used as the communication channel.
4167 Return value is the width given by the last width cookie in the
4168 same column as TABLE-CELL, or nil."
4173 cookie-width)
4177 ;; In a special row, try to find a width cookie at COLUMN.
4181 ;; The following checks avoid expanding unnecessarily the
4182 ;; cell with `org-export-data'
4190 ;; Ignore table rules.
4193 ;; Return value.
4194 cookie-width))
4197 "Return TABLE-CELL contents alignment.
4199 INFO is a plist used as the communication channel.
4201 Return alignment as specified by the last alignment cookie in the
4202 same column as TABLE-CELL. If no such cookie is found, a default
4203 alignment value will be deduced from fraction of numbers in the
4204 column (see `org-table-number-fraction' for more information).
4205 Possible values are `left', `right' and `center'."
4212 cookie-align)
4216 ;; In a special row, try to find an alignment cookie at
4217 ;; COLUMN.
4221 ;; Since VALUE is a secondary string, the following checks
4222 ;; avoid useless expansion through `org-export-data'.
4230 ;; Ignore table rules.
4232 ;; In a standard row, check if cell's contents are expressing
4233 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4234 ;; Though, don't bother if an alignment cookie has already
4235 ;; defined cell's alignment.
4240 info)))
4245 ;; Return value. Alignment specified by cookies has precedence
4246 ;; over alignment deduced from cells contents.
4255 "Return TABLE-CELL borders.
4257 INFO is a plist used as a communication channel.
4259 Return value is a list of symbols, or nil. Possible values are:
4260 `top', `bottom', `above', `below', `left' and `right'. Note:
4261 `top' (resp. `bottom') only happen for a cell in the first
4262 row (resp. last row) of the table, ignoring table rules, if any.
4264 Returned borders ignore special rows."
4267 borders)
4268 ;; Top/above border? TABLE-CELL has a border above when a rule
4269 ;; used to demarcate row groups can be found above. Hence,
4270 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4271 ;; another regular row has to be found above that rule.
4280 ;; Look at every row before the current one.
4282 ;; No rule above, or rule found starts the table (ignoring any
4283 ;; special row): TABLE-CELL is at the top of the table.
4286 ;; Bottom/below border? TABLE-CELL has a border below when next
4287 ;; non-regular row below is a rule.
4296 ;; Look at every row after the current one.
4298 ;; No rule below, or rule found ends the table (modulo some
4299 ;; special row): TABLE-CELL is at the bottom of the table.
4302 ;; Right/left borders? They can only be specified by column
4303 ;; groups. Column groups are defined in a row starting with "/".
4304 ;; Also a column groups row only contains "<", "<>", ">" or blank
4305 ;; cells.
4322 ;; There's a left border when previous cell, if
4323 ;; any, ends a group, or current one starts one.
4329 ;; There's a right border when next cell, if any,
4330 ;; starts a group, or current one ends one.
4337 ;; Table rows are read in reverse order so last column groups
4338 ;; row has precedence over any previous one.
4340 ;; Return value.
4341 borders))
4344 "Non-nil when TABLE-CELL is at the beginning of a row group.
4345 INFO is a plist used as a communication channel."
4346 ;; A cell starts a column group either when it is at the beginning
4347 ;; of a row (or after the special column, if any) or when it has
4348 ;; a left border.
4351 table-cell)
4355 "Non-nil when TABLE-CELL is at the end of a row group.
4356 INFO is a plist used as a communication channel."
4357 ;; A cell ends a column group either when it is at the end of a row
4358 ;; or when it has a right border.
4361 table-cell)
4365 "Non-nil when TABLE-ROW is at the beginning of a column group.
4366 INFO is a plist used as a communication channel."
4374 "Non-nil when TABLE-ROW is at the end of a column group.
4375 INFO is a plist used as a communication channel."
4383 "Non-nil when TABLE-ROW is the first table header's row.
4384 INFO is a plist used as a communication channel."
4391 "Non-nil when TABLE-ROW is the last table header's row.
4392 INFO is a plist used as a communication channel."
4399 "Return TABLE dimensions.
4401 INFO is a plist used as a communication channel.
4403 Return value is a CONS like (ROWS . COLUMNS) where
4404 ROWS (resp. COLUMNS) is the number of exportable
4405 rows (resp. columns)."
4407 ;; Set number of rows, and extract first one.
4413 ;; Set number of columns.
4415 ;; Return value.
4419 "Return address of a regular TABLE-CELL object.
4421 TABLE-CELL is the cell considered. INFO is a plist used as
4422 a communication channel.
4424 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4425 zero-based index. Only exportable cells are considered. The
4426 function returns nil for other cells."
4429 ;; Ignore cells in special rows or in special column.
4434 ;; Row number.
4442 ;; Column number.
4450 "Return regular table-cell object at ADDRESS in TABLE.
4452 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4453 zero-based index. TABLE is a table type element. INFO is
4454 a plist used as a communication channel.
4456 If no table-cell, among exportable cells, is found at ADDRESS,
4457 return nil."
4460 ;; Row at (car address) or nil.
4468 'table-cell
4475 ;;;; For Tables Of Contents
4476 ;;
4477 ;; `org-export-collect-headlines' builds a list of all exportable
4478 ;; headline elements, maybe limited to a certain depth. One can then
4479 ;; easily parse it and transcode it.
4480 ;;
4481 ;; Building lists of tables, figures or listings is quite similar.
4482 ;; Once the generic function `org-export-collect-elements' is defined,
4483 ;; `org-export-collect-tables', `org-export-collect-figures' and
4484 ;; `org-export-collect-listings' can be derived from it.
4487 "Collect headlines in order to build a table of contents.
4489 INFO is a plist used as a communication channel.
4491 When optional argument N is an integer, it specifies the depth of
4492 the table of contents. Otherwise, it is set to the value of the
4493 last headline level. See `org-export-headline-levels' for more
4494 information.
4496 Return a list of all exportable headlines as parsed elements.
4497 Footnote sections, if any, will be ignored."
4502 ;; Strip contents from HEADLINE.
4505 info))
4508 "Collect referenceable elements of a determined type.
4510 TYPE can be a symbol or a list of symbols specifying element
4511 types to search. Only elements with a caption are collected.
4513 INFO is a plist used as a communication channel.
4515 When non-nil, optional argument PREDICATE is a function accepting
4516 one argument, an element of type TYPE. It returns a non-nil
4517 value when that element should be collected.
4519 Return a list of all elements found, in order of appearance."
4524 element))
4525 info))
4528 "Build a list of tables.
4529 INFO is a plist used as a communication channel.
4531 Return a list of table elements with a caption."
4535 "Build a list of figures.
4537 INFO is a plist used as a communication channel. PREDICATE is
4538 a function which accepts one argument: a paragraph element and
4539 whose return value is non-nil when that element should be
4540 collected.
4542 A figure is a paragraph type element, with a caption, verifying
4544 a vague concept that may depend on back-end.
4546 Return a list of elements recognized as figures."
4550 "Build a list of src blocks.
4552 INFO is a plist used as a communication channel.
4554 Return a list of src-block elements with a caption."
4558 ;;;; Smart Quotes
4559 ;;
4560 ;; The main function for the smart quotes sub-system is
4561 ;; `org-export-activate-smart-quotes', which replaces every quote in
4562 ;; a given string from the parse tree with its "smart" counterpart.
4563 ;;
4564 ;; Dictionary for smart quotes is stored in
4565 ;; `org-export-smart-quotes-alist'.
4566 ;;
4567 ;; Internally, regexps matching potential smart quotes (checks at
4568 ;; string boundaries are also necessary) are defined in
4569 ;; `org-export-smart-quotes-regexps'.
4606 "Smart quotes translations.
4608 Alist whose CAR is a language string and CDR is an alist with
4609 quote type as key and a plist associating various encodings to
4610 their translation as value.
4612 A quote type can be any symbol among `opening-double-quote',
4613 `closing-double-quote', `opening-single-quote',
4614 `closing-single-quote' and `apostrophe'.
4616 Valid encodings include `:utf-8', `:html', `:latex' and
4617 `:texinfo'.
4623 ;; Possible opening quote at beginning of string.
4625 ;; Possible closing quote at beginning of string.
4627 ;; Possible apostrophe at beginning of string.
4629 ;; Opening single and double quotes.
4631 ;; Closing single and double quotes.
4633 ;; Apostrophe.
4635 ;; Possible opening quote at end of string.
4637 ;; Possible closing quote at end of string.
4639 ;; Possible apostrophe at end of string.
4641 "List of regexps matching a quote or an apostrophe.
4647 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4648 `:utf-8'. INFO is a plist used as a communication channel.
4650 The function has to retrieve information about string
4651 surroundings in parse tree. It can only happen with an
4652 unmodified string. Thus, if S has already been through another
4653 process, a non-nil ORIGINAL optional argument will provide that
4654 original string.
4656 Return the new string."
4659 ;; Try to be flexible when computing number of blanks
4660 ;; before object. The previous object may be a string
4661 ;; introduced by the back-end and not completely parsed.
4664 ;; A string with missing `:post-blank'
4665 ;; property.
4669 ;; Fallback value.
4674 ;; Return smart quote associated to a give quote Q, as
4675 ;; a string. TYPE is a symbol among `open', `close' and
4676 ;; `apostrophe'.
4686 org-export-smart-quotes-alist))))
4687 encoding)
4688 q)))))
4690 ;; Only a quote: no regexp can match. We have to check both
4691 ;; sides and decide what to do.
4699 ;; 1. Replace quote character at the beginning of S.
4701 ;; Apostrophe?
4707 ;; Closing quote?
4713 ;; Opening quote?
4719 ;; 2. Replace quotes in the middle of the string.
4721 ;; Opening quotes.
4727 ;; Closing quotes.
4733 ;; Apostrophes.
4738 ;; 3. Replace quote character at the end of S.
4740 ;; Apostrophe?
4745 ;; Closing quote?
4751 ;; Opening quote?
4756 ;; Return string with smart quotes.
4757 s))))
4759 ;;;; Topology
4760 ;;
4761 ;; Here are various functions to retrieve information about the
4762 ;; neighbourhood of a given element or object. Neighbours of interest
4763 ;; are direct parent (`org-export-get-parent'), parent headline
4764 ;; (`org-export-get-parent-headline'), first element containing an
4765 ;; object, (`org-export-get-parent-element'), parent table
4766 ;; (`org-export-get-parent-table'), previous element or object
4767 ;; (`org-export-get-previous-element') and next element or object
4768 ;; (`org-export-get-next-element').
4769 ;;
4770 ;; `org-export-get-genealogy' returns the full genealogy of a given
4771 ;; element or object, from closest parent to full parse tree.
4774 "Return BLOB parent or nil.
4775 BLOB is the element or object considered."
4779 "Return full genealogy relative to a given element or object.
4781 BLOB is the element or object being considered.
4783 Ancestors are returned from closest to farthest, the last one
4784 being the full parse tree."
4791 "Return BLOB parent headline or nil.
4792 BLOB is the element or object being considered."
4796 parent))
4799 "Return first element containing OBJECT or nil.
4800 OBJECT is the object to consider."
4804 parent))
4807 "Return OBJECT parent table or nil.
4808 OBJECT is either a `table-cell' or `table-element' type object."
4812 parent))
4815 "Return previous element or object.
4817 BLOB is an element or object. INFO is a plist used as
4818 a communication channel. Return previous exportable element or
4819 object, a string, or nil.
4821 When optional argument N is a positive integer, return a list
4822 containing up to N siblings before BLOB, from farthest to
4823 closest. With any other non-nil value, return a list containing
4824 all of them."
4826 ;; An object can belong to the contents of its parent or
4827 ;; to a secondary string. We check the latter option
4828 ;; first.
4831 org-element-all-elements))
4835 org-element-secondary-value-alist))
4836 parent)))
4839 prev)
4848 prev)))
4851 "Return next element or object.
4853 BLOB is an element or object. INFO is a plist used as
4854 a communication channel. Return next exportable element or
4855 object, a string, or nil.
4857 When optional argument N is a positive integer, return a list
4858 containing up to N siblings after BLOB, from closest to farthest.
4859 With any other non-nil value, return a list containing all of
4860 them."
4862 ;; An object can belong to the contents of its parent or to
4863 ;; a secondary string. We check the latter option first.
4866 org-element-all-objects))
4870 org-element-secondary-value-alist))
4871 parent)))
4874 next)
4882 siblings)
4886 ;;;; Translation
4887 ;;
4888 ;; `org-export-translate' translates a string according to language
4889 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4890 ;; variable and a specified charset. `org-export-dictionary' contains
4891 ;; the dictionary used for the translation.
5013 "Dictionary for export engine.
5015 Alist whose CAR is the string to translate and CDR is an alist
5016 whose CAR is the language string and CDR is a plist whose
5017 properties are possible charsets and values translated terms.
5019 It is used as a database for `org-export-translate'. Since this
5020 function returns the string as-is if no translation was found,
5021 the variable only needs to record values different from the
5025 "Translate string S according to language specification.
5027 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5028 and `:utf-8'. INFO is a plist used as a communication channel.
5030 Translation depends on `:language' property. Return the
5031 translated string. If no translation is found, try to fall back
5032 to `:default' encoding. If it fails, return S."
5038 s)))
5041 \f
5042 ;;; Asynchronous Export
5043 ;;
5044 ;; `org-export-async-start' is the entry point for asynchronous
5045 ;; export. It recreates current buffer (including visibility,
5046 ;; narrowing and visited file) in an external Emacs process, and
5047 ;; evaluates a command there. It then applies a function on the
5048 ;; returned results in the current process.
5049 ;;
5050 ;; Asynchronously generated results are never displayed directly.
5051 ;; Instead, they are stored in `org-export-stack-contents'. They can
5052 ;; then be retrieved by calling `org-export-stack'.
5053 ;;
5054 ;; Export Stack is viewed through a dedicated major mode
5055 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5056 ;;`org-export-stack-delete', `org-export-stack-view' and
5057 ;;`org-export-stack-clear'.
5058 ;;
5059 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5060 ;; It should used whenever `org-export-async-start' is called.
5063 "Call function FUN on the results returned by BODY evaluation.
5065 BODY evaluation happens in an asynchronous process, from a buffer
5066 which is an exact copy of the current one.
5068 Use `org-export-add-to-stack' in FUN in order to register results
5069 in the stack. Examples for, respectively a temporary buffer and
5070 a file are:
5072 \(org-export-async-start
5073 \(lambda (output)
5075 \(erase-buffer)
5076 \(insert output)
5077 \(goto-char (point-min))
5078 \(org-export-add-to-stack (current-buffer) 'backend)))
5079 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5081 and
5083 \(org-export-async-start
5084 \(lambda (f) (org-export-add-to-stack f 'backend))
5085 `(expand-file-name
5086 \(org-export-to-file
5087 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5090 ;; Write the full sexp evaluating BODY in a copy of the current
5091 ;; buffer to a temporary file, as it may be too long for program
5092 ;; args in `start-process'.
5099 "%S"
5102 ;; Ignore `org-mode-hook' as it has been run already
5103 ;; in the original buffer. Ignore `kill-emacs-hook'
5104 ;; as we need a truly non-interactive process.
5106 ;; Initialize `org-mode' and export framework in the
5107 ;; external process.
5110 ;; Re-create current buffer there.
5113 ;; Sexp to evaluate in the buffer.
5115 ;; Start external process.
5118 (,process
5123 "-l" org-export-async-init-file
5125 ;; Register running process in stack.
5127 ;; Set-up sentinel in order to catch results.
5129 ,process
5153 "Add a new result to export stack if not present already.
5155 SOURCE is a buffer or a file name containing export results.
5156 BACKEND is a symbol representing export back-end used to generate
5157 it.
5159 Entries already pointing to SOURCE and unavailable entries are
5160 removed beforehand. Return the new stack."
5166 "Menu for asynchronous export results and running processes."
5176 "Return source from export results at point in stack."
5183 source
5184 ;; SOURCE is not consistent with current line. The stack
5185 ;; view is outdated.
5189 "Remove all entries from export stack."
5194 "Refresh the asynchronous export stack.
5195 DUMMY is ignored. Unavailable sources are removed from the list.
5196 Return the new stack."
5206 ;; Back-end.
5208 ;; Age.
5211 ;; Compute age of the results.
5213 "%4h:%.2m "
5215 ;; Source.
5220 ;; Clear stack from exited processes, dead buffers or
5221 ;; non-existent files.
5233 "Remove export results at point from stack.
5234 If optional argument SOURCE is non-nil, remove it instead."
5239 org-export-stack-contents))))
5242 "View export results at point in stack.
5243 With an optional prefix argument IN-EMACS, force viewing files
5244 within Emacs."
5258 (define-key km "p" 'previous-line)
5259 (define-key km "\C-p" 'previous-line)
5260 (define-key km "\C-?" 'previous-line)
5261 (define-key km [up] 'previous-line)
5262 (define-key km "C" 'org-export-stack-clear)
5263 (define-key km "v" 'org-export-stack-view)
5264 (define-key km (kbd "RET") 'org-export-stack-view)
5265 (define-key km "d" 'org-export-stack-remove)
5266 km)
5267 "Keymap for Org Export Stack.")
5269 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5270 "Mode for displaying asynchronous export stack.
5273 stack.
5275 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5276 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5277 stack completely.
5279 Removing entries in an Org Export Stack buffer doesn't affect
5280 files or buffers, only the display.
5283 (abbrev-mode 0)
5284 (auto-fill-mode 0)
5285 (setq buffer-read-only t
5286 buffer-undo-list t
5287 truncate-lines t
5288 header-line-format
5289 '(:eval
5290 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5291 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5292 (set (make-local-variable 'revert-buffer-function)
5293 'org-export-stack-refresh))
5296 \f
5297 ;;; The Dispatcher
5298 ;;
5299 ;; `org-export-dispatch' is the standard interactive way to start an
5300 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5301 ;; for its interface, which, in turn, delegates response to key
5302 ;; pressed to `org-export--dispatch-action'.
5304 ;;;###autoload
5305 (defun org-export-dispatch (&optional arg)
5306 "Export dispatcher for Org mode.
5308 It provides an access to common export related tasks in a buffer.
5309 Its interface comes in two flavours: standard and expert.
5311 While both share the same set of bindings, only the former
5312 displays the valid keys associations in a dedicated buffer.
5313 Scrolling (resp. line-wise motion) in this buffer is done with
5314 SPC and DEL (resp. C-n and C-p) keys.
5316 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5317 flavour or the other.
5320 of options used back then, on the current buffer.
5322 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5323 (interactive "P")
5324 (let* ((input
5325 (cond ((equal arg '(16)) '(stack))
5326 ((and arg org-export-dispatch-last-action))
5327 (t (save-window-excursion
5328 (unwind-protect
5329 (progn
5330 ;; Remember where we are
5331 (move-marker org-export-dispatch-last-position
5332 (point)
5333 (org-base-buffer (current-buffer)))
5334 ;; Get and store an export command
5335 (setq org-export-dispatch-last-action
5336 (org-export--dispatch-ui
5337 (list org-export-initial-scope
5338 (and org-export-in-background 'async))
5339 nil
5340 org-export-dispatch-use-expert-ui)))
5341 (and (get-buffer "*Org Export Dispatcher*")
5342 (kill-buffer "*Org Export Dispatcher*")))))))
5343 (action (car input))
5344 (optns (cdr input)))
5345 (unless (memq 'subtree optns)
5346 (move-marker org-export-dispatch-last-position nil))
5347 (case action
5348 ;; First handle special hard-coded actions.
5349 (stack (org-export-stack))
5350 (publish-current-file
5351 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5352 (publish-current-project
5353 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5354 (publish-choose-project
5355 (org-publish (assoc (org-icompleting-read
5356 "Publish project: "
5357 org-publish-project-alist nil t)
5358 org-publish-project-alist)
5359 (memq 'force optns)
5360 (memq 'async optns)))
5361 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5362 (otherwise
5363 (save-excursion
5364 (when arg
5365 ;; Repeating command, maybe move cursor
5366 ;; to restore subtree context
5367 (if (eq (marker-buffer org-export-dispatch-last-position)
5368 (org-base-buffer (current-buffer)))
5369 (goto-char org-export-dispatch-last-position)
5370 ;; We are in a differnet buffer, forget position
5371 (move-marker org-export-dispatch-last-position nil)))
5372 (funcall action
5373 ;; Return a symbol instead of a list to ease
5374 ;; asynchronous export macro use.
5375 (and (memq 'async optns) t)
5376 (and (memq 'subtree optns) t)
5377 (and (memq 'visible optns) t)
5378 (and (memq 'body optns) t)))))))
5380 (defun org-export--dispatch-ui (options first-key expertp)
5381 "Handle interface for `org-export-dispatch'.
5383 OPTIONS is a list containing current interactive options set for
5384 export. It can contain any of the following symbols:
5385 `body' toggles a body-only export
5386 `subtree' restricts export to current subtree
5387 `visible' restricts export to visible part of buffer.
5388 `force' force publishing files.
5389 `async' use asynchronous export process
5391 FIRST-KEY is the key pressed to select the first level menu. It
5392 is nil when this menu hasn't been selected yet.
5394 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5395 buffer is provided, but indications about currently active
5396 options are given in the prompt. Moreover, \[?] allows to switch
5397 back to standard interface."
5398 (let* ((fontify-key
5399 (lambda (key &optional access-key)
5400 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5401 ;; non-nil is the required first-level key to activate
5402 ;; KEY. When its value is t, activate KEY independently
5403 ;; on the first key, if any. A nil value means KEY will
5404 ;; only be activated at first level.
5405 (if (or (eq access-key t) (eq access-key first-key))
5406 (org-propertize key 'face 'org-warning)
5407 key)))
5408 (fontify-value
5409 (lambda (value)
5410 ;; Fontify VALUE string.
5411 (org-propertize value 'face 'font-lock-variable-name-face)))
5412 ;; Prepare menu entries by extracting them from
5413 ;; `org-export-registered-backends', and sorting them by
5414 ;; access key and by ordinal, if any.
5415 (backends
5416 (sort
5417 (sort
5418 (delq nil
5419 (mapcar
5420 (lambda (b)
5421 (let ((name (car b)))
5422 (catch 'ignored
5423 ;; Ignore any back-end belonging to
5424 ;; `org-export-invisible-backends' or derived
5425 ;; from one of them.
5426 (dolist (ignored org-export-invisible-backends)
5427 (when (org-export-derived-backend-p name ignored)
5428 (throw 'ignored nil)))
5429 (org-export-backend-menu name))))
5430 org-export-registered-backends))
5431 (lambda (a b)
5432 (let ((key-a (nth 1 a))
5433 (key-b (nth 1 b)))
5434 (cond ((and (numberp key-a) (numberp key-b))
5435 (< key-a key-b))
5436 ((numberp key-b) t)))))
5437 (lambda (a b) (< (car a) (car b)))))
5438 ;; Compute a list of allowed keys based on the first key
5439 ;; pressed, if any. Some keys (?^B, ?^V, ?^S, ?^F, ?^A
5440 ;; and ?q) are always available.
5441 (allowed-keys
5442 (nconc (list 2 22 19 6 1)
5443 (if (not first-key) (org-uniquify (mapcar 'car backends))
5444 (let (sub-menu)
5445 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5446 (when (eq (car backend) first-key)
5447 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5448 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5449 ((not first-key) (list ?P)))
5450 (list ?&)
5451 (when expertp (list ??))
5452 (list ?q)))
5453 ;; Build the help menu for standard UI.
5454 (help
5455 (unless expertp
5456 (concat
5457 ;; Options are hard-coded.
5458 (format "Options
5459 [%s] Body only: %s [%s] Visible only: %s
5460 [%s] Export scope: %s [%s] Force publishing: %s
5462 (funcall fontify-key "C-b" t)
5463 (funcall fontify-value
5464 (if (memq 'body options) "On " "Off"))
5465 (funcall fontify-key "C-v" t)
5466 (funcall fontify-value
5467 (if (memq 'visible options) "On " "Off"))
5468 (funcall fontify-key "C-s" t)
5469 (funcall fontify-value
5470 (if (memq 'subtree options) "Subtree" "Buffer "))
5471 (funcall fontify-key "C-f" t)
5472 (funcall fontify-value
5473 (if (memq 'force options) "On " "Off"))
5474 (funcall fontify-key "C-a" t)
5475 (funcall fontify-value
5476 (if (memq 'async options) "On " "Off")))
5477 ;; Display registered back-end entries. When a key
5478 ;; appears for the second time, do not create another
5479 ;; entry, but append its sub-menu to existing menu.
5480 (let (last-key)
5481 (mapconcat
5482 (lambda (entry)
5483 (let ((top-key (car entry)))
5484 (concat
5485 (unless (eq top-key last-key)
5486 (setq last-key top-key)
5488 (funcall fontify-key (char-to-string top-key))
5489 (nth 1 entry)))
5490 (let ((sub-menu (nth 2 entry)))
5491 (unless (functionp sub-menu)
5492 ;; Split sub-menu into two columns.
5493 (let ((index -1))
5494 (concat
5495 (mapconcat
5496 (lambda (sub-entry)
5497 (incf index)
5498 (format
5499 (if (zerop (mod index 2)) " [%s] %-26s"
5501 (funcall fontify-key
5502 (char-to-string (car sub-entry))
5503 top-key)
5504 (nth 1 sub-entry)))
5505 sub-menu "")
5507 backends ""))
5508 ;; Publishing menu is hard-coded.
5510 [%s] Current file [%s] Current project
5512 (funcall fontify-key "P")
5513 (funcall fontify-key "f" ?P)
5514 (funcall fontify-key "p" ?P)
5515 (funcall fontify-key "x" ?P)
5516 (funcall fontify-key "a" ?P))
5518 (format "\[%s] %s"
5519 (funcall fontify-key "q" t)
5520 (if first-key "Main menu" "Exit")))))
5521 ;; Build prompts for both standard and expert UI.
5522 (standard-prompt (unless expertp "Export command: "))
5523 (expert-prompt
5524 (when expertp
5525 (format
5526 "Export command (C-%s%s%s%s%s) [%s]: "
5527 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5528 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5529 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5530 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5531 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5532 (mapconcat (lambda (k)
5533 ;; Strip control characters.
5534 (unless (< k 27) (char-to-string k)))
5535 allowed-keys "")))))
5536 ;; With expert UI, just read key with a fancy prompt. In standard
5537 ;; UI, display an intrusive help buffer.
5538 (if expertp
5539 (org-export--dispatch-action
5540 expert-prompt allowed-keys backends options first-key expertp)
5541 ;; At first call, create frame layout in order to display menu.
5542 (unless (get-buffer "*Org Export Dispatcher*")
5543 (delete-other-windows)
5544 (org-switch-to-buffer-other-window
5545 (get-buffer-create "*Org Export Dispatcher*"))
5546 (setq cursor-type nil
5547 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
5548 ;; Make sure that invisible cursor will not highlight square
5549 ;; brackets.
5550 (set-syntax-table (copy-syntax-table))
5551 (modify-syntax-entry ?\[ "w"))
5552 ;; At this point, the buffer containing the menu exists and is
5553 ;; visible in the current window. So, refresh it.
5554 (with-current-buffer "*Org Export Dispatcher*"
5555 ;; Refresh help. Maintain display continuity by re-visiting
5556 ;; previous window position.
5557 (let ((pos (window-start)))
5558 (erase-buffer)
5559 (insert help)
5560 (set-window-start nil pos)))
5561 (org-fit-window-to-buffer)
5562 (org-export--dispatch-action
5563 standard-prompt allowed-keys backends options first-key expertp))))
5565 (defun org-export--dispatch-action
5566 (prompt allowed-keys backends options first-key expertp)
5567 "Read a character from command input and act accordingly.
5569 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5570 a list of characters available at a given step in the process.
5571 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5572 EXPERTP are the same as defined in `org-export--dispatch-ui',
5573 which see.
5575 Toggle export options when required. Otherwise, return value is
5576 a list with action as CAR and a list of interactive export
5577 options as CDR."
5578 (let (key)
5579 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
5580 ;; C-p, SPC, DEL).
5581 (while (and (setq key (read-char-exclusive prompt))
5582 (not expertp)
5583 (memq key '(14 16 ?\s ?\d)))
5584 (case key
5585 (14 (if (not (pos-visible-in-window-p (point-max)))
5586 (ignore-errors (scroll-up-line))
5587 (message "End of buffer")
5588 (sit-for 1)))
5589 (16 (if (not (pos-visible-in-window-p (point-min)))
5590 (ignore-errors (scroll-down-line))
5591 (message "Beginning of buffer")
5592 (sit-for 1)))
5593 (?\s (if (not (pos-visible-in-window-p (point-max)))
5594 (scroll-up nil)
5595 (message "End of buffer")
5596 (sit-for 1)))
5597 (?\d (if (not (pos-visible-in-window-p (point-min)))
5598 (scroll-down nil)
5599 (message "Beginning of buffer")
5600 (sit-for 1)))))
5601 (cond
5602 ;; Ignore undefined associations.
5603 ((not (memq key allowed-keys))
5604 (ding)
5605 (unless expertp (message "Invalid key") (sit-for 1))
5606 (org-export--dispatch-ui options first-key expertp))
5607 ;; q key at first level aborts export. At second
5608 ;; level, cancel first key instead.
5609 ((eq key ?q) (if (not first-key) (error "Export aborted")
5610 (org-export--dispatch-ui options nil expertp)))
5611 ;; Help key: Switch back to standard interface if
5612 ;; expert UI was active.
5613 ((eq key ??) (org-export--dispatch-ui options first-key nil))
5614 ;; Switch to asynchronous export stack.
5615 ((eq key ?&) '(stack))
5616 ;; Toggle export options
5617 ;; C-b (2) C-v (22) C-s (19) C-f (6) C-a (1)
5618 ((memq key '(2 22 19 6 1))
5619 (org-export--dispatch-ui
5620 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
5621 (6 'force) (1 'async))))
5622 (if (memq option options) (remq option options)
5623 (cons option options)))
5624 first-key expertp))
5625 ;; Action selected: Send key and options back to
5626 ;; `org-export-dispatch'.
5627 ((or first-key (functionp (nth 2 (assq key backends))))
5628 (cons (cond
5629 ((not first-key) (nth 2 (assq key backends)))
5630 ;; Publishing actions are hard-coded. Send a special
5631 ;; signal to `org-export-dispatch'.
5632 ((eq first-key ?P)
5633 (case key
5634 (?f 'publish-current-file)
5635 (?p 'publish-current-project)
5636 (?x 'publish-choose-project)
5637 (?a 'publish-all)))
5638 ;; Return first action associated to FIRST-KEY + KEY
5639 ;; path. Indeed, derived backends can share the same
5640 ;; FIRST-KEY.
5641 (t (catch 'found
5642 (mapc (lambda (backend)
5643 (let ((match (assq key (nth 2 backend))))
5644 (when match (throw 'found (nth 2 match)))))
5645 (member (assq first-key backends) backends)))))
5646 options))
5647 ;; Otherwise, enter sub-menu.
5648 (t (org-export--dispatch-ui options key expertp)))))
5652 (provide 'ox)
5654 ;; Local variables:
5655 ;; generated-autoload-file: "org-loaddefs.el"
5656 ;; End:
5658 ;;; ox.el ends here