| blob | ac03662492821c0c0406bc7cd447c765e849d815 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2015 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
90 \f
91 ;;; Internal Variables
92 ;;
93 ;; Among internal variables, the most important is
94 ;; `org-export-options-alist'. This variable define the global export
95 ;; options, shared between every exporter, and how they are acquired.
140 "Alist between export properties and ways to set them.
142 The key of the alist is the property name, and the value is a list
143 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
145 KEYWORD is a string representing a buffer keyword, or nil. Each
146 property defined this way can also be set, during subtree
147 export, through a headline property named after the keyword
149 property).
150 OPTION is a string that could be found in an #+OPTIONS: line.
151 DEFAULT is the default value for the property.
152 BEHAVIOR determines how Org should handle multiple keywords for
153 the same property. It is a symbol among:
154 nil Keep old value and discard the new one.
155 t Replace old value with the new one.
156 `space' Concatenate the values, separating them with a space.
157 `newline' Concatenate the values, separating them with
158 a newline.
159 `split' Split values at white spaces, and cons them to the
160 previous list.
161 `parse' Parse value as a list of strings and Org objects,
162 which can then be transcoded with, e.g.,
163 `org-export-data'. It implies `space' behavior.
165 Values set through KEYWORD and OPTION have precedence over
166 DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
233 "Alist between filters properties and initial values.
235 The key of each association is a property name accessible through
236 the communication channel. Its value is a configurable global
237 variable defining initial filters.
239 This list is meant to install user specified filters. Back-end
240 developers may install their own filters using
241 `org-export-define-backend'. Filters defined there will always
242 be prepended to the current list, so they always get applied
251 "Default rule for link matching an inline image.
252 This rule applies to links with no description. By default, it
253 will be considered as an inline image if it targets a local file
256 See `org-export-inline-image-p' for more information about
261 org-element--cache org-element--cache-objects org-element--cache-sync-keys
262 org-element--cache-sync-requests org-element--cache-sync-timer)
263 "List of variables not copied through upon buffer duplication.
264 Export process takes place on a copy of the original buffer.
265 When this copy is created, all Org related local variables not in
266 this list are copied to the new buffer. Variables with an
270 "Non-nil means asynchronous export process should leave data behind.
274 located in `temporary-file-directory'.
276 When non-nil, it will also set `debug-on-error' to a non-nil
280 "Record asynchronously generated export results and processes.
281 This is an alist: its CAR is the source of the
282 result (destination file or buffer for a finished process,
283 original buffer for a running one) and its CDR is a list
284 containing the back-end used, as a symbol, and either a process
285 or the time at which it finished. It is used to build the menu
289 "List of backends currently available in the exporter.
290 This variable is set with `org-export-define-backend' and
294 "Last command called from the dispatcher.
295 The value should be a list. Its CAR is the action, as a symbol,
299 "The position where the last export command was created using the dispatcher.
300 This marker will be used with `C-u C-c C-e' to make sure export repetition
303 ;; For compatibility with Org < 8
305 "Name, if any, of the back-end used during an export process.
307 Its value is a symbol such as `html', `latex', `ascii', or nil if
308 the back-end is anonymous (see `org-export-create-backend') or if
309 there is no export process in progress.
311 It can be used to teach Babel blocks how to act differently
315 \f
316 ;;; User-configurable Variables
317 ;;
318 ;; Configuration for the masses.
319 ;;
320 ;; They should never be accessed directly, as their value is to be
321 ;; stored in a property list (cf. `org-export-options-alist').
322 ;; Back-ends will read their value from there instead.
325 "Options for exporting Org mode files."
330 "General options for export engine."
335 "Whether sub-trees with the ARCHIVE tag should be exported.
337 This can have three different values:
338 nil Do not export, pretend this tree is not present.
339 t Do export the entire tree.
340 `headline' Only export the headline, but skip the tree below it.
342 This option can also be set with the OPTIONS keyword,
351 "Non-nil means insert author name into the exported file.
352 This option can also be set with the OPTIONS keyword,
358 "Non-nil means export CLOCK keywords.
359 This option can also be set with the OPTIONS keyword,
365 "Non-nil means the postamble should contain a creator sentence.
367 The sentence can be set in `org-export-creator-string', which
368 see.
370 This option can also be set with the OPTIONS keyword, e.g.,
378 "Non-nil means insert date in the exported document.
379 This option can also be set with the OPTIONS keyword,
385 "Time-stamp format string to use for DATE keyword.
387 The format string, when specified, only applies if date consists
388 in a single time-stamp. Otherwise its value will be ignored.
390 See `format-time-string' for details on how to build this
391 string."
399 emacs-version
401 "Information about the creator of the document.
402 This option can also be set on with the CREATOR keyword."
407 "Non-nil means export contents of standard drawers.
409 When t, all drawers are exported. This may also be a list of
410 drawer names to export, as strings. If that list starts with
411 `not', only drawers with such names will be ignored.
413 This variable doesn't apply to properties drawers. See
414 `org-export-with-properties' instead.
416 This option can also be set with the OPTIONS keyword,
429 :inline t
433 "Non-nil means insert author email into the exported file.
434 This option can also be set with the OPTIONS keyword,
440 "Non-nil means interpret *word*, /word/, _word_ and +word+.
442 If the export target supports emphasizing text, the word will be
443 typeset in bold, italic, with an underline or strike-through,
444 respectively.
446 This option can also be set with the OPTIONS keyword,
452 "Tags that exclude a tree from export.
454 All trees carrying any of these tags will be excluded from
455 export. This is without condition, so even subtrees inside that
456 carry one of the `org-export-select-tags' will be removed.
458 This option can also be set with the EXCLUDE_TAGS keyword."
464 This option can also be set with the OPTIONS keyword,
472 "Non-nil means Org footnotes should be exported.
473 This option can also be set with the OPTIONS keyword,
479 "Non-nil means process LaTeX environments and fragments.
481 This option can also be set with the OPTIONS line,
484 nil Ignore math snippets.
485 `verbatim' Keep everything in verbatim.
486 t Allow export of math snippets."
496 "The last level which is still exported as a headline.
498 Inferior levels will usually produce itemize or enumerate lists
499 when exported, but back-end behavior may differ.
501 This option can also be set with the OPTIONS keyword,
507 "The default language for export and clocktable translations, as a string.
508 This may have an association in
509 `org-clock-clocktable-language-setup',
510 `org-export-smart-quotes-alist' and `org-export-dictionary'.
511 This option can also be set with the LANGUAGE keyword."
516 "Non-nil means preserve all line breaks when exporting.
517 This option can also be set with the OPTIONS keyword,
523 "Non-nil means interpret entities when exporting.
526 Å.
528 For a list of supported names, see the constant `org-entities'
529 and the user option `org-entities-user'.
531 This option can also be set with the OPTIONS keyword,
537 "Non-nil means inlinetasks should be exported.
538 This option can also be set with the OPTIONS keyword,
546 "Non-nil means include planning info in export.
548 Planning info is the line containing either SCHEDULED:,
549 DEADLINE:, CLOSED: time-stamps, or a combination of them.
551 This option can also be set with the OPTIONS keyword,
559 "Non-nil means include priority cookies in export.
560 This option can also be set with the OPTIONS keyword,
566 "Non-nil means export contents of properties drawers.
568 When t, all properties are exported. This may also be a list of
569 properties to export, as strings.
571 This option can also be set with the OPTIONS keyword,
583 "Non-nil means add section numbers to headlines when exporting.
585 When set to an integer n, numbering will only happen for
586 headlines whose relative level is higher or equal to n.
588 This option can also be set with the OPTIONS keyword,
594 "Tags that select a tree for export.
596 If any such tag is found in a buffer, all trees that do not carry
597 one of these tags will be ignored during export. Inside trees
598 that are selected like this, you can still deselect a subtree by
599 tagging it with one of the `org-export-exclude-tags'.
601 This option can also be set with the SELECT_TAGS keyword."
606 "Non-nil means activate smart quotes during export.
607 This option can also be set with the OPTIONS keyword,
610 When setting this to non-nil, you need to take care of
611 using the correct Babel package when exporting to LaTeX.
612 E.g., you can load Babel for french like this:
623 When this option is turned on, these strings will be exported as:
625 Org HTML LaTeX UTF-8
626 -----+----------+--------+-------
628 -- – -- –
629 --- — --- —
632 This option can also be set with the OPTIONS keyword,
638 "Non-nil means include statistics cookies in export.
639 This option can also be set with the OPTIONS keyword,
649 If you want to control how Org displays those characters, see
650 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
651 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
652 it is not anymore.
654 When this option is turned on, you can use TeX-like syntax for
655 sub- and superscripts and see them exported correctly.
657 You can also set the option with #+OPTIONS: ^:t
660 single item - so grouping with {} is normally not needed. For
661 example, the following things will be parsed as single sub- or
662 superscripts:
664 10^24 or 10^tau several digits will be considered 1 item.
665 10^-12 or 10^-tau a leading sign with digits or a word
666 x^2-y^3 will be read as x^2 - y^3, because items are
667 terminated by almost any nonword/nondigit char.
668 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
670 Still, ambiguity is possible. So when in doubt, use {} to enclose
671 the sub/superscript. If you set this variable to the symbol `{}',
672 the braces are *required* in order to trigger interpretations as
674 frequently in plain text."
684 "Non-nil means create a table of contents in exported files.
686 The TOC contains headlines with levels up
687 to`org-export-headline-levels'. When an integer, include levels
688 up to N in the toc, this may then be different from
689 `org-export-headline-levels', but it will not be allowed to be
690 larger than the number of headline levels. When nil, no table of
691 contents is made.
693 This option can also be set with the OPTIONS keyword,
702 "Non-nil means export tables.
703 This option can also be set with the OPTIONS keyword,
711 "If nil, do not export tags, just remove them from headlines.
713 If this is the symbol `not-in-toc', tags will be removed from
714 table of contents entries, but still be shown in the headlines of
715 the document.
717 This option can also be set with the OPTIONS keyword,
726 "Non-nil means include TODO items for export.
728 This may have the following values:
729 t include tasks independent of state.
730 `todo' include only tasks that are not yet done.
731 `done' include only tasks that are already done.
732 nil ignore all tasks.
733 list of keywords include tasks with these keywords.
735 This option can also be set with the OPTIONS keyword,
747 "Non-nil means print title into the exported file.
748 This option can also be set with the OPTIONS keyword,
756 "Non-nil means insert a time stamp into the exported file.
757 The time stamp shows when the file was created. This option can
763 "Non nil means allow timestamps in export.
765 It can be set to any of the following values:
766 t export all timestamps.
767 `active' export active timestamps only.
768 `inactive' export inactive timestamps only.
769 nil do not export timestamps
771 This only applies to timestamps isolated in a paragraph
772 containing only timestamps. Other timestamps are always
773 exported.
775 This option can also be set with the OPTIONS keyword, e.g.
785 "Non-nil means include TODO keywords in export.
786 When nil, remove all these keywords from the export. This option
792 "Non-nil means BIND keywords can define local variable values.
793 This is a potential security risk, which is why the default value
794 is nil. You can also allow them through local buffer variables."
801 "Alist between export snippets back-ends and exporter back-ends.
803 This variable allows to provide shortcuts for export snippets.
807 HTML code while every other back-end will ignore it."
816 "Coding system for the exported file."
823 "Non-nil means pushing export output to the kill ring.
824 This variable is ignored during asynchronous export."
834 "The initial scope when exporting with `org-export-dispatch'.
835 This variable can be either set to `buffer' or `subtree'."
842 "Non-nil means show buffer after exporting to temp buffer.
843 When Org exports to a file, the buffer visiting that file is never
844 shown, but remains buried. However, when exporting to
845 a temporary buffer, that buffer is popped up in a second window.
846 When this variable is nil, the buffer remains buried also in
847 these cases."
852 "Non-nil means export and publishing commands will run in background.
853 Results from an asynchronous export are never displayed
861 "File used to initialize external export process.
863 Value must be either nil or an absolute file name. When nil, the
864 external process is launched like a regular Emacs session,
865 loading user's initialization file and any site specific
866 configuration. If a file is provided, it, and only it, is loaded
867 at start-up.
869 Therefore, using a specific configuration makes the process to
870 load faster and the export more portable."
879 "Non-nil means using a non-intrusive `org-export-dispatch'.
880 In that case, no help buffer is displayed. Though, an indicator
886 asynchronous). Also, \[?] allows to switch back to standard
887 mode."
894 \f
895 ;;; Defining Back-ends
896 ;;
897 ;; An export back-end is a structure with `org-export-backend' type
898 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
899 ;; and `menu' slots.
900 ;;
901 ;; At the lowest level, a back-end is created with
902 ;; `org-export-create-backend' function.
903 ;;
904 ;; A named back-end can be registered with
905 ;; `org-export-register-backend' function. A registered back-end can
906 ;; later be referred to by its name, with `org-export-get-backend'
907 ;; function. Also, such a back-end can become the parent of a derived
908 ;; back-end from which slot values will be inherited by default.
909 ;; `org-export-derived-backend-p' can check if a given back-end is
910 ;; derived from a list of back-end names.
911 ;;
912 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
913 ;; `org-export-get-all-filters' return the full alist of transcoders,
914 ;; options and filters, including those inherited from ancestors.
915 ;;
916 ;; At a higher level, `org-export-define-backend' is the standard way
917 ;; to define an export back-end. If the new back-end is similar to
918 ;; a registered back-end, `org-export-define-derived-backend' may be
919 ;; used instead.
920 ;;
921 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
922 ;; when a given back-end hasn't been registered yet.
926 name parent transcoders options filters blocks menu)
929 "Return export back-end named after NAME.
930 NAME is a symbol. Return nil if no such back-end is found."
937 "Register BACKEND as a known export back-end.
938 BACKEND is a structure with `org-export-backend' type."
939 ;; Refuse to register an unnamed back-end.
942 ;; Refuse to register a back-end with an unknown parent.
946 ;; Register dedicated export blocks in the parser.
950 ;; If a back-end with the same name as BACKEND is already
951 ;; registered, replace it with BACKEND. Otherwise, simply add
952 ;; BACKEND to the list of registered back-ends.
958 "Signal an error if BACKEND isn't defined."
963 "Non-nil if BACKEND is derived from one of BACKENDS.
964 BACKEND is an export back-end, as returned by, e.g.,
965 `org-export-create-backend', or a symbol referring to
966 a registered back-end. BACKENDS is constituted of symbols."
978 "Return full translation table for BACKEND.
980 BACKEND is an export back-end, as return by, e.g,,
981 `org-export-create-backend'. Return value is an alist where
982 keys are element or object types, as symbols, and values are
983 transcoders.
985 Unlike to `org-export-backend-transcoders', this function
986 also returns transcoders inherited from parent back-ends,
987 if any."
991 parent)
996 transcoders)))
999 "Return export options for BACKEND.
1001 BACKEND is an export back-end, as return by, e.g,,
1002 `org-export-create-backend'. See `org-export-options-alist'
1003 for the shape of the return value.
1005 Unlike to `org-export-backend-options', this function also
1006 returns options inherited from parent back-ends, if any."
1010 parent)
1014 options)))
1017 "Return complete list of filters for BACKEND.
1019 BACKEND is an export back-end, as return by, e.g,,
1020 `org-export-create-backend'. Return value is an alist where
1021 keys are symbols and values lists of functions.
1023 Unlike to `org-export-backend-filters', this function also
1024 returns filters inherited from parent back-ends, if any."
1028 parent)
1032 filters)))
1035 "Define a new back-end BACKEND.
1037 TRANSCODERS is an alist between object or element types and
1038 functions handling them.
1040 These functions should return a string without any trailing
1041 space, or nil. They must accept three arguments: the object or
1042 element itself, its contents or nil when it isn't recursive and
1043 the property list used as a communication channel.
1045 Contents, when not nil, are stripped from any global indentation
1046 \(although the relative one is preserved). They also always end
1047 with a single newline character.
1049 If, for a given type, no function is found, that element or
1050 object type will simply be ignored, along with any blank line or
1051 white space at its end. The same will happen if the function
1052 returns the nil value. If that function returns the empty
1053 string, the type will be ignored, but the blank lines or white
1054 spaces will be kept.
1056 In addition to element and object types, one function can be
1057 associated to the `template' (or `inner-template') symbol and
1058 another one to the `plain-text' symbol.
1060 The former returns the final transcoded string, and can be used
1061 to add a preamble and a postamble to document's body. It must
1062 accept two arguments: the transcoded string and the property list
1063 containing export options. A function associated to `template'
1065 A function associated to `inner-template' is always applied.
1067 The latter, when defined, is to be called on every text not
1068 recognized as an element or an object. It must accept two
1069 arguments: the text string and the information channel. It is an
1070 appropriate place to protect special chars relative to the
1071 back-end.
1073 BODY can start with pre-defined keyword arguments. The following
1074 keywords are understood:
1076 :export-block
1078 String, or list of strings, representing block names that
1079 will not be parsed. This is used to specify blocks that will
1080 contain raw code specific to the back-end. These blocks
1081 still have to be handled by the relative `export-block' type
1082 translator.
1084 :filters-alist
1086 Alist between filters and function, or list of functions,
1087 specific to the back-end. See `org-export-filters-alist' for
1088 a list of all allowed filters. Filters defined here
1089 shouldn't make a back-end test, as it may prevent back-ends
1090 derived from this one to behave properly.
1092 :menu-entry
1094 Menu entry for the export dispatcher. It should be a list
1095 like:
1097 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1099 where :
1101 KEY is a free character selecting the back-end.
1103 DESCRIPTION-OR-ORDINAL is either a string or a number.
1105 If it is a string, is will be used to name the back-end in
1106 its menu entry. If it is a number, the following menu will
1107 be displayed as a sub-menu of the back-end with the same
1108 KEY. Also, the number will be used to determine in which
1109 order such sub-menus will appear (lowest first).
1111 ACTION-OR-MENU is either a function or an alist.
1113 If it is an action, it will be called with four
1114 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1115 BODY-ONLY. See `org-export-as' for further explanations on
1116 some of them.
1118 If it is an alist, associations should follow the
1119 pattern:
1121 '(KEY DESCRIPTION ACTION)
1123 where KEY, DESCRIPTION and ACTION are described above.
1125 Valid values include:
1129 or
1134 \(lambda (a s v b)
1135 \(if a (org-latex-export-to-pdf t s v b)
1136 \(org-open-file
1137 \(org-latex-export-to-pdf nil s v b)))))))
1139 or the following, which will be added to the previous
1140 sub-menu,
1142 '(?l 1
1146 :options-alist
1148 Alist between back-end specific properties introduced in
1149 communication channel and how their value are acquired. See
1150 `org-export-options-alist' for more information about
1151 structure of the values."
1166 :transcoders transcoders
1167 :options options
1168 :filters filters
1169 :blocks blocks
1173 "Create a new back-end as a variant of an existing one.
1175 CHILD is the name of the derived back-end. PARENT is the name of
1176 the parent back-end.
1178 BODY can start with pre-defined keyword arguments. The following
1179 keywords are understood:
1181 :export-block
1183 String, or list of strings, representing block names that
1184 will not be parsed. This is used to specify blocks that will
1185 contain raw code specific to the back-end. These blocks
1186 still have to be handled by the relative `export-block' type
1187 translator.
1189 :filters-alist
1191 Alist of filters that will overwrite or complete filters
1192 defined in PARENT back-end. See `org-export-filters-alist'
1193 for a list of allowed filters.
1195 :menu-entry
1197 Menu entry for the export dispatcher. See
1198 `org-export-define-backend' for more information about the
1199 expected value.
1201 :options-alist
1203 Alist of back-end specific properties that will overwrite or
1204 complete those defined in PARENT back-end. Refer to
1205 `org-export-options-alist' for more information about
1206 structure of the values.
1208 :translate-alist
1210 Alist of element and object types and transcoders that will
1211 overwrite or complete transcode table from PARENT back-end.
1212 Refer to `org-export-define-backend' for detailed information
1213 about transcoders.
1216 as a variant of `latex' back-end with a custom template function:
1218 \(org-export-define-derived-backend 'my-latex 'latex
1219 :translate-alist '((template . my-latex-template-fun)))
1221 The back-end could then be called with, for example:
1239 :parent parent
1240 :transcoders transcoders
1241 :options options
1242 :filters filters
1243 :blocks blocks
1247 \f
1248 ;;; The Communication Channel
1249 ;;
1250 ;; During export process, every function has access to a number of
1251 ;; properties. They are of two types:
1252 ;;
1253 ;; 1. Environment options are collected once at the very beginning of
1254 ;; the process, out of the original buffer and configuration.
1255 ;; Collecting them is handled by `org-export-get-environment'
1256 ;; function.
1257 ;;
1258 ;; Most environment options are defined through the
1259 ;; `org-export-options-alist' variable.
1260 ;;
1261 ;; 2. Tree properties are extracted directly from the parsed tree,
1262 ;; just before export, by `org-export-collect-tree-properties'.
1264 ;;;; Environment Options
1265 ;;
1266 ;; Environment options encompass all parameters defined outside the
1267 ;; scope of the parsed data. They come from five sources, in
1268 ;; increasing precedence order:
1269 ;;
1270 ;; - Global variables,
1271 ;; - Buffer's attributes,
1272 ;; - Options keyword symbols,
1273 ;; - Buffer keywords,
1274 ;; - Subtree properties.
1275 ;;
1276 ;; The central internal function with regards to environment options
1277 ;; is `org-export-get-environment'. It updates global variables with
1278 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1279 ;; the different sources.
1280 ;;
1281 ;; The internal functions doing the retrieval are:
1282 ;; `org-export--get-global-options',
1283 ;; `org-export--get-buffer-attributes',
1284 ;; `org-export--parse-option-keyword',
1285 ;; `org-export--get-subtree-options' and
1286 ;; `org-export--get-inbuffer-options'
1287 ;;
1288 ;; Also, `org-export--list-bound-variables' collects bound variables
1289 ;; along with their value in order to set them as buffer local
1290 ;; variables later in the process.
1293 "Collect export options from the current buffer.
1295 Optional argument BACKEND is an export back-end, as returned by
1296 `org-export-create-backend'.
1298 When optional argument SUBTREEP is non-nil, assume the export is
1299 done against the current sub-tree.
1301 Third optional argument EXT-PLIST is a property list with
1302 external parameters overriding Org default settings, but still
1303 inferior to file-local settings."
1304 ;; First install #+BIND variables since these must be set before
1305 ;; global options are read.
1308 ;; Get and prioritize export options...
1310 ;; ... from global variables...
1312 ;; ... from an external property list...
1313 ext-plist
1314 ;; ... from in-buffer settings...
1316 ;; ... and from subtree, when appropriate.
1318 ;; Eventually add misc. properties.
1320 :back-end
1321 backend
1323 :id-alist
1324 ;; Collect id references.
1335 alist))))
1338 "Parse an OPTIONS line and return values as a plist.
1339 Optional argument BACKEND is an export back-end, as returned by,
1340 e.g., `org-export-create-backend'. It specifies which back-end
1341 specific items to read, if any."
1345 ;; Priority is given to back-end specific options.
1347 org-export-options-alist)))
1349 plist)
1356 plist))
1359 "Get export options in subtree at point.
1360 Optional argument BACKEND is an export back-end, as returned by,
1361 e.g., `org-export-create-backend'. It specifies back-end used
1362 for export. Return options as a plist."
1363 ;; For each buffer keyword, create a headline property setting the
1364 ;; same property in communication channel. The name for the
1365 ;; property is the keyword with "EXPORT_" appended to it.
1367 ;; Make sure point is at a heading.
1370 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1371 ;; care of them right from the start.
1374 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1375 ;; headline's title (with no todo keyword, priority cookie or
1376 ;; tag) as its fallback value.
1382 ;; Look for both general keywords and back-end specific
1383 ;; options, with priority given to the latter.
1385 org-export-options-alist)))
1386 ;; Handle other keywords. Then return PLIST.
1400 property
1409 "Return current buffer export options, as a plist.
1411 Optional argument BACKEND, when non-nil, is an export back-end,
1412 as returned by, e.g., `org-export-create-backend'. It specifies
1413 which back-end specific options should also be read in the
1414 process.
1416 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1418 get-options ; For byte-compiler.
1421 ;; Priority is given to back-end specific options.
1423 org-export-options-alist))
1426 org-export-special-keywords))))
1429 ;; Return all properties associated to KEYWORD.
1434 to-parse
1437 ;; Recursively read keywords in buffer. FILES is a list
1438 ;; of files read so far. PLIST is the current property
1439 ;; list obtained.
1448 ;; Options in `org-export-special-keywords'.
1452 ;; Avoid circular dependencies.
1462 plist
1467 plist
1473 ;; Options in `org-export-options-alist'.
1476 plist
1478 plist property
1479 ;; Handle value depending on specified
1480 ;; BEHAVIOR.
1485 ;; Even if `parse' implies `space'
1486 ;; behavior, we separate line with "\n"
1487 ;; so as to preserve line-breaks.
1488 ;; However, empty lines are forbidden
1489 ;; since `parse' doesn't allow more than
1490 ;; one paragraph.
1499 " "
1512 plist))))
1513 ;; Read options in the current buffer and return value.
1516 nil)))
1517 ;; Parse properties in TO-PARSE. Remove newline characters not
1518 ;; involved in line breaks to simulate `space' behavior.
1519 ;; Finally return options.
1531 "Return properties related to buffer attributes, as a plist."
1536 "Return global export options as a plist.
1537 Optional argument BACKEND, if non-nil, is an export back-end, as
1538 returned by, e.g., `org-export-create-backend'. It specifies
1539 which back-end specific export options should also be read in the
1540 process."
1542 ;; Priority is given to back-end specific options.
1544 org-export-options-alist)))
1550 plist
1551 prop
1552 ;; Evaluate default value provided.
1557 value)))))))))
1560 "Return variables bound from BIND keywords in current buffer.
1561 Also look for BIND keywords in setup files. The return value is
1562 an alist where associations are (VARIABLE-NAME VALUE)."
1567 ;; Return an alist between variable names and their
1568 ;; value. FILES is a list of setup files names read so
1569 ;; far, used to avoid circular dependencies. ALIST is
1570 ;; the alist collected so far.
1581 ;; Enter setup file.
1591 alist))))))))))
1592 alist)))))
1593 ;; Return value in appropriate order of appearance.
1596 ;; defsubst org-export-get-parent must be defined before first use,
1597 ;; was originally defined in the topology section
1600 "Return BLOB parent or nil.
1601 BLOB is the element or object considered."
1604 ;;;; Tree Properties
1605 ;;
1606 ;; Tree properties are information extracted from parse tree. They
1607 ;; are initialized at the beginning of the transcoding process by
1608 ;; `org-export-collect-tree-properties'.
1609 ;;
1610 ;; Dedicated functions focus on computing the value of specific tree
1611 ;; properties during initialization. Thus,
1612 ;; `org-export--populate-ignore-list' lists elements and objects that
1613 ;; should be skipped during export, `org-export--get-min-level' gets
1614 ;; the minimal exportable level, used as a basis to compute relative
1615 ;; level for headlines. Eventually
1616 ;; `org-export--collect-headline-numbering' builds an alist between
1617 ;; headlines and their numbering.
1620 "Extract tree properties from parse tree.
1622 DATA is the parse tree from which information is retrieved. INFO
1623 is a list holding export options.
1625 Following tree properties are set or updated:
1627 `:exported-data' Hash table used to memoize results from
1628 `org-export-data'.
1630 `:headline-offset' Offset between true level of headlines and
1631 local level. An offset of -1 means a headline
1632 of level 2 should be considered as a level
1633 1 headline in the context.
1635 `:headline-numbering' Alist of all headlines as key an the
1636 associated numbering as value.
1638 Return updated plist."
1639 ;; Install the parse tree in the communication channel.
1641 ;; Compute `:headline-offset' in order to be able to use
1642 ;; `org-export-get-relative-level'.
1645 :headline-offset
1647 ;; Properties order doesn't matter: get the rest of the tree
1648 ;; properties.
1652 info))
1655 "Return minimum exportable headline's level in DATA.
1656 DATA is parsed tree as returned by `org-element-parse-buffer'.
1657 OPTIONS is a plist holding export options."
1668 ;; If no headline was found, for the sake of consistency, set
1669 ;; minimum level to 1 nonetheless.
1673 "Return numbering of all exportable, numbered headlines in a parse tree.
1675 DATA is the parse tree. OPTIONS is the plist holding export
1676 options.
1678 Return an alist whose key is a headline and value is its
1679 associated numbering \(in the shape of a list of numbers\) or nil
1680 for a footnotes section."
1689 headline
1691 for idx from 0 to org-export-max-depth
1695 options)))
1698 "List headlines and inlinetasks with a select tag in their tree.
1699 DATA is parsed data as returned by `org-element-parse-buffer'.
1700 INFO is a plist holding export options."
1702 walk-data ; For byte-compiler.
1712 ;; When a select tag is found, mark full
1713 ;; genealogy and every headline within the tree
1714 ;; as acceptable.
1717 genealogy
1720 selected-trees))
1721 ;; If at a headline, continue searching in tree,
1722 ;; recursively.
1731 selected-trees))
1734 "Non-nil when element or object BLOB should be skipped during export.
1735 OPTIONS is the plist holding export options. SELECTED, when
1736 non-nil, is a list of headlines or inlinetasks belonging to
1737 a tree with a select tag."
1744 ;; If `:with-drawers' value starts with `not', ignore
1745 ;; every drawer whose name belong to that list.
1746 ;; Otherwise, ignore drawers whose name isn't in that
1747 ;; list.
1764 ;; Ignore subtrees with an exclude tag.
1767 ;; When a select tag is present in the buffer, ignore any tree
1768 ;; without it.
1770 ;; Ignore commented sub-trees.
1772 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1774 ;; Ignore tasks, if specified by `:with-tasks' property.
1786 properties-set))))))
1797 ;; `:with-timestamps' only applies to isolated timestamps
1798 ;; objects, i.e. timestamp objects in a paragraph containing only
1799 ;; timestamps and whitespaces.
1807 options t))))
1816 \f
1817 ;;; The Transcoder
1818 ;;
1819 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1820 ;; `org-element-parse-buffer') and transcodes it into a specified
1821 ;; back-end output. It takes care of filtering out elements or
1822 ;; objects according to export options and organizing the output blank
1823 ;; lines and white space are preserved. The function memoizes its
1824 ;; results, so it is cheap to call it within transcoders.
1825 ;;
1826 ;; It is possible to modify locally the back-end used by
1827 ;; `org-export-data' or even use a temporary back-end by using
1828 ;; `org-export-data-with-backend'.
1829 ;;
1830 ;; `org-export-transcoder' is an accessor returning appropriate
1831 ;; translator function for a given element or object.
1834 "Return appropriate transcoder for BLOB.
1835 INFO is a plist containing export directives."
1837 ;; Return contents only for complete parse trees.
1843 "Convert DATA into current back-end format.
1845 DATA is a parse tree, an element or an object or a secondary
1846 string. INFO is a plist holding export options.
1848 Return a string."
1853 ;; Ignored element/object.
1855 ;; Plain text.
1861 info))
1862 ;; Secondary string.
1865 ;; Element/Object without contents or, as a special
1866 ;; case, headline with archive tag and archived trees
1867 ;; restricted to title only.
1875 ;; Export snippets never return a nil value so
1876 ;; that white spaces following them are never
1877 ;; ignored.
1879 ;; Element/Object with contents.
1892 ;; Elements directly containing
1893 ;; objects must have their indentation
1894 ;; normalized first.
1896 data
1897 ;; When normalizing contents of the
1898 ;; first paragraph in an item or
1899 ;; a footnote definition, ignore
1900 ;; first line's indentation: there is
1901 ;; none and it might be misleading.
1906 data)
1913 info))))))))
1914 ;; Final result will be memoized before being returned.
1916 data
1920 ;; Append the same white space between elements or objects
1921 ;; as in the original buffer, and call appropriate filters.
1932 info)))
1933 results)))
1937 "Convert DATA into BACKEND format.
1939 DATA is an element, an object, a secondary string or a string.
1940 BACKEND is a symbol. INFO is a plist used as a communication
1941 channel.
1943 Unlike to `org-export-with-backend', this function will
1944 recursively convert DATA using BACKEND translation table."
1947 data
1948 ;; Set-up a new communication channel with translations defined in
1949 ;; BACKEND as the translate table and a new hash table for
1950 ;; memoization.
1952 info
1955 ;; Size of the hash table is reduced since this function
1956 ;; will probably be used on small trees.
1960 "Expand a parsed element or object to its original state.
1962 BLOB is either an element or an object. CONTENTS is its
1963 contents, as a string or nil.
1965 When optional argument WITH-AFFILIATED is non-nil, add affiliated
1966 keywords before output."
1971 blob contents))))
1974 \f
1975 ;;; The Filter System
1976 ;;
1977 ;; Filters allow end-users to tweak easily the transcoded output.
1978 ;; They are the functional counterpart of hooks, as every filter in
1979 ;; a set is applied to the return value of the previous one.
1980 ;;
1981 ;; Every set is back-end agnostic. Although, a filter is always
1982 ;; called, in addition to the string it applies to, with the back-end
1983 ;; used as argument, so it's easy for the end-user to add back-end
1984 ;; specific filters in the set. The communication channel, as
1985 ;; a plist, is required as the third argument.
1986 ;;
1987 ;; From the developer side, filters sets can be installed in the
1988 ;; process with the help of `org-export-define-backend', which
1989 ;; internally stores filters as an alist. Each association has a key
1990 ;; among the following symbols and a function or a list of functions
1991 ;; as value.
1992 ;;
1993 ;; - `:filter-options' applies to the property list containing export
1994 ;; options. Unlike to other filters, functions in this list accept
1995 ;; two arguments instead of three: the property list containing
1996 ;; export options and the back-end. Users can set its value through
1997 ;; `org-export-filter-options-functions' variable.
1998 ;;
1999 ;; - `:filter-parse-tree' applies directly to the complete parsed
2000 ;; tree. Users can set it through
2001 ;; `org-export-filter-parse-tree-functions' variable.
2002 ;;
2003 ;; - `:filter-body' applies to the body of the output, before template
2004 ;; translator chimes in. Users can set it through
2005 ;; `org-export-filter-body-functions' variable.
2006 ;;
2007 ;; - `:filter-final-output' applies to the final transcoded string.
2008 ;; Users can set it with `org-export-filter-final-output-functions'
2009 ;; variable.
2010 ;;
2011 ;; - `:filter-plain-text' applies to any string not recognized as Org
2012 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2013 ;; configure it.
2014 ;;
2015 ;; - `:filter-TYPE' applies on the string returned after an element or
2016 ;; object of type TYPE has been transcoded. A user can modify
2017 ;; `org-export-filter-TYPE-functions' to install these filters.
2018 ;;
2019 ;; All filters sets are applied with
2020 ;; `org-export-filter-apply-functions' function. Filters in a set are
2021 ;; applied in a LIFO fashion. It allows developers to be sure that
2022 ;; their filters will be applied first.
2023 ;;
2024 ;; Filters properties are installed in communication channel with
2025 ;; `org-export-install-filters' function.
2026 ;;
2027 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2028 ;; `org-export-before-parsing-hook') are run at the beginning of the
2029 ;; export process and just before parsing to allow for heavy structure
2030 ;; modifications.
2033 ;;;; Hooks
2036 "Hook run at the beginning of the export process.
2038 This is run before include keywords and macros are expanded and
2039 Babel code blocks executed, on a copy of the original buffer
2040 being exported. Visibility and narrowing are preserved. Point
2041 is at the beginning of the buffer.
2043 Every function in this hook will be called with one argument: the
2047 "Hook run before parsing an export buffer.
2049 This is run after include keywords and macros have been expanded
2050 and Babel code blocks executed, on a copy of the original buffer
2051 being exported. Visibility and narrowing are preserved. Point
2052 is at the beginning of the buffer.
2054 Every function in this hook will be called with one argument: the
2058 ;;;; Special Filters
2061 "List of functions applied to the export options.
2062 Each filter is called with two arguments: the export options, as
2063 a plist, and the back-end, as a symbol. It must return
2067 "List of functions applied to the parsed tree.
2068 Each filter is called with three arguments: the parse tree, as
2069 returned by `org-element-parse-buffer', the back-end, as
2070 a symbol, and the communication channel, as a plist. It must
2074 "List of functions applied to plain text.
2075 Each filter is called with three arguments: a string which
2076 contains no Org syntax, the back-end, as a symbol, and the
2077 communication channel, as a plist. It must return a string or
2081 "List of functions applied to transcoded body.
2082 Each filter is called with three arguments: a string which
2083 contains no Org syntax, the back-end, as a symbol, and the
2084 communication channel, as a plist. It must return a string or
2088 "List of functions applied to the transcoded string.
2089 Each filter is called with three arguments: the full transcoded
2090 string, the back-end, as a symbol, and the communication channel,
2091 as a plist. It must return a string that will be used as the
2095 ;;;; Elements Filters
2098 "List of functions applied to a transcoded babel-call.
2099 Each filter is called with three arguments: the transcoded data,
2100 as a string, the back-end, as a symbol, and the communication
2104 "List of functions applied to a transcoded center block.
2105 Each filter is called with three arguments: the transcoded data,
2106 as a string, the back-end, as a symbol, and the communication
2110 "List of functions applied to a transcoded clock.
2111 Each filter is called with three arguments: the transcoded data,
2112 as a string, the back-end, as a symbol, and the communication
2116 "List of functions applied to a transcoded diary-sexp.
2117 Each filter is called with three arguments: the transcoded data,
2118 as a string, the back-end, as a symbol, and the communication
2122 "List of functions applied to a transcoded drawer.
2123 Each filter is called with three arguments: the transcoded data,
2124 as a string, the back-end, as a symbol, and the communication
2128 "List of functions applied to a transcoded dynamic-block.
2129 Each filter is called with three arguments: the transcoded data,
2130 as a string, the back-end, as a symbol, and the communication
2134 "List of functions applied to a transcoded example-block.
2135 Each filter is called with three arguments: the transcoded data,
2136 as a string, the back-end, as a symbol, and the communication
2140 "List of functions applied to a transcoded export-block.
2141 Each filter is called with three arguments: the transcoded data,
2142 as a string, the back-end, as a symbol, and the communication
2146 "List of functions applied to a transcoded fixed-width.
2147 Each filter is called with three arguments: the transcoded data,
2148 as a string, the back-end, as a symbol, and the communication
2152 "List of functions applied to a transcoded footnote-definition.
2153 Each filter is called with three arguments: the transcoded data,
2154 as a string, the back-end, as a symbol, and the communication
2158 "List of functions applied to a transcoded headline.
2159 Each filter is called with three arguments: the transcoded data,
2160 as a string, the back-end, as a symbol, and the communication
2164 "List of functions applied to a transcoded horizontal-rule.
2165 Each filter is called with three arguments: the transcoded data,
2166 as a string, the back-end, as a symbol, and the communication
2170 "List of functions applied to a transcoded inlinetask.
2171 Each filter is called with three arguments: the transcoded data,
2172 as a string, the back-end, as a symbol, and the communication
2176 "List of functions applied to a transcoded item.
2177 Each filter is called with three arguments: the transcoded data,
2178 as a string, the back-end, as a symbol, and the communication
2182 "List of functions applied to a transcoded keyword.
2183 Each filter is called with three arguments: the transcoded data,
2184 as a string, the back-end, as a symbol, and the communication
2188 "List of functions applied to a transcoded latex-environment.
2189 Each filter is called with three arguments: the transcoded data,
2190 as a string, the back-end, as a symbol, and the communication
2194 "List of functions applied to a transcoded node-property.
2195 Each filter is called with three arguments: the transcoded data,
2196 as a string, the back-end, as a symbol, and the communication
2200 "List of functions applied to a transcoded paragraph.
2201 Each filter is called with three arguments: the transcoded data,
2202 as a string, the back-end, as a symbol, and the communication
2206 "List of functions applied to a transcoded plain-list.
2207 Each filter is called with three arguments: the transcoded data,
2208 as a string, the back-end, as a symbol, and the communication
2212 "List of functions applied to a transcoded planning.
2213 Each filter is called with three arguments: the transcoded data,
2214 as a string, the back-end, as a symbol, and the communication
2218 "List of functions applied to a transcoded property-drawer.
2219 Each filter is called with three arguments: the transcoded data,
2220 as a string, the back-end, as a symbol, and the communication
2224 "List of functions applied to a transcoded quote block.
2225 Each filter is called with three arguments: the transcoded quote
2226 data, as a string, the back-end, as a symbol, and the
2227 communication channel, as a plist. It must return a string or
2231 "List of functions applied to a transcoded section.
2232 Each filter is called with three arguments: the transcoded data,
2233 as a string, the back-end, as a symbol, and the communication
2237 "List of functions applied to a transcoded special block.
2238 Each filter is called with three arguments: the transcoded data,
2239 as a string, the back-end, as a symbol, and the communication
2243 "List of functions applied to a transcoded src-block.
2244 Each filter is called with three arguments: the transcoded data,
2245 as a string, the back-end, as a symbol, and the communication
2249 "List of functions applied to a transcoded table.
2250 Each filter is called with three arguments: the transcoded data,
2251 as a string, the back-end, as a symbol, and the communication
2255 "List of functions applied to a transcoded table-cell.
2256 Each filter is called with three arguments: the transcoded data,
2257 as a string, the back-end, as a symbol, and the communication
2261 "List of functions applied to a transcoded table-row.
2262 Each filter is called with three arguments: the transcoded data,
2263 as a string, the back-end, as a symbol, and the communication
2267 "List of functions applied to a transcoded verse block.
2268 Each filter is called with three arguments: the transcoded data,
2269 as a string, the back-end, as a symbol, and the communication
2273 ;;;; Objects Filters
2276 "List of functions applied to transcoded bold text.
2277 Each filter is called with three arguments: the transcoded data,
2278 as a string, the back-end, as a symbol, and the communication
2282 "List of functions applied to transcoded code text.
2283 Each filter is called with three arguments: the transcoded data,
2284 as a string, the back-end, as a symbol, and the communication
2288 "List of functions applied to a transcoded entity.
2289 Each filter is called with three arguments: the transcoded data,
2290 as a string, the back-end, as a symbol, and the communication
2294 "List of functions applied to a transcoded export-snippet.
2295 Each filter is called with three arguments: the transcoded data,
2296 as a string, the back-end, as a symbol, and the communication
2300 "List of functions applied to a transcoded footnote-reference.
2301 Each filter is called with three arguments: the transcoded data,
2302 as a string, the back-end, as a symbol, and the communication
2306 "List of functions applied to a transcoded inline-babel-call.
2307 Each filter is called with three arguments: the transcoded data,
2308 as a string, the back-end, as a symbol, and the communication
2312 "List of functions applied to a transcoded inline-src-block.
2313 Each filter is called with three arguments: the transcoded data,
2314 as a string, the back-end, as a symbol, and the communication
2318 "List of functions applied to transcoded italic text.
2319 Each filter is called with three arguments: the transcoded data,
2320 as a string, the back-end, as a symbol, and the communication
2324 "List of functions applied to a transcoded latex-fragment.
2325 Each filter is called with three arguments: the transcoded data,
2326 as a string, the back-end, as a symbol, and the communication
2330 "List of functions applied to a transcoded line-break.
2331 Each filter is called with three arguments: the transcoded data,
2332 as a string, the back-end, as a symbol, and the communication
2336 "List of functions applied to a transcoded link.
2337 Each filter is called with three arguments: the transcoded data,
2338 as a string, the back-end, as a symbol, and the communication
2342 "List of functions applied to a transcoded radio-target.
2343 Each filter is called with three arguments: the transcoded data,
2344 as a string, the back-end, as a symbol, and the communication
2348 "List of functions applied to a transcoded statistics-cookie.
2349 Each filter is called with three arguments: the transcoded data,
2350 as a string, the back-end, as a symbol, and the communication
2354 "List of functions applied to transcoded strike-through text.
2355 Each filter is called with three arguments: the transcoded data,
2356 as a string, the back-end, as a symbol, and the communication
2360 "List of functions applied to a transcoded subscript.
2361 Each filter is called with three arguments: the transcoded data,
2362 as a string, the back-end, as a symbol, and the communication
2366 "List of functions applied to a transcoded superscript.
2367 Each filter is called with three arguments: the transcoded data,
2368 as a string, the back-end, as a symbol, and the communication
2372 "List of functions applied to a transcoded target.
2373 Each filter is called with three arguments: the transcoded data,
2374 as a string, the back-end, as a symbol, and the communication
2378 "List of functions applied to a transcoded timestamp.
2379 Each filter is called with three arguments: the transcoded data,
2380 as a string, the back-end, as a symbol, and the communication
2384 "List of functions applied to transcoded underline text.
2385 Each filter is called with three arguments: the transcoded data,
2386 as a string, the back-end, as a symbol, and the communication
2390 "List of functions applied to transcoded verbatim text.
2391 Each filter is called with three arguments: the transcoded data,
2392 as a string, the back-end, as a symbol, and the communication
2396 ;;;; Filters Tools
2397 ;;
2398 ;; Internal function `org-export-install-filters' installs filters
2399 ;; hard-coded in back-ends (developer filters) and filters from global
2400 ;; variables (user filters) in the communication channel.
2401 ;;
2402 ;; Internal function `org-export-filter-apply-functions' takes care
2403 ;; about applying each filter in order to a given data. It ignores
2404 ;; filters returning a nil value but stops whenever a filter returns
2405 ;; an empty string.
2408 "Call every function in FILTERS.
2410 Functions are called with arguments VALUE, current export
2411 back-end's name and INFO. A function returning a nil value will
2412 be skipped. If it returns the empty string, the process ends and
2413 VALUE is ignored.
2415 Call is done in a LIFO fashion, to be sure that developer
2416 specified filters, if any, are called first."
2427 "Install filters properties in communication channel.
2428 INFO is a plist containing the current communication channel.
2429 Return the updated communication channel."
2431 ;; Install user-defined filters with `org-export-filters-alist'
2432 ;; and filters already in INFO (through ext-plist mechanism).
2439 ;; Filters in INFO will be called
2440 ;; before those user provided.
2443 default-value)))))
2444 org-export-filters-alist)
2445 ;; Prepend back-end specific filters to that list.
2447 ;; Single values get consed, lists are appended.
2452 plist key
2456 ;; Return new communication channel.
2460 \f
2461 ;;; Core functions
2462 ;;
2463 ;; This is the room for the main function, `org-export-as', along with
2464 ;; its derivative, `org-export-string-as'.
2465 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2466 ;; function should be added to kill ring.
2467 ;;
2468 ;; Note that `org-export-as' doesn't really parse the current buffer,
2469 ;; but a copy of it (with the same buffer-local variables and
2470 ;; visibility), where macros and include keywords are expanded and
2471 ;; Babel blocks are executed, if appropriate.
2472 ;; `org-export-with-buffer-copy' macro prepares that copy.
2473 ;;
2474 ;; File inclusion is taken care of by
2475 ;; `org-export-expand-include-keyword' and
2476 ;; `org-export--prepare-file-contents'. Structure wise, including
2477 ;; a whole Org file in a buffer often makes little sense. For
2478 ;; example, if the file contains a headline and the include keyword
2479 ;; was within an item, the item should contain the headline. That's
2480 ;; why file inclusion should be done before any structure can be
2481 ;; associated to the file, that is before parsing.
2482 ;;
2483 ;; `org-export-insert-default-template' is a command to insert
2484 ;; a default template (or a back-end specific template) at point or in
2485 ;; current subtree.
2488 "Return a copy of the current buffer.
2489 The copy preserves Org buffer-local variables, visibility and
2490 narrowing."
2496 new-buf))
2499 "Apply BODY in a copy of the current buffer.
2500 The copy preserves local variables, visibility and contents of
2501 the original buffer. Point is at the beginning of the buffer
2502 when BODY is applied."
2511 ;; Kill copy without confirmation.
2517 "Generate a function duplicating BUFFER.
2519 The copy will preserve local variables, visibility, contents and
2520 narrowing of the original buffer. If a region was active in
2521 BUFFER, contents will be narrowed to that region instead.
2523 The resulting function can be evaluated at a later time, from
2524 another buffer, effectively cloning the original buffer there.
2526 The function assumes BUFFER's major mode is `org-mode'."
2530 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2531 ;; already in BUFFER.
2533 ;; Copy specific buffer local variables and variables set
2534 ;; through BIND keywords.
2536 vars)
2544 buffer-file-name
2545 buffer-file-coding-system))
2549 ;; Skip unreadable values, as they cannot be
2550 ;; sent to external process.
2554 vars))))))
2555 ;; Whole buffer contents.
2560 ;; Narrowing.
2564 ;; Current position of point.
2566 ;; Overlays with invisible property.
2576 ov-set))))
2578 ov-set)))))
2581 "Delete commented areas in the buffer.
2582 Commented areas are comments, comment blocks, commented trees and
2583 inlinetasks. Trailing blank lines after a comment or a comment
2584 block are preserved. Narrowing, if any, is ignored."
2605 "Prune non exportable elements from DATA.
2606 DATA is the parse tree to traverse. INFO is the plist holding
2607 export info. Also set `:ignore-list' in INFO to a list of
2608 objects which should be ignored during export, but not removed
2609 from tree."
2611 ignore
2612 ;; First find trees containing a select tag, if any.
2616 ;; Prune non-exportable elements and objects from tree.
2617 ;; As a special case, special rows and cells from tables
2618 ;; are stored in IGNORE, as they still need to be accessed
2619 ;; during export.
2628 ;; If headline is archived but tree below has to
2629 ;; be skipped, remove contents.
2631 ;; Move into secondary string, if any.
2636 ;; Move into recursive objects/elements.
2638 ;; If a select tag is active, also ignore the section before the
2639 ;; first headline, if any.
2644 ;; Prune tree and communication channel.
2648 ;; Priority is given to back-end specific options.
2650 org-export-options-alist))
2653 ;; Eventually set `:ignore-list'.
2657 "Change uninterpreted elements back into Org syntax.
2658 DATA is the parse tree. INFO is a plist containing export
2659 options. Each uninterpreted element or object is changed back
2660 into a string. Contents, if any, are not modified. The parse
2661 tree is modified by side effect."
2667 p
2670 info))))))
2673 "Change uninterpreted elements back into Org syntax.
2674 DATA is a parse tree or a secondary string. INFO is a plist
2675 containing export options. It is modified by side effect and
2676 returned by the function."
2679 subscript superscript underline)
2683 ;; ... entities...
2690 ?\s)))))
2691 ;; ... emphasis...
2703 marker
2707 ?\s)))))))
2708 ;; ... LaTeX environments and fragments...
2712 ;; ... sub/superscripts...
2721 "_"
2730 ?\s)))))))))))
2732 ;; Splice NEW at BLOB location in parse tree.
2735 info)
2736 ;; Return modified parse tree.
2737 data)
2740 "Insert footnote definitions outside parsing scope in TREE.
2742 If there is a footnote section in TREE, definitions found are
2743 appended to it. If `org-footnote-section' is non-nil, a new
2744 footnote section containing all definitions is inserted in TREE.
2745 Otherwise, definitions are appended at the end of the section
2746 containing their first reference.
2748 Only definitions actually referred to within TREE, directly or
2749 not, are considered."
2768 definitions))
2776 'footnote-definition
2782 definitions))))))))
2783 ;; Collect all out of scope definitions.
2793 ;; Filter out definitions referenced neither in the original
2794 ;; tree nor in the external definitions.
2799 definitions))
2802 referenced-labels)))
2807 definitions)))
2808 ;; Install definitions in subtree.
2811 ;; If there is a footnote section, insert them here.
2816 nil t)))
2819 ;; If there should be a footnote section, create one containing
2820 ;; all the definitions at the end of the tree.
2823 tree
2829 'section
2830 nil
2832 ;; Otherwise add each definition at the end of the section where
2833 ;; it is first referenced.
2839 ;; Insert definitions in the same section as their
2840 ;; first reference in DATA.
2852 label)
2859 definition)
2861 definition)))))))))))
2864 ;;;###autoload
2867 "Transcode current Org buffer into BACKEND code.
2869 BACKEND is either an export back-end, as returned by, e.g.,
2870 `org-export-create-backend', or a symbol referring to
2871 a registered back-end.
2873 If narrowing is active in the current buffer, only transcode its
2874 narrowed part.
2876 If a region is active, transcode that region.
2878 When optional argument SUBTREEP is non-nil, transcode the
2879 sub-tree at point, extracting information from the headline
2880 properties first.
2882 When optional argument VISIBLE-ONLY is non-nil, don't export
2883 contents of hidden elements.
2885 When optional argument BODY-ONLY is non-nil, only return body
2886 code, without surrounding template.
2888 Optional argument EXT-PLIST, when provided, is a property list
2889 with external parameters overriding Org default settings, but
2890 still inferior to file-local settings.
2892 Return code as a string."
2897 ;; Narrow buffer to an appropriate region or subtree for
2898 ;; parsing. If parsing subtree, be sure to remove main headline
2899 ;; too.
2907 ;; Initialize communication channel with original buffer
2908 ;; attributes, unavailable in its copy.
2921 org-export-options-alist))))
2922 tree)
2923 ;; Update communication channel and get parse tree. Buffer
2924 ;; isn't parsed directly. Instead, all buffer modifications
2925 ;; and consequent parsing are undertaken in a temporary copy.
2927 ;; Run first hook with current back-end's name as argument.
2930 ;; Include files, delete comments and expand macros.
2935 ;; Refresh buffer properties and radio targets after
2936 ;; potentially invasive previous changes. Likewise, do it
2937 ;; again after executing Babel code.
2943 ;; Run last hook with current back-end's name as argument.
2944 ;; Update buffer properties and radio targets one last time
2945 ;; before parsing.
2952 ;; Update communication channel with environment. Also
2953 ;; install user's and developer's filters.
2958 ;; Call options filters and update export options. We do not
2959 ;; use `org-export-filter-apply-functions' here since the
2960 ;; arity of such filters is different.
2965 ;; Expand export-specific set of macros: {{{author}}},
2966 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2967 ;; be done once regular macros have been expanded, since
2968 ;; parsed keywords may contain one of them.
2981 value)
2982 value)))
2986 'finalize
2987 parsed-keywords)
2988 ;; Parse buffer.
2990 ;; Merge footnote definitions outside scope into parse tree.
2992 ;; Prune tree from non-exported elements and transform
2993 ;; uninterpreted elements or objects in both parse tree and
2994 ;; communication channel.
2997 ;; Call parse tree filters.
3001 ;; Now tree is complete, compute its properties and add them
3002 ;; to communication channel.
3006 ;; Eventually transcode TREE. Wrap the resulting string into
3007 ;; a template.
3016 info))
3019 ;; Remove all text properties since they cannot be
3020 ;; retrieved from an external process. Finally call
3021 ;; final-output filter and return result.
3027 info))))))))
3029 ;;;###autoload
3031 "Transcode STRING into BACKEND code.
3033 BACKEND is either an export back-end, as returned by, e.g.,
3034 `org-export-create-backend', or a symbol referring to
3035 a registered back-end.
3037 When optional argument BODY-ONLY is non-nil, only return body
3038 code, without preamble nor postamble.
3040 Optional argument EXT-PLIST, when provided, is a property list
3041 with external parameters overriding Org default settings, but
3042 still inferior to file-local settings.
3044 Return code as a string."
3050 ;;;###autoload
3052 "Replace the active region by its export to BACKEND.
3053 BACKEND is either an export back-end, as returned by, e.g.,
3054 `org-export-create-backend', or a symbol referring to
3055 a registered back-end."
3061 ;;;###autoload
3063 "Insert all export keywords with default values at beginning of line.
3065 BACKEND is a symbol referring to the name of a registered export
3066 back-end, for which specific export options should be added to
3067 the template, or `default' for default template. When it is nil,
3068 the user will be prompted for a category.
3070 If SUBTREEP is non-nil, export configuration will be set up
3071 locally for the subtree through node properties."
3081 "Options category: "
3085 org-export-registered-backends))
3086 nil t))))
3087 options keywords)
3088 ;; Populate OPTIONS and KEYWORDS.
3105 ;; Move to an appropriate location in order to insert options.
3107 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3125 ;; Then the rest of keywords, in the order specified in either
3126 ;; `org-export-options-alist' or respective export back-ends.
3147 "Expand every include keyword in buffer.
3148 Optional argument INCLUDED is a list of included file names along
3149 with their line restriction, when appropriate. It is used to
3150 avoid infinite recursion. Optional argument DIR is the current
3151 working directory. It is used to properly resolve relative
3152 paths. Optional argument FOOTNOTES is a hash-table used for
3153 storing and resolving footnotes. It is created automatically."
3159 ;; If :minlevel is not set the text-property
3160 ;; `:org-include-induced-level' will be used to determine the
3161 ;; relative level when expanding INCLUDE.
3162 ;; Only affects included Org documents.
3166 :org-include-induced-level
3168 ;; Expand INCLUDE keywords.
3174 ;; Extract arguments from keyword's value.
3177 location
3185 matched)
3191 matched)
3192 dir)))
3196 value)
3202 value)
3209 ;; Minimal level of included file defaults to the child
3210 ;; level of the current headline, if any, or one. It
3211 ;; only applies is the file is meant to be included as
3212 ;; an Org one.
3224 ;; Remove keyword.
3230 ;; Check if files has already been parsed. Look after
3231 ;; inclusion lines too, as different parts of the same file
3232 ;; can be included too.
3247 ind-str block arg-str contents ind-str block))))
3254 ind-str block contents ind-str block))))
3262 file location only-contents lines)
3263 lines)))
3267 file lines ind minlevel
3270 footnotes)))
3274 footnotes)
3276 ;; Expand footnotes after all files have been included.
3277 ;; Footnotes are stored at end of buffer.
3282 footnotes)))))))))))
3285 "Resolve absolute lines for an included file with file-link.
3287 FILE is string file-name of the file to include. LOCATION is a
3288 string name within FILE to be included (located via
3289 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3290 contents of the named element will be included, as determined
3291 Org-Element. If LINES is non-nil only those lines are included.
3293 Return a string of lines to be included in the format expected by
3294 `org-export--prepare-file-contents'."
3300 ;; Enforce consistent search.
3313 ;; Skip planning line and property-drawer.
3339 start-line
3341 (+ start-line
3344 counter))))))))
3347 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3349 REF-BEGIN corresponds to the property `:begin' of objects of type
3350 footnote-definition and footnote-reference.
3352 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3353 \[N] where N is one or more numbers.
3355 Return the new label."
3366 "Prepare contents of FILE for inclusion and return it as a string.
3368 When optional argument LINES is a string specifying a range of
3369 lines, include only those lines.
3371 Optional argument IND, when non-nil, is an integer specifying the
3372 global indentation of returned contents. Since its purpose is to
3373 allow an included file to stay in the same environment it was
3374 created \(i.e. a list item), it doesn't apply past the first
3375 headline encountered.
3377 Optional argument MINLEVEL, when non-nil, is an integer
3378 specifying the level that any top-level headline in the included
3379 file should have.
3380 Optional argument ID is an integer that will be inserted before
3381 each footnote definition and reference if FILE is an Org file.
3382 This is useful to avoid conflicts when more than one Org file
3383 with footnotes is included in a document.
3385 Optional argument FOOTNOTES is a hash-table to store footnotes in
3386 the included document.
3387 "
3403 ;; Remove blank lines at beginning and end of contents. The logic
3404 ;; behind that removal is that blank lines around include keyword
3405 ;; override blank lines in included file.
3414 ;; If IND is set, preserve indentation of include keyword until
3415 ;; the first headline encountered.
3422 ;; Do not move footnote definitions out of column 0.
3428 ;; When MINLEVEL is specified, compute minimal level for headlines
3429 ;; in the file (CUR-MIN), and remove stars to each headline so
3430 ;; that headlines with minimal level have a level of MINLEVEL.
3441 ;; Only change stars, don't bother moving whole
3442 ;; sections.
3446 ;; Append ID to all footnote references and definitions, so they
3447 ;; become file specific and cannot collide with footnotes in other
3448 ;; included files. Further, collect relevant footnotes outside of
3449 ;; LINES.
3460 ;; Update the footnote-reference at point and collect
3461 ;; the new label, which is only used for footnotes
3462 ;; outsides LINES.
3464 ;; If label is akin to [1] convert it to [fn:ID-1].
3465 ;; Otherwise add "ID-" after "fn:".
3468 digit-label id)))
3475 "Definition not found for footnote %s in file %s"
3476 label file))
3479 ;; Store since footnote-definition is
3480 ;; outside of LINES.
3484 footnotes)
3485 ;; Update label of definition since it is
3486 ;; included directly.
3488 beginning digit-label id)))))))))))
3494 "Execute every Babel code in the visible part of current buffer."
3495 ;; Get a pristine copy of current buffer so Babel references can be
3496 ;; properly resolved.
3502 "Return a non-nil value when output should be added to the kill ring.
3503 See also `org-export-copy-to-kill-ring'."
3509 \f
3510 ;;; Tools For Back-Ends
3511 ;;
3512 ;; A whole set of tools is available to help build new exporters. Any
3513 ;; function general enough to have its use across many back-ends
3514 ;; should be added here.
3516 ;;;; For Affiliated Keywords
3517 ;;
3518 ;; `org-export-read-attribute' reads a property from a given element
3519 ;; as a plist. It can be used to normalize affiliated keywords'
3520 ;; syntax.
3521 ;;
3522 ;; Since captions can span over multiple lines and accept dual values,
3523 ;; their internal representation is a bit tricky. Therefore,
3524 ;; `org-export-get-caption' transparently returns a given element's
3525 ;; caption as a secondary string.
3528 "Turn ATTRIBUTE property from ELEMENT into a plist.
3530 When optional argument PROPERTY is non-nil, return the value of
3531 that property within attributes.
3535 properties.
3537 All values will become strings except the empty string and
3540 will become the empty string."
3554 s)
3559 ;; Ignore any string before first property with `cdr'.
3564 "Return caption from ELEMENT as a secondary string.
3566 When optional argument SHORTP is non-nil, return short caption,
3567 as a secondary string, instead.
3569 Caption lines are separated by a white space."
3577 ;;;; For Derived Back-ends
3578 ;;
3579 ;; `org-export-with-backend' is a function allowing to locally use
3580 ;; another back-end to transcode some object or element. In a derived
3581 ;; back-end, it may be used as a fall-back function once all specific
3582 ;; cases have been treated.
3585 "Call a transcoder from BACKEND on DATA.
3586 BACKEND is an export back-end, as returned by, e.g.,
3587 `org-export-create-backend', or a symbol referring to
3588 a registered back-end. DATA is an Org element, object, secondary
3589 string or string. CONTENTS, when non-nil, is the transcoded
3590 contents of DATA element, as a string. INFO, when non-nil, is
3591 the communication channel used for export, as a plist."
3601 transcoder data contents
3604 :back-end backend
3605 :translate-alist all-transcoders
3609 ;;;; For Export Snippets
3610 ;;
3611 ;; Every export snippet is transmitted to the back-end. Though, the
3612 ;; latter will only retain one type of export-snippet, ignoring
3613 ;; others, based on the former's target back-end. The function
3614 ;; `org-export-snippet-backend' returns that back-end for a given
3615 ;; export-snippet.
3618 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3619 Translation, with `org-export-snippet-translation-alist', is
3620 applied."
3624 back-end))))
3627 ;;;; For Footnotes
3628 ;;
3629 ;; `org-export-collect-footnote-definitions' is a tool to list
3630 ;; actually used footnotes definitions in the whole parse tree, or in
3631 ;; a headline, in order to add footnote listings throughout the
3632 ;; transcoded data.
3633 ;;
3634 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3635 ;; back-ends, when they need to attach the footnote definition only to
3636 ;; the first occurrence of the corresponding label.
3637 ;;
3638 ;; `org-export-get-footnote-definition' and
3639 ;; `org-export-get-footnote-number' provide easier access to
3640 ;; additional information relative to a footnote reference.
3643 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3644 INFO is the plist used as a communication channel. If no such
3645 definition can be found, raise an error."
3651 hash))))
3659 info t)
3660 cache)
3665 "Apply FUNCTION on every footnote reference in DATA.
3666 INFO is a plist containing export state. By default, as soon as
3667 a new footnote reference is encountered, FUNCTION is called onto
3668 its definition. However, if BODY-FIRST is non-nil, this step is
3669 delayed until the end of the process."
3675 ;; Search footnote references through DATA, filling
3676 ;; SEEN-REFS along the way. When DELAYP is non-nil, store
3677 ;; footnote definitions so they can be entered later.
3684 ;; Search for subsequent references in footnote
3685 ;; definition so numbering follows reading logic,
3686 ;; unless DELAYP in non-nil.
3690 definitions))
3691 ;; Do not force entering inline definitions,
3692 ;; since `org-element-map' already traverses them
3693 ;; at the right time.
3697 nil))))))
3698 info nil
3699 ;; Don't enter footnote definitions since it will happen
3700 ;; when their first reference is found. Moreover, if
3701 ;; DELAYP is non-nil, make sure we postpone entering
3702 ;; definitions of inline references.
3709 "Return an alist between footnote numbers, labels and definitions.
3711 INFO is the current export state, as a plist.
3713 Definitions are collected throughout the whole parse tree, or
3714 DATA when non-nil.
3716 Sorting is done by order of references. As soon as a new
3717 reference is encountered, other references are searched within
3718 its definition. However, if BODY-FIRST is non-nil, this step is
3719 delayed after the whole tree is checked. This alters results
3720 when references are found in footnote definitions.
3722 Definitions either appear as Org data or as a secondary string
3723 for inlined footnotes. Unreferenced definitions are ignored."
3727 ;; Collect footnote number, label and definition.
3738 "Non-nil when a footnote reference is the first one for its label.
3740 FOOTNOTE-REFERENCE is the footnote reference being considered.
3741 INFO is a plist containing current export state.
3743 Search is done throughout the whole parse tree, or DATA when
3744 non-nil.
3746 By default, as soon as a new footnote reference is encountered,
3747 other references are searched within its definition. However, if
3748 BODY-FIRST is non-nil, this step is delayed after the whole tree
3749 is checked. This alters results when references are found in
3750 footnote definitions."
3752 ;; Anonymous footnotes are always a first reference.
3763 "Return number associated to a footnote.
3765 FOOTNOTE is either a footnote reference or a footnote definition.
3766 INFO is the plist containing export state.
3768 Number is unique throughout the whole parse tree, or DATA, when
3769 non-nil.
3771 By default, as soon as a new footnote reference is encountered,
3772 counting process moves into its definition. However, if
3773 BODY-FIRST is non-nil, this step is delayed until the end of the
3774 process, leading to a different order when footnotes are nested."
3783 ;; Anonymous footnote match: return number.
3785 ;; Labels match: return number.
3787 ;; Otherwise store label and increase counter if label
3788 ;; wasn't encountered yet.
3794 ;;;; For Headlines
3795 ;;
3796 ;; `org-export-get-relative-level' is a shortcut to get headline
3797 ;; level, relatively to the lower headline level in the parsed tree.
3798 ;;
3799 ;; `org-export-get-headline-number' returns the section number of an
3800 ;; headline, while `org-export-number-to-roman' allows to convert it
3801 ;; to roman numbers. With an optional argument,
3802 ;; `org-export-get-headline-number' returns a number to unnumbered
3803 ;; headlines (used for internal id).
3804 ;;
3805 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3806 ;; `org-export-last-sibling-p' are three useful predicates when it
3807 ;; comes to fulfill the `:headline-levels' property.
3808 ;;
3809 ;; `org-export-get-tags', `org-export-get-category' and
3810 ;; `org-export-get-node-property' extract useful information from an
3811 ;; headline or a parent headline. They all handle inheritance.
3812 ;;
3813 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3814 ;; as a secondary string, suitable for table of contents. It falls
3815 ;; back onto default title.
3818 "Return HEADLINE relative level within current parsed tree.
3819 INFO is a plist holding contextual information."
3824 "Non-nil when HEADLINE is considered as low level.
3826 INFO is a plist used as a communication channel.
3828 A low level headlines has a relative level greater than
3829 `:headline-levels' property value.
3831 Return value is the difference between HEADLINE relative level
3832 and the last level being considered as high enough, or nil."
3839 "Return numbered HEADLINE numbering as a list of numbers.
3840 INFO is a plist holding contextual information."
3845 "Return a non-nil value if HEADLINE element should be numbered.
3846 INFO is a plist used as a communication channel."
3855 "Convert integer N into a roman numeral."
3868 res)))
3871 "Return list of tags associated to ELEMENT.
3873 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3874 is a plist used as a communication channel.
3876 Select tags (see `org-export-select-tags') and exclude tags (see
3877 `org-export-exclude-tags') are removed from the list.
3879 When non-nil, optional argument TAGS should be a list of strings.
3880 Any tag belonging to this list will also be removed.
3882 When optional argument INHERITED is non-nil, tags can also be
3883 inherited from parent headlines and FILETAGS keywords."
3889 ;; Build complete list of inherited tags.
3896 ;; Add FILETAGS keywords and return results.
3900 "Return node PROPERTY value for BLOB.
3902 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3903 element or object.
3905 If optional argument INHERITED is non-nil, the value can be
3906 inherited from a parent headline.
3908 Return value is a string or nil."
3920 "Return category for element or object BLOB.
3922 INFO is a plist used as a communication channel.
3924 CATEGORY is automatically inherited from a parent headline, from
3925 #+CATEGORY: keyword or created out of original file name. If all
3938 "Return alternative title for HEADLINE, as a secondary string.
3939 INFO is a plist used as a communication channel. If no optional
3940 title is defined, fall-back to the regular title."
3947 "Non-nil when BLOB is the first sibling in its parent.
3948 BLOB is an element or an object. If BLOB is a headline, non-nil
3949 means it is the first sibling in the sub-tree. INFO is a plist
3950 used as a communication channel."
3955 "Non-nil when BLOB is the last sibling in its parent.
3956 BLOB is an element or an object. INFO is a plist used as
3957 a communication channel."
3961 ;;;; For Keywords
3962 ;;
3963 ;; `org-export-get-date' returns a date appropriate for the document
3964 ;; to about to be exported. In particular, it takes care of
3965 ;; `org-export-date-timestamp-format'.
3968 "Return date value for the current document.
3970 INFO is a plist used as a communication channel. FMT, when
3971 non-nil, is a time format string that will be applied on the date
3972 if it consists in a single timestamp object. It defaults to
3973 `org-export-date-timestamp-format' when nil.
3975 A proper date can be a secondary string, a string or nil. It is
3976 meant to be translated with `org-export-data' or alike."
3987 ;;;; For Links
3988 ;;
3989 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3990 ;; with `org-add-link-type', which see.
3991 ;;
3992 ;; `org-export-get-coderef-format' returns an appropriate format
3993 ;; string for coderefs.
3994 ;;
3995 ;; `org-export-inline-image-p' returns a non-nil value when the link
3996 ;; provided should be considered as an inline image.
3997 ;;
3998 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3999 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4000 ;; returns an appropriate unique identifier when found, or nil.
4001 ;;
4002 ;; `org-export-resolve-id-link' returns the first headline with
4003 ;; specified id or custom-id in parse tree, the path to the external
4004 ;; file with the id or nil when neither was found.
4005 ;;
4006 ;; `org-export-resolve-coderef' associates a reference to a line
4007 ;; number in the element it belongs, or returns the reference itself
4008 ;; when the element isn't numbered.
4009 ;;
4010 ;; `org-export-file-uri' expands a filename as stored in :path value
4011 ;; of a "file" link into a file URI.
4014 "Try exporting LINK with a dedicated function.
4016 DESC is its description, as a string, or nil. BACKEND is the
4017 back-end used for export, as a symbol.
4019 Return output as a string, or nil if no protocol handles LINK.
4021 A custom protocol has precedence over regular back-end export.
4022 The function ignores links with an implicit type (e.g.,
4031 desc
4032 backend))))))
4035 "Return format string for code reference link.
4036 PATH is the link path. DESC is its description."
4044 "Non-nil if LINK object points to an inline image.
4046 Optional argument is a set of RULES defining inline images. It
4047 is an alist where associations have the following shape:
4049 \(TYPE . REGEXP)
4051 Applying a rule means apply REGEXP against LINK's path when its
4052 type is TYPE. The function will return a non-nil value if any of
4053 the provided rules is non-nil. The default rule is
4054 `org-export-default-inline-image-rule'.
4056 This only applies to links without a description."
4067 "Resolve a code reference REF.
4069 INFO is a plist used as a communication channel.
4071 Return associated line number in source code, or REF itself,
4072 depending on src-block or example element's switches. Throw an
4073 error if no block contains REF."
4080 org-coderef-label-format)))
4084 ;; Element containing REF is found. Resolve it to
4085 ;; either a label or a line number, as needed.
4096 "Return LINK destination.
4098 INFO is a plist holding contextual information.
4100 Return value can be an object, an element, or nil:
4102 - If LINK path matches a target object (i.e. <<path>>) return it.
4104 - If LINK path exactly matches the name affiliated keyword
4105 \(i.e. #+NAME: path) of an element, return that element.
4107 - If LINK path exactly matches any headline name, return that
4108 element.
4110 - Otherwise, throw an error.
4113 significant."
4116 ;; Split PATH at white spaces so matches are space
4117 ;; insensitive.
4123 :resolve-fuzzy-link-cache
4130 path
4132 ;; First try to find a matching "<<path>>" unless user
4133 ;; specified he was looking for a headline (path starts with
4134 ;; a "*" character).
4140 path)
4141 datum))
4143 ;; Then try to find an element with a matching "#+NAME: path"
4144 ;; affiliated keyword.
4151 ;; Try to find a matching headline.
4158 path)
4159 h))
4162 link-cache)))))
4165 "Return headline referenced as LINK destination.
4167 INFO is a plist used as a communication channel.
4169 Return value can be the headline element matched in current parse
4173 ;; First check if id is within the current parse tree.
4178 headline))
4180 ;; Otherwise, look for external files.
4185 "Return radio-target object referenced as LINK destination.
4187 INFO is a plist used as a communication channel.
4189 Return value can be a radio-target object or nil. Assume LINK
4198 nil nil path nil nil t)
4199 t)
4200 radio))
4204 "Return file URI associated to FILENAME."
4210 filename))))
4213 ;;;; For References
4214 ;;
4215 ;; `org-export-get-reference' associate a unique reference for any
4216 ;; object or element.
4217 ;;
4218 ;; `org-export-get-ordinal' associates a sequence number to any object
4219 ;; or element.
4222 "Return a unique reference for DATUM, as a string.
4223 DATUM is either an element or an object. INFO is the current
4224 export state, as a plist. Returned reference consists of
4225 alphanumeric characters only."
4230 h))))
4238 cache))))
4241 "Return ordinal number of an element or object.
4243 ELEMENT is the element or object considered. INFO is the plist
4244 used as a communication channel.
4246 Optional argument TYPES, when non-nil, is a list of element or
4247 object types, as symbols, that should also be counted in.
4248 Otherwise, only provided element's type is considered.
4250 Optional argument PREDICATE is a function returning a non-nil
4251 value if the current element or object should be counted in. It
4252 accepts two arguments: the element or object being considered and
4253 the plist used as a communication channel. This allows to count
4254 only a certain type of objects (i.e. inline images).
4256 Return value is a list of numbers if ELEMENT is a headline or an
4257 item. It is nil for keywords. It represents the footnote number
4258 for footnote definitions and footnote references. If ELEMENT is
4259 a target, return the same value as if ELEMENT was the closest
4260 table, item or headline containing the target. In any other
4261 case, return the sequence number of ELEMENT among elements or
4262 objects of the same type."
4263 ;; Ordinal of a target object refer to the ordinal of the closest
4264 ;; table, item, or headline containing the object.
4268 element
4271 ;; Special case 1: A headline returns its number as a list.
4273 ;; Special case 2: An item returns its number as a list.
4277 struct
4284 ;; Increment counter until ELEMENT is found again.
4295 ;;;; For Src-Blocks
4296 ;;
4297 ;; `org-export-get-loc' counts number of code lines accumulated in
4298 ;; src-block or example-block elements with a "+n" switch until
4299 ;; a given element, excluded. Note: "-n" switches reset that count.
4300 ;;
4301 ;; `org-export-unravel-code' extracts source code (along with a code
4302 ;; references alist) from an `element-block' or `src-block' type
4303 ;; element.
4304 ;;
4305 ;; `org-export-format-code' applies a formatting function to each line
4306 ;; of code, providing relative line number and code reference when
4307 ;; appropriate. Since it doesn't access the original element from
4308 ;; which the source code is coming, it expects from the code calling
4309 ;; it to know if lines should be numbered and if code references
4310 ;; should appear.
4311 ;;
4312 ;; Eventually, `org-export-format-code-default' is a higher-level
4313 ;; function (it makes use of the two previous functions) which handles
4314 ;; line numbering and code references inclusion, and returns source
4315 ;; code in a format suitable for plain text or verbatim output.
4318 "Return accumulated lines of code up to ELEMENT.
4320 INFO is the plist used as a communication channel.
4322 ELEMENT is excluded from count."
4328 ;; ELEMENT is reached: Quit the loop.
4330 ;; Only count lines from src-block and example-block elements
4331 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4335 ;; Accumulate locs or reset them.
4339 ;; Return nil to stay in the loop.
4340 nil)))
4342 ;; Return value.
4343 loc))
4346 "Clean source code and extract references out of it.
4348 ELEMENT has either a `src-block' an `example-block' type.
4350 Return a cons cell whose CAR is the source code, cleaned from any
4351 reference, protective commas and spurious indentation, and CDR is
4352 an alist between relative line number (integer) and name of code
4353 reference on that line (string)."
4356 ;; Get code and clean it. Remove blank lines at its
4357 ;; beginning and end.
4364 value
4366 ;; Get format used for references.
4369 org-coderef-label-format)))
4370 ;; Build a regexp matching a loc with a reference.
4375 ;; Return value.
4377 ;; Code with references removed.
4383 ;; Ref line: remove ref, and signal its position in REFS.
4387 ;; Reference alist.
4388 refs)))
4391 "Format CODE by applying FUN line-wise and return it.
4393 CODE is a string representing the code to format. FUN is
4394 a function. It must accept three arguments: a line of
4395 code (string), the current line number (integer) or nil and the
4396 reference associated to the current line (string) or nil.
4398 Optional argument NUM-LINES can be an integer representing the
4399 number of code lines accumulated until the current code. Line
4400 numbers passed to FUN will take it into account. If it is nil,
4401 FUN's second argument will always be nil. This number can be
4402 obtained with `org-export-get-loc' function.
4404 Optional argument REF-ALIST can be an alist between relative line
4405 number (i.e. ignoring NUM-LINES) and the name of the code
4406 reference on it. If it is nil, FUN's third argument will always
4407 be nil. It can be obtained through the use of
4408 `org-export-unravel-code' function."
4420 "Return source code from ELEMENT, formatted in a standard way.
4422 ELEMENT is either a `src-block' or `example-block' element. INFO
4423 is a plist used as a communication channel.
4425 This function takes care of line numbering and code references
4426 inclusion. Line numbers, when applicable, appear at the
4427 beginning of the line, separated from the code by two white
4428 spaces. Code references, on the other hand, appear flushed to
4429 the right, separated by six white spaces from the widest line of
4430 code."
4431 ;; Extract code and references.
4438 ;; Handle line numbering.
4447 ;; Prepare references display, if required. Any reference
4448 ;; should start six columns after the widest line of code,
4449 ;; wrapped with parenthesis.
4454 code
4458 number-str
4459 loc
4465 num-start refs)))))
4468 ;;;; For Tables
4469 ;;
4470 ;; `org-export-table-has-special-column-p' and and
4471 ;; `org-export-table-row-is-special-p' are predicates used to look for
4472 ;; meta-information about the table structure.
4473 ;;
4474 ;; `org-table-has-header-p' tells when the rows before the first rule
4475 ;; should be considered as table's header.
4476 ;;
4477 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4478 ;; and `org-export-table-cell-borders' extract information from
4479 ;; a table-cell element.
4480 ;;
4481 ;; `org-export-table-dimensions' gives the number on rows and columns
4482 ;; in the table, ignoring horizontal rules and special columns.
4483 ;; `org-export-table-cell-address', given a table-cell object, returns
4484 ;; the absolute address of a cell. On the other hand,
4485 ;; `org-export-get-table-cell-at' does the contrary.
4486 ;;
4487 ;; `org-export-table-cell-starts-colgroup-p',
4488 ;; `org-export-table-cell-ends-colgroup-p',
4489 ;; `org-export-table-row-starts-rowgroup-p',
4490 ;; `org-export-table-row-ends-rowgroup-p',
4491 ;; `org-export-table-row-starts-header-p',
4492 ;; `org-export-table-row-ends-header-p' and
4493 ;; `org-export-table-row-in-header-p' indicate position of current row
4494 ;; or cell within the table.
4497 "Non-nil when TABLE has a special column.
4498 All special columns will be ignored during export."
4499 ;; The table has a special column when every first cell of every row
4500 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4501 ;; "*" "_" and "^". Though, do not consider a first row containing
4502 ;; only empty cells as special.
4518 "Non-nil when TABLE has a header.
4520 INFO is a plist used as a communication channel.
4522 A table has a header when it contains at least two row groups."
4531 table
4542 cache)))))
4545 "Non-nil if TABLE-ROW is considered special.
4547 INFO is a plist used as the communication channel.
4549 All special rows will be ignored during export."
4553 ;; A row is special either when...
4555 ;; ... it starts with a field only containing "/",
4557 ;; ... the table contains a special column and the row start
4558 ;; with a marking character among, "^", "_", "$" or "!",
4562 ;; ... it contains only alignment cookies and empty cells.
4568 ;; Since VALUE is a secondary string, the following
4569 ;; checks avoid expanding it with `org-export-data'.
4581 "Return TABLE-ROW's group number, as an integer.
4583 INFO is a plist used as the communication channel.
4585 Return value is the group number, as an integer, or nil for
4586 special rows and rows separators. First group is also table's
4587 header."
4605 "Return TABLE-CELL contents width.
4607 INFO is a plist used as the communication channel.
4609 Return value is the width given by the last width cookie in the
4610 same column as TABLE-CELL, or nil."
4629 ;; In a special row, try to find a width cookie at COLUMN.
4633 ;; The following checks avoid expanding unnecessarily
4634 ;; the cell with `org-export-data'.
4644 "Return TABLE-CELL contents alignment.
4646 INFO is a plist used as the communication channel.
4648 Return alignment as specified by the last alignment cookie in the
4649 same column as TABLE-CELL. If no such cookie is found, a default
4650 alignment value will be deduced from fraction of numbers in the
4651 column (see `org-table-number-fraction' for more information).
4652 Possible values are `left', `right' and `center'."
4653 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4670 cookie-align
4671 previous-cell-number-p)
4674 ;; In a special row, try to find an alignment cookie at
4675 ;; COLUMN.
4679 ;; Since VALUE is a secondary string, the following
4680 ;; checks avoid useless expansion through
4681 ;; `org-export-data'.
4689 ;; Ignore table rules.
4691 ;; In a standard row, check if cell's contents are
4692 ;; expressing some kind of number. Increase NUMBER-CELLS
4693 ;; accordingly. Though, don't bother if an alignment
4694 ;; cookie has already defined cell's alignment.
4699 info)))
4701 ;; Treat an empty cell as a number if it follows
4702 ;; a number.
4708 ;; Return value. Alignment specified by cookies has
4709 ;; precedence over alignment deduced from cell's contents.
4711 column
4716 org-table-number-fraction)
4721 "Return TABLE-CELL borders.
4723 INFO is a plist used as a communication channel.
4725 Return value is a list of symbols, or nil. Possible values are:
4726 `top', `bottom', `above', `below', `left' and `right'. Note:
4727 `top' (resp. `bottom') only happen for a cell in the first
4728 row (resp. last row) of the table, ignoring table rules, if any.
4730 Returned borders ignore special rows."
4733 borders)
4734 ;; Top/above border? TABLE-CELL has a border above when a rule
4735 ;; used to demarcate row groups can be found above. Hence,
4736 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4737 ;; another regular row has to be found above that rule.
4746 ;; Look at every row before the current one.
4748 ;; No rule above, or rule found starts the table (ignoring any
4749 ;; special row): TABLE-CELL is at the top of the table.
4752 ;; Bottom/below border? TABLE-CELL has a border below when next
4753 ;; non-regular row below is a rule.
4762 ;; Look at every row after the current one.
4764 ;; No rule below, or rule found ends the table (modulo some
4765 ;; special row): TABLE-CELL is at the bottom of the table.
4768 ;; Right/left borders? They can only be specified by column
4769 ;; groups. Column groups are defined in a row starting with "/".
4770 ;; Also a column groups row only contains "<", "<>", ">" or blank
4771 ;; cells.
4788 ;; There's a left border when previous cell, if
4789 ;; any, ends a group, or current one starts one.
4795 ;; There's a right border when next cell, if any,
4796 ;; starts a group, or current one ends one.
4803 ;; Table rows are read in reverse order so last column groups
4804 ;; row has precedence over any previous one.
4806 ;; Return value.
4807 borders))
4810 "Non-nil when TABLE-CELL is at the beginning of a column group.
4811 INFO is a plist used as a communication channel."
4812 ;; A cell starts a column group either when it is at the beginning
4813 ;; of a row (or after the special column, if any) or when it has
4814 ;; a left border.
4817 table-cell)
4821 "Non-nil when TABLE-CELL is at the end of a column group.
4822 INFO is a plist used as a communication channel."
4823 ;; A cell ends a column group either when it is at the end of a row
4824 ;; or when it has a right border.
4827 table-cell)
4831 "Non-nil when TABLE-ROW is at the beginning of a row group.
4832 INFO is a plist used as a communication channel."
4840 "Non-nil when TABLE-ROW is at the end of a row group.
4841 INFO is a plist used as a communication channel."
4849 "Non-nil when TABLE-ROW is located within table's header.
4850 INFO is a plist used as a communication channel. Always return
4851 nil for special rows and rows separators."
4857 "Non-nil when TABLE-ROW is the first table header's row.
4858 INFO is a plist used as a communication channel."
4863 "Non-nil when TABLE-ROW is the last table header's row.
4864 INFO is a plist used as a communication channel."
4869 "Return TABLE-ROW number.
4870 INFO is a plist used as a communication channel. Return value is
4871 zero-based and ignores separators. The function returns nil for
4872 special columns and separators."
4884 "Return TABLE dimensions.
4886 INFO is a plist used as a communication channel.
4888 Return value is a CONS like (ROWS . COLUMNS) where
4889 ROWS (resp. COLUMNS) is the number of exportable
4890 rows (resp. columns)."
4892 ;; Set number of rows, and extract first one.
4898 ;; Set number of columns.
4900 ;; Return value.
4904 "Return address of a regular TABLE-CELL object.
4906 TABLE-CELL is the cell considered. INFO is a plist used as
4907 a communication channel.
4909 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4910 zero-based index. Only exportable cells are considered. The
4911 function returns nil for other cells."
4923 "Return regular table-cell object at ADDRESS in TABLE.
4925 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4926 zero-based index. TABLE is a table type element. INFO is
4927 a plist used as a communication channel.
4929 If no table-cell, among exportable cells, is found at ADDRESS,
4930 return nil."
4933 ;; Row at (car address) or nil.
4941 'table-cell
4948 ;;;; For Tables Of Contents
4949 ;;
4950 ;; `org-export-collect-headlines' builds a list of all exportable
4951 ;; headline elements, maybe limited to a certain depth. One can then
4952 ;; easily parse it and transcode it.
4953 ;;
4954 ;; Building lists of tables, figures or listings is quite similar.
4955 ;; Once the generic function `org-export-collect-elements' is defined,
4956 ;; `org-export-collect-tables', `org-export-collect-figures' and
4957 ;; `org-export-collect-listings' can be derived from it.
4960 "Collect headlines in order to build a table of contents.
4962 INFO is a plist used as a communication channel.
4964 When optional argument N is an integer, it specifies the depth of
4965 the table of contents. Otherwise, it is set to the value of the
4966 last headline level. See `org-export-headline-levels' for more
4967 information.
4969 Optional argument SCOPE, when non-nil, is an element. If it is
4970 a headline, only children of SCOPE are collected. Otherwise,
4971 collect children of the headline containing provided element. If
4972 there is no such headline, collect all headlines. In any case,
4973 argument N becomes relative to the level of that headline.
4975 Return a list of all exportable headlines as parsed elements.
4976 Footnote sections are ignored."
4985 limit))))
4991 info)))
4994 "Collect referenceable elements of a determined type.
4996 TYPE can be a symbol or a list of symbols specifying element
4997 types to search. Only elements with a caption are collected.
4999 INFO is a plist used as a communication channel.
5001 When non-nil, optional argument PREDICATE is a function accepting
5002 one argument, an element of type TYPE. It returns a non-nil
5003 value when that element should be collected.
5005 Return a list of all elements found, in order of appearance."
5010 element))
5011 info))
5014 "Build a list of tables.
5015 INFO is a plist used as a communication channel.
5017 Return a list of table elements with a caption."
5021 "Build a list of figures.
5023 INFO is a plist used as a communication channel. PREDICATE is
5024 a function which accepts one argument: a paragraph element and
5025 whose return value is non-nil when that element should be
5026 collected.
5028 A figure is a paragraph type element, with a caption, verifying
5030 a vague concept that may depend on back-end.
5032 Return a list of elements recognized as figures."
5036 "Build a list of src blocks.
5038 INFO is a plist used as a communication channel.
5040 Return a list of src-block elements with a caption."
5044 ;;;; Smart Quotes
5045 ;;
5046 ;; The main function for the smart quotes sub-system is
5047 ;; `org-export-activate-smart-quotes', which replaces every quote in
5048 ;; a given string from the parse tree with its "smart" counterpart.
5049 ;;
5050 ;; Dictionary for smart quotes is stored in
5051 ;; `org-export-smart-quotes-alist'.
5052 ;;
5053 ;; Internally, regexps matching potential smart quotes (checks at
5054 ;; string boundaries are also necessary) are defined in
5055 ;; `org-export-smart-quotes-regexps'.
5059 ;; one may use: »...«, "...", ›...‹, or '...'.
5060 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5061 ;; LaTeX quotes require Babel!
5106 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5115 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5124 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5133 ;; 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
5134 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5145 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5151 )
5152 "Smart quotes translations.
5154 Alist whose CAR is a language string and CDR is an alist with
5155 quote type as key and a plist associating various encodings to
5156 their translation as value.
5158 A quote type can be any symbol among `opening-double-quote',
5159 `closing-double-quote', `opening-single-quote',
5160 `closing-single-quote' and `apostrophe'.
5162 Valid encodings include `:utf-8', `:html', `:latex' and
5163 `:texinfo'.
5168 "Return smart quote status at the beginning of string S.
5169 INFO is the current export state, as a plist."
5174 table)))
5189 ;; Not already in a level 1 quote: this is an
5190 ;; apostrophe.
5192 ;; Apostrophe.
5194 ;; Apostrophe at the beginning of a string. Check
5195 ;; white space at the end of the last object.
5204 ;; Apostrophe at the end of a string. Check white
5205 ;; space at the beginning of the next object, which
5206 ;; can only happen if that object is a string.
5213 ;; Lonesome apostrophe. Check white space around
5214 ;; both ends.
5226 n))))))))
5228 ;; Else, consider it as a level 2 quote.
5232 current-status))
5235 info nil org-element-recursive-objects)
5242 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5243 `:utf-8'. INFO is a plist used as a communication channel.
5245 The function has to retrieve information about string
5246 surroundings in parse tree. It can only happen with an
5247 unmodified string. Thus, if S has already been through another
5248 process, a non-nil ORIGINAL optional argument will provide that
5249 original string.
5251 Return the new string."
5260 org-export-smart-quotes-alist))))
5261 encoding)
5262 match))
5263 s nil t)))
5265 ;;;; Topology
5266 ;;
5267 ;; Here are various functions to retrieve information about the
5268 ;; neighborhood of a given element or object. Neighbors of interest
5269 ;; are direct parent (`org-export-get-parent'), parent headline
5270 ;; (`org-export-get-parent-headline'), first element containing an
5271 ;; object, (`org-export-get-parent-element'), parent table
5272 ;; (`org-export-get-parent-table'), previous element or object
5273 ;; (`org-export-get-previous-element') and next element or object
5274 ;; (`org-export-get-next-element').
5276 ;; defsubst org-export-get-parent must be defined before first use
5282 "Return BLOB parent headline or nil.
5283 BLOB is the element or object being considered."
5287 "Return first element containing OBJECT or nil.
5288 OBJECT is the object to consider."
5292 "Return OBJECT parent table or nil.
5293 OBJECT is either a `table-cell' or `table-element' type object."
5297 "Return previous element or object.
5299 BLOB is an element or object. INFO is a plist used as
5300 a communication channel. Return previous exportable element or
5301 object, a string, or nil.
5303 When optional argument N is a positive integer, return a list
5304 containing up to N siblings before BLOB, from farthest to
5305 closest. With any other non-nil value, return a list containing
5306 all of them."
5312 prev)
5322 "Return next element or object.
5324 BLOB is an element or object. INFO is a plist used as
5325 a communication channel. Return next exportable element or
5326 object, a string, or nil.
5328 When optional argument N is a positive integer, return a list
5329 containing up to N siblings after BLOB, from closest to farthest.
5330 With any other non-nil value, return a list containing all of
5331 them."
5338 next)
5348 ;;;; Translation
5349 ;;
5350 ;; `org-export-translate' translates a string according to the language
5351 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5352 ;; the dictionary used for the translation.
5384 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5394 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5400 ("ru" :html "(Продолжение следует)"
5474 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5497 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5503 ("ru" :html "Список распечаток"
5517 ("ru" :html "Список таблиц"
5623 ("ru" :html "Неизвестная ссылка"
5626 "Dictionary for export engine.
5628 Alist whose car is the string to translate and cdr is an alist
5629 whose car is the language string and cdr is a plist whose
5630 properties are possible charsets and values translated terms.
5632 It is used as a database for `org-export-translate'. Since this
5633 function returns the string as-is if no translation was found,
5634 the variable only needs to record values different from the
5638 "Translate string S according to language specification.
5640 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5641 and `:utf-8'. INFO is a plist used as a communication channel.
5643 Translation depends on `:language' property. Return the
5644 translated string. If no translation is found, try to fall back
5645 to `:default' encoding. If it fails, return S."
5651 s)))
5654 \f
5655 ;;; Asynchronous Export
5656 ;;
5657 ;; `org-export-async-start' is the entry point for asynchronous
5658 ;; export. It recreates current buffer (including visibility,
5659 ;; narrowing and visited file) in an external Emacs process, and
5660 ;; evaluates a command there. It then applies a function on the
5661 ;; returned results in the current process.
5662 ;;
5663 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5664 ;; allow to export to a buffer or a file, asynchronously or not.
5665 ;;
5666 ;; `org-export-output-file-name' is an auxiliary function meant to be
5667 ;; used with `org-export-to-file'. With a given extension, it tries
5668 ;; to provide a canonical file name to write export output to.
5669 ;;
5670 ;; Asynchronously generated results are never displayed directly.
5671 ;; Instead, they are stored in `org-export-stack-contents'. They can
5672 ;; then be retrieved by calling `org-export-stack'.
5673 ;;
5674 ;; Export Stack is viewed through a dedicated major mode
5675 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5676 ;;`org-export-stack-delete', `org-export-stack-view' and
5677 ;;`org-export-stack-clear'.
5678 ;;
5679 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5680 ;; It should be used whenever `org-export-async-start' is called.
5683 "Call function FUN on the results returned by BODY evaluation.
5685 FUN is an anonymous function of one argument. BODY evaluation
5686 happens in an asynchronous process, from a buffer which is an
5687 exact copy of the current one.
5689 Use `org-export-add-to-stack' in FUN in order to register results
5690 in the stack.
5692 This is a low level function. See also `org-export-to-buffer'
5693 and `org-export-to-file' for more specialized functions."
5696 ;; Write the full sexp evaluating BODY in a copy of the current
5697 ;; buffer to a temporary file, as it may be too long for program
5698 ;; args in `start-process'.
5705 ;; Null characters (from variable values) are inserted
5706 ;; within the file. As a consequence, coding system for
5707 ;; buffer contents will not be recognized properly. So,
5708 ;; we make sure it is the same as the one used to display
5709 ;; the original buffer.
5711 ,coding
5714 ;; Ignore `kill-emacs-hook' and code evaluation
5715 ;; queries from Babel as we need a truly
5716 ;; non-interactive process.
5718 org-babel-confirm-evaluate-answer-no t)
5719 ;; Initialize export framework.
5721 ;; Re-create current buffer there.
5724 ;; Sexp to evaluate in the buffer.
5726 ;; Start external process.
5729 (,process
5731 #'start-process
5734 ,proc-buffer
5741 ;; Register running process in stack.
5743 ;; Set-up sentinel in order to catch results.
5746 ,process
5768 ;;;###autoload
5771 &optional async subtreep visible-only body-only ext-plist
5772 post-process)
5773 "Call `org-export-as' with output to a specified buffer.
5775 BACKEND is either an export back-end, as returned by, e.g.,
5776 `org-export-create-backend', or a symbol referring to
5777 a registered back-end.
5779 BUFFER is the name of the output buffer. If it already exists,
5780 it will be erased first, otherwise, it will be created.
5782 A non-nil optional argument ASYNC means the process should happen
5783 asynchronously. The resulting buffer should then be accessible
5784 through the `org-export-stack' interface. When ASYNC is nil, the
5785 buffer is displayed if `org-export-show-temporary-export-buffer'
5786 is non-nil.
5788 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5789 EXT-PLIST are similar to those used in `org-export-as', which
5790 see.
5792 Optional argument POST-PROCESS is a function which should accept
5793 no argument. It is always called within the current process,
5794 from BUFFER, with point at its beginning. Export back-ends can
5795 use it to set a major mode there, e.g,
5797 \(defun org-latex-export-as-latex
5798 \(&optional async subtreep visible-only body-only ext-plist)
5799 \(interactive)
5801 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5803 This function returns BUFFER."
5831 buffer)))
5833 ;;;###autoload
5836 post-process)
5837 "Call `org-export-as' with output to a specified file.
5839 BACKEND is either an export back-end, as returned by, e.g.,
5840 `org-export-create-backend', or a symbol referring to
5841 a registered back-end. FILE is the name of the output file, as
5842 a string.
5844 A non-nil optional argument ASYNC means the process should happen
5845 asynchronously. The resulting buffer will then be accessible
5846 through the `org-export-stack' interface.
5848 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5849 EXT-PLIST are similar to those used in `org-export-as', which
5850 see.
5852 Optional argument POST-PROCESS is called with FILE as its
5853 argument and happens asynchronously when ASYNC is non-nil. It
5854 has to return a file name, or nil. Export back-ends can use this
5855 to send the output file through additional processing, e.g,
5857 \(defun org-latex-export-to-latex
5858 \(&optional async subtreep visible-only body-only ext-plist)
5859 \(interactive)
5861 \(org-export-to-file 'latex outfile
5862 async subtreep visible-only body-only ext-plist
5863 \(lambda (file) (org-latex-compile file)))
5865 The function returns either a file name returned by POST-PROCESS,
5866 or FILE."
5885 backend subtreep visible-only body-only ext-plist)))
5892 ;; Get proper return value.
5894 file))))))
5897 "Return output file's name according to buffer specifications.
5899 EXTENSION is a string representing the output file extension,
5900 with the leading dot.
5902 With a non-nil optional argument SUBTREEP, try to determine
5904 of subtree at point.
5906 When optional argument PUB-DIR is set, use it as the publishing
5907 directory.
5909 Return file name as a string."
5912 ;; File name may come from EXPORT_FILE_NAME subtree
5913 ;; property, assuming point is at beginning of said
5914 ;; sub-tree.
5921 ;; File name may be extracted from buffer's associated
5922 ;; file, if any.
5924 ;; Can't determine file name on our own: Ask user.
5928 "Output file: " pub-dir nil nil nil
5932 ;; Build file name. Enforce EXTENSION over whatever user
5933 ;; may have come up with. PUB-DIR, if defined, always has
5934 ;; precedence over any provided path.
5939 extension))
5942 ;; If writing to OUTPUT-FILE would overwrite original file, append
5943 ;; EXTENSION another time to final name.
5946 output-file)))
5949 "Add a new result to export stack if not present already.
5951 SOURCE is a buffer or a file name containing export results.
5952 BACKEND is a symbol representing export back-end used to generate
5953 it.
5955 Entries already pointing to SOURCE and unavailable entries are
5956 removed beforehand. Return the new stack."
5962 "Menu for asynchronous export results and running processes."
5972 "Return source from export results at point in stack."
5979 source
5980 ;; SOURCE is not consistent with current line. The stack
5981 ;; view is outdated.
5985 "Remove all entries from export stack."
5990 "Refresh the asynchronous export stack.
5991 DUMMY is ignored. Unavailable sources are removed from the list.
5992 Return the new stack."
6002 ;; Back-end.
6004 ;; Age.
6007 ;; Compute age of the results.
6009 "%4h:%.2m "
6011 ;; Source.
6016 ;; Clear stack from exited processes, dead buffers or
6017 ;; non-existent files.
6029 "Remove export results at point from stack.
6030 If optional argument SOURCE is non-nil, remove it instead."
6035 org-export-stack-contents))))
6038 "View export results at point in stack.
6039 With an optional prefix argument IN-EMACS, force viewing files
6040 within Emacs."
6054 (define-key km "p" 'previous-line)
6055 (define-key km "\C-p" 'previous-line)
6056 (define-key km "\C-?" 'previous-line)
6057 (define-key km [up] 'previous-line)
6058 (define-key km "C" 'org-export-stack-clear)
6059 (define-key km "v" 'org-export-stack-view)
6060 (define-key km (kbd "RET") 'org-export-stack-view)
6061 (define-key km "d" 'org-export-stack-remove)
6062 km)
6063 "Keymap for Org Export Stack.")
6065 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6066 "Mode for displaying asynchronous export stack.
6069 stack.
6071 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6072 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6073 stack completely.
6075 Removing entries in an Org Export Stack buffer doesn't affect
6076 files or buffers, only the display.
6079 (abbrev-mode 0)
6080 (auto-fill-mode 0)
6081 (setq buffer-read-only t
6082 buffer-undo-list t
6083 truncate-lines t
6084 header-line-format
6085 '(:eval
6086 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6087 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6088 (set (make-local-variable 'revert-buffer-function)
6089 'org-export-stack-refresh))
6092 \f
6093 ;;; The Dispatcher
6094 ;;
6095 ;; `org-export-dispatch' is the standard interactive way to start an
6096 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6097 ;; for its interface, which, in turn, delegates response to key
6098 ;; pressed to `org-export--dispatch-action'.
6100 ;;;###autoload
6101 (defun org-export-dispatch (&optional arg)
6102 "Export dispatcher for Org mode.
6104 It provides an access to common export related tasks in a buffer.
6105 Its interface comes in two flavors: standard and expert.
6107 While both share the same set of bindings, only the former
6108 displays the valid keys associations in a dedicated buffer.
6109 Scrolling (resp. line-wise motion) in this buffer is done with
6110 SPC and DEL (resp. C-n and C-p) keys.
6112 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6113 flavor or the other.
6116 of options used back then, on the current buffer.
6118 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6119 (interactive "P")
6120 (let* ((input
6121 (cond ((equal arg '(16)) '(stack))
6122 ((and arg org-export-dispatch-last-action))
6123 (t (save-window-excursion
6124 (unwind-protect
6125 (progn
6126 ;; Remember where we are
6127 (move-marker org-export-dispatch-last-position
6128 (point)
6129 (org-base-buffer (current-buffer)))
6130 ;; Get and store an export command
6131 (setq org-export-dispatch-last-action
6132 (org-export--dispatch-ui
6133 (list org-export-initial-scope
6134 (and org-export-in-background 'async))
6135 nil
6136 org-export-dispatch-use-expert-ui)))
6137 (and (get-buffer "*Org Export Dispatcher*")
6138 (kill-buffer "*Org Export Dispatcher*")))))))
6139 (action (car input))
6140 (optns (cdr input)))
6141 (unless (memq 'subtree optns)
6142 (move-marker org-export-dispatch-last-position nil))
6143 (case action
6144 ;; First handle special hard-coded actions.
6145 (template (org-export-insert-default-template nil optns))
6146 (stack (org-export-stack))
6147 (publish-current-file
6148 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6149 (publish-current-project
6150 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6151 (publish-choose-project
6152 (org-publish (assoc (org-icompleting-read
6153 "Publish project: "
6154 org-publish-project-alist nil t)
6155 org-publish-project-alist)
6156 (memq 'force optns)
6157 (memq 'async optns)))
6158 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6159 (otherwise
6160 (save-excursion
6161 (when arg
6162 ;; Repeating command, maybe move cursor to restore subtree
6163 ;; context.
6164 (if (eq (marker-buffer org-export-dispatch-last-position)
6165 (org-base-buffer (current-buffer)))
6166 (goto-char org-export-dispatch-last-position)
6167 ;; We are in a different buffer, forget position.
6168 (move-marker org-export-dispatch-last-position nil)))
6169 (funcall action
6170 ;; Return a symbol instead of a list to ease
6171 ;; asynchronous export macro use.
6172 (and (memq 'async optns) t)
6173 (and (memq 'subtree optns) t)
6174 (and (memq 'visible optns) t)
6175 (and (memq 'body optns) t)))))))
6177 (defun org-export--dispatch-ui (options first-key expertp)
6178 "Handle interface for `org-export-dispatch'.
6180 OPTIONS is a list containing current interactive options set for
6181 export. It can contain any of the following symbols:
6182 `body' toggles a body-only export
6183 `subtree' restricts export to current subtree
6184 `visible' restricts export to visible part of buffer.
6185 `force' force publishing files.
6186 `async' use asynchronous export process
6188 FIRST-KEY is the key pressed to select the first level menu. It
6189 is nil when this menu hasn't been selected yet.
6191 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6192 buffer is provided, but indications about currently active
6193 options are given in the prompt. Moreover, \[?] allows to switch
6194 back to standard interface."
6195 (let* ((fontify-key
6196 (lambda (key &optional access-key)
6197 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6198 ;; non-nil is the required first-level key to activate
6199 ;; KEY. When its value is t, activate KEY independently
6200 ;; on the first key, if any. A nil value means KEY will
6201 ;; only be activated at first level.
6202 (if (or (eq access-key t) (eq access-key first-key))
6203 (org-propertize key 'face 'org-warning)
6204 key)))
6205 (fontify-value
6206 (lambda (value)
6207 ;; Fontify VALUE string.
6208 (org-propertize value 'face 'font-lock-variable-name-face)))
6209 ;; Prepare menu entries by extracting them from registered
6210 ;; back-ends and sorting them by access key and by ordinal,
6211 ;; if any.
6212 (entries
6213 (sort (sort (delq nil
6214 (mapcar #'org-export-backend-menu
6215 org-export-registered-backends))
6216 (lambda (a b)
6217 (let ((key-a (nth 1 a))
6218 (key-b (nth 1 b)))
6219 (cond ((and (numberp key-a) (numberp key-b))
6220 (< key-a key-b))
6221 ((numberp key-b) t)))))
6222 'car-less-than-car))
6223 ;; Compute a list of allowed keys based on the first key
6224 ;; pressed, if any. Some keys
6225 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6226 ;; available.
6227 (allowed-keys
6228 (nconc (list 2 22 19 6 1)
6229 (if (not first-key) (org-uniquify (mapcar 'car entries))
6230 (let (sub-menu)
6231 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6232 (when (eq (car entry) first-key)
6233 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6234 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6235 ((not first-key) (list ?P)))
6236 (list ?& ?#)
6237 (when expertp (list ??))
6238 (list ?q)))
6239 ;; Build the help menu for standard UI.
6240 (help
6241 (unless expertp
6242 (concat
6243 ;; Options are hard-coded.
6244 (format "[%s] Body only: %s [%s] Visible only: %s
6245 \[%s] Export scope: %s [%s] Force publishing: %s
6247 (funcall fontify-key "C-b" t)
6248 (funcall fontify-value
6249 (if (memq 'body options) "On " "Off"))
6250 (funcall fontify-key "C-v" t)
6251 (funcall fontify-value
6252 (if (memq 'visible options) "On " "Off"))
6253 (funcall fontify-key "C-s" t)
6254 (funcall fontify-value
6255 (if (memq 'subtree options) "Subtree" "Buffer "))
6256 (funcall fontify-key "C-f" t)
6257 (funcall fontify-value
6258 (if (memq 'force options) "On " "Off"))
6259 (funcall fontify-key "C-a" t)
6260 (funcall fontify-value
6261 (if (memq 'async options) "On " "Off")))
6262 ;; Display registered back-end entries. When a key
6263 ;; appears for the second time, do not create another
6264 ;; entry, but append its sub-menu to existing menu.
6265 (let (last-key)
6266 (mapconcat
6267 (lambda (entry)
6268 (let ((top-key (car entry)))
6269 (concat
6270 (unless (eq top-key last-key)
6271 (setq last-key top-key)
6273 (funcall fontify-key (char-to-string top-key))
6274 (nth 1 entry)))
6275 (let ((sub-menu (nth 2 entry)))
6276 (unless (functionp sub-menu)
6277 ;; Split sub-menu into two columns.
6278 (let ((index -1))
6279 (concat
6280 (mapconcat
6281 (lambda (sub-entry)
6282 (incf index)
6283 (format
6284 (if (zerop (mod index 2)) " [%s] %-26s"
6286 (funcall fontify-key
6287 (char-to-string (car sub-entry))
6288 top-key)
6289 (nth 1 sub-entry)))
6290 sub-menu "")
6292 entries ""))
6293 ;; Publishing menu is hard-coded.
6295 [%s] Current file [%s] Current project
6297 (funcall fontify-key "P")
6298 (funcall fontify-key "f" ?P)
6299 (funcall fontify-key "p" ?P)
6300 (funcall fontify-key "x" ?P)
6301 (funcall fontify-key "a" ?P))
6303 (funcall fontify-key "&" t)
6304 (funcall fontify-key "#" t))
6305 (format "[%s] %s"
6306 (funcall fontify-key "q" t)
6307 (if first-key "Main menu" "Exit")))))
6308 ;; Build prompts for both standard and expert UI.
6309 (standard-prompt (unless expertp "Export command: "))
6310 (expert-prompt
6311 (when expertp
6312 (format
6313 "Export command (C-%s%s%s%s%s) [%s]: "
6314 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6315 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6316 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6317 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6318 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6319 (mapconcat (lambda (k)
6320 ;; Strip control characters.
6321 (unless (< k 27) (char-to-string k)))
6322 allowed-keys "")))))
6323 ;; With expert UI, just read key with a fancy prompt. In standard
6324 ;; UI, display an intrusive help buffer.
6325 (if expertp
6326 (org-export--dispatch-action
6327 expert-prompt allowed-keys entries options first-key expertp)
6328 ;; At first call, create frame layout in order to display menu.
6329 (unless (get-buffer "*Org Export Dispatcher*")
6330 (delete-other-windows)
6331 (org-switch-to-buffer-other-window
6332 (get-buffer-create "*Org Export Dispatcher*"))
6333 (setq cursor-type nil
6334 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6335 ;; Make sure that invisible cursor will not highlight square
6336 ;; brackets.
6337 (set-syntax-table (copy-syntax-table))
6338 (modify-syntax-entry ?\[ "w"))
6339 ;; At this point, the buffer containing the menu exists and is
6340 ;; visible in the current window. So, refresh it.
6341 (with-current-buffer "*Org Export Dispatcher*"
6342 ;; Refresh help. Maintain display continuity by re-visiting
6343 ;; previous window position.
6344 (let ((pos (window-start)))
6345 (erase-buffer)
6346 (insert help)
6347 (set-window-start nil pos)))
6348 (org-fit-window-to-buffer)
6349 (org-export--dispatch-action
6350 standard-prompt allowed-keys entries options first-key expertp))))
6352 (defun org-export--dispatch-action
6353 (prompt allowed-keys entries options first-key expertp)
6354 "Read a character from command input and act accordingly.
6356 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6357 a list of characters available at a given step in the process.
6358 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6359 EXPERTP are the same as defined in `org-export--dispatch-ui',
6360 which see.
6362 Toggle export options when required. Otherwise, return value is
6363 a list with action as CAR and a list of interactive export
6364 options as CDR."
6365 (let (key)
6366 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6367 ;; C-p, SPC, DEL).
6368 (while (and (setq key (read-char-exclusive prompt))
6369 (not expertp)
6370 (memq key '(14 16 ?\s ?\d)))
6371 (case key
6372 (14 (if (not (pos-visible-in-window-p (point-max)))
6373 (ignore-errors (scroll-up 1))
6374 (message "End of buffer")
6375 (sit-for 1)))
6376 (16 (if (not (pos-visible-in-window-p (point-min)))
6377 (ignore-errors (scroll-down 1))
6378 (message "Beginning of buffer")
6379 (sit-for 1)))
6380 (?\s (if (not (pos-visible-in-window-p (point-max)))
6381 (scroll-up nil)
6382 (message "End of buffer")
6383 (sit-for 1)))
6384 (?\d (if (not (pos-visible-in-window-p (point-min)))
6385 (scroll-down nil)
6386 (message "Beginning of buffer")
6387 (sit-for 1)))))
6388 (cond
6389 ;; Ignore undefined associations.
6390 ((not (memq key allowed-keys))
6391 (ding)
6392 (unless expertp (message "Invalid key") (sit-for 1))
6393 (org-export--dispatch-ui options first-key expertp))
6394 ;; q key at first level aborts export. At second level, cancel
6395 ;; first key instead.
6396 ((eq key ?q) (if (not first-key) (error "Export aborted")
6397 (org-export--dispatch-ui options nil expertp)))
6398 ;; Help key: Switch back to standard interface if expert UI was
6399 ;; active.
6400 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6401 ;; Send request for template insertion along with export scope.
6402 ((eq key ?#) (cons 'template (memq 'subtree options)))
6403 ;; Switch to asynchronous export stack.
6404 ((eq key ?&) '(stack))
6405 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6406 ((memq key '(2 22 19 6 1))
6407 (org-export--dispatch-ui
6408 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6409 (6 'force) (1 'async))))
6410 (if (memq option options) (remq option options)
6411 (cons option options)))
6412 first-key expertp))
6413 ;; Action selected: Send key and options back to
6414 ;; `org-export-dispatch'.
6415 ((or first-key (functionp (nth 2 (assq key entries))))
6416 (cons (cond
6417 ((not first-key) (nth 2 (assq key entries)))
6418 ;; Publishing actions are hard-coded. Send a special
6419 ;; signal to `org-export-dispatch'.
6420 ((eq first-key ?P)
6421 (case key
6422 (?f 'publish-current-file)
6423 (?p 'publish-current-project)
6424 (?x 'publish-choose-project)
6425 (?a 'publish-all)))
6426 ;; Return first action associated to FIRST-KEY + KEY
6427 ;; path. Indeed, derived backends can share the same
6428 ;; FIRST-KEY.
6429 (t (catch 'found
6430 (mapc (lambda (entry)
6431 (let ((match (assq key (nth 2 entry))))
6432 (when match (throw 'found (nth 2 match)))))
6433 (member (assq first-key entries) entries)))))
6434 options))
6435 ;; Otherwise, enter sub-menu.
6436 (t (org-export--dispatch-ui options key expertp)))))
6440 (provide 'ox)
6442 ;; Local variables:
6443 ;; generated-autoload-file: "org-loaddefs.el"
6444 ;; End:
6446 ;;; ox.el ends here