| blob | f7d0ef5e6226c9ec7798699283710085fb64e765 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 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 behaviour 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 :footnote-definition-alist
1324 ;; Footnotes definitions must be collected in the original
1325 ;; buffer, as there's no insurance that they will still be in
1326 ;; the parse tree, due to possible narrowing.
1342 alist))
1354 alist)))))))
1355 alist))
1356 :id-alist
1357 ;; Collect id references.
1368 alist))))
1371 "Parse an OPTIONS line and return values as a plist.
1372 Optional argument BACKEND is an export back-end, as returned by,
1373 e.g., `org-export-create-backend'. It specifies which back-end
1374 specific items to read, if any."
1376 ;; Priority is given to back-end specific options.
1378 org-export-options-alist))
1379 plist)
1388 options))
1390 property
1393 plist))
1396 "Get export options in subtree at point.
1397 Optional argument BACKEND is an export back-end, as returned by,
1398 e.g., `org-export-create-backend'. It specifies back-end used
1399 for export. Return options as a plist."
1400 ;; For each buffer keyword, create a headline property setting the
1401 ;; same property in communication channel. The name for the property
1402 ;; is the keyword with "EXPORT_" appended to it.
1405 ;; Look for both general keywords and back-end specific
1406 ;; options, with priority given to the latter.
1408 org-export-options-alist)))
1409 ;; Make sure point is at a heading.
1411 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1412 ;; title (with no todo keyword, priority cookie or tag) as its
1413 ;; fallback value.
1419 plist :title
1423 title))))
1424 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1429 ;; Handle other keywords. TITLE keyword is excluded as it has
1430 ;; been handled already. Then return PLIST.
1442 plist
1443 property
1452 "Return current buffer export options, as a plist.
1454 Optional argument BACKEND, when non-nil, is an export back-end,
1455 as returned by, e.g., `org-export-create-backend'. It specifies
1456 which back-end specific options should also be read in the
1457 process.
1459 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1461 get-options ; For byte-compiler.
1464 ;; Priority is given to back-end specific options.
1466 org-export-options-alist))
1469 org-export-special-keywords))))
1472 ;; Return all properties associated to KEYWORD.
1477 to-parse
1480 ;; Recursively read keywords in buffer. FILES is a list
1481 ;; of files read so far. PLIST is the current property
1482 ;; list obtained.
1491 ;; Options in `org-export-special-keywords'.
1495 ;; Avoid circular dependencies.
1505 plist
1510 plist
1516 ;; Options in `org-export-options-alist'.
1519 plist
1521 plist property
1522 ;; Handle value depending on specified
1523 ;; BEHAVIOR.
1528 ;; Even if `parse' implies `space'
1529 ;; behavior, we separate line with "\n"
1530 ;; so as to preserve line-breaks.
1531 ;; However, empty lines are forbidden
1532 ;; since `parse' doesn't allow more than
1533 ;; one paragraph.
1542 " "
1555 plist))))
1556 ;; Read options in the current buffer and return value.
1559 nil)))
1560 ;; Parse properties in TO-PARSE. Remove newline characters not
1561 ;; involved in line breaks to simulate `space' behaviour.
1562 ;; Finally return options.
1574 "Return properties related to buffer attributes, as a plist."
1579 "Return global export options as a plist.
1580 Optional argument BACKEND, if non-nil, is an export back-end, as
1581 returned by, e.g., `org-export-create-backend'. It specifies
1582 which back-end specific export options should also be read in the
1583 process."
1585 ;; Priority is given to back-end specific options.
1587 org-export-options-alist)))
1593 plist
1594 prop
1595 ;; Evaluate default value provided.
1600 value)))))))))
1603 "Return variables bound from BIND keywords in current buffer.
1604 Also look for BIND keywords in setup files. The return value is
1605 an alist where associations are (VARIABLE-NAME VALUE)."
1610 ;; Return an alist between variable names and their
1611 ;; value. FILES is a list of setup files names read so
1612 ;; far, used to avoid circular dependencies. ALIST is
1613 ;; the alist collected so far.
1624 ;; Enter setup file.
1634 alist))))))))))
1635 alist)))))
1636 ;; Return value in appropriate order of appearance.
1639 ;; defsubst org-export-get-parent must be defined before first use,
1640 ;; was originally defined in the topology section
1643 "Return BLOB parent or nil.
1644 BLOB is the element or object considered."
1647 ;;;; Tree Properties
1648 ;;
1649 ;; Tree properties are information extracted from parse tree. They
1650 ;; are initialized at the beginning of the transcoding process by
1651 ;; `org-export-collect-tree-properties'.
1652 ;;
1653 ;; Dedicated functions focus on computing the value of specific tree
1654 ;; properties during initialization. Thus,
1655 ;; `org-export--populate-ignore-list' lists elements and objects that
1656 ;; should be skipped during export, `org-export--get-min-level' gets
1657 ;; the minimal exportable level, used as a basis to compute relative
1658 ;; level for headlines. Eventually
1659 ;; `org-export--collect-headline-numbering' builds an alist between
1660 ;; headlines and their numbering.
1663 "Extract tree properties from parse tree.
1665 DATA is the parse tree from which information is retrieved. INFO
1666 is a list holding export options.
1668 Following tree properties are set or updated:
1670 `:exported-data' Hash table used to memoize results from
1671 `org-export-data'.
1673 `:footnote-definition-alist' List of footnotes definitions in
1674 original buffer and current parse tree.
1676 `:headline-offset' Offset between true level of headlines and
1677 local level. An offset of -1 means a headline
1678 of level 2 should be considered as a level
1679 1 headline in the context.
1681 `:headline-numbering' Alist of all headlines as key an the
1682 associated numbering as value.
1684 Return updated plist."
1685 ;; Install the parse tree in the communication channel.
1687 ;; Compute `:headline-offset' in order to be able to use
1688 ;; `org-export-get-relative-level'.
1691 :headline-offset
1693 ;; Footnote definitions in parse tree override those stored in
1694 ;; `:footnote-definition-alist'. This way, any change to
1695 ;; a definition in the parse tree (e.g., through a parse tree
1696 ;; filter) propagates into the alist.
1703 defs))
1707 defs)))))
1709 ;; Properties order doesn't matter: get the rest of the tree
1710 ;; properties.
1714 info))
1717 "Return minimum exportable headline's level in DATA.
1718 DATA is parsed tree as returned by `org-element-parse-buffer'.
1719 OPTIONS is a plist holding export options."
1730 ;; If no headline was found, for the sake of consistency, set
1731 ;; minimum level to 1 nonetheless.
1735 "Return numbering of all exportable, numbered headlines in a parse tree.
1737 DATA is the parse tree. OPTIONS is the plist holding export
1738 options.
1740 Return an alist whose key is a headline and value is its
1741 associated numbering \(in the shape of a list of numbers\) or nil
1742 for a footnotes section."
1751 headline
1753 for idx from 0 to org-export-max-depth
1757 options)))
1760 "List headlines and inlinetasks with a select tag in their tree.
1761 DATA is parsed data as returned by `org-element-parse-buffer'.
1762 INFO is a plist holding export options."
1764 walk-data ; For byte-compiler.
1774 ;; When a select tag is found, mark full
1775 ;; genealogy and every headline within the tree
1776 ;; as acceptable.
1779 genealogy
1782 selected-trees))
1783 ;; If at a headline, continue searching in tree,
1784 ;; recursively.
1793 selected-trees))
1796 "Non-nil when element or object BLOB should be skipped during export.
1797 OPTIONS is the plist holding export options. SELECTED, when
1798 non-nil, is a list of headlines or inlinetasks belonging to
1799 a tree with a select tag."
1806 ;; If `:with-drawers' value starts with `not', ignore
1807 ;; every drawer whose name belong to that list.
1808 ;; Otherwise, ignore drawers whose name isn't in that
1809 ;; list.
1826 ;; Ignore subtrees with an exclude tag.
1829 ;; When a select tag is present in the buffer, ignore any tree
1830 ;; without it.
1832 ;; Ignore commented sub-trees.
1834 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1836 ;; Ignore tasks, if specified by `:with-tasks' property.
1848 properties-set))))))
1859 ;; `:with-timestamps' only applies to isolated timestamps
1860 ;; objects, i.e. timestamp objects in a paragraph containing only
1861 ;; timestamps and whitespaces.
1869 options t))))
1878 \f
1879 ;;; The Transcoder
1880 ;;
1881 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1882 ;; `org-element-parse-buffer') and transcodes it into a specified
1883 ;; back-end output. It takes care of filtering out elements or
1884 ;; objects according to export options and organizing the output blank
1885 ;; lines and white space are preserved. The function memoizes its
1886 ;; results, so it is cheap to call it within transcoders.
1887 ;;
1888 ;; It is possible to modify locally the back-end used by
1889 ;; `org-export-data' or even use a temporary back-end by using
1890 ;; `org-export-data-with-backend'.
1891 ;;
1892 ;; `org-export-transcoder' is an accessor returning appropriate
1893 ;; translator function for a given element or object.
1896 "Return appropriate transcoder for BLOB.
1897 INFO is a plist containing export directives."
1899 ;; Return contents only for complete parse trees.
1905 "Convert DATA into current back-end format.
1907 DATA is a parse tree, an element or an object or a secondary
1908 string. INFO is a plist holding export options.
1910 Return a string."
1915 ;; Ignored element/object.
1917 ;; Plain text.
1923 info))
1924 ;; Secondary string.
1927 ;; Element/Object without contents or, as a special
1928 ;; case, headline with archive tag and archived trees
1929 ;; restricted to title only.
1937 ;; Export snippets never return a nil value so
1938 ;; that white spaces following them are never
1939 ;; ignored.
1941 ;; Element/Object with contents.
1954 ;; Elements directly containing
1955 ;; objects must have their indentation
1956 ;; normalized first.
1958 data
1959 ;; When normalizing contents of the
1960 ;; first paragraph in an item or
1961 ;; a footnote definition, ignore
1962 ;; first line's indentation: there is
1963 ;; none and it might be misleading.
1968 data)
1975 info))))))))
1976 ;; Final result will be memoized before being returned.
1978 data
1982 ;; Append the same white space between elements or objects
1983 ;; as in the original buffer, and call appropriate filters.
1994 info)))
1995 results)))
1999 "Convert DATA into BACKEND format.
2001 DATA is an element, an object, a secondary string or a string.
2002 BACKEND is a symbol. INFO is a plist used as a communication
2003 channel.
2005 Unlike to `org-export-with-backend', this function will
2006 recursively convert DATA using BACKEND translation table."
2009 data
2010 ;; Set-up a new communication channel with translations defined in
2011 ;; BACKEND as the translate table and a new hash table for
2012 ;; memoization.
2014 info
2017 ;; Size of the hash table is reduced since this function
2018 ;; will probably be used on small trees.
2022 "Expand a parsed element or object to its original state.
2024 BLOB is either an element or an object. CONTENTS is its
2025 contents, as a string or nil.
2027 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2028 keywords before output."
2033 blob contents))))
2036 \f
2037 ;;; The Filter System
2038 ;;
2039 ;; Filters allow end-users to tweak easily the transcoded output.
2040 ;; They are the functional counterpart of hooks, as every filter in
2041 ;; a set is applied to the return value of the previous one.
2042 ;;
2043 ;; Every set is back-end agnostic. Although, a filter is always
2044 ;; called, in addition to the string it applies to, with the back-end
2045 ;; used as argument, so it's easy for the end-user to add back-end
2046 ;; specific filters in the set. The communication channel, as
2047 ;; a plist, is required as the third argument.
2048 ;;
2049 ;; From the developer side, filters sets can be installed in the
2050 ;; process with the help of `org-export-define-backend', which
2051 ;; internally stores filters as an alist. Each association has a key
2052 ;; among the following symbols and a function or a list of functions
2053 ;; as value.
2054 ;;
2055 ;; - `:filter-options' applies to the property list containing export
2056 ;; options. Unlike to other filters, functions in this list accept
2057 ;; two arguments instead of three: the property list containing
2058 ;; export options and the back-end. Users can set its value through
2059 ;; `org-export-filter-options-functions' variable.
2060 ;;
2061 ;; - `:filter-parse-tree' applies directly to the complete parsed
2062 ;; tree. Users can set it through
2063 ;; `org-export-filter-parse-tree-functions' variable.
2064 ;;
2065 ;; - `:filter-body' applies to the body of the output, before template
2066 ;; translator chimes in. Users can set it through
2067 ;; `org-export-filter-body-functions' variable.
2068 ;;
2069 ;; - `:filter-final-output' applies to the final transcoded string.
2070 ;; Users can set it with `org-export-filter-final-output-functions'
2071 ;; variable.
2072 ;;
2073 ;; - `:filter-plain-text' applies to any string not recognized as Org
2074 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2075 ;; configure it.
2076 ;;
2077 ;; - `:filter-TYPE' applies on the string returned after an element or
2078 ;; object of type TYPE has been transcoded. A user can modify
2079 ;; `org-export-filter-TYPE-functions' to install these filters.
2080 ;;
2081 ;; All filters sets are applied with
2082 ;; `org-export-filter-apply-functions' function. Filters in a set are
2083 ;; applied in a LIFO fashion. It allows developers to be sure that
2084 ;; their filters will be applied first.
2085 ;;
2086 ;; Filters properties are installed in communication channel with
2087 ;; `org-export-install-filters' function.
2088 ;;
2089 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2090 ;; `org-export-before-parsing-hook') are run at the beginning of the
2091 ;; export process and just before parsing to allow for heavy structure
2092 ;; modifications.
2095 ;;;; Hooks
2098 "Hook run at the beginning of the export process.
2100 This is run before include keywords and macros are expanded and
2101 Babel code blocks executed, on a copy of the original buffer
2102 being exported. Visibility and narrowing are preserved. Point
2103 is at the beginning of the buffer.
2105 Every function in this hook will be called with one argument: the
2109 "Hook run before parsing an export buffer.
2111 This is run after include keywords and macros have been expanded
2112 and Babel code blocks executed, on a copy of the original buffer
2113 being exported. Visibility and narrowing are preserved. Point
2114 is at the beginning of the buffer.
2116 Every function in this hook will be called with one argument: the
2120 ;;;; Special Filters
2123 "List of functions applied to the export options.
2124 Each filter is called with two arguments: the export options, as
2125 a plist, and the back-end, as a symbol. It must return
2129 "List of functions applied to the parsed tree.
2130 Each filter is called with three arguments: the parse tree, as
2131 returned by `org-element-parse-buffer', the back-end, as
2132 a symbol, and the communication channel, as a plist. It must
2136 "List of functions applied to plain text.
2137 Each filter is called with three arguments: a string which
2138 contains no Org syntax, the back-end, as a symbol, and the
2139 communication channel, as a plist. It must return a string or
2143 "List of functions applied to transcoded body.
2144 Each filter is called with three arguments: a string which
2145 contains no Org syntax, the back-end, as a symbol, and the
2146 communication channel, as a plist. It must return a string or
2150 "List of functions applied to the transcoded string.
2151 Each filter is called with three arguments: the full transcoded
2152 string, the back-end, as a symbol, and the communication channel,
2153 as a plist. It must return a string that will be used as the
2157 ;;;; Elements Filters
2160 "List of functions applied to a transcoded babel-call.
2161 Each filter is called with three arguments: the transcoded data,
2162 as a string, the back-end, as a symbol, and the communication
2166 "List of functions applied to a transcoded center block.
2167 Each filter is called with three arguments: the transcoded data,
2168 as a string, the back-end, as a symbol, and the communication
2172 "List of functions applied to a transcoded clock.
2173 Each filter is called with three arguments: the transcoded data,
2174 as a string, the back-end, as a symbol, and the communication
2178 "List of functions applied to a transcoded diary-sexp.
2179 Each filter is called with three arguments: the transcoded data,
2180 as a string, the back-end, as a symbol, and the communication
2184 "List of functions applied to a transcoded drawer.
2185 Each filter is called with three arguments: the transcoded data,
2186 as a string, the back-end, as a symbol, and the communication
2190 "List of functions applied to a transcoded dynamic-block.
2191 Each filter is called with three arguments: the transcoded data,
2192 as a string, the back-end, as a symbol, and the communication
2196 "List of functions applied to a transcoded example-block.
2197 Each filter is called with three arguments: the transcoded data,
2198 as a string, the back-end, as a symbol, and the communication
2202 "List of functions applied to a transcoded export-block.
2203 Each filter is called with three arguments: the transcoded data,
2204 as a string, the back-end, as a symbol, and the communication
2208 "List of functions applied to a transcoded fixed-width.
2209 Each filter is called with three arguments: the transcoded data,
2210 as a string, the back-end, as a symbol, and the communication
2214 "List of functions applied to a transcoded footnote-definition.
2215 Each filter is called with three arguments: the transcoded data,
2216 as a string, the back-end, as a symbol, and the communication
2220 "List of functions applied to a transcoded headline.
2221 Each filter is called with three arguments: the transcoded data,
2222 as a string, the back-end, as a symbol, and the communication
2226 "List of functions applied to a transcoded horizontal-rule.
2227 Each filter is called with three arguments: the transcoded data,
2228 as a string, the back-end, as a symbol, and the communication
2232 "List of functions applied to a transcoded inlinetask.
2233 Each filter is called with three arguments: the transcoded data,
2234 as a string, the back-end, as a symbol, and the communication
2238 "List of functions applied to a transcoded item.
2239 Each filter is called with three arguments: the transcoded data,
2240 as a string, the back-end, as a symbol, and the communication
2244 "List of functions applied to a transcoded keyword.
2245 Each filter is called with three arguments: the transcoded data,
2246 as a string, the back-end, as a symbol, and the communication
2250 "List of functions applied to a transcoded latex-environment.
2251 Each filter is called with three arguments: the transcoded data,
2252 as a string, the back-end, as a symbol, and the communication
2256 "List of functions applied to a transcoded node-property.
2257 Each filter is called with three arguments: the transcoded data,
2258 as a string, the back-end, as a symbol, and the communication
2262 "List of functions applied to a transcoded paragraph.
2263 Each filter is called with three arguments: the transcoded data,
2264 as a string, the back-end, as a symbol, and the communication
2268 "List of functions applied to a transcoded plain-list.
2269 Each filter is called with three arguments: the transcoded data,
2270 as a string, the back-end, as a symbol, and the communication
2274 "List of functions applied to a transcoded planning.
2275 Each filter is called with three arguments: the transcoded data,
2276 as a string, the back-end, as a symbol, and the communication
2280 "List of functions applied to a transcoded property-drawer.
2281 Each filter is called with three arguments: the transcoded data,
2282 as a string, the back-end, as a symbol, and the communication
2286 "List of functions applied to a transcoded quote block.
2287 Each filter is called with three arguments: the transcoded quote
2288 data, as a string, the back-end, as a symbol, and the
2289 communication channel, as a plist. It must return a string or
2293 "List of functions applied to a transcoded section.
2294 Each filter is called with three arguments: the transcoded data,
2295 as a string, the back-end, as a symbol, and the communication
2299 "List of functions applied to a transcoded special block.
2300 Each filter is called with three arguments: the transcoded data,
2301 as a string, the back-end, as a symbol, and the communication
2305 "List of functions applied to a transcoded src-block.
2306 Each filter is called with three arguments: the transcoded data,
2307 as a string, the back-end, as a symbol, and the communication
2311 "List of functions applied to a transcoded table.
2312 Each filter is called with three arguments: the transcoded data,
2313 as a string, the back-end, as a symbol, and the communication
2317 "List of functions applied to a transcoded table-cell.
2318 Each filter is called with three arguments: the transcoded data,
2319 as a string, the back-end, as a symbol, and the communication
2323 "List of functions applied to a transcoded table-row.
2324 Each filter is called with three arguments: the transcoded data,
2325 as a string, the back-end, as a symbol, and the communication
2329 "List of functions applied to a transcoded verse block.
2330 Each filter is called with three arguments: the transcoded data,
2331 as a string, the back-end, as a symbol, and the communication
2335 ;;;; Objects Filters
2338 "List of functions applied to transcoded bold text.
2339 Each filter is called with three arguments: the transcoded data,
2340 as a string, the back-end, as a symbol, and the communication
2344 "List of functions applied to transcoded code text.
2345 Each filter is called with three arguments: the transcoded data,
2346 as a string, the back-end, as a symbol, and the communication
2350 "List of functions applied to a transcoded entity.
2351 Each filter is called with three arguments: the transcoded data,
2352 as a string, the back-end, as a symbol, and the communication
2356 "List of functions applied to a transcoded export-snippet.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 "List of functions applied to a transcoded footnote-reference.
2363 Each filter is called with three arguments: the transcoded data,
2364 as a string, the back-end, as a symbol, and the communication
2368 "List of functions applied to a transcoded inline-babel-call.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded inline-src-block.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 "List of functions applied to transcoded italic text.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to a transcoded latex-fragment.
2387 Each filter is called with three arguments: the transcoded data,
2388 as a string, the back-end, as a symbol, and the communication
2392 "List of functions applied to a transcoded line-break.
2393 Each filter is called with three arguments: the transcoded data,
2394 as a string, the back-end, as a symbol, and the communication
2398 "List of functions applied to a transcoded link.
2399 Each filter is called with three arguments: the transcoded data,
2400 as a string, the back-end, as a symbol, and the communication
2404 "List of functions applied to a transcoded radio-target.
2405 Each filter is called with three arguments: the transcoded data,
2406 as a string, the back-end, as a symbol, and the communication
2410 "List of functions applied to a transcoded statistics-cookie.
2411 Each filter is called with three arguments: the transcoded data,
2412 as a string, the back-end, as a symbol, and the communication
2416 "List of functions applied to transcoded strike-through text.
2417 Each filter is called with three arguments: the transcoded data,
2418 as a string, the back-end, as a symbol, and the communication
2422 "List of functions applied to a transcoded subscript.
2423 Each filter is called with three arguments: the transcoded data,
2424 as a string, the back-end, as a symbol, and the communication
2428 "List of functions applied to a transcoded superscript.
2429 Each filter is called with three arguments: the transcoded data,
2430 as a string, the back-end, as a symbol, and the communication
2434 "List of functions applied to a transcoded target.
2435 Each filter is called with three arguments: the transcoded data,
2436 as a string, the back-end, as a symbol, and the communication
2440 "List of functions applied to a transcoded timestamp.
2441 Each filter is called with three arguments: the transcoded data,
2442 as a string, the back-end, as a symbol, and the communication
2446 "List of functions applied to transcoded underline text.
2447 Each filter is called with three arguments: the transcoded data,
2448 as a string, the back-end, as a symbol, and the communication
2452 "List of functions applied to transcoded verbatim text.
2453 Each filter is called with three arguments: the transcoded data,
2454 as a string, the back-end, as a symbol, and the communication
2458 ;;;; Filters Tools
2459 ;;
2460 ;; Internal function `org-export-install-filters' installs filters
2461 ;; hard-coded in back-ends (developer filters) and filters from global
2462 ;; variables (user filters) in the communication channel.
2463 ;;
2464 ;; Internal function `org-export-filter-apply-functions' takes care
2465 ;; about applying each filter in order to a given data. It ignores
2466 ;; filters returning a nil value but stops whenever a filter returns
2467 ;; an empty string.
2470 "Call every function in FILTERS.
2472 Functions are called with arguments VALUE, current export
2473 back-end's name and INFO. A function returning a nil value will
2474 be skipped. If it returns the empty string, the process ends and
2475 VALUE is ignored.
2477 Call is done in a LIFO fashion, to be sure that developer
2478 specified filters, if any, are called first."
2489 "Install filters properties in communication channel.
2490 INFO is a plist containing the current communication channel.
2491 Return the updated communication channel."
2493 ;; Install user-defined filters with `org-export-filters-alist'
2494 ;; and filters already in INFO (through ext-plist mechanism).
2501 ;; Filters in INFO will be called
2502 ;; before those user provided.
2505 default-value)))))
2506 org-export-filters-alist)
2507 ;; Prepend back-end specific filters to that list.
2509 ;; Single values get consed, lists are appended.
2514 plist key
2518 ;; Return new communication channel.
2522 \f
2523 ;;; Core functions
2524 ;;
2525 ;; This is the room for the main function, `org-export-as', along with
2526 ;; its derivative, `org-export-string-as'.
2527 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2528 ;; function should be added to kill ring.
2529 ;;
2530 ;; Note that `org-export-as' doesn't really parse the current buffer,
2531 ;; but a copy of it (with the same buffer-local variables and
2532 ;; visibility), where macros and include keywords are expanded and
2533 ;; Babel blocks are executed, if appropriate.
2534 ;; `org-export-with-buffer-copy' macro prepares that copy.
2535 ;;
2536 ;; File inclusion is taken care of by
2537 ;; `org-export-expand-include-keyword' and
2538 ;; `org-export--prepare-file-contents'. Structure wise, including
2539 ;; a whole Org file in a buffer often makes little sense. For
2540 ;; example, if the file contains a headline and the include keyword
2541 ;; was within an item, the item should contain the headline. That's
2542 ;; why file inclusion should be done before any structure can be
2543 ;; associated to the file, that is before parsing.
2544 ;;
2545 ;; `org-export-insert-default-template' is a command to insert
2546 ;; a default template (or a back-end specific template) at point or in
2547 ;; current subtree.
2550 "Return a copy of the current buffer.
2551 The copy preserves Org buffer-local variables, visibility and
2552 narrowing."
2558 new-buf))
2561 "Apply BODY in a copy of the current buffer.
2562 The copy preserves local variables, visibility and contents of
2563 the original buffer. Point is at the beginning of the buffer
2564 when BODY is applied."
2573 ;; Kill copy without confirmation.
2579 "Generate a function duplicating BUFFER.
2581 The copy will preserve local variables, visibility, contents and
2582 narrowing of the original buffer. If a region was active in
2583 BUFFER, contents will be narrowed to that region instead.
2585 The resulting function can be evaluated at a later time, from
2586 another buffer, effectively cloning the original buffer there.
2588 The function assumes BUFFER's major mode is `org-mode'."
2592 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2593 ;; already in BUFFER.
2595 ;; Copy specific buffer local variables and variables set
2596 ;; through BIND keywords.
2598 vars)
2606 buffer-file-name
2607 buffer-file-coding-system))
2611 ;; Skip unreadable values, as they cannot be
2612 ;; sent to external process.
2616 vars))))))
2617 ;; Whole buffer contents.
2622 ;; Narrowing.
2626 ;; Current position of point.
2628 ;; Overlays with invisible property.
2638 ov-set))))
2640 ov-set)))))
2643 "Delete commented areas in the buffer.
2644 Commented areas are comments, comment blocks, commented trees and
2645 inlinetasks. Trailing blank lines after a comment or a comment
2646 block are preserved. Narrowing, if any, is ignored."
2667 "Prune non exportable elements from DATA.
2668 DATA is the parse tree to traverse. INFO is the plist holding
2669 export info. Also set `:ignore-list' in INFO to a list of
2670 objects which should be ignored during export, but not removed
2671 from tree."
2673 ignore
2674 ;; First find trees containing a select tag, if any.
2678 ;; Prune non-exportable elements and objects from tree.
2679 ;; As a special case, special rows and cells from tables
2680 ;; are stored in IGNORE, as they still need to be accessed
2681 ;; during export.
2690 ;; If headline is archived but tree below has to
2691 ;; be skipped, remove contents.
2693 ;; Move into secondary string, if any.
2698 ;; Move into recursive objects/elements.
2700 ;; If a select tag is active, also ignore the section before the
2701 ;; first headline, if any.
2706 ;; Prune tree and communication channel.
2710 ;; Priority is given to back-end specific options.
2712 org-export-options-alist))
2715 ;; Eventually set `:ignore-list'.
2719 "Change uninterpreted elements back into Org syntax.
2720 DATA is the parse tree. INFO is a plist containing export
2721 options. Each uninterpreted element or object is changed back
2722 into a string. Contents, if any, are not modified. The parse
2723 tree is modified by side effect."
2729 p
2732 info))))))
2735 "Change uninterpreted elements back into Org syntax.
2736 DATA is a parse tree or a secondary string. INFO is a plist
2737 containing export options. It is modified by side effect and
2738 returned by the function."
2741 subscript superscript underline)
2745 ;; ... entities...
2752 ?\s)))))
2753 ;; ... emphasis...
2765 marker
2769 ?\s)))))))
2770 ;; ... LaTeX environments and fragments...
2774 ;; ... sub/superscripts...
2783 "_"
2792 ?\s)))))))))))
2794 ;; Splice NEW at BLOB location in parse tree.
2797 info)
2798 ;; Return modified parse tree.
2799 data)
2801 ;;;###autoload
2804 "Transcode current Org buffer into BACKEND code.
2806 BACKEND is either an export back-end, as returned by, e.g.,
2807 `org-export-create-backend', or a symbol referring to
2808 a registered back-end.
2810 If narrowing is active in the current buffer, only transcode its
2811 narrowed part.
2813 If a region is active, transcode that region.
2815 When optional argument SUBTREEP is non-nil, transcode the
2816 sub-tree at point, extracting information from the headline
2817 properties first.
2819 When optional argument VISIBLE-ONLY is non-nil, don't export
2820 contents of hidden elements.
2822 When optional argument BODY-ONLY is non-nil, only return body
2823 code, without surrounding template.
2825 Optional argument EXT-PLIST, when provided, is a property list
2826 with external parameters overriding Org default settings, but
2827 still inferior to file-local settings.
2829 Return code as a string."
2834 ;; Narrow buffer to an appropriate region or subtree for
2835 ;; parsing. If parsing subtree, be sure to remove main headline
2836 ;; too.
2844 ;; Initialize communication channel with original buffer
2845 ;; attributes, unavailable in its copy.
2858 org-export-options-alist))))
2859 tree)
2860 ;; Update communication channel and get parse tree. Buffer
2861 ;; isn't parsed directly. Instead, a temporary copy is
2862 ;; created, where include keywords, macros are expanded and
2863 ;; code blocks are evaluated.
2865 ;; Run first hook with current back-end's name as argument.
2870 ;; Update macro templates since #+INCLUDE keywords might have
2871 ;; added some new ones.
2875 ;; Update radio targets since keyword inclusion might have
2876 ;; added some more.
2878 ;; Run last hook with current back-end's name as argument.
2883 ;; Update communication channel with environment. Also
2884 ;; install user's and developer's filters.
2889 ;; Call options filters and update export options. We do not
2890 ;; use `org-export-filter-apply-functions' here since the
2891 ;; arity of such filters is different.
2896 ;; Expand export-specific set of macros: {{{author}}},
2897 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2898 ;; be done once regular macros have been expanded, since
2899 ;; parsed keywords may contain one of them.
2912 value)
2913 value)))
2917 'finalize
2918 parsed-keywords)
2919 ;; Parse buffer.
2921 ;; Prune tree from non-exported elements and transform
2922 ;; uninterpreted elements or objects in both parse tree and
2923 ;; communication channel.
2926 ;; Parse buffer, handle uninterpreted elements or objects,
2927 ;; then call parse-tree filters.
2931 ;; Now tree is complete, compute its properties and add them
2932 ;; to communication channel.
2936 ;; Eventually transcode TREE. Wrap the resulting string into
2937 ;; a template.
2946 info))
2949 ;; Remove all text properties since they cannot be
2950 ;; retrieved from an external process. Finally call
2951 ;; final-output filter and return result.
2957 info))))))))
2959 ;;;###autoload
2961 "Transcode STRING into BACKEND code.
2963 BACKEND is either an export back-end, as returned by, e.g.,
2964 `org-export-create-backend', or a symbol referring to
2965 a registered back-end.
2967 When optional argument BODY-ONLY is non-nil, only return body
2968 code, without preamble nor postamble.
2970 Optional argument EXT-PLIST, when provided, is a property list
2971 with external parameters overriding Org default settings, but
2972 still inferior to file-local settings.
2974 Return code as a string."
2980 ;;;###autoload
2982 "Replace the active region by its export to BACKEND.
2983 BACKEND is either an export back-end, as returned by, e.g.,
2984 `org-export-create-backend', or a symbol referring to
2985 a registered back-end."
2995 ;;;###autoload
2997 "Insert all export keywords with default values at beginning of line.
2999 BACKEND is a symbol referring to the name of a registered export
3000 back-end, for which specific export options should be added to
3001 the template, or `default' for default template. When it is nil,
3002 the user will be prompted for a category.
3004 If SUBTREEP is non-nil, export configuration will be set up
3005 locally for the subtree through node properties."
3015 "Options category: "
3019 org-export--registered-backends))
3020 nil t))))
3021 options keywords)
3022 ;; Populate OPTIONS and KEYWORDS.
3039 ;; Move to an appropriate location in order to insert options.
3041 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3059 ;; Then the rest of keywords, in the order specified in either
3060 ;; `org-export-options-alist' or respective export back-ends.
3081 "Expand every include keyword in buffer.
3082 Optional argument INCLUDED is a list of included file names along
3083 with their line restriction, when appropriate. It is used to
3084 avoid infinite recursion. Optional argument DIR is the current
3085 working directory. It is used to properly resolve relative
3086 paths. Optional argument FOOTNOTES is a hash-table used for
3087 storing and resolving footnotes. It is created automatically."
3093 ;; If :minlevel is not set the text-property
3094 ;; `:org-include-induced-level' will be used to determine the
3095 ;; relative level when expanding INCLUDE.
3096 ;; Only affects included Org documents.
3100 :org-include-induced-level
3102 ;; Expand INCLUDE keywords.
3108 ;; Extract arguments from keyword's value.
3111 location
3123 matched)
3124 dir)))
3133 value)
3140 ;; Minimal level of included file defaults to the child
3141 ;; level of the current headline, if any, or one. It
3142 ;; only applies is the file is meant to be included as
3143 ;; an Org one.
3154 ;; Remove keyword.
3160 ;; Check if files has already been parsed. Look after
3161 ;; inclusion lines too, as different parts of the same file
3162 ;; can be included too.
3177 ind-str block arg-str contents ind-str block))))
3184 ind-str block contents ind-str block))))
3192 file location only-contents lines)
3193 lines)))
3196 file lines ind minlevel
3199 footnotes)))
3203 footnotes)
3205 ;; Expand footnotes after all files have been
3206 ;; included. Footnotes are stored at end of buffer.
3211 footnotes)))))))))))
3214 "Resolve absolute lines for an included file with file-link.
3216 FILE is string file-name of the file to include. LOCATION is a
3217 string name within FILE to be included (located via
3218 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3219 contents of the named element will be included, as determined
3220 Org-Element. If LINES is non-nil only those lines are included.
3222 Return a string of lines to be included in the format expected by
3223 `org-export--prepare-file-contents'."
3229 ;; Enforce consistent search.
3242 ;; Skip planning line and property-drawer.
3268 start-line
3270 (+ start-line
3273 counter))))))))
3276 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3278 REF-BEGIN corresponds to the property `:begin' of objects of type
3279 footnote-definition and footnote-reference.
3281 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3282 \[N] where N is one or more numbers.
3284 Return the new label."
3294 "Prepare contents of FILE for inclusion and return it as a string.
3296 When optional argument LINES is a string specifying a range of
3297 lines, include only those lines.
3299 Optional argument IND, when non-nil, is an integer specifying the
3300 global indentation of returned contents. Since its purpose is to
3301 allow an included file to stay in the same environment it was
3302 created \(i.e. a list item), it doesn't apply past the first
3303 headline encountered.
3305 Optional argument MINLEVEL, when non-nil, is an integer
3306 specifying the level that any top-level headline in the included
3307 file should have.
3308 Optional argument ID is an integer that will be inserted before
3309 each footnote definition and reference if FILE is an Org file.
3310 This is useful to avoid conflicts when more than one Org file
3311 with footnotes is included in a document.
3313 Optional argument FOOTNOTES is a hash-table to store footnotes in
3314 the included document.
3315 "
3331 ;; Remove blank lines at beginning and end of contents. The logic
3332 ;; behind that removal is that blank lines around include keyword
3333 ;; override blank lines in included file.
3342 ;; If IND is set, preserve indentation of include keyword until
3343 ;; the first headline encountered.
3350 ;; Do not move footnote definitions out of column 0.
3356 ;; When MINLEVEL is specified, compute minimal level for headlines
3357 ;; in the file (CUR-MIN), and remove stars to each headline so
3358 ;; that headlines with minimal level have a level of MINLEVEL.
3369 ;; Only change stars, don't bother moving whole
3370 ;; sections.
3374 ;; Append ID to all footnote references and definitions, so they
3375 ;; become file specific and cannot collide with footnotes in other
3376 ;; included files. Further, collect relevant footnotes outside of
3377 ;; LINES.
3387 ;; Update the footnote-reference at point and collect
3388 ;; the new label, which is only used for footnotes
3389 ;; outsides LINES.
3391 ;; If label is akin to [1] convert it to [fn:ID-1].
3392 ;; Otherwise add "ID-" after "fn:".
3402 ;; Store since footnote-definition is outside of LINES.
3405 footnotes)
3406 ;; Update label of definition since it is included directly.
3413 "Execute every Babel code in the visible part of current buffer."
3414 ;; Get a pristine copy of current buffer so Babel references can be
3415 ;; properly resolved.
3421 "Return a non-nil value when output should be added to the kill ring.
3422 See also `org-export-copy-to-kill-ring'."
3428 \f
3429 ;;; Tools For Back-Ends
3430 ;;
3431 ;; A whole set of tools is available to help build new exporters. Any
3432 ;; function general enough to have its use across many back-ends
3433 ;; should be added here.
3435 ;;;; For Affiliated Keywords
3436 ;;
3437 ;; `org-export-read-attribute' reads a property from a given element
3438 ;; as a plist. It can be used to normalize affiliated keywords'
3439 ;; syntax.
3440 ;;
3441 ;; Since captions can span over multiple lines and accept dual values,
3442 ;; their internal representation is a bit tricky. Therefore,
3443 ;; `org-export-get-caption' transparently returns a given element's
3444 ;; caption as a secondary string.
3447 "Turn ATTRIBUTE property from ELEMENT into a plist.
3449 When optional argument PROPERTY is non-nil, return the value of
3450 that property within attributes.
3454 properties.
3456 All values will become strings except the empty string and
3459 will become the empty string."
3473 s)
3478 ;; Ignore any string before first property with `cdr'.
3483 "Return caption from ELEMENT as a secondary string.
3485 When optional argument SHORTP is non-nil, return short caption,
3486 as a secondary string, instead.
3488 Caption lines are separated by a white space."
3496 ;;;; For Derived Back-ends
3497 ;;
3498 ;; `org-export-with-backend' is a function allowing to locally use
3499 ;; another back-end to transcode some object or element. In a derived
3500 ;; back-end, it may be used as a fall-back function once all specific
3501 ;; cases have been treated.
3504 "Call a transcoder from BACKEND on DATA.
3505 BACKEND is an export back-end, as returned by, e.g.,
3506 `org-export-create-backend', or a symbol referring to
3507 a registered back-end. DATA is an Org element, object, secondary
3508 string or string. CONTENTS, when non-nil, is the transcoded
3509 contents of DATA element, as a string. INFO, when non-nil, is
3510 the communication channel used for export, as a plist."
3520 transcoder data contents
3523 :translate-alist all-transcoders
3527 ;;;; For Export Snippets
3528 ;;
3529 ;; Every export snippet is transmitted to the back-end. Though, the
3530 ;; latter will only retain one type of export-snippet, ignoring
3531 ;; others, based on the former's target back-end. The function
3532 ;; `org-export-snippet-backend' returns that back-end for a given
3533 ;; export-snippet.
3536 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3537 Translation, with `org-export-snippet-translation-alist', is
3538 applied."
3542 back-end))))
3545 ;;;; For Footnotes
3546 ;;
3547 ;; `org-export-collect-footnote-definitions' is a tool to list
3548 ;; actually used footnotes definitions in the whole parse tree, or in
3549 ;; a headline, in order to add footnote listings throughout the
3550 ;; transcoded data.
3551 ;;
3552 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3553 ;; back-ends, when they need to attach the footnote definition only to
3554 ;; the first occurrence of the corresponding label.
3555 ;;
3556 ;; `org-export-get-footnote-definition' and
3557 ;; `org-export-get-footnote-number' provide easier access to
3558 ;; additional information relative to a footnote reference.
3561 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3562 INFO is the plist used as a communication channel. If no such
3563 definition can be found, raise an error."
3572 "Apply FUNCTION on every footnote reference in DATA.
3573 INFO is a plist containing export state. By default, as soon as
3574 a new footnote reference is encountered, FUNCTION is called onto
3575 its definition. However, if BODY-FIRST is non-nil, this step is
3576 delayed until the end of the process."
3582 ;; Search footnote references through DATA, filling
3583 ;; SEEN-REFS along the way. When DELAYP is non-nil, store
3584 ;; footnote definitions so they can be entered later.
3591 ;; Search for subsequent references in footnote
3592 ;; definition so numbering follows reading logic,
3593 ;; unless DELAYP in non-nil.
3597 definitions))
3598 ;; Do not force entering inline definitions,
3599 ;; since `org-element-map' already traverses them
3600 ;; at the right time.
3604 nil))))))
3605 info nil
3606 ;; Don't enter footnote definitions since it will happen
3607 ;; when their first reference is found. Moreover, if
3608 ;; DELAYP is non-nil, make sure we postpone entering
3609 ;; definitions of inline references.
3616 "Return an alist between footnote numbers, labels and definitions.
3618 INFO is the current export state, as a plist.
3620 Definitions are collected throughout the whole parse tree, or
3621 DATA when non-nil.
3623 Sorting is done by order of references. As soon as a new
3624 reference is encountered, other references are searched within
3625 its definition. However, if BODY-FIRST is non-nil, this step is
3626 delayed after the whole tree is checked. This alters results
3627 when references are found in footnote definitions.
3629 Definitions either appear as Org data or as a secondary string
3630 for inlined footnotes. Unreferenced definitions are ignored."
3634 ;; Collect footnote number, label and definition.
3645 "Non-nil when a footnote reference is the first one for its label.
3647 FOOTNOTE-REFERENCE is the footnote reference being considered.
3648 INFO is a plist containing current export state.
3650 Search is done throughout the whole parse tree, or DATA when
3651 non-nil.
3653 By default, as soon as a new footnote reference is encountered,
3654 other references are searched within its definition. However, if
3655 BODY-FIRST is non-nil, this step is delayed after the whole tree
3656 is checked. This alters results when references are found in
3657 footnote definitions."
3659 ;; Anonymous footnotes are always a first reference.
3670 "Return number associated to a footnote.
3672 FOOTNOTE is either a footnote reference or a footnote definition.
3673 INFO is the plist containing export state.
3675 Number is unique throughout the whole parse tree, or DATA, when
3676 non-nil.
3678 By default, as soon as a new footnote reference is encountered,
3679 counting process moves into its definition. However, if
3680 BODY-FIRST is non-nil, this step is delayed until the end of the
3681 process, leading to a different order when footnotes are nested."
3690 ;; Anonymous footnote match: return number.
3692 ;; Labels match: return number.
3694 ;; Otherwise store label and increase counter if label
3695 ;; wasn't encountered yet.
3701 ;;;; For Headlines
3702 ;;
3703 ;; `org-export-get-relative-level' is a shortcut to get headline
3704 ;; level, relatively to the lower headline level in the parsed tree.
3705 ;;
3706 ;; `org-export-get-headline-number' returns the section number of an
3707 ;; headline, while `org-export-number-to-roman' allows to convert it
3708 ;; to roman numbers. With an optional argument,
3709 ;; `org-export-get-headline-number' returns a number to unnumbered
3710 ;; headlines (used for internal id).
3711 ;;
3712 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3713 ;; `org-export-last-sibling-p' are three useful predicates when it
3714 ;; comes to fulfill the `:headline-levels' property.
3715 ;;
3716 ;; `org-export-get-tags', `org-export-get-category' and
3717 ;; `org-export-get-node-property' extract useful information from an
3718 ;; headline or a parent headline. They all handle inheritance.
3719 ;;
3720 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3721 ;; as a secondary string, suitable for table of contents. It falls
3722 ;; back onto default title.
3725 "Return HEADLINE relative level within current parsed tree.
3726 INFO is a plist holding contextual information."
3731 "Non-nil when HEADLINE is considered as low level.
3733 INFO is a plist used as a communication channel.
3735 A low level headlines has a relative level greater than
3736 `:headline-levels' property value.
3738 Return value is the difference between HEADLINE relative level
3739 and the last level being considered as high enough, or nil."
3746 "Return numbered HEADLINE numbering as a list of numbers.
3747 INFO is a plist holding contextual information."
3752 "Return a non-nil value if HEADLINE element should be numbered.
3753 INFO is a plist used as a communication channel."
3762 "Convert integer N into a roman numeral."
3775 res)))
3778 "Return list of tags associated to ELEMENT.
3780 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3781 is a plist used as a communication channel.
3783 Select tags (see `org-export-select-tags') and exclude tags (see
3784 `org-export-exclude-tags') are removed from the list.
3786 When non-nil, optional argument TAGS should be a list of strings.
3787 Any tag belonging to this list will also be removed.
3789 When optional argument INHERITED is non-nil, tags can also be
3790 inherited from parent headlines and FILETAGS keywords."
3796 ;; Build complete list of inherited tags.
3803 ;; Add FILETAGS keywords and return results.
3807 "Return node PROPERTY value for BLOB.
3809 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3810 element or object.
3812 If optional argument INHERITED is non-nil, the value can be
3813 inherited from a parent headline.
3815 Return value is a string or nil."
3827 "Return category for element or object BLOB.
3829 INFO is a plist used as a communication channel.
3831 CATEGORY is automatically inherited from a parent headline, from
3832 #+CATEGORY: keyword or created out of original file name. If all
3845 "Return alternative title for HEADLINE, as a secondary string.
3846 INFO is a plist used as a communication channel. If no optional
3847 title is defined, fall-back to the regular title."
3854 "Non-nil when BLOB is the first sibling in its parent.
3855 BLOB is an element or an object. If BLOB is a headline, non-nil
3856 means it is the first sibling in the sub-tree. INFO is a plist
3857 used as a communication channel."
3862 "Non-nil when BLOB is the last sibling in its parent.
3863 BLOB is an element or an object. INFO is a plist used as
3864 a communication channel."
3868 ;;;; For Keywords
3869 ;;
3870 ;; `org-export-get-date' returns a date appropriate for the document
3871 ;; to about to be exported. In particular, it takes care of
3872 ;; `org-export-date-timestamp-format'.
3875 "Return date value for the current document.
3877 INFO is a plist used as a communication channel. FMT, when
3878 non-nil, is a time format string that will be applied on the date
3879 if it consists in a single timestamp object. It defaults to
3880 `org-export-date-timestamp-format' when nil.
3882 A proper date can be a secondary string, a string or nil. It is
3883 meant to be translated with `org-export-data' or alike."
3894 ;;;; For Links
3895 ;;
3896 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3897 ;; with `org-add-link-type', which see.
3898 ;;
3899 ;; `org-export-get-coderef-format' returns an appropriate format
3900 ;; string for coderefs.
3901 ;;
3902 ;; `org-export-inline-image-p' returns a non-nil value when the link
3903 ;; provided should be considered as an inline image.
3904 ;;
3905 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3906 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3907 ;; returns an appropriate unique identifier when found, or nil.
3908 ;;
3909 ;; `org-export-resolve-id-link' returns the first headline with
3910 ;; specified id or custom-id in parse tree, the path to the external
3911 ;; file with the id or nil when neither was found.
3912 ;;
3913 ;; `org-export-resolve-coderef' associates a reference to a line
3914 ;; number in the element it belongs, or returns the reference itself
3915 ;; when the element isn't numbered.
3918 "Try exporting LINK with a dedicated function.
3920 DESC is its description, as a string, or nil. BACKEND is the
3921 back-end used for export, as a symbol.
3923 Return output as a string, or nil if no protocol handles LINK.
3925 A custom protocol has precedence over regular back-end export.
3926 The function ignores links with an implicit type (e.g.,
3935 desc
3936 backend))))))
3939 "Return format string for code reference link.
3940 PATH is the link path. DESC is its description."
3948 "Non-nil if LINK object points to an inline image.
3950 Optional argument is a set of RULES defining inline images. It
3951 is an alist where associations have the following shape:
3953 \(TYPE . REGEXP)
3955 Applying a rule means apply REGEXP against LINK's path when its
3956 type is TYPE. The function will return a non-nil value if any of
3957 the provided rules is non-nil. The default rule is
3958 `org-export-default-inline-image-rule'.
3960 This only applies to links without a description."
3971 "Resolve a code reference REF.
3973 INFO is a plist used as a communication channel.
3975 Return associated line number in source code, or REF itself,
3976 depending on src-block or example element's switches. Throw an
3977 error if no block contains REF."
3984 org-coderef-label-format)))
3988 ;; Element containing REF is found. Resolve it to
3989 ;; either a label or a line number, as needed.
4000 "Return LINK destination.
4002 INFO is a plist holding contextual information.
4004 Return value can be an object, an element, or nil:
4006 - If LINK path matches a target object (i.e. <<path>>) return it.
4008 - If LINK path exactly matches the name affiliated keyword
4009 \(i.e. #+NAME: path) of an element, return that element.
4011 - If LINK path exactly matches any headline name, return that
4012 element. If more than one headline share that name, priority
4013 will be given to the one with the closest common ancestor, if
4014 any, or the first one in the parse tree otherwise.
4016 - Otherwise, throw an error.
4019 significant."
4022 ;; Split PATH at white spaces so matches are space
4023 ;; insensitive.
4026 ;; Cache for destinations that are not position dependent.
4034 ;; Destination is not position dependent: use cached value.
4036 ;; First try to find a matching "<<path>>" unless user specified
4037 ;; he was looking for a headline (path starts with a "*"
4038 ;; character).
4044 path)
4045 blob))
4048 ;; Then try to find an element with a matching "#+NAME: path"
4049 ;; affiliated keyword.
4052 org-element-all-elements
4057 el)))
4060 ;; Last case: link either points to a headline or to nothingness.
4061 ;; Try to find the source, with priority given to headlines with
4062 ;; the closest common ancestor. If such candidate is found,
4063 ;; return it, otherwise signal an error.
4067 ;; Return first headline whose `:raw-value' property is
4068 ;; NAME in parse tree DATA, or nil. Statistics cookies
4069 ;; are ignored.
4077 name)
4078 headline))
4080 ;; Search among headlines sharing an ancestor with link, from
4081 ;; closest to farthest.
4089 ;; No destination found: error.
4093 "Return headline referenced as LINK destination.
4095 INFO is a plist used as a communication channel.
4097 Return value can be the headline element matched in current parse
4101 ;; First check if id is within the current parse tree.
4106 headline))
4108 ;; Otherwise, look for external files.
4113 "Return radio-target object referenced as LINK destination.
4115 INFO is a plist used as a communication channel.
4117 Return value can be a radio-target object or nil. Assume LINK
4126 nil nil path nil nil t)
4127 t)
4128 radio))
4132 ;;;; For References
4133 ;;
4134 ;; `org-export-get-reference' associate a unique reference for any
4135 ;; object or element.
4136 ;;
4137 ;; `org-export-get-ordinal' associates a sequence number to any object
4138 ;; or element.
4141 "Return a unique reference for DATUM, as a string.
4142 DATUM is either an element or an object. INFO is the current
4143 export state, as a plist. Returned reference consists of
4144 alphanumeric characters only."
4149 h))))
4166 cache))))
4169 "Return ordinal number of an element or object.
4171 ELEMENT is the element or object considered. INFO is the plist
4172 used as a communication channel.
4174 Optional argument TYPES, when non-nil, is a list of element or
4175 object types, as symbols, that should also be counted in.
4176 Otherwise, only provided element's type is considered.
4178 Optional argument PREDICATE is a function returning a non-nil
4179 value if the current element or object should be counted in. It
4180 accepts two arguments: the element or object being considered and
4181 the plist used as a communication channel. This allows to count
4182 only a certain type of objects (i.e. inline images).
4184 Return value is a list of numbers if ELEMENT is a headline or an
4185 item. It is nil for keywords. It represents the footnote number
4186 for footnote definitions and footnote references. If ELEMENT is
4187 a target, return the same value as if ELEMENT was the closest
4188 table, item or headline containing the target. In any other
4189 case, return the sequence number of ELEMENT among elements or
4190 objects of the same type."
4191 ;; Ordinal of a target object refer to the ordinal of the closest
4192 ;; table, item, or headline containing the object.
4196 element
4199 ;; Special case 1: A headline returns its number as a list.
4201 ;; Special case 2: An item returns its number as a list.
4205 struct
4212 ;; Increment counter until ELEMENT is found again.
4223 ;;;; For Src-Blocks
4224 ;;
4225 ;; `org-export-get-loc' counts number of code lines accumulated in
4226 ;; src-block or example-block elements with a "+n" switch until
4227 ;; a given element, excluded. Note: "-n" switches reset that count.
4228 ;;
4229 ;; `org-export-unravel-code' extracts source code (along with a code
4230 ;; references alist) from an `element-block' or `src-block' type
4231 ;; element.
4232 ;;
4233 ;; `org-export-format-code' applies a formatting function to each line
4234 ;; of code, providing relative line number and code reference when
4235 ;; appropriate. Since it doesn't access the original element from
4236 ;; which the source code is coming, it expects from the code calling
4237 ;; it to know if lines should be numbered and if code references
4238 ;; should appear.
4239 ;;
4240 ;; Eventually, `org-export-format-code-default' is a higher-level
4241 ;; function (it makes use of the two previous functions) which handles
4242 ;; line numbering and code references inclusion, and returns source
4243 ;; code in a format suitable for plain text or verbatim output.
4246 "Return accumulated lines of code up to ELEMENT.
4248 INFO is the plist used as a communication channel.
4250 ELEMENT is excluded from count."
4256 ;; ELEMENT is reached: Quit the loop.
4258 ;; Only count lines from src-block and example-block elements
4259 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4263 ;; Accumulate locs or reset them.
4267 ;; Return nil to stay in the loop.
4268 nil)))
4270 ;; Return value.
4271 loc))
4274 "Clean source code and extract references out of it.
4276 ELEMENT has either a `src-block' an `example-block' type.
4278 Return a cons cell whose CAR is the source code, cleaned from any
4279 reference, protective commas and spurious indentation, and CDR is
4280 an alist between relative line number (integer) and name of code
4281 reference on that line (string)."
4284 ;; Get code and clean it. Remove blank lines at its
4285 ;; beginning and end.
4292 value
4294 ;; Get format used for references.
4297 org-coderef-label-format)))
4298 ;; Build a regexp matching a loc with a reference.
4303 ;; Return value.
4305 ;; Code with references removed.
4311 ;; Ref line: remove ref, and signal its position in REFS.
4315 ;; Reference alist.
4316 refs)))
4319 "Format CODE by applying FUN line-wise and return it.
4321 CODE is a string representing the code to format. FUN is
4322 a function. It must accept three arguments: a line of
4323 code (string), the current line number (integer) or nil and the
4324 reference associated to the current line (string) or nil.
4326 Optional argument NUM-LINES can be an integer representing the
4327 number of code lines accumulated until the current code. Line
4328 numbers passed to FUN will take it into account. If it is nil,
4329 FUN's second argument will always be nil. This number can be
4330 obtained with `org-export-get-loc' function.
4332 Optional argument REF-ALIST can be an alist between relative line
4333 number (i.e. ignoring NUM-LINES) and the name of the code
4334 reference on it. If it is nil, FUN's third argument will always
4335 be nil. It can be obtained through the use of
4336 `org-export-unravel-code' function."
4348 "Return source code from ELEMENT, formatted in a standard way.
4350 ELEMENT is either a `src-block' or `example-block' element. INFO
4351 is a plist used as a communication channel.
4353 This function takes care of line numbering and code references
4354 inclusion. Line numbers, when applicable, appear at the
4355 beginning of the line, separated from the code by two white
4356 spaces. Code references, on the other hand, appear flushed to
4357 the right, separated by six white spaces from the widest line of
4358 code."
4359 ;; Extract code and references.
4366 ;; Handle line numbering.
4375 ;; Prepare references display, if required. Any reference
4376 ;; should start six columns after the widest line of code,
4377 ;; wrapped with parenthesis.
4382 code
4386 number-str
4387 loc
4393 num-start refs)))))
4396 ;;;; For Tables
4397 ;;
4398 ;; `org-export-table-has-special-column-p' and and
4399 ;; `org-export-table-row-is-special-p' are predicates used to look for
4400 ;; meta-information about the table structure.
4401 ;;
4402 ;; `org-table-has-header-p' tells when the rows before the first rule
4403 ;; should be considered as table's header.
4404 ;;
4405 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4406 ;; and `org-export-table-cell-borders' extract information from
4407 ;; a table-cell element.
4408 ;;
4409 ;; `org-export-table-dimensions' gives the number on rows and columns
4410 ;; in the table, ignoring horizontal rules and special columns.
4411 ;; `org-export-table-cell-address', given a table-cell object, returns
4412 ;; the absolute address of a cell. On the other hand,
4413 ;; `org-export-get-table-cell-at' does the contrary.
4414 ;;
4415 ;; `org-export-table-cell-starts-colgroup-p',
4416 ;; `org-export-table-cell-ends-colgroup-p',
4417 ;; `org-export-table-row-starts-rowgroup-p',
4418 ;; `org-export-table-row-ends-rowgroup-p',
4419 ;; `org-export-table-row-starts-header-p',
4420 ;; `org-export-table-row-ends-header-p' and
4421 ;; `org-export-table-row-in-header-p' indicate position of current row
4422 ;; or cell within the table.
4425 "Non-nil when TABLE has a special column.
4426 All special columns will be ignored during export."
4427 ;; The table has a special column when every first cell of every row
4428 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4429 ;; "*" "_" and "^". Though, do not consider a first row containing
4430 ;; only empty cells as special.
4446 "Non-nil when TABLE has a header.
4448 INFO is a plist used as a communication channel.
4450 A table has a header when it contains at least two row groups."
4459 table
4470 cache)))))
4473 "Non-nil if TABLE-ROW is considered special.
4475 INFO is a plist used as the communication channel.
4477 All special rows will be ignored during export."
4481 ;; A row is special either when...
4483 ;; ... it starts with a field only containing "/",
4485 ;; ... the table contains a special column and the row start
4486 ;; with a marking character among, "^", "_", "$" or "!",
4490 ;; ... it contains only alignment cookies and empty cells.
4496 ;; Since VALUE is a secondary string, the following
4497 ;; checks avoid expanding it with `org-export-data'.
4509 "Return TABLE-ROW's group number, as an integer.
4511 INFO is a plist used as the communication channel.
4513 Return value is the group number, as an integer, or nil for
4514 special rows and rows separators. First group is also table's
4515 header."
4533 "Return TABLE-CELL contents width.
4535 INFO is a plist used as the communication channel.
4537 Return value is the width given by the last width cookie in the
4538 same column as TABLE-CELL, or nil."
4557 ;; In a special row, try to find a width cookie at COLUMN.
4561 ;; The following checks avoid expanding unnecessarily
4562 ;; the cell with `org-export-data'.
4572 "Return TABLE-CELL contents alignment.
4574 INFO is a plist used as the communication channel.
4576 Return alignment as specified by the last alignment cookie in the
4577 same column as TABLE-CELL. If no such cookie is found, a default
4578 alignment value will be deduced from fraction of numbers in the
4579 column (see `org-table-number-fraction' for more information).
4580 Possible values are `left', `right' and `center'."
4581 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4598 cookie-align
4599 previous-cell-number-p)
4602 ;; In a special row, try to find an alignment cookie at
4603 ;; COLUMN.
4607 ;; Since VALUE is a secondary string, the following
4608 ;; checks avoid useless expansion through
4609 ;; `org-export-data'.
4617 ;; Ignore table rules.
4619 ;; In a standard row, check if cell's contents are
4620 ;; expressing some kind of number. Increase NUMBER-CELLS
4621 ;; accordingly. Though, don't bother if an alignment
4622 ;; cookie has already defined cell's alignment.
4627 info)))
4629 ;; Treat an empty cell as a number if it follows
4630 ;; a number.
4636 ;; Return value. Alignment specified by cookies has
4637 ;; precedence over alignment deduced from cell's contents.
4639 column
4644 org-table-number-fraction)
4649 "Return TABLE-CELL borders.
4651 INFO is a plist used as a communication channel.
4653 Return value is a list of symbols, or nil. Possible values are:
4654 `top', `bottom', `above', `below', `left' and `right'. Note:
4655 `top' (resp. `bottom') only happen for a cell in the first
4656 row (resp. last row) of the table, ignoring table rules, if any.
4658 Returned borders ignore special rows."
4661 borders)
4662 ;; Top/above border? TABLE-CELL has a border above when a rule
4663 ;; used to demarcate row groups can be found above. Hence,
4664 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4665 ;; another regular row has to be found above that rule.
4674 ;; Look at every row before the current one.
4676 ;; No rule above, or rule found starts the table (ignoring any
4677 ;; special row): TABLE-CELL is at the top of the table.
4680 ;; Bottom/below border? TABLE-CELL has a border below when next
4681 ;; non-regular row below is a rule.
4690 ;; Look at every row after the current one.
4692 ;; No rule below, or rule found ends the table (modulo some
4693 ;; special row): TABLE-CELL is at the bottom of the table.
4696 ;; Right/left borders? They can only be specified by column
4697 ;; groups. Column groups are defined in a row starting with "/".
4698 ;; Also a column groups row only contains "<", "<>", ">" or blank
4699 ;; cells.
4716 ;; There's a left border when previous cell, if
4717 ;; any, ends a group, or current one starts one.
4723 ;; There's a right border when next cell, if any,
4724 ;; starts a group, or current one ends one.
4731 ;; Table rows are read in reverse order so last column groups
4732 ;; row has precedence over any previous one.
4734 ;; Return value.
4735 borders))
4738 "Non-nil when TABLE-CELL is at the beginning of a column group.
4739 INFO is a plist used as a communication channel."
4740 ;; A cell starts a column group either when it is at the beginning
4741 ;; of a row (or after the special column, if any) or when it has
4742 ;; a left border.
4745 table-cell)
4749 "Non-nil when TABLE-CELL is at the end of a column group.
4750 INFO is a plist used as a communication channel."
4751 ;; A cell ends a column group either when it is at the end of a row
4752 ;; or when it has a right border.
4755 table-cell)
4759 "Non-nil when TABLE-ROW is at the beginning of a row group.
4760 INFO is a plist used as a communication channel."
4768 "Non-nil when TABLE-ROW is at the end of a row group.
4769 INFO is a plist used as a communication channel."
4777 "Non-nil when TABLE-ROW is located within table's header.
4778 INFO is a plist used as a communication channel. Always return
4779 nil for special rows and rows separators."
4785 "Non-nil when TABLE-ROW is the first table header's row.
4786 INFO is a plist used as a communication channel."
4791 "Non-nil when TABLE-ROW is the last table header's row.
4792 INFO is a plist used as a communication channel."
4797 "Return TABLE-ROW number.
4798 INFO is a plist used as a communication channel. Return value is
4799 zero-based and ignores separators. The function returns nil for
4800 special columns and separators."
4812 "Return TABLE dimensions.
4814 INFO is a plist used as a communication channel.
4816 Return value is a CONS like (ROWS . COLUMNS) where
4817 ROWS (resp. COLUMNS) is the number of exportable
4818 rows (resp. columns)."
4820 ;; Set number of rows, and extract first one.
4826 ;; Set number of columns.
4828 ;; Return value.
4832 "Return address of a regular TABLE-CELL object.
4834 TABLE-CELL is the cell considered. INFO is a plist used as
4835 a communication channel.
4837 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4838 zero-based index. Only exportable cells are considered. The
4839 function returns nil for other cells."
4851 "Return regular table-cell object at ADDRESS in TABLE.
4853 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4854 zero-based index. TABLE is a table type element. INFO is
4855 a plist used as a communication channel.
4857 If no table-cell, among exportable cells, is found at ADDRESS,
4858 return nil."
4861 ;; Row at (car address) or nil.
4869 'table-cell
4876 ;;;; For Tables Of Contents
4877 ;;
4878 ;; `org-export-collect-headlines' builds a list of all exportable
4879 ;; headline elements, maybe limited to a certain depth. One can then
4880 ;; easily parse it and transcode it.
4881 ;;
4882 ;; Building lists of tables, figures or listings is quite similar.
4883 ;; Once the generic function `org-export-collect-elements' is defined,
4884 ;; `org-export-collect-tables', `org-export-collect-figures' and
4885 ;; `org-export-collect-listings' can be derived from it.
4888 "Collect headlines in order to build a table of contents.
4890 INFO is a plist used as a communication channel.
4892 When optional argument N is an integer, it specifies the depth of
4893 the table of contents. Otherwise, it is set to the value of the
4894 last headline level. See `org-export-headline-levels' for more
4895 information.
4897 Optional argument SCOPE, when non-nil, is an element. If it is
4898 a headline, only children of SCOPE are collected. Otherwise,
4899 collect children of the headline containing provided element. If
4900 there is no such headline, collect all headlines. In any case,
4901 argument N becomes relative to the level of that headline.
4903 Return a list of all exportable headlines as parsed elements.
4904 Footnote sections are ignored."
4913 limit))))
4919 info)))
4922 "Collect referenceable elements of a determined type.
4924 TYPE can be a symbol or a list of symbols specifying element
4925 types to search. Only elements with a caption are collected.
4927 INFO is a plist used as a communication channel.
4929 When non-nil, optional argument PREDICATE is a function accepting
4930 one argument, an element of type TYPE. It returns a non-nil
4931 value when that element should be collected.
4933 Return a list of all elements found, in order of appearance."
4938 element))
4939 info))
4942 "Build a list of tables.
4943 INFO is a plist used as a communication channel.
4945 Return a list of table elements with a caption."
4949 "Build a list of figures.
4951 INFO is a plist used as a communication channel. PREDICATE is
4952 a function which accepts one argument: a paragraph element and
4953 whose return value is non-nil when that element should be
4954 collected.
4956 A figure is a paragraph type element, with a caption, verifying
4958 a vague concept that may depend on back-end.
4960 Return a list of elements recognized as figures."
4964 "Build a list of src blocks.
4966 INFO is a plist used as a communication channel.
4968 Return a list of src-block elements with a caption."
4972 ;;;; Smart Quotes
4973 ;;
4974 ;; The main function for the smart quotes sub-system is
4975 ;; `org-export-activate-smart-quotes', which replaces every quote in
4976 ;; a given string from the parse tree with its "smart" counterpart.
4977 ;;
4978 ;; Dictionary for smart quotes is stored in
4979 ;; `org-export-smart-quotes-alist'.
4980 ;;
4981 ;; Internally, regexps matching potential smart quotes (checks at
4982 ;; string boundaries are also necessary) are defined in
4983 ;; `org-export-smart-quotes-regexps'.
4987 ;; one may use: »...«, "...", ›...‹, or '...'.
4988 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4989 ;; LaTeX quotes require Babel!
5034 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5043 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5052 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5061 ;; 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
5062 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5073 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5079 )
5080 "Smart quotes translations.
5082 Alist whose CAR is a language string and CDR is an alist with
5083 quote type as key and a plist associating various encodings to
5084 their translation as value.
5086 A quote type can be any symbol among `opening-double-quote',
5087 `closing-double-quote', `opening-single-quote',
5088 `closing-single-quote' and `apostrophe'.
5090 Valid encodings include `:utf-8', `:html', `:latex' and
5091 `:texinfo'.
5096 "Return smart quote status at the beginning of string S.
5097 INFO is the current export state, as a plist."
5102 table)))
5117 ;; Not already in a level 1 quote: this is an
5118 ;; apostrophe.
5120 ;; Apostrophe.
5122 ;; Apostrophe at the beginning of a string. Check
5123 ;; white space at the end of the last object.
5132 ;; Apostrophe at the end of a string. Check white
5133 ;; space at the beginning of the next object, which
5134 ;; can only happen if that object is a string.
5141 ;; Lonesome apostrophe. Check white space around
5142 ;; both ends.
5154 n))))))))
5156 ;; Else, consider it as a level 2 quote.
5160 current-status))
5163 info nil org-element-recursive-objects)
5170 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5171 `:utf-8'. INFO is a plist used as a communication channel.
5173 The function has to retrieve information about string
5174 surroundings in parse tree. It can only happen with an
5175 unmodified string. Thus, if S has already been through another
5176 process, a non-nil ORIGINAL optional argument will provide that
5177 original string.
5179 Return the new string."
5188 org-export-smart-quotes-alist))))
5189 encoding)
5190 match))
5191 s nil t)))
5193 ;;;; Topology
5194 ;;
5195 ;; Here are various functions to retrieve information about the
5196 ;; neighborhood of a given element or object. Neighbors of interest
5197 ;; are direct parent (`org-export-get-parent'), parent headline
5198 ;; (`org-export-get-parent-headline'), first element containing an
5199 ;; object, (`org-export-get-parent-element'), parent table
5200 ;; (`org-export-get-parent-table'), previous element or object
5201 ;; (`org-export-get-previous-element') and next element or object
5202 ;; (`org-export-get-next-element').
5204 ;; defsubst org-export-get-parent must be defined before first use
5210 "Return BLOB parent headline or nil.
5211 BLOB is the element or object being considered."
5215 "Return first element containing OBJECT or nil.
5216 OBJECT is the object to consider."
5220 "Return OBJECT parent table or nil.
5221 OBJECT is either a `table-cell' or `table-element' type object."
5225 "Return previous element or object.
5227 BLOB is an element or object. INFO is a plist used as
5228 a communication channel. Return previous exportable element or
5229 object, a string, or nil.
5231 When optional argument N is a positive integer, return a list
5232 containing up to N siblings before BLOB, from farthest to
5233 closest. With any other non-nil value, return a list containing
5234 all of them."
5240 prev)
5250 "Return next element or object.
5252 BLOB is an element or object. INFO is a plist used as
5253 a communication channel. Return next exportable element or
5254 object, a string, or nil.
5256 When optional argument N is a positive integer, return a list
5257 containing up to N siblings after BLOB, from closest to farthest.
5258 With any other non-nil value, return a list containing all of
5259 them."
5266 next)
5276 ;;;; Translation
5277 ;;
5278 ;; `org-export-translate' translates a string according to the language
5279 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5280 ;; the dictionary used for the translation.
5312 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5322 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5328 ("ru" :html "(Продолжение следует)"
5402 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5425 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5431 ("ru" :html "Список распечаток"
5445 ("ru" :html "Список таблиц"
5538 ("ru" :html "Неизвестная ссылка"
5541 "Dictionary for export engine.
5543 Alist whose car is the string to translate and cdr is an alist
5544 whose car is the language string and cdr is a plist whose
5545 properties are possible charsets and values translated terms.
5547 It is used as a database for `org-export-translate'. Since this
5548 function returns the string as-is if no translation was found,
5549 the variable only needs to record values different from the
5553 "Translate string S according to language specification.
5555 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5556 and `:utf-8'. INFO is a plist used as a communication channel.
5558 Translation depends on `:language' property. Return the
5559 translated string. If no translation is found, try to fall back
5560 to `:default' encoding. If it fails, return S."
5566 s)))
5569 \f
5570 ;;; Asynchronous Export
5571 ;;
5572 ;; `org-export-async-start' is the entry point for asynchronous
5573 ;; export. It recreates current buffer (including visibility,
5574 ;; narrowing and visited file) in an external Emacs process, and
5575 ;; evaluates a command there. It then applies a function on the
5576 ;; returned results in the current process.
5577 ;;
5578 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5579 ;; allow to export to a buffer or a file, asynchronously or not.
5580 ;;
5581 ;; `org-export-output-file-name' is an auxiliary function meant to be
5582 ;; used with `org-export-to-file'. With a given extension, it tries
5583 ;; to provide a canonical file name to write export output to.
5584 ;;
5585 ;; Asynchronously generated results are never displayed directly.
5586 ;; Instead, they are stored in `org-export-stack-contents'. They can
5587 ;; then be retrieved by calling `org-export-stack'.
5588 ;;
5589 ;; Export Stack is viewed through a dedicated major mode
5590 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5591 ;;`org-export-stack-delete', `org-export-stack-view' and
5592 ;;`org-export-stack-clear'.
5593 ;;
5594 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5595 ;; It should be used whenever `org-export-async-start' is called.
5598 "Call function FUN on the results returned by BODY evaluation.
5600 FUN is an anonymous function of one argument. BODY evaluation
5601 happens in an asynchronous process, from a buffer which is an
5602 exact copy of the current one.
5604 Use `org-export-add-to-stack' in FUN in order to register results
5605 in the stack.
5607 This is a low level function. See also `org-export-to-buffer'
5608 and `org-export-to-file' for more specialized functions."
5611 ;; Write the full sexp evaluating BODY in a copy of the current
5612 ;; buffer to a temporary file, as it may be too long for program
5613 ;; args in `start-process'.
5620 ;; Null characters (from variable values) are inserted
5621 ;; within the file. As a consequence, coding system for
5622 ;; buffer contents will not be recognized properly. So,
5623 ;; we make sure it is the same as the one used to display
5624 ;; the original buffer.
5626 ,coding
5629 ;; Ignore `kill-emacs-hook' and code evaluation
5630 ;; queries from Babel as we need a truly
5631 ;; non-interactive process.
5633 org-babel-confirm-evaluate-answer-no t)
5634 ;; Initialize export framework.
5636 ;; Re-create current buffer there.
5639 ;; Sexp to evaluate in the buffer.
5641 ;; Start external process.
5644 (,process
5646 #'start-process
5649 ,proc-buffer
5656 ;; Register running process in stack.
5658 ;; Set-up sentinel in order to catch results.
5661 ,process
5683 ;;;###autoload
5686 &optional async subtreep visible-only body-only ext-plist
5687 post-process)
5688 "Call `org-export-as' with output to a specified buffer.
5690 BACKEND is either an export back-end, as returned by, e.g.,
5691 `org-export-create-backend', or a symbol referring to
5692 a registered back-end.
5694 BUFFER is the name of the output buffer. If it already exists,
5695 it will be erased first, otherwise, it will be created.
5697 A non-nil optional argument ASYNC means the process should happen
5698 asynchronously. The resulting buffer should then be accessible
5699 through the `org-export-stack' interface. When ASYNC is nil, the
5700 buffer is displayed if `org-export-show-temporary-export-buffer'
5701 is non-nil.
5703 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5704 EXT-PLIST are similar to those used in `org-export-as', which
5705 see.
5707 Optional argument POST-PROCESS is a function which should accept
5708 no argument. It is always called within the current process,
5709 from BUFFER, with point at its beginning. Export back-ends can
5710 use it to set a major mode there, e.g,
5712 \(defun org-latex-export-as-latex
5713 \(&optional async subtreep visible-only body-only ext-plist)
5714 \(interactive)
5716 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5718 This function returns BUFFER."
5746 buffer)))
5748 ;;;###autoload
5751 post-process)
5752 "Call `org-export-as' with output to a specified file.
5754 BACKEND is either an export back-end, as returned by, e.g.,
5755 `org-export-create-backend', or a symbol referring to
5756 a registered back-end. FILE is the name of the output file, as
5757 a string.
5759 A non-nil optional argument ASYNC means the process should happen
5760 asynchronously. The resulting buffer will then be accessible
5761 through the `org-export-stack' interface.
5763 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5764 EXT-PLIST are similar to those used in `org-export-as', which
5765 see.
5767 Optional argument POST-PROCESS is called with FILE as its
5768 argument and happens asynchronously when ASYNC is non-nil. It
5769 has to return a file name, or nil. Export back-ends can use this
5770 to send the output file through additional processing, e.g,
5772 \(defun org-latex-export-to-latex
5773 \(&optional async subtreep visible-only body-only ext-plist)
5774 \(interactive)
5776 \(org-export-to-file 'latex outfile
5777 async subtreep visible-only body-only ext-plist
5778 \(lambda (file) (org-latex-compile file)))
5780 The function returns either a file name returned by POST-PROCESS,
5781 or FILE."
5800 backend subtreep visible-only body-only ext-plist)))
5807 ;; Get proper return value.
5809 file))))))
5812 "Return output file's name according to buffer specifications.
5814 EXTENSION is a string representing the output file extension,
5815 with the leading dot.
5817 With a non-nil optional argument SUBTREEP, try to determine
5819 of subtree at point.
5821 When optional argument PUB-DIR is set, use it as the publishing
5822 directory.
5824 When optional argument VISIBLE-ONLY is non-nil, don't export
5825 contents of hidden elements.
5827 Return file name as a string."
5830 ;; File name may come from EXPORT_FILE_NAME subtree
5831 ;; property, assuming point is at beginning of said
5832 ;; sub-tree.
5839 ;; File name may be extracted from buffer's associated
5840 ;; file, if any.
5842 ;; Can't determine file name on our own: Ask user.
5846 "Output file: " pub-dir nil nil nil
5850 ;; Build file name. Enforce EXTENSION over whatever user
5851 ;; may have come up with. PUB-DIR, if defined, always has
5852 ;; precedence over any provided path.
5857 extension))
5860 ;; If writing to OUTPUT-FILE would overwrite original file, append
5861 ;; EXTENSION another time to final name.
5864 output-file)))
5867 "Add a new result to export stack if not present already.
5869 SOURCE is a buffer or a file name containing export results.
5870 BACKEND is a symbol representing export back-end used to generate
5871 it.
5873 Entries already pointing to SOURCE and unavailable entries are
5874 removed beforehand. Return the new stack."
5880 "Menu for asynchronous export results and running processes."
5890 "Return source from export results at point in stack."
5897 source
5898 ;; SOURCE is not consistent with current line. The stack
5899 ;; view is outdated.
5903 "Remove all entries from export stack."
5908 "Refresh the asynchronous export stack.
5909 DUMMY is ignored. Unavailable sources are removed from the list.
5910 Return the new stack."
5920 ;; Back-end.
5922 ;; Age.
5925 ;; Compute age of the results.
5927 "%4h:%.2m "
5929 ;; Source.
5934 ;; Clear stack from exited processes, dead buffers or
5935 ;; non-existent files.
5947 "Remove export results at point from stack.
5948 If optional argument SOURCE is non-nil, remove it instead."
5953 org-export-stack-contents))))
5956 "View export results at point in stack.
5957 With an optional prefix argument IN-EMACS, force viewing files
5958 within Emacs."
5972 (define-key km "p" 'previous-line)
5973 (define-key km "\C-p" 'previous-line)
5974 (define-key km "\C-?" 'previous-line)
5975 (define-key km [up] 'previous-line)
5976 (define-key km "C" 'org-export-stack-clear)
5977 (define-key km "v" 'org-export-stack-view)
5978 (define-key km (kbd "RET") 'org-export-stack-view)
5979 (define-key km "d" 'org-export-stack-remove)
5980 km)
5981 "Keymap for Org Export Stack.")
5983 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5984 "Mode for displaying asynchronous export stack.
5987 stack.
5989 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5990 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5991 stack completely.
5993 Removing entries in an Org Export Stack buffer doesn't affect
5994 files or buffers, only the display.
5997 (abbrev-mode 0)
5998 (auto-fill-mode 0)
5999 (setq buffer-read-only t
6000 buffer-undo-list t
6001 truncate-lines t
6002 header-line-format
6003 '(:eval
6004 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6005 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6006 (set (make-local-variable 'revert-buffer-function)
6007 'org-export-stack-refresh))
6010 \f
6011 ;;; The Dispatcher
6012 ;;
6013 ;; `org-export-dispatch' is the standard interactive way to start an
6014 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6015 ;; for its interface, which, in turn, delegates response to key
6016 ;; pressed to `org-export--dispatch-action'.
6018 ;;;###autoload
6019 (defun org-export-dispatch (&optional arg)
6020 "Export dispatcher for Org mode.
6022 It provides an access to common export related tasks in a buffer.
6023 Its interface comes in two flavors: standard and expert.
6025 While both share the same set of bindings, only the former
6026 displays the valid keys associations in a dedicated buffer.
6027 Scrolling (resp. line-wise motion) in this buffer is done with
6028 SPC and DEL (resp. C-n and C-p) keys.
6030 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6031 flavor or the other.
6034 of options used back then, on the current buffer.
6036 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6037 (interactive "P")
6038 (let* ((input
6039 (cond ((equal arg '(16)) '(stack))
6040 ((and arg org-export-dispatch-last-action))
6041 (t (save-window-excursion
6042 (unwind-protect
6043 (progn
6044 ;; Remember where we are
6045 (move-marker org-export-dispatch-last-position
6046 (point)
6047 (org-base-buffer (current-buffer)))
6048 ;; Get and store an export command
6049 (setq org-export-dispatch-last-action
6050 (org-export--dispatch-ui
6051 (list org-export-initial-scope
6052 (and org-export-in-background 'async))
6053 nil
6054 org-export-dispatch-use-expert-ui)))
6055 (and (get-buffer "*Org Export Dispatcher*")
6056 (kill-buffer "*Org Export Dispatcher*")))))))
6057 (action (car input))
6058 (optns (cdr input)))
6059 (unless (memq 'subtree optns)
6060 (move-marker org-export-dispatch-last-position nil))
6061 (case action
6062 ;; First handle special hard-coded actions.
6063 (template (org-export-insert-default-template nil optns))
6064 (stack (org-export-stack))
6065 (publish-current-file
6066 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6067 (publish-current-project
6068 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6069 (publish-choose-project
6070 (org-publish (assoc (org-icompleting-read
6071 "Publish project: "
6072 org-publish-project-alist nil t)
6073 org-publish-project-alist)
6074 (memq 'force optns)
6075 (memq 'async optns)))
6076 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6077 (otherwise
6078 (save-excursion
6079 (when arg
6080 ;; Repeating command, maybe move cursor to restore subtree
6081 ;; context.
6082 (if (eq (marker-buffer org-export-dispatch-last-position)
6083 (org-base-buffer (current-buffer)))
6084 (goto-char org-export-dispatch-last-position)
6085 ;; We are in a different buffer, forget position.
6086 (move-marker org-export-dispatch-last-position nil)))
6087 (funcall action
6088 ;; Return a symbol instead of a list to ease
6089 ;; asynchronous export macro use.
6090 (and (memq 'async optns) t)
6091 (and (memq 'subtree optns) t)
6092 (and (memq 'visible optns) t)
6093 (and (memq 'body optns) t)))))))
6095 (defun org-export--dispatch-ui (options first-key expertp)
6096 "Handle interface for `org-export-dispatch'.
6098 OPTIONS is a list containing current interactive options set for
6099 export. It can contain any of the following symbols:
6100 `body' toggles a body-only export
6101 `subtree' restricts export to current subtree
6102 `visible' restricts export to visible part of buffer.
6103 `force' force publishing files.
6104 `async' use asynchronous export process
6106 FIRST-KEY is the key pressed to select the first level menu. It
6107 is nil when this menu hasn't been selected yet.
6109 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6110 buffer is provided, but indications about currently active
6111 options are given in the prompt. Moreover, \[?] allows to switch
6112 back to standard interface."
6113 (let* ((fontify-key
6114 (lambda (key &optional access-key)
6115 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6116 ;; non-nil is the required first-level key to activate
6117 ;; KEY. When its value is t, activate KEY independently
6118 ;; on the first key, if any. A nil value means KEY will
6119 ;; only be activated at first level.
6120 (if (or (eq access-key t) (eq access-key first-key))
6121 (org-propertize key 'face 'org-warning)
6122 key)))
6123 (fontify-value
6124 (lambda (value)
6125 ;; Fontify VALUE string.
6126 (org-propertize value 'face 'font-lock-variable-name-face)))
6127 ;; Prepare menu entries by extracting them from registered
6128 ;; back-ends and sorting them by access key and by ordinal,
6129 ;; if any.
6130 (entries
6131 (sort (sort (delq nil
6132 (mapcar 'org-export-backend-menu
6133 org-export--registered-backends))
6134 (lambda (a b)
6135 (let ((key-a (nth 1 a))
6136 (key-b (nth 1 b)))
6137 (cond ((and (numberp key-a) (numberp key-b))
6138 (< key-a key-b))
6139 ((numberp key-b) t)))))
6140 'car-less-than-car))
6141 ;; Compute a list of allowed keys based on the first key
6142 ;; pressed, if any. Some keys
6143 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6144 ;; available.
6145 (allowed-keys
6146 (nconc (list 2 22 19 6 1)
6147 (if (not first-key) (org-uniquify (mapcar 'car entries))
6148 (let (sub-menu)
6149 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6150 (when (eq (car entry) first-key)
6151 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6152 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6153 ((not first-key) (list ?P)))
6154 (list ?& ?#)
6155 (when expertp (list ??))
6156 (list ?q)))
6157 ;; Build the help menu for standard UI.
6158 (help
6159 (unless expertp
6160 (concat
6161 ;; Options are hard-coded.
6162 (format "[%s] Body only: %s [%s] Visible only: %s
6163 \[%s] Export scope: %s [%s] Force publishing: %s
6165 (funcall fontify-key "C-b" t)
6166 (funcall fontify-value
6167 (if (memq 'body options) "On " "Off"))
6168 (funcall fontify-key "C-v" t)
6169 (funcall fontify-value
6170 (if (memq 'visible options) "On " "Off"))
6171 (funcall fontify-key "C-s" t)
6172 (funcall fontify-value
6173 (if (memq 'subtree options) "Subtree" "Buffer "))
6174 (funcall fontify-key "C-f" t)
6175 (funcall fontify-value
6176 (if (memq 'force options) "On " "Off"))
6177 (funcall fontify-key "C-a" t)
6178 (funcall fontify-value
6179 (if (memq 'async options) "On " "Off")))
6180 ;; Display registered back-end entries. When a key
6181 ;; appears for the second time, do not create another
6182 ;; entry, but append its sub-menu to existing menu.
6183 (let (last-key)
6184 (mapconcat
6185 (lambda (entry)
6186 (let ((top-key (car entry)))
6187 (concat
6188 (unless (eq top-key last-key)
6189 (setq last-key top-key)
6191 (funcall fontify-key (char-to-string top-key))
6192 (nth 1 entry)))
6193 (let ((sub-menu (nth 2 entry)))
6194 (unless (functionp sub-menu)
6195 ;; Split sub-menu into two columns.
6196 (let ((index -1))
6197 (concat
6198 (mapconcat
6199 (lambda (sub-entry)
6200 (incf index)
6201 (format
6202 (if (zerop (mod index 2)) " [%s] %-26s"
6204 (funcall fontify-key
6205 (char-to-string (car sub-entry))
6206 top-key)
6207 (nth 1 sub-entry)))
6208 sub-menu "")
6210 entries ""))
6211 ;; Publishing menu is hard-coded.
6213 [%s] Current file [%s] Current project
6215 (funcall fontify-key "P")
6216 (funcall fontify-key "f" ?P)
6217 (funcall fontify-key "p" ?P)
6218 (funcall fontify-key "x" ?P)
6219 (funcall fontify-key "a" ?P))
6221 (funcall fontify-key "&" t)
6222 (funcall fontify-key "#" t))
6223 (format "[%s] %s"
6224 (funcall fontify-key "q" t)
6225 (if first-key "Main menu" "Exit")))))
6226 ;; Build prompts for both standard and expert UI.
6227 (standard-prompt (unless expertp "Export command: "))
6228 (expert-prompt
6229 (when expertp
6230 (format
6231 "Export command (C-%s%s%s%s%s) [%s]: "
6232 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6233 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6234 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6235 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6236 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6237 (mapconcat (lambda (k)
6238 ;; Strip control characters.
6239 (unless (< k 27) (char-to-string k)))
6240 allowed-keys "")))))
6241 ;; With expert UI, just read key with a fancy prompt. In standard
6242 ;; UI, display an intrusive help buffer.
6243 (if expertp
6244 (org-export--dispatch-action
6245 expert-prompt allowed-keys entries options first-key expertp)
6246 ;; At first call, create frame layout in order to display menu.
6247 (unless (get-buffer "*Org Export Dispatcher*")
6248 (delete-other-windows)
6249 (org-switch-to-buffer-other-window
6250 (get-buffer-create "*Org Export Dispatcher*"))
6251 (setq cursor-type nil
6252 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6253 ;; Make sure that invisible cursor will not highlight square
6254 ;; brackets.
6255 (set-syntax-table (copy-syntax-table))
6256 (modify-syntax-entry ?\[ "w"))
6257 ;; At this point, the buffer containing the menu exists and is
6258 ;; visible in the current window. So, refresh it.
6259 (with-current-buffer "*Org Export Dispatcher*"
6260 ;; Refresh help. Maintain display continuity by re-visiting
6261 ;; previous window position.
6262 (let ((pos (window-start)))
6263 (erase-buffer)
6264 (insert help)
6265 (set-window-start nil pos)))
6266 (org-fit-window-to-buffer)
6267 (org-export--dispatch-action
6268 standard-prompt allowed-keys entries options first-key expertp))))
6270 (defun org-export--dispatch-action
6271 (prompt allowed-keys entries options first-key expertp)
6272 "Read a character from command input and act accordingly.
6274 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6275 a list of characters available at a given step in the process.
6276 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6277 EXPERTP are the same as defined in `org-export--dispatch-ui',
6278 which see.
6280 Toggle export options when required. Otherwise, return value is
6281 a list with action as CAR and a list of interactive export
6282 options as CDR."
6283 (let (key)
6284 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6285 ;; C-p, SPC, DEL).
6286 (while (and (setq key (read-char-exclusive prompt))
6287 (not expertp)
6288 (memq key '(14 16 ?\s ?\d)))
6289 (case key
6290 (14 (if (not (pos-visible-in-window-p (point-max)))
6291 (ignore-errors (scroll-up 1))
6292 (message "End of buffer")
6293 (sit-for 1)))
6294 (16 (if (not (pos-visible-in-window-p (point-min)))
6295 (ignore-errors (scroll-down 1))
6296 (message "Beginning of buffer")
6297 (sit-for 1)))
6298 (?\s (if (not (pos-visible-in-window-p (point-max)))
6299 (scroll-up nil)
6300 (message "End of buffer")
6301 (sit-for 1)))
6302 (?\d (if (not (pos-visible-in-window-p (point-min)))
6303 (scroll-down nil)
6304 (message "Beginning of buffer")
6305 (sit-for 1)))))
6306 (cond
6307 ;; Ignore undefined associations.
6308 ((not (memq key allowed-keys))
6309 (ding)
6310 (unless expertp (message "Invalid key") (sit-for 1))
6311 (org-export--dispatch-ui options first-key expertp))
6312 ;; q key at first level aborts export. At second level, cancel
6313 ;; first key instead.
6314 ((eq key ?q) (if (not first-key) (error "Export aborted")
6315 (org-export--dispatch-ui options nil expertp)))
6316 ;; Help key: Switch back to standard interface if expert UI was
6317 ;; active.
6318 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6319 ;; Send request for template insertion along with export scope.
6320 ((eq key ?#) (cons 'template (memq 'subtree options)))
6321 ;; Switch to asynchronous export stack.
6322 ((eq key ?&) '(stack))
6323 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6324 ((memq key '(2 22 19 6 1))
6325 (org-export--dispatch-ui
6326 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6327 (6 'force) (1 'async))))
6328 (if (memq option options) (remq option options)
6329 (cons option options)))
6330 first-key expertp))
6331 ;; Action selected: Send key and options back to
6332 ;; `org-export-dispatch'.
6333 ((or first-key (functionp (nth 2 (assq key entries))))
6334 (cons (cond
6335 ((not first-key) (nth 2 (assq key entries)))
6336 ;; Publishing actions are hard-coded. Send a special
6337 ;; signal to `org-export-dispatch'.
6338 ((eq first-key ?P)
6339 (case key
6340 (?f 'publish-current-file)
6341 (?p 'publish-current-project)
6342 (?x 'publish-choose-project)
6343 (?a 'publish-all)))
6344 ;; Return first action associated to FIRST-KEY + KEY
6345 ;; path. Indeed, derived backends can share the same
6346 ;; FIRST-KEY.
6347 (t (catch 'found
6348 (mapc (lambda (entry)
6349 (let ((match (assq key (nth 2 entry))))
6350 (when match (throw 'found (nth 2 match)))))
6351 (member (assq first-key entries) entries)))))
6352 options))
6353 ;; Otherwise, enter sub-menu.
6354 (t (org-export--dispatch-ui options key expertp)))))
6358 (provide 'ox)
6360 ;; Local variables:
6361 ;; generated-autoload-file: "org-loaddefs.el"
6362 ;; End:
6364 ;;; ox.el ends here