| blob | f47baef8ff1067bb38dec69010a164961b0b67da |
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.
141 "Alist between export properties and ways to set them.
143 The CAR of the alist is the property name, and the CDR is a list
144 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
146 KEYWORD is a string representing a buffer keyword, or nil. Each
147 property defined this way can also be set, during subtree
148 export, through a headline property named after the keyword
150 property).
151 OPTION is a string that could be found in an #+OPTIONS: line.
152 DEFAULT is the default value for the property.
153 BEHAVIOR determines how Org should handle multiple keywords for
154 the same property. It is a symbol among:
155 nil Keep old value and discard the new one.
156 t Replace old value with the new one.
157 `space' Concatenate the values, separating them with a space.
158 `newline' Concatenate the values, separating them with
159 a newline.
160 `split' Split values at white spaces, and cons them to the
161 previous list.
163 Values set through KEYWORD and OPTION have precedence over
164 DEFAULT.
166 All these properties should be back-end agnostic. Back-end
167 specific properties are set through `org-export-define-backend'.
171 "List of in-buffer keywords that require special treatment.
172 These keywords are not directly associated to a property. The
173 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' and
370 If the value is `comment' insert it as a comment."
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 insert a time stamp into the exported file.
748 The time stamp shows when the file was created. This option can
754 "Non nil means allow timestamps in export.
756 It can be set to any of the following values:
757 t export all timestamps.
758 `active' export active timestamps only.
759 `inactive' export inactive timestamps only.
760 nil do not export timestamps
762 This only applies to timestamps isolated in a paragraph
763 containing only timestamps. Other timestamps are always
764 exported.
766 This option can also be set with the OPTIONS keyword, e.g.
776 "Non-nil means include TODO keywords in export.
777 When nil, remove all these keywords from the export. This option
783 "Non-nil means BIND keywords can define local variable values.
784 This is a potential security risk, which is why the default value
785 is nil. You can also allow them through local buffer variables."
792 "Alist between export snippets back-ends and exporter back-ends.
794 This variable allows to provide shortcuts for export snippets.
798 HTML code while every other back-end will ignore it."
807 "Coding system for the exported file."
814 "Non-nil means pushing export output to the kill ring.
815 This variable is ignored during asynchronous export."
825 "The initial scope when exporting with `org-export-dispatch'.
826 This variable can be either set to `buffer' or `subtree'."
833 "Non-nil means show buffer after exporting to temp buffer.
834 When Org exports to a file, the buffer visiting that file is never
835 shown, but remains buried. However, when exporting to
836 a temporary buffer, that buffer is popped up in a second window.
837 When this variable is nil, the buffer remains buried also in
838 these cases."
843 "Non-nil means export and publishing commands will run in background.
844 Results from an asynchronous export are never displayed
852 "File used to initialize external export process.
854 Value must be either nil or an absolute file name. When nil, the
855 external process is launched like a regular Emacs session,
856 loading user's initialization file and any site specific
857 configuration. If a file is provided, it, and only it, is loaded
858 at start-up.
860 Therefore, using a specific configuration makes the process to
861 load faster and the export more portable."
870 "Non-nil means using a non-intrusive `org-export-dispatch'.
871 In that case, no help buffer is displayed. Though, an indicator
877 asynchronous). Also, \[?] allows to switch back to standard
878 mode."
885 \f
886 ;;; Defining Back-ends
887 ;;
888 ;; An export back-end is a structure with `org-export-backend' type
889 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
890 ;; and `menu' slots.
891 ;;
892 ;; At the lowest level, a back-end is created with
893 ;; `org-export-create-backend' function.
894 ;;
895 ;; A named back-end can be registered with
896 ;; `org-export-register-backend' function. A registered back-end can
897 ;; later be referred to by its name, with `org-export-get-backend'
898 ;; function. Also, such a back-end can become the parent of a derived
899 ;; back-end from which slot values will be inherited by default.
900 ;; `org-export-derived-backend-p' can check if a given back-end is
901 ;; derived from a list of back-end names.
902 ;;
903 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
904 ;; `org-export-get-all-filters' return the full alist of transcoders,
905 ;; options and filters, including those inherited from ancestors.
906 ;;
907 ;; At a higher level, `org-export-define-backend' is the standard way
908 ;; to define an export back-end. If the new back-end is similar to
909 ;; a registered back-end, `org-export-define-derived-backend' may be
910 ;; used instead.
911 ;;
912 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
913 ;; when a given back-end hasn't been registered yet.
917 name parent transcoders options filters blocks menu)
920 "Return export back-end named after NAME.
921 NAME is a symbol. Return nil if no such back-end is found."
928 "Register BACKEND as a known export back-end.
929 BACKEND is a structure with `org-export-backend' type."
930 ;; Refuse to register an unnamed back-end.
933 ;; Refuse to register a back-end with an unknown parent.
937 ;; Register dedicated export blocks in the parser.
941 ;; If a back-end with the same name as BACKEND is already
942 ;; registered, replace it with BACKEND. Otherwise, simply add
943 ;; BACKEND to the list of registered back-ends.
949 "Signal an error if BACKEND isn't defined."
954 "Non-nil if BACKEND is derived from one of BACKENDS.
955 BACKEND is an export back-end, as returned by, e.g.,
956 `org-export-create-backend', or a symbol referring to
957 a registered back-end. BACKENDS is constituted of symbols."
969 "Return full translation table for BACKEND.
971 BACKEND is an export back-end, as return by, e.g,,
972 `org-export-create-backend'. Return value is an alist where
973 keys are element or object types, as symbols, and values are
974 transcoders.
976 Unlike to `org-export-backend-transcoders', this function
977 also returns transcoders inherited from parent back-ends,
978 if any."
982 parent)
987 transcoders)))
990 "Return export options for BACKEND.
992 BACKEND is an export back-end, as return by, e.g,,
993 `org-export-create-backend'. See `org-export-options-alist'
994 for the shape of the return value.
996 Unlike to `org-export-backend-options', this function also
997 returns options inherited from parent back-ends, if any."
1001 parent)
1005 options)))
1008 "Return complete list of filters for BACKEND.
1010 BACKEND is an export back-end, as return by, e.g,,
1011 `org-export-create-backend'. Return value is an alist where
1012 keys are symbols and values lists of functions.
1014 Unlike to `org-export-backend-filters', this function also
1015 returns filters inherited from parent back-ends, if any."
1019 parent)
1023 filters)))
1026 "Define a new back-end BACKEND.
1028 TRANSCODERS is an alist between object or element types and
1029 functions handling them.
1031 These functions should return a string without any trailing
1032 space, or nil. They must accept three arguments: the object or
1033 element itself, its contents or nil when it isn't recursive and
1034 the property list used as a communication channel.
1036 Contents, when not nil, are stripped from any global indentation
1037 \(although the relative one is preserved). They also always end
1038 with a single newline character.
1040 If, for a given type, no function is found, that element or
1041 object type will simply be ignored, along with any blank line or
1042 white space at its end. The same will happen if the function
1043 returns the nil value. If that function returns the empty
1044 string, the type will be ignored, but the blank lines or white
1045 spaces will be kept.
1047 In addition to element and object types, one function can be
1048 associated to the `template' (or `inner-template') symbol and
1049 another one to the `plain-text' symbol.
1051 The former returns the final transcoded string, and can be used
1052 to add a preamble and a postamble to document's body. It must
1053 accept two arguments: the transcoded string and the property list
1054 containing export options. A function associated to `template'
1056 A function associated to `inner-template' is always applied.
1058 The latter, when defined, is to be called on every text not
1059 recognized as an element or an object. It must accept two
1060 arguments: the text string and the information channel. It is an
1061 appropriate place to protect special chars relative to the
1062 back-end.
1064 BODY can start with pre-defined keyword arguments. The following
1065 keywords are understood:
1067 :export-block
1069 String, or list of strings, representing block names that
1070 will not be parsed. This is used to specify blocks that will
1071 contain raw code specific to the back-end. These blocks
1072 still have to be handled by the relative `export-block' type
1073 translator.
1075 :filters-alist
1077 Alist between filters and function, or list of functions,
1078 specific to the back-end. See `org-export-filters-alist' for
1079 a list of all allowed filters. Filters defined here
1080 shouldn't make a back-end test, as it may prevent back-ends
1081 derived from this one to behave properly.
1083 :menu-entry
1085 Menu entry for the export dispatcher. It should be a list
1086 like:
1088 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1090 where :
1092 KEY is a free character selecting the back-end.
1094 DESCRIPTION-OR-ORDINAL is either a string or a number.
1096 If it is a string, is will be used to name the back-end in
1097 its menu entry. If it is a number, the following menu will
1098 be displayed as a sub-menu of the back-end with the same
1099 KEY. Also, the number will be used to determine in which
1100 order such sub-menus will appear (lowest first).
1102 ACTION-OR-MENU is either a function or an alist.
1104 If it is an action, it will be called with four
1105 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1106 BODY-ONLY. See `org-export-as' for further explanations on
1107 some of them.
1109 If it is an alist, associations should follow the
1110 pattern:
1112 '(KEY DESCRIPTION ACTION)
1114 where KEY, DESCRIPTION and ACTION are described above.
1116 Valid values include:
1120 or
1125 \(lambda (a s v b)
1126 \(if a (org-latex-export-to-pdf t s v b)
1127 \(org-open-file
1128 \(org-latex-export-to-pdf nil s v b)))))))
1130 or the following, which will be added to the previous
1131 sub-menu,
1133 '(?l 1
1137 :options-alist
1139 Alist between back-end specific properties introduced in
1140 communication channel and how their value are acquired. See
1141 `org-export-options-alist' for more information about
1142 structure of the values."
1157 :transcoders transcoders
1158 :options options
1159 :filters filters
1160 :blocks blocks
1164 "Create a new back-end as a variant of an existing one.
1166 CHILD is the name of the derived back-end. PARENT is the name of
1167 the parent back-end.
1169 BODY can start with pre-defined keyword arguments. The following
1170 keywords are understood:
1172 :export-block
1174 String, or list of strings, representing block names that
1175 will not be parsed. This is used to specify blocks that will
1176 contain raw code specific to the back-end. These blocks
1177 still have to be handled by the relative `export-block' type
1178 translator.
1180 :filters-alist
1182 Alist of filters that will overwrite or complete filters
1183 defined in PARENT back-end. See `org-export-filters-alist'
1184 for a list of allowed filters.
1186 :menu-entry
1188 Menu entry for the export dispatcher. See
1189 `org-export-define-backend' for more information about the
1190 expected value.
1192 :options-alist
1194 Alist of back-end specific properties that will overwrite or
1195 complete those defined in PARENT back-end. Refer to
1196 `org-export-options-alist' for more information about
1197 structure of the values.
1199 :translate-alist
1201 Alist of element and object types and transcoders that will
1202 overwrite or complete transcode table from PARENT back-end.
1203 Refer to `org-export-define-backend' for detailed information
1204 about transcoders.
1207 as a variant of `latex' back-end with a custom template function:
1209 \(org-export-define-derived-backend 'my-latex 'latex
1210 :translate-alist '((template . my-latex-template-fun)))
1212 The back-end could then be called with, for example:
1230 :parent parent
1231 :transcoders transcoders
1232 :options options
1233 :filters filters
1234 :blocks blocks
1238 \f
1239 ;;; The Communication Channel
1240 ;;
1241 ;; During export process, every function has access to a number of
1242 ;; properties. They are of two types:
1243 ;;
1244 ;; 1. Environment options are collected once at the very beginning of
1245 ;; the process, out of the original buffer and configuration.
1246 ;; Collecting them is handled by `org-export-get-environment'
1247 ;; function.
1248 ;;
1249 ;; Most environment options are defined through the
1250 ;; `org-export-options-alist' variable.
1251 ;;
1252 ;; 2. Tree properties are extracted directly from the parsed tree,
1253 ;; just before export, by `org-export-collect-tree-properties'.
1255 ;;;; Environment Options
1256 ;;
1257 ;; Environment options encompass all parameters defined outside the
1258 ;; scope of the parsed data. They come from five sources, in
1259 ;; increasing precedence order:
1260 ;;
1261 ;; - Global variables,
1262 ;; - Buffer's attributes,
1263 ;; - Options keyword symbols,
1264 ;; - Buffer keywords,
1265 ;; - Subtree properties.
1266 ;;
1267 ;; The central internal function with regards to environment options
1268 ;; is `org-export-get-environment'. It updates global variables with
1269 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1270 ;; the different sources.
1271 ;;
1272 ;; The internal functions doing the retrieval are:
1273 ;; `org-export--get-global-options',
1274 ;; `org-export--get-buffer-attributes',
1275 ;; `org-export--parse-option-keyword',
1276 ;; `org-export--get-subtree-options' and
1277 ;; `org-export--get-inbuffer-options'
1278 ;;
1279 ;; Also, `org-export--list-bound-variables' collects bound variables
1280 ;; along with their value in order to set them as buffer local
1281 ;; variables later in the process.
1284 "Collect export options from the current buffer.
1286 Optional argument BACKEND is an export back-end, as returned by
1287 `org-export-create-backend'.
1289 When optional argument SUBTREEP is non-nil, assume the export is
1290 done against the current sub-tree.
1292 Third optional argument EXT-PLIST is a property list with
1293 external parameters overriding Org default settings, but still
1294 inferior to file-local settings."
1295 ;; First install #+BIND variables since these must be set before
1296 ;; global options are read.
1299 ;; Get and prioritize export options...
1301 ;; ... from global variables...
1303 ;; ... from an external property list...
1304 ext-plist
1305 ;; ... from in-buffer settings...
1307 ;; ... and from subtree, when appropriate.
1309 ;; Eventually add misc. properties.
1311 :back-end
1312 backend
1314 :footnote-definition-alist
1315 ;; Footnotes definitions must be collected in the original
1316 ;; buffer, as there's no insurance that they will still be in
1317 ;; the parse tree, due to possible narrowing.
1333 alist))
1345 alist)))))))
1346 alist))
1347 :id-alist
1348 ;; Collect id references.
1359 alist))))
1362 "Parse an OPTIONS line and return values as a plist.
1363 Optional argument BACKEND is an export back-end, as returned by,
1364 e.g., `org-export-create-backend'. It specifies which back-end
1365 specific items to read, if any."
1367 ;; Priority is given to back-end specific options.
1369 org-export-options-alist))
1370 plist)
1379 options))
1381 property
1384 plist))
1387 "Get export options in subtree at point.
1388 Optional argument BACKEND is an export back-end, as returned by,
1389 e.g., `org-export-create-backend'. It specifies back-end used
1390 for export. Return options as a plist."
1391 ;; For each buffer keyword, create a headline property setting the
1392 ;; same property in communication channel. The name for the property
1393 ;; is the keyword with "EXPORT_" appended to it.
1396 ;; Make sure point is at a heading.
1398 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1399 ;; title (with no todo keyword, priority cookie or tag) as its
1400 ;; fallback value.
1406 plist :title
1409 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1413 ;; Handle other keywords. TITLE keyword is excluded as it has
1414 ;; been handled already.
1422 ;; Export properties are not case-sensitive.
1429 plist
1430 property
1432 ;; Parse VALUE if required.
1436 ;; If BEHAVIOR is `split' expected value is
1437 ;; a list of strings, not a string.
1440 ;; Look for both general keywords and back-end specific
1441 ;; options, with priority given to the latter.
1443 org-export-options-alist)))
1444 ;; Return value.
1445 plist)))
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.
1475 ;; Recursively read keywords in buffer. FILES is a list
1476 ;; of files read so far. PLIST is the current property
1477 ;; list obtained.
1486 ;; Options in `org-export-special-keywords'.
1490 ;; Avoid circular dependencies.
1500 plist
1505 plist
1511 ;; Options in `org-export-options-alist'.
1516 plist property
1517 ;; Handle value depending on specified
1518 ;; BEHAVIOR.
1524 " "
1537 ;; Return final value.
1538 plist))))
1539 ;; Read options in the current buffer.
1542 ;; Parse keywords specified in `org-element-document-properties'
1543 ;; and return PLIST.
1554 "Return properties related to buffer attributes, as a plist."
1559 "Return global export options as a plist.
1560 Optional argument BACKEND, if non-nil, is an export back-end, as
1561 returned by, e.g., `org-export-create-backend'. It specifies
1562 which back-end specific export options should also be read in the
1563 process."
1565 ;; Priority is given to back-end specific options.
1567 org-export-options-alist)))
1573 plist
1574 prop
1575 ;; Evaluate default value provided. If keyword is
1576 ;; a member of `org-element-document-properties',
1577 ;; parse it as a secondary string before storing it.
1581 org-element-document-properties))
1584 value)))))))))
1587 "Return variables bound from BIND keywords in current buffer.
1588 Also look for BIND keywords in setup files. The return value is
1589 an alist where associations are (VARIABLE-NAME VALUE)."
1594 ;; Return an alist between variable names and their
1595 ;; value. FILES is a list of setup files names read so
1596 ;; far, used to avoid circular dependencies. ALIST is
1597 ;; the alist collected so far.
1608 ;; Enter setup file.
1618 alist))))))))))
1619 alist)))))
1620 ;; Return value in appropriate order of appearance.
1623 ;; defsubst org-export-get-parent must be defined before first use,
1624 ;; was originally defined in the topology section
1627 "Return BLOB parent or nil.
1628 BLOB is the element or object considered."
1631 ;;;; Tree Properties
1632 ;;
1633 ;; Tree properties are information extracted from parse tree. They
1634 ;; are initialized at the beginning of the transcoding process by
1635 ;; `org-export-collect-tree-properties'.
1636 ;;
1637 ;; Dedicated functions focus on computing the value of specific tree
1638 ;; properties during initialization. Thus,
1639 ;; `org-export--populate-ignore-list' lists elements and objects that
1640 ;; should be skipped during export, `org-export--get-min-level' gets
1641 ;; the minimal exportable level, used as a basis to compute relative
1642 ;; level for headlines. Eventually
1643 ;; `org-export--collect-headline-numbering' builds an alist between
1644 ;; headlines and their numbering.
1647 "Extract tree properties from parse tree.
1649 DATA is the parse tree from which information is retrieved. INFO
1650 is a list holding export options.
1652 Following tree properties are set or updated:
1654 `:exported-data' Hash table used to memoize results from
1655 `org-export-data'.
1657 `:footnote-definition-alist' List of footnotes definitions in
1658 original buffer and current parse tree.
1660 `:headline-offset' Offset between true level of headlines and
1661 local level. An offset of -1 means a headline
1662 of level 2 should be considered as a level
1663 1 headline in the context.
1665 `:headline-numbering' Alist of all headlines as key an the
1666 associated numbering as value.
1668 `:ignore-list' List of elements that should be ignored during
1669 export.
1671 Return updated plist."
1672 ;; Install the parse tree in the communication channel.
1674 ;; Get the list of elements and objects to ignore, and put it into
1675 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1676 ;; been done during parse tree filtering.
1679 :ignore-list
1682 ;; Compute `:headline-offset' in order to be able to use
1683 ;; `org-export-get-relative-level'.
1686 :headline-offset
1688 ;; Footnote definitions in parse tree override those stored in
1689 ;; `:footnote-definition-alist'. This way, any change to
1690 ;; a definition in the parse tree (e.g., through a parse tree
1691 ;; filter) propagates into the alist.
1698 defs))
1702 defs)))))
1704 ;; Properties order doesn't matter: get the rest of the tree
1705 ;; 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 "Return numbering of all exportable, unnumbered headlines.
1757 DATA is the parse tree. OPTIONS is the plist holding export
1758 options. Unnumbered headlines are numbered as a function of
1759 occurrence."
1767 "Return list of elements and objects to ignore during export.
1768 DATA is the parse tree to traverse. OPTIONS is the plist holding
1769 export options."
1771 ;; First find trees containing a select tag, if any.
1773 ;; If a select tag is active, also ignore the section before
1774 ;; the first headline, if any.
1778 first-element))))
1781 ;; Collect ignored elements or objects into IGNORE-LIST.
1787 ;; If headline is archived but tree below has
1788 ;; to be skipped, add it to ignore list.
1791 ;; Move into secondary string, if any.
1796 ;; Move into recursive objects/elements.
1798 ;; Main call.
1800 ;; Return value.
1801 ignore))
1804 "Return list of headlines and inlinetasks with a select tag in their tree.
1805 DATA is parsed data as returned by `org-element-parse-buffer'.
1806 INFO is a plist holding export options."
1808 walk-data ; For byte-compiler.
1818 ;; When a select tag is found, mark full
1819 ;; genealogy and every headline within the tree
1820 ;; as acceptable.
1823 genealogy
1826 selected-trees))
1827 ;; If at a headline, continue searching in tree,
1828 ;; recursively.
1838 selected-trees))
1841 "Non-nil when element or object BLOB should be skipped during export.
1842 OPTIONS is the plist holding export options. SELECTED, when
1843 non-nil, is a list of headlines or inlinetasks belonging to
1844 a tree with a select tag."
1851 ;; If `:with-drawers' value starts with `not', ignore
1852 ;; every drawer whose name belong to that list.
1853 ;; Otherwise, ignore drawers whose name isn't in that
1854 ;; list.
1871 ;; Ignore subtrees with an exclude tag.
1874 ;; When a select tag is present in the buffer, ignore any tree
1875 ;; without it.
1877 ;; Ignore commented sub-trees.
1879 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1881 ;; Ignore tasks, if specified by `:with-tasks' property.
1893 properties-set))))))
1904 ;; `:with-timestamps' only applies to isolated timestamps
1905 ;; objects, i.e. timestamp objects in a paragraph containing only
1906 ;; timestamps and whitespaces.
1914 options t))))
1923 \f
1924 ;;; The Transcoder
1925 ;;
1926 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1927 ;; `org-element-parse-buffer') and transcodes it into a specified
1928 ;; back-end output. It takes care of filtering out elements or
1929 ;; objects according to export options and organizing the output blank
1930 ;; lines and white space are preserved. The function memoizes its
1931 ;; results, so it is cheap to call it within transcoders.
1932 ;;
1933 ;; It is possible to modify locally the back-end used by
1934 ;; `org-export-data' or even use a temporary back-end by using
1935 ;; `org-export-data-with-backend'.
1936 ;;
1937 ;; Internally, three functions handle the filtering of objects and
1938 ;; elements during the export. In particular,
1939 ;; `org-export-ignore-element' marks an element or object so future
1940 ;; parse tree traversals skip it and `org-export-expand' transforms
1941 ;; the others back into their original shape.
1942 ;;
1943 ;; `org-export-transcoder' is an accessor returning appropriate
1944 ;; translator function for a given element or object.
1947 "Return appropriate transcoder for BLOB.
1948 INFO is a plist containing export directives."
1950 ;; Return contents only for complete parse trees.
1956 "Convert DATA into current back-end format.
1958 DATA is a parse tree, an element or an object or a secondary
1959 string. INFO is a plist holding export options.
1961 Return a string."
1966 ;; Ignored element/object.
1968 ;; Plain text.
1974 info))
1975 ;; Secondary string.
1978 ;; Element/Object without contents or, as a special
1979 ;; case, headline with archive tag and archived trees
1980 ;; restricted to title only.
1988 ;; Export snippets never return a nil value so
1989 ;; that white spaces following them are never
1990 ;; ignored.
1992 ;; Element/Object with contents.
2005 ;; Elements directly containing
2006 ;; objects must have their indentation
2007 ;; normalized first.
2009 data
2010 ;; When normalizing contents of the
2011 ;; first paragraph in an item or
2012 ;; a footnote definition, ignore
2013 ;; first line's indentation: there is
2014 ;; none and it might be misleading.
2019 data)
2026 info))))))))
2027 ;; Final result will be memoized before being returned.
2029 data
2033 ;; Append the same white space between elements or objects
2034 ;; as in the original buffer, and call appropriate filters.
2045 info)))
2046 results)))
2050 "Convert DATA into BACKEND format.
2052 DATA is an element, an object, a secondary string or a string.
2053 BACKEND is a symbol. INFO is a plist used as a communication
2054 channel.
2056 Unlike to `org-export-with-backend', this function will
2057 recursively convert DATA using BACKEND translation table."
2060 data
2061 ;; Set-up a new communication channel with translations defined in
2062 ;; BACKEND as the translate table and a new hash table for
2063 ;; memoization.
2065 info
2068 ;; Size of the hash table is reduced since this function
2069 ;; will probably be used on small trees.
2073 "Change uninterpreted elements back into Org syntax.
2074 DATA is the parse tree. INFO is a plist containing export
2075 options. Each uninterpreted element or object is changed back
2076 into a string. Contents, if any, are not modified. The parse
2077 tree is modified by side effect and returned by the function."
2081 prop
2084 info))))
2087 "Change uninterpreted elements back into Org syntax.
2088 DATA is a parse tree or a secondary string. INFO is a plist
2089 containing export options. It is modified by side effect and
2090 returned by the function."
2093 subscript superscript underline)
2097 ;; ... entities...
2104 ?\s)))))
2105 ;; ... emphasis...
2117 marker
2121 ?\s)))))))
2122 ;; ... LaTeX environments and fragments...
2126 ;; ... sub/superscripts...
2135 "_"
2144 ?\s)))))))))))
2146 ;; Splice NEW at BLOB location in parse tree.
2149 info)
2150 ;; Return modified parse tree.
2151 data)
2154 "Expand a parsed element or object to its original state.
2156 BLOB is either an element or an object. CONTENTS is its
2157 contents, as a string or nil.
2159 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2160 keywords before output."
2165 blob contents))))
2168 "Add ELEMENT to `:ignore-list' in INFO.
2170 Any element in `:ignore-list' will be skipped when using
2171 `org-element-map'. INFO is modified by side effects."
2175 \f
2176 ;;; The Filter System
2177 ;;
2178 ;; Filters allow end-users to tweak easily the transcoded output.
2179 ;; They are the functional counterpart of hooks, as every filter in
2180 ;; a set is applied to the return value of the previous one.
2181 ;;
2182 ;; Every set is back-end agnostic. Although, a filter is always
2183 ;; called, in addition to the string it applies to, with the back-end
2184 ;; used as argument, so it's easy for the end-user to add back-end
2185 ;; specific filters in the set. The communication channel, as
2186 ;; a plist, is required as the third argument.
2187 ;;
2188 ;; From the developer side, filters sets can be installed in the
2189 ;; process with the help of `org-export-define-backend', which
2190 ;; internally stores filters as an alist. Each association has a key
2191 ;; among the following symbols and a function or a list of functions
2192 ;; as value.
2193 ;;
2194 ;; - `:filter-options' applies to the property list containing export
2195 ;; options. Unlike to other filters, functions in this list accept
2196 ;; two arguments instead of three: the property list containing
2197 ;; export options and the back-end. Users can set its value through
2198 ;; `org-export-filter-options-functions' variable.
2199 ;;
2200 ;; - `:filter-parse-tree' applies directly to the complete parsed
2201 ;; tree. Users can set it through
2202 ;; `org-export-filter-parse-tree-functions' variable.
2203 ;;
2204 ;; - `:filter-body' applies to the body of the output, before template
2205 ;; translator chimes in. Users can set it through
2206 ;; `org-export-filter-body-functions' variable.
2207 ;;
2208 ;; - `:filter-final-output' applies to the final transcoded string.
2209 ;; Users can set it with `org-export-filter-final-output-functions'
2210 ;; variable.
2211 ;;
2212 ;; - `:filter-plain-text' applies to any string not recognized as Org
2213 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2214 ;; configure it.
2215 ;;
2216 ;; - `:filter-TYPE' applies on the string returned after an element or
2217 ;; object of type TYPE has been transcoded. A user can modify
2218 ;; `org-export-filter-TYPE-functions' to install these filters.
2219 ;;
2220 ;; All filters sets are applied with
2221 ;; `org-export-filter-apply-functions' function. Filters in a set are
2222 ;; applied in a LIFO fashion. It allows developers to be sure that
2223 ;; their filters will be applied first.
2224 ;;
2225 ;; Filters properties are installed in communication channel with
2226 ;; `org-export-install-filters' function.
2227 ;;
2228 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2229 ;; `org-export-before-parsing-hook') are run at the beginning of the
2230 ;; export process and just before parsing to allow for heavy structure
2231 ;; modifications.
2234 ;;;; Hooks
2237 "Hook run at the beginning of the export process.
2239 This is run before include keywords and macros are expanded and
2240 Babel code blocks executed, on a copy of the original buffer
2241 being exported. Visibility and narrowing are preserved. Point
2242 is at the beginning of the buffer.
2244 Every function in this hook will be called with one argument: the
2248 "Hook run before parsing an export buffer.
2250 This is run after include keywords and macros have been expanded
2251 and Babel code blocks executed, on a copy of the original buffer
2252 being exported. Visibility and narrowing are preserved. Point
2253 is at the beginning of the buffer.
2255 Every function in this hook will be called with one argument: the
2259 ;;;; Special Filters
2262 "List of functions applied to the export options.
2263 Each filter is called with two arguments: the export options, as
2264 a plist, and the back-end, as a symbol. It must return
2268 "List of functions applied to the parsed tree.
2269 Each filter is called with three arguments: the parse tree, as
2270 returned by `org-element-parse-buffer', the back-end, as
2271 a symbol, and the communication channel, as a plist. It must
2275 "List of functions applied to plain text.
2276 Each filter is called with three arguments: a string which
2277 contains no Org syntax, the back-end, as a symbol, and the
2278 communication channel, as a plist. It must return a string or
2282 "List of functions applied to transcoded body.
2283 Each filter is called with three arguments: a string which
2284 contains no Org syntax, 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 the transcoded string.
2290 Each filter is called with three arguments: the full transcoded
2291 string, the back-end, as a symbol, and the communication channel,
2292 as a plist. It must return a string that will be used as the
2296 ;;;; Elements Filters
2299 "List of functions applied to a transcoded babel-call.
2300 Each filter is called with three arguments: the transcoded data,
2301 as a string, the back-end, as a symbol, and the communication
2305 "List of functions applied to a transcoded center block.
2306 Each filter is called with three arguments: the transcoded data,
2307 as a string, the back-end, as a symbol, and the communication
2311 "List of functions applied to a transcoded clock.
2312 Each filter is called with three arguments: the transcoded data,
2313 as a string, the back-end, as a symbol, and the communication
2317 "List of functions applied to a transcoded comment.
2318 Each filter is called with three arguments: the transcoded data,
2319 as a string, the back-end, as a symbol, and the communication
2323 "List of functions applied to a transcoded comment-block.
2324 Each filter is called with three arguments: the transcoded data,
2325 as a string, the back-end, as a symbol, and the communication
2329 "List of functions applied to a transcoded diary-sexp.
2330 Each filter is called with three arguments: the transcoded data,
2331 as a string, the back-end, as a symbol, and the communication
2335 "List of functions applied to a transcoded drawer.
2336 Each filter is called with three arguments: the transcoded data,
2337 as a string, the back-end, as a symbol, and the communication
2341 "List of functions applied to a transcoded dynamic-block.
2342 Each filter is called with three arguments: the transcoded data,
2343 as a string, the back-end, as a symbol, and the communication
2347 "List of functions applied to a transcoded example-block.
2348 Each filter is called with three arguments: the transcoded data,
2349 as a string, the back-end, as a symbol, and the communication
2353 "List of functions applied to a transcoded export-block.
2354 Each filter is called with three arguments: the transcoded data,
2355 as a string, the back-end, as a symbol, and the communication
2359 "List of functions applied to a transcoded fixed-width.
2360 Each filter is called with three arguments: the transcoded data,
2361 as a string, the back-end, as a symbol, and the communication
2365 "List of functions applied to a transcoded footnote-definition.
2366 Each filter is called with three arguments: the transcoded data,
2367 as a string, the back-end, as a symbol, and the communication
2371 "List of functions applied to a transcoded headline.
2372 Each filter is called with three arguments: the transcoded data,
2373 as a string, the back-end, as a symbol, and the communication
2377 "List of functions applied to a transcoded horizontal-rule.
2378 Each filter is called with three arguments: the transcoded data,
2379 as a string, the back-end, as a symbol, and the communication
2383 "List of functions applied to a transcoded inlinetask.
2384 Each filter is called with three arguments: the transcoded data,
2385 as a string, the back-end, as a symbol, and the communication
2389 "List of functions applied to a transcoded item.
2390 Each filter is called with three arguments: the transcoded data,
2391 as a string, the back-end, as a symbol, and the communication
2395 "List of functions applied to a transcoded keyword.
2396 Each filter is called with three arguments: the transcoded data,
2397 as a string, the back-end, as a symbol, and the communication
2401 "List of functions applied to a transcoded latex-environment.
2402 Each filter is called with three arguments: the transcoded data,
2403 as a string, the back-end, as a symbol, and the communication
2407 "List of functions applied to a transcoded node-property.
2408 Each filter is called with three arguments: the transcoded data,
2409 as a string, the back-end, as a symbol, and the communication
2413 "List of functions applied to a transcoded paragraph.
2414 Each filter is called with three arguments: the transcoded data,
2415 as a string, the back-end, as a symbol, and the communication
2419 "List of functions applied to a transcoded plain-list.
2420 Each filter is called with three arguments: the transcoded data,
2421 as a string, the back-end, as a symbol, and the communication
2425 "List of functions applied to a transcoded planning.
2426 Each filter is called with three arguments: the transcoded data,
2427 as a string, the back-end, as a symbol, and the communication
2431 "List of functions applied to a transcoded property-drawer.
2432 Each filter is called with three arguments: the transcoded data,
2433 as a string, the back-end, as a symbol, and the communication
2437 "List of functions applied to a transcoded quote block.
2438 Each filter is called with three arguments: the transcoded quote
2439 data, as a string, the back-end, as a symbol, and the
2440 communication channel, as a plist. It must return a string or
2444 "List of functions applied to a transcoded section.
2445 Each filter is called with three arguments: the transcoded data,
2446 as a string, the back-end, as a symbol, and the communication
2450 "List of functions applied to a transcoded special block.
2451 Each filter is called with three arguments: the transcoded data,
2452 as a string, the back-end, as a symbol, and the communication
2456 "List of functions applied to a transcoded src-block.
2457 Each filter is called with three arguments: the transcoded data,
2458 as a string, the back-end, as a symbol, and the communication
2462 "List of functions applied to a transcoded table.
2463 Each filter is called with three arguments: the transcoded data,
2464 as a string, the back-end, as a symbol, and the communication
2468 "List of functions applied to a transcoded table-cell.
2469 Each filter is called with three arguments: the transcoded data,
2470 as a string, the back-end, as a symbol, and the communication
2474 "List of functions applied to a transcoded table-row.
2475 Each filter is called with three arguments: the transcoded data,
2476 as a string, the back-end, as a symbol, and the communication
2480 "List of functions applied to a transcoded verse block.
2481 Each filter is called with three arguments: the transcoded data,
2482 as a string, the back-end, as a symbol, and the communication
2486 ;;;; Objects Filters
2489 "List of functions applied to transcoded bold text.
2490 Each filter is called with three arguments: the transcoded data,
2491 as a string, the back-end, as a symbol, and the communication
2495 "List of functions applied to transcoded code text.
2496 Each filter is called with three arguments: the transcoded data,
2497 as a string, the back-end, as a symbol, and the communication
2501 "List of functions applied to a transcoded entity.
2502 Each filter is called with three arguments: the transcoded data,
2503 as a string, the back-end, as a symbol, and the communication
2507 "List of functions applied to a transcoded export-snippet.
2508 Each filter is called with three arguments: the transcoded data,
2509 as a string, the back-end, as a symbol, and the communication
2513 "List of functions applied to a transcoded footnote-reference.
2514 Each filter is called with three arguments: the transcoded data,
2515 as a string, the back-end, as a symbol, and the communication
2519 "List of functions applied to a transcoded inline-babel-call.
2520 Each filter is called with three arguments: the transcoded data,
2521 as a string, the back-end, as a symbol, and the communication
2525 "List of functions applied to a transcoded inline-src-block.
2526 Each filter is called with three arguments: the transcoded data,
2527 as a string, the back-end, as a symbol, and the communication
2531 "List of functions applied to transcoded italic text.
2532 Each filter is called with three arguments: the transcoded data,
2533 as a string, the back-end, as a symbol, and the communication
2537 "List of functions applied to a transcoded latex-fragment.
2538 Each filter is called with three arguments: the transcoded data,
2539 as a string, the back-end, as a symbol, and the communication
2543 "List of functions applied to a transcoded line-break.
2544 Each filter is called with three arguments: the transcoded data,
2545 as a string, the back-end, as a symbol, and the communication
2549 "List of functions applied to a transcoded link.
2550 Each filter is called with three arguments: the transcoded data,
2551 as a string, the back-end, as a symbol, and the communication
2555 "List of functions applied to a transcoded radio-target.
2556 Each filter is called with three arguments: the transcoded data,
2557 as a string, the back-end, as a symbol, and the communication
2561 "List of functions applied to a transcoded statistics-cookie.
2562 Each filter is called with three arguments: the transcoded data,
2563 as a string, the back-end, as a symbol, and the communication
2567 "List of functions applied to transcoded strike-through text.
2568 Each filter is called with three arguments: the transcoded data,
2569 as a string, the back-end, as a symbol, and the communication
2573 "List of functions applied to a transcoded subscript.
2574 Each filter is called with three arguments: the transcoded data,
2575 as a string, the back-end, as a symbol, and the communication
2579 "List of functions applied to a transcoded superscript.
2580 Each filter is called with three arguments: the transcoded data,
2581 as a string, the back-end, as a symbol, and the communication
2585 "List of functions applied to a transcoded target.
2586 Each filter is called with three arguments: the transcoded data,
2587 as a string, the back-end, as a symbol, and the communication
2591 "List of functions applied to a transcoded timestamp.
2592 Each filter is called with three arguments: the transcoded data,
2593 as a string, the back-end, as a symbol, and the communication
2597 "List of functions applied to transcoded underline text.
2598 Each filter is called with three arguments: the transcoded data,
2599 as a string, the back-end, as a symbol, and the communication
2603 "List of functions applied to transcoded verbatim text.
2604 Each filter is called with three arguments: the transcoded data,
2605 as a string, the back-end, as a symbol, and the communication
2609 ;;;; Filters Tools
2610 ;;
2611 ;; Internal function `org-export-install-filters' installs filters
2612 ;; hard-coded in back-ends (developer filters) and filters from global
2613 ;; variables (user filters) in the communication channel.
2614 ;;
2615 ;; Internal function `org-export-filter-apply-functions' takes care
2616 ;; about applying each filter in order to a given data. It ignores
2617 ;; filters returning a nil value but stops whenever a filter returns
2618 ;; an empty string.
2621 "Call every function in FILTERS.
2623 Functions are called with arguments VALUE, current export
2624 back-end's name and INFO. A function returning a nil value will
2625 be skipped. If it returns the empty string, the process ends and
2626 VALUE is ignored.
2628 Call is done in a LIFO fashion, to be sure that developer
2629 specified filters, if any, are called first."
2640 "Install filters properties in communication channel.
2641 INFO is a plist containing the current communication channel.
2642 Return the updated communication channel."
2644 ;; Install user-defined filters with `org-export-filters-alist'
2645 ;; and filters already in INFO (through ext-plist mechanism).
2652 ;; Filters in INFO will be called
2653 ;; before those user provided.
2656 default-value)))))
2657 org-export-filters-alist)
2658 ;; Prepend back-end specific filters to that list.
2660 ;; Single values get consed, lists are appended.
2665 plist key
2669 ;; Return new communication channel.
2673 \f
2674 ;;; Core functions
2675 ;;
2676 ;; This is the room for the main function, `org-export-as', along with
2677 ;; its derivative, `org-export-string-as'.
2678 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2679 ;; function should be added to kill ring.
2680 ;;
2681 ;; Note that `org-export-as' doesn't really parse the current buffer,
2682 ;; but a copy of it (with the same buffer-local variables and
2683 ;; visibility), where macros and include keywords are expanded and
2684 ;; Babel blocks are executed, if appropriate.
2685 ;; `org-export-with-buffer-copy' macro prepares that copy.
2686 ;;
2687 ;; File inclusion is taken care of by
2688 ;; `org-export-expand-include-keyword' and
2689 ;; `org-export--prepare-file-contents'. Structure wise, including
2690 ;; a whole Org file in a buffer often makes little sense. For
2691 ;; example, if the file contains a headline and the include keyword
2692 ;; was within an item, the item should contain the headline. That's
2693 ;; why file inclusion should be done before any structure can be
2694 ;; associated to the file, that is before parsing.
2695 ;;
2696 ;; `org-export-insert-default-template' is a command to insert
2697 ;; a default template (or a back-end specific template) at point or in
2698 ;; current subtree.
2701 "Return a copy of the current buffer.
2702 The copy preserves Org buffer-local variables, visibility and
2703 narrowing."
2709 new-buf))
2712 "Apply BODY in a copy of the current buffer.
2713 The copy preserves local variables, visibility and contents of
2714 the original buffer. Point is at the beginning of the buffer
2715 when BODY is applied."
2724 ;; Kill copy without confirmation.
2730 "Generate a function duplicating BUFFER.
2732 The copy will preserve local variables, visibility, contents and
2733 narrowing of the original buffer. If a region was active in
2734 BUFFER, contents will be narrowed to that region instead.
2736 The resulting function can be evaluated at a later time, from
2737 another buffer, effectively cloning the original buffer there.
2739 The function assumes BUFFER's major mode is `org-mode'."
2743 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2744 ;; already in BUFFER.
2746 ;; Copy specific buffer local variables and variables set
2747 ;; through BIND keywords.
2749 vars)
2757 buffer-file-name
2758 buffer-file-coding-system))
2762 ;; Skip unreadable values, as they cannot be
2763 ;; sent to external process.
2767 vars))))))
2768 ;; Whole buffer contents.
2773 ;; Narrowing.
2777 ;; Current position of point.
2779 ;; Overlays with invisible property.
2789 ov-set))))
2791 ov-set)))))
2793 ;;;###autoload
2796 "Transcode current Org buffer into BACKEND code.
2798 BACKEND is either an export back-end, as returned by, e.g.,
2799 `org-export-create-backend', or a symbol referring to
2800 a registered back-end.
2802 If narrowing is active in the current buffer, only transcode its
2803 narrowed part.
2805 If a region is active, transcode that region.
2807 When optional argument SUBTREEP is non-nil, transcode the
2808 sub-tree at point, extracting information from the headline
2809 properties first.
2811 When optional argument VISIBLE-ONLY is non-nil, don't export
2812 contents of hidden elements.
2814 When optional argument BODY-ONLY is non-nil, only return body
2815 code, without surrounding template.
2817 Optional argument EXT-PLIST, when provided, is a property list
2818 with external parameters overriding Org default settings, but
2819 still inferior to file-local settings.
2821 Return code as a string."
2826 ;; Narrow buffer to an appropriate region or subtree for
2827 ;; parsing. If parsing subtree, be sure to remove main headline
2828 ;; too.
2836 ;; Initialize communication channel with original buffer
2837 ;; attributes, unavailable in its copy.
2846 tree)
2847 ;; Update communication channel and get parse tree. Buffer
2848 ;; isn't parsed directly. Instead, a temporary copy is
2849 ;; created, where include keywords, macros are expanded and
2850 ;; code blocks are evaluated.
2852 ;; Run first hook with current back-end's name as argument.
2856 ;; Update macro templates since #+INCLUDE keywords might have
2857 ;; added some new ones.
2861 ;; Update radio targets since keyword inclusion might have
2862 ;; added some more.
2864 ;; Run last hook with current back-end's name as argument.
2869 ;; Update communication channel with environment. Also
2870 ;; install user's and developer's filters.
2875 ;; Expand export-specific set of macros: {{{author}}},
2876 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2877 ;; once regular macros have been expanded, since document
2878 ;; keywords may contain one of them.
2884 ;; EMAIL is not a parsed keyword: store it as-is.
2889 ;; Parse buffer.
2891 ;; Handle left-over uninterpreted elements or objects in
2892 ;; parse tree and communication channel.
2894 ;; Call options filters and update export options. We do not
2895 ;; use `org-export-filter-apply-functions' here since the
2896 ;; arity of such filters is different.
2901 ;; Parse buffer, handle uninterpreted elements or objects,
2902 ;; then call parse-tree filters.
2906 ;; Now tree is complete, compute its properties and add them
2907 ;; to communication channel.
2911 ;; Eventually transcode TREE. Wrap the resulting string into
2912 ;; a template.
2921 info))
2924 ;; Remove all text properties since they cannot be
2925 ;; retrieved from an external process. Finally call
2926 ;; final-output filter and return result.
2932 info))))))))
2934 ;;;###autoload
2936 "Transcode STRING into BACKEND code.
2938 BACKEND is either an export back-end, as returned by, e.g.,
2939 `org-export-create-backend', or a symbol referring to
2940 a registered back-end.
2942 When optional argument BODY-ONLY is non-nil, only return body
2943 code, without preamble nor postamble.
2945 Optional argument EXT-PLIST, when provided, is a property list
2946 with external parameters overriding Org default settings, but
2947 still inferior to file-local settings.
2949 Return code as a string."
2955 ;;;###autoload
2957 "Replace the active region by its export to BACKEND.
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."
2970 ;;;###autoload
2972 "Insert all export keywords with default values at beginning of line.
2974 BACKEND is a symbol referring to the name of a registered export
2975 back-end, for which specific export options should be added to
2976 the template, or `default' for default template. When it is nil,
2977 the user will be prompted for a category.
2979 If SUBTREEP is non-nil, export configuration will be set up
2980 locally for the subtree through node properties."
2990 "Options category: "
2994 org-export--registered-backends))
2995 nil t))))
2996 options keywords)
2997 ;; Populate OPTIONS and KEYWORDS.
3014 ;; Move to an appropriate location in order to insert options.
3016 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3034 ;; Then the rest of keywords, in the order specified in either
3035 ;; `org-export-options-alist' or respective export back-ends.
3056 "Expand every include keyword in buffer.
3057 Optional argument INCLUDED is a list of included file names along
3058 with their line restriction, when appropriate. It is used to
3059 avoid infinite recursion. Optional argument DIR is the current
3060 working directory. It is used to properly resolve relative
3061 paths. Optional argument FOOTNOTES is a hash-table used for
3062 storing and resolving footnotes. It is created automatically."
3068 ;; If :minlevel is not set the text-property
3069 ;; `:org-include-induced-level' will be used to determine the
3070 ;; relative level when expanding INCLUDE.
3071 ;; Only affects included Org documents.
3075 :org-include-induced-level
3077 ;; Expand INCLUDE keywords.
3083 ;; Extract arguments from keyword's value.
3086 location
3098 matched)
3099 dir)))
3108 value)
3115 ;; Minimal level of included file defaults to the child
3116 ;; level of the current headline, if any, or one. It
3117 ;; only applies is the file is meant to be included as
3118 ;; an Org one.
3129 ;; Remove keyword.
3135 ;; Check if files has already been parsed. Look after
3136 ;; inclusion lines too, as different parts of the same file
3137 ;; can be included too.
3152 ind-str block arg-str contents ind-str block))))
3159 ind-str block contents ind-str block))))
3167 file location only-contents lines)
3168 lines)))
3171 file lines ind minlevel
3174 footnotes)))
3178 footnotes)
3180 ;; Expand footnotes after all files have been
3181 ;; included. Footnotes are stored at end of buffer.
3186 footnotes)))))))))))
3189 "Resolve absolute lines for an included file with file-link.
3191 FILE is string file-name of the file to include. LOCATION is a
3192 string name within FILE to be included (located via
3193 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3194 contents of the named element will be included, as determined
3195 Org-Element. If LINES is non-nil only those lines are included.
3197 Return a string of lines to be included in the format expected by
3198 `org-export--prepare-file-contents'."
3204 ;; Enforce consistent search.
3217 ;; Skip planning line and property-drawer.
3243 start-line
3245 (+ start-line
3248 counter))))))))
3251 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3253 REF-BEGIN corresponds to the property `:begin' of objects of type
3254 footnote-definition and footnote-reference.
3256 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3257 \[N] where N is one or more numbers.
3259 Return the new label."
3269 "Prepare contents of FILE for inclusion and return it as a string.
3271 When optional argument LINES is a string specifying a range of
3272 lines, include only those lines.
3274 Optional argument IND, when non-nil, is an integer specifying the
3275 global indentation of returned contents. Since its purpose is to
3276 allow an included file to stay in the same environment it was
3277 created \(i.e. a list item), it doesn't apply past the first
3278 headline encountered.
3280 Optional argument MINLEVEL, when non-nil, is an integer
3281 specifying the level that any top-level headline in the included
3282 file should have.
3283 Optional argument ID is an integer that will be inserted before
3284 each footnote definition and reference if FILE is an Org file.
3285 This is useful to avoid conflicts when more than one Org file
3286 with footnotes is included in a document.
3288 Optional argument FOOTNOTES is a hash-table to store footnotes in
3289 the included document.
3290 "
3306 ;; Remove blank lines at beginning and end of contents. The logic
3307 ;; behind that removal is that blank lines around include keyword
3308 ;; override blank lines in included file.
3317 ;; If IND is set, preserve indentation of include keyword until
3318 ;; the first headline encountered.
3325 ;; Do not move footnote definitions out of column 0.
3331 ;; When MINLEVEL is specified, compute minimal level for headlines
3332 ;; in the file (CUR-MIN), and remove stars to each headline so
3333 ;; that headlines with minimal level have a level of MINLEVEL.
3344 ;; Only change stars, don't bother moving whole
3345 ;; sections.
3349 ;; Append ID to all footnote references and definitions, so they
3350 ;; become file specific and cannot collide with footnotes in other
3351 ;; included files. Further, collect relevant footnotes outside of
3352 ;; LINES.
3362 ;; Update the footnote-reference at point and collect
3363 ;; the new label, which is only used for footnotes
3364 ;; outsides LINES.
3366 ;; If label is akin to [1] convert it to [fn:ID-1].
3367 ;; Otherwise add "ID-" after "fn:".
3377 ;; Store since footnote-definition is outside of LINES.
3380 footnotes)
3381 ;; Update label of definition since it is included directly.
3388 "Execute every Babel code in the visible part of current buffer."
3389 ;; Get a pristine copy of current buffer so Babel references can be
3390 ;; properly resolved.
3396 "Return a non-nil value when output should be added to the kill ring.
3397 See also `org-export-copy-to-kill-ring'."
3403 \f
3404 ;;; Tools For Back-Ends
3405 ;;
3406 ;; A whole set of tools is available to help build new exporters. Any
3407 ;; function general enough to have its use across many back-ends
3408 ;; should be added here.
3410 ;;;; For Affiliated Keywords
3411 ;;
3412 ;; `org-export-read-attribute' reads a property from a given element
3413 ;; as a plist. It can be used to normalize affiliated keywords'
3414 ;; syntax.
3415 ;;
3416 ;; Since captions can span over multiple lines and accept dual values,
3417 ;; their internal representation is a bit tricky. Therefore,
3418 ;; `org-export-get-caption' transparently returns a given element's
3419 ;; caption as a secondary string.
3422 "Turn ATTRIBUTE property from ELEMENT into a plist.
3424 When optional argument PROPERTY is non-nil, return the value of
3425 that property within attributes.
3429 properties.
3431 All values will become strings except the empty string and
3434 will become the empty string."
3448 s)
3453 ;; Ignore any string before first property with `cdr'.
3458 "Return caption from ELEMENT as a secondary string.
3460 When optional argument SHORTP is non-nil, return short caption,
3461 as a secondary string, instead.
3463 Caption lines are separated by a white space."
3471 ;;;; For Derived Back-ends
3472 ;;
3473 ;; `org-export-with-backend' is a function allowing to locally use
3474 ;; another back-end to transcode some object or element. In a derived
3475 ;; back-end, it may be used as a fall-back function once all specific
3476 ;; cases have been treated.
3479 "Call a transcoder from BACKEND on DATA.
3480 BACKEND is an export back-end, as returned by, e.g.,
3481 `org-export-create-backend', or a symbol referring to
3482 a registered back-end. DATA is an Org element, object, secondary
3483 string or string. CONTENTS, when non-nil, is the transcoded
3484 contents of DATA element, as a string. INFO, when non-nil, is
3485 the communication channel used for export, as a plist."
3495 transcoder data contents
3498 :translate-alist all-transcoders
3502 ;;;; For Export Snippets
3503 ;;
3504 ;; Every export snippet is transmitted to the back-end. Though, the
3505 ;; latter will only retain one type of export-snippet, ignoring
3506 ;; others, based on the former's target back-end. The function
3507 ;; `org-export-snippet-backend' returns that back-end for a given
3508 ;; export-snippet.
3511 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3512 Translation, with `org-export-snippet-translation-alist', is
3513 applied."
3517 back-end))))
3520 ;;;; For Footnotes
3521 ;;
3522 ;; `org-export-collect-footnote-definitions' is a tool to list
3523 ;; actually used footnotes definitions in the whole parse tree, or in
3524 ;; a headline, in order to add footnote listings throughout the
3525 ;; transcoded data.
3526 ;;
3527 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3528 ;; back-ends, when they need to attach the footnote definition only to
3529 ;; the first occurrence of the corresponding label.
3530 ;;
3531 ;; `org-export-get-footnote-definition' and
3532 ;; `org-export-get-footnote-number' provide easier access to
3533 ;; additional information relative to a footnote reference.
3536 "Return an alist between footnote numbers, labels and definitions.
3538 DATA is the parse tree from which definitions are collected.
3539 INFO is the plist used as a communication channel.
3541 Definitions are sorted by order of references. They either
3542 appear as Org data or as a secondary string for inlined
3543 footnotes. Unreferenced definitions are ignored."
3545 collect-fn ; for byte-compiler.
3549 ;; Collect footnote number, label and definition in DATA.
3557 def)
3558 num-alist)
3559 ;; Also search in definition for nested footnotes.
3562 ;; Don't enter footnote definitions since it will happen
3563 ;; when their first reference is found.
3569 "Non-nil when a footnote reference is the first one for its label.
3571 FOOTNOTE-REFERENCE is the footnote reference being considered.
3572 INFO is the plist used as a communication channel."
3574 ;; Anonymous footnotes are always a first reference.
3576 ;; Otherwise, return the first footnote with the same LABEL and
3577 ;; test if it is equal to FOOTNOTE-REFERENCE.
3587 ;; If FN isn't inlined, be sure to traverse its
3588 ;; definition before resuming search. See
3589 ;; comments in `org-export-get-footnote-number'
3590 ;; for more information.
3594 ;; Don't enter footnote definitions since it will
3595 ;; happen when their first reference is found.
3598 footnote-reference)))))
3601 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3602 INFO is the plist used as a communication channel. If no such
3603 definition can be found, raise an error."
3611 "Return number associated to a footnote.
3613 FOOTNOTE is either a footnote reference or a footnote definition.
3614 INFO is the plist used as a communication channel."
3616 seen-refs
3617 search-ref ; For byte-compiler.
3621 ;; Search footnote references through DATA, filling
3622 ;; SEEN-REFS along the way.
3627 ;; Anonymous footnote match: return number.
3630 ;; Labels match: return number.
3633 ;; Anonymous footnote: it's always a new one.
3634 ;; Also, be sure to return nil from the `cond' so
3635 ;; `first-match' doesn't get us out of the loop.
3637 ;; Label not seen so far: add it so SEEN-REFS.
3638 ;;
3639 ;; Also search for subsequent references in
3640 ;; footnote definition so numbering follows
3641 ;; reading logic. Note that we don't have to care
3642 ;; about inline definitions, since
3643 ;; `org-element-map' already traverses them at the
3644 ;; right time.
3645 ;;
3646 ;; Once again, return nil to stay in the loop.
3651 nil))))
3652 ;; Don't enter footnote definitions since it will
3653 ;; happen when their first reference is found.
3658 ;;;; For Headlines
3659 ;;
3660 ;; `org-export-get-relative-level' is a shortcut to get headline
3661 ;; level, relatively to the lower headline level in the parsed tree.
3662 ;;
3663 ;; `org-export-get-headline-number' returns the section number of an
3664 ;; headline, while `org-export-number-to-roman' allows to convert it
3665 ;; to roman numbers. With an optional argument,
3666 ;; `org-export-get-headline-number' returns a number to unnumbered
3667 ;; headlines (used for internal id).
3668 ;;
3669 ;; `org-export-get-headline-id' returns the unique internal id of a
3670 ;; headline.
3671 ;;
3672 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3673 ;; `org-export-last-sibling-p' are three useful predicates when it
3674 ;; comes to fulfill the `:headline-levels' property.
3675 ;;
3676 ;; `org-export-get-tags', `org-export-get-category' and
3677 ;; `org-export-get-node-property' extract useful information from an
3678 ;; headline or a parent headline. They all handle inheritance.
3679 ;;
3680 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3681 ;; as a secondary string, suitable for table of contents. It falls
3682 ;; back onto default title.
3685 "Return HEADLINE relative level within current parsed tree.
3686 INFO is a plist holding contextual information."
3691 "Non-nil when HEADLINE is considered as low level.
3693 INFO is a plist used as a communication channel.
3695 A low level headlines has a relative level greater than
3696 `:headline-levels' property value.
3698 Return value is the difference between HEADLINE relative level
3699 and the last level being considered as high enough, or nil."
3706 "Return a unique ID for HEADLINE.
3707 INFO is a plist holding contextual information."
3717 "Return numbered HEADLINE numbering as a list of numbers.
3718 INFO is a plist holding contextual information."
3723 "Return a non-nil value if HEADLINE element should be numbered.
3724 INFO is a plist used as a communication channel."
3733 "Convert integer N into a roman numeral."
3746 res)))
3749 "Return list of tags associated to ELEMENT.
3751 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3752 is a plist used as a communication channel.
3754 Select tags (see `org-export-select-tags') and exclude tags (see
3755 `org-export-exclude-tags') are removed from the list.
3757 When non-nil, optional argument TAGS should be a list of strings.
3758 Any tag belonging to this list will also be removed.
3760 When optional argument INHERITED is non-nil, tags can also be
3761 inherited from parent headlines and FILETAGS keywords."
3767 ;; Build complete list of inherited tags.
3774 ;; Add FILETAGS keywords and return results.
3778 "Return node PROPERTY value for BLOB.
3780 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3781 element or object.
3783 If optional argument INHERITED is non-nil, the value can be
3784 inherited from a parent headline.
3786 Return value is a string or nil."
3798 "Return category for element or object BLOB.
3800 INFO is a plist used as a communication channel.
3802 CATEGORY is automatically inherited from a parent headline, from
3803 #+CATEGORY: keyword or created out of original file name. If all
3816 "Return alternative title for HEADLINE, as a secondary string.
3817 INFO is a plist used as a communication channel. If no optional
3818 title is defined, fall-back to the regular title."
3823 "Non-nil when BLOB is the first sibling in its parent.
3824 BLOB is an element or an object. If BLOB is a headline, non-nil
3825 means it is the first sibling in the sub-tree. INFO is a plist
3826 used as a communication channel."
3831 "Non-nil when BLOB is the last sibling in its parent.
3832 BLOB is an element or an object. INFO is a plist used as
3833 a communication channel."
3837 ;;;; For Keywords
3838 ;;
3839 ;; `org-export-get-date' returns a date appropriate for the document
3840 ;; to about to be exported. In particular, it takes care of
3841 ;; `org-export-date-timestamp-format'.
3844 "Return date value for the current document.
3846 INFO is a plist used as a communication channel. FMT, when
3847 non-nil, is a time format string that will be applied on the date
3848 if it consists in a single timestamp object. It defaults to
3849 `org-export-date-timestamp-format' when nil.
3851 A proper date can be a secondary string, a string or nil. It is
3852 meant to be translated with `org-export-data' or alike."
3863 ;;;; For Links
3864 ;;
3865 ;; `org-export-solidify-link-text' turns a string into a safer version
3866 ;; for links, replacing most non-standard characters with hyphens.
3867 ;;
3868 ;; `org-export-get-coderef-format' returns an appropriate format
3869 ;; string for coderefs.
3870 ;;
3871 ;; `org-export-inline-image-p' returns a non-nil value when the link
3872 ;; provided should be considered as an inline image.
3873 ;;
3874 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3875 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3876 ;; returns an appropriate unique identifier when found, or nil.
3877 ;;
3878 ;; `org-export-resolve-id-link' returns the first headline with
3879 ;; specified id or custom-id in parse tree, the path to the external
3880 ;; file with the id or nil when neither was found.
3881 ;;
3882 ;; `org-export-resolve-coderef' associates a reference to a line
3883 ;; number in the element it belongs, or returns the reference itself
3884 ;; when the element isn't numbered.
3887 "Take link text S and make a safe target out of it."
3892 "Return format string for code reference link.
3893 PATH is the link path. DESC is its description."
3901 "Non-nil if LINK object points to an inline image.
3903 Optional argument is a set of RULES defining inline images. It
3904 is an alist where associations have the following shape:
3906 \(TYPE . REGEXP)
3908 Applying a rule means apply REGEXP against LINK's path when its
3909 type is TYPE. The function will return a non-nil value if any of
3910 the provided rules is non-nil. The default rule is
3911 `org-export-default-inline-image-rule'.
3913 This only applies to links without a description."
3924 rules)
3925 ;; Return nil if no rule matched.
3926 nil))))
3929 "Resolve a code reference REF.
3931 INFO is a plist used as a communication channel.
3933 Return associated line number in source code, or REF itself,
3934 depending on src-block or example element's switches."
3941 org-coderef-label-format)))
3945 ;; Element containing REF is found. Resolve it to either
3946 ;; a label or a line number, as needed.
3956 "Return LINK destination.
3958 INFO is a plist holding contextual information.
3960 Return value can be an object, an element, or nil:
3962 - If LINK path matches a target object (i.e. <<path>>) return it.
3964 - If LINK path exactly matches the name affiliated keyword
3965 \(i.e. #+NAME: path) of an element, return that element.
3967 - If LINK path exactly matches any headline name, return that
3968 element. If more than one headline share that name, priority
3969 will be given to the one with the closest common ancestor, if
3970 any, or the first one in the parse tree otherwise.
3972 - Otherwise, return nil.
3975 significant."
3978 ;; Split PATH at white spaces so matches are space
3979 ;; insensitive.
3982 ;; Cache for destinations that are not position dependent.
3990 ;; Destination is not position dependent: use cached value.
3992 ;; First try to find a matching "<<path>>" unless user specified
3993 ;; he was looking for a headline (path starts with a "*"
3994 ;; character).
4000 path)
4001 blob))
4004 ;; Then try to find an element with a matching "#+NAME: path"
4005 ;; affiliated keyword.
4008 org-element-all-elements
4013 el)))
4016 ;; Last case: link either points to a headline or to nothingness.
4017 ;; Try to find the source, with priority given to headlines with
4018 ;; the closest common ancestor. If such candidate is found,
4019 ;; return it, otherwise return nil.
4023 ;; Return first headline whose `:raw-value' property is
4024 ;; NAME in parse tree DATA, or nil. Statistics cookies
4025 ;; are ignored.
4033 name)
4034 headline))
4036 ;; Search among headlines sharing an ancestor with link, from
4037 ;; closest to farthest.
4045 ;; No destination found: return nil.
4049 "Return headline referenced as LINK destination.
4051 INFO is a plist used as a communication channel.
4053 Return value can be the headline element matched in current parse
4057 ;; First check if id is within the current parse tree.
4062 headline))
4064 ;; Otherwise, look for external files.
4068 "Return radio-target object referenced as LINK destination.
4070 INFO is a plist used as a communication channel.
4072 Return value can be a radio-target object or nil. Assume LINK
4081 nil nil path nil nil t)
4082 t)
4083 radio))
4087 ;;;; For References
4088 ;;
4089 ;; `org-export-get-ordinal' associates a sequence number to any object
4090 ;; or element.
4093 "Return ordinal number of an element or object.
4095 ELEMENT is the element or object considered. INFO is the plist
4096 used as a communication channel.
4098 Optional argument TYPES, when non-nil, is a list of element or
4099 object types, as symbols, that should also be counted in.
4100 Otherwise, only provided element's type is considered.
4102 Optional argument PREDICATE is a function returning a non-nil
4103 value if the current element or object should be counted in. It
4104 accepts two arguments: the element or object being considered and
4105 the plist used as a communication channel. This allows to count
4106 only a certain type of objects (i.e. inline images).
4108 Return value is a list of numbers if ELEMENT is a headline or an
4109 item. It is nil for keywords. It represents the footnote number
4110 for footnote definitions and footnote references. If ELEMENT is
4111 a target, return the same value as if ELEMENT was the closest
4112 table, item or headline containing the target. In any other
4113 case, return the sequence number of ELEMENT among elements or
4114 objects of the same type."
4115 ;; Ordinal of a target object refer to the ordinal of the closest
4116 ;; table, item, or headline containing the object.
4120 element
4123 ;; Special case 1: A headline returns its number as a list.
4125 ;; Special case 2: An item returns its number as a list.
4129 struct
4136 ;; Increment counter until ELEMENT is found again.
4147 ;;;; For Src-Blocks
4148 ;;
4149 ;; `org-export-get-loc' counts number of code lines accumulated in
4150 ;; src-block or example-block elements with a "+n" switch until
4151 ;; a given element, excluded. Note: "-n" switches reset that count.
4152 ;;
4153 ;; `org-export-unravel-code' extracts source code (along with a code
4154 ;; references alist) from an `element-block' or `src-block' type
4155 ;; element.
4156 ;;
4157 ;; `org-export-format-code' applies a formatting function to each line
4158 ;; of code, providing relative line number and code reference when
4159 ;; appropriate. Since it doesn't access the original element from
4160 ;; which the source code is coming, it expects from the code calling
4161 ;; it to know if lines should be numbered and if code references
4162 ;; should appear.
4163 ;;
4164 ;; Eventually, `org-export-format-code-default' is a higher-level
4165 ;; function (it makes use of the two previous functions) which handles
4166 ;; line numbering and code references inclusion, and returns source
4167 ;; code in a format suitable for plain text or verbatim output.
4170 "Return accumulated lines of code up to ELEMENT.
4172 INFO is the plist used as a communication channel.
4174 ELEMENT is excluded from count."
4180 ;; ELEMENT is reached: Quit the loop.
4182 ;; Only count lines from src-block and example-block elements
4183 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4187 ;; Accumulate locs or reset them.
4191 ;; Return nil to stay in the loop.
4192 nil)))
4194 ;; Return value.
4195 loc))
4198 "Clean source code and extract references out of it.
4200 ELEMENT has either a `src-block' an `example-block' type.
4202 Return a cons cell whose CAR is the source code, cleaned from any
4203 reference, protective commas and spurious indentation, and CDR is
4204 an alist between relative line number (integer) and name of code
4205 reference on that line (string)."
4208 ;; Get code and clean it. Remove blank lines at its
4209 ;; beginning and end.
4216 value
4218 ;; Get format used for references.
4221 org-coderef-label-format)))
4222 ;; Build a regexp matching a loc with a reference.
4227 ;; Return value.
4229 ;; Code with references removed.
4235 ;; Ref line: remove ref, and signal its position in REFS.
4239 ;; Reference alist.
4240 refs)))
4243 "Format CODE by applying FUN line-wise and return it.
4245 CODE is a string representing the code to format. FUN is
4246 a function. It must accept three arguments: a line of
4247 code (string), the current line number (integer) or nil and the
4248 reference associated to the current line (string) or nil.
4250 Optional argument NUM-LINES can be an integer representing the
4251 number of code lines accumulated until the current code. Line
4252 numbers passed to FUN will take it into account. If it is nil,
4253 FUN's second argument will always be nil. This number can be
4254 obtained with `org-export-get-loc' function.
4256 Optional argument REF-ALIST can be an alist between relative line
4257 number (i.e. ignoring NUM-LINES) and the name of the code
4258 reference on it. If it is nil, FUN's third argument will always
4259 be nil. It can be obtained through the use of
4260 `org-export-unravel-code' function."
4272 "Return source code from ELEMENT, formatted in a standard way.
4274 ELEMENT is either a `src-block' or `example-block' element. INFO
4275 is a plist used as a communication channel.
4277 This function takes care of line numbering and code references
4278 inclusion. Line numbers, when applicable, appear at the
4279 beginning of the line, separated from the code by two white
4280 spaces. Code references, on the other hand, appear flushed to
4281 the right, separated by six white spaces from the widest line of
4282 code."
4283 ;; Extract code and references.
4290 ;; Handle line numbering.
4299 ;; Prepare references display, if required. Any reference
4300 ;; should start six columns after the widest line of code,
4301 ;; wrapped with parenthesis.
4306 code
4310 number-str
4311 loc
4317 num-start refs)))))
4320 ;;;; For Tables
4321 ;;
4322 ;; `org-export-table-has-special-column-p' and and
4323 ;; `org-export-table-row-is-special-p' are predicates used to look for
4324 ;; meta-information about the table structure.
4325 ;;
4326 ;; `org-table-has-header-p' tells when the rows before the first rule
4327 ;; should be considered as table's header.
4328 ;;
4329 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4330 ;; and `org-export-table-cell-borders' extract information from
4331 ;; a table-cell element.
4332 ;;
4333 ;; `org-export-table-dimensions' gives the number on rows and columns
4334 ;; in the table, ignoring horizontal rules and special columns.
4335 ;; `org-export-table-cell-address', given a table-cell object, returns
4336 ;; the absolute address of a cell. On the other hand,
4337 ;; `org-export-get-table-cell-at' does the contrary.
4338 ;;
4339 ;; `org-export-table-cell-starts-colgroup-p',
4340 ;; `org-export-table-cell-ends-colgroup-p',
4341 ;; `org-export-table-row-starts-rowgroup-p',
4342 ;; `org-export-table-row-ends-rowgroup-p',
4343 ;; `org-export-table-row-starts-header-p',
4344 ;; `org-export-table-row-ends-header-p' and
4345 ;; `org-export-table-row-in-header-p' indicate position of current row
4346 ;; or cell within the table.
4349 "Non-nil when TABLE has a special column.
4350 All special columns will be ignored during export."
4351 ;; The table has a special column when every first cell of every row
4352 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4353 ;; "*" "_" and "^". Though, do not consider a first row containing
4354 ;; only empty cells as special.
4370 "Non-nil when TABLE has a header.
4372 INFO is a plist used as a communication channel.
4374 A table has a header when it contains at least two row groups."
4383 table
4394 cache)))))
4397 "Non-nil if TABLE-ROW is considered special.
4399 INFO is a plist used as the communication channel.
4401 All special rows will be ignored during export."
4405 ;; A row is special either when...
4407 ;; ... it starts with a field only containing "/",
4409 ;; ... the table contains a special column and the row start
4410 ;; with a marking character among, "^", "_", "$" or "!",
4414 ;; ... it contains only alignment cookies and empty cells.
4420 ;; Since VALUE is a secondary string, the following
4421 ;; checks avoid expanding it with `org-export-data'.
4433 "Return TABLE-ROW's group number, as an integer.
4435 INFO is a plist used as the communication channel.
4437 Return value is the group number, as an integer, or nil for
4438 special rows and rows separators. First group is also table's
4439 header."
4457 "Return TABLE-CELL contents width.
4459 INFO is a plist used as the communication channel.
4461 Return value is the width given by the last width cookie in the
4462 same column as TABLE-CELL, or nil."
4481 ;; In a special row, try to find a width cookie at COLUMN.
4485 ;; The following checks avoid expanding unnecessarily
4486 ;; the cell with `org-export-data'.
4496 "Return TABLE-CELL contents alignment.
4498 INFO is a plist used as the communication channel.
4500 Return alignment as specified by the last alignment cookie in the
4501 same column as TABLE-CELL. If no such cookie is found, a default
4502 alignment value will be deduced from fraction of numbers in the
4503 column (see `org-table-number-fraction' for more information).
4504 Possible values are `left', `right' and `center'."
4505 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4522 cookie-align
4523 previous-cell-number-p)
4526 ;; In a special row, try to find an alignment cookie at
4527 ;; COLUMN.
4531 ;; Since VALUE is a secondary string, the following
4532 ;; checks avoid useless expansion through
4533 ;; `org-export-data'.
4541 ;; Ignore table rules.
4543 ;; In a standard row, check if cell's contents are
4544 ;; expressing some kind of number. Increase NUMBER-CELLS
4545 ;; accordingly. Though, don't bother if an alignment
4546 ;; cookie has already defined cell's alignment.
4551 info)))
4553 ;; Treat an empty cell as a number if it follows
4554 ;; a number.
4560 ;; Return value. Alignment specified by cookies has
4561 ;; precedence over alignment deduced from cell's contents.
4563 column
4568 org-table-number-fraction)
4573 "Return TABLE-CELL borders.
4575 INFO is a plist used as a communication channel.
4577 Return value is a list of symbols, or nil. Possible values are:
4578 `top', `bottom', `above', `below', `left' and `right'. Note:
4579 `top' (resp. `bottom') only happen for a cell in the first
4580 row (resp. last row) of the table, ignoring table rules, if any.
4582 Returned borders ignore special rows."
4585 borders)
4586 ;; Top/above border? TABLE-CELL has a border above when a rule
4587 ;; used to demarcate row groups can be found above. Hence,
4588 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4589 ;; another regular row has to be found above that rule.
4598 ;; Look at every row before the current one.
4600 ;; No rule above, or rule found starts the table (ignoring any
4601 ;; special row): TABLE-CELL is at the top of the table.
4604 ;; Bottom/below border? TABLE-CELL has a border below when next
4605 ;; non-regular row below is a rule.
4614 ;; Look at every row after the current one.
4616 ;; No rule below, or rule found ends the table (modulo some
4617 ;; special row): TABLE-CELL is at the bottom of the table.
4620 ;; Right/left borders? They can only be specified by column
4621 ;; groups. Column groups are defined in a row starting with "/".
4622 ;; Also a column groups row only contains "<", "<>", ">" or blank
4623 ;; cells.
4640 ;; There's a left border when previous cell, if
4641 ;; any, ends a group, or current one starts one.
4647 ;; There's a right border when next cell, if any,
4648 ;; starts a group, or current one ends one.
4655 ;; Table rows are read in reverse order so last column groups
4656 ;; row has precedence over any previous one.
4658 ;; Return value.
4659 borders))
4662 "Non-nil when TABLE-CELL is at the beginning of a column group.
4663 INFO is a plist used as a communication channel."
4664 ;; A cell starts a column group either when it is at the beginning
4665 ;; of a row (or after the special column, if any) or when it has
4666 ;; a left border.
4669 table-cell)
4673 "Non-nil when TABLE-CELL is at the end of a column group.
4674 INFO is a plist used as a communication channel."
4675 ;; A cell ends a column group either when it is at the end of a row
4676 ;; or when it has a right border.
4679 table-cell)
4683 "Non-nil when TABLE-ROW is at the beginning of a row group.
4684 INFO is a plist used as a communication channel."
4692 "Non-nil when TABLE-ROW is at the end of a row group.
4693 INFO is a plist used as a communication channel."
4701 "Non-nil when TABLE-ROW is located within table's header.
4702 INFO is a plist used as a communication channel. Always return
4703 nil for special rows and rows separators."
4709 "Non-nil when TABLE-ROW is the first table header's row.
4710 INFO is a plist used as a communication channel."
4715 "Non-nil when TABLE-ROW is the last table header's row.
4716 INFO is a plist used as a communication channel."
4721 "Return TABLE-ROW number.
4722 INFO is a plist used as a communication channel. Return value is
4723 zero-based and ignores separators. The function returns nil for
4724 special columns and separators."
4736 "Return TABLE dimensions.
4738 INFO is a plist used as a communication channel.
4740 Return value is a CONS like (ROWS . COLUMNS) where
4741 ROWS (resp. COLUMNS) is the number of exportable
4742 rows (resp. columns)."
4744 ;; Set number of rows, and extract first one.
4750 ;; Set number of columns.
4752 ;; Return value.
4756 "Return address of a regular TABLE-CELL object.
4758 TABLE-CELL is the cell considered. INFO is a plist used as
4759 a communication channel.
4761 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4762 zero-based index. Only exportable cells are considered. The
4763 function returns nil for other cells."
4775 "Return regular table-cell object at ADDRESS in TABLE.
4777 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4778 zero-based index. TABLE is a table type element. INFO is
4779 a plist used as a communication channel.
4781 If no table-cell, among exportable cells, is found at ADDRESS,
4782 return nil."
4785 ;; Row at (car address) or nil.
4793 'table-cell
4800 ;;;; For Tables Of Contents
4801 ;;
4802 ;; `org-export-collect-headlines' builds a list of all exportable
4803 ;; headline elements, maybe limited to a certain depth. One can then
4804 ;; easily parse it and transcode it.
4805 ;;
4806 ;; Building lists of tables, figures or listings is quite similar.
4807 ;; Once the generic function `org-export-collect-elements' is defined,
4808 ;; `org-export-collect-tables', `org-export-collect-figures' and
4809 ;; `org-export-collect-listings' can be derived from it.
4812 "Collect headlines in order to build a table of contents.
4814 INFO is a plist used as a communication channel.
4816 When optional argument N is an integer, it specifies the depth of
4817 the table of contents. Otherwise, it is set to the value of the
4818 last headline level. See `org-export-headline-levels' for more
4819 information.
4821 Return a list of all exportable headlines as parsed elements.
4822 Footnote sections, if any, will be ignored."
4830 info)))
4833 "Collect referenceable elements of a determined type.
4835 TYPE can be a symbol or a list of symbols specifying element
4836 types to search. Only elements with a caption are collected.
4838 INFO is a plist used as a communication channel.
4840 When non-nil, optional argument PREDICATE is a function accepting
4841 one argument, an element of type TYPE. It returns a non-nil
4842 value when that element should be collected.
4844 Return a list of all elements found, in order of appearance."
4849 element))
4850 info))
4853 "Build a list of tables.
4854 INFO is a plist used as a communication channel.
4856 Return a list of table elements with a caption."
4860 "Build a list of figures.
4862 INFO is a plist used as a communication channel. PREDICATE is
4863 a function which accepts one argument: a paragraph element and
4864 whose return value is non-nil when that element should be
4865 collected.
4867 A figure is a paragraph type element, with a caption, verifying
4869 a vague concept that may depend on back-end.
4871 Return a list of elements recognized as figures."
4875 "Build a list of src blocks.
4877 INFO is a plist used as a communication channel.
4879 Return a list of src-block elements with a caption."
4883 ;;;; Smart Quotes
4884 ;;
4885 ;; The main function for the smart quotes sub-system is
4886 ;; `org-export-activate-smart-quotes', which replaces every quote in
4887 ;; a given string from the parse tree with its "smart" counterpart.
4888 ;;
4889 ;; Dictionary for smart quotes is stored in
4890 ;; `org-export-smart-quotes-alist'.
4891 ;;
4892 ;; Internally, regexps matching potential smart quotes (checks at
4893 ;; string boundaries are also necessary) are defined in
4894 ;; `org-export-smart-quotes-regexps'.
4898 ;; one may use: »...«, "...", ›...‹, or '...'.
4899 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4900 ;; LaTeX quotes require Babel!
4945 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4954 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4963 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4972 ;; 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
4973 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
4984 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4990 )
4991 "Smart quotes translations.
4993 Alist whose CAR is a language string and CDR is an alist with
4994 quote type as key and a plist associating various encodings to
4995 their translation as value.
4997 A quote type can be any symbol among `opening-double-quote',
4998 `closing-double-quote', `opening-single-quote',
4999 `closing-single-quote' and `apostrophe'.
5001 Valid encodings include `:utf-8', `:html', `:latex' and
5002 `:texinfo'.
5008 ;; Possible opening quote at beginning of string.
5010 ;; Possible closing quote at beginning of string.
5012 ;; Possible apostrophe at beginning of string.
5014 ;; Opening single and double quotes.
5016 ;; Closing single and double quotes.
5018 ;; Apostrophe.
5020 ;; Possible opening quote at end of string.
5022 ;; Possible closing quote at end of string.
5024 ;; Possible apostrophe at end of string.
5026 "List of regexps matching a quote or an apostrophe.
5032 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5033 `:utf-8'. INFO is a plist used as a communication channel.
5035 The function has to retrieve information about string
5036 surroundings in parse tree. It can only happen with an
5037 unmodified string. Thus, if S has already been through another
5038 process, a non-nil ORIGINAL optional argument will provide that
5039 original string.
5041 Return the new string."
5044 ;; Try to be flexible when computing number of blanks
5045 ;; before object. The previous object may be a string
5046 ;; introduced by the back-end and not completely parsed.
5049 ;; A string with missing `:post-blank'
5050 ;; property.
5054 ;; Fallback value.
5059 ;; Return smart quote associated to a give quote Q, as
5060 ;; a string. TYPE is a symbol among `open', `close' and
5061 ;; `apostrophe'.
5071 org-export-smart-quotes-alist))))
5072 encoding)
5073 q)))))
5075 ;; Only a quote: no regexp can match. We have to check both
5076 ;; sides and decide what to do.
5084 ;; 1. Replace quote character at the beginning of S.
5086 ;; Apostrophe?
5092 ;; Closing quote?
5098 ;; Opening quote?
5104 ;; 2. Replace quotes in the middle of the string.
5106 ;; Opening quotes.
5112 ;; Closing quotes.
5118 ;; Apostrophes.
5123 ;; 3. Replace quote character at the end of S.
5125 ;; Apostrophe?
5130 ;; Closing quote?
5136 ;; Opening quote?
5141 ;; Return string with smart quotes.
5142 s))))
5144 ;;;; Topology
5145 ;;
5146 ;; Here are various functions to retrieve information about the
5147 ;; neighborhood of a given element or object. Neighbors of interest
5148 ;; are direct parent (`org-export-get-parent'), parent headline
5149 ;; (`org-export-get-parent-headline'), first element containing an
5150 ;; object, (`org-export-get-parent-element'), parent table
5151 ;; (`org-export-get-parent-table'), previous element or object
5152 ;; (`org-export-get-previous-element') and next element or object
5153 ;; (`org-export-get-next-element').
5155 ;; defsubst org-export-get-parent must be defined before first use
5161 "Return BLOB parent headline or nil.
5162 BLOB is the element or object being considered."
5166 "Return first element containing OBJECT or nil.
5167 OBJECT is the object to consider."
5171 "Return OBJECT parent table or nil.
5172 OBJECT is either a `table-cell' or `table-element' type object."
5176 "Return previous element or object.
5178 BLOB is an element or object. INFO is a plist used as
5179 a communication channel. Return previous exportable element or
5180 object, a string, or nil.
5182 When optional argument N is a positive integer, return a list
5183 containing up to N siblings before BLOB, from farthest to
5184 closest. With any other non-nil value, return a list containing
5185 all of them."
5191 prev)
5201 "Return next element or object.
5203 BLOB is an element or object. INFO is a plist used as
5204 a communication channel. Return next exportable element or
5205 object, a string, or nil.
5207 When optional argument N is a positive integer, return a list
5208 containing up to N siblings after BLOB, from closest to farthest.
5209 With any other non-nil value, return a list containing all of
5210 them."
5217 next)
5227 ;;;; Translation
5228 ;;
5229 ;; `org-export-translate' translates a string according to the language
5230 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5231 ;; the dictionary used for the translation.
5279 ("ru" :html "(Продолжение следует)"
5382 ("ru" :html "Список распечаток"
5396 ("ru" :html "Список таблиц"
5488 ("ru" :html "Неизвестная ссылка"
5491 "Dictionary for export engine.
5493 Alist whose CAR is the string to translate and CDR is an alist
5494 whose CAR is the language string and CDR is a plist whose
5495 properties are possible charsets and values translated terms.
5497 It is used as a database for `org-export-translate'. Since this
5498 function returns the string as-is if no translation was found,
5499 the variable only needs to record values different from the
5503 "Translate string S according to language specification.
5505 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5506 and `:utf-8'. INFO is a plist used as a communication channel.
5508 Translation depends on `:language' property. Return the
5509 translated string. If no translation is found, try to fall back
5510 to `:default' encoding. If it fails, return S."
5516 s)))
5519 \f
5520 ;;; Asynchronous Export
5521 ;;
5522 ;; `org-export-async-start' is the entry point for asynchronous
5523 ;; export. It recreates current buffer (including visibility,
5524 ;; narrowing and visited file) in an external Emacs process, and
5525 ;; evaluates a command there. It then applies a function on the
5526 ;; returned results in the current process.
5527 ;;
5528 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5529 ;; allow to export to a buffer or a file, asynchronously or not.
5530 ;;
5531 ;; `org-export-output-file-name' is an auxiliary function meant to be
5532 ;; used with `org-export-to-file'. With a given extension, it tries
5533 ;; to provide a canonical file name to write export output to.
5534 ;;
5535 ;; Asynchronously generated results are never displayed directly.
5536 ;; Instead, they are stored in `org-export-stack-contents'. They can
5537 ;; then be retrieved by calling `org-export-stack'.
5538 ;;
5539 ;; Export Stack is viewed through a dedicated major mode
5540 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5541 ;;`org-export-stack-delete', `org-export-stack-view' and
5542 ;;`org-export-stack-clear'.
5543 ;;
5544 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5545 ;; It should be used whenever `org-export-async-start' is called.
5548 "Call function FUN on the results returned by BODY evaluation.
5550 FUN is an anonymous function of one argument. BODY evaluation
5551 happens in an asynchronous process, from a buffer which is an
5552 exact copy of the current one.
5554 Use `org-export-add-to-stack' in FUN in order to register results
5555 in the stack.
5557 This is a low level function. See also `org-export-to-buffer'
5558 and `org-export-to-file' for more specialized functions."
5561 ;; Write the full sexp evaluating BODY in a copy of the current
5562 ;; buffer to a temporary file, as it may be too long for program
5563 ;; args in `start-process'.
5570 ;; Null characters (from variable values) are inserted
5571 ;; within the file. As a consequence, coding system for
5572 ;; buffer contents will not be recognized properly. So,
5573 ;; we make sure it is the same as the one used to display
5574 ;; the original buffer.
5576 ,coding
5579 ;; Ignore `kill-emacs-hook' and code evaluation
5580 ;; queries from Babel as we need a truly
5581 ;; non-interactive process.
5583 org-babel-confirm-evaluate-answer-no t)
5584 ;; Initialize export framework.
5586 ;; Re-create current buffer there.
5589 ;; Sexp to evaluate in the buffer.
5591 ;; Start external process.
5594 (,process
5596 #'start-process
5599 ,proc-buffer
5606 ;; Register running process in stack.
5608 ;; Set-up sentinel in order to catch results.
5611 ,process
5633 ;;;###autoload
5636 &optional async subtreep visible-only body-only ext-plist
5637 post-process)
5638 "Call `org-export-as' with output to a specified buffer.
5640 BACKEND is either an export back-end, as returned by, e.g.,
5641 `org-export-create-backend', or a symbol referring to
5642 a registered back-end.
5644 BUFFER is the name of the output buffer. If it already exists,
5645 it will be erased first, otherwise, it will be created.
5647 A non-nil optional argument ASYNC means the process should happen
5648 asynchronously. The resulting buffer should then be accessible
5649 through the `org-export-stack' interface. When ASYNC is nil, the
5650 buffer is displayed if `org-export-show-temporary-export-buffer'
5651 is non-nil.
5653 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5654 EXT-PLIST are similar to those used in `org-export-as', which
5655 see.
5657 Optional argument POST-PROCESS is a function which should accept
5658 no argument. It is always called within the current process,
5659 from BUFFER, with point at its beginning. Export back-ends can
5660 use it to set a major mode there, e.g,
5662 \(defun org-latex-export-as-latex
5663 \(&optional async subtreep visible-only body-only ext-plist)
5664 \(interactive)
5666 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5668 This function returns BUFFER."
5696 buffer)))
5698 ;;;###autoload
5701 post-process)
5702 "Call `org-export-as' with output to a specified file.
5704 BACKEND is either an export back-end, as returned by, e.g.,
5705 `org-export-create-backend', or a symbol referring to
5706 a registered back-end. FILE is the name of the output file, as
5707 a string.
5709 A non-nil optional argument ASYNC means the process should happen
5710 asynchronously. The resulting buffer will then be accessible
5711 through the `org-export-stack' interface.
5713 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5714 EXT-PLIST are similar to those used in `org-export-as', which
5715 see.
5717 Optional argument POST-PROCESS is called with FILE as its
5718 argument and happens asynchronously when ASYNC is non-nil. It
5719 has to return a file name, or nil. Export back-ends can use this
5720 to send the output file through additional processing, e.g,
5722 \(defun org-latex-export-to-latex
5723 \(&optional async subtreep visible-only body-only ext-plist)
5724 \(interactive)
5726 \(org-export-to-file 'latex outfile
5727 async subtreep visible-only body-only ext-plist
5728 \(lambda (file) (org-latex-compile file)))
5730 The function returns either a file name returned by POST-PROCESS,
5731 or FILE."
5750 backend subtreep visible-only body-only ext-plist)))
5757 ;; Get proper return value.
5759 file))))))
5762 "Return output file's name according to buffer specifications.
5764 EXTENSION is a string representing the output file extension,
5765 with the leading dot.
5767 With a non-nil optional argument SUBTREEP, try to determine
5769 of subtree at point.
5771 When optional argument PUB-DIR is set, use it as the publishing
5772 directory.
5774 When optional argument VISIBLE-ONLY is non-nil, don't export
5775 contents of hidden elements.
5777 Return file name as a string."
5780 ;; File name may come from EXPORT_FILE_NAME subtree
5781 ;; property, assuming point is at beginning of said
5782 ;; sub-tree.
5789 ;; File name may be extracted from buffer's associated
5790 ;; file, if any.
5792 ;; Can't determine file name on our own: Ask user.
5796 "Output file: " pub-dir nil nil nil
5800 ;; Build file name. Enforce EXTENSION over whatever user
5801 ;; may have come up with. PUB-DIR, if defined, always has
5802 ;; precedence over any provided path.
5807 extension))
5810 ;; If writing to OUTPUT-FILE would overwrite original file, append
5811 ;; EXTENSION another time to final name.
5814 output-file)))
5817 "Add a new result to export stack if not present already.
5819 SOURCE is a buffer or a file name containing export results.
5820 BACKEND is a symbol representing export back-end used to generate
5821 it.
5823 Entries already pointing to SOURCE and unavailable entries are
5824 removed beforehand. Return the new stack."
5830 "Menu for asynchronous export results and running processes."
5840 "Return source from export results at point in stack."
5847 source
5848 ;; SOURCE is not consistent with current line. The stack
5849 ;; view is outdated.
5853 "Remove all entries from export stack."
5858 "Refresh the asynchronous export stack.
5859 DUMMY is ignored. Unavailable sources are removed from the list.
5860 Return the new stack."
5870 ;; Back-end.
5872 ;; Age.
5875 ;; Compute age of the results.
5877 "%4h:%.2m "
5879 ;; Source.
5884 ;; Clear stack from exited processes, dead buffers or
5885 ;; non-existent files.
5897 "Remove export results at point from stack.
5898 If optional argument SOURCE is non-nil, remove it instead."
5903 org-export-stack-contents))))
5906 "View export results at point in stack.
5907 With an optional prefix argument IN-EMACS, force viewing files
5908 within Emacs."
5922 (define-key km "p" 'previous-line)
5923 (define-key km "\C-p" 'previous-line)
5924 (define-key km "\C-?" 'previous-line)
5925 (define-key km [up] 'previous-line)
5926 (define-key km "C" 'org-export-stack-clear)
5927 (define-key km "v" 'org-export-stack-view)
5928 (define-key km (kbd "RET") 'org-export-stack-view)
5929 (define-key km "d" 'org-export-stack-remove)
5930 km)
5931 "Keymap for Org Export Stack.")
5933 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5934 "Mode for displaying asynchronous export stack.
5937 stack.
5939 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5940 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5941 stack completely.
5943 Removing entries in an Org Export Stack buffer doesn't affect
5944 files or buffers, only the display.
5947 (abbrev-mode 0)
5948 (auto-fill-mode 0)
5949 (setq buffer-read-only t
5950 buffer-undo-list t
5951 truncate-lines t
5952 header-line-format
5953 '(:eval
5954 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5955 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5956 (set (make-local-variable 'revert-buffer-function)
5957 'org-export-stack-refresh))
5960 \f
5961 ;;; The Dispatcher
5962 ;;
5963 ;; `org-export-dispatch' is the standard interactive way to start an
5964 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5965 ;; for its interface, which, in turn, delegates response to key
5966 ;; pressed to `org-export--dispatch-action'.
5968 ;;;###autoload
5969 (defun org-export-dispatch (&optional arg)
5970 "Export dispatcher for Org mode.
5972 It provides an access to common export related tasks in a buffer.
5973 Its interface comes in two flavors: standard and expert.
5975 While both share the same set of bindings, only the former
5976 displays the valid keys associations in a dedicated buffer.
5977 Scrolling (resp. line-wise motion) in this buffer is done with
5978 SPC and DEL (resp. C-n and C-p) keys.
5980 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5981 flavor or the other.
5984 of options used back then, on the current buffer.
5986 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5987 (interactive "P")
5988 (let* ((input
5989 (cond ((equal arg '(16)) '(stack))
5990 ((and arg org-export-dispatch-last-action))
5991 (t (save-window-excursion
5992 (unwind-protect
5993 (progn
5994 ;; Remember where we are
5995 (move-marker org-export-dispatch-last-position
5996 (point)
5997 (org-base-buffer (current-buffer)))
5998 ;; Get and store an export command
5999 (setq org-export-dispatch-last-action
6000 (org-export--dispatch-ui
6001 (list org-export-initial-scope
6002 (and org-export-in-background 'async))
6003 nil
6004 org-export-dispatch-use-expert-ui)))
6005 (and (get-buffer "*Org Export Dispatcher*")
6006 (kill-buffer "*Org Export Dispatcher*")))))))
6007 (action (car input))
6008 (optns (cdr input)))
6009 (unless (memq 'subtree optns)
6010 (move-marker org-export-dispatch-last-position nil))
6011 (case action
6012 ;; First handle special hard-coded actions.
6013 (template (org-export-insert-default-template nil optns))
6014 (stack (org-export-stack))
6015 (publish-current-file
6016 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6017 (publish-current-project
6018 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6019 (publish-choose-project
6020 (org-publish (assoc (org-icompleting-read
6021 "Publish project: "
6022 org-publish-project-alist nil t)
6023 org-publish-project-alist)
6024 (memq 'force optns)
6025 (memq 'async optns)))
6026 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6027 (otherwise
6028 (save-excursion
6029 (when arg
6030 ;; Repeating command, maybe move cursor to restore subtree
6031 ;; context.
6032 (if (eq (marker-buffer org-export-dispatch-last-position)
6033 (org-base-buffer (current-buffer)))
6034 (goto-char org-export-dispatch-last-position)
6035 ;; We are in a different buffer, forget position.
6036 (move-marker org-export-dispatch-last-position nil)))
6037 (funcall action
6038 ;; Return a symbol instead of a list to ease
6039 ;; asynchronous export macro use.
6040 (and (memq 'async optns) t)
6041 (and (memq 'subtree optns) t)
6042 (and (memq 'visible optns) t)
6043 (and (memq 'body optns) t)))))))
6045 (defun org-export--dispatch-ui (options first-key expertp)
6046 "Handle interface for `org-export-dispatch'.
6048 OPTIONS is a list containing current interactive options set for
6049 export. It can contain any of the following symbols:
6050 `body' toggles a body-only export
6051 `subtree' restricts export to current subtree
6052 `visible' restricts export to visible part of buffer.
6053 `force' force publishing files.
6054 `async' use asynchronous export process
6056 FIRST-KEY is the key pressed to select the first level menu. It
6057 is nil when this menu hasn't been selected yet.
6059 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6060 buffer is provided, but indications about currently active
6061 options are given in the prompt. Moreover, \[?] allows to switch
6062 back to standard interface."
6063 (let* ((fontify-key
6064 (lambda (key &optional access-key)
6065 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6066 ;; non-nil is the required first-level key to activate
6067 ;; KEY. When its value is t, activate KEY independently
6068 ;; on the first key, if any. A nil value means KEY will
6069 ;; only be activated at first level.
6070 (if (or (eq access-key t) (eq access-key first-key))
6071 (org-propertize key 'face 'org-warning)
6072 key)))
6073 (fontify-value
6074 (lambda (value)
6075 ;; Fontify VALUE string.
6076 (org-propertize value 'face 'font-lock-variable-name-face)))
6077 ;; Prepare menu entries by extracting them from registered
6078 ;; back-ends and sorting them by access key and by ordinal,
6079 ;; if any.
6080 (entries
6081 (sort (sort (delq nil
6082 (mapcar 'org-export-backend-menu
6083 org-export--registered-backends))
6084 (lambda (a b)
6085 (let ((key-a (nth 1 a))
6086 (key-b (nth 1 b)))
6087 (cond ((and (numberp key-a) (numberp key-b))
6088 (< key-a key-b))
6089 ((numberp key-b) t)))))
6090 'car-less-than-car))
6091 ;; Compute a list of allowed keys based on the first key
6092 ;; pressed, if any. Some keys
6093 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6094 ;; available.
6095 (allowed-keys
6096 (nconc (list 2 22 19 6 1)
6097 (if (not first-key) (org-uniquify (mapcar 'car entries))
6098 (let (sub-menu)
6099 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6100 (when (eq (car entry) first-key)
6101 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6102 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6103 ((not first-key) (list ?P)))
6104 (list ?& ?#)
6105 (when expertp (list ??))
6106 (list ?q)))
6107 ;; Build the help menu for standard UI.
6108 (help
6109 (unless expertp
6110 (concat
6111 ;; Options are hard-coded.
6112 (format "[%s] Body only: %s [%s] Visible only: %s
6113 \[%s] Export scope: %s [%s] Force publishing: %s
6115 (funcall fontify-key "C-b" t)
6116 (funcall fontify-value
6117 (if (memq 'body options) "On " "Off"))
6118 (funcall fontify-key "C-v" t)
6119 (funcall fontify-value
6120 (if (memq 'visible options) "On " "Off"))
6121 (funcall fontify-key "C-s" t)
6122 (funcall fontify-value
6123 (if (memq 'subtree options) "Subtree" "Buffer "))
6124 (funcall fontify-key "C-f" t)
6125 (funcall fontify-value
6126 (if (memq 'force options) "On " "Off"))
6127 (funcall fontify-key "C-a" t)
6128 (funcall fontify-value
6129 (if (memq 'async options) "On " "Off")))
6130 ;; Display registered back-end entries. When a key
6131 ;; appears for the second time, do not create another
6132 ;; entry, but append its sub-menu to existing menu.
6133 (let (last-key)
6134 (mapconcat
6135 (lambda (entry)
6136 (let ((top-key (car entry)))
6137 (concat
6138 (unless (eq top-key last-key)
6139 (setq last-key top-key)
6141 (funcall fontify-key (char-to-string top-key))
6142 (nth 1 entry)))
6143 (let ((sub-menu (nth 2 entry)))
6144 (unless (functionp sub-menu)
6145 ;; Split sub-menu into two columns.
6146 (let ((index -1))
6147 (concat
6148 (mapconcat
6149 (lambda (sub-entry)
6150 (incf index)
6151 (format
6152 (if (zerop (mod index 2)) " [%s] %-26s"
6154 (funcall fontify-key
6155 (char-to-string (car sub-entry))
6156 top-key)
6157 (nth 1 sub-entry)))
6158 sub-menu "")
6160 entries ""))
6161 ;; Publishing menu is hard-coded.
6163 [%s] Current file [%s] Current project
6165 (funcall fontify-key "P")
6166 (funcall fontify-key "f" ?P)
6167 (funcall fontify-key "p" ?P)
6168 (funcall fontify-key "x" ?P)
6169 (funcall fontify-key "a" ?P))
6171 (funcall fontify-key "&" t)
6172 (funcall fontify-key "#" t))
6173 (format "[%s] %s"
6174 (funcall fontify-key "q" t)
6175 (if first-key "Main menu" "Exit")))))
6176 ;; Build prompts for both standard and expert UI.
6177 (standard-prompt (unless expertp "Export command: "))
6178 (expert-prompt
6179 (when expertp
6180 (format
6181 "Export command (C-%s%s%s%s%s) [%s]: "
6182 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6183 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6184 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6185 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6186 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6187 (mapconcat (lambda (k)
6188 ;; Strip control characters.
6189 (unless (< k 27) (char-to-string k)))
6190 allowed-keys "")))))
6191 ;; With expert UI, just read key with a fancy prompt. In standard
6192 ;; UI, display an intrusive help buffer.
6193 (if expertp
6194 (org-export--dispatch-action
6195 expert-prompt allowed-keys entries options first-key expertp)
6196 ;; At first call, create frame layout in order to display menu.
6197 (unless (get-buffer "*Org Export Dispatcher*")
6198 (delete-other-windows)
6199 (org-switch-to-buffer-other-window
6200 (get-buffer-create "*Org Export Dispatcher*"))
6201 (setq cursor-type nil
6202 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6203 ;; Make sure that invisible cursor will not highlight square
6204 ;; brackets.
6205 (set-syntax-table (copy-syntax-table))
6206 (modify-syntax-entry ?\[ "w"))
6207 ;; At this point, the buffer containing the menu exists and is
6208 ;; visible in the current window. So, refresh it.
6209 (with-current-buffer "*Org Export Dispatcher*"
6210 ;; Refresh help. Maintain display continuity by re-visiting
6211 ;; previous window position.
6212 (let ((pos (window-start)))
6213 (erase-buffer)
6214 (insert help)
6215 (set-window-start nil pos)))
6216 (org-fit-window-to-buffer)
6217 (org-export--dispatch-action
6218 standard-prompt allowed-keys entries options first-key expertp))))
6220 (defun org-export--dispatch-action
6221 (prompt allowed-keys entries options first-key expertp)
6222 "Read a character from command input and act accordingly.
6224 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6225 a list of characters available at a given step in the process.
6226 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6227 EXPERTP are the same as defined in `org-export--dispatch-ui',
6228 which see.
6230 Toggle export options when required. Otherwise, return value is
6231 a list with action as CAR and a list of interactive export
6232 options as CDR."
6233 (let (key)
6234 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6235 ;; C-p, SPC, DEL).
6236 (while (and (setq key (read-char-exclusive prompt))
6237 (not expertp)
6238 (memq key '(14 16 ?\s ?\d)))
6239 (case key
6240 (14 (if (not (pos-visible-in-window-p (point-max)))
6241 (ignore-errors (scroll-up 1))
6242 (message "End of buffer")
6243 (sit-for 1)))
6244 (16 (if (not (pos-visible-in-window-p (point-min)))
6245 (ignore-errors (scroll-down 1))
6246 (message "Beginning of buffer")
6247 (sit-for 1)))
6248 (?\s (if (not (pos-visible-in-window-p (point-max)))
6249 (scroll-up nil)
6250 (message "End of buffer")
6251 (sit-for 1)))
6252 (?\d (if (not (pos-visible-in-window-p (point-min)))
6253 (scroll-down nil)
6254 (message "Beginning of buffer")
6255 (sit-for 1)))))
6256 (cond
6257 ;; Ignore undefined associations.
6258 ((not (memq key allowed-keys))
6259 (ding)
6260 (unless expertp (message "Invalid key") (sit-for 1))
6261 (org-export--dispatch-ui options first-key expertp))
6262 ;; q key at first level aborts export. At second level, cancel
6263 ;; first key instead.
6264 ((eq key ?q) (if (not first-key) (error "Export aborted")
6265 (org-export--dispatch-ui options nil expertp)))
6266 ;; Help key: Switch back to standard interface if expert UI was
6267 ;; active.
6268 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6269 ;; Send request for template insertion along with export scope.
6270 ((eq key ?#) (cons 'template (memq 'subtree options)))
6271 ;; Switch to asynchronous export stack.
6272 ((eq key ?&) '(stack))
6273 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6274 ((memq key '(2 22 19 6 1))
6275 (org-export--dispatch-ui
6276 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6277 (6 'force) (1 'async))))
6278 (if (memq option options) (remq option options)
6279 (cons option options)))
6280 first-key expertp))
6281 ;; Action selected: Send key and options back to
6282 ;; `org-export-dispatch'.
6283 ((or first-key (functionp (nth 2 (assq key entries))))
6284 (cons (cond
6285 ((not first-key) (nth 2 (assq key entries)))
6286 ;; Publishing actions are hard-coded. Send a special
6287 ;; signal to `org-export-dispatch'.
6288 ((eq first-key ?P)
6289 (case key
6290 (?f 'publish-current-file)
6291 (?p 'publish-current-project)
6292 (?x 'publish-choose-project)
6293 (?a 'publish-all)))
6294 ;; Return first action associated to FIRST-KEY + KEY
6295 ;; path. Indeed, derived backends can share the same
6296 ;; FIRST-KEY.
6297 (t (catch 'found
6298 (mapc (lambda (entry)
6299 (let ((match (assq key (nth 2 entry))))
6300 (when match (throw 'found (nth 2 match)))))
6301 (member (assq first-key entries) entries)))))
6302 options))
6303 ;; Otherwise, enter sub-menu.
6304 (t (org-export--dispatch-ui options key expertp)))))
6308 (provide 'ox)
6310 ;; Local variables:
6311 ;; generated-autoload-file: "org-loaddefs.el"
6312 ;; End:
6314 ;;; ox.el ends here