| blob | bfdfebab09108f980f637ba7d6207b7e98047f30 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
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."
1348 alist))
1349 alist))
1350 ;; Priority is given to back-end specific options.
1352 org-export-options-alist))
1362 "Get export options in subtree at point.
1363 Optional argument BACKEND is an export back-end, as returned by,
1364 e.g., `org-export-create-backend'. It specifies back-end used
1365 for export. Return options as a plist."
1366 ;; For each buffer keyword, create a headline property setting the
1367 ;; same property in communication channel. The name for the
1368 ;; property is the keyword with "EXPORT_" appended to it.
1370 ;; Make sure point is at a heading.
1373 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1374 ;; care of them right from the start.
1377 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1378 ;; headline's title (with no todo keyword, priority cookie or
1379 ;; tag) as its fallback value.
1385 ;; Look for both general keywords and back-end specific
1386 ;; options, with priority given to the latter.
1388 org-export-options-alist)))
1389 ;; Handle other keywords. Then return PLIST.
1403 property
1412 "Return current buffer export options, as a plist.
1414 Optional argument BACKEND, when non-nil, is an export back-end,
1415 as returned by, e.g., `org-export-create-backend'. It specifies
1416 which back-end specific options should also be read in the
1417 process.
1419 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1421 get-options ; For byte-compiler.
1424 ;; Priority is given to back-end specific options.
1426 org-export-options-alist))
1429 org-export-special-keywords))))
1432 ;; Return all properties associated to KEYWORD.
1437 to-parse
1440 ;; Recursively read keywords in buffer. FILES is a list
1441 ;; of files read so far. PLIST is the current property
1442 ;; list obtained.
1451 ;; Options in `org-export-special-keywords'.
1455 ;; Avoid circular dependencies.
1465 plist
1470 plist
1476 ;; Options in `org-export-options-alist'.
1479 plist
1481 plist property
1482 ;; Handle value depending on specified
1483 ;; BEHAVIOR.
1488 ;; Even if `parse' implies `space'
1489 ;; behavior, we separate line with "\n"
1490 ;; so as to preserve line-breaks.
1491 ;; However, empty lines are forbidden
1492 ;; since `parse' doesn't allow more than
1493 ;; one paragraph.
1502 " "
1515 plist))))
1516 ;; Read options in the current buffer and return value.
1519 nil)))
1520 ;; Parse properties in TO-PARSE. Remove newline characters not
1521 ;; involved in line breaks to simulate `space' behavior.
1522 ;; Finally return options.
1534 "Return properties related to buffer attributes, as a plist."
1539 "Return global export options as a plist.
1540 Optional argument BACKEND, if non-nil, is an export back-end, as
1541 returned by, e.g., `org-export-create-backend'. It specifies
1542 which back-end specific export options should also be read in the
1543 process."
1545 ;; Priority is given to back-end specific options.
1547 org-export-options-alist)))
1553 plist
1554 prop
1555 ;; Evaluate default value provided.
1560 value)))))))))
1563 "Return variables bound from BIND keywords in current buffer.
1564 Also look for BIND keywords in setup files. The return value is
1565 an alist where associations are (VARIABLE-NAME VALUE)."
1570 ;; Return an alist between variable names and their
1571 ;; value. FILES is a list of setup files names read so
1572 ;; far, used to avoid circular dependencies. ALIST is
1573 ;; the alist collected so far.
1584 ;; Enter setup file.
1594 alist))))))))))
1595 alist)))))
1596 ;; Return value in appropriate order of appearance.
1599 ;; defsubst org-export-get-parent must be defined before first use,
1600 ;; was originally defined in the topology section
1603 "Return BLOB parent or nil.
1604 BLOB is the element or object considered."
1607 ;;;; Tree Properties
1608 ;;
1609 ;; Tree properties are information extracted from parse tree. They
1610 ;; are initialized at the beginning of the transcoding process by
1611 ;; `org-export-collect-tree-properties'.
1612 ;;
1613 ;; Dedicated functions focus on computing the value of specific tree
1614 ;; properties during initialization. Thus,
1615 ;; `org-export--populate-ignore-list' lists elements and objects that
1616 ;; should be skipped during export, `org-export--get-min-level' gets
1617 ;; the minimal exportable level, used as a basis to compute relative
1618 ;; level for headlines. Eventually
1619 ;; `org-export--collect-headline-numbering' builds an alist between
1620 ;; headlines and their numbering.
1623 "Extract tree properties from parse tree.
1625 DATA is the parse tree from which information is retrieved. INFO
1626 is a list holding export options.
1628 Following tree properties are set or updated:
1630 `:exported-data' Hash table used to memoize results from
1631 `org-export-data'.
1633 `:headline-offset' Offset between true level of headlines and
1634 local level. An offset of -1 means a headline
1635 of level 2 should be considered as a level
1636 1 headline in the context.
1638 `:headline-numbering' Alist of all headlines as key an the
1639 associated numbering as value.
1641 Return updated plist."
1642 ;; Install the parse tree in the communication channel.
1644 ;; Compute `:headline-offset' in order to be able to use
1645 ;; `org-export-get-relative-level'.
1648 :headline-offset
1650 ;; Properties order doesn't matter: get the rest of the tree
1651 ;; properties.
1655 info))
1658 "Return minimum exportable headline's level in DATA.
1659 DATA is parsed tree as returned by `org-element-parse-buffer'.
1660 OPTIONS is a plist holding export options."
1671 ;; If no headline was found, for the sake of consistency, set
1672 ;; minimum level to 1 nonetheless.
1676 "Return numbering of all exportable, numbered headlines in a parse tree.
1678 DATA is the parse tree. OPTIONS is the plist holding export
1679 options.
1681 Return an alist whose key is a headline and value is its
1682 associated numbering \(in the shape of a list of numbers\) or nil
1683 for a footnotes section."
1692 headline
1694 for idx from 0 to org-export-max-depth
1698 options)))
1701 "List headlines and inlinetasks with a select tag in their tree.
1702 DATA is parsed data as returned by `org-element-parse-buffer'.
1703 INFO is a plist holding export options."
1705 walk-data ; For byte-compiler.
1715 ;; When a select tag is found, mark full
1716 ;; genealogy and every headline within the tree
1717 ;; as acceptable.
1720 genealogy
1723 selected-trees))
1724 ;; If at a headline, continue searching in tree,
1725 ;; recursively.
1734 selected-trees))
1737 "Non-nil when element or object BLOB should be skipped during export.
1738 OPTIONS is the plist holding export options. SELECTED, when
1739 non-nil, is a list of headlines or inlinetasks belonging to
1740 a tree with a select tag."
1747 ;; If `:with-drawers' value starts with `not', ignore
1748 ;; every drawer whose name belong to that list.
1749 ;; Otherwise, ignore drawers whose name isn't in that
1750 ;; list.
1767 ;; Ignore subtrees with an exclude tag.
1770 ;; When a select tag is present in the buffer, ignore any tree
1771 ;; without it.
1773 ;; Ignore commented sub-trees.
1775 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1777 ;; Ignore tasks, if specified by `:with-tasks' property.
1789 properties-set))))))
1800 ;; `:with-timestamps' only applies to isolated timestamps
1801 ;; objects, i.e. timestamp objects in a paragraph containing only
1802 ;; timestamps and whitespaces.
1810 options t))))
1819 \f
1820 ;;; The Transcoder
1821 ;;
1822 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1823 ;; `org-element-parse-buffer') and transcodes it into a specified
1824 ;; back-end output. It takes care of filtering out elements or
1825 ;; objects according to export options and organizing the output blank
1826 ;; lines and white space are preserved. The function memoizes its
1827 ;; results, so it is cheap to call it within transcoders.
1828 ;;
1829 ;; It is possible to modify locally the back-end used by
1830 ;; `org-export-data' or even use a temporary back-end by using
1831 ;; `org-export-data-with-backend'.
1832 ;;
1833 ;; `org-export-transcoder' is an accessor returning appropriate
1834 ;; translator function for a given element or object.
1837 "Return appropriate transcoder for BLOB.
1838 INFO is a plist containing export directives."
1840 ;; Return contents only for complete parse trees.
1846 "Convert DATA into current back-end format.
1848 DATA is a parse tree, an element or an object or a secondary
1849 string. INFO is a plist holding export options.
1851 Return a string."
1856 ;; Ignored element/object.
1858 ;; Plain text.
1864 info))
1865 ;; Secondary string.
1868 ;; Element/Object without contents or, as a special
1869 ;; case, headline with archive tag and archived trees
1870 ;; restricted to title only.
1878 ;; Export snippets never return a nil value so
1879 ;; that white spaces following them are never
1880 ;; ignored.
1882 ;; Element/Object with contents.
1895 ;; Elements directly containing
1896 ;; objects must have their indentation
1897 ;; normalized first.
1899 data
1900 ;; When normalizing contents of the
1901 ;; first paragraph in an item or
1902 ;; a footnote definition, ignore
1903 ;; first line's indentation: there is
1904 ;; none and it might be misleading.
1909 data)
1916 info))))))))
1917 ;; Final result will be memoized before being returned.
1919 data
1923 ;; Append the same white space between elements or objects
1924 ;; as in the original buffer, and call appropriate filters.
1935 info)))
1936 results)))
1940 "Convert DATA into BACKEND format.
1942 DATA is an element, an object, a secondary string or a string.
1943 BACKEND is a symbol. INFO is a plist used as a communication
1944 channel.
1946 Unlike to `org-export-with-backend', this function will
1947 recursively convert DATA using BACKEND translation table."
1950 data
1951 ;; Set-up a new communication channel with translations defined in
1952 ;; BACKEND as the translate table and a new hash table for
1953 ;; memoization.
1955 info
1958 ;; Size of the hash table is reduced since this function
1959 ;; will probably be used on small trees.
1963 "Expand a parsed element or object to its original state.
1965 BLOB is either an element or an object. CONTENTS is its
1966 contents, as a string or nil.
1968 When optional argument WITH-AFFILIATED is non-nil, add affiliated
1969 keywords before output."
1974 blob contents))))
1977 \f
1978 ;;; The Filter System
1979 ;;
1980 ;; Filters allow end-users to tweak easily the transcoded output.
1981 ;; They are the functional counterpart of hooks, as every filter in
1982 ;; a set is applied to the return value of the previous one.
1983 ;;
1984 ;; Every set is back-end agnostic. Although, a filter is always
1985 ;; called, in addition to the string it applies to, with the back-end
1986 ;; used as argument, so it's easy for the end-user to add back-end
1987 ;; specific filters in the set. The communication channel, as
1988 ;; a plist, is required as the third argument.
1989 ;;
1990 ;; From the developer side, filters sets can be installed in the
1991 ;; process with the help of `org-export-define-backend', which
1992 ;; internally stores filters as an alist. Each association has a key
1993 ;; among the following symbols and a function or a list of functions
1994 ;; as value.
1995 ;;
1996 ;; - `:filter-options' applies to the property list containing export
1997 ;; options. Unlike to other filters, functions in this list accept
1998 ;; two arguments instead of three: the property list containing
1999 ;; export options and the back-end. Users can set its value through
2000 ;; `org-export-filter-options-functions' variable.
2001 ;;
2002 ;; - `:filter-parse-tree' applies directly to the complete parsed
2003 ;; tree. Users can set it through
2004 ;; `org-export-filter-parse-tree-functions' variable.
2005 ;;
2006 ;; - `:filter-body' applies to the body of the output, before template
2007 ;; translator chimes in. Users can set it through
2008 ;; `org-export-filter-body-functions' variable.
2009 ;;
2010 ;; - `:filter-final-output' applies to the final transcoded string.
2011 ;; Users can set it with `org-export-filter-final-output-functions'
2012 ;; variable.
2013 ;;
2014 ;; - `:filter-plain-text' applies to any string not recognized as Org
2015 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2016 ;; configure it.
2017 ;;
2018 ;; - `:filter-TYPE' applies on the string returned after an element or
2019 ;; object of type TYPE has been transcoded. A user can modify
2020 ;; `org-export-filter-TYPE-functions' to install these filters.
2021 ;;
2022 ;; All filters sets are applied with
2023 ;; `org-export-filter-apply-functions' function. Filters in a set are
2024 ;; applied in a LIFO fashion. It allows developers to be sure that
2025 ;; their filters will be applied first.
2026 ;;
2027 ;; Filters properties are installed in communication channel with
2028 ;; `org-export-install-filters' function.
2029 ;;
2030 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2031 ;; `org-export-before-parsing-hook') are run at the beginning of the
2032 ;; export process and just before parsing to allow for heavy structure
2033 ;; modifications.
2036 ;;;; Hooks
2039 "Hook run at the beginning of the export process.
2041 This is run before include keywords and macros are expanded and
2042 Babel code blocks executed, on a copy of the original buffer
2043 being exported. Visibility and narrowing are preserved. Point
2044 is at the beginning of the buffer.
2046 Every function in this hook will be called with one argument: the
2050 "Hook run before parsing an export buffer.
2052 This is run after include keywords and macros have been expanded
2053 and Babel code blocks executed, on a copy of the original buffer
2054 being exported. Visibility and narrowing are preserved. Point
2055 is at the beginning of the buffer.
2057 Every function in this hook will be called with one argument: the
2061 ;;;; Special Filters
2064 "List of functions applied to the export options.
2065 Each filter is called with two arguments: the export options, as
2066 a plist, and the back-end, as a symbol. It must return
2070 "List of functions applied to the parsed tree.
2071 Each filter is called with three arguments: the parse tree, as
2072 returned by `org-element-parse-buffer', the back-end, as
2073 a symbol, and the communication channel, as a plist. It must
2077 "List of functions applied to plain text.
2078 Each filter is called with three arguments: a string which
2079 contains no Org syntax, the back-end, as a symbol, and the
2080 communication channel, as a plist. It must return a string or
2084 "List of functions applied to transcoded body.
2085 Each filter is called with three arguments: a string which
2086 contains no Org syntax, the back-end, as a symbol, and the
2087 communication channel, as a plist. It must return a string or
2091 "List of functions applied to the transcoded string.
2092 Each filter is called with three arguments: the full transcoded
2093 string, the back-end, as a symbol, and the communication channel,
2094 as a plist. It must return a string that will be used as the
2098 ;;;; Elements Filters
2101 "List of functions applied to a transcoded babel-call.
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 center block.
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 clock.
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 diary-sexp.
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 drawer.
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 dynamic-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 example-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 export-block.
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 fixed-width.
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 footnote-definition.
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 headline.
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 horizontal-rule.
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 inlinetask.
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 item.
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 keyword.
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 latex-environment.
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 node-property.
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 paragraph.
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 plain-list.
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 planning.
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 property-drawer.
2222 Each filter is called with three arguments: the transcoded data,
2223 as a string, the back-end, as a symbol, and the communication
2227 "List of functions applied to a transcoded quote block.
2228 Each filter is called with three arguments: the transcoded quote
2229 data, as a string, the back-end, as a symbol, and the
2230 communication channel, as a plist. It must return a string or
2234 "List of functions applied to a transcoded section.
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 special 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 src-block.
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.
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-cell.
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 table-row.
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 "List of functions applied to a transcoded verse block.
2271 Each filter is called with three arguments: the transcoded data,
2272 as a string, the back-end, as a symbol, and the communication
2276 ;;;; Objects Filters
2279 "List of functions applied to transcoded bold 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 transcoded code text.
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 entity.
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 export-snippet.
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 footnote-reference.
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-babel-call.
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 a transcoded inline-src-block.
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 transcoded italic text.
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 latex-fragment.
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 line-break.
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 link.
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 radio-target.
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 a transcoded statistics-cookie.
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 transcoded strike-through text.
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 subscript.
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 superscript.
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 target.
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 a transcoded timestamp.
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 underline 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 "List of functions applied to transcoded verbatim text.
2394 Each filter is called with three arguments: the transcoded data,
2395 as a string, the back-end, as a symbol, and the communication
2399 ;;;; Filters Tools
2400 ;;
2401 ;; Internal function `org-export-install-filters' installs filters
2402 ;; hard-coded in back-ends (developer filters) and filters from global
2403 ;; variables (user filters) in the communication channel.
2404 ;;
2405 ;; Internal function `org-export-filter-apply-functions' takes care
2406 ;; about applying each filter in order to a given data. It ignores
2407 ;; filters returning a nil value but stops whenever a filter returns
2408 ;; an empty string.
2411 "Call every function in FILTERS.
2413 Functions are called with arguments VALUE, current export
2414 back-end's name and INFO. A function returning a nil value will
2415 be skipped. If it returns the empty string, the process ends and
2416 VALUE is ignored.
2418 Call is done in a LIFO fashion, to be sure that developer
2419 specified filters, if any, are called first."
2430 "Install filters properties in communication channel.
2431 INFO is a plist containing the current communication channel.
2432 Return the updated communication channel."
2434 ;; Install user-defined filters with `org-export-filters-alist'
2435 ;; and filters already in INFO (through ext-plist mechanism).
2442 ;; Filters in INFO will be called
2443 ;; before those user provided.
2446 default-value)))))
2447 org-export-filters-alist)
2448 ;; Prepend back-end specific filters to that list.
2450 ;; Single values get consed, lists are appended.
2455 plist key
2459 ;; Return new communication channel.
2463 \f
2464 ;;; Core functions
2465 ;;
2466 ;; This is the room for the main function, `org-export-as', along with
2467 ;; its derivative, `org-export-string-as'.
2468 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2469 ;; function should be added to kill ring.
2470 ;;
2471 ;; Note that `org-export-as' doesn't really parse the current buffer,
2472 ;; but a copy of it (with the same buffer-local variables and
2473 ;; visibility), where macros and include keywords are expanded and
2474 ;; Babel blocks are executed, if appropriate.
2475 ;; `org-export-with-buffer-copy' macro prepares that copy.
2476 ;;
2477 ;; File inclusion is taken care of by
2478 ;; `org-export-expand-include-keyword' and
2479 ;; `org-export--prepare-file-contents'. Structure wise, including
2480 ;; a whole Org file in a buffer often makes little sense. For
2481 ;; example, if the file contains a headline and the include keyword
2482 ;; was within an item, the item should contain the headline. That's
2483 ;; why file inclusion should be done before any structure can be
2484 ;; associated to the file, that is before parsing.
2485 ;;
2486 ;; `org-export-insert-default-template' is a command to insert
2487 ;; a default template (or a back-end specific template) at point or in
2488 ;; current subtree.
2491 "Return a copy of the current buffer.
2492 The copy preserves Org buffer-local variables, visibility and
2493 narrowing."
2499 new-buf))
2502 "Apply BODY in a copy of the current buffer.
2503 The copy preserves local variables, visibility and contents of
2504 the original buffer. Point is at the beginning of the buffer
2505 when BODY is applied."
2514 ;; Kill copy without confirmation.
2520 "Generate a function duplicating BUFFER.
2522 The copy will preserve local variables, visibility, contents and
2523 narrowing of the original buffer. If a region was active in
2524 BUFFER, contents will be narrowed to that region instead.
2526 The resulting function can be evaluated at a later time, from
2527 another buffer, effectively cloning the original buffer there.
2529 The function assumes BUFFER's major mode is `org-mode'."
2533 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2534 ;; already in BUFFER.
2536 ;; Copy specific buffer local variables and variables set
2537 ;; through BIND keywords.
2539 vars)
2547 buffer-file-name
2548 buffer-file-coding-system))
2552 ;; Skip unreadable values, as they cannot be
2553 ;; sent to external process.
2557 vars))))))
2558 ;; Whole buffer contents.
2563 ;; Narrowing.
2567 ;; Current position of point.
2569 ;; Overlays with invisible property.
2579 ov-set))))
2581 ov-set)))))
2584 "Delete commented areas in the buffer.
2585 Commented areas are comments, comment blocks, commented trees and
2586 inlinetasks. Trailing blank lines after a comment or a comment
2587 block are preserved. Narrowing, if any, is ignored."
2608 "Prune non exportable elements from DATA.
2609 DATA is the parse tree to traverse. INFO is the plist holding
2610 export info. Also set `:ignore-list' in INFO to a list of
2611 objects which should be ignored during export, but not removed
2612 from tree."
2614 ignore
2615 ;; First find trees containing a select tag, if any.
2619 ;; Prune non-exportable elements and objects from tree.
2620 ;; As a special case, special rows and cells from tables
2621 ;; are stored in IGNORE, as they still need to be accessed
2622 ;; during export.
2631 ;; If headline is archived but tree below has to
2632 ;; be skipped, remove contents.
2634 ;; Move into recursive objects/elements.
2636 ;; Move into secondary string, if any.
2638 org-element-secondary-value-alist)))
2640 ;; If a select tag is active, also ignore the section before the
2641 ;; first headline, if any.
2646 ;; Prune tree and communication channel.
2650 ;; Priority is given to back-end specific options.
2652 org-export-options-alist))
2655 ;; Eventually set `:ignore-list'.
2659 "Change uninterpreted elements back into Org syntax.
2660 DATA is the parse tree. INFO is a plist containing export
2661 options. Each uninterpreted element or object is changed back
2662 into a string. Contents, if any, are not modified. The parse
2663 tree is modified by side effect."
2669 p
2672 info))))))
2675 "Change uninterpreted elements back into Org syntax.
2676 DATA is a parse tree or a secondary string. INFO is a plist
2677 containing export options. It is modified by side effect and
2678 returned by the function."
2681 subscript superscript underline)
2685 ;; ... entities...
2692 ?\s)))))
2693 ;; ... emphasis...
2705 marker
2709 ?\s)))))))
2710 ;; ... LaTeX environments and fragments...
2714 ;; ... sub/superscripts...
2723 "_"
2732 ?\s)))))))))))
2734 ;; Splice NEW at BLOB location in parse tree.
2737 info nil nil t)
2738 ;; Return modified parse tree.
2739 data)
2742 "Insert footnote definitions outside parsing scope in TREE.
2744 If there is a footnote section in TREE, definitions found are
2745 appended to it. If `org-footnote-section' is non-nil, a new
2746 footnote section containing all definitions is inserted in TREE.
2747 Otherwise, definitions are appended at the end of the section
2748 containing their first reference.
2750 Only definitions actually referred to within TREE, directly or
2751 not, are considered."
2770 definitions))
2778 'footnote-definition
2784 definitions))))))))
2785 ;; Collect all out of scope definitions.
2795 ;; Filter out definitions referenced neither in the original
2796 ;; tree nor in the external definitions.
2801 definitions))
2804 referenced-labels)))
2809 definitions)))
2810 ;; Install definitions in subtree.
2813 ;; If there is a footnote section, insert them here.
2818 nil t)))
2821 ;; If there should be a footnote section, create one containing
2822 ;; all the definitions at the end of the tree.
2825 tree
2831 'section
2832 nil
2834 ;; Otherwise add each definition at the end of the section where
2835 ;; it is first referenced.
2841 ;; Insert definitions in the same section as their
2842 ;; first reference in DATA.
2854 label)
2861 definition)
2863 definition)))))))))))
2866 ;;;###autoload
2869 "Transcode current Org buffer into BACKEND code.
2871 BACKEND is either an export back-end, as returned by, e.g.,
2872 `org-export-create-backend', or a symbol referring to
2873 a registered back-end.
2875 If narrowing is active in the current buffer, only transcode its
2876 narrowed part.
2878 If a region is active, transcode that region.
2880 When optional argument SUBTREEP is non-nil, transcode the
2881 sub-tree at point, extracting information from the headline
2882 properties first.
2884 When optional argument VISIBLE-ONLY is non-nil, don't export
2885 contents of hidden elements.
2887 When optional argument BODY-ONLY is non-nil, only return body
2888 code, without surrounding template.
2890 Optional argument EXT-PLIST, when provided, is a property list
2891 with external parameters overriding Org default settings, but
2892 still inferior to file-local settings.
2894 Return code as a string."
2899 ;; Narrow buffer to an appropriate region or subtree for
2900 ;; parsing. If parsing subtree, be sure to remove main headline
2901 ;; too.
2909 ;; Initialize communication channel with original buffer
2910 ;; attributes, unavailable in its copy.
2923 org-export-options-alist))))
2924 tree)
2925 ;; Update communication channel and get parse tree. Buffer
2926 ;; isn't parsed directly. Instead, all buffer modifications
2927 ;; and consequent parsing are undertaken in a temporary copy.
2929 ;; Run first hook with current back-end's name as argument.
2932 ;; Include files, delete comments and expand macros.
2937 ;; Refresh buffer properties and radio targets after
2938 ;; potentially invasive previous changes. Likewise, do it
2939 ;; again after executing Babel code.
2945 ;; Run last hook with current back-end's name as argument.
2946 ;; Update buffer properties and radio targets one last time
2947 ;; before parsing.
2954 ;; Update communication channel with environment. Also
2955 ;; install user's and developer's filters.
2960 ;; Call options filters and update export options. We do not
2961 ;; use `org-export-filter-apply-functions' here since the
2962 ;; arity of such filters is different.
2967 ;; Expand export-specific set of macros: {{{author}}},
2968 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2969 ;; be done once regular macros have been expanded, since
2970 ;; parsed keywords may contain one of them.
2983 value)
2984 value)))
2988 'finalize
2989 parsed-keywords)
2990 ;; Parse buffer.
2992 ;; Merge footnote definitions outside scope into parse tree.
2994 ;; Prune tree from non-exported elements and transform
2995 ;; uninterpreted elements or objects in both parse tree and
2996 ;; communication channel.
2999 ;; Call parse tree filters.
3003 ;; Now tree is complete, compute its properties and add them
3004 ;; to communication channel.
3008 ;; Eventually transcode TREE. Wrap the resulting string into
3009 ;; a template.
3018 info))
3021 ;; Remove all text properties since they cannot be
3022 ;; retrieved from an external process. Finally call
3023 ;; final-output filter and return result.
3029 info))))))))
3031 ;;;###autoload
3033 "Transcode STRING into BACKEND code.
3035 BACKEND is either an export back-end, as returned by, e.g.,
3036 `org-export-create-backend', or a symbol referring to
3037 a registered back-end.
3039 When optional argument BODY-ONLY is non-nil, only return body
3040 code, without preamble nor postamble.
3042 Optional argument EXT-PLIST, when provided, is a property list
3043 with external parameters overriding Org default settings, but
3044 still inferior to file-local settings.
3046 Return code as a string."
3052 ;;;###autoload
3054 "Replace the active region by its export to BACKEND.
3055 BACKEND is either an export back-end, as returned by, e.g.,
3056 `org-export-create-backend', or a symbol referring to
3057 a registered back-end."
3063 ;;;###autoload
3065 "Insert all export keywords with default values at beginning of line.
3067 BACKEND is a symbol referring to the name of a registered export
3068 back-end, for which specific export options should be added to
3069 the template, or `default' for default template. When it is nil,
3070 the user will be prompted for a category.
3072 If SUBTREEP is non-nil, export configuration will be set up
3073 locally for the subtree through node properties."
3083 "Options category: "
3087 org-export-registered-backends))
3088 nil t))))
3089 options keywords)
3090 ;; Populate OPTIONS and KEYWORDS.
3107 ;; Move to an appropriate location in order to insert options.
3109 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3127 ;; Then the rest of keywords, in the order specified in either
3128 ;; `org-export-options-alist' or respective export back-ends.
3149 "Expand every include keyword in buffer.
3150 Optional argument INCLUDED is a list of included file names along
3151 with their line restriction, when appropriate. It is used to
3152 avoid infinite recursion. Optional argument DIR is the current
3153 working directory. It is used to properly resolve relative
3154 paths. Optional argument FOOTNOTES is a hash-table used for
3155 storing and resolving footnotes. It is created automatically."
3161 ;; If :minlevel is not set the text-property
3162 ;; `:org-include-induced-level' will be used to determine the
3163 ;; relative level when expanding INCLUDE.
3164 ;; Only affects included Org documents.
3168 :org-include-induced-level
3170 ;; Expand INCLUDE keywords.
3176 ;; Extract arguments from keyword's value.
3179 location
3187 matched)
3193 matched)
3194 dir)))
3198 value)
3204 value)
3211 ;; Minimal level of included file defaults to the child
3212 ;; level of the current headline, if any, or one. It
3213 ;; only applies is the file is meant to be included as
3214 ;; an Org one.
3226 ;; Remove keyword.
3232 ;; Check if files has already been parsed. Look after
3233 ;; inclusion lines too, as different parts of the same file
3234 ;; can be included too.
3249 ind-str block arg-str contents ind-str block))))
3256 ind-str block contents ind-str block))))
3264 file location only-contents lines)
3265 lines)))
3269 file lines ind minlevel
3272 footnotes)))
3276 footnotes)
3278 ;; Expand footnotes after all files have been included.
3279 ;; Footnotes are stored at end of buffer.
3284 footnotes)))))))))))
3287 "Resolve absolute lines for an included file with file-link.
3289 FILE is string file-name of the file to include. LOCATION is a
3290 string name within FILE to be included (located via
3291 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3292 contents of the named element will be included, as determined
3293 Org-Element. If LINES is non-nil only those lines are included.
3295 Return a string of lines to be included in the format expected by
3296 `org-export--prepare-file-contents'."
3302 ;; Enforce consistent search.
3315 ;; Skip planning line and property-drawer.
3341 start-line
3343 (+ start-line
3346 counter))))))))
3350 "Prepare contents of FILE for inclusion and return it as a string.
3352 When optional argument LINES is a string specifying a range of
3353 lines, include only those lines.
3355 Optional argument IND, when non-nil, is an integer specifying the
3356 global indentation of returned contents. Since its purpose is to
3357 allow an included file to stay in the same environment it was
3358 created (e.g., a list item), it doesn't apply past the first
3359 headline encountered.
3361 Optional argument MINLEVEL, when non-nil, is an integer
3362 specifying the level that any top-level headline in the included
3363 file should have.
3365 Optional argument ID is an integer that will be inserted before
3366 each footnote definition and reference if FILE is an Org file.
3367 This is useful to avoid conflicts when more than one Org file
3368 with footnotes is included in a document.
3370 Optional argument FOOTNOTES is a hash-table to store footnotes in
3371 the included document."
3387 ;; Remove blank lines at beginning and end of contents. The logic
3388 ;; behind that removal is that blank lines around include keyword
3389 ;; override blank lines in included file.
3398 ;; If IND is set, preserve indentation of include keyword until
3399 ;; the first headline encountered.
3406 ;; Do not move footnote definitions out of column 0.
3412 ;; When MINLEVEL is specified, compute minimal level for headlines
3413 ;; in the file (CUR-MIN), and remove stars to each headline so
3414 ;; that headlines with minimal level have a level of MINLEVEL.
3425 ;; Only change stars, don't bother moving whole
3426 ;; sections.
3431 ;; Append ID to all footnote references and definitions, so they
3432 ;; become file specific and cannot collide with footnotes in other
3433 ;; included files. Further, collect relevant footnote definitions
3434 ;; outside of LINES, in order to reintroduce them later.
3440 ;; Generate new label from LABEL. If LABEL is akin to
3441 ;; [1] convert it to [fn:--ID-1]. Otherwise add "-ID-"
3442 ;; after "fn:".
3448 ;; Replace OLD label with NEW in footnote F.
3462 ;; Update the footnote-reference at point and collect
3463 ;; the new label, which is only used for footnotes
3464 ;; outsides LINES.
3476 ;; Store since footnote-definition is
3477 ;; outside of LINES.
3480 footnotes))))
3487 "Execute every Babel code in the visible part of current buffer."
3488 ;; Get a pristine copy of current buffer so Babel references can be
3489 ;; properly resolved.
3495 "Return a non-nil value when output should be added to the kill ring.
3496 See also `org-export-copy-to-kill-ring'."
3502 \f
3503 ;;; Tools For Back-Ends
3504 ;;
3505 ;; A whole set of tools is available to help build new exporters. Any
3506 ;; function general enough to have its use across many back-ends
3507 ;; should be added here.
3509 ;;;; For Affiliated Keywords
3510 ;;
3511 ;; `org-export-read-attribute' reads a property from a given element
3512 ;; as a plist. It can be used to normalize affiliated keywords'
3513 ;; syntax.
3514 ;;
3515 ;; Since captions can span over multiple lines and accept dual values,
3516 ;; their internal representation is a bit tricky. Therefore,
3517 ;; `org-export-get-caption' transparently returns a given element's
3518 ;; caption as a secondary string.
3521 "Turn ATTRIBUTE property from ELEMENT into a plist.
3523 When optional argument PROPERTY is non-nil, return the value of
3524 that property within attributes.
3528 properties.
3530 All values will become strings except the empty string and
3533 will become the empty string."
3547 s)
3552 ;; Ignore any string before first property with `cdr'.
3557 "Return caption from ELEMENT as a secondary string.
3559 When optional argument SHORTP is non-nil, return short caption,
3560 as a secondary string, instead.
3562 Caption lines are separated by a white space."
3570 ;;;; For Derived Back-ends
3571 ;;
3572 ;; `org-export-with-backend' is a function allowing to locally use
3573 ;; another back-end to transcode some object or element. In a derived
3574 ;; back-end, it may be used as a fall-back function once all specific
3575 ;; cases have been treated.
3578 "Call a transcoder from BACKEND on DATA.
3579 BACKEND is an export back-end, as returned by, e.g.,
3580 `org-export-create-backend', or a symbol referring to
3581 a registered back-end. DATA is an Org element, object, secondary
3582 string or string. CONTENTS, when non-nil, is the transcoded
3583 contents of DATA element, as a string. INFO, when non-nil, is
3584 the communication channel used for export, as a plist."
3594 transcoder data contents
3597 :back-end backend
3598 :translate-alist all-transcoders
3602 ;;;; For Export Snippets
3603 ;;
3604 ;; Every export snippet is transmitted to the back-end. Though, the
3605 ;; latter will only retain one type of export-snippet, ignoring
3606 ;; others, based on the former's target back-end. The function
3607 ;; `org-export-snippet-backend' returns that back-end for a given
3608 ;; export-snippet.
3611 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3612 Translation, with `org-export-snippet-translation-alist', is
3613 applied."
3617 back-end))))
3620 ;;;; For Footnotes
3621 ;;
3622 ;; `org-export-collect-footnote-definitions' is a tool to list
3623 ;; actually used footnotes definitions in the whole parse tree, or in
3624 ;; a headline, in order to add footnote listings throughout the
3625 ;; transcoded data.
3626 ;;
3627 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3628 ;; back-ends, when they need to attach the footnote definition only to
3629 ;; the first occurrence of the corresponding label.
3630 ;;
3631 ;; `org-export-get-footnote-definition' and
3632 ;; `org-export-get-footnote-number' provide easier access to
3633 ;; additional information relative to a footnote reference.
3636 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3637 INFO is the plist used as a communication channel. If no such
3638 definition can be found, raise an error."
3644 hash))))
3652 info t)
3653 cache)
3658 "Apply FUNCTION on every footnote reference in DATA.
3659 INFO is a plist containing export state. By default, as soon as
3660 a new footnote reference is encountered, FUNCTION is called onto
3661 its definition. However, if BODY-FIRST is non-nil, this step is
3662 delayed until the end of the process."
3668 ;; Search footnote references through DATA, filling
3669 ;; SEEN-REFS along the way. When DELAYP is non-nil, store
3670 ;; footnote definitions so they can be entered later.
3677 ;; Search for subsequent references in footnote
3678 ;; definition so numbering follows reading logic,
3679 ;; unless DELAYP in non-nil.
3683 definitions))
3684 ;; Do not force entering inline definitions,
3685 ;; since `org-element-map' already traverses them
3686 ;; at the right time.
3690 nil))))))
3691 info nil
3692 ;; Don't enter footnote definitions since it will happen
3693 ;; when their first reference is found. Moreover, if
3694 ;; DELAYP is non-nil, make sure we postpone entering
3695 ;; definitions of inline references.
3702 "Return an alist between footnote numbers, labels and definitions.
3704 INFO is the current export state, as a plist.
3706 Definitions are collected throughout the whole parse tree, or
3707 DATA when non-nil.
3709 Sorting is done by order of references. As soon as a new
3710 reference is encountered, other references are searched within
3711 its definition. However, if BODY-FIRST is non-nil, this step is
3712 delayed after the whole tree is checked. This alters results
3713 when references are found in footnote definitions.
3715 Definitions either appear as Org data or as a secondary string
3716 for inlined footnotes. Unreferenced definitions are ignored."
3720 ;; Collect footnote number, label and definition.
3731 "Non-nil when a footnote reference is the first one for its label.
3733 FOOTNOTE-REFERENCE is the footnote reference being considered.
3734 INFO is a plist containing current export state.
3736 Search is done throughout the whole parse tree, or DATA when
3737 non-nil.
3739 By default, as soon as a new footnote reference is encountered,
3740 other references are searched within its definition. However, if
3741 BODY-FIRST is non-nil, this step is delayed after the whole tree
3742 is checked. This alters results when references are found in
3743 footnote definitions."
3745 ;; Anonymous footnotes are always a first reference.
3756 "Return number associated to a footnote.
3758 FOOTNOTE is either a footnote reference or a footnote definition.
3759 INFO is the plist containing export state.
3761 Number is unique throughout the whole parse tree, or DATA, when
3762 non-nil.
3764 By default, as soon as a new footnote reference is encountered,
3765 counting process moves into its definition. However, if
3766 BODY-FIRST is non-nil, this step is delayed until the end of the
3767 process, leading to a different order when footnotes are nested."
3776 ;; Anonymous footnote match: return number.
3778 ;; Labels match: return number.
3780 ;; Otherwise store label and increase counter if label
3781 ;; wasn't encountered yet.
3787 ;;;; For Headlines
3788 ;;
3789 ;; `org-export-get-relative-level' is a shortcut to get headline
3790 ;; level, relatively to the lower headline level in the parsed tree.
3791 ;;
3792 ;; `org-export-get-headline-number' returns the section number of an
3793 ;; headline, while `org-export-number-to-roman' allows to convert it
3794 ;; to roman numbers. With an optional argument,
3795 ;; `org-export-get-headline-number' returns a number to unnumbered
3796 ;; headlines (used for internal id).
3797 ;;
3798 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3799 ;; `org-export-last-sibling-p' are three useful predicates when it
3800 ;; comes to fulfill the `:headline-levels' property.
3801 ;;
3802 ;; `org-export-get-tags', `org-export-get-category' and
3803 ;; `org-export-get-node-property' extract useful information from an
3804 ;; headline or a parent headline. They all handle inheritance.
3805 ;;
3806 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3807 ;; as a secondary string, suitable for table of contents. It falls
3808 ;; back onto default title.
3811 "Return HEADLINE relative level within current parsed tree.
3812 INFO is a plist holding contextual information."
3817 "Non-nil when HEADLINE is considered as low level.
3819 INFO is a plist used as a communication channel.
3821 A low level headlines has a relative level greater than
3822 `:headline-levels' property value.
3824 Return value is the difference between HEADLINE relative level
3825 and the last level being considered as high enough, or nil."
3832 "Return numbered HEADLINE numbering as a list of numbers.
3833 INFO is a plist holding contextual information."
3838 "Return a non-nil value if HEADLINE element should be numbered.
3839 INFO is a plist used as a communication channel."
3848 "Convert integer N into a roman numeral."
3861 res)))
3864 "Return list of tags associated to ELEMENT.
3866 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3867 is a plist used as a communication channel.
3869 Select tags (see `org-export-select-tags') and exclude tags (see
3870 `org-export-exclude-tags') are removed from the list.
3872 When non-nil, optional argument TAGS should be a list of strings.
3873 Any tag belonging to this list will also be removed.
3875 When optional argument INHERITED is non-nil, tags can also be
3876 inherited from parent headlines and FILETAGS keywords."
3882 ;; Build complete list of inherited tags.
3889 ;; Add FILETAGS keywords and return results.
3893 "Return node PROPERTY value for BLOB.
3895 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3896 element or object.
3898 If optional argument INHERITED is non-nil, the value can be
3899 inherited from a parent headline.
3901 Return value is a string or nil."
3913 "Return category for element or object BLOB.
3915 INFO is a plist used as a communication channel.
3917 CATEGORY is automatically inherited from a parent headline, from
3918 #+CATEGORY: keyword or created out of original file name. If all
3931 "Return alternative title for HEADLINE, as a secondary string.
3932 INFO is a plist used as a communication channel. If no optional
3933 title is defined, fall-back to the regular title."
3940 "Non-nil when BLOB is the first sibling in its parent.
3941 BLOB is an element or an object. If BLOB is a headline, non-nil
3942 means it is the first sibling in the sub-tree. INFO is a plist
3943 used as a communication channel."
3948 "Non-nil when BLOB is the last sibling in its parent.
3949 BLOB is an element or an object. INFO is a plist used as
3950 a communication channel."
3954 ;;;; For Keywords
3955 ;;
3956 ;; `org-export-get-date' returns a date appropriate for the document
3957 ;; to about to be exported. In particular, it takes care of
3958 ;; `org-export-date-timestamp-format'.
3961 "Return date value for the current document.
3963 INFO is a plist used as a communication channel. FMT, when
3964 non-nil, is a time format string that will be applied on the date
3965 if it consists in a single timestamp object. It defaults to
3966 `org-export-date-timestamp-format' when nil.
3968 A proper date can be a secondary string, a string or nil. It is
3969 meant to be translated with `org-export-data' or alike."
3980 ;;;; For Links
3981 ;;
3982 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3983 ;; with `org-add-link-type', which see.
3984 ;;
3985 ;; `org-export-get-coderef-format' returns an appropriate format
3986 ;; string for coderefs.
3987 ;;
3988 ;; `org-export-inline-image-p' returns a non-nil value when the link
3989 ;; provided should be considered as an inline image.
3990 ;;
3991 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3992 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3993 ;; returns an appropriate unique identifier when found, or nil.
3994 ;;
3995 ;; `org-export-resolve-id-link' returns the first headline with
3996 ;; specified id or custom-id in parse tree, the path to the external
3997 ;; file with the id or nil when neither was found.
3998 ;;
3999 ;; `org-export-resolve-coderef' associates a reference to a line
4000 ;; number in the element it belongs, or returns the reference itself
4001 ;; when the element isn't numbered.
4002 ;;
4003 ;; `org-export-file-uri' expands a filename as stored in :path value
4004 ;; of a "file" link into a file URI.
4007 "Try exporting LINK with a dedicated function.
4009 DESC is its description, as a string, or nil. BACKEND is the
4010 back-end used for export, as a symbol.
4012 Return output as a string, or nil if no protocol handles LINK.
4014 A custom protocol has precedence over regular back-end export.
4015 The function ignores links with an implicit type (e.g.,
4024 desc
4025 backend))))))
4028 "Return format string for code reference link.
4029 PATH is the link path. DESC is its description."
4037 "Non-nil if LINK object points to an inline image.
4039 Optional argument is a set of RULES defining inline images. It
4040 is an alist where associations have the following shape:
4042 \(TYPE . REGEXP)
4044 Applying a rule means apply REGEXP against LINK's path when its
4045 type is TYPE. The function will return a non-nil value if any of
4046 the provided rules is non-nil. The default rule is
4047 `org-export-default-inline-image-rule'.
4049 This only applies to links without a description."
4060 "Resolve a code reference REF.
4062 INFO is a plist used as a communication channel.
4064 Return associated line number in source code, or REF itself,
4065 depending on src-block or example element's switches. Throw an
4066 error if no block contains REF."
4073 org-coderef-label-format)))
4077 ;; Element containing REF is found. Resolve it to
4078 ;; either a label or a line number, as needed.
4089 "Return LINK destination.
4091 INFO is a plist holding contextual information.
4093 Return value can be an object or an element:
4095 - If LINK path matches a target object (i.e. <<path>>) return it.
4097 - If LINK path exactly matches the name affiliated keyword
4098 \(i.e. #+NAME: path) of an element, return that element.
4100 - If LINK path exactly matches any headline name, return that
4101 element.
4103 - Otherwise, throw an error.
4106 significant."
4109 ;; Split PATH at white spaces so matches are space
4110 ;; insensitive.
4116 :resolve-fuzzy-link-cache
4123 path
4125 ;; First try to find a matching "<<path>>" unless user
4126 ;; specified he was looking for a headline (path starts with
4127 ;; a "*" character).
4133 path)
4134 datum))
4136 ;; Then try to find an element with a matching "#+NAME: path"
4137 ;; affiliated keyword.
4144 ;; Try to find a matching headline.
4151 path)
4152 h))
4155 link-cache)))))
4158 "Return headline referenced as LINK destination.
4160 INFO is a plist used as a communication channel.
4162 Return value can be the headline element matched in current parse
4166 ;; First check if id is within the current parse tree.
4171 headline))
4173 ;; Otherwise, look for external files.
4178 "Return radio-target object referenced as LINK destination.
4180 INFO is a plist used as a communication channel.
4182 Return value can be a radio-target object or nil. Assume LINK
4191 nil nil path nil nil t)
4192 t)
4193 radio))
4197 "Return file URI associated to FILENAME."
4203 filename))))
4206 ;;;; For References
4207 ;;
4208 ;; `org-export-get-reference' associate a unique reference for any
4209 ;; object or element.
4210 ;;
4211 ;; `org-export-get-ordinal' associates a sequence number to any object
4212 ;; or element.
4215 "Return a unique reference for DATUM, as a string.
4216 DATUM is either an element or an object. INFO is the current
4217 export state, as a plist. Returned reference consists of
4218 alphanumeric characters only."
4223 h))))
4231 cache))))
4234 "Return ordinal number of an element or object.
4236 ELEMENT is the element or object considered. INFO is the plist
4237 used as a communication channel.
4239 Optional argument TYPES, when non-nil, is a list of element or
4240 object types, as symbols, that should also be counted in.
4241 Otherwise, only provided element's type is considered.
4243 Optional argument PREDICATE is a function returning a non-nil
4244 value if the current element or object should be counted in. It
4245 accepts two arguments: the element or object being considered and
4246 the plist used as a communication channel. This allows to count
4247 only a certain type of objects (i.e. inline images).
4249 Return value is a list of numbers if ELEMENT is a headline or an
4250 item. It is nil for keywords. It represents the footnote number
4251 for footnote definitions and footnote references. If ELEMENT is
4252 a target, return the same value as if ELEMENT was the closest
4253 table, item or headline containing the target. In any other
4254 case, return the sequence number of ELEMENT among elements or
4255 objects of the same type."
4256 ;; Ordinal of a target object refer to the ordinal of the closest
4257 ;; table, item, or headline containing the object.
4261 element
4264 ;; Special case 1: A headline returns its number as a list.
4266 ;; Special case 2: An item returns its number as a list.
4270 struct
4277 ;; Increment counter until ELEMENT is found again.
4288 ;;;; For Src-Blocks
4289 ;;
4290 ;; `org-export-get-loc' counts number of code lines accumulated in
4291 ;; src-block or example-block elements with a "+n" switch until
4292 ;; a given element, excluded. Note: "-n" switches reset that count.
4293 ;;
4294 ;; `org-export-unravel-code' extracts source code (along with a code
4295 ;; references alist) from an `element-block' or `src-block' type
4296 ;; element.
4297 ;;
4298 ;; `org-export-format-code' applies a formatting function to each line
4299 ;; of code, providing relative line number and code reference when
4300 ;; appropriate. Since it doesn't access the original element from
4301 ;; which the source code is coming, it expects from the code calling
4302 ;; it to know if lines should be numbered and if code references
4303 ;; should appear.
4304 ;;
4305 ;; Eventually, `org-export-format-code-default' is a higher-level
4306 ;; function (it makes use of the two previous functions) which handles
4307 ;; line numbering and code references inclusion, and returns source
4308 ;; code in a format suitable for plain text or verbatim output.
4311 "Return accumulated lines of code up to ELEMENT.
4313 INFO is the plist used as a communication channel.
4315 ELEMENT is excluded from count."
4321 ;; ELEMENT is reached: Quit the loop.
4323 ;; Only count lines from src-block and example-block elements
4324 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4328 ;; Accumulate locs or reset them.
4332 ;; Return nil to stay in the loop.
4333 nil)))
4335 ;; Return value.
4336 loc))
4339 "Clean source code and extract references out of it.
4341 ELEMENT has either a `src-block' an `example-block' type.
4343 Return a cons cell whose CAR is the source code, cleaned from any
4344 reference, protective commas and spurious indentation, and CDR is
4345 an alist between relative line number (integer) and name of code
4346 reference on that line (string)."
4349 ;; Get code and clean it. Remove blank lines at its
4350 ;; beginning and end.
4357 value
4359 ;; Get format used for references.
4362 org-coderef-label-format)))
4363 ;; Build a regexp matching a loc with a reference.
4368 ;; Return value.
4370 ;; Code with references removed.
4376 ;; Ref line: remove ref, and signal its position in REFS.
4380 ;; Reference alist.
4381 refs)))
4384 "Format CODE by applying FUN line-wise and return it.
4386 CODE is a string representing the code to format. FUN is
4387 a function. It must accept three arguments: a line of
4388 code (string), the current line number (integer) or nil and the
4389 reference associated to the current line (string) or nil.
4391 Optional argument NUM-LINES can be an integer representing the
4392 number of code lines accumulated until the current code. Line
4393 numbers passed to FUN will take it into account. If it is nil,
4394 FUN's second argument will always be nil. This number can be
4395 obtained with `org-export-get-loc' function.
4397 Optional argument REF-ALIST can be an alist between relative line
4398 number (i.e. ignoring NUM-LINES) and the name of the code
4399 reference on it. If it is nil, FUN's third argument will always
4400 be nil. It can be obtained through the use of
4401 `org-export-unravel-code' function."
4413 "Return source code from ELEMENT, formatted in a standard way.
4415 ELEMENT is either a `src-block' or `example-block' element. INFO
4416 is a plist used as a communication channel.
4418 This function takes care of line numbering and code references
4419 inclusion. Line numbers, when applicable, appear at the
4420 beginning of the line, separated from the code by two white
4421 spaces. Code references, on the other hand, appear flushed to
4422 the right, separated by six white spaces from the widest line of
4423 code."
4424 ;; Extract code and references.
4431 ;; Handle line numbering.
4440 ;; Prepare references display, if required. Any reference
4441 ;; should start six columns after the widest line of code,
4442 ;; wrapped with parenthesis.
4447 code
4451 number-str
4452 loc
4458 num-start refs)))))
4461 ;;;; For Tables
4462 ;;
4463 ;; `org-export-table-has-special-column-p' and and
4464 ;; `org-export-table-row-is-special-p' are predicates used to look for
4465 ;; meta-information about the table structure.
4466 ;;
4467 ;; `org-table-has-header-p' tells when the rows before the first rule
4468 ;; should be considered as table's header.
4469 ;;
4470 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4471 ;; and `org-export-table-cell-borders' extract information from
4472 ;; a table-cell element.
4473 ;;
4474 ;; `org-export-table-dimensions' gives the number on rows and columns
4475 ;; in the table, ignoring horizontal rules and special columns.
4476 ;; `org-export-table-cell-address', given a table-cell object, returns
4477 ;; the absolute address of a cell. On the other hand,
4478 ;; `org-export-get-table-cell-at' does the contrary.
4479 ;;
4480 ;; `org-export-table-cell-starts-colgroup-p',
4481 ;; `org-export-table-cell-ends-colgroup-p',
4482 ;; `org-export-table-row-starts-rowgroup-p',
4483 ;; `org-export-table-row-ends-rowgroup-p',
4484 ;; `org-export-table-row-starts-header-p',
4485 ;; `org-export-table-row-ends-header-p' and
4486 ;; `org-export-table-row-in-header-p' indicate position of current row
4487 ;; or cell within the table.
4490 "Non-nil when TABLE has a special column.
4491 All special columns will be ignored during export."
4492 ;; The table has a special column when every first cell of every row
4493 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4494 ;; "*" "_" and "^". Though, do not consider a first row containing
4495 ;; only empty cells as special.
4511 "Non-nil when TABLE has a header.
4513 INFO is a plist used as a communication channel.
4515 A table has a header when it contains at least two row groups."
4524 table
4535 cache)))))
4538 "Non-nil if TABLE-ROW is considered special.
4540 INFO is a plist used as the communication channel.
4542 All special rows will be ignored during export."
4546 ;; A row is special either when...
4548 ;; ... it starts with a field only containing "/",
4550 ;; ... the table contains a special column and the row start
4551 ;; with a marking character among, "^", "_", "$" or "!",
4555 ;; ... it contains only alignment cookies and empty cells.
4561 ;; Since VALUE is a secondary string, the following
4562 ;; checks avoid expanding it with `org-export-data'.
4574 "Return TABLE-ROW's group number, as an integer.
4576 INFO is a plist used as the communication channel.
4578 Return value is the group number, as an integer, or nil for
4579 special rows and rows separators. First group is also table's
4580 header."
4598 "Return TABLE-CELL contents width.
4600 INFO is a plist used as the communication channel.
4602 Return value is the width given by the last width cookie in the
4603 same column as TABLE-CELL, or nil."
4622 ;; In a special row, try to find a width cookie at COLUMN.
4626 ;; The following checks avoid expanding unnecessarily
4627 ;; the cell with `org-export-data'.
4637 "Return TABLE-CELL contents alignment.
4639 INFO is a plist used as the communication channel.
4641 Return alignment as specified by the last alignment cookie in the
4642 same column as TABLE-CELL. If no such cookie is found, a default
4643 alignment value will be deduced from fraction of numbers in the
4644 column (see `org-table-number-fraction' for more information).
4645 Possible values are `left', `right' and `center'."
4646 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4663 cookie-align
4664 previous-cell-number-p)
4667 ;; In a special row, try to find an alignment cookie at
4668 ;; COLUMN.
4672 ;; Since VALUE is a secondary string, the following
4673 ;; checks avoid useless expansion through
4674 ;; `org-export-data'.
4682 ;; Ignore table rules.
4684 ;; In a standard row, check if cell's contents are
4685 ;; expressing some kind of number. Increase NUMBER-CELLS
4686 ;; accordingly. Though, don't bother if an alignment
4687 ;; cookie has already defined cell's alignment.
4692 info)))
4694 ;; Treat an empty cell as a number if it follows
4695 ;; a number.
4701 ;; Return value. Alignment specified by cookies has
4702 ;; precedence over alignment deduced from cell's contents.
4704 column
4709 org-table-number-fraction)
4714 "Return TABLE-CELL borders.
4716 INFO is a plist used as a communication channel.
4718 Return value is a list of symbols, or nil. Possible values are:
4719 `top', `bottom', `above', `below', `left' and `right'. Note:
4720 `top' (resp. `bottom') only happen for a cell in the first
4721 row (resp. last row) of the table, ignoring table rules, if any.
4723 Returned borders ignore special rows."
4726 borders)
4727 ;; Top/above border? TABLE-CELL has a border above when a rule
4728 ;; used to demarcate row groups can be found above. Hence,
4729 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4730 ;; another regular row has to be found above that rule.
4739 ;; Look at every row before the current one.
4741 ;; No rule above, or rule found starts the table (ignoring any
4742 ;; special row): TABLE-CELL is at the top of the table.
4745 ;; Bottom/below border? TABLE-CELL has a border below when next
4746 ;; non-regular row below is a rule.
4755 ;; Look at every row after the current one.
4757 ;; No rule below, or rule found ends the table (modulo some
4758 ;; special row): TABLE-CELL is at the bottom of the table.
4761 ;; Right/left borders? They can only be specified by column
4762 ;; groups. Column groups are defined in a row starting with "/".
4763 ;; Also a column groups row only contains "<", "<>", ">" or blank
4764 ;; cells.
4781 ;; There's a left border when previous cell, if
4782 ;; any, ends a group, or current one starts one.
4788 ;; There's a right border when next cell, if any,
4789 ;; starts a group, or current one ends one.
4796 ;; Table rows are read in reverse order so last column groups
4797 ;; row has precedence over any previous one.
4799 ;; Return value.
4800 borders))
4803 "Non-nil when TABLE-CELL is at the beginning of a column group.
4804 INFO is a plist used as a communication channel."
4805 ;; A cell starts a column group either when it is at the beginning
4806 ;; of a row (or after the special column, if any) or when it has
4807 ;; a left border.
4810 table-cell)
4814 "Non-nil when TABLE-CELL is at the end of a column group.
4815 INFO is a plist used as a communication channel."
4816 ;; A cell ends a column group either when it is at the end of a row
4817 ;; or when it has a right border.
4820 table-cell)
4824 "Non-nil when TABLE-ROW is at the beginning of a row group.
4825 INFO is a plist used as a communication channel."
4833 "Non-nil when TABLE-ROW is at the end of a row group.
4834 INFO is a plist used as a communication channel."
4842 "Non-nil when TABLE-ROW is located within table's header.
4843 INFO is a plist used as a communication channel. Always return
4844 nil for special rows and rows separators."
4850 "Non-nil when TABLE-ROW is the first table header's row.
4851 INFO is a plist used as a communication channel."
4856 "Non-nil when TABLE-ROW is the last table header's row.
4857 INFO is a plist used as a communication channel."
4862 "Return TABLE-ROW number.
4863 INFO is a plist used as a communication channel. Return value is
4864 zero-based and ignores separators. The function returns nil for
4865 special columns and separators."
4877 "Return TABLE dimensions.
4879 INFO is a plist used as a communication channel.
4881 Return value is a CONS like (ROWS . COLUMNS) where
4882 ROWS (resp. COLUMNS) is the number of exportable
4883 rows (resp. columns)."
4885 ;; Set number of rows, and extract first one.
4891 ;; Set number of columns.
4893 ;; Return value.
4897 "Return address of a regular TABLE-CELL object.
4899 TABLE-CELL is the cell considered. INFO is a plist used as
4900 a communication channel.
4902 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4903 zero-based index. Only exportable cells are considered. The
4904 function returns nil for other cells."
4916 "Return regular table-cell object at ADDRESS in TABLE.
4918 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4919 zero-based index. TABLE is a table type element. INFO is
4920 a plist used as a communication channel.
4922 If no table-cell, among exportable cells, is found at ADDRESS,
4923 return nil."
4926 ;; Row at (car address) or nil.
4934 'table-cell
4941 ;;;; For Tables Of Contents
4942 ;;
4943 ;; `org-export-collect-headlines' builds a list of all exportable
4944 ;; headline elements, maybe limited to a certain depth. One can then
4945 ;; easily parse it and transcode it.
4946 ;;
4947 ;; Building lists of tables, figures or listings is quite similar.
4948 ;; Once the generic function `org-export-collect-elements' is defined,
4949 ;; `org-export-collect-tables', `org-export-collect-figures' and
4950 ;; `org-export-collect-listings' can be derived from it.
4953 "Collect headlines in order to build a table of contents.
4955 INFO is a plist used as a communication channel.
4957 When optional argument N is an integer, it specifies the depth of
4958 the table of contents. Otherwise, it is set to the value of the
4959 last headline level. See `org-export-headline-levels' for more
4960 information.
4962 Optional argument SCOPE, when non-nil, is an element. If it is
4963 a headline, only children of SCOPE are collected. Otherwise,
4964 collect children of the headline containing provided element. If
4965 there is no such headline, collect all headlines. In any case,
4966 argument N becomes relative to the level of that headline.
4968 Return a list of all exportable headlines as parsed elements.
4969 Footnote sections are ignored."
4978 limit))))
4984 info)))
4987 "Collect referenceable elements of a determined type.
4989 TYPE can be a symbol or a list of symbols specifying element
4990 types to search. Only elements with a caption are collected.
4992 INFO is a plist used as a communication channel.
4994 When non-nil, optional argument PREDICATE is a function accepting
4995 one argument, an element of type TYPE. It returns a non-nil
4996 value when that element should be collected.
4998 Return a list of all elements found, in order of appearance."
5003 element))
5004 info))
5007 "Build a list of tables.
5008 INFO is a plist used as a communication channel.
5010 Return a list of table elements with a caption."
5014 "Build a list of figures.
5016 INFO is a plist used as a communication channel. PREDICATE is
5017 a function which accepts one argument: a paragraph element and
5018 whose return value is non-nil when that element should be
5019 collected.
5021 A figure is a paragraph type element, with a caption, verifying
5023 a vague concept that may depend on back-end.
5025 Return a list of elements recognized as figures."
5029 "Build a list of src blocks.
5031 INFO is a plist used as a communication channel.
5033 Return a list of src-block elements with a caption."
5037 ;;;; Smart Quotes
5038 ;;
5039 ;; The main function for the smart quotes sub-system is
5040 ;; `org-export-activate-smart-quotes', which replaces every quote in
5041 ;; a given string from the parse tree with its "smart" counterpart.
5042 ;;
5043 ;; Dictionary for smart quotes is stored in
5044 ;; `org-export-smart-quotes-alist'.
5045 ;;
5046 ;; Internally, regexps matching potential smart quotes (checks at
5047 ;; string boundaries are also necessary) are defined in
5048 ;; `org-export-smart-quotes-regexps'.
5052 ;; one may use: »...«, "...", ›...‹, or '...'.
5053 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5054 ;; LaTeX quotes require Babel!
5099 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5108 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5117 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5126 ;; 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
5127 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5138 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5144 )
5145 "Smart quotes translations.
5147 Alist whose CAR is a language string and CDR is an alist with
5148 quote type as key and a plist associating various encodings to
5149 their translation as value.
5151 A quote type can be any symbol among `opening-double-quote',
5152 `closing-double-quote', `opening-single-quote',
5153 `closing-single-quote' and `apostrophe'.
5155 Valid encodings include `:utf-8', `:html', `:latex' and
5156 `:texinfo'.
5161 "Return smart quote status at the beginning of string S.
5162 INFO is the current export state, as a plist."
5167 table)))
5180 ;; Not already in a level 1 quote: this is an
5181 ;; apostrophe.
5183 ;; Extract previous char and next char. As
5184 ;; a special case, they can also be set to `blank',
5185 ;; `no-blank' or nil. Then determine if current
5186 ;; match is allowed as an opening quote or a closing
5187 ;; quote.
5192 text info)))
5209 previous)
5220 next)
5227 current-status)
5231 info nil org-element-recursive-objects)
5238 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5239 `:utf-8'. INFO is a plist used as a communication channel.
5241 The function has to retrieve information about string
5242 surroundings in parse tree. It can only happen with an
5243 unmodified string. Thus, if S has already been through another
5244 process, a non-nil ORIGINAL optional argument will provide that
5245 original string.
5247 Return the new string."
5256 org-export-smart-quotes-alist))))
5257 encoding)
5258 match))
5259 s nil t)))
5261 ;;;; Topology
5262 ;;
5263 ;; Here are various functions to retrieve information about the
5264 ;; neighborhood of a given element or object. Neighbors of interest
5265 ;; are direct parent (`org-export-get-parent'), parent headline
5266 ;; (`org-export-get-parent-headline'), first element containing an
5267 ;; object, (`org-export-get-parent-element'), parent table
5268 ;; (`org-export-get-parent-table'), previous element or object
5269 ;; (`org-export-get-previous-element') and next element or object
5270 ;; (`org-export-get-next-element').
5272 ;; defsubst org-export-get-parent must be defined before first use
5278 "Return BLOB parent headline or nil.
5279 BLOB is the element or object being considered."
5283 "Return first element containing OBJECT or nil.
5284 OBJECT is the object to consider."
5288 "Return OBJECT parent table or nil.
5289 OBJECT is either a `table-cell' or `table-element' type object."
5293 "Return previous element or object.
5295 BLOB is an element or object. INFO is a plist used as
5296 a communication channel. Return previous exportable element or
5297 object, a string, or nil.
5299 When optional argument N is a positive integer, return a list
5300 containing up to N siblings before BLOB, from farthest to
5301 closest. With any other non-nil value, return a list containing
5302 all of them."
5308 prev)
5318 "Return next element or object.
5320 BLOB is an element or object. INFO is a plist used as
5321 a communication channel. Return next exportable element or
5322 object, a string, or nil.
5324 When optional argument N is a positive integer, return a list
5325 containing up to N siblings after BLOB, from closest to farthest.
5326 With any other non-nil value, return a list containing all of
5327 them."
5334 next)
5344 ;;;; Translation
5345 ;;
5346 ;; `org-export-translate' translates a string according to the language
5347 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5348 ;; the dictionary used for the translation.
5380 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5390 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5396 ("ru" :html "(Продолжение следует)"
5470 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5493 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5499 ("ru" :html "Список распечаток"
5513 ("ru" :html "Список таблиц"
5619 ("ru" :html "Неизвестная ссылка"
5622 "Dictionary for export engine.
5624 Alist whose car is the string to translate and cdr is an alist
5625 whose car is the language string and cdr is a plist whose
5626 properties are possible charsets and values translated terms.
5628 It is used as a database for `org-export-translate'. Since this
5629 function returns the string as-is if no translation was found,
5630 the variable only needs to record values different from the
5634 "Translate string S according to language specification.
5636 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5637 and `:utf-8'. INFO is a plist used as a communication channel.
5639 Translation depends on `:language' property. Return the
5640 translated string. If no translation is found, try to fall back
5641 to `:default' encoding. If it fails, return S."
5647 s)))
5650 \f
5651 ;;; Asynchronous Export
5652 ;;
5653 ;; `org-export-async-start' is the entry point for asynchronous
5654 ;; export. It recreates current buffer (including visibility,
5655 ;; narrowing and visited file) in an external Emacs process, and
5656 ;; evaluates a command there. It then applies a function on the
5657 ;; returned results in the current process.
5658 ;;
5659 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5660 ;; allow to export to a buffer or a file, asynchronously or not.
5661 ;;
5662 ;; `org-export-output-file-name' is an auxiliary function meant to be
5663 ;; used with `org-export-to-file'. With a given extension, it tries
5664 ;; to provide a canonical file name to write export output to.
5665 ;;
5666 ;; Asynchronously generated results are never displayed directly.
5667 ;; Instead, they are stored in `org-export-stack-contents'. They can
5668 ;; then be retrieved by calling `org-export-stack'.
5669 ;;
5670 ;; Export Stack is viewed through a dedicated major mode
5671 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5672 ;;`org-export-stack-delete', `org-export-stack-view' and
5673 ;;`org-export-stack-clear'.
5674 ;;
5675 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5676 ;; It should be used whenever `org-export-async-start' is called.
5679 "Call function FUN on the results returned by BODY evaluation.
5681 FUN is an anonymous function of one argument. BODY evaluation
5682 happens in an asynchronous process, from a buffer which is an
5683 exact copy of the current one.
5685 Use `org-export-add-to-stack' in FUN in order to register results
5686 in the stack.
5688 This is a low level function. See also `org-export-to-buffer'
5689 and `org-export-to-file' for more specialized functions."
5692 ;; Write the full sexp evaluating BODY in a copy of the current
5693 ;; buffer to a temporary file, as it may be too long for program
5694 ;; args in `start-process'.
5701 ;; Null characters (from variable values) are inserted
5702 ;; within the file. As a consequence, coding system for
5703 ;; buffer contents will not be recognized properly. So,
5704 ;; we make sure it is the same as the one used to display
5705 ;; the original buffer.
5707 ,coding
5710 ;; Ignore `kill-emacs-hook' and code evaluation
5711 ;; queries from Babel as we need a truly
5712 ;; non-interactive process.
5714 org-babel-confirm-evaluate-answer-no t)
5715 ;; Initialize export framework.
5717 ;; Re-create current buffer there.
5720 ;; Sexp to evaluate in the buffer.
5722 ;; Start external process.
5725 (,process
5727 #'start-process
5730 ,proc-buffer
5737 ;; Register running process in stack.
5739 ;; Set-up sentinel in order to catch results.
5742 ,process
5764 ;;;###autoload
5767 &optional async subtreep visible-only body-only ext-plist
5768 post-process)
5769 "Call `org-export-as' with output to a specified buffer.
5771 BACKEND is either an export back-end, as returned by, e.g.,
5772 `org-export-create-backend', or a symbol referring to
5773 a registered back-end.
5775 BUFFER is the name of the output buffer. If it already exists,
5776 it will be erased first, otherwise, it will be created.
5778 A non-nil optional argument ASYNC means the process should happen
5779 asynchronously. The resulting buffer should then be accessible
5780 through the `org-export-stack' interface. When ASYNC is nil, the
5781 buffer is displayed if `org-export-show-temporary-export-buffer'
5782 is non-nil.
5784 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5785 EXT-PLIST are similar to those used in `org-export-as', which
5786 see.
5788 Optional argument POST-PROCESS is a function which should accept
5789 no argument. It is always called within the current process,
5790 from BUFFER, with point at its beginning. Export back-ends can
5791 use it to set a major mode there, e.g,
5793 \(defun org-latex-export-as-latex
5794 \(&optional async subtreep visible-only body-only ext-plist)
5795 \(interactive)
5797 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5799 This function returns BUFFER."
5827 buffer)))
5829 ;;;###autoload
5832 post-process)
5833 "Call `org-export-as' with output to a specified file.
5835 BACKEND is either an export back-end, as returned by, e.g.,
5836 `org-export-create-backend', or a symbol referring to
5837 a registered back-end. FILE is the name of the output file, as
5838 a string.
5840 A non-nil optional argument ASYNC means the process should happen
5841 asynchronously. The resulting buffer will then be accessible
5842 through the `org-export-stack' interface.
5844 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5845 EXT-PLIST are similar to those used in `org-export-as', which
5846 see.
5848 Optional argument POST-PROCESS is called with FILE as its
5849 argument and happens asynchronously when ASYNC is non-nil. It
5850 has to return a file name, or nil. Export back-ends can use this
5851 to send the output file through additional processing, e.g,
5853 \(defun org-latex-export-to-latex
5854 \(&optional async subtreep visible-only body-only ext-plist)
5855 \(interactive)
5857 \(org-export-to-file 'latex outfile
5858 async subtreep visible-only body-only ext-plist
5859 \(lambda (file) (org-latex-compile file)))
5861 The function returns either a file name returned by POST-PROCESS,
5862 or FILE."
5881 backend subtreep visible-only body-only ext-plist)))
5888 ;; Get proper return value.
5890 file))))))
5893 "Return output file's name according to buffer specifications.
5895 EXTENSION is a string representing the output file extension,
5896 with the leading dot.
5898 With a non-nil optional argument SUBTREEP, try to determine
5900 of subtree at point.
5902 When optional argument PUB-DIR is set, use it as the publishing
5903 directory.
5905 Return file name as a string."
5908 ;; File name may come from EXPORT_FILE_NAME subtree
5909 ;; property, assuming point is at beginning of said
5910 ;; sub-tree.
5917 ;; File name may be extracted from buffer's associated
5918 ;; file, if any.
5920 ;; Can't determine file name on our own: Ask user.
5924 "Output file: " pub-dir nil nil nil
5928 ;; Build file name. Enforce EXTENSION over whatever user
5929 ;; may have come up with. PUB-DIR, if defined, always has
5930 ;; precedence over any provided path.
5935 extension))
5938 ;; If writing to OUTPUT-FILE would overwrite original file, append
5939 ;; EXTENSION another time to final name.
5942 output-file)))
5945 "Add a new result to export stack if not present already.
5947 SOURCE is a buffer or a file name containing export results.
5948 BACKEND is a symbol representing export back-end used to generate
5949 it.
5951 Entries already pointing to SOURCE and unavailable entries are
5952 removed beforehand. Return the new stack."
5958 "Menu for asynchronous export results and running processes."
5968 "Return source from export results at point in stack."
5975 source
5976 ;; SOURCE is not consistent with current line. The stack
5977 ;; view is outdated.
5981 "Remove all entries from export stack."
5986 "Refresh the asynchronous export stack.
5987 DUMMY is ignored. Unavailable sources are removed from the list.
5988 Return the new stack."
5998 ;; Back-end.
6000 ;; Age.
6003 ;; Compute age of the results.
6005 "%4h:%.2m "
6007 ;; Source.
6012 ;; Clear stack from exited processes, dead buffers or
6013 ;; non-existent files.
6025 "Remove export results at point from stack.
6026 If optional argument SOURCE is non-nil, remove it instead."
6031 org-export-stack-contents))))
6034 "View export results at point in stack.
6035 With an optional prefix argument IN-EMACS, force viewing files
6036 within Emacs."
6050 (define-key km "p" 'previous-line)
6051 (define-key km "\C-p" 'previous-line)
6052 (define-key km "\C-?" 'previous-line)
6053 (define-key km [up] 'previous-line)
6054 (define-key km "C" 'org-export-stack-clear)
6055 (define-key km "v" 'org-export-stack-view)
6056 (define-key km (kbd "RET") 'org-export-stack-view)
6057 (define-key km "d" 'org-export-stack-remove)
6058 km)
6059 "Keymap for Org Export Stack.")
6061 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6062 "Mode for displaying asynchronous export stack.
6065 stack.
6067 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6068 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6069 stack completely.
6071 Removing entries in an Org Export Stack buffer doesn't affect
6072 files or buffers, only the display.
6075 (abbrev-mode 0)
6076 (auto-fill-mode 0)
6077 (setq buffer-read-only t
6078 buffer-undo-list t
6079 truncate-lines t
6080 header-line-format
6081 '(:eval
6082 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6083 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6084 (set (make-local-variable 'revert-buffer-function)
6085 'org-export-stack-refresh))
6088 \f
6089 ;;; The Dispatcher
6090 ;;
6091 ;; `org-export-dispatch' is the standard interactive way to start an
6092 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6093 ;; for its interface, which, in turn, delegates response to key
6094 ;; pressed to `org-export--dispatch-action'.
6096 ;;;###autoload
6097 (defun org-export-dispatch (&optional arg)
6098 "Export dispatcher for Org mode.
6100 It provides an access to common export related tasks in a buffer.
6101 Its interface comes in two flavors: standard and expert.
6103 While both share the same set of bindings, only the former
6104 displays the valid keys associations in a dedicated buffer.
6105 Scrolling (resp. line-wise motion) in this buffer is done with
6106 SPC and DEL (resp. C-n and C-p) keys.
6108 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6109 flavor or the other.
6112 of options used back then, on the current buffer.
6114 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6115 (interactive "P")
6116 (let* ((input
6117 (cond ((equal arg '(16)) '(stack))
6118 ((and arg org-export-dispatch-last-action))
6119 (t (save-window-excursion
6120 (unwind-protect
6121 (progn
6122 ;; Remember where we are
6123 (move-marker org-export-dispatch-last-position
6124 (point)
6125 (org-base-buffer (current-buffer)))
6126 ;; Get and store an export command
6127 (setq org-export-dispatch-last-action
6128 (org-export--dispatch-ui
6129 (list org-export-initial-scope
6130 (and org-export-in-background 'async))
6131 nil
6132 org-export-dispatch-use-expert-ui)))
6133 (and (get-buffer "*Org Export Dispatcher*")
6134 (kill-buffer "*Org Export Dispatcher*")))))))
6135 (action (car input))
6136 (optns (cdr input)))
6137 (unless (memq 'subtree optns)
6138 (move-marker org-export-dispatch-last-position nil))
6139 (case action
6140 ;; First handle special hard-coded actions.
6141 (template (org-export-insert-default-template nil optns))
6142 (stack (org-export-stack))
6143 (publish-current-file
6144 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6145 (publish-current-project
6146 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6147 (publish-choose-project
6148 (org-publish (assoc (org-icompleting-read
6149 "Publish project: "
6150 org-publish-project-alist nil t)
6151 org-publish-project-alist)
6152 (memq 'force optns)
6153 (memq 'async optns)))
6154 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6155 (otherwise
6156 (save-excursion
6157 (when arg
6158 ;; Repeating command, maybe move cursor to restore subtree
6159 ;; context.
6160 (if (eq (marker-buffer org-export-dispatch-last-position)
6161 (org-base-buffer (current-buffer)))
6162 (goto-char org-export-dispatch-last-position)
6163 ;; We are in a different buffer, forget position.
6164 (move-marker org-export-dispatch-last-position nil)))
6165 (funcall action
6166 ;; Return a symbol instead of a list to ease
6167 ;; asynchronous export macro use.
6168 (and (memq 'async optns) t)
6169 (and (memq 'subtree optns) t)
6170 (and (memq 'visible optns) t)
6171 (and (memq 'body optns) t)))))))
6173 (defun org-export--dispatch-ui (options first-key expertp)
6174 "Handle interface for `org-export-dispatch'.
6176 OPTIONS is a list containing current interactive options set for
6177 export. It can contain any of the following symbols:
6178 `body' toggles a body-only export
6179 `subtree' restricts export to current subtree
6180 `visible' restricts export to visible part of buffer.
6181 `force' force publishing files.
6182 `async' use asynchronous export process
6184 FIRST-KEY is the key pressed to select the first level menu. It
6185 is nil when this menu hasn't been selected yet.
6187 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6188 buffer is provided, but indications about currently active
6189 options are given in the prompt. Moreover, \[?] allows to switch
6190 back to standard interface."
6191 (let* ((fontify-key
6192 (lambda (key &optional access-key)
6193 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6194 ;; non-nil is the required first-level key to activate
6195 ;; KEY. When its value is t, activate KEY independently
6196 ;; on the first key, if any. A nil value means KEY will
6197 ;; only be activated at first level.
6198 (if (or (eq access-key t) (eq access-key first-key))
6199 (org-propertize key 'face 'org-warning)
6200 key)))
6201 (fontify-value
6202 (lambda (value)
6203 ;; Fontify VALUE string.
6204 (org-propertize value 'face 'font-lock-variable-name-face)))
6205 ;; Prepare menu entries by extracting them from registered
6206 ;; back-ends and sorting them by access key and by ordinal,
6207 ;; if any.
6208 (entries
6209 (sort (sort (delq nil
6210 (mapcar #'org-export-backend-menu
6211 org-export-registered-backends))
6212 (lambda (a b)
6213 (let ((key-a (nth 1 a))
6214 (key-b (nth 1 b)))
6215 (cond ((and (numberp key-a) (numberp key-b))
6216 (< key-a key-b))
6217 ((numberp key-b) t)))))
6218 'car-less-than-car))
6219 ;; Compute a list of allowed keys based on the first key
6220 ;; pressed, if any. Some keys
6221 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6222 ;; available.
6223 (allowed-keys
6224 (nconc (list 2 22 19 6 1)
6225 (if (not first-key) (org-uniquify (mapcar 'car entries))
6226 (let (sub-menu)
6227 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6228 (when (eq (car entry) first-key)
6229 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6230 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6231 ((not first-key) (list ?P)))
6232 (list ?& ?#)
6233 (when expertp (list ??))
6234 (list ?q)))
6235 ;; Build the help menu for standard UI.
6236 (help
6237 (unless expertp
6238 (concat
6239 ;; Options are hard-coded.
6240 (format "[%s] Body only: %s [%s] Visible only: %s
6241 \[%s] Export scope: %s [%s] Force publishing: %s
6243 (funcall fontify-key "C-b" t)
6244 (funcall fontify-value
6245 (if (memq 'body options) "On " "Off"))
6246 (funcall fontify-key "C-v" t)
6247 (funcall fontify-value
6248 (if (memq 'visible options) "On " "Off"))
6249 (funcall fontify-key "C-s" t)
6250 (funcall fontify-value
6251 (if (memq 'subtree options) "Subtree" "Buffer "))
6252 (funcall fontify-key "C-f" t)
6253 (funcall fontify-value
6254 (if (memq 'force options) "On " "Off"))
6255 (funcall fontify-key "C-a" t)
6256 (funcall fontify-value
6257 (if (memq 'async options) "On " "Off")))
6258 ;; Display registered back-end entries. When a key
6259 ;; appears for the second time, do not create another
6260 ;; entry, but append its sub-menu to existing menu.
6261 (let (last-key)
6262 (mapconcat
6263 (lambda (entry)
6264 (let ((top-key (car entry)))
6265 (concat
6266 (unless (eq top-key last-key)
6267 (setq last-key top-key)
6269 (funcall fontify-key (char-to-string top-key))
6270 (nth 1 entry)))
6271 (let ((sub-menu (nth 2 entry)))
6272 (unless (functionp sub-menu)
6273 ;; Split sub-menu into two columns.
6274 (let ((index -1))
6275 (concat
6276 (mapconcat
6277 (lambda (sub-entry)
6278 (incf index)
6279 (format
6280 (if (zerop (mod index 2)) " [%s] %-26s"
6282 (funcall fontify-key
6283 (char-to-string (car sub-entry))
6284 top-key)
6285 (nth 1 sub-entry)))
6286 sub-menu "")
6288 entries ""))
6289 ;; Publishing menu is hard-coded.
6291 [%s] Current file [%s] Current project
6293 (funcall fontify-key "P")
6294 (funcall fontify-key "f" ?P)
6295 (funcall fontify-key "p" ?P)
6296 (funcall fontify-key "x" ?P)
6297 (funcall fontify-key "a" ?P))
6299 (funcall fontify-key "&" t)
6300 (funcall fontify-key "#" t))
6301 (format "[%s] %s"
6302 (funcall fontify-key "q" t)
6303 (if first-key "Main menu" "Exit")))))
6304 ;; Build prompts for both standard and expert UI.
6305 (standard-prompt (unless expertp "Export command: "))
6306 (expert-prompt
6307 (when expertp
6308 (format
6309 "Export command (C-%s%s%s%s%s) [%s]: "
6310 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6311 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6312 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6313 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6314 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6315 (mapconcat (lambda (k)
6316 ;; Strip control characters.
6317 (unless (< k 27) (char-to-string k)))
6318 allowed-keys "")))))
6319 ;; With expert UI, just read key with a fancy prompt. In standard
6320 ;; UI, display an intrusive help buffer.
6321 (if expertp
6322 (org-export--dispatch-action
6323 expert-prompt allowed-keys entries options first-key expertp)
6324 ;; At first call, create frame layout in order to display menu.
6325 (unless (get-buffer "*Org Export Dispatcher*")
6326 (delete-other-windows)
6327 (org-switch-to-buffer-other-window
6328 (get-buffer-create "*Org Export Dispatcher*"))
6329 (setq cursor-type nil
6330 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6331 ;; Make sure that invisible cursor will not highlight square
6332 ;; brackets.
6333 (set-syntax-table (copy-syntax-table))
6334 (modify-syntax-entry ?\[ "w"))
6335 ;; At this point, the buffer containing the menu exists and is
6336 ;; visible in the current window. So, refresh it.
6337 (with-current-buffer "*Org Export Dispatcher*"
6338 ;; Refresh help. Maintain display continuity by re-visiting
6339 ;; previous window position.
6340 (let ((pos (window-start)))
6341 (erase-buffer)
6342 (insert help)
6343 (set-window-start nil pos)))
6344 (org-fit-window-to-buffer)
6345 (org-export--dispatch-action
6346 standard-prompt allowed-keys entries options first-key expertp))))
6348 (defun org-export--dispatch-action
6349 (prompt allowed-keys entries options first-key expertp)
6350 "Read a character from command input and act accordingly.
6352 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6353 a list of characters available at a given step in the process.
6354 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6355 EXPERTP are the same as defined in `org-export--dispatch-ui',
6356 which see.
6358 Toggle export options when required. Otherwise, return value is
6359 a list with action as CAR and a list of interactive export
6360 options as CDR."
6361 (let (key)
6362 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6363 ;; C-p, SPC, DEL).
6364 (while (and (setq key (read-char-exclusive prompt))
6365 (not expertp)
6366 (memq key '(14 16 ?\s ?\d)))
6367 (case key
6368 (14 (if (not (pos-visible-in-window-p (point-max)))
6369 (ignore-errors (scroll-up 1))
6370 (message "End of buffer")
6371 (sit-for 1)))
6372 (16 (if (not (pos-visible-in-window-p (point-min)))
6373 (ignore-errors (scroll-down 1))
6374 (message "Beginning of buffer")
6375 (sit-for 1)))
6376 (?\s (if (not (pos-visible-in-window-p (point-max)))
6377 (scroll-up nil)
6378 (message "End of buffer")
6379 (sit-for 1)))
6380 (?\d (if (not (pos-visible-in-window-p (point-min)))
6381 (scroll-down nil)
6382 (message "Beginning of buffer")
6383 (sit-for 1)))))
6384 (cond
6385 ;; Ignore undefined associations.
6386 ((not (memq key allowed-keys))
6387 (ding)
6388 (unless expertp (message "Invalid key") (sit-for 1))
6389 (org-export--dispatch-ui options first-key expertp))
6390 ;; q key at first level aborts export. At second level, cancel
6391 ;; first key instead.
6392 ((eq key ?q) (if (not first-key) (error "Export aborted")
6393 (org-export--dispatch-ui options nil expertp)))
6394 ;; Help key: Switch back to standard interface if expert UI was
6395 ;; active.
6396 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6397 ;; Send request for template insertion along with export scope.
6398 ((eq key ?#) (cons 'template (memq 'subtree options)))
6399 ;; Switch to asynchronous export stack.
6400 ((eq key ?&) '(stack))
6401 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6402 ((memq key '(2 22 19 6 1))
6403 (org-export--dispatch-ui
6404 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6405 (6 'force) (1 'async))))
6406 (if (memq option options) (remq option options)
6407 (cons option options)))
6408 first-key expertp))
6409 ;; Action selected: Send key and options back to
6410 ;; `org-export-dispatch'.
6411 ((or first-key (functionp (nth 2 (assq key entries))))
6412 (cons (cond
6413 ((not first-key) (nth 2 (assq key entries)))
6414 ;; Publishing actions are hard-coded. Send a special
6415 ;; signal to `org-export-dispatch'.
6416 ((eq first-key ?P)
6417 (case key
6418 (?f 'publish-current-file)
6419 (?p 'publish-current-project)
6420 (?x 'publish-choose-project)
6421 (?a 'publish-all)))
6422 ;; Return first action associated to FIRST-KEY + KEY
6423 ;; path. Indeed, derived backends can share the same
6424 ;; FIRST-KEY.
6425 (t (catch 'found
6426 (mapc (lambda (entry)
6427 (let ((match (assq key (nth 2 entry))))
6428 (when match (throw 'found (nth 2 match)))))
6429 (member (assq first-key entries) entries)))))
6430 options))
6431 ;; Otherwise, enter sub-menu.
6432 (t (org-export--dispatch-ui options key expertp)))))
6436 (provide 'ox)
6438 ;; Local variables:
6439 ;; generated-autoload-file: "org-loaddefs.el"
6440 ;; End:
6442 ;;; ox.el ends here