| blob | c5b6d7ca5d4542a44bda516baa19fae25ac99281 |
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."
794 "List of back-ends that shouldn't appear in the dispatcher.
796 Any back-end belonging to this list or derived from a back-end
797 belonging to it will not appear in the dispatcher menu.
799 Indeed, Org may require some export back-ends without notice. If
800 these modules are never to be used interactively, adding them
801 here will avoid cluttering the dispatcher menu."
808 "Non-nil means using a non-intrusive `org-export-dispatch'.
809 In that case, no help buffer is displayed. Though, an indicator
815 asynchronous). Also, \[?] allows to switch back to standard
816 mode."
823 \f
824 ;;; Defining Back-ends
825 ;;
826 ;; `org-export-define-backend' is the standard way to define an export
827 ;; back-end. It allows to specify translators, filters, buffer
828 ;; options and a menu entry. If the new back-end shares translators
829 ;; with another back-end, `org-export-define-derived-backend' may be
830 ;; used instead.
831 ;;
832 ;; Internally, a back-end is stored as a list, of which CAR is the
833 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
834 ;; properties of a given back-end are: `org-export-backend-filters',
835 ;; `org-export-backend-menu', `org-export-backend-options' and
836 ;; `org-export-backend-translate-table'.
837 ;;
838 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
839 ;; when a given back-end hasn't been registered yet.
842 "Define a new back-end BACKEND.
844 TRANSLATORS is an alist between object or element types and
845 functions handling them.
847 These functions should return a string without any trailing
848 space, or nil. They must accept three arguments: the object or
849 element itself, its contents or nil when it isn't recursive and
850 the property list used as a communication channel.
852 Contents, when not nil, are stripped from any global indentation
853 \(although the relative one is preserved). They also always end
854 with a single newline character.
856 If, for a given type, no function is found, that element or
857 object type will simply be ignored, along with any blank line or
858 white space at its end. The same will happen if the function
859 returns the nil value. If that function returns the empty
860 string, the type will be ignored, but the blank lines or white
861 spaces will be kept.
863 In addition to element and object types, one function can be
864 associated to the `template' (or `inner-template') symbol and
865 another one to the `plain-text' symbol.
867 The former returns the final transcoded string, and can be used
868 to add a preamble and a postamble to document's body. It must
869 accept two arguments: the transcoded string and the property list
870 containing export options. A function associated to `template'
872 A function associated to `inner-template' is always applied.
874 The latter, when defined, is to be called on every text not
875 recognized as an element or an object. It must accept two
876 arguments: the text string and the information channel. It is an
877 appropriate place to protect special chars relative to the
878 back-end.
880 BODY can start with pre-defined keyword arguments. The following
881 keywords are understood:
883 :export-block
885 String, or list of strings, representing block names that
886 will not be parsed. This is used to specify blocks that will
887 contain raw code specific to the back-end. These blocks
888 still have to be handled by the relative `export-block' type
889 translator.
891 :filters-alist
893 Alist between filters and function, or list of functions,
894 specific to the back-end. See `org-export-filters-alist' for
895 a list of all allowed filters. Filters defined here
896 shouldn't make a back-end test, as it may prevent back-ends
897 derived from this one to behave properly.
899 :menu-entry
901 Menu entry for the export dispatcher. It should be a list
902 like:
904 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
906 where :
908 KEY is a free character selecting the back-end.
910 DESCRIPTION-OR-ORDINAL is either a string or a number.
912 If it is a string, is will be used to name the back-end in
913 its menu entry. If it is a number, the following menu will
914 be displayed as a sub-menu of the back-end with the same
915 KEY. Also, the number will be used to determine in which
916 order such sub-menus will appear (lowest first).
918 ACTION-OR-MENU is either a function or an alist.
920 If it is an action, it will be called with four
921 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
922 BODY-ONLY. See `org-export-as' for further explanations on
923 some of them.
925 If it is an alist, associations should follow the
926 pattern:
928 \(KEY DESCRIPTION ACTION)
930 where KEY, DESCRIPTION and ACTION are described above.
932 Valid values include:
936 or
941 \(lambda (a s v b)
942 \(if a (org-latex-export-to-pdf t s v b)
943 \(org-open-file
944 \(org-latex-export-to-pdf nil s v b)))))))
946 or the following, which will be added to the previous
947 sub-menu,
949 \(?l 1
953 :options-alist
955 Alist between back-end specific properties introduced in
956 communication channel and how their value are acquired. See
957 `org-export-options-alist' for more information about
958 structure of the values."
977 ;; Register back-end.
981 ;; Tell parser to not parse EXPORT-BLOCK blocks.
988 ;; Splice in the body, if any.
992 "Create a new back-end as a variant of an existing one.
994 CHILD is the name of the derived back-end. PARENT is the name of
995 the parent back-end.
997 BODY can start with pre-defined keyword arguments. The following
998 keywords are understood:
1000 :export-block
1002 String, or list of strings, representing block names that
1003 will not be parsed. This is used to specify blocks that will
1004 contain raw code specific to the back-end. These blocks
1005 still have to be handled by the relative `export-block' type
1006 translator.
1008 :filters-alist
1010 Alist of filters that will overwrite or complete filters
1011 defined in PARENT back-end. See `org-export-filters-alist'
1012 for a list of allowed filters.
1014 :menu-entry
1016 Menu entry for the export dispatcher. See
1017 `org-export-define-backend' for more information about the
1018 expected value.
1020 :options-alist
1022 Alist of back-end specific properties that will overwrite or
1023 complete those defined in PARENT back-end. Refer to
1024 `org-export-options-alist' for more information about
1025 structure of the values.
1027 :translate-alist
1029 Alist of element and object types and transcoders that will
1030 overwrite or complete transcode table from PARENT back-end.
1031 Refer to `org-export-define-backend' for detailed information
1032 about transcoders.
1035 as a variant of `latex' back-end with a custom template function:
1037 \(org-export-define-derived-backend my-latex latex
1038 :translate-alist ((template . my-latex-template-fun)))
1040 The back-end could then be called with, for example:
1068 ;; Register back-end.
1072 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1079 ;; Splice in the body, if any.
1083 "Return back-end from which BACKEND is derived, or nil."
1087 "Return filters for BACKEND."
1092 "Return menu entry for BACKEND."
1097 "Return export options for BACKEND."
1102 "Return translate table for BACKEND."
1107 "Signal an error if BACKEND isn't defined."
1112 "Non-nil if BACKEND is derived from one of BACKENDS."
1116 parent))
1119 \f
1120 ;;; The Communication Channel
1121 ;;
1122 ;; During export process, every function has access to a number of
1123 ;; properties. They are of two types:
1124 ;;
1125 ;; 1. Environment options are collected once at the very beginning of
1126 ;; the process, out of the original buffer and configuration.
1127 ;; Collecting them is handled by `org-export-get-environment'
1128 ;; function.
1129 ;;
1130 ;; Most environment options are defined through the
1131 ;; `org-export-options-alist' variable.
1132 ;;
1133 ;; 2. Tree properties are extracted directly from the parsed tree,
1134 ;; just before export, by `org-export-collect-tree-properties'.
1135 ;;
1136 ;; Here is the full list of properties available during transcode
1137 ;; process, with their category and their value type.
1138 ;;
1139 ;; + `:author' :: Author's name.
1140 ;; - category :: option
1141 ;; - type :: string
1142 ;;
1143 ;; + `:back-end' :: Current back-end used for transcoding.
1144 ;; - category :: tree
1145 ;; - type :: symbol
1146 ;;
1147 ;; + `:creator' :: String to write as creation information.
1148 ;; - category :: option
1149 ;; - type :: string
1150 ;;
1151 ;; + `:date' :: String to use as date.
1152 ;; - category :: option
1153 ;; - type :: string
1154 ;;
1155 ;; + `:description' :: Description text for the current data.
1156 ;; - category :: option
1157 ;; - type :: string
1158 ;;
1159 ;; + `:email' :: Author's email.
1160 ;; - category :: option
1161 ;; - type :: string
1162 ;;
1163 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1164 ;; process.
1165 ;; - category :: option
1166 ;; - type :: list of strings
1167 ;;
1168 ;; + `:export-options' :: List of export options available for current
1169 ;; process.
1170 ;; - category :: none
1171 ;; - type :: list of symbols, among `subtree', `body-only' and
1172 ;; `visible-only'.
1173 ;;
1174 ;; + `:exported-data' :: Hash table used for memoizing
1175 ;; `org-export-data'.
1176 ;; - category :: tree
1177 ;; - type :: hash table
1178 ;;
1179 ;; + `:filetags' :: List of global tags for buffer. Used by
1180 ;; `org-export-get-tags' to get tags with inheritance.
1181 ;; - category :: option
1182 ;; - type :: list of strings
1183 ;;
1184 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1185 ;; their definition, as parsed data. Only non-inlined footnotes
1186 ;; are represented in this alist. Also, every definition isn't
1187 ;; guaranteed to be referenced in the parse tree. The purpose of
1188 ;; this property is to preserve definitions from oblivion
1189 ;; (i.e. when the parse tree comes from a part of the original
1190 ;; buffer), it isn't meant for direct use in a back-end. To
1191 ;; retrieve a definition relative to a reference, use
1192 ;; `org-export-get-footnote-definition' instead.
1193 ;; - category :: option
1194 ;; - type :: alist (STRING . LIST)
1195 ;;
1196 ;; + `:headline-levels' :: Maximum level being exported as an
1197 ;; headline. Comparison is done with the relative level of
1198 ;; headlines in the parse tree, not necessarily with their
1199 ;; actual level.
1200 ;; - category :: option
1201 ;; - type :: integer
1202 ;;
1203 ;; + `:headline-offset' :: Difference between relative and real level
1204 ;; of headlines in the parse tree. For example, a value of -1
1205 ;; means a level 2 headline should be considered as level
1206 ;; 1 (cf. `org-export-get-relative-level').
1207 ;; - category :: tree
1208 ;; - type :: integer
1209 ;;
1210 ;; + `:headline-numbering' :: Alist between headlines and their
1211 ;; numbering, as a list of numbers
1212 ;; (cf. `org-export-get-headline-number').
1213 ;; - category :: tree
1214 ;; - type :: alist (INTEGER . LIST)
1215 ;;
1216 ;; + `:id-alist' :: Alist between ID strings and destination file's
1217 ;; path, relative to current directory. It is used by
1218 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1219 ;; external file.
1220 ;; - category :: option
1221 ;; - type :: alist (STRING . STRING)
1222 ;;
1223 ;; + `:ignore-list' :: List of elements and objects that should be
1224 ;; ignored during export.
1225 ;; - category :: tree
1226 ;; - type :: list of elements and objects
1227 ;;
1228 ;; + `:input-file' :: Full path to input file, if any.
1229 ;; - category :: option
1230 ;; - type :: string or nil
1231 ;;
1232 ;; + `:keywords' :: List of keywords attached to data.
1233 ;; - category :: option
1234 ;; - type :: string
1235 ;;
1236 ;; + `:language' :: Default language used for translations.
1237 ;; - category :: option
1238 ;; - type :: string
1239 ;;
1240 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1241 ;; transcoding.
1242 ;; - category :: option
1243 ;; - type :: list (as returned by `org-element-parse-buffer')
1244 ;;
1245 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1246 ;; all line breaks.
1247 ;; - category :: option
1248 ;; - type :: symbol (nil, t)
1249 ;;
1250 ;; + `:section-numbers' :: Non-nil means transcoding should add
1251 ;; section numbers to headlines.
1252 ;; - category :: option
1253 ;; - type :: symbol (nil, t)
1254 ;;
1255 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1256 ;; in transcoding. When such a tag is present, subtrees without
1257 ;; it are de facto excluded from the process. See
1258 ;; `use-select-tags'.
1259 ;; - category :: option
1260 ;; - type :: list of strings
1261 ;;
1262 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1263 ;; a time stamp in the output.
1264 ;; - category :: option
1265 ;; - type :: symbol (nil, t)
1266 ;;
1267 ;; + `:translate-alist' :: Alist between element and object types and
1268 ;; transcoding functions relative to the current back-end.
1269 ;; Special keys `inner-template', `template' and `plain-text' are
1270 ;; also possible.
1271 ;; - category :: option
1272 ;; - type :: alist (SYMBOL . FUNCTION)
1273 ;;
1274 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1275 ;; also be transcoded. If it is set to the `headline' symbol,
1276 ;; only the archived headline's name is retained.
1277 ;; - category :: option
1278 ;; - type :: symbol (nil, t, `headline')
1279 ;;
1280 ;; + `:with-author' :: Non-nil means author's name should be included
1281 ;; in the output.
1282 ;; - category :: option
1283 ;; - type :: symbol (nil, t)
1284 ;;
1285 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1286 ;; - category :: option
1287 ;; - type :: symbol (nil, t)
1288 ;;
1289 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1290 ;; inserted at the end of the transcoded string. If the value
1291 ;; is `comment', it should be commented.
1292 ;; - category :: option
1293 ;; - type :: symbol (`comment', nil, t)
1294 ;;
1295 ;; + `:with-date' :: Non-nil means output should contain a date.
1296 ;; - category :: option
1297 ;; - type :. symbol (nil, t)
1298 ;;
1299 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1300 ;; its value is a list of names, only drawers with such names
1301 ;; will be transcoded. If that list starts with `not', drawer
1302 ;; with these names will be skipped.
1303 ;; - category :: option
1304 ;; - type :: symbol (nil, t) or list of strings
1305 ;;
1306 ;; + `:with-email' :: Non-nil means output should contain author's
1307 ;; email.
1308 ;; - category :: option
1309 ;; - type :: symbol (nil, t)
1310 ;;
1311 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1312 ;; interpreted.
1313 ;; - category :: option
1314 ;; - type :: symbol (nil, t)
1315 ;;
1316 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1317 ;; strings starting with a colon as a fixed-with (verbatim) area.
1318 ;; - category :: option
1319 ;; - type :: symbol (nil, t)
1320 ;;
1321 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1322 ;; footnotes.
1323 ;; - category :: option
1324 ;; - type :: symbol (nil, t)
1325 ;;
1326 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1327 ;; `latex-fragment' objects should appear in export output. When
1328 ;; this property is set to `verbatim', they will be left as-is.
1329 ;; - category :: option
1330 ;; - type :: symbol (`verbatim', nil, t)
1331 ;;
1332 ;; + `:with-plannings' :: Non-nil means transcoding should include
1333 ;; planning info.
1334 ;; - category :: option
1335 ;; - type :: symbol (nil, t)
1336 ;;
1337 ;; + `:with-priority' :: Non-nil means transcoding should include
1338 ;; priority cookies.
1339 ;; - category :: option
1340 ;; - type :: symbol (nil, t)
1341 ;;
1342 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1343 ;; plain text.
1344 ;; - category :: option
1345 ;; - type :: symbol (nil, t)
1346 ;;
1347 ;; + `:with-special-strings' :: Non-nil means transcoding should
1348 ;; interpret special strings in plain text.
1349 ;; - category :: option
1350 ;; - type :: symbol (nil, t)
1351 ;;
1352 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1353 ;; interpret subscript and superscript. With a value of "{}",
1354 ;; only interpret those using curly brackets.
1355 ;; - category :: option
1356 ;; - type :: symbol (nil, {}, t)
1357 ;;
1358 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1359 ;; tables.
1360 ;; - category :: option
1361 ;; - type :: symbol (nil, t)
1362 ;;
1363 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1364 ;; headlines. A `not-in-toc' value will remove them from the
1365 ;; table of contents, if any, nonetheless.
1366 ;; - category :: option
1367 ;; - type :: symbol (nil, t, `not-in-toc')
1368 ;;
1369 ;; + `:with-tasks' :: Non-nil means transcoding should include
1370 ;; headlines with a TODO keyword. A `todo' value will only
1371 ;; include headlines with a todo type keyword while a `done'
1372 ;; value will do the contrary. If a list of strings is provided,
1373 ;; only tasks with keywords belonging to that list will be kept.
1374 ;; - category :: option
1375 ;; - type :: symbol (t, todo, done, nil) or list of strings
1376 ;;
1377 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1378 ;; time stamps. Special value `active' (resp. `inactive') ask to
1379 ;; export only active (resp. inactive) timestamps. Otherwise,
1380 ;; completely remove them.
1381 ;; - category :: option
1382 ;; - type :: symbol: (`active', `inactive', t, nil)
1383 ;;
1384 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1385 ;; added to the output. An integer value limits its depth.
1386 ;; - category :: option
1387 ;; - type :: symbol (nil, t or integer)
1388 ;;
1389 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1390 ;; include TODO keywords.
1391 ;; - category :: option
1392 ;; - type :: symbol (nil, t)
1395 ;;;; Environment Options
1396 ;;
1397 ;; Environment options encompass all parameters defined outside the
1398 ;; scope of the parsed data. They come from five sources, in
1399 ;; increasing precedence order:
1400 ;;
1401 ;; - Global variables,
1402 ;; - Buffer's attributes,
1403 ;; - Options keyword symbols,
1404 ;; - Buffer keywords,
1405 ;; - Subtree properties.
1406 ;;
1407 ;; The central internal function with regards to environment options
1408 ;; is `org-export-get-environment'. It updates global variables with
1409 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1410 ;; the different sources.
1411 ;;
1412 ;; The internal functions doing the retrieval are:
1413 ;; `org-export--get-global-options',
1414 ;; `org-export--get-buffer-attributes',
1415 ;; `org-export--parse-option-keyword',
1416 ;; `org-export--get-subtree-options' and
1417 ;; `org-export--get-inbuffer-options'
1418 ;;
1419 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1420 ;; relative to "#+BIND:" keywords.
1423 "Collect export options from the current buffer.
1425 Optional argument BACKEND is a symbol specifying which back-end
1426 specific options to read, if any.
1428 When optional argument SUBTREEP is non-nil, assume the export is
1429 done against the current sub-tree.
1431 Third optional argument EXT-PLIST is a property list with
1432 external parameters overriding Org default settings, but still
1433 inferior to file-local settings."
1434 ;; First install #+BIND variables.
1436 ;; Get and prioritize export options...
1438 ;; ... from global variables...
1440 ;; ... from an external property list...
1441 ext-plist
1442 ;; ... from in-buffer settings...
1444 ;; ... and from subtree, when appropriate.
1446 ;; Eventually add misc. properties.
1448 :back-end
1449 backend
1450 :translate-alist
1452 :footnote-definition-alist
1453 ;; Footnotes definitions must be collected in the original
1454 ;; buffer, as there's no insurance that they will still be in
1455 ;; the parse tree, due to possible narrowing.
1469 alist))))
1470 alist))
1471 :id-alist
1472 ;; Collect id references.
1483 alist))))
1486 "Parse an OPTIONS line and return values as a plist.
1487 Optional argument BACKEND is a symbol specifying which back-end
1488 specific items to read, if any."
1490 ;; Priority is given to back-end specific options.
1492 org-export-options-alist))
1493 plist)
1502 options))
1504 property
1507 plist))
1510 "Get export options in subtree at point.
1511 Optional argument BACKEND is a symbol specifying back-end used
1512 for export. Return options as a plist."
1513 ;; For each buffer keyword, create a headline property setting the
1514 ;; same property in communication channel. The name for the property
1515 ;; is the keyword with "EXPORT_" appended to it.
1518 ;; Make sure point is at an heading.
1520 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1521 ;; title as its fallback value.
1527 plist :title
1530 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1534 ;; Handle other keywords. TITLE keyword is excluded as it has
1535 ;; been handled already.
1543 ;; Export properties are not case-sensitive.
1550 plist
1551 property
1553 ;; Parse VALUE if required.
1557 ;; If BEHAVIOUR is `split' expected value is
1558 ;; a list of strings, not a string.
1561 ;; Look for both general keywords and back-end specific
1562 ;; options, with priority given to the latter.
1564 org-export-options-alist)))
1565 ;; Return value.
1566 plist)))
1569 "Return current buffer export options, as a plist.
1571 Optional argument BACKEND, when non-nil, is a symbol specifying
1572 which back-end specific options should also be read in the
1573 process.
1575 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1577 get-options ; For byte-compiler.
1580 ;; Priority is given to back-end specific options.
1582 org-export-options-alist))
1585 org-export-special-keywords))))
1588 ;; Return property name associated to KEYWORD.
1593 options))))
1596 ;; Recursively read keywords in buffer. FILES is a list
1597 ;; of files read so far. PLIST is the current property
1598 ;; list obtained.
1607 ;; Options in `org-export-special-keywords'.
1611 ;; Avoid circular dependencies.
1621 plist
1626 plist
1632 ;; Options in `org-export-options-alist'.
1637 plist prop
1638 ;; Handle value depending on specified
1639 ;; BEHAVIOUR.
1645 " "
1657 ;; Return final value.
1658 plist))))
1659 ;; Read options in the current buffer.
1661 ;; Parse keywords specified in `org-element-document-properties'.
1663 ;; Find the property associated to the keyword.
1671 org-element-document-properties)
1672 ;; Return value.
1673 plist))
1676 "Return properties related to buffer attributes, as a plist."
1679 ;; Store full path of input file name, or nil. For internal use.
1680 :input-file visited-file
1687 "Return global export options as a plist.
1689 Optional argument BACKEND, if non-nil, is a symbol specifying
1690 which back-end specific export options should also be read in the
1691 process."
1693 ;; Priority is given to back-end specific options.
1695 org-export-options-alist))
1696 plist)
1703 plist
1704 prop
1705 ;; Eval default value provided. If keyword is a member
1706 ;; of `org-element-document-properties', parse it as
1707 ;; a secondary string before storing it.
1712 value
1715 all)
1716 ;; Return value.
1717 plist))
1720 "Install the values from #+BIND lines as local variables.
1721 Variables must be installed before in-buffer options are
1722 retrieved."
1737 ;;;; Tree Properties
1738 ;;
1739 ;; Tree properties are information extracted from parse tree. They
1740 ;; are initialized at the beginning of the transcoding process by
1741 ;; `org-export-collect-tree-properties'.
1742 ;;
1743 ;; Dedicated functions focus on computing the value of specific tree
1744 ;; properties during initialization. Thus,
1745 ;; `org-export--populate-ignore-list' lists elements and objects that
1746 ;; should be skipped during export, `org-export--get-min-level' gets
1747 ;; the minimal exportable level, used as a basis to compute relative
1748 ;; level for headlines. Eventually
1749 ;; `org-export--collect-headline-numbering' builds an alist between
1750 ;; headlines and their numbering.
1753 "Extract tree properties from parse tree.
1755 DATA is the parse tree from which information is retrieved. INFO
1756 is a list holding export options.
1758 Following tree properties are set or updated:
1760 `:exported-data' Hash table used to memoize results from
1761 `org-export-data'.
1763 `:footnote-definition-alist' List of footnotes definitions in
1764 original buffer and current parse tree.
1766 `:headline-offset' Offset between true level of headlines and
1767 local level. An offset of -1 means a headline
1768 of level 2 should be considered as a level
1769 1 headline in the context.
1771 `:headline-numbering' Alist of all headlines as key an the
1772 associated numbering as value.
1774 `:ignore-list' List of elements that should be ignored during
1775 export.
1777 Return updated plist."
1778 ;; Install the parse tree in the communication channel, in order to
1779 ;; use `org-export-get-genealogy' and al.
1781 ;; Get the list of elements and objects to ignore, and put it into
1782 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1783 ;; been done during parse tree filtering.
1786 :ignore-list
1789 ;; Compute `:headline-offset' in order to be able to use
1790 ;; `org-export-get-relative-level'.
1793 :headline-offset
1795 ;; Update footnotes definitions list with definitions in parse tree.
1796 ;; This is required since buffer expansion might have modified
1797 ;; boundaries of footnote definitions contained in the parse tree.
1798 ;; This way, definitions in `footnote-definition-alist' are bound to
1799 ;; match those in the parse tree.
1805 defs)))
1807 ;; Properties order doesn't matter: get the rest of the tree
1808 ;; properties.
1812 info))
1815 "Return minimum exportable headline's level in DATA.
1816 DATA is parsed tree as returned by `org-element-parse-buffer'.
1817 OPTIONS is a plist holding export options."
1828 ;; If no headline was found, for the sake of consistency, set
1829 ;; minimum level to 1 nonetheless.
1833 "Return numbering of all exportable headlines in a parse tree.
1835 DATA is the parse tree. OPTIONS is the plist holding export
1836 options.
1838 Return an alist whose key is a headline and value is its
1839 associated numbering \(in the shape of a list of numbers\) or nil
1840 for a footnotes section."
1848 headline
1850 for idx from 0 to org-export-max-depth
1854 options)))
1857 "Return list of elements and objects to ignore during export.
1858 DATA is the parse tree to traverse. OPTIONS is the plist holding
1859 export options."
1861 walk-data
1862 ;; First find trees containing a select tag, if any.
1866 ;; Collect ignored elements or objects into IGNORE-LIST.
1872 ;; If headline is archived but tree below has
1873 ;; to be skipped, add it to ignore list.
1876 ;; Move into secondary string, if any.
1881 ;; Move into recursive objects/elements.
1883 ;; Main call.
1885 ;; Return value.
1886 ignore))
1889 "Return list of headlines and inlinetasks with a select tag in their tree.
1890 DATA is parsed data as returned by `org-element-parse-buffer'.
1891 INFO is a plist holding export options."
1893 walk-data ; For byte-compiler.
1903 ;; When a select tag is found, mark full
1904 ;; genealogy and every headline within the tree
1905 ;; as acceptable.
1908 genealogy
1911 selected-trees))
1912 ;; If at a headline, continue searching in tree,
1913 ;; recursively.
1923 selected-trees))
1926 "Non-nil when element or object BLOB should be skipped during export.
1927 OPTIONS is the plist holding export options. SELECTED, when
1928 non-nil, is a list of headlines or inlinetasks belonging to
1929 a tree with a select tag."
1936 ;; If `:with-drawers' value starts with `not', ignore
1937 ;; every drawer whose name belong to that list.
1938 ;; Otherwise, ignore drawers whose name isn't in that
1939 ;; list.
1953 ;; Ignore subtrees with an exclude tag.
1956 ;; When a select tag is present in the buffer, ignore any tree
1957 ;; without it.
1959 ;; Ignore commented sub-trees.
1961 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1963 ;; Ignore tasks, if specified by `:with-tasks' property.
1979 ;; No timestamp allowed.
1981 ;; Only active timestamps allowed and the current one isn't
1982 ;; active.
1986 ;; Only inactive timestamps allowed and the current one isn't
1987 ;; inactive.
1993 \f
1994 ;;; The Transcoder
1995 ;;
1996 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1997 ;; `org-element-parse-buffer') and transcodes it into a specified
1998 ;; back-end output. It takes care of filtering out elements or
1999 ;; objects according to export options and organizing the output blank
2000 ;; lines and white space are preserved. The function memoizes its
2001 ;; results, so it is cheap to call it within translators.
2002 ;;
2003 ;; It is possible to modify locally the back-end used by
2004 ;; `org-export-data' or even use a temporary back-end by using
2005 ;; `org-export-data-with-translations' and
2006 ;; `org-export-data-with-backend'.
2007 ;;
2008 ;; Internally, three functions handle the filtering of objects and
2009 ;; elements during the export. In particular,
2010 ;; `org-export-ignore-element' marks an element or object so future
2011 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2012 ;; elements or objects should be seen as real Org syntax and
2013 ;; `org-export-expand' transforms the others back into their original
2014 ;; shape
2015 ;;
2016 ;; `org-export-transcoder' is an accessor returning appropriate
2017 ;; translator function for a given element or object.
2020 "Return appropriate transcoder for BLOB.
2021 INFO is a plist containing export directives."
2023 ;; Return contents only for complete parse trees.
2029 "Convert DATA into current back-end format.
2031 DATA is a parse tree, an element or an object or a secondary
2032 string. INFO is a plist holding export options.
2034 Return transcoded string."
2040 ;; Ignored element/object.
2042 ;; Plain text.
2048 info))
2049 ;; Uninterpreted element/object: change it back to Org
2050 ;; syntax and export again resulting raw string.
2054 data
2058 info))
2059 ;; Secondary string.
2062 ;; Element/Object without contents or, as a special case,
2063 ;; headline with archive tag and archived trees restricted
2064 ;; to title only.
2072 ;; Element/Object with contents.
2085 ;; Elements directly containing objects
2086 ;; must have their indentation normalized
2087 ;; first.
2089 data
2090 ;; When normalizing contents of the first
2091 ;; paragraph in an item or a footnote
2092 ;; definition, ignore first line's
2093 ;; indentation: there is none and it
2094 ;; might be misleading.
2099 data)
2106 info))))))))
2107 ;; Final result will be memoized before being returned.
2109 data
2113 ;; Append the same white space between elements or objects as in
2114 ;; the original buffer, and call appropriate filters.
2125 info)))
2126 results)))
2130 "Convert DATA into another format using a given translation table.
2131 DATA is an element, an object, a secondary string or a string.
2132 TRANSLATIONS is an alist between element or object types and
2133 a functions handling them. See `org-export-define-backend' for
2134 more information. INFO is a plist used as a communication
2135 channel."
2137 data
2138 ;; Set-up a new communication channel with TRANSLATIONS as the
2139 ;; translate table and a new hash table for memoization.
2141 info
2143 ;; Size of the hash table is reduced since this function
2144 ;; will probably be used on short trees.
2148 "Convert DATA into BACKEND format.
2150 DATA is an element, an object, a secondary string or a string.
2151 BACKEND is a symbol. INFO is a plist used as a communication
2152 channel.
2154 Unlike to `org-export-with-backend', this function will
2155 recursively convert DATA using BACKEND translation table."
2161 "Non-nil if element or object BLOB should be interpreted during export.
2162 If nil, BLOB will appear as raw Org syntax. Check is done
2163 according to export options INFO, stored as a plist."
2165 ;; ... entities...
2167 ;; ... emphasis...
2170 ;; ... fixed-width areas.
2172 ;; ... footnotes...
2175 ;; ... LaTeX environments and fragments...
2179 ;; ... sub/superscripts...
2185 ;; ... tables...
2190 "Expand a parsed element or object to its original state.
2191 BLOB is either an element or an object. CONTENTS is its
2192 contents, as a string or nil."
2195 blob contents))
2198 "Add ELEMENT to `:ignore-list' in INFO.
2200 Any element in `:ignore-list' will be skipped when using
2201 `org-element-map'. INFO is modified by side effects."
2205 \f
2206 ;;; The Filter System
2207 ;;
2208 ;; Filters allow end-users to tweak easily the transcoded output.
2209 ;; They are the functional counterpart of hooks, as every filter in
2210 ;; a set is applied to the return value of the previous one.
2211 ;;
2212 ;; Every set is back-end agnostic. Although, a filter is always
2213 ;; called, in addition to the string it applies to, with the back-end
2214 ;; used as argument, so it's easy for the end-user to add back-end
2215 ;; specific filters in the set. The communication channel, as
2216 ;; a plist, is required as the third argument.
2217 ;;
2218 ;; From the developer side, filters sets can be installed in the
2219 ;; process with the help of `org-export-define-backend', which
2220 ;; internally stores filters as an alist. Each association has a key
2221 ;; among the following symbols and a function or a list of functions
2222 ;; as value.
2223 ;;
2224 ;; - `:filter-options' applies to the property list containing export
2225 ;; options. Unlike to other filters, functions in this list accept
2226 ;; two arguments instead of three: the property list containing
2227 ;; export options and the back-end. Users can set its value through
2228 ;; `org-export-filter-options-functions' variable.
2229 ;;
2230 ;; - `:filter-parse-tree' applies directly to the complete parsed
2231 ;; tree. Users can set it through
2232 ;; `org-export-filter-parse-tree-functions' variable.
2233 ;;
2234 ;; - `:filter-final-output' applies to the final transcoded string.
2235 ;; Users can set it with `org-export-filter-final-output-functions'
2236 ;; variable
2237 ;;
2238 ;; - `:filter-plain-text' applies to any string not recognized as Org
2239 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2240 ;; configure it.
2241 ;;
2242 ;; - `:filter-TYPE' applies on the string returned after an element or
2243 ;; object of type TYPE has been transcoded. An user can modify
2244 ;; `org-export-filter-TYPE-functions'
2245 ;;
2246 ;; All filters sets are applied with
2247 ;; `org-export-filter-apply-functions' function. Filters in a set are
2248 ;; applied in a LIFO fashion. It allows developers to be sure that
2249 ;; their filters will be applied first.
2250 ;;
2251 ;; Filters properties are installed in communication channel with
2252 ;; `org-export-install-filters' function.
2253 ;;
2254 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2255 ;; `org-export-before-parsing-hook') are run at the beginning of the
2256 ;; export process and just before parsing to allow for heavy structure
2257 ;; modifications.
2260 ;;;; Hooks
2263 "Hook run at the beginning of the export process.
2265 This is run before include keywords and macros are expanded and
2266 Babel code blocks executed, on a copy of the original buffer
2267 being exported. Visibility and narrowing are preserved. Point
2268 is at the beginning of the buffer.
2270 Every function in this hook will be called with one argument: the
2274 "Hook run before parsing an export buffer.
2276 This is run after include keywords and macros have been expanded
2277 and Babel code blocks executed, on a copy of the original buffer
2278 being exported. Visibility and narrowing are preserved. Point
2279 is at the beginning of the buffer.
2281 Every function in this hook will be called with one argument: the
2285 ;;;; Special Filters
2288 "List of functions applied to the export options.
2289 Each filter is called with two arguments: the export options, as
2290 a plist, and the back-end, as a symbol. It must return
2294 "List of functions applied to the parsed tree.
2295 Each filter is called with three arguments: the parse tree, as
2296 returned by `org-element-parse-buffer', the back-end, as
2297 a symbol, and the communication channel, as a plist. It must
2301 "List of functions applied to plain text.
2302 Each filter is called with three arguments: a string which
2303 contains no Org syntax, the back-end, as a symbol, and the
2304 communication channel, as a plist. It must return a string or
2308 "List of functions applied to the transcoded string.
2309 Each filter is called with three arguments: the full transcoded
2310 string, the back-end, as a symbol, and the communication channel,
2311 as a plist. It must return a string that will be used as the
2315 ;;;; Elements Filters
2318 "List of functions applied to a transcoded babel-call.
2319 Each filter is called with three arguments: the transcoded data,
2320 as a string, the back-end, as a symbol, and the communication
2324 "List of functions applied to a transcoded center block.
2325 Each filter is called with three arguments: the transcoded data,
2326 as a string, the back-end, as a symbol, and the communication
2330 "List of functions applied to a transcoded clock.
2331 Each filter is called with three arguments: the transcoded data,
2332 as a string, the back-end, as a symbol, and the communication
2336 "List of functions applied to a transcoded comment.
2337 Each filter is called with three arguments: the transcoded data,
2338 as a string, the back-end, as a symbol, and the communication
2342 "List of functions applied to a transcoded comment-block.
2343 Each filter is called with three arguments: the transcoded data,
2344 as a string, the back-end, as a symbol, and the communication
2348 "List of functions applied to a transcoded diary-sexp.
2349 Each filter is called with three arguments: the transcoded data,
2350 as a string, the back-end, as a symbol, and the communication
2354 "List of functions applied to a transcoded drawer.
2355 Each filter is called with three arguments: the transcoded data,
2356 as a string, the back-end, as a symbol, and the communication
2360 "List of functions applied to a transcoded dynamic-block.
2361 Each filter is called with three arguments: the transcoded data,
2362 as a string, the back-end, as a symbol, and the communication
2366 "List of functions applied to a transcoded example-block.
2367 Each filter is called with three arguments: the transcoded data,
2368 as a string, the back-end, as a symbol, and the communication
2372 "List of functions applied to a transcoded export-block.
2373 Each filter is called with three arguments: the transcoded data,
2374 as a string, the back-end, as a symbol, and the communication
2378 "List of functions applied to a transcoded fixed-width.
2379 Each filter is called with three arguments: the transcoded data,
2380 as a string, the back-end, as a symbol, and the communication
2384 "List of functions applied to a transcoded footnote-definition.
2385 Each filter is called with three arguments: the transcoded data,
2386 as a string, the back-end, as a symbol, and the communication
2390 "List of functions applied to a transcoded headline.
2391 Each filter is called with three arguments: the transcoded data,
2392 as a string, the back-end, as a symbol, and the communication
2396 "List of functions applied to a transcoded horizontal-rule.
2397 Each filter is called with three arguments: the transcoded data,
2398 as a string, the back-end, as a symbol, and the communication
2402 "List of functions applied to a transcoded inlinetask.
2403 Each filter is called with three arguments: the transcoded data,
2404 as a string, the back-end, as a symbol, and the communication
2408 "List of functions applied to a transcoded item.
2409 Each filter is called with three arguments: the transcoded data,
2410 as a string, the back-end, as a symbol, and the communication
2414 "List of functions applied to a transcoded keyword.
2415 Each filter is called with three arguments: the transcoded data,
2416 as a string, the back-end, as a symbol, and the communication
2420 "List of functions applied to a transcoded latex-environment.
2421 Each filter is called with three arguments: the transcoded data,
2422 as a string, the back-end, as a symbol, and the communication
2426 "List of functions applied to a transcoded node-property.
2427 Each filter is called with three arguments: the transcoded data,
2428 as a string, the back-end, as a symbol, and the communication
2432 "List of functions applied to a transcoded paragraph.
2433 Each filter is called with three arguments: the transcoded data,
2434 as a string, the back-end, as a symbol, and the communication
2438 "List of functions applied to a transcoded plain-list.
2439 Each filter is called with three arguments: the transcoded data,
2440 as a string, the back-end, as a symbol, and the communication
2444 "List of functions applied to a transcoded planning.
2445 Each filter is called with three arguments: the transcoded data,
2446 as a string, the back-end, as a symbol, and the communication
2450 "List of functions applied to a transcoded property-drawer.
2451 Each filter is called with three arguments: the transcoded data,
2452 as a string, the back-end, as a symbol, and the communication
2456 "List of functions applied to a transcoded quote block.
2457 Each filter is called with three arguments: the transcoded quote
2458 data, as a string, the back-end, as a symbol, and the
2459 communication channel, as a plist. It must return a string or
2463 "List of functions applied to a transcoded quote-section.
2464 Each filter is called with three arguments: the transcoded data,
2465 as a string, the back-end, as a symbol, and the communication
2469 "List of functions applied to a transcoded section.
2470 Each filter is called with three arguments: the transcoded data,
2471 as a string, the back-end, as a symbol, and the communication
2475 "List of functions applied to a transcoded special block.
2476 Each filter is called with three arguments: the transcoded data,
2477 as a string, the back-end, as a symbol, and the communication
2481 "List of functions applied to a transcoded src-block.
2482 Each filter is called with three arguments: the transcoded data,
2483 as a string, the back-end, as a symbol, and the communication
2487 "List of functions applied to a transcoded table.
2488 Each filter is called with three arguments: the transcoded data,
2489 as a string, the back-end, as a symbol, and the communication
2493 "List of functions applied to a transcoded table-cell.
2494 Each filter is called with three arguments: the transcoded data,
2495 as a string, the back-end, as a symbol, and the communication
2499 "List of functions applied to a transcoded table-row.
2500 Each filter is called with three arguments: the transcoded data,
2501 as a string, the back-end, as a symbol, and the communication
2505 "List of functions applied to a transcoded verse block.
2506 Each filter is called with three arguments: the transcoded data,
2507 as a string, the back-end, as a symbol, and the communication
2511 ;;;; Objects Filters
2514 "List of functions applied to transcoded bold text.
2515 Each filter is called with three arguments: the transcoded data,
2516 as a string, the back-end, as a symbol, and the communication
2520 "List of functions applied to transcoded code text.
2521 Each filter is called with three arguments: the transcoded data,
2522 as a string, the back-end, as a symbol, and the communication
2526 "List of functions applied to a transcoded entity.
2527 Each filter is called with three arguments: the transcoded data,
2528 as a string, the back-end, as a symbol, and the communication
2532 "List of functions applied to a transcoded export-snippet.
2533 Each filter is called with three arguments: the transcoded data,
2534 as a string, the back-end, as a symbol, and the communication
2538 "List of functions applied to a transcoded footnote-reference.
2539 Each filter is called with three arguments: the transcoded data,
2540 as a string, the back-end, as a symbol, and the communication
2544 "List of functions applied to a transcoded inline-babel-call.
2545 Each filter is called with three arguments: the transcoded data,
2546 as a string, the back-end, as a symbol, and the communication
2550 "List of functions applied to a transcoded inline-src-block.
2551 Each filter is called with three arguments: the transcoded data,
2552 as a string, the back-end, as a symbol, and the communication
2556 "List of functions applied to transcoded italic text.
2557 Each filter is called with three arguments: the transcoded data,
2558 as a string, the back-end, as a symbol, and the communication
2562 "List of functions applied to a transcoded latex-fragment.
2563 Each filter is called with three arguments: the transcoded data,
2564 as a string, the back-end, as a symbol, and the communication
2568 "List of functions applied to a transcoded line-break.
2569 Each filter is called with three arguments: the transcoded data,
2570 as a string, the back-end, as a symbol, and the communication
2574 "List of functions applied to a transcoded link.
2575 Each filter is called with three arguments: the transcoded data,
2576 as a string, the back-end, as a symbol, and the communication
2580 "List of functions applied to a transcoded macro.
2581 Each filter is called with three arguments: the transcoded data,
2582 as a string, the back-end, as a symbol, and the communication
2586 "List of functions applied to a transcoded radio-target.
2587 Each filter is called with three arguments: the transcoded data,
2588 as a string, the back-end, as a symbol, and the communication
2592 "List of functions applied to a transcoded statistics-cookie.
2593 Each filter is called with three arguments: the transcoded data,
2594 as a string, the back-end, as a symbol, and the communication
2598 "List of functions applied to transcoded strike-through text.
2599 Each filter is called with three arguments: the transcoded data,
2600 as a string, the back-end, as a symbol, and the communication
2604 "List of functions applied to a transcoded subscript.
2605 Each filter is called with three arguments: the transcoded data,
2606 as a string, the back-end, as a symbol, and the communication
2610 "List of functions applied to a transcoded superscript.
2611 Each filter is called with three arguments: the transcoded data,
2612 as a string, the back-end, as a symbol, and the communication
2616 "List of functions applied to a transcoded target.
2617 Each filter is called with three arguments: the transcoded data,
2618 as a string, the back-end, as a symbol, and the communication
2622 "List of functions applied to a transcoded timestamp.
2623 Each filter is called with three arguments: the transcoded data,
2624 as a string, the back-end, as a symbol, and the communication
2628 "List of functions applied to transcoded underline text.
2629 Each filter is called with three arguments: the transcoded data,
2630 as a string, the back-end, as a symbol, and the communication
2634 "List of functions applied to transcoded verbatim text.
2635 Each filter is called with three arguments: the transcoded data,
2636 as a string, the back-end, as a symbol, and the communication
2640 ;;;; Filters Tools
2641 ;;
2642 ;; Internal function `org-export-install-filters' installs filters
2643 ;; hard-coded in back-ends (developer filters) and filters from global
2644 ;; variables (user filters) in the communication channel.
2645 ;;
2646 ;; Internal function `org-export-filter-apply-functions' takes care
2647 ;; about applying each filter in order to a given data. It ignores
2648 ;; filters returning a nil value but stops whenever a filter returns
2649 ;; an empty string.
2652 "Call every function in FILTERS.
2654 Functions are called with arguments VALUE, current export
2655 back-end and INFO. A function returning a nil value will be
2656 skipped. If it returns the empty string, the process ends and
2657 VALUE is ignored.
2659 Call is done in a LIFO fashion, to be sure that developer
2660 specified filters, if any, are called first."
2669 "Install filters properties in communication channel.
2670 INFO is a plist containing the current communication channel.
2671 Return the updated communication channel."
2673 ;; Install user-defined filters with `org-export-filters-alist'
2674 ;; and filters already in INFO (through ext-plist mechanism).
2681 ;; Filters in INFO will be called
2682 ;; before those user provided.
2685 default-value)))))
2686 org-export-filters-alist)
2687 ;; Prepend back-end specific filters to that list.
2689 ;; Single values get consed, lists are appended.
2694 plist key
2698 ;; Return new communication channel.
2702 \f
2703 ;;; Core functions
2704 ;;
2705 ;; This is the room for the main function, `org-export-as', along with
2706 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2707 ;; `org-export-string-as'. They differ either by the way they output
2708 ;; the resulting code (for the first two) or by the input type (for
2709 ;; the latter).
2710 ;;
2711 ;; `org-export-output-file-name' is an auxiliary function meant to be
2712 ;; used with `org-export-to-file'. With a given extension, it tries
2713 ;; to provide a canonical file name to write export output to.
2714 ;;
2715 ;; Note that `org-export-as' doesn't really parse the current buffer,
2716 ;; but a copy of it (with the same buffer-local variables and
2717 ;; visibility), where macros and include keywords are expanded and
2718 ;; Babel blocks are executed, if appropriate.
2719 ;; `org-export-with-buffer-copy' macro prepares that copy.
2720 ;;
2721 ;; File inclusion is taken care of by
2722 ;; `org-export-expand-include-keyword' and
2723 ;; `org-export--prepare-file-contents'. Structure wise, including
2724 ;; a whole Org file in a buffer often makes little sense. For
2725 ;; example, if the file contains a headline and the include keyword
2726 ;; was within an item, the item should contain the headline. That's
2727 ;; why file inclusion should be done before any structure can be
2728 ;; associated to the file, that is before parsing.
2731 "Return a copy of the current buffer.
2732 The copy preserves Org buffer-local variables, visibility and
2733 narrowing."
2739 new-buf))
2742 "Apply BODY in a copy of the current buffer.
2743 The copy preserves local variables, visibility and contents of
2744 the original buffer. Point is at the beginning of the buffer
2745 when BODY is applied."
2754 ;; Kill copy without confirmation.
2760 "Generate a function duplicating BUFFER.
2762 The copy will preserve local variables, visibility, contents and
2763 narrowing of the original buffer. If a region was active in
2764 BUFFER, contents will be narrowed to that region instead.
2766 The resulting function can be evaled at a later time, from
2767 another buffer, effectively cloning the original buffer there.
2769 The function assumes BUFFER's major mode is `org-mode'."
2773 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2774 ;; already in BUFFER.
2776 ;; Buffer local variables.
2786 buffer-file-name
2787 buffer-file-coding-system))
2790 ;; Skip unreadable values, as they cannot be
2791 ;; sent to external process.
2795 local-vars)))))
2797 local-vars)
2798 ;; Whole buffer contents.
2803 ;; Narrowing.
2807 ;; Current position of point.
2809 ;; Overlays with invisible property.
2819 ov-set))))
2821 ov-set)))))
2823 ;;;###autoload
2826 "Transcode current Org buffer into BACKEND code.
2828 If narrowing is active in the current buffer, only transcode its
2829 narrowed part.
2831 If a region is active, transcode that region.
2833 When optional argument SUBTREEP is non-nil, transcode the
2834 sub-tree at point, extracting information from the headline
2835 properties first.
2837 When optional argument VISIBLE-ONLY is non-nil, don't export
2838 contents of hidden elements.
2840 When optional argument BODY-ONLY is non-nil, only return body
2841 code, without surrounding template.
2843 Optional argument EXT-PLIST, when provided, is a property list
2844 with external parameters overriding Org default settings, but
2845 still inferior to file-local settings.
2847 Return code as a string."
2851 ;; Narrow buffer to an appropriate region or subtree for
2852 ;; parsing. If parsing subtree, be sure to remove main headline
2853 ;; too.
2861 ;; Initialize communication channel with original buffer
2862 ;; attributes, unavailable in its copy.
2870 tree)
2871 ;; Update communication channel and get parse tree. Buffer
2872 ;; isn't parsed directly. Instead, a temporary copy is
2873 ;; created, where include keywords, macros are expanded and
2874 ;; code blocks are evaluated.
2876 ;; Run first hook with current back-end as argument.
2879 ;; Update macro templates since #+INCLUDE keywords might have
2880 ;; added some new ones.
2884 ;; Update radio targets since keyword inclusion might have
2885 ;; added some more.
2887 ;; Run last hook with current back-end as argument.
2890 ;; Update communication channel with environment. Also
2891 ;; install user's and developer's filters.
2896 ;; Expand export-specific set of macros: {{{author}}},
2897 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2898 ;; once regular macros have been expanded, since document
2899 ;; keywords may contain one of them.
2905 ;; EMAIL is not a parsed keyword: store it as-is.
2909 ;; Call options filters and update export options. We do not
2910 ;; use `org-export-filter-apply-functions' here since the
2911 ;; arity of such filters is different.
2915 ;; Parse buffer and call parse-tree filter on it.
2920 ;; Now tree is complete, compute its properties and add them
2921 ;; to communication channel.
2925 ;; Eventually transcode TREE. Wrap the resulting string into
2926 ;; a template.
2935 ;; Remove all text properties since they cannot be
2936 ;; retrieved from an external process. Finally call
2937 ;; final-output filter and return result.
2943 info))))))))
2945 ;;;###autoload
2948 "Call `org-export-as' with output to a specified buffer.
2950 BACKEND is the back-end used for transcoding, as a symbol.
2952 BUFFER is the output buffer. If it already exists, it will be
2953 erased first, otherwise, it will be created.
2955 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2956 EXT-PLIST are similar to those used in `org-export-as', which
2957 see.
2959 If `org-export-copy-to-kill-ring' is non-nil, add buffer contents
2960 to kill ring. Return buffer."
2967 ;; Maybe add buffer contents to kill ring.
2970 ;; Return buffer.
2971 buffer))
2973 ;;;###autoload
2976 "Call `org-export-as' with output to a specified file.
2978 BACKEND is the back-end used for transcoding, as a symbol. FILE
2979 is the name of the output file, as a string.
2981 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2982 EXT-PLIST are similar to those used in `org-export-as', which
2983 see.
2985 If `org-export-copy-to-kill-ring' is non-nil, add file contents
2986 to kill ring. Return output file's name."
2987 ;; Checks for FILE permissions. `write-file' would do the same, but
2988 ;; we'd rather avoid needless transcoding of parse tree.
2990 ;; Insert contents to a temporary buffer and write it to FILE.
2996 ;; Maybe add file contents to kill ring.
2999 ;; Return full path.
3000 file)
3002 ;;;###autoload
3004 "Transcode STRING into BACKEND code.
3006 When optional argument BODY-ONLY is non-nil, only return body
3007 code, without preamble nor postamble.
3009 Optional argument EXT-PLIST, when provided, is a property list
3010 with external parameters overriding Org default settings, but
3011 still inferior to file-local settings.
3013 Return code as a string."
3020 "Return output file's name according to buffer specifications.
3022 EXTENSION is a string representing the output file extension,
3023 with the leading dot.
3025 With a non-nil optional argument SUBTREEP, try to determine
3027 of subtree at point.
3029 When optional argument PUB-DIR is set, use it as the publishing
3030 directory.
3032 When optional argument VISIBLE-ONLY is non-nil, don't export
3033 contents of hidden elements.
3035 Return file name as a string."
3038 ;; File name may come from EXPORT_FILE_NAME subtree
3039 ;; property, assuming point is at beginning of said
3040 ;; sub-tree.
3047 ;; File name may be extracted from buffer's associated
3048 ;; file, if any.
3050 ;; Can't determine file name on our own: Ask user.
3054 "Output file: " pub-dir nil nil nil
3058 ;; Build file name. Enforce EXTENSION over whatever user
3059 ;; may have come up with. PUB-DIR, if defined, always has
3060 ;; precedence over any provided path.
3065 extension))
3068 ;; If writing to OUTPUT-FILE would overwrite original file, append
3069 ;; EXTENSION another time to final name.
3072 output-file)))
3075 "Expand every include keyword in buffer.
3076 Optional argument INCLUDED is a list of included file names along
3077 with their line restriction, when appropriate. It is used to
3078 avoid infinite recursion. Optional argument DIR is the current
3079 working directory. It is used to properly resolve relative
3080 paths."
3087 ;; Extract arguments from keyword's value.
3101 ;; Minimal level of included file defaults to the child
3102 ;; level of the current headline, if any, or one. It
3103 ;; only applies is the file is meant to be included as
3104 ;; an Org one.
3112 ;; Remove keyword.
3117 ;; Check if files has already been parsed. Look after
3118 ;; inclusion lines too, as different parts of the same file
3119 ;; can be included too.
3131 ind-str contents ind-str))))
3139 ind-str env contents ind-str))))
3152 "Prepare the contents of FILE for inclusion and return them as a string.
3154 When optional argument LINES is a string specifying a range of
3155 lines, include only those lines.
3157 Optional argument IND, when non-nil, is an integer specifying the
3158 global indentation of returned contents. Since its purpose is to
3159 allow an included file to stay in the same environment it was
3160 created \(i.e. a list item), it doesn't apply past the first
3161 headline encountered.
3163 Optional argument MINLEVEL, when non-nil, is an integer
3164 specifying the level that any top-level headline in the included
3165 file should have."
3181 ;; Remove blank lines at beginning and end of contents. The logic
3182 ;; behind that removal is that blank lines around include keyword
3183 ;; override blank lines in included file.
3192 ;; If IND is set, preserve indentation of include keyword until
3193 ;; the first headline encountered.
3199 ;; Do not move footnote definitions out of column 0.
3205 ;; When MINLEVEL is specified, compute minimal level for headlines
3206 ;; in the file (CUR-MIN), and remove stars to each headline so
3207 ;; that headlines with minimal level have a level of MINLEVEL.
3217 ;; Only change stars, don't bother moving whole
3218 ;; sections.
3225 "Execute every Babel code in the visible part of current buffer."
3226 ;; Get a pristine copy of current buffer so Babel references can be
3227 ;; properly resolved.
3234 \f
3235 ;;; Tools For Back-Ends
3236 ;;
3237 ;; A whole set of tools is available to help build new exporters. Any
3238 ;; function general enough to have its use across many back-ends
3239 ;; should be added here.
3241 ;;;; For Affiliated Keywords
3242 ;;
3243 ;; `org-export-read-attribute' reads a property from a given element
3244 ;; as a plist. It can be used to normalize affiliated keywords'
3245 ;; syntax.
3246 ;;
3247 ;; Since captions can span over multiple lines and accept dual values,
3248 ;; their internal representation is a bit tricky. Therefore,
3249 ;; `org-export-get-caption' transparently returns a given element's
3250 ;; caption as a secondary string.
3253 "Turn ATTRIBUTE property from ELEMENT into a plist.
3255 When optional argument PROPERTY is non-nil, return the value of
3256 that property within attributes.
3260 properties. All values will become strings except the empty
3268 s)
3273 ;; Ignore any string before the first property with `cdr'.
3276 s)
3277 result))))))))
3281 "Return caption from ELEMENT as a secondary string.
3283 When optional argument SHORTP is non-nil, return short caption,
3284 as a secondary string, instead.
3286 Caption lines are separated by a white space."
3294 ;;;; For Derived Back-ends
3295 ;;
3296 ;; `org-export-with-backend' is a function allowing to locally use
3297 ;; another back-end to transcode some object or element. In a derived
3298 ;; back-end, it may be used as a fall-back function once all specific
3299 ;; cases have been treated.
3302 "Call a transcoder from BACK-END on DATA.
3303 CONTENTS, when non-nil, is the transcoded contents of DATA
3304 element, as a string. INFO, when non-nil, is the communication
3305 channel used for export, as a plist.."
3315 ;;;; For Export Snippets
3316 ;;
3317 ;; Every export snippet is transmitted to the back-end. Though, the
3318 ;; latter will only retain one type of export-snippet, ignoring
3319 ;; others, based on the former's target back-end. The function
3320 ;; `org-export-snippet-backend' returns that back-end for a given
3321 ;; export-snippet.
3324 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3325 Translation, with `org-export-snippet-translation-alist', is
3326 applied."
3330 back-end))))
3333 ;;;; For Footnotes
3334 ;;
3335 ;; `org-export-collect-footnote-definitions' is a tool to list
3336 ;; actually used footnotes definitions in the whole parse tree, or in
3337 ;; a headline, in order to add footnote listings throughout the
3338 ;; transcoded data.
3339 ;;
3340 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3341 ;; back-ends, when they need to attach the footnote definition only to
3342 ;; the first occurrence of the corresponding label.
3343 ;;
3344 ;; `org-export-get-footnote-definition' and
3345 ;; `org-export-get-footnote-number' provide easier access to
3346 ;; additional information relative to a footnote reference.
3349 "Return an alist between footnote numbers, labels and definitions.
3351 DATA is the parse tree from which definitions are collected.
3352 INFO is the plist used as a communication channel.
3354 Definitions are sorted by order of references. They either
3355 appear as Org data or as a secondary string for inlined
3356 footnotes. Unreferenced definitions are ignored."
3358 collect-fn ; for byte-compiler.
3362 ;; Collect footnote number, label and definition in DATA.
3370 def)
3371 num-alist)
3372 ;; Also search in definition for nested footnotes.
3375 ;; Don't enter footnote definitions since it will happen
3376 ;; when their first reference is found.
3382 "Non-nil when a footnote reference is the first one for its label.
3384 FOOTNOTE-REFERENCE is the footnote reference being considered.
3385 INFO is the plist used as a communication channel."
3387 ;; Anonymous footnotes are always a first reference.
3389 ;; Otherwise, return the first footnote with the same LABEL and
3390 ;; test if it is equal to FOOTNOTE-REFERENCE.
3400 ;; If FN isn't inlined, be sure to traverse its
3401 ;; definition before resuming search. See
3402 ;; comments in `org-export-get-footnote-number'
3403 ;; for more information.
3407 ;; Don't enter footnote definitions since it will
3408 ;; happen when their first reference is found.
3411 footnote-reference)))))
3414 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3415 INFO is the plist used as a communication channel. If no such
3417 string."
3424 "Return number associated to a footnote.
3426 FOOTNOTE is either a footnote reference or a footnote definition.
3427 INFO is the plist used as a communication channel."
3429 seen-refs
3430 search-ref ; For byte-compiler.
3434 ;; Search footnote references through DATA, filling
3435 ;; SEEN-REFS along the way.
3440 ;; Anonymous footnote match: return number.
3443 ;; Labels match: return number.
3446 ;; Anonymous footnote: it's always a new one.
3447 ;; Also, be sure to return nil from the `cond' so
3448 ;; `first-match' doesn't get us out of the loop.
3450 ;; Label not seen so far: add it so SEEN-REFS.
3451 ;;
3452 ;; Also search for subsequent references in
3453 ;; footnote definition so numbering follows
3454 ;; reading logic. Note that we don't have to care
3455 ;; about inline definitions, since
3456 ;; `org-element-map' already traverses them at the
3457 ;; right time.
3458 ;;
3459 ;; Once again, return nil to stay in the loop.
3464 nil))))
3465 ;; Don't enter footnote definitions since it will
3466 ;; happen when their first reference is found.
3471 ;;;; For Headlines
3472 ;;
3473 ;; `org-export-get-relative-level' is a shortcut to get headline
3474 ;; level, relatively to the lower headline level in the parsed tree.
3475 ;;
3476 ;; `org-export-get-headline-number' returns the section number of an
3477 ;; headline, while `org-export-number-to-roman' allows to convert it
3478 ;; to roman numbers.
3479 ;;
3480 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3481 ;; `org-export-last-sibling-p' are three useful predicates when it
3482 ;; comes to fulfill the `:headline-levels' property.
3483 ;;
3484 ;; `org-export-get-tags', `org-export-get-category' and
3485 ;; `org-export-get-node-property' extract useful information from an
3486 ;; headline or a parent headline. They all handle inheritance.
3487 ;;
3488 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3489 ;; as a secondary string, suitable for table of contents. It falls
3490 ;; back onto default title.
3493 "Return HEADLINE relative level within current parsed tree.
3494 INFO is a plist holding contextual information."
3499 "Non-nil when HEADLINE is considered as low level.
3501 INFO is a plist used as a communication channel.
3503 A low level headlines has a relative level greater than
3504 `:headline-levels' property value.
3506 Return value is the difference between HEADLINE relative level
3507 and the last level being considered as high enough, or nil."
3514 "Return HEADLINE numbering as a list of numbers.
3515 INFO is a plist holding contextual information."
3519 "Return a non-nil value if HEADLINE element should be numbered.
3520 INFO is a plist used as a communication channel."
3526 "Convert integer N into a roman numeral."
3539 res)))
3542 "Return list of tags associated to ELEMENT.
3544 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3545 is a plist used as a communication channel.
3547 Select tags (see `org-export-select-tags') and exclude tags (see
3548 `org-export-exclude-tags') are removed from the list.
3550 When non-nil, optional argument TAGS should be a list of strings.
3551 Any tag belonging to this list will also be removed.
3553 When optional argument INHERITED is non-nil, tags can also be
3554 inherited from parent headlines and FILETAGS keywords."
3560 ;; Build complete list of inherited tags.
3571 ;; Add FILETAGS keywords and return results.
3575 "Return node PROPERTY value for BLOB.
3577 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3578 element or object.
3580 If optional argument INHERITED is non-nil, the value can be
3581 inherited from a parent headline.
3583 Return value is a string or nil."
3595 "Return category for element or object BLOB.
3597 INFO is a plist used as a communication channel.
3599 CATEGORY is automatically inherited from a parent headline, from
3600 #+CATEGORY: keyword or created out of original file name. If all
3604 ;; Almost like `org-export-node-property', but we cannot trust
3605 ;; `plist-member' as every headline has a `:CATEGORY'
3606 ;; property, would it be nil or equal to "???" (which has the
3607 ;; same meaning).
3625 "Return alternative title for HEADLINE, as a secondary string.
3626 INFO is a plist used as a communication channel. If no optional
3627 title is defined, fall-back to the regular title."
3632 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3633 INFO is a plist used as a communication channel."
3638 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3639 INFO is a plist used as a communication channel."
3643 ;;;; For Links
3644 ;;
3645 ;; `org-export-solidify-link-text' turns a string into a safer version
3646 ;; for links, replacing most non-standard characters with hyphens.
3647 ;;
3648 ;; `org-export-get-coderef-format' returns an appropriate format
3649 ;; string for coderefs.
3650 ;;
3651 ;; `org-export-inline-image-p' returns a non-nil value when the link
3652 ;; provided should be considered as an inline image.
3653 ;;
3654 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3655 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3656 ;; returns an appropriate unique identifier when found, or nil.
3657 ;;
3658 ;; `org-export-resolve-id-link' returns the first headline with
3659 ;; specified id or custom-id in parse tree, the path to the external
3660 ;; file with the id or nil when neither was found.
3661 ;;
3662 ;; `org-export-resolve-coderef' associates a reference to a line
3663 ;; number in the element it belongs, or returns the reference itself
3664 ;; when the element isn't numbered.
3667 "Take link text S and make a safe target out of it."
3672 "Return format string for code reference link.
3673 PATH is the link path. DESC is its description."
3681 "Non-nil if LINK object points to an inline image.
3683 Optional argument is a set of RULES defining inline images. It
3684 is an alist where associations have the following shape:
3686 \(TYPE . REGEXP)
3688 Applying a rule means apply REGEXP against LINK's path when its
3689 type is TYPE. The function will return a non-nil value if any of
3690 the provided rules is non-nil. The default rule is
3691 `org-export-default-inline-image-rule'.
3693 This only applies to links without a description."
3704 rules)
3705 ;; Return nil if no rule matched.
3706 nil))))
3709 "Resolve a code reference REF.
3711 INFO is a plist used as a communication channel.
3713 Return associated line number in source code, or REF itself,
3714 depending on src-block or example element's switches."
3721 org-coderef-label-format)))
3725 ;; Element containing REF is found. Resolve it to either
3726 ;; a label or a line number, as needed.
3736 "Return LINK destination.
3738 INFO is a plist holding contextual information.
3740 Return value can be an object, an element, or nil:
3742 - If LINK path matches a target object (i.e. <<path>>) or
3745 - If LINK path exactly matches the name affiliated keyword
3746 \(i.e. #+NAME: path) of an element, return that element.
3748 - If LINK path exactly matches any headline name, return that
3749 element. If more than one headline share that name, priority
3750 will be given to the one with the closest common ancestor, if
3751 any, or the first one in the parse tree otherwise.
3753 - Otherwise, return nil.
3756 significant."
3759 ;; Split PATH at white spaces so matches are space
3760 ;; insensitive.
3764 ;; First try to find a matching "<<path>>" unless user specified
3765 ;; he was looking for a headline (path starts with a *
3766 ;; character).
3773 path)
3774 blob))
3775 info t)))
3776 ;; Then try to find an element with a matching "#+NAME: path"
3777 ;; affiliated keyword.
3780 org-element-all-elements
3785 ;; Last case: link either points to a headline or to
3786 ;; nothingness. Try to find the source, with priority given to
3787 ;; headlines with the closest common ancestor. If such candidate
3788 ;; is found, return it, otherwise return nil.
3792 ;; Return first headline whose `:raw-value' property is
3793 ;; NAME in parse tree DATA, or nil. Statistics cookies
3794 ;; are ignored.
3802 name)
3803 headline))
3805 ;; Search among headlines sharing an ancestor with link, from
3806 ;; closest to farthest.
3814 ;; No match with a common ancestor: try full parse-tree.
3818 "Return headline referenced as LINK destination.
3820 INFO is a plist used as a communication channel.
3822 Return value can be the headline element matched in current parse
3826 ;; First check if id is within the current parse tree.
3831 headline))
3833 ;; Otherwise, look for external files.
3837 "Return radio-target object referenced as LINK destination.
3839 INFO is a plist used as a communication channel.
3841 Return value can be a radio-target object or nil. Assume LINK
3848 radio))
3852 ;;;; For References
3853 ;;
3854 ;; `org-export-get-ordinal' associates a sequence number to any object
3855 ;; or element.
3858 "Return ordinal number of an element or object.
3860 ELEMENT is the element or object considered. INFO is the plist
3861 used as a communication channel.
3863 Optional argument TYPES, when non-nil, is a list of element or
3864 object types, as symbols, that should also be counted in.
3865 Otherwise, only provided element's type is considered.
3867 Optional argument PREDICATE is a function returning a non-nil
3868 value if the current element or object should be counted in. It
3869 accepts two arguments: the element or object being considered and
3870 the plist used as a communication channel. This allows to count
3871 only a certain type of objects (i.e. inline images).
3873 Return value is a list of numbers if ELEMENT is a headline or an
3874 item. It is nil for keywords. It represents the footnote number
3875 for footnote definitions and footnote references. If ELEMENT is
3876 a target, return the same value as if ELEMENT was the closest
3877 table, item or headline containing the target. In any other
3878 case, return the sequence number of ELEMENT among elements or
3879 objects of the same type."
3880 ;; A target keyword, representing an invisible target, never has
3881 ;; a sequence number.
3883 ;; Ordinal of a target object refer to the ordinal of the closest
3884 ;; table, item, or headline containing the object.
3888 when
3892 table))
3893 return parent)))
3895 ;; Special case 1: A headline returns its number as a list.
3897 ;; Special case 2: An item returns its number as a list.
3901 struct
3908 ;; Increment counter until ELEMENT is found again.
3919 ;;;; For Src-Blocks
3920 ;;
3921 ;; `org-export-get-loc' counts number of code lines accumulated in
3922 ;; src-block or example-block elements with a "+n" switch until
3923 ;; a given element, excluded. Note: "-n" switches reset that count.
3924 ;;
3925 ;; `org-export-unravel-code' extracts source code (along with a code
3926 ;; references alist) from an `element-block' or `src-block' type
3927 ;; element.
3928 ;;
3929 ;; `org-export-format-code' applies a formatting function to each line
3930 ;; of code, providing relative line number and code reference when
3931 ;; appropriate. Since it doesn't access the original element from
3932 ;; which the source code is coming, it expects from the code calling
3933 ;; it to know if lines should be numbered and if code references
3934 ;; should appear.
3935 ;;
3936 ;; Eventually, `org-export-format-code-default' is a higher-level
3937 ;; function (it makes use of the two previous functions) which handles
3938 ;; line numbering and code references inclusion, and returns source
3939 ;; code in a format suitable for plain text or verbatim output.
3942 "Return accumulated lines of code up to ELEMENT.
3944 INFO is the plist used as a communication channel.
3946 ELEMENT is excluded from count."
3952 ;; ELEMENT is reached: Quit the loop.
3954 ;; Only count lines from src-block and example-block elements
3955 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3959 ;; Accumulate locs or reset them.
3963 ;; Return nil to stay in the loop.
3964 nil)))
3966 ;; Return value.
3967 loc))
3970 "Clean source code and extract references out of it.
3972 ELEMENT has either a `src-block' an `example-block' type.
3974 Return a cons cell whose CAR is the source code, cleaned from any
3975 reference and protective comma and CDR is an alist between
3976 relative line number (integer) and name of code reference on that
3977 line (string)."
3979 ;; Get code and clean it. Remove blank lines at its
3980 ;; beginning and end.
3986 ;; If appropriate, remove global indentation.
3989 c
3991 ;; Get format used for references.
3994 org-coderef-label-format)))
3995 ;; Build a regexp matching a loc with a reference.
4000 ;; Return value.
4002 ;; Code with references removed.
4008 ;; Ref line: remove ref, and signal its position in REFS.
4012 ;; Reference alist.
4013 refs)))
4016 "Format CODE by applying FUN line-wise and return it.
4018 CODE is a string representing the code to format. FUN is
4019 a function. It must accept three arguments: a line of
4020 code (string), the current line number (integer) or nil and the
4021 reference associated to the current line (string) or nil.
4023 Optional argument NUM-LINES can be an integer representing the
4024 number of code lines accumulated until the current code. Line
4025 numbers passed to FUN will take it into account. If it is nil,
4026 FUN's second argument will always be nil. This number can be
4027 obtained with `org-export-get-loc' function.
4029 Optional argument REF-ALIST can be an alist between relative line
4030 number (i.e. ignoring NUM-LINES) and the name of the code
4031 reference on it. If it is nil, FUN's third argument will always
4032 be nil. It can be obtained through the use of
4033 `org-export-unravel-code' function."
4045 "Return source code from ELEMENT, formatted in a standard way.
4047 ELEMENT is either a `src-block' or `example-block' element. INFO
4048 is a plist used as a communication channel.
4050 This function takes care of line numbering and code references
4051 inclusion. Line numbers, when applicable, appear at the
4052 beginning of the line, separated from the code by two white
4053 spaces. Code references, on the other hand, appear flushed to
4054 the right, separated by six white spaces from the widest line of
4055 code."
4056 ;; Extract code and references.
4063 ;; Handle line numbering.
4072 ;; Prepare references display, if required. Any reference
4073 ;; should start six columns after the widest line of code,
4074 ;; wrapped with parenthesis.
4079 code
4083 number-str
4084 loc
4090 num-start refs)))))
4093 ;;;; For Tables
4094 ;;
4095 ;; `org-export-table-has-special-column-p' and and
4096 ;; `org-export-table-row-is-special-p' are predicates used to look for
4097 ;; meta-information about the table structure.
4098 ;;
4099 ;; `org-table-has-header-p' tells when the rows before the first rule
4100 ;; should be considered as table's header.
4101 ;;
4102 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4103 ;; and `org-export-table-cell-borders' extract information from
4104 ;; a table-cell element.
4105 ;;
4106 ;; `org-export-table-dimensions' gives the number on rows and columns
4107 ;; in the table, ignoring horizontal rules and special columns.
4108 ;; `org-export-table-cell-address', given a table-cell object, returns
4109 ;; the absolute address of a cell. On the other hand,
4110 ;; `org-export-get-table-cell-at' does the contrary.
4111 ;;
4112 ;; `org-export-table-cell-starts-colgroup-p',
4113 ;; `org-export-table-cell-ends-colgroup-p',
4114 ;; `org-export-table-row-starts-rowgroup-p',
4115 ;; `org-export-table-row-ends-rowgroup-p',
4116 ;; `org-export-table-row-starts-header-p' and
4117 ;; `org-export-table-row-ends-header-p' indicate position of current
4118 ;; row or cell within the table.
4121 "Non-nil when TABLE has a special column.
4122 All special columns will be ignored during export."
4123 ;; The table has a special column when every first cell of every row
4124 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4125 ;; "*" "_" and "^". Though, do not consider a first row containing
4126 ;; only empty cells as special.
4142 "Non-nil when TABLE has an header.
4144 INFO is a plist used as a communication channel.
4146 A table has an header when it contains at least two row groups."
4156 info)))
4159 "Non-nil if TABLE-ROW is considered special.
4161 INFO is a plist used as the communication channel.
4163 All special rows will be ignored during export."
4167 ;; A row is special either when...
4169 ;; ... it starts with a field only containing "/",
4171 ;; ... the table contains a special column and the row start
4172 ;; with a marking character among, "^", "_", "$" or "!",
4176 ;; ... it contains only alignment cookies and empty cells.
4182 ;; Since VALUE is a secondary string, the following
4183 ;; checks avoid expanding it with `org-export-data'.
4195 "Return TABLE-ROW's group.
4197 INFO is a plist used as the communication channel.
4199 Return value is the group number, as an integer, or nil special
4200 rows and table rules. Group 1 is also table's header."
4217 "Return TABLE-CELL contents width.
4219 INFO is a plist used as the communication channel.
4221 Return value is the width given by the last width cookie in the
4222 same column as TABLE-CELL, or nil."
4227 cookie-width)
4231 ;; In a special row, try to find a width cookie at COLUMN.
4235 ;; The following checks avoid expanding unnecessarily the
4236 ;; cell with `org-export-data'
4244 ;; Ignore table rules.
4247 ;; Return value.
4248 cookie-width))
4251 "Return TABLE-CELL contents alignment.
4253 INFO is a plist used as the communication channel.
4255 Return alignment as specified by the last alignment cookie in the
4256 same column as TABLE-CELL. If no such cookie is found, a default
4257 alignment value will be deduced from fraction of numbers in the
4258 column (see `org-table-number-fraction' for more information).
4259 Possible values are `left', `right' and `center'."
4266 cookie-align)
4270 ;; In a special row, try to find an alignment cookie at
4271 ;; COLUMN.
4275 ;; Since VALUE is a secondary string, the following checks
4276 ;; avoid useless expansion through `org-export-data'.
4284 ;; Ignore table rules.
4286 ;; In a standard row, check if cell's contents are expressing
4287 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4288 ;; Though, don't bother if an alignment cookie has already
4289 ;; defined cell's alignment.
4294 info)))
4299 ;; Return value. Alignment specified by cookies has precedence
4300 ;; over alignment deduced from cells contents.
4309 "Return TABLE-CELL borders.
4311 INFO is a plist used as a communication channel.
4313 Return value is a list of symbols, or nil. Possible values are:
4314 `top', `bottom', `above', `below', `left' and `right'. Note:
4315 `top' (resp. `bottom') only happen for a cell in the first
4316 row (resp. last row) of the table, ignoring table rules, if any.
4318 Returned borders ignore special rows."
4321 borders)
4322 ;; Top/above border? TABLE-CELL has a border above when a rule
4323 ;; used to demarcate row groups can be found above. Hence,
4324 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4325 ;; another regular row has to be found above that rule.
4334 ;; Look at every row before the current one.
4336 ;; No rule above, or rule found starts the table (ignoring any
4337 ;; special row): TABLE-CELL is at the top of the table.
4340 ;; Bottom/below border? TABLE-CELL has a border below when next
4341 ;; non-regular row below is a rule.
4350 ;; Look at every row after the current one.
4352 ;; No rule below, or rule found ends the table (modulo some
4353 ;; special row): TABLE-CELL is at the bottom of the table.
4356 ;; Right/left borders? They can only be specified by column
4357 ;; groups. Column groups are defined in a row starting with "/".
4358 ;; Also a column groups row only contains "<", "<>", ">" or blank
4359 ;; cells.
4376 ;; There's a left border when previous cell, if
4377 ;; any, ends a group, or current one starts one.
4383 ;; There's a right border when next cell, if any,
4384 ;; starts a group, or current one ends one.
4391 ;; Table rows are read in reverse order so last column groups
4392 ;; row has precedence over any previous one.
4394 ;; Return value.
4395 borders))
4398 "Non-nil when TABLE-CELL is at the beginning of a row group.
4399 INFO is a plist used as a communication channel."
4400 ;; A cell starts a column group either when it is at the beginning
4401 ;; of a row (or after the special column, if any) or when it has
4402 ;; a left border.
4405 table-cell)
4409 "Non-nil when TABLE-CELL is at the end of a row group.
4410 INFO is a plist used as a communication channel."
4411 ;; A cell ends a column group either when it is at the end of a row
4412 ;; or when it has a right border.
4415 table-cell)
4419 "Non-nil when TABLE-ROW is at the beginning of a column group.
4420 INFO is a plist used as a communication channel."
4428 "Non-nil when TABLE-ROW is at the end of a column group.
4429 INFO is a plist used as a communication channel."
4437 "Non-nil when TABLE-ROW is the first table header's row.
4438 INFO is a plist used as a communication channel."
4445 "Non-nil when TABLE-ROW is the last table header's row.
4446 INFO is a plist used as a communication channel."
4453 "Return TABLE dimensions.
4455 INFO is a plist used as a communication channel.
4457 Return value is a CONS like (ROWS . COLUMNS) where
4458 ROWS (resp. COLUMNS) is the number of exportable
4459 rows (resp. columns)."
4461 ;; Set number of rows, and extract first one.
4467 ;; Set number of columns.
4469 ;; Return value.
4473 "Return address of a regular TABLE-CELL object.
4475 TABLE-CELL is the cell considered. INFO is a plist used as
4476 a communication channel.
4478 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4479 zero-based index. Only exportable cells are considered. The
4480 function returns nil for other cells."
4483 ;; Ignore cells in special rows or in special column.
4488 ;; Row number.
4496 ;; Column number.
4504 "Return regular table-cell object at ADDRESS in TABLE.
4506 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4507 zero-based index. TABLE is a table type element. INFO is
4508 a plist used as a communication channel.
4510 If no table-cell, among exportable cells, is found at ADDRESS,
4511 return nil."
4514 ;; Row at (car address) or nil.
4522 'table-cell
4529 ;;;; For Tables Of Contents
4530 ;;
4531 ;; `org-export-collect-headlines' builds a list of all exportable
4532 ;; headline elements, maybe limited to a certain depth. One can then
4533 ;; easily parse it and transcode it.
4534 ;;
4535 ;; Building lists of tables, figures or listings is quite similar.
4536 ;; Once the generic function `org-export-collect-elements' is defined,
4537 ;; `org-export-collect-tables', `org-export-collect-figures' and
4538 ;; `org-export-collect-listings' can be derived from it.
4541 "Collect headlines in order to build a table of contents.
4543 INFO is a plist used as a communication channel.
4545 When optional argument N is an integer, it specifies the depth of
4546 the table of contents. Otherwise, it is set to the value of the
4547 last headline level. See `org-export-headline-levels' for more
4548 information.
4550 Return a list of all exportable headlines as parsed elements.
4551 Footnote sections, if any, will be ignored."
4556 ;; Strip contents from HEADLINE.
4559 info))
4562 "Collect referenceable elements of a determined type.
4564 TYPE can be a symbol or a list of symbols specifying element
4565 types to search. Only elements with a caption are collected.
4567 INFO is a plist used as a communication channel.
4569 When non-nil, optional argument PREDICATE is a function accepting
4570 one argument, an element of type TYPE. It returns a non-nil
4571 value when that element should be collected.
4573 Return a list of all elements found, in order of appearance."
4578 element))
4579 info))
4582 "Build a list of tables.
4583 INFO is a plist used as a communication channel.
4585 Return a list of table elements with a caption."
4589 "Build a list of figures.
4591 INFO is a plist used as a communication channel. PREDICATE is
4592 a function which accepts one argument: a paragraph element and
4593 whose return value is non-nil when that element should be
4594 collected.
4596 A figure is a paragraph type element, with a caption, verifying
4598 a vague concept that may depend on back-end.
4600 Return a list of elements recognized as figures."
4604 "Build a list of src blocks.
4606 INFO is a plist used as a communication channel.
4608 Return a list of src-block elements with a caption."
4612 ;;;; Smart Quotes
4613 ;;
4614 ;; The main function for the smart quotes sub-system is
4615 ;; `org-export-activate-smart-quotes', which replaces every quote in
4616 ;; a given string from the parse tree with its "smart" counterpart.
4617 ;;
4618 ;; Dictionary for smart quotes is stored in
4619 ;; `org-export-smart-quotes-alist'.
4620 ;;
4621 ;; Internally, regexps matching potential smart quotes (checks at
4622 ;; string boundaries are also necessary) are defined in
4623 ;; `org-export-smart-quotes-regexps'.
4660 "Smart quotes translations.
4662 Alist whose CAR is a language string and CDR is an alist with
4663 quote type as key and a plist associating various encodings to
4664 their translation as value.
4666 A quote type can be any symbol among `opening-double-quote',
4667 `closing-double-quote', `opening-single-quote',
4668 `closing-single-quote' and `apostrophe'.
4670 Valid encodings include `:utf-8', `:html', `:latex' and
4671 `:texinfo'.
4677 ;; Possible opening quote at beginning of string.
4679 ;; Possible closing quote at beginning of string.
4681 ;; Possible apostrophe at beginning of string.
4683 ;; Opening single and double quotes.
4685 ;; Closing single and double quotes.
4687 ;; Apostrophe.
4689 ;; Possible opening quote at end of string.
4691 ;; Possible closing quote at end of string.
4693 ;; Possible apostrophe at end of string.
4695 "List of regexps matching a quote or an apostrophe.
4701 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4702 `:utf-8'. INFO is a plist used as a communication channel.
4704 The function has to retrieve information about string
4705 surroundings in parse tree. It can only happen with an
4706 unmodified string. Thus, if S has already been through another
4707 process, a non-nil ORIGINAL optional argument will provide that
4708 original string.
4710 Return the new string."
4713 ;; Try to be flexible when computing number of blanks
4714 ;; before object. The previous object may be a string
4715 ;; introduced by the back-end and not completely parsed.
4718 ;; A string with missing `:post-blank'
4719 ;; property.
4723 ;; Fallback value.
4728 ;; Return smart quote associated to a give quote Q, as
4729 ;; a string. TYPE is a symbol among `open', `close' and
4730 ;; `apostrophe'.
4740 org-export-smart-quotes-alist))))
4741 encoding)
4742 q)))))
4744 ;; Only a quote: no regexp can match. We have to check both
4745 ;; sides and decide what to do.
4753 ;; 1. Replace quote character at the beginning of S.
4755 ;; Apostrophe?
4761 ;; Closing quote?
4767 ;; Opening quote?
4773 ;; 2. Replace quotes in the middle of the string.
4775 ;; Opening quotes.
4781 ;; Closing quotes.
4787 ;; Apostrophes.
4792 ;; 3. Replace quote character at the end of S.
4794 ;; Apostrophe?
4799 ;; Closing quote?
4805 ;; Opening quote?
4810 ;; Return string with smart quotes.
4811 s))))
4813 ;;;; Topology
4814 ;;
4815 ;; Here are various functions to retrieve information about the
4816 ;; neighbourhood of a given element or object. Neighbours of interest
4817 ;; are direct parent (`org-export-get-parent'), parent headline
4818 ;; (`org-export-get-parent-headline'), first element containing an
4819 ;; object, (`org-export-get-parent-element'), parent table
4820 ;; (`org-export-get-parent-table'), previous element or object
4821 ;; (`org-export-get-previous-element') and next element or object
4822 ;; (`org-export-get-next-element').
4823 ;;
4824 ;; `org-export-get-genealogy' returns the full genealogy of a given
4825 ;; element or object, from closest parent to full parse tree.
4828 "Return BLOB parent or nil.
4829 BLOB is the element or object considered."
4833 "Return full genealogy relative to a given element or object.
4835 BLOB is the element or object being considered.
4837 Ancestors are returned from closest to farthest, the last one
4838 being the full parse tree."
4845 "Return BLOB parent headline or nil.
4846 BLOB is the element or object being considered."
4850 parent))
4853 "Return first element containing OBJECT or nil.
4854 OBJECT is the object to consider."
4858 parent))
4861 "Return OBJECT parent table or nil.
4862 OBJECT is either a `table-cell' or `table-element' type object."
4866 parent))
4869 "Return previous element or object.
4871 BLOB is an element or object. INFO is a plist used as
4872 a communication channel. Return previous exportable element or
4873 object, a string, or nil.
4875 When optional argument N is a positive integer, return a list
4876 containing up to N siblings before BLOB, from farthest to
4877 closest. With any other non-nil value, return a list containing
4878 all of them."
4880 ;; An object can belong to the contents of its parent or
4881 ;; to a secondary string. We check the latter option
4882 ;; first.
4885 org-element-all-elements))
4889 org-element-secondary-value-alist))
4890 parent)))
4893 prev)
4902 prev)))
4905 "Return next element or object.
4907 BLOB is an element or object. INFO is a plist used as
4908 a communication channel. Return next exportable element or
4909 object, a string, or nil.
4911 When optional argument N is a positive integer, return a list
4912 containing up to N siblings after BLOB, from closest to farthest.
4913 With any other non-nil value, return a list containing all of
4914 them."
4916 ;; An object can belong to the contents of its parent or to
4917 ;; a secondary string. We check the latter option first.
4920 org-element-all-objects))
4924 org-element-secondary-value-alist))
4925 parent)))
4928 next)
4936 siblings)
4940 ;;;; Translation
4941 ;;
4942 ;; `org-export-translate' translates a string according to language
4943 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4944 ;; variable and a specified charset. `org-export-dictionary' contains
4945 ;; the dictionary used for the translation.
5067 "Dictionary for export engine.
5069 Alist whose CAR is the string to translate and CDR is an alist
5070 whose CAR is the language string and CDR is a plist whose
5071 properties are possible charsets and values translated terms.
5073 It is used as a database for `org-export-translate'. Since this
5074 function returns the string as-is if no translation was found,
5075 the variable only needs to record values different from the
5079 "Translate string S according to language specification.
5081 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5082 and `:utf-8'. INFO is a plist used as a communication channel.
5084 Translation depends on `:language' property. Return the
5085 translated string. If no translation is found, try to fall back
5086 to `:default' encoding. If it fails, return S."
5092 s)))
5095 \f
5096 ;;; Asynchronous Export
5097 ;;
5098 ;; `org-export-async-start' is the entry point for asynchronous
5099 ;; export. It recreates current buffer (including visibility,
5100 ;; narrowing and visited file) in an external Emacs process, and
5101 ;; evaluates a command there. It then applies a function on the
5102 ;; returned results in the current process.
5103 ;;
5104 ;; Asynchronously generated results are never displayed directly.
5105 ;; Instead, they are stored in `org-export-stack-contents'. They can
5106 ;; then be retrieved by calling `org-export-stack'.
5107 ;;
5108 ;; Export Stack is viewed through a dedicated major mode
5109 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5110 ;;`org-export-stack-delete', `org-export-stack-view' and
5111 ;;`org-export-stack-clear'.
5112 ;;
5113 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5114 ;; It should used whenever `org-export-async-start' is called.
5117 "Call function FUN on the results returned by BODY evaluation.
5119 BODY evaluation happens in an asynchronous process, from a buffer
5120 which is an exact copy of the current one.
5122 Use `org-export-add-to-stack' in FUN in order to register results
5123 in the stack. Examples for, respectively a temporary buffer and
5124 a file are:
5126 \(org-export-async-start
5127 \(lambda (output)
5129 \(erase-buffer)
5130 \(insert output)
5131 \(goto-char (point-min))
5132 \(org-export-add-to-stack (current-buffer) 'backend)))
5133 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5135 and
5137 \(org-export-async-start
5138 \(lambda (f) (org-export-add-to-stack f 'backend))
5139 `(expand-file-name
5140 \(org-export-to-file
5141 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5144 ;; Write the full sexp evaluating BODY in a copy of the current
5145 ;; buffer to a temporary file, as it may be too long for program
5146 ;; args in `start-process'.
5153 "%S"
5156 ;; Ignore `kill-emacs-hook' and code evaluation
5157 ;; queries from Babel as we need a truly
5158 ;; non-interactive process.
5160 org-babel-confirm-evaluate-answer-no t)
5161 ;; Initialize export framework in external process.
5163 ;; Re-create current buffer there.
5166 ;; Sexp to evaluate in the buffer.
5168 ;; Start external process.
5171 (,process
5176 "-l" org-export-async-init-file
5178 ;; Register running process in stack.
5180 ;; Set-up sentinel in order to catch results.
5182 ,process
5206 "Add a new result to export stack if not present already.
5208 SOURCE is a buffer or a file name containing export results.
5209 BACKEND is a symbol representing export back-end used to generate
5210 it.
5212 Entries already pointing to SOURCE and unavailable entries are
5213 removed beforehand. Return the new stack."
5219 "Menu for asynchronous export results and running processes."
5229 "Return source from export results at point in stack."
5236 source
5237 ;; SOURCE is not consistent with current line. The stack
5238 ;; view is outdated.
5242 "Remove all entries from export stack."
5247 "Refresh the asynchronous export stack.
5248 DUMMY is ignored. Unavailable sources are removed from the list.
5249 Return the new stack."
5259 ;; Back-end.
5261 ;; Age.
5264 ;; Compute age of the results.
5266 "%4h:%.2m "
5268 ;; Source.
5273 ;; Clear stack from exited processes, dead buffers or
5274 ;; non-existent files.
5286 "Remove export results at point from stack.
5287 If optional argument SOURCE is non-nil, remove it instead."
5292 org-export-stack-contents))))
5295 "View export results at point in stack.
5296 With an optional prefix argument IN-EMACS, force viewing files
5297 within Emacs."
5311 (define-key km "p" 'previous-line)
5312 (define-key km "\C-p" 'previous-line)
5313 (define-key km "\C-?" 'previous-line)
5314 (define-key km [up] 'previous-line)
5315 (define-key km "C" 'org-export-stack-clear)
5316 (define-key km "v" 'org-export-stack-view)
5317 (define-key km (kbd "RET") 'org-export-stack-view)
5318 (define-key km "d" 'org-export-stack-remove)
5319 km)
5320 "Keymap for Org Export Stack.")
5322 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5323 "Mode for displaying asynchronous export stack.
5326 stack.
5328 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5329 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5330 stack completely.
5332 Removing entries in an Org Export Stack buffer doesn't affect
5333 files or buffers, only the display.
5336 (abbrev-mode 0)
5337 (auto-fill-mode 0)
5338 (setq buffer-read-only t
5339 buffer-undo-list t
5340 truncate-lines t
5341 header-line-format
5342 '(:eval
5343 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5344 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5345 (set (make-local-variable 'revert-buffer-function)
5346 'org-export-stack-refresh))
5349 \f
5350 ;;; The Dispatcher
5351 ;;
5352 ;; `org-export-dispatch' is the standard interactive way to start an
5353 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5354 ;; for its interface, which, in turn, delegates response to key
5355 ;; pressed to `org-export--dispatch-action'.
5357 ;;;###autoload
5358 (defun org-export-dispatch (&optional arg)
5359 "Export dispatcher for Org mode.
5361 It provides an access to common export related tasks in a buffer.
5362 Its interface comes in two flavours: standard and expert.
5364 While both share the same set of bindings, only the former
5365 displays the valid keys associations in a dedicated buffer.
5366 Scrolling (resp. line-wise motion) in this buffer is done with
5367 SPC and DEL (resp. C-n and C-p) keys.
5369 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5370 flavour or the other.
5373 of options used back then, on the current buffer.
5375 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5376 (interactive "P")
5377 (let* ((input
5378 (cond ((equal arg '(16)) '(stack))
5379 ((and arg org-export-dispatch-last-action))
5380 (t (save-window-excursion
5381 (unwind-protect
5382 (progn
5383 ;; Remember where we are
5384 (move-marker org-export-dispatch-last-position
5385 (point)
5386 (org-base-buffer (current-buffer)))
5387 ;; Get and store an export command
5388 (setq org-export-dispatch-last-action
5389 (org-export--dispatch-ui
5390 (list org-export-initial-scope
5391 (and org-export-in-background 'async))
5392 nil
5393 org-export-dispatch-use-expert-ui)))
5394 (and (get-buffer "*Org Export Dispatcher*")
5395 (kill-buffer "*Org Export Dispatcher*")))))))
5396 (action (car input))
5397 (optns (cdr input)))
5398 (unless (memq 'subtree optns)
5399 (move-marker org-export-dispatch-last-position nil))
5400 (case action
5401 ;; First handle special hard-coded actions.
5402 (stack (org-export-stack))
5403 (publish-current-file
5404 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5405 (publish-current-project
5406 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5407 (publish-choose-project
5408 (org-publish (assoc (org-icompleting-read
5409 "Publish project: "
5410 org-publish-project-alist nil t)
5411 org-publish-project-alist)
5412 (memq 'force optns)
5413 (memq 'async optns)))
5414 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5415 (otherwise
5416 (save-excursion
5417 (when arg
5418 ;; Repeating command, maybe move cursor
5419 ;; to restore subtree context
5420 (if (eq (marker-buffer org-export-dispatch-last-position)
5421 (org-base-buffer (current-buffer)))
5422 (goto-char org-export-dispatch-last-position)
5423 ;; We are in a differnet buffer, forget position
5424 (move-marker org-export-dispatch-last-position nil)))
5425 (funcall action
5426 ;; Return a symbol instead of a list to ease
5427 ;; asynchronous export macro use.
5428 (and (memq 'async optns) t)
5429 (and (memq 'subtree optns) t)
5430 (and (memq 'visible optns) t)
5431 (and (memq 'body optns) t)))))))
5433 (defun org-export--dispatch-ui (options first-key expertp)
5434 "Handle interface for `org-export-dispatch'.
5436 OPTIONS is a list containing current interactive options set for
5437 export. It can contain any of the following symbols:
5438 `body' toggles a body-only export
5439 `subtree' restricts export to current subtree
5440 `visible' restricts export to visible part of buffer.
5441 `force' force publishing files.
5442 `async' use asynchronous export process
5444 FIRST-KEY is the key pressed to select the first level menu. It
5445 is nil when this menu hasn't been selected yet.
5447 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5448 buffer is provided, but indications about currently active
5449 options are given in the prompt. Moreover, \[?] allows to switch
5450 back to standard interface."
5451 (let* ((fontify-key
5452 (lambda (key &optional access-key)
5453 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5454 ;; non-nil is the required first-level key to activate
5455 ;; KEY. When its value is t, activate KEY independently
5456 ;; on the first key, if any. A nil value means KEY will
5457 ;; only be activated at first level.
5458 (if (or (eq access-key t) (eq access-key first-key))
5459 (org-propertize key 'face 'org-warning)
5460 key)))
5461 (fontify-value
5462 (lambda (value)
5463 ;; Fontify VALUE string.
5464 (org-propertize value 'face 'font-lock-variable-name-face)))
5465 ;; Prepare menu entries by extracting them from
5466 ;; `org-export-registered-backends', and sorting them by
5467 ;; access key and by ordinal, if any.
5468 (backends
5469 (sort
5470 (sort
5471 (delq nil
5472 (mapcar
5473 (lambda (b)
5474 (let ((name (car b)))
5475 (catch 'ignored
5476 ;; Ignore any back-end belonging to
5477 ;; `org-export-invisible-backends' or derived
5478 ;; from one of them.
5479 (dolist (ignored org-export-invisible-backends)
5480 (when (org-export-derived-backend-p name ignored)
5481 (throw 'ignored nil)))
5482 (org-export-backend-menu name))))
5483 org-export-registered-backends))
5484 (lambda (a b)
5485 (let ((key-a (nth 1 a))
5486 (key-b (nth 1 b)))
5487 (cond ((and (numberp key-a) (numberp key-b))
5488 (< key-a key-b))
5489 ((numberp key-b) t)))))
5490 (lambda (a b) (< (car a) (car b)))))
5491 ;; Compute a list of allowed keys based on the first key
5492 ;; pressed, if any. Some keys (?^B, ?^V, ?^S, ?^F, ?^A
5493 ;; and ?q) are always available.
5494 (allowed-keys
5495 (nconc (list 2 22 19 6 1)
5496 (if (not first-key) (org-uniquify (mapcar 'car backends))
5497 (let (sub-menu)
5498 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5499 (when (eq (car backend) first-key)
5500 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5501 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5502 ((not first-key) (list ?P)))
5503 (list ?&)
5504 (when expertp (list ??))
5505 (list ?q)))
5506 ;; Build the help menu for standard UI.
5507 (help
5508 (unless expertp
5509 (concat
5510 ;; Options are hard-coded.
5511 (format "Options
5512 [%s] Body only: %s [%s] Visible only: %s
5513 [%s] Export scope: %s [%s] Force publishing: %s
5515 (funcall fontify-key "C-b" t)
5516 (funcall fontify-value
5517 (if (memq 'body options) "On " "Off"))
5518 (funcall fontify-key "C-v" t)
5519 (funcall fontify-value
5520 (if (memq 'visible options) "On " "Off"))
5521 (funcall fontify-key "C-s" t)
5522 (funcall fontify-value
5523 (if (memq 'subtree options) "Subtree" "Buffer "))
5524 (funcall fontify-key "C-f" t)
5525 (funcall fontify-value
5526 (if (memq 'force options) "On " "Off"))
5527 (funcall fontify-key "C-a" t)
5528 (funcall fontify-value
5529 (if (memq 'async options) "On " "Off")))
5530 ;; Display registered back-end entries. When a key
5531 ;; appears for the second time, do not create another
5532 ;; entry, but append its sub-menu to existing menu.
5533 (let (last-key)
5534 (mapconcat
5535 (lambda (entry)
5536 (let ((top-key (car entry)))
5537 (concat
5538 (unless (eq top-key last-key)
5539 (setq last-key top-key)
5541 (funcall fontify-key (char-to-string top-key))
5542 (nth 1 entry)))
5543 (let ((sub-menu (nth 2 entry)))
5544 (unless (functionp sub-menu)
5545 ;; Split sub-menu into two columns.
5546 (let ((index -1))
5547 (concat
5548 (mapconcat
5549 (lambda (sub-entry)
5550 (incf index)
5551 (format
5552 (if (zerop (mod index 2)) " [%s] %-26s"
5554 (funcall fontify-key
5555 (char-to-string (car sub-entry))
5556 top-key)
5557 (nth 1 sub-entry)))
5558 sub-menu "")
5560 backends ""))
5561 ;; Publishing menu is hard-coded.
5563 [%s] Current file [%s] Current project
5565 (funcall fontify-key "P")
5566 (funcall fontify-key "f" ?P)
5567 (funcall fontify-key "p" ?P)
5568 (funcall fontify-key "x" ?P)
5569 (funcall fontify-key "a" ?P))
5571 (format "\[%s] %s"
5572 (funcall fontify-key "q" t)
5573 (if first-key "Main menu" "Exit")))))
5574 ;; Build prompts for both standard and expert UI.
5575 (standard-prompt (unless expertp "Export command: "))
5576 (expert-prompt
5577 (when expertp
5578 (format
5579 "Export command (C-%s%s%s%s%s) [%s]: "
5580 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5581 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5582 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5583 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5584 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5585 (mapconcat (lambda (k)
5586 ;; Strip control characters.
5587 (unless (< k 27) (char-to-string k)))
5588 allowed-keys "")))))
5589 ;; With expert UI, just read key with a fancy prompt. In standard
5590 ;; UI, display an intrusive help buffer.
5591 (if expertp
5592 (org-export--dispatch-action
5593 expert-prompt allowed-keys backends options first-key expertp)
5594 ;; At first call, create frame layout in order to display menu.
5595 (unless (get-buffer "*Org Export Dispatcher*")
5596 (delete-other-windows)
5597 (org-switch-to-buffer-other-window
5598 (get-buffer-create "*Org Export Dispatcher*"))
5599 (setq cursor-type nil
5600 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
5601 ;; Make sure that invisible cursor will not highlight square
5602 ;; brackets.
5603 (set-syntax-table (copy-syntax-table))
5604 (modify-syntax-entry ?\[ "w"))
5605 ;; At this point, the buffer containing the menu exists and is
5606 ;; visible in the current window. So, refresh it.
5607 (with-current-buffer "*Org Export Dispatcher*"
5608 ;; Refresh help. Maintain display continuity by re-visiting
5609 ;; previous window position.
5610 (let ((pos (window-start)))
5611 (erase-buffer)
5612 (insert help)
5613 (set-window-start nil pos)))
5614 (org-fit-window-to-buffer)
5615 (org-export--dispatch-action
5616 standard-prompt allowed-keys backends options first-key expertp))))
5618 (defun org-export--dispatch-action
5619 (prompt allowed-keys backends options first-key expertp)
5620 "Read a character from command input and act accordingly.
5622 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5623 a list of characters available at a given step in the process.
5624 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5625 EXPERTP are the same as defined in `org-export--dispatch-ui',
5626 which see.
5628 Toggle export options when required. Otherwise, return value is
5629 a list with action as CAR and a list of interactive export
5630 options as CDR."
5631 (let (key)
5632 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
5633 ;; C-p, SPC, DEL).
5634 (while (and (setq key (read-char-exclusive prompt))
5635 (not expertp)
5636 (memq key '(14 16 ?\s ?\d)))
5637 (case key
5638 (14 (if (not (pos-visible-in-window-p (point-max)))
5639 (ignore-errors (scroll-up-line))
5640 (message "End of buffer")
5641 (sit-for 1)))
5642 (16 (if (not (pos-visible-in-window-p (point-min)))
5643 (ignore-errors (scroll-down-line))
5644 (message "Beginning of buffer")
5645 (sit-for 1)))
5646 (?\s (if (not (pos-visible-in-window-p (point-max)))
5647 (scroll-up nil)
5648 (message "End of buffer")
5649 (sit-for 1)))
5650 (?\d (if (not (pos-visible-in-window-p (point-min)))
5651 (scroll-down nil)
5652 (message "Beginning of buffer")
5653 (sit-for 1)))))
5654 (cond
5655 ;; Ignore undefined associations.
5656 ((not (memq key allowed-keys))
5657 (ding)
5658 (unless expertp (message "Invalid key") (sit-for 1))
5659 (org-export--dispatch-ui options first-key expertp))
5660 ;; q key at first level aborts export. At second
5661 ;; level, cancel first key instead.
5662 ((eq key ?q) (if (not first-key) (error "Export aborted")
5663 (org-export--dispatch-ui options nil expertp)))
5664 ;; Help key: Switch back to standard interface if
5665 ;; expert UI was active.
5666 ((eq key ??) (org-export--dispatch-ui options first-key nil))
5667 ;; Switch to asynchronous export stack.
5668 ((eq key ?&) '(stack))
5669 ;; Toggle export options
5670 ;; C-b (2) C-v (22) C-s (19) C-f (6) C-a (1)
5671 ((memq key '(2 22 19 6 1))
5672 (org-export--dispatch-ui
5673 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
5674 (6 'force) (1 'async))))
5675 (if (memq option options) (remq option options)
5676 (cons option options)))
5677 first-key expertp))
5678 ;; Action selected: Send key and options back to
5679 ;; `org-export-dispatch'.
5680 ((or first-key (functionp (nth 2 (assq key backends))))
5681 (cons (cond
5682 ((not first-key) (nth 2 (assq key backends)))
5683 ;; Publishing actions are hard-coded. Send a special
5684 ;; signal to `org-export-dispatch'.
5685 ((eq first-key ?P)
5686 (case key
5687 (?f 'publish-current-file)
5688 (?p 'publish-current-project)
5689 (?x 'publish-choose-project)
5690 (?a 'publish-all)))
5691 ;; Return first action associated to FIRST-KEY + KEY
5692 ;; path. Indeed, derived backends can share the same
5693 ;; FIRST-KEY.
5694 (t (catch 'found
5695 (mapc (lambda (backend)
5696 (let ((match (assq key (nth 2 backend))))
5697 (when match (throw 'found (nth 2 match)))))
5698 (member (assq first-key backends) backends)))))
5699 options))
5700 ;; Otherwise, enter sub-menu.
5701 (t (org-export--dispatch-ui options key expertp)))))
5705 (provide 'ox)
5707 ;; Local variables:
5708 ;; generated-autoload-file: "org-loaddefs.el"
5709 ;; End:
5711 ;;; ox.el ends here