| blob | d23623358053e8b1ac563cdd0d6e48bf9b509739 |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2015 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
90 \f
91 ;;; Internal Variables
92 ;;
93 ;; Among internal variables, the most important is
94 ;; `org-export-options-alist'. This variable define the global export
95 ;; options, shared between every exporter, and how they are acquired.
140 "Alist between export properties and ways to set them.
142 The key of the alist is the property name, and the value is a list
143 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
145 KEYWORD is a string representing a buffer keyword, or nil. Each
146 property defined this way can also be set, during subtree
147 export, through a headline property named after the keyword
149 property).
150 OPTION is a string that could be found in an #+OPTIONS: line.
151 DEFAULT is the default value for the property.
152 BEHAVIOR determines how Org should handle multiple keywords for
153 the same property. It is a symbol among:
154 nil Keep old value and discard the new one.
155 t Replace old value with the new one.
156 `space' Concatenate the values, separating them with a space.
157 `newline' Concatenate the values, separating them with
158 a newline.
159 `split' Split values at white spaces, and cons them to the
160 previous list.
161 `parse' Parse value as a list of strings and Org objects,
162 which can then be transcoded with, e.g.,
163 `org-export-data'. It implies `space' behavior.
165 Values set through KEYWORD and OPTION have precedence over
166 DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
233 "Alist between filters properties and initial values.
235 The key of each association is a property name accessible through
236 the communication channel. Its value is a configurable global
237 variable defining initial filters.
239 This list is meant to install user specified filters. Back-end
240 developers may install their own filters using
241 `org-export-define-backend'. Filters defined there will always
242 be prepended to the current list, so they always get applied
251 "Default rule for link matching an inline image.
252 This rule applies to links with no description. By default, it
253 will be considered as an inline image if it targets a local file
256 See `org-export-inline-image-p' for more information about
261 org-element--cache org-element--cache-objects org-element--cache-sync-keys
262 org-element--cache-sync-requests org-element--cache-sync-timer)
263 "List of variables not copied through upon buffer duplication.
264 Export process takes place on a copy of the original buffer.
265 When this copy is created, all Org related local variables not in
266 this list are copied to the new buffer. Variables with an
270 "Non-nil means asynchronous export process should leave data behind.
274 located in `temporary-file-directory'.
276 When non-nil, it will also set `debug-on-error' to a non-nil
280 "Record asynchronously generated export results and processes.
281 This is an alist: its CAR is the source of the
282 result (destination file or buffer for a finished process,
283 original buffer for a running one) and its CDR is a list
284 containing the back-end used, as a symbol, and either a process
285 or the time at which it finished. It is used to build the menu
289 "List of backends currently available in the exporter.
290 This variable is set with `org-export-define-backend' and
294 "Last command called from the dispatcher.
295 The value should be a list. Its CAR is the action, as a symbol,
299 "The position where the last export command was created using the dispatcher.
300 This marker will be used with `C-u C-c C-e' to make sure export repetition
303 ;; For compatibility with Org < 8
305 "Name, if any, of the back-end used during an export process.
307 Its value is a symbol such as `html', `latex', `ascii', or nil if
308 the back-end is anonymous (see `org-export-create-backend') or if
309 there is no export process in progress.
311 It can be used to teach Babel blocks how to act differently
315 \f
316 ;;; User-configurable Variables
317 ;;
318 ;; Configuration for the masses.
319 ;;
320 ;; They should never be accessed directly, as their value is to be
321 ;; stored in a property list (cf. `org-export-options-alist').
322 ;; Back-ends will read their value from there instead.
325 "Options for exporting Org mode files."
330 "General options for export engine."
335 "Whether sub-trees with the ARCHIVE tag should be exported.
337 This can have three different values:
338 nil Do not export, pretend this tree is not present.
339 t Do export the entire tree.
340 `headline' Only export the headline, but skip the tree below it.
342 This option can also be set with the OPTIONS keyword,
351 "Non-nil means insert author name into the exported file.
352 This option can also be set with the OPTIONS keyword,
358 "Non-nil means export CLOCK keywords.
359 This option can also be set with the OPTIONS keyword,
365 "Non-nil means the postamble should contain a creator sentence.
367 The sentence can be set in `org-export-creator-string', which
368 see.
370 This option can also be set with the OPTIONS keyword, e.g.,
378 "Non-nil means insert date in the exported document.
379 This option can also be set with the OPTIONS keyword,
385 "Time-stamp format string to use for DATE keyword.
387 The format string, when specified, only applies if date consists
388 in a single time-stamp. Otherwise its value will be ignored.
390 See `format-time-string' for details on how to build this
391 string."
399 emacs-version
401 "Information about the creator of the document.
402 This option can also be set on with the CREATOR keyword."
407 "Non-nil means export contents of standard drawers.
409 When t, all drawers are exported. This may also be a list of
410 drawer names to export, as strings. If that list starts with
411 `not', only drawers with such names will be ignored.
413 This variable doesn't apply to properties drawers. See
414 `org-export-with-properties' instead.
416 This option can also be set with the OPTIONS keyword,
429 :inline t
433 "Non-nil means insert author email into the exported file.
434 This option can also be set with the OPTIONS keyword,
440 "Non-nil means interpret *word*, /word/, _word_ and +word+.
442 If the export target supports emphasizing text, the word will be
443 typeset in bold, italic, with an underline or strike-through,
444 respectively.
446 This option can also be set with the OPTIONS keyword,
452 "Tags that exclude a tree from export.
454 All trees carrying any of these tags will be excluded from
455 export. This is without condition, so even subtrees inside that
456 carry one of the `org-export-select-tags' will be removed.
458 This option can also be set with the EXCLUDE_TAGS keyword."
464 This option can also be set with the OPTIONS keyword,
472 "Non-nil means Org footnotes should be exported.
473 This option can also be set with the OPTIONS keyword,
479 "Non-nil means process LaTeX environments and fragments.
481 This option can also be set with the OPTIONS line,
484 nil Ignore math snippets.
485 `verbatim' Keep everything in verbatim.
486 t Allow export of math snippets."
496 "The last level which is still exported as a headline.
498 Inferior levels will usually produce itemize or enumerate lists
499 when exported, but back-end behavior may differ.
501 This option can also be set with the OPTIONS keyword,
507 "The default language for export and clocktable translations, as a string.
508 This may have an association in
509 `org-clock-clocktable-language-setup',
510 `org-export-smart-quotes-alist' and `org-export-dictionary'.
511 This option can also be set with the LANGUAGE keyword."
516 "Non-nil means preserve all line breaks when exporting.
517 This option can also be set with the OPTIONS keyword,
523 "Non-nil means interpret entities when exporting.
526 Å.
528 For a list of supported names, see the constant `org-entities'
529 and the user option `org-entities-user'.
531 This option can also be set with the OPTIONS keyword,
537 "Non-nil means inlinetasks should be exported.
538 This option can also be set with the OPTIONS keyword,
546 "Non-nil means include planning info in export.
548 Planning info is the line containing either SCHEDULED:,
549 DEADLINE:, CLOSED: time-stamps, or a combination of them.
551 This option can also be set with the OPTIONS keyword,
559 "Non-nil means include priority cookies in export.
560 This option can also be set with the OPTIONS keyword,
566 "Non-nil means export contents of properties drawers.
568 When t, all properties are exported. This may also be a list of
569 properties to export, as strings.
571 This option can also be set with the OPTIONS keyword,
583 "Non-nil means add section numbers to headlines when exporting.
585 When set to an integer n, numbering will only happen for
586 headlines whose relative level is higher or equal to n.
588 This option can also be set with the OPTIONS keyword,
594 "Tags that select a tree for export.
596 If any such tag is found in a buffer, all trees that do not carry
597 one of these tags will be ignored during export. Inside trees
598 that are selected like this, you can still deselect a subtree by
599 tagging it with one of the `org-export-exclude-tags'.
601 This option can also be set with the SELECT_TAGS keyword."
606 "Non-nil means activate smart quotes during export.
607 This option can also be set with the OPTIONS keyword,
610 When setting this to non-nil, you need to take care of
611 using the correct Babel package when exporting to LaTeX.
612 E.g., you can load Babel for french like this:
623 When this option is turned on, these strings will be exported as:
625 Org HTML LaTeX UTF-8
626 -----+----------+--------+-------
628 -- – -- –
629 --- — --- —
632 This option can also be set with the OPTIONS keyword,
638 "Non-nil means include statistics cookies in export.
639 This option can also be set with the OPTIONS keyword,
649 If you want to control how Org displays those characters, see
650 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
651 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
652 it is not anymore.
654 When this option is turned on, you can use TeX-like syntax for
655 sub- and superscripts and see them exported correctly.
657 You can also set the option with #+OPTIONS: ^:t
660 single item - so grouping with {} is normally not needed. For
661 example, the following things will be parsed as single sub- or
662 superscripts:
664 10^24 or 10^tau several digits will be considered 1 item.
665 10^-12 or 10^-tau a leading sign with digits or a word
666 x^2-y^3 will be read as x^2 - y^3, because items are
667 terminated by almost any nonword/nondigit char.
668 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
670 Still, ambiguity is possible. So when in doubt, use {} to enclose
671 the sub/superscript. If you set this variable to the symbol `{}',
672 the braces are *required* in order to trigger interpretations as
674 frequently in plain text."
684 "Non-nil means create a table of contents in exported files.
686 The TOC contains headlines with levels up
687 to`org-export-headline-levels'. When an integer, include levels
688 up to N in the toc, this may then be different from
689 `org-export-headline-levels', but it will not be allowed to be
690 larger than the number of headline levels. When nil, no table of
691 contents is made.
693 This option can also be set with the OPTIONS keyword,
702 "Non-nil means export tables.
703 This option can also be set with the OPTIONS keyword,
711 "If nil, do not export tags, just remove them from headlines.
713 If this is the symbol `not-in-toc', tags will be removed from
714 table of contents entries, but still be shown in the headlines of
715 the document.
717 This option can also be set with the OPTIONS keyword,
726 "Non-nil means include TODO items for export.
728 This may have the following values:
729 t include tasks independent of state.
730 `todo' include only tasks that are not yet done.
731 `done' include only tasks that are already done.
732 nil ignore all tasks.
733 list of keywords include tasks with these keywords.
735 This option can also be set with the OPTIONS keyword,
747 "Non-nil means print title into the exported file.
748 This option can also be set with the OPTIONS keyword,
756 "Non-nil means insert a time stamp into the exported file.
757 The time stamp shows when the file was created. This option can
763 "Non nil means allow timestamps in export.
765 It can be set to any of the following values:
766 t export all timestamps.
767 `active' export active timestamps only.
768 `inactive' export inactive timestamps only.
769 nil do not export timestamps
771 This only applies to timestamps isolated in a paragraph
772 containing only timestamps. Other timestamps are always
773 exported.
775 This option can also be set with the OPTIONS keyword, e.g.
785 "Non-nil means include TODO keywords in export.
786 When nil, remove all these keywords from the export. This option
792 "Non-nil means BIND keywords can define local variable values.
793 This is a potential security risk, which is why the default value
794 is nil. You can also allow them through local buffer variables."
801 "Alist between export snippets back-ends and exporter back-ends.
803 This variable allows to provide shortcuts for export snippets.
807 HTML code while every other back-end will ignore it."
816 "Coding system for the exported file."
823 "Non-nil means pushing export output to the kill ring.
824 This variable is ignored during asynchronous export."
834 "The initial scope when exporting with `org-export-dispatch'.
835 This variable can be either set to `buffer' or `subtree'."
842 "Non-nil means show buffer after exporting to temp buffer.
843 When Org exports to a file, the buffer visiting that file is never
844 shown, but remains buried. However, when exporting to
845 a temporary buffer, that buffer is popped up in a second window.
846 When this variable is nil, the buffer remains buried also in
847 these cases."
852 "Non-nil means export and publishing commands will run in background.
853 Results from an asynchronous export are never displayed
861 "File used to initialize external export process.
863 Value must be either nil or an absolute file name. When nil, the
864 external process is launched like a regular Emacs session,
865 loading user's initialization file and any site specific
866 configuration. If a file is provided, it, and only it, is loaded
867 at start-up.
869 Therefore, using a specific configuration makes the process to
870 load faster and the export more portable."
879 "Non-nil means using a non-intrusive `org-export-dispatch'.
880 In that case, no help buffer is displayed. Though, an indicator
886 asynchronous). Also, \[?] allows to switch back to standard
887 mode."
894 \f
895 ;;; Defining Back-ends
896 ;;
897 ;; An export back-end is a structure with `org-export-backend' type
898 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
899 ;; and `menu' slots.
900 ;;
901 ;; At the lowest level, a back-end is created with
902 ;; `org-export-create-backend' function.
903 ;;
904 ;; A named back-end can be registered with
905 ;; `org-export-register-backend' function. A registered back-end can
906 ;; later be referred to by its name, with `org-export-get-backend'
907 ;; function. Also, such a back-end can become the parent of a derived
908 ;; back-end from which slot values will be inherited by default.
909 ;; `org-export-derived-backend-p' can check if a given back-end is
910 ;; derived from a list of back-end names.
911 ;;
912 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
913 ;; `org-export-get-all-filters' return the full alist of transcoders,
914 ;; options and filters, including those inherited from ancestors.
915 ;;
916 ;; At a higher level, `org-export-define-backend' is the standard way
917 ;; to define an export back-end. If the new back-end is similar to
918 ;; a registered back-end, `org-export-define-derived-backend' may be
919 ;; used instead.
920 ;;
921 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
922 ;; when a given back-end hasn't been registered yet.
926 name parent transcoders options filters blocks menu)
929 "Return export back-end named after NAME.
930 NAME is a symbol. Return nil if no such back-end is found."
937 "Register BACKEND as a known export back-end.
938 BACKEND is a structure with `org-export-backend' type."
939 ;; Refuse to register an unnamed back-end.
942 ;; Refuse to register a back-end with an unknown parent.
946 ;; Register dedicated export blocks in the parser.
950 ;; If a back-end with the same name as BACKEND is already
951 ;; registered, replace it with BACKEND. Otherwise, simply add
952 ;; BACKEND to the list of registered back-ends.
958 "Signal an error if BACKEND isn't defined."
963 "Non-nil if BACKEND is derived from one of BACKENDS.
964 BACKEND is an export back-end, as returned by, e.g.,
965 `org-export-create-backend', or a symbol referring to
966 a registered back-end. BACKENDS is constituted of symbols."
978 "Return full translation table for BACKEND.
980 BACKEND is an export back-end, as return by, e.g,,
981 `org-export-create-backend'. Return value is an alist where
982 keys are element or object types, as symbols, and values are
983 transcoders.
985 Unlike to `org-export-backend-transcoders', this function
986 also returns transcoders inherited from parent back-ends,
987 if any."
991 parent)
996 transcoders)))
999 "Return export options for BACKEND.
1001 BACKEND is an export back-end, as return by, e.g,,
1002 `org-export-create-backend'. See `org-export-options-alist'
1003 for the shape of the return value.
1005 Unlike to `org-export-backend-options', this function also
1006 returns options inherited from parent back-ends, if any."
1010 parent)
1014 options)))
1017 "Return complete list of filters for BACKEND.
1019 BACKEND is an export back-end, as return by, e.g,,
1020 `org-export-create-backend'. Return value is an alist where
1021 keys are symbols and values lists of functions.
1023 Unlike to `org-export-backend-filters', this function also
1024 returns filters inherited from parent back-ends, if any."
1028 parent)
1032 filters)))
1035 "Define a new back-end BACKEND.
1037 TRANSCODERS is an alist between object or element types and
1038 functions handling them.
1040 These functions should return a string without any trailing
1041 space, or nil. They must accept three arguments: the object or
1042 element itself, its contents or nil when it isn't recursive and
1043 the property list used as a communication channel.
1045 Contents, when not nil, are stripped from any global indentation
1046 \(although the relative one is preserved). They also always end
1047 with a single newline character.
1049 If, for a given type, no function is found, that element or
1050 object type will simply be ignored, along with any blank line or
1051 white space at its end. The same will happen if the function
1052 returns the nil value. If that function returns the empty
1053 string, the type will be ignored, but the blank lines or white
1054 spaces will be kept.
1056 In addition to element and object types, one function can be
1057 associated to the `template' (or `inner-template') symbol and
1058 another one to the `plain-text' symbol.
1060 The former returns the final transcoded string, and can be used
1061 to add a preamble and a postamble to document's body. It must
1062 accept two arguments: the transcoded string and the property list
1063 containing export options. A function associated to `template'
1065 A function associated to `inner-template' is always applied.
1067 The latter, when defined, is to be called on every text not
1068 recognized as an element or an object. It must accept two
1069 arguments: the text string and the information channel. It is an
1070 appropriate place to protect special chars relative to the
1071 back-end.
1073 BODY can start with pre-defined keyword arguments. The following
1074 keywords are understood:
1076 :export-block
1078 String, or list of strings, representing block names that
1079 will not be parsed. This is used to specify blocks that will
1080 contain raw code specific to the back-end. These blocks
1081 still have to be handled by the relative `export-block' type
1082 translator.
1084 :filters-alist
1086 Alist between filters and function, or list of functions,
1087 specific to the back-end. See `org-export-filters-alist' for
1088 a list of all allowed filters. Filters defined here
1089 shouldn't make a back-end test, as it may prevent back-ends
1090 derived from this one to behave properly.
1092 :menu-entry
1094 Menu entry for the export dispatcher. It should be a list
1095 like:
1097 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1099 where :
1101 KEY is a free character selecting the back-end.
1103 DESCRIPTION-OR-ORDINAL is either a string or a number.
1105 If it is a string, is will be used to name the back-end in
1106 its menu entry. If it is a number, the following menu will
1107 be displayed as a sub-menu of the back-end with the same
1108 KEY. Also, the number will be used to determine in which
1109 order such sub-menus will appear (lowest first).
1111 ACTION-OR-MENU is either a function or an alist.
1113 If it is an action, it will be called with four
1114 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1115 BODY-ONLY. See `org-export-as' for further explanations on
1116 some of them.
1118 If it is an alist, associations should follow the
1119 pattern:
1121 '(KEY DESCRIPTION ACTION)
1123 where KEY, DESCRIPTION and ACTION are described above.
1125 Valid values include:
1129 or
1134 \(lambda (a s v b)
1135 \(if a (org-latex-export-to-pdf t s v b)
1136 \(org-open-file
1137 \(org-latex-export-to-pdf nil s v b)))))))
1139 or the following, which will be added to the previous
1140 sub-menu,
1142 '(?l 1
1146 :options-alist
1148 Alist between back-end specific properties introduced in
1149 communication channel and how their value are acquired. See
1150 `org-export-options-alist' for more information about
1151 structure of the values."
1166 :transcoders transcoders
1167 :options options
1168 :filters filters
1169 :blocks blocks
1173 "Create a new back-end as a variant of an existing one.
1175 CHILD is the name of the derived back-end. PARENT is the name of
1176 the parent back-end.
1178 BODY can start with pre-defined keyword arguments. The following
1179 keywords are understood:
1181 :export-block
1183 String, or list of strings, representing block names that
1184 will not be parsed. This is used to specify blocks that will
1185 contain raw code specific to the back-end. These blocks
1186 still have to be handled by the relative `export-block' type
1187 translator.
1189 :filters-alist
1191 Alist of filters that will overwrite or complete filters
1192 defined in PARENT back-end. See `org-export-filters-alist'
1193 for a list of allowed filters.
1195 :menu-entry
1197 Menu entry for the export dispatcher. See
1198 `org-export-define-backend' for more information about the
1199 expected value.
1201 :options-alist
1203 Alist of back-end specific properties that will overwrite or
1204 complete those defined in PARENT back-end. Refer to
1205 `org-export-options-alist' for more information about
1206 structure of the values.
1208 :translate-alist
1210 Alist of element and object types and transcoders that will
1211 overwrite or complete transcode table from PARENT back-end.
1212 Refer to `org-export-define-backend' for detailed information
1213 about transcoders.
1216 as a variant of `latex' back-end with a custom template function:
1218 \(org-export-define-derived-backend 'my-latex 'latex
1219 :translate-alist '((template . my-latex-template-fun)))
1221 The back-end could then be called with, for example:
1239 :parent parent
1240 :transcoders transcoders
1241 :options options
1242 :filters filters
1243 :blocks blocks
1247 \f
1248 ;;; The Communication Channel
1249 ;;
1250 ;; During export process, every function has access to a number of
1251 ;; properties. They are of two types:
1252 ;;
1253 ;; 1. Environment options are collected once at the very beginning of
1254 ;; the process, out of the original buffer and configuration.
1255 ;; Collecting them is handled by `org-export-get-environment'
1256 ;; function.
1257 ;;
1258 ;; Most environment options are defined through the
1259 ;; `org-export-options-alist' variable.
1260 ;;
1261 ;; 2. Tree properties are extracted directly from the parsed tree,
1262 ;; just before export, by `org-export-collect-tree-properties'.
1264 ;;;; Environment Options
1265 ;;
1266 ;; Environment options encompass all parameters defined outside the
1267 ;; scope of the parsed data. They come from five sources, in
1268 ;; increasing precedence order:
1269 ;;
1270 ;; - Global variables,
1271 ;; - Buffer's attributes,
1272 ;; - Options keyword symbols,
1273 ;; - Buffer keywords,
1274 ;; - Subtree properties.
1275 ;;
1276 ;; The central internal function with regards to environment options
1277 ;; is `org-export-get-environment'. It updates global variables with
1278 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1279 ;; the different sources.
1280 ;;
1281 ;; The internal functions doing the retrieval are:
1282 ;; `org-export--get-global-options',
1283 ;; `org-export--get-buffer-attributes',
1284 ;; `org-export--parse-option-keyword',
1285 ;; `org-export--get-subtree-options' and
1286 ;; `org-export--get-inbuffer-options'
1287 ;;
1288 ;; Also, `org-export--list-bound-variables' collects bound variables
1289 ;; along with their value in order to set them as buffer local
1290 ;; variables later in the process.
1293 "Collect export options from the current buffer.
1295 Optional argument BACKEND is an export back-end, as returned by
1296 `org-export-create-backend'.
1298 When optional argument SUBTREEP is non-nil, assume the export is
1299 done against the current sub-tree.
1301 Third optional argument EXT-PLIST is a property list with
1302 external parameters overriding Org default settings, but still
1303 inferior to file-local settings."
1304 ;; First install #+BIND variables since these must be set before
1305 ;; global options are read.
1308 ;; Get and prioritize export options...
1310 ;; ... from global variables...
1312 ;; ... from an external property list...
1313 ext-plist
1314 ;; ... from in-buffer settings...
1316 ;; ... and from subtree, when appropriate.
1318 ;; Eventually add misc. properties.
1320 :back-end
1321 backend
1323 :id-alist
1324 ;; Collect id references.
1335 alist))))
1338 "Parse an OPTIONS line and return values as a plist.
1339 Optional argument BACKEND is an export back-end, as returned by,
1340 e.g., `org-export-create-backend'. It specifies which back-end
1341 specific items to read, if any."
1345 ;; Priority is given to back-end specific options.
1347 org-export-options-alist)))
1349 plist)
1356 plist))
1359 "Get export options in subtree at point.
1360 Optional argument BACKEND is an export back-end, as returned by,
1361 e.g., `org-export-create-backend'. It specifies back-end used
1362 for export. Return options as a plist."
1363 ;; For each buffer keyword, create a headline property setting the
1364 ;; same property in communication channel. The name for the
1365 ;; property is the keyword with "EXPORT_" appended to it.
1367 ;; Make sure point is at a heading.
1370 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1371 ;; care of them right from the start.
1374 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1375 ;; headline's title (with no todo keyword, priority cookie or
1376 ;; tag) as its fallback value.
1382 ;; Look for both general keywords and back-end specific
1383 ;; options, with priority given to the latter.
1385 org-export-options-alist)))
1386 ;; Handle other keywords. Then return PLIST.
1399 property
1408 "Return current buffer export options, as a plist.
1410 Optional argument BACKEND, when non-nil, is an export back-end,
1411 as returned by, e.g., `org-export-create-backend'. It specifies
1412 which back-end specific options should also be read in the
1413 process.
1415 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1418 ;; Priority is given to back-end specific options.
1420 org-export-options-alist))
1423 org-export-special-keywords))))
1424 plist to-parse)
1427 ;; Return all properties associated to KEYWORD.
1434 ;; Recursively read keywords in buffer. FILES is
1435 ;; a list of files read so far. PLIST is the current
1436 ;; property list obtained.
1445 ;; Options in `org-export-special-keywords'.
1450 ;; Avoid circular dependencies.
1459 plist
1461 val backend))))
1465 plist
1472 ;; Options in `org-export-options-alist'.
1475 plist
1477 plist property
1478 ;; Handle value depending on specified
1479 ;; BEHAVIOR.
1484 ;; Even if `parse' implies `space'
1485 ;; behavior, we separate line with
1486 ;; "\n" so as to preserve
1487 ;; line-breaks. However, empty
1488 ;; lines are forbidden since `parse'
1489 ;; doesn't allow more than one
1490 ;; paragraph.
1499 " "
1512 ;; Read options in the current buffer and return value.
1514 ;; Parse properties in TO-PARSE. Remove newline characters not
1515 ;; involved in line breaks to simulate `space' behavior.
1516 ;; Finally return options.
1528 "Return properties related to buffer attributes, as a plist."
1533 "Return global export options as a plist.
1534 Optional argument BACKEND, if non-nil, is an export back-end, as
1535 returned by, e.g., `org-export-create-backend'. It specifies
1536 which back-end specific export options should also be read in the
1537 process."
1539 ;; Priority is given to back-end specific options.
1541 org-export-options-alist)))
1547 plist
1548 prop
1549 ;; Evaluate default value provided.
1554 value)))))))))
1557 "Return variables bound from BIND keywords in current buffer.
1558 Also look for BIND keywords in setup files. The return value is
1559 an alist where associations are (VARIABLE-NAME VALUE)."
1563 ;; Return an alist between variable names and their
1564 ;; value. FILES is a list of setup files names read
1565 ;; so far, used to avoid circular dependencies. ALIST
1566 ;; is the alist collected so far.
1578 ;; Enter setup file.
1588 alist))))))))))
1589 alist)))))
1590 ;; Return value in appropriate order of appearance.
1593 ;; defsubst org-export-get-parent must be defined before first use,
1594 ;; was originally defined in the topology section
1597 "Return BLOB parent or nil.
1598 BLOB is the element or object considered."
1601 ;;;; Tree Properties
1602 ;;
1603 ;; Tree properties are information extracted from parse tree. They
1604 ;; are initialized at the beginning of the transcoding process by
1605 ;; `org-export-collect-tree-properties'.
1606 ;;
1607 ;; Dedicated functions focus on computing the value of specific tree
1608 ;; properties during initialization. Thus,
1609 ;; `org-export--populate-ignore-list' lists elements and objects that
1610 ;; should be skipped during export, `org-export--get-min-level' gets
1611 ;; the minimal exportable level, used as a basis to compute relative
1612 ;; level for headlines. Eventually
1613 ;; `org-export--collect-headline-numbering' builds an alist between
1614 ;; headlines and their numbering.
1617 "Extract tree properties from parse tree.
1619 DATA is the parse tree from which information is retrieved. INFO
1620 is a list holding export options.
1622 Following tree properties are set or updated:
1624 `:exported-data' Hash table used to memoize results from
1625 `org-export-data'.
1627 `:headline-offset' Offset between true level of headlines and
1628 local level. An offset of -1 means a headline
1629 of level 2 should be considered as a level
1630 1 headline in the context.
1632 `:headline-numbering' Alist of all headlines as key an the
1633 associated numbering as value.
1635 Return updated plist."
1636 ;; Install the parse tree in the communication channel.
1638 ;; Compute `:headline-offset' in order to be able to use
1639 ;; `org-export-get-relative-level'.
1642 :headline-offset
1644 ;; Properties order doesn't matter: get the rest of the tree
1645 ;; properties.
1649 info))
1652 "Return minimum exportable headline's level in DATA.
1653 DATA is parsed tree as returned by `org-element-parse-buffer'.
1654 OPTIONS is a plist holding export options."
1665 ;; If no headline was found, for the sake of consistency, set
1666 ;; minimum level to 1 nonetheless.
1670 "Return numbering of all exportable, numbered headlines in a parse tree.
1672 DATA is the parse tree. OPTIONS is the plist holding export
1673 options.
1675 Return an alist whose key is a headline and value is its
1676 associated numbering \(in the shape of a list of numbers\) or nil
1677 for a footnotes section."
1686 headline
1688 for idx from 0 to org-export-max-depth
1692 options)))
1695 "List headlines and inlinetasks with a select tag in their tree.
1696 DATA is parsed data as returned by `org-element-parse-buffer'.
1697 INFO is a plist holding export options."
1707 ;; When a select tag is found, mark full
1708 ;; genealogy and every headline within the
1709 ;; tree as acceptable.
1712 genealogy
1715 selected-trees))
1716 ;; If at a headline, continue searching in tree,
1717 ;; recursively.
1726 selected-trees))
1729 "Non-nil when element or object BLOB should be skipped during export.
1730 OPTIONS is the plist holding export options. SELECTED, when
1731 non-nil, is a list of headlines or inlinetasks belonging to
1732 a tree with a select tag."
1739 ;; If `:with-drawers' value starts with `not', ignore
1740 ;; every drawer whose name belong to that list.
1741 ;; Otherwise, ignore drawers whose name isn't in that
1742 ;; list.
1759 ;; Ignore subtrees with an exclude tag.
1762 ;; When a select tag is present in the buffer, ignore any tree
1763 ;; without it.
1765 ;; Ignore commented sub-trees.
1767 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1769 ;; Ignore tasks, if specified by `:with-tasks' property.
1781 properties-set))))))
1792 ;; `:with-timestamps' only applies to isolated timestamps
1793 ;; objects, i.e. timestamp objects in a paragraph containing only
1794 ;; timestamps and whitespaces.
1802 options t))))
1811 \f
1812 ;;; The Transcoder
1813 ;;
1814 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1815 ;; `org-element-parse-buffer') and transcodes it into a specified
1816 ;; back-end output. It takes care of filtering out elements or
1817 ;; objects according to export options and organizing the output blank
1818 ;; lines and white space are preserved. The function memoizes its
1819 ;; results, so it is cheap to call it within transcoders.
1820 ;;
1821 ;; It is possible to modify locally the back-end used by
1822 ;; `org-export-data' or even use a temporary back-end by using
1823 ;; `org-export-data-with-backend'.
1824 ;;
1825 ;; `org-export-transcoder' is an accessor returning appropriate
1826 ;; translator function for a given element or object.
1829 "Return appropriate transcoder for BLOB.
1830 INFO is a plist containing export directives."
1832 ;; Return contents only for complete parse trees.
1838 "Convert DATA into current back-end format.
1840 DATA is a parse tree, an element or an object or a secondary
1841 string. INFO is a plist holding export options.
1843 Return a string."
1848 ;; Ignored element/object.
1850 ;; Plain text.
1856 info))
1857 ;; Secondary string.
1860 ;; Element/Object without contents or, as a special
1861 ;; case, headline with archive tag and archived trees
1862 ;; restricted to title only.
1870 ;; Export snippets never return a nil value so
1871 ;; that white spaces following them are never
1872 ;; ignored.
1874 ;; Element/Object with contents.
1887 ;; Elements directly containing
1888 ;; objects must have their indentation
1889 ;; normalized first.
1891 data
1892 ;; When normalizing contents of the
1893 ;; first paragraph in an item or
1894 ;; a footnote definition, ignore
1895 ;; first line's indentation: there is
1896 ;; none and it might be misleading.
1901 data)
1908 info))))))))
1909 ;; Final result will be memoized before being returned.
1911 data
1915 ;; Append the same white space between elements or objects
1916 ;; as in the original buffer, and call appropriate filters.
1927 info)))
1928 results)))
1932 "Convert DATA into BACKEND format.
1934 DATA is an element, an object, a secondary string or a string.
1935 BACKEND is a symbol. INFO is a plist used as a communication
1936 channel.
1938 Unlike to `org-export-with-backend', this function will
1939 recursively convert DATA using BACKEND translation table."
1942 data
1943 ;; Set-up a new communication channel with translations defined in
1944 ;; BACKEND as the translate table and a new hash table for
1945 ;; memoization.
1947 info
1950 ;; Size of the hash table is reduced since this function
1951 ;; will probably be used on small trees.
1955 "Expand a parsed element or object to its original state.
1957 BLOB is either an element or an object. CONTENTS is its
1958 contents, as a string or nil.
1960 When optional argument WITH-AFFILIATED is non-nil, add affiliated
1961 keywords before output."
1966 blob contents))))
1969 \f
1970 ;;; The Filter System
1971 ;;
1972 ;; Filters allow end-users to tweak easily the transcoded output.
1973 ;; They are the functional counterpart of hooks, as every filter in
1974 ;; a set is applied to the return value of the previous one.
1975 ;;
1976 ;; Every set is back-end agnostic. Although, a filter is always
1977 ;; called, in addition to the string it applies to, with the back-end
1978 ;; used as argument, so it's easy for the end-user to add back-end
1979 ;; specific filters in the set. The communication channel, as
1980 ;; a plist, is required as the third argument.
1981 ;;
1982 ;; From the developer side, filters sets can be installed in the
1983 ;; process with the help of `org-export-define-backend', which
1984 ;; internally stores filters as an alist. Each association has a key
1985 ;; among the following symbols and a function or a list of functions
1986 ;; as value.
1987 ;;
1988 ;; - `:filter-options' applies to the property list containing export
1989 ;; options. Unlike to other filters, functions in this list accept
1990 ;; two arguments instead of three: the property list containing
1991 ;; export options and the back-end. Users can set its value through
1992 ;; `org-export-filter-options-functions' variable.
1993 ;;
1994 ;; - `:filter-parse-tree' applies directly to the complete parsed
1995 ;; tree. Users can set it through
1996 ;; `org-export-filter-parse-tree-functions' variable.
1997 ;;
1998 ;; - `:filter-body' applies to the body of the output, before template
1999 ;; translator chimes in. Users can set it through
2000 ;; `org-export-filter-body-functions' variable.
2001 ;;
2002 ;; - `:filter-final-output' applies to the final transcoded string.
2003 ;; Users can set it with `org-export-filter-final-output-functions'
2004 ;; variable.
2005 ;;
2006 ;; - `:filter-plain-text' applies to any string not recognized as Org
2007 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2008 ;; configure it.
2009 ;;
2010 ;; - `:filter-TYPE' applies on the string returned after an element or
2011 ;; object of type TYPE has been transcoded. A user can modify
2012 ;; `org-export-filter-TYPE-functions' to install these filters.
2013 ;;
2014 ;; All filters sets are applied with
2015 ;; `org-export-filter-apply-functions' function. Filters in a set are
2016 ;; applied in a LIFO fashion. It allows developers to be sure that
2017 ;; their filters will be applied first.
2018 ;;
2019 ;; Filters properties are installed in communication channel with
2020 ;; `org-export-install-filters' function.
2021 ;;
2022 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2023 ;; `org-export-before-parsing-hook') are run at the beginning of the
2024 ;; export process and just before parsing to allow for heavy structure
2025 ;; modifications.
2028 ;;;; Hooks
2031 "Hook run at the beginning of the export process.
2033 This is run before include keywords and macros are expanded and
2034 Babel code blocks executed, on a copy of the original buffer
2035 being exported. Visibility and narrowing are preserved. Point
2036 is at the beginning of the buffer.
2038 Every function in this hook will be called with one argument: the
2042 "Hook run before parsing an export buffer.
2044 This is run after include keywords and macros have been expanded
2045 and Babel code blocks executed, on a copy of the original buffer
2046 being exported. Visibility and narrowing are preserved. Point
2047 is at the beginning of the buffer.
2049 Every function in this hook will be called with one argument: the
2053 ;;;; Special Filters
2056 "List of functions applied to the export options.
2057 Each filter is called with two arguments: the export options, as
2058 a plist, and the back-end, as a symbol. It must return
2062 "List of functions applied to the parsed tree.
2063 Each filter is called with three arguments: the parse tree, as
2064 returned by `org-element-parse-buffer', the back-end, as
2065 a symbol, and the communication channel, as a plist. It must
2069 "List of functions applied to plain text.
2070 Each filter is called with three arguments: a string which
2071 contains no Org syntax, the back-end, as a symbol, and the
2072 communication channel, as a plist. It must return a string or
2076 "List of functions applied to transcoded body.
2077 Each filter is called with three arguments: a string which
2078 contains no Org syntax, the back-end, as a symbol, and the
2079 communication channel, as a plist. It must return a string or
2083 "List of functions applied to the transcoded string.
2084 Each filter is called with three arguments: the full transcoded
2085 string, the back-end, as a symbol, and the communication channel,
2086 as a plist. It must return a string that will be used as the
2090 ;;;; Elements Filters
2093 "List of functions applied to a transcoded babel-call.
2094 Each filter is called with three arguments: the transcoded data,
2095 as a string, the back-end, as a symbol, and the communication
2099 "List of functions applied to a transcoded center block.
2100 Each filter is called with three arguments: the transcoded data,
2101 as a string, the back-end, as a symbol, and the communication
2105 "List of functions applied to a transcoded clock.
2106 Each filter is called with three arguments: the transcoded data,
2107 as a string, the back-end, as a symbol, and the communication
2111 "List of functions applied to a transcoded diary-sexp.
2112 Each filter is called with three arguments: the transcoded data,
2113 as a string, the back-end, as a symbol, and the communication
2117 "List of functions applied to a transcoded drawer.
2118 Each filter is called with three arguments: the transcoded data,
2119 as a string, the back-end, as a symbol, and the communication
2123 "List of functions applied to a transcoded dynamic-block.
2124 Each filter is called with three arguments: the transcoded data,
2125 as a string, the back-end, as a symbol, and the communication
2129 "List of functions applied to a transcoded example-block.
2130 Each filter is called with three arguments: the transcoded data,
2131 as a string, the back-end, as a symbol, and the communication
2135 "List of functions applied to a transcoded export-block.
2136 Each filter is called with three arguments: the transcoded data,
2137 as a string, the back-end, as a symbol, and the communication
2141 "List of functions applied to a transcoded fixed-width.
2142 Each filter is called with three arguments: the transcoded data,
2143 as a string, the back-end, as a symbol, and the communication
2147 "List of functions applied to a transcoded footnote-definition.
2148 Each filter is called with three arguments: the transcoded data,
2149 as a string, the back-end, as a symbol, and the communication
2153 "List of functions applied to a transcoded headline.
2154 Each filter is called with three arguments: the transcoded data,
2155 as a string, the back-end, as a symbol, and the communication
2159 "List of functions applied to a transcoded horizontal-rule.
2160 Each filter is called with three arguments: the transcoded data,
2161 as a string, the back-end, as a symbol, and the communication
2165 "List of functions applied to a transcoded inlinetask.
2166 Each filter is called with three arguments: the transcoded data,
2167 as a string, the back-end, as a symbol, and the communication
2171 "List of functions applied to a transcoded item.
2172 Each filter is called with three arguments: the transcoded data,
2173 as a string, the back-end, as a symbol, and the communication
2177 "List of functions applied to a transcoded keyword.
2178 Each filter is called with three arguments: the transcoded data,
2179 as a string, the back-end, as a symbol, and the communication
2183 "List of functions applied to a transcoded latex-environment.
2184 Each filter is called with three arguments: the transcoded data,
2185 as a string, the back-end, as a symbol, and the communication
2189 "List of functions applied to a transcoded node-property.
2190 Each filter is called with three arguments: the transcoded data,
2191 as a string, the back-end, as a symbol, and the communication
2195 "List of functions applied to a transcoded paragraph.
2196 Each filter is called with three arguments: the transcoded data,
2197 as a string, the back-end, as a symbol, and the communication
2201 "List of functions applied to a transcoded plain-list.
2202 Each filter is called with three arguments: the transcoded data,
2203 as a string, the back-end, as a symbol, and the communication
2207 "List of functions applied to a transcoded planning.
2208 Each filter is called with three arguments: the transcoded data,
2209 as a string, the back-end, as a symbol, and the communication
2213 "List of functions applied to a transcoded property-drawer.
2214 Each filter is called with three arguments: the transcoded data,
2215 as a string, the back-end, as a symbol, and the communication
2219 "List of functions applied to a transcoded quote block.
2220 Each filter is called with three arguments: the transcoded quote
2221 data, as a string, the back-end, as a symbol, and the
2222 communication channel, as a plist. It must return a string or
2226 "List of functions applied to a transcoded section.
2227 Each filter is called with three arguments: the transcoded data,
2228 as a string, the back-end, as a symbol, and the communication
2232 "List of functions applied to a transcoded special block.
2233 Each filter is called with three arguments: the transcoded data,
2234 as a string, the back-end, as a symbol, and the communication
2238 "List of functions applied to a transcoded src-block.
2239 Each filter is called with three arguments: the transcoded data,
2240 as a string, the back-end, as a symbol, and the communication
2244 "List of functions applied to a transcoded table.
2245 Each filter is called with three arguments: the transcoded data,
2246 as a string, the back-end, as a symbol, and the communication
2250 "List of functions applied to a transcoded table-cell.
2251 Each filter is called with three arguments: the transcoded data,
2252 as a string, the back-end, as a symbol, and the communication
2256 "List of functions applied to a transcoded table-row.
2257 Each filter is called with three arguments: the transcoded data,
2258 as a string, the back-end, as a symbol, and the communication
2262 "List of functions applied to a transcoded verse block.
2263 Each filter is called with three arguments: the transcoded data,
2264 as a string, the back-end, as a symbol, and the communication
2268 ;;;; Objects Filters
2271 "List of functions applied to transcoded bold text.
2272 Each filter is called with three arguments: the transcoded data,
2273 as a string, the back-end, as a symbol, and the communication
2277 "List of functions applied to transcoded code text.
2278 Each filter is called with three arguments: the transcoded data,
2279 as a string, the back-end, as a symbol, and the communication
2283 "List of functions applied to a transcoded entity.
2284 Each filter is called with three arguments: the transcoded data,
2285 as a string, the back-end, as a symbol, and the communication
2289 "List of functions applied to a transcoded export-snippet.
2290 Each filter is called with three arguments: the transcoded data,
2291 as a string, the back-end, as a symbol, and the communication
2295 "List of functions applied to a transcoded footnote-reference.
2296 Each filter is called with three arguments: the transcoded data,
2297 as a string, the back-end, as a symbol, and the communication
2301 "List of functions applied to a transcoded inline-babel-call.
2302 Each filter is called with three arguments: the transcoded data,
2303 as a string, the back-end, as a symbol, and the communication
2307 "List of functions applied to a transcoded inline-src-block.
2308 Each filter is called with three arguments: the transcoded data,
2309 as a string, the back-end, as a symbol, and the communication
2313 "List of functions applied to transcoded italic text.
2314 Each filter is called with three arguments: the transcoded data,
2315 as a string, the back-end, as a symbol, and the communication
2319 "List of functions applied to a transcoded latex-fragment.
2320 Each filter is called with three arguments: the transcoded data,
2321 as a string, the back-end, as a symbol, and the communication
2325 "List of functions applied to a transcoded line-break.
2326 Each filter is called with three arguments: the transcoded data,
2327 as a string, the back-end, as a symbol, and the communication
2331 "List of functions applied to a transcoded link.
2332 Each filter is called with three arguments: the transcoded data,
2333 as a string, the back-end, as a symbol, and the communication
2337 "List of functions applied to a transcoded radio-target.
2338 Each filter is called with three arguments: the transcoded data,
2339 as a string, the back-end, as a symbol, and the communication
2343 "List of functions applied to a transcoded statistics-cookie.
2344 Each filter is called with three arguments: the transcoded data,
2345 as a string, the back-end, as a symbol, and the communication
2349 "List of functions applied to transcoded strike-through text.
2350 Each filter is called with three arguments: the transcoded data,
2351 as a string, the back-end, as a symbol, and the communication
2355 "List of functions applied to a transcoded subscript.
2356 Each filter is called with three arguments: the transcoded data,
2357 as a string, the back-end, as a symbol, and the communication
2361 "List of functions applied to a transcoded superscript.
2362 Each filter is called with three arguments: the transcoded data,
2363 as a string, the back-end, as a symbol, and the communication
2367 "List of functions applied to a transcoded target.
2368 Each filter is called with three arguments: the transcoded data,
2369 as a string, the back-end, as a symbol, and the communication
2373 "List of functions applied to a transcoded timestamp.
2374 Each filter is called with three arguments: the transcoded data,
2375 as a string, the back-end, as a symbol, and the communication
2379 "List of functions applied to transcoded underline text.
2380 Each filter is called with three arguments: the transcoded data,
2381 as a string, the back-end, as a symbol, and the communication
2385 "List of functions applied to transcoded verbatim text.
2386 Each filter is called with three arguments: the transcoded data,
2387 as a string, the back-end, as a symbol, and the communication
2391 ;;;; Filters Tools
2392 ;;
2393 ;; Internal function `org-export-install-filters' installs filters
2394 ;; hard-coded in back-ends (developer filters) and filters from global
2395 ;; variables (user filters) in the communication channel.
2396 ;;
2397 ;; Internal function `org-export-filter-apply-functions' takes care
2398 ;; about applying each filter in order to a given data. It ignores
2399 ;; filters returning a nil value but stops whenever a filter returns
2400 ;; an empty string.
2403 "Call every function in FILTERS.
2405 Functions are called with arguments VALUE, current export
2406 back-end's name and INFO. A function returning a nil value will
2407 be skipped. If it returns the empty string, the process ends and
2408 VALUE is ignored.
2410 Call is done in a LIFO fashion, to be sure that developer
2411 specified filters, if any, are called first."
2422 "Install filters properties in communication channel.
2423 INFO is a plist containing the current communication channel.
2424 Return the updated communication channel."
2426 ;; Install user-defined filters with `org-export-filters-alist'
2427 ;; and filters already in INFO (through ext-plist mechanism).
2434 ;; Filters in INFO will be called
2435 ;; before those user provided.
2438 default-value)))))
2439 org-export-filters-alist)
2440 ;; Prepend back-end specific filters to that list.
2442 ;; Single values get consed, lists are appended.
2447 plist key
2451 ;; Return new communication channel.
2455 \f
2456 ;;; Core functions
2457 ;;
2458 ;; This is the room for the main function, `org-export-as', along with
2459 ;; its derivative, `org-export-string-as'.
2460 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2461 ;; function should be added to kill ring.
2462 ;;
2463 ;; Note that `org-export-as' doesn't really parse the current buffer,
2464 ;; but a copy of it (with the same buffer-local variables and
2465 ;; visibility), where macros and include keywords are expanded and
2466 ;; Babel blocks are executed, if appropriate.
2467 ;; `org-export-with-buffer-copy' macro prepares that copy.
2468 ;;
2469 ;; File inclusion is taken care of by
2470 ;; `org-export-expand-include-keyword' and
2471 ;; `org-export--prepare-file-contents'. Structure wise, including
2472 ;; a whole Org file in a buffer often makes little sense. For
2473 ;; example, if the file contains a headline and the include keyword
2474 ;; was within an item, the item should contain the headline. That's
2475 ;; why file inclusion should be done before any structure can be
2476 ;; associated to the file, that is before parsing.
2477 ;;
2478 ;; `org-export-insert-default-template' is a command to insert
2479 ;; a default template (or a back-end specific template) at point or in
2480 ;; current subtree.
2483 "Return a copy of the current buffer.
2484 The copy preserves Org buffer-local variables, visibility and
2485 narrowing."
2491 new-buf))
2494 "Apply BODY in a copy of the current buffer.
2495 The copy preserves local variables, visibility and contents of
2496 the original buffer. Point is at the beginning of the buffer
2497 when BODY is applied."
2506 ;; Kill copy without confirmation.
2512 "Generate a function duplicating BUFFER.
2514 The copy will preserve local variables, visibility, contents and
2515 narrowing of the original buffer. If a region was active in
2516 BUFFER, contents will be narrowed to that region instead.
2518 The resulting function can be evaluated at a later time, from
2519 another buffer, effectively cloning the original buffer there.
2521 The function assumes BUFFER's major mode is `org-mode'."
2525 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2526 ;; already in BUFFER.
2528 ;; Copy specific buffer local variables and variables set
2529 ;; through BIND keywords.
2531 vars)
2539 buffer-file-name
2540 buffer-file-coding-system))
2544 ;; Skip unreadable values, as they cannot be
2545 ;; sent to external process.
2549 vars))))))
2550 ;; Whole buffer contents.
2555 ;; Narrowing.
2559 ;; Current position of point.
2561 ;; Overlays with invisible property.
2571 ov-set))))
2573 ov-set)))))
2576 "Delete commented areas in the buffer.
2577 Commented areas are comments, comment blocks, commented trees and
2578 inlinetasks. Trailing blank lines after a comment or a comment
2579 block are preserved. Narrowing, if any, is ignored."
2600 "Prune non exportable elements from DATA.
2601 DATA is the parse tree to traverse. INFO is the plist holding
2602 export info. Also set `:ignore-list' in INFO to a list of
2603 objects which should be ignored during export, but not removed
2604 from tree."
2606 ;; First find trees containing a select tag, if any.
2610 ;; Prune non-exportable elements and objects from tree.
2611 ;; As a special case, special rows and cells from tables
2612 ;; are stored in IGNORE, as they still need to be
2613 ;; accessed during export.
2623 ;; If headline is archived but tree below has
2624 ;; to be skipped, remove contents.
2626 ;; Move into secondary string, if any.
2629 org-element-secondary-value-alist))))
2633 ;; Move into recursive objects/elements.
2635 ;; If a select tag is active, also ignore the section before the
2636 ;; first headline, if any.
2641 ;; Prune tree and communication channel.
2645 ;; Priority is given to back-end specific options.
2647 org-export-options-alist))
2650 ;; Eventually set `:ignore-list'.
2654 "Change uninterpreted elements back into Org syntax.
2655 DATA is the parse tree. INFO is a plist containing export
2656 options. Each uninterpreted element or object is changed back
2657 into a string. Contents, if any, are not modified. The parse
2658 tree is modified by side effect."
2664 p
2667 info))))))
2670 "Change uninterpreted elements back into Org syntax.
2671 DATA is a parse tree or a secondary string. INFO is a plist
2672 containing export options. It is modified by side effect and
2673 returned by the function."
2676 subscript superscript underline)
2680 ;; ... entities...
2687 ?\s)))))
2688 ;; ... emphasis...
2700 marker
2704 ?\s)))))))
2705 ;; ... LaTeX environments and fragments...
2709 ;; ... sub/superscripts...
2718 "_"
2727 ?\s)))))))))))
2729 ;; Splice NEW at BLOB location in parse tree.
2732 info)
2733 ;; Return modified parse tree.
2734 data)
2737 "Insert footnote definitions outside parsing scope in TREE.
2739 If there is a footnote section in TREE, definitions found are
2740 appended to it. If `org-footnote-section' is non-nil, a new
2741 footnote section containing all definitions is inserted in TREE.
2742 Otherwise, definitions are appended at the end of the section
2743 containing their first reference.
2745 Only definitions actually referred to within TREE, directly or
2746 not, are considered."
2765 definitions))
2773 'footnote-definition
2779 definitions))))))))
2780 ;; Collect all out of scope definitions.
2790 ;; Filter out definitions referenced neither in the original
2791 ;; tree nor in the external definitions.
2796 definitions))
2799 referenced-labels)))
2804 definitions)))
2805 ;; Install definitions in subtree.
2808 ;; If there is a footnote section, insert them here.
2813 nil t)))
2816 ;; If there should be a footnote section, create one containing
2817 ;; all the definitions at the end of the tree.
2820 tree
2826 'section
2827 nil
2829 ;; Otherwise add each definition at the end of the section where
2830 ;; it is first referenced.
2835 ;; Insert definitions in the same section as
2836 ;; their first reference in DATA.
2848 d)
2849 label)
2856 definition)
2858 definition)))))))))))
2861 ;;;###autoload
2864 "Transcode current Org buffer into BACKEND code.
2866 BACKEND is either an export back-end, as returned by, e.g.,
2867 `org-export-create-backend', or a symbol referring to
2868 a registered back-end.
2870 If narrowing is active in the current buffer, only transcode its
2871 narrowed part.
2873 If a region is active, transcode that region.
2875 When optional argument SUBTREEP is non-nil, transcode the
2876 sub-tree at point, extracting information from the headline
2877 properties first.
2879 When optional argument VISIBLE-ONLY is non-nil, don't export
2880 contents of hidden elements.
2882 When optional argument BODY-ONLY is non-nil, only return body
2883 code, without surrounding template.
2885 Optional argument EXT-PLIST, when provided, is a property list
2886 with external parameters overriding Org default settings, but
2887 still inferior to file-local settings.
2889 Return code as a string."
2894 ;; Narrow buffer to an appropriate region or subtree for
2895 ;; parsing. If parsing subtree, be sure to remove main headline
2896 ;; too.
2904 ;; Initialize communication channel with original buffer
2905 ;; attributes, unavailable in its copy.
2918 org-export-options-alist))))
2919 tree)
2920 ;; Update communication channel and get parse tree. Buffer
2921 ;; isn't parsed directly. Instead, all buffer modifications
2922 ;; and consequent parsing are undertaken in a temporary copy.
2924 ;; Run first hook with current back-end's name as argument.
2927 ;; Include files, delete comments and expand macros.
2932 ;; Refresh buffer properties and radio targets after
2933 ;; potentially invasive previous changes. Likewise, do it
2934 ;; again after executing Babel code.
2940 ;; Run last hook with current back-end's name as argument.
2941 ;; Update buffer properties and radio targets one last time
2942 ;; before parsing.
2949 ;; Update communication channel with environment. Also
2950 ;; install user's and developer's filters.
2955 ;; Call options filters and update export options. We do not
2956 ;; use `org-export-filter-apply-functions' here since the
2957 ;; arity of such filters is different.
2962 ;; Expand export-specific set of macros: {{{author}}},
2963 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2964 ;; be done once regular macros have been expanded, since
2965 ;; parsed keywords may contain one of them.
2978 value)
2979 value)))
2983 'finalize
2984 parsed-keywords)
2985 ;; Parse buffer.
2987 ;; Merge footnote definitions outside scope into parse tree.
2989 ;; Prune tree from non-exported elements and transform
2990 ;; uninterpreted elements or objects in both parse tree and
2991 ;; communication channel.
2994 ;; Call parse tree filters.
2998 ;; Now tree is complete, compute its properties and add them
2999 ;; to communication channel.
3003 ;; Eventually transcode TREE. Wrap the resulting string into
3004 ;; a template.
3013 info))
3016 ;; Remove all text properties since they cannot be
3017 ;; retrieved from an external process. Finally call
3018 ;; final-output filter and return result.
3024 info))))))))
3026 ;;;###autoload
3028 "Transcode STRING into BACKEND code.
3030 BACKEND is either an export back-end, as returned by, e.g.,
3031 `org-export-create-backend', or a symbol referring to
3032 a registered back-end.
3034 When optional argument BODY-ONLY is non-nil, only return body
3035 code, without preamble nor postamble.
3037 Optional argument EXT-PLIST, when provided, is a property list
3038 with external parameters overriding Org default settings, but
3039 still inferior to file-local settings.
3041 Return code as a string."
3047 ;;;###autoload
3049 "Replace the active region by its export to BACKEND.
3050 BACKEND is either an export back-end, as returned by, e.g.,
3051 `org-export-create-backend', or a symbol referring to
3052 a registered back-end."
3058 ;;;###autoload
3060 "Insert all export keywords with default values at beginning of line.
3062 BACKEND is a symbol referring to the name of a registered export
3063 back-end, for which specific export options should be added to
3064 the template, or `default' for default template. When it is nil,
3065 the user will be prompted for a category.
3067 If SUBTREEP is non-nil, export configuration will be set up
3068 locally for the subtree through node properties."
3078 "Options category: "
3082 org-export-registered-backends))
3083 nil t))))
3084 options keywords)
3085 ;; Populate OPTIONS and KEYWORDS.
3102 ;; Move to an appropriate location in order to insert options.
3104 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3122 ;; Then the rest of keywords, in the order specified in either
3123 ;; `org-export-options-alist' or respective export back-ends.
3144 "Expand every include keyword in buffer.
3145 Optional argument INCLUDED is a list of included file names along
3146 with their line restriction, when appropriate. It is used to
3147 avoid infinite recursion. Optional argument DIR is the current
3148 working directory. It is used to properly resolve relative
3149 paths. Optional argument FOOTNOTES is a hash-table used for
3150 storing and resolving footnotes. It is created automatically."
3156 ;; If :minlevel is not set the text-property
3157 ;; `:org-include-induced-level' will be used to determine the
3158 ;; relative level when expanding INCLUDE.
3159 ;; Only affects included Org documents.
3163 :org-include-induced-level
3165 ;; Expand INCLUDE keywords.
3171 ;; Extract arguments from keyword's value.
3174 location
3182 matched)
3188 matched)
3189 dir)))
3193 value)
3199 value)
3206 ;; Minimal level of included file defaults to the child
3207 ;; level of the current headline, if any, or one. It
3208 ;; only applies is the file is meant to be included as
3209 ;; an Org one.
3221 ;; Remove keyword.
3227 ;; Check if files has already been parsed. Look after
3228 ;; inclusion lines too, as different parts of the same file
3229 ;; can be included too.
3244 ind-str block arg-str contents ind-str block))))
3251 ind-str block contents ind-str block))))
3259 file location only-contents lines)
3260 lines)))
3264 file lines ind minlevel
3267 footnotes)))
3271 footnotes)
3273 ;; Expand footnotes after all files have been included.
3274 ;; Footnotes are stored at end of buffer.
3279 footnotes)))))))))))
3282 "Resolve absolute lines for an included file with file-link.
3284 FILE is string file-name of the file to include. LOCATION is a
3285 string name within FILE to be included (located via
3286 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3287 contents of the named element will be included, as determined
3288 Org-Element. If LINES is non-nil only those lines are included.
3290 Return a string of lines to be included in the format expected by
3291 `org-export--prepare-file-contents'."
3297 ;; Enforce consistent search.
3310 ;; Skip planning line and property-drawer.
3336 start-line
3338 (+ start-line
3341 counter))))))))
3344 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3346 REF-BEGIN corresponds to the property `:begin' of objects of type
3347 footnote-definition and footnote-reference.
3349 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3350 \[N] where N is one or more numbers.
3352 Return the new label."
3363 "Prepare contents of FILE for inclusion and return it as a string.
3365 When optional argument LINES is a string specifying a range of
3366 lines, include only those lines.
3368 Optional argument IND, when non-nil, is an integer specifying the
3369 global indentation of returned contents. Since its purpose is to
3370 allow an included file to stay in the same environment it was
3371 created \(i.e. a list item), it doesn't apply past the first
3372 headline encountered.
3374 Optional argument MINLEVEL, when non-nil, is an integer
3375 specifying the level that any top-level headline in the included
3376 file should have.
3377 Optional argument ID is an integer that will be inserted before
3378 each footnote definition and reference if FILE is an Org file.
3379 This is useful to avoid conflicts when more than one Org file
3380 with footnotes is included in a document.
3382 Optional argument FOOTNOTES is a hash-table to store footnotes in
3383 the included document.
3384 "
3400 ;; Remove blank lines at beginning and end of contents. The logic
3401 ;; behind that removal is that blank lines around include keyword
3402 ;; override blank lines in included file.
3411 ;; If IND is set, preserve indentation of include keyword until
3412 ;; the first headline encountered.
3419 ;; Do not move footnote definitions out of column 0.
3425 ;; When MINLEVEL is specified, compute minimal level for headlines
3426 ;; in the file (CUR-MIN), and remove stars to each headline so
3427 ;; that headlines with minimal level have a level of MINLEVEL.
3438 ;; Only change stars, don't bother moving whole
3439 ;; sections.
3443 ;; Append ID to all footnote references and definitions, so they
3444 ;; become file specific and cannot collide with footnotes in other
3445 ;; included files. Further, collect relevant footnotes outside of
3446 ;; LINES.
3457 ;; Update the footnote-reference at point and collect
3458 ;; the new label, which is only used for footnotes
3459 ;; outsides LINES.
3461 ;; If label is akin to [1] convert it to [fn:ID-1].
3462 ;; Otherwise add "ID-" after "fn:".
3465 digit-label id)))
3472 "Definition not found for footnote %s in file %s"
3473 label file))
3476 ;; Store since footnote-definition is
3477 ;; outside of LINES.
3481 footnotes)
3482 ;; Update label of definition since it is
3483 ;; included directly.
3485 beginning digit-label id)))))))))))
3491 "Execute every Babel code in the visible part of current buffer."
3492 ;; Get a pristine copy of current buffer so Babel references can be
3493 ;; properly resolved.
3499 "Return a non-nil value when output should be added to the kill ring.
3500 See also `org-export-copy-to-kill-ring'."
3506 \f
3507 ;;; Tools For Back-Ends
3508 ;;
3509 ;; A whole set of tools is available to help build new exporters. Any
3510 ;; function general enough to have its use across many back-ends
3511 ;; should be added here.
3513 ;;;; For Affiliated Keywords
3514 ;;
3515 ;; `org-export-read-attribute' reads a property from a given element
3516 ;; as a plist. It can be used to normalize affiliated keywords'
3517 ;; syntax.
3518 ;;
3519 ;; Since captions can span over multiple lines and accept dual values,
3520 ;; their internal representation is a bit tricky. Therefore,
3521 ;; `org-export-get-caption' transparently returns a given element's
3522 ;; caption as a secondary string.
3525 "Turn ATTRIBUTE property from ELEMENT into a plist.
3527 When optional argument PROPERTY is non-nil, return the value of
3528 that property within attributes.
3532 properties.
3534 All values will become strings except the empty string and
3537 will become the empty string."
3551 s)
3556 ;; Ignore any string before first property with `cdr'.
3561 "Return caption from ELEMENT as a secondary string.
3563 When optional argument SHORTP is non-nil, return short caption,
3564 as a secondary string, instead.
3566 Caption lines are separated by a white space."
3574 ;;;; For Derived Back-ends
3575 ;;
3576 ;; `org-export-with-backend' is a function allowing to locally use
3577 ;; another back-end to transcode some object or element. In a derived
3578 ;; back-end, it may be used as a fall-back function once all specific
3579 ;; cases have been treated.
3582 "Call a transcoder from BACKEND on DATA.
3583 BACKEND is an export back-end, as returned by, e.g.,
3584 `org-export-create-backend', or a symbol referring to
3585 a registered back-end. DATA is an Org element, object, secondary
3586 string or string. CONTENTS, when non-nil, is the transcoded
3587 contents of DATA element, as a string. INFO, when non-nil, is
3588 the communication channel used for export, as a plist."
3598 transcoder data contents
3601 :back-end backend
3602 :translate-alist all-transcoders
3606 ;;;; For Export Snippets
3607 ;;
3608 ;; Every export snippet is transmitted to the back-end. Though, the
3609 ;; latter will only retain one type of export-snippet, ignoring
3610 ;; others, based on the former's target back-end. The function
3611 ;; `org-export-snippet-backend' returns that back-end for a given
3612 ;; export-snippet.
3615 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3616 Translation, with `org-export-snippet-translation-alist', is
3617 applied."
3621 back-end))))
3624 ;;;; For Footnotes
3625 ;;
3626 ;; `org-export-collect-footnote-definitions' is a tool to list
3627 ;; actually used footnotes definitions in the whole parse tree, or in
3628 ;; a headline, in order to add footnote listings throughout the
3629 ;; transcoded data.
3630 ;;
3631 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3632 ;; back-ends, when they need to attach the footnote definition only to
3633 ;; the first occurrence of the corresponding label.
3634 ;;
3635 ;; `org-export-get-footnote-definition' and
3636 ;; `org-export-get-footnote-number' provide easier access to
3637 ;; additional information relative to a footnote reference.
3640 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3641 INFO is the plist used as a communication channel. If no such
3642 definition can be found, raise an error."
3648 hash))))
3656 info t)
3657 cache)
3662 "Apply FUNCTION on every footnote reference in DATA.
3663 INFO is a plist containing export state. By default, as soon as
3664 a new footnote reference is encountered, FUNCTION is called onto
3665 its definition. However, if BODY-FIRST is non-nil, this step is
3666 delayed until the end of the process."
3671 ;; Search footnote references through DATA, filling
3672 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3673 ;; store footnote definitions so they can be entered
3674 ;; later.
3681 ;; Search for subsequent references in footnote
3682 ;; definition so numbering follows reading
3683 ;; logic, unless DELAYP in non-nil.
3687 definitions))
3688 ;; Do not force entering inline definitions,
3689 ;; since `org-element-map' already traverses
3690 ;; them at the right time.
3694 nil))))))
3695 info nil
3696 ;; Don't enter footnote definitions since it will
3697 ;; happen when their first reference is found.
3698 ;; Moreover, if DELAYP is non-nil, make sure we
3699 ;; postpone entering definitions of inline references.
3706 "Return an alist between footnote numbers, labels and definitions.
3708 INFO is the current export state, as a plist.
3710 Definitions are collected throughout the whole parse tree, or
3711 DATA when non-nil.
3713 Sorting is done by order of references. As soon as a new
3714 reference is encountered, other references are searched within
3715 its definition. However, if BODY-FIRST is non-nil, this step is
3716 delayed after the whole tree is checked. This alters results
3717 when references are found in footnote definitions.
3719 Definitions either appear as Org data or as a secondary string
3720 for inlined footnotes. Unreferenced definitions are ignored."
3724 ;; Collect footnote number, label and definition.
3735 "Non-nil when a footnote reference is the first one for its label.
3737 FOOTNOTE-REFERENCE is the footnote reference being considered.
3738 INFO is a plist containing current export state.
3740 Search is done throughout the whole parse tree, or DATA when
3741 non-nil.
3743 By default, as soon as a new footnote reference is encountered,
3744 other references are searched within its definition. However, if
3745 BODY-FIRST is non-nil, this step is delayed after the whole tree
3746 is checked. This alters results when references are found in
3747 footnote definitions."
3749 ;; Anonymous footnotes are always a first reference.
3760 "Return number associated to a footnote.
3762 FOOTNOTE is either a footnote reference or a footnote definition.
3763 INFO is the plist containing export state.
3765 Number is unique throughout the whole parse tree, or DATA, when
3766 non-nil.
3768 By default, as soon as a new footnote reference is encountered,
3769 counting process moves into its definition. However, if
3770 BODY-FIRST is non-nil, this step is delayed until the end of the
3771 process, leading to a different order when footnotes are nested."
3780 ;; Anonymous footnote match: return number.
3782 ;; Labels match: return number.
3784 ;; Otherwise store label and increase counter if label
3785 ;; wasn't encountered yet.
3791 ;;;; For Headlines
3792 ;;
3793 ;; `org-export-get-relative-level' is a shortcut to get headline
3794 ;; level, relatively to the lower headline level in the parsed tree.
3795 ;;
3796 ;; `org-export-get-headline-number' returns the section number of an
3797 ;; headline, while `org-export-number-to-roman' allows to convert it
3798 ;; to roman numbers. With an optional argument,
3799 ;; `org-export-get-headline-number' returns a number to unnumbered
3800 ;; headlines (used for internal id).
3801 ;;
3802 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3803 ;; `org-export-last-sibling-p' are three useful predicates when it
3804 ;; comes to fulfill the `:headline-levels' property.
3805 ;;
3806 ;; `org-export-get-tags', `org-export-get-category' and
3807 ;; `org-export-get-node-property' extract useful information from an
3808 ;; headline or a parent headline. They all handle inheritance.
3809 ;;
3810 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3811 ;; as a secondary string, suitable for table of contents. It falls
3812 ;; back onto default title.
3815 "Return HEADLINE relative level within current parsed tree.
3816 INFO is a plist holding contextual information."
3821 "Non-nil when HEADLINE is considered as low level.
3823 INFO is a plist used as a communication channel.
3825 A low level headlines has a relative level greater than
3826 `:headline-levels' property value.
3828 Return value is the difference between HEADLINE relative level
3829 and the last level being considered as high enough, or nil."
3836 "Return numbered HEADLINE numbering as a list of numbers.
3837 INFO is a plist holding contextual information."
3842 "Return a non-nil value if HEADLINE element should be numbered.
3843 INFO is a plist used as a communication channel."
3852 "Convert integer N into a roman numeral."
3865 res)))
3868 "Return list of tags associated to ELEMENT.
3870 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3871 is a plist used as a communication channel.
3873 Select tags (see `org-export-select-tags') and exclude tags (see
3874 `org-export-exclude-tags') are removed from the list.
3876 When non-nil, optional argument TAGS should be a list of strings.
3877 Any tag belonging to this list will also be removed.
3879 When optional argument INHERITED is non-nil, tags can also be
3880 inherited from parent headlines and FILETAGS keywords."
3886 ;; Build complete list of inherited tags.
3893 ;; Add FILETAGS keywords and return results.
3897 "Return node PROPERTY value for BLOB.
3899 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3900 element or object.
3902 If optional argument INHERITED is non-nil, the value can be
3903 inherited from a parent headline.
3905 Return value is a string or nil."
3917 "Return category for element or object BLOB.
3919 INFO is a plist used as a communication channel.
3921 CATEGORY is automatically inherited from a parent headline, from
3922 #+CATEGORY: keyword or created out of original file name. If all
3935 "Return alternative title for HEADLINE, as a secondary string.
3936 If no optional title is defined, fall-back to the regular title."
3943 "Non-nil when BLOB is the first sibling in its parent.
3944 BLOB is an element or an object. If BLOB is a headline, non-nil
3945 means it is the first sibling in the sub-tree. INFO is a plist
3946 used as a communication channel."
3951 "Non-nil when BLOB is the last sibling in its parent.
3952 BLOB is an element or an object. INFO is a plist used as
3953 a communication channel."
3957 ;;;; For Keywords
3958 ;;
3959 ;; `org-export-get-date' returns a date appropriate for the document
3960 ;; to about to be exported. In particular, it takes care of
3961 ;; `org-export-date-timestamp-format'.
3964 "Return date value for the current document.
3966 INFO is a plist used as a communication channel. FMT, when
3967 non-nil, is a time format string that will be applied on the date
3968 if it consists in a single timestamp object. It defaults to
3969 `org-export-date-timestamp-format' when nil.
3971 A proper date can be a secondary string, a string or nil. It is
3972 meant to be translated with `org-export-data' or alike."
3983 ;;;; For Links
3984 ;;
3985 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3986 ;; with `org-add-link-type', which see.
3987 ;;
3988 ;; `org-export-get-coderef-format' returns an appropriate format
3989 ;; string for coderefs.
3990 ;;
3991 ;; `org-export-inline-image-p' returns a non-nil value when the link
3992 ;; provided should be considered as an inline image.
3993 ;;
3994 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3995 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3996 ;; returns an appropriate unique identifier when found, or nil.
3997 ;;
3998 ;; `org-export-resolve-id-link' returns the first headline with
3999 ;; specified id or custom-id in parse tree, the path to the external
4000 ;; file with the id or nil when neither was found.
4001 ;;
4002 ;; `org-export-resolve-coderef' associates a reference to a line
4003 ;; number in the element it belongs, or returns the reference itself
4004 ;; when the element isn't numbered.
4005 ;;
4006 ;; `org-export-file-uri' expands a filename as stored in :path value
4007 ;; of a "file" link into a file URI.
4010 "Try exporting LINK with a dedicated function.
4012 DESC is its description, as a string, or nil. BACKEND is the
4013 back-end used for export, as a symbol.
4015 Return output as a string, or nil if no protocol handles LINK.
4017 A custom protocol has precedence over regular back-end export.
4018 The function ignores links with an implicit type (e.g.,
4027 desc
4028 backend))))))
4031 "Return format string for code reference link.
4032 PATH is the link path. DESC is its description."
4040 "Non-nil if LINK object points to an inline image.
4042 Optional argument is a set of RULES defining inline images. It
4043 is an alist where associations have the following shape:
4045 \(TYPE . REGEXP)
4047 Applying a rule means apply REGEXP against LINK's path when its
4048 type is TYPE. The function will return a non-nil value if any of
4049 the provided rules is non-nil. The default rule is
4050 `org-export-default-inline-image-rule'.
4052 This only applies to links without a description."
4063 "Resolve a code reference REF.
4065 INFO is a plist used as a communication channel.
4067 Return associated line number in source code, or REF itself,
4068 depending on src-block or example element's switches. Throw an
4069 error if no block contains REF."
4076 org-coderef-label-format)))
4080 ;; Element containing REF is found. Resolve it to
4081 ;; either a label or a line number, as needed.
4092 "Return LINK destination.
4094 INFO is a plist holding contextual information.
4096 Return value can be an object, an element, or nil:
4098 - If LINK path matches a target object (i.e. <<path>>) return it.
4100 - If LINK path exactly matches the name affiliated keyword
4101 \(i.e. #+NAME: path) of an element, return that element.
4103 - If LINK path exactly matches any headline name, return that
4104 element.
4106 - Otherwise, throw an error.
4109 significant."
4112 ;; Split PATH at white spaces so matches are space
4113 ;; insensitive.
4119 :resolve-fuzzy-link-cache
4126 path
4128 ;; First try to find a matching "<<path>>" unless user
4129 ;; specified he was looking for a headline (path starts with
4130 ;; a "*" character).
4136 path)
4137 datum))
4139 ;; Then try to find an element with a matching "#+NAME: path"
4140 ;; affiliated keyword.
4147 ;; Try to find a matching headline.
4154 path)
4155 h))
4158 link-cache)))))
4161 "Return headline referenced as LINK destination.
4163 INFO is a plist used as a communication channel.
4165 Return value can be the headline element matched in current parse
4169 ;; First check if id is within the current parse tree.
4174 headline))
4176 ;; Otherwise, look for external files.
4181 "Return radio-target object referenced as LINK destination.
4183 INFO is a plist used as a communication channel.
4185 Return value can be a radio-target object or nil. Assume LINK
4194 nil nil path nil nil t)
4195 t)
4196 radio))
4200 "Return file URI associated to FILENAME."
4206 filename))))
4209 ;;;; For References
4210 ;;
4211 ;; `org-export-get-reference' associate a unique reference for any
4212 ;; object or element.
4213 ;;
4214 ;; `org-export-get-ordinal' associates a sequence number to any object
4215 ;; or element.
4218 "Return a unique reference for DATUM, as a string.
4219 DATUM is either an element or an object. INFO is the current
4220 export state, as a plist. Returned reference consists of
4221 alphanumeric characters only."
4226 h))))
4234 cache))))
4237 "Return ordinal number of an element or object.
4239 ELEMENT is the element or object considered. INFO is the plist
4240 used as a communication channel.
4242 Optional argument TYPES, when non-nil, is a list of element or
4243 object types, as symbols, that should also be counted in.
4244 Otherwise, only provided element's type is considered.
4246 Optional argument PREDICATE is a function returning a non-nil
4247 value if the current element or object should be counted in. It
4248 accepts two arguments: the element or object being considered and
4249 the plist used as a communication channel. This allows to count
4250 only a certain type of objects (i.e. inline images).
4252 Return value is a list of numbers if ELEMENT is a headline or an
4253 item. It is nil for keywords. It represents the footnote number
4254 for footnote definitions and footnote references. If ELEMENT is
4255 a target, return the same value as if ELEMENT was the closest
4256 table, item or headline containing the target. In any other
4257 case, return the sequence number of ELEMENT among elements or
4258 objects of the same type."
4259 ;; Ordinal of a target object refer to the ordinal of the closest
4260 ;; table, item, or headline containing the object.
4264 element
4267 ;; Special case 1: A headline returns its number as a list.
4269 ;; Special case 2: An item returns its number as a list.
4273 struct
4280 ;; Increment counter until ELEMENT is found again.
4291 ;;;; For Src-Blocks
4292 ;;
4293 ;; `org-export-get-loc' counts number of code lines accumulated in
4294 ;; src-block or example-block elements with a "+n" switch until
4295 ;; a given element, excluded. Note: "-n" switches reset that count.
4296 ;;
4297 ;; `org-export-unravel-code' extracts source code (along with a code
4298 ;; references alist) from an `element-block' or `src-block' type
4299 ;; element.
4300 ;;
4301 ;; `org-export-format-code' applies a formatting function to each line
4302 ;; of code, providing relative line number and code reference when
4303 ;; appropriate. Since it doesn't access the original element from
4304 ;; which the source code is coming, it expects from the code calling
4305 ;; it to know if lines should be numbered and if code references
4306 ;; should appear.
4307 ;;
4308 ;; Eventually, `org-export-format-code-default' is a higher-level
4309 ;; function (it makes use of the two previous functions) which handles
4310 ;; line numbering and code references inclusion, and returns source
4311 ;; code in a format suitable for plain text or verbatim output.
4314 "Return accumulated lines of code up to ELEMENT.
4316 INFO is the plist used as a communication channel.
4318 ELEMENT is excluded from count."
4324 ;; ELEMENT is reached: Quit the loop.
4326 ;; Only count lines from src-block and example-block elements
4327 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4331 ;; Accumulate locs or reset them.
4335 ;; Return nil to stay in the loop.
4336 nil)))
4338 ;; Return value.
4339 loc))
4342 "Clean source code and extract references out of it.
4344 ELEMENT has either a `src-block' an `example-block' type.
4346 Return a cons cell whose CAR is the source code, cleaned from any
4347 reference, protective commas and spurious indentation, and CDR is
4348 an alist between relative line number (integer) and name of code
4349 reference on that line (string)."
4352 ;; Get code and clean it. Remove blank lines at its
4353 ;; beginning and end.
4360 value
4362 ;; Get format used for references.
4365 org-coderef-label-format)))
4366 ;; Build a regexp matching a loc with a reference.
4371 ;; Return value.
4373 ;; Code with references removed.
4379 ;; Ref line: remove ref, and signal its position in REFS.
4383 ;; Reference alist.
4384 refs)))
4387 "Format CODE by applying FUN line-wise and return it.
4389 CODE is a string representing the code to format. FUN is
4390 a function. It must accept three arguments: a line of
4391 code (string), the current line number (integer) or nil and the
4392 reference associated to the current line (string) or nil.
4394 Optional argument NUM-LINES can be an integer representing the
4395 number of code lines accumulated until the current code. Line
4396 numbers passed to FUN will take it into account. If it is nil,
4397 FUN's second argument will always be nil. This number can be
4398 obtained with `org-export-get-loc' function.
4400 Optional argument REF-ALIST can be an alist between relative line
4401 number (i.e. ignoring NUM-LINES) and the name of the code
4402 reference on it. If it is nil, FUN's third argument will always
4403 be nil. It can be obtained through the use of
4404 `org-export-unravel-code' function."
4416 "Return source code from ELEMENT, formatted in a standard way.
4418 ELEMENT is either a `src-block' or `example-block' element. INFO
4419 is a plist used as a communication channel.
4421 This function takes care of line numbering and code references
4422 inclusion. Line numbers, when applicable, appear at the
4423 beginning of the line, separated from the code by two white
4424 spaces. Code references, on the other hand, appear flushed to
4425 the right, separated by six white spaces from the widest line of
4426 code."
4427 ;; Extract code and references.
4434 ;; Handle line numbering.
4443 ;; Prepare references display, if required. Any reference
4444 ;; should start six columns after the widest line of code,
4445 ;; wrapped with parenthesis.
4450 code
4454 number-str
4455 loc
4461 num-start refs)))))
4464 ;;;; For Tables
4465 ;;
4466 ;; `org-export-table-has-special-column-p' and and
4467 ;; `org-export-table-row-is-special-p' are predicates used to look for
4468 ;; meta-information about the table structure.
4469 ;;
4470 ;; `org-table-has-header-p' tells when the rows before the first rule
4471 ;; should be considered as table's header.
4472 ;;
4473 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4474 ;; and `org-export-table-cell-borders' extract information from
4475 ;; a table-cell element.
4476 ;;
4477 ;; `org-export-table-dimensions' gives the number on rows and columns
4478 ;; in the table, ignoring horizontal rules and special columns.
4479 ;; `org-export-table-cell-address', given a table-cell object, returns
4480 ;; the absolute address of a cell. On the other hand,
4481 ;; `org-export-get-table-cell-at' does the contrary.
4482 ;;
4483 ;; `org-export-table-cell-starts-colgroup-p',
4484 ;; `org-export-table-cell-ends-colgroup-p',
4485 ;; `org-export-table-row-starts-rowgroup-p',
4486 ;; `org-export-table-row-ends-rowgroup-p',
4487 ;; `org-export-table-row-starts-header-p',
4488 ;; `org-export-table-row-ends-header-p' and
4489 ;; `org-export-table-row-in-header-p' indicate position of current row
4490 ;; or cell within the table.
4493 "Non-nil when TABLE has a special column.
4494 All special columns will be ignored during export."
4495 ;; The table has a special column when every first cell of every row
4496 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4497 ;; "*" "_" and "^". Though, do not consider a first row containing
4498 ;; only empty cells as special.
4514 "Non-nil when TABLE has a header.
4516 INFO is a plist used as a communication channel.
4518 A table has a header when it contains at least two row groups."
4527 table
4538 cache)))))
4541 "Non-nil if TABLE-ROW is considered special.
4542 All special rows will be ignored during export."
4546 ;; A row is special either when...
4548 ;; ... it starts with a field only containing "/",
4550 ;; ... the table contains a special column and the row start
4551 ;; with a marking character among, "^", "_", "$" or "!",
4555 ;; ... it contains only alignment cookies and empty cells.
4561 ;; Since VALUE is a secondary string, the following
4562 ;; checks avoid expanding it with `org-export-data'.
4574 "Return TABLE-ROW's group number, as an integer.
4576 INFO is a plist used as the communication channel.
4578 Return value is the group number, as an integer, or nil for
4579 special rows and rows separators. First group is also table's
4580 header."
4598 "Return TABLE-CELL contents width.
4600 INFO is a plist used as the communication channel.
4602 Return value is the width given by the last width cookie in the
4603 same column as TABLE-CELL, or nil."
4622 ;; In a special row, try to find a width cookie at COLUMN.
4626 ;; The following checks avoid expanding unnecessarily
4627 ;; the cell with `org-export-data'.
4637 "Return TABLE-CELL contents alignment.
4639 INFO is a plist used as the communication channel.
4641 Return alignment as specified by the last alignment cookie in the
4642 same column as TABLE-CELL. If no such cookie is found, a default
4643 alignment value will be deduced from fraction of numbers in the
4644 column (see `org-table-number-fraction' for more information).
4645 Possible values are `left', `right' and `center'."
4646 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4663 cookie-align
4664 previous-cell-number-p)
4667 ;; In a special row, try to find an alignment cookie at
4668 ;; COLUMN.
4672 ;; Since VALUE is a secondary string, the following
4673 ;; checks avoid useless expansion through
4674 ;; `org-export-data'.
4682 ;; Ignore table rules.
4684 ;; In a standard row, check if cell's contents are
4685 ;; expressing some kind of number. Increase NUMBER-CELLS
4686 ;; accordingly. Though, don't bother if an alignment
4687 ;; cookie has already defined cell's alignment.
4692 info)))
4694 ;; Treat an empty cell as a number if it follows
4695 ;; a number.
4701 ;; Return value. Alignment specified by cookies has
4702 ;; precedence over alignment deduced from cell's contents.
4704 column
4709 org-table-number-fraction)
4714 "Return TABLE-CELL borders.
4716 INFO is a plist used as a communication channel.
4718 Return value is a list of symbols, or nil. Possible values are:
4719 `top', `bottom', `above', `below', `left' and `right'. Note:
4720 `top' (resp. `bottom') only happen for a cell in the first
4721 row (resp. last row) of the table, ignoring table rules, if any.
4723 Returned borders ignore special rows."
4726 borders)
4727 ;; Top/above border? TABLE-CELL has a border above when a rule
4728 ;; used to demarcate row groups can be found above. Hence,
4729 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4730 ;; another regular row has to be found above that rule.
4739 ;; Look at every row before the current one.
4741 ;; No rule above, or rule found starts the table (ignoring any
4742 ;; special row): TABLE-CELL is at the top of the table.
4745 ;; Bottom/below border? TABLE-CELL has a border below when next
4746 ;; non-regular row below is a rule.
4755 ;; Look at every row after the current one.
4757 ;; No rule below, or rule found ends the table (modulo some
4758 ;; special row): TABLE-CELL is at the bottom of the table.
4761 ;; Right/left borders? They can only be specified by column
4762 ;; groups. Column groups are defined in a row starting with "/".
4763 ;; Also a column groups row only contains "<", "<>", ">" or blank
4764 ;; cells.
4781 ;; There's a left border when previous cell, if
4782 ;; any, ends a group, or current one starts one.
4788 ;; There's a right border when next cell, if any,
4789 ;; starts a group, or current one ends one.
4796 ;; Table rows are read in reverse order so last column groups
4797 ;; row has precedence over any previous one.
4799 ;; Return value.
4800 borders))
4803 "Non-nil when TABLE-CELL is at the beginning of a column group.
4804 INFO is a plist used as a communication channel."
4805 ;; A cell starts a column group either when it is at the beginning
4806 ;; of a row (or after the special column, if any) or when it has
4807 ;; a left border.
4810 table-cell)
4814 "Non-nil when TABLE-CELL is at the end of a column group.
4815 INFO is a plist used as a communication channel."
4816 ;; A cell ends a column group either when it is at the end of a row
4817 ;; or when it has a right border.
4820 table-cell)
4824 "Non-nil when TABLE-ROW is at the beginning of a row group.
4825 INFO is a plist used as a communication channel."
4833 "Non-nil when TABLE-ROW is at the end of a row group.
4834 INFO is a plist used as a communication channel."
4842 "Non-nil when TABLE-ROW is located within table's header.
4843 INFO is a plist used as a communication channel. Always return
4844 nil for special rows and rows separators."
4850 "Non-nil when TABLE-ROW is the first table header's row.
4851 INFO is a plist used as a communication channel."
4856 "Non-nil when TABLE-ROW is the last table header's row.
4857 INFO is a plist used as a communication channel."
4862 "Return TABLE-ROW number.
4863 INFO is a plist used as a communication channel. Return value is
4864 zero-based and ignores separators. The function returns nil for
4865 special columns and separators."
4877 "Return TABLE dimensions.
4879 INFO is a plist used as a communication channel.
4881 Return value is a CONS like (ROWS . COLUMNS) where
4882 ROWS (resp. COLUMNS) is the number of exportable
4883 rows (resp. columns)."
4885 ;; Set number of rows, and extract first one.
4891 ;; Set number of columns.
4893 ;; Return value.
4897 "Return address of a regular TABLE-CELL object.
4899 TABLE-CELL is the cell considered. INFO is a plist used as
4900 a communication channel.
4902 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4903 zero-based index. Only exportable cells are considered. The
4904 function returns nil for other cells."
4916 "Return regular table-cell object at ADDRESS in TABLE.
4918 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4919 zero-based index. TABLE is a table type element. INFO is
4920 a plist used as a communication channel.
4922 If no table-cell, among exportable cells, is found at ADDRESS,
4923 return nil."
4926 ;; Row at (car address) or nil.
4934 'table-cell
4941 ;;;; For Tables Of Contents
4942 ;;
4943 ;; `org-export-collect-headlines' builds a list of all exportable
4944 ;; headline elements, maybe limited to a certain depth. One can then
4945 ;; easily parse it and transcode it.
4946 ;;
4947 ;; Building lists of tables, figures or listings is quite similar.
4948 ;; Once the generic function `org-export-collect-elements' is defined,
4949 ;; `org-export-collect-tables', `org-export-collect-figures' and
4950 ;; `org-export-collect-listings' can be derived from it.
4953 "Collect headlines in order to build a table of contents.
4955 INFO is a plist used as a communication channel.
4957 When optional argument N is an integer, it specifies the depth of
4958 the table of contents. Otherwise, it is set to the value of the
4959 last headline level. See `org-export-headline-levels' for more
4960 information.
4962 Optional argument SCOPE, when non-nil, is an element. If it is
4963 a headline, only children of SCOPE are collected. Otherwise,
4964 collect children of the headline containing provided element. If
4965 there is no such headline, collect all headlines. In any case,
4966 argument N becomes relative to the level of that headline.
4968 Return a list of all exportable headlines as parsed elements.
4969 Footnote sections are ignored."
4978 limit))))
4984 info)))
4987 "Collect referenceable elements of a determined type.
4989 TYPE can be a symbol or a list of symbols specifying element
4990 types to search. Only elements with a caption are collected.
4992 INFO is a plist used as a communication channel.
4994 When non-nil, optional argument PREDICATE is a function accepting
4995 one argument, an element of type TYPE. It returns a non-nil
4996 value when that element should be collected.
4998 Return a list of all elements found, in order of appearance."
5003 element))
5004 info))
5007 "Build a list of tables.
5008 INFO is a plist used as a communication channel.
5010 Return a list of table elements with a caption."
5014 "Build a list of figures.
5016 INFO is a plist used as a communication channel. PREDICATE is
5017 a function which accepts one argument: a paragraph element and
5018 whose return value is non-nil when that element should be
5019 collected.
5021 A figure is a paragraph type element, with a caption, verifying
5023 a vague concept that may depend on back-end.
5025 Return a list of elements recognized as figures."
5029 "Build a list of src blocks.
5031 INFO is a plist used as a communication channel.
5033 Return a list of src-block elements with a caption."
5037 ;;;; Smart Quotes
5038 ;;
5039 ;; The main function for the smart quotes sub-system is
5040 ;; `org-export-activate-smart-quotes', which replaces every quote in
5041 ;; a given string from the parse tree with its "smart" counterpart.
5042 ;;
5043 ;; Dictionary for smart quotes is stored in
5044 ;; `org-export-smart-quotes-alist'.
5048 ;; one may use: »...«, "...", ›...‹, or '...'.
5049 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5050 ;; LaTeX quotes require Babel!
5095 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5104 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5113 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5122 ;; 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
5123 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5134 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5140 )
5141 "Smart quotes translations.
5143 Alist whose CAR is a language string and CDR is an alist with
5144 quote type as key and a plist associating various encodings to
5145 their translation as value.
5147 A quote type can be any symbol among `opening-double-quote',
5148 `closing-double-quote', `opening-single-quote',
5149 `closing-single-quote' and `apostrophe'.
5151 Valid encodings include `:utf-8', `:html', `:latex' and
5152 `:texinfo'.
5157 "Return smart quote status at the beginning of string S.
5158 INFO is the current export state, as a plist."
5163 table)))
5178 ;; Not already in a level 1 quote: this is an
5179 ;; apostrophe.
5181 ;; Apostrophe.
5183 ;; Apostrophe at the beginning of a string. Check
5184 ;; white space at the end of the last object.
5193 ;; Apostrophe at the end of a string. Check white
5194 ;; space at the beginning of the next object, which
5195 ;; can only happen if that object is a string.
5202 ;; Lonesome apostrophe. Check white space around
5203 ;; both ends.
5215 n))))))))
5217 ;; Else, consider it as a level 2 quote.
5221 current-status))
5224 info nil org-element-recursive-objects)
5231 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5232 `:utf-8'. INFO is a plist used as a communication channel.
5234 The function has to retrieve information about string
5235 surroundings in parse tree. It can only happen with an
5236 unmodified string. Thus, if S has already been through another
5237 process, a non-nil ORIGINAL optional argument will provide that
5238 original string.
5240 Return the new string."
5249 org-export-smart-quotes-alist))))
5250 encoding)
5251 match))
5252 s nil t)))
5254 ;;;; Topology
5255 ;;
5256 ;; Here are various functions to retrieve information about the
5257 ;; neighborhood of a given element or object. Neighbors of interest
5258 ;; are direct parent (`org-export-get-parent'), parent headline
5259 ;; (`org-export-get-parent-headline'), first element containing an
5260 ;; object, (`org-export-get-parent-element'), parent table
5261 ;; (`org-export-get-parent-table'), previous element or object
5262 ;; (`org-export-get-previous-element') and next element or object
5263 ;; (`org-export-get-next-element').
5265 ;; defsubst org-export-get-parent must be defined before first use
5271 "Return BLOB parent headline or nil.
5272 BLOB is the element or object being considered."
5276 "Return first element containing OBJECT or nil.
5277 OBJECT is the object to consider."
5281 "Return OBJECT parent table or nil.
5282 OBJECT is either a `table-cell' or `table-element' type object."
5286 "Return previous element or object.
5288 BLOB is an element or object. INFO is a plist used as
5289 a communication channel. Return previous exportable element or
5290 object, a string, or nil.
5292 When optional argument N is a positive integer, return a list
5293 containing up to N siblings before BLOB, from farthest to
5294 closest. With any other non-nil value, return a list containing
5295 all of them."
5301 prev)
5311 "Return next element or object.
5313 BLOB is an element or object. INFO is a plist used as
5314 a communication channel. Return next exportable element or
5315 object, a string, or nil.
5317 When optional argument N is a positive integer, return a list
5318 containing up to N siblings after BLOB, from closest to farthest.
5319 With any other non-nil value, return a list containing all of
5320 them."
5327 next)
5337 ;;;; Translation
5338 ;;
5339 ;; `org-export-translate' translates a string according to the language
5340 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5341 ;; the dictionary used for the translation.
5373 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5383 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5389 ("ru" :html "(Продолжение следует)"
5463 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5486 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5492 ("ru" :html "Список распечаток"
5506 ("ru" :html "Список таблиц"
5612 ("ru" :html "Неизвестная ссылка"
5615 "Dictionary for export engine.
5617 Alist whose car is the string to translate and cdr is an alist
5618 whose car is the language string and cdr is a plist whose
5619 properties are possible charsets and values translated terms.
5621 It is used as a database for `org-export-translate'. Since this
5622 function returns the string as-is if no translation was found,
5623 the variable only needs to record values different from the
5627 "Translate string S according to language specification.
5629 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5630 and `:utf-8'. INFO is a plist used as a communication channel.
5632 Translation depends on `:language' property. Return the
5633 translated string. If no translation is found, try to fall back
5634 to `:default' encoding. If it fails, return S."
5640 s)))
5643 \f
5644 ;;; Asynchronous Export
5645 ;;
5646 ;; `org-export-async-start' is the entry point for asynchronous
5647 ;; export. It recreates current buffer (including visibility,
5648 ;; narrowing and visited file) in an external Emacs process, and
5649 ;; evaluates a command there. It then applies a function on the
5650 ;; returned results in the current process.
5651 ;;
5652 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5653 ;; allow to export to a buffer or a file, asynchronously or not.
5654 ;;
5655 ;; `org-export-output-file-name' is an auxiliary function meant to be
5656 ;; used with `org-export-to-file'. With a given extension, it tries
5657 ;; to provide a canonical file name to write export output to.
5658 ;;
5659 ;; Asynchronously generated results are never displayed directly.
5660 ;; Instead, they are stored in `org-export-stack-contents'. They can
5661 ;; then be retrieved by calling `org-export-stack'.
5662 ;;
5663 ;; Export Stack is viewed through a dedicated major mode
5664 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5665 ;;`org-export-stack-delete', `org-export-stack-view' and
5666 ;;`org-export-stack-clear'.
5667 ;;
5668 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5669 ;; It should be used whenever `org-export-async-start' is called.
5672 "Call function FUN on the results returned by BODY evaluation.
5674 FUN is an anonymous function of one argument. BODY evaluation
5675 happens in an asynchronous process, from a buffer which is an
5676 exact copy of the current one.
5678 Use `org-export-add-to-stack' in FUN in order to register results
5679 in the stack.
5681 This is a low level function. See also `org-export-to-buffer'
5682 and `org-export-to-file' for more specialized functions."
5685 ;; Write the full sexp evaluating BODY in a copy of the current
5686 ;; buffer to a temporary file, as it may be too long for program
5687 ;; args in `start-process'.
5694 ;; Null characters (from variable values) are inserted
5695 ;; within the file. As a consequence, coding system for
5696 ;; buffer contents will not be recognized properly. So,
5697 ;; we make sure it is the same as the one used to display
5698 ;; the original buffer.
5700 ,coding
5703 ;; Ignore `kill-emacs-hook' and code evaluation
5704 ;; queries from Babel as we need a truly
5705 ;; non-interactive process.
5707 org-babel-confirm-evaluate-answer-no t)
5708 ;; Initialize export framework.
5710 ;; Re-create current buffer there.
5713 ;; Sexp to evaluate in the buffer.
5715 ;; Start external process.
5718 (,process
5720 #'start-process
5723 ,proc-buffer
5730 ;; Register running process in stack.
5732 ;; Set-up sentinel in order to catch results.
5735 ,process
5757 ;;;###autoload
5760 &optional async subtreep visible-only body-only ext-plist
5761 post-process)
5762 "Call `org-export-as' with output to a specified buffer.
5764 BACKEND is either an export back-end, as returned by, e.g.,
5765 `org-export-create-backend', or a symbol referring to
5766 a registered back-end.
5768 BUFFER is the name of the output buffer. If it already exists,
5769 it will be erased first, otherwise, it will be created.
5771 A non-nil optional argument ASYNC means the process should happen
5772 asynchronously. The resulting buffer should then be accessible
5773 through the `org-export-stack' interface. When ASYNC is nil, the
5774 buffer is displayed if `org-export-show-temporary-export-buffer'
5775 is non-nil.
5777 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5778 EXT-PLIST are similar to those used in `org-export-as', which
5779 see.
5781 Optional argument POST-PROCESS is a function which should accept
5782 no argument. It is always called within the current process,
5783 from BUFFER, with point at its beginning. Export back-ends can
5784 use it to set a major mode there, e.g,
5786 \(defun org-latex-export-as-latex
5787 \(&optional async subtreep visible-only body-only ext-plist)
5788 \(interactive)
5790 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5792 This function returns BUFFER."
5820 buffer)))
5822 ;;;###autoload
5825 post-process)
5826 "Call `org-export-as' with output to a specified file.
5828 BACKEND is either an export back-end, as returned by, e.g.,
5829 `org-export-create-backend', or a symbol referring to
5830 a registered back-end. FILE is the name of the output file, as
5831 a string.
5833 A non-nil optional argument ASYNC means the process should happen
5834 asynchronously. The resulting buffer will then be accessible
5835 through the `org-export-stack' interface.
5837 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5838 EXT-PLIST are similar to those used in `org-export-as', which
5839 see.
5841 Optional argument POST-PROCESS is called with FILE as its
5842 argument and happens asynchronously when ASYNC is non-nil. It
5843 has to return a file name, or nil. Export back-ends can use this
5844 to send the output file through additional processing, e.g,
5846 \(defun org-latex-export-to-latex
5847 \(&optional async subtreep visible-only body-only ext-plist)
5848 \(interactive)
5850 \(org-export-to-file 'latex outfile
5851 async subtreep visible-only body-only ext-plist
5852 \(lambda (file) (org-latex-compile file)))
5854 The function returns either a file name returned by POST-PROCESS,
5855 or FILE."
5874 backend subtreep visible-only body-only ext-plist)))
5881 ;; Get proper return value.
5883 file))))))
5886 "Return output file's name according to buffer specifications.
5888 EXTENSION is a string representing the output file extension,
5889 with the leading dot.
5891 With a non-nil optional argument SUBTREEP, try to determine
5893 of subtree at point.
5895 When optional argument PUB-DIR is set, use it as the publishing
5896 directory.
5898 Return file name as a string."
5901 ;; File name may come from EXPORT_FILE_NAME subtree
5902 ;; property, assuming point is at beginning of said
5903 ;; sub-tree.
5910 ;; File name may be extracted from buffer's associated
5911 ;; file, if any.
5913 ;; Can't determine file name on our own: Ask user.
5917 "Output file: " pub-dir nil nil nil
5921 ;; Build file name. Enforce EXTENSION over whatever user
5922 ;; may have come up with. PUB-DIR, if defined, always has
5923 ;; precedence over any provided path.
5928 extension))
5931 ;; If writing to OUTPUT-FILE would overwrite original file, append
5932 ;; EXTENSION another time to final name.
5935 output-file)))
5938 "Add a new result to export stack if not present already.
5940 SOURCE is a buffer or a file name containing export results.
5941 BACKEND is a symbol representing export back-end used to generate
5942 it.
5944 Entries already pointing to SOURCE and unavailable entries are
5945 removed beforehand. Return the new stack."
5951 "Menu for asynchronous export results and running processes."
5961 "Return source from export results at point in stack."
5968 source
5969 ;; SOURCE is not consistent with current line. The stack
5970 ;; view is outdated.
5974 "Remove all entries from export stack."
5979 "Refresh the asynchronous export stack.
5980 Unavailable sources are removed from the list. Return the new
5981 stack."
5990 ;; Back-end.
5992 ;; Age.
5995 ;; Compute age of the results.
5997 "%4h:%.2m "
5999 ;; Source.
6004 ;; Clear stack from exited processes, dead buffers or
6005 ;; non-existent files.
6017 "Remove export results at point from stack.
6018 If optional argument SOURCE is non-nil, remove it instead."
6023 org-export-stack-contents))))
6026 "View export results at point in stack.
6027 With an optional prefix argument IN-EMACS, force viewing files
6028 within Emacs."
6042 (define-key km "p" 'previous-line)
6043 (define-key km "\C-p" 'previous-line)
6044 (define-key km "\C-?" 'previous-line)
6045 (define-key km [up] 'previous-line)
6046 (define-key km "C" 'org-export-stack-clear)
6047 (define-key km "v" 'org-export-stack-view)
6048 (define-key km (kbd "RET") 'org-export-stack-view)
6049 (define-key km "d" 'org-export-stack-remove)
6050 km)
6051 "Keymap for Org Export Stack.")
6053 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6054 "Mode for displaying asynchronous export stack.
6057 stack.
6059 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6060 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6061 stack completely.
6063 Removing entries in an Org Export Stack buffer doesn't affect
6064 files or buffers, only the display.
6067 (abbrev-mode 0)
6068 (auto-fill-mode 0)
6069 (setq buffer-read-only t
6070 buffer-undo-list t
6071 truncate-lines t
6072 header-line-format
6073 '(:eval
6074 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6075 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6076 (set (make-local-variable 'revert-buffer-function)
6077 'org-export-stack-refresh))
6080 \f
6081 ;;; The Dispatcher
6082 ;;
6083 ;; `org-export-dispatch' is the standard interactive way to start an
6084 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6085 ;; for its interface, which, in turn, delegates response to key
6086 ;; pressed to `org-export--dispatch-action'.
6088 ;;;###autoload
6089 (defun org-export-dispatch (&optional arg)
6090 "Export dispatcher for Org mode.
6092 It provides an access to common export related tasks in a buffer.
6093 Its interface comes in two flavors: standard and expert.
6095 While both share the same set of bindings, only the former
6096 displays the valid keys associations in a dedicated buffer.
6097 Scrolling (resp. line-wise motion) in this buffer is done with
6098 SPC and DEL (resp. C-n and C-p) keys.
6100 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6101 flavor or the other.
6104 of options used back then, on the current buffer.
6106 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6107 (interactive "P")
6108 (let* ((input
6109 (cond ((equal arg '(16)) '(stack))
6110 ((and arg org-export-dispatch-last-action))
6111 (t (save-window-excursion
6112 (unwind-protect
6113 (progn
6114 ;; Remember where we are
6115 (move-marker org-export-dispatch-last-position
6116 (point)
6117 (org-base-buffer (current-buffer)))
6118 ;; Get and store an export command
6119 (setq org-export-dispatch-last-action
6120 (org-export--dispatch-ui
6121 (list org-export-initial-scope
6122 (and org-export-in-background 'async))
6123 nil
6124 org-export-dispatch-use-expert-ui)))
6125 (and (get-buffer "*Org Export Dispatcher*")
6126 (kill-buffer "*Org Export Dispatcher*")))))))
6127 (action (car input))
6128 (optns (cdr input)))
6129 (unless (memq 'subtree optns)
6130 (move-marker org-export-dispatch-last-position nil))
6131 (case action
6132 ;; First handle special hard-coded actions.
6133 (template (org-export-insert-default-template nil optns))
6134 (stack (org-export-stack))
6135 (publish-current-file
6136 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6137 (publish-current-project
6138 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6139 (publish-choose-project
6140 (org-publish (assoc (org-icompleting-read
6141 "Publish project: "
6142 org-publish-project-alist nil t)
6143 org-publish-project-alist)
6144 (memq 'force optns)
6145 (memq 'async optns)))
6146 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6147 (otherwise
6148 (save-excursion
6149 (when arg
6150 ;; Repeating command, maybe move cursor to restore subtree
6151 ;; context.
6152 (if (eq (marker-buffer org-export-dispatch-last-position)
6153 (org-base-buffer (current-buffer)))
6154 (goto-char org-export-dispatch-last-position)
6155 ;; We are in a different buffer, forget position.
6156 (move-marker org-export-dispatch-last-position nil)))
6157 (funcall action
6158 ;; Return a symbol instead of a list to ease
6159 ;; asynchronous export macro use.
6160 (and (memq 'async optns) t)
6161 (and (memq 'subtree optns) t)
6162 (and (memq 'visible optns) t)
6163 (and (memq 'body optns) t)))))))
6165 (defun org-export--dispatch-ui (options first-key expertp)
6166 "Handle interface for `org-export-dispatch'.
6168 OPTIONS is a list containing current interactive options set for
6169 export. It can contain any of the following symbols:
6170 `body' toggles a body-only export
6171 `subtree' restricts export to current subtree
6172 `visible' restricts export to visible part of buffer.
6173 `force' force publishing files.
6174 `async' use asynchronous export process
6176 FIRST-KEY is the key pressed to select the first level menu. It
6177 is nil when this menu hasn't been selected yet.
6179 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6180 buffer is provided, but indications about currently active
6181 options are given in the prompt. Moreover, \[?] allows to switch
6182 back to standard interface."
6183 (let* ((fontify-key
6184 (lambda (key &optional access-key)
6185 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6186 ;; non-nil is the required first-level key to activate
6187 ;; KEY. When its value is t, activate KEY independently
6188 ;; on the first key, if any. A nil value means KEY will
6189 ;; only be activated at first level.
6190 (if (or (eq access-key t) (eq access-key first-key))
6191 (org-propertize key 'face 'org-warning)
6192 key)))
6193 (fontify-value
6194 (lambda (value)
6195 ;; Fontify VALUE string.
6196 (org-propertize value 'face 'font-lock-variable-name-face)))
6197 ;; Prepare menu entries by extracting them from registered
6198 ;; back-ends and sorting them by access key and by ordinal,
6199 ;; if any.
6200 (entries
6201 (sort (sort (delq nil
6202 (mapcar #'org-export-backend-menu
6203 org-export-registered-backends))
6204 (lambda (a b)
6205 (let ((key-a (nth 1 a))
6206 (key-b (nth 1 b)))
6207 (cond ((and (numberp key-a) (numberp key-b))
6208 (< key-a key-b))
6209 ((numberp key-b) t)))))
6210 'car-less-than-car))
6211 ;; Compute a list of allowed keys based on the first key
6212 ;; pressed, if any. Some keys
6213 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6214 ;; available.
6215 (allowed-keys
6216 (nconc (list 2 22 19 6 1)
6217 (if (not first-key) (org-uniquify (mapcar 'car entries))
6218 (let (sub-menu)
6219 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6220 (when (eq (car entry) first-key)
6221 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6222 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6223 ((not first-key) (list ?P)))
6224 (list ?& ?#)
6225 (when expertp (list ??))
6226 (list ?q)))
6227 ;; Build the help menu for standard UI.
6228 (help
6229 (unless expertp
6230 (concat
6231 ;; Options are hard-coded.
6232 (format "[%s] Body only: %s [%s] Visible only: %s
6233 \[%s] Export scope: %s [%s] Force publishing: %s
6235 (funcall fontify-key "C-b" t)
6236 (funcall fontify-value
6237 (if (memq 'body options) "On " "Off"))
6238 (funcall fontify-key "C-v" t)
6239 (funcall fontify-value
6240 (if (memq 'visible options) "On " "Off"))
6241 (funcall fontify-key "C-s" t)
6242 (funcall fontify-value
6243 (if (memq 'subtree options) "Subtree" "Buffer "))
6244 (funcall fontify-key "C-f" t)
6245 (funcall fontify-value
6246 (if (memq 'force options) "On " "Off"))
6247 (funcall fontify-key "C-a" t)
6248 (funcall fontify-value
6249 (if (memq 'async options) "On " "Off")))
6250 ;; Display registered back-end entries. When a key
6251 ;; appears for the second time, do not create another
6252 ;; entry, but append its sub-menu to existing menu.
6253 (let (last-key)
6254 (mapconcat
6255 (lambda (entry)
6256 (let ((top-key (car entry)))
6257 (concat
6258 (unless (eq top-key last-key)
6259 (setq last-key top-key)
6261 (funcall fontify-key (char-to-string top-key))
6262 (nth 1 entry)))
6263 (let ((sub-menu (nth 2 entry)))
6264 (unless (functionp sub-menu)
6265 ;; Split sub-menu into two columns.
6266 (let ((index -1))
6267 (concat
6268 (mapconcat
6269 (lambda (sub-entry)
6270 (incf index)
6271 (format
6272 (if (zerop (mod index 2)) " [%s] %-26s"
6274 (funcall fontify-key
6275 (char-to-string (car sub-entry))
6276 top-key)
6277 (nth 1 sub-entry)))
6278 sub-menu "")
6280 entries ""))
6281 ;; Publishing menu is hard-coded.
6283 [%s] Current file [%s] Current project
6285 (funcall fontify-key "P")
6286 (funcall fontify-key "f" ?P)
6287 (funcall fontify-key "p" ?P)
6288 (funcall fontify-key "x" ?P)
6289 (funcall fontify-key "a" ?P))
6291 (funcall fontify-key "&" t)
6292 (funcall fontify-key "#" t))
6293 (format "[%s] %s"
6294 (funcall fontify-key "q" t)
6295 (if first-key "Main menu" "Exit")))))
6296 ;; Build prompts for both standard and expert UI.
6297 (standard-prompt (unless expertp "Export command: "))
6298 (expert-prompt
6299 (when expertp
6300 (format
6301 "Export command (C-%s%s%s%s%s) [%s]: "
6302 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6303 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6304 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6305 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6306 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6307 (mapconcat (lambda (k)
6308 ;; Strip control characters.
6309 (unless (< k 27) (char-to-string k)))
6310 allowed-keys "")))))
6311 ;; With expert UI, just read key with a fancy prompt. In standard
6312 ;; UI, display an intrusive help buffer.
6313 (if expertp
6314 (org-export--dispatch-action
6315 expert-prompt allowed-keys entries options first-key expertp)
6316 ;; At first call, create frame layout in order to display menu.
6317 (unless (get-buffer "*Org Export Dispatcher*")
6318 (delete-other-windows)
6319 (org-switch-to-buffer-other-window
6320 (get-buffer-create "*Org Export Dispatcher*"))
6321 (setq cursor-type nil
6322 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6323 ;; Make sure that invisible cursor will not highlight square
6324 ;; brackets.
6325 (set-syntax-table (copy-syntax-table))
6326 (modify-syntax-entry ?\[ "w"))
6327 ;; At this point, the buffer containing the menu exists and is
6328 ;; visible in the current window. So, refresh it.
6329 (with-current-buffer "*Org Export Dispatcher*"
6330 ;; Refresh help. Maintain display continuity by re-visiting
6331 ;; previous window position.
6332 (let ((pos (window-start)))
6333 (erase-buffer)
6334 (insert help)
6335 (set-window-start nil pos)))
6336 (org-fit-window-to-buffer)
6337 (org-export--dispatch-action
6338 standard-prompt allowed-keys entries options first-key expertp))))
6340 (defun org-export--dispatch-action
6341 (prompt allowed-keys entries options first-key expertp)
6342 "Read a character from command input and act accordingly.
6344 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6345 a list of characters available at a given step in the process.
6346 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6347 EXPERTP are the same as defined in `org-export--dispatch-ui',
6348 which see.
6350 Toggle export options when required. Otherwise, return value is
6351 a list with action as CAR and a list of interactive export
6352 options as CDR."
6353 (let (key)
6354 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6355 ;; C-p, SPC, DEL).
6356 (while (and (setq key (read-char-exclusive prompt))
6357 (not expertp)
6358 (memq key '(14 16 ?\s ?\d)))
6359 (case key
6360 (14 (if (not (pos-visible-in-window-p (point-max)))
6361 (ignore-errors (scroll-up 1))
6362 (message "End of buffer")
6363 (sit-for 1)))
6364 (16 (if (not (pos-visible-in-window-p (point-min)))
6365 (ignore-errors (scroll-down 1))
6366 (message "Beginning of buffer")
6367 (sit-for 1)))
6368 (?\s (if (not (pos-visible-in-window-p (point-max)))
6369 (scroll-up nil)
6370 (message "End of buffer")
6371 (sit-for 1)))
6372 (?\d (if (not (pos-visible-in-window-p (point-min)))
6373 (scroll-down nil)
6374 (message "Beginning of buffer")
6375 (sit-for 1)))))
6376 (cond
6377 ;; Ignore undefined associations.
6378 ((not (memq key allowed-keys))
6379 (ding)
6380 (unless expertp (message "Invalid key") (sit-for 1))
6381 (org-export--dispatch-ui options first-key expertp))
6382 ;; q key at first level aborts export. At second level, cancel
6383 ;; first key instead.
6384 ((eq key ?q) (if (not first-key) (error "Export aborted")
6385 (org-export--dispatch-ui options nil expertp)))
6386 ;; Help key: Switch back to standard interface if expert UI was
6387 ;; active.
6388 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6389 ;; Send request for template insertion along with export scope.
6390 ((eq key ?#) (cons 'template (memq 'subtree options)))
6391 ;; Switch to asynchronous export stack.
6392 ((eq key ?&) '(stack))
6393 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6394 ((memq key '(2 22 19 6 1))
6395 (org-export--dispatch-ui
6396 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6397 (6 'force) (1 'async))))
6398 (if (memq option options) (remq option options)
6399 (cons option options)))
6400 first-key expertp))
6401 ;; Action selected: Send key and options back to
6402 ;; `org-export-dispatch'.
6403 ((or first-key (functionp (nth 2 (assq key entries))))
6404 (cons (cond
6405 ((not first-key) (nth 2 (assq key entries)))
6406 ;; Publishing actions are hard-coded. Send a special
6407 ;; signal to `org-export-dispatch'.
6408 ((eq first-key ?P)
6409 (case key
6410 (?f 'publish-current-file)
6411 (?p 'publish-current-project)
6412 (?x 'publish-choose-project)
6413 (?a 'publish-all)))
6414 ;; Return first action associated to FIRST-KEY + KEY
6415 ;; path. Indeed, derived backends can share the same
6416 ;; FIRST-KEY.
6417 (t (catch 'found
6418 (mapc (lambda (entry)
6419 (let ((match (assq key (nth 2 entry))))
6420 (when match (throw 'found (nth 2 match)))))
6421 (member (assq first-key entries) entries)))))
6422 options))
6423 ;; Otherwise, enter sub-menu.
6424 (t (org-export--dispatch-ui options key expertp)))))
6428 (provide 'ox)
6430 ;; Local variables:
6431 ;; generated-autoload-file: "org-loaddefs.el"
6432 ;; End:
6434 ;;; ox.el ends here