| blob | 29098b82f557040fcdaf3021f0293667c7052b0b |
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,
402 :inline t
406 "Non-nil means insert author email into the exported file.
407 This option can also be set with the #+OPTIONS line,
413 "Non-nil means interpret *word*, /word/, _word_ and +word+.
415 If the export target supports emphasizing text, the word will be
416 typeset in bold, italic, with an underline or strike-through,
417 respectively.
424 "Tags that exclude a tree from export.
426 All trees carrying any of these tags will be excluded from
427 export. This is without condition, so even subtrees inside that
428 carry one of the `org-export-select-tags' will be removed.
430 This option can also be set with the #+EXCLUDE_TAGS: keyword."
437 This can be used to have pre-formatted text, fragments of code
438 etc. For example:
439 : ;; Some Lisp examples
440 : (while (defc cnt)
441 : (ding))
442 will be looking just like this in also HTML. See also the QUOTE
443 keyword. Not all export backends support this.
450 "Non-nil means Org footnotes should be exported.
451 This option can also be set with the #+OPTIONS line,
457 "Non-nil means process LaTeX environments and fragments.
459 This option can also be set with the +OPTIONS line,
462 nil Ignore math snippets.
463 `verbatim' Keep everything in verbatim.
464 t Allow export of math snippets."
474 "The last level which is still exported as a headline.
476 Inferior levels will produce itemize or enumerate lists when
477 exported.
484 "The default language for export and clocktable translations, as a string.
485 This may have an association in
486 `org-clock-clocktable-language-setup'."
491 "Non-nil means preserve all line breaks when exporting.
492 This option can also be set with the #+OPTIONS line,
498 "Non-nil means interpret entities when exporting.
501 Å.
503 For a list of supported names, see the constant `org-entities'
504 and the user option `org-entities-user'.
506 This option can also be set with the #+OPTIONS line,
512 "Non-nil means inlinetasks should be exported.
513 This option can also be set with the #+OPTIONS line,
521 "Non-nil means include planning info in export.
522 This option can also be set with the #+OPTIONS: line,
530 "Non-nil means include priority cookies in export.
531 This option can also be set with the #+OPTIONS line,
537 "Non-nil means add section numbers to headlines when exporting.
539 When set to an integer n, numbering will only happen for
540 headlines whose relative level is higher or equal to n.
542 This option can also be set with the #+OPTIONS line,
548 "Tags that select a tree for export.
550 If any such tag is found in a buffer, all trees that do not carry
551 one of these tags will be ignored during export. Inside trees
552 that are selected like this, you can still deselect a subtree by
553 tagging it with one of the `org-export-exclude-tags'.
555 This option can also be set with the #+SELECT_TAGS: keyword."
560 "Non-nil means activate smart quotes during export.
561 This option can also be set with the #+OPTIONS: line,
571 When this option is turned on, these strings will be exported as:
573 Org HTML LaTeX UTF-8
574 -----+----------+--------+-------
576 -- – -- –
577 --- — --- —
580 This option can also be set with the #+OPTIONS line,
586 "Non-nil means include statistics cookies in export.
587 This option can also be set with the #+OPTIONS: line,
597 When this option is turned on, you can use TeX-like syntax for
599 will be considered as a single item - so grouping with {} is
600 normally not needed. For example, the following things will be
601 parsed as single sub- or superscripts.
603 10^24 or 10^tau several digits will be considered 1 item.
604 10^-12 or 10^-tau a leading sign with digits or a word
605 x^2-y^3 will be read as x^2 - y^3, because items are
606 terminated by almost any nonword/nondigit char.
607 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
609 Still, ambiguity is possible - so when in doubt use {} to enclose
610 the sub/superscript. If you set this variable to the symbol
611 `{}', the braces are *required* in order to trigger
612 interpretations as sub/superscript. This can be helpful in
615 This option can also be set with the #+OPTIONS line,
624 "Non-nil means create a table of contents in exported files.
626 The TOC contains headlines with levels up
627 to`org-export-headline-levels'. When an integer, include levels
628 up to N in the toc, this may then be different from
629 `org-export-headline-levels', but it will not be allowed to be
630 larger than the number of headline levels. When nil, no table of
631 contents is made.
633 This option can also be set with the #+OPTIONS line,
643 For example:
645 | Name | Address | Birthday |
646 |-------------+----------+-----------|
647 | Arthur Dent | England | 29.2.2100 |
654 "If nil, do not export tags, just remove them from headlines.
656 If this is the symbol `not-in-toc', tags will be removed from
657 table of contents entries, but still be shown in the headlines of
658 the document.
660 This option can also be set with the #+OPTIONS line,
669 "Non-nil means include TODO items for export.
671 This may have the following values:
672 t include tasks independent of state.
673 `todo' include only tasks that are not yet done.
674 `done' include only tasks that are already done.
675 nil ignore all tasks.
676 list of keywords include tasks with these keywords.
678 This option can also be set with the #+OPTIONS line,
690 "Non-nil means insert a time stamp into the exported file.
691 The time stamp shows when the file was created.
693 This option can also be set with the #+OPTIONS line,
699 "Non nil means allow timestamps in export.
701 It can be set to `active', `inactive', t or nil, in order to
702 export, respectively, only active timestamps, only inactive ones,
703 all of them or none.
705 This option can also be set with the #+OPTIONS line, e.g.
715 "Non-nil means include TODO keywords in export.
716 When nil, remove all these keywords from the export."
721 "Non-nil means BIND keywords can define local variable values.
722 This is a potential security risk, which is why the default value
723 is nil. You can also allow them through local buffer variables."
730 "Alist between export snippets back-ends and exporter back-ends.
732 This variable allows to provide shortcuts for export snippets.
736 HTML code while every other back-end will ignore it."
745 "Coding system for the exported file."
752 "Non-nil means exported stuff will also be pushed onto the kill ring."
757 "The initial scope when exporting with `org-export-dispatch'.
758 This variable can be either set to `buffer' or `subtree'."
765 "Non-nil means show buffer after exporting to temp buffer.
766 When Org exports to a file, the buffer visiting that file is ever
767 shown, but remains buried. However, when exporting to
768 a temporary buffer, that buffer is popped up in a second window.
769 When this variable is nil, the buffer remains buried also in
770 these cases."
775 "Non-nil means export and publishing commands will run in background.
776 Results from an asynchronous export are never displayed
784 "File used to initialize external export process.
785 Value must be an absolute file name. It defaults to user's
786 initialization file. Though, a specific configuration makes the
787 process faster and the export more portable."
796 "List of back-ends that shouldn't appear in the dispatcher.
798 Any back-end belonging to this list or derived from a back-end
799 belonging to it will not appear in the dispatcher menu.
801 Indeed, Org may require some export back-ends without notice. If
802 these modules are never to be used interactively, adding them
803 here will avoid cluttering the dispatcher menu."
810 "Non-nil means using a non-intrusive `org-export-dispatch'.
811 In that case, no help buffer is displayed. Though, an indicator
817 asynchronous). Also, \[?] allows to switch back to standard
818 mode."
825 \f
826 ;;; Defining Back-ends
827 ;;
828 ;; `org-export-define-backend' is the standard way to define an export
829 ;; back-end. It allows to specify translators, filters, buffer
830 ;; options and a menu entry. If the new back-end shares translators
831 ;; with another back-end, `org-export-define-derived-backend' may be
832 ;; used instead.
833 ;;
834 ;; Internally, a back-end is stored as a list, of which CAR is the
835 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
836 ;; properties of a given back-end are: `org-export-backend-filters',
837 ;; `org-export-backend-menu', `org-export-backend-options' and
838 ;; `org-export-backend-translate-table'.
839 ;;
840 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
841 ;; when a given back-end hasn't been registered yet.
844 "Define a new back-end BACKEND.
846 TRANSLATORS is an alist between object or element types and
847 functions handling them.
849 These functions should return a string without any trailing
850 space, or nil. They must accept three arguments: the object or
851 element itself, its contents or nil when it isn't recursive and
852 the property list used as a communication channel.
854 Contents, when not nil, are stripped from any global indentation
855 \(although the relative one is preserved). They also always end
856 with a single newline character.
858 If, for a given type, no function is found, that element or
859 object type will simply be ignored, along with any blank line or
860 white space at its end. The same will happen if the function
861 returns the nil value. If that function returns the empty
862 string, the type will be ignored, but the blank lines or white
863 spaces will be kept.
865 In addition to element and object types, one function can be
866 associated to the `template' (or `inner-template') symbol and
867 another one to the `plain-text' symbol.
869 The former returns the final transcoded string, and can be used
870 to add a preamble and a postamble to document's body. It must
871 accept two arguments: the transcoded string and the property list
872 containing export options. A function associated to `template'
874 A function associated to `inner-template' is always applied.
876 The latter, when defined, is to be called on every text not
877 recognized as an element or an object. It must accept two
878 arguments: the text string and the information channel. It is an
879 appropriate place to protect special chars relative to the
880 back-end.
882 BODY can start with pre-defined keyword arguments. The following
883 keywords are understood:
885 :export-block
887 String, or list of strings, representing block names that
888 will not be parsed. This is used to specify blocks that will
889 contain raw code specific to the back-end. These blocks
890 still have to be handled by the relative `export-block' type
891 translator.
893 :filters-alist
895 Alist between filters and function, or list of functions,
896 specific to the back-end. See `org-export-filters-alist' for
897 a list of all allowed filters. Filters defined here
898 shouldn't make a back-end test, as it may prevent back-ends
899 derived from this one to behave properly.
901 :menu-entry
903 Menu entry for the export dispatcher. It should be a list
904 like:
906 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
908 where :
910 KEY is a free character selecting the back-end.
912 DESCRIPTION-OR-ORDINAL is either a string or a number.
914 If it is a string, is will be used to name the back-end in
915 its menu entry. If it is a number, the following menu will
916 be displayed as a sub-menu of the back-end with the same
917 KEY. Also, the number will be used to determine in which
918 order such sub-menus will appear (lowest first).
920 ACTION-OR-MENU is either a function or an alist.
922 If it is an action, it will be called with four
923 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
924 BODY-ONLY. See `org-export-as' for further explanations on
925 some of them.
927 If it is an alist, associations should follow the
928 pattern:
930 \(KEY DESCRIPTION ACTION)
932 where KEY, DESCRIPTION and ACTION are described above.
934 Valid values include:
938 or
943 \(lambda (a s v b)
944 \(if a (org-latex-export-to-pdf t s v b)
945 \(org-open-file
946 \(org-latex-export-to-pdf nil s v b)))))))
948 or the following, which will be added to the previous
949 sub-menu,
951 \(?l 1
955 :options-alist
957 Alist between back-end specific properties introduced in
958 communication channel and how their value are acquired. See
959 `org-export-options-alist' for more information about
960 structure of the values."
979 ;; Register back-end.
983 ;; Tell parser to not parse EXPORT-BLOCK blocks.
990 ;; Splice in the body, if any.
994 "Create a new back-end as a variant of an existing one.
996 CHILD is the name of the derived back-end. PARENT is the name of
997 the parent back-end.
999 BODY can start with pre-defined keyword arguments. The following
1000 keywords are understood:
1002 :export-block
1004 String, or list of strings, representing block names that
1005 will not be parsed. This is used to specify blocks that will
1006 contain raw code specific to the back-end. These blocks
1007 still have to be handled by the relative `export-block' type
1008 translator.
1010 :filters-alist
1012 Alist of filters that will overwrite or complete filters
1013 defined in PARENT back-end. See `org-export-filters-alist'
1014 for a list of allowed filters.
1016 :menu-entry
1018 Menu entry for the export dispatcher. See
1019 `org-export-define-backend' for more information about the
1020 expected value.
1022 :options-alist
1024 Alist of back-end specific properties that will overwrite or
1025 complete those defined in PARENT back-end. Refer to
1026 `org-export-options-alist' for more information about
1027 structure of the values.
1029 :translate-alist
1031 Alist of element and object types and transcoders that will
1032 overwrite or complete transcode table from PARENT back-end.
1033 Refer to `org-export-define-backend' for detailed information
1034 about transcoders.
1037 as a variant of `latex' back-end with a custom template function:
1039 \(org-export-define-derived-backend my-latex latex
1040 :translate-alist ((template . my-latex-template-fun)))
1042 The back-end could then be called with, for example:
1070 ;; Register back-end.
1074 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1081 ;; Splice in the body, if any.
1085 "Return back-end from which BACKEND is derived, or nil."
1089 "Return filters for BACKEND."
1094 "Return menu entry for BACKEND."
1099 "Return export options for BACKEND."
1104 "Return translate table for BACKEND."
1109 "Signal an error if BACKEND isn't defined."
1114 "Non-nil if BACKEND is derived from one of BACKENDS."
1118 parent))
1121 \f
1122 ;;; The Communication Channel
1123 ;;
1124 ;; During export process, every function has access to a number of
1125 ;; properties. They are of two types:
1126 ;;
1127 ;; 1. Environment options are collected once at the very beginning of
1128 ;; the process, out of the original buffer and configuration.
1129 ;; Collecting them is handled by `org-export-get-environment'
1130 ;; function.
1131 ;;
1132 ;; Most environment options are defined through the
1133 ;; `org-export-options-alist' variable.
1134 ;;
1135 ;; 2. Tree properties are extracted directly from the parsed tree,
1136 ;; just before export, by `org-export-collect-tree-properties'.
1137 ;;
1138 ;; Here is the full list of properties available during transcode
1139 ;; process, with their category and their value type.
1140 ;;
1141 ;; + `:author' :: Author's name.
1142 ;; - category :: option
1143 ;; - type :: string
1144 ;;
1145 ;; + `:back-end' :: Current back-end used for transcoding.
1146 ;; - category :: tree
1147 ;; - type :: symbol
1148 ;;
1149 ;; + `:creator' :: String to write as creation information.
1150 ;; - category :: option
1151 ;; - type :: string
1152 ;;
1153 ;; + `:date' :: String to use as date.
1154 ;; - category :: option
1155 ;; - type :: string
1156 ;;
1157 ;; + `:description' :: Description text for the current data.
1158 ;; - category :: option
1159 ;; - type :: string
1160 ;;
1161 ;; + `:email' :: Author's email.
1162 ;; - category :: option
1163 ;; - type :: string
1164 ;;
1165 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1166 ;; process.
1167 ;; - category :: option
1168 ;; - type :: list of strings
1169 ;;
1170 ;; + `:export-options' :: List of export options available for current
1171 ;; process.
1172 ;; - category :: none
1173 ;; - type :: list of symbols, among `subtree', `body-only' and
1174 ;; `visible-only'.
1175 ;;
1176 ;; + `:exported-data' :: Hash table used for memoizing
1177 ;; `org-export-data'.
1178 ;; - category :: tree
1179 ;; - type :: hash table
1180 ;;
1181 ;; + `:filetags' :: List of global tags for buffer. Used by
1182 ;; `org-export-get-tags' to get tags with inheritance.
1183 ;; - category :: option
1184 ;; - type :: list of strings
1185 ;;
1186 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1187 ;; their definition, as parsed data. Only non-inlined footnotes
1188 ;; are represented in this alist. Also, every definition isn't
1189 ;; guaranteed to be referenced in the parse tree. The purpose of
1190 ;; this property is to preserve definitions from oblivion
1191 ;; (i.e. when the parse tree comes from a part of the original
1192 ;; buffer), it isn't meant for direct use in a back-end. To
1193 ;; retrieve a definition relative to a reference, use
1194 ;; `org-export-get-footnote-definition' instead.
1195 ;; - category :: option
1196 ;; - type :: alist (STRING . LIST)
1197 ;;
1198 ;; + `:headline-levels' :: Maximum level being exported as an
1199 ;; headline. Comparison is done with the relative level of
1200 ;; headlines in the parse tree, not necessarily with their
1201 ;; actual level.
1202 ;; - category :: option
1203 ;; - type :: integer
1204 ;;
1205 ;; + `:headline-offset' :: Difference between relative and real level
1206 ;; of headlines in the parse tree. For example, a value of -1
1207 ;; means a level 2 headline should be considered as level
1208 ;; 1 (cf. `org-export-get-relative-level').
1209 ;; - category :: tree
1210 ;; - type :: integer
1211 ;;
1212 ;; + `:headline-numbering' :: Alist between headlines and their
1213 ;; numbering, as a list of numbers
1214 ;; (cf. `org-export-get-headline-number').
1215 ;; - category :: tree
1216 ;; - type :: alist (INTEGER . LIST)
1217 ;;
1218 ;; + `:id-alist' :: Alist between ID strings and destination file's
1219 ;; path, relative to current directory. It is used by
1220 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1221 ;; external file.
1222 ;; - category :: option
1223 ;; - type :: alist (STRING . STRING)
1224 ;;
1225 ;; + `:ignore-list' :: List of elements and objects that should be
1226 ;; ignored during export.
1227 ;; - category :: tree
1228 ;; - type :: list of elements and objects
1229 ;;
1230 ;; + `:input-file' :: Full path to input file, if any.
1231 ;; - category :: option
1232 ;; - type :: string or nil
1233 ;;
1234 ;; + `:keywords' :: List of keywords attached to data.
1235 ;; - category :: option
1236 ;; - type :: string
1237 ;;
1238 ;; + `:language' :: Default language used for translations.
1239 ;; - category :: option
1240 ;; - type :: string
1241 ;;
1242 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1243 ;; transcoding.
1244 ;; - category :: option
1245 ;; - type :: list (as returned by `org-element-parse-buffer')
1246 ;;
1247 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1248 ;; all line breaks.
1249 ;; - category :: option
1250 ;; - type :: symbol (nil, t)
1251 ;;
1252 ;; + `:section-numbers' :: Non-nil means transcoding should add
1253 ;; section numbers to headlines.
1254 ;; - category :: option
1255 ;; - type :: symbol (nil, t)
1256 ;;
1257 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1258 ;; in transcoding. When such a tag is present, subtrees without
1259 ;; it are de facto excluded from the process. See
1260 ;; `use-select-tags'.
1261 ;; - category :: option
1262 ;; - type :: list of strings
1263 ;;
1264 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1265 ;; a time stamp in the output.
1266 ;; - category :: option
1267 ;; - type :: symbol (nil, t)
1268 ;;
1269 ;; + `:translate-alist' :: Alist between element and object types and
1270 ;; transcoding functions relative to the current back-end.
1271 ;; Special keys `inner-template', `template' and `plain-text' are
1272 ;; also possible.
1273 ;; - category :: option
1274 ;; - type :: alist (SYMBOL . FUNCTION)
1275 ;;
1276 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1277 ;; also be transcoded. If it is set to the `headline' symbol,
1278 ;; only the archived headline's name is retained.
1279 ;; - category :: option
1280 ;; - type :: symbol (nil, t, `headline')
1281 ;;
1282 ;; + `:with-author' :: Non-nil means author's name should be included
1283 ;; in the output.
1284 ;; - category :: option
1285 ;; - type :: symbol (nil, t)
1286 ;;
1287 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1288 ;; - category :: option
1289 ;; - type :: symbol (nil, t)
1290 ;;
1291 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1292 ;; inserted at the end of the transcoded string. If the value
1293 ;; is `comment', it should be commented.
1294 ;; - category :: option
1295 ;; - type :: symbol (`comment', nil, t)
1296 ;;
1297 ;; + `:with-date' :: Non-nil means output should contain a date.
1298 ;; - category :: option
1299 ;; - type :. symbol (nil, t)
1300 ;;
1301 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1302 ;; its value is a list of names, only drawers with such names
1303 ;; will be transcoded. If that list starts with `not', drawer
1304 ;; with these names will be skipped.
1305 ;; - category :: option
1306 ;; - type :: symbol (nil, t) or list of strings
1307 ;;
1308 ;; + `:with-email' :: Non-nil means output should contain author's
1309 ;; email.
1310 ;; - category :: option
1311 ;; - type :: symbol (nil, t)
1312 ;;
1313 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1314 ;; interpreted.
1315 ;; - category :: option
1316 ;; - type :: symbol (nil, t)
1317 ;;
1318 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1319 ;; strings starting with a colon as a fixed-with (verbatim) area.
1320 ;; - category :: option
1321 ;; - type :: symbol (nil, t)
1322 ;;
1323 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1324 ;; footnotes.
1325 ;; - category :: option
1326 ;; - type :: symbol (nil, t)
1327 ;;
1328 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1329 ;; `latex-fragment' objects should appear in export output. When
1330 ;; this property is set to `verbatim', they will be left as-is.
1331 ;; - category :: option
1332 ;; - type :: symbol (`verbatim', nil, t)
1333 ;;
1334 ;; + `:with-plannings' :: Non-nil means transcoding should include
1335 ;; planning info.
1336 ;; - category :: option
1337 ;; - type :: symbol (nil, t)
1338 ;;
1339 ;; + `:with-priority' :: Non-nil means transcoding should include
1340 ;; priority cookies.
1341 ;; - category :: option
1342 ;; - type :: symbol (nil, t)
1343 ;;
1344 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1345 ;; plain text.
1346 ;; - category :: option
1347 ;; - type :: symbol (nil, t)
1348 ;;
1349 ;; + `:with-special-strings' :: Non-nil means transcoding should
1350 ;; interpret special strings in plain text.
1351 ;; - category :: option
1352 ;; - type :: symbol (nil, t)
1353 ;;
1354 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1355 ;; interpret subscript and superscript. With a value of "{}",
1356 ;; only interpret those using curly brackets.
1357 ;; - category :: option
1358 ;; - type :: symbol (nil, {}, t)
1359 ;;
1360 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1361 ;; tables.
1362 ;; - category :: option
1363 ;; - type :: symbol (nil, t)
1364 ;;
1365 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1366 ;; headlines. A `not-in-toc' value will remove them from the
1367 ;; table of contents, if any, nonetheless.
1368 ;; - category :: option
1369 ;; - type :: symbol (nil, t, `not-in-toc')
1370 ;;
1371 ;; + `:with-tasks' :: Non-nil means transcoding should include
1372 ;; headlines with a TODO keyword. A `todo' value will only
1373 ;; include headlines with a todo type keyword while a `done'
1374 ;; value will do the contrary. If a list of strings is provided,
1375 ;; only tasks with keywords belonging to that list will be kept.
1376 ;; - category :: option
1377 ;; - type :: symbol (t, todo, done, nil) or list of strings
1378 ;;
1379 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1380 ;; time stamps. Special value `active' (resp. `inactive') ask to
1381 ;; export only active (resp. inactive) timestamps. Otherwise,
1382 ;; completely remove them.
1383 ;; - category :: option
1384 ;; - type :: symbol: (`active', `inactive', t, nil)
1385 ;;
1386 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1387 ;; added to the output. An integer value limits its depth.
1388 ;; - category :: option
1389 ;; - type :: symbol (nil, t or integer)
1390 ;;
1391 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1392 ;; include TODO keywords.
1393 ;; - category :: option
1394 ;; - type :: symbol (nil, t)
1397 ;;;; Environment Options
1398 ;;
1399 ;; Environment options encompass all parameters defined outside the
1400 ;; scope of the parsed data. They come from five sources, in
1401 ;; increasing precedence order:
1402 ;;
1403 ;; - Global variables,
1404 ;; - Buffer's attributes,
1405 ;; - Options keyword symbols,
1406 ;; - Buffer keywords,
1407 ;; - Subtree properties.
1408 ;;
1409 ;; The central internal function with regards to environment options
1410 ;; is `org-export-get-environment'. It updates global variables with
1411 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1412 ;; the different sources.
1413 ;;
1414 ;; The internal functions doing the retrieval are:
1415 ;; `org-export--get-global-options',
1416 ;; `org-export--get-buffer-attributes',
1417 ;; `org-export--parse-option-keyword',
1418 ;; `org-export--get-subtree-options' and
1419 ;; `org-export--get-inbuffer-options'
1420 ;;
1421 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1422 ;; relative to "#+BIND:" keywords.
1425 "Collect export options from the current buffer.
1427 Optional argument BACKEND is a symbol specifying which back-end
1428 specific options to read, if any.
1430 When optional argument SUBTREEP is non-nil, assume the export is
1431 done against the current sub-tree.
1433 Third optional argument EXT-PLIST is a property list with
1434 external parameters overriding Org default settings, but still
1435 inferior to file-local settings."
1436 ;; First install #+BIND variables.
1438 ;; Get and prioritize export options...
1440 ;; ... from global variables...
1442 ;; ... from an external property list...
1443 ext-plist
1444 ;; ... from in-buffer settings...
1446 ;; ... and from subtree, when appropriate.
1448 ;; Eventually add misc. properties.
1450 :back-end
1451 backend
1452 :translate-alist
1454 :footnote-definition-alist
1455 ;; Footnotes definitions must be collected in the original
1456 ;; buffer, as there's no insurance that they will still be in
1457 ;; the parse tree, due to possible narrowing.
1471 alist))))
1472 alist))
1473 :id-alist
1474 ;; Collect id references.
1485 alist))))
1488 "Parse an OPTIONS line and return values as a plist.
1489 Optional argument BACKEND is a symbol specifying which back-end
1490 specific items to read, if any."
1492 ;; Priority is given to back-end specific options.
1494 org-export-options-alist))
1495 plist)
1504 options))
1506 property
1509 plist))
1512 "Get export options in subtree at point.
1513 Optional argument BACKEND is a symbol specifying back-end used
1514 for export. Return options as a plist."
1515 ;; For each buffer keyword, create a headline property setting the
1516 ;; same property in communication channel. The name for the property
1517 ;; is the keyword with "EXPORT_" appended to it.
1520 ;; Make sure point is at an heading.
1522 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1523 ;; title as its fallback value.
1529 plist :title
1532 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1536 ;; Handle other keywords. TITLE keyword is excluded as it has
1537 ;; been handled already.
1545 ;; Export properties are not case-sensitive.
1552 plist
1553 property
1555 ;; Parse VALUE if required.
1559 ;; If BEHAVIOUR is `split' expected value is
1560 ;; a list of strings, not a string.
1563 ;; Look for both general keywords and back-end specific
1564 ;; options, with priority given to the latter.
1566 org-export-options-alist)))
1567 ;; Return value.
1568 plist)))
1571 "Return current buffer export options, as a plist.
1573 Optional argument BACKEND, when non-nil, is a symbol specifying
1574 which back-end specific options should also be read in the
1575 process.
1577 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1579 get-options ; For byte-compiler.
1582 ;; Priority is given to back-end specific options.
1584 org-export-options-alist))
1587 org-export-special-keywords))))
1590 ;; Return property name associated to KEYWORD.
1595 options))))
1598 ;; Recursively read keywords in buffer. FILES is a list
1599 ;; of files read so far. PLIST is the current property
1600 ;; list obtained.
1609 ;; Options in `org-export-special-keywords'.
1613 ;; Avoid circular dependencies.
1623 plist
1628 plist
1634 ;; Options in `org-export-options-alist'.
1639 plist prop
1640 ;; Handle value depending on specified
1641 ;; BEHAVIOUR.
1647 " "
1659 ;; Return final value.
1660 plist))))
1661 ;; Read options in the current buffer.
1663 ;; Parse keywords specified in `org-element-document-properties'.
1665 ;; Find the property associated to the keyword.
1673 org-element-document-properties)
1674 ;; Return value.
1675 plist))
1678 "Return properties related to buffer attributes, as a plist."
1681 ;; Store full path of input file name, or nil. For internal use.
1682 :input-file visited-file
1689 "Return global export options as a plist.
1691 Optional argument BACKEND, if non-nil, is a symbol specifying
1692 which back-end specific export options should also be read in the
1693 process."
1695 ;; Priority is given to back-end specific options.
1697 org-export-options-alist))
1698 plist)
1705 plist
1706 prop
1707 ;; Eval default value provided. If keyword is a member
1708 ;; of `org-element-document-properties', parse it as
1709 ;; a secondary string before storing it.
1714 value
1717 all)
1718 ;; Return value.
1719 plist))
1722 "Install the values from #+BIND lines as local variables.
1723 Variables must be installed before in-buffer options are
1724 retrieved."
1739 ;;;; Tree Properties
1740 ;;
1741 ;; Tree properties are information extracted from parse tree. They
1742 ;; are initialized at the beginning of the transcoding process by
1743 ;; `org-export-collect-tree-properties'.
1744 ;;
1745 ;; Dedicated functions focus on computing the value of specific tree
1746 ;; properties during initialization. Thus,
1747 ;; `org-export--populate-ignore-list' lists elements and objects that
1748 ;; should be skipped during export, `org-export--get-min-level' gets
1749 ;; the minimal exportable level, used as a basis to compute relative
1750 ;; level for headlines. Eventually
1751 ;; `org-export--collect-headline-numbering' builds an alist between
1752 ;; headlines and their numbering.
1755 "Extract tree properties from parse tree.
1757 DATA is the parse tree from which information is retrieved. INFO
1758 is a list holding export options.
1760 Following tree properties are set or updated:
1762 `:exported-data' Hash table used to memoize results from
1763 `org-export-data'.
1765 `:footnote-definition-alist' List of footnotes definitions in
1766 original buffer and current parse tree.
1768 `:headline-offset' Offset between true level of headlines and
1769 local level. An offset of -1 means a headline
1770 of level 2 should be considered as a level
1771 1 headline in the context.
1773 `:headline-numbering' Alist of all headlines as key an the
1774 associated numbering as value.
1776 `:ignore-list' List of elements that should be ignored during
1777 export.
1779 Return updated plist."
1780 ;; Install the parse tree in the communication channel, in order to
1781 ;; use `org-export-get-genealogy' and al.
1783 ;; Get the list of elements and objects to ignore, and put it into
1784 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1785 ;; been done during parse tree filtering.
1788 :ignore-list
1791 ;; Compute `:headline-offset' in order to be able to use
1792 ;; `org-export-get-relative-level'.
1795 :headline-offset
1797 ;; Update footnotes definitions list with definitions in parse tree.
1798 ;; This is required since buffer expansion might have modified
1799 ;; boundaries of footnote definitions contained in the parse tree.
1800 ;; This way, definitions in `footnote-definition-alist' are bound to
1801 ;; match those in the parse tree.
1807 defs)))
1809 ;; Properties order doesn't matter: get the rest of the tree
1810 ;; properties.
1814 info))
1817 "Return minimum exportable headline's level in DATA.
1818 DATA is parsed tree as returned by `org-element-parse-buffer'.
1819 OPTIONS is a plist holding export options."
1830 ;; If no headline was found, for the sake of consistency, set
1831 ;; minimum level to 1 nonetheless.
1835 "Return numbering of all exportable headlines in a parse tree.
1837 DATA is the parse tree. OPTIONS is the plist holding export
1838 options.
1840 Return an alist whose key is a headline and value is its
1841 associated numbering \(in the shape of a list of numbers\) or nil
1842 for a footnotes section."
1850 headline
1852 for idx from 0 to org-export-max-depth
1856 options)))
1859 "Return list of elements and objects to ignore during export.
1860 DATA is the parse tree to traverse. OPTIONS is the plist holding
1861 export options."
1863 walk-data
1864 ;; First find trees containing a select tag, if any.
1868 ;; Collect ignored elements or objects into IGNORE-LIST.
1874 ;; If headline is archived but tree below has
1875 ;; to be skipped, add it to ignore list.
1878 ;; Move into secondary string, if any.
1883 ;; Move into recursive objects/elements.
1885 ;; Main call.
1887 ;; Return value.
1888 ignore))
1891 "Return list of headlines and inlinetasks with a select tag in their tree.
1892 DATA is parsed data as returned by `org-element-parse-buffer'.
1893 INFO is a plist holding export options."
1895 walk-data ; For byte-compiler.
1905 ;; When a select tag is found, mark full
1906 ;; genealogy and every headline within the tree
1907 ;; as acceptable.
1910 genealogy
1913 selected-trees))
1914 ;; If at a headline, continue searching in tree,
1915 ;; recursively.
1925 selected-trees))
1928 "Non-nil when element or object BLOB should be skipped during export.
1929 OPTIONS is the plist holding export options. SELECTED, when
1930 non-nil, is a list of headlines or inlinetasks belonging to
1931 a tree with a select tag."
1938 ;; If `:with-drawers' value starts with `not', ignore
1939 ;; every drawer whose name belong to that list.
1940 ;; Otherwise, ignore drawers whose name isn't in that
1941 ;; list.
1955 ;; Ignore subtrees with an exclude tag.
1958 ;; When a select tag is present in the buffer, ignore any tree
1959 ;; without it.
1961 ;; Ignore commented sub-trees.
1963 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1965 ;; Ignore tasks, if specified by `:with-tasks' property.
1981 ;; No timestamp allowed.
1983 ;; Only active timestamps allowed and the current one isn't
1984 ;; active.
1988 ;; Only inactive timestamps allowed and the current one isn't
1989 ;; inactive.
1995 \f
1996 ;;; The Transcoder
1997 ;;
1998 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1999 ;; `org-element-parse-buffer') and transcodes it into a specified
2000 ;; back-end output. It takes care of filtering out elements or
2001 ;; objects according to export options and organizing the output blank
2002 ;; lines and white space are preserved. The function memoizes its
2003 ;; results, so it is cheap to call it within translators.
2004 ;;
2005 ;; It is possible to modify locally the back-end used by
2006 ;; `org-export-data' or even use a temporary back-end by using
2007 ;; `org-export-data-with-translations' and
2008 ;; `org-export-data-with-backend'.
2009 ;;
2010 ;; Internally, three functions handle the filtering of objects and
2011 ;; elements during the export. In particular,
2012 ;; `org-export-ignore-element' marks an element or object so future
2013 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2014 ;; elements or objects should be seen as real Org syntax and
2015 ;; `org-export-expand' transforms the others back into their original
2016 ;; shape
2017 ;;
2018 ;; `org-export-transcoder' is an accessor returning appropriate
2019 ;; translator function for a given element or object.
2022 "Return appropriate transcoder for BLOB.
2023 INFO is a plist containing export directives."
2025 ;; Return contents only for complete parse trees.
2031 "Convert DATA into current back-end format.
2033 DATA is a parse tree, an element or an object or a secondary
2034 string. INFO is a plist holding export options.
2036 Return transcoded string."
2042 ;; Ignored element/object.
2044 ;; Plain text.
2050 info))
2051 ;; Uninterpreted element/object: change it back to Org
2052 ;; syntax and export again resulting raw string.
2056 data
2060 info))
2061 ;; Secondary string.
2064 ;; Element/Object without contents or, as a special case,
2065 ;; headline with archive tag and archived trees restricted
2066 ;; to title only.
2074 ;; Element/Object with contents.
2087 ;; Elements directly containing objects
2088 ;; must have their indentation normalized
2089 ;; first.
2091 data
2092 ;; When normalizing contents of the first
2093 ;; paragraph in an item or a footnote
2094 ;; definition, ignore first line's
2095 ;; indentation: there is none and it
2096 ;; might be misleading.
2101 data)
2108 info))))))))
2109 ;; Final result will be memoized before being returned.
2111 data
2115 ;; Append the same white space between elements or objects as in
2116 ;; the original buffer, and call appropriate filters.
2127 info)))
2128 results)))
2132 "Convert DATA into another format using a given translation table.
2133 DATA is an element, an object, a secondary string or a string.
2134 TRANSLATIONS is an alist between element or object types and
2135 a functions handling them. See `org-export-define-backend' for
2136 more information. INFO is a plist used as a communication
2137 channel."
2139 data
2140 ;; Set-up a new communication channel with TRANSLATIONS as the
2141 ;; translate table and a new hash table for memoization.
2143 info
2145 ;; Size of the hash table is reduced since this function
2146 ;; will probably be used on short trees.
2150 "Convert DATA into BACKEND format.
2152 DATA is an element, an object, a secondary string or a string.
2153 BACKEND is a symbol. INFO is a plist used as a communication
2154 channel.
2156 Unlike to `org-export-with-backend', this function will
2157 recursively convert DATA using BACKEND translation table."
2163 "Non-nil if element or object BLOB should be interpreted during export.
2164 If nil, BLOB will appear as raw Org syntax. Check is done
2165 according to export options INFO, stored as a plist."
2167 ;; ... entities...
2169 ;; ... emphasis...
2172 ;; ... fixed-width areas.
2174 ;; ... footnotes...
2177 ;; ... LaTeX environments and fragments...
2181 ;; ... sub/superscripts...
2187 ;; ... tables...
2192 "Expand a parsed element or object to its original state.
2193 BLOB is either an element or an object. CONTENTS is its
2194 contents, as a string or nil."
2197 blob contents))
2200 "Add ELEMENT to `:ignore-list' in INFO.
2202 Any element in `:ignore-list' will be skipped when using
2203 `org-element-map'. INFO is modified by side effects."
2207 \f
2208 ;;; The Filter System
2209 ;;
2210 ;; Filters allow end-users to tweak easily the transcoded output.
2211 ;; They are the functional counterpart of hooks, as every filter in
2212 ;; a set is applied to the return value of the previous one.
2213 ;;
2214 ;; Every set is back-end agnostic. Although, a filter is always
2215 ;; called, in addition to the string it applies to, with the back-end
2216 ;; used as argument, so it's easy for the end-user to add back-end
2217 ;; specific filters in the set. The communication channel, as
2218 ;; a plist, is required as the third argument.
2219 ;;
2220 ;; From the developer side, filters sets can be installed in the
2221 ;; process with the help of `org-export-define-backend', which
2222 ;; internally stores filters as an alist. Each association has a key
2223 ;; among the following symbols and a function or a list of functions
2224 ;; as value.
2225 ;;
2226 ;; - `:filter-options' applies to the property list containing export
2227 ;; options. Unlike to other filters, functions in this list accept
2228 ;; two arguments instead of three: the property list containing
2229 ;; export options and the back-end. Users can set its value through
2230 ;; `org-export-filter-options-functions' variable.
2231 ;;
2232 ;; - `:filter-parse-tree' applies directly to the complete parsed
2233 ;; tree. Users can set it through
2234 ;; `org-export-filter-parse-tree-functions' variable.
2235 ;;
2236 ;; - `:filter-final-output' applies to the final transcoded string.
2237 ;; Users can set it with `org-export-filter-final-output-functions'
2238 ;; variable
2239 ;;
2240 ;; - `:filter-plain-text' applies to any string not recognized as Org
2241 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2242 ;; configure it.
2243 ;;
2244 ;; - `:filter-TYPE' applies on the string returned after an element or
2245 ;; object of type TYPE has been transcoded. An user can modify
2246 ;; `org-export-filter-TYPE-functions'
2247 ;;
2248 ;; All filters sets are applied with
2249 ;; `org-export-filter-apply-functions' function. Filters in a set are
2250 ;; applied in a LIFO fashion. It allows developers to be sure that
2251 ;; their filters will be applied first.
2252 ;;
2253 ;; Filters properties are installed in communication channel with
2254 ;; `org-export-install-filters' function.
2255 ;;
2256 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2257 ;; `org-export-before-parsing-hook') are run at the beginning of the
2258 ;; export process and just before parsing to allow for heavy structure
2259 ;; modifications.
2262 ;;;; Hooks
2265 "Hook run at the beginning of the export process.
2267 This is run before include keywords and macros are expanded and
2268 Babel code blocks executed, on a copy of the original buffer
2269 being exported. Visibility and narrowing are preserved. Point
2270 is at the beginning of the buffer.
2272 Every function in this hook will be called with one argument: the
2276 "Hook run before parsing an export buffer.
2278 This is run after include keywords and macros have been expanded
2279 and Babel code blocks executed, on a copy of the original buffer
2280 being exported. Visibility and narrowing are preserved. Point
2281 is at the beginning of the buffer.
2283 Every function in this hook will be called with one argument: the
2287 ;;;; Special Filters
2290 "List of functions applied to the export options.
2291 Each filter is called with two arguments: the export options, as
2292 a plist, and the back-end, as a symbol. It must return
2296 "List of functions applied to the parsed tree.
2297 Each filter is called with three arguments: the parse tree, as
2298 returned by `org-element-parse-buffer', the back-end, as
2299 a symbol, and the communication channel, as a plist. It must
2303 "List of functions applied to plain text.
2304 Each filter is called with three arguments: a string which
2305 contains no Org syntax, the back-end, as a symbol, and the
2306 communication channel, as a plist. It must return a string or
2310 "List of functions applied to the transcoded string.
2311 Each filter is called with three arguments: the full transcoded
2312 string, the back-end, as a symbol, and the communication channel,
2313 as a plist. It must return a string that will be used as the
2317 ;;;; Elements Filters
2320 "List of functions applied to a transcoded babel-call.
2321 Each filter is called with three arguments: the transcoded data,
2322 as a string, the back-end, as a symbol, and the communication
2326 "List of functions applied to a transcoded center block.
2327 Each filter is called with three arguments: the transcoded data,
2328 as a string, the back-end, as a symbol, and the communication
2332 "List of functions applied to a transcoded clock.
2333 Each filter is called with three arguments: the transcoded data,
2334 as a string, the back-end, as a symbol, and the communication
2338 "List of functions applied to a transcoded comment.
2339 Each filter is called with three arguments: the transcoded data,
2340 as a string, the back-end, as a symbol, and the communication
2344 "List of functions applied to a transcoded comment-block.
2345 Each filter is called with three arguments: the transcoded data,
2346 as a string, the back-end, as a symbol, and the communication
2350 "List of functions applied to a transcoded diary-sexp.
2351 Each filter is called with three arguments: the transcoded data,
2352 as a string, the back-end, as a symbol, and the communication
2356 "List of functions applied to a transcoded drawer.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 "List of functions applied to a transcoded dynamic-block.
2363 Each filter is called with three arguments: the transcoded data,
2364 as a string, the back-end, as a symbol, and the communication
2368 "List of functions applied to a transcoded example-block.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded export-block.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 "List of functions applied to a transcoded fixed-width.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to a transcoded footnote-definition.
2387 Each filter is called with three arguments: the transcoded data,
2388 as a string, the back-end, as a symbol, and the communication
2392 "List of functions applied to a transcoded headline.
2393 Each filter is called with three arguments: the transcoded data,
2394 as a string, the back-end, as a symbol, and the communication
2398 "List of functions applied to a transcoded horizontal-rule.
2399 Each filter is called with three arguments: the transcoded data,
2400 as a string, the back-end, as a symbol, and the communication
2404 "List of functions applied to a transcoded inlinetask.
2405 Each filter is called with three arguments: the transcoded data,
2406 as a string, the back-end, as a symbol, and the communication
2410 "List of functions applied to a transcoded item.
2411 Each filter is called with three arguments: the transcoded data,
2412 as a string, the back-end, as a symbol, and the communication
2416 "List of functions applied to a transcoded keyword.
2417 Each filter is called with three arguments: the transcoded data,
2418 as a string, the back-end, as a symbol, and the communication
2422 "List of functions applied to a transcoded latex-environment.
2423 Each filter is called with three arguments: the transcoded data,
2424 as a string, the back-end, as a symbol, and the communication
2428 "List of functions applied to a transcoded node-property.
2429 Each filter is called with three arguments: the transcoded data,
2430 as a string, the back-end, as a symbol, and the communication
2434 "List of functions applied to a transcoded paragraph.
2435 Each filter is called with three arguments: the transcoded data,
2436 as a string, the back-end, as a symbol, and the communication
2440 "List of functions applied to a transcoded plain-list.
2441 Each filter is called with three arguments: the transcoded data,
2442 as a string, the back-end, as a symbol, and the communication
2446 "List of functions applied to a transcoded planning.
2447 Each filter is called with three arguments: the transcoded data,
2448 as a string, the back-end, as a symbol, and the communication
2452 "List of functions applied to a transcoded property-drawer.
2453 Each filter is called with three arguments: the transcoded data,
2454 as a string, the back-end, as a symbol, and the communication
2458 "List of functions applied to a transcoded quote block.
2459 Each filter is called with three arguments: the transcoded quote
2460 data, as a string, the back-end, as a symbol, and the
2461 communication channel, as a plist. It must return a string or
2465 "List of functions applied to a transcoded quote-section.
2466 Each filter is called with three arguments: the transcoded data,
2467 as a string, the back-end, as a symbol, and the communication
2471 "List of functions applied to a transcoded section.
2472 Each filter is called with three arguments: the transcoded data,
2473 as a string, the back-end, as a symbol, and the communication
2477 "List of functions applied to a transcoded special block.
2478 Each filter is called with three arguments: the transcoded data,
2479 as a string, the back-end, as a symbol, and the communication
2483 "List of functions applied to a transcoded src-block.
2484 Each filter is called with three arguments: the transcoded data,
2485 as a string, the back-end, as a symbol, and the communication
2489 "List of functions applied to a transcoded table.
2490 Each filter is called with three arguments: the transcoded data,
2491 as a string, the back-end, as a symbol, and the communication
2495 "List of functions applied to a transcoded table-cell.
2496 Each filter is called with three arguments: the transcoded data,
2497 as a string, the back-end, as a symbol, and the communication
2501 "List of functions applied to a transcoded table-row.
2502 Each filter is called with three arguments: the transcoded data,
2503 as a string, the back-end, as a symbol, and the communication
2507 "List of functions applied to a transcoded verse block.
2508 Each filter is called with three arguments: the transcoded data,
2509 as a string, the back-end, as a symbol, and the communication
2513 ;;;; Objects Filters
2516 "List of functions applied to transcoded bold text.
2517 Each filter is called with three arguments: the transcoded data,
2518 as a string, the back-end, as a symbol, and the communication
2522 "List of functions applied to transcoded code text.
2523 Each filter is called with three arguments: the transcoded data,
2524 as a string, the back-end, as a symbol, and the communication
2528 "List of functions applied to a transcoded entity.
2529 Each filter is called with three arguments: the transcoded data,
2530 as a string, the back-end, as a symbol, and the communication
2534 "List of functions applied to a transcoded export-snippet.
2535 Each filter is called with three arguments: the transcoded data,
2536 as a string, the back-end, as a symbol, and the communication
2540 "List of functions applied to a transcoded footnote-reference.
2541 Each filter is called with three arguments: the transcoded data,
2542 as a string, the back-end, as a symbol, and the communication
2546 "List of functions applied to a transcoded inline-babel-call.
2547 Each filter is called with three arguments: the transcoded data,
2548 as a string, the back-end, as a symbol, and the communication
2552 "List of functions applied to a transcoded inline-src-block.
2553 Each filter is called with three arguments: the transcoded data,
2554 as a string, the back-end, as a symbol, and the communication
2558 "List of functions applied to transcoded italic text.
2559 Each filter is called with three arguments: the transcoded data,
2560 as a string, the back-end, as a symbol, and the communication
2564 "List of functions applied to a transcoded latex-fragment.
2565 Each filter is called with three arguments: the transcoded data,
2566 as a string, the back-end, as a symbol, and the communication
2570 "List of functions applied to a transcoded line-break.
2571 Each filter is called with three arguments: the transcoded data,
2572 as a string, the back-end, as a symbol, and the communication
2576 "List of functions applied to a transcoded link.
2577 Each filter is called with three arguments: the transcoded data,
2578 as a string, the back-end, as a symbol, and the communication
2582 "List of functions applied to a transcoded macro.
2583 Each filter is called with three arguments: the transcoded data,
2584 as a string, the back-end, as a symbol, and the communication
2588 "List of functions applied to a transcoded radio-target.
2589 Each filter is called with three arguments: the transcoded data,
2590 as a string, the back-end, as a symbol, and the communication
2594 "List of functions applied to a transcoded statistics-cookie.
2595 Each filter is called with three arguments: the transcoded data,
2596 as a string, the back-end, as a symbol, and the communication
2600 "List of functions applied to transcoded strike-through text.
2601 Each filter is called with three arguments: the transcoded data,
2602 as a string, the back-end, as a symbol, and the communication
2606 "List of functions applied to a transcoded subscript.
2607 Each filter is called with three arguments: the transcoded data,
2608 as a string, the back-end, as a symbol, and the communication
2612 "List of functions applied to a transcoded superscript.
2613 Each filter is called with three arguments: the transcoded data,
2614 as a string, the back-end, as a symbol, and the communication
2618 "List of functions applied to a transcoded target.
2619 Each filter is called with three arguments: the transcoded data,
2620 as a string, the back-end, as a symbol, and the communication
2624 "List of functions applied to a transcoded timestamp.
2625 Each filter is called with three arguments: the transcoded data,
2626 as a string, the back-end, as a symbol, and the communication
2630 "List of functions applied to transcoded underline text.
2631 Each filter is called with three arguments: the transcoded data,
2632 as a string, the back-end, as a symbol, and the communication
2636 "List of functions applied to transcoded verbatim text.
2637 Each filter is called with three arguments: the transcoded data,
2638 as a string, the back-end, as a symbol, and the communication
2642 ;;;; Filters Tools
2643 ;;
2644 ;; Internal function `org-export-install-filters' installs filters
2645 ;; hard-coded in back-ends (developer filters) and filters from global
2646 ;; variables (user filters) in the communication channel.
2647 ;;
2648 ;; Internal function `org-export-filter-apply-functions' takes care
2649 ;; about applying each filter in order to a given data. It ignores
2650 ;; filters returning a nil value but stops whenever a filter returns
2651 ;; an empty string.
2654 "Call every function in FILTERS.
2656 Functions are called with arguments VALUE, current export
2657 back-end and INFO. A function returning a nil value will be
2658 skipped. If it returns the empty string, the process ends and
2659 VALUE is ignored.
2661 Call is done in a LIFO fashion, to be sure that developer
2662 specified filters, if any, are called first."
2671 "Install filters properties in communication channel.
2672 INFO is a plist containing the current communication channel.
2673 Return the updated communication channel."
2675 ;; Install user-defined filters with `org-export-filters-alist'
2676 ;; and filters already in INFO (through ext-plist mechanism).
2683 ;; Filters in INFO will be called
2684 ;; before those user provided.
2687 default-value)))))
2688 org-export-filters-alist)
2689 ;; Prepend back-end specific filters to that list.
2691 ;; Single values get consed, lists are appended.
2696 plist key
2700 ;; Return new communication channel.
2704 \f
2705 ;;; Core functions
2706 ;;
2707 ;; This is the room for the main function, `org-export-as', along with
2708 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2709 ;; `org-export-string-as'. They differ either by the way they output
2710 ;; the resulting code (for the first two) or by the input type (for
2711 ;; the latter).
2712 ;;
2713 ;; `org-export-output-file-name' is an auxiliary function meant to be
2714 ;; used with `org-export-to-file'. With a given extension, it tries
2715 ;; to provide a canonical file name to write export output to.
2716 ;;
2717 ;; Note that `org-export-as' doesn't really parse the current buffer,
2718 ;; but a copy of it (with the same buffer-local variables and
2719 ;; visibility), where macros and include keywords are expanded and
2720 ;; Babel blocks are executed, if appropriate.
2721 ;; `org-export-with-buffer-copy' macro prepares that copy.
2722 ;;
2723 ;; File inclusion is taken care of by
2724 ;; `org-export-expand-include-keyword' and
2725 ;; `org-export--prepare-file-contents'. Structure wise, including
2726 ;; a whole Org file in a buffer often makes little sense. For
2727 ;; example, if the file contains a headline and the include keyword
2728 ;; was within an item, the item should contain the headline. That's
2729 ;; why file inclusion should be done before any structure can be
2730 ;; associated to the file, that is before parsing.
2733 "Return a copy of the current buffer.
2734 The copy preserves Org buffer-local variables, visibility and
2735 narrowing."
2741 new-buf))
2744 "Apply BODY in a copy of the current buffer.
2745 The copy preserves local variables, visibility and contents of
2746 the original buffer. Point is at the beginning of the buffer
2747 when BODY is applied."
2756 ;; Kill copy without confirmation.
2762 "Generate a function duplicating BUFFER.
2764 The copy will preserve local variables, visibility, contents and
2765 narrowing of the original buffer. If a region was active in
2766 BUFFER, contents will be narrowed to that region instead.
2768 The resulting function can be evaled at a later time, from
2769 another buffer, effectively cloning the original buffer there.
2771 The function assumes BUFFER's major mode is `org-mode'."
2775 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2776 ;; already in BUFFER.
2778 ;; Buffer local variables.
2788 buffer-file-name
2789 buffer-file-coding-system))
2792 ;; Skip unreadable values, as they cannot be
2793 ;; sent to external process.
2797 local-vars)))))
2799 local-vars)
2800 ;; Whole buffer contents.
2805 ;; Narrowing.
2809 ;; Current position of point.
2811 ;; Overlays with invisible property.
2821 ov-set))))
2823 ov-set)))))
2825 ;;;###autoload
2828 "Transcode current Org buffer into BACKEND code.
2830 If narrowing is active in the current buffer, only transcode its
2831 narrowed part.
2833 If a region is active, transcode that region.
2835 When optional argument SUBTREEP is non-nil, transcode the
2836 sub-tree at point, extracting information from the headline
2837 properties first.
2839 When optional argument VISIBLE-ONLY is non-nil, don't export
2840 contents of hidden elements.
2842 When optional argument BODY-ONLY is non-nil, only return body
2843 code, without surrounding template.
2845 Optional argument EXT-PLIST, when provided, is a property list
2846 with external parameters overriding Org default settings, but
2847 still inferior to file-local settings.
2849 Return code as a string."
2853 ;; Narrow buffer to an appropriate region or subtree for
2854 ;; parsing. If parsing subtree, be sure to remove main headline
2855 ;; too.
2863 ;; Initialize communication channel with original buffer
2864 ;; attributes, unavailable in its copy.
2872 tree)
2873 ;; Update communication channel and get parse tree. Buffer
2874 ;; isn't parsed directly. Instead, a temporary copy is
2875 ;; created, where include keywords, macros are expanded and
2876 ;; code blocks are evaluated.
2878 ;; Run first hook with current back-end as argument.
2881 ;; Update macro templates since #+INCLUDE keywords might have
2882 ;; added some new ones.
2886 ;; Update radio targets since keyword inclusion might have
2887 ;; added some more.
2889 ;; Run last hook with current back-end as argument.
2892 ;; Update communication channel with environment. Also
2893 ;; install user's and developer's filters.
2898 ;; Expand export-specific set of macros: {{{author}}},
2899 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2900 ;; once regular macros have been expanded, since document
2901 ;; keywords may contain one of them.
2907 ;; EMAIL is not a parsed keyword: store it as-is.
2911 ;; Call options filters and update export options. We do not
2912 ;; use `org-export-filter-apply-functions' here since the
2913 ;; arity of such filters is different.
2917 ;; Parse buffer and call parse-tree filter on it.
2922 ;; Now tree is complete, compute its properties and add them
2923 ;; to communication channel.
2927 ;; Eventually transcode TREE. Wrap the resulting string into
2928 ;; a template.
2937 ;; Remove all text properties since they cannot be
2938 ;; retrieved from an external process. Finally call
2939 ;; final-output filter and return result.
2945 info))))))))
2947 ;;;###autoload
2950 "Call `org-export-as' with output to a specified buffer.
2952 BACKEND is the back-end used for transcoding, as a symbol.
2954 BUFFER is the output buffer. If it already exists, it will be
2955 erased first, otherwise, it will be created.
2957 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2958 EXT-PLIST are similar to those used in `org-export-as', which
2959 see.
2961 If `org-export-copy-to-kill-ring' is non-nil, add buffer contents
2962 to kill ring. Return buffer."
2969 ;; Maybe add buffer contents to kill ring.
2972 ;; Return buffer.
2973 buffer))
2975 ;;;###autoload
2978 "Call `org-export-as' with output to a specified file.
2980 BACKEND is the back-end used for transcoding, as a symbol. FILE
2981 is the name of the output file, as a string.
2983 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2984 EXT-PLIST are similar to those used in `org-export-as', which
2985 see.
2987 If `org-export-copy-to-kill-ring' is non-nil, add file contents
2988 to kill ring. Return output file's name."
2989 ;; Checks for FILE permissions. `write-file' would do the same, but
2990 ;; we'd rather avoid needless transcoding of parse tree.
2992 ;; Insert contents to a temporary buffer and write it to FILE.
2998 ;; Maybe add file contents to kill ring.
3001 ;; Return full path.
3002 file)
3004 ;;;###autoload
3006 "Transcode STRING into BACKEND code.
3008 When optional argument BODY-ONLY is non-nil, only return body
3009 code, without preamble nor postamble.
3011 Optional argument EXT-PLIST, when provided, is a property list
3012 with external parameters overriding Org default settings, but
3013 still inferior to file-local settings.
3015 Return code as a string."
3022 "Return output file's name according to buffer specifications.
3024 EXTENSION is a string representing the output file extension,
3025 with the leading dot.
3027 With a non-nil optional argument SUBTREEP, try to determine
3029 of subtree at point.
3031 When optional argument PUB-DIR is set, use it as the publishing
3032 directory.
3034 When optional argument VISIBLE-ONLY is non-nil, don't export
3035 contents of hidden elements.
3037 Return file name as a string."
3040 ;; File name may come from EXPORT_FILE_NAME subtree
3041 ;; property, assuming point is at beginning of said
3042 ;; sub-tree.
3049 ;; File name may be extracted from buffer's associated
3050 ;; file, if any.
3052 ;; Can't determine file name on our own: Ask user.
3056 "Output file: " pub-dir nil nil nil
3060 ;; Build file name. Enforce EXTENSION over whatever user
3061 ;; may have come up with. PUB-DIR, if defined, always has
3062 ;; precedence over any provided path.
3067 extension))
3070 ;; If writing to OUTPUT-FILE would overwrite original file, append
3071 ;; EXTENSION another time to final name.
3074 output-file)))
3077 "Expand every include keyword in buffer.
3078 Optional argument INCLUDED is a list of included file names along
3079 with their line restriction, when appropriate. It is used to
3080 avoid infinite recursion. Optional argument DIR is the current
3081 working directory. It is used to properly resolve relative
3082 paths."
3089 ;; Extract arguments from keyword's value.
3103 ;; Minimal level of included file defaults to the child
3104 ;; level of the current headline, if any, or one. It
3105 ;; only applies is the file is meant to be included as
3106 ;; an Org one.
3114 ;; Remove keyword.
3119 ;; Check if files has already been parsed. Look after
3120 ;; inclusion lines too, as different parts of the same file
3121 ;; can be included too.
3133 ind-str contents ind-str))))
3141 ind-str env contents ind-str))))
3154 "Prepare the contents of FILE for inclusion and return them as a string.
3156 When optional argument LINES is a string specifying a range of
3157 lines, include only those lines.
3159 Optional argument IND, when non-nil, is an integer specifying the
3160 global indentation of returned contents. Since its purpose is to
3161 allow an included file to stay in the same environment it was
3162 created \(i.e. a list item), it doesn't apply past the first
3163 headline encountered.
3165 Optional argument MINLEVEL, when non-nil, is an integer
3166 specifying the level that any top-level headline in the included
3167 file should have."
3183 ;; Remove blank lines at beginning and end of contents. The logic
3184 ;; behind that removal is that blank lines around include keyword
3185 ;; override blank lines in included file.
3194 ;; If IND is set, preserve indentation of include keyword until
3195 ;; the first headline encountered.
3201 ;; Do not move footnote definitions out of column 0.
3207 ;; When MINLEVEL is specified, compute minimal level for headlines
3208 ;; in the file (CUR-MIN), and remove stars to each headline so
3209 ;; that headlines with minimal level have a level of MINLEVEL.
3219 ;; Only change stars, don't bother moving whole
3220 ;; sections.
3227 "Execute every Babel code in the visible part of current buffer."
3228 ;; Get a pristine copy of current buffer so Babel references can be
3229 ;; properly resolved.
3236 \f
3237 ;;; Tools For Back-Ends
3238 ;;
3239 ;; A whole set of tools is available to help build new exporters. Any
3240 ;; function general enough to have its use across many back-ends
3241 ;; should be added here.
3243 ;;;; For Affiliated Keywords
3244 ;;
3245 ;; `org-export-read-attribute' reads a property from a given element
3246 ;; as a plist. It can be used to normalize affiliated keywords'
3247 ;; syntax.
3248 ;;
3249 ;; Since captions can span over multiple lines and accept dual values,
3250 ;; their internal representation is a bit tricky. Therefore,
3251 ;; `org-export-get-caption' transparently returns a given element's
3252 ;; caption as a secondary string.
3255 "Turn ATTRIBUTE property from ELEMENT into a plist.
3257 When optional argument PROPERTY is non-nil, return the value of
3258 that property within attributes.
3262 properties."
3270 "Return caption from ELEMENT as a secondary string.
3272 When optional argument SHORTP is non-nil, return short caption,
3273 as a secondary string, instead.
3275 Caption lines are separated by a white space."
3283 ;;;; For Derived Back-ends
3284 ;;
3285 ;; `org-export-with-backend' is a function allowing to locally use
3286 ;; another back-end to transcode some object or element. In a derived
3287 ;; back-end, it may be used as a fall-back function once all specific
3288 ;; cases have been treated.
3291 "Call a transcoder from BACK-END on DATA.
3292 CONTENTS, when non-nil, is the transcoded contents of DATA
3293 element, as a string. INFO, when non-nil, is the communication
3294 channel used for export, as a plist.."
3304 ;;;; For Export Snippets
3305 ;;
3306 ;; Every export snippet is transmitted to the back-end. Though, the
3307 ;; latter will only retain one type of export-snippet, ignoring
3308 ;; others, based on the former's target back-end. The function
3309 ;; `org-export-snippet-backend' returns that back-end for a given
3310 ;; export-snippet.
3313 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3314 Translation, with `org-export-snippet-translation-alist', is
3315 applied."
3319 back-end))))
3322 ;;;; For Footnotes
3323 ;;
3324 ;; `org-export-collect-footnote-definitions' is a tool to list
3325 ;; actually used footnotes definitions in the whole parse tree, or in
3326 ;; a headline, in order to add footnote listings throughout the
3327 ;; transcoded data.
3328 ;;
3329 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3330 ;; back-ends, when they need to attach the footnote definition only to
3331 ;; the first occurrence of the corresponding label.
3332 ;;
3333 ;; `org-export-get-footnote-definition' and
3334 ;; `org-export-get-footnote-number' provide easier access to
3335 ;; additional information relative to a footnote reference.
3338 "Return an alist between footnote numbers, labels and definitions.
3340 DATA is the parse tree from which definitions are collected.
3341 INFO is the plist used as a communication channel.
3343 Definitions are sorted by order of references. They either
3344 appear as Org data or as a secondary string for inlined
3345 footnotes. Unreferenced definitions are ignored."
3347 collect-fn ; for byte-compiler.
3351 ;; Collect footnote number, label and definition in DATA.
3359 def)
3360 num-alist)
3361 ;; Also search in definition for nested footnotes.
3364 ;; Don't enter footnote definitions since it will happen
3365 ;; when their first reference is found.
3371 "Non-nil when a footnote reference is the first one for its label.
3373 FOOTNOTE-REFERENCE is the footnote reference being considered.
3374 INFO is the plist used as a communication channel."
3376 ;; Anonymous footnotes are always a first reference.
3378 ;; Otherwise, return the first footnote with the same LABEL and
3379 ;; test if it is equal to FOOTNOTE-REFERENCE.
3389 ;; If FN isn't inlined, be sure to traverse its
3390 ;; definition before resuming search. See
3391 ;; comments in `org-export-get-footnote-number'
3392 ;; for more information.
3396 ;; Don't enter footnote definitions since it will
3397 ;; happen when their first reference is found.
3400 footnote-reference)))))
3403 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3404 INFO is the plist used as a communication channel. If no such
3406 string."
3413 "Return number associated to a footnote.
3415 FOOTNOTE is either a footnote reference or a footnote definition.
3416 INFO is the plist used as a communication channel."
3418 seen-refs
3419 search-ref ; For byte-compiler.
3423 ;; Search footnote references through DATA, filling
3424 ;; SEEN-REFS along the way.
3429 ;; Anonymous footnote match: return number.
3432 ;; Labels match: return number.
3435 ;; Anonymous footnote: it's always a new one.
3436 ;; Also, be sure to return nil from the `cond' so
3437 ;; `first-match' doesn't get us out of the loop.
3439 ;; Label not seen so far: add it so SEEN-REFS.
3440 ;;
3441 ;; Also search for subsequent references in
3442 ;; footnote definition so numbering follows
3443 ;; reading logic. Note that we don't have to care
3444 ;; about inline definitions, since
3445 ;; `org-element-map' already traverses them at the
3446 ;; right time.
3447 ;;
3448 ;; Once again, return nil to stay in the loop.
3453 nil))))
3454 ;; Don't enter footnote definitions since it will
3455 ;; happen when their first reference is found.
3460 ;;;; For Headlines
3461 ;;
3462 ;; `org-export-get-relative-level' is a shortcut to get headline
3463 ;; level, relatively to the lower headline level in the parsed tree.
3464 ;;
3465 ;; `org-export-get-headline-number' returns the section number of an
3466 ;; headline, while `org-export-number-to-roman' allows to convert it
3467 ;; to roman numbers.
3468 ;;
3469 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3470 ;; `org-export-last-sibling-p' are three useful predicates when it
3471 ;; comes to fulfill the `:headline-levels' property.
3472 ;;
3473 ;; `org-export-get-tags', `org-export-get-category' and
3474 ;; `org-export-get-node-property' extract useful information from an
3475 ;; headline or a parent headline. They all handle inheritance.
3476 ;;
3477 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3478 ;; as a secondary string, suitable for table of contents. It falls
3479 ;; back onto default title.
3482 "Return HEADLINE relative level within current parsed tree.
3483 INFO is a plist holding contextual information."
3488 "Non-nil when HEADLINE is considered as low level.
3490 INFO is a plist used as a communication channel.
3492 A low level headlines has a relative level greater than
3493 `:headline-levels' property value.
3495 Return value is the difference between HEADLINE relative level
3496 and the last level being considered as high enough, or nil."
3503 "Return HEADLINE numbering as a list of numbers.
3504 INFO is a plist holding contextual information."
3508 "Return a non-nil value if HEADLINE element should be numbered.
3509 INFO is a plist used as a communication channel."
3515 "Convert integer N into a roman numeral."
3528 res)))
3531 "Return list of tags associated to ELEMENT.
3533 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3534 is a plist used as a communication channel.
3536 Select tags (see `org-export-select-tags') and exclude tags (see
3537 `org-export-exclude-tags') are removed from the list.
3539 When non-nil, optional argument TAGS should be a list of strings.
3540 Any tag belonging to this list will also be removed.
3542 When optional argument INHERITED is non-nil, tags can also be
3543 inherited from parent headlines and FILETAGS keywords."
3549 ;; Build complete list of inherited tags.
3560 ;; Add FILETAGS keywords and return results.
3564 "Return node PROPERTY value for BLOB.
3566 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3567 element or object.
3569 If optional argument INHERITED is non-nil, the value can be
3570 inherited from a parent headline.
3572 Return value is a string or nil."
3584 "Return category for element or object BLOB.
3586 INFO is a plist used as a communication channel.
3588 CATEGORY is automatically inherited from a parent headline, from
3589 #+CATEGORY: keyword or created out of original file name. If all
3593 ;; Almost like `org-export-node-property', but we cannot trust
3594 ;; `plist-member' as every headline has a `:CATEGORY'
3595 ;; property, would it be nil or equal to "???" (which has the
3596 ;; same meaning).
3614 "Return alternative title for HEADLINE, as a secondary string.
3615 INFO is a plist used as a communication channel. If no optional
3616 title is defined, fall-back to the regular title."
3621 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3622 INFO is a plist used as a communication channel."
3627 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3628 INFO is a plist used as a communication channel."
3632 ;;;; For Links
3633 ;;
3634 ;; `org-export-solidify-link-text' turns a string into a safer version
3635 ;; for links, replacing most non-standard characters with hyphens.
3636 ;;
3637 ;; `org-export-get-coderef-format' returns an appropriate format
3638 ;; string for coderefs.
3639 ;;
3640 ;; `org-export-inline-image-p' returns a non-nil value when the link
3641 ;; provided should be considered as an inline image.
3642 ;;
3643 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3644 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3645 ;; returns an appropriate unique identifier when found, or nil.
3646 ;;
3647 ;; `org-export-resolve-id-link' returns the first headline with
3648 ;; specified id or custom-id in parse tree, the path to the external
3649 ;; file with the id or nil when neither was found.
3650 ;;
3651 ;; `org-export-resolve-coderef' associates a reference to a line
3652 ;; number in the element it belongs, or returns the reference itself
3653 ;; when the element isn't numbered.
3656 "Take link text S and make a safe target out of it."
3661 "Return format string for code reference link.
3662 PATH is the link path. DESC is its description."
3670 "Non-nil if LINK object points to an inline image.
3672 Optional argument is a set of RULES defining inline images. It
3673 is an alist where associations have the following shape:
3675 \(TYPE . REGEXP)
3677 Applying a rule means apply REGEXP against LINK's path when its
3678 type is TYPE. The function will return a non-nil value if any of
3679 the provided rules is non-nil. The default rule is
3680 `org-export-default-inline-image-rule'.
3682 This only applies to links without a description."
3693 rules)
3694 ;; Return nil if no rule matched.
3695 nil))))
3698 "Resolve a code reference REF.
3700 INFO is a plist used as a communication channel.
3702 Return associated line number in source code, or REF itself,
3703 depending on src-block or example element's switches."
3710 org-coderef-label-format)))
3714 ;; Element containing REF is found. Resolve it to either
3715 ;; a label or a line number, as needed.
3725 "Return LINK destination.
3727 INFO is a plist holding contextual information.
3729 Return value can be an object, an element, or nil:
3731 - If LINK path matches a target object (i.e. <<path>>) or
3734 - If LINK path exactly matches the name affiliated keyword
3735 \(i.e. #+NAME: path) of an element, return that element.
3737 - If LINK path exactly matches any headline name, return that
3738 element. If more than one headline share that name, priority
3739 will be given to the one with the closest common ancestor, if
3740 any, or the first one in the parse tree otherwise.
3742 - Otherwise, return nil.
3745 significant."
3748 ;; Split PATH at white spaces so matches are space
3749 ;; insensitive.
3753 ;; First try to find a matching "<<path>>" unless user specified
3754 ;; he was looking for a headline (path starts with a *
3755 ;; character).
3762 path)
3763 blob))
3764 info t)))
3765 ;; Then try to find an element with a matching "#+NAME: path"
3766 ;; affiliated keyword.
3769 org-element-all-elements
3774 ;; Last case: link either points to a headline or to
3775 ;; nothingness. Try to find the source, with priority given to
3776 ;; headlines with the closest common ancestor. If such candidate
3777 ;; is found, return it, otherwise return nil.
3781 ;; Return first headline whose `:raw-value' property is
3782 ;; NAME in parse tree DATA, or nil. Statistics cookies
3783 ;; are ignored.
3791 name)
3792 headline))
3794 ;; Search among headlines sharing an ancestor with link, from
3795 ;; closest to farthest.
3803 ;; No match with a common ancestor: try full parse-tree.
3807 "Return headline referenced as LINK destination.
3809 INFO is a plist used as a communication channel.
3811 Return value can be the headline element matched in current parse
3815 ;; First check if id is within the current parse tree.
3820 headline))
3822 ;; Otherwise, look for external files.
3826 "Return radio-target object referenced as LINK destination.
3828 INFO is a plist used as a communication channel.
3830 Return value can be a radio-target object or nil. Assume LINK
3837 radio))
3841 ;;;; For References
3842 ;;
3843 ;; `org-export-get-ordinal' associates a sequence number to any object
3844 ;; or element.
3847 "Return ordinal number of an element or object.
3849 ELEMENT is the element or object considered. INFO is the plist
3850 used as a communication channel.
3852 Optional argument TYPES, when non-nil, is a list of element or
3853 object types, as symbols, that should also be counted in.
3854 Otherwise, only provided element's type is considered.
3856 Optional argument PREDICATE is a function returning a non-nil
3857 value if the current element or object should be counted in. It
3858 accepts two arguments: the element or object being considered and
3859 the plist used as a communication channel. This allows to count
3860 only a certain type of objects (i.e. inline images).
3862 Return value is a list of numbers if ELEMENT is a headline or an
3863 item. It is nil for keywords. It represents the footnote number
3864 for footnote definitions and footnote references. If ELEMENT is
3865 a target, return the same value as if ELEMENT was the closest
3866 table, item or headline containing the target. In any other
3867 case, return the sequence number of ELEMENT among elements or
3868 objects of the same type."
3869 ;; A target keyword, representing an invisible target, never has
3870 ;; a sequence number.
3872 ;; Ordinal of a target object refer to the ordinal of the closest
3873 ;; table, item, or headline containing the object.
3877 when
3881 table))
3882 return parent)))
3884 ;; Special case 1: A headline returns its number as a list.
3886 ;; Special case 2: An item returns its number as a list.
3890 struct
3897 ;; Increment counter until ELEMENT is found again.
3908 ;;;; For Src-Blocks
3909 ;;
3910 ;; `org-export-get-loc' counts number of code lines accumulated in
3911 ;; src-block or example-block elements with a "+n" switch until
3912 ;; a given element, excluded. Note: "-n" switches reset that count.
3913 ;;
3914 ;; `org-export-unravel-code' extracts source code (along with a code
3915 ;; references alist) from an `element-block' or `src-block' type
3916 ;; element.
3917 ;;
3918 ;; `org-export-format-code' applies a formatting function to each line
3919 ;; of code, providing relative line number and code reference when
3920 ;; appropriate. Since it doesn't access the original element from
3921 ;; which the source code is coming, it expects from the code calling
3922 ;; it to know if lines should be numbered and if code references
3923 ;; should appear.
3924 ;;
3925 ;; Eventually, `org-export-format-code-default' is a higher-level
3926 ;; function (it makes use of the two previous functions) which handles
3927 ;; line numbering and code references inclusion, and returns source
3928 ;; code in a format suitable for plain text or verbatim output.
3931 "Return accumulated lines of code up to ELEMENT.
3933 INFO is the plist used as a communication channel.
3935 ELEMENT is excluded from count."
3941 ;; ELEMENT is reached: Quit the loop.
3943 ;; Only count lines from src-block and example-block elements
3944 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3948 ;; Accumulate locs or reset them.
3952 ;; Return nil to stay in the loop.
3953 nil)))
3955 ;; Return value.
3956 loc))
3959 "Clean source code and extract references out of it.
3961 ELEMENT has either a `src-block' an `example-block' type.
3963 Return a cons cell whose CAR is the source code, cleaned from any
3964 reference and protective comma and CDR is an alist between
3965 relative line number (integer) and name of code reference on that
3966 line (string)."
3968 ;; Get code and clean it. Remove blank lines at its
3969 ;; beginning and end.
3975 ;; If appropriate, remove global indentation.
3978 c
3980 ;; Get format used for references.
3983 org-coderef-label-format)))
3984 ;; Build a regexp matching a loc with a reference.
3989 ;; Return value.
3991 ;; Code with references removed.
3997 ;; Ref line: remove ref, and signal its position in REFS.
4001 ;; Reference alist.
4002 refs)))
4005 "Format CODE by applying FUN line-wise and return it.
4007 CODE is a string representing the code to format. FUN is
4008 a function. It must accept three arguments: a line of
4009 code (string), the current line number (integer) or nil and the
4010 reference associated to the current line (string) or nil.
4012 Optional argument NUM-LINES can be an integer representing the
4013 number of code lines accumulated until the current code. Line
4014 numbers passed to FUN will take it into account. If it is nil,
4015 FUN's second argument will always be nil. This number can be
4016 obtained with `org-export-get-loc' function.
4018 Optional argument REF-ALIST can be an alist between relative line
4019 number (i.e. ignoring NUM-LINES) and the name of the code
4020 reference on it. If it is nil, FUN's third argument will always
4021 be nil. It can be obtained through the use of
4022 `org-export-unravel-code' function."
4034 "Return source code from ELEMENT, formatted in a standard way.
4036 ELEMENT is either a `src-block' or `example-block' element. INFO
4037 is a plist used as a communication channel.
4039 This function takes care of line numbering and code references
4040 inclusion. Line numbers, when applicable, appear at the
4041 beginning of the line, separated from the code by two white
4042 spaces. Code references, on the other hand, appear flushed to
4043 the right, separated by six white spaces from the widest line of
4044 code."
4045 ;; Extract code and references.
4052 ;; Handle line numbering.
4061 ;; Prepare references display, if required. Any reference
4062 ;; should start six columns after the widest line of code,
4063 ;; wrapped with parenthesis.
4068 code
4072 number-str
4073 loc
4079 num-start refs)))))
4082 ;;;; For Tables
4083 ;;
4084 ;; `org-export-table-has-special-column-p' and and
4085 ;; `org-export-table-row-is-special-p' are predicates used to look for
4086 ;; meta-information about the table structure.
4087 ;;
4088 ;; `org-table-has-header-p' tells when the rows before the first rule
4089 ;; should be considered as table's header.
4090 ;;
4091 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4092 ;; and `org-export-table-cell-borders' extract information from
4093 ;; a table-cell element.
4094 ;;
4095 ;; `org-export-table-dimensions' gives the number on rows and columns
4096 ;; in the table, ignoring horizontal rules and special columns.
4097 ;; `org-export-table-cell-address', given a table-cell object, returns
4098 ;; the absolute address of a cell. On the other hand,
4099 ;; `org-export-get-table-cell-at' does the contrary.
4100 ;;
4101 ;; `org-export-table-cell-starts-colgroup-p',
4102 ;; `org-export-table-cell-ends-colgroup-p',
4103 ;; `org-export-table-row-starts-rowgroup-p',
4104 ;; `org-export-table-row-ends-rowgroup-p',
4105 ;; `org-export-table-row-starts-header-p' and
4106 ;; `org-export-table-row-ends-header-p' indicate position of current
4107 ;; row or cell within the table.
4110 "Non-nil when TABLE has a special column.
4111 All special columns will be ignored during export."
4112 ;; The table has a special column when every first cell of every row
4113 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4114 ;; "*" "_" and "^". Though, do not consider a first row containing
4115 ;; only empty cells as special.
4131 "Non-nil when TABLE has an header.
4133 INFO is a plist used as a communication channel.
4135 A table has an header when it contains at least two row groups."
4145 info)))
4148 "Non-nil if TABLE-ROW is considered special.
4150 INFO is a plist used as the communication channel.
4152 All special rows will be ignored during export."
4156 ;; A row is special either when...
4158 ;; ... it starts with a field only containing "/",
4160 ;; ... the table contains a special column and the row start
4161 ;; with a marking character among, "^", "_", "$" or "!",
4165 ;; ... it contains only alignment cookies and empty cells.
4171 ;; Since VALUE is a secondary string, the following
4172 ;; checks avoid expanding it with `org-export-data'.
4184 "Return TABLE-ROW's group.
4186 INFO is a plist used as the communication channel.
4188 Return value is the group number, as an integer, or nil special
4189 rows and table rules. Group 1 is also table's header."
4206 "Return TABLE-CELL contents width.
4208 INFO is a plist used as the communication channel.
4210 Return value is the width given by the last width cookie in the
4211 same column as TABLE-CELL, or nil."
4216 cookie-width)
4220 ;; In a special row, try to find a width cookie at COLUMN.
4224 ;; The following checks avoid expanding unnecessarily the
4225 ;; cell with `org-export-data'
4233 ;; Ignore table rules.
4236 ;; Return value.
4237 cookie-width))
4240 "Return TABLE-CELL contents alignment.
4242 INFO is a plist used as the communication channel.
4244 Return alignment as specified by the last alignment cookie in the
4245 same column as TABLE-CELL. If no such cookie is found, a default
4246 alignment value will be deduced from fraction of numbers in the
4247 column (see `org-table-number-fraction' for more information).
4248 Possible values are `left', `right' and `center'."
4255 cookie-align)
4259 ;; In a special row, try to find an alignment cookie at
4260 ;; COLUMN.
4264 ;; Since VALUE is a secondary string, the following checks
4265 ;; avoid useless expansion through `org-export-data'.
4273 ;; Ignore table rules.
4275 ;; In a standard row, check if cell's contents are expressing
4276 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4277 ;; Though, don't bother if an alignment cookie has already
4278 ;; defined cell's alignment.
4283 info)))
4288 ;; Return value. Alignment specified by cookies has precedence
4289 ;; over alignment deduced from cells contents.
4298 "Return TABLE-CELL borders.
4300 INFO is a plist used as a communication channel.
4302 Return value is a list of symbols, or nil. Possible values are:
4303 `top', `bottom', `above', `below', `left' and `right'. Note:
4304 `top' (resp. `bottom') only happen for a cell in the first
4305 row (resp. last row) of the table, ignoring table rules, if any.
4307 Returned borders ignore special rows."
4310 borders)
4311 ;; Top/above border? TABLE-CELL has a border above when a rule
4312 ;; used to demarcate row groups can be found above. Hence,
4313 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4314 ;; another regular row has to be found above that rule.
4323 ;; Look at every row before the current one.
4325 ;; No rule above, or rule found starts the table (ignoring any
4326 ;; special row): TABLE-CELL is at the top of the table.
4329 ;; Bottom/below border? TABLE-CELL has a border below when next
4330 ;; non-regular row below is a rule.
4339 ;; Look at every row after the current one.
4341 ;; No rule below, or rule found ends the table (modulo some
4342 ;; special row): TABLE-CELL is at the bottom of the table.
4345 ;; Right/left borders? They can only be specified by column
4346 ;; groups. Column groups are defined in a row starting with "/".
4347 ;; Also a column groups row only contains "<", "<>", ">" or blank
4348 ;; cells.
4365 ;; There's a left border when previous cell, if
4366 ;; any, ends a group, or current one starts one.
4372 ;; There's a right border when next cell, if any,
4373 ;; starts a group, or current one ends one.
4380 ;; Table rows are read in reverse order so last column groups
4381 ;; row has precedence over any previous one.
4383 ;; Return value.
4384 borders))
4387 "Non-nil when TABLE-CELL is at the beginning of a row group.
4388 INFO is a plist used as a communication channel."
4389 ;; A cell starts a column group either when it is at the beginning
4390 ;; of a row (or after the special column, if any) or when it has
4391 ;; a left border.
4394 table-cell)
4398 "Non-nil when TABLE-CELL is at the end of a row group.
4399 INFO is a plist used as a communication channel."
4400 ;; A cell ends a column group either when it is at the end of a row
4401 ;; or when it has a right border.
4404 table-cell)
4408 "Non-nil when TABLE-ROW is at the beginning of a column group.
4409 INFO is a plist used as a communication channel."
4417 "Non-nil when TABLE-ROW is at the end of a column group.
4418 INFO is a plist used as a communication channel."
4426 "Non-nil when TABLE-ROW is the first table header's row.
4427 INFO is a plist used as a communication channel."
4434 "Non-nil when TABLE-ROW is the last table header's row.
4435 INFO is a plist used as a communication channel."
4442 "Return TABLE dimensions.
4444 INFO is a plist used as a communication channel.
4446 Return value is a CONS like (ROWS . COLUMNS) where
4447 ROWS (resp. COLUMNS) is the number of exportable
4448 rows (resp. columns)."
4450 ;; Set number of rows, and extract first one.
4456 ;; Set number of columns.
4458 ;; Return value.
4462 "Return address of a regular TABLE-CELL object.
4464 TABLE-CELL is the cell considered. INFO is a plist used as
4465 a communication channel.
4467 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4468 zero-based index. Only exportable cells are considered. The
4469 function returns nil for other cells."
4472 ;; Ignore cells in special rows or in special column.
4477 ;; Row number.
4485 ;; Column number.
4493 "Return regular table-cell object at ADDRESS in TABLE.
4495 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4496 zero-based index. TABLE is a table type element. INFO is
4497 a plist used as a communication channel.
4499 If no table-cell, among exportable cells, is found at ADDRESS,
4500 return nil."
4503 ;; Row at (car address) or nil.
4511 'table-cell
4518 ;;;; For Tables Of Contents
4519 ;;
4520 ;; `org-export-collect-headlines' builds a list of all exportable
4521 ;; headline elements, maybe limited to a certain depth. One can then
4522 ;; easily parse it and transcode it.
4523 ;;
4524 ;; Building lists of tables, figures or listings is quite similar.
4525 ;; Once the generic function `org-export-collect-elements' is defined,
4526 ;; `org-export-collect-tables', `org-export-collect-figures' and
4527 ;; `org-export-collect-listings' can be derived from it.
4530 "Collect headlines in order to build a table of contents.
4532 INFO is a plist used as a communication channel.
4534 When optional argument N is an integer, it specifies the depth of
4535 the table of contents. Otherwise, it is set to the value of the
4536 last headline level. See `org-export-headline-levels' for more
4537 information.
4539 Return a list of all exportable headlines as parsed elements.
4540 Footnote sections, if any, will be ignored."
4545 ;; Strip contents from HEADLINE.
4548 info))
4551 "Collect referenceable elements of a determined type.
4553 TYPE can be a symbol or a list of symbols specifying element
4554 types to search. Only elements with a caption are collected.
4556 INFO is a plist used as a communication channel.
4558 When non-nil, optional argument PREDICATE is a function accepting
4559 one argument, an element of type TYPE. It returns a non-nil
4560 value when that element should be collected.
4562 Return a list of all elements found, in order of appearance."
4567 element))
4568 info))
4571 "Build a list of tables.
4572 INFO is a plist used as a communication channel.
4574 Return a list of table elements with a caption."
4578 "Build a list of figures.
4580 INFO is a plist used as a communication channel. PREDICATE is
4581 a function which accepts one argument: a paragraph element and
4582 whose return value is non-nil when that element should be
4583 collected.
4585 A figure is a paragraph type element, with a caption, verifying
4587 a vague concept that may depend on back-end.
4589 Return a list of elements recognized as figures."
4593 "Build a list of src blocks.
4595 INFO is a plist used as a communication channel.
4597 Return a list of src-block elements with a caption."
4601 ;;;; Smart Quotes
4602 ;;
4603 ;; The main function for the smart quotes sub-system is
4604 ;; `org-export-activate-smart-quotes', which replaces every quote in
4605 ;; a given string from the parse tree with its "smart" counterpart.
4606 ;;
4607 ;; Dictionary for smart quotes is stored in
4608 ;; `org-export-smart-quotes-alist'.
4609 ;;
4610 ;; Internally, regexps matching potential smart quotes (checks at
4611 ;; string boundaries are also necessary) are defined in
4612 ;; `org-export-smart-quotes-regexps'.
4649 "Smart quotes translations.
4651 Alist whose CAR is a language string and CDR is an alist with
4652 quote type as key and a plist associating various encodings to
4653 their translation as value.
4655 A quote type can be any symbol among `opening-double-quote',
4656 `closing-double-quote', `opening-single-quote',
4657 `closing-single-quote' and `apostrophe'.
4659 Valid encodings include `:utf-8', `:html', `:latex' and
4660 `:texinfo'.
4666 ;; Possible opening quote at beginning of string.
4668 ;; Possible closing quote at beginning of string.
4670 ;; Possible apostrophe at beginning of string.
4672 ;; Opening single and double quotes.
4674 ;; Closing single and double quotes.
4676 ;; Apostrophe.
4678 ;; Possible opening quote at end of string.
4680 ;; Possible closing quote at end of string.
4682 ;; Possible apostrophe at end of string.
4684 "List of regexps matching a quote or an apostrophe.
4690 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4691 `:utf-8'. INFO is a plist used as a communication channel.
4693 The function has to retrieve information about string
4694 surroundings in parse tree. It can only happen with an
4695 unmodified string. Thus, if S has already been through another
4696 process, a non-nil ORIGINAL optional argument will provide that
4697 original string.
4699 Return the new string."
4702 ;; Try to be flexible when computing number of blanks
4703 ;; before object. The previous object may be a string
4704 ;; introduced by the back-end and not completely parsed.
4707 ;; A string with missing `:post-blank'
4708 ;; property.
4712 ;; Fallback value.
4717 ;; Return smart quote associated to a give quote Q, as
4718 ;; a string. TYPE is a symbol among `open', `close' and
4719 ;; `apostrophe'.
4729 org-export-smart-quotes-alist))))
4730 encoding)
4731 q)))))
4733 ;; Only a quote: no regexp can match. We have to check both
4734 ;; sides and decide what to do.
4742 ;; 1. Replace quote character at the beginning of S.
4744 ;; Apostrophe?
4750 ;; Closing quote?
4756 ;; Opening quote?
4762 ;; 2. Replace quotes in the middle of the string.
4764 ;; Opening quotes.
4770 ;; Closing quotes.
4776 ;; Apostrophes.
4781 ;; 3. Replace quote character at the end of S.
4783 ;; Apostrophe?
4788 ;; Closing quote?
4794 ;; Opening quote?
4799 ;; Return string with smart quotes.
4800 s))))
4802 ;;;; Topology
4803 ;;
4804 ;; Here are various functions to retrieve information about the
4805 ;; neighbourhood of a given element or object. Neighbours of interest
4806 ;; are direct parent (`org-export-get-parent'), parent headline
4807 ;; (`org-export-get-parent-headline'), first element containing an
4808 ;; object, (`org-export-get-parent-element'), parent table
4809 ;; (`org-export-get-parent-table'), previous element or object
4810 ;; (`org-export-get-previous-element') and next element or object
4811 ;; (`org-export-get-next-element').
4812 ;;
4813 ;; `org-export-get-genealogy' returns the full genealogy of a given
4814 ;; element or object, from closest parent to full parse tree.
4817 "Return BLOB parent or nil.
4818 BLOB is the element or object considered."
4822 "Return full genealogy relative to a given element or object.
4824 BLOB is the element or object being considered.
4826 Ancestors are returned from closest to farthest, the last one
4827 being the full parse tree."
4834 "Return BLOB parent headline or nil.
4835 BLOB is the element or object being considered."
4839 parent))
4842 "Return first element containing OBJECT or nil.
4843 OBJECT is the object to consider."
4847 parent))
4850 "Return OBJECT parent table or nil.
4851 OBJECT is either a `table-cell' or `table-element' type object."
4855 parent))
4858 "Return previous element or object.
4860 BLOB is an element or object. INFO is a plist used as
4861 a communication channel. Return previous exportable element or
4862 object, a string, or nil.
4864 When optional argument N is a positive integer, return a list
4865 containing up to N siblings before BLOB, from farthest to
4866 closest. With any other non-nil value, return a list containing
4867 all of them."
4869 ;; An object can belong to the contents of its parent or
4870 ;; to a secondary string. We check the latter option
4871 ;; first.
4874 org-element-all-elements))
4878 org-element-secondary-value-alist))
4879 parent)))
4882 prev)
4891 prev)))
4894 "Return next element or object.
4896 BLOB is an element or object. INFO is a plist used as
4897 a communication channel. Return next exportable element or
4898 object, a string, or nil.
4900 When optional argument N is a positive integer, return a list
4901 containing up to N siblings after BLOB, from closest to farthest.
4902 With any other non-nil value, return a list containing all of
4903 them."
4905 ;; An object can belong to the contents of its parent or to
4906 ;; a secondary string. We check the latter option first.
4909 org-element-all-objects))
4913 org-element-secondary-value-alist))
4914 parent)))
4917 next)
4925 siblings)
4929 ;;;; Translation
4930 ;;
4931 ;; `org-export-translate' translates a string according to language
4932 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4933 ;; variable and a specified charset. `org-export-dictionary' contains
4934 ;; the dictionary used for the translation.
5056 "Dictionary for export engine.
5058 Alist whose CAR is the string to translate and CDR is an alist
5059 whose CAR is the language string and CDR is a plist whose
5060 properties are possible charsets and values translated terms.
5062 It is used as a database for `org-export-translate'. Since this
5063 function returns the string as-is if no translation was found,
5064 the variable only needs to record values different from the
5068 "Translate string S according to language specification.
5070 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5071 and `:utf-8'. INFO is a plist used as a communication channel.
5073 Translation depends on `:language' property. Return the
5074 translated string. If no translation is found, try to fall back
5075 to `:default' encoding. If it fails, return S."
5081 s)))
5084 \f
5085 ;;; Asynchronous Export
5086 ;;
5087 ;; `org-export-async-start' is the entry point for asynchronous
5088 ;; export. It recreates current buffer (including visibility,
5089 ;; narrowing and visited file) in an external Emacs process, and
5090 ;; evaluates a command there. It then applies a function on the
5091 ;; returned results in the current process.
5092 ;;
5093 ;; Asynchronously generated results are never displayed directly.
5094 ;; Instead, they are stored in `org-export-stack-contents'. They can
5095 ;; then be retrieved by calling `org-export-stack'.
5096 ;;
5097 ;; Export Stack is viewed through a dedicated major mode
5098 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5099 ;;`org-export-stack-delete', `org-export-stack-view' and
5100 ;;`org-export-stack-clear'.
5101 ;;
5102 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5103 ;; It should used whenever `org-export-async-start' is called.
5106 "Call function FUN on the results returned by BODY evaluation.
5108 BODY evaluation happens in an asynchronous process, from a buffer
5109 which is an exact copy of the current one.
5111 Use `org-export-add-to-stack' in FUN in order to register results
5112 in the stack. Examples for, respectively a temporary buffer and
5113 a file are:
5115 \(org-export-async-start
5116 \(lambda (output)
5118 \(erase-buffer)
5119 \(insert output)
5120 \(goto-char (point-min))
5121 \(org-export-add-to-stack (current-buffer) 'backend)))
5122 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5124 and
5126 \(org-export-async-start
5127 \(lambda (f) (org-export-add-to-stack f 'backend))
5128 `(expand-file-name
5129 \(org-export-to-file
5130 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5133 ;; Write the full sexp evaluating BODY in a copy of the current
5134 ;; buffer to a temporary file, as it may be too long for program
5135 ;; args in `start-process'.
5142 "%S"
5145 ;; Ignore `kill-emacs-hook' as we need a truly
5146 ;; non-interactive process.
5148 ;; Initialize export framework in external process.
5150 ;; Re-create current buffer there.
5153 ;; Sexp to evaluate in the buffer.
5155 ;; Start external process.
5158 (,process
5163 "-l" org-export-async-init-file
5165 ;; Register running process in stack.
5167 ;; Set-up sentinel in order to catch results.
5169 ,process
5193 "Add a new result to export stack if not present already.
5195 SOURCE is a buffer or a file name containing export results.
5196 BACKEND is a symbol representing export back-end used to generate
5197 it.
5199 Entries already pointing to SOURCE and unavailable entries are
5200 removed beforehand. Return the new stack."
5206 "Menu for asynchronous export results and running processes."
5216 "Return source from export results at point in stack."
5223 source
5224 ;; SOURCE is not consistent with current line. The stack
5225 ;; view is outdated.
5229 "Remove all entries from export stack."
5234 "Refresh the asynchronous export stack.
5235 DUMMY is ignored. Unavailable sources are removed from the list.
5236 Return the new stack."
5246 ;; Back-end.
5248 ;; Age.
5251 ;; Compute age of the results.
5253 "%4h:%.2m "
5255 ;; Source.
5260 ;; Clear stack from exited processes, dead buffers or
5261 ;; non-existent files.
5273 "Remove export results at point from stack.
5274 If optional argument SOURCE is non-nil, remove it instead."
5279 org-export-stack-contents))))
5282 "View export results at point in stack.
5283 With an optional prefix argument IN-EMACS, force viewing files
5284 within Emacs."
5298 (define-key km "p" 'previous-line)
5299 (define-key km "\C-p" 'previous-line)
5300 (define-key km "\C-?" 'previous-line)
5301 (define-key km [up] 'previous-line)
5302 (define-key km "C" 'org-export-stack-clear)
5303 (define-key km "v" 'org-export-stack-view)
5304 (define-key km (kbd "RET") 'org-export-stack-view)
5305 (define-key km "d" 'org-export-stack-remove)
5306 km)
5307 "Keymap for Org Export Stack.")
5309 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5310 "Mode for displaying asynchronous export stack.
5313 stack.
5315 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5316 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5317 stack completely.
5319 Removing entries in an Org Export Stack buffer doesn't affect
5320 files or buffers, only the display.
5323 (abbrev-mode 0)
5324 (auto-fill-mode 0)
5325 (setq buffer-read-only t
5326 buffer-undo-list t
5327 truncate-lines t
5328 header-line-format
5329 '(:eval
5330 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5331 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5332 (set (make-local-variable 'revert-buffer-function)
5333 'org-export-stack-refresh))
5336 \f
5337 ;;; The Dispatcher
5338 ;;
5339 ;; `org-export-dispatch' is the standard interactive way to start an
5340 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5341 ;; for its interface, which, in turn, delegates response to key
5342 ;; pressed to `org-export--dispatch-action'.
5344 ;;;###autoload
5345 (defun org-export-dispatch (&optional arg)
5346 "Export dispatcher for Org mode.
5348 It provides an access to common export related tasks in a buffer.
5349 Its interface comes in two flavours: standard and expert.
5351 While both share the same set of bindings, only the former
5352 displays the valid keys associations in a dedicated buffer.
5353 Scrolling (resp. line-wise motion) in this buffer is done with
5354 SPC and DEL (resp. C-n and C-p) keys.
5356 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5357 flavour or the other.
5360 of options used back then, on the current buffer.
5362 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5363 (interactive "P")
5364 (let* ((input
5365 (cond ((equal arg '(16)) '(stack))
5366 ((and arg org-export-dispatch-last-action))
5367 (t (save-window-excursion
5368 (unwind-protect
5369 (progn
5370 ;; Remember where we are
5371 (move-marker org-export-dispatch-last-position
5372 (point)
5373 (org-base-buffer (current-buffer)))
5374 ;; Get and store an export command
5375 (setq org-export-dispatch-last-action
5376 (org-export--dispatch-ui
5377 (list org-export-initial-scope
5378 (and org-export-in-background 'async))
5379 nil
5380 org-export-dispatch-use-expert-ui)))
5381 (and (get-buffer "*Org Export Dispatcher*")
5382 (kill-buffer "*Org Export Dispatcher*")))))))
5383 (action (car input))
5384 (optns (cdr input)))
5385 (unless (memq 'subtree optns)
5386 (move-marker org-export-dispatch-last-position nil))
5387 (case action
5388 ;; First handle special hard-coded actions.
5389 (stack (org-export-stack))
5390 (publish-current-file
5391 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5392 (publish-current-project
5393 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5394 (publish-choose-project
5395 (org-publish (assoc (org-icompleting-read
5396 "Publish project: "
5397 org-publish-project-alist nil t)
5398 org-publish-project-alist)
5399 (memq 'force optns)
5400 (memq 'async optns)))
5401 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5402 (otherwise
5403 (save-excursion
5404 (when arg
5405 ;; Repeating command, maybe move cursor
5406 ;; to restore subtree context
5407 (if (eq (marker-buffer org-export-dispatch-last-position)
5408 (org-base-buffer (current-buffer)))
5409 (goto-char org-export-dispatch-last-position)
5410 ;; We are in a differnet buffer, forget position
5411 (move-marker org-export-dispatch-last-position nil)))
5412 (funcall action
5413 ;; Return a symbol instead of a list to ease
5414 ;; asynchronous export macro use.
5415 (and (memq 'async optns) t)
5416 (and (memq 'subtree optns) t)
5417 (and (memq 'visible optns) t)
5418 (and (memq 'body optns) t)))))))
5420 (defun org-export--dispatch-ui (options first-key expertp)
5421 "Handle interface for `org-export-dispatch'.
5423 OPTIONS is a list containing current interactive options set for
5424 export. It can contain any of the following symbols:
5425 `body' toggles a body-only export
5426 `subtree' restricts export to current subtree
5427 `visible' restricts export to visible part of buffer.
5428 `force' force publishing files.
5429 `async' use asynchronous export process
5431 FIRST-KEY is the key pressed to select the first level menu. It
5432 is nil when this menu hasn't been selected yet.
5434 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5435 buffer is provided, but indications about currently active
5436 options are given in the prompt. Moreover, \[?] allows to switch
5437 back to standard interface."
5438 (let* ((fontify-key
5439 (lambda (key &optional access-key)
5440 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5441 ;; non-nil is the required first-level key to activate
5442 ;; KEY. When its value is t, activate KEY independently
5443 ;; on the first key, if any. A nil value means KEY will
5444 ;; only be activated at first level.
5445 (if (or (eq access-key t) (eq access-key first-key))
5446 (org-propertize key 'face 'org-warning)
5447 key)))
5448 (fontify-value
5449 (lambda (value)
5450 ;; Fontify VALUE string.
5451 (org-propertize value 'face 'font-lock-variable-name-face)))
5452 ;; Prepare menu entries by extracting them from
5453 ;; `org-export-registered-backends', and sorting them by
5454 ;; access key and by ordinal, if any.
5455 (backends
5456 (sort
5457 (sort
5458 (delq nil
5459 (mapcar
5460 (lambda (b)
5461 (let ((name (car b)))
5462 (catch 'ignored
5463 ;; Ignore any back-end belonging to
5464 ;; `org-export-invisible-backends' or derived
5465 ;; from one of them.
5466 (dolist (ignored org-export-invisible-backends)
5467 (when (org-export-derived-backend-p name ignored)
5468 (throw 'ignored nil)))
5469 (org-export-backend-menu name))))
5470 org-export-registered-backends))
5471 (lambda (a b)
5472 (let ((key-a (nth 1 a))
5473 (key-b (nth 1 b)))
5474 (cond ((and (numberp key-a) (numberp key-b))
5475 (< key-a key-b))
5476 ((numberp key-b) t)))))
5477 (lambda (a b) (< (car a) (car b)))))
5478 ;; Compute a list of allowed keys based on the first key
5479 ;; pressed, if any. Some keys (?^B, ?^V, ?^S, ?^F, ?^A
5480 ;; and ?q) are always available.
5481 (allowed-keys
5482 (nconc (list 2 22 19 6 1)
5483 (if (not first-key) (org-uniquify (mapcar 'car backends))
5484 (let (sub-menu)
5485 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5486 (when (eq (car backend) first-key)
5487 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5488 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5489 ((not first-key) (list ?P)))
5490 (list ?&)
5491 (when expertp (list ??))
5492 (list ?q)))
5493 ;; Build the help menu for standard UI.
5494 (help
5495 (unless expertp
5496 (concat
5497 ;; Options are hard-coded.
5498 (format "Options
5499 [%s] Body only: %s [%s] Visible only: %s
5500 [%s] Export scope: %s [%s] Force publishing: %s
5502 (funcall fontify-key "C-b" t)
5503 (funcall fontify-value
5504 (if (memq 'body options) "On " "Off"))
5505 (funcall fontify-key "C-v" t)
5506 (funcall fontify-value
5507 (if (memq 'visible options) "On " "Off"))
5508 (funcall fontify-key "C-s" t)
5509 (funcall fontify-value
5510 (if (memq 'subtree options) "Subtree" "Buffer "))
5511 (funcall fontify-key "C-f" t)
5512 (funcall fontify-value
5513 (if (memq 'force options) "On " "Off"))
5514 (funcall fontify-key "C-a" t)
5515 (funcall fontify-value
5516 (if (memq 'async options) "On " "Off")))
5517 ;; Display registered back-end entries. When a key
5518 ;; appears for the second time, do not create another
5519 ;; entry, but append its sub-menu to existing menu.
5520 (let (last-key)
5521 (mapconcat
5522 (lambda (entry)
5523 (let ((top-key (car entry)))
5524 (concat
5525 (unless (eq top-key last-key)
5526 (setq last-key top-key)
5528 (funcall fontify-key (char-to-string top-key))
5529 (nth 1 entry)))
5530 (let ((sub-menu (nth 2 entry)))
5531 (unless (functionp sub-menu)
5532 ;; Split sub-menu into two columns.
5533 (let ((index -1))
5534 (concat
5535 (mapconcat
5536 (lambda (sub-entry)
5537 (incf index)
5538 (format
5539 (if (zerop (mod index 2)) " [%s] %-26s"
5541 (funcall fontify-key
5542 (char-to-string (car sub-entry))
5543 top-key)
5544 (nth 1 sub-entry)))
5545 sub-menu "")
5547 backends ""))
5548 ;; Publishing menu is hard-coded.
5550 [%s] Current file [%s] Current project
5552 (funcall fontify-key "P")
5553 (funcall fontify-key "f" ?P)
5554 (funcall fontify-key "p" ?P)
5555 (funcall fontify-key "x" ?P)
5556 (funcall fontify-key "a" ?P))
5558 (format "\[%s] %s"
5559 (funcall fontify-key "q" t)
5560 (if first-key "Main menu" "Exit")))))
5561 ;; Build prompts for both standard and expert UI.
5562 (standard-prompt (unless expertp "Export command: "))
5563 (expert-prompt
5564 (when expertp
5565 (format
5566 "Export command (C-%s%s%s%s%s) [%s]: "
5567 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5568 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5569 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5570 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5571 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5572 (mapconcat (lambda (k)
5573 ;; Strip control characters.
5574 (unless (< k 27) (char-to-string k)))
5575 allowed-keys "")))))
5576 ;; With expert UI, just read key with a fancy prompt. In standard
5577 ;; UI, display an intrusive help buffer.
5578 (if expertp
5579 (org-export--dispatch-action
5580 expert-prompt allowed-keys backends options first-key expertp)
5581 ;; At first call, create frame layout in order to display menu.
5582 (unless (get-buffer "*Org Export Dispatcher*")
5583 (delete-other-windows)
5584 (org-switch-to-buffer-other-window
5585 (get-buffer-create "*Org Export Dispatcher*"))
5586 (setq cursor-type nil
5587 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
5588 ;; Make sure that invisible cursor will not highlight square
5589 ;; brackets.
5590 (set-syntax-table (copy-syntax-table))
5591 (modify-syntax-entry ?\[ "w"))
5592 ;; At this point, the buffer containing the menu exists and is
5593 ;; visible in the current window. So, refresh it.
5594 (with-current-buffer "*Org Export Dispatcher*"
5595 ;; Refresh help. Maintain display continuity by re-visiting
5596 ;; previous window position.
5597 (let ((pos (window-start)))
5598 (erase-buffer)
5599 (insert help)
5600 (set-window-start nil pos)))
5601 (org-fit-window-to-buffer)
5602 (org-export--dispatch-action
5603 standard-prompt allowed-keys backends options first-key expertp))))
5605 (defun org-export--dispatch-action
5606 (prompt allowed-keys backends options first-key expertp)
5607 "Read a character from command input and act accordingly.
5609 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5610 a list of characters available at a given step in the process.
5611 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5612 EXPERTP are the same as defined in `org-export--dispatch-ui',
5613 which see.
5615 Toggle export options when required. Otherwise, return value is
5616 a list with action as CAR and a list of interactive export
5617 options as CDR."
5618 (let (key)
5619 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
5620 ;; C-p, SPC, DEL).
5621 (while (and (setq key (read-char-exclusive prompt))
5622 (not expertp)
5623 (memq key '(14 16 ?\s ?\d)))
5624 (case key
5625 (14 (if (not (pos-visible-in-window-p (point-max)))
5626 (ignore-errors (scroll-up-line))
5627 (message "End of buffer")
5628 (sit-for 1)))
5629 (16 (if (not (pos-visible-in-window-p (point-min)))
5630 (ignore-errors (scroll-down-line))
5631 (message "Beginning of buffer")
5632 (sit-for 1)))
5633 (?\s (if (not (pos-visible-in-window-p (point-max)))
5634 (scroll-up nil)
5635 (message "End of buffer")
5636 (sit-for 1)))
5637 (?\d (if (not (pos-visible-in-window-p (point-min)))
5638 (scroll-down nil)
5639 (message "Beginning of buffer")
5640 (sit-for 1)))))
5641 (cond
5642 ;; Ignore undefined associations.
5643 ((not (memq key allowed-keys))
5644 (ding)
5645 (unless expertp (message "Invalid key") (sit-for 1))
5646 (org-export--dispatch-ui options first-key expertp))
5647 ;; q key at first level aborts export. At second
5648 ;; level, cancel first key instead.
5649 ((eq key ?q) (if (not first-key) (error "Export aborted")
5650 (org-export--dispatch-ui options nil expertp)))
5651 ;; Help key: Switch back to standard interface if
5652 ;; expert UI was active.
5653 ((eq key ??) (org-export--dispatch-ui options first-key nil))
5654 ;; Switch to asynchronous export stack.
5655 ((eq key ?&) '(stack))
5656 ;; Toggle export options
5657 ;; C-b (2) C-v (22) C-s (19) C-f (6) C-a (1)
5658 ((memq key '(2 22 19 6 1))
5659 (org-export--dispatch-ui
5660 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
5661 (6 'force) (1 'async))))
5662 (if (memq option options) (remq option options)
5663 (cons option options)))
5664 first-key expertp))
5665 ;; Action selected: Send key and options back to
5666 ;; `org-export-dispatch'.
5667 ((or first-key (functionp (nth 2 (assq key backends))))
5668 (cons (cond
5669 ((not first-key) (nth 2 (assq key backends)))
5670 ;; Publishing actions are hard-coded. Send a special
5671 ;; signal to `org-export-dispatch'.
5672 ((eq first-key ?P)
5673 (case key
5674 (?f 'publish-current-file)
5675 (?p 'publish-current-project)
5676 (?x 'publish-choose-project)
5677 (?a 'publish-all)))
5678 ;; Return first action associated to FIRST-KEY + KEY
5679 ;; path. Indeed, derived backends can share the same
5680 ;; FIRST-KEY.
5681 (t (catch 'found
5682 (mapc (lambda (backend)
5683 (let ((match (assq key (nth 2 backend))))
5684 (when match (throw 'found (nth 2 match)))))
5685 (member (assq first-key backends) backends)))))
5686 options))
5687 ;; Otherwise, enter sub-menu.
5688 (t (org-export--dispatch-ui options key expertp)))))
5692 (provide 'ox)
5694 ;; Local variables:
5695 ;; generated-autoload-file: "org-loaddefs.el"
5696 ;; End:
5698 ;;; ox.el ends here