| blob | 6f5ebf474005919fe47e5eec03374070e83a37de |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
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 functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
90 \f
91 ;;; Internal Variables
92 ;;
93 ;; Among internal variables, the most important is
94 ;; `org-export-options-alist'. This variable define the global export
95 ;; options, shared between every exporter, and how they are acquired.
140 "Alist between export properties and ways to set them.
142 The key of the alist is the property name, and the value is a list
143 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
145 KEYWORD is a string representing a buffer keyword, or nil. Each
146 property defined this way can also be set, during subtree
147 export, through a headline property named after the keyword
149 property).
150 OPTION is a string that could be found in an #+OPTIONS: line.
151 DEFAULT is the default value for the property.
152 BEHAVIOR determines how Org should handle multiple keywords for
153 the same property. It is a symbol among:
154 nil Keep old value and discard the new one.
155 t Replace old value with the new one.
156 `space' Concatenate the values, separating them with a space.
157 `newline' Concatenate the values, separating them with
158 a newline.
159 `split' Split values at white spaces, and cons them to the
160 previous list.
161 `parse' Parse value as a list of strings and Org objects,
162 which can then be transcoded with, e.g.,
163 `org-export-data'. It implies `space' behavior.
165 Values set through KEYWORD and OPTION have precedence over
166 DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
233 "Alist between filters properties and initial values.
235 The key of each association is a property name accessible through
236 the communication channel. Its value is a configurable global
237 variable defining initial filters.
239 This list is meant to install user specified filters. Back-end
240 developers may install their own filters using
241 `org-export-define-backend'. Filters defined there will always
242 be prepended to the current list, so they always get applied
251 "Default rule for link matching an inline image.
252 This rule applies to links with no description. By default, it
253 will be considered as an inline image if it targets a local file
256 See `org-export-inline-image-p' for more information about
261 org-element--cache org-element--cache-objects org-element--cache-sync-keys
262 org-element--cache-sync-requests org-element--cache-sync-timer)
263 "List of variables not copied through upon buffer duplication.
264 Export process takes place on a copy of the original buffer.
265 When this copy is created, all Org related local variables not in
266 this list are copied to the new buffer. Variables with an
270 "Non-nil means asynchronous export process should leave data behind.
274 located in `temporary-file-directory'.
276 When non-nil, it will also set `debug-on-error' to a non-nil
280 "Record asynchronously generated export results and processes.
281 This is an alist: its CAR is the source of the
282 result (destination file or buffer for a finished process,
283 original buffer for a running one) and its CDR is a list
284 containing the back-end used, as a symbol, and either a process
285 or the time at which it finished. It is used to build the menu
289 "List of backends currently available in the exporter.
290 This variable is set with `org-export-define-backend' and
294 "Last command called from the dispatcher.
295 The value should be a list. Its CAR is the action, as a symbol,
299 "The position where the last export command was created using the dispatcher.
300 This marker will be used with `C-u C-c C-e' to make sure export repetition
303 ;; For compatibility with Org < 8
305 "Name, if any, of the back-end used during an export process.
307 Its value is a symbol such as `html', `latex', `ascii', or nil if
308 the back-end is anonymous (see `org-export-create-backend') or if
309 there is no export process in progress.
311 It can be used to teach Babel blocks how to act differently
315 \f
316 ;;; User-configurable Variables
317 ;;
318 ;; Configuration for the masses.
319 ;;
320 ;; They should never be accessed directly, as their value is to be
321 ;; stored in a property list (cf. `org-export-options-alist').
322 ;; Back-ends will read their value from there instead.
325 "Options for exporting Org mode files."
330 "General options for export engine."
335 "Whether sub-trees with the ARCHIVE tag should be exported.
337 This can have three different values:
338 nil Do not export, pretend this tree is not present.
339 t Do export the entire tree.
340 `headline' Only export the headline, but skip the tree below it.
342 This option can also be set with the OPTIONS keyword,
351 "Non-nil means insert author name into the exported file.
352 This option can also be set with the OPTIONS keyword,
358 "Non-nil means export CLOCK keywords.
359 This option can also be set with the OPTIONS keyword,
365 "Non-nil means the postamble should contain a creator sentence.
367 The sentence can be set in `org-export-creator-string', which
368 see.
370 This option can also be set with the OPTIONS keyword, e.g.,
378 "Non-nil means insert date in the exported document.
379 This option can also be set with the OPTIONS keyword,
385 "Time-stamp format string to use for DATE keyword.
387 The format string, when specified, only applies if date consists
388 in a single time-stamp. Otherwise its value will be ignored.
390 See `format-time-string' for details on how to build this
391 string."
399 emacs-version
401 "Information about the creator of the document.
402 This option can also be set on with the CREATOR keyword."
407 "Non-nil means export contents of standard drawers.
409 When t, all drawers are exported. This may also be a list of
410 drawer names to export, as strings. If that list starts with
411 `not', only drawers with such names will be ignored.
413 This variable doesn't apply to properties drawers. See
414 `org-export-with-properties' instead.
416 This option can also be set with the OPTIONS keyword,
429 :inline t
433 "Non-nil means insert author email into the exported file.
434 This option can also be set with the OPTIONS keyword,
440 "Non-nil means interpret *word*, /word/, _word_ and +word+.
442 If the export target supports emphasizing text, the word will be
443 typeset in bold, italic, with an underline or strike-through,
444 respectively.
446 This option can also be set with the OPTIONS keyword,
452 "Tags that exclude a tree from export.
454 All trees carrying any of these tags will be excluded from
455 export. This is without condition, so even subtrees inside that
456 carry one of the `org-export-select-tags' will be removed.
458 This option can also be set with the EXCLUDE_TAGS keyword."
464 This option can also be set with the OPTIONS keyword,
472 "Non-nil means Org footnotes should be exported.
473 This option can also be set with the OPTIONS keyword,
479 "Non-nil means process LaTeX environments and fragments.
481 This option can also be set with the OPTIONS line,
484 nil Ignore math snippets.
485 `verbatim' Keep everything in verbatim.
486 t Allow export of math snippets."
496 "The last level which is still exported as a headline.
498 Inferior levels will usually produce itemize or enumerate lists
499 when exported, but back-end behavior may differ.
501 This option can also be set with the OPTIONS keyword,
507 "The default language for export and clocktable translations, as a string.
508 This may have an association in
509 `org-clock-clocktable-language-setup',
510 `org-export-smart-quotes-alist' and `org-export-dictionary'.
511 This option can also be set with the LANGUAGE keyword."
516 "Non-nil means preserve all line breaks when exporting.
517 This option can also be set with the OPTIONS keyword,
523 "Non-nil means interpret entities when exporting.
526 Å.
528 For a list of supported names, see the constant `org-entities'
529 and the user option `org-entities-user'.
531 This option can also be set with the OPTIONS keyword,
537 "Non-nil means inlinetasks should be exported.
538 This option can also be set with the OPTIONS keyword,
546 "Non-nil means include planning info in export.
548 Planning info is the line containing either SCHEDULED:,
549 DEADLINE:, CLOSED: time-stamps, or a combination of them.
551 This option can also be set with the OPTIONS keyword,
559 "Non-nil means include priority cookies in export.
560 This option can also be set with the OPTIONS keyword,
566 "Non-nil means export contents of properties drawers.
568 When t, all properties are exported. This may also be a list of
569 properties to export, as strings.
571 This option can also be set with the OPTIONS keyword,
583 "Non-nil means add section numbers to headlines when exporting.
585 When set to an integer n, numbering will only happen for
586 headlines whose relative level is higher or equal to n.
588 This option can also be set with the OPTIONS keyword,
594 "Tags that select a tree for export.
596 If any such tag is found in a buffer, all trees that do not carry
597 one of these tags will be ignored during export. Inside trees
598 that are selected like this, you can still deselect a subtree by
599 tagging it with one of the `org-export-exclude-tags'.
601 This option can also be set with the SELECT_TAGS keyword."
606 "Non-nil means activate smart quotes during export.
607 This option can also be set with the OPTIONS keyword,
610 When setting this to non-nil, you need to take care of
611 using the correct Babel package when exporting to LaTeX.
612 E.g., you can load Babel for french like this:
623 When this option is turned on, these strings will be exported as:
625 Org HTML LaTeX UTF-8
626 -----+----------+--------+-------
628 -- – -- –
629 --- — --- —
632 This option can also be set with the OPTIONS keyword,
638 "Non-nil means include statistics cookies in export.
639 This option can also be set with the OPTIONS keyword,
649 If you want to control how Org displays those characters, see
650 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
651 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
652 it is not anymore.
654 When this option is turned on, you can use TeX-like syntax for
655 sub- and superscripts and see them exported correctly.
657 You can also set the option with #+OPTIONS: ^:t
660 single item - so grouping with {} is normally not needed. For
661 example, the following things will be parsed as single sub- or
662 superscripts:
664 10^24 or 10^tau several digits will be considered 1 item.
665 10^-12 or 10^-tau a leading sign with digits or a word
666 x^2-y^3 will be read as x^2 - y^3, because items are
667 terminated by almost any nonword/nondigit char.
668 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
670 Still, ambiguity is possible. So when in doubt, use {} to enclose
671 the sub/superscript. If you set this variable to the symbol `{}',
672 the braces are *required* in order to trigger interpretations as
674 frequently in plain text."
684 "Non-nil means create a table of contents in exported files.
686 The TOC contains headlines with levels up
687 to`org-export-headline-levels'. When an integer, include levels
688 up to N in the toc, this may then be different from
689 `org-export-headline-levels', but it will not be allowed to be
690 larger than the number of headline levels. When nil, no table of
691 contents is made.
693 This option can also be set with the OPTIONS keyword,
702 "Non-nil means export tables.
703 This option can also be set with the OPTIONS keyword,
711 "If nil, do not export tags, just remove them from headlines.
713 If this is the symbol `not-in-toc', tags will be removed from
714 table of contents entries, but still be shown in the headlines of
715 the document.
717 This option can also be set with the OPTIONS keyword,
726 "Non-nil means include TODO items for export.
728 This may have the following values:
729 t include tasks independent of state.
730 `todo' include only tasks that are not yet done.
731 `done' include only tasks that are already done.
732 nil ignore all tasks.
733 list of keywords include tasks with these keywords.
735 This option can also be set with the OPTIONS keyword,
747 "Non-nil means print title into the exported file.
748 This option can also be set with the OPTIONS keyword,
756 "Non-nil means insert a time stamp into the exported file.
757 The time stamp shows when the file was created. This option can
763 "Non nil means allow timestamps in export.
765 It can be set to any of the following values:
766 t export all timestamps.
767 `active' export active timestamps only.
768 `inactive' export inactive timestamps only.
769 nil do not export timestamps
771 This only applies to timestamps isolated in a paragraph
772 containing only timestamps. Other timestamps are always
773 exported.
775 This option can also be set with the OPTIONS keyword, e.g.
785 "Non-nil means include TODO keywords in export.
786 When nil, remove all these keywords from the export. This option
792 "Non-nil means BIND keywords can define local variable values.
793 This is a potential security risk, which is why the default value
794 is nil. You can also allow them through local buffer variables."
801 "Alist between export snippets back-ends and exporter back-ends.
803 This variable allows providing shortcuts for export snippets.
807 HTML code while every other back-end will ignore it."
816 "Coding system for the exported file."
823 "Non-nil means pushing export output to the kill ring.
824 This variable is ignored during asynchronous export."
834 "The initial scope when exporting with `org-export-dispatch'.
835 This variable can be either set to `buffer' or `subtree'."
842 "Non-nil means show buffer after exporting to temp buffer.
843 When Org exports to a file, the buffer visiting that file is never
844 shown, but remains buried. However, when exporting to
845 a temporary buffer, that buffer is popped up in a second window.
846 When this variable is nil, the buffer remains buried also in
847 these cases."
852 "Non-nil means export and publishing commands will run in background.
853 Results from an asynchronous export are never displayed
861 "File used to initialize external export process.
863 Value must be either nil or an absolute file name. When nil, the
864 external process is launched like a regular Emacs session,
865 loading user's initialization file and any site specific
866 configuration. If a file is provided, it, and only it, is loaded
867 at start-up.
869 Therefore, using a specific configuration makes the process to
870 load faster and the export more portable."
879 "Non-nil means using a non-intrusive `org-export-dispatch'.
880 In that case, no help buffer is displayed. Though, an indicator
886 asynchronous). Also, [?] allows switching back to standard
887 mode."
894 \f
895 ;;; Defining Back-ends
896 ;;
897 ;; An export back-end is a structure with `org-export-backend' type
898 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
899 ;; and `menu' slots.
900 ;;
901 ;; At the lowest level, a back-end is created with
902 ;; `org-export-create-backend' function.
903 ;;
904 ;; A named back-end can be registered with
905 ;; `org-export-register-backend' function. A registered back-end can
906 ;; later be referred to by its name, with `org-export-get-backend'
907 ;; function. Also, such a back-end can become the parent of a derived
908 ;; back-end from which slot values will be inherited by default.
909 ;; `org-export-derived-backend-p' can check if a given back-end is
910 ;; derived from a list of back-end names.
911 ;;
912 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
913 ;; `org-export-get-all-filters' return the full alist of transcoders,
914 ;; options and filters, including those inherited from ancestors.
915 ;;
916 ;; At a higher level, `org-export-define-backend' is the standard way
917 ;; to define an export back-end. If the new back-end is similar to
918 ;; a registered back-end, `org-export-define-derived-backend' may be
919 ;; used instead.
920 ;;
921 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
922 ;; when a given back-end hasn't been registered yet.
926 name parent transcoders options filters blocks menu)
929 "Return export back-end named after NAME.
930 NAME is a symbol. Return nil if no such back-end is found."
937 "Register BACKEND as a known export back-end.
938 BACKEND is a structure with `org-export-backend' type."
939 ;; Refuse to register an unnamed back-end.
942 ;; Refuse to register a back-end with an unknown parent.
946 ;; Register dedicated export blocks in the parser.
950 ;; If a back-end with the same name as BACKEND is already
951 ;; registered, replace it with BACKEND. Otherwise, simply add
952 ;; BACKEND to the list of registered back-ends.
958 "Signal an error if BACKEND isn't defined."
963 "Non-nil if BACKEND is derived from one of BACKENDS.
964 BACKEND is an export back-end, as returned by, e.g.,
965 `org-export-create-backend', or a symbol referring to
966 a registered back-end. BACKENDS is constituted of symbols."
978 "Return full translation table for BACKEND.
980 BACKEND is an export back-end, as return by, e.g,,
981 `org-export-create-backend'. Return value is an alist where
982 keys are element or object types, as symbols, and values are
983 transcoders.
985 Unlike to `org-export-backend-transcoders', this function
986 also returns transcoders inherited from parent back-ends,
987 if any."
991 parent)
996 transcoders)))
999 "Return export options for BACKEND.
1001 BACKEND is an export back-end, as return by, e.g,,
1002 `org-export-create-backend'. See `org-export-options-alist'
1003 for the shape of the return value.
1005 Unlike to `org-export-backend-options', this function also
1006 returns options inherited from parent back-ends, if any."
1010 parent)
1014 options)))
1017 "Return complete list of filters for BACKEND.
1019 BACKEND is an export back-end, as return by, e.g,,
1020 `org-export-create-backend'. Return value is an alist where
1021 keys are symbols and values lists of functions.
1023 Unlike to `org-export-backend-filters', this function also
1024 returns filters inherited from parent back-ends, if any."
1028 parent)
1032 filters)))
1035 "Define a new back-end BACKEND.
1037 TRANSCODERS is an alist between object or element types and
1038 functions handling them.
1040 These functions should return a string without any trailing
1041 space, or nil. They must accept three arguments: the object or
1042 element itself, its contents or nil when it isn't recursive and
1043 the property list used as a communication channel.
1045 Contents, when not nil, are stripped from any global indentation
1046 \(although the relative one is preserved). They also always end
1047 with a single newline character.
1049 If, for a given type, no function is found, that element or
1050 object type will simply be ignored, along with any blank line or
1051 white space at its end. The same will happen if the function
1052 returns the nil value. If that function returns the empty
1053 string, the type will be ignored, but the blank lines or white
1054 spaces will be kept.
1056 In addition to element and object types, one function can be
1057 associated to the `template' (or `inner-template') symbol and
1058 another one to the `plain-text' symbol.
1060 The former returns the final transcoded string, and can be used
1061 to add a preamble and a postamble to document's body. It must
1062 accept two arguments: the transcoded string and the property list
1063 containing export options. A function associated to `template'
1065 A function associated to `inner-template' is always applied.
1067 The latter, when defined, is to be called on every text not
1068 recognized as an element or an object. It must accept two
1069 arguments: the text string and the information channel. It is an
1070 appropriate place to protect special chars relative to the
1071 back-end.
1073 BODY can start with pre-defined keyword arguments. The following
1074 keywords are understood:
1076 :export-block
1078 String, or list of strings, representing block names that
1079 will not be parsed. This is used to specify blocks that will
1080 contain raw code specific to the back-end. These blocks
1081 still have to be handled by the relative `export-block' type
1082 translator.
1084 :filters-alist
1086 Alist between filters and function, or list of functions,
1087 specific to the back-end. See `org-export-filters-alist' for
1088 a list of all allowed filters. Filters defined here
1089 shouldn't make a back-end test, as it may prevent back-ends
1090 derived from this one to behave properly.
1092 :menu-entry
1094 Menu entry for the export dispatcher. It should be a list
1095 like:
1099 where :
1101 KEY is a free character selecting the back-end.
1103 DESCRIPTION-OR-ORDINAL is either a string or a number.
1105 If it is a string, is will be used to name the back-end in
1106 its menu entry. If it is a number, the following menu will
1107 be displayed as a sub-menu of the back-end with the same
1108 KEY. Also, the number will be used to determine in which
1109 order such sub-menus will appear (lowest first).
1111 ACTION-OR-MENU is either a function or an alist.
1113 If it is an action, it will be called with four
1114 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1115 BODY-ONLY. See `org-export-as' for further explanations on
1116 some of them.
1118 If it is an alist, associations should follow the
1119 pattern:
1123 where KEY, DESCRIPTION and ACTION are described above.
1125 Valid values include:
1129 or
1134 (lambda (a s v b)
1135 (if a (org-latex-export-to-pdf t s v b)
1136 (org-open-file
1137 (org-latex-export-to-pdf nil s v b)))))))
1139 or the following, which will be added to the previous
1140 sub-menu,
1146 :options-alist
1148 Alist between back-end specific properties introduced in
1149 communication channel and how their value are acquired. See
1150 `org-export-options-alist' for more information about
1151 structure of the values."
1166 :transcoders transcoders
1167 :options options
1168 :filters filters
1169 :blocks blocks
1173 "Create a new back-end as a variant of an existing one.
1175 CHILD is the name of the derived back-end. PARENT is the name of
1176 the parent back-end.
1178 BODY can start with pre-defined keyword arguments. The following
1179 keywords are understood:
1181 :export-block
1183 String, or list of strings, representing block names that
1184 will not be parsed. This is used to specify blocks that will
1185 contain raw code specific to the back-end. These blocks
1186 still have to be handled by the relative `export-block' type
1187 translator.
1189 :filters-alist
1191 Alist of filters that will overwrite or complete filters
1192 defined in PARENT back-end. See `org-export-filters-alist'
1193 for a list of allowed filters.
1195 :menu-entry
1197 Menu entry for the export dispatcher. See
1198 `org-export-define-backend' for more information about the
1199 expected value.
1201 :options-alist
1203 Alist of back-end specific properties that will overwrite or
1204 complete those defined in PARENT back-end. Refer to
1205 `org-export-options-alist' for more information about
1206 structure of the values.
1208 :translate-alist
1210 Alist of element and object types and transcoders that will
1211 overwrite or complete transcode table from PARENT back-end.
1212 Refer to `org-export-define-backend' for detailed information
1213 about transcoders.
1216 as a variant of `latex' back-end with a custom template function:
1221 The back-end could then be called with, for example:
1239 :parent parent
1240 :transcoders transcoders
1241 :options options
1242 :filters filters
1243 :blocks blocks
1247 \f
1248 ;;; The Communication Channel
1249 ;;
1250 ;; During export process, every function has access to a number of
1251 ;; properties. They are of two types:
1252 ;;
1253 ;; 1. Environment options are collected once at the very beginning of
1254 ;; the process, out of the original buffer and configuration.
1255 ;; Collecting them is handled by `org-export-get-environment'
1256 ;; function.
1257 ;;
1258 ;; Most environment options are defined through the
1259 ;; `org-export-options-alist' variable.
1260 ;;
1261 ;; 2. Tree properties are extracted directly from the parsed tree,
1262 ;; just before export, by `org-export-collect-tree-properties'.
1264 ;;;; Environment Options
1265 ;;
1266 ;; Environment options encompass all parameters defined outside the
1267 ;; scope of the parsed data. They come from five sources, in
1268 ;; increasing precedence order:
1269 ;;
1270 ;; - Global variables,
1271 ;; - Buffer's attributes,
1272 ;; - Options keyword symbols,
1273 ;; - Buffer keywords,
1274 ;; - Subtree properties.
1275 ;;
1276 ;; The central internal function with regards to environment options
1277 ;; is `org-export-get-environment'. It updates global variables with
1278 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1279 ;; the different sources.
1280 ;;
1281 ;; The internal functions doing the retrieval are:
1282 ;; `org-export--get-global-options',
1283 ;; `org-export--get-buffer-attributes',
1284 ;; `org-export--parse-option-keyword',
1285 ;; `org-export--get-subtree-options' and
1286 ;; `org-export--get-inbuffer-options'
1287 ;;
1288 ;; Also, `org-export--list-bound-variables' collects bound variables
1289 ;; along with their value in order to set them as buffer local
1290 ;; variables later in the process.
1293 "Collect export options from the current buffer.
1295 Optional argument BACKEND is an export back-end, as returned by
1296 `org-export-create-backend'.
1298 When optional argument SUBTREEP is non-nil, assume the export is
1299 done against the current sub-tree.
1301 Third optional argument EXT-PLIST is a property list with
1302 external parameters overriding Org default settings, but still
1303 inferior to file-local settings."
1304 ;; First install #+BIND variables since these must be set before
1305 ;; global options are read.
1308 ;; Get and prioritize export options...
1310 ;; ... from global variables...
1312 ;; ... from an external property list...
1313 ext-plist
1314 ;; ... from in-buffer settings...
1316 ;; ... and from subtree, when appropriate.
1318 ;; Eventually add misc. properties.
1320 :back-end
1321 backend
1323 :id-alist
1324 ;; Collect id references.
1335 alist))))
1338 "Parse an OPTIONS line and return values as a plist.
1339 Optional argument BACKEND is an export back-end, as returned by,
1340 e.g., `org-export-create-backend'. It specifies which back-end
1341 specific items to read, if any."
1348 alist))
1349 alist))
1350 ;; Priority is given to back-end specific options.
1352 org-export-options-alist))
1362 "Get export options in subtree at point.
1363 Optional argument BACKEND is an export back-end, as returned by,
1364 e.g., `org-export-create-backend'. It specifies back-end used
1365 for export. Return options as a plist."
1366 ;; For each buffer keyword, create a headline property setting the
1367 ;; same property in communication channel. The name for the
1368 ;; property is the keyword with "EXPORT_" appended to it.
1370 ;; Make sure point is at a heading.
1373 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1374 ;; care of them right from the start.
1377 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1378 ;; headline's title (with no todo keyword, priority cookie or
1379 ;; tag) as its fallback value.
1385 ;; Look for both general keywords and back-end specific
1386 ;; options, with priority given to the latter.
1388 org-export-options-alist)))
1389 ;; Handle other keywords. Then return PLIST.
1403 property
1412 "Return current buffer export options, as a plist.
1414 Optional argument BACKEND, when non-nil, is an export back-end,
1415 as returned by, e.g., `org-export-create-backend'. It specifies
1416 which back-end specific options should also be read in the
1417 process.
1419 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1421 get-options ; For byte-compiler.
1424 ;; Priority is given to back-end specific options.
1426 org-export-options-alist))
1429 org-export-special-keywords))))
1432 ;; Return all properties associated to KEYWORD.
1437 to-parse
1440 ;; Recursively read keywords in buffer. FILES is a list
1441 ;; of files read so far. PLIST is the current property
1442 ;; list obtained.
1451 ;; Options in `org-export-special-keywords'.
1455 ;; Avoid circular dependencies.
1467 plist
1472 plist
1478 ;; Options in `org-export-options-alist'.
1481 plist
1483 plist property
1484 ;; Handle value depending on specified
1485 ;; BEHAVIOR.
1490 ;; Even if `parse' implies `space'
1491 ;; behavior, we separate line with "\n"
1492 ;; so as to preserve line-breaks.
1493 ;; However, empty lines are forbidden
1494 ;; since `parse' doesn't allow more than
1495 ;; one paragraph.
1504 " "
1517 plist))))
1518 ;; Read options in the current buffer and return value.
1521 nil)))
1522 ;; Parse properties in TO-PARSE. Remove newline characters not
1523 ;; involved in line breaks to simulate `space' behavior.
1524 ;; Finally return options.
1536 "Return properties related to buffer attributes, as a plist."
1541 "Return global export options as a plist.
1542 Optional argument BACKEND, if non-nil, is an export back-end, as
1543 returned by, e.g., `org-export-create-backend'. It specifies
1544 which back-end specific export options should also be read in the
1545 process."
1547 ;; Priority is given to back-end specific options.
1549 org-export-options-alist)))
1555 plist
1556 prop
1557 ;; Evaluate default value provided.
1562 value)))))))))
1565 "Return variables bound from BIND keywords in current buffer.
1566 Also look for BIND keywords in setup files. The return value is
1567 an alist where associations are (VARIABLE-NAME VALUE)."
1572 ;; Return an alist between variable names and their
1573 ;; value. FILES is a list of setup files names read so
1574 ;; far, used to avoid circular dependencies. ALIST is
1575 ;; the alist collected so far.
1586 ;; Enter setup file.
1598 alist))))))))))
1599 alist)))))
1600 ;; Return value in appropriate order of appearance.
1603 ;; defsubst org-export-get-parent must be defined before first use,
1604 ;; was originally defined in the topology section
1607 "Return BLOB parent or nil.
1608 BLOB is the element or object considered."
1611 ;;;; Tree Properties
1612 ;;
1613 ;; Tree properties are information extracted from parse tree. They
1614 ;; are initialized at the beginning of the transcoding process by
1615 ;; `org-export-collect-tree-properties'.
1616 ;;
1617 ;; Dedicated functions focus on computing the value of specific tree
1618 ;; properties during initialization. Thus,
1619 ;; `org-export--populate-ignore-list' lists elements and objects that
1620 ;; should be skipped during export, `org-export--get-min-level' gets
1621 ;; the minimal exportable level, used as a basis to compute relative
1622 ;; level for headlines. Eventually
1623 ;; `org-export--collect-headline-numbering' builds an alist between
1624 ;; headlines and their numbering.
1627 "Extract tree properties from parse tree.
1629 DATA is the parse tree from which information is retrieved. INFO
1630 is a list holding export options.
1632 Following tree properties are set or updated:
1634 `:exported-data' Hash table used to memoize results from
1635 `org-export-data'.
1637 `:headline-offset' Offset between true level of headlines and
1638 local level. An offset of -1 means a headline
1639 of level 2 should be considered as a level
1640 1 headline in the context.
1642 `:headline-numbering' Alist of all headlines as key an the
1643 associated numbering as value.
1645 Return updated plist."
1646 ;; Install the parse tree in the communication channel.
1648 ;; Compute `:headline-offset' in order to be able to use
1649 ;; `org-export-get-relative-level'.
1652 :headline-offset
1654 ;; Properties order doesn't matter: get the rest of the tree
1655 ;; properties.
1659 info))
1662 "Return minimum exportable headline's level in DATA.
1663 DATA is parsed tree as returned by `org-element-parse-buffer'.
1664 OPTIONS is a plist holding export options."
1675 ;; If no headline was found, for the sake of consistency, set
1676 ;; minimum level to 1 nonetheless.
1680 "Return numbering of all exportable, numbered headlines in a parse tree.
1682 DATA is the parse tree. OPTIONS is the plist holding export
1683 options.
1685 Return an alist whose key is a headline and value is its
1686 associated numbering \(in the shape of a list of numbers) or nil
1687 for a footnotes section."
1696 headline
1698 for idx from 0 to org-export-max-depth
1702 options)))
1705 "List headlines and inlinetasks with a select tag in their tree.
1706 DATA is parsed data as returned by `org-element-parse-buffer'.
1707 INFO is a plist holding export options."
1709 walk-data ; For byte-compiler.
1719 ;; When a select tag is found, mark full
1720 ;; genealogy and every headline within the tree
1721 ;; as acceptable.
1724 genealogy
1727 selected-trees))
1728 ;; If at a headline, continue searching in tree,
1729 ;; recursively.
1738 selected-trees))
1741 "Non-nil when element or object BLOB should be skipped during export.
1742 OPTIONS is the plist holding export options. SELECTED, when
1743 non-nil, is a list of headlines or inlinetasks belonging to
1744 a tree with a select tag."
1751 ;; If `:with-drawers' value starts with `not', ignore
1752 ;; every drawer whose name belong to that list.
1753 ;; Otherwise, ignore drawers whose name isn't in that
1754 ;; list.
1771 ;; Ignore subtrees with an exclude tag.
1774 ;; When a select tag is present in the buffer, ignore any tree
1775 ;; without it.
1777 ;; Ignore commented sub-trees.
1779 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1781 ;; Ignore tasks, if specified by `:with-tasks' property.
1793 properties-set))))))
1804 ;; `:with-timestamps' only applies to isolated timestamps
1805 ;; objects, i.e. timestamp objects in a paragraph containing only
1806 ;; timestamps and whitespaces.
1814 options t))))
1823 \f
1824 ;;; The Transcoder
1825 ;;
1826 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1827 ;; `org-element-parse-buffer') and transcodes it into a specified
1828 ;; back-end output. It takes care of filtering out elements or
1829 ;; objects according to export options and organizing the output blank
1830 ;; lines and white space are preserved. The function memoizes its
1831 ;; results, so it is cheap to call it within transcoders.
1832 ;;
1833 ;; It is possible to modify locally the back-end used by
1834 ;; `org-export-data' or even use a temporary back-end by using
1835 ;; `org-export-data-with-backend'.
1836 ;;
1837 ;; `org-export-transcoder' is an accessor returning appropriate
1838 ;; translator function for a given element or object.
1841 "Return appropriate transcoder for BLOB.
1842 INFO is a plist containing export directives."
1844 ;; Return contents only for complete parse trees.
1850 "Convert DATA into current back-end format.
1852 DATA is a parse tree, an element or an object or a secondary
1853 string. INFO is a plist holding export options.
1855 Return a string."
1860 ;; Ignored element/object.
1862 ;; Plain text.
1868 info))
1869 ;; Secondary string.
1872 ;; Element/Object without contents or, as a special
1873 ;; case, headline with archive tag and archived trees
1874 ;; restricted to title only.
1882 ;; Export snippets never return a nil value so
1883 ;; that white spaces following them are never
1884 ;; ignored.
1886 ;; Element/Object with contents.
1899 ;; Elements directly containing
1900 ;; objects must have their indentation
1901 ;; normalized first.
1903 data
1904 ;; When normalizing contents of the
1905 ;; first paragraph in an item or
1906 ;; a footnote definition, ignore
1907 ;; first line's indentation: there is
1908 ;; none and it might be misleading.
1913 data)
1920 info))))))))
1921 ;; Final result will be memoized before being returned.
1923 data
1927 ;; Append the same white space between elements or objects
1928 ;; as in the original buffer, and call appropriate filters.
1939 info)))
1940 results)))
1944 "Convert DATA into BACKEND format.
1946 DATA is an element, an object, a secondary string or a string.
1947 BACKEND is a symbol. INFO is a plist used as a communication
1948 channel.
1950 Unlike to `org-export-with-backend', this function will
1951 recursively convert DATA using BACKEND translation table."
1954 data
1955 ;; Set-up a new communication channel with translations defined in
1956 ;; BACKEND as the translate table and a new hash table for
1957 ;; memoization.
1959 info
1962 ;; Size of the hash table is reduced since this function
1963 ;; will probably be used on small trees.
1967 "Expand a parsed element or object to its original state.
1969 BLOB is either an element or an object. CONTENTS is its
1970 contents, as a string or nil.
1972 When optional argument WITH-AFFILIATED is non-nil, add affiliated
1973 keywords before output."
1978 blob contents))))
1981 \f
1982 ;;; The Filter System
1983 ;;
1984 ;; Filters allow end-users to tweak easily the transcoded output.
1985 ;; They are the functional counterpart of hooks, as every filter in
1986 ;; a set is applied to the return value of the previous one.
1987 ;;
1988 ;; Every set is back-end agnostic. Although, a filter is always
1989 ;; called, in addition to the string it applies to, with the back-end
1990 ;; used as argument, so it's easy for the end-user to add back-end
1991 ;; specific filters in the set. The communication channel, as
1992 ;; a plist, is required as the third argument.
1993 ;;
1994 ;; From the developer side, filters sets can be installed in the
1995 ;; process with the help of `org-export-define-backend', which
1996 ;; internally stores filters as an alist. Each association has a key
1997 ;; among the following symbols and a function or a list of functions
1998 ;; as value.
1999 ;;
2000 ;; - `:filter-options' applies to the property list containing export
2001 ;; options. Unlike to other filters, functions in this list accept
2002 ;; two arguments instead of three: the property list containing
2003 ;; export options and the back-end. Users can set its value through
2004 ;; `org-export-filter-options-functions' variable.
2005 ;;
2006 ;; - `:filter-parse-tree' applies directly to the complete parsed
2007 ;; tree. Users can set it through
2008 ;; `org-export-filter-parse-tree-functions' variable.
2009 ;;
2010 ;; - `:filter-body' applies to the body of the output, before template
2011 ;; translator chimes in. Users can set it through
2012 ;; `org-export-filter-body-functions' variable.
2013 ;;
2014 ;; - `:filter-final-output' applies to the final transcoded string.
2015 ;; Users can set it with `org-export-filter-final-output-functions'
2016 ;; variable.
2017 ;;
2018 ;; - `:filter-plain-text' applies to any string not recognized as Org
2019 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2020 ;; configure it.
2021 ;;
2022 ;; - `:filter-TYPE' applies on the string returned after an element or
2023 ;; object of type TYPE has been transcoded. A user can modify
2024 ;; `org-export-filter-TYPE-functions' to install these filters.
2025 ;;
2026 ;; All filters sets are applied with
2027 ;; `org-export-filter-apply-functions' function. Filters in a set are
2028 ;; applied in a LIFO fashion. It allows developers to be sure that
2029 ;; their filters will be applied first.
2030 ;;
2031 ;; Filters properties are installed in communication channel with
2032 ;; `org-export-install-filters' function.
2033 ;;
2034 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2035 ;; `org-export-before-parsing-hook') are run at the beginning of the
2036 ;; export process and just before parsing to allow for heavy structure
2037 ;; modifications.
2040 ;;;; Hooks
2043 "Hook run at the beginning of the export process.
2045 This is run before include keywords and macros are expanded and
2046 Babel code blocks executed, on a copy of the original buffer
2047 being exported. Visibility and narrowing are preserved. Point
2048 is at the beginning of the buffer.
2050 Every function in this hook will be called with one argument: the
2054 "Hook run before parsing an export buffer.
2056 This is run after include keywords and macros have been expanded
2057 and Babel code blocks executed, on a copy of the original buffer
2058 being exported. Visibility and narrowing are preserved. Point
2059 is at the beginning of the buffer.
2061 Every function in this hook will be called with one argument: the
2065 ;;;; Special Filters
2068 "List of functions applied to the export options.
2069 Each filter is called with two arguments: the export options, as
2070 a plist, and the back-end, as a symbol. It must return
2074 "List of functions applied to the parsed tree.
2075 Each filter is called with three arguments: the parse tree, as
2076 returned by `org-element-parse-buffer', the back-end, as
2077 a symbol, and the communication channel, as a plist. It must
2081 "List of functions applied to plain text.
2082 Each filter is called with three arguments: a string which
2083 contains no Org syntax, the back-end, as a symbol, and the
2084 communication channel, as a plist. It must return a string or
2088 "List of functions applied to transcoded body.
2089 Each filter is called with three arguments: a string which
2090 contains no Org syntax, the back-end, as a symbol, and the
2091 communication channel, as a plist. It must return a string or
2095 "List of functions applied to the transcoded string.
2096 Each filter is called with three arguments: the full transcoded
2097 string, the back-end, as a symbol, and the communication channel,
2098 as a plist. It must return a string that will be used as the
2102 ;;;; Elements Filters
2105 "List of functions applied to a transcoded babel-call.
2106 Each filter is called with three arguments: the transcoded data,
2107 as a string, the back-end, as a symbol, and the communication
2111 "List of functions applied to a transcoded center block.
2112 Each filter is called with three arguments: the transcoded data,
2113 as a string, the back-end, as a symbol, and the communication
2117 "List of functions applied to a transcoded clock.
2118 Each filter is called with three arguments: the transcoded data,
2119 as a string, the back-end, as a symbol, and the communication
2123 "List of functions applied to a transcoded diary-sexp.
2124 Each filter is called with three arguments: the transcoded data,
2125 as a string, the back-end, as a symbol, and the communication
2129 "List of functions applied to a transcoded drawer.
2130 Each filter is called with three arguments: the transcoded data,
2131 as a string, the back-end, as a symbol, and the communication
2135 "List of functions applied to a transcoded dynamic-block.
2136 Each filter is called with three arguments: the transcoded data,
2137 as a string, the back-end, as a symbol, and the communication
2141 "List of functions applied to a transcoded example-block.
2142 Each filter is called with three arguments: the transcoded data,
2143 as a string, the back-end, as a symbol, and the communication
2147 "List of functions applied to a transcoded export-block.
2148 Each filter is called with three arguments: the transcoded data,
2149 as a string, the back-end, as a symbol, and the communication
2153 "List of functions applied to a transcoded fixed-width.
2154 Each filter is called with three arguments: the transcoded data,
2155 as a string, the back-end, as a symbol, and the communication
2159 "List of functions applied to a transcoded footnote-definition.
2160 Each filter is called with three arguments: the transcoded data,
2161 as a string, the back-end, as a symbol, and the communication
2165 "List of functions applied to a transcoded headline.
2166 Each filter is called with three arguments: the transcoded data,
2167 as a string, the back-end, as a symbol, and the communication
2171 "List of functions applied to a transcoded horizontal-rule.
2172 Each filter is called with three arguments: the transcoded data,
2173 as a string, the back-end, as a symbol, and the communication
2177 "List of functions applied to a transcoded inlinetask.
2178 Each filter is called with three arguments: the transcoded data,
2179 as a string, the back-end, as a symbol, and the communication
2183 "List of functions applied to a transcoded item.
2184 Each filter is called with three arguments: the transcoded data,
2185 as a string, the back-end, as a symbol, and the communication
2189 "List of functions applied to a transcoded keyword.
2190 Each filter is called with three arguments: the transcoded data,
2191 as a string, the back-end, as a symbol, and the communication
2195 "List of functions applied to a transcoded latex-environment.
2196 Each filter is called with three arguments: the transcoded data,
2197 as a string, the back-end, as a symbol, and the communication
2201 "List of functions applied to a transcoded node-property.
2202 Each filter is called with three arguments: the transcoded data,
2203 as a string, the back-end, as a symbol, and the communication
2207 "List of functions applied to a transcoded paragraph.
2208 Each filter is called with three arguments: the transcoded data,
2209 as a string, the back-end, as a symbol, and the communication
2213 "List of functions applied to a transcoded plain-list.
2214 Each filter is called with three arguments: the transcoded data,
2215 as a string, the back-end, as a symbol, and the communication
2219 "List of functions applied to a transcoded planning.
2220 Each filter is called with three arguments: the transcoded data,
2221 as a string, the back-end, as a symbol, and the communication
2225 "List of functions applied to a transcoded property-drawer.
2226 Each filter is called with three arguments: the transcoded data,
2227 as a string, the back-end, as a symbol, and the communication
2231 "List of functions applied to a transcoded quote block.
2232 Each filter is called with three arguments: the transcoded quote
2233 data, as a string, the back-end, as a symbol, and the
2234 communication channel, as a plist. It must return a string or
2238 "List of functions applied to a transcoded section.
2239 Each filter is called with three arguments: the transcoded data,
2240 as a string, the back-end, as a symbol, and the communication
2244 "List of functions applied to a transcoded special block.
2245 Each filter is called with three arguments: the transcoded data,
2246 as a string, the back-end, as a symbol, and the communication
2250 "List of functions applied to a transcoded src-block.
2251 Each filter is called with three arguments: the transcoded data,
2252 as a string, the back-end, as a symbol, and the communication
2256 "List of functions applied to a transcoded table.
2257 Each filter is called with three arguments: the transcoded data,
2258 as a string, the back-end, as a symbol, and the communication
2262 "List of functions applied to a transcoded table-cell.
2263 Each filter is called with three arguments: the transcoded data,
2264 as a string, the back-end, as a symbol, and the communication
2268 "List of functions applied to a transcoded table-row.
2269 Each filter is called with three arguments: the transcoded data,
2270 as a string, the back-end, as a symbol, and the communication
2274 "List of functions applied to a transcoded verse block.
2275 Each filter is called with three arguments: the transcoded data,
2276 as a string, the back-end, as a symbol, and the communication
2280 ;;;; Objects Filters
2283 "List of functions applied to transcoded bold text.
2284 Each filter is called with three arguments: the transcoded data,
2285 as a string, the back-end, as a symbol, and the communication
2289 "List of functions applied to transcoded code text.
2290 Each filter is called with three arguments: the transcoded data,
2291 as a string, the back-end, as a symbol, and the communication
2295 "List of functions applied to a transcoded entity.
2296 Each filter is called with three arguments: the transcoded data,
2297 as a string, the back-end, as a symbol, and the communication
2301 "List of functions applied to a transcoded export-snippet.
2302 Each filter is called with three arguments: the transcoded data,
2303 as a string, the back-end, as a symbol, and the communication
2307 "List of functions applied to a transcoded footnote-reference.
2308 Each filter is called with three arguments: the transcoded data,
2309 as a string, the back-end, as a symbol, and the communication
2313 "List of functions applied to a transcoded inline-babel-call.
2314 Each filter is called with three arguments: the transcoded data,
2315 as a string, the back-end, as a symbol, and the communication
2319 "List of functions applied to a transcoded inline-src-block.
2320 Each filter is called with three arguments: the transcoded data,
2321 as a string, the back-end, as a symbol, and the communication
2325 "List of functions applied to transcoded italic text.
2326 Each filter is called with three arguments: the transcoded data,
2327 as a string, the back-end, as a symbol, and the communication
2331 "List of functions applied to a transcoded latex-fragment.
2332 Each filter is called with three arguments: the transcoded data,
2333 as a string, the back-end, as a symbol, and the communication
2337 "List of functions applied to a transcoded line-break.
2338 Each filter is called with three arguments: the transcoded data,
2339 as a string, the back-end, as a symbol, and the communication
2343 "List of functions applied to a transcoded link.
2344 Each filter is called with three arguments: the transcoded data,
2345 as a string, the back-end, as a symbol, and the communication
2349 "List of functions applied to a transcoded radio-target.
2350 Each filter is called with three arguments: the transcoded data,
2351 as a string, the back-end, as a symbol, and the communication
2355 "List of functions applied to a transcoded statistics-cookie.
2356 Each filter is called with three arguments: the transcoded data,
2357 as a string, the back-end, as a symbol, and the communication
2361 "List of functions applied to transcoded strike-through text.
2362 Each filter is called with three arguments: the transcoded data,
2363 as a string, the back-end, as a symbol, and the communication
2367 "List of functions applied to a transcoded subscript.
2368 Each filter is called with three arguments: the transcoded data,
2369 as a string, the back-end, as a symbol, and the communication
2373 "List of functions applied to a transcoded superscript.
2374 Each filter is called with three arguments: the transcoded data,
2375 as a string, the back-end, as a symbol, and the communication
2379 "List of functions applied to a transcoded target.
2380 Each filter is called with three arguments: the transcoded data,
2381 as a string, the back-end, as a symbol, and the communication
2385 "List of functions applied to a transcoded timestamp.
2386 Each filter is called with three arguments: the transcoded data,
2387 as a string, the back-end, as a symbol, and the communication
2391 "List of functions applied to transcoded underline text.
2392 Each filter is called with three arguments: the transcoded data,
2393 as a string, the back-end, as a symbol, and the communication
2397 "List of functions applied to transcoded verbatim text.
2398 Each filter is called with three arguments: the transcoded data,
2399 as a string, the back-end, as a symbol, and the communication
2403 ;;;; Filters Tools
2404 ;;
2405 ;; Internal function `org-export-install-filters' installs filters
2406 ;; hard-coded in back-ends (developer filters) and filters from global
2407 ;; variables (user filters) in the communication channel.
2408 ;;
2409 ;; Internal function `org-export-filter-apply-functions' takes care
2410 ;; about applying each filter in order to a given data. It ignores
2411 ;; filters returning a nil value but stops whenever a filter returns
2412 ;; an empty string.
2415 "Call every function in FILTERS.
2417 Functions are called with arguments VALUE, current export
2418 back-end's name and INFO. A function returning a nil value will
2419 be skipped. If it returns the empty string, the process ends and
2420 VALUE is ignored.
2422 Call is done in a LIFO fashion, to be sure that developer
2423 specified filters, if any, are called first."
2434 "Install filters properties in communication channel.
2435 INFO is a plist containing the current communication channel.
2436 Return the updated communication channel."
2438 ;; Install user-defined filters with `org-export-filters-alist'
2439 ;; and filters already in INFO (through ext-plist mechanism).
2446 ;; Filters in INFO will be called
2447 ;; before those user provided.
2450 default-value)))))
2451 org-export-filters-alist)
2452 ;; Prepend back-end specific filters to that list.
2454 ;; Single values get consed, lists are appended.
2459 plist key
2463 ;; Return new communication channel.
2467 \f
2468 ;;; Core functions
2469 ;;
2470 ;; This is the room for the main function, `org-export-as', along with
2471 ;; its derivative, `org-export-string-as'.
2472 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2473 ;; function should be added to kill ring.
2474 ;;
2475 ;; Note that `org-export-as' doesn't really parse the current buffer,
2476 ;; but a copy of it (with the same buffer-local variables and
2477 ;; visibility), where macros and include keywords are expanded and
2478 ;; Babel blocks are executed, if appropriate.
2479 ;; `org-export-with-buffer-copy' macro prepares that copy.
2480 ;;
2481 ;; File inclusion is taken care of by
2482 ;; `org-export-expand-include-keyword' and
2483 ;; `org-export--prepare-file-contents'. Structure wise, including
2484 ;; a whole Org file in a buffer often makes little sense. For
2485 ;; example, if the file contains a headline and the include keyword
2486 ;; was within an item, the item should contain the headline. That's
2487 ;; why file inclusion should be done before any structure can be
2488 ;; associated to the file, that is before parsing.
2489 ;;
2490 ;; `org-export-insert-default-template' is a command to insert
2491 ;; a default template (or a back-end specific template) at point or in
2492 ;; current subtree.
2495 "Return a copy of the current buffer.
2496 The copy preserves Org buffer-local variables, visibility and
2497 narrowing."
2503 new-buf))
2506 "Apply BODY in a copy of the current buffer.
2507 The copy preserves local variables, visibility and contents of
2508 the original buffer. Point is at the beginning of the buffer
2509 when BODY is applied."
2518 ;; Kill copy without confirmation.
2524 "Generate a function duplicating BUFFER.
2526 The copy will preserve local variables, visibility, contents and
2527 narrowing of the original buffer. If a region was active in
2528 BUFFER, contents will be narrowed to that region instead.
2530 The resulting function can be evaluated at a later time, from
2531 another buffer, effectively cloning the original buffer there.
2533 The function assumes BUFFER's major mode is `org-mode'."
2537 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2538 ;; already in BUFFER.
2540 ;; Copy specific buffer local variables and variables set
2541 ;; through BIND keywords.
2543 vars)
2551 buffer-file-name
2552 buffer-file-coding-system))
2556 ;; Skip unreadable values, as they cannot be
2557 ;; sent to external process.
2561 vars))))))
2562 ;; Whole buffer contents.
2567 ;; Narrowing.
2571 ;; Current position of point.
2573 ;; Overlays with invisible property.
2583 ov-set))))
2585 ov-set)))))
2588 "Delete commented areas in the buffer.
2589 Commented areas are comments, comment blocks, commented trees and
2590 inlinetasks. Trailing blank lines after a comment or a comment
2591 block are removed, as long as it doesn't alter the structure of
2592 the document. Narrowing, if any, is ignored."
2598 comment-re)))
2610 ;; We remove trailing blank lines. Doing so could
2611 ;; modify the structure of the document. Therefore
2612 ;; we ensure that any comment between elements is
2613 ;; replaced with one empty line, so as to keep them
2614 ;; separated.
2620 start)
2622 end)
2632 "Prune non exportable elements from DATA.
2633 DATA is the parse tree to traverse. INFO is the plist holding
2634 export info. Also set `:ignore-list' in INFO to a list of
2635 objects which should be ignored during export, but not removed
2636 from tree."
2638 ignore
2639 ;; First find trees containing a select tag, if any.
2643 ;; Prune non-exportable elements and objects from tree.
2644 ;; As a special case, special rows and cells from tables
2645 ;; are stored in IGNORE, as they still need to be accessed
2646 ;; during export.
2655 ;; If headline is archived but tree below has to
2656 ;; be skipped, remove contents.
2658 ;; Move into recursive objects/elements.
2660 ;; Move into secondary string, if any.
2662 org-element-secondary-value-alist)))
2664 ;; If a select tag is active, also ignore the section before the
2665 ;; first headline, if any.
2670 ;; Prune tree and communication channel.
2674 ;; Priority is given to back-end specific options.
2676 org-export-options-alist))
2679 ;; Eventually set `:ignore-list'.
2683 "Change uninterpreted elements back into Org syntax.
2684 DATA is the parse tree. INFO is a plist containing export
2685 options. Each uninterpreted element or object is changed back
2686 into a string. Contents, if any, are not modified. The parse
2687 tree is modified by side effect."
2693 p
2696 info))))))
2699 "Change uninterpreted elements back into Org syntax.
2700 DATA is a parse tree or a secondary string. INFO is a plist
2701 containing export options. It is modified by side effect and
2702 returned by the function."
2705 subscript superscript underline)
2709 ;; ... entities...
2716 ?\s)))))
2717 ;; ... emphasis...
2729 marker
2733 ?\s)))))))
2734 ;; ... LaTeX environments and fragments...
2738 ;; ... sub/superscripts...
2747 "_"
2756 ?\s)))))))))))
2758 ;; Splice NEW at BLOB location in parse tree.
2761 info nil nil t)
2762 ;; Return modified parse tree.
2763 data)
2766 "Insert footnote definitions outside parsing scope in TREE.
2768 If there is a footnote section in TREE, definitions found are
2769 appended to it. If `org-footnote-section' is non-nil, a new
2770 footnote section containing all definitions is inserted in TREE.
2771 Otherwise, definitions are appended at the end of the section
2772 containing their first reference.
2774 Only definitions actually referred to within TREE, directly or
2775 not, are considered."
2794 definitions))
2802 'footnote-definition
2808 definitions))))))))
2809 ;; Collect all out of scope definitions.
2819 ;; Filter out definitions referenced neither in the original
2820 ;; tree nor in the external definitions.
2825 definitions))
2828 referenced-labels)))
2833 definitions)))
2834 ;; Install definitions in subtree.
2837 ;; If there is a footnote section, insert them here.
2842 nil t)))
2845 ;; If there should be a footnote section, create one containing
2846 ;; all the definitions at the end of the tree.
2849 tree
2855 'section
2856 nil
2858 ;; Otherwise add each definition at the end of the section where
2859 ;; it is first referenced.
2865 ;; Insert definitions in the same section as their
2866 ;; first reference in DATA.
2878 label)
2885 definition)
2887 definition)))))))))))
2890 ;;;###autoload
2893 "Transcode current Org buffer into BACKEND code.
2895 BACKEND is either an export back-end, as returned by, e.g.,
2896 `org-export-create-backend', or a symbol referring to
2897 a registered back-end.
2899 If narrowing is active in the current buffer, only transcode its
2900 narrowed part.
2902 If a region is active, transcode that region.
2904 When optional argument SUBTREEP is non-nil, transcode the
2905 sub-tree at point, extracting information from the headline
2906 properties first.
2908 When optional argument VISIBLE-ONLY is non-nil, don't export
2909 contents of hidden elements.
2911 When optional argument BODY-ONLY is non-nil, only return body
2912 code, without surrounding template.
2914 Optional argument EXT-PLIST, when provided, is a property list
2915 with external parameters overriding Org default settings, but
2916 still inferior to file-local settings.
2918 Return code as a string."
2923 ;; Narrow buffer to an appropriate region or subtree for
2924 ;; parsing. If parsing subtree, be sure to remove main headline
2925 ;; too.
2933 ;; Initialize communication channel with original buffer
2934 ;; attributes, unavailable in its copy.
2947 org-export-options-alist))))
2948 tree)
2949 ;; Update communication channel and get parse tree. Buffer
2950 ;; isn't parsed directly. Instead, all buffer modifications
2951 ;; and consequent parsing are undertaken in a temporary copy.
2953 ;; Run first hook with current back-end's name as argument.
2956 ;; Include files, delete comments and expand macros.
2961 ;; Refresh buffer properties and radio targets after
2962 ;; potentially invasive previous changes. Likewise, do it
2963 ;; again after executing Babel code.
2969 ;; Run last hook with current back-end's name as argument.
2970 ;; Update buffer properties and radio targets one last time
2971 ;; before parsing.
2978 ;; Update communication channel with environment. Also
2979 ;; install user's and developer's filters.
2984 ;; Call options filters and update export options. We do not
2985 ;; use `org-export-filter-apply-functions' here since the
2986 ;; arity of such filters is different.
2991 ;; Expand export-specific set of macros: {{{author}}},
2992 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2993 ;; be done once regular macros have been expanded, since
2994 ;; parsed keywords may contain one of them.
3007 value)
3008 value)))
3012 'finalize
3013 parsed-keywords)
3014 ;; Parse buffer.
3016 ;; Merge footnote definitions outside scope into parse tree.
3018 ;; Prune tree from non-exported elements and transform
3019 ;; uninterpreted elements or objects in both parse tree and
3020 ;; communication channel.
3023 ;; Call parse tree filters.
3027 ;; Now tree is complete, compute its properties and add them
3028 ;; to communication channel.
3032 ;; Eventually transcode TREE. Wrap the resulting string into
3033 ;; a template.
3042 info))
3045 ;; Remove all text properties since they cannot be
3046 ;; retrieved from an external process. Finally call
3047 ;; final-output filter and return result.
3053 info))))))))
3055 ;;;###autoload
3057 "Transcode STRING into BACKEND code.
3059 BACKEND is either an export back-end, as returned by, e.g.,
3060 `org-export-create-backend', or a symbol referring to
3061 a registered back-end.
3063 When optional argument BODY-ONLY is non-nil, only return body
3064 code, without preamble nor postamble.
3066 Optional argument EXT-PLIST, when provided, is a property list
3067 with external parameters overriding Org default settings, but
3068 still inferior to file-local settings.
3070 Return code as a string."
3076 ;;;###autoload
3078 "Replace the active region by its export to BACKEND.
3079 BACKEND is either an export back-end, as returned by, e.g.,
3080 `org-export-create-backend', or a symbol referring to
3081 a registered back-end."
3087 ;;;###autoload
3089 "Insert all export keywords with default values at beginning of line.
3091 BACKEND is a symbol referring to the name of a registered export
3092 back-end, for which specific export options should be added to
3093 the template, or `default' for default template. When it is nil,
3094 the user will be prompted for a category.
3096 If SUBTREEP is non-nil, export configuration will be set up
3097 locally for the subtree through node properties."
3107 "Options category: "
3111 org-export-registered-backends))
3112 nil t))))
3113 options keywords)
3114 ;; Populate OPTIONS and KEYWORDS.
3131 ;; Move to an appropriate location in order to insert options.
3133 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3151 ;; Then the rest of keywords, in the order specified in either
3152 ;; `org-export-options-alist' or respective export back-ends.
3173 "Expand every include keyword in buffer.
3174 Optional argument INCLUDED is a list of included file names along
3175 with their line restriction, when appropriate. It is used to
3176 avoid infinite recursion. Optional argument DIR is the current
3177 working directory. It is used to properly resolve relative
3178 paths. Optional argument FOOTNOTES is a hash-table used for
3179 storing and resolving footnotes. It is created automatically."
3185 ;; If :minlevel is not set the text-property
3186 ;; `:org-include-induced-level' will be used to determine the
3187 ;; relative level when expanding INCLUDE.
3188 ;; Only affects included Org documents.
3192 :org-include-induced-level
3194 ;; Expand INCLUDE keywords.
3200 ;; Extract arguments from keyword's value.
3203 location
3211 matched)
3217 matched)
3218 dir)))
3222 value)
3228 value)
3235 ;; Minimal level of included file defaults to the child
3236 ;; level of the current headline, if any, or one. It
3237 ;; only applies is the file is meant to be included as
3238 ;; an Org one.
3250 ;; Remove keyword.
3256 ;; Check if files has already been parsed. Look after
3257 ;; inclusion lines too, as different parts of the same file
3258 ;; can be included too.
3273 ind-str block arg-str contents ind-str block))))
3280 ind-str block contents ind-str block))))
3288 file location only-contents lines)
3289 lines)))
3293 file lines ind minlevel
3296 footnotes)))
3300 footnotes)
3302 ;; Expand footnotes after all files have been included.
3303 ;; Footnotes are stored at end of buffer.
3308 footnotes)))))))))))
3311 "Resolve absolute lines for an included file with file-link.
3313 FILE is string file-name of the file to include. LOCATION is a
3314 string name within FILE to be included (located via
3315 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3316 contents of the named element will be included, as determined
3317 Org-Element. If LINES is non-nil only those lines are included.
3319 Return a string of lines to be included in the format expected by
3320 `org-export--prepare-file-contents'."
3326 ;; Enforce consistent search.
3339 ;; Skip planning line and property-drawer.
3365 start-line
3367 (+ start-line
3370 counter))))))))
3374 "Prepare contents of FILE for inclusion and return it as a string.
3376 When optional argument LINES is a string specifying a range of
3377 lines, include only those lines.
3379 Optional argument IND, when non-nil, is an integer specifying the
3380 global indentation of returned contents. Since its purpose is to
3381 allow an included file to stay in the same environment it was
3382 created (e.g., a list item), it doesn't apply past the first
3383 headline encountered.
3385 Optional argument MINLEVEL, when non-nil, is an integer
3386 specifying the level that any top-level headline in the included
3387 file should have.
3389 Optional argument ID is an integer that will be inserted before
3390 each footnote definition and reference if FILE is an Org file.
3391 This is useful to avoid conflicts when more than one Org file
3392 with footnotes is included in a document.
3394 Optional argument FOOTNOTES is a hash-table to store footnotes in
3395 the included document."
3411 ;; Remove blank lines at beginning and end of contents. The logic
3412 ;; behind that removal is that blank lines around include keyword
3413 ;; override blank lines in included file.
3422 ;; If IND is set, preserve indentation of include keyword until
3423 ;; the first headline encountered.
3430 ;; Do not move footnote definitions out of column 0.
3436 ;; When MINLEVEL is specified, compute minimal level for headlines
3437 ;; in the file (CUR-MIN), and remove stars to each headline so
3438 ;; that headlines with minimal level have a level of MINLEVEL.
3449 ;; Only change stars, don't bother moving whole
3450 ;; sections.
3455 ;; Append ID to all footnote references and definitions, so they
3456 ;; become file specific and cannot collide with footnotes in other
3457 ;; included files. Further, collect relevant footnote definitions
3458 ;; outside of LINES, in order to reintroduce them later.
3464 ;; Generate new label from LABEL. If LABEL is akin to
3465 ;; [1] convert it to [fn:--ID-1]. Otherwise add "-ID-"
3466 ;; after "fn:".
3472 ;; Replace OLD label with NEW in footnote F.
3486 ;; Update the footnote-reference at point and collect
3487 ;; the new label, which is only used for footnotes
3488 ;; outsides LINES.
3500 ;; Store since footnote-definition is
3501 ;; outside of LINES.
3504 footnotes))))
3511 "Execute every Babel code in the visible part of current buffer."
3512 ;; Get a pristine copy of current buffer so Babel references can be
3513 ;; properly resolved.
3519 "Return a non-nil value when output should be added to the kill ring.
3520 See also `org-export-copy-to-kill-ring'."
3526 \f
3527 ;;; Tools For Back-Ends
3528 ;;
3529 ;; A whole set of tools is available to help build new exporters. Any
3530 ;; function general enough to have its use across many back-ends
3531 ;; should be added here.
3533 ;;;; For Affiliated Keywords
3534 ;;
3535 ;; `org-export-read-attribute' reads a property from a given element
3536 ;; as a plist. It can be used to normalize affiliated keywords'
3537 ;; syntax.
3538 ;;
3539 ;; Since captions can span over multiple lines and accept dual values,
3540 ;; their internal representation is a bit tricky. Therefore,
3541 ;; `org-export-get-caption' transparently returns a given element's
3542 ;; caption as a secondary string.
3545 "Turn ATTRIBUTE property from ELEMENT into a plist.
3547 When optional argument PROPERTY is non-nil, return the value of
3548 that property within attributes.
3552 properties.
3554 All values will become strings except the empty string and
3557 will become the empty string."
3571 s)
3576 ;; Ignore any string before first property with `cdr'.
3581 "Return caption from ELEMENT as a secondary string.
3583 When optional argument SHORTP is non-nil, return short caption,
3584 as a secondary string, instead.
3586 Caption lines are separated by a white space."
3594 ;;;; For Derived Back-ends
3595 ;;
3596 ;; `org-export-with-backend' is a function allowing to locally use
3597 ;; another back-end to transcode some object or element. In a derived
3598 ;; back-end, it may be used as a fall-back function once all specific
3599 ;; cases have been treated.
3602 "Call a transcoder from BACKEND on DATA.
3603 BACKEND is an export back-end, as returned by, e.g.,
3604 `org-export-create-backend', or a symbol referring to
3605 a registered back-end. DATA is an Org element, object, secondary
3606 string or string. CONTENTS, when non-nil, is the transcoded
3607 contents of DATA element, as a string. INFO, when non-nil, is
3608 the communication channel used for export, as a plist."
3618 transcoder data contents
3621 :back-end backend
3622 :translate-alist all-transcoders
3626 ;;;; For Export Snippets
3627 ;;
3628 ;; Every export snippet is transmitted to the back-end. Though, the
3629 ;; latter will only retain one type of export-snippet, ignoring
3630 ;; others, based on the former's target back-end. The function
3631 ;; `org-export-snippet-backend' returns that back-end for a given
3632 ;; export-snippet.
3635 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3636 Translation, with `org-export-snippet-translation-alist', is
3637 applied."
3641 back-end))))
3644 ;;;; For Footnotes
3645 ;;
3646 ;; `org-export-collect-footnote-definitions' is a tool to list
3647 ;; actually used footnotes definitions in the whole parse tree, or in
3648 ;; a headline, in order to add footnote listings throughout the
3649 ;; transcoded data.
3650 ;;
3651 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3652 ;; back-ends, when they need to attach the footnote definition only to
3653 ;; the first occurrence of the corresponding label.
3654 ;;
3655 ;; `org-export-get-footnote-definition' and
3656 ;; `org-export-get-footnote-number' provide easier access to
3657 ;; additional information relative to a footnote reference.
3660 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3661 INFO is the plist used as a communication channel. If no such
3662 definition can be found, raise an error."
3668 hash))))
3676 info t)
3677 cache)
3682 "Apply FUNCTION on every footnote reference in DATA.
3683 INFO is a plist containing export state. By default, as soon as
3684 a new footnote reference is encountered, FUNCTION is called onto
3685 its definition. However, if BODY-FIRST is non-nil, this step is
3686 delayed until the end of the process."
3692 ;; Search footnote references through DATA, filling
3693 ;; SEEN-REFS along the way. When DELAYP is non-nil, store
3694 ;; footnote definitions so they can be entered later.
3701 ;; Search for subsequent references in footnote
3702 ;; definition so numbering follows reading logic,
3703 ;; unless DELAYP in non-nil.
3707 definitions))
3708 ;; Do not force entering inline definitions,
3709 ;; since `org-element-map' already traverses them
3710 ;; at the right time.
3714 nil))))))
3715 info nil
3716 ;; Don't enter footnote definitions since it will happen
3717 ;; when their first reference is found. Moreover, if
3718 ;; DELAYP is non-nil, make sure we postpone entering
3719 ;; definitions of inline references.
3726 "Return an alist between footnote numbers, labels and definitions.
3728 INFO is the current export state, as a plist.
3730 Definitions are collected throughout the whole parse tree, or
3731 DATA when non-nil.
3733 Sorting is done by order of references. As soon as a new
3734 reference is encountered, other references are searched within
3735 its definition. However, if BODY-FIRST is non-nil, this step is
3736 delayed after the whole tree is checked. This alters results
3737 when references are found in footnote definitions.
3739 Definitions either appear as Org data or as a secondary string
3740 for inlined footnotes. Unreferenced definitions are ignored."
3744 ;; Collect footnote number, label and definition.
3755 "Non-nil when a footnote reference is the first one for its label.
3757 FOOTNOTE-REFERENCE is the footnote reference being considered.
3758 INFO is a plist containing current export state.
3760 Search is done throughout the whole parse tree, or DATA when
3761 non-nil.
3763 By default, as soon as a new footnote reference is encountered,
3764 other references are searched within its definition. However, if
3765 BODY-FIRST is non-nil, this step is delayed after the whole tree
3766 is checked. This alters results when references are found in
3767 footnote definitions."
3769 ;; Anonymous footnotes are always a first reference.
3780 "Return number associated to a footnote.
3782 FOOTNOTE is either a footnote reference or a footnote definition.
3783 INFO is the plist containing export state.
3785 Number is unique throughout the whole parse tree, or DATA, when
3786 non-nil.
3788 By default, as soon as a new footnote reference is encountered,
3789 counting process moves into its definition. However, if
3790 BODY-FIRST is non-nil, this step is delayed until the end of the
3791 process, leading to a different order when footnotes are nested."
3800 ;; Anonymous footnote match: return number.
3802 ;; Labels match: return number.
3804 ;; Otherwise store label and increase counter if label
3805 ;; wasn't encountered yet.
3811 ;;;; For Headlines
3812 ;;
3813 ;; `org-export-get-relative-level' is a shortcut to get headline
3814 ;; level, relatively to the lower headline level in the parsed tree.
3815 ;;
3816 ;; `org-export-get-headline-number' returns the section number of an
3817 ;; headline, while `org-export-number-to-roman' allows it to be
3818 ;; converted to roman numbers. With an optional argument,
3819 ;; `org-export-get-headline-number' returns a number to unnumbered
3820 ;; headlines (used for internal id).
3821 ;;
3822 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3823 ;; `org-export-last-sibling-p' are three useful predicates when it
3824 ;; comes to fulfill the `:headline-levels' property.
3825 ;;
3826 ;; `org-export-get-tags', `org-export-get-category' and
3827 ;; `org-export-get-node-property' extract useful information from an
3828 ;; headline or a parent headline. They all handle inheritance.
3829 ;;
3830 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3831 ;; as a secondary string, suitable for table of contents. It falls
3832 ;; back onto default title.
3835 "Return HEADLINE relative level within current parsed tree.
3836 INFO is a plist holding contextual information."
3841 "Non-nil when HEADLINE is considered as low level.
3843 INFO is a plist used as a communication channel.
3845 A low level headlines has a relative level greater than
3846 `:headline-levels' property value.
3848 Return value is the difference between HEADLINE relative level
3849 and the last level being considered as high enough, or nil."
3856 "Return numbered HEADLINE numbering as a list of numbers.
3857 INFO is a plist holding contextual information."
3862 "Return a non-nil value if HEADLINE element should be numbered.
3863 INFO is a plist used as a communication channel."
3872 "Convert integer N into a roman numeral."
3885 res)))
3888 "Return list of tags associated to ELEMENT.
3890 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3891 is a plist used as a communication channel.
3893 Select tags (see `org-export-select-tags') and exclude tags (see
3894 `org-export-exclude-tags') are removed from the list.
3896 When non-nil, optional argument TAGS should be a list of strings.
3897 Any tag belonging to this list will also be removed.
3899 When optional argument INHERITED is non-nil, tags can also be
3900 inherited from parent headlines and FILETAGS keywords."
3906 ;; Build complete list of inherited tags.
3913 ;; Add FILETAGS keywords and return results.
3917 "Return node PROPERTY value for BLOB.
3919 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3920 element or object.
3922 If optional argument INHERITED is non-nil, the value can be
3923 inherited from a parent headline.
3925 Return value is a string or nil."
3937 "Return category for element or object BLOB.
3939 INFO is a plist used as a communication channel.
3941 CATEGORY is automatically inherited from a parent headline, from
3942 #+CATEGORY: keyword or created out of original file name. If all
3955 "Return alternative title for HEADLINE, as a secondary string.
3956 INFO is a plist used as a communication channel. If no optional
3957 title is defined, fall-back to the regular title."
3964 "Non-nil when BLOB is the first sibling in its parent.
3965 BLOB is an element or an object. If BLOB is a headline, non-nil
3966 means it is the first sibling in the sub-tree. INFO is a plist
3967 used as a communication channel."
3972 "Non-nil when BLOB is the last sibling in its parent.
3973 BLOB is an element or an object. INFO is a plist used as
3974 a communication channel."
3978 ;;;; For Keywords
3979 ;;
3980 ;; `org-export-get-date' returns a date appropriate for the document
3981 ;; to about to be exported. In particular, it takes care of
3982 ;; `org-export-date-timestamp-format'.
3985 "Return date value for the current document.
3987 INFO is a plist used as a communication channel. FMT, when
3988 non-nil, is a time format string that will be applied on the date
3989 if it consists in a single timestamp object. It defaults to
3990 `org-export-date-timestamp-format' when nil.
3992 A proper date can be a secondary string, a string or nil. It is
3993 meant to be translated with `org-export-data' or alike."
4004 ;;;; For Links
4005 ;;
4006 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4007 ;; with `org-add-link-type', which see.
4008 ;;
4009 ;; `org-export-get-coderef-format' returns an appropriate format
4010 ;; string for coderefs.
4011 ;;
4012 ;; `org-export-inline-image-p' returns a non-nil value when the link
4013 ;; provided should be considered as an inline image.
4014 ;;
4015 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4016 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4017 ;; returns an appropriate unique identifier when found, or nil.
4018 ;;
4019 ;; `org-export-resolve-id-link' returns the first headline with
4020 ;; specified id or custom-id in parse tree, the path to the external
4021 ;; file with the id or nil when neither was found.
4022 ;;
4023 ;; `org-export-resolve-coderef' associates a reference to a line
4024 ;; number in the element it belongs, or returns the reference itself
4025 ;; when the element isn't numbered.
4026 ;;
4027 ;; `org-export-file-uri' expands a filename as stored in :path value
4028 ;; of a "file" link into a file URI.
4031 "Try exporting LINK with a dedicated function.
4033 DESC is its description, as a string, or nil. BACKEND is the
4034 back-end used for export, as a symbol.
4036 Return output as a string, or nil if no protocol handles LINK.
4038 A custom protocol has precedence over regular back-end export.
4039 The function ignores links with an implicit type (e.g.,
4048 desc
4049 backend))))))
4052 "Return format string for code reference link.
4053 PATH is the link path. DESC is its description."
4061 "Non-nil if LINK object points to an inline image.
4063 Optional argument is a set of RULES defining inline images. It
4064 is an alist where associations have the following shape:
4066 (TYPE . REGEXP)
4068 Applying a rule means apply REGEXP against LINK's path when its
4069 type is TYPE. The function will return a non-nil value if any of
4070 the provided rules is non-nil. The default rule is
4071 `org-export-default-inline-image-rule'.
4073 This only applies to links without a description."
4084 "Resolve a code reference REF.
4086 INFO is a plist used as a communication channel.
4088 Return associated line number in source code, or REF itself,
4089 depending on src-block or example element's switches. Throw an
4090 error if no block contains REF."
4097 org-coderef-label-format)))
4101 ;; Element containing REF is found. Resolve it to
4102 ;; either a label or a line number, as needed.
4113 "Return LINK destination.
4115 INFO is a plist holding contextual information.
4117 Return value can be an object or an element:
4119 - If LINK path matches a target object (i.e. <<path>>) return it.
4121 - If LINK path exactly matches the name affiliated keyword
4122 (i.e. #+NAME: path) of an element, return that element.
4124 - If LINK path exactly matches any headline name, return that
4125 element.
4127 - Otherwise, throw an error.
4130 significant."
4133 ;; Split PATH at white spaces so matches are space
4134 ;; insensitive.
4140 :resolve-fuzzy-link-cache
4147 path
4149 ;; First try to find a matching "<<path>>" unless user
4150 ;; specified he was looking for a headline (path starts with
4151 ;; a "*" character).
4157 path)
4158 datum))
4160 ;; Then try to find an element with a matching "#+NAME: path"
4161 ;; affiliated keyword.
4168 ;; Try to find a matching headline.
4175 path)
4176 h))
4179 link-cache)))))
4182 "Return headline referenced as LINK destination.
4184 INFO is a plist used as a communication channel.
4186 Return value can be the headline element matched in current parse
4190 ;; First check if id is within the current parse tree.
4195 headline))
4197 ;; Otherwise, look for external files.
4202 "Return radio-target object referenced as LINK destination.
4204 INFO is a plist used as a communication channel.
4206 Return value can be a radio-target object or nil. Assume LINK
4215 nil nil path nil nil t)
4216 t)
4217 radio))
4221 "Return file URI associated to FILENAME."
4228 ;;;; For References
4229 ;;
4230 ;; `org-export-get-reference' associate a unique reference for any
4231 ;; object or element.
4232 ;;
4233 ;; `org-export-get-ordinal' associates a sequence number to any object
4234 ;; or element.
4237 "Return a unique reference for DATUM, as a string.
4238 DATUM is either an element or an object. INFO is the current
4239 export state, as a plist. Returned reference consists of
4240 alphanumeric characters only."
4245 h))))
4253 cache))))
4256 "Return ordinal number of an element or object.
4258 ELEMENT is the element or object considered. INFO is the plist
4259 used as a communication channel.
4261 Optional argument TYPES, when non-nil, is a list of element or
4262 object types, as symbols, that should also be counted in.
4263 Otherwise, only provided element's type is considered.
4265 Optional argument PREDICATE is a function returning a non-nil
4266 value if the current element or object should be counted in. It
4267 accepts two arguments: the element or object being considered and
4268 the plist used as a communication channel. This allows counting
4269 only a certain type of object (i.e. inline images).
4271 Return value is a list of numbers if ELEMENT is a headline or an
4272 item. It is nil for keywords. It represents the footnote number
4273 for footnote definitions and footnote references. If ELEMENT is
4274 a target, return the same value as if ELEMENT was the closest
4275 table, item or headline containing the target. In any other
4276 case, return the sequence number of ELEMENT among elements or
4277 objects of the same type."
4278 ;; Ordinal of a target object refer to the ordinal of the closest
4279 ;; table, item, or headline containing the object.
4283 element
4286 ;; Special case 1: A headline returns its number as a list.
4288 ;; Special case 2: An item returns its number as a list.
4292 struct
4299 ;; Increment counter until ELEMENT is found again.
4310 ;;;; For Src-Blocks
4311 ;;
4312 ;; `org-export-get-loc' counts number of code lines accumulated in
4313 ;; src-block or example-block elements with a "+n" switch until
4314 ;; a given element, excluded. Note: "-n" switches reset that count.
4315 ;;
4316 ;; `org-export-unravel-code' extracts source code (along with a code
4317 ;; references alist) from an `element-block' or `src-block' type
4318 ;; element.
4319 ;;
4320 ;; `org-export-format-code' applies a formatting function to each line
4321 ;; of code, providing relative line number and code reference when
4322 ;; appropriate. Since it doesn't access the original element from
4323 ;; which the source code is coming, it expects from the code calling
4324 ;; it to know if lines should be numbered and if code references
4325 ;; should appear.
4326 ;;
4327 ;; Eventually, `org-export-format-code-default' is a higher-level
4328 ;; function (it makes use of the two previous functions) which handles
4329 ;; line numbering and code references inclusion, and returns source
4330 ;; code in a format suitable for plain text or verbatim output.
4333 "Return accumulated lines of code up to ELEMENT.
4335 INFO is the plist used as a communication channel.
4337 ELEMENT is excluded from count."
4343 ;; ELEMENT is reached: Quit the loop.
4345 ;; Only count lines from src-block and example-block elements
4346 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4350 ;; Accumulate locs or reset them.
4354 ;; Return nil to stay in the loop.
4355 nil)))
4357 ;; Return value.
4358 loc))
4361 "Clean source code and extract references out of it.
4363 ELEMENT has either a `src-block' an `example-block' type.
4365 Return a cons cell whose CAR is the source code, cleaned from any
4366 reference, protective commas and spurious indentation, and CDR is
4367 an alist between relative line number (integer) and name of code
4368 reference on that line (string)."
4371 ;; Get code and clean it. Remove blank lines at its
4372 ;; beginning and end.
4379 value
4381 ;; Get format used for references.
4384 org-coderef-label-format)))
4385 ;; Build a regexp matching a loc with a reference.
4390 ;; Return value.
4392 ;; Code with references removed.
4398 ;; Ref line: remove ref, and signal its position in REFS.
4402 ;; Reference alist.
4403 refs)))
4406 "Format CODE by applying FUN line-wise and return it.
4408 CODE is a string representing the code to format. FUN is
4409 a function. It must accept three arguments: a line of
4410 code (string), the current line number (integer) or nil and the
4411 reference associated to the current line (string) or nil.
4413 Optional argument NUM-LINES can be an integer representing the
4414 number of code lines accumulated until the current code. Line
4415 numbers passed to FUN will take it into account. If it is nil,
4416 FUN's second argument will always be nil. This number can be
4417 obtained with `org-export-get-loc' function.
4419 Optional argument REF-ALIST can be an alist between relative line
4420 number (i.e. ignoring NUM-LINES) and the name of the code
4421 reference on it. If it is nil, FUN's third argument will always
4422 be nil. It can be obtained through the use of
4423 `org-export-unravel-code' function."
4435 "Return source code from ELEMENT, formatted in a standard way.
4437 ELEMENT is either a `src-block' or `example-block' element. INFO
4438 is a plist used as a communication channel.
4440 This function takes care of line numbering and code references
4441 inclusion. Line numbers, when applicable, appear at the
4442 beginning of the line, separated from the code by two white
4443 spaces. Code references, on the other hand, appear flushed to
4444 the right, separated by six white spaces from the widest line of
4445 code."
4446 ;; Extract code and references.
4453 ;; Handle line numbering.
4462 ;; Prepare references display, if required. Any reference
4463 ;; should start six columns after the widest line of code,
4464 ;; wrapped with parenthesis.
4469 code
4473 number-str
4474 loc
4480 num-start refs)))))
4483 ;;;; For Tables
4484 ;;
4485 ;; `org-export-table-has-special-column-p' and and
4486 ;; `org-export-table-row-is-special-p' are predicates used to look for
4487 ;; meta-information about the table structure.
4488 ;;
4489 ;; `org-table-has-header-p' tells when the rows before the first rule
4490 ;; should be considered as table's header.
4491 ;;
4492 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4493 ;; and `org-export-table-cell-borders' extract information from
4494 ;; a table-cell element.
4495 ;;
4496 ;; `org-export-table-dimensions' gives the number on rows and columns
4497 ;; in the table, ignoring horizontal rules and special columns.
4498 ;; `org-export-table-cell-address', given a table-cell object, returns
4499 ;; the absolute address of a cell. On the other hand,
4500 ;; `org-export-get-table-cell-at' does the contrary.
4501 ;;
4502 ;; `org-export-table-cell-starts-colgroup-p',
4503 ;; `org-export-table-cell-ends-colgroup-p',
4504 ;; `org-export-table-row-starts-rowgroup-p',
4505 ;; `org-export-table-row-ends-rowgroup-p',
4506 ;; `org-export-table-row-starts-header-p',
4507 ;; `org-export-table-row-ends-header-p' and
4508 ;; `org-export-table-row-in-header-p' indicate position of current row
4509 ;; or cell within the table.
4512 "Non-nil when TABLE has a special column.
4513 All special columns will be ignored during export."
4514 ;; The table has a special column when every first cell of every row
4515 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4516 ;; "*" "_" and "^". Though, do not consider a first row containing
4517 ;; only empty cells as special.
4533 "Non-nil when TABLE has a header.
4535 INFO is a plist used as a communication channel.
4537 A table has a header when it contains at least two row groups."
4546 table
4557 cache)))))
4560 "Non-nil if TABLE-ROW is considered special.
4562 INFO is a plist used as the communication channel.
4564 All special rows will be ignored during export."
4568 ;; A row is special either when...
4570 ;; ... it starts with a field only containing "/",
4572 ;; ... the table contains a special column and the row start
4573 ;; with a marking character among, "^", "_", "$" or "!",
4577 ;; ... it contains only alignment cookies and empty cells.
4583 ;; Since VALUE is a secondary string, the following
4584 ;; checks avoid expanding it with `org-export-data'.
4596 "Return TABLE-ROW's group number, as an integer.
4598 INFO is a plist used as the communication channel.
4600 Return value is the group number, as an integer, or nil for
4601 special rows and rows separators. First group is also table's
4602 header."
4620 "Return TABLE-CELL contents width.
4622 INFO is a plist used as the communication channel.
4624 Return value is the width given by the last width cookie in the
4625 same column as TABLE-CELL, or nil."
4644 ;; In a special row, try to find a width cookie at COLUMN.
4648 ;; The following checks avoid expanding unnecessarily
4649 ;; the cell with `org-export-data'.
4659 "Return TABLE-CELL contents alignment.
4661 INFO is a plist used as the communication channel.
4663 Return alignment as specified by the last alignment cookie in the
4664 same column as TABLE-CELL. If no such cookie is found, a default
4665 alignment value will be deduced from fraction of numbers in the
4666 column (see `org-table-number-fraction' for more information).
4667 Possible values are `left', `right' and `center'."
4668 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4685 cookie-align
4686 previous-cell-number-p)
4689 ;; In a special row, try to find an alignment cookie at
4690 ;; COLUMN.
4694 ;; Since VALUE is a secondary string, the following
4695 ;; checks avoid useless expansion through
4696 ;; `org-export-data'.
4704 ;; Ignore table rules.
4706 ;; In a standard row, check if cell's contents are
4707 ;; expressing some kind of number. Increase NUMBER-CELLS
4708 ;; accordingly. Though, don't bother if an alignment
4709 ;; cookie has already defined cell's alignment.
4714 info)))
4716 ;; Treat an empty cell as a number if it follows
4717 ;; a number.
4723 ;; Return value. Alignment specified by cookies has
4724 ;; precedence over alignment deduced from cell's contents.
4726 column
4731 org-table-number-fraction)
4736 "Return TABLE-CELL borders.
4738 INFO is a plist used as a communication channel.
4740 Return value is a list of symbols, or nil. Possible values are:
4741 `top', `bottom', `above', `below', `left' and `right'. Note:
4742 `top' (resp. `bottom') only happen for a cell in the first
4743 row (resp. last row) of the table, ignoring table rules, if any.
4745 Returned borders ignore special rows."
4748 borders)
4749 ;; Top/above border? TABLE-CELL has a border above when a rule
4750 ;; used to demarcate row groups can be found above. Hence,
4751 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4752 ;; another regular row has to be found above that rule.
4761 ;; Look at every row before the current one.
4763 ;; No rule above, or rule found starts the table (ignoring any
4764 ;; special row): TABLE-CELL is at the top of the table.
4767 ;; Bottom/below border? TABLE-CELL has a border below when next
4768 ;; non-regular row below is a rule.
4777 ;; Look at every row after the current one.
4779 ;; No rule below, or rule found ends the table (modulo some
4780 ;; special row): TABLE-CELL is at the bottom of the table.
4783 ;; Right/left borders? They can only be specified by column
4784 ;; groups. Column groups are defined in a row starting with "/".
4785 ;; Also a column groups row only contains "<", "<>", ">" or blank
4786 ;; cells.
4803 ;; There's a left border when previous cell, if
4804 ;; any, ends a group, or current one starts one.
4810 ;; There's a right border when next cell, if any,
4811 ;; starts a group, or current one ends one.
4818 ;; Table rows are read in reverse order so last column groups
4819 ;; row has precedence over any previous one.
4821 ;; Return value.
4822 borders))
4825 "Non-nil when TABLE-CELL is at the beginning of a column group.
4826 INFO is a plist used as a communication channel."
4827 ;; A cell starts a column group either when it is at the beginning
4828 ;; of a row (or after the special column, if any) or when it has
4829 ;; a left border.
4832 table-cell)
4836 "Non-nil when TABLE-CELL is at the end of a column group.
4837 INFO is a plist used as a communication channel."
4838 ;; A cell ends a column group either when it is at the end of a row
4839 ;; or when it has a right border.
4842 table-cell)
4846 "Non-nil when TABLE-ROW is at the beginning of a row group.
4847 INFO is a plist used as a communication channel."
4855 "Non-nil when TABLE-ROW is at the end of a row group.
4856 INFO is a plist used as a communication channel."
4864 "Non-nil when TABLE-ROW is located within table's header.
4865 INFO is a plist used as a communication channel. Always return
4866 nil for special rows and rows separators."
4872 "Non-nil when TABLE-ROW is the first table header's row.
4873 INFO is a plist used as a communication channel."
4878 "Non-nil when TABLE-ROW is the last table header's row.
4879 INFO is a plist used as a communication channel."
4884 "Return TABLE-ROW number.
4885 INFO is a plist used as a communication channel. Return value is
4886 zero-based and ignores separators. The function returns nil for
4887 special columns and separators."
4899 "Return TABLE dimensions.
4901 INFO is a plist used as a communication channel.
4903 Return value is a CONS like (ROWS . COLUMNS) where
4904 ROWS (resp. COLUMNS) is the number of exportable
4905 rows (resp. columns)."
4907 ;; Set number of rows, and extract first one.
4913 ;; Set number of columns.
4915 ;; Return value.
4919 "Return address of a regular TABLE-CELL object.
4921 TABLE-CELL is the cell considered. INFO is a plist used as
4922 a communication channel.
4924 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4925 zero-based index. Only exportable cells are considered. The
4926 function returns nil for other cells."
4938 "Return regular table-cell object at ADDRESS in TABLE.
4940 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4941 zero-based index. TABLE is a table type element. INFO is
4942 a plist used as a communication channel.
4944 If no table-cell, among exportable cells, is found at ADDRESS,
4945 return nil."
4948 ;; Row at (car address) or nil.
4956 'table-cell
4963 ;;;; For Tables Of Contents
4964 ;;
4965 ;; `org-export-collect-headlines' builds a list of all exportable
4966 ;; headline elements, maybe limited to a certain depth. One can then
4967 ;; easily parse it and transcode it.
4968 ;;
4969 ;; Building lists of tables, figures or listings is quite similar.
4970 ;; Once the generic function `org-export-collect-elements' is defined,
4971 ;; `org-export-collect-tables', `org-export-collect-figures' and
4972 ;; `org-export-collect-listings' can be derived from it.
4975 "Collect headlines in order to build a table of contents.
4977 INFO is a plist used as a communication channel.
4979 When optional argument N is an integer, it specifies the depth of
4980 the table of contents. Otherwise, it is set to the value of the
4981 last headline level. See `org-export-headline-levels' for more
4982 information.
4984 Optional argument SCOPE, when non-nil, is an element. If it is
4985 a headline, only children of SCOPE are collected. Otherwise,
4986 collect children of the headline containing provided element. If
4987 there is no such headline, collect all headlines. In any case,
4988 argument N becomes relative to the level of that headline.
4990 Return a list of all exportable headlines as parsed elements.
4991 Footnote sections are ignored."
5000 limit))))
5006 info)))
5009 "Collect referenceable elements of a determined type.
5011 TYPE can be a symbol or a list of symbols specifying element
5012 types to search. Only elements with a caption are collected.
5014 INFO is a plist used as a communication channel.
5016 When non-nil, optional argument PREDICATE is a function accepting
5017 one argument, an element of type TYPE. It returns a non-nil
5018 value when that element should be collected.
5020 Return a list of all elements found, in order of appearance."
5025 element))
5026 info))
5029 "Build a list of tables.
5030 INFO is a plist used as a communication channel.
5032 Return a list of table elements with a caption."
5036 "Build a list of figures.
5038 INFO is a plist used as a communication channel. PREDICATE is
5039 a function which accepts one argument: a paragraph element and
5040 whose return value is non-nil when that element should be
5041 collected.
5043 A figure is a paragraph type element, with a caption, verifying
5045 a vague concept that may depend on back-end.
5047 Return a list of elements recognized as figures."
5051 "Build a list of src blocks.
5053 INFO is a plist used as a communication channel.
5055 Return a list of src-block elements with a caption."
5059 ;;;; Smart Quotes
5060 ;;
5061 ;; The main function for the smart quotes sub-system is
5062 ;; `org-export-activate-smart-quotes', which replaces every quote in
5063 ;; a given string from the parse tree with its "smart" counterpart.
5064 ;;
5065 ;; Dictionary for smart quotes is stored in
5066 ;; `org-export-smart-quotes-alist'.
5067 ;;
5068 ;; Internally, regexps matching potential smart quotes (checks at
5069 ;; string boundaries are also necessary) are defined in
5070 ;; `org-export-smart-quotes-regexps'.
5074 ;; one may use: »...«, "...", ›...‹, or '...'.
5075 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5076 ;; LaTeX quotes require Babel!
5126 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5137 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5148 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5159 ;; http://ru.wikipedia.org/wiki/%D0%9A%D0%B0%D0%B2%D1%8B%D1%87%D0%BA%D0%B8#.D0.9A.D0.B0.D0.B2.D1.8B.D1.87.D0.BA.D0.B8.2C_.D0.B8.D1.81.D0.BF.D0.BE.D0.BB.D1.8C.D0.B7.D1.83.D0.B5.D0.BC.D1.8B.D0.B5_.D0.B2_.D1.80.D1.83.D1.81.D1.81.D0.BA.D0.BE.D0.BC_.D1.8F.D0.B7.D1.8B.D0.BA.D0.B5
5160 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5171 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5177 "Smart quotes translations.
5179 Alist whose CAR is a language string and CDR is an alist with
5180 quote type as key and a plist associating various encodings to
5181 their translation as value.
5183 A quote type can be any symbol among `primary-opening',
5184 `primary-closing', `secondary-opening', `secondary-closing' and
5185 `apostrophe'.
5187 Valid encodings include `:utf-8', `:html', `:latex' and
5188 `:texinfo'.
5193 "Return smart quote status at the beginning of string S.
5194 INFO is the current export state, as a plist."
5199 table)))
5207 'plain-text
5216 ;; Not already in a level 1 quote: this is an
5217 ;; apostrophe.
5219 ;; Extract previous char and next char. As
5220 ;; a special case, they can also be set to `blank',
5221 ;; `no-blank' or nil. Then determine if current
5222 ;; match is allowed as an opening quote or a closing
5223 ;; quote.
5228 text info)))
5245 previous)
5256 next)
5263 current-status)
5267 info nil org-element-recursive-objects)
5274 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5275 `:utf-8'. INFO is a plist used as a communication channel.
5277 The function has to retrieve information about string
5278 surroundings in parse tree. It can only happen with an
5279 unmodified string. Thus, if S has already been through another
5280 process, a non-nil ORIGINAL optional argument will provide that
5281 original string.
5283 Return the new string."
5292 org-export-smart-quotes-alist))))
5293 encoding)
5294 match))
5295 s nil t)))
5297 ;;;; Topology
5298 ;;
5299 ;; Here are various functions to retrieve information about the
5300 ;; neighborhood of a given element or object. Neighbors of interest
5301 ;; are direct parent (`org-export-get-parent'), parent headline
5302 ;; (`org-export-get-parent-headline'), first element containing an
5303 ;; object, (`org-export-get-parent-element'), parent table
5304 ;; (`org-export-get-parent-table'), previous element or object
5305 ;; (`org-export-get-previous-element') and next element or object
5306 ;; (`org-export-get-next-element').
5308 ;; defsubst org-export-get-parent must be defined before first use
5314 "Return BLOB parent headline or nil.
5315 BLOB is the element or object being considered."
5319 "Return first element containing OBJECT or nil.
5320 OBJECT is the object to consider."
5324 "Return OBJECT parent table or nil.
5325 OBJECT is either a `table-cell' or `table-element' type object."
5329 "Return previous element or object.
5331 BLOB is an element or object. INFO is a plist used as
5332 a communication channel. Return previous exportable element or
5333 object, a string, or nil.
5335 When optional argument N is a positive integer, return a list
5336 containing up to N siblings before BLOB, from farthest to
5337 closest. With any other non-nil value, return a list containing
5338 all of them."
5344 prev)
5354 "Return next element or object.
5356 BLOB is an element or object. INFO is a plist used as
5357 a communication channel. Return next exportable element or
5358 object, a string, or nil.
5360 When optional argument N is a positive integer, return a list
5361 containing up to N siblings after BLOB, from closest to farthest.
5362 With any other non-nil value, return a list containing all of
5363 them."
5370 next)
5380 ;;;; Translation
5381 ;;
5382 ;; `org-export-translate' translates a string according to the language
5383 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5384 ;; the dictionary used for the translation.
5416 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5426 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5432 ("ru" :html "(Продолжение следует)"
5506 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5529 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5535 ("ru" :html "Список распечаток"
5549 ("ru" :html "Список таблиц"
5655 ("ru" :html "Неизвестная ссылка"
5658 "Dictionary for export engine.
5660 Alist whose car is the string to translate and cdr is an alist
5661 whose car is the language string and cdr is a plist whose
5662 properties are possible charsets and values translated terms.
5664 It is used as a database for `org-export-translate'. Since this
5665 function returns the string as-is if no translation was found,
5666 the variable only needs to record values different from the
5670 "Translate string S according to language specification.
5672 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5673 and `:utf-8'. INFO is a plist used as a communication channel.
5675 Translation depends on `:language' property. Return the
5676 translated string. If no translation is found, try to fall back
5677 to `:default' encoding. If it fails, return S."
5683 s)))
5686 \f
5687 ;;; Asynchronous Export
5688 ;;
5689 ;; `org-export-async-start' is the entry point for asynchronous
5690 ;; export. It recreates current buffer (including visibility,
5691 ;; narrowing and visited file) in an external Emacs process, and
5692 ;; evaluates a command there. It then applies a function on the
5693 ;; returned results in the current process.
5694 ;;
5695 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5696 ;; allow exporting to a buffer or a file, asynchronously or not.
5697 ;;
5698 ;; `org-export-output-file-name' is an auxiliary function meant to be
5699 ;; used with `org-export-to-file'. With a given extension, it tries
5700 ;; to provide a canonical file name to write export output to.
5701 ;;
5702 ;; Asynchronously generated results are never displayed directly.
5703 ;; Instead, they are stored in `org-export-stack-contents'. They can
5704 ;; then be retrieved by calling `org-export-stack'.
5705 ;;
5706 ;; Export Stack is viewed through a dedicated major mode
5707 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5708 ;;`org-export-stack-delete', `org-export-stack-view' and
5709 ;;`org-export-stack-clear'.
5710 ;;
5711 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5712 ;; It should be used whenever `org-export-async-start' is called.
5715 "Call function FUN on the results returned by BODY evaluation.
5717 FUN is an anonymous function of one argument. BODY evaluation
5718 happens in an asynchronous process, from a buffer which is an
5719 exact copy of the current one.
5721 Use `org-export-add-to-stack' in FUN in order to register results
5722 in the stack.
5724 This is a low level function. See also `org-export-to-buffer'
5725 and `org-export-to-file' for more specialized functions."
5728 ;; Write the full sexp evaluating BODY in a copy of the current
5729 ;; buffer to a temporary file, as it may be too long for program
5730 ;; args in `start-process'.
5737 ;; Null characters (from variable values) are inserted
5738 ;; within the file. As a consequence, coding system for
5739 ;; buffer contents will not be recognized properly. So,
5740 ;; we make sure it is the same as the one used to display
5741 ;; the original buffer.
5743 ,coding
5746 ;; Ignore `kill-emacs-hook' and code evaluation
5747 ;; queries from Babel as we need a truly
5748 ;; non-interactive process.
5750 org-babel-confirm-evaluate-answer-no t)
5751 ;; Initialize export framework.
5753 ;; Re-create current buffer there.
5756 ;; Sexp to evaluate in the buffer.
5758 ;; Start external process.
5761 (,process
5763 #'start-process
5766 ,proc-buffer
5773 ;; Register running process in stack.
5775 ;; Set-up sentinel in order to catch results.
5778 ,process
5800 ;;;###autoload
5803 &optional async subtreep visible-only body-only ext-plist
5804 post-process)
5805 "Call `org-export-as' with output to a specified buffer.
5807 BACKEND is either an export back-end, as returned by, e.g.,
5808 `org-export-create-backend', or a symbol referring to
5809 a registered back-end.
5811 BUFFER is the name of the output buffer. If it already exists,
5812 it will be erased first, otherwise, it will be created.
5814 A non-nil optional argument ASYNC means the process should happen
5815 asynchronously. The resulting buffer should then be accessible
5816 through the `org-export-stack' interface. When ASYNC is nil, the
5817 buffer is displayed if `org-export-show-temporary-export-buffer'
5818 is non-nil.
5820 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5821 EXT-PLIST are similar to those used in `org-export-as', which
5822 see.
5824 Optional argument POST-PROCESS is a function which should accept
5825 no argument. It is always called within the current process,
5826 from BUFFER, with point at its beginning. Export back-ends can
5827 use it to set a major mode there, e.g,
5829 (defun org-latex-export-as-latex
5830 (&optional async subtreep visible-only body-only ext-plist)
5831 (interactive)
5833 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5835 This function returns BUFFER."
5863 buffer)))
5865 ;;;###autoload
5868 post-process)
5869 "Call `org-export-as' with output to a specified file.
5871 BACKEND is either an export back-end, as returned by, e.g.,
5872 `org-export-create-backend', or a symbol referring to
5873 a registered back-end. FILE is the name of the output file, as
5874 a string.
5876 A non-nil optional argument ASYNC means the process should happen
5877 asynchronously. The resulting buffer will then be accessible
5878 through the `org-export-stack' interface.
5880 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5881 EXT-PLIST are similar to those used in `org-export-as', which
5882 see.
5884 Optional argument POST-PROCESS is called with FILE as its
5885 argument and happens asynchronously when ASYNC is non-nil. It
5886 has to return a file name, or nil. Export back-ends can use this
5887 to send the output file through additional processing, e.g,
5889 (defun org-latex-export-to-latex
5890 (&optional async subtreep visible-only body-only ext-plist)
5891 (interactive)
5894 async subtreep visible-only body-only ext-plist
5895 (lambda (file) (org-latex-compile file)))
5897 The function returns either a file name returned by POST-PROCESS,
5898 or FILE."
5917 backend subtreep visible-only body-only ext-plist)))
5924 ;; Get proper return value.
5926 file))))))
5929 "Return output file's name according to buffer specifications.
5931 EXTENSION is a string representing the output file extension,
5932 with the leading dot.
5934 With a non-nil optional argument SUBTREEP, try to determine
5936 of subtree at point.
5938 When optional argument PUB-DIR is set, use it as the publishing
5939 directory.
5941 Return file name as a string."
5944 ;; File name may come from EXPORT_FILE_NAME subtree
5945 ;; property, assuming point is at beginning of said
5946 ;; sub-tree.
5953 ;; File name may be extracted from buffer's associated
5954 ;; file, if any.
5956 ;; Can't determine file name on our own: Ask user.
5960 "Output file: " pub-dir nil nil nil
5964 ;; Build file name. Enforce EXTENSION over whatever user
5965 ;; may have come up with. PUB-DIR, if defined, always has
5966 ;; precedence over any provided path.
5971 extension))
5974 ;; If writing to OUTPUT-FILE would overwrite original file, append
5975 ;; EXTENSION another time to final name.
5978 output-file)))
5981 "Add a new result to export stack if not present already.
5983 SOURCE is a buffer or a file name containing export results.
5984 BACKEND is a symbol representing export back-end used to generate
5985 it.
5987 Entries already pointing to SOURCE and unavailable entries are
5988 removed beforehand. Return the new stack."
5994 "Menu for asynchronous export results and running processes."
6004 "Return source from export results at point in stack."
6011 source
6012 ;; SOURCE is not consistent with current line. The stack
6013 ;; view is outdated.
6017 "Remove all entries from export stack."
6022 "Refresh the asynchronous export stack.
6023 DUMMY is ignored. Unavailable sources are removed from the list.
6024 Return the new stack."
6034 ;; Back-end.
6036 ;; Age.
6039 ;; Compute age of the results.
6041 "%4h:%.2m "
6043 ;; Source.
6048 ;; Clear stack from exited processes, dead buffers or
6049 ;; non-existent files.
6061 "Remove export results at point from stack.
6062 If optional argument SOURCE is non-nil, remove it instead."
6067 org-export-stack-contents))))
6070 "View export results at point in stack.
6071 With an optional prefix argument IN-EMACS, force viewing files
6072 within Emacs."
6086 (define-key km "p" 'previous-line)
6087 (define-key km "\C-p" 'previous-line)
6088 (define-key km "\C-?" 'previous-line)
6089 (define-key km [up] 'previous-line)
6090 (define-key km "C" 'org-export-stack-clear)
6091 (define-key km "v" 'org-export-stack-view)
6092 (define-key km (kbd "RET") 'org-export-stack-view)
6093 (define-key km "d" 'org-export-stack-remove)
6094 km)
6095 "Keymap for Org Export Stack.")
6097 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6098 "Mode for displaying asynchronous export stack.
6101 stack.
6103 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6104 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6105 stack completely.
6107 Removing entries in an Org Export Stack buffer doesn't affect
6108 files or buffers, only the display.
6111 (abbrev-mode 0)
6112 (auto-fill-mode 0)
6113 (setq buffer-read-only t
6114 buffer-undo-list t
6115 truncate-lines t
6116 header-line-format
6117 '(:eval
6118 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6119 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6120 (set (make-local-variable 'revert-buffer-function)
6121 'org-export-stack-refresh))
6124 \f
6125 ;;; The Dispatcher
6126 ;;
6127 ;; `org-export-dispatch' is the standard interactive way to start an
6128 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6129 ;; for its interface, which, in turn, delegates response to key
6130 ;; pressed to `org-export--dispatch-action'.
6132 ;;;###autoload
6133 (defun org-export-dispatch (&optional arg)
6134 "Export dispatcher for Org mode.
6136 It provides an access to common export related tasks in a buffer.
6137 Its interface comes in two flavors: standard and expert.
6139 While both share the same set of bindings, only the former
6140 displays the valid keys associations in a dedicated buffer.
6141 Scrolling (resp. line-wise motion) in this buffer is done with
6142 SPC and DEL (resp. C-n and C-p) keys.
6144 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6145 flavor or the other.
6148 of options used back then, on the current buffer.
6150 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6151 (interactive "P")
6152 (let* ((input
6153 (cond ((equal arg '(16)) '(stack))
6154 ((and arg org-export-dispatch-last-action))
6155 (t (save-window-excursion
6156 (unwind-protect
6157 (progn
6158 ;; Remember where we are
6159 (move-marker org-export-dispatch-last-position
6160 (point)
6161 (org-base-buffer (current-buffer)))
6162 ;; Get and store an export command
6163 (setq org-export-dispatch-last-action
6164 (org-export--dispatch-ui
6165 (list org-export-initial-scope
6166 (and org-export-in-background 'async))
6167 nil
6168 org-export-dispatch-use-expert-ui)))
6169 (and (get-buffer "*Org Export Dispatcher*")
6170 (kill-buffer "*Org Export Dispatcher*")))))))
6171 (action (car input))
6172 (optns (cdr input)))
6173 (unless (memq 'subtree optns)
6174 (move-marker org-export-dispatch-last-position nil))
6175 (case action
6176 ;; First handle special hard-coded actions.
6177 (template (org-export-insert-default-template nil optns))
6178 (stack (org-export-stack))
6179 (publish-current-file
6180 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6181 (publish-current-project
6182 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6183 (publish-choose-project
6184 (org-publish (assoc (org-icompleting-read
6185 "Publish project: "
6186 org-publish-project-alist nil t)
6187 org-publish-project-alist)
6188 (memq 'force optns)
6189 (memq 'async optns)))
6190 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6191 (otherwise
6192 (save-excursion
6193 (when arg
6194 ;; Repeating command, maybe move cursor to restore subtree
6195 ;; context.
6196 (if (eq (marker-buffer org-export-dispatch-last-position)
6197 (org-base-buffer (current-buffer)))
6198 (goto-char org-export-dispatch-last-position)
6199 ;; We are in a different buffer, forget position.
6200 (move-marker org-export-dispatch-last-position nil)))
6201 (funcall action
6202 ;; Return a symbol instead of a list to ease
6203 ;; asynchronous export macro use.
6204 (and (memq 'async optns) t)
6205 (and (memq 'subtree optns) t)
6206 (and (memq 'visible optns) t)
6207 (and (memq 'body optns) t)))))))
6209 (defun org-export--dispatch-ui (options first-key expertp)
6210 "Handle interface for `org-export-dispatch'.
6212 OPTIONS is a list containing current interactive options set for
6213 export. It can contain any of the following symbols:
6214 `body' toggles a body-only export
6215 `subtree' restricts export to current subtree
6216 `visible' restricts export to visible part of buffer.
6217 `force' force publishing files.
6218 `async' use asynchronous export process
6220 FIRST-KEY is the key pressed to select the first level menu. It
6221 is nil when this menu hasn't been selected yet.
6223 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6224 buffer is provided, but indications about currently active
6225 options are given in the prompt. Moreover, [?] allows switching
6226 back to standard interface."
6227 (let* ((fontify-key
6228 (lambda (key &optional access-key)
6229 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6230 ;; non-nil is the required first-level key to activate
6231 ;; KEY. When its value is t, activate KEY independently
6232 ;; on the first key, if any. A nil value means KEY will
6233 ;; only be activated at first level.
6234 (if (or (eq access-key t) (eq access-key first-key))
6235 (org-propertize key 'face 'org-warning)
6236 key)))
6237 (fontify-value
6238 (lambda (value)
6239 ;; Fontify VALUE string.
6240 (org-propertize value 'face 'font-lock-variable-name-face)))
6241 ;; Prepare menu entries by extracting them from registered
6242 ;; back-ends and sorting them by access key and by ordinal,
6243 ;; if any.
6244 (entries
6245 (sort (sort (delq nil
6246 (mapcar #'org-export-backend-menu
6247 org-export-registered-backends))
6248 (lambda (a b)
6249 (let ((key-a (nth 1 a))
6250 (key-b (nth 1 b)))
6251 (cond ((and (numberp key-a) (numberp key-b))
6252 (< key-a key-b))
6253 ((numberp key-b) t)))))
6254 'car-less-than-car))
6255 ;; Compute a list of allowed keys based on the first key
6256 ;; pressed, if any. Some keys
6257 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6258 ;; available.
6259 (allowed-keys
6260 (nconc (list 2 22 19 6 1)
6261 (if (not first-key) (org-uniquify (mapcar 'car entries))
6262 (let (sub-menu)
6263 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6264 (when (eq (car entry) first-key)
6265 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6266 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6267 ((not first-key) (list ?P)))
6268 (list ?& ?#)
6269 (when expertp (list ??))
6270 (list ?q)))
6271 ;; Build the help menu for standard UI.
6272 (help
6273 (unless expertp
6274 (concat
6275 ;; Options are hard-coded.
6276 (format "[%s] Body only: %s [%s] Visible only: %s
6277 \[%s] Export scope: %s [%s] Force publishing: %s
6279 (funcall fontify-key "C-b" t)
6280 (funcall fontify-value
6281 (if (memq 'body options) "On " "Off"))
6282 (funcall fontify-key "C-v" t)
6283 (funcall fontify-value
6284 (if (memq 'visible options) "On " "Off"))
6285 (funcall fontify-key "C-s" t)
6286 (funcall fontify-value
6287 (if (memq 'subtree options) "Subtree" "Buffer "))
6288 (funcall fontify-key "C-f" t)
6289 (funcall fontify-value
6290 (if (memq 'force options) "On " "Off"))
6291 (funcall fontify-key "C-a" t)
6292 (funcall fontify-value
6293 (if (memq 'async options) "On " "Off")))
6294 ;; Display registered back-end entries. When a key
6295 ;; appears for the second time, do not create another
6296 ;; entry, but append its sub-menu to existing menu.
6297 (let (last-key)
6298 (mapconcat
6299 (lambda (entry)
6300 (let ((top-key (car entry)))
6301 (concat
6302 (unless (eq top-key last-key)
6303 (setq last-key top-key)
6305 (funcall fontify-key (char-to-string top-key))
6306 (nth 1 entry)))
6307 (let ((sub-menu (nth 2 entry)))
6308 (unless (functionp sub-menu)
6309 ;; Split sub-menu into two columns.
6310 (let ((index -1))
6311 (concat
6312 (mapconcat
6313 (lambda (sub-entry)
6314 (incf index)
6315 (format
6316 (if (zerop (mod index 2)) " [%s] %-26s"
6318 (funcall fontify-key
6319 (char-to-string (car sub-entry))
6320 top-key)
6321 (nth 1 sub-entry)))
6322 sub-menu "")
6324 entries ""))
6325 ;; Publishing menu is hard-coded.
6327 [%s] Current file [%s] Current project
6329 (funcall fontify-key "P")
6330 (funcall fontify-key "f" ?P)
6331 (funcall fontify-key "p" ?P)
6332 (funcall fontify-key "x" ?P)
6333 (funcall fontify-key "a" ?P))
6335 (funcall fontify-key "&" t)
6336 (funcall fontify-key "#" t))
6337 (format "[%s] %s"
6338 (funcall fontify-key "q" t)
6339 (if first-key "Main menu" "Exit")))))
6340 ;; Build prompts for both standard and expert UI.
6341 (standard-prompt (unless expertp "Export command: "))
6342 (expert-prompt
6343 (when expertp
6344 (format
6345 "Export command (C-%s%s%s%s%s) [%s]: "
6346 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6347 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6348 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6349 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6350 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6351 (mapconcat (lambda (k)
6352 ;; Strip control characters.
6353 (unless (< k 27) (char-to-string k)))
6354 allowed-keys "")))))
6355 ;; With expert UI, just read key with a fancy prompt. In standard
6356 ;; UI, display an intrusive help buffer.
6357 (if expertp
6358 (org-export--dispatch-action
6359 expert-prompt allowed-keys entries options first-key expertp)
6360 ;; At first call, create frame layout in order to display menu.
6361 (unless (get-buffer "*Org Export Dispatcher*")
6362 (delete-other-windows)
6363 (org-switch-to-buffer-other-window
6364 (get-buffer-create "*Org Export Dispatcher*"))
6365 (setq cursor-type nil
6366 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6367 ;; Make sure that invisible cursor will not highlight square
6368 ;; brackets.
6369 (set-syntax-table (copy-syntax-table))
6370 (modify-syntax-entry ?\[ "w"))
6371 ;; At this point, the buffer containing the menu exists and is
6372 ;; visible in the current window. So, refresh it.
6373 (with-current-buffer "*Org Export Dispatcher*"
6374 ;; Refresh help. Maintain display continuity by re-visiting
6375 ;; previous window position.
6376 (let ((pos (window-start)))
6377 (erase-buffer)
6378 (insert help)
6379 (set-window-start nil pos)))
6380 (org-fit-window-to-buffer)
6381 (org-export--dispatch-action
6382 standard-prompt allowed-keys entries options first-key expertp))))
6384 (defun org-export--dispatch-action
6385 (prompt allowed-keys entries options first-key expertp)
6386 "Read a character from command input and act accordingly.
6388 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6389 a list of characters available at a given step in the process.
6390 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6391 EXPERTP are the same as defined in `org-export--dispatch-ui',
6392 which see.
6394 Toggle export options when required. Otherwise, return value is
6395 a list with action as CAR and a list of interactive export
6396 options as CDR."
6397 (let (key)
6398 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6399 ;; C-p, SPC, DEL).
6400 (while (and (setq key (read-char-exclusive prompt))
6401 (not expertp)
6402 (memq key '(14 16 ?\s ?\d)))
6403 (case key
6404 (14 (if (not (pos-visible-in-window-p (point-max)))
6405 (ignore-errors (scroll-up 1))
6406 (message "End of buffer")
6407 (sit-for 1)))
6408 (16 (if (not (pos-visible-in-window-p (point-min)))
6409 (ignore-errors (scroll-down 1))
6410 (message "Beginning of buffer")
6411 (sit-for 1)))
6412 (?\s (if (not (pos-visible-in-window-p (point-max)))
6413 (scroll-up nil)
6414 (message "End of buffer")
6415 (sit-for 1)))
6416 (?\d (if (not (pos-visible-in-window-p (point-min)))
6417 (scroll-down nil)
6418 (message "Beginning of buffer")
6419 (sit-for 1)))))
6420 (cond
6421 ;; Ignore undefined associations.
6422 ((not (memq key allowed-keys))
6423 (ding)
6424 (unless expertp (message "Invalid key") (sit-for 1))
6425 (org-export--dispatch-ui options first-key expertp))
6426 ;; q key at first level aborts export. At second level, cancel
6427 ;; first key instead.
6428 ((eq key ?q) (if (not first-key) (error "Export aborted")
6429 (org-export--dispatch-ui options nil expertp)))
6430 ;; Help key: Switch back to standard interface if expert UI was
6431 ;; active.
6432 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6433 ;; Send request for template insertion along with export scope.
6434 ((eq key ?#) (cons 'template (memq 'subtree options)))
6435 ;; Switch to asynchronous export stack.
6436 ((eq key ?&) '(stack))
6437 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6438 ((memq key '(2 22 19 6 1))
6439 (org-export--dispatch-ui
6440 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6441 (6 'force) (1 'async))))
6442 (if (memq option options) (remq option options)
6443 (cons option options)))
6444 first-key expertp))
6445 ;; Action selected: Send key and options back to
6446 ;; `org-export-dispatch'.
6447 ((or first-key (functionp (nth 2 (assq key entries))))
6448 (cons (cond
6449 ((not first-key) (nth 2 (assq key entries)))
6450 ;; Publishing actions are hard-coded. Send a special
6451 ;; signal to `org-export-dispatch'.
6452 ((eq first-key ?P)
6453 (case key
6454 (?f 'publish-current-file)
6455 (?p 'publish-current-project)
6456 (?x 'publish-choose-project)
6457 (?a 'publish-all)))
6458 ;; Return first action associated to FIRST-KEY + KEY
6459 ;; path. Indeed, derived backends can share the same
6460 ;; FIRST-KEY.
6461 (t (catch 'found
6462 (mapc (lambda (entry)
6463 (let ((match (assq key (nth 2 entry))))
6464 (when match (throw 'found (nth 2 match)))))
6465 (member (assq first-key entries) entries)))))
6466 options))
6467 ;; Otherwise, enter sub-menu.
6468 (t (org-export--dispatch-ui options key expertp)))))
6472 (provide 'ox)
6474 ;; Local variables:
6475 ;; generated-autoload-file: "org-loaddefs.el"
6476 ;; End:
6478 ;;; ox.el ends here