| blob | 246ec8b3f06ae8c820a493084cc3588bd41970c0 |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2015 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 to provide 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 to switch 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:
1097 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
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:
1121 '(KEY DESCRIPTION ACTION)
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,
1142 '(?l 1
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:
1218 \(org-export-define-derived-backend 'my-latex 'latex
1219 :translate-alist '((template . my-latex-template-fun)))
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."
1345 ;; Priority is given to back-end specific options.
1347 org-export-options-alist)))
1349 plist)
1356 plist))
1359 "Get export options in subtree at point.
1360 Optional argument BACKEND is an export back-end, as returned by,
1361 e.g., `org-export-create-backend'. It specifies back-end used
1362 for export. Return options as a plist."
1363 ;; For each buffer keyword, create a headline property setting the
1364 ;; same property in communication channel. The name for the
1365 ;; property is the keyword with "EXPORT_" appended to it.
1367 ;; Make sure point is at a heading.
1370 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1371 ;; care of them right from the start.
1374 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1375 ;; headline's title (with no todo keyword, priority cookie or
1376 ;; tag) as its fallback value.
1382 ;; Look for both general keywords and back-end specific
1383 ;; options, with priority given to the latter.
1385 org-export-options-alist)))
1386 ;; Handle other keywords. Then return PLIST.
1399 property
1408 "Return current buffer export options, as a plist.
1410 Optional argument BACKEND, when non-nil, is an export back-end,
1411 as returned by, e.g., `org-export-create-backend'. It specifies
1412 which back-end specific options should also be read in the
1413 process.
1415 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1418 ;; Priority is given to back-end specific options.
1420 org-export-options-alist))
1423 org-export-special-keywords))))
1424 plist to-parse)
1427 ;; Return all properties associated to KEYWORD.
1434 ;; Recursively read keywords in buffer. FILES is
1435 ;; a list of files read so far. PLIST is the current
1436 ;; property list obtained.
1445 ;; Options in `org-export-special-keywords'.
1450 ;; Avoid circular dependencies.
1459 plist
1461 val backend))))
1465 plist
1472 ;; Options in `org-export-options-alist'.
1475 plist
1477 plist property
1478 ;; Handle value depending on specified
1479 ;; BEHAVIOR.
1484 ;; Even if `parse' implies `space'
1485 ;; behavior, we separate line with
1486 ;; "\n" so as to preserve
1487 ;; line-breaks. However, empty
1488 ;; lines are forbidden since `parse'
1489 ;; doesn't allow more than one
1490 ;; paragraph.
1499 " "
1512 ;; Read options in the current buffer and return value.
1514 ;; Parse properties in TO-PARSE. Remove newline characters not
1515 ;; involved in line breaks to simulate `space' behavior.
1516 ;; Finally return options.
1528 "Return properties related to buffer attributes, as a plist."
1533 "Return global export options as a plist.
1534 Optional argument BACKEND, if non-nil, is an export back-end, as
1535 returned by, e.g., `org-export-create-backend'. It specifies
1536 which back-end specific export options should also be read in the
1537 process."
1539 ;; Priority is given to back-end specific options.
1541 org-export-options-alist)))
1547 plist
1548 prop
1549 ;; Evaluate default value provided.
1554 value)))))))))
1557 "Return variables bound from BIND keywords in current buffer.
1558 Also look for BIND keywords in setup files. The return value is
1559 an alist where associations are (VARIABLE-NAME VALUE)."
1563 ;; Return an alist between variable names and their
1564 ;; value. FILES is a list of setup files names read
1565 ;; so far, used to avoid circular dependencies. ALIST
1566 ;; is the alist collected so far.
1578 ;; Enter setup file.
1588 alist))))))))))
1589 alist)))))
1590 ;; Return value in appropriate order of appearance.
1593 ;; defsubst org-export-get-parent must be defined before first use,
1594 ;; was originally defined in the topology section
1597 "Return BLOB parent or nil.
1598 BLOB is the element or object considered."
1601 ;;;; Tree Properties
1602 ;;
1603 ;; Tree properties are information extracted from parse tree. They
1604 ;; are initialized at the beginning of the transcoding process by
1605 ;; `org-export-collect-tree-properties'.
1606 ;;
1607 ;; Dedicated functions focus on computing the value of specific tree
1608 ;; properties during initialization. Thus,
1609 ;; `org-export--populate-ignore-list' lists elements and objects that
1610 ;; should be skipped during export, `org-export--get-min-level' gets
1611 ;; the minimal exportable level, used as a basis to compute relative
1612 ;; level for headlines. Eventually
1613 ;; `org-export--collect-headline-numbering' builds an alist between
1614 ;; headlines and their numbering.
1617 "Extract tree properties from parse tree.
1619 DATA is the parse tree from which information is retrieved. INFO
1620 is a list holding export options.
1622 Following tree properties are set or updated:
1624 `:exported-data' Hash table used to memoize results from
1625 `org-export-data'.
1627 `:headline-offset' Offset between true level of headlines and
1628 local level. An offset of -1 means a headline
1629 of level 2 should be considered as a level
1630 1 headline in the context.
1632 `:headline-numbering' Alist of all headlines as key an the
1633 associated numbering as value.
1635 Return updated plist."
1636 ;; Install the parse tree in the communication channel.
1638 ;; Compute `:headline-offset' in order to be able to use
1639 ;; `org-export-get-relative-level'.
1642 :headline-offset
1644 ;; Properties order doesn't matter: get the rest of the tree
1645 ;; properties.
1649 info))
1652 "Return minimum exportable headline's level in DATA.
1653 DATA is parsed tree as returned by `org-element-parse-buffer'.
1654 OPTIONS is a plist holding export options."
1665 ;; If no headline was found, for the sake of consistency, set
1666 ;; minimum level to 1 nonetheless.
1670 "Return numbering of all exportable, numbered headlines in a parse tree.
1672 DATA is the parse tree. OPTIONS is the plist holding export
1673 options.
1675 Return an alist whose key is a headline and value is its
1676 associated numbering \(in the shape of a list of numbers\) or nil
1677 for a footnotes section."
1686 headline
1688 for n across numbering
1689 for idx from 0 to org-export-max-depth
1693 options)))
1696 "List headlines and inlinetasks with a select tag in their tree.
1697 DATA is parsed data as returned by `org-element-parse-buffer'.
1698 INFO is a plist holding export options."
1708 ;; When a select tag is found, mark full
1709 ;; genealogy and every headline within the
1710 ;; tree as acceptable.
1713 genealogy
1716 selected-trees))
1717 ;; If at a headline, continue searching in tree,
1718 ;; recursively.
1727 selected-trees))
1730 "Non-nil when element or object BLOB should be skipped during export.
1731 OPTIONS is the plist holding export options. SELECTED, when
1732 non-nil, is a list of headlines or inlinetasks belonging to
1733 a tree with a select tag."
1740 ;; If `:with-drawers' value starts with `not', ignore
1741 ;; every drawer whose name belong to that list.
1742 ;; Otherwise, ignore drawers whose name isn't in that
1743 ;; list.
1760 ;; Ignore subtrees with an exclude tag.
1763 ;; When a select tag is present in the buffer, ignore any tree
1764 ;; without it.
1766 ;; Ignore commented sub-trees.
1768 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1770 ;; Ignore tasks, if specified by `:with-tasks' property.
1782 properties-set))))))
1793 ;; `:with-timestamps' only applies to isolated timestamps
1794 ;; objects, i.e. timestamp objects in a paragraph containing only
1795 ;; timestamps and whitespaces.
1803 options t))))
1812 \f
1813 ;;; The Transcoder
1814 ;;
1815 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1816 ;; `org-element-parse-buffer') and transcodes it into a specified
1817 ;; back-end output. It takes care of filtering out elements or
1818 ;; objects according to export options and organizing the output blank
1819 ;; lines and white space are preserved. The function memoizes its
1820 ;; results, so it is cheap to call it within transcoders.
1821 ;;
1822 ;; It is possible to modify locally the back-end used by
1823 ;; `org-export-data' or even use a temporary back-end by using
1824 ;; `org-export-data-with-backend'.
1825 ;;
1826 ;; `org-export-transcoder' is an accessor returning appropriate
1827 ;; translator function for a given element or object.
1830 "Return appropriate transcoder for BLOB.
1831 INFO is a plist containing export directives."
1833 ;; Return contents only for complete parse trees.
1839 "Convert DATA into current back-end format.
1841 DATA is a parse tree, an element or an object or a secondary
1842 string. INFO is a plist holding export options.
1844 Return a string."
1849 ;; Ignored element/object.
1851 ;; Plain text.
1857 info))
1858 ;; Secondary string.
1861 ;; Element/Object without contents or, as a special
1862 ;; case, headline with archive tag and archived trees
1863 ;; restricted to title only.
1871 ;; Export snippets never return a nil value so
1872 ;; that white spaces following them are never
1873 ;; ignored.
1875 ;; Element/Object with contents.
1888 ;; Elements directly containing
1889 ;; objects must have their indentation
1890 ;; normalized first.
1892 data
1893 ;; When normalizing contents of the
1894 ;; first paragraph in an item or
1895 ;; a footnote definition, ignore
1896 ;; first line's indentation: there is
1897 ;; none and it might be misleading.
1902 data)
1909 info))))))))
1910 ;; Final result will be memoized before being returned.
1912 data
1916 ;; Append the same white space between elements or objects
1917 ;; as in the original buffer, and call appropriate filters.
1928 info)))
1929 results)))
1933 "Convert DATA into BACKEND format.
1935 DATA is an element, an object, a secondary string or a string.
1936 BACKEND is a symbol. INFO is a plist used as a communication
1937 channel.
1939 Unlike to `org-export-with-backend', this function will
1940 recursively convert DATA using BACKEND translation table."
1943 data
1944 ;; Set-up a new communication channel with translations defined in
1945 ;; BACKEND as the translate table and a new hash table for
1946 ;; memoization.
1948 info
1951 ;; Size of the hash table is reduced since this function
1952 ;; will probably be used on small trees.
1956 "Expand a parsed element or object to its original state.
1958 BLOB is either an element or an object. CONTENTS is its
1959 contents, as a string or nil.
1961 When optional argument WITH-AFFILIATED is non-nil, add affiliated
1962 keywords before output."
1967 blob contents))))
1970 \f
1971 ;;; The Filter System
1972 ;;
1973 ;; Filters allow end-users to tweak easily the transcoded output.
1974 ;; They are the functional counterpart of hooks, as every filter in
1975 ;; a set is applied to the return value of the previous one.
1976 ;;
1977 ;; Every set is back-end agnostic. Although, a filter is always
1978 ;; called, in addition to the string it applies to, with the back-end
1979 ;; used as argument, so it's easy for the end-user to add back-end
1980 ;; specific filters in the set. The communication channel, as
1981 ;; a plist, is required as the third argument.
1982 ;;
1983 ;; From the developer side, filters sets can be installed in the
1984 ;; process with the help of `org-export-define-backend', which
1985 ;; internally stores filters as an alist. Each association has a key
1986 ;; among the following symbols and a function or a list of functions
1987 ;; as value.
1988 ;;
1989 ;; - `:filter-options' applies to the property list containing export
1990 ;; options. Unlike to other filters, functions in this list accept
1991 ;; two arguments instead of three: the property list containing
1992 ;; export options and the back-end. Users can set its value through
1993 ;; `org-export-filter-options-functions' variable.
1994 ;;
1995 ;; - `:filter-parse-tree' applies directly to the complete parsed
1996 ;; tree. Users can set it through
1997 ;; `org-export-filter-parse-tree-functions' variable.
1998 ;;
1999 ;; - `:filter-body' applies to the body of the output, before template
2000 ;; translator chimes in. Users can set it through
2001 ;; `org-export-filter-body-functions' variable.
2002 ;;
2003 ;; - `:filter-final-output' applies to the final transcoded string.
2004 ;; Users can set it with `org-export-filter-final-output-functions'
2005 ;; variable.
2006 ;;
2007 ;; - `:filter-plain-text' applies to any string not recognized as Org
2008 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2009 ;; configure it.
2010 ;;
2011 ;; - `:filter-TYPE' applies on the string returned after an element or
2012 ;; object of type TYPE has been transcoded. A user can modify
2013 ;; `org-export-filter-TYPE-functions' to install these filters.
2014 ;;
2015 ;; All filters sets are applied with
2016 ;; `org-export-filter-apply-functions' function. Filters in a set are
2017 ;; applied in a LIFO fashion. It allows developers to be sure that
2018 ;; their filters will be applied first.
2019 ;;
2020 ;; Filters properties are installed in communication channel with
2021 ;; `org-export-install-filters' function.
2022 ;;
2023 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2024 ;; `org-export-before-parsing-hook') are run at the beginning of the
2025 ;; export process and just before parsing to allow for heavy structure
2026 ;; modifications.
2029 ;;;; Hooks
2032 "Hook run at the beginning of the export process.
2034 This is run before include keywords and macros are expanded and
2035 Babel code blocks executed, on a copy of the original buffer
2036 being exported. Visibility and narrowing are preserved. Point
2037 is at the beginning of the buffer.
2039 Every function in this hook will be called with one argument: the
2043 "Hook run before parsing an export buffer.
2045 This is run after include keywords and macros have been expanded
2046 and 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 ;;;; Special Filters
2057 "List of functions applied to the export options.
2058 Each filter is called with two arguments: the export options, as
2059 a plist, and the back-end, as a symbol. It must return
2063 "List of functions applied to the parsed tree.
2064 Each filter is called with three arguments: the parse tree, as
2065 returned by `org-element-parse-buffer', the back-end, as
2066 a symbol, and the communication channel, as a plist. It must
2070 "List of functions applied to plain text.
2071 Each filter is called with three arguments: a string which
2072 contains no Org syntax, the back-end, as a symbol, and the
2073 communication channel, as a plist. It must return a string or
2077 "List of functions applied to transcoded body.
2078 Each filter is called with three arguments: a string which
2079 contains no Org syntax, the back-end, as a symbol, and the
2080 communication channel, as a plist. It must return a string or
2084 "List of functions applied to the transcoded string.
2085 Each filter is called with three arguments: the full transcoded
2086 string, the back-end, as a symbol, and the communication channel,
2087 as a plist. It must return a string that will be used as the
2091 ;;;; Elements Filters
2094 "List of functions applied to a transcoded babel-call.
2095 Each filter is called with three arguments: the transcoded data,
2096 as a string, the back-end, as a symbol, and the communication
2100 "List of functions applied to a transcoded center block.
2101 Each filter is called with three arguments: the transcoded data,
2102 as a string, the back-end, as a symbol, and the communication
2106 "List of functions applied to a transcoded clock.
2107 Each filter is called with three arguments: the transcoded data,
2108 as a string, the back-end, as a symbol, and the communication
2112 "List of functions applied to a transcoded diary-sexp.
2113 Each filter is called with three arguments: the transcoded data,
2114 as a string, the back-end, as a symbol, and the communication
2118 "List of functions applied to a transcoded drawer.
2119 Each filter is called with three arguments: the transcoded data,
2120 as a string, the back-end, as a symbol, and the communication
2124 "List of functions applied to a transcoded dynamic-block.
2125 Each filter is called with three arguments: the transcoded data,
2126 as a string, the back-end, as a symbol, and the communication
2130 "List of functions applied to a transcoded example-block.
2131 Each filter is called with three arguments: the transcoded data,
2132 as a string, the back-end, as a symbol, and the communication
2136 "List of functions applied to a transcoded export-block.
2137 Each filter is called with three arguments: the transcoded data,
2138 as a string, the back-end, as a symbol, and the communication
2142 "List of functions applied to a transcoded fixed-width.
2143 Each filter is called with three arguments: the transcoded data,
2144 as a string, the back-end, as a symbol, and the communication
2148 "List of functions applied to a transcoded footnote-definition.
2149 Each filter is called with three arguments: the transcoded data,
2150 as a string, the back-end, as a symbol, and the communication
2154 "List of functions applied to a transcoded headline.
2155 Each filter is called with three arguments: the transcoded data,
2156 as a string, the back-end, as a symbol, and the communication
2160 "List of functions applied to a transcoded horizontal-rule.
2161 Each filter is called with three arguments: the transcoded data,
2162 as a string, the back-end, as a symbol, and the communication
2166 "List of functions applied to a transcoded inlinetask.
2167 Each filter is called with three arguments: the transcoded data,
2168 as a string, the back-end, as a symbol, and the communication
2172 "List of functions applied to a transcoded item.
2173 Each filter is called with three arguments: the transcoded data,
2174 as a string, the back-end, as a symbol, and the communication
2178 "List of functions applied to a transcoded keyword.
2179 Each filter is called with three arguments: the transcoded data,
2180 as a string, the back-end, as a symbol, and the communication
2184 "List of functions applied to a transcoded latex-environment.
2185 Each filter is called with three arguments: the transcoded data,
2186 as a string, the back-end, as a symbol, and the communication
2190 "List of functions applied to a transcoded node-property.
2191 Each filter is called with three arguments: the transcoded data,
2192 as a string, the back-end, as a symbol, and the communication
2196 "List of functions applied to a transcoded paragraph.
2197 Each filter is called with three arguments: the transcoded data,
2198 as a string, the back-end, as a symbol, and the communication
2202 "List of functions applied to a transcoded plain-list.
2203 Each filter is called with three arguments: the transcoded data,
2204 as a string, the back-end, as a symbol, and the communication
2208 "List of functions applied to a transcoded planning.
2209 Each filter is called with three arguments: the transcoded data,
2210 as a string, the back-end, as a symbol, and the communication
2214 "List of functions applied to a transcoded property-drawer.
2215 Each filter is called with three arguments: the transcoded data,
2216 as a string, the back-end, as a symbol, and the communication
2220 "List of functions applied to a transcoded quote block.
2221 Each filter is called with three arguments: the transcoded quote
2222 data, as a string, the back-end, as a symbol, and the
2223 communication channel, as a plist. It must return a string or
2227 "List of functions applied to a transcoded section.
2228 Each filter is called with three arguments: the transcoded data,
2229 as a string, the back-end, as a symbol, and the communication
2233 "List of functions applied to a transcoded special block.
2234 Each filter is called with three arguments: the transcoded data,
2235 as a string, the back-end, as a symbol, and the communication
2239 "List of functions applied to a transcoded src-block.
2240 Each filter is called with three arguments: the transcoded data,
2241 as a string, the back-end, as a symbol, and the communication
2245 "List of functions applied to a transcoded table.
2246 Each filter is called with three arguments: the transcoded data,
2247 as a string, the back-end, as a symbol, and the communication
2251 "List of functions applied to a transcoded table-cell.
2252 Each filter is called with three arguments: the transcoded data,
2253 as a string, the back-end, as a symbol, and the communication
2257 "List of functions applied to a transcoded table-row.
2258 Each filter is called with three arguments: the transcoded data,
2259 as a string, the back-end, as a symbol, and the communication
2263 "List of functions applied to a transcoded verse block.
2264 Each filter is called with three arguments: the transcoded data,
2265 as a string, the back-end, as a symbol, and the communication
2269 ;;;; Objects Filters
2272 "List of functions applied to transcoded bold text.
2273 Each filter is called with three arguments: the transcoded data,
2274 as a string, the back-end, as a symbol, and the communication
2278 "List of functions applied to transcoded code text.
2279 Each filter is called with three arguments: the transcoded data,
2280 as a string, the back-end, as a symbol, and the communication
2284 "List of functions applied to a transcoded entity.
2285 Each filter is called with three arguments: the transcoded data,
2286 as a string, the back-end, as a symbol, and the communication
2290 "List of functions applied to a transcoded export-snippet.
2291 Each filter is called with three arguments: the transcoded data,
2292 as a string, the back-end, as a symbol, and the communication
2296 "List of functions applied to a transcoded footnote-reference.
2297 Each filter is called with three arguments: the transcoded data,
2298 as a string, the back-end, as a symbol, and the communication
2302 "List of functions applied to a transcoded inline-babel-call.
2303 Each filter is called with three arguments: the transcoded data,
2304 as a string, the back-end, as a symbol, and the communication
2308 "List of functions applied to a transcoded inline-src-block.
2309 Each filter is called with three arguments: the transcoded data,
2310 as a string, the back-end, as a symbol, and the communication
2314 "List of functions applied to transcoded italic text.
2315 Each filter is called with three arguments: the transcoded data,
2316 as a string, the back-end, as a symbol, and the communication
2320 "List of functions applied to a transcoded latex-fragment.
2321 Each filter is called with three arguments: the transcoded data,
2322 as a string, the back-end, as a symbol, and the communication
2326 "List of functions applied to a transcoded line-break.
2327 Each filter is called with three arguments: the transcoded data,
2328 as a string, the back-end, as a symbol, and the communication
2332 "List of functions applied to a transcoded link.
2333 Each filter is called with three arguments: the transcoded data,
2334 as a string, the back-end, as a symbol, and the communication
2338 "List of functions applied to a transcoded radio-target.
2339 Each filter is called with three arguments: the transcoded data,
2340 as a string, the back-end, as a symbol, and the communication
2344 "List of functions applied to a transcoded statistics-cookie.
2345 Each filter is called with three arguments: the transcoded data,
2346 as a string, the back-end, as a symbol, and the communication
2350 "List of functions applied to transcoded strike-through text.
2351 Each filter is called with three arguments: the transcoded data,
2352 as a string, the back-end, as a symbol, and the communication
2356 "List of functions applied to a transcoded subscript.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 "List of functions applied to a transcoded superscript.
2363 Each filter is called with three arguments: the transcoded data,
2364 as a string, the back-end, as a symbol, and the communication
2368 "List of functions applied to a transcoded target.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded timestamp.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 "List of functions applied to transcoded underline text.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to transcoded verbatim text.
2387 Each filter is called with three arguments: the transcoded data,
2388 as a string, the back-end, as a symbol, and the communication
2392 ;;;; Filters Tools
2393 ;;
2394 ;; Internal function `org-export-install-filters' installs filters
2395 ;; hard-coded in back-ends (developer filters) and filters from global
2396 ;; variables (user filters) in the communication channel.
2397 ;;
2398 ;; Internal function `org-export-filter-apply-functions' takes care
2399 ;; about applying each filter in order to a given data. It ignores
2400 ;; filters returning a nil value but stops whenever a filter returns
2401 ;; an empty string.
2404 "Call every function in FILTERS.
2406 Functions are called with arguments VALUE, current export
2407 back-end's name and INFO. A function returning a nil value will
2408 be skipped. If it returns the empty string, the process ends and
2409 VALUE is ignored.
2411 Call is done in a LIFO fashion, to be sure that developer
2412 specified filters, if any, are called first."
2423 "Install filters properties in communication channel.
2424 INFO is a plist containing the current communication channel.
2425 Return the updated communication channel."
2427 ;; Install user-defined filters with `org-export-filters-alist'
2428 ;; and filters already in INFO (through ext-plist mechanism).
2435 ;; Filters in INFO will be called
2436 ;; before those user provided.
2439 default-value)))))
2440 org-export-filters-alist)
2441 ;; Prepend back-end specific filters to that list.
2443 ;; Single values get consed, lists are appended.
2448 plist key
2452 ;; Return new communication channel.
2456 \f
2457 ;;; Core functions
2458 ;;
2459 ;; This is the room for the main function, `org-export-as', along with
2460 ;; its derivative, `org-export-string-as'.
2461 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2462 ;; function should be added to kill ring.
2463 ;;
2464 ;; Note that `org-export-as' doesn't really parse the current buffer,
2465 ;; but a copy of it (with the same buffer-local variables and
2466 ;; visibility), where macros and include keywords are expanded and
2467 ;; Babel blocks are executed, if appropriate.
2468 ;; `org-export-with-buffer-copy' macro prepares that copy.
2469 ;;
2470 ;; File inclusion is taken care of by
2471 ;; `org-export-expand-include-keyword' and
2472 ;; `org-export--prepare-file-contents'. Structure wise, including
2473 ;; a whole Org file in a buffer often makes little sense. For
2474 ;; example, if the file contains a headline and the include keyword
2475 ;; was within an item, the item should contain the headline. That's
2476 ;; why file inclusion should be done before any structure can be
2477 ;; associated to the file, that is before parsing.
2478 ;;
2479 ;; `org-export-insert-default-template' is a command to insert
2480 ;; a default template (or a back-end specific template) at point or in
2481 ;; current subtree.
2484 "Return a copy of the current buffer.
2485 The copy preserves Org buffer-local variables, visibility and
2486 narrowing."
2492 new-buf))
2495 "Apply BODY in a copy of the current buffer.
2496 The copy preserves local variables, visibility and contents of
2497 the original buffer. Point is at the beginning of the buffer
2498 when BODY is applied."
2507 ;; Kill copy without confirmation.
2513 "Generate a function duplicating BUFFER.
2515 The copy will preserve local variables, visibility, contents and
2516 narrowing of the original buffer. If a region was active in
2517 BUFFER, contents will be narrowed to that region instead.
2519 The resulting function can be evaluated at a later time, from
2520 another buffer, effectively cloning the original buffer there.
2522 The function assumes BUFFER's major mode is `org-mode'."
2526 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2527 ;; already in BUFFER.
2529 ;; Copy specific buffer local variables and variables set
2530 ;; through BIND keywords.
2532 vars)
2540 buffer-file-name
2541 buffer-file-coding-system))
2545 ;; Skip unreadable values, as they cannot be
2546 ;; sent to external process.
2550 vars))))))
2551 ;; Whole buffer contents.
2556 ;; Narrowing.
2560 ;; Current position of point.
2562 ;; Overlays with invisible property.
2572 ov-set))))
2574 ov-set)))))
2577 "Delete commented areas in the buffer.
2578 Commented areas are comments, comment blocks, commented trees and
2579 inlinetasks. Trailing blank lines after a comment or a comment
2580 block are preserved. Narrowing, if any, is ignored."
2601 "Prune non exportable elements from DATA.
2602 DATA is the parse tree to traverse. INFO is the plist holding
2603 export info. Also set `:ignore-list' in INFO to a list of
2604 objects which should be ignored during export, but not removed
2605 from tree."
2607 ;; First find trees containing a select tag, if any.
2611 ;; Prune non-exportable elements and objects from tree.
2612 ;; As a special case, special rows and cells from tables
2613 ;; are stored in IGNORE, as they still need to be
2614 ;; accessed during export.
2624 ;; If headline is archived but tree below has
2625 ;; to be skipped, remove contents.
2627 ;; Move into secondary string, if any.
2630 org-element-secondary-value-alist))))
2634 ;; Move into recursive objects/elements.
2636 ;; If a select tag is active, also ignore the section before the
2637 ;; first headline, if any.
2642 ;; Prune tree and communication channel.
2646 ;; Priority is given to back-end specific options.
2648 org-export-options-alist))
2651 ;; Eventually set `:ignore-list'.
2655 "Change uninterpreted elements back into Org syntax.
2656 DATA is the parse tree. INFO is a plist containing export
2657 options. Each uninterpreted element or object is changed back
2658 into a string. Contents, if any, are not modified. The parse
2659 tree is modified by side effect."
2665 p
2668 info))))))
2671 "Change uninterpreted elements back into Org syntax.
2672 DATA is a parse tree or a secondary string. INFO is a plist
2673 containing export options. It is modified by side effect and
2674 returned by the function."
2677 subscript superscript underline)
2681 ;; ... entities...
2688 ?\s)))))
2689 ;; ... emphasis...
2701 marker
2705 ?\s)))))))
2706 ;; ... LaTeX environments and fragments...
2710 ;; ... sub/superscripts...
2719 "_"
2728 ?\s)))))))))))
2730 ;; Splice NEW at BLOB location in parse tree.
2733 info)
2734 ;; Return modified parse tree.
2735 data)
2738 "Insert footnote definitions outside parsing scope in TREE.
2740 If there is a footnote section in TREE, definitions found are
2741 appended to it. If `org-footnote-section' is non-nil, a new
2742 footnote section containing all definitions is inserted in TREE.
2743 Otherwise, definitions are appended at the end of the section
2744 containing their first reference.
2746 Only definitions actually referred to within TREE, directly or
2747 not, are considered."
2766 definitions))
2774 'footnote-definition
2780 definitions))))))))
2781 ;; Collect all out of scope definitions.
2791 ;; Filter out definitions referenced neither in the original
2792 ;; tree nor in the external definitions.
2797 definitions))
2800 referenced-labels)))
2805 definitions)))
2806 ;; Install definitions in subtree.
2809 ;; If there is a footnote section, insert them here.
2814 nil t)))
2817 ;; If there should be a footnote section, create one containing
2818 ;; all the definitions at the end of the tree.
2821 tree
2827 'section
2828 nil
2830 ;; Otherwise add each definition at the end of the section where
2831 ;; it is first referenced.
2836 ;; Insert definitions in the same section as
2837 ;; their first reference in DATA.
2849 d)
2850 label)
2857 definition)
2859 definition)))))))))))
2862 ;;;###autoload
2865 "Transcode current Org buffer into BACKEND code.
2867 BACKEND is either an export back-end, as returned by, e.g.,
2868 `org-export-create-backend', or a symbol referring to
2869 a registered back-end.
2871 If narrowing is active in the current buffer, only transcode its
2872 narrowed part.
2874 If a region is active, transcode that region.
2876 When optional argument SUBTREEP is non-nil, transcode the
2877 sub-tree at point, extracting information from the headline
2878 properties first.
2880 When optional argument VISIBLE-ONLY is non-nil, don't export
2881 contents of hidden elements.
2883 When optional argument BODY-ONLY is non-nil, only return body
2884 code, without surrounding template.
2886 Optional argument EXT-PLIST, when provided, is a property list
2887 with external parameters overriding Org default settings, but
2888 still inferior to file-local settings.
2890 Return code as a string."
2895 ;; Narrow buffer to an appropriate region or subtree for
2896 ;; parsing. If parsing subtree, be sure to remove main headline
2897 ;; too.
2905 ;; Initialize communication channel with original buffer
2906 ;; attributes, unavailable in its copy.
2919 org-export-options-alist))))
2920 tree)
2921 ;; Update communication channel and get parse tree. Buffer
2922 ;; isn't parsed directly. Instead, all buffer modifications
2923 ;; and consequent parsing are undertaken in a temporary copy.
2925 ;; Run first hook with current back-end's name as argument.
2928 ;; Include files, delete comments and expand macros.
2933 ;; Refresh buffer properties and radio targets after
2934 ;; potentially invasive previous changes. Likewise, do it
2935 ;; again after executing Babel code.
2941 ;; Run last hook with current back-end's name as argument.
2942 ;; Update buffer properties and radio targets one last time
2943 ;; before parsing.
2950 ;; Update communication channel with environment. Also
2951 ;; install user's and developer's filters.
2956 ;; Call options filters and update export options. We do not
2957 ;; use `org-export-filter-apply-functions' here since the
2958 ;; arity of such filters is different.
2963 ;; Expand export-specific set of macros: {{{author}}},
2964 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2965 ;; be done once regular macros have been expanded, since
2966 ;; parsed keywords may contain one of them.
2979 value)
2980 value)))
2984 'finalize
2985 parsed-keywords)
2986 ;; Parse buffer.
2988 ;; Merge footnote definitions outside scope into parse tree.
2990 ;; Prune tree from non-exported elements and transform
2991 ;; uninterpreted elements or objects in both parse tree and
2992 ;; communication channel.
2995 ;; Call parse tree filters.
2999 ;; Now tree is complete, compute its properties and add them
3000 ;; to communication channel.
3004 ;; Eventually transcode TREE. Wrap the resulting string into
3005 ;; a template.
3014 info))
3017 ;; Remove all text properties since they cannot be
3018 ;; retrieved from an external process. Finally call
3019 ;; final-output filter and return result.
3025 info))))))))
3027 ;;;###autoload
3029 "Transcode STRING into BACKEND code.
3031 BACKEND is either an export back-end, as returned by, e.g.,
3032 `org-export-create-backend', or a symbol referring to
3033 a registered back-end.
3035 When optional argument BODY-ONLY is non-nil, only return body
3036 code, without preamble nor postamble.
3038 Optional argument EXT-PLIST, when provided, is a property list
3039 with external parameters overriding Org default settings, but
3040 still inferior to file-local settings.
3042 Return code as a string."
3048 ;;;###autoload
3050 "Replace the active region by its export to BACKEND.
3051 BACKEND is either an export back-end, as returned by, e.g.,
3052 `org-export-create-backend', or a symbol referring to
3053 a registered back-end."
3059 ;;;###autoload
3061 "Insert all export keywords with default values at beginning of line.
3063 BACKEND is a symbol referring to the name of a registered export
3064 back-end, for which specific export options should be added to
3065 the template, or `default' for default template. When it is nil,
3066 the user will be prompted for a category.
3068 If SUBTREEP is non-nil, export configuration will be set up
3069 locally for the subtree through node properties."
3079 "Options category: "
3083 org-export-registered-backends))
3084 nil t))))
3085 options keywords)
3086 ;; Populate OPTIONS and KEYWORDS.
3103 ;; Move to an appropriate location in order to insert options.
3105 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3123 ;; Then the rest of keywords, in the order specified in either
3124 ;; `org-export-options-alist' or respective export back-ends.
3145 "Expand every include keyword in buffer.
3146 Optional argument INCLUDED is a list of included file names along
3147 with their line restriction, when appropriate. It is used to
3148 avoid infinite recursion. Optional argument DIR is the current
3149 working directory. It is used to properly resolve relative
3150 paths. Optional argument FOOTNOTES is a hash-table used for
3151 storing and resolving footnotes. It is created automatically."
3157 ;; If :minlevel is not set the text-property
3158 ;; `:org-include-induced-level' will be used to determine the
3159 ;; relative level when expanding INCLUDE.
3160 ;; Only affects included Org documents.
3164 :org-include-induced-level
3166 ;; Expand INCLUDE keywords.
3172 ;; Extract arguments from keyword's value.
3175 location
3183 matched)
3189 matched)
3190 dir)))
3194 value)
3200 value)
3207 ;; Minimal level of included file defaults to the child
3208 ;; level of the current headline, if any, or one. It
3209 ;; only applies is the file is meant to be included as
3210 ;; an Org one.
3222 ;; Remove keyword.
3228 ;; Check if files has already been parsed. Look after
3229 ;; inclusion lines too, as different parts of the same file
3230 ;; can be included too.
3245 ind-str block arg-str contents ind-str block))))
3252 ind-str block contents ind-str block))))
3260 file location only-contents lines)
3261 lines)))
3265 file lines ind minlevel
3268 footnotes)))
3272 footnotes)
3274 ;; Expand footnotes after all files have been included.
3275 ;; Footnotes are stored at end of buffer.
3280 footnotes)))))))))))
3283 "Resolve absolute lines for an included file with file-link.
3285 FILE is string file-name of the file to include. LOCATION is a
3286 string name within FILE to be included (located via
3287 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3288 contents of the named element will be included, as determined
3289 Org-Element. If LINES is non-nil only those lines are included.
3291 Return a string of lines to be included in the format expected by
3292 `org-export--prepare-file-contents'."
3298 ;; Enforce consistent search.
3311 ;; Skip planning line and property-drawer.
3337 start-line
3339 (+ start-line
3342 counter))))))))
3345 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3347 REF-BEGIN corresponds to the property `:begin' of objects of type
3348 footnote-definition and footnote-reference.
3350 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3351 \[N] where N is one or more numbers.
3353 Return the new label."
3364 "Prepare contents of FILE for inclusion and return it as a string.
3366 When optional argument LINES is a string specifying a range of
3367 lines, include only those lines.
3369 Optional argument IND, when non-nil, is an integer specifying the
3370 global indentation of returned contents. Since its purpose is to
3371 allow an included file to stay in the same environment it was
3372 created \(i.e. a list item), it doesn't apply past the first
3373 headline encountered.
3375 Optional argument MINLEVEL, when non-nil, is an integer
3376 specifying the level that any top-level headline in the included
3377 file should have.
3378 Optional argument ID is an integer that will be inserted before
3379 each footnote definition and reference if FILE is an Org file.
3380 This is useful to avoid conflicts when more than one Org file
3381 with footnotes is included in a document.
3383 Optional argument FOOTNOTES is a hash-table to store footnotes in
3384 the included document.
3385 "
3401 ;; Remove blank lines at beginning and end of contents. The logic
3402 ;; behind that removal is that blank lines around include keyword
3403 ;; override blank lines in included file.
3412 ;; If IND is set, preserve indentation of include keyword until
3413 ;; the first headline encountered.
3420 ;; Do not move footnote definitions out of column 0.
3426 ;; When MINLEVEL is specified, compute minimal level for headlines
3427 ;; in the file (CUR-MIN), and remove stars to each headline so
3428 ;; that headlines with minimal level have a level of MINLEVEL.
3439 ;; Only change stars, don't bother moving whole
3440 ;; sections.
3444 ;; Append ID to all footnote references and definitions, so they
3445 ;; become file specific and cannot collide with footnotes in other
3446 ;; included files. Further, collect relevant footnotes outside of
3447 ;; LINES.
3458 ;; Update the footnote-reference at point and collect
3459 ;; the new label, which is only used for footnotes
3460 ;; outsides LINES.
3462 ;; If label is akin to [1] convert it to [fn:ID-1].
3463 ;; Otherwise add "ID-" after "fn:".
3466 digit-label id)))
3473 "Definition not found for footnote %s in file %s"
3474 label file))
3477 ;; Store since footnote-definition is
3478 ;; outside of LINES.
3482 footnotes)
3483 ;; Update label of definition since it is
3484 ;; included directly.
3486 beginning digit-label id)))))))))))
3492 "Execute every Babel code in the visible part of current buffer."
3493 ;; Get a pristine copy of current buffer so Babel references can be
3494 ;; properly resolved.
3500 "Return a non-nil value when output should be added to the kill ring.
3501 See also `org-export-copy-to-kill-ring'."
3507 \f
3508 ;;; Tools For Back-Ends
3509 ;;
3510 ;; A whole set of tools is available to help build new exporters. Any
3511 ;; function general enough to have its use across many back-ends
3512 ;; should be added here.
3514 ;;;; For Affiliated Keywords
3515 ;;
3516 ;; `org-export-read-attribute' reads a property from a given element
3517 ;; as a plist. It can be used to normalize affiliated keywords'
3518 ;; syntax.
3519 ;;
3520 ;; Since captions can span over multiple lines and accept dual values,
3521 ;; their internal representation is a bit tricky. Therefore,
3522 ;; `org-export-get-caption' transparently returns a given element's
3523 ;; caption as a secondary string.
3526 "Turn ATTRIBUTE property from ELEMENT into a plist.
3528 When optional argument PROPERTY is non-nil, return the value of
3529 that property within attributes.
3533 properties.
3535 All values will become strings except the empty string and
3538 will become the empty string."
3552 s)
3557 ;; Ignore any string before first property with `cdr'.
3562 "Return caption from ELEMENT as a secondary string.
3564 When optional argument SHORTP is non-nil, return short caption,
3565 as a secondary string, instead.
3567 Caption lines are separated by a white space."
3575 ;;;; For Derived Back-ends
3576 ;;
3577 ;; `org-export-with-backend' is a function allowing to locally use
3578 ;; another back-end to transcode some object or element. In a derived
3579 ;; back-end, it may be used as a fall-back function once all specific
3580 ;; cases have been treated.
3583 "Call a transcoder from BACKEND on DATA.
3584 BACKEND is an export back-end, as returned by, e.g.,
3585 `org-export-create-backend', or a symbol referring to
3586 a registered back-end. DATA is an Org element, object, secondary
3587 string or string. CONTENTS, when non-nil, is the transcoded
3588 contents of DATA element, as a string. INFO, when non-nil, is
3589 the communication channel used for export, as a plist."
3599 transcoder data contents
3602 :back-end backend
3603 :translate-alist all-transcoders
3607 ;;;; For Export Snippets
3608 ;;
3609 ;; Every export snippet is transmitted to the back-end. Though, the
3610 ;; latter will only retain one type of export-snippet, ignoring
3611 ;; others, based on the former's target back-end. The function
3612 ;; `org-export-snippet-backend' returns that back-end for a given
3613 ;; export-snippet.
3616 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3617 Translation, with `org-export-snippet-translation-alist', is
3618 applied."
3622 back-end))))
3625 ;;;; For Footnotes
3626 ;;
3627 ;; `org-export-collect-footnote-definitions' is a tool to list
3628 ;; actually used footnotes definitions in the whole parse tree, or in
3629 ;; a headline, in order to add footnote listings throughout the
3630 ;; transcoded data.
3631 ;;
3632 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3633 ;; back-ends, when they need to attach the footnote definition only to
3634 ;; the first occurrence of the corresponding label.
3635 ;;
3636 ;; `org-export-get-footnote-definition' and
3637 ;; `org-export-get-footnote-number' provide easier access to
3638 ;; additional information relative to a footnote reference.
3641 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3642 INFO is the plist used as a communication channel. If no such
3643 definition can be found, raise an error."
3649 hash))))
3657 info t)
3658 cache)
3663 "Apply FUNCTION on every footnote reference in DATA.
3664 INFO is a plist containing export state. By default, as soon as
3665 a new footnote reference is encountered, FUNCTION is called onto
3666 its definition. However, if BODY-FIRST is non-nil, this step is
3667 delayed until the end of the process."
3672 ;; Search footnote references through DATA, filling
3673 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3674 ;; store footnote definitions so they can be entered
3675 ;; later.
3682 ;; Search for subsequent references in footnote
3683 ;; definition so numbering follows reading
3684 ;; logic, unless DELAYP in non-nil.
3688 definitions))
3689 ;; Do not force entering inline definitions,
3690 ;; since `org-element-map' already traverses
3691 ;; them at the right time.
3695 nil))))))
3696 info nil
3697 ;; Don't enter footnote definitions since it will
3698 ;; happen when their first reference is found.
3699 ;; Moreover, if DELAYP is non-nil, make sure we
3700 ;; postpone entering definitions of inline references.
3707 "Return an alist between footnote numbers, labels and definitions.
3709 INFO is the current export state, as a plist.
3711 Definitions are collected throughout the whole parse tree, or
3712 DATA when non-nil.
3714 Sorting is done by order of references. As soon as a new
3715 reference is encountered, other references are searched within
3716 its definition. However, if BODY-FIRST is non-nil, this step is
3717 delayed after the whole tree is checked. This alters results
3718 when references are found in footnote definitions.
3720 Definitions either appear as Org data or as a secondary string
3721 for inlined footnotes. Unreferenced definitions are ignored."
3725 ;; Collect footnote number, label and definition.
3736 "Non-nil when a footnote reference is the first one for its label.
3738 FOOTNOTE-REFERENCE is the footnote reference being considered.
3739 INFO is a plist containing current export state.
3741 Search is done throughout the whole parse tree, or DATA when
3742 non-nil.
3744 By default, as soon as a new footnote reference is encountered,
3745 other references are searched within its definition. However, if
3746 BODY-FIRST is non-nil, this step is delayed after the whole tree
3747 is checked. This alters results when references are found in
3748 footnote definitions."
3750 ;; Anonymous footnotes are always a first reference.
3761 "Return number associated to a footnote.
3763 FOOTNOTE is either a footnote reference or a footnote definition.
3764 INFO is the plist containing export state.
3766 Number is unique throughout the whole parse tree, or DATA, when
3767 non-nil.
3769 By default, as soon as a new footnote reference is encountered,
3770 counting process moves into its definition. However, if
3771 BODY-FIRST is non-nil, this step is delayed until the end of the
3772 process, leading to a different order when footnotes are nested."
3781 ;; Anonymous footnote match: return number.
3783 ;; Labels match: return number.
3785 ;; Otherwise store label and increase counter if label
3786 ;; wasn't encountered yet.
3792 ;;;; For Headlines
3793 ;;
3794 ;; `org-export-get-relative-level' is a shortcut to get headline
3795 ;; level, relatively to the lower headline level in the parsed tree.
3796 ;;
3797 ;; `org-export-get-headline-number' returns the section number of an
3798 ;; headline, while `org-export-number-to-roman' allows to convert it
3799 ;; to roman numbers. With an optional argument,
3800 ;; `org-export-get-headline-number' returns a number to unnumbered
3801 ;; headlines (used for internal id).
3802 ;;
3803 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3804 ;; `org-export-last-sibling-p' are three useful predicates when it
3805 ;; comes to fulfill the `:headline-levels' property.
3806 ;;
3807 ;; `org-export-get-tags', `org-export-get-category' and
3808 ;; `org-export-get-node-property' extract useful information from an
3809 ;; headline or a parent headline. They all handle inheritance.
3810 ;;
3811 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3812 ;; as a secondary string, suitable for table of contents. It falls
3813 ;; back onto default title.
3816 "Return HEADLINE relative level within current parsed tree.
3817 INFO is a plist holding contextual information."
3822 "Non-nil when HEADLINE is considered as low level.
3824 INFO is a plist used as a communication channel.
3826 A low level headlines has a relative level greater than
3827 `:headline-levels' property value.
3829 Return value is the difference between HEADLINE relative level
3830 and the last level being considered as high enough, or nil."
3837 "Return numbered HEADLINE numbering as a list of numbers.
3838 INFO is a plist holding contextual information."
3843 "Return a non-nil value if HEADLINE element should be numbered.
3844 INFO is a plist used as a communication channel."
3853 "Convert integer N into a roman numeral."
3866 res)))
3869 "Return list of tags associated to ELEMENT.
3871 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3872 is a plist used as a communication channel.
3874 Select tags (see `org-export-select-tags') and exclude tags (see
3875 `org-export-exclude-tags') are removed from the list.
3877 When non-nil, optional argument TAGS should be a list of strings.
3878 Any tag belonging to this list will also be removed.
3880 When optional argument INHERITED is non-nil, tags can also be
3881 inherited from parent headlines and FILETAGS keywords."
3887 ;; Build complete list of inherited tags.
3894 ;; Add FILETAGS keywords and return results.
3898 "Return node PROPERTY value for BLOB.
3900 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3901 element or object.
3903 If optional argument INHERITED is non-nil, the value can be
3904 inherited from a parent headline.
3906 Return value is a string or nil."
3918 "Return category for element or object BLOB.
3920 INFO is a plist used as a communication channel.
3922 CATEGORY is automatically inherited from a parent headline, from
3923 #+CATEGORY: keyword or created out of original file name. If all
3936 "Return alternative title for HEADLINE, as a secondary string.
3937 If no optional title is defined, fall-back to the regular title."
3944 "Non-nil when BLOB is the first sibling in its parent.
3945 BLOB is an element or an object. If BLOB is a headline, non-nil
3946 means it is the first sibling in the sub-tree. INFO is a plist
3947 used as a communication channel."
3952 "Non-nil when BLOB is the last sibling in its parent.
3953 BLOB is an element or an object. INFO is a plist used as
3954 a communication channel."
3958 ;;;; For Keywords
3959 ;;
3960 ;; `org-export-get-date' returns a date appropriate for the document
3961 ;; to about to be exported. In particular, it takes care of
3962 ;; `org-export-date-timestamp-format'.
3965 "Return date value for the current document.
3967 INFO is a plist used as a communication channel. FMT, when
3968 non-nil, is a time format string that will be applied on the date
3969 if it consists in a single timestamp object. It defaults to
3970 `org-export-date-timestamp-format' when nil.
3972 A proper date can be a secondary string, a string or nil. It is
3973 meant to be translated with `org-export-data' or alike."
3984 ;;;; For Links
3985 ;;
3986 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3987 ;; with `org-add-link-type', which see.
3988 ;;
3989 ;; `org-export-get-coderef-format' returns an appropriate format
3990 ;; string for coderefs.
3991 ;;
3992 ;; `org-export-inline-image-p' returns a non-nil value when the link
3993 ;; provided should be considered as an inline image.
3994 ;;
3995 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3996 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3997 ;; returns an appropriate unique identifier when found, or nil.
3998 ;;
3999 ;; `org-export-resolve-id-link' returns the first headline with
4000 ;; specified id or custom-id in parse tree, the path to the external
4001 ;; file with the id or nil when neither was found.
4002 ;;
4003 ;; `org-export-resolve-coderef' associates a reference to a line
4004 ;; number in the element it belongs, or returns the reference itself
4005 ;; when the element isn't numbered.
4006 ;;
4007 ;; `org-export-file-uri' expands a filename as stored in :path value
4008 ;; of a "file" link into a file URI.
4011 "Try exporting LINK with a dedicated function.
4013 DESC is its description, as a string, or nil. BACKEND is the
4014 back-end used for export, as a symbol.
4016 Return output as a string, or nil if no protocol handles LINK.
4018 A custom protocol has precedence over regular back-end export.
4019 The function ignores links with an implicit type (e.g.,
4028 desc
4029 backend))))))
4032 "Return format string for code reference link.
4033 PATH is the link path. DESC is its description."
4041 "Non-nil if LINK object points to an inline image.
4043 Optional argument is a set of RULES defining inline images. It
4044 is an alist where associations have the following shape:
4046 \(TYPE . REGEXP)
4048 Applying a rule means apply REGEXP against LINK's path when its
4049 type is TYPE. The function will return a non-nil value if any of
4050 the provided rules is non-nil. The default rule is
4051 `org-export-default-inline-image-rule'.
4053 This only applies to links without a description."
4064 "Resolve a code reference REF.
4066 INFO is a plist used as a communication channel.
4068 Return associated line number in source code, or REF itself,
4069 depending on src-block or example element's switches. Throw an
4070 error if no block contains REF."
4077 org-coderef-label-format)))
4081 ;; Element containing REF is found. Resolve it to
4082 ;; either a label or a line number, as needed.
4093 "Return LINK destination.
4095 INFO is a plist holding contextual information.
4097 Return value can be an object, an element, or nil:
4099 - If LINK path matches a target object (i.e. <<path>>) return it.
4101 - If LINK path exactly matches the name affiliated keyword
4102 \(i.e. #+NAME: path) of an element, return that element.
4104 - If LINK path exactly matches any headline name, return that
4105 element.
4107 - Otherwise, throw an error.
4110 significant."
4113 ;; Split PATH at white spaces so matches are space
4114 ;; insensitive.
4120 :resolve-fuzzy-link-cache
4127 path
4129 ;; First try to find a matching "<<path>>" unless user
4130 ;; specified he was looking for a headline (path starts with
4131 ;; a "*" character).
4137 path)
4138 datum))
4140 ;; Then try to find an element with a matching "#+NAME: path"
4141 ;; affiliated keyword.
4148 ;; Try to find a matching headline.
4155 path)
4156 h))
4159 link-cache)))))
4162 "Return headline referenced as LINK destination.
4164 INFO is a plist used as a communication channel.
4166 Return value can be the headline element matched in current parse
4170 ;; First check if id is within the current parse tree.
4175 headline))
4177 ;; Otherwise, look for external files.
4182 "Return radio-target object referenced as LINK destination.
4184 INFO is a plist used as a communication channel.
4186 Return value can be a radio-target object or nil. Assume LINK
4195 nil nil path nil nil t)
4196 t)
4197 radio))
4201 "Return file URI associated to FILENAME."
4207 filename))))
4210 ;;;; For References
4211 ;;
4212 ;; `org-export-get-reference' associate a unique reference for any
4213 ;; object or element.
4214 ;;
4215 ;; `org-export-get-ordinal' associates a sequence number to any object
4216 ;; or element.
4219 "Return a unique reference for DATUM, as a string.
4220 DATUM is either an element or an object. INFO is the current
4221 export state, as a plist. Returned reference consists of
4222 alphanumeric characters only."
4227 h))))
4235 cache))))
4238 "Return ordinal number of an element or object.
4240 ELEMENT is the element or object considered. INFO is the plist
4241 used as a communication channel.
4243 Optional argument TYPES, when non-nil, is a list of element or
4244 object types, as symbols, that should also be counted in.
4245 Otherwise, only provided element's type is considered.
4247 Optional argument PREDICATE is a function returning a non-nil
4248 value if the current element or object should be counted in. It
4249 accepts two arguments: the element or object being considered and
4250 the plist used as a communication channel. This allows to count
4251 only a certain type of objects (i.e. inline images).
4253 Return value is a list of numbers if ELEMENT is a headline or an
4254 item. It is nil for keywords. It represents the footnote number
4255 for footnote definitions and footnote references. If ELEMENT is
4256 a target, return the same value as if ELEMENT was the closest
4257 table, item or headline containing the target. In any other
4258 case, return the sequence number of ELEMENT among elements or
4259 objects of the same type."
4260 ;; Ordinal of a target object refer to the ordinal of the closest
4261 ;; table, item, or headline containing the object.
4265 element
4268 ;; Special case 1: A headline returns its number as a list.
4270 ;; Special case 2: An item returns its number as a list.
4274 struct
4281 ;; Increment counter until ELEMENT is found again.
4292 ;;;; For Src-Blocks
4293 ;;
4294 ;; `org-export-get-loc' counts number of code lines accumulated in
4295 ;; src-block or example-block elements with a "+n" switch until
4296 ;; a given element, excluded. Note: "-n" switches reset that count.
4297 ;;
4298 ;; `org-export-unravel-code' extracts source code (along with a code
4299 ;; references alist) from an `element-block' or `src-block' type
4300 ;; element.
4301 ;;
4302 ;; `org-export-format-code' applies a formatting function to each line
4303 ;; of code, providing relative line number and code reference when
4304 ;; appropriate. Since it doesn't access the original element from
4305 ;; which the source code is coming, it expects from the code calling
4306 ;; it to know if lines should be numbered and if code references
4307 ;; should appear.
4308 ;;
4309 ;; Eventually, `org-export-format-code-default' is a higher-level
4310 ;; function (it makes use of the two previous functions) which handles
4311 ;; line numbering and code references inclusion, and returns source
4312 ;; code in a format suitable for plain text or verbatim output.
4315 "Return accumulated lines of code up to ELEMENT.
4317 INFO is the plist used as a communication channel.
4319 ELEMENT is excluded from count."
4325 ;; ELEMENT is reached: Quit the loop.
4327 ;; Only count lines from src-block and example-block elements
4328 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4332 ;; Accumulate locs or reset them.
4336 ;; Return nil to stay in the loop.
4337 nil)))
4339 ;; Return value.
4340 loc))
4343 "Clean source code and extract references out of it.
4345 ELEMENT has either a `src-block' an `example-block' type.
4347 Return a cons cell whose CAR is the source code, cleaned from any
4348 reference, protective commas and spurious indentation, and CDR is
4349 an alist between relative line number (integer) and name of code
4350 reference on that line (string)."
4353 ;; Get code and clean it. Remove blank lines at its
4354 ;; beginning and end.
4361 value
4363 ;; Get format used for references.
4366 org-coderef-label-format)))
4367 ;; Build a regexp matching a loc with a reference.
4372 ;; Return value.
4374 ;; Code with references removed.
4380 ;; Ref line: remove ref, and signal its position in REFS.
4384 ;; Reference alist.
4385 refs)))
4388 "Format CODE by applying FUN line-wise and return it.
4390 CODE is a string representing the code to format. FUN is
4391 a function. It must accept three arguments: a line of
4392 code (string), the current line number (integer) or nil and the
4393 reference associated to the current line (string) or nil.
4395 Optional argument NUM-LINES can be an integer representing the
4396 number of code lines accumulated until the current code. Line
4397 numbers passed to FUN will take it into account. If it is nil,
4398 FUN's second argument will always be nil. This number can be
4399 obtained with `org-export-get-loc' function.
4401 Optional argument REF-ALIST can be an alist between relative line
4402 number (i.e. ignoring NUM-LINES) and the name of the code
4403 reference on it. If it is nil, FUN's third argument will always
4404 be nil. It can be obtained through the use of
4405 `org-export-unravel-code' function."
4417 "Return source code from ELEMENT, formatted in a standard way.
4419 ELEMENT is either a `src-block' or `example-block' element. INFO
4420 is a plist used as a communication channel.
4422 This function takes care of line numbering and code references
4423 inclusion. Line numbers, when applicable, appear at the
4424 beginning of the line, separated from the code by two white
4425 spaces. Code references, on the other hand, appear flushed to
4426 the right, separated by six white spaces from the widest line of
4427 code."
4428 ;; Extract code and references.
4435 ;; Handle line numbering.
4444 ;; Prepare references display, if required. Any reference
4445 ;; should start six columns after the widest line of code,
4446 ;; wrapped with parenthesis.
4451 code
4455 number-str
4456 loc
4462 num-start refs)))))
4465 ;;;; For Tables
4466 ;;
4467 ;; `org-export-table-has-special-column-p' and and
4468 ;; `org-export-table-row-is-special-p' are predicates used to look for
4469 ;; meta-information about the table structure.
4470 ;;
4471 ;; `org-table-has-header-p' tells when the rows before the first rule
4472 ;; should be considered as table's header.
4473 ;;
4474 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4475 ;; and `org-export-table-cell-borders' extract information from
4476 ;; a table-cell element.
4477 ;;
4478 ;; `org-export-table-dimensions' gives the number on rows and columns
4479 ;; in the table, ignoring horizontal rules and special columns.
4480 ;; `org-export-table-cell-address', given a table-cell object, returns
4481 ;; the absolute address of a cell. On the other hand,
4482 ;; `org-export-get-table-cell-at' does the contrary.
4483 ;;
4484 ;; `org-export-table-cell-starts-colgroup-p',
4485 ;; `org-export-table-cell-ends-colgroup-p',
4486 ;; `org-export-table-row-starts-rowgroup-p',
4487 ;; `org-export-table-row-ends-rowgroup-p',
4488 ;; `org-export-table-row-starts-header-p',
4489 ;; `org-export-table-row-ends-header-p' and
4490 ;; `org-export-table-row-in-header-p' indicate position of current row
4491 ;; or cell within the table.
4494 "Non-nil when TABLE has a special column.
4495 All special columns will be ignored during export."
4496 ;; The table has a special column when every first cell of every row
4497 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4498 ;; "*" "_" and "^". Though, do not consider a first row containing
4499 ;; only empty cells as special.
4515 "Non-nil when TABLE has a header.
4517 INFO is a plist used as a communication channel.
4519 A table has a header when it contains at least two row groups."
4528 table
4539 cache)))))
4542 "Non-nil if TABLE-ROW is considered special.
4543 All special rows will be ignored during export."
4547 ;; A row is special either when...
4549 ;; ... it starts with a field only containing "/",
4551 ;; ... the table contains a special column and the row start
4552 ;; with a marking character among, "^", "_", "$" or "!",
4556 ;; ... it contains only alignment cookies and empty cells.
4562 ;; Since VALUE is a secondary string, the following
4563 ;; checks avoid expanding it with `org-export-data'.
4575 "Return TABLE-ROW's group number, as an integer.
4577 INFO is a plist used as the communication channel.
4579 Return value is the group number, as an integer, or nil for
4580 special rows and rows separators. First group is also table's
4581 header."
4599 "Return TABLE-CELL contents width.
4601 INFO is a plist used as the communication channel.
4603 Return value is the width given by the last width cookie in the
4604 same column as TABLE-CELL, or nil."
4623 ;; In a special row, try to find a width cookie at COLUMN.
4627 ;; The following checks avoid expanding unnecessarily
4628 ;; the cell with `org-export-data'.
4638 "Return TABLE-CELL contents alignment.
4640 INFO is a plist used as the communication channel.
4642 Return alignment as specified by the last alignment cookie in the
4643 same column as TABLE-CELL. If no such cookie is found, a default
4644 alignment value will be deduced from fraction of numbers in the
4645 column (see `org-table-number-fraction' for more information).
4646 Possible values are `left', `right' and `center'."
4647 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4664 cookie-align
4665 previous-cell-number-p)
4668 ;; In a special row, try to find an alignment cookie at
4669 ;; COLUMN.
4673 ;; Since VALUE is a secondary string, the following
4674 ;; checks avoid useless expansion through
4675 ;; `org-export-data'.
4683 ;; Ignore table rules.
4685 ;; In a standard row, check if cell's contents are
4686 ;; expressing some kind of number. Increase NUMBER-CELLS
4687 ;; accordingly. Though, don't bother if an alignment
4688 ;; cookie has already defined cell's alignment.
4693 info)))
4695 ;; Treat an empty cell as a number if it follows
4696 ;; a number.
4702 ;; Return value. Alignment specified by cookies has
4703 ;; precedence over alignment deduced from cell's contents.
4705 column
4710 org-table-number-fraction)
4715 "Return TABLE-CELL borders.
4717 INFO is a plist used as a communication channel.
4719 Return value is a list of symbols, or nil. Possible values are:
4720 `top', `bottom', `above', `below', `left' and `right'. Note:
4721 `top' (resp. `bottom') only happen for a cell in the first
4722 row (resp. last row) of the table, ignoring table rules, if any.
4724 Returned borders ignore special rows."
4727 borders)
4728 ;; Top/above border? TABLE-CELL has a border above when a rule
4729 ;; used to demarcate row groups can be found above. Hence,
4730 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4731 ;; another regular row has to be found above that rule.
4740 ;; Look at every row before the current one.
4742 ;; No rule above, or rule found starts the table (ignoring any
4743 ;; special row): TABLE-CELL is at the top of the table.
4746 ;; Bottom/below border? TABLE-CELL has a border below when next
4747 ;; non-regular row below is a rule.
4756 ;; Look at every row after the current one.
4758 ;; No rule below, or rule found ends the table (modulo some
4759 ;; special row): TABLE-CELL is at the bottom of the table.
4762 ;; Right/left borders? They can only be specified by column
4763 ;; groups. Column groups are defined in a row starting with "/".
4764 ;; Also a column groups row only contains "<", "<>", ">" or blank
4765 ;; cells.
4782 ;; There's a left border when previous cell, if
4783 ;; any, ends a group, or current one starts one.
4789 ;; There's a right border when next cell, if any,
4790 ;; starts a group, or current one ends one.
4797 ;; Table rows are read in reverse order so last column groups
4798 ;; row has precedence over any previous one.
4800 ;; Return value.
4801 borders))
4804 "Non-nil when TABLE-CELL is at the beginning of a column group.
4805 INFO is a plist used as a communication channel."
4806 ;; A cell starts a column group either when it is at the beginning
4807 ;; of a row (or after the special column, if any) or when it has
4808 ;; a left border.
4811 table-cell)
4815 "Non-nil when TABLE-CELL is at the end of a column group.
4816 INFO is a plist used as a communication channel."
4817 ;; A cell ends a column group either when it is at the end of a row
4818 ;; or when it has a right border.
4821 table-cell)
4825 "Non-nil when TABLE-ROW is at the beginning of a row group.
4826 INFO is a plist used as a communication channel."
4834 "Non-nil when TABLE-ROW is at the end of a row group.
4835 INFO is a plist used as a communication channel."
4843 "Non-nil when TABLE-ROW is located within table's header.
4844 INFO is a plist used as a communication channel. Always return
4845 nil for special rows and rows separators."
4851 "Non-nil when TABLE-ROW is the first table header's row.
4852 INFO is a plist used as a communication channel."
4857 "Non-nil when TABLE-ROW is the last table header's row.
4858 INFO is a plist used as a communication channel."
4863 "Return TABLE-ROW number.
4864 INFO is a plist used as a communication channel. Return value is
4865 zero-based and ignores separators. The function returns nil for
4866 special columns and separators."
4878 "Return TABLE dimensions.
4880 INFO is a plist used as a communication channel.
4882 Return value is a CONS like (ROWS . COLUMNS) where
4883 ROWS (resp. COLUMNS) is the number of exportable
4884 rows (resp. columns)."
4886 ;; Set number of rows, and extract first one.
4892 ;; Set number of columns.
4894 ;; Return value.
4898 "Return address of a regular TABLE-CELL object.
4900 TABLE-CELL is the cell considered. INFO is a plist used as
4901 a communication channel.
4903 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4904 zero-based index. Only exportable cells are considered. The
4905 function returns nil for other cells."
4917 "Return regular table-cell object at ADDRESS in TABLE.
4919 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4920 zero-based index. TABLE is a table type element. INFO is
4921 a plist used as a communication channel.
4923 If no table-cell, among exportable cells, is found at ADDRESS,
4924 return nil."
4927 ;; Row at (car address) or nil.
4935 'table-cell
4942 ;;;; For Tables Of Contents
4943 ;;
4944 ;; `org-export-collect-headlines' builds a list of all exportable
4945 ;; headline elements, maybe limited to a certain depth. One can then
4946 ;; easily parse it and transcode it.
4947 ;;
4948 ;; Building lists of tables, figures or listings is quite similar.
4949 ;; Once the generic function `org-export-collect-elements' is defined,
4950 ;; `org-export-collect-tables', `org-export-collect-figures' and
4951 ;; `org-export-collect-listings' can be derived from it.
4954 "Collect headlines in order to build a table of contents.
4956 INFO is a plist used as a communication channel.
4958 When optional argument N is an integer, it specifies the depth of
4959 the table of contents. Otherwise, it is set to the value of the
4960 last headline level. See `org-export-headline-levels' for more
4961 information.
4963 Optional argument SCOPE, when non-nil, is an element. If it is
4964 a headline, only children of SCOPE are collected. Otherwise,
4965 collect children of the headline containing provided element. If
4966 there is no such headline, collect all headlines. In any case,
4967 argument N becomes relative to the level of that headline.
4969 Return a list of all exportable headlines as parsed elements.
4970 Footnote sections are ignored."
4979 limit))))
4985 info)))
4988 "Collect referenceable elements of a determined type.
4990 TYPE can be a symbol or a list of symbols specifying element
4991 types to search. Only elements with a caption are collected.
4993 INFO is a plist used as a communication channel.
4995 When non-nil, optional argument PREDICATE is a function accepting
4996 one argument, an element of type TYPE. It returns a non-nil
4997 value when that element should be collected.
4999 Return a list of all elements found, in order of appearance."
5004 element))
5005 info))
5008 "Build a list of tables.
5009 INFO is a plist used as a communication channel.
5011 Return a list of table elements with a caption."
5015 "Build a list of figures.
5017 INFO is a plist used as a communication channel. PREDICATE is
5018 a function which accepts one argument: a paragraph element and
5019 whose return value is non-nil when that element should be
5020 collected.
5022 A figure is a paragraph type element, with a caption, verifying
5024 a vague concept that may depend on back-end.
5026 Return a list of elements recognized as figures."
5030 "Build a list of src blocks.
5032 INFO is a plist used as a communication channel.
5034 Return a list of src-block elements with a caption."
5038 ;;;; Smart Quotes
5039 ;;
5040 ;; The main function for the smart quotes sub-system is
5041 ;; `org-export-activate-smart-quotes', which replaces every quote in
5042 ;; a given string from the parse tree with its "smart" counterpart.
5043 ;;
5044 ;; Dictionary for smart quotes is stored in
5045 ;; `org-export-smart-quotes-alist'.
5049 ;; one may use: »...«, "...", ›...‹, or '...'.
5050 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5051 ;; LaTeX quotes require Babel!
5096 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5105 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5114 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5123 ;; 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
5124 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5135 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5141 )
5142 "Smart quotes translations.
5144 Alist whose CAR is a language string and CDR is an alist with
5145 quote type as key and a plist associating various encodings to
5146 their translation as value.
5148 A quote type can be any symbol among `opening-double-quote',
5149 `closing-double-quote', `opening-single-quote',
5150 `closing-single-quote' and `apostrophe'.
5152 Valid encodings include `:utf-8', `:html', `:latex' and
5153 `:texinfo'.
5158 "Return smart quote status at the beginning of string S.
5159 INFO is the current export state, as a plist."
5164 table)))
5179 ;; Not already in a level 1 quote: this is an
5180 ;; apostrophe.
5182 ;; Apostrophe.
5184 ;; Apostrophe at the beginning of a string. Check
5185 ;; white space at the end of the last object.
5194 ;; Apostrophe at the end of a string. Check white
5195 ;; space at the beginning of the next object, which
5196 ;; can only happen if that object is a string.
5203 ;; Lonesome apostrophe. Check white space around
5204 ;; both ends.
5216 n))))))))
5218 ;; Else, consider it as a level 2 quote.
5222 current-status))
5225 info nil org-element-recursive-objects)
5232 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5233 `:utf-8'. INFO is a plist used as a communication channel.
5235 The function has to retrieve information about string
5236 surroundings in parse tree. It can only happen with an
5237 unmodified string. Thus, if S has already been through another
5238 process, a non-nil ORIGINAL optional argument will provide that
5239 original string.
5241 Return the new string."
5250 org-export-smart-quotes-alist))))
5251 encoding)
5252 match))
5253 s nil t)))
5255 ;;;; Topology
5256 ;;
5257 ;; Here are various functions to retrieve information about the
5258 ;; neighborhood of a given element or object. Neighbors of interest
5259 ;; are direct parent (`org-export-get-parent'), parent headline
5260 ;; (`org-export-get-parent-headline'), first element containing an
5261 ;; object, (`org-export-get-parent-element'), parent table
5262 ;; (`org-export-get-parent-table'), previous element or object
5263 ;; (`org-export-get-previous-element') and next element or object
5264 ;; (`org-export-get-next-element').
5266 ;; defsubst org-export-get-parent must be defined before first use
5272 "Return BLOB parent headline or nil.
5273 BLOB is the element or object being considered."
5277 "Return first element containing OBJECT or nil.
5278 OBJECT is the object to consider."
5282 "Return OBJECT parent table or nil.
5283 OBJECT is either a `table-cell' or `table-element' type object."
5287 "Return previous element or object.
5289 BLOB is an element or object. INFO is a plist used as
5290 a communication channel. Return previous exportable element or
5291 object, a string, or nil.
5293 When optional argument N is a positive integer, return a list
5294 containing up to N siblings before BLOB, from farthest to
5295 closest. With any other non-nil value, return a list containing
5296 all of them."
5302 prev)
5312 "Return next element or object.
5314 BLOB is an element or object. INFO is a plist used as
5315 a communication channel. Return next exportable element or
5316 object, a string, or nil.
5318 When optional argument N is a positive integer, return a list
5319 containing up to N siblings after BLOB, from closest to farthest.
5320 With any other non-nil value, return a list containing all of
5321 them."
5328 next)
5338 ;;;; Translation
5339 ;;
5340 ;; `org-export-translate' translates a string according to the language
5341 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5342 ;; the dictionary used for the translation.
5374 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5384 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5390 ("ru" :html "(Продолжение следует)"
5464 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5487 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5493 ("ru" :html "Список распечаток"
5507 ("ru" :html "Список таблиц"
5613 ("ru" :html "Неизвестная ссылка"
5616 "Dictionary for export engine.
5618 Alist whose car is the string to translate and cdr is an alist
5619 whose car is the language string and cdr is a plist whose
5620 properties are possible charsets and values translated terms.
5622 It is used as a database for `org-export-translate'. Since this
5623 function returns the string as-is if no translation was found,
5624 the variable only needs to record values different from the
5628 "Translate string S according to language specification.
5630 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5631 and `:utf-8'. INFO is a plist used as a communication channel.
5633 Translation depends on `:language' property. Return the
5634 translated string. If no translation is found, try to fall back
5635 to `:default' encoding. If it fails, return S."
5641 s)))
5644 \f
5645 ;;; Asynchronous Export
5646 ;;
5647 ;; `org-export-async-start' is the entry point for asynchronous
5648 ;; export. It recreates current buffer (including visibility,
5649 ;; narrowing and visited file) in an external Emacs process, and
5650 ;; evaluates a command there. It then applies a function on the
5651 ;; returned results in the current process.
5652 ;;
5653 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5654 ;; allow to export to a buffer or a file, asynchronously or not.
5655 ;;
5656 ;; `org-export-output-file-name' is an auxiliary function meant to be
5657 ;; used with `org-export-to-file'. With a given extension, it tries
5658 ;; to provide a canonical file name to write export output to.
5659 ;;
5660 ;; Asynchronously generated results are never displayed directly.
5661 ;; Instead, they are stored in `org-export-stack-contents'. They can
5662 ;; then be retrieved by calling `org-export-stack'.
5663 ;;
5664 ;; Export Stack is viewed through a dedicated major mode
5665 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5666 ;;`org-export-stack-delete', `org-export-stack-view' and
5667 ;;`org-export-stack-clear'.
5668 ;;
5669 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5670 ;; It should be used whenever `org-export-async-start' is called.
5673 "Call function FUN on the results returned by BODY evaluation.
5675 FUN is an anonymous function of one argument. BODY evaluation
5676 happens in an asynchronous process, from a buffer which is an
5677 exact copy of the current one.
5679 Use `org-export-add-to-stack' in FUN in order to register results
5680 in the stack.
5682 This is a low level function. See also `org-export-to-buffer'
5683 and `org-export-to-file' for more specialized functions."
5686 ;; Write the full sexp evaluating BODY in a copy of the current
5687 ;; buffer to a temporary file, as it may be too long for program
5688 ;; args in `start-process'.
5695 ;; Null characters (from variable values) are inserted
5696 ;; within the file. As a consequence, coding system for
5697 ;; buffer contents will not be recognized properly. So,
5698 ;; we make sure it is the same as the one used to display
5699 ;; the original buffer.
5701 ,coding
5704 ;; Ignore `kill-emacs-hook' and code evaluation
5705 ;; queries from Babel as we need a truly
5706 ;; non-interactive process.
5708 org-babel-confirm-evaluate-answer-no t)
5709 ;; Initialize export framework.
5711 ;; Re-create current buffer there.
5714 ;; Sexp to evaluate in the buffer.
5716 ;; Start external process.
5719 (,process
5721 #'start-process
5724 ,proc-buffer
5731 ;; Register running process in stack.
5733 ;; Set-up sentinel in order to catch results.
5736 ,process
5758 ;;;###autoload
5761 &optional async subtreep visible-only body-only ext-plist
5762 post-process)
5763 "Call `org-export-as' with output to a specified buffer.
5765 BACKEND is either an export back-end, as returned by, e.g.,
5766 `org-export-create-backend', or a symbol referring to
5767 a registered back-end.
5769 BUFFER is the name of the output buffer. If it already exists,
5770 it will be erased first, otherwise, it will be created.
5772 A non-nil optional argument ASYNC means the process should happen
5773 asynchronously. The resulting buffer should then be accessible
5774 through the `org-export-stack' interface. When ASYNC is nil, the
5775 buffer is displayed if `org-export-show-temporary-export-buffer'
5776 is non-nil.
5778 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5779 EXT-PLIST are similar to those used in `org-export-as', which
5780 see.
5782 Optional argument POST-PROCESS is a function which should accept
5783 no argument. It is always called within the current process,
5784 from BUFFER, with point at its beginning. Export back-ends can
5785 use it to set a major mode there, e.g,
5787 \(defun org-latex-export-as-latex
5788 \(&optional async subtreep visible-only body-only ext-plist)
5789 \(interactive)
5791 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5793 This function returns BUFFER."
5821 buffer)))
5823 ;;;###autoload
5826 post-process)
5827 "Call `org-export-as' with output to a specified file.
5829 BACKEND is either an export back-end, as returned by, e.g.,
5830 `org-export-create-backend', or a symbol referring to
5831 a registered back-end. FILE is the name of the output file, as
5832 a string.
5834 A non-nil optional argument ASYNC means the process should happen
5835 asynchronously. The resulting buffer will then be accessible
5836 through the `org-export-stack' interface.
5838 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5839 EXT-PLIST are similar to those used in `org-export-as', which
5840 see.
5842 Optional argument POST-PROCESS is called with FILE as its
5843 argument and happens asynchronously when ASYNC is non-nil. It
5844 has to return a file name, or nil. Export back-ends can use this
5845 to send the output file through additional processing, e.g,
5847 \(defun org-latex-export-to-latex
5848 \(&optional async subtreep visible-only body-only ext-plist)
5849 \(interactive)
5851 \(org-export-to-file 'latex outfile
5852 async subtreep visible-only body-only ext-plist
5853 \(lambda (file) (org-latex-compile file)))
5855 The function returns either a file name returned by POST-PROCESS,
5856 or FILE."
5875 backend subtreep visible-only body-only ext-plist)))
5882 ;; Get proper return value.
5884 file))))))
5887 "Return output file's name according to buffer specifications.
5889 EXTENSION is a string representing the output file extension,
5890 with the leading dot.
5892 With a non-nil optional argument SUBTREEP, try to determine
5894 of subtree at point.
5896 When optional argument PUB-DIR is set, use it as the publishing
5897 directory.
5899 Return file name as a string."
5902 ;; File name may come from EXPORT_FILE_NAME subtree
5903 ;; property, assuming point is at beginning of said
5904 ;; sub-tree.
5911 ;; File name may be extracted from buffer's associated
5912 ;; file, if any.
5914 ;; Can't determine file name on our own: Ask user.
5918 "Output file: " pub-dir nil nil nil
5922 ;; Build file name. Enforce EXTENSION over whatever user
5923 ;; may have come up with. PUB-DIR, if defined, always has
5924 ;; precedence over any provided path.
5929 extension))
5932 ;; If writing to OUTPUT-FILE would overwrite original file, append
5933 ;; EXTENSION another time to final name.
5936 output-file)))
5939 "Add a new result to export stack if not present already.
5941 SOURCE is a buffer or a file name containing export results.
5942 BACKEND is a symbol representing export back-end used to generate
5943 it.
5945 Entries already pointing to SOURCE and unavailable entries are
5946 removed beforehand. Return the new stack."
5952 "Menu for asynchronous export results and running processes."
5962 "Return source from export results at point in stack."
5969 source
5970 ;; SOURCE is not consistent with current line. The stack
5971 ;; view is outdated.
5975 "Remove all entries from export stack."
5980 "Refresh the asynchronous export stack.
5981 Unavailable sources are removed from the list. Return the new
5982 stack."
5991 ;; Back-end.
5993 ;; Age.
5996 ;; Compute age of the results.
5998 "%4h:%.2m "
6000 ;; Source.
6005 ;; Clear stack from exited processes, dead buffers or
6006 ;; non-existent files.
6018 "Remove export results at point from stack.
6019 If optional argument SOURCE is non-nil, remove it instead."
6024 org-export-stack-contents))))
6027 "View export results at point in stack.
6028 With an optional prefix argument IN-EMACS, force viewing files
6029 within Emacs."
6043 (define-key km "p" 'previous-line)
6044 (define-key km "\C-p" 'previous-line)
6045 (define-key km "\C-?" 'previous-line)
6046 (define-key km [up] 'previous-line)
6047 (define-key km "C" 'org-export-stack-clear)
6048 (define-key km "v" 'org-export-stack-view)
6049 (define-key km (kbd "RET") 'org-export-stack-view)
6050 (define-key km "d" 'org-export-stack-remove)
6051 km)
6052 "Keymap for Org Export Stack.")
6054 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6055 "Mode for displaying asynchronous export stack.
6058 stack.
6060 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6061 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6062 stack completely.
6064 Removing entries in an Org Export Stack buffer doesn't affect
6065 files or buffers, only the display.
6068 (abbrev-mode 0)
6069 (auto-fill-mode 0)
6070 (setq buffer-read-only t
6071 buffer-undo-list t
6072 truncate-lines t
6073 header-line-format
6074 '(:eval
6075 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6076 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6077 (set (make-local-variable 'revert-buffer-function)
6078 'org-export-stack-refresh))
6081 \f
6082 ;;; The Dispatcher
6083 ;;
6084 ;; `org-export-dispatch' is the standard interactive way to start an
6085 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6086 ;; for its interface, which, in turn, delegates response to key
6087 ;; pressed to `org-export--dispatch-action'.
6089 ;;;###autoload
6090 (defun org-export-dispatch (&optional arg)
6091 "Export dispatcher for Org mode.
6093 It provides an access to common export related tasks in a buffer.
6094 Its interface comes in two flavors: standard and expert.
6096 While both share the same set of bindings, only the former
6097 displays the valid keys associations in a dedicated buffer.
6098 Scrolling (resp. line-wise motion) in this buffer is done with
6099 SPC and DEL (resp. C-n and C-p) keys.
6101 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6102 flavor or the other.
6105 of options used back then, on the current buffer.
6107 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6108 (interactive "P")
6109 (let* ((input
6110 (cond ((equal arg '(16)) '(stack))
6111 ((and arg org-export-dispatch-last-action))
6112 (t (save-window-excursion
6113 (unwind-protect
6114 (progn
6115 ;; Remember where we are
6116 (move-marker org-export-dispatch-last-position
6117 (point)
6118 (org-base-buffer (current-buffer)))
6119 ;; Get and store an export command
6120 (setq org-export-dispatch-last-action
6121 (org-export--dispatch-ui
6122 (list org-export-initial-scope
6123 (and org-export-in-background 'async))
6124 nil
6125 org-export-dispatch-use-expert-ui)))
6126 (and (get-buffer "*Org Export Dispatcher*")
6127 (kill-buffer "*Org Export Dispatcher*")))))))
6128 (action (car input))
6129 (optns (cdr input)))
6130 (unless (memq 'subtree optns)
6131 (move-marker org-export-dispatch-last-position nil))
6132 (cl-case action
6133 ;; First handle special hard-coded actions.
6134 (template (org-export-insert-default-template nil optns))
6135 (stack (org-export-stack))
6136 (publish-current-file
6137 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6138 (publish-current-project
6139 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6140 (publish-choose-project
6141 (org-publish (assoc (org-icompleting-read
6142 "Publish project: "
6143 org-publish-project-alist nil t)
6144 org-publish-project-alist)
6145 (memq 'force optns)
6146 (memq 'async optns)))
6147 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6148 (otherwise
6149 (save-excursion
6150 (when arg
6151 ;; Repeating command, maybe move cursor to restore subtree
6152 ;; context.
6153 (if (eq (marker-buffer org-export-dispatch-last-position)
6154 (org-base-buffer (current-buffer)))
6155 (goto-char org-export-dispatch-last-position)
6156 ;; We are in a different buffer, forget position.
6157 (move-marker org-export-dispatch-last-position nil)))
6158 (funcall action
6159 ;; Return a symbol instead of a list to ease
6160 ;; asynchronous export macro use.
6161 (and (memq 'async optns) t)
6162 (and (memq 'subtree optns) t)
6163 (and (memq 'visible optns) t)
6164 (and (memq 'body optns) t)))))))
6166 (defun org-export--dispatch-ui (options first-key expertp)
6167 "Handle interface for `org-export-dispatch'.
6169 OPTIONS is a list containing current interactive options set for
6170 export. It can contain any of the following symbols:
6171 `body' toggles a body-only export
6172 `subtree' restricts export to current subtree
6173 `visible' restricts export to visible part of buffer.
6174 `force' force publishing files.
6175 `async' use asynchronous export process
6177 FIRST-KEY is the key pressed to select the first level menu. It
6178 is nil when this menu hasn't been selected yet.
6180 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6181 buffer is provided, but indications about currently active
6182 options are given in the prompt. Moreover, \[?] allows to switch
6183 back to standard interface."
6184 (let* ((fontify-key
6185 (lambda (key &optional access-key)
6186 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6187 ;; non-nil is the required first-level key to activate
6188 ;; KEY. When its value is t, activate KEY independently
6189 ;; on the first key, if any. A nil value means KEY will
6190 ;; only be activated at first level.
6191 (if (or (eq access-key t) (eq access-key first-key))
6192 (org-propertize key 'face 'org-warning)
6193 key)))
6194 (fontify-value
6195 (lambda (value)
6196 ;; Fontify VALUE string.
6197 (org-propertize value 'face 'font-lock-variable-name-face)))
6198 ;; Prepare menu entries by extracting them from registered
6199 ;; back-ends and sorting them by access key and by ordinal,
6200 ;; if any.
6201 (entries
6202 (sort (sort (delq nil
6203 (mapcar #'org-export-backend-menu
6204 org-export-registered-backends))
6205 (lambda (a b)
6206 (let ((key-a (nth 1 a))
6207 (key-b (nth 1 b)))
6208 (cond ((and (numberp key-a) (numberp key-b))
6209 (< key-a key-b))
6210 ((numberp key-b) t)))))
6211 'car-less-than-car))
6212 ;; Compute a list of allowed keys based on the first key
6213 ;; pressed, if any. Some keys
6214 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6215 ;; available.
6216 (allowed-keys
6217 (nconc (list 2 22 19 6 1)
6218 (if (not first-key) (org-uniquify (mapcar 'car entries))
6219 (let (sub-menu)
6220 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6221 (when (eq (car entry) first-key)
6222 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6223 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6224 ((not first-key) (list ?P)))
6225 (list ?& ?#)
6226 (when expertp (list ??))
6227 (list ?q)))
6228 ;; Build the help menu for standard UI.
6229 (help
6230 (unless expertp
6231 (concat
6232 ;; Options are hard-coded.
6233 (format "[%s] Body only: %s [%s] Visible only: %s
6234 \[%s] Export scope: %s [%s] Force publishing: %s
6236 (funcall fontify-key "C-b" t)
6237 (funcall fontify-value
6238 (if (memq 'body options) "On " "Off"))
6239 (funcall fontify-key "C-v" t)
6240 (funcall fontify-value
6241 (if (memq 'visible options) "On " "Off"))
6242 (funcall fontify-key "C-s" t)
6243 (funcall fontify-value
6244 (if (memq 'subtree options) "Subtree" "Buffer "))
6245 (funcall fontify-key "C-f" t)
6246 (funcall fontify-value
6247 (if (memq 'force options) "On " "Off"))
6248 (funcall fontify-key "C-a" t)
6249 (funcall fontify-value
6250 (if (memq 'async options) "On " "Off")))
6251 ;; Display registered back-end entries. When a key
6252 ;; appears for the second time, do not create another
6253 ;; entry, but append its sub-menu to existing menu.
6254 (let (last-key)
6255 (mapconcat
6256 (lambda (entry)
6257 (let ((top-key (car entry)))
6258 (concat
6259 (unless (eq top-key last-key)
6260 (setq last-key top-key)
6262 (funcall fontify-key (char-to-string top-key))
6263 (nth 1 entry)))
6264 (let ((sub-menu (nth 2 entry)))
6265 (unless (functionp sub-menu)
6266 ;; Split sub-menu into two columns.
6267 (let ((index -1))
6268 (concat
6269 (mapconcat
6270 (lambda (sub-entry)
6271 (cl-incf index)
6272 (format
6273 (if (zerop (mod index 2)) " [%s] %-26s"
6275 (funcall fontify-key
6276 (char-to-string (car sub-entry))
6277 top-key)
6278 (nth 1 sub-entry)))
6279 sub-menu "")
6281 entries ""))
6282 ;; Publishing menu is hard-coded.
6284 [%s] Current file [%s] Current project
6286 (funcall fontify-key "P")
6287 (funcall fontify-key "f" ?P)
6288 (funcall fontify-key "p" ?P)
6289 (funcall fontify-key "x" ?P)
6290 (funcall fontify-key "a" ?P))
6292 (funcall fontify-key "&" t)
6293 (funcall fontify-key "#" t))
6294 (format "[%s] %s"
6295 (funcall fontify-key "q" t)
6296 (if first-key "Main menu" "Exit")))))
6297 ;; Build prompts for both standard and expert UI.
6298 (standard-prompt (unless expertp "Export command: "))
6299 (expert-prompt
6300 (when expertp
6301 (format
6302 "Export command (C-%s%s%s%s%s) [%s]: "
6303 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6304 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6305 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6306 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6307 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6308 (mapconcat (lambda (k)
6309 ;; Strip control characters.
6310 (unless (< k 27) (char-to-string k)))
6311 allowed-keys "")))))
6312 ;; With expert UI, just read key with a fancy prompt. In standard
6313 ;; UI, display an intrusive help buffer.
6314 (if expertp
6315 (org-export--dispatch-action
6316 expert-prompt allowed-keys entries options first-key expertp)
6317 ;; At first call, create frame layout in order to display menu.
6318 (unless (get-buffer "*Org Export Dispatcher*")
6319 (delete-other-windows)
6320 (org-switch-to-buffer-other-window
6321 (get-buffer-create "*Org Export Dispatcher*"))
6322 (setq cursor-type nil
6323 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6324 ;; Make sure that invisible cursor will not highlight square
6325 ;; brackets.
6326 (set-syntax-table (copy-syntax-table))
6327 (modify-syntax-entry ?\[ "w"))
6328 ;; At this point, the buffer containing the menu exists and is
6329 ;; visible in the current window. So, refresh it.
6330 (with-current-buffer "*Org Export Dispatcher*"
6331 ;; Refresh help. Maintain display continuity by re-visiting
6332 ;; previous window position.
6333 (let ((pos (window-start)))
6334 (erase-buffer)
6335 (insert help)
6336 (set-window-start nil pos)))
6337 (org-fit-window-to-buffer)
6338 (org-export--dispatch-action
6339 standard-prompt allowed-keys entries options first-key expertp))))
6341 (defun org-export--dispatch-action
6342 (prompt allowed-keys entries options first-key expertp)
6343 "Read a character from command input and act accordingly.
6345 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6346 a list of characters available at a given step in the process.
6347 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6348 EXPERTP are the same as defined in `org-export--dispatch-ui',
6349 which see.
6351 Toggle export options when required. Otherwise, return value is
6352 a list with action as CAR and a list of interactive export
6353 options as CDR."
6354 (let (key)
6355 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6356 ;; C-p, SPC, DEL).
6357 (while (and (setq key (read-char-exclusive prompt))
6358 (not expertp)
6359 (memq key '(14 16 ?\s ?\d)))
6360 (cl-case key
6361 (14 (if (not (pos-visible-in-window-p (point-max)))
6362 (ignore-errors (scroll-up 1))
6363 (message "End of buffer")
6364 (sit-for 1)))
6365 (16 (if (not (pos-visible-in-window-p (point-min)))
6366 (ignore-errors (scroll-down 1))
6367 (message "Beginning of buffer")
6368 (sit-for 1)))
6369 (?\s (if (not (pos-visible-in-window-p (point-max)))
6370 (scroll-up nil)
6371 (message "End of buffer")
6372 (sit-for 1)))
6373 (?\d (if (not (pos-visible-in-window-p (point-min)))
6374 (scroll-down nil)
6375 (message "Beginning of buffer")
6376 (sit-for 1)))))
6377 (cond
6378 ;; Ignore undefined associations.
6379 ((not (memq key allowed-keys))
6380 (ding)
6381 (unless expertp (message "Invalid key") (sit-for 1))
6382 (org-export--dispatch-ui options first-key expertp))
6383 ;; q key at first level aborts export. At second level, cancel
6384 ;; first key instead.
6385 ((eq key ?q) (if (not first-key) (error "Export aborted")
6386 (org-export--dispatch-ui options nil expertp)))
6387 ;; Help key: Switch back to standard interface if expert UI was
6388 ;; active.
6389 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6390 ;; Send request for template insertion along with export scope.
6391 ((eq key ?#) (cons 'template (memq 'subtree options)))
6392 ;; Switch to asynchronous export stack.
6393 ((eq key ?&) '(stack))
6394 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6395 ((memq key '(2 22 19 6 1))
6396 (org-export--dispatch-ui
6397 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6398 (6 'force) (1 'async))))
6399 (if (memq option options) (remq option options)
6400 (cons option options)))
6401 first-key expertp))
6402 ;; Action selected: Send key and options back to
6403 ;; `org-export-dispatch'.
6404 ((or first-key (functionp (nth 2 (assq key entries))))
6405 (cons (cond
6406 ((not first-key) (nth 2 (assq key entries)))
6407 ;; Publishing actions are hard-coded. Send a special
6408 ;; signal to `org-export-dispatch'.
6409 ((eq first-key ?P)
6410 (cl-case key
6411 (?f 'publish-current-file)
6412 (?p 'publish-current-project)
6413 (?x 'publish-choose-project)
6414 (?a 'publish-all)))
6415 ;; Return first action associated to FIRST-KEY + KEY
6416 ;; path. Indeed, derived backends can share the same
6417 ;; FIRST-KEY.
6418 (t (catch 'found
6419 (mapc (lambda (entry)
6420 (let ((match (assq key (nth 2 entry))))
6421 (when match (throw 'found (nth 2 match)))))
6422 (member (assq first-key entries) entries)))))
6423 options))
6424 ;; Otherwise, enter sub-menu.
6425 (t (org-export--dispatch-ui options key expertp)))))
6429 (provide 'ox)
6431 ;; Local variables:
6432 ;; generated-autoload-file: "org-loaddefs.el"
6433 ;; End:
6435 ;;; ox.el ends here