| blob | 3b44094a9d73391c6dcf988d83fe3cf26621c050 |
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.
1400 property
1409 "Return current buffer export options, as a plist.
1411 Optional argument BACKEND, when non-nil, is an export back-end,
1412 as returned by, e.g., `org-export-create-backend'. It specifies
1413 which back-end specific options should also be read in the
1414 process.
1416 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1419 ;; Priority is given to back-end specific options.
1421 org-export-options-alist))
1424 org-export-special-keywords))))
1425 plist to-parse)
1428 ;; Return all properties associated to KEYWORD.
1435 ;; Recursively read keywords in buffer. FILES is
1436 ;; a list of files read so far. PLIST is the current
1437 ;; property list obtained.
1446 ;; Options in `org-export-special-keywords'.
1451 ;; Avoid circular dependencies.
1460 plist
1462 val backend))))
1466 plist
1473 ;; Options in `org-export-options-alist'.
1476 plist
1478 plist property
1479 ;; Handle value depending on specified
1480 ;; BEHAVIOR.
1485 ;; Even if `parse' implies `space'
1486 ;; behavior, we separate line with
1487 ;; "\n" so as to preserve
1488 ;; line-breaks. However, empty
1489 ;; lines are forbidden since `parse'
1490 ;; doesn't allow more than one
1491 ;; paragraph.
1500 " "
1513 ;; Read options in the current buffer and return value.
1515 ;; Parse properties in TO-PARSE. Remove newline characters not
1516 ;; involved in line breaks to simulate `space' behavior.
1517 ;; Finally return options.
1529 "Return properties related to buffer attributes, as a plist."
1534 "Return global export options as a plist.
1535 Optional argument BACKEND, if non-nil, is an export back-end, as
1536 returned by, e.g., `org-export-create-backend'. It specifies
1537 which back-end specific export options should also be read in the
1538 process."
1540 ;; Priority is given to back-end specific options.
1542 org-export-options-alist)))
1548 plist
1549 prop
1550 ;; Evaluate default value provided.
1555 value)))))))))
1558 "Return variables bound from BIND keywords in current buffer.
1559 Also look for BIND keywords in setup files. The return value is
1560 an alist where associations are (VARIABLE-NAME VALUE)."
1564 ;; Return an alist between variable names and their
1565 ;; value. FILES is a list of setup files names read
1566 ;; so far, used to avoid circular dependencies. ALIST
1567 ;; is the alist collected so far.
1579 ;; Enter setup file.
1589 alist))))))))))
1590 alist)))))
1591 ;; Return value in appropriate order of appearance.
1594 ;; defsubst org-export-get-parent must be defined before first use,
1595 ;; was originally defined in the topology section
1598 "Return BLOB parent or nil.
1599 BLOB is the element or object considered."
1602 ;;;; Tree Properties
1603 ;;
1604 ;; Tree properties are information extracted from parse tree. They
1605 ;; are initialized at the beginning of the transcoding process by
1606 ;; `org-export-collect-tree-properties'.
1607 ;;
1608 ;; Dedicated functions focus on computing the value of specific tree
1609 ;; properties during initialization. Thus,
1610 ;; `org-export--populate-ignore-list' lists elements and objects that
1611 ;; should be skipped during export, `org-export--get-min-level' gets
1612 ;; the minimal exportable level, used as a basis to compute relative
1613 ;; level for headlines. Eventually
1614 ;; `org-export--collect-headline-numbering' builds an alist between
1615 ;; headlines and their numbering.
1618 "Extract tree properties from parse tree.
1620 DATA is the parse tree from which information is retrieved. INFO
1621 is a list holding export options.
1623 Following tree properties are set or updated:
1625 `:exported-data' Hash table used to memoize results from
1626 `org-export-data'.
1628 `:headline-offset' Offset between true level of headlines and
1629 local level. An offset of -1 means a headline
1630 of level 2 should be considered as a level
1631 1 headline in the context.
1633 `:headline-numbering' Alist of all headlines as key an the
1634 associated numbering as value.
1636 Return updated plist."
1637 ;; Install the parse tree in the communication channel.
1639 ;; Compute `:headline-offset' in order to be able to use
1640 ;; `org-export-get-relative-level'.
1643 :headline-offset
1645 ;; Properties order doesn't matter: get the rest of the tree
1646 ;; properties.
1650 info))
1653 "Return minimum exportable headline's level in DATA.
1654 DATA is parsed tree as returned by `org-element-parse-buffer'.
1655 OPTIONS is a plist holding export options."
1666 ;; If no headline was found, for the sake of consistency, set
1667 ;; minimum level to 1 nonetheless.
1671 "Return numbering of all exportable, numbered headlines in a parse tree.
1673 DATA is the parse tree. OPTIONS is the plist holding export
1674 options.
1676 Return an alist whose key is a headline and value is its
1677 associated numbering \(in the shape of a list of numbers\) or nil
1678 for a footnotes section."
1687 headline
1689 for n across numbering
1690 for idx from 0 to org-export-max-depth
1694 options)))
1697 "List headlines and inlinetasks with a select tag in their tree.
1698 DATA is parsed data as returned by `org-element-parse-buffer'.
1699 INFO is a plist holding export options."
1709 ;; When a select tag is found, mark full
1710 ;; genealogy and every headline within the
1711 ;; tree as acceptable.
1714 genealogy
1717 selected-trees))
1718 ;; If at a headline, continue searching in tree,
1719 ;; recursively.
1728 selected-trees))
1731 "Non-nil when element or object BLOB should be skipped during export.
1732 OPTIONS is the plist holding export options. SELECTED, when
1733 non-nil, is a list of headlines or inlinetasks belonging to
1734 a tree with a select tag."
1741 ;; If `:with-drawers' value starts with `not', ignore
1742 ;; every drawer whose name belong to that list.
1743 ;; Otherwise, ignore drawers whose name isn't in that
1744 ;; list.
1761 ;; Ignore subtrees with an exclude tag.
1764 ;; When a select tag is present in the buffer, ignore any tree
1765 ;; without it.
1767 ;; Ignore commented sub-trees.
1769 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1771 ;; Ignore tasks, if specified by `:with-tasks' property.
1783 properties-set))))))
1794 ;; `:with-timestamps' only applies to isolated timestamps
1795 ;; objects, i.e. timestamp objects in a paragraph containing only
1796 ;; timestamps and whitespaces.
1804 options t))))
1813 \f
1814 ;;; The Transcoder
1815 ;;
1816 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1817 ;; `org-element-parse-buffer') and transcodes it into a specified
1818 ;; back-end output. It takes care of filtering out elements or
1819 ;; objects according to export options and organizing the output blank
1820 ;; lines and white space are preserved. The function memoizes its
1821 ;; results, so it is cheap to call it within transcoders.
1822 ;;
1823 ;; It is possible to modify locally the back-end used by
1824 ;; `org-export-data' or even use a temporary back-end by using
1825 ;; `org-export-data-with-backend'.
1826 ;;
1827 ;; `org-export-transcoder' is an accessor returning appropriate
1828 ;; translator function for a given element or object.
1831 "Return appropriate transcoder for BLOB.
1832 INFO is a plist containing export directives."
1834 ;; Return contents only for complete parse trees.
1840 "Convert DATA into current back-end format.
1842 DATA is a parse tree, an element or an object or a secondary
1843 string. INFO is a plist holding export options.
1845 Return a string."
1850 ;; Ignored element/object.
1852 ;; Plain text.
1858 info))
1859 ;; Secondary string.
1862 ;; Element/Object without contents or, as a special
1863 ;; case, headline with archive tag and archived trees
1864 ;; restricted to title only.
1872 ;; Export snippets never return a nil value so
1873 ;; that white spaces following them are never
1874 ;; ignored.
1876 ;; Element/Object with contents.
1889 ;; Elements directly containing
1890 ;; objects must have their indentation
1891 ;; normalized first.
1893 data
1894 ;; When normalizing contents of the
1895 ;; first paragraph in an item or
1896 ;; a footnote definition, ignore
1897 ;; first line's indentation: there is
1898 ;; none and it might be misleading.
1903 data)
1910 info))))))))
1911 ;; Final result will be memoized before being returned.
1913 data
1917 ;; Append the same white space between elements or objects
1918 ;; as in the original buffer, and call appropriate filters.
1929 info)))
1930 results)))
1934 "Convert DATA into BACKEND format.
1936 DATA is an element, an object, a secondary string or a string.
1937 BACKEND is a symbol. INFO is a plist used as a communication
1938 channel.
1940 Unlike to `org-export-with-backend', this function will
1941 recursively convert DATA using BACKEND translation table."
1944 data
1945 ;; Set-up a new communication channel with translations defined in
1946 ;; BACKEND as the translate table and a new hash table for
1947 ;; memoization.
1949 info
1952 ;; Size of the hash table is reduced since this function
1953 ;; will probably be used on small trees.
1957 "Expand a parsed element or object to its original state.
1959 BLOB is either an element or an object. CONTENTS is its
1960 contents, as a string or nil.
1962 When optional argument WITH-AFFILIATED is non-nil, add affiliated
1963 keywords before output."
1968 blob contents))))
1971 \f
1972 ;;; The Filter System
1973 ;;
1974 ;; Filters allow end-users to tweak easily the transcoded output.
1975 ;; They are the functional counterpart of hooks, as every filter in
1976 ;; a set is applied to the return value of the previous one.
1977 ;;
1978 ;; Every set is back-end agnostic. Although, a filter is always
1979 ;; called, in addition to the string it applies to, with the back-end
1980 ;; used as argument, so it's easy for the end-user to add back-end
1981 ;; specific filters in the set. The communication channel, as
1982 ;; a plist, is required as the third argument.
1983 ;;
1984 ;; From the developer side, filters sets can be installed in the
1985 ;; process with the help of `org-export-define-backend', which
1986 ;; internally stores filters as an alist. Each association has a key
1987 ;; among the following symbols and a function or a list of functions
1988 ;; as value.
1989 ;;
1990 ;; - `:filter-options' applies to the property list containing export
1991 ;; options. Unlike to other filters, functions in this list accept
1992 ;; two arguments instead of three: the property list containing
1993 ;; export options and the back-end. Users can set its value through
1994 ;; `org-export-filter-options-functions' variable.
1995 ;;
1996 ;; - `:filter-parse-tree' applies directly to the complete parsed
1997 ;; tree. Users can set it through
1998 ;; `org-export-filter-parse-tree-functions' variable.
1999 ;;
2000 ;; - `:filter-body' applies to the body of the output, before template
2001 ;; translator chimes in. Users can set it through
2002 ;; `org-export-filter-body-functions' variable.
2003 ;;
2004 ;; - `:filter-final-output' applies to the final transcoded string.
2005 ;; Users can set it with `org-export-filter-final-output-functions'
2006 ;; variable.
2007 ;;
2008 ;; - `:filter-plain-text' applies to any string not recognized as Org
2009 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2010 ;; configure it.
2011 ;;
2012 ;; - `:filter-TYPE' applies on the string returned after an element or
2013 ;; object of type TYPE has been transcoded. A user can modify
2014 ;; `org-export-filter-TYPE-functions' to install these filters.
2015 ;;
2016 ;; All filters sets are applied with
2017 ;; `org-export-filter-apply-functions' function. Filters in a set are
2018 ;; applied in a LIFO fashion. It allows developers to be sure that
2019 ;; their filters will be applied first.
2020 ;;
2021 ;; Filters properties are installed in communication channel with
2022 ;; `org-export-install-filters' function.
2023 ;;
2024 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2025 ;; `org-export-before-parsing-hook') are run at the beginning of the
2026 ;; export process and just before parsing to allow for heavy structure
2027 ;; modifications.
2030 ;;;; Hooks
2033 "Hook run at the beginning of the export process.
2035 This is run before include keywords and macros are expanded and
2036 Babel code blocks executed, on a copy of the original buffer
2037 being exported. Visibility and narrowing are preserved. Point
2038 is at the beginning of the buffer.
2040 Every function in this hook will be called with one argument: the
2044 "Hook run before parsing an export buffer.
2046 This is run after include keywords and macros have been expanded
2047 and Babel code blocks executed, on a copy of the original buffer
2048 being exported. Visibility and narrowing are preserved. Point
2049 is at the beginning of the buffer.
2051 Every function in this hook will be called with one argument: the
2055 ;;;; Special Filters
2058 "List of functions applied to the export options.
2059 Each filter is called with two arguments: the export options, as
2060 a plist, and the back-end, as a symbol. It must return
2064 "List of functions applied to the parsed tree.
2065 Each filter is called with three arguments: the parse tree, as
2066 returned by `org-element-parse-buffer', the back-end, as
2067 a symbol, and the communication channel, as a plist. It must
2071 "List of functions applied to plain text.
2072 Each filter is called with three arguments: a string which
2073 contains no Org syntax, the back-end, as a symbol, and the
2074 communication channel, as a plist. It must return a string or
2078 "List of functions applied to transcoded body.
2079 Each filter is called with three arguments: a string which
2080 contains no Org syntax, the back-end, as a symbol, and the
2081 communication channel, as a plist. It must return a string or
2085 "List of functions applied to the transcoded string.
2086 Each filter is called with three arguments: the full transcoded
2087 string, the back-end, as a symbol, and the communication channel,
2088 as a plist. It must return a string that will be used as the
2092 ;;;; Elements Filters
2095 "List of functions applied to a transcoded babel-call.
2096 Each filter is called with three arguments: the transcoded data,
2097 as a string, the back-end, as a symbol, and the communication
2101 "List of functions applied to a transcoded center block.
2102 Each filter is called with three arguments: the transcoded data,
2103 as a string, the back-end, as a symbol, and the communication
2107 "List of functions applied to a transcoded clock.
2108 Each filter is called with three arguments: the transcoded data,
2109 as a string, the back-end, as a symbol, and the communication
2113 "List of functions applied to a transcoded diary-sexp.
2114 Each filter is called with three arguments: the transcoded data,
2115 as a string, the back-end, as a symbol, and the communication
2119 "List of functions applied to a transcoded drawer.
2120 Each filter is called with three arguments: the transcoded data,
2121 as a string, the back-end, as a symbol, and the communication
2125 "List of functions applied to a transcoded dynamic-block.
2126 Each filter is called with three arguments: the transcoded data,
2127 as a string, the back-end, as a symbol, and the communication
2131 "List of functions applied to a transcoded example-block.
2132 Each filter is called with three arguments: the transcoded data,
2133 as a string, the back-end, as a symbol, and the communication
2137 "List of functions applied to a transcoded export-block.
2138 Each filter is called with three arguments: the transcoded data,
2139 as a string, the back-end, as a symbol, and the communication
2143 "List of functions applied to a transcoded fixed-width.
2144 Each filter is called with three arguments: the transcoded data,
2145 as a string, the back-end, as a symbol, and the communication
2149 "List of functions applied to a transcoded footnote-definition.
2150 Each filter is called with three arguments: the transcoded data,
2151 as a string, the back-end, as a symbol, and the communication
2155 "List of functions applied to a transcoded headline.
2156 Each filter is called with three arguments: the transcoded data,
2157 as a string, the back-end, as a symbol, and the communication
2161 "List of functions applied to a transcoded horizontal-rule.
2162 Each filter is called with three arguments: the transcoded data,
2163 as a string, the back-end, as a symbol, and the communication
2167 "List of functions applied to a transcoded inlinetask.
2168 Each filter is called with three arguments: the transcoded data,
2169 as a string, the back-end, as a symbol, and the communication
2173 "List of functions applied to a transcoded item.
2174 Each filter is called with three arguments: the transcoded data,
2175 as a string, the back-end, as a symbol, and the communication
2179 "List of functions applied to a transcoded keyword.
2180 Each filter is called with three arguments: the transcoded data,
2181 as a string, the back-end, as a symbol, and the communication
2185 "List of functions applied to a transcoded latex-environment.
2186 Each filter is called with three arguments: the transcoded data,
2187 as a string, the back-end, as a symbol, and the communication
2191 "List of functions applied to a transcoded node-property.
2192 Each filter is called with three arguments: the transcoded data,
2193 as a string, the back-end, as a symbol, and the communication
2197 "List of functions applied to a transcoded paragraph.
2198 Each filter is called with three arguments: the transcoded data,
2199 as a string, the back-end, as a symbol, and the communication
2203 "List of functions applied to a transcoded plain-list.
2204 Each filter is called with three arguments: the transcoded data,
2205 as a string, the back-end, as a symbol, and the communication
2209 "List of functions applied to a transcoded planning.
2210 Each filter is called with three arguments: the transcoded data,
2211 as a string, the back-end, as a symbol, and the communication
2215 "List of functions applied to a transcoded property-drawer.
2216 Each filter is called with three arguments: the transcoded data,
2217 as a string, the back-end, as a symbol, and the communication
2221 "List of functions applied to a transcoded quote block.
2222 Each filter is called with three arguments: the transcoded quote
2223 data, as a string, the back-end, as a symbol, and the
2224 communication channel, as a plist. It must return a string or
2228 "List of functions applied to a transcoded section.
2229 Each filter is called with three arguments: the transcoded data,
2230 as a string, the back-end, as a symbol, and the communication
2234 "List of functions applied to a transcoded special block.
2235 Each filter is called with three arguments: the transcoded data,
2236 as a string, the back-end, as a symbol, and the communication
2240 "List of functions applied to a transcoded src-block.
2241 Each filter is called with three arguments: the transcoded data,
2242 as a string, the back-end, as a symbol, and the communication
2246 "List of functions applied to a transcoded table.
2247 Each filter is called with three arguments: the transcoded data,
2248 as a string, the back-end, as a symbol, and the communication
2252 "List of functions applied to a transcoded table-cell.
2253 Each filter is called with three arguments: the transcoded data,
2254 as a string, the back-end, as a symbol, and the communication
2258 "List of functions applied to a transcoded table-row.
2259 Each filter is called with three arguments: the transcoded data,
2260 as a string, the back-end, as a symbol, and the communication
2264 "List of functions applied to a transcoded verse block.
2265 Each filter is called with three arguments: the transcoded data,
2266 as a string, the back-end, as a symbol, and the communication
2270 ;;;; Objects Filters
2273 "List of functions applied to transcoded bold text.
2274 Each filter is called with three arguments: the transcoded data,
2275 as a string, the back-end, as a symbol, and the communication
2279 "List of functions applied to transcoded code text.
2280 Each filter is called with three arguments: the transcoded data,
2281 as a string, the back-end, as a symbol, and the communication
2285 "List of functions applied to a transcoded entity.
2286 Each filter is called with three arguments: the transcoded data,
2287 as a string, the back-end, as a symbol, and the communication
2291 "List of functions applied to a transcoded export-snippet.
2292 Each filter is called with three arguments: the transcoded data,
2293 as a string, the back-end, as a symbol, and the communication
2297 "List of functions applied to a transcoded footnote-reference.
2298 Each filter is called with three arguments: the transcoded data,
2299 as a string, the back-end, as a symbol, and the communication
2303 "List of functions applied to a transcoded inline-babel-call.
2304 Each filter is called with three arguments: the transcoded data,
2305 as a string, the back-end, as a symbol, and the communication
2309 "List of functions applied to a transcoded inline-src-block.
2310 Each filter is called with three arguments: the transcoded data,
2311 as a string, the back-end, as a symbol, and the communication
2315 "List of functions applied to transcoded italic text.
2316 Each filter is called with three arguments: the transcoded data,
2317 as a string, the back-end, as a symbol, and the communication
2321 "List of functions applied to a transcoded latex-fragment.
2322 Each filter is called with three arguments: the transcoded data,
2323 as a string, the back-end, as a symbol, and the communication
2327 "List of functions applied to a transcoded line-break.
2328 Each filter is called with three arguments: the transcoded data,
2329 as a string, the back-end, as a symbol, and the communication
2333 "List of functions applied to a transcoded link.
2334 Each filter is called with three arguments: the transcoded data,
2335 as a string, the back-end, as a symbol, and the communication
2339 "List of functions applied to a transcoded radio-target.
2340 Each filter is called with three arguments: the transcoded data,
2341 as a string, the back-end, as a symbol, and the communication
2345 "List of functions applied to a transcoded statistics-cookie.
2346 Each filter is called with three arguments: the transcoded data,
2347 as a string, the back-end, as a symbol, and the communication
2351 "List of functions applied to transcoded strike-through text.
2352 Each filter is called with three arguments: the transcoded data,
2353 as a string, the back-end, as a symbol, and the communication
2357 "List of functions applied to a transcoded subscript.
2358 Each filter is called with three arguments: the transcoded data,
2359 as a string, the back-end, as a symbol, and the communication
2363 "List of functions applied to a transcoded superscript.
2364 Each filter is called with three arguments: the transcoded data,
2365 as a string, the back-end, as a symbol, and the communication
2369 "List of functions applied to a transcoded target.
2370 Each filter is called with three arguments: the transcoded data,
2371 as a string, the back-end, as a symbol, and the communication
2375 "List of functions applied to a transcoded timestamp.
2376 Each filter is called with three arguments: the transcoded data,
2377 as a string, the back-end, as a symbol, and the communication
2381 "List of functions applied to transcoded underline text.
2382 Each filter is called with three arguments: the transcoded data,
2383 as a string, the back-end, as a symbol, and the communication
2387 "List of functions applied to transcoded verbatim text.
2388 Each filter is called with three arguments: the transcoded data,
2389 as a string, the back-end, as a symbol, and the communication
2393 ;;;; Filters Tools
2394 ;;
2395 ;; Internal function `org-export-install-filters' installs filters
2396 ;; hard-coded in back-ends (developer filters) and filters from global
2397 ;; variables (user filters) in the communication channel.
2398 ;;
2399 ;; Internal function `org-export-filter-apply-functions' takes care
2400 ;; about applying each filter in order to a given data. It ignores
2401 ;; filters returning a nil value but stops whenever a filter returns
2402 ;; an empty string.
2405 "Call every function in FILTERS.
2407 Functions are called with arguments VALUE, current export
2408 back-end's name and INFO. A function returning a nil value will
2409 be skipped. If it returns the empty string, the process ends and
2410 VALUE is ignored.
2412 Call is done in a LIFO fashion, to be sure that developer
2413 specified filters, if any, are called first."
2424 "Install filters properties in communication channel.
2425 INFO is a plist containing the current communication channel.
2426 Return the updated communication channel."
2428 ;; Install user-defined filters with `org-export-filters-alist'
2429 ;; and filters already in INFO (through ext-plist mechanism).
2436 ;; Filters in INFO will be called
2437 ;; before those user provided.
2440 default-value)))))
2441 org-export-filters-alist)
2442 ;; Prepend back-end specific filters to that list.
2444 ;; Single values get consed, lists are appended.
2449 plist key
2453 ;; Return new communication channel.
2457 \f
2458 ;;; Core functions
2459 ;;
2460 ;; This is the room for the main function, `org-export-as', along with
2461 ;; its derivative, `org-export-string-as'.
2462 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2463 ;; function should be added to kill ring.
2464 ;;
2465 ;; Note that `org-export-as' doesn't really parse the current buffer,
2466 ;; but a copy of it (with the same buffer-local variables and
2467 ;; visibility), where macros and include keywords are expanded and
2468 ;; Babel blocks are executed, if appropriate.
2469 ;; `org-export-with-buffer-copy' macro prepares that copy.
2470 ;;
2471 ;; File inclusion is taken care of by
2472 ;; `org-export-expand-include-keyword' and
2473 ;; `org-export--prepare-file-contents'. Structure wise, including
2474 ;; a whole Org file in a buffer often makes little sense. For
2475 ;; example, if the file contains a headline and the include keyword
2476 ;; was within an item, the item should contain the headline. That's
2477 ;; why file inclusion should be done before any structure can be
2478 ;; associated to the file, that is before parsing.
2479 ;;
2480 ;; `org-export-insert-default-template' is a command to insert
2481 ;; a default template (or a back-end specific template) at point or in
2482 ;; current subtree.
2485 "Return a copy of the current buffer.
2486 The copy preserves Org buffer-local variables, visibility and
2487 narrowing."
2493 new-buf))
2496 "Apply BODY in a copy of the current buffer.
2497 The copy preserves local variables, visibility and contents of
2498 the original buffer. Point is at the beginning of the buffer
2499 when BODY is applied."
2508 ;; Kill copy without confirmation.
2514 "Generate a function duplicating BUFFER.
2516 The copy will preserve local variables, visibility, contents and
2517 narrowing of the original buffer. If a region was active in
2518 BUFFER, contents will be narrowed to that region instead.
2520 The resulting function can be evaluated at a later time, from
2521 another buffer, effectively cloning the original buffer there.
2523 The function assumes BUFFER's major mode is `org-mode'."
2527 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2528 ;; already in BUFFER.
2530 ;; Copy specific buffer local variables and variables set
2531 ;; through BIND keywords.
2533 vars)
2541 buffer-file-name
2542 buffer-file-coding-system))
2546 ;; Skip unreadable values, as they cannot be
2547 ;; sent to external process.
2551 vars))))))
2552 ;; Whole buffer contents.
2557 ;; Narrowing.
2561 ;; Current position of point.
2563 ;; Overlays with invisible property.
2573 ov-set))))
2575 ov-set)))))
2578 "Delete commented areas in the buffer.
2579 Commented areas are comments, comment blocks, commented trees and
2580 inlinetasks. Trailing blank lines after a comment or a comment
2581 block are preserved. Narrowing, if any, is ignored."
2602 "Prune non exportable elements from DATA.
2603 DATA is the parse tree to traverse. INFO is the plist holding
2604 export info. Also set `:ignore-list' in INFO to a list of
2605 objects which should be ignored during export, but not removed
2606 from tree."
2608 ;; First find trees containing a select tag, if any.
2612 ;; Prune non-exportable elements and objects from tree.
2613 ;; As a special case, special rows and cells from tables
2614 ;; are stored in IGNORE, as they still need to be
2615 ;; accessed during export.
2625 ;; If headline is archived but tree below has
2626 ;; to be skipped, remove contents.
2628 ;; Move into secondary string, if any.
2631 org-element-secondary-value-alist))))
2635 ;; Move into recursive objects/elements.
2637 ;; If a select tag is active, also ignore the section before the
2638 ;; first headline, if any.
2643 ;; Prune tree and communication channel.
2647 ;; Priority is given to back-end specific options.
2649 org-export-options-alist))
2652 ;; Eventually set `:ignore-list'.
2656 "Change uninterpreted elements back into Org syntax.
2657 DATA is the parse tree. INFO is a plist containing export
2658 options. Each uninterpreted element or object is changed back
2659 into a string. Contents, if any, are not modified. The parse
2660 tree is modified by side effect."
2666 p
2669 info))))))
2672 "Change uninterpreted elements back into Org syntax.
2673 DATA is a parse tree or a secondary string. INFO is a plist
2674 containing export options. It is modified by side effect and
2675 returned by the function."
2678 subscript superscript underline)
2682 ;; ... entities...
2689 ?\s)))))
2690 ;; ... emphasis...
2702 marker
2706 ?\s)))))))
2707 ;; ... LaTeX environments and fragments...
2711 ;; ... sub/superscripts...
2720 "_"
2729 ?\s)))))))))))
2731 ;; Splice NEW at BLOB location in parse tree.
2734 info nil nil t)
2735 ;; Return modified parse tree.
2736 data)
2739 "Insert footnote definitions outside parsing scope in TREE.
2741 If there is a footnote section in TREE, definitions found are
2742 appended to it. If `org-footnote-section' is non-nil, a new
2743 footnote section containing all definitions is inserted in TREE.
2744 Otherwise, definitions are appended at the end of the section
2745 containing their first reference.
2747 Only definitions actually referred to within TREE, directly or
2748 not, are considered."
2767 definitions))
2775 'footnote-definition
2781 definitions))))))))
2782 ;; Collect all out of scope definitions.
2792 ;; Filter out definitions referenced neither in the original
2793 ;; tree nor in the external definitions.
2798 definitions))
2801 referenced-labels)))
2806 definitions)))
2807 ;; Install definitions in subtree.
2810 ;; If there is a footnote section, insert them here.
2815 nil t)))
2818 ;; If there should be a footnote section, create one containing
2819 ;; all the definitions at the end of the tree.
2822 tree
2828 'section
2829 nil
2831 ;; Otherwise add each definition at the end of the section where
2832 ;; it is first referenced.
2837 ;; Insert definitions in the same section as
2838 ;; their first reference in DATA.
2850 d)
2851 label)
2858 definition)
2860 definition)))))))))))
2863 ;;;###autoload
2866 "Transcode current Org buffer into BACKEND code.
2868 BACKEND is either an export back-end, as returned by, e.g.,
2869 `org-export-create-backend', or a symbol referring to
2870 a registered back-end.
2872 If narrowing is active in the current buffer, only transcode its
2873 narrowed part.
2875 If a region is active, transcode that region.
2877 When optional argument SUBTREEP is non-nil, transcode the
2878 sub-tree at point, extracting information from the headline
2879 properties first.
2881 When optional argument VISIBLE-ONLY is non-nil, don't export
2882 contents of hidden elements.
2884 When optional argument BODY-ONLY is non-nil, only return body
2885 code, without surrounding template.
2887 Optional argument EXT-PLIST, when provided, is a property list
2888 with external parameters overriding Org default settings, but
2889 still inferior to file-local settings.
2891 Return code as a string."
2896 ;; Narrow buffer to an appropriate region or subtree for
2897 ;; parsing. If parsing subtree, be sure to remove main headline
2898 ;; too.
2906 ;; Initialize communication channel with original buffer
2907 ;; attributes, unavailable in its copy.
2920 org-export-options-alist))))
2921 tree)
2922 ;; Update communication channel and get parse tree. Buffer
2923 ;; isn't parsed directly. Instead, all buffer modifications
2924 ;; and consequent parsing are undertaken in a temporary copy.
2926 ;; Run first hook with current back-end's name as argument.
2929 ;; Include files, delete comments and expand macros.
2934 ;; Refresh buffer properties and radio targets after
2935 ;; potentially invasive previous changes. Likewise, do it
2936 ;; again after executing Babel code.
2942 ;; Run last hook with current back-end's name as argument.
2943 ;; Update buffer properties and radio targets one last time
2944 ;; before parsing.
2951 ;; Update communication channel with environment. Also
2952 ;; install user's and developer's filters.
2957 ;; Call options filters and update export options. We do not
2958 ;; use `org-export-filter-apply-functions' here since the
2959 ;; arity of such filters is different.
2964 ;; Expand export-specific set of macros: {{{author}}},
2965 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2966 ;; be done once regular macros have been expanded, since
2967 ;; parsed keywords may contain one of them.
2980 value)
2981 value)))
2985 'finalize
2986 parsed-keywords)
2987 ;; Parse buffer.
2989 ;; Merge footnote definitions outside scope into parse tree.
2991 ;; Prune tree from non-exported elements and transform
2992 ;; uninterpreted elements or objects in both parse tree and
2993 ;; communication channel.
2996 ;; Call parse tree filters.
3000 ;; Now tree is complete, compute its properties and add them
3001 ;; to communication channel.
3005 ;; Eventually transcode TREE. Wrap the resulting string into
3006 ;; a template.
3015 info))
3018 ;; Remove all text properties since they cannot be
3019 ;; retrieved from an external process. Finally call
3020 ;; final-output filter and return result.
3026 info))))))))
3028 ;;;###autoload
3030 "Transcode STRING into BACKEND code.
3032 BACKEND is either an export back-end, as returned by, e.g.,
3033 `org-export-create-backend', or a symbol referring to
3034 a registered back-end.
3036 When optional argument BODY-ONLY is non-nil, only return body
3037 code, without preamble nor postamble.
3039 Optional argument EXT-PLIST, when provided, is a property list
3040 with external parameters overriding Org default settings, but
3041 still inferior to file-local settings.
3043 Return code as a string."
3049 ;;;###autoload
3051 "Replace the active region by its export to BACKEND.
3052 BACKEND is either an export back-end, as returned by, e.g.,
3053 `org-export-create-backend', or a symbol referring to
3054 a registered back-end."
3060 ;;;###autoload
3062 "Insert all export keywords with default values at beginning of line.
3064 BACKEND is a symbol referring to the name of a registered export
3065 back-end, for which specific export options should be added to
3066 the template, or `default' for default template. When it is nil,
3067 the user will be prompted for a category.
3069 If SUBTREEP is non-nil, export configuration will be set up
3070 locally for the subtree through node properties."
3080 "Options category: "
3084 org-export-registered-backends))
3085 nil t))))
3086 options keywords)
3087 ;; Populate OPTIONS and KEYWORDS.
3104 ;; Move to an appropriate location in order to insert options.
3106 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3124 ;; Then the rest of keywords, in the order specified in either
3125 ;; `org-export-options-alist' or respective export back-ends.
3146 "Expand every include keyword in buffer.
3147 Optional argument INCLUDED is a list of included file names along
3148 with their line restriction, when appropriate. It is used to
3149 avoid infinite recursion. Optional argument DIR is the current
3150 working directory. It is used to properly resolve relative
3151 paths. Optional argument FOOTNOTES is a hash-table used for
3152 storing and resolving footnotes. It is created automatically."
3158 ;; If :minlevel is not set the text-property
3159 ;; `:org-include-induced-level' will be used to determine the
3160 ;; relative level when expanding INCLUDE.
3161 ;; Only affects included Org documents.
3165 :org-include-induced-level
3167 ;; Expand INCLUDE keywords.
3173 ;; Extract arguments from keyword's value.
3176 location
3184 matched)
3190 matched)
3191 dir)))
3195 value)
3201 value)
3208 ;; Minimal level of included file defaults to the child
3209 ;; level of the current headline, if any, or one. It
3210 ;; only applies is the file is meant to be included as
3211 ;; an Org one.
3223 ;; Remove keyword.
3229 ;; Check if files has already been parsed. Look after
3230 ;; inclusion lines too, as different parts of the same file
3231 ;; can be included too.
3246 ind-str block arg-str contents ind-str block))))
3253 ind-str block contents ind-str block))))
3261 file location only-contents lines)
3262 lines)))
3266 file lines ind minlevel
3269 footnotes)))
3273 footnotes)
3275 ;; Expand footnotes after all files have been included.
3276 ;; Footnotes are stored at end of buffer.
3281 footnotes)))))))))))
3284 "Resolve absolute lines for an included file with file-link.
3286 FILE is string file-name of the file to include. LOCATION is a
3287 string name within FILE to be included (located via
3288 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3289 contents of the named element will be included, as determined
3290 Org-Element. If LINES is non-nil only those lines are included.
3292 Return a string of lines to be included in the format expected by
3293 `org-export--prepare-file-contents'."
3299 ;; Enforce consistent search.
3312 ;; Skip planning line and property-drawer.
3338 start-line
3340 (+ start-line
3343 counter))))))))
3346 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3348 REF-BEGIN corresponds to the property `:begin' of objects of type
3349 footnote-definition and footnote-reference.
3351 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3352 \[N] where N is one or more numbers.
3354 Return the new label."
3365 "Prepare contents of FILE for inclusion and return it as a string.
3367 When optional argument LINES is a string specifying a range of
3368 lines, include only those lines.
3370 Optional argument IND, when non-nil, is an integer specifying the
3371 global indentation of returned contents. Since its purpose is to
3372 allow an included file to stay in the same environment it was
3373 created \(i.e. a list item), it doesn't apply past the first
3374 headline encountered.
3376 Optional argument MINLEVEL, when non-nil, is an integer
3377 specifying the level that any top-level headline in the included
3378 file should have.
3379 Optional argument ID is an integer that will be inserted before
3380 each footnote definition and reference if FILE is an Org file.
3381 This is useful to avoid conflicts when more than one Org file
3382 with footnotes is included in a document.
3384 Optional argument FOOTNOTES is a hash-table to store footnotes in
3385 the included document.
3386 "
3402 ;; Remove blank lines at beginning and end of contents. The logic
3403 ;; behind that removal is that blank lines around include keyword
3404 ;; override blank lines in included file.
3413 ;; If IND is set, preserve indentation of include keyword until
3414 ;; the first headline encountered.
3421 ;; Do not move footnote definitions out of column 0.
3427 ;; When MINLEVEL is specified, compute minimal level for headlines
3428 ;; in the file (CUR-MIN), and remove stars to each headline so
3429 ;; that headlines with minimal level have a level of MINLEVEL.
3440 ;; Only change stars, don't bother moving whole
3441 ;; sections.
3445 ;; Append ID to all footnote references and definitions, so they
3446 ;; become file specific and cannot collide with footnotes in other
3447 ;; included files. Further, collect relevant footnotes outside of
3448 ;; LINES.
3459 ;; Update the footnote-reference at point and collect
3460 ;; the new label, which is only used for footnotes
3461 ;; outsides LINES.
3463 ;; If label is akin to [1] convert it to [fn:ID-1].
3464 ;; Otherwise add "ID-" after "fn:".
3467 digit-label id)))
3474 "Definition not found for footnote %s in file %s"
3475 label file))
3478 ;; Store since footnote-definition is
3479 ;; outside of LINES.
3483 footnotes)
3484 ;; Update label of definition since it is
3485 ;; included directly.
3487 beginning digit-label id)))))))))))
3493 "Execute every Babel code in the visible part of current buffer."
3494 ;; Get a pristine copy of current buffer so Babel references can be
3495 ;; properly resolved.
3501 "Return a non-nil value when output should be added to the kill ring.
3502 See also `org-export-copy-to-kill-ring'."
3508 \f
3509 ;;; Tools For Back-Ends
3510 ;;
3511 ;; A whole set of tools is available to help build new exporters. Any
3512 ;; function general enough to have its use across many back-ends
3513 ;; should be added here.
3515 ;;;; For Affiliated Keywords
3516 ;;
3517 ;; `org-export-read-attribute' reads a property from a given element
3518 ;; as a plist. It can be used to normalize affiliated keywords'
3519 ;; syntax.
3520 ;;
3521 ;; Since captions can span over multiple lines and accept dual values,
3522 ;; their internal representation is a bit tricky. Therefore,
3523 ;; `org-export-get-caption' transparently returns a given element's
3524 ;; caption as a secondary string.
3527 "Turn ATTRIBUTE property from ELEMENT into a plist.
3529 When optional argument PROPERTY is non-nil, return the value of
3530 that property within attributes.
3534 properties.
3536 All values will become strings except the empty string and
3539 will become the empty string."
3553 s)
3558 ;; Ignore any string before first property with `cdr'.
3563 "Return caption from ELEMENT as a secondary string.
3565 When optional argument SHORTP is non-nil, return short caption,
3566 as a secondary string, instead.
3568 Caption lines are separated by a white space."
3576 ;;;; For Derived Back-ends
3577 ;;
3578 ;; `org-export-with-backend' is a function allowing to locally use
3579 ;; another back-end to transcode some object or element. In a derived
3580 ;; back-end, it may be used as a fall-back function once all specific
3581 ;; cases have been treated.
3584 "Call a transcoder from BACKEND on DATA.
3585 BACKEND is an export back-end, as returned by, e.g.,
3586 `org-export-create-backend', or a symbol referring to
3587 a registered back-end. DATA is an Org element, object, secondary
3588 string or string. CONTENTS, when non-nil, is the transcoded
3589 contents of DATA element, as a string. INFO, when non-nil, is
3590 the communication channel used for export, as a plist."
3600 transcoder data contents
3603 :back-end backend
3604 :translate-alist all-transcoders
3608 ;;;; For Export Snippets
3609 ;;
3610 ;; Every export snippet is transmitted to the back-end. Though, the
3611 ;; latter will only retain one type of export-snippet, ignoring
3612 ;; others, based on the former's target back-end. The function
3613 ;; `org-export-snippet-backend' returns that back-end for a given
3614 ;; export-snippet.
3617 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3618 Translation, with `org-export-snippet-translation-alist', is
3619 applied."
3623 back-end))))
3626 ;;;; For Footnotes
3627 ;;
3628 ;; `org-export-collect-footnote-definitions' is a tool to list
3629 ;; actually used footnotes definitions in the whole parse tree, or in
3630 ;; a headline, in order to add footnote listings throughout the
3631 ;; transcoded data.
3632 ;;
3633 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3634 ;; back-ends, when they need to attach the footnote definition only to
3635 ;; the first occurrence of the corresponding label.
3636 ;;
3637 ;; `org-export-get-footnote-definition' and
3638 ;; `org-export-get-footnote-number' provide easier access to
3639 ;; additional information relative to a footnote reference.
3642 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3643 INFO is the plist used as a communication channel. If no such
3644 definition can be found, raise an error."
3650 hash))))
3658 info t)
3659 cache)
3664 "Apply FUNCTION on every footnote reference in DATA.
3665 INFO is a plist containing export state. By default, as soon as
3666 a new footnote reference is encountered, FUNCTION is called onto
3667 its definition. However, if BODY-FIRST is non-nil, this step is
3668 delayed until the end of the process."
3673 ;; Search footnote references through DATA, filling
3674 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3675 ;; store footnote definitions so they can be entered
3676 ;; later.
3683 ;; Search for subsequent references in footnote
3684 ;; definition so numbering follows reading
3685 ;; logic, unless DELAYP in non-nil.
3689 definitions))
3690 ;; Do not force entering inline definitions,
3691 ;; since `org-element-map' already traverses
3692 ;; them at the right time.
3696 nil))))))
3697 info nil
3698 ;; Don't enter footnote definitions since it will
3699 ;; happen when their first reference is found.
3700 ;; Moreover, if DELAYP is non-nil, make sure we
3701 ;; postpone entering definitions of inline references.
3708 "Return an alist between footnote numbers, labels and definitions.
3710 INFO is the current export state, as a plist.
3712 Definitions are collected throughout the whole parse tree, or
3713 DATA when non-nil.
3715 Sorting is done by order of references. As soon as a new
3716 reference is encountered, other references are searched within
3717 its definition. However, if BODY-FIRST is non-nil, this step is
3718 delayed after the whole tree is checked. This alters results
3719 when references are found in footnote definitions.
3721 Definitions either appear as Org data or as a secondary string
3722 for inlined footnotes. Unreferenced definitions are ignored."
3726 ;; Collect footnote number, label and definition.
3737 "Non-nil when a footnote reference is the first one for its label.
3739 FOOTNOTE-REFERENCE is the footnote reference being considered.
3740 INFO is a plist containing current export state.
3742 Search is done throughout the whole parse tree, or DATA when
3743 non-nil.
3745 By default, as soon as a new footnote reference is encountered,
3746 other references are searched within its definition. However, if
3747 BODY-FIRST is non-nil, this step is delayed after the whole tree
3748 is checked. This alters results when references are found in
3749 footnote definitions."
3751 ;; Anonymous footnotes are always a first reference.
3762 "Return number associated to a footnote.
3764 FOOTNOTE is either a footnote reference or a footnote definition.
3765 INFO is the plist containing export state.
3767 Number is unique throughout the whole parse tree, or DATA, when
3768 non-nil.
3770 By default, as soon as a new footnote reference is encountered,
3771 counting process moves into its definition. However, if
3772 BODY-FIRST is non-nil, this step is delayed until the end of the
3773 process, leading to a different order when footnotes are nested."
3782 ;; Anonymous footnote match: return number.
3784 ;; Labels match: return number.
3786 ;; Otherwise store label and increase counter if label
3787 ;; wasn't encountered yet.
3793 ;;;; For Headlines
3794 ;;
3795 ;; `org-export-get-relative-level' is a shortcut to get headline
3796 ;; level, relatively to the lower headline level in the parsed tree.
3797 ;;
3798 ;; `org-export-get-headline-number' returns the section number of an
3799 ;; headline, while `org-export-number-to-roman' allows to convert it
3800 ;; to roman numbers. With an optional argument,
3801 ;; `org-export-get-headline-number' returns a number to unnumbered
3802 ;; headlines (used for internal id).
3803 ;;
3804 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3805 ;; `org-export-last-sibling-p' are three useful predicates when it
3806 ;; comes to fulfill the `:headline-levels' property.
3807 ;;
3808 ;; `org-export-get-tags', `org-export-get-category' and
3809 ;; `org-export-get-node-property' extract useful information from an
3810 ;; headline or a parent headline. They all handle inheritance.
3811 ;;
3812 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3813 ;; as a secondary string, suitable for table of contents. It falls
3814 ;; back onto default title.
3817 "Return HEADLINE relative level within current parsed tree.
3818 INFO is a plist holding contextual information."
3823 "Non-nil when HEADLINE is considered as low level.
3825 INFO is a plist used as a communication channel.
3827 A low level headlines has a relative level greater than
3828 `:headline-levels' property value.
3830 Return value is the difference between HEADLINE relative level
3831 and the last level being considered as high enough, or nil."
3838 "Return numbered HEADLINE numbering as a list of numbers.
3839 INFO is a plist holding contextual information."
3844 "Return a non-nil value if HEADLINE element should be numbered.
3845 INFO is a plist used as a communication channel."
3854 "Convert integer N into a roman numeral."
3867 res)))
3870 "Return list of tags associated to ELEMENT.
3872 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3873 is a plist used as a communication channel.
3875 Select tags (see `org-export-select-tags') and exclude tags (see
3876 `org-export-exclude-tags') are removed from the list.
3878 When non-nil, optional argument TAGS should be a list of strings.
3879 Any tag belonging to this list will also be removed.
3881 When optional argument INHERITED is non-nil, tags can also be
3882 inherited from parent headlines and FILETAGS keywords."
3888 ;; Build complete list of inherited tags.
3895 ;; Add FILETAGS keywords and return results.
3899 "Return node PROPERTY value for BLOB.
3901 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3902 element or object.
3904 If optional argument INHERITED is non-nil, the value can be
3905 inherited from a parent headline.
3907 Return value is a string or nil."
3919 "Return category for element or object BLOB.
3921 INFO is a plist used as a communication channel.
3923 CATEGORY is automatically inherited from a parent headline, from
3924 #+CATEGORY: keyword or created out of original file name. If all
3937 "Return alternative title for HEADLINE, as a secondary string.
3938 If no optional title is defined, fall-back to the regular title."
3945 "Non-nil when BLOB is the first sibling in its parent.
3946 BLOB is an element or an object. If BLOB is a headline, non-nil
3947 means it is the first sibling in the sub-tree. INFO is a plist
3948 used as a communication channel."
3953 "Non-nil when BLOB is the last sibling in its parent.
3954 BLOB is an element or an object. INFO is a plist used as
3955 a communication channel."
3959 ;;;; For Keywords
3960 ;;
3961 ;; `org-export-get-date' returns a date appropriate for the document
3962 ;; to about to be exported. In particular, it takes care of
3963 ;; `org-export-date-timestamp-format'.
3966 "Return date value for the current document.
3968 INFO is a plist used as a communication channel. FMT, when
3969 non-nil, is a time format string that will be applied on the date
3970 if it consists in a single timestamp object. It defaults to
3971 `org-export-date-timestamp-format' when nil.
3973 A proper date can be a secondary string, a string or nil. It is
3974 meant to be translated with `org-export-data' or alike."
3985 ;;;; For Links
3986 ;;
3987 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3988 ;; with `org-add-link-type', which see.
3989 ;;
3990 ;; `org-export-get-coderef-format' returns an appropriate format
3991 ;; string for coderefs.
3992 ;;
3993 ;; `org-export-inline-image-p' returns a non-nil value when the link
3994 ;; provided should be considered as an inline image.
3995 ;;
3996 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3997 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3998 ;; returns an appropriate unique identifier when found, or nil.
3999 ;;
4000 ;; `org-export-resolve-id-link' returns the first headline with
4001 ;; specified id or custom-id in parse tree, the path to the external
4002 ;; file with the id or nil when neither was found.
4003 ;;
4004 ;; `org-export-resolve-coderef' associates a reference to a line
4005 ;; number in the element it belongs, or returns the reference itself
4006 ;; when the element isn't numbered.
4007 ;;
4008 ;; `org-export-file-uri' expands a filename as stored in :path value
4009 ;; of a "file" link into a file URI.
4012 "Try exporting LINK with a dedicated function.
4014 DESC is its description, as a string, or nil. BACKEND is the
4015 back-end used for export, as a symbol.
4017 Return output as a string, or nil if no protocol handles LINK.
4019 A custom protocol has precedence over regular back-end export.
4020 The function ignores links with an implicit type (e.g.,
4029 desc
4030 backend))))))
4033 "Return format string for code reference link.
4034 PATH is the link path. DESC is its description."
4042 "Non-nil if LINK object points to an inline image.
4044 Optional argument is a set of RULES defining inline images. It
4045 is an alist where associations have the following shape:
4047 \(TYPE . REGEXP)
4049 Applying a rule means apply REGEXP against LINK's path when its
4050 type is TYPE. The function will return a non-nil value if any of
4051 the provided rules is non-nil. The default rule is
4052 `org-export-default-inline-image-rule'.
4054 This only applies to links without a description."
4065 "Resolve a code reference REF.
4067 INFO is a plist used as a communication channel.
4069 Return associated line number in source code, or REF itself,
4070 depending on src-block or example element's switches. Throw an
4071 error if no block contains REF."
4078 org-coderef-label-format)))
4082 ;; Element containing REF is found. Resolve it to
4083 ;; either a label or a line number, as needed.
4094 "Return LINK destination.
4096 INFO is a plist holding contextual information.
4098 Return value can be an object, an element, or nil:
4100 - If LINK path matches a target object (i.e. <<path>>) return it.
4102 - If LINK path exactly matches the name affiliated keyword
4103 \(i.e. #+NAME: path) of an element, return that element.
4105 - If LINK path exactly matches any headline name, return that
4106 element.
4108 - Otherwise, throw an error.
4111 significant."
4114 ;; Split PATH at white spaces so matches are space
4115 ;; insensitive.
4121 :resolve-fuzzy-link-cache
4128 path
4130 ;; First try to find a matching "<<path>>" unless user
4131 ;; specified he was looking for a headline (path starts with
4132 ;; a "*" character).
4138 path)
4139 datum))
4141 ;; Then try to find an element with a matching "#+NAME: path"
4142 ;; affiliated keyword.
4149 ;; Try to find a matching headline.
4156 path)
4157 h))
4160 link-cache)))))
4163 "Return headline referenced as LINK destination.
4165 INFO is a plist used as a communication channel.
4167 Return value can be the headline element matched in current parse
4171 ;; First check if id is within the current parse tree.
4176 headline))
4178 ;; Otherwise, look for external files.
4183 "Return radio-target object referenced as LINK destination.
4185 INFO is a plist used as a communication channel.
4187 Return value can be a radio-target object or nil. Assume LINK
4196 nil nil path nil nil t)
4197 t)
4198 radio))
4202 "Return file URI associated to FILENAME."
4208 filename))))
4211 ;;;; For References
4212 ;;
4213 ;; `org-export-get-reference' associate a unique reference for any
4214 ;; object or element.
4215 ;;
4216 ;; `org-export-get-ordinal' associates a sequence number to any object
4217 ;; or element.
4220 "Return a unique reference for DATUM, as a string.
4221 DATUM is either an element or an object. INFO is the current
4222 export state, as a plist. Returned reference consists of
4223 alphanumeric characters only."
4228 h))))
4236 cache))))
4239 "Return ordinal number of an element or object.
4241 ELEMENT is the element or object considered. INFO is the plist
4242 used as a communication channel.
4244 Optional argument TYPES, when non-nil, is a list of element or
4245 object types, as symbols, that should also be counted in.
4246 Otherwise, only provided element's type is considered.
4248 Optional argument PREDICATE is a function returning a non-nil
4249 value if the current element or object should be counted in. It
4250 accepts two arguments: the element or object being considered and
4251 the plist used as a communication channel. This allows to count
4252 only a certain type of objects (i.e. inline images).
4254 Return value is a list of numbers if ELEMENT is a headline or an
4255 item. It is nil for keywords. It represents the footnote number
4256 for footnote definitions and footnote references. If ELEMENT is
4257 a target, return the same value as if ELEMENT was the closest
4258 table, item or headline containing the target. In any other
4259 case, return the sequence number of ELEMENT among elements or
4260 objects of the same type."
4261 ;; Ordinal of a target object refer to the ordinal of the closest
4262 ;; table, item, or headline containing the object.
4266 element
4269 ;; Special case 1: A headline returns its number as a list.
4271 ;; Special case 2: An item returns its number as a list.
4275 struct
4282 ;; Increment counter until ELEMENT is found again.
4293 ;;;; For Src-Blocks
4294 ;;
4295 ;; `org-export-get-loc' counts number of code lines accumulated in
4296 ;; src-block or example-block elements with a "+n" switch until
4297 ;; a given element, excluded. Note: "-n" switches reset that count.
4298 ;;
4299 ;; `org-export-unravel-code' extracts source code (along with a code
4300 ;; references alist) from an `element-block' or `src-block' type
4301 ;; element.
4302 ;;
4303 ;; `org-export-format-code' applies a formatting function to each line
4304 ;; of code, providing relative line number and code reference when
4305 ;; appropriate. Since it doesn't access the original element from
4306 ;; which the source code is coming, it expects from the code calling
4307 ;; it to know if lines should be numbered and if code references
4308 ;; should appear.
4309 ;;
4310 ;; Eventually, `org-export-format-code-default' is a higher-level
4311 ;; function (it makes use of the two previous functions) which handles
4312 ;; line numbering and code references inclusion, and returns source
4313 ;; code in a format suitable for plain text or verbatim output.
4316 "Return accumulated lines of code up to ELEMENT.
4318 INFO is the plist used as a communication channel.
4320 ELEMENT is excluded from count."
4326 ;; ELEMENT is reached: Quit the loop.
4328 ;; Only count lines from src-block and example-block elements
4329 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4333 ;; Accumulate locs or reset them.
4337 ;; Return nil to stay in the loop.
4338 nil)))
4340 ;; Return value.
4341 loc))
4344 "Clean source code and extract references out of it.
4346 ELEMENT has either a `src-block' an `example-block' type.
4348 Return a cons cell whose CAR is the source code, cleaned from any
4349 reference, protective commas and spurious indentation, and CDR is
4350 an alist between relative line number (integer) and name of code
4351 reference on that line (string)."
4354 ;; Get code and clean it. Remove blank lines at its
4355 ;; beginning and end.
4362 value
4364 ;; Get format used for references.
4367 org-coderef-label-format)))
4368 ;; Build a regexp matching a loc with a reference.
4373 ;; Return value.
4375 ;; Code with references removed.
4381 ;; Ref line: remove ref, and signal its position in REFS.
4385 ;; Reference alist.
4386 refs)))
4389 "Format CODE by applying FUN line-wise and return it.
4391 CODE is a string representing the code to format. FUN is
4392 a function. It must accept three arguments: a line of
4393 code (string), the current line number (integer) or nil and the
4394 reference associated to the current line (string) or nil.
4396 Optional argument NUM-LINES can be an integer representing the
4397 number of code lines accumulated until the current code. Line
4398 numbers passed to FUN will take it into account. If it is nil,
4399 FUN's second argument will always be nil. This number can be
4400 obtained with `org-export-get-loc' function.
4402 Optional argument REF-ALIST can be an alist between relative line
4403 number (i.e. ignoring NUM-LINES) and the name of the code
4404 reference on it. If it is nil, FUN's third argument will always
4405 be nil. It can be obtained through the use of
4406 `org-export-unravel-code' function."
4418 "Return source code from ELEMENT, formatted in a standard way.
4420 ELEMENT is either a `src-block' or `example-block' element. INFO
4421 is a plist used as a communication channel.
4423 This function takes care of line numbering and code references
4424 inclusion. Line numbers, when applicable, appear at the
4425 beginning of the line, separated from the code by two white
4426 spaces. Code references, on the other hand, appear flushed to
4427 the right, separated by six white spaces from the widest line of
4428 code."
4429 ;; Extract code and references.
4436 ;; Handle line numbering.
4445 ;; Prepare references display, if required. Any reference
4446 ;; should start six columns after the widest line of code,
4447 ;; wrapped with parenthesis.
4452 code
4456 number-str
4457 loc
4463 num-start refs)))))
4466 ;;;; For Tables
4467 ;;
4468 ;; `org-export-table-has-special-column-p' and and
4469 ;; `org-export-table-row-is-special-p' are predicates used to look for
4470 ;; meta-information about the table structure.
4471 ;;
4472 ;; `org-table-has-header-p' tells when the rows before the first rule
4473 ;; should be considered as table's header.
4474 ;;
4475 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4476 ;; and `org-export-table-cell-borders' extract information from
4477 ;; a table-cell element.
4478 ;;
4479 ;; `org-export-table-dimensions' gives the number on rows and columns
4480 ;; in the table, ignoring horizontal rules and special columns.
4481 ;; `org-export-table-cell-address', given a table-cell object, returns
4482 ;; the absolute address of a cell. On the other hand,
4483 ;; `org-export-get-table-cell-at' does the contrary.
4484 ;;
4485 ;; `org-export-table-cell-starts-colgroup-p',
4486 ;; `org-export-table-cell-ends-colgroup-p',
4487 ;; `org-export-table-row-starts-rowgroup-p',
4488 ;; `org-export-table-row-ends-rowgroup-p',
4489 ;; `org-export-table-row-starts-header-p',
4490 ;; `org-export-table-row-ends-header-p' and
4491 ;; `org-export-table-row-in-header-p' indicate position of current row
4492 ;; or cell within the table.
4495 "Non-nil when TABLE has a special column.
4496 All special columns will be ignored during export."
4497 ;; The table has a special column when every first cell of every row
4498 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4499 ;; "*" "_" and "^". Though, do not consider a first row containing
4500 ;; only empty cells as special.
4516 "Non-nil when TABLE has a header.
4518 INFO is a plist used as a communication channel.
4520 A table has a header when it contains at least two row groups."
4529 table
4540 cache)))))
4543 "Non-nil if TABLE-ROW is considered special.
4544 All special rows will be ignored during export."
4548 ;; A row is special either when...
4550 ;; ... it starts with a field only containing "/",
4552 ;; ... the table contains a special column and the row start
4553 ;; with a marking character among, "^", "_", "$" or "!",
4557 ;; ... it contains only alignment cookies and empty cells.
4563 ;; Since VALUE is a secondary string, the following
4564 ;; checks avoid expanding it with `org-export-data'.
4576 "Return TABLE-ROW's group number, as an integer.
4578 INFO is a plist used as the communication channel.
4580 Return value is the group number, as an integer, or nil for
4581 special rows and rows separators. First group is also table's
4582 header."
4600 "Return TABLE-CELL contents width.
4602 INFO is a plist used as the communication channel.
4604 Return value is the width given by the last width cookie in the
4605 same column as TABLE-CELL, or nil."
4624 ;; In a special row, try to find a width cookie at COLUMN.
4628 ;; The following checks avoid expanding unnecessarily
4629 ;; the cell with `org-export-data'.
4639 "Return TABLE-CELL contents alignment.
4641 INFO is a plist used as the communication channel.
4643 Return alignment as specified by the last alignment cookie in the
4644 same column as TABLE-CELL. If no such cookie is found, a default
4645 alignment value will be deduced from fraction of numbers in the
4646 column (see `org-table-number-fraction' for more information).
4647 Possible values are `left', `right' and `center'."
4648 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4665 cookie-align
4666 previous-cell-number-p)
4669 ;; In a special row, try to find an alignment cookie at
4670 ;; COLUMN.
4674 ;; Since VALUE is a secondary string, the following
4675 ;; checks avoid useless expansion through
4676 ;; `org-export-data'.
4684 ;; Ignore table rules.
4686 ;; In a standard row, check if cell's contents are
4687 ;; expressing some kind of number. Increase NUMBER-CELLS
4688 ;; accordingly. Though, don't bother if an alignment
4689 ;; cookie has already defined cell's alignment.
4694 info)))
4696 ;; Treat an empty cell as a number if it follows
4697 ;; a number.
4703 ;; Return value. Alignment specified by cookies has
4704 ;; precedence over alignment deduced from cell's contents.
4706 column
4711 org-table-number-fraction)
4716 "Return TABLE-CELL borders.
4718 INFO is a plist used as a communication channel.
4720 Return value is a list of symbols, or nil. Possible values are:
4721 `top', `bottom', `above', `below', `left' and `right'. Note:
4722 `top' (resp. `bottom') only happen for a cell in the first
4723 row (resp. last row) of the table, ignoring table rules, if any.
4725 Returned borders ignore special rows."
4728 borders)
4729 ;; Top/above border? TABLE-CELL has a border above when a rule
4730 ;; used to demarcate row groups can be found above. Hence,
4731 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4732 ;; another regular row has to be found above that rule.
4741 ;; Look at every row before the current one.
4743 ;; No rule above, or rule found starts the table (ignoring any
4744 ;; special row): TABLE-CELL is at the top of the table.
4747 ;; Bottom/below border? TABLE-CELL has a border below when next
4748 ;; non-regular row below is a rule.
4757 ;; Look at every row after the current one.
4759 ;; No rule below, or rule found ends the table (modulo some
4760 ;; special row): TABLE-CELL is at the bottom of the table.
4763 ;; Right/left borders? They can only be specified by column
4764 ;; groups. Column groups are defined in a row starting with "/".
4765 ;; Also a column groups row only contains "<", "<>", ">" or blank
4766 ;; cells.
4783 ;; There's a left border when previous cell, if
4784 ;; any, ends a group, or current one starts one.
4790 ;; There's a right border when next cell, if any,
4791 ;; starts a group, or current one ends one.
4798 ;; Table rows are read in reverse order so last column groups
4799 ;; row has precedence over any previous one.
4801 ;; Return value.
4802 borders))
4805 "Non-nil when TABLE-CELL is at the beginning of a column group.
4806 INFO is a plist used as a communication channel."
4807 ;; A cell starts a column group either when it is at the beginning
4808 ;; of a row (or after the special column, if any) or when it has
4809 ;; a left border.
4812 table-cell)
4816 "Non-nil when TABLE-CELL is at the end of a column group.
4817 INFO is a plist used as a communication channel."
4818 ;; A cell ends a column group either when it is at the end of a row
4819 ;; or when it has a right border.
4822 table-cell)
4826 "Non-nil when TABLE-ROW is at the beginning of a row group.
4827 INFO is a plist used as a communication channel."
4835 "Non-nil when TABLE-ROW is at the end of a row group.
4836 INFO is a plist used as a communication channel."
4844 "Non-nil when TABLE-ROW is located within table's header.
4845 INFO is a plist used as a communication channel. Always return
4846 nil for special rows and rows separators."
4852 "Non-nil when TABLE-ROW is the first table header's row.
4853 INFO is a plist used as a communication channel."
4858 "Non-nil when TABLE-ROW is the last table header's row.
4859 INFO is a plist used as a communication channel."
4864 "Return TABLE-ROW number.
4865 INFO is a plist used as a communication channel. Return value is
4866 zero-based and ignores separators. The function returns nil for
4867 special columns and separators."
4879 "Return TABLE dimensions.
4881 INFO is a plist used as a communication channel.
4883 Return value is a CONS like (ROWS . COLUMNS) where
4884 ROWS (resp. COLUMNS) is the number of exportable
4885 rows (resp. columns)."
4887 ;; Set number of rows, and extract first one.
4893 ;; Set number of columns.
4895 ;; Return value.
4899 "Return address of a regular TABLE-CELL object.
4901 TABLE-CELL is the cell considered. INFO is a plist used as
4902 a communication channel.
4904 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4905 zero-based index. Only exportable cells are considered. The
4906 function returns nil for other cells."
4918 "Return regular table-cell object at ADDRESS in TABLE.
4920 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4921 zero-based index. TABLE is a table type element. INFO is
4922 a plist used as a communication channel.
4924 If no table-cell, among exportable cells, is found at ADDRESS,
4925 return nil."
4928 ;; Row at (car address) or nil.
4936 'table-cell
4943 ;;;; For Tables Of Contents
4944 ;;
4945 ;; `org-export-collect-headlines' builds a list of all exportable
4946 ;; headline elements, maybe limited to a certain depth. One can then
4947 ;; easily parse it and transcode it.
4948 ;;
4949 ;; Building lists of tables, figures or listings is quite similar.
4950 ;; Once the generic function `org-export-collect-elements' is defined,
4951 ;; `org-export-collect-tables', `org-export-collect-figures' and
4952 ;; `org-export-collect-listings' can be derived from it.
4955 "Collect headlines in order to build a table of contents.
4957 INFO is a plist used as a communication channel.
4959 When optional argument N is an integer, it specifies the depth of
4960 the table of contents. Otherwise, it is set to the value of the
4961 last headline level. See `org-export-headline-levels' for more
4962 information.
4964 Optional argument SCOPE, when non-nil, is an element. If it is
4965 a headline, only children of SCOPE are collected. Otherwise,
4966 collect children of the headline containing provided element. If
4967 there is no such headline, collect all headlines. In any case,
4968 argument N becomes relative to the level of that headline.
4970 Return a list of all exportable headlines as parsed elements.
4971 Footnote sections are ignored."
4980 limit))))
4986 info)))
4989 "Collect referenceable elements of a determined type.
4991 TYPE can be a symbol or a list of symbols specifying element
4992 types to search. Only elements with a caption are collected.
4994 INFO is a plist used as a communication channel.
4996 When non-nil, optional argument PREDICATE is a function accepting
4997 one argument, an element of type TYPE. It returns a non-nil
4998 value when that element should be collected.
5000 Return a list of all elements found, in order of appearance."
5005 element))
5006 info))
5009 "Build a list of tables.
5010 INFO is a plist used as a communication channel.
5012 Return a list of table elements with a caption."
5016 "Build a list of figures.
5018 INFO is a plist used as a communication channel. PREDICATE is
5019 a function which accepts one argument: a paragraph element and
5020 whose return value is non-nil when that element should be
5021 collected.
5023 A figure is a paragraph type element, with a caption, verifying
5025 a vague concept that may depend on back-end.
5027 Return a list of elements recognized as figures."
5031 "Build a list of src blocks.
5033 INFO is a plist used as a communication channel.
5035 Return a list of src-block elements with a caption."
5039 ;;;; Smart Quotes
5040 ;;
5041 ;; The main function for the smart quotes sub-system is
5042 ;; `org-export-activate-smart-quotes', which replaces every quote in
5043 ;; a given string from the parse tree with its "smart" counterpart.
5044 ;;
5045 ;; Dictionary for smart quotes is stored in
5046 ;; `org-export-smart-quotes-alist'.
5050 ;; one may use: »...«, "...", ›...‹, or '...'.
5051 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5052 ;; LaTeX quotes require Babel!
5097 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5106 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5115 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5124 ;; 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
5125 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5136 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5142 )
5143 "Smart quotes translations.
5145 Alist whose CAR is a language string and CDR is an alist with
5146 quote type as key and a plist associating various encodings to
5147 their translation as value.
5149 A quote type can be any symbol among `opening-double-quote',
5150 `closing-double-quote', `opening-single-quote',
5151 `closing-single-quote' and `apostrophe'.
5153 Valid encodings include `:utf-8', `:html', `:latex' and
5154 `:texinfo'.
5159 "Return smart quote status at the beginning of string S.
5160 INFO is the current export state, as a plist."
5165 table)))
5180 ;; Not already in a level 1 quote: this is an
5181 ;; apostrophe.
5183 ;; Apostrophe.
5185 ;; Apostrophe at the beginning of a string. Check
5186 ;; white space at the end of the last object.
5195 ;; Apostrophe at the end of a string. Check white
5196 ;; space at the beginning of the next object, which
5197 ;; can only happen if that object is a string.
5204 ;; Lonesome apostrophe. Check white space around
5205 ;; both ends.
5217 n))))))))
5219 ;; Else, consider it as a level 2 quote.
5223 current-status))
5226 info nil org-element-recursive-objects)
5233 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5234 `:utf-8'. INFO is a plist used as a communication channel.
5236 The function has to retrieve information about string
5237 surroundings in parse tree. It can only happen with an
5238 unmodified string. Thus, if S has already been through another
5239 process, a non-nil ORIGINAL optional argument will provide that
5240 original string.
5242 Return the new string."
5251 org-export-smart-quotes-alist))))
5252 encoding)
5253 match))
5254 s nil t)))
5256 ;;;; Topology
5257 ;;
5258 ;; Here are various functions to retrieve information about the
5259 ;; neighborhood of a given element or object. Neighbors of interest
5260 ;; are direct parent (`org-export-get-parent'), parent headline
5261 ;; (`org-export-get-parent-headline'), first element containing an
5262 ;; object, (`org-export-get-parent-element'), parent table
5263 ;; (`org-export-get-parent-table'), previous element or object
5264 ;; (`org-export-get-previous-element') and next element or object
5265 ;; (`org-export-get-next-element').
5267 ;; defsubst org-export-get-parent must be defined before first use
5273 "Return BLOB parent headline or nil.
5274 BLOB is the element or object being considered."
5278 "Return first element containing OBJECT or nil.
5279 OBJECT is the object to consider."
5283 "Return OBJECT parent table or nil.
5284 OBJECT is either a `table-cell' or `table-element' type object."
5288 "Return previous element or object.
5290 BLOB is an element or object. INFO is a plist used as
5291 a communication channel. Return previous exportable element or
5292 object, a string, or nil.
5294 When optional argument N is a positive integer, return a list
5295 containing up to N siblings before BLOB, from farthest to
5296 closest. With any other non-nil value, return a list containing
5297 all of them."
5303 prev)
5313 "Return next element or object.
5315 BLOB is an element or object. INFO is a plist used as
5316 a communication channel. Return next exportable element or
5317 object, a string, or nil.
5319 When optional argument N is a positive integer, return a list
5320 containing up to N siblings after BLOB, from closest to farthest.
5321 With any other non-nil value, return a list containing all of
5322 them."
5329 next)
5339 ;;;; Translation
5340 ;;
5341 ;; `org-export-translate' translates a string according to the language
5342 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5343 ;; the dictionary used for the translation.
5375 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5385 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5391 ("ru" :html "(Продолжение следует)"
5465 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5488 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5494 ("ru" :html "Список распечаток"
5508 ("ru" :html "Список таблиц"
5614 ("ru" :html "Неизвестная ссылка"
5617 "Dictionary for export engine.
5619 Alist whose car is the string to translate and cdr is an alist
5620 whose car is the language string and cdr is a plist whose
5621 properties are possible charsets and values translated terms.
5623 It is used as a database for `org-export-translate'. Since this
5624 function returns the string as-is if no translation was found,
5625 the variable only needs to record values different from the
5629 "Translate string S according to language specification.
5631 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5632 and `:utf-8'. INFO is a plist used as a communication channel.
5634 Translation depends on `:language' property. Return the
5635 translated string. If no translation is found, try to fall back
5636 to `:default' encoding. If it fails, return S."
5642 s)))
5645 \f
5646 ;;; Asynchronous Export
5647 ;;
5648 ;; `org-export-async-start' is the entry point for asynchronous
5649 ;; export. It recreates current buffer (including visibility,
5650 ;; narrowing and visited file) in an external Emacs process, and
5651 ;; evaluates a command there. It then applies a function on the
5652 ;; returned results in the current process.
5653 ;;
5654 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5655 ;; allow to export to a buffer or a file, asynchronously or not.
5656 ;;
5657 ;; `org-export-output-file-name' is an auxiliary function meant to be
5658 ;; used with `org-export-to-file'. With a given extension, it tries
5659 ;; to provide a canonical file name to write export output to.
5660 ;;
5661 ;; Asynchronously generated results are never displayed directly.
5662 ;; Instead, they are stored in `org-export-stack-contents'. They can
5663 ;; then be retrieved by calling `org-export-stack'.
5664 ;;
5665 ;; Export Stack is viewed through a dedicated major mode
5666 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5667 ;;`org-export-stack-delete', `org-export-stack-view' and
5668 ;;`org-export-stack-clear'.
5669 ;;
5670 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5671 ;; It should be used whenever `org-export-async-start' is called.
5674 "Call function FUN on the results returned by BODY evaluation.
5676 FUN is an anonymous function of one argument. BODY evaluation
5677 happens in an asynchronous process, from a buffer which is an
5678 exact copy of the current one.
5680 Use `org-export-add-to-stack' in FUN in order to register results
5681 in the stack.
5683 This is a low level function. See also `org-export-to-buffer'
5684 and `org-export-to-file' for more specialized functions."
5687 ;; Write the full sexp evaluating BODY in a copy of the current
5688 ;; buffer to a temporary file, as it may be too long for program
5689 ;; args in `start-process'.
5696 ;; Null characters (from variable values) are inserted
5697 ;; within the file. As a consequence, coding system for
5698 ;; buffer contents will not be recognized properly. So,
5699 ;; we make sure it is the same as the one used to display
5700 ;; the original buffer.
5702 ,coding
5705 ;; Ignore `kill-emacs-hook' and code evaluation
5706 ;; queries from Babel as we need a truly
5707 ;; non-interactive process.
5709 org-babel-confirm-evaluate-answer-no t)
5710 ;; Initialize export framework.
5712 ;; Re-create current buffer there.
5715 ;; Sexp to evaluate in the buffer.
5717 ;; Start external process.
5720 (,process
5722 #'start-process
5725 ,proc-buffer
5732 ;; Register running process in stack.
5734 ;; Set-up sentinel in order to catch results.
5737 ,process
5759 ;;;###autoload
5762 &optional async subtreep visible-only body-only ext-plist
5763 post-process)
5764 "Call `org-export-as' with output to a specified buffer.
5766 BACKEND is either an export back-end, as returned by, e.g.,
5767 `org-export-create-backend', or a symbol referring to
5768 a registered back-end.
5770 BUFFER is the name of the output buffer. If it already exists,
5771 it will be erased first, otherwise, it will be created.
5773 A non-nil optional argument ASYNC means the process should happen
5774 asynchronously. The resulting buffer should then be accessible
5775 through the `org-export-stack' interface. When ASYNC is nil, the
5776 buffer is displayed if `org-export-show-temporary-export-buffer'
5777 is non-nil.
5779 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5780 EXT-PLIST are similar to those used in `org-export-as', which
5781 see.
5783 Optional argument POST-PROCESS is a function which should accept
5784 no argument. It is always called within the current process,
5785 from BUFFER, with point at its beginning. Export back-ends can
5786 use it to set a major mode there, e.g,
5788 \(defun org-latex-export-as-latex
5789 \(&optional async subtreep visible-only body-only ext-plist)
5790 \(interactive)
5792 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5794 This function returns BUFFER."
5822 buffer)))
5824 ;;;###autoload
5827 post-process)
5828 "Call `org-export-as' with output to a specified file.
5830 BACKEND is either an export back-end, as returned by, e.g.,
5831 `org-export-create-backend', or a symbol referring to
5832 a registered back-end. FILE is the name of the output file, as
5833 a string.
5835 A non-nil optional argument ASYNC means the process should happen
5836 asynchronously. The resulting buffer will then be accessible
5837 through the `org-export-stack' interface.
5839 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5840 EXT-PLIST are similar to those used in `org-export-as', which
5841 see.
5843 Optional argument POST-PROCESS is called with FILE as its
5844 argument and happens asynchronously when ASYNC is non-nil. It
5845 has to return a file name, or nil. Export back-ends can use this
5846 to send the output file through additional processing, e.g,
5848 \(defun org-latex-export-to-latex
5849 \(&optional async subtreep visible-only body-only ext-plist)
5850 \(interactive)
5852 \(org-export-to-file 'latex outfile
5853 async subtreep visible-only body-only ext-plist
5854 \(lambda (file) (org-latex-compile file)))
5856 The function returns either a file name returned by POST-PROCESS,
5857 or FILE."
5876 backend subtreep visible-only body-only ext-plist)))
5883 ;; Get proper return value.
5885 file))))))
5888 "Return output file's name according to buffer specifications.
5890 EXTENSION is a string representing the output file extension,
5891 with the leading dot.
5893 With a non-nil optional argument SUBTREEP, try to determine
5895 of subtree at point.
5897 When optional argument PUB-DIR is set, use it as the publishing
5898 directory.
5900 Return file name as a string."
5903 ;; File name may come from EXPORT_FILE_NAME subtree
5904 ;; property, assuming point is at beginning of said
5905 ;; sub-tree.
5912 ;; File name may be extracted from buffer's associated
5913 ;; file, if any.
5915 ;; Can't determine file name on our own: Ask user.
5919 "Output file: " pub-dir nil nil nil
5923 ;; Build file name. Enforce EXTENSION over whatever user
5924 ;; may have come up with. PUB-DIR, if defined, always has
5925 ;; precedence over any provided path.
5930 extension))
5933 ;; If writing to OUTPUT-FILE would overwrite original file, append
5934 ;; EXTENSION another time to final name.
5937 output-file)))
5940 "Add a new result to export stack if not present already.
5942 SOURCE is a buffer or a file name containing export results.
5943 BACKEND is a symbol representing export back-end used to generate
5944 it.
5946 Entries already pointing to SOURCE and unavailable entries are
5947 removed beforehand. Return the new stack."
5953 "Menu for asynchronous export results and running processes."
5963 "Return source from export results at point in stack."
5970 source
5971 ;; SOURCE is not consistent with current line. The stack
5972 ;; view is outdated.
5976 "Remove all entries from export stack."
5981 "Refresh the asynchronous export stack.
5982 Unavailable sources are removed from the list. Return the new
5983 stack."
5992 ;; Back-end.
5994 ;; Age.
5997 ;; Compute age of the results.
5999 "%4h:%.2m "
6001 ;; Source.
6006 ;; Clear stack from exited processes, dead buffers or
6007 ;; non-existent files.
6019 "Remove export results at point from stack.
6020 If optional argument SOURCE is non-nil, remove it instead."
6025 org-export-stack-contents))))
6028 "View export results at point in stack.
6029 With an optional prefix argument IN-EMACS, force viewing files
6030 within Emacs."
6044 (define-key km "p" 'previous-line)
6045 (define-key km "\C-p" 'previous-line)
6046 (define-key km "\C-?" 'previous-line)
6047 (define-key km [up] 'previous-line)
6048 (define-key km "C" 'org-export-stack-clear)
6049 (define-key km "v" 'org-export-stack-view)
6050 (define-key km (kbd "RET") 'org-export-stack-view)
6051 (define-key km "d" 'org-export-stack-remove)
6052 km)
6053 "Keymap for Org Export Stack.")
6055 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6056 "Mode for displaying asynchronous export stack.
6059 stack.
6061 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6062 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6063 stack completely.
6065 Removing entries in an Org Export Stack buffer doesn't affect
6066 files or buffers, only the display.
6069 (abbrev-mode 0)
6070 (auto-fill-mode 0)
6071 (setq buffer-read-only t
6072 buffer-undo-list t
6073 truncate-lines t
6074 header-line-format
6075 '(:eval
6076 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6077 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6078 (set (make-local-variable 'revert-buffer-function)
6079 'org-export-stack-refresh))
6082 \f
6083 ;;; The Dispatcher
6084 ;;
6085 ;; `org-export-dispatch' is the standard interactive way to start an
6086 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6087 ;; for its interface, which, in turn, delegates response to key
6088 ;; pressed to `org-export--dispatch-action'.
6090 ;;;###autoload
6091 (defun org-export-dispatch (&optional arg)
6092 "Export dispatcher for Org mode.
6094 It provides an access to common export related tasks in a buffer.
6095 Its interface comes in two flavors: standard and expert.
6097 While both share the same set of bindings, only the former
6098 displays the valid keys associations in a dedicated buffer.
6099 Scrolling (resp. line-wise motion) in this buffer is done with
6100 SPC and DEL (resp. C-n and C-p) keys.
6102 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6103 flavor or the other.
6106 of options used back then, on the current buffer.
6108 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6109 (interactive "P")
6110 (let* ((input
6111 (cond ((equal arg '(16)) '(stack))
6112 ((and arg org-export-dispatch-last-action))
6113 (t (save-window-excursion
6114 (unwind-protect
6115 (progn
6116 ;; Remember where we are
6117 (move-marker org-export-dispatch-last-position
6118 (point)
6119 (org-base-buffer (current-buffer)))
6120 ;; Get and store an export command
6121 (setq org-export-dispatch-last-action
6122 (org-export--dispatch-ui
6123 (list org-export-initial-scope
6124 (and org-export-in-background 'async))
6125 nil
6126 org-export-dispatch-use-expert-ui)))
6127 (and (get-buffer "*Org Export Dispatcher*")
6128 (kill-buffer "*Org Export Dispatcher*")))))))
6129 (action (car input))
6130 (optns (cdr input)))
6131 (unless (memq 'subtree optns)
6132 (move-marker org-export-dispatch-last-position nil))
6133 (cl-case action
6134 ;; First handle special hard-coded actions.
6135 (template (org-export-insert-default-template nil optns))
6136 (stack (org-export-stack))
6137 (publish-current-file
6138 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6139 (publish-current-project
6140 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6141 (publish-choose-project
6142 (org-publish (assoc (org-icompleting-read
6143 "Publish project: "
6144 org-publish-project-alist nil t)
6145 org-publish-project-alist)
6146 (memq 'force optns)
6147 (memq 'async optns)))
6148 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6149 (otherwise
6150 (save-excursion
6151 (when arg
6152 ;; Repeating command, maybe move cursor to restore subtree
6153 ;; context.
6154 (if (eq (marker-buffer org-export-dispatch-last-position)
6155 (org-base-buffer (current-buffer)))
6156 (goto-char org-export-dispatch-last-position)
6157 ;; We are in a different buffer, forget position.
6158 (move-marker org-export-dispatch-last-position nil)))
6159 (funcall action
6160 ;; Return a symbol instead of a list to ease
6161 ;; asynchronous export macro use.
6162 (and (memq 'async optns) t)
6163 (and (memq 'subtree optns) t)
6164 (and (memq 'visible optns) t)
6165 (and (memq 'body optns) t)))))))
6167 (defun org-export--dispatch-ui (options first-key expertp)
6168 "Handle interface for `org-export-dispatch'.
6170 OPTIONS is a list containing current interactive options set for
6171 export. It can contain any of the following symbols:
6172 `body' toggles a body-only export
6173 `subtree' restricts export to current subtree
6174 `visible' restricts export to visible part of buffer.
6175 `force' force publishing files.
6176 `async' use asynchronous export process
6178 FIRST-KEY is the key pressed to select the first level menu. It
6179 is nil when this menu hasn't been selected yet.
6181 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6182 buffer is provided, but indications about currently active
6183 options are given in the prompt. Moreover, \[?] allows to switch
6184 back to standard interface."
6185 (let* ((fontify-key
6186 (lambda (key &optional access-key)
6187 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6188 ;; non-nil is the required first-level key to activate
6189 ;; KEY. When its value is t, activate KEY independently
6190 ;; on the first key, if any. A nil value means KEY will
6191 ;; only be activated at first level.
6192 (if (or (eq access-key t) (eq access-key first-key))
6193 (org-propertize key 'face 'org-warning)
6194 key)))
6195 (fontify-value
6196 (lambda (value)
6197 ;; Fontify VALUE string.
6198 (org-propertize value 'face 'font-lock-variable-name-face)))
6199 ;; Prepare menu entries by extracting them from registered
6200 ;; back-ends and sorting them by access key and by ordinal,
6201 ;; if any.
6202 (entries
6203 (sort (sort (delq nil
6204 (mapcar #'org-export-backend-menu
6205 org-export-registered-backends))
6206 (lambda (a b)
6207 (let ((key-a (nth 1 a))
6208 (key-b (nth 1 b)))
6209 (cond ((and (numberp key-a) (numberp key-b))
6210 (< key-a key-b))
6211 ((numberp key-b) t)))))
6212 'car-less-than-car))
6213 ;; Compute a list of allowed keys based on the first key
6214 ;; pressed, if any. Some keys
6215 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6216 ;; available.
6217 (allowed-keys
6218 (nconc (list 2 22 19 6 1)
6219 (if (not first-key) (org-uniquify (mapcar 'car entries))
6220 (let (sub-menu)
6221 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6222 (when (eq (car entry) first-key)
6223 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6224 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6225 ((not first-key) (list ?P)))
6226 (list ?& ?#)
6227 (when expertp (list ??))
6228 (list ?q)))
6229 ;; Build the help menu for standard UI.
6230 (help
6231 (unless expertp
6232 (concat
6233 ;; Options are hard-coded.
6234 (format "[%s] Body only: %s [%s] Visible only: %s
6235 \[%s] Export scope: %s [%s] Force publishing: %s
6237 (funcall fontify-key "C-b" t)
6238 (funcall fontify-value
6239 (if (memq 'body options) "On " "Off"))
6240 (funcall fontify-key "C-v" t)
6241 (funcall fontify-value
6242 (if (memq 'visible options) "On " "Off"))
6243 (funcall fontify-key "C-s" t)
6244 (funcall fontify-value
6245 (if (memq 'subtree options) "Subtree" "Buffer "))
6246 (funcall fontify-key "C-f" t)
6247 (funcall fontify-value
6248 (if (memq 'force options) "On " "Off"))
6249 (funcall fontify-key "C-a" t)
6250 (funcall fontify-value
6251 (if (memq 'async options) "On " "Off")))
6252 ;; Display registered back-end entries. When a key
6253 ;; appears for the second time, do not create another
6254 ;; entry, but append its sub-menu to existing menu.
6255 (let (last-key)
6256 (mapconcat
6257 (lambda (entry)
6258 (let ((top-key (car entry)))
6259 (concat
6260 (unless (eq top-key last-key)
6261 (setq last-key top-key)
6263 (funcall fontify-key (char-to-string top-key))
6264 (nth 1 entry)))
6265 (let ((sub-menu (nth 2 entry)))
6266 (unless (functionp sub-menu)
6267 ;; Split sub-menu into two columns.
6268 (let ((index -1))
6269 (concat
6270 (mapconcat
6271 (lambda (sub-entry)
6272 (cl-incf index)
6273 (format
6274 (if (zerop (mod index 2)) " [%s] %-26s"
6276 (funcall fontify-key
6277 (char-to-string (car sub-entry))
6278 top-key)
6279 (nth 1 sub-entry)))
6280 sub-menu "")
6282 entries ""))
6283 ;; Publishing menu is hard-coded.
6285 [%s] Current file [%s] Current project
6287 (funcall fontify-key "P")
6288 (funcall fontify-key "f" ?P)
6289 (funcall fontify-key "p" ?P)
6290 (funcall fontify-key "x" ?P)
6291 (funcall fontify-key "a" ?P))
6293 (funcall fontify-key "&" t)
6294 (funcall fontify-key "#" t))
6295 (format "[%s] %s"
6296 (funcall fontify-key "q" t)
6297 (if first-key "Main menu" "Exit")))))
6298 ;; Build prompts for both standard and expert UI.
6299 (standard-prompt (unless expertp "Export command: "))
6300 (expert-prompt
6301 (when expertp
6302 (format
6303 "Export command (C-%s%s%s%s%s) [%s]: "
6304 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6305 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6306 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6307 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6308 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6309 (mapconcat (lambda (k)
6310 ;; Strip control characters.
6311 (unless (< k 27) (char-to-string k)))
6312 allowed-keys "")))))
6313 ;; With expert UI, just read key with a fancy prompt. In standard
6314 ;; UI, display an intrusive help buffer.
6315 (if expertp
6316 (org-export--dispatch-action
6317 expert-prompt allowed-keys entries options first-key expertp)
6318 ;; At first call, create frame layout in order to display menu.
6319 (unless (get-buffer "*Org Export Dispatcher*")
6320 (delete-other-windows)
6321 (org-switch-to-buffer-other-window
6322 (get-buffer-create "*Org Export Dispatcher*"))
6323 (setq cursor-type nil
6324 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6325 ;; Make sure that invisible cursor will not highlight square
6326 ;; brackets.
6327 (set-syntax-table (copy-syntax-table))
6328 (modify-syntax-entry ?\[ "w"))
6329 ;; At this point, the buffer containing the menu exists and is
6330 ;; visible in the current window. So, refresh it.
6331 (with-current-buffer "*Org Export Dispatcher*"
6332 ;; Refresh help. Maintain display continuity by re-visiting
6333 ;; previous window position.
6334 (let ((pos (window-start)))
6335 (erase-buffer)
6336 (insert help)
6337 (set-window-start nil pos)))
6338 (org-fit-window-to-buffer)
6339 (org-export--dispatch-action
6340 standard-prompt allowed-keys entries options first-key expertp))))
6342 (defun org-export--dispatch-action
6343 (prompt allowed-keys entries options first-key expertp)
6344 "Read a character from command input and act accordingly.
6346 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6347 a list of characters available at a given step in the process.
6348 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6349 EXPERTP are the same as defined in `org-export--dispatch-ui',
6350 which see.
6352 Toggle export options when required. Otherwise, return value is
6353 a list with action as CAR and a list of interactive export
6354 options as CDR."
6355 (let (key)
6356 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6357 ;; C-p, SPC, DEL).
6358 (while (and (setq key (read-char-exclusive prompt))
6359 (not expertp)
6360 (memq key '(14 16 ?\s ?\d)))
6361 (cl-case key
6362 (14 (if (not (pos-visible-in-window-p (point-max)))
6363 (ignore-errors (scroll-up 1))
6364 (message "End of buffer")
6365 (sit-for 1)))
6366 (16 (if (not (pos-visible-in-window-p (point-min)))
6367 (ignore-errors (scroll-down 1))
6368 (message "Beginning of buffer")
6369 (sit-for 1)))
6370 (?\s (if (not (pos-visible-in-window-p (point-max)))
6371 (scroll-up nil)
6372 (message "End of buffer")
6373 (sit-for 1)))
6374 (?\d (if (not (pos-visible-in-window-p (point-min)))
6375 (scroll-down nil)
6376 (message "Beginning of buffer")
6377 (sit-for 1)))))
6378 (cond
6379 ;; Ignore undefined associations.
6380 ((not (memq key allowed-keys))
6381 (ding)
6382 (unless expertp (message "Invalid key") (sit-for 1))
6383 (org-export--dispatch-ui options first-key expertp))
6384 ;; q key at first level aborts export. At second level, cancel
6385 ;; first key instead.
6386 ((eq key ?q) (if (not first-key) (error "Export aborted")
6387 (org-export--dispatch-ui options nil expertp)))
6388 ;; Help key: Switch back to standard interface if expert UI was
6389 ;; active.
6390 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6391 ;; Send request for template insertion along with export scope.
6392 ((eq key ?#) (cons 'template (memq 'subtree options)))
6393 ;; Switch to asynchronous export stack.
6394 ((eq key ?&) '(stack))
6395 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6396 ((memq key '(2 22 19 6 1))
6397 (org-export--dispatch-ui
6398 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6399 (6 'force) (1 'async))))
6400 (if (memq option options) (remq option options)
6401 (cons option options)))
6402 first-key expertp))
6403 ;; Action selected: Send key and options back to
6404 ;; `org-export-dispatch'.
6405 ((or first-key (functionp (nth 2 (assq key entries))))
6406 (cons (cond
6407 ((not first-key) (nth 2 (assq key entries)))
6408 ;; Publishing actions are hard-coded. Send a special
6409 ;; signal to `org-export-dispatch'.
6410 ((eq first-key ?P)
6411 (cl-case key
6412 (?f 'publish-current-file)
6413 (?p 'publish-current-project)
6414 (?x 'publish-choose-project)
6415 (?a 'publish-all)))
6416 ;; Return first action associated to FIRST-KEY + KEY
6417 ;; path. Indeed, derived backends can share the same
6418 ;; FIRST-KEY.
6419 (t (catch 'found
6420 (mapc (lambda (entry)
6421 (let ((match (assq key (nth 2 entry))))
6422 (when match (throw 'found (nth 2 match)))))
6423 (member (assq first-key entries) entries)))))
6424 options))
6425 ;; Otherwise, enter sub-menu.
6426 (t (org-export--dispatch-ui options key expertp)))))
6430 (provide 'ox)
6432 ;; Local variables:
6433 ;; generated-autoload-file: "org-loaddefs.el"
6434 ;; End:
6436 ;;; ox.el ends here