| blob | 003ec279e103cae02bbbff3ea9fc2567d86e730f |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
90 \f
91 ;;; Internal Variables
92 ;;
93 ;; Among internal variables, the most important is
94 ;; `org-export-options-alist'. This variable define the global export
95 ;; options, shared between every exporter, and how they are acquired.
140 "Alist between export properties and ways to set them.
142 The key of the alist is the property name, and the value is a list
143 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
145 KEYWORD is a string representing a buffer keyword, or nil. Each
146 property defined this way can also be set, during subtree
147 export, through a headline property named after the keyword
149 property).
150 OPTION is a string that could be found in an #+OPTIONS: line.
151 DEFAULT is the default value for the property.
152 BEHAVIOR determines how Org should handle multiple keywords for
153 the same property. It is a symbol among:
154 nil Keep old value and discard the new one.
155 t Replace old value with the new one.
156 `space' Concatenate the values, separating them with a space.
157 `newline' Concatenate the values, separating them with
158 a newline.
159 `split' Split values at white spaces, and cons them to the
160 previous list.
161 `parse' Parse value as a list of strings and Org objects,
162 which can then be transcoded with, e.g.,
163 `org-export-data'. It implies `space' behavior.
165 Values set through KEYWORD and OPTION have precedence over
166 DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
233 "Alist between filters properties and initial values.
235 The key of each association is a property name accessible through
236 the communication channel. Its value is a configurable global
237 variable defining initial filters.
239 This list is meant to install user specified filters. Back-end
240 developers may install their own filters using
241 `org-export-define-backend'. Filters defined there will always
242 be prepended to the current list, so they always get applied
251 "Default rule for link matching an inline image.
252 This rule applies to links with no description. By default, it
253 will be considered as an inline image if it targets a local file
256 See `org-export-inline-image-p' for more information about
261 org-element--cache org-element--cache-objects org-element--cache-sync-keys
262 org-element--cache-sync-requests org-element--cache-sync-timer)
263 "List of variables not copied through upon buffer duplication.
264 Export process takes place on a copy of the original buffer.
265 When this copy is created, all Org related local variables not in
266 this list are copied to the new buffer. Variables with an
270 "Non-nil means asynchronous export process should leave data behind.
274 located in `temporary-file-directory'.
276 When non-nil, it will also set `debug-on-error' to a non-nil
280 "Record asynchronously generated export results and processes.
281 This is an alist: its CAR is the source of the
282 result (destination file or buffer for a finished process,
283 original buffer for a running one) and its CDR is a list
284 containing the back-end used, as a symbol, and either a process
285 or the time at which it finished. It is used to build the menu
289 "List of backends currently available in the exporter.
290 This variable is set with `org-export-define-backend' and
294 "Last command called from the dispatcher.
295 The value should be a list. Its CAR is the action, as a symbol,
299 "The position where the last export command was created using the dispatcher.
300 This marker will be used with `C-u C-c C-e' to make sure export repetition
303 ;; For compatibility with Org < 8
305 "Name, if any, of the back-end used during an export process.
307 Its value is a symbol such as `html', `latex', `ascii', or nil if
308 the back-end is anonymous (see `org-export-create-backend') or if
309 there is no export process in progress.
311 It can be used to teach Babel blocks how to act differently
315 \f
316 ;;; User-configurable Variables
317 ;;
318 ;; Configuration for the masses.
319 ;;
320 ;; They should never be accessed directly, as their value is to be
321 ;; stored in a property list (cf. `org-export-options-alist').
322 ;; Back-ends will read their value from there instead.
325 "Options for exporting Org mode files."
330 "General options for export engine."
335 "Whether sub-trees with the ARCHIVE tag should be exported.
337 This can have three different values:
338 nil Do not export, pretend this tree is not present.
339 t Do export the entire tree.
340 `headline' Only export the headline, but skip the tree below it.
342 This option can also be set with the OPTIONS keyword,
351 "Non-nil means insert author name into the exported file.
352 This option can also be set with the OPTIONS keyword,
358 "Non-nil means export CLOCK keywords.
359 This option can also be set with the OPTIONS keyword,
365 "Non-nil means the postamble should contain a creator sentence.
367 The sentence can be set in `org-export-creator-string', which
368 see.
370 This option can also be set with the OPTIONS keyword, e.g.,
378 "Non-nil means insert date in the exported document.
379 This option can also be set with the OPTIONS keyword,
385 "Time-stamp format string to use for DATE keyword.
387 The format string, when specified, only applies if date consists
388 in a single time-stamp. Otherwise its value will be ignored.
390 See `format-time-string' for details on how to build this
391 string."
399 emacs-version
401 "Information about the creator of the document.
402 This option can also be set on with the CREATOR keyword."
407 "Non-nil means export contents of standard drawers.
409 When t, all drawers are exported. This may also be a list of
410 drawer names to export, as strings. If that list starts with
411 `not', only drawers with such names will be ignored.
413 This variable doesn't apply to properties drawers. See
414 `org-export-with-properties' instead.
416 This option can also be set with the OPTIONS keyword,
429 :inline t
433 "Non-nil means insert author email into the exported file.
434 This option can also be set with the OPTIONS keyword,
440 "Non-nil means interpret *word*, /word/, _word_ and +word+.
442 If the export target supports emphasizing text, the word will be
443 typeset in bold, italic, with an underline or strike-through,
444 respectively.
446 This option can also be set with the OPTIONS keyword,
452 "Tags that exclude a tree from export.
454 All trees carrying any of these tags will be excluded from
455 export. This is without condition, so even subtrees inside that
456 carry one of the `org-export-select-tags' will be removed.
458 This option can also be set with the EXCLUDE_TAGS keyword."
464 This option can also be set with the OPTIONS keyword,
472 "Non-nil means Org footnotes should be exported.
473 This option can also be set with the OPTIONS keyword,
479 "Non-nil means process LaTeX environments and fragments.
481 This option can also be set with the OPTIONS line,
484 nil Ignore math snippets.
485 `verbatim' Keep everything in verbatim.
486 t Allow export of math snippets."
496 "The last level which is still exported as a headline.
498 Inferior levels will usually produce itemize or enumerate lists
499 when exported, but back-end behaviour may differ.
501 This option can also be set with the OPTIONS keyword,
507 "The default language for export and clocktable translations, as a string.
508 This may have an association in
509 `org-clock-clocktable-language-setup',
510 `org-export-smart-quotes-alist' and `org-export-dictionary'.
511 This option can also be set with the LANGUAGE keyword."
516 "Non-nil means preserve all line breaks when exporting.
517 This option can also be set with the OPTIONS keyword,
523 "Non-nil means interpret entities when exporting.
526 Å.
528 For a list of supported names, see the constant `org-entities'
529 and the user option `org-entities-user'.
531 This option can also be set with the OPTIONS keyword,
537 "Non-nil means inlinetasks should be exported.
538 This option can also be set with the OPTIONS keyword,
546 "Non-nil means include planning info in export.
548 Planning info is the line containing either SCHEDULED:,
549 DEADLINE:, CLOSED: time-stamps, or a combination of them.
551 This option can also be set with the OPTIONS keyword,
559 "Non-nil means include priority cookies in export.
560 This option can also be set with the OPTIONS keyword,
566 "Non-nil means export contents of properties drawers.
568 When t, all properties are exported. This may also be a list of
569 properties to export, as strings.
571 This option can also be set with the OPTIONS keyword,
583 "Non-nil means add section numbers to headlines when exporting.
585 When set to an integer n, numbering will only happen for
586 headlines whose relative level is higher or equal to n.
588 This option can also be set with the OPTIONS keyword,
594 "Tags that select a tree for export.
596 If any such tag is found in a buffer, all trees that do not carry
597 one of these tags will be ignored during export. Inside trees
598 that are selected like this, you can still deselect a subtree by
599 tagging it with one of the `org-export-exclude-tags'.
601 This option can also be set with the SELECT_TAGS keyword."
606 "Non-nil means activate smart quotes during export.
607 This option can also be set with the OPTIONS keyword,
610 When setting this to non-nil, you need to take care of
611 using the correct Babel package when exporting to LaTeX.
612 E.g., you can load Babel for french like this:
623 When this option is turned on, these strings will be exported as:
625 Org HTML LaTeX UTF-8
626 -----+----------+--------+-------
628 -- – -- –
629 --- — --- —
632 This option can also be set with the OPTIONS keyword,
638 "Non-nil means include statistics cookies in export.
639 This option can also be set with the OPTIONS keyword,
649 If you want to control how Org displays those characters, see
650 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
651 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
652 it is not anymore.
654 When this option is turned on, you can use TeX-like syntax for
655 sub- and superscripts and see them exported correctly.
657 You can also set the option with #+OPTIONS: ^:t
660 single item - so grouping with {} is normally not needed. For
661 example, the following things will be parsed as single sub- or
662 superscripts:
664 10^24 or 10^tau several digits will be considered 1 item.
665 10^-12 or 10^-tau a leading sign with digits or a word
666 x^2-y^3 will be read as x^2 - y^3, because items are
667 terminated by almost any nonword/nondigit char.
668 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
670 Still, ambiguity is possible. So when in doubt, use {} to enclose
671 the sub/superscript. If you set this variable to the symbol `{}',
672 the braces are *required* in order to trigger interpretations as
674 frequently in plain text."
684 "Non-nil means create a table of contents in exported files.
686 The TOC contains headlines with levels up
687 to`org-export-headline-levels'. When an integer, include levels
688 up to N in the toc, this may then be different from
689 `org-export-headline-levels', but it will not be allowed to be
690 larger than the number of headline levels. When nil, no table of
691 contents is made.
693 This option can also be set with the OPTIONS keyword,
702 "Non-nil means export tables.
703 This option can also be set with the OPTIONS keyword,
711 "If nil, do not export tags, just remove them from headlines.
713 If this is the symbol `not-in-toc', tags will be removed from
714 table of contents entries, but still be shown in the headlines of
715 the document.
717 This option can also be set with the OPTIONS keyword,
726 "Non-nil means include TODO items for export.
728 This may have the following values:
729 t include tasks independent of state.
730 `todo' include only tasks that are not yet done.
731 `done' include only tasks that are already done.
732 nil ignore all tasks.
733 list of keywords include tasks with these keywords.
735 This option can also be set with the OPTIONS keyword,
747 "Non-nil means print title into the exported file.
748 This option can also be set with the OPTIONS keyword,
756 "Non-nil means insert a time stamp into the exported file.
757 The time stamp shows when the file was created. This option can
763 "Non nil means allow timestamps in export.
765 It can be set to any of the following values:
766 t export all timestamps.
767 `active' export active timestamps only.
768 `inactive' export inactive timestamps only.
769 nil do not export timestamps
771 This only applies to timestamps isolated in a paragraph
772 containing only timestamps. Other timestamps are always
773 exported.
775 This option can also be set with the OPTIONS keyword, e.g.
785 "Non-nil means include TODO keywords in export.
786 When nil, remove all these keywords from the export. This option
792 "Non-nil means BIND keywords can define local variable values.
793 This is a potential security risk, which is why the default value
794 is nil. You can also allow them through local buffer variables."
801 "Alist between export snippets back-ends and exporter back-ends.
803 This variable allows to provide shortcuts for export snippets.
807 HTML code while every other back-end will ignore it."
816 "Coding system for the exported file."
823 "Non-nil means pushing export output to the kill ring.
824 This variable is ignored during asynchronous export."
834 "The initial scope when exporting with `org-export-dispatch'.
835 This variable can be either set to `buffer' or `subtree'."
842 "Non-nil means show buffer after exporting to temp buffer.
843 When Org exports to a file, the buffer visiting that file is never
844 shown, but remains buried. However, when exporting to
845 a temporary buffer, that buffer is popped up in a second window.
846 When this variable is nil, the buffer remains buried also in
847 these cases."
852 "Non-nil means export and publishing commands will run in background.
853 Results from an asynchronous export are never displayed
861 "File used to initialize external export process.
863 Value must be either nil or an absolute file name. When nil, the
864 external process is launched like a regular Emacs session,
865 loading user's initialization file and any site specific
866 configuration. If a file is provided, it, and only it, is loaded
867 at start-up.
869 Therefore, using a specific configuration makes the process to
870 load faster and the export more portable."
879 "Non-nil means using a non-intrusive `org-export-dispatch'.
880 In that case, no help buffer is displayed. Though, an indicator
886 asynchronous). Also, \[?] allows to switch back to standard
887 mode."
894 \f
895 ;;; Defining Back-ends
896 ;;
897 ;; An export back-end is a structure with `org-export-backend' type
898 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
899 ;; and `menu' slots.
900 ;;
901 ;; At the lowest level, a back-end is created with
902 ;; `org-export-create-backend' function.
903 ;;
904 ;; A named back-end can be registered with
905 ;; `org-export-register-backend' function. A registered back-end can
906 ;; later be referred to by its name, with `org-export-get-backend'
907 ;; function. Also, such a back-end can become the parent of a derived
908 ;; back-end from which slot values will be inherited by default.
909 ;; `org-export-derived-backend-p' can check if a given back-end is
910 ;; derived from a list of back-end names.
911 ;;
912 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
913 ;; `org-export-get-all-filters' return the full alist of transcoders,
914 ;; options and filters, including those inherited from ancestors.
915 ;;
916 ;; At a higher level, `org-export-define-backend' is the standard way
917 ;; to define an export back-end. If the new back-end is similar to
918 ;; a registered back-end, `org-export-define-derived-backend' may be
919 ;; used instead.
920 ;;
921 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
922 ;; when a given back-end hasn't been registered yet.
926 name parent transcoders options filters blocks menu)
929 "Return export back-end named after NAME.
930 NAME is a symbol. Return nil if no such back-end is found."
937 "Register BACKEND as a known export back-end.
938 BACKEND is a structure with `org-export-backend' type."
939 ;; Refuse to register an unnamed back-end.
942 ;; Refuse to register a back-end with an unknown parent.
946 ;; Register dedicated export blocks in the parser.
950 ;; If a back-end with the same name as BACKEND is already
951 ;; registered, replace it with BACKEND. Otherwise, simply add
952 ;; BACKEND to the list of registered back-ends.
958 "Signal an error if BACKEND isn't defined."
963 "Non-nil if BACKEND is derived from one of BACKENDS.
964 BACKEND is an export back-end, as returned by, e.g.,
965 `org-export-create-backend', or a symbol referring to
966 a registered back-end. BACKENDS is constituted of symbols."
978 "Return full translation table for BACKEND.
980 BACKEND is an export back-end, as return by, e.g,,
981 `org-export-create-backend'. Return value is an alist where
982 keys are element or object types, as symbols, and values are
983 transcoders.
985 Unlike to `org-export-backend-transcoders', this function
986 also returns transcoders inherited from parent back-ends,
987 if any."
991 parent)
996 transcoders)))
999 "Return export options for BACKEND.
1001 BACKEND is an export back-end, as return by, e.g,,
1002 `org-export-create-backend'. See `org-export-options-alist'
1003 for the shape of the return value.
1005 Unlike to `org-export-backend-options', this function also
1006 returns options inherited from parent back-ends, if any."
1010 parent)
1014 options)))
1017 "Return complete list of filters for BACKEND.
1019 BACKEND is an export back-end, as return by, e.g,,
1020 `org-export-create-backend'. Return value is an alist where
1021 keys are symbols and values lists of functions.
1023 Unlike to `org-export-backend-filters', this function also
1024 returns filters inherited from parent back-ends, if any."
1028 parent)
1032 filters)))
1035 "Define a new back-end BACKEND.
1037 TRANSCODERS is an alist between object or element types and
1038 functions handling them.
1040 These functions should return a string without any trailing
1041 space, or nil. They must accept three arguments: the object or
1042 element itself, its contents or nil when it isn't recursive and
1043 the property list used as a communication channel.
1045 Contents, when not nil, are stripped from any global indentation
1046 \(although the relative one is preserved). They also always end
1047 with a single newline character.
1049 If, for a given type, no function is found, that element or
1050 object type will simply be ignored, along with any blank line or
1051 white space at its end. The same will happen if the function
1052 returns the nil value. If that function returns the empty
1053 string, the type will be ignored, but the blank lines or white
1054 spaces will be kept.
1056 In addition to element and object types, one function can be
1057 associated to the `template' (or `inner-template') symbol and
1058 another one to the `plain-text' symbol.
1060 The former returns the final transcoded string, and can be used
1061 to add a preamble and a postamble to document's body. It must
1062 accept two arguments: the transcoded string and the property list
1063 containing export options. A function associated to `template'
1065 A function associated to `inner-template' is always applied.
1067 The latter, when defined, is to be called on every text not
1068 recognized as an element or an object. It must accept two
1069 arguments: the text string and the information channel. It is an
1070 appropriate place to protect special chars relative to the
1071 back-end.
1073 BODY can start with pre-defined keyword arguments. The following
1074 keywords are understood:
1076 :export-block
1078 String, or list of strings, representing block names that
1079 will not be parsed. This is used to specify blocks that will
1080 contain raw code specific to the back-end. These blocks
1081 still have to be handled by the relative `export-block' type
1082 translator.
1084 :filters-alist
1086 Alist between filters and function, or list of functions,
1087 specific to the back-end. See `org-export-filters-alist' for
1088 a list of all allowed filters. Filters defined here
1089 shouldn't make a back-end test, as it may prevent back-ends
1090 derived from this one to behave properly.
1092 :menu-entry
1094 Menu entry for the export dispatcher. It should be a list
1095 like:
1097 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1099 where :
1101 KEY is a free character selecting the back-end.
1103 DESCRIPTION-OR-ORDINAL is either a string or a number.
1105 If it is a string, is will be used to name the back-end in
1106 its menu entry. If it is a number, the following menu will
1107 be displayed as a sub-menu of the back-end with the same
1108 KEY. Also, the number will be used to determine in which
1109 order such sub-menus will appear (lowest first).
1111 ACTION-OR-MENU is either a function or an alist.
1113 If it is an action, it will be called with four
1114 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1115 BODY-ONLY. See `org-export-as' for further explanations on
1116 some of them.
1118 If it is an alist, associations should follow the
1119 pattern:
1121 '(KEY DESCRIPTION ACTION)
1123 where KEY, DESCRIPTION and ACTION are described above.
1125 Valid values include:
1129 or
1134 \(lambda (a s v b)
1135 \(if a (org-latex-export-to-pdf t s v b)
1136 \(org-open-file
1137 \(org-latex-export-to-pdf nil s v b)))))))
1139 or the following, which will be added to the previous
1140 sub-menu,
1142 '(?l 1
1146 :options-alist
1148 Alist between back-end specific properties introduced in
1149 communication channel and how their value are acquired. See
1150 `org-export-options-alist' for more information about
1151 structure of the values."
1166 :transcoders transcoders
1167 :options options
1168 :filters filters
1169 :blocks blocks
1173 "Create a new back-end as a variant of an existing one.
1175 CHILD is the name of the derived back-end. PARENT is the name of
1176 the parent back-end.
1178 BODY can start with pre-defined keyword arguments. The following
1179 keywords are understood:
1181 :export-block
1183 String, or list of strings, representing block names that
1184 will not be parsed. This is used to specify blocks that will
1185 contain raw code specific to the back-end. These blocks
1186 still have to be handled by the relative `export-block' type
1187 translator.
1189 :filters-alist
1191 Alist of filters that will overwrite or complete filters
1192 defined in PARENT back-end. See `org-export-filters-alist'
1193 for a list of allowed filters.
1195 :menu-entry
1197 Menu entry for the export dispatcher. See
1198 `org-export-define-backend' for more information about the
1199 expected value.
1201 :options-alist
1203 Alist of back-end specific properties that will overwrite or
1204 complete those defined in PARENT back-end. Refer to
1205 `org-export-options-alist' for more information about
1206 structure of the values.
1208 :translate-alist
1210 Alist of element and object types and transcoders that will
1211 overwrite or complete transcode table from PARENT back-end.
1212 Refer to `org-export-define-backend' for detailed information
1213 about transcoders.
1216 as a variant of `latex' back-end with a custom template function:
1218 \(org-export-define-derived-backend 'my-latex 'latex
1219 :translate-alist '((template . my-latex-template-fun)))
1221 The back-end could then be called with, for example:
1239 :parent parent
1240 :transcoders transcoders
1241 :options options
1242 :filters filters
1243 :blocks blocks
1247 \f
1248 ;;; The Communication Channel
1249 ;;
1250 ;; During export process, every function has access to a number of
1251 ;; properties. They are of two types:
1252 ;;
1253 ;; 1. Environment options are collected once at the very beginning of
1254 ;; the process, out of the original buffer and configuration.
1255 ;; Collecting them is handled by `org-export-get-environment'
1256 ;; function.
1257 ;;
1258 ;; Most environment options are defined through the
1259 ;; `org-export-options-alist' variable.
1260 ;;
1261 ;; 2. Tree properties are extracted directly from the parsed tree,
1262 ;; just before export, by `org-export-collect-tree-properties'.
1264 ;;;; Environment Options
1265 ;;
1266 ;; Environment options encompass all parameters defined outside the
1267 ;; scope of the parsed data. They come from five sources, in
1268 ;; increasing precedence order:
1269 ;;
1270 ;; - Global variables,
1271 ;; - Buffer's attributes,
1272 ;; - Options keyword symbols,
1273 ;; - Buffer keywords,
1274 ;; - Subtree properties.
1275 ;;
1276 ;; The central internal function with regards to environment options
1277 ;; is `org-export-get-environment'. It updates global variables with
1278 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1279 ;; the different sources.
1280 ;;
1281 ;; The internal functions doing the retrieval are:
1282 ;; `org-export--get-global-options',
1283 ;; `org-export--get-buffer-attributes',
1284 ;; `org-export--parse-option-keyword',
1285 ;; `org-export--get-subtree-options' and
1286 ;; `org-export--get-inbuffer-options'
1287 ;;
1288 ;; Also, `org-export--list-bound-variables' collects bound variables
1289 ;; along with their value in order to set them as buffer local
1290 ;; variables later in the process.
1293 "Collect export options from the current buffer.
1295 Optional argument BACKEND is an export back-end, as returned by
1296 `org-export-create-backend'.
1298 When optional argument SUBTREEP is non-nil, assume the export is
1299 done against the current sub-tree.
1301 Third optional argument EXT-PLIST is a property list with
1302 external parameters overriding Org default settings, but still
1303 inferior to file-local settings."
1304 ;; First install #+BIND variables since these must be set before
1305 ;; global options are read.
1308 ;; Get and prioritize export options...
1310 ;; ... from global variables...
1312 ;; ... from an external property list...
1313 ext-plist
1314 ;; ... from in-buffer settings...
1316 ;; ... and from subtree, when appropriate.
1318 ;; Eventually add misc. properties.
1320 :back-end
1321 backend
1323 :footnote-definition-alist
1324 ;; Footnotes definitions must be collected in the original
1325 ;; buffer, as there's no insurance that they will still be in
1326 ;; the parse tree, due to possible narrowing.
1342 alist))
1354 alist)))))))
1355 alist))
1356 :id-alist
1357 ;; Collect id references.
1368 alist))))
1371 "Parse an OPTIONS line and return values as a plist.
1372 Optional argument BACKEND is an export back-end, as returned by,
1373 e.g., `org-export-create-backend'. It specifies which back-end
1374 specific items to read, if any."
1378 ;; Priority is given to back-end specific options.
1380 org-export-options-alist)))
1382 plist)
1389 plist))
1392 "Get export options in subtree at point.
1393 Optional argument BACKEND is an export back-end, as returned by,
1394 e.g., `org-export-create-backend'. It specifies back-end used
1395 for export. Return options as a plist."
1396 ;; For each buffer keyword, create a headline property setting the
1397 ;; same property in communication channel. The name for the
1398 ;; property is the keyword with "EXPORT_" appended to it.
1401 ;; Look for both general keywords and back-end specific
1402 ;; options, with priority given to the latter.
1404 org-export-options-alist)))
1405 ;; Make sure point is at a heading.
1407 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1408 ;; headline's title (with no todo keyword, priority cookie or
1409 ;; tag) as its fallback value.
1415 plist :title
1419 title))))
1420 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1425 ;; Handle other keywords. TITLE keyword is excluded as it has
1426 ;; been handled already. Then return PLIST.
1438 plist
1439 property
1448 "Return current buffer export options, as a plist.
1450 Optional argument BACKEND, when non-nil, is an export back-end,
1451 as returned by, e.g., `org-export-create-backend'. It specifies
1452 which back-end specific options should also be read in the
1453 process.
1455 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1457 get-options ; For byte-compiler.
1460 ;; Priority is given to back-end specific options.
1462 org-export-options-alist))
1465 org-export-special-keywords))))
1468 ;; Return all properties associated to KEYWORD.
1473 to-parse
1476 ;; Recursively read keywords in buffer. FILES is a list
1477 ;; of files read so far. PLIST is the current property
1478 ;; list obtained.
1487 ;; Options in `org-export-special-keywords'.
1491 ;; Avoid circular dependencies.
1501 plist
1506 plist
1512 ;; Options in `org-export-options-alist'.
1515 plist
1517 plist property
1518 ;; Handle value depending on specified
1519 ;; BEHAVIOR.
1524 ;; Even if `parse' implies `space'
1525 ;; behavior, we separate line with "\n"
1526 ;; so as to preserve line-breaks.
1527 ;; However, empty lines are forbidden
1528 ;; since `parse' doesn't allow more than
1529 ;; one paragraph.
1538 " "
1551 plist))))
1552 ;; Read options in the current buffer and return value.
1555 nil)))
1556 ;; Parse properties in TO-PARSE. Remove newline characters not
1557 ;; involved in line breaks to simulate `space' behaviour.
1558 ;; Finally return options.
1570 "Return properties related to buffer attributes, as a plist."
1575 "Return global export options as a plist.
1576 Optional argument BACKEND, if non-nil, is an export back-end, as
1577 returned by, e.g., `org-export-create-backend'. It specifies
1578 which back-end specific export options should also be read in the
1579 process."
1581 ;; Priority is given to back-end specific options.
1583 org-export-options-alist)))
1589 plist
1590 prop
1591 ;; Evaluate default value provided.
1596 value)))))))))
1599 "Return variables bound from BIND keywords in current buffer.
1600 Also look for BIND keywords in setup files. The return value is
1601 an alist where associations are (VARIABLE-NAME VALUE)."
1606 ;; Return an alist between variable names and their
1607 ;; value. FILES is a list of setup files names read so
1608 ;; far, used to avoid circular dependencies. ALIST is
1609 ;; the alist collected so far.
1620 ;; Enter setup file.
1630 alist))))))))))
1631 alist)))))
1632 ;; Return value in appropriate order of appearance.
1635 ;; defsubst org-export-get-parent must be defined before first use,
1636 ;; was originally defined in the topology section
1639 "Return BLOB parent or nil.
1640 BLOB is the element or object considered."
1643 ;;;; Tree Properties
1644 ;;
1645 ;; Tree properties are information extracted from parse tree. They
1646 ;; are initialized at the beginning of the transcoding process by
1647 ;; `org-export-collect-tree-properties'.
1648 ;;
1649 ;; Dedicated functions focus on computing the value of specific tree
1650 ;; properties during initialization. Thus,
1651 ;; `org-export--populate-ignore-list' lists elements and objects that
1652 ;; should be skipped during export, `org-export--get-min-level' gets
1653 ;; the minimal exportable level, used as a basis to compute relative
1654 ;; level for headlines. Eventually
1655 ;; `org-export--collect-headline-numbering' builds an alist between
1656 ;; headlines and their numbering.
1659 "Extract tree properties from parse tree.
1661 DATA is the parse tree from which information is retrieved. INFO
1662 is a list holding export options.
1664 Following tree properties are set or updated:
1666 `:exported-data' Hash table used to memoize results from
1667 `org-export-data'.
1669 `:footnote-definition-alist' List of footnotes definitions in
1670 original buffer and current parse tree.
1672 `:headline-offset' Offset between true level of headlines and
1673 local level. An offset of -1 means a headline
1674 of level 2 should be considered as a level
1675 1 headline in the context.
1677 `:headline-numbering' Alist of all headlines as key an the
1678 associated numbering as value.
1680 Return updated plist."
1681 ;; Install the parse tree in the communication channel.
1683 ;; Compute `:headline-offset' in order to be able to use
1684 ;; `org-export-get-relative-level'.
1687 :headline-offset
1689 ;; Footnote definitions in parse tree override those stored in
1690 ;; `:footnote-definition-alist'. This way, any change to
1691 ;; a definition in the parse tree (e.g., through a parse tree
1692 ;; filter) propagates into the alist.
1699 defs))
1703 defs)))))
1705 ;; Properties order doesn't matter: get the rest of the tree
1706 ;; properties.
1710 info))
1713 "Return minimum exportable headline's level in DATA.
1714 DATA is parsed tree as returned by `org-element-parse-buffer'.
1715 OPTIONS is a plist holding export options."
1726 ;; If no headline was found, for the sake of consistency, set
1727 ;; minimum level to 1 nonetheless.
1731 "Return numbering of all exportable, numbered headlines in a parse tree.
1733 DATA is the parse tree. OPTIONS is the plist holding export
1734 options.
1736 Return an alist whose key is a headline and value is its
1737 associated numbering \(in the shape of a list of numbers\) or nil
1738 for a footnotes section."
1747 headline
1749 for idx from 0 to org-export-max-depth
1753 options)))
1756 "List headlines and inlinetasks with a select tag in their tree.
1757 DATA is parsed data as returned by `org-element-parse-buffer'.
1758 INFO is a plist holding export options."
1760 walk-data ; For byte-compiler.
1770 ;; When a select tag is found, mark full
1771 ;; genealogy and every headline within the tree
1772 ;; as acceptable.
1775 genealogy
1778 selected-trees))
1779 ;; If at a headline, continue searching in tree,
1780 ;; recursively.
1789 selected-trees))
1792 "Non-nil when element or object BLOB should be skipped during export.
1793 OPTIONS is the plist holding export options. SELECTED, when
1794 non-nil, is a list of headlines or inlinetasks belonging to
1795 a tree with a select tag."
1802 ;; If `:with-drawers' value starts with `not', ignore
1803 ;; every drawer whose name belong to that list.
1804 ;; Otherwise, ignore drawers whose name isn't in that
1805 ;; list.
1822 ;; Ignore subtrees with an exclude tag.
1825 ;; When a select tag is present in the buffer, ignore any tree
1826 ;; without it.
1828 ;; Ignore commented sub-trees.
1830 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1832 ;; Ignore tasks, if specified by `:with-tasks' property.
1844 properties-set))))))
1855 ;; `:with-timestamps' only applies to isolated timestamps
1856 ;; objects, i.e. timestamp objects in a paragraph containing only
1857 ;; timestamps and whitespaces.
1865 options t))))
1874 \f
1875 ;;; The Transcoder
1876 ;;
1877 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1878 ;; `org-element-parse-buffer') and transcodes it into a specified
1879 ;; back-end output. It takes care of filtering out elements or
1880 ;; objects according to export options and organizing the output blank
1881 ;; lines and white space are preserved. The function memoizes its
1882 ;; results, so it is cheap to call it within transcoders.
1883 ;;
1884 ;; It is possible to modify locally the back-end used by
1885 ;; `org-export-data' or even use a temporary back-end by using
1886 ;; `org-export-data-with-backend'.
1887 ;;
1888 ;; `org-export-transcoder' is an accessor returning appropriate
1889 ;; translator function for a given element or object.
1892 "Return appropriate transcoder for BLOB.
1893 INFO is a plist containing export directives."
1895 ;; Return contents only for complete parse trees.
1901 "Convert DATA into current back-end format.
1903 DATA is a parse tree, an element or an object or a secondary
1904 string. INFO is a plist holding export options.
1906 Return a string."
1911 ;; Ignored element/object.
1913 ;; Plain text.
1919 info))
1920 ;; Secondary string.
1923 ;; Element/Object without contents or, as a special
1924 ;; case, headline with archive tag and archived trees
1925 ;; restricted to title only.
1933 ;; Export snippets never return a nil value so
1934 ;; that white spaces following them are never
1935 ;; ignored.
1937 ;; Element/Object with contents.
1950 ;; Elements directly containing
1951 ;; objects must have their indentation
1952 ;; normalized first.
1954 data
1955 ;; When normalizing contents of the
1956 ;; first paragraph in an item or
1957 ;; a footnote definition, ignore
1958 ;; first line's indentation: there is
1959 ;; none and it might be misleading.
1964 data)
1971 info))))))))
1972 ;; Final result will be memoized before being returned.
1974 data
1978 ;; Append the same white space between elements or objects
1979 ;; as in the original buffer, and call appropriate filters.
1990 info)))
1991 results)))
1995 "Convert DATA into BACKEND format.
1997 DATA is an element, an object, a secondary string or a string.
1998 BACKEND is a symbol. INFO is a plist used as a communication
1999 channel.
2001 Unlike to `org-export-with-backend', this function will
2002 recursively convert DATA using BACKEND translation table."
2005 data
2006 ;; Set-up a new communication channel with translations defined in
2007 ;; BACKEND as the translate table and a new hash table for
2008 ;; memoization.
2010 info
2013 ;; Size of the hash table is reduced since this function
2014 ;; will probably be used on small trees.
2018 "Expand a parsed element or object to its original state.
2020 BLOB is either an element or an object. CONTENTS is its
2021 contents, as a string or nil.
2023 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2024 keywords before output."
2029 blob contents))))
2032 \f
2033 ;;; The Filter System
2034 ;;
2035 ;; Filters allow end-users to tweak easily the transcoded output.
2036 ;; They are the functional counterpart of hooks, as every filter in
2037 ;; a set is applied to the return value of the previous one.
2038 ;;
2039 ;; Every set is back-end agnostic. Although, a filter is always
2040 ;; called, in addition to the string it applies to, with the back-end
2041 ;; used as argument, so it's easy for the end-user to add back-end
2042 ;; specific filters in the set. The communication channel, as
2043 ;; a plist, is required as the third argument.
2044 ;;
2045 ;; From the developer side, filters sets can be installed in the
2046 ;; process with the help of `org-export-define-backend', which
2047 ;; internally stores filters as an alist. Each association has a key
2048 ;; among the following symbols and a function or a list of functions
2049 ;; as value.
2050 ;;
2051 ;; - `:filter-options' applies to the property list containing export
2052 ;; options. Unlike to other filters, functions in this list accept
2053 ;; two arguments instead of three: the property list containing
2054 ;; export options and the back-end. Users can set its value through
2055 ;; `org-export-filter-options-functions' variable.
2056 ;;
2057 ;; - `:filter-parse-tree' applies directly to the complete parsed
2058 ;; tree. Users can set it through
2059 ;; `org-export-filter-parse-tree-functions' variable.
2060 ;;
2061 ;; - `:filter-body' applies to the body of the output, before template
2062 ;; translator chimes in. Users can set it through
2063 ;; `org-export-filter-body-functions' variable.
2064 ;;
2065 ;; - `:filter-final-output' applies to the final transcoded string.
2066 ;; Users can set it with `org-export-filter-final-output-functions'
2067 ;; variable.
2068 ;;
2069 ;; - `:filter-plain-text' applies to any string not recognized as Org
2070 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2071 ;; configure it.
2072 ;;
2073 ;; - `:filter-TYPE' applies on the string returned after an element or
2074 ;; object of type TYPE has been transcoded. A user can modify
2075 ;; `org-export-filter-TYPE-functions' to install these filters.
2076 ;;
2077 ;; All filters sets are applied with
2078 ;; `org-export-filter-apply-functions' function. Filters in a set are
2079 ;; applied in a LIFO fashion. It allows developers to be sure that
2080 ;; their filters will be applied first.
2081 ;;
2082 ;; Filters properties are installed in communication channel with
2083 ;; `org-export-install-filters' function.
2084 ;;
2085 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2086 ;; `org-export-before-parsing-hook') are run at the beginning of the
2087 ;; export process and just before parsing to allow for heavy structure
2088 ;; modifications.
2091 ;;;; Hooks
2094 "Hook run at the beginning of the export process.
2096 This is run before include keywords and macros are expanded and
2097 Babel code blocks executed, on a copy of the original buffer
2098 being exported. Visibility and narrowing are preserved. Point
2099 is at the beginning of the buffer.
2101 Every function in this hook will be called with one argument: the
2105 "Hook run before parsing an export buffer.
2107 This is run after include keywords and macros have been expanded
2108 and Babel code blocks executed, on a copy of the original buffer
2109 being exported. Visibility and narrowing are preserved. Point
2110 is at the beginning of the buffer.
2112 Every function in this hook will be called with one argument: the
2116 ;;;; Special Filters
2119 "List of functions applied to the export options.
2120 Each filter is called with two arguments: the export options, as
2121 a plist, and the back-end, as a symbol. It must return
2125 "List of functions applied to the parsed tree.
2126 Each filter is called with three arguments: the parse tree, as
2127 returned by `org-element-parse-buffer', the back-end, as
2128 a symbol, and the communication channel, as a plist. It must
2132 "List of functions applied to plain text.
2133 Each filter is called with three arguments: a string which
2134 contains no Org syntax, the back-end, as a symbol, and the
2135 communication channel, as a plist. It must return a string or
2139 "List of functions applied to transcoded body.
2140 Each filter is called with three arguments: a string which
2141 contains no Org syntax, the back-end, as a symbol, and the
2142 communication channel, as a plist. It must return a string or
2146 "List of functions applied to the transcoded string.
2147 Each filter is called with three arguments: the full transcoded
2148 string, the back-end, as a symbol, and the communication channel,
2149 as a plist. It must return a string that will be used as the
2153 ;;;; Elements Filters
2156 "List of functions applied to a transcoded babel-call.
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 center block.
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 clock.
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 diary-sexp.
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 drawer.
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 dynamic-block.
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 example-block.
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 export-block.
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 fixed-width.
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 footnote-definition.
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 headline.
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 horizontal-rule.
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 inlinetask.
2229 Each filter is called with three arguments: the transcoded data,
2230 as a string, the back-end, as a symbol, and the communication
2234 "List of functions applied to a transcoded item.
2235 Each filter is called with three arguments: the transcoded data,
2236 as a string, the back-end, as a symbol, and the communication
2240 "List of functions applied to a transcoded keyword.
2241 Each filter is called with three arguments: the transcoded data,
2242 as a string, the back-end, as a symbol, and the communication
2246 "List of functions applied to a transcoded latex-environment.
2247 Each filter is called with three arguments: the transcoded data,
2248 as a string, the back-end, as a symbol, and the communication
2252 "List of functions applied to a transcoded node-property.
2253 Each filter is called with three arguments: the transcoded data,
2254 as a string, the back-end, as a symbol, and the communication
2258 "List of functions applied to a transcoded paragraph.
2259 Each filter is called with three arguments: the transcoded data,
2260 as a string, the back-end, as a symbol, and the communication
2264 "List of functions applied to a transcoded plain-list.
2265 Each filter is called with three arguments: the transcoded data,
2266 as a string, the back-end, as a symbol, and the communication
2270 "List of functions applied to a transcoded planning.
2271 Each filter is called with three arguments: the transcoded data,
2272 as a string, the back-end, as a symbol, and the communication
2276 "List of functions applied to a transcoded property-drawer.
2277 Each filter is called with three arguments: the transcoded data,
2278 as a string, the back-end, as a symbol, and the communication
2282 "List of functions applied to a transcoded quote block.
2283 Each filter is called with three arguments: the transcoded quote
2284 data, as a string, the back-end, as a symbol, and the
2285 communication channel, as a plist. It must return a string or
2289 "List of functions applied to a transcoded section.
2290 Each filter is called with three arguments: the transcoded data,
2291 as a string, the back-end, as a symbol, and the communication
2295 "List of functions applied to a transcoded special block.
2296 Each filter is called with three arguments: the transcoded data,
2297 as a string, the back-end, as a symbol, and the communication
2301 "List of functions applied to a transcoded src-block.
2302 Each filter is called with three arguments: the transcoded data,
2303 as a string, the back-end, as a symbol, and the communication
2307 "List of functions applied to a transcoded table.
2308 Each filter is called with three arguments: the transcoded data,
2309 as a string, the back-end, as a symbol, and the communication
2313 "List of functions applied to a transcoded table-cell.
2314 Each filter is called with three arguments: the transcoded data,
2315 as a string, the back-end, as a symbol, and the communication
2319 "List of functions applied to a transcoded table-row.
2320 Each filter is called with three arguments: the transcoded data,
2321 as a string, the back-end, as a symbol, and the communication
2325 "List of functions applied to a transcoded verse block.
2326 Each filter is called with three arguments: the transcoded data,
2327 as a string, the back-end, as a symbol, and the communication
2331 ;;;; Objects Filters
2334 "List of functions applied to transcoded bold text.
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 transcoded code text.
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 entity.
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 export-snippet.
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 a transcoded footnote-reference.
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 inline-babel-call.
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 inline-src-block.
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 transcoded italic text.
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 latex-fragment.
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 a transcoded line-break.
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 a transcoded link.
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 "List of functions applied to a transcoded radio-target.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2406 "List of functions applied to a transcoded statistics-cookie.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2412 "List of functions applied to transcoded strike-through text.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2418 "List of functions applied to a transcoded subscript.
2419 Each filter is called with three arguments: the transcoded data,
2420 as a string, the back-end, as a symbol, and the communication
2424 "List of functions applied to a transcoded superscript.
2425 Each filter is called with three arguments: the transcoded data,
2426 as a string, the back-end, as a symbol, and the communication
2430 "List of functions applied to a transcoded target.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2436 "List of functions applied to a transcoded timestamp.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2442 "List of functions applied to transcoded underline text.
2443 Each filter is called with three arguments: the transcoded data,
2444 as a string, the back-end, as a symbol, and the communication
2448 "List of functions applied to transcoded verbatim text.
2449 Each filter is called with three arguments: the transcoded data,
2450 as a string, the back-end, as a symbol, and the communication
2454 ;;;; Filters Tools
2455 ;;
2456 ;; Internal function `org-export-install-filters' installs filters
2457 ;; hard-coded in back-ends (developer filters) and filters from global
2458 ;; variables (user filters) in the communication channel.
2459 ;;
2460 ;; Internal function `org-export-filter-apply-functions' takes care
2461 ;; about applying each filter in order to a given data. It ignores
2462 ;; filters returning a nil value but stops whenever a filter returns
2463 ;; an empty string.
2466 "Call every function in FILTERS.
2468 Functions are called with arguments VALUE, current export
2469 back-end's name and INFO. A function returning a nil value will
2470 be skipped. If it returns the empty string, the process ends and
2471 VALUE is ignored.
2473 Call is done in a LIFO fashion, to be sure that developer
2474 specified filters, if any, are called first."
2485 "Install filters properties in communication channel.
2486 INFO is a plist containing the current communication channel.
2487 Return the updated communication channel."
2489 ;; Install user-defined filters with `org-export-filters-alist'
2490 ;; and filters already in INFO (through ext-plist mechanism).
2497 ;; Filters in INFO will be called
2498 ;; before those user provided.
2501 default-value)))))
2502 org-export-filters-alist)
2503 ;; Prepend back-end specific filters to that list.
2505 ;; Single values get consed, lists are appended.
2510 plist key
2514 ;; Return new communication channel.
2518 \f
2519 ;;; Core functions
2520 ;;
2521 ;; This is the room for the main function, `org-export-as', along with
2522 ;; its derivative, `org-export-string-as'.
2523 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2524 ;; function should be added to kill ring.
2525 ;;
2526 ;; Note that `org-export-as' doesn't really parse the current buffer,
2527 ;; but a copy of it (with the same buffer-local variables and
2528 ;; visibility), where macros and include keywords are expanded and
2529 ;; Babel blocks are executed, if appropriate.
2530 ;; `org-export-with-buffer-copy' macro prepares that copy.
2531 ;;
2532 ;; File inclusion is taken care of by
2533 ;; `org-export-expand-include-keyword' and
2534 ;; `org-export--prepare-file-contents'. Structure wise, including
2535 ;; a whole Org file in a buffer often makes little sense. For
2536 ;; example, if the file contains a headline and the include keyword
2537 ;; was within an item, the item should contain the headline. That's
2538 ;; why file inclusion should be done before any structure can be
2539 ;; associated to the file, that is before parsing.
2540 ;;
2541 ;; `org-export-insert-default-template' is a command to insert
2542 ;; a default template (or a back-end specific template) at point or in
2543 ;; current subtree.
2546 "Return a copy of the current buffer.
2547 The copy preserves Org buffer-local variables, visibility and
2548 narrowing."
2554 new-buf))
2557 "Apply BODY in a copy of the current buffer.
2558 The copy preserves local variables, visibility and contents of
2559 the original buffer. Point is at the beginning of the buffer
2560 when BODY is applied."
2569 ;; Kill copy without confirmation.
2575 "Generate a function duplicating BUFFER.
2577 The copy will preserve local variables, visibility, contents and
2578 narrowing of the original buffer. If a region was active in
2579 BUFFER, contents will be narrowed to that region instead.
2581 The resulting function can be evaluated at a later time, from
2582 another buffer, effectively cloning the original buffer there.
2584 The function assumes BUFFER's major mode is `org-mode'."
2588 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2589 ;; already in BUFFER.
2591 ;; Copy specific buffer local variables and variables set
2592 ;; through BIND keywords.
2594 vars)
2602 buffer-file-name
2603 buffer-file-coding-system))
2607 ;; Skip unreadable values, as they cannot be
2608 ;; sent to external process.
2612 vars))))))
2613 ;; Whole buffer contents.
2618 ;; Narrowing.
2622 ;; Current position of point.
2624 ;; Overlays with invisible property.
2634 ov-set))))
2636 ov-set)))))
2639 "Delete commented areas in the buffer.
2640 Commented areas are comments, comment blocks, commented trees and
2641 inlinetasks. Trailing blank lines after a comment or a comment
2642 block are preserved. Narrowing, if any, is ignored."
2663 "Prune non exportable elements from DATA.
2664 DATA is the parse tree to traverse. INFO is the plist holding
2665 export info. Also set `:ignore-list' in INFO to a list of
2666 objects which should be ignored during export, but not removed
2667 from tree."
2669 ignore
2670 ;; First find trees containing a select tag, if any.
2674 ;; Prune non-exportable elements and objects from tree.
2675 ;; As a special case, special rows and cells from tables
2676 ;; are stored in IGNORE, as they still need to be accessed
2677 ;; during export.
2686 ;; If headline is archived but tree below has to
2687 ;; be skipped, remove contents.
2689 ;; Move into secondary string, if any.
2694 ;; Move into recursive objects/elements.
2696 ;; If a select tag is active, also ignore the section before the
2697 ;; first headline, if any.
2702 ;; Prune tree and communication channel.
2706 ;; Priority is given to back-end specific options.
2708 org-export-options-alist))
2711 ;; Eventually set `:ignore-list'.
2715 "Change uninterpreted elements back into Org syntax.
2716 DATA is the parse tree. INFO is a plist containing export
2717 options. Each uninterpreted element or object is changed back
2718 into a string. Contents, if any, are not modified. The parse
2719 tree is modified by side effect."
2725 p
2728 info))))))
2731 "Change uninterpreted elements back into Org syntax.
2732 DATA is a parse tree or a secondary string. INFO is a plist
2733 containing export options. It is modified by side effect and
2734 returned by the function."
2737 subscript superscript underline)
2741 ;; ... entities...
2748 ?\s)))))
2749 ;; ... emphasis...
2761 marker
2765 ?\s)))))))
2766 ;; ... LaTeX environments and fragments...
2770 ;; ... sub/superscripts...
2779 "_"
2788 ?\s)))))))))))
2790 ;; Splice NEW at BLOB location in parse tree.
2793 info)
2794 ;; Return modified parse tree.
2795 data)
2797 ;;;###autoload
2800 "Transcode current Org buffer into BACKEND code.
2802 BACKEND is either an export back-end, as returned by, e.g.,
2803 `org-export-create-backend', or a symbol referring to
2804 a registered back-end.
2806 If narrowing is active in the current buffer, only transcode its
2807 narrowed part.
2809 If a region is active, transcode that region.
2811 When optional argument SUBTREEP is non-nil, transcode the
2812 sub-tree at point, extracting information from the headline
2813 properties first.
2815 When optional argument VISIBLE-ONLY is non-nil, don't export
2816 contents of hidden elements.
2818 When optional argument BODY-ONLY is non-nil, only return body
2819 code, without surrounding template.
2821 Optional argument EXT-PLIST, when provided, is a property list
2822 with external parameters overriding Org default settings, but
2823 still inferior to file-local settings.
2825 Return code as a string."
2830 ;; Narrow buffer to an appropriate region or subtree for
2831 ;; parsing. If parsing subtree, be sure to remove main headline
2832 ;; too.
2840 ;; Initialize communication channel with original buffer
2841 ;; attributes, unavailable in its copy.
2854 org-export-options-alist))))
2855 tree)
2856 ;; Update communication channel and get parse tree. Buffer
2857 ;; isn't parsed directly. Instead, a temporary copy is
2858 ;; created, where include keywords, macros are expanded and
2859 ;; code blocks are evaluated.
2861 ;; Run first hook with current back-end's name as argument.
2866 ;; Refresh buffer properties, radio targets and macros after
2867 ;; including files.
2873 ;; Run last hook with current back-end's name as argument.
2878 ;; Update communication channel with environment. Also
2879 ;; install user's and developer's filters.
2884 ;; Call options filters and update export options. We do not
2885 ;; use `org-export-filter-apply-functions' here since the
2886 ;; arity of such filters is different.
2891 ;; Expand export-specific set of macros: {{{author}}},
2892 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2893 ;; be done once regular macros have been expanded, since
2894 ;; parsed keywords may contain one of them.
2907 value)
2908 value)))
2912 'finalize
2913 parsed-keywords)
2914 ;; Parse buffer.
2916 ;; Prune tree from non-exported elements and transform
2917 ;; uninterpreted elements or objects in both parse tree and
2918 ;; communication channel.
2921 ;; Parse buffer, handle uninterpreted elements or objects,
2922 ;; then call parse-tree filters.
2926 ;; Now tree is complete, compute its properties and add them
2927 ;; to communication channel.
2931 ;; Eventually transcode TREE. Wrap the resulting string into
2932 ;; a template.
2941 info))
2944 ;; Remove all text properties since they cannot be
2945 ;; retrieved from an external process. Finally call
2946 ;; final-output filter and return result.
2952 info))))))))
2954 ;;;###autoload
2956 "Transcode STRING into BACKEND code.
2958 BACKEND is either an export back-end, as returned by, e.g.,
2959 `org-export-create-backend', or a symbol referring to
2960 a registered back-end.
2962 When optional argument BODY-ONLY is non-nil, only return body
2963 code, without preamble nor postamble.
2965 Optional argument EXT-PLIST, when provided, is a property list
2966 with external parameters overriding Org default settings, but
2967 still inferior to file-local settings.
2969 Return code as a string."
2975 ;;;###autoload
2977 "Replace the active region by its export to BACKEND.
2978 BACKEND is either an export back-end, as returned by, e.g.,
2979 `org-export-create-backend', or a symbol referring to
2980 a registered back-end."
2990 ;;;###autoload
2992 "Insert all export keywords with default values at beginning of line.
2994 BACKEND is a symbol referring to the name of a registered export
2995 back-end, for which specific export options should be added to
2996 the template, or `default' for default template. When it is nil,
2997 the user will be prompted for a category.
2999 If SUBTREEP is non-nil, export configuration will be set up
3000 locally for the subtree through node properties."
3010 "Options category: "
3014 org-export-registered-backends))
3015 nil t))))
3016 options keywords)
3017 ;; Populate OPTIONS and KEYWORDS.
3034 ;; Move to an appropriate location in order to insert options.
3036 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3054 ;; Then the rest of keywords, in the order specified in either
3055 ;; `org-export-options-alist' or respective export back-ends.
3076 "Expand every include keyword in buffer.
3077 Optional argument INCLUDED is a list of included file names along
3078 with their line restriction, when appropriate. It is used to
3079 avoid infinite recursion. Optional argument DIR is the current
3080 working directory. It is used to properly resolve relative
3081 paths. Optional argument FOOTNOTES is a hash-table used for
3082 storing and resolving footnotes. It is created automatically."
3088 ;; If :minlevel is not set the text-property
3089 ;; `:org-include-induced-level' will be used to determine the
3090 ;; relative level when expanding INCLUDE.
3091 ;; Only affects included Org documents.
3095 :org-include-induced-level
3097 ;; Expand INCLUDE keywords.
3103 ;; Extract arguments from keyword's value.
3106 location
3118 matched)
3119 dir)))
3128 value)
3135 ;; Minimal level of included file defaults to the child
3136 ;; level of the current headline, if any, or one. It
3137 ;; only applies is the file is meant to be included as
3138 ;; an Org one.
3149 ;; Remove keyword.
3155 ;; Check if files has already been parsed. Look after
3156 ;; inclusion lines too, as different parts of the same file
3157 ;; can be included too.
3172 ind-str block arg-str contents ind-str block))))
3179 ind-str block contents ind-str block))))
3187 file location only-contents lines)
3188 lines)))
3191 file lines ind minlevel
3194 footnotes)))
3198 footnotes)
3200 ;; Expand footnotes after all files have been
3201 ;; included. Footnotes are stored at end of buffer.
3206 footnotes)))))))))))
3209 "Resolve absolute lines for an included file with file-link.
3211 FILE is string file-name of the file to include. LOCATION is a
3212 string name within FILE to be included (located via
3213 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3214 contents of the named element will be included, as determined
3215 Org-Element. If LINES is non-nil only those lines are included.
3217 Return a string of lines to be included in the format expected by
3218 `org-export--prepare-file-contents'."
3224 ;; Enforce consistent search.
3237 ;; Skip planning line and property-drawer.
3263 start-line
3265 (+ start-line
3268 counter))))))))
3271 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3273 REF-BEGIN corresponds to the property `:begin' of objects of type
3274 footnote-definition and footnote-reference.
3276 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3277 \[N] where N is one or more numbers.
3279 Return the new label."
3289 "Prepare contents of FILE for inclusion and return it as a string.
3291 When optional argument LINES is a string specifying a range of
3292 lines, include only those lines.
3294 Optional argument IND, when non-nil, is an integer specifying the
3295 global indentation of returned contents. Since its purpose is to
3296 allow an included file to stay in the same environment it was
3297 created \(i.e. a list item), it doesn't apply past the first
3298 headline encountered.
3300 Optional argument MINLEVEL, when non-nil, is an integer
3301 specifying the level that any top-level headline in the included
3302 file should have.
3303 Optional argument ID is an integer that will be inserted before
3304 each footnote definition and reference if FILE is an Org file.
3305 This is useful to avoid conflicts when more than one Org file
3306 with footnotes is included in a document.
3308 Optional argument FOOTNOTES is a hash-table to store footnotes in
3309 the included document.
3310 "
3326 ;; Remove blank lines at beginning and end of contents. The logic
3327 ;; behind that removal is that blank lines around include keyword
3328 ;; override blank lines in included file.
3337 ;; If IND is set, preserve indentation of include keyword until
3338 ;; the first headline encountered.
3345 ;; Do not move footnote definitions out of column 0.
3351 ;; When MINLEVEL is specified, compute minimal level for headlines
3352 ;; in the file (CUR-MIN), and remove stars to each headline so
3353 ;; that headlines with minimal level have a level of MINLEVEL.
3364 ;; Only change stars, don't bother moving whole
3365 ;; sections.
3369 ;; Append ID to all footnote references and definitions, so they
3370 ;; become file specific and cannot collide with footnotes in other
3371 ;; included files. Further, collect relevant footnotes outside of
3372 ;; LINES.
3382 ;; Update the footnote-reference at point and collect
3383 ;; the new label, which is only used for footnotes
3384 ;; outsides LINES.
3386 ;; If label is akin to [1] convert it to [fn:ID-1].
3387 ;; Otherwise add "ID-" after "fn:".
3397 ;; Store since footnote-definition is outside of LINES.
3400 footnotes)
3401 ;; Update label of definition since it is included directly.
3408 "Execute every Babel code in the visible part of current buffer."
3409 ;; Get a pristine copy of current buffer so Babel references can be
3410 ;; properly resolved.
3416 "Return a non-nil value when output should be added to the kill ring.
3417 See also `org-export-copy-to-kill-ring'."
3423 \f
3424 ;;; Tools For Back-Ends
3425 ;;
3426 ;; A whole set of tools is available to help build new exporters. Any
3427 ;; function general enough to have its use across many back-ends
3428 ;; should be added here.
3430 ;;;; For Affiliated Keywords
3431 ;;
3432 ;; `org-export-read-attribute' reads a property from a given element
3433 ;; as a plist. It can be used to normalize affiliated keywords'
3434 ;; syntax.
3435 ;;
3436 ;; Since captions can span over multiple lines and accept dual values,
3437 ;; their internal representation is a bit tricky. Therefore,
3438 ;; `org-export-get-caption' transparently returns a given element's
3439 ;; caption as a secondary string.
3442 "Turn ATTRIBUTE property from ELEMENT into a plist.
3444 When optional argument PROPERTY is non-nil, return the value of
3445 that property within attributes.
3449 properties.
3451 All values will become strings except the empty string and
3454 will become the empty string."
3468 s)
3473 ;; Ignore any string before first property with `cdr'.
3478 "Return caption from ELEMENT as a secondary string.
3480 When optional argument SHORTP is non-nil, return short caption,
3481 as a secondary string, instead.
3483 Caption lines are separated by a white space."
3491 ;;;; For Derived Back-ends
3492 ;;
3493 ;; `org-export-with-backend' is a function allowing to locally use
3494 ;; another back-end to transcode some object or element. In a derived
3495 ;; back-end, it may be used as a fall-back function once all specific
3496 ;; cases have been treated.
3499 "Call a transcoder from BACKEND on DATA.
3500 BACKEND is an export back-end, as returned by, e.g.,
3501 `org-export-create-backend', or a symbol referring to
3502 a registered back-end. DATA is an Org element, object, secondary
3503 string or string. CONTENTS, when non-nil, is the transcoded
3504 contents of DATA element, as a string. INFO, when non-nil, is
3505 the communication channel used for export, as a plist."
3515 transcoder data contents
3518 :translate-alist all-transcoders
3522 ;;;; For Export Snippets
3523 ;;
3524 ;; Every export snippet is transmitted to the back-end. Though, the
3525 ;; latter will only retain one type of export-snippet, ignoring
3526 ;; others, based on the former's target back-end. The function
3527 ;; `org-export-snippet-backend' returns that back-end for a given
3528 ;; export-snippet.
3531 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3532 Translation, with `org-export-snippet-translation-alist', is
3533 applied."
3537 back-end))))
3540 ;;;; For Footnotes
3541 ;;
3542 ;; `org-export-collect-footnote-definitions' is a tool to list
3543 ;; actually used footnotes definitions in the whole parse tree, or in
3544 ;; a headline, in order to add footnote listings throughout the
3545 ;; transcoded data.
3546 ;;
3547 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3548 ;; back-ends, when they need to attach the footnote definition only to
3549 ;; the first occurrence of the corresponding label.
3550 ;;
3551 ;; `org-export-get-footnote-definition' and
3552 ;; `org-export-get-footnote-number' provide easier access to
3553 ;; additional information relative to a footnote reference.
3556 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3557 INFO is the plist used as a communication channel. If no such
3558 definition can be found, raise an error."
3567 "Apply FUNCTION on every footnote reference in DATA.
3568 INFO is a plist containing export state. By default, as soon as
3569 a new footnote reference is encountered, FUNCTION is called onto
3570 its definition. However, if BODY-FIRST is non-nil, this step is
3571 delayed until the end of the process."
3577 ;; Search footnote references through DATA, filling
3578 ;; SEEN-REFS along the way. When DELAYP is non-nil, store
3579 ;; footnote definitions so they can be entered later.
3586 ;; Search for subsequent references in footnote
3587 ;; definition so numbering follows reading logic,
3588 ;; unless DELAYP in non-nil.
3592 definitions))
3593 ;; Do not force entering inline definitions,
3594 ;; since `org-element-map' already traverses them
3595 ;; at the right time.
3599 nil))))))
3600 info nil
3601 ;; Don't enter footnote definitions since it will happen
3602 ;; when their first reference is found. Moreover, if
3603 ;; DELAYP is non-nil, make sure we postpone entering
3604 ;; definitions of inline references.
3611 "Return an alist between footnote numbers, labels and definitions.
3613 INFO is the current export state, as a plist.
3615 Definitions are collected throughout the whole parse tree, or
3616 DATA when non-nil.
3618 Sorting is done by order of references. As soon as a new
3619 reference is encountered, other references are searched within
3620 its definition. However, if BODY-FIRST is non-nil, this step is
3621 delayed after the whole tree is checked. This alters results
3622 when references are found in footnote definitions.
3624 Definitions either appear as Org data or as a secondary string
3625 for inlined footnotes. Unreferenced definitions are ignored."
3629 ;; Collect footnote number, label and definition.
3640 "Non-nil when a footnote reference is the first one for its label.
3642 FOOTNOTE-REFERENCE is the footnote reference being considered.
3643 INFO is a plist containing current export state.
3645 Search is done throughout the whole parse tree, or DATA when
3646 non-nil.
3648 By default, as soon as a new footnote reference is encountered,
3649 other references are searched within its definition. However, if
3650 BODY-FIRST is non-nil, this step is delayed after the whole tree
3651 is checked. This alters results when references are found in
3652 footnote definitions."
3654 ;; Anonymous footnotes are always a first reference.
3665 "Return number associated to a footnote.
3667 FOOTNOTE is either a footnote reference or a footnote definition.
3668 INFO is the plist containing export state.
3670 Number is unique throughout the whole parse tree, or DATA, when
3671 non-nil.
3673 By default, as soon as a new footnote reference is encountered,
3674 counting process moves into its definition. However, if
3675 BODY-FIRST is non-nil, this step is delayed until the end of the
3676 process, leading to a different order when footnotes are nested."
3685 ;; Anonymous footnote match: return number.
3687 ;; Labels match: return number.
3689 ;; Otherwise store label and increase counter if label
3690 ;; wasn't encountered yet.
3696 ;;;; For Headlines
3697 ;;
3698 ;; `org-export-get-relative-level' is a shortcut to get headline
3699 ;; level, relatively to the lower headline level in the parsed tree.
3700 ;;
3701 ;; `org-export-get-headline-number' returns the section number of an
3702 ;; headline, while `org-export-number-to-roman' allows to convert it
3703 ;; to roman numbers. With an optional argument,
3704 ;; `org-export-get-headline-number' returns a number to unnumbered
3705 ;; headlines (used for internal id).
3706 ;;
3707 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3708 ;; `org-export-last-sibling-p' are three useful predicates when it
3709 ;; comes to fulfill the `:headline-levels' property.
3710 ;;
3711 ;; `org-export-get-tags', `org-export-get-category' and
3712 ;; `org-export-get-node-property' extract useful information from an
3713 ;; headline or a parent headline. They all handle inheritance.
3714 ;;
3715 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3716 ;; as a secondary string, suitable for table of contents. It falls
3717 ;; back onto default title.
3720 "Return HEADLINE relative level within current parsed tree.
3721 INFO is a plist holding contextual information."
3726 "Non-nil when HEADLINE is considered as low level.
3728 INFO is a plist used as a communication channel.
3730 A low level headlines has a relative level greater than
3731 `:headline-levels' property value.
3733 Return value is the difference between HEADLINE relative level
3734 and the last level being considered as high enough, or nil."
3741 "Return numbered HEADLINE numbering as a list of numbers.
3742 INFO is a plist holding contextual information."
3747 "Return a non-nil value if HEADLINE element should be numbered.
3748 INFO is a plist used as a communication channel."
3757 "Convert integer N into a roman numeral."
3770 res)))
3773 "Return list of tags associated to ELEMENT.
3775 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3776 is a plist used as a communication channel.
3778 Select tags (see `org-export-select-tags') and exclude tags (see
3779 `org-export-exclude-tags') are removed from the list.
3781 When non-nil, optional argument TAGS should be a list of strings.
3782 Any tag belonging to this list will also be removed.
3784 When optional argument INHERITED is non-nil, tags can also be
3785 inherited from parent headlines and FILETAGS keywords."
3791 ;; Build complete list of inherited tags.
3798 ;; Add FILETAGS keywords and return results.
3802 "Return node PROPERTY value for BLOB.
3804 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3805 element or object.
3807 If optional argument INHERITED is non-nil, the value can be
3808 inherited from a parent headline.
3810 Return value is a string or nil."
3822 "Return category for element or object BLOB.
3824 INFO is a plist used as a communication channel.
3826 CATEGORY is automatically inherited from a parent headline, from
3827 #+CATEGORY: keyword or created out of original file name. If all
3840 "Return alternative title for HEADLINE, as a secondary string.
3841 INFO is a plist used as a communication channel. If no optional
3842 title is defined, fall-back to the regular title."
3849 "Non-nil when BLOB is the first sibling in its parent.
3850 BLOB is an element or an object. If BLOB is a headline, non-nil
3851 means it is the first sibling in the sub-tree. INFO is a plist
3852 used as a communication channel."
3857 "Non-nil when BLOB is the last sibling in its parent.
3858 BLOB is an element or an object. INFO is a plist used as
3859 a communication channel."
3863 ;;;; For Keywords
3864 ;;
3865 ;; `org-export-get-date' returns a date appropriate for the document
3866 ;; to about to be exported. In particular, it takes care of
3867 ;; `org-export-date-timestamp-format'.
3870 "Return date value for the current document.
3872 INFO is a plist used as a communication channel. FMT, when
3873 non-nil, is a time format string that will be applied on the date
3874 if it consists in a single timestamp object. It defaults to
3875 `org-export-date-timestamp-format' when nil.
3877 A proper date can be a secondary string, a string or nil. It is
3878 meant to be translated with `org-export-data' or alike."
3889 ;;;; For Links
3890 ;;
3891 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3892 ;; with `org-add-link-type', which see.
3893 ;;
3894 ;; `org-export-get-coderef-format' returns an appropriate format
3895 ;; string for coderefs.
3896 ;;
3897 ;; `org-export-inline-image-p' returns a non-nil value when the link
3898 ;; provided should be considered as an inline image.
3899 ;;
3900 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3901 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3902 ;; returns an appropriate unique identifier when found, or nil.
3903 ;;
3904 ;; `org-export-resolve-id-link' returns the first headline with
3905 ;; specified id or custom-id in parse tree, the path to the external
3906 ;; file with the id or nil when neither was found.
3907 ;;
3908 ;; `org-export-resolve-coderef' associates a reference to a line
3909 ;; number in the element it belongs, or returns the reference itself
3910 ;; when the element isn't numbered.
3911 ;;
3912 ;; `org-export-file-uri' expands a filename as stored in :path value
3913 ;; of a "file" link into a file URI.
3916 "Try exporting LINK with a dedicated function.
3918 DESC is its description, as a string, or nil. BACKEND is the
3919 back-end used for export, as a symbol.
3921 Return output as a string, or nil if no protocol handles LINK.
3923 A custom protocol has precedence over regular back-end export.
3924 The function ignores links with an implicit type (e.g.,
3933 desc
3934 backend))))))
3937 "Return format string for code reference link.
3938 PATH is the link path. DESC is its description."
3946 "Non-nil if LINK object points to an inline image.
3948 Optional argument is a set of RULES defining inline images. It
3949 is an alist where associations have the following shape:
3951 \(TYPE . REGEXP)
3953 Applying a rule means apply REGEXP against LINK's path when its
3954 type is TYPE. The function will return a non-nil value if any of
3955 the provided rules is non-nil. The default rule is
3956 `org-export-default-inline-image-rule'.
3958 This only applies to links without a description."
3969 "Resolve a code reference REF.
3971 INFO is a plist used as a communication channel.
3973 Return associated line number in source code, or REF itself,
3974 depending on src-block or example element's switches. Throw an
3975 error if no block contains REF."
3982 org-coderef-label-format)))
3986 ;; Element containing REF is found. Resolve it to
3987 ;; either a label or a line number, as needed.
3998 "Return LINK destination.
4000 INFO is a plist holding contextual information.
4002 Return value can be an object, an element, or nil:
4004 - If LINK path matches a target object (i.e. <<path>>) return it.
4006 - If LINK path exactly matches the name affiliated keyword
4007 \(i.e. #+NAME: path) of an element, return that element.
4009 - If LINK path exactly matches any headline name, return that
4010 element. If more than one headline share that name, priority
4011 will be given to the one with the closest common ancestor, if
4012 any, or the first one in the parse tree otherwise.
4014 - Otherwise, throw an error.
4017 significant."
4020 ;; Split PATH at white spaces so matches are space
4021 ;; insensitive.
4024 ;; Cache for destinations that are not position dependent.
4032 ;; Destination is not position dependent: use cached value.
4034 ;; First try to find a matching "<<path>>" unless user specified
4035 ;; he was looking for a headline (path starts with a "*"
4036 ;; character).
4042 path)
4043 blob))
4046 ;; Then try to find an element with a matching "#+NAME: path"
4047 ;; affiliated keyword.
4050 org-element-all-elements
4055 el)))
4058 ;; Last case: link either points to a headline or to nothingness.
4059 ;; Try to find the source, with priority given to headlines with
4060 ;; the closest common ancestor. If such candidate is found,
4061 ;; return it, otherwise signal an error.
4065 ;; Return first headline whose `:raw-value' property is
4066 ;; NAME in parse tree DATA, or nil. Statistics cookies
4067 ;; are ignored.
4075 name)
4076 headline))
4078 ;; Search among headlines sharing an ancestor with link, from
4079 ;; closest to farthest.
4087 ;; No destination found: error.
4091 "Return headline referenced as LINK destination.
4093 INFO is a plist used as a communication channel.
4095 Return value can be the headline element matched in current parse
4099 ;; First check if id is within the current parse tree.
4104 headline))
4106 ;; Otherwise, look for external files.
4111 "Return radio-target object referenced as LINK destination.
4113 INFO is a plist used as a communication channel.
4115 Return value can be a radio-target object or nil. Assume LINK
4124 nil nil path nil nil t)
4125 t)
4126 radio))
4130 "Return file URI associated to FILENAME."
4136 filename))))
4139 ;;;; For References
4140 ;;
4141 ;; `org-export-get-reference' associate a unique reference for any
4142 ;; object or element.
4143 ;;
4144 ;; `org-export-get-ordinal' associates a sequence number to any object
4145 ;; or element.
4148 "Return a unique reference for DATUM, as a string.
4149 DATUM is either an element or an object. INFO is the current
4150 export state, as a plist. Returned reference consists of
4151 alphanumeric characters only."
4156 h))))
4164 cache))))
4167 "Return ordinal number of an element or object.
4169 ELEMENT is the element or object considered. INFO is the plist
4170 used as a communication channel.
4172 Optional argument TYPES, when non-nil, is a list of element or
4173 object types, as symbols, that should also be counted in.
4174 Otherwise, only provided element's type is considered.
4176 Optional argument PREDICATE is a function returning a non-nil
4177 value if the current element or object should be counted in. It
4178 accepts two arguments: the element or object being considered and
4179 the plist used as a communication channel. This allows to count
4180 only a certain type of objects (i.e. inline images).
4182 Return value is a list of numbers if ELEMENT is a headline or an
4183 item. It is nil for keywords. It represents the footnote number
4184 for footnote definitions and footnote references. If ELEMENT is
4185 a target, return the same value as if ELEMENT was the closest
4186 table, item or headline containing the target. In any other
4187 case, return the sequence number of ELEMENT among elements or
4188 objects of the same type."
4189 ;; Ordinal of a target object refer to the ordinal of the closest
4190 ;; table, item, or headline containing the object.
4194 element
4197 ;; Special case 1: A headline returns its number as a list.
4199 ;; Special case 2: An item returns its number as a list.
4203 struct
4210 ;; Increment counter until ELEMENT is found again.
4221 ;;;; For Src-Blocks
4222 ;;
4223 ;; `org-export-get-loc' counts number of code lines accumulated in
4224 ;; src-block or example-block elements with a "+n" switch until
4225 ;; a given element, excluded. Note: "-n" switches reset that count.
4226 ;;
4227 ;; `org-export-unravel-code' extracts source code (along with a code
4228 ;; references alist) from an `element-block' or `src-block' type
4229 ;; element.
4230 ;;
4231 ;; `org-export-format-code' applies a formatting function to each line
4232 ;; of code, providing relative line number and code reference when
4233 ;; appropriate. Since it doesn't access the original element from
4234 ;; which the source code is coming, it expects from the code calling
4235 ;; it to know if lines should be numbered and if code references
4236 ;; should appear.
4237 ;;
4238 ;; Eventually, `org-export-format-code-default' is a higher-level
4239 ;; function (it makes use of the two previous functions) which handles
4240 ;; line numbering and code references inclusion, and returns source
4241 ;; code in a format suitable for plain text or verbatim output.
4244 "Return accumulated lines of code up to ELEMENT.
4246 INFO is the plist used as a communication channel.
4248 ELEMENT is excluded from count."
4254 ;; ELEMENT is reached: Quit the loop.
4256 ;; Only count lines from src-block and example-block elements
4257 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4261 ;; Accumulate locs or reset them.
4265 ;; Return nil to stay in the loop.
4266 nil)))
4268 ;; Return value.
4269 loc))
4272 "Clean source code and extract references out of it.
4274 ELEMENT has either a `src-block' an `example-block' type.
4276 Return a cons cell whose CAR is the source code, cleaned from any
4277 reference, protective commas and spurious indentation, and CDR is
4278 an alist between relative line number (integer) and name of code
4279 reference on that line (string)."
4282 ;; Get code and clean it. Remove blank lines at its
4283 ;; beginning and end.
4290 value
4292 ;; Get format used for references.
4295 org-coderef-label-format)))
4296 ;; Build a regexp matching a loc with a reference.
4301 ;; Return value.
4303 ;; Code with references removed.
4309 ;; Ref line: remove ref, and signal its position in REFS.
4313 ;; Reference alist.
4314 refs)))
4317 "Format CODE by applying FUN line-wise and return it.
4319 CODE is a string representing the code to format. FUN is
4320 a function. It must accept three arguments: a line of
4321 code (string), the current line number (integer) or nil and the
4322 reference associated to the current line (string) or nil.
4324 Optional argument NUM-LINES can be an integer representing the
4325 number of code lines accumulated until the current code. Line
4326 numbers passed to FUN will take it into account. If it is nil,
4327 FUN's second argument will always be nil. This number can be
4328 obtained with `org-export-get-loc' function.
4330 Optional argument REF-ALIST can be an alist between relative line
4331 number (i.e. ignoring NUM-LINES) and the name of the code
4332 reference on it. If it is nil, FUN's third argument will always
4333 be nil. It can be obtained through the use of
4334 `org-export-unravel-code' function."
4346 "Return source code from ELEMENT, formatted in a standard way.
4348 ELEMENT is either a `src-block' or `example-block' element. INFO
4349 is a plist used as a communication channel.
4351 This function takes care of line numbering and code references
4352 inclusion. Line numbers, when applicable, appear at the
4353 beginning of the line, separated from the code by two white
4354 spaces. Code references, on the other hand, appear flushed to
4355 the right, separated by six white spaces from the widest line of
4356 code."
4357 ;; Extract code and references.
4364 ;; Handle line numbering.
4373 ;; Prepare references display, if required. Any reference
4374 ;; should start six columns after the widest line of code,
4375 ;; wrapped with parenthesis.
4380 code
4384 number-str
4385 loc
4391 num-start refs)))))
4394 ;;;; For Tables
4395 ;;
4396 ;; `org-export-table-has-special-column-p' and and
4397 ;; `org-export-table-row-is-special-p' are predicates used to look for
4398 ;; meta-information about the table structure.
4399 ;;
4400 ;; `org-table-has-header-p' tells when the rows before the first rule
4401 ;; should be considered as table's header.
4402 ;;
4403 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4404 ;; and `org-export-table-cell-borders' extract information from
4405 ;; a table-cell element.
4406 ;;
4407 ;; `org-export-table-dimensions' gives the number on rows and columns
4408 ;; in the table, ignoring horizontal rules and special columns.
4409 ;; `org-export-table-cell-address', given a table-cell object, returns
4410 ;; the absolute address of a cell. On the other hand,
4411 ;; `org-export-get-table-cell-at' does the contrary.
4412 ;;
4413 ;; `org-export-table-cell-starts-colgroup-p',
4414 ;; `org-export-table-cell-ends-colgroup-p',
4415 ;; `org-export-table-row-starts-rowgroup-p',
4416 ;; `org-export-table-row-ends-rowgroup-p',
4417 ;; `org-export-table-row-starts-header-p',
4418 ;; `org-export-table-row-ends-header-p' and
4419 ;; `org-export-table-row-in-header-p' indicate position of current row
4420 ;; or cell within the table.
4423 "Non-nil when TABLE has a special column.
4424 All special columns will be ignored during export."
4425 ;; The table has a special column when every first cell of every row
4426 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4427 ;; "*" "_" and "^". Though, do not consider a first row containing
4428 ;; only empty cells as special.
4444 "Non-nil when TABLE has a header.
4446 INFO is a plist used as a communication channel.
4448 A table has a header when it contains at least two row groups."
4457 table
4468 cache)))))
4471 "Non-nil if TABLE-ROW is considered special.
4473 INFO is a plist used as the communication channel.
4475 All special rows will be ignored during export."
4479 ;; A row is special either when...
4481 ;; ... it starts with a field only containing "/",
4483 ;; ... the table contains a special column and the row start
4484 ;; with a marking character among, "^", "_", "$" or "!",
4488 ;; ... it contains only alignment cookies and empty cells.
4494 ;; Since VALUE is a secondary string, the following
4495 ;; checks avoid expanding it with `org-export-data'.
4507 "Return TABLE-ROW's group number, as an integer.
4509 INFO is a plist used as the communication channel.
4511 Return value is the group number, as an integer, or nil for
4512 special rows and rows separators. First group is also table's
4513 header."
4531 "Return TABLE-CELL contents width.
4533 INFO is a plist used as the communication channel.
4535 Return value is the width given by the last width cookie in the
4536 same column as TABLE-CELL, or nil."
4555 ;; In a special row, try to find a width cookie at COLUMN.
4559 ;; The following checks avoid expanding unnecessarily
4560 ;; the cell with `org-export-data'.
4570 "Return TABLE-CELL contents alignment.
4572 INFO is a plist used as the communication channel.
4574 Return alignment as specified by the last alignment cookie in the
4575 same column as TABLE-CELL. If no such cookie is found, a default
4576 alignment value will be deduced from fraction of numbers in the
4577 column (see `org-table-number-fraction' for more information).
4578 Possible values are `left', `right' and `center'."
4579 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4596 cookie-align
4597 previous-cell-number-p)
4600 ;; In a special row, try to find an alignment cookie at
4601 ;; COLUMN.
4605 ;; Since VALUE is a secondary string, the following
4606 ;; checks avoid useless expansion through
4607 ;; `org-export-data'.
4615 ;; Ignore table rules.
4617 ;; In a standard row, check if cell's contents are
4618 ;; expressing some kind of number. Increase NUMBER-CELLS
4619 ;; accordingly. Though, don't bother if an alignment
4620 ;; cookie has already defined cell's alignment.
4625 info)))
4627 ;; Treat an empty cell as a number if it follows
4628 ;; a number.
4634 ;; Return value. Alignment specified by cookies has
4635 ;; precedence over alignment deduced from cell's contents.
4637 column
4642 org-table-number-fraction)
4647 "Return TABLE-CELL borders.
4649 INFO is a plist used as a communication channel.
4651 Return value is a list of symbols, or nil. Possible values are:
4652 `top', `bottom', `above', `below', `left' and `right'. Note:
4653 `top' (resp. `bottom') only happen for a cell in the first
4654 row (resp. last row) of the table, ignoring table rules, if any.
4656 Returned borders ignore special rows."
4659 borders)
4660 ;; Top/above border? TABLE-CELL has a border above when a rule
4661 ;; used to demarcate row groups can be found above. Hence,
4662 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4663 ;; another regular row has to be found above that rule.
4672 ;; Look at every row before the current one.
4674 ;; No rule above, or rule found starts the table (ignoring any
4675 ;; special row): TABLE-CELL is at the top of the table.
4678 ;; Bottom/below border? TABLE-CELL has a border below when next
4679 ;; non-regular row below is a rule.
4688 ;; Look at every row after the current one.
4690 ;; No rule below, or rule found ends the table (modulo some
4691 ;; special row): TABLE-CELL is at the bottom of the table.
4694 ;; Right/left borders? They can only be specified by column
4695 ;; groups. Column groups are defined in a row starting with "/".
4696 ;; Also a column groups row only contains "<", "<>", ">" or blank
4697 ;; cells.
4714 ;; There's a left border when previous cell, if
4715 ;; any, ends a group, or current one starts one.
4721 ;; There's a right border when next cell, if any,
4722 ;; starts a group, or current one ends one.
4729 ;; Table rows are read in reverse order so last column groups
4730 ;; row has precedence over any previous one.
4732 ;; Return value.
4733 borders))
4736 "Non-nil when TABLE-CELL is at the beginning of a column group.
4737 INFO is a plist used as a communication channel."
4738 ;; A cell starts a column group either when it is at the beginning
4739 ;; of a row (or after the special column, if any) or when it has
4740 ;; a left border.
4743 table-cell)
4747 "Non-nil when TABLE-CELL is at the end of a column group.
4748 INFO is a plist used as a communication channel."
4749 ;; A cell ends a column group either when it is at the end of a row
4750 ;; or when it has a right border.
4753 table-cell)
4757 "Non-nil when TABLE-ROW is at the beginning of a row group.
4758 INFO is a plist used as a communication channel."
4766 "Non-nil when TABLE-ROW is at the end of a row group.
4767 INFO is a plist used as a communication channel."
4775 "Non-nil when TABLE-ROW is located within table's header.
4776 INFO is a plist used as a communication channel. Always return
4777 nil for special rows and rows separators."
4783 "Non-nil when TABLE-ROW is the first table header's row.
4784 INFO is a plist used as a communication channel."
4789 "Non-nil when TABLE-ROW is the last table header's row.
4790 INFO is a plist used as a communication channel."
4795 "Return TABLE-ROW number.
4796 INFO is a plist used as a communication channel. Return value is
4797 zero-based and ignores separators. The function returns nil for
4798 special columns and separators."
4810 "Return TABLE dimensions.
4812 INFO is a plist used as a communication channel.
4814 Return value is a CONS like (ROWS . COLUMNS) where
4815 ROWS (resp. COLUMNS) is the number of exportable
4816 rows (resp. columns)."
4818 ;; Set number of rows, and extract first one.
4824 ;; Set number of columns.
4826 ;; Return value.
4830 "Return address of a regular TABLE-CELL object.
4832 TABLE-CELL is the cell considered. INFO is a plist used as
4833 a communication channel.
4835 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4836 zero-based index. Only exportable cells are considered. The
4837 function returns nil for other cells."
4849 "Return regular table-cell object at ADDRESS in TABLE.
4851 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4852 zero-based index. TABLE is a table type element. INFO is
4853 a plist used as a communication channel.
4855 If no table-cell, among exportable cells, is found at ADDRESS,
4856 return nil."
4859 ;; Row at (car address) or nil.
4867 'table-cell
4874 ;;;; For Tables Of Contents
4875 ;;
4876 ;; `org-export-collect-headlines' builds a list of all exportable
4877 ;; headline elements, maybe limited to a certain depth. One can then
4878 ;; easily parse it and transcode it.
4879 ;;
4880 ;; Building lists of tables, figures or listings is quite similar.
4881 ;; Once the generic function `org-export-collect-elements' is defined,
4882 ;; `org-export-collect-tables', `org-export-collect-figures' and
4883 ;; `org-export-collect-listings' can be derived from it.
4886 "Collect headlines in order to build a table of contents.
4888 INFO is a plist used as a communication channel.
4890 When optional argument N is an integer, it specifies the depth of
4891 the table of contents. Otherwise, it is set to the value of the
4892 last headline level. See `org-export-headline-levels' for more
4893 information.
4895 Optional argument SCOPE, when non-nil, is an element. If it is
4896 a headline, only children of SCOPE are collected. Otherwise,
4897 collect children of the headline containing provided element. If
4898 there is no such headline, collect all headlines. In any case,
4899 argument N becomes relative to the level of that headline.
4901 Return a list of all exportable headlines as parsed elements.
4902 Footnote sections are ignored."
4911 limit))))
4917 info)))
4920 "Collect referenceable elements of a determined type.
4922 TYPE can be a symbol or a list of symbols specifying element
4923 types to search. Only elements with a caption are collected.
4925 INFO is a plist used as a communication channel.
4927 When non-nil, optional argument PREDICATE is a function accepting
4928 one argument, an element of type TYPE. It returns a non-nil
4929 value when that element should be collected.
4931 Return a list of all elements found, in order of appearance."
4936 element))
4937 info))
4940 "Build a list of tables.
4941 INFO is a plist used as a communication channel.
4943 Return a list of table elements with a caption."
4947 "Build a list of figures.
4949 INFO is a plist used as a communication channel. PREDICATE is
4950 a function which accepts one argument: a paragraph element and
4951 whose return value is non-nil when that element should be
4952 collected.
4954 A figure is a paragraph type element, with a caption, verifying
4956 a vague concept that may depend on back-end.
4958 Return a list of elements recognized as figures."
4962 "Build a list of src blocks.
4964 INFO is a plist used as a communication channel.
4966 Return a list of src-block elements with a caption."
4970 ;;;; Smart Quotes
4971 ;;
4972 ;; The main function for the smart quotes sub-system is
4973 ;; `org-export-activate-smart-quotes', which replaces every quote in
4974 ;; a given string from the parse tree with its "smart" counterpart.
4975 ;;
4976 ;; Dictionary for smart quotes is stored in
4977 ;; `org-export-smart-quotes-alist'.
4978 ;;
4979 ;; Internally, regexps matching potential smart quotes (checks at
4980 ;; string boundaries are also necessary) are defined in
4981 ;; `org-export-smart-quotes-regexps'.
4985 ;; one may use: »...«, "...", ›...‹, or '...'.
4986 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4987 ;; LaTeX quotes require Babel!
5032 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5041 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5050 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5059 ;; 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
5060 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5071 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5077 )
5078 "Smart quotes translations.
5080 Alist whose CAR is a language string and CDR is an alist with
5081 quote type as key and a plist associating various encodings to
5082 their translation as value.
5084 A quote type can be any symbol among `opening-double-quote',
5085 `closing-double-quote', `opening-single-quote',
5086 `closing-single-quote' and `apostrophe'.
5088 Valid encodings include `:utf-8', `:html', `:latex' and
5089 `:texinfo'.
5094 "Return smart quote status at the beginning of string S.
5095 INFO is the current export state, as a plist."
5100 table)))
5115 ;; Not already in a level 1 quote: this is an
5116 ;; apostrophe.
5118 ;; Apostrophe.
5120 ;; Apostrophe at the beginning of a string. Check
5121 ;; white space at the end of the last object.
5130 ;; Apostrophe at the end of a string. Check white
5131 ;; space at the beginning of the next object, which
5132 ;; can only happen if that object is a string.
5139 ;; Lonesome apostrophe. Check white space around
5140 ;; both ends.
5152 n))))))))
5154 ;; Else, consider it as a level 2 quote.
5158 current-status))
5161 info nil org-element-recursive-objects)
5168 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5169 `:utf-8'. INFO is a plist used as a communication channel.
5171 The function has to retrieve information about string
5172 surroundings in parse tree. It can only happen with an
5173 unmodified string. Thus, if S has already been through another
5174 process, a non-nil ORIGINAL optional argument will provide that
5175 original string.
5177 Return the new string."
5186 org-export-smart-quotes-alist))))
5187 encoding)
5188 match))
5189 s nil t)))
5191 ;;;; Topology
5192 ;;
5193 ;; Here are various functions to retrieve information about the
5194 ;; neighborhood of a given element or object. Neighbors of interest
5195 ;; are direct parent (`org-export-get-parent'), parent headline
5196 ;; (`org-export-get-parent-headline'), first element containing an
5197 ;; object, (`org-export-get-parent-element'), parent table
5198 ;; (`org-export-get-parent-table'), previous element or object
5199 ;; (`org-export-get-previous-element') and next element or object
5200 ;; (`org-export-get-next-element').
5202 ;; defsubst org-export-get-parent must be defined before first use
5208 "Return BLOB parent headline or nil.
5209 BLOB is the element or object being considered."
5213 "Return first element containing OBJECT or nil.
5214 OBJECT is the object to consider."
5218 "Return OBJECT parent table or nil.
5219 OBJECT is either a `table-cell' or `table-element' type object."
5223 "Return previous element or object.
5225 BLOB is an element or object. INFO is a plist used as
5226 a communication channel. Return previous exportable element or
5227 object, a string, or nil.
5229 When optional argument N is a positive integer, return a list
5230 containing up to N siblings before BLOB, from farthest to
5231 closest. With any other non-nil value, return a list containing
5232 all of them."
5238 prev)
5248 "Return next element or object.
5250 BLOB is an element or object. INFO is a plist used as
5251 a communication channel. Return next exportable element or
5252 object, a string, or nil.
5254 When optional argument N is a positive integer, return a list
5255 containing up to N siblings after BLOB, from closest to farthest.
5256 With any other non-nil value, return a list containing all of
5257 them."
5264 next)
5274 ;;;; Translation
5275 ;;
5276 ;; `org-export-translate' translates a string according to the language
5277 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5278 ;; the dictionary used for the translation.
5310 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5320 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5326 ("ru" :html "(Продолжение следует)"
5400 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5423 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5429 ("ru" :html "Список распечаток"
5443 ("ru" :html "Список таблиц"
5536 ("ru" :html "Неизвестная ссылка"
5539 "Dictionary for export engine.
5541 Alist whose car is the string to translate and cdr is an alist
5542 whose car is the language string and cdr is a plist whose
5543 properties are possible charsets and values translated terms.
5545 It is used as a database for `org-export-translate'. Since this
5546 function returns the string as-is if no translation was found,
5547 the variable only needs to record values different from the
5551 "Translate string S according to language specification.
5553 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5554 and `:utf-8'. INFO is a plist used as a communication channel.
5556 Translation depends on `:language' property. Return the
5557 translated string. If no translation is found, try to fall back
5558 to `:default' encoding. If it fails, return S."
5564 s)))
5567 \f
5568 ;;; Asynchronous Export
5569 ;;
5570 ;; `org-export-async-start' is the entry point for asynchronous
5571 ;; export. It recreates current buffer (including visibility,
5572 ;; narrowing and visited file) in an external Emacs process, and
5573 ;; evaluates a command there. It then applies a function on the
5574 ;; returned results in the current process.
5575 ;;
5576 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5577 ;; allow to export to a buffer or a file, asynchronously or not.
5578 ;;
5579 ;; `org-export-output-file-name' is an auxiliary function meant to be
5580 ;; used with `org-export-to-file'. With a given extension, it tries
5581 ;; to provide a canonical file name to write export output to.
5582 ;;
5583 ;; Asynchronously generated results are never displayed directly.
5584 ;; Instead, they are stored in `org-export-stack-contents'. They can
5585 ;; then be retrieved by calling `org-export-stack'.
5586 ;;
5587 ;; Export Stack is viewed through a dedicated major mode
5588 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5589 ;;`org-export-stack-delete', `org-export-stack-view' and
5590 ;;`org-export-stack-clear'.
5591 ;;
5592 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5593 ;; It should be used whenever `org-export-async-start' is called.
5596 "Call function FUN on the results returned by BODY evaluation.
5598 FUN is an anonymous function of one argument. BODY evaluation
5599 happens in an asynchronous process, from a buffer which is an
5600 exact copy of the current one.
5602 Use `org-export-add-to-stack' in FUN in order to register results
5603 in the stack.
5605 This is a low level function. See also `org-export-to-buffer'
5606 and `org-export-to-file' for more specialized functions."
5609 ;; Write the full sexp evaluating BODY in a copy of the current
5610 ;; buffer to a temporary file, as it may be too long for program
5611 ;; args in `start-process'.
5618 ;; Null characters (from variable values) are inserted
5619 ;; within the file. As a consequence, coding system for
5620 ;; buffer contents will not be recognized properly. So,
5621 ;; we make sure it is the same as the one used to display
5622 ;; the original buffer.
5624 ,coding
5627 ;; Ignore `kill-emacs-hook' and code evaluation
5628 ;; queries from Babel as we need a truly
5629 ;; non-interactive process.
5631 org-babel-confirm-evaluate-answer-no t)
5632 ;; Initialize export framework.
5634 ;; Re-create current buffer there.
5637 ;; Sexp to evaluate in the buffer.
5639 ;; Start external process.
5642 (,process
5644 #'start-process
5647 ,proc-buffer
5654 ;; Register running process in stack.
5656 ;; Set-up sentinel in order to catch results.
5659 ,process
5681 ;;;###autoload
5684 &optional async subtreep visible-only body-only ext-plist
5685 post-process)
5686 "Call `org-export-as' with output to a specified buffer.
5688 BACKEND is either an export back-end, as returned by, e.g.,
5689 `org-export-create-backend', or a symbol referring to
5690 a registered back-end.
5692 BUFFER is the name of the output buffer. If it already exists,
5693 it will be erased first, otherwise, it will be created.
5695 A non-nil optional argument ASYNC means the process should happen
5696 asynchronously. The resulting buffer should then be accessible
5697 through the `org-export-stack' interface. When ASYNC is nil, the
5698 buffer is displayed if `org-export-show-temporary-export-buffer'
5699 is non-nil.
5701 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5702 EXT-PLIST are similar to those used in `org-export-as', which
5703 see.
5705 Optional argument POST-PROCESS is a function which should accept
5706 no argument. It is always called within the current process,
5707 from BUFFER, with point at its beginning. Export back-ends can
5708 use it to set a major mode there, e.g,
5710 \(defun org-latex-export-as-latex
5711 \(&optional async subtreep visible-only body-only ext-plist)
5712 \(interactive)
5714 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5716 This function returns BUFFER."
5744 buffer)))
5746 ;;;###autoload
5749 post-process)
5750 "Call `org-export-as' with output to a specified file.
5752 BACKEND is either an export back-end, as returned by, e.g.,
5753 `org-export-create-backend', or a symbol referring to
5754 a registered back-end. FILE is the name of the output file, as
5755 a string.
5757 A non-nil optional argument ASYNC means the process should happen
5758 asynchronously. The resulting buffer will then be accessible
5759 through the `org-export-stack' interface.
5761 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5762 EXT-PLIST are similar to those used in `org-export-as', which
5763 see.
5765 Optional argument POST-PROCESS is called with FILE as its
5766 argument and happens asynchronously when ASYNC is non-nil. It
5767 has to return a file name, or nil. Export back-ends can use this
5768 to send the output file through additional processing, e.g,
5770 \(defun org-latex-export-to-latex
5771 \(&optional async subtreep visible-only body-only ext-plist)
5772 \(interactive)
5774 \(org-export-to-file 'latex outfile
5775 async subtreep visible-only body-only ext-plist
5776 \(lambda (file) (org-latex-compile file)))
5778 The function returns either a file name returned by POST-PROCESS,
5779 or FILE."
5798 backend subtreep visible-only body-only ext-plist)))
5805 ;; Get proper return value.
5807 file))))))
5810 "Return output file's name according to buffer specifications.
5812 EXTENSION is a string representing the output file extension,
5813 with the leading dot.
5815 With a non-nil optional argument SUBTREEP, try to determine
5817 of subtree at point.
5819 When optional argument PUB-DIR is set, use it as the publishing
5820 directory.
5822 When optional argument VISIBLE-ONLY is non-nil, don't export
5823 contents of hidden elements.
5825 Return file name as a string."
5828 ;; File name may come from EXPORT_FILE_NAME subtree
5829 ;; property, assuming point is at beginning of said
5830 ;; sub-tree.
5837 ;; File name may be extracted from buffer's associated
5838 ;; file, if any.
5840 ;; Can't determine file name on our own: Ask user.
5844 "Output file: " pub-dir nil nil nil
5848 ;; Build file name. Enforce EXTENSION over whatever user
5849 ;; may have come up with. PUB-DIR, if defined, always has
5850 ;; precedence over any provided path.
5855 extension))
5858 ;; If writing to OUTPUT-FILE would overwrite original file, append
5859 ;; EXTENSION another time to final name.
5862 output-file)))
5865 "Add a new result to export stack if not present already.
5867 SOURCE is a buffer or a file name containing export results.
5868 BACKEND is a symbol representing export back-end used to generate
5869 it.
5871 Entries already pointing to SOURCE and unavailable entries are
5872 removed beforehand. Return the new stack."
5878 "Menu for asynchronous export results and running processes."
5888 "Return source from export results at point in stack."
5895 source
5896 ;; SOURCE is not consistent with current line. The stack
5897 ;; view is outdated.
5901 "Remove all entries from export stack."
5906 "Refresh the asynchronous export stack.
5907 DUMMY is ignored. Unavailable sources are removed from the list.
5908 Return the new stack."
5918 ;; Back-end.
5920 ;; Age.
5923 ;; Compute age of the results.
5925 "%4h:%.2m "
5927 ;; Source.
5932 ;; Clear stack from exited processes, dead buffers or
5933 ;; non-existent files.
5945 "Remove export results at point from stack.
5946 If optional argument SOURCE is non-nil, remove it instead."
5951 org-export-stack-contents))))
5954 "View export results at point in stack.
5955 With an optional prefix argument IN-EMACS, force viewing files
5956 within Emacs."
5970 (define-key km "p" 'previous-line)
5971 (define-key km "\C-p" 'previous-line)
5972 (define-key km "\C-?" 'previous-line)
5973 (define-key km [up] 'previous-line)
5974 (define-key km "C" 'org-export-stack-clear)
5975 (define-key km "v" 'org-export-stack-view)
5976 (define-key km (kbd "RET") 'org-export-stack-view)
5977 (define-key km "d" 'org-export-stack-remove)
5978 km)
5979 "Keymap for Org Export Stack.")
5981 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5982 "Mode for displaying asynchronous export stack.
5985 stack.
5987 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5988 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5989 stack completely.
5991 Removing entries in an Org Export Stack buffer doesn't affect
5992 files or buffers, only the display.
5995 (abbrev-mode 0)
5996 (auto-fill-mode 0)
5997 (setq buffer-read-only t
5998 buffer-undo-list t
5999 truncate-lines t
6000 header-line-format
6001 '(:eval
6002 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6003 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6004 (set (make-local-variable 'revert-buffer-function)
6005 'org-export-stack-refresh))
6008 \f
6009 ;;; The Dispatcher
6010 ;;
6011 ;; `org-export-dispatch' is the standard interactive way to start an
6012 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6013 ;; for its interface, which, in turn, delegates response to key
6014 ;; pressed to `org-export--dispatch-action'.
6016 ;;;###autoload
6017 (defun org-export-dispatch (&optional arg)
6018 "Export dispatcher for Org mode.
6020 It provides an access to common export related tasks in a buffer.
6021 Its interface comes in two flavors: standard and expert.
6023 While both share the same set of bindings, only the former
6024 displays the valid keys associations in a dedicated buffer.
6025 Scrolling (resp. line-wise motion) in this buffer is done with
6026 SPC and DEL (resp. C-n and C-p) keys.
6028 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6029 flavor or the other.
6032 of options used back then, on the current buffer.
6034 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6035 (interactive "P")
6036 (let* ((input
6037 (cond ((equal arg '(16)) '(stack))
6038 ((and arg org-export-dispatch-last-action))
6039 (t (save-window-excursion
6040 (unwind-protect
6041 (progn
6042 ;; Remember where we are
6043 (move-marker org-export-dispatch-last-position
6044 (point)
6045 (org-base-buffer (current-buffer)))
6046 ;; Get and store an export command
6047 (setq org-export-dispatch-last-action
6048 (org-export--dispatch-ui
6049 (list org-export-initial-scope
6050 (and org-export-in-background 'async))
6051 nil
6052 org-export-dispatch-use-expert-ui)))
6053 (and (get-buffer "*Org Export Dispatcher*")
6054 (kill-buffer "*Org Export Dispatcher*")))))))
6055 (action (car input))
6056 (optns (cdr input)))
6057 (unless (memq 'subtree optns)
6058 (move-marker org-export-dispatch-last-position nil))
6059 (case action
6060 ;; First handle special hard-coded actions.
6061 (template (org-export-insert-default-template nil optns))
6062 (stack (org-export-stack))
6063 (publish-current-file
6064 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6065 (publish-current-project
6066 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6067 (publish-choose-project
6068 (org-publish (assoc (org-icompleting-read
6069 "Publish project: "
6070 org-publish-project-alist nil t)
6071 org-publish-project-alist)
6072 (memq 'force optns)
6073 (memq 'async optns)))
6074 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6075 (otherwise
6076 (save-excursion
6077 (when arg
6078 ;; Repeating command, maybe move cursor to restore subtree
6079 ;; context.
6080 (if (eq (marker-buffer org-export-dispatch-last-position)
6081 (org-base-buffer (current-buffer)))
6082 (goto-char org-export-dispatch-last-position)
6083 ;; We are in a different buffer, forget position.
6084 (move-marker org-export-dispatch-last-position nil)))
6085 (funcall action
6086 ;; Return a symbol instead of a list to ease
6087 ;; asynchronous export macro use.
6088 (and (memq 'async optns) t)
6089 (and (memq 'subtree optns) t)
6090 (and (memq 'visible optns) t)
6091 (and (memq 'body optns) t)))))))
6093 (defun org-export--dispatch-ui (options first-key expertp)
6094 "Handle interface for `org-export-dispatch'.
6096 OPTIONS is a list containing current interactive options set for
6097 export. It can contain any of the following symbols:
6098 `body' toggles a body-only export
6099 `subtree' restricts export to current subtree
6100 `visible' restricts export to visible part of buffer.
6101 `force' force publishing files.
6102 `async' use asynchronous export process
6104 FIRST-KEY is the key pressed to select the first level menu. It
6105 is nil when this menu hasn't been selected yet.
6107 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6108 buffer is provided, but indications about currently active
6109 options are given in the prompt. Moreover, \[?] allows to switch
6110 back to standard interface."
6111 (let* ((fontify-key
6112 (lambda (key &optional access-key)
6113 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6114 ;; non-nil is the required first-level key to activate
6115 ;; KEY. When its value is t, activate KEY independently
6116 ;; on the first key, if any. A nil value means KEY will
6117 ;; only be activated at first level.
6118 (if (or (eq access-key t) (eq access-key first-key))
6119 (org-propertize key 'face 'org-warning)
6120 key)))
6121 (fontify-value
6122 (lambda (value)
6123 ;; Fontify VALUE string.
6124 (org-propertize value 'face 'font-lock-variable-name-face)))
6125 ;; Prepare menu entries by extracting them from registered
6126 ;; back-ends and sorting them by access key and by ordinal,
6127 ;; if any.
6128 (entries
6129 (sort (sort (delq nil
6130 (mapcar #'org-export-backend-menu
6131 org-export-registered-backends))
6132 (lambda (a b)
6133 (let ((key-a (nth 1 a))
6134 (key-b (nth 1 b)))
6135 (cond ((and (numberp key-a) (numberp key-b))
6136 (< key-a key-b))
6137 ((numberp key-b) t)))))
6138 'car-less-than-car))
6139 ;; Compute a list of allowed keys based on the first key
6140 ;; pressed, if any. Some keys
6141 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6142 ;; available.
6143 (allowed-keys
6144 (nconc (list 2 22 19 6 1)
6145 (if (not first-key) (org-uniquify (mapcar 'car entries))
6146 (let (sub-menu)
6147 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6148 (when (eq (car entry) first-key)
6149 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6150 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6151 ((not first-key) (list ?P)))
6152 (list ?& ?#)
6153 (when expertp (list ??))
6154 (list ?q)))
6155 ;; Build the help menu for standard UI.
6156 (help
6157 (unless expertp
6158 (concat
6159 ;; Options are hard-coded.
6160 (format "[%s] Body only: %s [%s] Visible only: %s
6161 \[%s] Export scope: %s [%s] Force publishing: %s
6163 (funcall fontify-key "C-b" t)
6164 (funcall fontify-value
6165 (if (memq 'body options) "On " "Off"))
6166 (funcall fontify-key "C-v" t)
6167 (funcall fontify-value
6168 (if (memq 'visible options) "On " "Off"))
6169 (funcall fontify-key "C-s" t)
6170 (funcall fontify-value
6171 (if (memq 'subtree options) "Subtree" "Buffer "))
6172 (funcall fontify-key "C-f" t)
6173 (funcall fontify-value
6174 (if (memq 'force options) "On " "Off"))
6175 (funcall fontify-key "C-a" t)
6176 (funcall fontify-value
6177 (if (memq 'async options) "On " "Off")))
6178 ;; Display registered back-end entries. When a key
6179 ;; appears for the second time, do not create another
6180 ;; entry, but append its sub-menu to existing menu.
6181 (let (last-key)
6182 (mapconcat
6183 (lambda (entry)
6184 (let ((top-key (car entry)))
6185 (concat
6186 (unless (eq top-key last-key)
6187 (setq last-key top-key)
6189 (funcall fontify-key (char-to-string top-key))
6190 (nth 1 entry)))
6191 (let ((sub-menu (nth 2 entry)))
6192 (unless (functionp sub-menu)
6193 ;; Split sub-menu into two columns.
6194 (let ((index -1))
6195 (concat
6196 (mapconcat
6197 (lambda (sub-entry)
6198 (incf index)
6199 (format
6200 (if (zerop (mod index 2)) " [%s] %-26s"
6202 (funcall fontify-key
6203 (char-to-string (car sub-entry))
6204 top-key)
6205 (nth 1 sub-entry)))
6206 sub-menu "")
6208 entries ""))
6209 ;; Publishing menu is hard-coded.
6211 [%s] Current file [%s] Current project
6213 (funcall fontify-key "P")
6214 (funcall fontify-key "f" ?P)
6215 (funcall fontify-key "p" ?P)
6216 (funcall fontify-key "x" ?P)
6217 (funcall fontify-key "a" ?P))
6219 (funcall fontify-key "&" t)
6220 (funcall fontify-key "#" t))
6221 (format "[%s] %s"
6222 (funcall fontify-key "q" t)
6223 (if first-key "Main menu" "Exit")))))
6224 ;; Build prompts for both standard and expert UI.
6225 (standard-prompt (unless expertp "Export command: "))
6226 (expert-prompt
6227 (when expertp
6228 (format
6229 "Export command (C-%s%s%s%s%s) [%s]: "
6230 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6231 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6232 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6233 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6234 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6235 (mapconcat (lambda (k)
6236 ;; Strip control characters.
6237 (unless (< k 27) (char-to-string k)))
6238 allowed-keys "")))))
6239 ;; With expert UI, just read key with a fancy prompt. In standard
6240 ;; UI, display an intrusive help buffer.
6241 (if expertp
6242 (org-export--dispatch-action
6243 expert-prompt allowed-keys entries options first-key expertp)
6244 ;; At first call, create frame layout in order to display menu.
6245 (unless (get-buffer "*Org Export Dispatcher*")
6246 (delete-other-windows)
6247 (org-switch-to-buffer-other-window
6248 (get-buffer-create "*Org Export Dispatcher*"))
6249 (setq cursor-type nil
6250 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6251 ;; Make sure that invisible cursor will not highlight square
6252 ;; brackets.
6253 (set-syntax-table (copy-syntax-table))
6254 (modify-syntax-entry ?\[ "w"))
6255 ;; At this point, the buffer containing the menu exists and is
6256 ;; visible in the current window. So, refresh it.
6257 (with-current-buffer "*Org Export Dispatcher*"
6258 ;; Refresh help. Maintain display continuity by re-visiting
6259 ;; previous window position.
6260 (let ((pos (window-start)))
6261 (erase-buffer)
6262 (insert help)
6263 (set-window-start nil pos)))
6264 (org-fit-window-to-buffer)
6265 (org-export--dispatch-action
6266 standard-prompt allowed-keys entries options first-key expertp))))
6268 (defun org-export--dispatch-action
6269 (prompt allowed-keys entries options first-key expertp)
6270 "Read a character from command input and act accordingly.
6272 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6273 a list of characters available at a given step in the process.
6274 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6275 EXPERTP are the same as defined in `org-export--dispatch-ui',
6276 which see.
6278 Toggle export options when required. Otherwise, return value is
6279 a list with action as CAR and a list of interactive export
6280 options as CDR."
6281 (let (key)
6282 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6283 ;; C-p, SPC, DEL).
6284 (while (and (setq key (read-char-exclusive prompt))
6285 (not expertp)
6286 (memq key '(14 16 ?\s ?\d)))
6287 (case key
6288 (14 (if (not (pos-visible-in-window-p (point-max)))
6289 (ignore-errors (scroll-up 1))
6290 (message "End of buffer")
6291 (sit-for 1)))
6292 (16 (if (not (pos-visible-in-window-p (point-min)))
6293 (ignore-errors (scroll-down 1))
6294 (message "Beginning of buffer")
6295 (sit-for 1)))
6296 (?\s (if (not (pos-visible-in-window-p (point-max)))
6297 (scroll-up nil)
6298 (message "End of buffer")
6299 (sit-for 1)))
6300 (?\d (if (not (pos-visible-in-window-p (point-min)))
6301 (scroll-down nil)
6302 (message "Beginning of buffer")
6303 (sit-for 1)))))
6304 (cond
6305 ;; Ignore undefined associations.
6306 ((not (memq key allowed-keys))
6307 (ding)
6308 (unless expertp (message "Invalid key") (sit-for 1))
6309 (org-export--dispatch-ui options first-key expertp))
6310 ;; q key at first level aborts export. At second level, cancel
6311 ;; first key instead.
6312 ((eq key ?q) (if (not first-key) (error "Export aborted")
6313 (org-export--dispatch-ui options nil expertp)))
6314 ;; Help key: Switch back to standard interface if expert UI was
6315 ;; active.
6316 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6317 ;; Send request for template insertion along with export scope.
6318 ((eq key ?#) (cons 'template (memq 'subtree options)))
6319 ;; Switch to asynchronous export stack.
6320 ((eq key ?&) '(stack))
6321 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6322 ((memq key '(2 22 19 6 1))
6323 (org-export--dispatch-ui
6324 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6325 (6 'force) (1 'async))))
6326 (if (memq option options) (remq option options)
6327 (cons option options)))
6328 first-key expertp))
6329 ;; Action selected: Send key and options back to
6330 ;; `org-export-dispatch'.
6331 ((or first-key (functionp (nth 2 (assq key entries))))
6332 (cons (cond
6333 ((not first-key) (nth 2 (assq key entries)))
6334 ;; Publishing actions are hard-coded. Send a special
6335 ;; signal to `org-export-dispatch'.
6336 ((eq first-key ?P)
6337 (case key
6338 (?f 'publish-current-file)
6339 (?p 'publish-current-project)
6340 (?x 'publish-choose-project)
6341 (?a 'publish-all)))
6342 ;; Return first action associated to FIRST-KEY + KEY
6343 ;; path. Indeed, derived backends can share the same
6344 ;; FIRST-KEY.
6345 (t (catch 'found
6346 (mapc (lambda (entry)
6347 (let ((match (assq key (nth 2 entry))))
6348 (when match (throw 'found (nth 2 match)))))
6349 (member (assq first-key entries) entries)))))
6350 options))
6351 ;; Otherwise, enter sub-menu.
6352 (t (org-export--dispatch-ui options key expertp)))))
6356 (provide 'ox)
6358 ;; Local variables:
6359 ;; generated-autoload-file: "org-loaddefs.el"
6360 ;; End:
6362 ;;; ox.el ends here