| blob | 39eedee48da4840988ddb07a9def3243900d33ff |
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:
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:
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,
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:
1221 The back-end could then be called with, for example:
1239 :parent parent
1240 :transcoders transcoders
1241 :options options
1242 :filters filters
1243 :blocks blocks
1247 \f
1248 ;;; The Communication Channel
1249 ;;
1250 ;; During export process, every function has access to a number of
1251 ;; properties. They are of two types:
1252 ;;
1253 ;; 1. Environment options are collected once at the very beginning of
1254 ;; the process, out of the original buffer and configuration.
1255 ;; Collecting them is handled by `org-export-get-environment'
1256 ;; function.
1257 ;;
1258 ;; Most environment options are defined through the
1259 ;; `org-export-options-alist' variable.
1260 ;;
1261 ;; 2. Tree properties are extracted directly from the parsed tree,
1262 ;; just before export, by `org-export-collect-tree-properties'.
1264 ;;;; Environment Options
1265 ;;
1266 ;; Environment options encompass all parameters defined outside the
1267 ;; scope of the parsed data. They come from five sources, in
1268 ;; increasing precedence order:
1269 ;;
1270 ;; - Global variables,
1271 ;; - Buffer's attributes,
1272 ;; - Options keyword symbols,
1273 ;; - Buffer keywords,
1274 ;; - Subtree properties.
1275 ;;
1276 ;; The central internal function with regards to environment options
1277 ;; is `org-export-get-environment'. It updates global variables with
1278 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1279 ;; the different sources.
1280 ;;
1281 ;; The internal functions doing the retrieval are:
1282 ;; `org-export--get-global-options',
1283 ;; `org-export--get-buffer-attributes',
1284 ;; `org-export--parse-option-keyword',
1285 ;; `org-export--get-subtree-options' and
1286 ;; `org-export--get-inbuffer-options'
1287 ;;
1288 ;; Also, `org-export--list-bound-variables' collects bound variables
1289 ;; along with their value in order to set them as buffer local
1290 ;; variables later in the process.
1293 "Collect export options from the current buffer.
1295 Optional argument BACKEND is an export back-end, as returned by
1296 `org-export-create-backend'.
1298 When optional argument SUBTREEP is non-nil, assume the export is
1299 done against the current sub-tree.
1301 Third optional argument EXT-PLIST is a property list with
1302 external parameters overriding Org default settings, but still
1303 inferior to file-local settings."
1304 ;; First install #+BIND variables since these must be set before
1305 ;; global options are read.
1308 ;; Get and prioritize export options...
1310 ;; ... from global variables...
1312 ;; ... from an external property list...
1313 ext-plist
1314 ;; ... from in-buffer settings...
1316 ;; ... and from subtree, when appropriate.
1318 ;; Eventually add misc. properties.
1320 :back-end
1321 backend
1323 :id-alist
1324 ;; Collect id references.
1335 alist))))
1338 "Parse an OPTIONS line and return values as a plist.
1339 Optional argument BACKEND is an export back-end, as returned by,
1340 e.g., `org-export-create-backend'. It specifies which back-end
1341 specific items to read, if any."
1348 alist))
1349 alist))
1350 ;; Priority is given to back-end specific options.
1352 org-export-options-alist))
1362 "Get export options in subtree at point.
1363 Optional argument BACKEND is an export back-end, as returned by,
1364 e.g., `org-export-create-backend'. It specifies back-end used
1365 for export. Return options as a plist."
1366 ;; For each buffer keyword, create a headline property setting the
1367 ;; same property in communication channel. The name for the
1368 ;; property is the keyword with "EXPORT_" appended to it.
1370 ;; Make sure point is at a heading.
1373 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1374 ;; care of them right from the start.
1377 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1378 ;; headline's title (with no todo keyword, priority cookie or
1379 ;; tag) as its fallback value.
1385 ;; Look for both general keywords and back-end specific
1386 ;; options, with priority given to the latter.
1388 org-export-options-alist)))
1389 ;; Handle other keywords. Then return PLIST.
1403 property
1412 "Return current buffer export options, as a plist.
1414 Optional argument BACKEND, when non-nil, is an export back-end,
1415 as returned by, e.g., `org-export-create-backend'. It specifies
1416 which back-end specific options should also be read in the
1417 process.
1419 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1422 ;; Priority is given to back-end specific options.
1424 org-export-options-alist))
1427 org-export-special-keywords))))
1428 plist to-parse)
1431 ;; Return all properties associated to KEYWORD.
1438 ;; Recursively read keywords in buffer. FILES is
1439 ;; a list of files read so far. PLIST is the current
1440 ;; property list obtained.
1449 ;; Options in `org-export-special-keywords'.
1454 ;; Avoid circular dependencies.
1465 plist
1467 val backend))))
1471 plist
1478 ;; Options in `org-export-options-alist'.
1481 plist
1483 plist property
1484 ;; Handle value depending on specified
1485 ;; BEHAVIOR.
1490 ;; Even if `parse' implies `space'
1491 ;; behavior, we separate line with
1492 ;; "\n" so as to preserve
1493 ;; line-breaks. However, empty
1494 ;; lines are forbidden since `parse'
1495 ;; doesn't allow more than one
1496 ;; paragraph.
1505 " "
1518 ;; Read options in the current buffer and return value.
1520 ;; Parse properties in TO-PARSE. Remove newline characters not
1521 ;; involved in line breaks to simulate `space' behavior.
1522 ;; Finally return options.
1534 "Return properties related to buffer attributes, as a plist."
1539 "Return global export options as a plist.
1540 Optional argument BACKEND, if non-nil, is an export back-end, as
1541 returned by, e.g., `org-export-create-backend'. It specifies
1542 which back-end specific export options should also be read in the
1543 process."
1545 ;; Priority is given to back-end specific options.
1547 org-export-options-alist)))
1553 plist
1554 prop
1555 ;; Evaluate default value provided.
1560 value)))))))))
1563 "Return variables bound from BIND keywords in current buffer.
1564 Also look for BIND keywords in setup files. The return value is
1565 an alist where associations are (VARIABLE-NAME VALUE)."
1569 ;; Return an alist between variable names and their
1570 ;; value. FILES is a list of setup files names read
1571 ;; so far, used to avoid circular dependencies. ALIST
1572 ;; is the alist collected so far.
1584 ;; Enter setup file.
1596 alist))))))))))
1597 alist)))))
1598 ;; Return value in appropriate order of appearance.
1601 ;; defsubst org-export-get-parent must be defined before first use,
1602 ;; was originally defined in the topology section
1605 "Return BLOB parent or nil.
1606 BLOB is the element or object considered."
1609 ;;;; Tree Properties
1610 ;;
1611 ;; Tree properties are information extracted from parse tree. They
1612 ;; are initialized at the beginning of the transcoding process by
1613 ;; `org-export-collect-tree-properties'.
1614 ;;
1615 ;; Dedicated functions focus on computing the value of specific tree
1616 ;; properties during initialization. Thus,
1617 ;; `org-export--populate-ignore-list' lists elements and objects that
1618 ;; should be skipped during export, `org-export--get-min-level' gets
1619 ;; the minimal exportable level, used as a basis to compute relative
1620 ;; level for headlines. Eventually
1621 ;; `org-export--collect-headline-numbering' builds an alist between
1622 ;; headlines and their numbering.
1625 "Extract tree properties from parse tree.
1627 DATA is the parse tree from which information is retrieved. INFO
1628 is a list holding export options.
1630 Following tree properties are set or updated:
1632 `:exported-data' Hash table used to memoize results from
1633 `org-export-data'.
1635 `:headline-offset' Offset between true level of headlines and
1636 local level. An offset of -1 means a headline
1637 of level 2 should be considered as a level
1638 1 headline in the context.
1640 `:headline-numbering' Alist of all headlines as key an the
1641 associated numbering as value.
1643 Return updated plist."
1644 ;; Install the parse tree in the communication channel.
1646 ;; Compute `:headline-offset' in order to be able to use
1647 ;; `org-export-get-relative-level'.
1650 :headline-offset
1652 ;; Properties order doesn't matter: get the rest of the tree
1653 ;; properties.
1657 info))
1660 "Return minimum exportable headline's level in DATA.
1661 DATA is parsed tree as returned by `org-element-parse-buffer'.
1662 OPTIONS is a plist holding export options."
1673 ;; If no headline was found, for the sake of consistency, set
1674 ;; minimum level to 1 nonetheless.
1678 "Return numbering of all exportable, numbered headlines in a parse tree.
1680 DATA is the parse tree. OPTIONS is the plist holding export
1681 options.
1683 Return an alist whose key is a headline and value is its
1684 associated numbering \(in the shape of a list of numbers) or nil
1685 for a footnotes section."
1694 headline
1696 for n across numbering
1697 for idx from 0 to org-export-max-depth
1701 options)))
1704 "List headlines and inlinetasks with a select tag in their tree.
1705 DATA is parsed data as returned by `org-element-parse-buffer'.
1706 INFO is a plist holding export options."
1716 ;; When a select tag is found, mark full
1717 ;; genealogy and every headline within the
1718 ;; tree as acceptable.
1721 genealogy
1724 selected-trees))
1725 ;; If at a headline, continue searching in tree,
1726 ;; recursively.
1735 selected-trees))
1738 "Non-nil when element or object BLOB should be skipped during export.
1739 OPTIONS is the plist holding export options. SELECTED, when
1740 non-nil, is a list of headlines or inlinetasks belonging to
1741 a tree with a select tag."
1748 ;; If `:with-drawers' value starts with `not', ignore
1749 ;; every drawer whose name belong to that list.
1750 ;; Otherwise, ignore drawers whose name isn't in that
1751 ;; list.
1768 ;; Ignore subtrees with an exclude tag.
1771 ;; When a select tag is present in the buffer, ignore any tree
1772 ;; without it.
1774 ;; Ignore commented sub-trees.
1776 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1778 ;; Ignore tasks, if specified by `:with-tasks' property.
1790 properties-set))))))
1801 ;; `:with-timestamps' only applies to isolated timestamps
1802 ;; objects, i.e. timestamp objects in a paragraph containing only
1803 ;; timestamps and whitespaces.
1811 options t))))
1820 \f
1821 ;;; The Transcoder
1822 ;;
1823 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1824 ;; `org-element-parse-buffer') and transcodes it into a specified
1825 ;; back-end output. It takes care of filtering out elements or
1826 ;; objects according to export options and organizing the output blank
1827 ;; lines and white space are preserved. The function memoizes its
1828 ;; results, so it is cheap to call it within transcoders.
1829 ;;
1830 ;; It is possible to modify locally the back-end used by
1831 ;; `org-export-data' or even use a temporary back-end by using
1832 ;; `org-export-data-with-backend'.
1833 ;;
1834 ;; `org-export-transcoder' is an accessor returning appropriate
1835 ;; translator function for a given element or object.
1838 "Return appropriate transcoder for BLOB.
1839 INFO is a plist containing export directives."
1841 ;; Return contents only for complete parse trees.
1847 "Convert DATA into current back-end format.
1849 DATA is a parse tree, an element or an object or a secondary
1850 string. INFO is a plist holding export options.
1852 Return a string."
1857 ;; Ignored element/object.
1859 ;; Plain text.
1865 info))
1866 ;; Secondary string.
1869 ;; Element/Object without contents or, as a special
1870 ;; case, headline with archive tag and archived trees
1871 ;; restricted to title only.
1879 ;; Export snippets never return a nil value so
1880 ;; that white spaces following them are never
1881 ;; ignored.
1883 ;; Element/Object with contents.
1896 ;; Elements directly containing
1897 ;; objects must have their indentation
1898 ;; normalized first.
1900 data
1901 ;; When normalizing contents of the
1902 ;; first paragraph in an item or
1903 ;; a footnote definition, ignore
1904 ;; first line's indentation: there is
1905 ;; none and it might be misleading.
1910 data)
1917 info))))))))
1918 ;; Final result will be memoized before being returned.
1920 data
1924 ;; Append the same white space between elements or objects
1925 ;; as in the original buffer, and call appropriate filters.
1936 info)))
1937 results)))
1941 "Convert DATA into BACKEND format.
1943 DATA is an element, an object, a secondary string or a string.
1944 BACKEND is a symbol. INFO is a plist used as a communication
1945 channel.
1947 Unlike to `org-export-with-backend', this function will
1948 recursively convert DATA using BACKEND translation table."
1951 data
1952 ;; Set-up a new communication channel with translations defined in
1953 ;; BACKEND as the translate table and a new hash table for
1954 ;; memoization.
1956 info
1959 ;; Size of the hash table is reduced since this function
1960 ;; will probably be used on small trees.
1964 "Expand a parsed element or object to its original state.
1966 BLOB is either an element or an object. CONTENTS is its
1967 contents, as a string or nil.
1969 When optional argument WITH-AFFILIATED is non-nil, add affiliated
1970 keywords before output."
1975 blob contents))))
1978 \f
1979 ;;; The Filter System
1980 ;;
1981 ;; Filters allow end-users to tweak easily the transcoded output.
1982 ;; They are the functional counterpart of hooks, as every filter in
1983 ;; a set is applied to the return value of the previous one.
1984 ;;
1985 ;; Every set is back-end agnostic. Although, a filter is always
1986 ;; called, in addition to the string it applies to, with the back-end
1987 ;; used as argument, so it's easy for the end-user to add back-end
1988 ;; specific filters in the set. The communication channel, as
1989 ;; a plist, is required as the third argument.
1990 ;;
1991 ;; From the developer side, filters sets can be installed in the
1992 ;; process with the help of `org-export-define-backend', which
1993 ;; internally stores filters as an alist. Each association has a key
1994 ;; among the following symbols and a function or a list of functions
1995 ;; as value.
1996 ;;
1997 ;; - `:filter-options' applies to the property list containing export
1998 ;; options. Unlike to other filters, functions in this list accept
1999 ;; two arguments instead of three: the property list containing
2000 ;; export options and the back-end. Users can set its value through
2001 ;; `org-export-filter-options-functions' variable.
2002 ;;
2003 ;; - `:filter-parse-tree' applies directly to the complete parsed
2004 ;; tree. Users can set it through
2005 ;; `org-export-filter-parse-tree-functions' variable.
2006 ;;
2007 ;; - `:filter-body' applies to the body of the output, before template
2008 ;; translator chimes in. Users can set it through
2009 ;; `org-export-filter-body-functions' variable.
2010 ;;
2011 ;; - `:filter-final-output' applies to the final transcoded string.
2012 ;; Users can set it with `org-export-filter-final-output-functions'
2013 ;; variable.
2014 ;;
2015 ;; - `:filter-plain-text' applies to any string not recognized as Org
2016 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2017 ;; configure it.
2018 ;;
2019 ;; - `:filter-TYPE' applies on the string returned after an element or
2020 ;; object of type TYPE has been transcoded. A user can modify
2021 ;; `org-export-filter-TYPE-functions' to install these filters.
2022 ;;
2023 ;; All filters sets are applied with
2024 ;; `org-export-filter-apply-functions' function. Filters in a set are
2025 ;; applied in a LIFO fashion. It allows developers to be sure that
2026 ;; their filters will be applied first.
2027 ;;
2028 ;; Filters properties are installed in communication channel with
2029 ;; `org-export-install-filters' function.
2030 ;;
2031 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2032 ;; `org-export-before-parsing-hook') are run at the beginning of the
2033 ;; export process and just before parsing to allow for heavy structure
2034 ;; modifications.
2037 ;;;; Hooks
2040 "Hook run at the beginning of the export process.
2042 This is run before include keywords and macros are expanded and
2043 Babel code blocks executed, on a copy of the original buffer
2044 being exported. Visibility and narrowing are preserved. Point
2045 is at the beginning of the buffer.
2047 Every function in this hook will be called with one argument: the
2051 "Hook run before parsing an export buffer.
2053 This is run after include keywords and macros have been expanded
2054 and Babel code blocks executed, on a copy of the original buffer
2055 being exported. Visibility and narrowing are preserved. Point
2056 is at the beginning of the buffer.
2058 Every function in this hook will be called with one argument: the
2062 ;;;; Special Filters
2065 "List of functions applied to the export options.
2066 Each filter is called with two arguments: the export options, as
2067 a plist, and the back-end, as a symbol. It must return
2071 "List of functions applied to the parsed tree.
2072 Each filter is called with three arguments: the parse tree, as
2073 returned by `org-element-parse-buffer', the back-end, as
2074 a symbol, and the communication channel, as a plist. It must
2078 "List of functions applied to plain text.
2079 Each filter is called with three arguments: a string which
2080 contains no Org syntax, the back-end, as a symbol, and the
2081 communication channel, as a plist. It must return a string or
2085 "List of functions applied to transcoded body.
2086 Each filter is called with three arguments: a string which
2087 contains no Org syntax, the back-end, as a symbol, and the
2088 communication channel, as a plist. It must return a string or
2092 "List of functions applied to the transcoded string.
2093 Each filter is called with three arguments: the full transcoded
2094 string, the back-end, as a symbol, and the communication channel,
2095 as a plist. It must return a string that will be used as the
2099 ;;;; Elements Filters
2102 "List of functions applied to a transcoded babel-call.
2103 Each filter is called with three arguments: the transcoded data,
2104 as a string, the back-end, as a symbol, and the communication
2108 "List of functions applied to a transcoded center block.
2109 Each filter is called with three arguments: the transcoded data,
2110 as a string, the back-end, as a symbol, and the communication
2114 "List of functions applied to a transcoded clock.
2115 Each filter is called with three arguments: the transcoded data,
2116 as a string, the back-end, as a symbol, and the communication
2120 "List of functions applied to a transcoded diary-sexp.
2121 Each filter is called with three arguments: the transcoded data,
2122 as a string, the back-end, as a symbol, and the communication
2126 "List of functions applied to a transcoded drawer.
2127 Each filter is called with three arguments: the transcoded data,
2128 as a string, the back-end, as a symbol, and the communication
2132 "List of functions applied to a transcoded dynamic-block.
2133 Each filter is called with three arguments: the transcoded data,
2134 as a string, the back-end, as a symbol, and the communication
2138 "List of functions applied to a transcoded example-block.
2139 Each filter is called with three arguments: the transcoded data,
2140 as a string, the back-end, as a symbol, and the communication
2144 "List of functions applied to a transcoded export-block.
2145 Each filter is called with three arguments: the transcoded data,
2146 as a string, the back-end, as a symbol, and the communication
2150 "List of functions applied to a transcoded fixed-width.
2151 Each filter is called with three arguments: the transcoded data,
2152 as a string, the back-end, as a symbol, and the communication
2156 "List of functions applied to a transcoded footnote-definition.
2157 Each filter is called with three arguments: the transcoded data,
2158 as a string, the back-end, as a symbol, and the communication
2162 "List of functions applied to a transcoded headline.
2163 Each filter is called with three arguments: the transcoded data,
2164 as a string, the back-end, as a symbol, and the communication
2168 "List of functions applied to a transcoded horizontal-rule.
2169 Each filter is called with three arguments: the transcoded data,
2170 as a string, the back-end, as a symbol, and the communication
2174 "List of functions applied to a transcoded inlinetask.
2175 Each filter is called with three arguments: the transcoded data,
2176 as a string, the back-end, as a symbol, and the communication
2180 "List of functions applied to a transcoded item.
2181 Each filter is called with three arguments: the transcoded data,
2182 as a string, the back-end, as a symbol, and the communication
2186 "List of functions applied to a transcoded keyword.
2187 Each filter is called with three arguments: the transcoded data,
2188 as a string, the back-end, as a symbol, and the communication
2192 "List of functions applied to a transcoded latex-environment.
2193 Each filter is called with three arguments: the transcoded data,
2194 as a string, the back-end, as a symbol, and the communication
2198 "List of functions applied to a transcoded node-property.
2199 Each filter is called with three arguments: the transcoded data,
2200 as a string, the back-end, as a symbol, and the communication
2204 "List of functions applied to a transcoded paragraph.
2205 Each filter is called with three arguments: the transcoded data,
2206 as a string, the back-end, as a symbol, and the communication
2210 "List of functions applied to a transcoded plain-list.
2211 Each filter is called with three arguments: the transcoded data,
2212 as a string, the back-end, as a symbol, and the communication
2216 "List of functions applied to a transcoded planning.
2217 Each filter is called with three arguments: the transcoded data,
2218 as a string, the back-end, as a symbol, and the communication
2222 "List of functions applied to a transcoded property-drawer.
2223 Each filter is called with three arguments: the transcoded data,
2224 as a string, the back-end, as a symbol, and the communication
2228 "List of functions applied to a transcoded quote block.
2229 Each filter is called with three arguments: the transcoded quote
2230 data, as a string, the back-end, as a symbol, and the
2231 communication channel, as a plist. It must return a string or
2235 "List of functions applied to a transcoded section.
2236 Each filter is called with three arguments: the transcoded data,
2237 as a string, the back-end, as a symbol, and the communication
2241 "List of functions applied to a transcoded special block.
2242 Each filter is called with three arguments: the transcoded data,
2243 as a string, the back-end, as a symbol, and the communication
2247 "List of functions applied to a transcoded src-block.
2248 Each filter is called with three arguments: the transcoded data,
2249 as a string, the back-end, as a symbol, and the communication
2253 "List of functions applied to a transcoded table.
2254 Each filter is called with three arguments: the transcoded data,
2255 as a string, the back-end, as a symbol, and the communication
2259 "List of functions applied to a transcoded table-cell.
2260 Each filter is called with three arguments: the transcoded data,
2261 as a string, the back-end, as a symbol, and the communication
2265 "List of functions applied to a transcoded table-row.
2266 Each filter is called with three arguments: the transcoded data,
2267 as a string, the back-end, as a symbol, and the communication
2271 "List of functions applied to a transcoded verse block.
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 ;;;; Objects Filters
2280 "List of functions applied to transcoded bold text.
2281 Each filter is called with three arguments: the transcoded data,
2282 as a string, the back-end, as a symbol, and the communication
2286 "List of functions applied to transcoded code text.
2287 Each filter is called with three arguments: the transcoded data,
2288 as a string, the back-end, as a symbol, and the communication
2292 "List of functions applied to a transcoded entity.
2293 Each filter is called with three arguments: the transcoded data,
2294 as a string, the back-end, as a symbol, and the communication
2298 "List of functions applied to a transcoded export-snippet.
2299 Each filter is called with three arguments: the transcoded data,
2300 as a string, the back-end, as a symbol, and the communication
2304 "List of functions applied to a transcoded footnote-reference.
2305 Each filter is called with three arguments: the transcoded data,
2306 as a string, the back-end, as a symbol, and the communication
2310 "List of functions applied to a transcoded inline-babel-call.
2311 Each filter is called with three arguments: the transcoded data,
2312 as a string, the back-end, as a symbol, and the communication
2316 "List of functions applied to a transcoded inline-src-block.
2317 Each filter is called with three arguments: the transcoded data,
2318 as a string, the back-end, as a symbol, and the communication
2322 "List of functions applied to transcoded italic text.
2323 Each filter is called with three arguments: the transcoded data,
2324 as a string, the back-end, as a symbol, and the communication
2328 "List of functions applied to a transcoded latex-fragment.
2329 Each filter is called with three arguments: the transcoded data,
2330 as a string, the back-end, as a symbol, and the communication
2334 "List of functions applied to a transcoded line-break.
2335 Each filter is called with three arguments: the transcoded data,
2336 as a string, the back-end, as a symbol, and the communication
2340 "List of functions applied to a transcoded link.
2341 Each filter is called with three arguments: the transcoded data,
2342 as a string, the back-end, as a symbol, and the communication
2346 "List of functions applied to a transcoded radio-target.
2347 Each filter is called with three arguments: the transcoded data,
2348 as a string, the back-end, as a symbol, and the communication
2352 "List of functions applied to a transcoded statistics-cookie.
2353 Each filter is called with three arguments: the transcoded data,
2354 as a string, the back-end, as a symbol, and the communication
2358 "List of functions applied to transcoded strike-through text.
2359 Each filter is called with three arguments: the transcoded data,
2360 as a string, the back-end, as a symbol, and the communication
2364 "List of functions applied to a transcoded subscript.
2365 Each filter is called with three arguments: the transcoded data,
2366 as a string, the back-end, as a symbol, and the communication
2370 "List of functions applied to a transcoded superscript.
2371 Each filter is called with three arguments: the transcoded data,
2372 as a string, the back-end, as a symbol, and the communication
2376 "List of functions applied to a transcoded target.
2377 Each filter is called with three arguments: the transcoded data,
2378 as a string, the back-end, as a symbol, and the communication
2382 "List of functions applied to a transcoded timestamp.
2383 Each filter is called with three arguments: the transcoded data,
2384 as a string, the back-end, as a symbol, and the communication
2388 "List of functions applied to transcoded underline text.
2389 Each filter is called with three arguments: the transcoded data,
2390 as a string, the back-end, as a symbol, and the communication
2394 "List of functions applied to transcoded verbatim text.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2400 ;;;; Filters Tools
2401 ;;
2402 ;; Internal function `org-export-install-filters' installs filters
2403 ;; hard-coded in back-ends (developer filters) and filters from global
2404 ;; variables (user filters) in the communication channel.
2405 ;;
2406 ;; Internal function `org-export-filter-apply-functions' takes care
2407 ;; about applying each filter in order to a given data. It ignores
2408 ;; filters returning a nil value but stops whenever a filter returns
2409 ;; an empty string.
2412 "Call every function in FILTERS.
2414 Functions are called with arguments VALUE, current export
2415 back-end's name and INFO. A function returning a nil value will
2416 be skipped. If it returns the empty string, the process ends and
2417 VALUE is ignored.
2419 Call is done in a LIFO fashion, to be sure that developer
2420 specified filters, if any, are called first."
2431 "Install filters properties in communication channel.
2432 INFO is a plist containing the current communication channel.
2433 Return the updated communication channel."
2435 ;; Install user-defined filters with `org-export-filters-alist'
2436 ;; and filters already in INFO (through ext-plist mechanism).
2443 ;; Filters in INFO will be called
2444 ;; before those user provided.
2447 default-value)))))
2448 org-export-filters-alist)
2449 ;; Prepend back-end specific filters to that list.
2451 ;; Single values get consed, lists are appended.
2456 plist key
2460 ;; Return new communication channel.
2464 \f
2465 ;;; Core functions
2466 ;;
2467 ;; This is the room for the main function, `org-export-as', along with
2468 ;; its derivative, `org-export-string-as'.
2469 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2470 ;; function should be added to kill ring.
2471 ;;
2472 ;; Note that `org-export-as' doesn't really parse the current buffer,
2473 ;; but a copy of it (with the same buffer-local variables and
2474 ;; visibility), where macros and include keywords are expanded and
2475 ;; Babel blocks are executed, if appropriate.
2476 ;; `org-export-with-buffer-copy' macro prepares that copy.
2477 ;;
2478 ;; File inclusion is taken care of by
2479 ;; `org-export-expand-include-keyword' and
2480 ;; `org-export--prepare-file-contents'. Structure wise, including
2481 ;; a whole Org file in a buffer often makes little sense. For
2482 ;; example, if the file contains a headline and the include keyword
2483 ;; was within an item, the item should contain the headline. That's
2484 ;; why file inclusion should be done before any structure can be
2485 ;; associated to the file, that is before parsing.
2486 ;;
2487 ;; `org-export-insert-default-template' is a command to insert
2488 ;; a default template (or a back-end specific template) at point or in
2489 ;; current subtree.
2492 "Return a copy of the current buffer.
2493 The copy preserves Org buffer-local variables, visibility and
2494 narrowing."
2500 new-buf))
2503 "Apply BODY in a copy of the current buffer.
2504 The copy preserves local variables, visibility and contents of
2505 the original buffer. Point is at the beginning of the buffer
2506 when BODY is applied."
2515 ;; Kill copy without confirmation.
2521 "Generate a function duplicating BUFFER.
2523 The copy will preserve local variables, visibility, contents and
2524 narrowing of the original buffer. If a region was active in
2525 BUFFER, contents will be narrowed to that region instead.
2527 The resulting function can be evaluated at a later time, from
2528 another buffer, effectively cloning the original buffer there.
2530 The function assumes BUFFER's major mode is `org-mode'."
2534 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2535 ;; already in BUFFER.
2537 ;; Copy specific buffer local variables and variables set
2538 ;; through BIND keywords.
2540 vars)
2548 buffer-file-name
2549 buffer-file-coding-system))
2553 ;; Skip unreadable values, as they cannot be
2554 ;; sent to external process.
2558 vars))))))
2559 ;; Whole buffer contents.
2564 ;; Narrowing.
2568 ;; Current position of point.
2570 ;; Overlays with invisible property.
2580 ov-set))))
2582 ov-set)))))
2585 "Delete commented areas in the buffer.
2586 Commented areas are comments, comment blocks, commented trees and
2587 inlinetasks. Trailing blank lines after a comment or a comment
2588 block are preserved. Narrowing, if any, is ignored."
2609 "Prune non exportable elements from DATA.
2610 DATA is the parse tree to traverse. INFO is the plist holding
2611 export info. Also set `:ignore-list' in INFO to a list of
2612 objects which should be ignored during export, but not removed
2613 from tree."
2615 ;; First find trees containing a select tag, if any.
2619 ;; Prune non-exportable elements and objects from tree.
2620 ;; As a special case, special rows and cells from tables
2621 ;; are stored in IGNORE, as they still need to be
2622 ;; accessed during export.
2632 ;; If headline is archived but tree below has
2633 ;; to be skipped, remove contents.
2635 ;; Move into recursive objects/elements.
2637 ;; Move into secondary string, if any.
2639 org-element-secondary-value-alist)))
2641 ;; If a select tag is active, also ignore the section before the
2642 ;; first headline, if any.
2647 ;; Prune tree and communication channel.
2651 ;; Priority is given to back-end specific options.
2653 org-export-options-alist))
2656 ;; Eventually set `:ignore-list'.
2660 "Change uninterpreted elements back into Org syntax.
2661 DATA is the parse tree. INFO is a plist containing export
2662 options. Each uninterpreted element or object is changed back
2663 into a string. Contents, if any, are not modified. The parse
2664 tree is modified by side effect."
2670 p
2673 info))))))
2676 "Change uninterpreted elements back into Org syntax.
2677 DATA is a parse tree or a secondary string. INFO is a plist
2678 containing export options. It is modified by side effect and
2679 returned by the function."
2682 subscript superscript underline)
2686 ;; ... entities...
2693 ?\s)))))
2694 ;; ... emphasis...
2706 marker
2710 ?\s)))))))
2711 ;; ... LaTeX environments and fragments...
2715 ;; ... sub/superscripts...
2724 "_"
2733 ?\s)))))))))))
2735 ;; Splice NEW at BLOB location in parse tree.
2738 info nil nil t)
2739 ;; Return modified parse tree.
2740 data)
2743 "Insert footnote definitions outside parsing scope in TREE.
2745 If there is a footnote section in TREE, definitions found are
2746 appended to it. If `org-footnote-section' is non-nil, a new
2747 footnote section containing all definitions is inserted in TREE.
2748 Otherwise, definitions are appended at the end of the section
2749 containing their first reference.
2751 Only definitions actually referred to within TREE, directly or
2752 not, are considered."
2771 definitions))
2779 'footnote-definition
2785 definitions))))))))
2786 ;; Collect all out of scope definitions.
2796 ;; Filter out definitions referenced neither in the original
2797 ;; tree nor in the external definitions.
2802 definitions))
2805 referenced-labels)))
2810 definitions)))
2811 ;; Install definitions in subtree.
2814 ;; If there is a footnote section, insert them here.
2819 nil t)))
2822 ;; If there should be a footnote section, create one containing
2823 ;; all the definitions at the end of the tree.
2826 tree
2832 'section
2833 nil
2835 ;; Otherwise add each definition at the end of the section where
2836 ;; it is first referenced.
2841 ;; Insert definitions in the same section as
2842 ;; their first reference in DATA.
2854 d)
2855 label)
2862 definition)
2864 definition)))))))))))
2867 ;;;###autoload
2870 "Transcode current Org buffer into BACKEND code.
2872 BACKEND is either an export back-end, as returned by, e.g.,
2873 `org-export-create-backend', or a symbol referring to
2874 a registered back-end.
2876 If narrowing is active in the current buffer, only transcode its
2877 narrowed part.
2879 If a region is active, transcode that region.
2881 When optional argument SUBTREEP is non-nil, transcode the
2882 sub-tree at point, extracting information from the headline
2883 properties first.
2885 When optional argument VISIBLE-ONLY is non-nil, don't export
2886 contents of hidden elements.
2888 When optional argument BODY-ONLY is non-nil, only return body
2889 code, without surrounding template.
2891 Optional argument EXT-PLIST, when provided, is a property list
2892 with external parameters overriding Org default settings, but
2893 still inferior to file-local settings.
2895 Return code as a string."
2900 ;; Narrow buffer to an appropriate region or subtree for
2901 ;; parsing. If parsing subtree, be sure to remove main headline
2902 ;; too.
2910 ;; Initialize communication channel with original buffer
2911 ;; attributes, unavailable in its copy.
2924 org-export-options-alist))))
2925 tree)
2926 ;; Update communication channel and get parse tree. Buffer
2927 ;; isn't parsed directly. Instead, all buffer modifications
2928 ;; and consequent parsing are undertaken in a temporary copy.
2930 ;; Run first hook with current back-end's name as argument.
2933 ;; Include files, delete comments and expand macros.
2938 ;; Refresh buffer properties and radio targets after
2939 ;; potentially invasive previous changes. Likewise, do it
2940 ;; again after executing Babel code.
2946 ;; Run last hook with current back-end's name as argument.
2947 ;; Update buffer properties and radio targets one last time
2948 ;; before parsing.
2955 ;; Update communication channel with environment. Also
2956 ;; install user's and developer's filters.
2961 ;; Call options filters and update export options. We do not
2962 ;; use `org-export-filter-apply-functions' here since the
2963 ;; arity of such filters is different.
2968 ;; Expand export-specific set of macros: {{{author}}},
2969 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2970 ;; be done once regular macros have been expanded, since
2971 ;; parsed keywords may contain one of them.
2984 value)
2985 value)))
2989 'finalize
2990 parsed-keywords)
2991 ;; Parse buffer.
2993 ;; Merge footnote definitions outside scope into parse tree.
2995 ;; Prune tree from non-exported elements and transform
2996 ;; uninterpreted elements or objects in both parse tree and
2997 ;; communication channel.
3000 ;; Call parse tree filters.
3004 ;; Now tree is complete, compute its properties and add them
3005 ;; to communication channel.
3009 ;; Eventually transcode TREE. Wrap the resulting string into
3010 ;; a template.
3019 info))
3022 ;; Remove all text properties since they cannot be
3023 ;; retrieved from an external process. Finally call
3024 ;; final-output filter and return result.
3030 info))))))))
3032 ;;;###autoload
3034 "Transcode STRING into BACKEND code.
3036 BACKEND is either an export back-end, as returned by, e.g.,
3037 `org-export-create-backend', or a symbol referring to
3038 a registered back-end.
3040 When optional argument BODY-ONLY is non-nil, only return body
3041 code, without preamble nor postamble.
3043 Optional argument EXT-PLIST, when provided, is a property list
3044 with external parameters overriding Org default settings, but
3045 still inferior to file-local settings.
3047 Return code as a string."
3053 ;;;###autoload
3055 "Replace the active region by its export to BACKEND.
3056 BACKEND is either an export back-end, as returned by, e.g.,
3057 `org-export-create-backend', or a symbol referring to
3058 a registered back-end."
3064 ;;;###autoload
3066 "Insert all export keywords with default values at beginning of line.
3068 BACKEND is a symbol referring to the name of a registered export
3069 back-end, for which specific export options should be added to
3070 the template, or `default' for default template. When it is nil,
3071 the user will be prompted for a category.
3073 If SUBTREEP is non-nil, export configuration will be set up
3074 locally for the subtree through node properties."
3084 "Options category: "
3088 org-export-registered-backends))
3089 nil t))))
3090 options keywords)
3091 ;; Populate OPTIONS and KEYWORDS.
3108 ;; Move to an appropriate location in order to insert options.
3110 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3128 ;; Then the rest of keywords, in the order specified in either
3129 ;; `org-export-options-alist' or respective export back-ends.
3150 "Expand every include keyword in buffer.
3151 Optional argument INCLUDED is a list of included file names along
3152 with their line restriction, when appropriate. It is used to
3153 avoid infinite recursion. Optional argument DIR is the current
3154 working directory. It is used to properly resolve relative
3155 paths. Optional argument FOOTNOTES is a hash-table used for
3156 storing and resolving footnotes. It is created automatically."
3162 ;; If :minlevel is not set the text-property
3163 ;; `:org-include-induced-level' will be used to determine the
3164 ;; relative level when expanding INCLUDE.
3165 ;; Only affects included Org documents.
3169 :org-include-induced-level
3171 ;; Expand INCLUDE keywords.
3177 ;; Extract arguments from keyword's value.
3180 location
3188 matched)
3194 matched)
3195 dir)))
3199 value)
3205 value)
3212 ;; Minimal level of included file defaults to the child
3213 ;; level of the current headline, if any, or one. It
3214 ;; only applies is the file is meant to be included as
3215 ;; an Org one.
3227 ;; Remove keyword.
3233 ;; Check if files has already been parsed. Look after
3234 ;; inclusion lines too, as different parts of the same file
3235 ;; can be included too.
3250 ind-str block arg-str contents ind-str block))))
3257 ind-str block contents ind-str block))))
3265 file location only-contents lines)
3266 lines)))
3270 file lines ind minlevel
3273 footnotes)))
3277 footnotes)
3279 ;; Expand footnotes after all files have been included.
3280 ;; Footnotes are stored at end of buffer.
3285 footnotes)))))))))))
3288 "Resolve absolute lines for an included file with file-link.
3290 FILE is string file-name of the file to include. LOCATION is a
3291 string name within FILE to be included (located via
3292 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3293 contents of the named element will be included, as determined
3294 Org-Element. If LINES is non-nil only those lines are included.
3296 Return a string of lines to be included in the format expected by
3297 `org-export--prepare-file-contents'."
3303 ;; Enforce consistent search.
3316 ;; Skip planning line and property-drawer.
3342 start-line
3344 (+ start-line
3347 counter))))))))
3351 "Prepare contents of FILE for inclusion and return it as a string.
3353 When optional argument LINES is a string specifying a range of
3354 lines, include only those lines.
3356 Optional argument IND, when non-nil, is an integer specifying the
3357 global indentation of returned contents. Since its purpose is to
3358 allow an included file to stay in the same environment it was
3359 created (e.g., a list item), it doesn't apply past the first
3360 headline encountered.
3362 Optional argument MINLEVEL, when non-nil, is an integer
3363 specifying the level that any top-level headline in the included
3364 file should have.
3366 Optional argument ID is an integer that will be inserted before
3367 each footnote definition and reference if FILE is an Org file.
3368 This is useful to avoid conflicts when more than one Org file
3369 with footnotes is included in a document.
3371 Optional argument FOOTNOTES is a hash-table to store footnotes in
3372 the included document."
3388 ;; Remove blank lines at beginning and end of contents. The logic
3389 ;; behind that removal is that blank lines around include keyword
3390 ;; override blank lines in included file.
3399 ;; If IND is set, preserve indentation of include keyword until
3400 ;; the first headline encountered.
3407 ;; Do not move footnote definitions out of column 0.
3413 ;; When MINLEVEL is specified, compute minimal level for headlines
3414 ;; in the file (CUR-MIN), and remove stars to each headline so
3415 ;; that headlines with minimal level have a level of MINLEVEL.
3426 ;; Only change stars, don't bother moving whole
3427 ;; sections.
3432 ;; Append ID to all footnote references and definitions, so they
3433 ;; become file specific and cannot collide with footnotes in other
3434 ;; included files. Further, collect relevant footnote definitions
3435 ;; outside of LINES, in order to reintroduce them later.
3441 ;; Generate new label from LABEL. If LABEL is akin to
3442 ;; [1] convert it to [fn:--ID-1]. Otherwise add "-ID-"
3443 ;; after "fn:".
3449 ;; Replace OLD label with NEW in footnote F.
3463 ;; Update the footnote-reference at point and collect
3464 ;; the new label, which is only used for footnotes
3465 ;; outsides LINES.
3477 ;; Store since footnote-definition is
3478 ;; outside of LINES.
3481 footnotes))))
3488 "Execute every Babel code in the visible part of current buffer."
3489 ;; Get a pristine copy of current buffer so Babel references can be
3490 ;; properly resolved.
3496 "Return a non-nil value when output should be added to the kill ring.
3497 See also `org-export-copy-to-kill-ring'."
3503 \f
3504 ;;; Tools For Back-Ends
3505 ;;
3506 ;; A whole set of tools is available to help build new exporters. Any
3507 ;; function general enough to have its use across many back-ends
3508 ;; should be added here.
3510 ;;;; For Affiliated Keywords
3511 ;;
3512 ;; `org-export-read-attribute' reads a property from a given element
3513 ;; as a plist. It can be used to normalize affiliated keywords'
3514 ;; syntax.
3515 ;;
3516 ;; Since captions can span over multiple lines and accept dual values,
3517 ;; their internal representation is a bit tricky. Therefore,
3518 ;; `org-export-get-caption' transparently returns a given element's
3519 ;; caption as a secondary string.
3522 "Turn ATTRIBUTE property from ELEMENT into a plist.
3524 When optional argument PROPERTY is non-nil, return the value of
3525 that property within attributes.
3529 properties.
3531 All values will become strings except the empty string and
3534 will become the empty string."
3548 s)
3553 ;; Ignore any string before first property with `cdr'.
3558 "Return caption from ELEMENT as a secondary string.
3560 When optional argument SHORTP is non-nil, return short caption,
3561 as a secondary string, instead.
3563 Caption lines are separated by a white space."
3571 ;;;; For Derived Back-ends
3572 ;;
3573 ;; `org-export-with-backend' is a function allowing to locally use
3574 ;; another back-end to transcode some object or element. In a derived
3575 ;; back-end, it may be used as a fall-back function once all specific
3576 ;; cases have been treated.
3579 "Call a transcoder from BACKEND on DATA.
3580 BACKEND is an export back-end, as returned by, e.g.,
3581 `org-export-create-backend', or a symbol referring to
3582 a registered back-end. DATA is an Org element, object, secondary
3583 string or string. CONTENTS, when non-nil, is the transcoded
3584 contents of DATA element, as a string. INFO, when non-nil, is
3585 the communication channel used for export, as a plist."
3595 transcoder data contents
3598 :back-end backend
3599 :translate-alist all-transcoders
3603 ;;;; For Export Snippets
3604 ;;
3605 ;; Every export snippet is transmitted to the back-end. Though, the
3606 ;; latter will only retain one type of export-snippet, ignoring
3607 ;; others, based on the former's target back-end. The function
3608 ;; `org-export-snippet-backend' returns that back-end for a given
3609 ;; export-snippet.
3612 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3613 Translation, with `org-export-snippet-translation-alist', is
3614 applied."
3618 back-end))))
3621 ;;;; For Footnotes
3622 ;;
3623 ;; `org-export-collect-footnote-definitions' is a tool to list
3624 ;; actually used footnotes definitions in the whole parse tree, or in
3625 ;; a headline, in order to add footnote listings throughout the
3626 ;; transcoded data.
3627 ;;
3628 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3629 ;; back-ends, when they need to attach the footnote definition only to
3630 ;; the first occurrence of the corresponding label.
3631 ;;
3632 ;; `org-export-get-footnote-definition' and
3633 ;; `org-export-get-footnote-number' provide easier access to
3634 ;; additional information relative to a footnote reference.
3637 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3638 INFO is the plist used as a communication channel. If no such
3639 definition can be found, raise an error."
3645 hash))))
3653 info t)
3654 cache)
3659 "Apply FUNCTION on every footnote reference in DATA.
3660 INFO is a plist containing export state. By default, as soon as
3661 a new footnote reference is encountered, FUNCTION is called onto
3662 its definition. However, if BODY-FIRST is non-nil, this step is
3663 delayed until the end of the process."
3668 ;; Search footnote references through DATA, filling
3669 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3670 ;; store footnote definitions so they can be entered
3671 ;; later.
3678 ;; Search for subsequent references in footnote
3679 ;; definition so numbering follows reading
3680 ;; logic, unless DELAYP in non-nil.
3684 definitions))
3685 ;; Do not force entering inline definitions,
3686 ;; since `org-element-map' already traverses
3687 ;; them at the right time.
3691 nil))))))
3692 info nil
3693 ;; Don't enter footnote definitions since it will
3694 ;; happen when their first reference is found.
3695 ;; Moreover, if DELAYP is non-nil, make sure we
3696 ;; postpone entering definitions of inline references.
3703 "Return an alist between footnote numbers, labels and definitions.
3705 INFO is the current export state, as a plist.
3707 Definitions are collected throughout the whole parse tree, or
3708 DATA when non-nil.
3710 Sorting is done by order of references. As soon as a new
3711 reference is encountered, other references are searched within
3712 its definition. However, if BODY-FIRST is non-nil, this step is
3713 delayed after the whole tree is checked. This alters results
3714 when references are found in footnote definitions.
3716 Definitions either appear as Org data or as a secondary string
3717 for inlined footnotes. Unreferenced definitions are ignored."
3721 ;; Collect footnote number, label and definition.
3732 "Non-nil when a footnote reference is the first one for its label.
3734 FOOTNOTE-REFERENCE is the footnote reference being considered.
3735 INFO is a plist containing current export state.
3737 Search is done throughout the whole parse tree, or DATA when
3738 non-nil.
3740 By default, as soon as a new footnote reference is encountered,
3741 other references are searched within its definition. However, if
3742 BODY-FIRST is non-nil, this step is delayed after the whole tree
3743 is checked. This alters results when references are found in
3744 footnote definitions."
3746 ;; Anonymous footnotes are always a first reference.
3757 "Return number associated to a footnote.
3759 FOOTNOTE is either a footnote reference or a footnote definition.
3760 INFO is the plist containing export state.
3762 Number is unique throughout the whole parse tree, or DATA, when
3763 non-nil.
3765 By default, as soon as a new footnote reference is encountered,
3766 counting process moves into its definition. However, if
3767 BODY-FIRST is non-nil, this step is delayed until the end of the
3768 process, leading to a different order when footnotes are nested."
3777 ;; Anonymous footnote match: return number.
3779 ;; Labels match: return number.
3781 ;; Otherwise store label and increase counter if label
3782 ;; wasn't encountered yet.
3788 ;;;; For Headlines
3789 ;;
3790 ;; `org-export-get-relative-level' is a shortcut to get headline
3791 ;; level, relatively to the lower headline level in the parsed tree.
3792 ;;
3793 ;; `org-export-get-headline-number' returns the section number of an
3794 ;; headline, while `org-export-number-to-roman' allows to convert it
3795 ;; to roman numbers. With an optional argument,
3796 ;; `org-export-get-headline-number' returns a number to unnumbered
3797 ;; headlines (used for internal id).
3798 ;;
3799 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3800 ;; `org-export-last-sibling-p' are three useful predicates when it
3801 ;; comes to fulfill the `:headline-levels' property.
3802 ;;
3803 ;; `org-export-get-tags', `org-export-get-category' and
3804 ;; `org-export-get-node-property' extract useful information from an
3805 ;; headline or a parent headline. They all handle inheritance.
3806 ;;
3807 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3808 ;; as a secondary string, suitable for table of contents. It falls
3809 ;; back onto default title.
3812 "Return HEADLINE relative level within current parsed tree.
3813 INFO is a plist holding contextual information."
3818 "Non-nil when HEADLINE is considered as low level.
3820 INFO is a plist used as a communication channel.
3822 A low level headlines has a relative level greater than
3823 `:headline-levels' property value.
3825 Return value is the difference between HEADLINE relative level
3826 and the last level being considered as high enough, or nil."
3833 "Return numbered HEADLINE numbering as a list of numbers.
3834 INFO is a plist holding contextual information."
3839 "Return a non-nil value if HEADLINE element should be numbered.
3840 INFO is a plist used as a communication channel."
3849 "Convert integer N into a roman numeral."
3862 res)))
3865 "Return list of tags associated to ELEMENT.
3867 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3868 is a plist used as a communication channel.
3870 Select tags (see `org-export-select-tags') and exclude tags (see
3871 `org-export-exclude-tags') are removed from the list.
3873 When non-nil, optional argument TAGS should be a list of strings.
3874 Any tag belonging to this list will also be removed.
3876 When optional argument INHERITED is non-nil, tags can also be
3877 inherited from parent headlines and FILETAGS keywords."
3883 ;; Build complete list of inherited tags.
3890 ;; Add FILETAGS keywords and return results.
3894 "Return node PROPERTY value for BLOB.
3896 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3897 element or object.
3899 If optional argument INHERITED is non-nil, the value can be
3900 inherited from a parent headline.
3902 Return value is a string or nil."
3914 "Return category for element or object BLOB.
3916 INFO is a plist used as a communication channel.
3918 CATEGORY is automatically inherited from a parent headline, from
3919 #+CATEGORY: keyword or created out of original file name. If all
3932 "Return alternative title for HEADLINE, as a secondary string.
3933 If no optional title is defined, fall-back to the regular title."
3940 "Non-nil when BLOB is the first sibling in its parent.
3941 BLOB is an element or an object. If BLOB is a headline, non-nil
3942 means it is the first sibling in the sub-tree. INFO is a plist
3943 used as a communication channel."
3948 "Non-nil when BLOB is the last sibling in its parent.
3949 BLOB is an element or an object. INFO is a plist used as
3950 a communication channel."
3954 ;;;; For Keywords
3955 ;;
3956 ;; `org-export-get-date' returns a date appropriate for the document
3957 ;; to about to be exported. In particular, it takes care of
3958 ;; `org-export-date-timestamp-format'.
3961 "Return date value for the current document.
3963 INFO is a plist used as a communication channel. FMT, when
3964 non-nil, is a time format string that will be applied on the date
3965 if it consists in a single timestamp object. It defaults to
3966 `org-export-date-timestamp-format' when nil.
3968 A proper date can be a secondary string, a string or nil. It is
3969 meant to be translated with `org-export-data' or alike."
3980 ;;;; For Links
3981 ;;
3982 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3983 ;; with `org-add-link-type', which see.
3984 ;;
3985 ;; `org-export-get-coderef-format' returns an appropriate format
3986 ;; string for coderefs.
3987 ;;
3988 ;; `org-export-inline-image-p' returns a non-nil value when the link
3989 ;; provided should be considered as an inline image.
3990 ;;
3991 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3992 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3993 ;; returns an appropriate unique identifier when found, or nil.
3994 ;;
3995 ;; `org-export-resolve-id-link' returns the first headline with
3996 ;; specified id or custom-id in parse tree, the path to the external
3997 ;; file with the id or nil when neither was found.
3998 ;;
3999 ;; `org-export-resolve-coderef' associates a reference to a line
4000 ;; number in the element it belongs, or returns the reference itself
4001 ;; when the element isn't numbered.
4002 ;;
4003 ;; `org-export-file-uri' expands a filename as stored in :path value
4004 ;; of a "file" link into a file URI.
4007 "Try exporting LINK with a dedicated function.
4009 DESC is its description, as a string, or nil. BACKEND is the
4010 back-end used for export, as a symbol.
4012 Return output as a string, or nil if no protocol handles LINK.
4014 A custom protocol has precedence over regular back-end export.
4015 The function ignores links with an implicit type (e.g.,
4024 desc
4025 backend))))))
4028 "Return format string for code reference link.
4029 PATH is the link path. DESC is its description."
4037 "Non-nil if LINK object points to an inline image.
4039 Optional argument is a set of RULES defining inline images. It
4040 is an alist where associations have the following shape:
4042 (TYPE . REGEXP)
4044 Applying a rule means apply REGEXP against LINK's path when its
4045 type is TYPE. The function will return a non-nil value if any of
4046 the provided rules is non-nil. The default rule is
4047 `org-export-default-inline-image-rule'.
4049 This only applies to links without a description."
4060 "Resolve a code reference REF.
4062 INFO is a plist used as a communication channel.
4064 Return associated line number in source code, or REF itself,
4065 depending on src-block or example element's switches. Throw an
4066 error if no block contains REF."
4073 org-coderef-label-format)))
4077 ;; Element containing REF is found. Resolve it to
4078 ;; either a label or a line number, as needed.
4089 "Return LINK destination.
4091 INFO is a plist holding contextual information.
4093 Return value can be an object or an element:
4095 - If LINK path matches a target object (i.e. <<path>>) return it.
4097 - If LINK path exactly matches the name affiliated keyword
4098 (i.e. #+NAME: path) of an element, return that element.
4100 - If LINK path exactly matches any headline name, return that
4101 element.
4103 - Otherwise, throw an error.
4106 significant."
4109 ;; Split PATH at white spaces so matches are space
4110 ;; insensitive.
4116 :resolve-fuzzy-link-cache
4123 path
4125 ;; First try to find a matching "<<path>>" unless user
4126 ;; specified he was looking for a headline (path starts with
4127 ;; a "*" character).
4133 path)
4134 datum))
4136 ;; Then try to find an element with a matching "#+NAME: path"
4137 ;; affiliated keyword.
4144 ;; Try to find a matching headline.
4151 path)
4152 h))
4155 link-cache)))))
4158 "Return headline referenced as LINK destination.
4160 INFO is a plist used as a communication channel.
4162 Return value can be the headline element matched in current parse
4166 ;; First check if id is within the current parse tree.
4171 headline))
4173 ;; Otherwise, look for external files.
4178 "Return radio-target object referenced as LINK destination.
4180 INFO is a plist used as a communication channel.
4182 Return value can be a radio-target object or nil. Assume LINK
4191 nil nil path nil nil t)
4192 t)
4193 radio))
4197 "Return file URI associated to FILENAME."
4204 ;;;; For References
4205 ;;
4206 ;; `org-export-get-reference' associate a unique reference for any
4207 ;; object or element.
4208 ;;
4209 ;; `org-export-get-ordinal' associates a sequence number to any object
4210 ;; or element.
4213 "Return a unique reference for DATUM, as a string.
4214 DATUM is either an element or an object. INFO is the current
4215 export state, as a plist. Returned reference consists of
4216 alphanumeric characters only."
4221 h))))
4229 cache))))
4232 "Return ordinal number of an element or object.
4234 ELEMENT is the element or object considered. INFO is the plist
4235 used as a communication channel.
4237 Optional argument TYPES, when non-nil, is a list of element or
4238 object types, as symbols, that should also be counted in.
4239 Otherwise, only provided element's type is considered.
4241 Optional argument PREDICATE is a function returning a non-nil
4242 value if the current element or object should be counted in. It
4243 accepts two arguments: the element or object being considered and
4244 the plist used as a communication channel. This allows to count
4245 only a certain type of objects (i.e. inline images).
4247 Return value is a list of numbers if ELEMENT is a headline or an
4248 item. It is nil for keywords. It represents the footnote number
4249 for footnote definitions and footnote references. If ELEMENT is
4250 a target, return the same value as if ELEMENT was the closest
4251 table, item or headline containing the target. In any other
4252 case, return the sequence number of ELEMENT among elements or
4253 objects of the same type."
4254 ;; Ordinal of a target object refer to the ordinal of the closest
4255 ;; table, item, or headline containing the object.
4259 element
4262 ;; Special case 1: A headline returns its number as a list.
4264 ;; Special case 2: An item returns its number as a list.
4268 struct
4275 ;; Increment counter until ELEMENT is found again.
4286 ;;;; For Src-Blocks
4287 ;;
4288 ;; `org-export-get-loc' counts number of code lines accumulated in
4289 ;; src-block or example-block elements with a "+n" switch until
4290 ;; a given element, excluded. Note: "-n" switches reset that count.
4291 ;;
4292 ;; `org-export-unravel-code' extracts source code (along with a code
4293 ;; references alist) from an `element-block' or `src-block' type
4294 ;; element.
4295 ;;
4296 ;; `org-export-format-code' applies a formatting function to each line
4297 ;; of code, providing relative line number and code reference when
4298 ;; appropriate. Since it doesn't access the original element from
4299 ;; which the source code is coming, it expects from the code calling
4300 ;; it to know if lines should be numbered and if code references
4301 ;; should appear.
4302 ;;
4303 ;; Eventually, `org-export-format-code-default' is a higher-level
4304 ;; function (it makes use of the two previous functions) which handles
4305 ;; line numbering and code references inclusion, and returns source
4306 ;; code in a format suitable for plain text or verbatim output.
4309 "Return accumulated lines of code up to ELEMENT.
4311 INFO is the plist used as a communication channel.
4313 ELEMENT is excluded from count."
4319 ;; ELEMENT is reached: Quit the loop.
4321 ;; Only count lines from src-block and example-block elements
4322 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4326 ;; Accumulate locs or reset them.
4330 ;; Return nil to stay in the loop.
4331 nil)))
4333 ;; Return value.
4334 loc))
4337 "Clean source code and extract references out of it.
4339 ELEMENT has either a `src-block' an `example-block' type.
4341 Return a cons cell whose CAR is the source code, cleaned from any
4342 reference, protective commas and spurious indentation, and CDR is
4343 an alist between relative line number (integer) and name of code
4344 reference on that line (string)."
4347 ;; Get code and clean it. Remove blank lines at its
4348 ;; beginning and end.
4355 value
4357 ;; Get format used for references.
4360 org-coderef-label-format)))
4361 ;; Build a regexp matching a loc with a reference.
4366 ;; Return value.
4368 ;; Code with references removed.
4374 ;; Ref line: remove ref, and signal its position in REFS.
4378 ;; Reference alist.
4379 refs)))
4382 "Format CODE by applying FUN line-wise and return it.
4384 CODE is a string representing the code to format. FUN is
4385 a function. It must accept three arguments: a line of
4386 code (string), the current line number (integer) or nil and the
4387 reference associated to the current line (string) or nil.
4389 Optional argument NUM-LINES can be an integer representing the
4390 number of code lines accumulated until the current code. Line
4391 numbers passed to FUN will take it into account. If it is nil,
4392 FUN's second argument will always be nil. This number can be
4393 obtained with `org-export-get-loc' function.
4395 Optional argument REF-ALIST can be an alist between relative line
4396 number (i.e. ignoring NUM-LINES) and the name of the code
4397 reference on it. If it is nil, FUN's third argument will always
4398 be nil. It can be obtained through the use of
4399 `org-export-unravel-code' function."
4411 "Return source code from ELEMENT, formatted in a standard way.
4413 ELEMENT is either a `src-block' or `example-block' element. INFO
4414 is a plist used as a communication channel.
4416 This function takes care of line numbering and code references
4417 inclusion. Line numbers, when applicable, appear at the
4418 beginning of the line, separated from the code by two white
4419 spaces. Code references, on the other hand, appear flushed to
4420 the right, separated by six white spaces from the widest line of
4421 code."
4422 ;; Extract code and references.
4429 ;; Handle line numbering.
4438 ;; Prepare references display, if required. Any reference
4439 ;; should start six columns after the widest line of code,
4440 ;; wrapped with parenthesis.
4445 code
4449 number-str
4450 loc
4456 num-start refs)))))
4459 ;;;; For Tables
4460 ;;
4461 ;; `org-export-table-has-special-column-p' and and
4462 ;; `org-export-table-row-is-special-p' are predicates used to look for
4463 ;; meta-information about the table structure.
4464 ;;
4465 ;; `org-table-has-header-p' tells when the rows before the first rule
4466 ;; should be considered as table's header.
4467 ;;
4468 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4469 ;; and `org-export-table-cell-borders' extract information from
4470 ;; a table-cell element.
4471 ;;
4472 ;; `org-export-table-dimensions' gives the number on rows and columns
4473 ;; in the table, ignoring horizontal rules and special columns.
4474 ;; `org-export-table-cell-address', given a table-cell object, returns
4475 ;; the absolute address of a cell. On the other hand,
4476 ;; `org-export-get-table-cell-at' does the contrary.
4477 ;;
4478 ;; `org-export-table-cell-starts-colgroup-p',
4479 ;; `org-export-table-cell-ends-colgroup-p',
4480 ;; `org-export-table-row-starts-rowgroup-p',
4481 ;; `org-export-table-row-ends-rowgroup-p',
4482 ;; `org-export-table-row-starts-header-p',
4483 ;; `org-export-table-row-ends-header-p' and
4484 ;; `org-export-table-row-in-header-p' indicate position of current row
4485 ;; or cell within the table.
4488 "Non-nil when TABLE has a special column.
4489 All special columns will be ignored during export."
4490 ;; The table has a special column when every first cell of every row
4491 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4492 ;; "*" "_" and "^". Though, do not consider a first row containing
4493 ;; only empty cells as special.
4509 "Non-nil when TABLE has a header.
4511 INFO is a plist used as a communication channel.
4513 A table has a header when it contains at least two row groups."
4522 table
4533 cache)))))
4536 "Non-nil if TABLE-ROW is considered special.
4537 All special rows will be ignored during export."
4541 ;; A row is special either when...
4543 ;; ... it starts with a field only containing "/",
4545 ;; ... the table contains a special column and the row start
4546 ;; with a marking character among, "^", "_", "$" or "!",
4550 ;; ... it contains only alignment cookies and empty cells.
4556 ;; Since VALUE is a secondary string, the following
4557 ;; checks avoid expanding it with `org-export-data'.
4569 "Return TABLE-ROW's group number, as an integer.
4571 INFO is a plist used as the communication channel.
4573 Return value is the group number, as an integer, or nil for
4574 special rows and rows separators. First group is also table's
4575 header."
4593 "Return TABLE-CELL contents width.
4595 INFO is a plist used as the communication channel.
4597 Return value is the width given by the last width cookie in the
4598 same column as TABLE-CELL, or nil."
4617 ;; In a special row, try to find a width cookie at COLUMN.
4621 ;; The following checks avoid expanding unnecessarily
4622 ;; the cell with `org-export-data'.
4632 "Return TABLE-CELL contents alignment.
4634 INFO is a plist used as the communication channel.
4636 Return alignment as specified by the last alignment cookie in the
4637 same column as TABLE-CELL. If no such cookie is found, a default
4638 alignment value will be deduced from fraction of numbers in the
4639 column (see `org-table-number-fraction' for more information).
4640 Possible values are `left', `right' and `center'."
4641 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4658 cookie-align
4659 previous-cell-number-p)
4662 ;; In a special row, try to find an alignment cookie at
4663 ;; COLUMN.
4667 ;; Since VALUE is a secondary string, the following
4668 ;; checks avoid useless expansion through
4669 ;; `org-export-data'.
4677 ;; Ignore table rules.
4679 ;; In a standard row, check if cell's contents are
4680 ;; expressing some kind of number. Increase NUMBER-CELLS
4681 ;; accordingly. Though, don't bother if an alignment
4682 ;; cookie has already defined cell's alignment.
4687 info)))
4689 ;; Treat an empty cell as a number if it follows
4690 ;; a number.
4696 ;; Return value. Alignment specified by cookies has
4697 ;; precedence over alignment deduced from cell's contents.
4699 column
4704 org-table-number-fraction)
4709 "Return TABLE-CELL borders.
4711 INFO is a plist used as a communication channel.
4713 Return value is a list of symbols, or nil. Possible values are:
4714 `top', `bottom', `above', `below', `left' and `right'. Note:
4715 `top' (resp. `bottom') only happen for a cell in the first
4716 row (resp. last row) of the table, ignoring table rules, if any.
4718 Returned borders ignore special rows."
4721 borders)
4722 ;; Top/above border? TABLE-CELL has a border above when a rule
4723 ;; used to demarcate row groups can be found above. Hence,
4724 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4725 ;; another regular row has to be found above that rule.
4734 ;; Look at every row before the current one.
4736 ;; No rule above, or rule found starts the table (ignoring any
4737 ;; special row): TABLE-CELL is at the top of the table.
4740 ;; Bottom/below border? TABLE-CELL has a border below when next
4741 ;; non-regular row below is a rule.
4750 ;; Look at every row after the current one.
4752 ;; No rule below, or rule found ends the table (modulo some
4753 ;; special row): TABLE-CELL is at the bottom of the table.
4756 ;; Right/left borders? They can only be specified by column
4757 ;; groups. Column groups are defined in a row starting with "/".
4758 ;; Also a column groups row only contains "<", "<>", ">" or blank
4759 ;; cells.
4776 ;; There's a left border when previous cell, if
4777 ;; any, ends a group, or current one starts one.
4783 ;; There's a right border when next cell, if any,
4784 ;; starts a group, or current one ends one.
4791 ;; Table rows are read in reverse order so last column groups
4792 ;; row has precedence over any previous one.
4794 ;; Return value.
4795 borders))
4798 "Non-nil when TABLE-CELL is at the beginning of a column group.
4799 INFO is a plist used as a communication channel."
4800 ;; A cell starts a column group either when it is at the beginning
4801 ;; of a row (or after the special column, if any) or when it has
4802 ;; a left border.
4805 table-cell)
4809 "Non-nil when TABLE-CELL is at the end of a column group.
4810 INFO is a plist used as a communication channel."
4811 ;; A cell ends a column group either when it is at the end of a row
4812 ;; or when it has a right border.
4815 table-cell)
4819 "Non-nil when TABLE-ROW is at the beginning of a row group.
4820 INFO is a plist used as a communication channel."
4828 "Non-nil when TABLE-ROW is at the end of a row group.
4829 INFO is a plist used as a communication channel."
4837 "Non-nil when TABLE-ROW is located within table's header.
4838 INFO is a plist used as a communication channel. Always return
4839 nil for special rows and rows separators."
4845 "Non-nil when TABLE-ROW is the first table header's row.
4846 INFO is a plist used as a communication channel."
4851 "Non-nil when TABLE-ROW is the last table header's row.
4852 INFO is a plist used as a communication channel."
4857 "Return TABLE-ROW number.
4858 INFO is a plist used as a communication channel. Return value is
4859 zero-based and ignores separators. The function returns nil for
4860 special columns and separators."
4872 "Return TABLE dimensions.
4874 INFO is a plist used as a communication channel.
4876 Return value is a CONS like (ROWS . COLUMNS) where
4877 ROWS (resp. COLUMNS) is the number of exportable
4878 rows (resp. columns)."
4880 ;; Set number of rows, and extract first one.
4886 ;; Set number of columns.
4888 ;; Return value.
4892 "Return address of a regular TABLE-CELL object.
4894 TABLE-CELL is the cell considered. INFO is a plist used as
4895 a communication channel.
4897 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4898 zero-based index. Only exportable cells are considered. The
4899 function returns nil for other cells."
4911 "Return regular table-cell object at ADDRESS in TABLE.
4913 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4914 zero-based index. TABLE is a table type element. INFO is
4915 a plist used as a communication channel.
4917 If no table-cell, among exportable cells, is found at ADDRESS,
4918 return nil."
4921 ;; Row at (car address) or nil.
4929 'table-cell
4936 ;;;; For Tables Of Contents
4937 ;;
4938 ;; `org-export-collect-headlines' builds a list of all exportable
4939 ;; headline elements, maybe limited to a certain depth. One can then
4940 ;; easily parse it and transcode it.
4941 ;;
4942 ;; Building lists of tables, figures or listings is quite similar.
4943 ;; Once the generic function `org-export-collect-elements' is defined,
4944 ;; `org-export-collect-tables', `org-export-collect-figures' and
4945 ;; `org-export-collect-listings' can be derived from it.
4948 "Collect headlines in order to build a table of contents.
4950 INFO is a plist used as a communication channel.
4952 When optional argument N is an integer, it specifies the depth of
4953 the table of contents. Otherwise, it is set to the value of the
4954 last headline level. See `org-export-headline-levels' for more
4955 information.
4957 Optional argument SCOPE, when non-nil, is an element. If it is
4958 a headline, only children of SCOPE are collected. Otherwise,
4959 collect children of the headline containing provided element. If
4960 there is no such headline, collect all headlines. In any case,
4961 argument N becomes relative to the level of that headline.
4963 Return a list of all exportable headlines as parsed elements.
4964 Footnote sections are ignored."
4973 limit))))
4979 info)))
4982 "Collect referenceable elements of a determined type.
4984 TYPE can be a symbol or a list of symbols specifying element
4985 types to search. Only elements with a caption are collected.
4987 INFO is a plist used as a communication channel.
4989 When non-nil, optional argument PREDICATE is a function accepting
4990 one argument, an element of type TYPE. It returns a non-nil
4991 value when that element should be collected.
4993 Return a list of all elements found, in order of appearance."
4998 element))
4999 info))
5002 "Build a list of tables.
5003 INFO is a plist used as a communication channel.
5005 Return a list of table elements with a caption."
5009 "Build a list of figures.
5011 INFO is a plist used as a communication channel. PREDICATE is
5012 a function which accepts one argument: a paragraph element and
5013 whose return value is non-nil when that element should be
5014 collected.
5016 A figure is a paragraph type element, with a caption, verifying
5018 a vague concept that may depend on back-end.
5020 Return a list of elements recognized as figures."
5024 "Build a list of src blocks.
5026 INFO is a plist used as a communication channel.
5028 Return a list of src-block elements with a caption."
5032 ;;;; Smart Quotes
5033 ;;
5034 ;; The main function for the smart quotes sub-system is
5035 ;; `org-export-activate-smart-quotes', which replaces every quote in
5036 ;; a given string from the parse tree with its "smart" counterpart.
5037 ;;
5038 ;; Dictionary for smart quotes is stored in
5039 ;; `org-export-smart-quotes-alist'.
5043 ;; one may use: »...«, "...", ›...‹, or '...'.
5044 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5045 ;; LaTeX quotes require Babel!
5095 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5106 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5117 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5128 ;; 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
5129 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5140 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5146 "Smart quotes translations.
5148 Alist whose CAR is a language string and CDR is an alist with
5149 quote type as key and a plist associating various encodings to
5150 their translation as value.
5152 A quote type can be any symbol among `primary-opening',
5153 `primary-closing', `secondary-opening', `secondary-closing' and
5154 `apostrophe'.
5156 Valid encodings include `:utf-8', `:html', `:latex' and
5157 `:texinfo'.
5162 "Return smart quote status at the beginning of string S.
5163 INFO is the current export state, as a plist."
5168 table)))
5181 ;; Not already in a level 1 quote: this is an
5182 ;; apostrophe.
5184 ;; Extract previous char and next char. As
5185 ;; a special case, they can also be set to `blank',
5186 ;; `no-blank' or nil. Then determine if current
5187 ;; match is allowed as an opening quote or a closing
5188 ;; quote.
5193 text info)))
5210 previous)
5221 next)
5228 current-status)
5232 info nil org-element-recursive-objects)
5239 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5240 `:utf-8'. INFO is a plist used as a communication channel.
5242 The function has to retrieve information about string
5243 surroundings in parse tree. It can only happen with an
5244 unmodified string. Thus, if S has already been through another
5245 process, a non-nil ORIGINAL optional argument will provide that
5246 original string.
5248 Return the new string."
5257 org-export-smart-quotes-alist))))
5258 encoding)
5259 match))
5260 s nil t)))
5262 ;;;; Topology
5263 ;;
5264 ;; Here are various functions to retrieve information about the
5265 ;; neighborhood of a given element or object. Neighbors of interest
5266 ;; are direct parent (`org-export-get-parent'), parent headline
5267 ;; (`org-export-get-parent-headline'), first element containing an
5268 ;; object, (`org-export-get-parent-element'), parent table
5269 ;; (`org-export-get-parent-table'), previous element or object
5270 ;; (`org-export-get-previous-element') and next element or object
5271 ;; (`org-export-get-next-element').
5273 ;; defsubst org-export-get-parent must be defined before first use
5279 "Return BLOB parent headline or nil.
5280 BLOB is the element or object being considered."
5284 "Return first element containing OBJECT or nil.
5285 OBJECT is the object to consider."
5289 "Return OBJECT parent table or nil.
5290 OBJECT is either a `table-cell' or `table-element' type object."
5294 "Return previous element or object.
5296 BLOB is an element or object. INFO is a plist used as
5297 a communication channel. Return previous exportable element or
5298 object, a string, or nil.
5300 When optional argument N is a positive integer, return a list
5301 containing up to N siblings before BLOB, from farthest to
5302 closest. With any other non-nil value, return a list containing
5303 all of them."
5309 prev)
5319 "Return next element or object.
5321 BLOB is an element or object. INFO is a plist used as
5322 a communication channel. Return next exportable element or
5323 object, a string, or nil.
5325 When optional argument N is a positive integer, return a list
5326 containing up to N siblings after BLOB, from closest to farthest.
5327 With any other non-nil value, return a list containing all of
5328 them."
5335 next)
5345 ;;;; Translation
5346 ;;
5347 ;; `org-export-translate' translates a string according to the language
5348 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5349 ;; the dictionary used for the translation.
5381 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5391 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5397 ("ru" :html "(Продолжение следует)"
5471 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5494 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5500 ("ru" :html "Список распечаток"
5514 ("ru" :html "Список таблиц"
5620 ("ru" :html "Неизвестная ссылка"
5623 "Dictionary for export engine.
5625 Alist whose car is the string to translate and cdr is an alist
5626 whose car is the language string and cdr is a plist whose
5627 properties are possible charsets and values translated terms.
5629 It is used as a database for `org-export-translate'. Since this
5630 function returns the string as-is if no translation was found,
5631 the variable only needs to record values different from the
5635 "Translate string S according to language specification.
5637 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5638 and `:utf-8'. INFO is a plist used as a communication channel.
5640 Translation depends on `:language' property. Return the
5641 translated string. If no translation is found, try to fall back
5642 to `:default' encoding. If it fails, return S."
5648 s)))
5651 \f
5652 ;;; Asynchronous Export
5653 ;;
5654 ;; `org-export-async-start' is the entry point for asynchronous
5655 ;; export. It recreates current buffer (including visibility,
5656 ;; narrowing and visited file) in an external Emacs process, and
5657 ;; evaluates a command there. It then applies a function on the
5658 ;; returned results in the current process.
5659 ;;
5660 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5661 ;; allow to export to a buffer or a file, asynchronously or not.
5662 ;;
5663 ;; `org-export-output-file-name' is an auxiliary function meant to be
5664 ;; used with `org-export-to-file'. With a given extension, it tries
5665 ;; to provide a canonical file name to write export output to.
5666 ;;
5667 ;; Asynchronously generated results are never displayed directly.
5668 ;; Instead, they are stored in `org-export-stack-contents'. They can
5669 ;; then be retrieved by calling `org-export-stack'.
5670 ;;
5671 ;; Export Stack is viewed through a dedicated major mode
5672 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5673 ;;`org-export-stack-delete', `org-export-stack-view' and
5674 ;;`org-export-stack-clear'.
5675 ;;
5676 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5677 ;; It should be used whenever `org-export-async-start' is called.
5680 "Call function FUN on the results returned by BODY evaluation.
5682 FUN is an anonymous function of one argument. BODY evaluation
5683 happens in an asynchronous process, from a buffer which is an
5684 exact copy of the current one.
5686 Use `org-export-add-to-stack' in FUN in order to register results
5687 in the stack.
5689 This is a low level function. See also `org-export-to-buffer'
5690 and `org-export-to-file' for more specialized functions."
5693 ;; Write the full sexp evaluating BODY in a copy of the current
5694 ;; buffer to a temporary file, as it may be too long for program
5695 ;; args in `start-process'.
5702 ;; Null characters (from variable values) are inserted
5703 ;; within the file. As a consequence, coding system for
5704 ;; buffer contents will not be recognized properly. So,
5705 ;; we make sure it is the same as the one used to display
5706 ;; the original buffer.
5708 ,coding
5711 ;; Ignore `kill-emacs-hook' and code evaluation
5712 ;; queries from Babel as we need a truly
5713 ;; non-interactive process.
5715 org-babel-confirm-evaluate-answer-no t)
5716 ;; Initialize export framework.
5718 ;; Re-create current buffer there.
5721 ;; Sexp to evaluate in the buffer.
5723 ;; Start external process.
5726 (,process
5728 #'start-process
5731 ,proc-buffer
5738 ;; Register running process in stack.
5740 ;; Set-up sentinel in order to catch results.
5743 ,process
5765 ;;;###autoload
5768 &optional async subtreep visible-only body-only ext-plist
5769 post-process)
5770 "Call `org-export-as' with output to a specified buffer.
5772 BACKEND is either an export back-end, as returned by, e.g.,
5773 `org-export-create-backend', or a symbol referring to
5774 a registered back-end.
5776 BUFFER is the name of the output buffer. If it already exists,
5777 it will be erased first, otherwise, it will be created.
5779 A non-nil optional argument ASYNC means the process should happen
5780 asynchronously. The resulting buffer should then be accessible
5781 through the `org-export-stack' interface. When ASYNC is nil, the
5782 buffer is displayed if `org-export-show-temporary-export-buffer'
5783 is non-nil.
5785 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5786 EXT-PLIST are similar to those used in `org-export-as', which
5787 see.
5789 Optional argument POST-PROCESS is a function which should accept
5790 no argument. It is always called within the current process,
5791 from BUFFER, with point at its beginning. Export back-ends can
5792 use it to set a major mode there, e.g,
5794 (defun org-latex-export-as-latex
5795 (&optional async subtreep visible-only body-only ext-plist)
5796 (interactive)
5798 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5800 This function returns BUFFER."
5828 buffer)))
5830 ;;;###autoload
5833 post-process)
5834 "Call `org-export-as' with output to a specified file.
5836 BACKEND is either an export back-end, as returned by, e.g.,
5837 `org-export-create-backend', or a symbol referring to
5838 a registered back-end. FILE is the name of the output file, as
5839 a string.
5841 A non-nil optional argument ASYNC means the process should happen
5842 asynchronously. The resulting buffer will then be accessible
5843 through the `org-export-stack' interface.
5845 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5846 EXT-PLIST are similar to those used in `org-export-as', which
5847 see.
5849 Optional argument POST-PROCESS is called with FILE as its
5850 argument and happens asynchronously when ASYNC is non-nil. It
5851 has to return a file name, or nil. Export back-ends can use this
5852 to send the output file through additional processing, e.g,
5854 (defun org-latex-export-to-latex
5855 (&optional async subtreep visible-only body-only ext-plist)
5856 (interactive)
5859 async subtreep visible-only body-only ext-plist
5860 (lambda (file) (org-latex-compile file)))
5862 The function returns either a file name returned by POST-PROCESS,
5863 or FILE."
5882 backend subtreep visible-only body-only ext-plist)))
5889 ;; Get proper return value.
5891 file))))))
5894 "Return output file's name according to buffer specifications.
5896 EXTENSION is a string representing the output file extension,
5897 with the leading dot.
5899 With a non-nil optional argument SUBTREEP, try to determine
5901 of subtree at point.
5903 When optional argument PUB-DIR is set, use it as the publishing
5904 directory.
5906 Return file name as a string."
5909 ;; File name may come from EXPORT_FILE_NAME subtree
5910 ;; property, assuming point is at beginning of said
5911 ;; sub-tree.
5918 ;; File name may be extracted from buffer's associated
5919 ;; file, if any.
5921 ;; Can't determine file name on our own: Ask user.
5925 "Output file: " pub-dir nil nil nil
5929 ;; Build file name. Enforce EXTENSION over whatever user
5930 ;; may have come up with. PUB-DIR, if defined, always has
5931 ;; precedence over any provided path.
5936 extension))
5939 ;; If writing to OUTPUT-FILE would overwrite original file, append
5940 ;; EXTENSION another time to final name.
5943 output-file)))
5946 "Add a new result to export stack if not present already.
5948 SOURCE is a buffer or a file name containing export results.
5949 BACKEND is a symbol representing export back-end used to generate
5950 it.
5952 Entries already pointing to SOURCE and unavailable entries are
5953 removed beforehand. Return the new stack."
5959 "Menu for asynchronous export results and running processes."
5969 "Return source from export results at point in stack."
5976 source
5977 ;; SOURCE is not consistent with current line. The stack
5978 ;; view is outdated.
5982 "Remove all entries from export stack."
5987 "Refresh the asynchronous export stack.
5988 Unavailable sources are removed from the list. Return the new
5989 stack."
5998 ;; Back-end.
6000 ;; Age.
6003 ;; Compute age of the results.
6005 "%4h:%.2m "
6007 ;; Source.
6012 ;; Clear stack from exited processes, dead buffers or
6013 ;; non-existent files.
6025 "Remove export results at point from stack.
6026 If optional argument SOURCE is non-nil, remove it instead."
6031 org-export-stack-contents))))
6034 "View export results at point in stack.
6035 With an optional prefix argument IN-EMACS, force viewing files
6036 within Emacs."
6050 (define-key km "p" 'previous-line)
6051 (define-key km "\C-p" 'previous-line)
6052 (define-key km "\C-?" 'previous-line)
6053 (define-key km [up] 'previous-line)
6054 (define-key km "C" 'org-export-stack-clear)
6055 (define-key km "v" 'org-export-stack-view)
6056 (define-key km (kbd "RET") 'org-export-stack-view)
6057 (define-key km "d" 'org-export-stack-remove)
6058 km)
6059 "Keymap for Org Export Stack.")
6061 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6062 "Mode for displaying asynchronous export stack.
6065 stack.
6067 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6068 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6069 stack completely.
6071 Removing entries in an Org Export Stack buffer doesn't affect
6072 files or buffers, only the display.
6075 (abbrev-mode 0)
6076 (auto-fill-mode 0)
6077 (setq buffer-read-only t
6078 buffer-undo-list t
6079 truncate-lines t
6080 header-line-format
6081 '(:eval
6082 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6083 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6084 (set (make-local-variable 'revert-buffer-function)
6085 'org-export-stack-refresh))
6088 \f
6089 ;;; The Dispatcher
6090 ;;
6091 ;; `org-export-dispatch' is the standard interactive way to start an
6092 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6093 ;; for its interface, which, in turn, delegates response to key
6094 ;; pressed to `org-export--dispatch-action'.
6096 ;;;###autoload
6097 (defun org-export-dispatch (&optional arg)
6098 "Export dispatcher for Org mode.
6100 It provides an access to common export related tasks in a buffer.
6101 Its interface comes in two flavors: standard and expert.
6103 While both share the same set of bindings, only the former
6104 displays the valid keys associations in a dedicated buffer.
6105 Scrolling (resp. line-wise motion) in this buffer is done with
6106 SPC and DEL (resp. C-n and C-p) keys.
6108 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6109 flavor or the other.
6112 of options used back then, on the current buffer.
6114 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6115 (interactive "P")
6116 (let* ((input
6117 (cond ((equal arg '(16)) '(stack))
6118 ((and arg org-export-dispatch-last-action))
6119 (t (save-window-excursion
6120 (unwind-protect
6121 (progn
6122 ;; Remember where we are
6123 (move-marker org-export-dispatch-last-position
6124 (point)
6125 (org-base-buffer (current-buffer)))
6126 ;; Get and store an export command
6127 (setq org-export-dispatch-last-action
6128 (org-export--dispatch-ui
6129 (list org-export-initial-scope
6130 (and org-export-in-background 'async))
6131 nil
6132 org-export-dispatch-use-expert-ui)))
6133 (and (get-buffer "*Org Export Dispatcher*")
6134 (kill-buffer "*Org Export Dispatcher*")))))))
6135 (action (car input))
6136 (optns (cdr input)))
6137 (unless (memq 'subtree optns)
6138 (move-marker org-export-dispatch-last-position nil))
6139 (cl-case action
6140 ;; First handle special hard-coded actions.
6141 (template (org-export-insert-default-template nil optns))
6142 (stack (org-export-stack))
6143 (publish-current-file
6144 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6145 (publish-current-project
6146 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6147 (publish-choose-project
6148 (org-publish (assoc (org-icompleting-read
6149 "Publish project: "
6150 org-publish-project-alist nil t)
6151 org-publish-project-alist)
6152 (memq 'force optns)
6153 (memq 'async optns)))
6154 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6155 (otherwise
6156 (save-excursion
6157 (when arg
6158 ;; Repeating command, maybe move cursor to restore subtree
6159 ;; context.
6160 (if (eq (marker-buffer org-export-dispatch-last-position)
6161 (org-base-buffer (current-buffer)))
6162 (goto-char org-export-dispatch-last-position)
6163 ;; We are in a different buffer, forget position.
6164 (move-marker org-export-dispatch-last-position nil)))
6165 (funcall action
6166 ;; Return a symbol instead of a list to ease
6167 ;; asynchronous export macro use.
6168 (and (memq 'async optns) t)
6169 (and (memq 'subtree optns) t)
6170 (and (memq 'visible optns) t)
6171 (and (memq 'body optns) t)))))))
6173 (defun org-export--dispatch-ui (options first-key expertp)
6174 "Handle interface for `org-export-dispatch'.
6176 OPTIONS is a list containing current interactive options set for
6177 export. It can contain any of the following symbols:
6178 `body' toggles a body-only export
6179 `subtree' restricts export to current subtree
6180 `visible' restricts export to visible part of buffer.
6181 `force' force publishing files.
6182 `async' use asynchronous export process
6184 FIRST-KEY is the key pressed to select the first level menu. It
6185 is nil when this menu hasn't been selected yet.
6187 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6188 buffer is provided, but indications about currently active
6189 options are given in the prompt. Moreover, [?] allows to switch
6190 back to standard interface."
6191 (let* ((fontify-key
6192 (lambda (key &optional access-key)
6193 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6194 ;; non-nil is the required first-level key to activate
6195 ;; KEY. When its value is t, activate KEY independently
6196 ;; on the first key, if any. A nil value means KEY will
6197 ;; only be activated at first level.
6198 (if (or (eq access-key t) (eq access-key first-key))
6199 (org-propertize key 'face 'org-warning)
6200 key)))
6201 (fontify-value
6202 (lambda (value)
6203 ;; Fontify VALUE string.
6204 (org-propertize value 'face 'font-lock-variable-name-face)))
6205 ;; Prepare menu entries by extracting them from registered
6206 ;; back-ends and sorting them by access key and by ordinal,
6207 ;; if any.
6208 (entries
6209 (sort (sort (delq nil
6210 (mapcar #'org-export-backend-menu
6211 org-export-registered-backends))
6212 (lambda (a b)
6213 (let ((key-a (nth 1 a))
6214 (key-b (nth 1 b)))
6215 (cond ((and (numberp key-a) (numberp key-b))
6216 (< key-a key-b))
6217 ((numberp key-b) t)))))
6218 'car-less-than-car))
6219 ;; Compute a list of allowed keys based on the first key
6220 ;; pressed, if any. Some keys
6221 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6222 ;; available.
6223 (allowed-keys
6224 (nconc (list 2 22 19 6 1)
6225 (if (not first-key) (org-uniquify (mapcar 'car entries))
6226 (let (sub-menu)
6227 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6228 (when (eq (car entry) first-key)
6229 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6230 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6231 ((not first-key) (list ?P)))
6232 (list ?& ?#)
6233 (when expertp (list ??))
6234 (list ?q)))
6235 ;; Build the help menu for standard UI.
6236 (help
6237 (unless expertp
6238 (concat
6239 ;; Options are hard-coded.
6240 (format "[%s] Body only: %s [%s] Visible only: %s
6241 \[%s] Export scope: %s [%s] Force publishing: %s
6243 (funcall fontify-key "C-b" t)
6244 (funcall fontify-value
6245 (if (memq 'body options) "On " "Off"))
6246 (funcall fontify-key "C-v" t)
6247 (funcall fontify-value
6248 (if (memq 'visible options) "On " "Off"))
6249 (funcall fontify-key "C-s" t)
6250 (funcall fontify-value
6251 (if (memq 'subtree options) "Subtree" "Buffer "))
6252 (funcall fontify-key "C-f" t)
6253 (funcall fontify-value
6254 (if (memq 'force options) "On " "Off"))
6255 (funcall fontify-key "C-a" t)
6256 (funcall fontify-value
6257 (if (memq 'async options) "On " "Off")))
6258 ;; Display registered back-end entries. When a key
6259 ;; appears for the second time, do not create another
6260 ;; entry, but append its sub-menu to existing menu.
6261 (let (last-key)
6262 (mapconcat
6263 (lambda (entry)
6264 (let ((top-key (car entry)))
6265 (concat
6266 (unless (eq top-key last-key)
6267 (setq last-key top-key)
6269 (funcall fontify-key (char-to-string top-key))
6270 (nth 1 entry)))
6271 (let ((sub-menu (nth 2 entry)))
6272 (unless (functionp sub-menu)
6273 ;; Split sub-menu into two columns.
6274 (let ((index -1))
6275 (concat
6276 (mapconcat
6277 (lambda (sub-entry)
6278 (cl-incf index)
6279 (format
6280 (if (zerop (mod index 2)) " [%s] %-26s"
6282 (funcall fontify-key
6283 (char-to-string (car sub-entry))
6284 top-key)
6285 (nth 1 sub-entry)))
6286 sub-menu "")
6288 entries ""))
6289 ;; Publishing menu is hard-coded.
6291 [%s] Current file [%s] Current project
6293 (funcall fontify-key "P")
6294 (funcall fontify-key "f" ?P)
6295 (funcall fontify-key "p" ?P)
6296 (funcall fontify-key "x" ?P)
6297 (funcall fontify-key "a" ?P))
6299 (funcall fontify-key "&" t)
6300 (funcall fontify-key "#" t))
6301 (format "[%s] %s"
6302 (funcall fontify-key "q" t)
6303 (if first-key "Main menu" "Exit")))))
6304 ;; Build prompts for both standard and expert UI.
6305 (standard-prompt (unless expertp "Export command: "))
6306 (expert-prompt
6307 (when expertp
6308 (format
6309 "Export command (C-%s%s%s%s%s) [%s]: "
6310 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6311 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6312 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6313 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6314 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6315 (mapconcat (lambda (k)
6316 ;; Strip control characters.
6317 (unless (< k 27) (char-to-string k)))
6318 allowed-keys "")))))
6319 ;; With expert UI, just read key with a fancy prompt. In standard
6320 ;; UI, display an intrusive help buffer.
6321 (if expertp
6322 (org-export--dispatch-action
6323 expert-prompt allowed-keys entries options first-key expertp)
6324 ;; At first call, create frame layout in order to display menu.
6325 (unless (get-buffer "*Org Export Dispatcher*")
6326 (delete-other-windows)
6327 (org-switch-to-buffer-other-window
6328 (get-buffer-create "*Org Export Dispatcher*"))
6329 (setq cursor-type nil
6330 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6331 ;; Make sure that invisible cursor will not highlight square
6332 ;; brackets.
6333 (set-syntax-table (copy-syntax-table))
6334 (modify-syntax-entry ?\[ "w"))
6335 ;; At this point, the buffer containing the menu exists and is
6336 ;; visible in the current window. So, refresh it.
6337 (with-current-buffer "*Org Export Dispatcher*"
6338 ;; Refresh help. Maintain display continuity by re-visiting
6339 ;; previous window position.
6340 (let ((pos (window-start)))
6341 (erase-buffer)
6342 (insert help)
6343 (set-window-start nil pos)))
6344 (org-fit-window-to-buffer)
6345 (org-export--dispatch-action
6346 standard-prompt allowed-keys entries options first-key expertp))))
6348 (defun org-export--dispatch-action
6349 (prompt allowed-keys entries options first-key expertp)
6350 "Read a character from command input and act accordingly.
6352 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6353 a list of characters available at a given step in the process.
6354 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6355 EXPERTP are the same as defined in `org-export--dispatch-ui',
6356 which see.
6358 Toggle export options when required. Otherwise, return value is
6359 a list with action as CAR and a list of interactive export
6360 options as CDR."
6361 (let (key)
6362 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6363 ;; C-p, SPC, DEL).
6364 (while (and (setq key (read-char-exclusive prompt))
6365 (not expertp)
6366 (memq key '(14 16 ?\s ?\d)))
6367 (cl-case key
6368 (14 (if (not (pos-visible-in-window-p (point-max)))
6369 (ignore-errors (scroll-up 1))
6370 (message "End of buffer")
6371 (sit-for 1)))
6372 (16 (if (not (pos-visible-in-window-p (point-min)))
6373 (ignore-errors (scroll-down 1))
6374 (message "Beginning of buffer")
6375 (sit-for 1)))
6376 (?\s (if (not (pos-visible-in-window-p (point-max)))
6377 (scroll-up nil)
6378 (message "End of buffer")
6379 (sit-for 1)))
6380 (?\d (if (not (pos-visible-in-window-p (point-min)))
6381 (scroll-down nil)
6382 (message "Beginning of buffer")
6383 (sit-for 1)))))
6384 (cond
6385 ;; Ignore undefined associations.
6386 ((not (memq key allowed-keys))
6387 (ding)
6388 (unless expertp (message "Invalid key") (sit-for 1))
6389 (org-export--dispatch-ui options first-key expertp))
6390 ;; q key at first level aborts export. At second level, cancel
6391 ;; first key instead.
6392 ((eq key ?q) (if (not first-key) (error "Export aborted")
6393 (org-export--dispatch-ui options nil expertp)))
6394 ;; Help key: Switch back to standard interface if expert UI was
6395 ;; active.
6396 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6397 ;; Send request for template insertion along with export scope.
6398 ((eq key ?#) (cons 'template (memq 'subtree options)))
6399 ;; Switch to asynchronous export stack.
6400 ((eq key ?&) '(stack))
6401 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6402 ((memq key '(2 22 19 6 1))
6403 (org-export--dispatch-ui
6404 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6405 (6 'force) (1 'async))))
6406 (if (memq option options) (remq option options)
6407 (cons option options)))
6408 first-key expertp))
6409 ;; Action selected: Send key and options back to
6410 ;; `org-export-dispatch'.
6411 ((or first-key (functionp (nth 2 (assq key entries))))
6412 (cons (cond
6413 ((not first-key) (nth 2 (assq key entries)))
6414 ;; Publishing actions are hard-coded. Send a special
6415 ;; signal to `org-export-dispatch'.
6416 ((eq first-key ?P)
6417 (cl-case key
6418 (?f 'publish-current-file)
6419 (?p 'publish-current-project)
6420 (?x 'publish-choose-project)
6421 (?a 'publish-all)))
6422 ;; Return first action associated to FIRST-KEY + KEY
6423 ;; path. Indeed, derived backends can share the same
6424 ;; FIRST-KEY.
6425 (t (catch 'found
6426 (mapc (lambda (entry)
6427 (let ((match (assq key (nth 2 entry))))
6428 (when match (throw 'found (nth 2 match)))))
6429 (member (assq first-key entries) entries)))))
6430 options))
6431 ;; Otherwise, enter sub-menu.
6432 (t (org-export--dispatch-ui options key expertp)))))
6436 (provide 'ox)
6438 ;; Local variables:
6439 ;; generated-autoload-file: "org-loaddefs.el"
6440 ;; End:
6442 ;;; ox.el ends here