| blob | f60ff125b6f3ba7cc88a365480e3d725eff646b0 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
90 \f
91 ;;; Internal Variables
92 ;;
93 ;; Among internal variables, the most important is
94 ;; `org-export-options-alist'. This variable define the global export
95 ;; options, shared between every exporter, and how they are acquired.
140 "Alist between export properties and ways to set them.
142 The key of the alist is the property name, and the value is a list
143 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
145 KEYWORD is a string representing a buffer keyword, or nil. Each
146 property defined this way can also be set, during subtree
147 export, through a headline property named after the keyword
149 property).
150 OPTION is a string that could be found in an #+OPTIONS: line.
151 DEFAULT is the default value for the property.
152 BEHAVIOR determines how Org should handle multiple keywords for
153 the same property. It is a symbol among:
154 nil Keep old value and discard the new one.
155 t Replace old value with the new one.
156 `space' Concatenate the values, separating them with a space.
157 `newline' Concatenate the values, separating them with
158 a newline.
159 `split' Split values at white spaces, and cons them to the
160 previous list.
161 `parse' Parse value as a list of strings and Org objects,
162 which can then be transcoded with, e.g.,
163 `org-export-data'. It implies `space' behavior.
165 Values set through KEYWORD and OPTION have precedence over
166 DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
233 "Alist between filters properties and initial values.
235 The key of each association is a property name accessible through
236 the communication channel. Its value is a configurable global
237 variable defining initial filters.
239 This list is meant to install user specified filters. Back-end
240 developers may install their own filters using
241 `org-export-define-backend'. Filters defined there will always
242 be prepended to the current list, so they always get applied
251 "Default rule for link matching an inline image.
252 This rule applies to links with no description. By default, it
253 will be considered as an inline image if it targets a local file
256 See `org-export-inline-image-p' for more information about
261 org-element--cache org-element--cache-objects org-element--cache-sync-keys
262 org-element--cache-sync-requests org-element--cache-sync-timer)
263 "List of variables not copied through upon buffer duplication.
264 Export process takes place on a copy of the original buffer.
265 When this copy is created, all Org related local variables not in
266 this list are copied to the new buffer. Variables with an
270 "Non-nil means asynchronous export process should leave data behind.
274 located in `temporary-file-directory'.
276 When non-nil, it will also set `debug-on-error' to a non-nil
280 "Record asynchronously generated export results and processes.
281 This is an alist: its CAR is the source of the
282 result (destination file or buffer for a finished process,
283 original buffer for a running one) and its CDR is a list
284 containing the back-end used, as a symbol, and either a process
285 or the time at which it finished. It is used to build the menu
289 "List of backends currently available in the exporter.
290 This variable is set with `org-export-define-backend' and
294 "Last command called from the dispatcher.
295 The value should be a list. Its CAR is the action, as a symbol,
299 "The position where the last export command was created using the dispatcher.
300 This marker will be used with `C-u C-c C-e' to make sure export repetition
303 ;; For compatibility with Org < 8
305 "Name, if any, of the back-end used during an export process.
307 Its value is a symbol such as `html', `latex', `ascii', or nil if
308 the back-end is anonymous (see `org-export-create-backend') or if
309 there is no export process in progress.
311 It can be used to teach Babel blocks how to act differently
315 \f
316 ;;; User-configurable Variables
317 ;;
318 ;; Configuration for the masses.
319 ;;
320 ;; They should never be accessed directly, as their value is to be
321 ;; stored in a property list (cf. `org-export-options-alist').
322 ;; Back-ends will read their value from there instead.
325 "Options for exporting Org mode files."
330 "General options for export engine."
335 "Whether sub-trees with the ARCHIVE tag should be exported.
337 This can have three different values:
338 nil Do not export, pretend this tree is not present.
339 t Do export the entire tree.
340 `headline' Only export the headline, but skip the tree below it.
342 This option can also be set with the OPTIONS keyword,
351 "Non-nil means insert author name into the exported file.
352 This option can also be set with the OPTIONS keyword,
358 "Non-nil means export CLOCK keywords.
359 This option can also be set with the OPTIONS keyword,
365 "Non-nil means the postamble should contain a creator sentence.
367 The sentence can be set in `org-export-creator-string', which
368 see.
370 This option can also be set with the OPTIONS keyword, e.g.,
378 "Non-nil means insert date in the exported document.
379 This option can also be set with the OPTIONS keyword,
385 "Time-stamp format string to use for DATE keyword.
387 The format string, when specified, only applies if date consists
388 in a single time-stamp. Otherwise its value will be ignored.
390 See `format-time-string' for details on how to build this
391 string."
399 emacs-version
401 "Information about the creator of the document.
402 This option can also be set on with the CREATOR keyword."
407 "Non-nil means export contents of standard drawers.
409 When t, all drawers are exported. This may also be a list of
410 drawer names to export, as strings. If that list starts with
411 `not', only drawers with such names will be ignored.
413 This variable doesn't apply to properties drawers. See
414 `org-export-with-properties' instead.
416 This option can also be set with the OPTIONS keyword,
429 :inline t
433 "Non-nil means insert author email into the exported file.
434 This option can also be set with the OPTIONS keyword,
440 "Non-nil means interpret *word*, /word/, _word_ and +word+.
442 If the export target supports emphasizing text, the word will be
443 typeset in bold, italic, with an underline or strike-through,
444 respectively.
446 This option can also be set with the OPTIONS keyword,
452 "Tags that exclude a tree from export.
454 All trees carrying any of these tags will be excluded from
455 export. This is without condition, so even subtrees inside that
456 carry one of the `org-export-select-tags' will be removed.
458 This option can also be set with the EXCLUDE_TAGS keyword."
464 This option can also be set with the OPTIONS keyword,
472 "Non-nil means Org footnotes should be exported.
473 This option can also be set with the OPTIONS keyword,
479 "Non-nil means process LaTeX environments and fragments.
481 This option can also be set with the OPTIONS line,
484 nil Ignore math snippets.
485 `verbatim' Keep everything in verbatim.
486 t Allow export of math snippets."
496 "The last level which is still exported as a headline.
498 Inferior levels will usually produce itemize or enumerate lists
499 when exported, but back-end behaviour may differ.
501 This option can also be set with the OPTIONS keyword,
507 "The default language for export and clocktable translations, as a string.
508 This may have an association in
509 `org-clock-clocktable-language-setup',
510 `org-export-smart-quotes-alist' and `org-export-dictionary'.
511 This option can also be set with the LANGUAGE keyword."
516 "Non-nil means preserve all line breaks when exporting.
517 This option can also be set with the OPTIONS keyword,
523 "Non-nil means interpret entities when exporting.
526 Å.
528 For a list of supported names, see the constant `org-entities'
529 and the user option `org-entities-user'.
531 This option can also be set with the OPTIONS keyword,
537 "Non-nil means inlinetasks should be exported.
538 This option can also be set with the OPTIONS keyword,
546 "Non-nil means include planning info in export.
548 Planning info is the line containing either SCHEDULED:,
549 DEADLINE:, CLOSED: time-stamps, or a combination of them.
551 This option can also be set with the OPTIONS keyword,
559 "Non-nil means include priority cookies in export.
560 This option can also be set with the OPTIONS keyword,
566 "Non-nil means export contents of properties drawers.
568 When t, all properties are exported. This may also be a list of
569 properties to export, as strings.
571 This option can also be set with the OPTIONS keyword,
583 "Non-nil means add section numbers to headlines when exporting.
585 When set to an integer n, numbering will only happen for
586 headlines whose relative level is higher or equal to n.
588 This option can also be set with the OPTIONS keyword,
594 "Tags that select a tree for export.
596 If any such tag is found in a buffer, all trees that do not carry
597 one of these tags will be ignored during export. Inside trees
598 that are selected like this, you can still deselect a subtree by
599 tagging it with one of the `org-export-exclude-tags'.
601 This option can also be set with the SELECT_TAGS keyword."
606 "Non-nil means activate smart quotes during export.
607 This option can also be set with the OPTIONS keyword,
610 When setting this to non-nil, you need to take care of
611 using the correct Babel package when exporting to LaTeX.
612 E.g., you can load Babel for french like this:
623 When this option is turned on, these strings will be exported as:
625 Org HTML LaTeX UTF-8
626 -----+----------+--------+-------
628 -- – -- –
629 --- — --- —
632 This option can also be set with the OPTIONS keyword,
638 "Non-nil means include statistics cookies in export.
639 This option can also be set with the OPTIONS keyword,
649 If you want to control how Org displays those characters, see
650 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
651 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
652 it is not anymore.
654 When this option is turned on, you can use TeX-like syntax for
655 sub- and superscripts and see them exported correctly.
657 You can also set the option with #+OPTIONS: ^:t
660 single item - so grouping with {} is normally not needed. For
661 example, the following things will be parsed as single sub- or
662 superscripts:
664 10^24 or 10^tau several digits will be considered 1 item.
665 10^-12 or 10^-tau a leading sign with digits or a word
666 x^2-y^3 will be read as x^2 - y^3, because items are
667 terminated by almost any nonword/nondigit char.
668 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
670 Still, ambiguity is possible. So when in doubt, use {} to enclose
671 the sub/superscript. If you set this variable to the symbol `{}',
672 the braces are *required* in order to trigger interpretations as
674 frequently in plain text."
684 "Non-nil means create a table of contents in exported files.
686 The TOC contains headlines with levels up
687 to`org-export-headline-levels'. When an integer, include levels
688 up to N in the toc, this may then be different from
689 `org-export-headline-levels', but it will not be allowed to be
690 larger than the number of headline levels. When nil, no table of
691 contents is made.
693 This option can also be set with the OPTIONS keyword,
702 "Non-nil means export tables.
703 This option can also be set with the OPTIONS keyword,
711 "If nil, do not export tags, just remove them from headlines.
713 If this is the symbol `not-in-toc', tags will be removed from
714 table of contents entries, but still be shown in the headlines of
715 the document.
717 This option can also be set with the OPTIONS keyword,
726 "Non-nil means include TODO items for export.
728 This may have the following values:
729 t include tasks independent of state.
730 `todo' include only tasks that are not yet done.
731 `done' include only tasks that are already done.
732 nil ignore all tasks.
733 list of keywords include tasks with these keywords.
735 This option can also be set with the OPTIONS keyword,
747 "Non-nil means print title into the exported file.
748 This option can also be set with the OPTIONS keyword,
756 "Non-nil means insert a time stamp into the exported file.
757 The time stamp shows when the file was created. This option can
763 "Non nil means allow timestamps in export.
765 It can be set to any of the following values:
766 t export all timestamps.
767 `active' export active timestamps only.
768 `inactive' export inactive timestamps only.
769 nil do not export timestamps
771 This only applies to timestamps isolated in a paragraph
772 containing only timestamps. Other timestamps are always
773 exported.
775 This option can also be set with the OPTIONS keyword, e.g.
785 "Non-nil means include TODO keywords in export.
786 When nil, remove all these keywords from the export. This option
792 "Non-nil means BIND keywords can define local variable values.
793 This is a potential security risk, which is why the default value
794 is nil. You can also allow them through local buffer variables."
801 "Alist between export snippets back-ends and exporter back-ends.
803 This variable allows to provide shortcuts for export snippets.
807 HTML code while every other back-end will ignore it."
816 "Coding system for the exported file."
823 "Non-nil means pushing export output to the kill ring.
824 This variable is ignored during asynchronous export."
834 "The initial scope when exporting with `org-export-dispatch'.
835 This variable can be either set to `buffer' or `subtree'."
842 "Non-nil means show buffer after exporting to temp buffer.
843 When Org exports to a file, the buffer visiting that file is never
844 shown, but remains buried. However, when exporting to
845 a temporary buffer, that buffer is popped up in a second window.
846 When this variable is nil, the buffer remains buried also in
847 these cases."
852 "Non-nil means export and publishing commands will run in background.
853 Results from an asynchronous export are never displayed
861 "File used to initialize external export process.
863 Value must be either nil or an absolute file name. When nil, the
864 external process is launched like a regular Emacs session,
865 loading user's initialization file and any site specific
866 configuration. If a file is provided, it, and only it, is loaded
867 at start-up.
869 Therefore, using a specific configuration makes the process to
870 load faster and the export more portable."
879 "Non-nil means using a non-intrusive `org-export-dispatch'.
880 In that case, no help buffer is displayed. Though, an indicator
886 asynchronous). Also, \[?] allows to switch back to standard
887 mode."
894 \f
895 ;;; Defining Back-ends
896 ;;
897 ;; An export back-end is a structure with `org-export-backend' type
898 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
899 ;; and `menu' slots.
900 ;;
901 ;; At the lowest level, a back-end is created with
902 ;; `org-export-create-backend' function.
903 ;;
904 ;; A named back-end can be registered with
905 ;; `org-export-register-backend' function. A registered back-end can
906 ;; later be referred to by its name, with `org-export-get-backend'
907 ;; function. Also, such a back-end can become the parent of a derived
908 ;; back-end from which slot values will be inherited by default.
909 ;; `org-export-derived-backend-p' can check if a given back-end is
910 ;; derived from a list of back-end names.
911 ;;
912 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
913 ;; `org-export-get-all-filters' return the full alist of transcoders,
914 ;; options and filters, including those inherited from ancestors.
915 ;;
916 ;; At a higher level, `org-export-define-backend' is the standard way
917 ;; to define an export back-end. If the new back-end is similar to
918 ;; a registered back-end, `org-export-define-derived-backend' may be
919 ;; used instead.
920 ;;
921 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
922 ;; when a given back-end hasn't been registered yet.
926 name parent transcoders options filters blocks menu)
929 "Return export back-end named after NAME.
930 NAME is a symbol. Return nil if no such back-end is found."
937 "Register BACKEND as a known export back-end.
938 BACKEND is a structure with `org-export-backend' type."
939 ;; Refuse to register an unnamed back-end.
942 ;; Refuse to register a back-end with an unknown parent.
946 ;; Register dedicated export blocks in the parser.
950 ;; If a back-end with the same name as BACKEND is already
951 ;; registered, replace it with BACKEND. Otherwise, simply add
952 ;; BACKEND to the list of registered back-ends.
958 "Signal an error if BACKEND isn't defined."
963 "Non-nil if BACKEND is derived from one of BACKENDS.
964 BACKEND is an export back-end, as returned by, e.g.,
965 `org-export-create-backend', or a symbol referring to
966 a registered back-end. BACKENDS is constituted of symbols."
978 "Return full translation table for BACKEND.
980 BACKEND is an export back-end, as return by, e.g,,
981 `org-export-create-backend'. Return value is an alist where
982 keys are element or object types, as symbols, and values are
983 transcoders.
985 Unlike to `org-export-backend-transcoders', this function
986 also returns transcoders inherited from parent back-ends,
987 if any."
991 parent)
996 transcoders)))
999 "Return export options for BACKEND.
1001 BACKEND is an export back-end, as return by, e.g,,
1002 `org-export-create-backend'. See `org-export-options-alist'
1003 for the shape of the return value.
1005 Unlike to `org-export-backend-options', this function also
1006 returns options inherited from parent back-ends, if any."
1010 parent)
1014 options)))
1017 "Return complete list of filters for BACKEND.
1019 BACKEND is an export back-end, as return by, e.g,,
1020 `org-export-create-backend'. Return value is an alist where
1021 keys are symbols and values lists of functions.
1023 Unlike to `org-export-backend-filters', this function also
1024 returns filters inherited from parent back-ends, if any."
1028 parent)
1032 filters)))
1035 "Define a new back-end BACKEND.
1037 TRANSCODERS is an alist between object or element types and
1038 functions handling them.
1040 These functions should return a string without any trailing
1041 space, or nil. They must accept three arguments: the object or
1042 element itself, its contents or nil when it isn't recursive and
1043 the property list used as a communication channel.
1045 Contents, when not nil, are stripped from any global indentation
1046 \(although the relative one is preserved). They also always end
1047 with a single newline character.
1049 If, for a given type, no function is found, that element or
1050 object type will simply be ignored, along with any blank line or
1051 white space at its end. The same will happen if the function
1052 returns the nil value. If that function returns the empty
1053 string, the type will be ignored, but the blank lines or white
1054 spaces will be kept.
1056 In addition to element and object types, one function can be
1057 associated to the `template' (or `inner-template') symbol and
1058 another one to the `plain-text' symbol.
1060 The former returns the final transcoded string, and can be used
1061 to add a preamble and a postamble to document's body. It must
1062 accept two arguments: the transcoded string and the property list
1063 containing export options. A function associated to `template'
1065 A function associated to `inner-template' is always applied.
1067 The latter, when defined, is to be called on every text not
1068 recognized as an element or an object. It must accept two
1069 arguments: the text string and the information channel. It is an
1070 appropriate place to protect special chars relative to the
1071 back-end.
1073 BODY can start with pre-defined keyword arguments. The following
1074 keywords are understood:
1076 :export-block
1078 String, or list of strings, representing block names that
1079 will not be parsed. This is used to specify blocks that will
1080 contain raw code specific to the back-end. These blocks
1081 still have to be handled by the relative `export-block' type
1082 translator.
1084 :filters-alist
1086 Alist between filters and function, or list of functions,
1087 specific to the back-end. See `org-export-filters-alist' for
1088 a list of all allowed filters. Filters defined here
1089 shouldn't make a back-end test, as it may prevent back-ends
1090 derived from this one to behave properly.
1092 :menu-entry
1094 Menu entry for the export dispatcher. It should be a list
1095 like:
1097 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1099 where :
1101 KEY is a free character selecting the back-end.
1103 DESCRIPTION-OR-ORDINAL is either a string or a number.
1105 If it is a string, is will be used to name the back-end in
1106 its menu entry. If it is a number, the following menu will
1107 be displayed as a sub-menu of the back-end with the same
1108 KEY. Also, the number will be used to determine in which
1109 order such sub-menus will appear (lowest first).
1111 ACTION-OR-MENU is either a function or an alist.
1113 If it is an action, it will be called with four
1114 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1115 BODY-ONLY. See `org-export-as' for further explanations on
1116 some of them.
1118 If it is an alist, associations should follow the
1119 pattern:
1121 '(KEY DESCRIPTION ACTION)
1123 where KEY, DESCRIPTION and ACTION are described above.
1125 Valid values include:
1129 or
1134 \(lambda (a s v b)
1135 \(if a (org-latex-export-to-pdf t s v b)
1136 \(org-open-file
1137 \(org-latex-export-to-pdf nil s v b)))))))
1139 or the following, which will be added to the previous
1140 sub-menu,
1142 '(?l 1
1146 :options-alist
1148 Alist between back-end specific properties introduced in
1149 communication channel and how their value are acquired. See
1150 `org-export-options-alist' for more information about
1151 structure of the values."
1166 :transcoders transcoders
1167 :options options
1168 :filters filters
1169 :blocks blocks
1173 "Create a new back-end as a variant of an existing one.
1175 CHILD is the name of the derived back-end. PARENT is the name of
1176 the parent back-end.
1178 BODY can start with pre-defined keyword arguments. The following
1179 keywords are understood:
1181 :export-block
1183 String, or list of strings, representing block names that
1184 will not be parsed. This is used to specify blocks that will
1185 contain raw code specific to the back-end. These blocks
1186 still have to be handled by the relative `export-block' type
1187 translator.
1189 :filters-alist
1191 Alist of filters that will overwrite or complete filters
1192 defined in PARENT back-end. See `org-export-filters-alist'
1193 for a list of allowed filters.
1195 :menu-entry
1197 Menu entry for the export dispatcher. See
1198 `org-export-define-backend' for more information about the
1199 expected value.
1201 :options-alist
1203 Alist of back-end specific properties that will overwrite or
1204 complete those defined in PARENT back-end. Refer to
1205 `org-export-options-alist' for more information about
1206 structure of the values.
1208 :translate-alist
1210 Alist of element and object types and transcoders that will
1211 overwrite or complete transcode table from PARENT back-end.
1212 Refer to `org-export-define-backend' for detailed information
1213 about transcoders.
1216 as a variant of `latex' back-end with a custom template function:
1218 \(org-export-define-derived-backend 'my-latex 'latex
1219 :translate-alist '((template . my-latex-template-fun)))
1221 The back-end could then be called with, for example:
1239 :parent parent
1240 :transcoders transcoders
1241 :options options
1242 :filters filters
1243 :blocks blocks
1247 \f
1248 ;;; The Communication Channel
1249 ;;
1250 ;; During export process, every function has access to a number of
1251 ;; properties. They are of two types:
1252 ;;
1253 ;; 1. Environment options are collected once at the very beginning of
1254 ;; the process, out of the original buffer and configuration.
1255 ;; Collecting them is handled by `org-export-get-environment'
1256 ;; function.
1257 ;;
1258 ;; Most environment options are defined through the
1259 ;; `org-export-options-alist' variable.
1260 ;;
1261 ;; 2. Tree properties are extracted directly from the parsed tree,
1262 ;; just before export, by `org-export-collect-tree-properties'.
1264 ;;;; Environment Options
1265 ;;
1266 ;; Environment options encompass all parameters defined outside the
1267 ;; scope of the parsed data. They come from five sources, in
1268 ;; increasing precedence order:
1269 ;;
1270 ;; - Global variables,
1271 ;; - Buffer's attributes,
1272 ;; - Options keyword symbols,
1273 ;; - Buffer keywords,
1274 ;; - Subtree properties.
1275 ;;
1276 ;; The central internal function with regards to environment options
1277 ;; is `org-export-get-environment'. It updates global variables with
1278 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1279 ;; the different sources.
1280 ;;
1281 ;; The internal functions doing the retrieval are:
1282 ;; `org-export--get-global-options',
1283 ;; `org-export--get-buffer-attributes',
1284 ;; `org-export--parse-option-keyword',
1285 ;; `org-export--get-subtree-options' and
1286 ;; `org-export--get-inbuffer-options'
1287 ;;
1288 ;; Also, `org-export--list-bound-variables' collects bound variables
1289 ;; along with their value in order to set them as buffer local
1290 ;; variables later in the process.
1293 "Collect export options from the current buffer.
1295 Optional argument BACKEND is an export back-end, as returned by
1296 `org-export-create-backend'.
1298 When optional argument SUBTREEP is non-nil, assume the export is
1299 done against the current sub-tree.
1301 Third optional argument EXT-PLIST is a property list with
1302 external parameters overriding Org default settings, but still
1303 inferior to file-local settings."
1304 ;; First install #+BIND variables since these must be set before
1305 ;; global options are read.
1308 ;; Get and prioritize export options...
1310 ;; ... from global variables...
1312 ;; ... from an external property list...
1313 ext-plist
1314 ;; ... from in-buffer settings...
1316 ;; ... and from subtree, when appropriate.
1318 ;; Eventually add misc. properties.
1320 :back-end
1321 backend
1323 :id-alist
1324 ;; Collect id references.
1335 alist))))
1338 "Parse an OPTIONS line and return values as a plist.
1339 Optional argument BACKEND is an export back-end, as returned by,
1340 e.g., `org-export-create-backend'. It specifies which back-end
1341 specific items to read, if any."
1345 ;; Priority is given to back-end specific options.
1347 org-export-options-alist)))
1349 plist)
1356 plist))
1359 "Get export options in subtree at point.
1360 Optional argument BACKEND is an export back-end, as returned by,
1361 e.g., `org-export-create-backend'. It specifies back-end used
1362 for export. Return options as a plist."
1363 ;; For each buffer keyword, create a headline property setting the
1364 ;; same property in communication channel. The name for the
1365 ;; property is the keyword with "EXPORT_" appended to it.
1367 ;; Make sure point is at a heading.
1370 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1371 ;; care of them right from the start.
1374 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1375 ;; headline's title (with no todo keyword, priority cookie or
1376 ;; tag) as its fallback value.
1382 ;; Look for both general keywords and back-end specific
1383 ;; options, with priority given to the latter.
1385 org-export-options-alist)))
1386 ;; Handle other keywords. Then return PLIST.
1399 property
1408 "Return current buffer export options, as a plist.
1410 Optional argument BACKEND, when non-nil, is an export back-end,
1411 as returned by, e.g., `org-export-create-backend'. It specifies
1412 which back-end specific options should also be read in the
1413 process.
1415 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1417 get-options ; For byte-compiler.
1420 ;; Priority is given to back-end specific options.
1422 org-export-options-alist))
1425 org-export-special-keywords))))
1428 ;; Return all properties associated to KEYWORD.
1433 to-parse
1436 ;; Recursively read keywords in buffer. FILES is a list
1437 ;; of files read so far. PLIST is the current property
1438 ;; list obtained.
1447 ;; Options in `org-export-special-keywords'.
1451 ;; Avoid circular dependencies.
1461 plist
1466 plist
1472 ;; Options in `org-export-options-alist'.
1475 plist
1477 plist property
1478 ;; Handle value depending on specified
1479 ;; BEHAVIOR.
1484 ;; Even if `parse' implies `space'
1485 ;; behavior, we separate line with "\n"
1486 ;; so as to preserve line-breaks.
1487 ;; However, empty lines are forbidden
1488 ;; since `parse' doesn't allow more than
1489 ;; one paragraph.
1498 " "
1511 plist))))
1512 ;; Read options in the current buffer and return value.
1515 nil)))
1516 ;; Parse properties in TO-PARSE. Remove newline characters not
1517 ;; involved in line breaks to simulate `space' behaviour.
1518 ;; Finally return options.
1530 "Return properties related to buffer attributes, as a plist."
1535 "Return global export options as a plist.
1536 Optional argument BACKEND, if non-nil, is an export back-end, as
1537 returned by, e.g., `org-export-create-backend'. It specifies
1538 which back-end specific export options should also be read in the
1539 process."
1541 ;; Priority is given to back-end specific options.
1543 org-export-options-alist)))
1549 plist
1550 prop
1551 ;; Evaluate default value provided.
1556 value)))))))))
1559 "Return variables bound from BIND keywords in current buffer.
1560 Also look for BIND keywords in setup files. The return value is
1561 an alist where associations are (VARIABLE-NAME VALUE)."
1566 ;; Return an alist between variable names and their
1567 ;; value. FILES is a list of setup files names read so
1568 ;; far, used to avoid circular dependencies. ALIST is
1569 ;; the alist collected so far.
1580 ;; Enter setup file.
1590 alist))))))))))
1591 alist)))))
1592 ;; Return value in appropriate order of appearance.
1595 ;; defsubst org-export-get-parent must be defined before first use,
1596 ;; was originally defined in the topology section
1599 "Return BLOB parent or nil.
1600 BLOB is the element or object considered."
1603 ;;;; Tree Properties
1604 ;;
1605 ;; Tree properties are information extracted from parse tree. They
1606 ;; are initialized at the beginning of the transcoding process by
1607 ;; `org-export-collect-tree-properties'.
1608 ;;
1609 ;; Dedicated functions focus on computing the value of specific tree
1610 ;; properties during initialization. Thus,
1611 ;; `org-export--populate-ignore-list' lists elements and objects that
1612 ;; should be skipped during export, `org-export--get-min-level' gets
1613 ;; the minimal exportable level, used as a basis to compute relative
1614 ;; level for headlines. Eventually
1615 ;; `org-export--collect-headline-numbering' builds an alist between
1616 ;; headlines and their numbering.
1619 "Extract tree properties from parse tree.
1621 DATA is the parse tree from which information is retrieved. INFO
1622 is a list holding export options.
1624 Following tree properties are set or updated:
1626 `:exported-data' Hash table used to memoize results from
1627 `org-export-data'.
1629 `:headline-offset' Offset between true level of headlines and
1630 local level. An offset of -1 means a headline
1631 of level 2 should be considered as a level
1632 1 headline in the context.
1634 `:headline-numbering' Alist of all headlines as key an the
1635 associated numbering as value.
1637 Return updated plist."
1638 ;; Install the parse tree in the communication channel.
1640 ;; Compute `:headline-offset' in order to be able to use
1641 ;; `org-export-get-relative-level'.
1644 :headline-offset
1646 ;; Properties order doesn't matter: get the rest of the tree
1647 ;; properties.
1651 info))
1654 "Return minimum exportable headline's level in DATA.
1655 DATA is parsed tree as returned by `org-element-parse-buffer'.
1656 OPTIONS is a plist holding export options."
1667 ;; If no headline was found, for the sake of consistency, set
1668 ;; minimum level to 1 nonetheless.
1672 "Return numbering of all exportable, numbered headlines in a parse tree.
1674 DATA is the parse tree. OPTIONS is the plist holding export
1675 options.
1677 Return an alist whose key is a headline and value is its
1678 associated numbering \(in the shape of a list of numbers\) or nil
1679 for a footnotes section."
1688 headline
1690 for idx from 0 to org-export-max-depth
1694 options)))
1697 "List headlines and inlinetasks with a select tag in their tree.
1698 DATA is parsed data as returned by `org-element-parse-buffer'.
1699 INFO is a plist holding export options."
1701 walk-data ; For byte-compiler.
1711 ;; When a select tag is found, mark full
1712 ;; genealogy and every headline within the tree
1713 ;; as acceptable.
1716 genealogy
1719 selected-trees))
1720 ;; If at a headline, continue searching in tree,
1721 ;; recursively.
1730 selected-trees))
1733 "Non-nil when element or object BLOB should be skipped during export.
1734 OPTIONS is the plist holding export options. SELECTED, when
1735 non-nil, is a list of headlines or inlinetasks belonging to
1736 a tree with a select tag."
1743 ;; If `:with-drawers' value starts with `not', ignore
1744 ;; every drawer whose name belong to that list.
1745 ;; Otherwise, ignore drawers whose name isn't in that
1746 ;; list.
1763 ;; Ignore subtrees with an exclude tag.
1766 ;; When a select tag is present in the buffer, ignore any tree
1767 ;; without it.
1769 ;; Ignore commented sub-trees.
1771 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1773 ;; Ignore tasks, if specified by `:with-tasks' property.
1785 properties-set))))))
1796 ;; `:with-timestamps' only applies to isolated timestamps
1797 ;; objects, i.e. timestamp objects in a paragraph containing only
1798 ;; timestamps and whitespaces.
1806 options t))))
1815 \f
1816 ;;; The Transcoder
1817 ;;
1818 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1819 ;; `org-element-parse-buffer') and transcodes it into a specified
1820 ;; back-end output. It takes care of filtering out elements or
1821 ;; objects according to export options and organizing the output blank
1822 ;; lines and white space are preserved. The function memoizes its
1823 ;; results, so it is cheap to call it within transcoders.
1824 ;;
1825 ;; It is possible to modify locally the back-end used by
1826 ;; `org-export-data' or even use a temporary back-end by using
1827 ;; `org-export-data-with-backend'.
1828 ;;
1829 ;; `org-export-transcoder' is an accessor returning appropriate
1830 ;; translator function for a given element or object.
1833 "Return appropriate transcoder for BLOB.
1834 INFO is a plist containing export directives."
1836 ;; Return contents only for complete parse trees.
1842 "Convert DATA into current back-end format.
1844 DATA is a parse tree, an element or an object or a secondary
1845 string. INFO is a plist holding export options.
1847 Return a string."
1852 ;; Ignored element/object.
1854 ;; Plain text.
1860 info))
1861 ;; Secondary string.
1864 ;; Element/Object without contents or, as a special
1865 ;; case, headline with archive tag and archived trees
1866 ;; restricted to title only.
1874 ;; Export snippets never return a nil value so
1875 ;; that white spaces following them are never
1876 ;; ignored.
1878 ;; Element/Object with contents.
1891 ;; Elements directly containing
1892 ;; objects must have their indentation
1893 ;; normalized first.
1895 data
1896 ;; When normalizing contents of the
1897 ;; first paragraph in an item or
1898 ;; a footnote definition, ignore
1899 ;; first line's indentation: there is
1900 ;; none and it might be misleading.
1905 data)
1912 info))))))))
1913 ;; Final result will be memoized before being returned.
1915 data
1919 ;; Append the same white space between elements or objects
1920 ;; as in the original buffer, and call appropriate filters.
1931 info)))
1932 results)))
1936 "Convert DATA into BACKEND format.
1938 DATA is an element, an object, a secondary string or a string.
1939 BACKEND is a symbol. INFO is a plist used as a communication
1940 channel.
1942 Unlike to `org-export-with-backend', this function will
1943 recursively convert DATA using BACKEND translation table."
1946 data
1947 ;; Set-up a new communication channel with translations defined in
1948 ;; BACKEND as the translate table and a new hash table for
1949 ;; memoization.
1951 info
1954 ;; Size of the hash table is reduced since this function
1955 ;; will probably be used on small trees.
1959 "Expand a parsed element or object to its original state.
1961 BLOB is either an element or an object. CONTENTS is its
1962 contents, as a string or nil.
1964 When optional argument WITH-AFFILIATED is non-nil, add affiliated
1965 keywords before output."
1970 blob contents))))
1973 \f
1974 ;;; The Filter System
1975 ;;
1976 ;; Filters allow end-users to tweak easily the transcoded output.
1977 ;; They are the functional counterpart of hooks, as every filter in
1978 ;; a set is applied to the return value of the previous one.
1979 ;;
1980 ;; Every set is back-end agnostic. Although, a filter is always
1981 ;; called, in addition to the string it applies to, with the back-end
1982 ;; used as argument, so it's easy for the end-user to add back-end
1983 ;; specific filters in the set. The communication channel, as
1984 ;; a plist, is required as the third argument.
1985 ;;
1986 ;; From the developer side, filters sets can be installed in the
1987 ;; process with the help of `org-export-define-backend', which
1988 ;; internally stores filters as an alist. Each association has a key
1989 ;; among the following symbols and a function or a list of functions
1990 ;; as value.
1991 ;;
1992 ;; - `:filter-options' applies to the property list containing export
1993 ;; options. Unlike to other filters, functions in this list accept
1994 ;; two arguments instead of three: the property list containing
1995 ;; export options and the back-end. Users can set its value through
1996 ;; `org-export-filter-options-functions' variable.
1997 ;;
1998 ;; - `:filter-parse-tree' applies directly to the complete parsed
1999 ;; tree. Users can set it through
2000 ;; `org-export-filter-parse-tree-functions' variable.
2001 ;;
2002 ;; - `:filter-body' applies to the body of the output, before template
2003 ;; translator chimes in. Users can set it through
2004 ;; `org-export-filter-body-functions' variable.
2005 ;;
2006 ;; - `:filter-final-output' applies to the final transcoded string.
2007 ;; Users can set it with `org-export-filter-final-output-functions'
2008 ;; variable.
2009 ;;
2010 ;; - `:filter-plain-text' applies to any string not recognized as Org
2011 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2012 ;; configure it.
2013 ;;
2014 ;; - `:filter-TYPE' applies on the string returned after an element or
2015 ;; object of type TYPE has been transcoded. A user can modify
2016 ;; `org-export-filter-TYPE-functions' to install these filters.
2017 ;;
2018 ;; All filters sets are applied with
2019 ;; `org-export-filter-apply-functions' function. Filters in a set are
2020 ;; applied in a LIFO fashion. It allows developers to be sure that
2021 ;; their filters will be applied first.
2022 ;;
2023 ;; Filters properties are installed in communication channel with
2024 ;; `org-export-install-filters' function.
2025 ;;
2026 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2027 ;; `org-export-before-parsing-hook') are run at the beginning of the
2028 ;; export process and just before parsing to allow for heavy structure
2029 ;; modifications.
2032 ;;;; Hooks
2035 "Hook run at the beginning of the export process.
2037 This is run before include keywords and macros are expanded and
2038 Babel code blocks executed, on a copy of the original buffer
2039 being exported. Visibility and narrowing are preserved. Point
2040 is at the beginning of the buffer.
2042 Every function in this hook will be called with one argument: the
2046 "Hook run before parsing an export buffer.
2048 This is run after include keywords and macros have been expanded
2049 and Babel code blocks executed, on a copy of the original buffer
2050 being exported. Visibility and narrowing are preserved. Point
2051 is at the beginning of the buffer.
2053 Every function in this hook will be called with one argument: the
2057 ;;;; Special Filters
2060 "List of functions applied to the export options.
2061 Each filter is called with two arguments: the export options, as
2062 a plist, and the back-end, as a symbol. It must return
2066 "List of functions applied to the parsed tree.
2067 Each filter is called with three arguments: the parse tree, as
2068 returned by `org-element-parse-buffer', the back-end, as
2069 a symbol, and the communication channel, as a plist. It must
2073 "List of functions applied to plain text.
2074 Each filter is called with three arguments: a string which
2075 contains no Org syntax, the back-end, as a symbol, and the
2076 communication channel, as a plist. It must return a string or
2080 "List of functions applied to transcoded body.
2081 Each filter is called with three arguments: a string which
2082 contains no Org syntax, the back-end, as a symbol, and the
2083 communication channel, as a plist. It must return a string or
2087 "List of functions applied to the transcoded string.
2088 Each filter is called with three arguments: the full transcoded
2089 string, the back-end, as a symbol, and the communication channel,
2090 as a plist. It must return a string that will be used as the
2094 ;;;; Elements Filters
2097 "List of functions applied to a transcoded babel-call.
2098 Each filter is called with three arguments: the transcoded data,
2099 as a string, the back-end, as a symbol, and the communication
2103 "List of functions applied to a transcoded center block.
2104 Each filter is called with three arguments: the transcoded data,
2105 as a string, the back-end, as a symbol, and the communication
2109 "List of functions applied to a transcoded clock.
2110 Each filter is called with three arguments: the transcoded data,
2111 as a string, the back-end, as a symbol, and the communication
2115 "List of functions applied to a transcoded diary-sexp.
2116 Each filter is called with three arguments: the transcoded data,
2117 as a string, the back-end, as a symbol, and the communication
2121 "List of functions applied to a transcoded drawer.
2122 Each filter is called with three arguments: the transcoded data,
2123 as a string, the back-end, as a symbol, and the communication
2127 "List of functions applied to a transcoded dynamic-block.
2128 Each filter is called with three arguments: the transcoded data,
2129 as a string, the back-end, as a symbol, and the communication
2133 "List of functions applied to a transcoded example-block.
2134 Each filter is called with three arguments: the transcoded data,
2135 as a string, the back-end, as a symbol, and the communication
2139 "List of functions applied to a transcoded export-block.
2140 Each filter is called with three arguments: the transcoded data,
2141 as a string, the back-end, as a symbol, and the communication
2145 "List of functions applied to a transcoded fixed-width.
2146 Each filter is called with three arguments: the transcoded data,
2147 as a string, the back-end, as a symbol, and the communication
2151 "List of functions applied to a transcoded footnote-definition.
2152 Each filter is called with three arguments: the transcoded data,
2153 as a string, the back-end, as a symbol, and the communication
2157 "List of functions applied to a transcoded headline.
2158 Each filter is called with three arguments: the transcoded data,
2159 as a string, the back-end, as a symbol, and the communication
2163 "List of functions applied to a transcoded horizontal-rule.
2164 Each filter is called with three arguments: the transcoded data,
2165 as a string, the back-end, as a symbol, and the communication
2169 "List of functions applied to a transcoded inlinetask.
2170 Each filter is called with three arguments: the transcoded data,
2171 as a string, the back-end, as a symbol, and the communication
2175 "List of functions applied to a transcoded item.
2176 Each filter is called with three arguments: the transcoded data,
2177 as a string, the back-end, as a symbol, and the communication
2181 "List of functions applied to a transcoded keyword.
2182 Each filter is called with three arguments: the transcoded data,
2183 as a string, the back-end, as a symbol, and the communication
2187 "List of functions applied to a transcoded latex-environment.
2188 Each filter is called with three arguments: the transcoded data,
2189 as a string, the back-end, as a symbol, and the communication
2193 "List of functions applied to a transcoded node-property.
2194 Each filter is called with three arguments: the transcoded data,
2195 as a string, the back-end, as a symbol, and the communication
2199 "List of functions applied to a transcoded paragraph.
2200 Each filter is called with three arguments: the transcoded data,
2201 as a string, the back-end, as a symbol, and the communication
2205 "List of functions applied to a transcoded plain-list.
2206 Each filter is called with three arguments: the transcoded data,
2207 as a string, the back-end, as a symbol, and the communication
2211 "List of functions applied to a transcoded planning.
2212 Each filter is called with three arguments: the transcoded data,
2213 as a string, the back-end, as a symbol, and the communication
2217 "List of functions applied to a transcoded property-drawer.
2218 Each filter is called with three arguments: the transcoded data,
2219 as a string, the back-end, as a symbol, and the communication
2223 "List of functions applied to a transcoded quote block.
2224 Each filter is called with three arguments: the transcoded quote
2225 data, as a string, the back-end, as a symbol, and the
2226 communication channel, as a plist. It must return a string or
2230 "List of functions applied to a transcoded section.
2231 Each filter is called with three arguments: the transcoded data,
2232 as a string, the back-end, as a symbol, and the communication
2236 "List of functions applied to a transcoded special block.
2237 Each filter is called with three arguments: the transcoded data,
2238 as a string, the back-end, as a symbol, and the communication
2242 "List of functions applied to a transcoded src-block.
2243 Each filter is called with three arguments: the transcoded data,
2244 as a string, the back-end, as a symbol, and the communication
2248 "List of functions applied to a transcoded table.
2249 Each filter is called with three arguments: the transcoded data,
2250 as a string, the back-end, as a symbol, and the communication
2254 "List of functions applied to a transcoded table-cell.
2255 Each filter is called with three arguments: the transcoded data,
2256 as a string, the back-end, as a symbol, and the communication
2260 "List of functions applied to a transcoded table-row.
2261 Each filter is called with three arguments: the transcoded data,
2262 as a string, the back-end, as a symbol, and the communication
2266 "List of functions applied to a transcoded verse block.
2267 Each filter is called with three arguments: the transcoded data,
2268 as a string, the back-end, as a symbol, and the communication
2272 ;;;; Objects Filters
2275 "List of functions applied to transcoded bold text.
2276 Each filter is called with three arguments: the transcoded data,
2277 as a string, the back-end, as a symbol, and the communication
2281 "List of functions applied to transcoded code text.
2282 Each filter is called with three arguments: the transcoded data,
2283 as a string, the back-end, as a symbol, and the communication
2287 "List of functions applied to a transcoded entity.
2288 Each filter is called with three arguments: the transcoded data,
2289 as a string, the back-end, as a symbol, and the communication
2293 "List of functions applied to a transcoded export-snippet.
2294 Each filter is called with three arguments: the transcoded data,
2295 as a string, the back-end, as a symbol, and the communication
2299 "List of functions applied to a transcoded footnote-reference.
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 inline-babel-call.
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 inline-src-block.
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 transcoded italic text.
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 latex-fragment.
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 line-break.
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 link.
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 radio-target.
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 statistics-cookie.
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 transcoded strike-through text.
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 subscript.
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 superscript.
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 target.
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 timestamp.
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 transcoded underline text.
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 transcoded verbatim text.
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 ;;;; Filters Tools
2396 ;;
2397 ;; Internal function `org-export-install-filters' installs filters
2398 ;; hard-coded in back-ends (developer filters) and filters from global
2399 ;; variables (user filters) in the communication channel.
2400 ;;
2401 ;; Internal function `org-export-filter-apply-functions' takes care
2402 ;; about applying each filter in order to a given data. It ignores
2403 ;; filters returning a nil value but stops whenever a filter returns
2404 ;; an empty string.
2407 "Call every function in FILTERS.
2409 Functions are called with arguments VALUE, current export
2410 back-end's name and INFO. A function returning a nil value will
2411 be skipped. If it returns the empty string, the process ends and
2412 VALUE is ignored.
2414 Call is done in a LIFO fashion, to be sure that developer
2415 specified filters, if any, are called first."
2426 "Install filters properties in communication channel.
2427 INFO is a plist containing the current communication channel.
2428 Return the updated communication channel."
2430 ;; Install user-defined filters with `org-export-filters-alist'
2431 ;; and filters already in INFO (through ext-plist mechanism).
2438 ;; Filters in INFO will be called
2439 ;; before those user provided.
2442 default-value)))))
2443 org-export-filters-alist)
2444 ;; Prepend back-end specific filters to that list.
2446 ;; Single values get consed, lists are appended.
2451 plist key
2455 ;; Return new communication channel.
2459 \f
2460 ;;; Core functions
2461 ;;
2462 ;; This is the room for the main function, `org-export-as', along with
2463 ;; its derivative, `org-export-string-as'.
2464 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2465 ;; function should be added to kill ring.
2466 ;;
2467 ;; Note that `org-export-as' doesn't really parse the current buffer,
2468 ;; but a copy of it (with the same buffer-local variables and
2469 ;; visibility), where macros and include keywords are expanded and
2470 ;; Babel blocks are executed, if appropriate.
2471 ;; `org-export-with-buffer-copy' macro prepares that copy.
2472 ;;
2473 ;; File inclusion is taken care of by
2474 ;; `org-export-expand-include-keyword' and
2475 ;; `org-export--prepare-file-contents'. Structure wise, including
2476 ;; a whole Org file in a buffer often makes little sense. For
2477 ;; example, if the file contains a headline and the include keyword
2478 ;; was within an item, the item should contain the headline. That's
2479 ;; why file inclusion should be done before any structure can be
2480 ;; associated to the file, that is before parsing.
2481 ;;
2482 ;; `org-export-insert-default-template' is a command to insert
2483 ;; a default template (or a back-end specific template) at point or in
2484 ;; current subtree.
2487 "Return a copy of the current buffer.
2488 The copy preserves Org buffer-local variables, visibility and
2489 narrowing."
2495 new-buf))
2498 "Apply BODY in a copy of the current buffer.
2499 The copy preserves local variables, visibility and contents of
2500 the original buffer. Point is at the beginning of the buffer
2501 when BODY is applied."
2510 ;; Kill copy without confirmation.
2516 "Generate a function duplicating BUFFER.
2518 The copy will preserve local variables, visibility, contents and
2519 narrowing of the original buffer. If a region was active in
2520 BUFFER, contents will be narrowed to that region instead.
2522 The resulting function can be evaluated at a later time, from
2523 another buffer, effectively cloning the original buffer there.
2525 The function assumes BUFFER's major mode is `org-mode'."
2529 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2530 ;; already in BUFFER.
2532 ;; Copy specific buffer local variables and variables set
2533 ;; through BIND keywords.
2535 vars)
2543 buffer-file-name
2544 buffer-file-coding-system))
2548 ;; Skip unreadable values, as they cannot be
2549 ;; sent to external process.
2553 vars))))))
2554 ;; Whole buffer contents.
2559 ;; Narrowing.
2563 ;; Current position of point.
2565 ;; Overlays with invisible property.
2575 ov-set))))
2577 ov-set)))))
2580 "Delete commented areas in the buffer.
2581 Commented areas are comments, comment blocks, commented trees and
2582 inlinetasks. Trailing blank lines after a comment or a comment
2583 block are preserved. Narrowing, if any, is ignored."
2604 "Prune non exportable elements from DATA.
2605 DATA is the parse tree to traverse. INFO is the plist holding
2606 export info. Also set `:ignore-list' in INFO to a list of
2607 objects which should be ignored during export, but not removed
2608 from tree."
2610 ignore
2611 ;; First find trees containing a select tag, if any.
2615 ;; Prune non-exportable elements and objects from tree.
2616 ;; As a special case, special rows and cells from tables
2617 ;; are stored in IGNORE, as they still need to be accessed
2618 ;; during export.
2627 ;; If headline is archived but tree below has to
2628 ;; be skipped, remove contents.
2630 ;; Move into secondary string, if any.
2635 ;; Move into recursive objects/elements.
2637 ;; If a select tag is active, also ignore the section before the
2638 ;; first headline, if any.
2643 ;; Prune tree and communication channel.
2647 ;; Priority is given to back-end specific options.
2649 org-export-options-alist))
2652 ;; Eventually set `:ignore-list'.
2656 "Change uninterpreted elements back into Org syntax.
2657 DATA is the parse tree. INFO is a plist containing export
2658 options. Each uninterpreted element or object is changed back
2659 into a string. Contents, if any, are not modified. The parse
2660 tree is modified by side effect."
2666 p
2669 info))))))
2672 "Change uninterpreted elements back into Org syntax.
2673 DATA is a parse tree or a secondary string. INFO is a plist
2674 containing export options. It is modified by side effect and
2675 returned by the function."
2678 subscript superscript underline)
2682 ;; ... entities...
2689 ?\s)))))
2690 ;; ... emphasis...
2702 marker
2706 ?\s)))))))
2707 ;; ... LaTeX environments and fragments...
2711 ;; ... sub/superscripts...
2720 "_"
2729 ?\s)))))))))))
2731 ;; Splice NEW at BLOB location in parse tree.
2734 info)
2735 ;; Return modified parse tree.
2736 data)
2739 "Insert footnote definitions outside parsing scope in TREE.
2741 If there is a footnote section in TREE, definitions found are
2742 appended to it. If `org-footnote-section' is non-nil, a new
2743 footnote section containing all definitions is inserted in TREE.
2744 Otherwise, definitions are appended at the end of the section
2745 containing their first reference.
2747 Only definitions actually referred to within TREE, directly or
2748 not, are considered."
2767 definitions))
2775 'footnote-definition
2781 definitions))))))))
2782 ;; Collect all out of scope definitions.
2792 ;; Filter out definitions referenced neither in the original
2793 ;; tree nor in the external definitions.
2798 definitions))
2801 referenced-labels)))
2806 definitions)))
2807 ;; Install definitions in subtree.
2810 ;; If there is a footnote section, insert them here.
2815 nil t)))
2818 ;; If there should be a footnote section, create one containing
2819 ;; all the definitions at the end of the tree.
2822 tree
2828 'section
2829 nil
2831 ;; Otherwise add each definition at the end of the section where
2832 ;; it is first referenced.
2838 ;; Insert definitions in the same section as their
2839 ;; first reference in DATA.
2851 label)
2858 definition)
2860 definition)))))))))))
2863 ;;;###autoload
2866 "Transcode current Org buffer into BACKEND code.
2868 BACKEND is either an export back-end, as returned by, e.g.,
2869 `org-export-create-backend', or a symbol referring to
2870 a registered back-end.
2872 If narrowing is active in the current buffer, only transcode its
2873 narrowed part.
2875 If a region is active, transcode that region.
2877 When optional argument SUBTREEP is non-nil, transcode the
2878 sub-tree at point, extracting information from the headline
2879 properties first.
2881 When optional argument VISIBLE-ONLY is non-nil, don't export
2882 contents of hidden elements.
2884 When optional argument BODY-ONLY is non-nil, only return body
2885 code, without surrounding template.
2887 Optional argument EXT-PLIST, when provided, is a property list
2888 with external parameters overriding Org default settings, but
2889 still inferior to file-local settings.
2891 Return code as a string."
2896 ;; Narrow buffer to an appropriate region or subtree for
2897 ;; parsing. If parsing subtree, be sure to remove main headline
2898 ;; too.
2906 ;; Initialize communication channel with original buffer
2907 ;; attributes, unavailable in its copy.
2920 org-export-options-alist))))
2921 tree)
2922 ;; Update communication channel and get parse tree. Buffer
2923 ;; isn't parsed directly. Instead, a temporary copy is
2924 ;; created, where include keywords, macros are expanded and
2925 ;; code blocks are evaluated.
2927 ;; Run first hook with current back-end's name as argument.
2932 ;; Refresh buffer properties, radio targets and macros after
2933 ;; including files.
2939 ;; Run last hook with current back-end's name as argument.
2944 ;; Update communication channel with environment. Also
2945 ;; install user's and developer's filters.
2950 ;; Call options filters and update export options. We do not
2951 ;; use `org-export-filter-apply-functions' here since the
2952 ;; arity of such filters is different.
2957 ;; Expand export-specific set of macros: {{{author}}},
2958 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2959 ;; be done once regular macros have been expanded, since
2960 ;; parsed keywords may contain one of them.
2973 value)
2974 value)))
2978 'finalize
2979 parsed-keywords)
2980 ;; Parse buffer.
2982 ;; Merge footnote definitions outside scope into parse tree.
2984 ;; Prune tree from non-exported elements and transform
2985 ;; uninterpreted elements or objects in both parse tree and
2986 ;; communication channel.
2989 ;; Call parse tree filters.
2993 ;; Now tree is complete, compute its properties and add them
2994 ;; to communication channel.
2998 ;; Eventually transcode TREE. Wrap the resulting string into
2999 ;; a template.
3008 info))
3011 ;; Remove all text properties since they cannot be
3012 ;; retrieved from an external process. Finally call
3013 ;; final-output filter and return result.
3019 info))))))))
3021 ;;;###autoload
3023 "Transcode STRING into BACKEND code.
3025 BACKEND is either an export back-end, as returned by, e.g.,
3026 `org-export-create-backend', or a symbol referring to
3027 a registered back-end.
3029 When optional argument BODY-ONLY is non-nil, only return body
3030 code, without preamble nor postamble.
3032 Optional argument EXT-PLIST, when provided, is a property list
3033 with external parameters overriding Org default settings, but
3034 still inferior to file-local settings.
3036 Return code as a string."
3042 ;;;###autoload
3044 "Replace the active region by its export to BACKEND.
3045 BACKEND is either an export back-end, as returned by, e.g.,
3046 `org-export-create-backend', or a symbol referring to
3047 a registered back-end."
3053 ;;;###autoload
3055 "Insert all export keywords with default values at beginning of line.
3057 BACKEND is a symbol referring to the name of a registered export
3058 back-end, for which specific export options should be added to
3059 the template, or `default' for default template. When it is nil,
3060 the user will be prompted for a category.
3062 If SUBTREEP is non-nil, export configuration will be set up
3063 locally for the subtree through node properties."
3073 "Options category: "
3077 org-export-registered-backends))
3078 nil t))))
3079 options keywords)
3080 ;; Populate OPTIONS and KEYWORDS.
3097 ;; Move to an appropriate location in order to insert options.
3099 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3117 ;; Then the rest of keywords, in the order specified in either
3118 ;; `org-export-options-alist' or respective export back-ends.
3139 "Expand every include keyword in buffer.
3140 Optional argument INCLUDED is a list of included file names along
3141 with their line restriction, when appropriate. It is used to
3142 avoid infinite recursion. Optional argument DIR is the current
3143 working directory. It is used to properly resolve relative
3144 paths. Optional argument FOOTNOTES is a hash-table used for
3145 storing and resolving footnotes. It is created automatically."
3151 ;; If :minlevel is not set the text-property
3152 ;; `:org-include-induced-level' will be used to determine the
3153 ;; relative level when expanding INCLUDE.
3154 ;; Only affects included Org documents.
3158 :org-include-induced-level
3160 ;; Expand INCLUDE keywords.
3166 ;; Extract arguments from keyword's value.
3169 location
3177 matched)
3183 matched)
3184 dir)))
3188 value)
3194 value)
3201 ;; Minimal level of included file defaults to the child
3202 ;; level of the current headline, if any, or one. It
3203 ;; only applies is the file is meant to be included as
3204 ;; an Org one.
3216 ;; Remove keyword.
3222 ;; Check if files has already been parsed. Look after
3223 ;; inclusion lines too, as different parts of the same file
3224 ;; can be included too.
3239 ind-str block arg-str contents ind-str block))))
3246 ind-str block contents ind-str block))))
3254 file location only-contents lines)
3255 lines)))
3259 file lines ind minlevel
3262 footnotes)))
3266 footnotes)
3268 ;; Expand footnotes after all files have been included.
3269 ;; Footnotes are stored at end of buffer.
3274 footnotes)))))))))))
3277 "Resolve absolute lines for an included file with file-link.
3279 FILE is string file-name of the file to include. LOCATION is a
3280 string name within FILE to be included (located via
3281 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3282 contents of the named element will be included, as determined
3283 Org-Element. If LINES is non-nil only those lines are included.
3285 Return a string of lines to be included in the format expected by
3286 `org-export--prepare-file-contents'."
3292 ;; Enforce consistent search.
3305 ;; Skip planning line and property-drawer.
3331 start-line
3333 (+ start-line
3336 counter))))))))
3339 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3341 REF-BEGIN corresponds to the property `:begin' of objects of type
3342 footnote-definition and footnote-reference.
3344 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3345 \[N] where N is one or more numbers.
3347 Return the new label."
3358 "Prepare contents of FILE for inclusion and return it as a string.
3360 When optional argument LINES is a string specifying a range of
3361 lines, include only those lines.
3363 Optional argument IND, when non-nil, is an integer specifying the
3364 global indentation of returned contents. Since its purpose is to
3365 allow an included file to stay in the same environment it was
3366 created \(i.e. a list item), it doesn't apply past the first
3367 headline encountered.
3369 Optional argument MINLEVEL, when non-nil, is an integer
3370 specifying the level that any top-level headline in the included
3371 file should have.
3372 Optional argument ID is an integer that will be inserted before
3373 each footnote definition and reference if FILE is an Org file.
3374 This is useful to avoid conflicts when more than one Org file
3375 with footnotes is included in a document.
3377 Optional argument FOOTNOTES is a hash-table to store footnotes in
3378 the included document.
3379 "
3395 ;; Remove blank lines at beginning and end of contents. The logic
3396 ;; behind that removal is that blank lines around include keyword
3397 ;; override blank lines in included file.
3406 ;; If IND is set, preserve indentation of include keyword until
3407 ;; the first headline encountered.
3414 ;; Do not move footnote definitions out of column 0.
3420 ;; When MINLEVEL is specified, compute minimal level for headlines
3421 ;; in the file (CUR-MIN), and remove stars to each headline so
3422 ;; that headlines with minimal level have a level of MINLEVEL.
3433 ;; Only change stars, don't bother moving whole
3434 ;; sections.
3438 ;; Append ID to all footnote references and definitions, so they
3439 ;; become file specific and cannot collide with footnotes in other
3440 ;; included files. Further, collect relevant footnotes outside of
3441 ;; LINES.
3452 ;; Update the footnote-reference at point and collect
3453 ;; the new label, which is only used for footnotes
3454 ;; outsides LINES.
3456 ;; If label is akin to [1] convert it to [fn:ID-1].
3457 ;; Otherwise add "ID-" after "fn:".
3460 digit-label id)))
3467 "Definition not found for footnote %s in file %s"
3468 label file))
3471 ;; Store since footnote-definition is
3472 ;; outside of LINES.
3476 footnotes)
3477 ;; Update label of definition since it is
3478 ;; included directly.
3480 beginning digit-label id)))))))))))
3486 "Execute every Babel code in the visible part of current buffer."
3487 ;; Get a pristine copy of current buffer so Babel references can be
3488 ;; properly resolved.
3494 "Return a non-nil value when output should be added to the kill ring.
3495 See also `org-export-copy-to-kill-ring'."
3501 \f
3502 ;;; Tools For Back-Ends
3503 ;;
3504 ;; A whole set of tools is available to help build new exporters. Any
3505 ;; function general enough to have its use across many back-ends
3506 ;; should be added here.
3508 ;;;; For Affiliated Keywords
3509 ;;
3510 ;; `org-export-read-attribute' reads a property from a given element
3511 ;; as a plist. It can be used to normalize affiliated keywords'
3512 ;; syntax.
3513 ;;
3514 ;; Since captions can span over multiple lines and accept dual values,
3515 ;; their internal representation is a bit tricky. Therefore,
3516 ;; `org-export-get-caption' transparently returns a given element's
3517 ;; caption as a secondary string.
3520 "Turn ATTRIBUTE property from ELEMENT into a plist.
3522 When optional argument PROPERTY is non-nil, return the value of
3523 that property within attributes.
3527 properties.
3529 All values will become strings except the empty string and
3532 will become the empty string."
3546 s)
3551 ;; Ignore any string before first property with `cdr'.
3556 "Return caption from ELEMENT as a secondary string.
3558 When optional argument SHORTP is non-nil, return short caption,
3559 as a secondary string, instead.
3561 Caption lines are separated by a white space."
3569 ;;;; For Derived Back-ends
3570 ;;
3571 ;; `org-export-with-backend' is a function allowing to locally use
3572 ;; another back-end to transcode some object or element. In a derived
3573 ;; back-end, it may be used as a fall-back function once all specific
3574 ;; cases have been treated.
3577 "Call a transcoder from BACKEND on DATA.
3578 BACKEND is an export back-end, as returned by, e.g.,
3579 `org-export-create-backend', or a symbol referring to
3580 a registered back-end. DATA is an Org element, object, secondary
3581 string or string. CONTENTS, when non-nil, is the transcoded
3582 contents of DATA element, as a string. INFO, when non-nil, is
3583 the communication channel used for export, as a plist."
3593 transcoder data contents
3596 :back-end backend
3597 :translate-alist all-transcoders
3601 ;;;; For Export Snippets
3602 ;;
3603 ;; Every export snippet is transmitted to the back-end. Though, the
3604 ;; latter will only retain one type of export-snippet, ignoring
3605 ;; others, based on the former's target back-end. The function
3606 ;; `org-export-snippet-backend' returns that back-end for a given
3607 ;; export-snippet.
3610 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3611 Translation, with `org-export-snippet-translation-alist', is
3612 applied."
3616 back-end))))
3619 ;;;; For Footnotes
3620 ;;
3621 ;; `org-export-collect-footnote-definitions' is a tool to list
3622 ;; actually used footnotes definitions in the whole parse tree, or in
3623 ;; a headline, in order to add footnote listings throughout the
3624 ;; transcoded data.
3625 ;;
3626 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3627 ;; back-ends, when they need to attach the footnote definition only to
3628 ;; the first occurrence of the corresponding label.
3629 ;;
3630 ;; `org-export-get-footnote-definition' and
3631 ;; `org-export-get-footnote-number' provide easier access to
3632 ;; additional information relative to a footnote reference.
3635 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3636 INFO is the plist used as a communication channel. If no such
3637 definition can be found, raise an error."
3643 hash))))
3651 info t)
3652 cache)
3657 "Apply FUNCTION on every footnote reference in DATA.
3658 INFO is a plist containing export state. By default, as soon as
3659 a new footnote reference is encountered, FUNCTION is called onto
3660 its definition. However, if BODY-FIRST is non-nil, this step is
3661 delayed until the end of the process."
3667 ;; Search footnote references through DATA, filling
3668 ;; SEEN-REFS along the way. When DELAYP is non-nil, store
3669 ;; footnote definitions so they can be entered later.
3676 ;; Search for subsequent references in footnote
3677 ;; definition so numbering follows reading logic,
3678 ;; unless DELAYP in non-nil.
3682 definitions))
3683 ;; Do not force entering inline definitions,
3684 ;; since `org-element-map' already traverses them
3685 ;; at the right time.
3689 nil))))))
3690 info nil
3691 ;; Don't enter footnote definitions since it will happen
3692 ;; when their first reference is found. Moreover, if
3693 ;; DELAYP is non-nil, make sure we postpone entering
3694 ;; definitions of inline references.
3701 "Return an alist between footnote numbers, labels and definitions.
3703 INFO is the current export state, as a plist.
3705 Definitions are collected throughout the whole parse tree, or
3706 DATA when non-nil.
3708 Sorting is done by order of references. As soon as a new
3709 reference is encountered, other references are searched within
3710 its definition. However, if BODY-FIRST is non-nil, this step is
3711 delayed after the whole tree is checked. This alters results
3712 when references are found in footnote definitions.
3714 Definitions either appear as Org data or as a secondary string
3715 for inlined footnotes. Unreferenced definitions are ignored."
3719 ;; Collect footnote number, label and definition.
3730 "Non-nil when a footnote reference is the first one for its label.
3732 FOOTNOTE-REFERENCE is the footnote reference being considered.
3733 INFO is a plist containing current export state.
3735 Search is done throughout the whole parse tree, or DATA when
3736 non-nil.
3738 By default, as soon as a new footnote reference is encountered,
3739 other references are searched within its definition. However, if
3740 BODY-FIRST is non-nil, this step is delayed after the whole tree
3741 is checked. This alters results when references are found in
3742 footnote definitions."
3744 ;; Anonymous footnotes are always a first reference.
3755 "Return number associated to a footnote.
3757 FOOTNOTE is either a footnote reference or a footnote definition.
3758 INFO is the plist containing export state.
3760 Number is unique throughout the whole parse tree, or DATA, when
3761 non-nil.
3763 By default, as soon as a new footnote reference is encountered,
3764 counting process moves into its definition. However, if
3765 BODY-FIRST is non-nil, this step is delayed until the end of the
3766 process, leading to a different order when footnotes are nested."
3775 ;; Anonymous footnote match: return number.
3777 ;; Labels match: return number.
3779 ;; Otherwise store label and increase counter if label
3780 ;; wasn't encountered yet.
3786 ;;;; For Headlines
3787 ;;
3788 ;; `org-export-get-relative-level' is a shortcut to get headline
3789 ;; level, relatively to the lower headline level in the parsed tree.
3790 ;;
3791 ;; `org-export-get-headline-number' returns the section number of an
3792 ;; headline, while `org-export-number-to-roman' allows to convert it
3793 ;; to roman numbers. With an optional argument,
3794 ;; `org-export-get-headline-number' returns a number to unnumbered
3795 ;; headlines (used for internal id).
3796 ;;
3797 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3798 ;; `org-export-last-sibling-p' are three useful predicates when it
3799 ;; comes to fulfill the `:headline-levels' property.
3800 ;;
3801 ;; `org-export-get-tags', `org-export-get-category' and
3802 ;; `org-export-get-node-property' extract useful information from an
3803 ;; headline or a parent headline. They all handle inheritance.
3804 ;;
3805 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3806 ;; as a secondary string, suitable for table of contents. It falls
3807 ;; back onto default title.
3810 "Return HEADLINE relative level within current parsed tree.
3811 INFO is a plist holding contextual information."
3816 "Non-nil when HEADLINE is considered as low level.
3818 INFO is a plist used as a communication channel.
3820 A low level headlines has a relative level greater than
3821 `:headline-levels' property value.
3823 Return value is the difference between HEADLINE relative level
3824 and the last level being considered as high enough, or nil."
3831 "Return numbered HEADLINE numbering as a list of numbers.
3832 INFO is a plist holding contextual information."
3837 "Return a non-nil value if HEADLINE element should be numbered.
3838 INFO is a plist used as a communication channel."
3847 "Convert integer N into a roman numeral."
3860 res)))
3863 "Return list of tags associated to ELEMENT.
3865 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3866 is a plist used as a communication channel.
3868 Select tags (see `org-export-select-tags') and exclude tags (see
3869 `org-export-exclude-tags') are removed from the list.
3871 When non-nil, optional argument TAGS should be a list of strings.
3872 Any tag belonging to this list will also be removed.
3874 When optional argument INHERITED is non-nil, tags can also be
3875 inherited from parent headlines and FILETAGS keywords."
3881 ;; Build complete list of inherited tags.
3888 ;; Add FILETAGS keywords and return results.
3892 "Return node PROPERTY value for BLOB.
3894 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3895 element or object.
3897 If optional argument INHERITED is non-nil, the value can be
3898 inherited from a parent headline.
3900 Return value is a string or nil."
3912 "Return category for element or object BLOB.
3914 INFO is a plist used as a communication channel.
3916 CATEGORY is automatically inherited from a parent headline, from
3917 #+CATEGORY: keyword or created out of original file name. If all
3930 "Return alternative title for HEADLINE, as a secondary string.
3931 INFO is a plist used as a communication channel. If no optional
3932 title is defined, fall-back to the regular title."
3939 "Non-nil when BLOB is the first sibling in its parent.
3940 BLOB is an element or an object. If BLOB is a headline, non-nil
3941 means it is the first sibling in the sub-tree. INFO is a plist
3942 used as a communication channel."
3947 "Non-nil when BLOB is the last sibling in its parent.
3948 BLOB is an element or an object. INFO is a plist used as
3949 a communication channel."
3953 ;;;; For Keywords
3954 ;;
3955 ;; `org-export-get-date' returns a date appropriate for the document
3956 ;; to about to be exported. In particular, it takes care of
3957 ;; `org-export-date-timestamp-format'.
3960 "Return date value for the current document.
3962 INFO is a plist used as a communication channel. FMT, when
3963 non-nil, is a time format string that will be applied on the date
3964 if it consists in a single timestamp object. It defaults to
3965 `org-export-date-timestamp-format' when nil.
3967 A proper date can be a secondary string, a string or nil. It is
3968 meant to be translated with `org-export-data' or alike."
3979 ;;;; For Links
3980 ;;
3981 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3982 ;; with `org-add-link-type', which see.
3983 ;;
3984 ;; `org-export-get-coderef-format' returns an appropriate format
3985 ;; string for coderefs.
3986 ;;
3987 ;; `org-export-inline-image-p' returns a non-nil value when the link
3988 ;; provided should be considered as an inline image.
3989 ;;
3990 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3991 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3992 ;; returns an appropriate unique identifier when found, or nil.
3993 ;;
3994 ;; `org-export-resolve-id-link' returns the first headline with
3995 ;; specified id or custom-id in parse tree, the path to the external
3996 ;; file with the id or nil when neither was found.
3997 ;;
3998 ;; `org-export-resolve-coderef' associates a reference to a line
3999 ;; number in the element it belongs, or returns the reference itself
4000 ;; when the element isn't numbered.
4001 ;;
4002 ;; `org-export-file-uri' expands a filename as stored in :path value
4003 ;; of a "file" link into a file URI.
4006 "Try exporting LINK with a dedicated function.
4008 DESC is its description, as a string, or nil. BACKEND is the
4009 back-end used for export, as a symbol.
4011 Return output as a string, or nil if no protocol handles LINK.
4013 A custom protocol has precedence over regular back-end export.
4014 The function ignores links with an implicit type (e.g.,
4023 desc
4024 backend))))))
4027 "Return format string for code reference link.
4028 PATH is the link path. DESC is its description."
4036 "Non-nil if LINK object points to an inline image.
4038 Optional argument is a set of RULES defining inline images. It
4039 is an alist where associations have the following shape:
4041 \(TYPE . REGEXP)
4043 Applying a rule means apply REGEXP against LINK's path when its
4044 type is TYPE. The function will return a non-nil value if any of
4045 the provided rules is non-nil. The default rule is
4046 `org-export-default-inline-image-rule'.
4048 This only applies to links without a description."
4059 "Resolve a code reference REF.
4061 INFO is a plist used as a communication channel.
4063 Return associated line number in source code, or REF itself,
4064 depending on src-block or example element's switches. Throw an
4065 error if no block contains REF."
4072 org-coderef-label-format)))
4076 ;; Element containing REF is found. Resolve it to
4077 ;; either a label or a line number, as needed.
4088 "Return LINK destination.
4090 INFO is a plist holding contextual information.
4092 Return value can be an object, an element, or nil:
4094 - If LINK path matches a target object (i.e. <<path>>) return it.
4096 - If LINK path exactly matches the name affiliated keyword
4097 \(i.e. #+NAME: path) of an element, return that element.
4099 - If LINK path exactly matches any headline name, return that
4100 element.
4102 - Otherwise, throw an error.
4105 significant."
4108 ;; Split PATH at white spaces so matches are space
4109 ;; insensitive.
4115 :resolve-fuzzy-link-cache
4122 path
4124 ;; First try to find a matching "<<path>>" unless user
4125 ;; specified he was looking for a headline (path starts with
4126 ;; a "*" character).
4132 path)
4133 datum))
4135 ;; Then try to find an element with a matching "#+NAME: path"
4136 ;; affiliated keyword.
4143 ;; Try to find a matching headline.
4150 path)
4151 h))
4154 link-cache)))))
4157 "Return headline referenced as LINK destination.
4159 INFO is a plist used as a communication channel.
4161 Return value can be the headline element matched in current parse
4165 ;; First check if id is within the current parse tree.
4170 headline))
4172 ;; Otherwise, look for external files.
4177 "Return radio-target object referenced as LINK destination.
4179 INFO is a plist used as a communication channel.
4181 Return value can be a radio-target object or nil. Assume LINK
4190 nil nil path nil nil t)
4191 t)
4192 radio))
4196 "Return file URI associated to FILENAME."
4202 filename))))
4205 ;;;; For References
4206 ;;
4207 ;; `org-export-get-reference' associate a unique reference for any
4208 ;; object or element.
4209 ;;
4210 ;; `org-export-get-ordinal' associates a sequence number to any object
4211 ;; or element.
4214 "Return a unique reference for DATUM, as a string.
4215 DATUM is either an element or an object. INFO is the current
4216 export state, as a plist. Returned reference consists of
4217 alphanumeric characters only."
4222 h))))
4230 cache))))
4233 "Return ordinal number of an element or object.
4235 ELEMENT is the element or object considered. INFO is the plist
4236 used as a communication channel.
4238 Optional argument TYPES, when non-nil, is a list of element or
4239 object types, as symbols, that should also be counted in.
4240 Otherwise, only provided element's type is considered.
4242 Optional argument PREDICATE is a function returning a non-nil
4243 value if the current element or object should be counted in. It
4244 accepts two arguments: the element or object being considered and
4245 the plist used as a communication channel. This allows to count
4246 only a certain type of objects (i.e. inline images).
4248 Return value is a list of numbers if ELEMENT is a headline or an
4249 item. It is nil for keywords. It represents the footnote number
4250 for footnote definitions and footnote references. If ELEMENT is
4251 a target, return the same value as if ELEMENT was the closest
4252 table, item or headline containing the target. In any other
4253 case, return the sequence number of ELEMENT among elements or
4254 objects of the same type."
4255 ;; Ordinal of a target object refer to the ordinal of the closest
4256 ;; table, item, or headline containing the object.
4260 element
4263 ;; Special case 1: A headline returns its number as a list.
4265 ;; Special case 2: An item returns its number as a list.
4269 struct
4276 ;; Increment counter until ELEMENT is found again.
4287 ;;;; For Src-Blocks
4288 ;;
4289 ;; `org-export-get-loc' counts number of code lines accumulated in
4290 ;; src-block or example-block elements with a "+n" switch until
4291 ;; a given element, excluded. Note: "-n" switches reset that count.
4292 ;;
4293 ;; `org-export-unravel-code' extracts source code (along with a code
4294 ;; references alist) from an `element-block' or `src-block' type
4295 ;; element.
4296 ;;
4297 ;; `org-export-format-code' applies a formatting function to each line
4298 ;; of code, providing relative line number and code reference when
4299 ;; appropriate. Since it doesn't access the original element from
4300 ;; which the source code is coming, it expects from the code calling
4301 ;; it to know if lines should be numbered and if code references
4302 ;; should appear.
4303 ;;
4304 ;; Eventually, `org-export-format-code-default' is a higher-level
4305 ;; function (it makes use of the two previous functions) which handles
4306 ;; line numbering and code references inclusion, and returns source
4307 ;; code in a format suitable for plain text or verbatim output.
4310 "Return accumulated lines of code up to ELEMENT.
4312 INFO is the plist used as a communication channel.
4314 ELEMENT is excluded from count."
4320 ;; ELEMENT is reached: Quit the loop.
4322 ;; Only count lines from src-block and example-block elements
4323 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4327 ;; Accumulate locs or reset them.
4331 ;; Return nil to stay in the loop.
4332 nil)))
4334 ;; Return value.
4335 loc))
4338 "Clean source code and extract references out of it.
4340 ELEMENT has either a `src-block' an `example-block' type.
4342 Return a cons cell whose CAR is the source code, cleaned from any
4343 reference, protective commas and spurious indentation, and CDR is
4344 an alist between relative line number (integer) and name of code
4345 reference on that line (string)."
4348 ;; Get code and clean it. Remove blank lines at its
4349 ;; beginning and end.
4356 value
4358 ;; Get format used for references.
4361 org-coderef-label-format)))
4362 ;; Build a regexp matching a loc with a reference.
4367 ;; Return value.
4369 ;; Code with references removed.
4375 ;; Ref line: remove ref, and signal its position in REFS.
4379 ;; Reference alist.
4380 refs)))
4383 "Format CODE by applying FUN line-wise and return it.
4385 CODE is a string representing the code to format. FUN is
4386 a function. It must accept three arguments: a line of
4387 code (string), the current line number (integer) or nil and the
4388 reference associated to the current line (string) or nil.
4390 Optional argument NUM-LINES can be an integer representing the
4391 number of code lines accumulated until the current code. Line
4392 numbers passed to FUN will take it into account. If it is nil,
4393 FUN's second argument will always be nil. This number can be
4394 obtained with `org-export-get-loc' function.
4396 Optional argument REF-ALIST can be an alist between relative line
4397 number (i.e. ignoring NUM-LINES) and the name of the code
4398 reference on it. If it is nil, FUN's third argument will always
4399 be nil. It can be obtained through the use of
4400 `org-export-unravel-code' function."
4412 "Return source code from ELEMENT, formatted in a standard way.
4414 ELEMENT is either a `src-block' or `example-block' element. INFO
4415 is a plist used as a communication channel.
4417 This function takes care of line numbering and code references
4418 inclusion. Line numbers, when applicable, appear at the
4419 beginning of the line, separated from the code by two white
4420 spaces. Code references, on the other hand, appear flushed to
4421 the right, separated by six white spaces from the widest line of
4422 code."
4423 ;; Extract code and references.
4430 ;; Handle line numbering.
4439 ;; Prepare references display, if required. Any reference
4440 ;; should start six columns after the widest line of code,
4441 ;; wrapped with parenthesis.
4446 code
4450 number-str
4451 loc
4457 num-start refs)))))
4460 ;;;; For Tables
4461 ;;
4462 ;; `org-export-table-has-special-column-p' and and
4463 ;; `org-export-table-row-is-special-p' are predicates used to look for
4464 ;; meta-information about the table structure.
4465 ;;
4466 ;; `org-table-has-header-p' tells when the rows before the first rule
4467 ;; should be considered as table's header.
4468 ;;
4469 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4470 ;; and `org-export-table-cell-borders' extract information from
4471 ;; a table-cell element.
4472 ;;
4473 ;; `org-export-table-dimensions' gives the number on rows and columns
4474 ;; in the table, ignoring horizontal rules and special columns.
4475 ;; `org-export-table-cell-address', given a table-cell object, returns
4476 ;; the absolute address of a cell. On the other hand,
4477 ;; `org-export-get-table-cell-at' does the contrary.
4478 ;;
4479 ;; `org-export-table-cell-starts-colgroup-p',
4480 ;; `org-export-table-cell-ends-colgroup-p',
4481 ;; `org-export-table-row-starts-rowgroup-p',
4482 ;; `org-export-table-row-ends-rowgroup-p',
4483 ;; `org-export-table-row-starts-header-p',
4484 ;; `org-export-table-row-ends-header-p' and
4485 ;; `org-export-table-row-in-header-p' indicate position of current row
4486 ;; or cell within the table.
4489 "Non-nil when TABLE has a special column.
4490 All special columns will be ignored during export."
4491 ;; The table has a special column when every first cell of every row
4492 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4493 ;; "*" "_" and "^". Though, do not consider a first row containing
4494 ;; only empty cells as special.
4510 "Non-nil when TABLE has a header.
4512 INFO is a plist used as a communication channel.
4514 A table has a header when it contains at least two row groups."
4523 table
4534 cache)))))
4537 "Non-nil if TABLE-ROW is considered special.
4539 INFO is a plist used as the communication channel.
4541 All special rows will be ignored during export."
4545 ;; A row is special either when...
4547 ;; ... it starts with a field only containing "/",
4549 ;; ... the table contains a special column and the row start
4550 ;; with a marking character among, "^", "_", "$" or "!",
4554 ;; ... it contains only alignment cookies and empty cells.
4560 ;; Since VALUE is a secondary string, the following
4561 ;; checks avoid expanding it with `org-export-data'.
4573 "Return TABLE-ROW's group number, as an integer.
4575 INFO is a plist used as the communication channel.
4577 Return value is the group number, as an integer, or nil for
4578 special rows and rows separators. First group is also table's
4579 header."
4597 "Return TABLE-CELL contents width.
4599 INFO is a plist used as the communication channel.
4601 Return value is the width given by the last width cookie in the
4602 same column as TABLE-CELL, or nil."
4621 ;; In a special row, try to find a width cookie at COLUMN.
4625 ;; The following checks avoid expanding unnecessarily
4626 ;; the cell with `org-export-data'.
4636 "Return TABLE-CELL contents alignment.
4638 INFO is a plist used as the communication channel.
4640 Return alignment as specified by the last alignment cookie in the
4641 same column as TABLE-CELL. If no such cookie is found, a default
4642 alignment value will be deduced from fraction of numbers in the
4643 column (see `org-table-number-fraction' for more information).
4644 Possible values are `left', `right' and `center'."
4645 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4662 cookie-align
4663 previous-cell-number-p)
4666 ;; In a special row, try to find an alignment cookie at
4667 ;; COLUMN.
4671 ;; Since VALUE is a secondary string, the following
4672 ;; checks avoid useless expansion through
4673 ;; `org-export-data'.
4681 ;; Ignore table rules.
4683 ;; In a standard row, check if cell's contents are
4684 ;; expressing some kind of number. Increase NUMBER-CELLS
4685 ;; accordingly. Though, don't bother if an alignment
4686 ;; cookie has already defined cell's alignment.
4691 info)))
4693 ;; Treat an empty cell as a number if it follows
4694 ;; a number.
4700 ;; Return value. Alignment specified by cookies has
4701 ;; precedence over alignment deduced from cell's contents.
4703 column
4708 org-table-number-fraction)
4713 "Return TABLE-CELL borders.
4715 INFO is a plist used as a communication channel.
4717 Return value is a list of symbols, or nil. Possible values are:
4718 `top', `bottom', `above', `below', `left' and `right'. Note:
4719 `top' (resp. `bottom') only happen for a cell in the first
4720 row (resp. last row) of the table, ignoring table rules, if any.
4722 Returned borders ignore special rows."
4725 borders)
4726 ;; Top/above border? TABLE-CELL has a border above when a rule
4727 ;; used to demarcate row groups can be found above. Hence,
4728 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4729 ;; another regular row has to be found above that rule.
4738 ;; Look at every row before the current one.
4740 ;; No rule above, or rule found starts the table (ignoring any
4741 ;; special row): TABLE-CELL is at the top of the table.
4744 ;; Bottom/below border? TABLE-CELL has a border below when next
4745 ;; non-regular row below is a rule.
4754 ;; Look at every row after the current one.
4756 ;; No rule below, or rule found ends the table (modulo some
4757 ;; special row): TABLE-CELL is at the bottom of the table.
4760 ;; Right/left borders? They can only be specified by column
4761 ;; groups. Column groups are defined in a row starting with "/".
4762 ;; Also a column groups row only contains "<", "<>", ">" or blank
4763 ;; cells.
4780 ;; There's a left border when previous cell, if
4781 ;; any, ends a group, or current one starts one.
4787 ;; There's a right border when next cell, if any,
4788 ;; starts a group, or current one ends one.
4795 ;; Table rows are read in reverse order so last column groups
4796 ;; row has precedence over any previous one.
4798 ;; Return value.
4799 borders))
4802 "Non-nil when TABLE-CELL is at the beginning of a column group.
4803 INFO is a plist used as a communication channel."
4804 ;; A cell starts a column group either when it is at the beginning
4805 ;; of a row (or after the special column, if any) or when it has
4806 ;; a left border.
4809 table-cell)
4813 "Non-nil when TABLE-CELL is at the end of a column group.
4814 INFO is a plist used as a communication channel."
4815 ;; A cell ends a column group either when it is at the end of a row
4816 ;; or when it has a right border.
4819 table-cell)
4823 "Non-nil when TABLE-ROW is at the beginning of a row group.
4824 INFO is a plist used as a communication channel."
4832 "Non-nil when TABLE-ROW is at the end of a row group.
4833 INFO is a plist used as a communication channel."
4841 "Non-nil when TABLE-ROW is located within table's header.
4842 INFO is a plist used as a communication channel. Always return
4843 nil for special rows and rows separators."
4849 "Non-nil when TABLE-ROW is the first table header's row.
4850 INFO is a plist used as a communication channel."
4855 "Non-nil when TABLE-ROW is the last table header's row.
4856 INFO is a plist used as a communication channel."
4861 "Return TABLE-ROW number.
4862 INFO is a plist used as a communication channel. Return value is
4863 zero-based and ignores separators. The function returns nil for
4864 special columns and separators."
4876 "Return TABLE dimensions.
4878 INFO is a plist used as a communication channel.
4880 Return value is a CONS like (ROWS . COLUMNS) where
4881 ROWS (resp. COLUMNS) is the number of exportable
4882 rows (resp. columns)."
4884 ;; Set number of rows, and extract first one.
4890 ;; Set number of columns.
4892 ;; Return value.
4896 "Return address of a regular TABLE-CELL object.
4898 TABLE-CELL is the cell considered. INFO is a plist used as
4899 a communication channel.
4901 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4902 zero-based index. Only exportable cells are considered. The
4903 function returns nil for other cells."
4915 "Return regular table-cell object at ADDRESS in TABLE.
4917 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4918 zero-based index. TABLE is a table type element. INFO is
4919 a plist used as a communication channel.
4921 If no table-cell, among exportable cells, is found at ADDRESS,
4922 return nil."
4925 ;; Row at (car address) or nil.
4933 'table-cell
4940 ;;;; For Tables Of Contents
4941 ;;
4942 ;; `org-export-collect-headlines' builds a list of all exportable
4943 ;; headline elements, maybe limited to a certain depth. One can then
4944 ;; easily parse it and transcode it.
4945 ;;
4946 ;; Building lists of tables, figures or listings is quite similar.
4947 ;; Once the generic function `org-export-collect-elements' is defined,
4948 ;; `org-export-collect-tables', `org-export-collect-figures' and
4949 ;; `org-export-collect-listings' can be derived from it.
4952 "Collect headlines in order to build a table of contents.
4954 INFO is a plist used as a communication channel.
4956 When optional argument N is an integer, it specifies the depth of
4957 the table of contents. Otherwise, it is set to the value of the
4958 last headline level. See `org-export-headline-levels' for more
4959 information.
4961 Optional argument SCOPE, when non-nil, is an element. If it is
4962 a headline, only children of SCOPE are collected. Otherwise,
4963 collect children of the headline containing provided element. If
4964 there is no such headline, collect all headlines. In any case,
4965 argument N becomes relative to the level of that headline.
4967 Return a list of all exportable headlines as parsed elements.
4968 Footnote sections are ignored."
4977 limit))))
4983 info)))
4986 "Collect referenceable elements of a determined type.
4988 TYPE can be a symbol or a list of symbols specifying element
4989 types to search. Only elements with a caption are collected.
4991 INFO is a plist used as a communication channel.
4993 When non-nil, optional argument PREDICATE is a function accepting
4994 one argument, an element of type TYPE. It returns a non-nil
4995 value when that element should be collected.
4997 Return a list of all elements found, in order of appearance."
5002 element))
5003 info))
5006 "Build a list of tables.
5007 INFO is a plist used as a communication channel.
5009 Return a list of table elements with a caption."
5013 "Build a list of figures.
5015 INFO is a plist used as a communication channel. PREDICATE is
5016 a function which accepts one argument: a paragraph element and
5017 whose return value is non-nil when that element should be
5018 collected.
5020 A figure is a paragraph type element, with a caption, verifying
5022 a vague concept that may depend on back-end.
5024 Return a list of elements recognized as figures."
5028 "Build a list of src blocks.
5030 INFO is a plist used as a communication channel.
5032 Return a list of src-block elements with a caption."
5036 ;;;; Smart Quotes
5037 ;;
5038 ;; The main function for the smart quotes sub-system is
5039 ;; `org-export-activate-smart-quotes', which replaces every quote in
5040 ;; a given string from the parse tree with its "smart" counterpart.
5041 ;;
5042 ;; Dictionary for smart quotes is stored in
5043 ;; `org-export-smart-quotes-alist'.
5044 ;;
5045 ;; Internally, regexps matching potential smart quotes (checks at
5046 ;; string boundaries are also necessary) are defined in
5047 ;; `org-export-smart-quotes-regexps'.
5051 ;; one may use: »...«, "...", ›...‹, or '...'.
5052 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5053 ;; LaTeX quotes require Babel!
5098 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5107 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5116 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5125 ;; 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
5126 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5137 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5143 )
5144 "Smart quotes translations.
5146 Alist whose CAR is a language string and CDR is an alist with
5147 quote type as key and a plist associating various encodings to
5148 their translation as value.
5150 A quote type can be any symbol among `opening-double-quote',
5151 `closing-double-quote', `opening-single-quote',
5152 `closing-single-quote' and `apostrophe'.
5154 Valid encodings include `:utf-8', `:html', `:latex' and
5155 `:texinfo'.
5160 "Return smart quote status at the beginning of string S.
5161 INFO is the current export state, as a plist."
5166 table)))
5181 ;; Not already in a level 1 quote: this is an
5182 ;; apostrophe.
5184 ;; Apostrophe.
5186 ;; Apostrophe at the beginning of a string. Check
5187 ;; white space at the end of the last object.
5196 ;; Apostrophe at the end of a string. Check white
5197 ;; space at the beginning of the next object, which
5198 ;; can only happen if that object is a string.
5205 ;; Lonesome apostrophe. Check white space around
5206 ;; both ends.
5218 n))))))))
5220 ;; Else, consider it as a level 2 quote.
5224 current-status))
5227 info nil org-element-recursive-objects)
5234 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5235 `:utf-8'. INFO is a plist used as a communication channel.
5237 The function has to retrieve information about string
5238 surroundings in parse tree. It can only happen with an
5239 unmodified string. Thus, if S has already been through another
5240 process, a non-nil ORIGINAL optional argument will provide that
5241 original string.
5243 Return the new string."
5252 org-export-smart-quotes-alist))))
5253 encoding)
5254 match))
5255 s nil t)))
5257 ;;;; Topology
5258 ;;
5259 ;; Here are various functions to retrieve information about the
5260 ;; neighborhood of a given element or object. Neighbors of interest
5261 ;; are direct parent (`org-export-get-parent'), parent headline
5262 ;; (`org-export-get-parent-headline'), first element containing an
5263 ;; object, (`org-export-get-parent-element'), parent table
5264 ;; (`org-export-get-parent-table'), previous element or object
5265 ;; (`org-export-get-previous-element') and next element or object
5266 ;; (`org-export-get-next-element').
5268 ;; defsubst org-export-get-parent must be defined before first use
5274 "Return BLOB parent headline or nil.
5275 BLOB is the element or object being considered."
5279 "Return first element containing OBJECT or nil.
5280 OBJECT is the object to consider."
5284 "Return OBJECT parent table or nil.
5285 OBJECT is either a `table-cell' or `table-element' type object."
5289 "Return previous element or object.
5291 BLOB is an element or object. INFO is a plist used as
5292 a communication channel. Return previous exportable element or
5293 object, a string, or nil.
5295 When optional argument N is a positive integer, return a list
5296 containing up to N siblings before BLOB, from farthest to
5297 closest. With any other non-nil value, return a list containing
5298 all of them."
5304 prev)
5314 "Return next element or object.
5316 BLOB is an element or object. INFO is a plist used as
5317 a communication channel. Return next exportable element or
5318 object, a string, or nil.
5320 When optional argument N is a positive integer, return a list
5321 containing up to N siblings after BLOB, from closest to farthest.
5322 With any other non-nil value, return a list containing all of
5323 them."
5330 next)
5340 ;;;; Translation
5341 ;;
5342 ;; `org-export-translate' translates a string according to the language
5343 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5344 ;; the dictionary used for the translation.
5376 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5386 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5392 ("ru" :html "(Продолжение следует)"
5466 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5489 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5495 ("ru" :html "Список распечаток"
5509 ("ru" :html "Список таблиц"
5615 ("ru" :html "Неизвестная ссылка"
5618 "Dictionary for export engine.
5620 Alist whose car is the string to translate and cdr is an alist
5621 whose car is the language string and cdr is a plist whose
5622 properties are possible charsets and values translated terms.
5624 It is used as a database for `org-export-translate'. Since this
5625 function returns the string as-is if no translation was found,
5626 the variable only needs to record values different from the
5630 "Translate string S according to language specification.
5632 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5633 and `:utf-8'. INFO is a plist used as a communication channel.
5635 Translation depends on `:language' property. Return the
5636 translated string. If no translation is found, try to fall back
5637 to `:default' encoding. If it fails, return S."
5643 s)))
5646 \f
5647 ;;; Asynchronous Export
5648 ;;
5649 ;; `org-export-async-start' is the entry point for asynchronous
5650 ;; export. It recreates current buffer (including visibility,
5651 ;; narrowing and visited file) in an external Emacs process, and
5652 ;; evaluates a command there. It then applies a function on the
5653 ;; returned results in the current process.
5654 ;;
5655 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5656 ;; allow to export to a buffer or a file, asynchronously or not.
5657 ;;
5658 ;; `org-export-output-file-name' is an auxiliary function meant to be
5659 ;; used with `org-export-to-file'. With a given extension, it tries
5660 ;; to provide a canonical file name to write export output to.
5661 ;;
5662 ;; Asynchronously generated results are never displayed directly.
5663 ;; Instead, they are stored in `org-export-stack-contents'. They can
5664 ;; then be retrieved by calling `org-export-stack'.
5665 ;;
5666 ;; Export Stack is viewed through a dedicated major mode
5667 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5668 ;;`org-export-stack-delete', `org-export-stack-view' and
5669 ;;`org-export-stack-clear'.
5670 ;;
5671 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5672 ;; It should be used whenever `org-export-async-start' is called.
5675 "Call function FUN on the results returned by BODY evaluation.
5677 FUN is an anonymous function of one argument. BODY evaluation
5678 happens in an asynchronous process, from a buffer which is an
5679 exact copy of the current one.
5681 Use `org-export-add-to-stack' in FUN in order to register results
5682 in the stack.
5684 This is a low level function. See also `org-export-to-buffer'
5685 and `org-export-to-file' for more specialized functions."
5688 ;; Write the full sexp evaluating BODY in a copy of the current
5689 ;; buffer to a temporary file, as it may be too long for program
5690 ;; args in `start-process'.
5697 ;; Null characters (from variable values) are inserted
5698 ;; within the file. As a consequence, coding system for
5699 ;; buffer contents will not be recognized properly. So,
5700 ;; we make sure it is the same as the one used to display
5701 ;; the original buffer.
5703 ,coding
5706 ;; Ignore `kill-emacs-hook' and code evaluation
5707 ;; queries from Babel as we need a truly
5708 ;; non-interactive process.
5710 org-babel-confirm-evaluate-answer-no t)
5711 ;; Initialize export framework.
5713 ;; Re-create current buffer there.
5716 ;; Sexp to evaluate in the buffer.
5718 ;; Start external process.
5721 (,process
5723 #'start-process
5726 ,proc-buffer
5733 ;; Register running process in stack.
5735 ;; Set-up sentinel in order to catch results.
5738 ,process
5760 ;;;###autoload
5763 &optional async subtreep visible-only body-only ext-plist
5764 post-process)
5765 "Call `org-export-as' with output to a specified buffer.
5767 BACKEND is either an export back-end, as returned by, e.g.,
5768 `org-export-create-backend', or a symbol referring to
5769 a registered back-end.
5771 BUFFER is the name of the output buffer. If it already exists,
5772 it will be erased first, otherwise, it will be created.
5774 A non-nil optional argument ASYNC means the process should happen
5775 asynchronously. The resulting buffer should then be accessible
5776 through the `org-export-stack' interface. When ASYNC is nil, the
5777 buffer is displayed if `org-export-show-temporary-export-buffer'
5778 is non-nil.
5780 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5781 EXT-PLIST are similar to those used in `org-export-as', which
5782 see.
5784 Optional argument POST-PROCESS is a function which should accept
5785 no argument. It is always called within the current process,
5786 from BUFFER, with point at its beginning. Export back-ends can
5787 use it to set a major mode there, e.g,
5789 \(defun org-latex-export-as-latex
5790 \(&optional async subtreep visible-only body-only ext-plist)
5791 \(interactive)
5793 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5795 This function returns BUFFER."
5823 buffer)))
5825 ;;;###autoload
5828 post-process)
5829 "Call `org-export-as' with output to a specified file.
5831 BACKEND is either an export back-end, as returned by, e.g.,
5832 `org-export-create-backend', or a symbol referring to
5833 a registered back-end. FILE is the name of the output file, as
5834 a string.
5836 A non-nil optional argument ASYNC means the process should happen
5837 asynchronously. The resulting buffer will then be accessible
5838 through the `org-export-stack' interface.
5840 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5841 EXT-PLIST are similar to those used in `org-export-as', which
5842 see.
5844 Optional argument POST-PROCESS is called with FILE as its
5845 argument and happens asynchronously when ASYNC is non-nil. It
5846 has to return a file name, or nil. Export back-ends can use this
5847 to send the output file through additional processing, e.g,
5849 \(defun org-latex-export-to-latex
5850 \(&optional async subtreep visible-only body-only ext-plist)
5851 \(interactive)
5853 \(org-export-to-file 'latex outfile
5854 async subtreep visible-only body-only ext-plist
5855 \(lambda (file) (org-latex-compile file)))
5857 The function returns either a file name returned by POST-PROCESS,
5858 or FILE."
5877 backend subtreep visible-only body-only ext-plist)))
5884 ;; Get proper return value.
5886 file))))))
5889 "Return output file's name according to buffer specifications.
5891 EXTENSION is a string representing the output file extension,
5892 with the leading dot.
5894 With a non-nil optional argument SUBTREEP, try to determine
5896 of subtree at point.
5898 When optional argument PUB-DIR is set, use it as the publishing
5899 directory.
5901 When optional argument VISIBLE-ONLY is non-nil, don't export
5902 contents of hidden elements.
5904 Return file name as a string."
5907 ;; File name may come from EXPORT_FILE_NAME subtree
5908 ;; property, assuming point is at beginning of said
5909 ;; sub-tree.
5916 ;; File name may be extracted from buffer's associated
5917 ;; file, if any.
5919 ;; Can't determine file name on our own: Ask user.
5923 "Output file: " pub-dir nil nil nil
5927 ;; Build file name. Enforce EXTENSION over whatever user
5928 ;; may have come up with. PUB-DIR, if defined, always has
5929 ;; precedence over any provided path.
5934 extension))
5937 ;; If writing to OUTPUT-FILE would overwrite original file, append
5938 ;; EXTENSION another time to final name.
5941 output-file)))
5944 "Add a new result to export stack if not present already.
5946 SOURCE is a buffer or a file name containing export results.
5947 BACKEND is a symbol representing export back-end used to generate
5948 it.
5950 Entries already pointing to SOURCE and unavailable entries are
5951 removed beforehand. Return the new stack."
5957 "Menu for asynchronous export results and running processes."
5967 "Return source from export results at point in stack."
5974 source
5975 ;; SOURCE is not consistent with current line. The stack
5976 ;; view is outdated.
5980 "Remove all entries from export stack."
5985 "Refresh the asynchronous export stack.
5986 DUMMY is ignored. Unavailable sources are removed from the list.
5987 Return the new stack."
5997 ;; Back-end.
5999 ;; Age.
6002 ;; Compute age of the results.
6004 "%4h:%.2m "
6006 ;; Source.
6011 ;; Clear stack from exited processes, dead buffers or
6012 ;; non-existent files.
6024 "Remove export results at point from stack.
6025 If optional argument SOURCE is non-nil, remove it instead."
6030 org-export-stack-contents))))
6033 "View export results at point in stack.
6034 With an optional prefix argument IN-EMACS, force viewing files
6035 within Emacs."
6049 (define-key km "p" 'previous-line)
6050 (define-key km "\C-p" 'previous-line)
6051 (define-key km "\C-?" 'previous-line)
6052 (define-key km [up] 'previous-line)
6053 (define-key km "C" 'org-export-stack-clear)
6054 (define-key km "v" 'org-export-stack-view)
6055 (define-key km (kbd "RET") 'org-export-stack-view)
6056 (define-key km "d" 'org-export-stack-remove)
6057 km)
6058 "Keymap for Org Export Stack.")
6060 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6061 "Mode for displaying asynchronous export stack.
6064 stack.
6066 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6067 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6068 stack completely.
6070 Removing entries in an Org Export Stack buffer doesn't affect
6071 files or buffers, only the display.
6074 (abbrev-mode 0)
6075 (auto-fill-mode 0)
6076 (setq buffer-read-only t
6077 buffer-undo-list t
6078 truncate-lines t
6079 header-line-format
6080 '(:eval
6081 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6082 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6083 (set (make-local-variable 'revert-buffer-function)
6084 'org-export-stack-refresh))
6087 \f
6088 ;;; The Dispatcher
6089 ;;
6090 ;; `org-export-dispatch' is the standard interactive way to start an
6091 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6092 ;; for its interface, which, in turn, delegates response to key
6093 ;; pressed to `org-export--dispatch-action'.
6095 ;;;###autoload
6096 (defun org-export-dispatch (&optional arg)
6097 "Export dispatcher for Org mode.
6099 It provides an access to common export related tasks in a buffer.
6100 Its interface comes in two flavors: standard and expert.
6102 While both share the same set of bindings, only the former
6103 displays the valid keys associations in a dedicated buffer.
6104 Scrolling (resp. line-wise motion) in this buffer is done with
6105 SPC and DEL (resp. C-n and C-p) keys.
6107 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6108 flavor or the other.
6111 of options used back then, on the current buffer.
6113 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6114 (interactive "P")
6115 (let* ((input
6116 (cond ((equal arg '(16)) '(stack))
6117 ((and arg org-export-dispatch-last-action))
6118 (t (save-window-excursion
6119 (unwind-protect
6120 (progn
6121 ;; Remember where we are
6122 (move-marker org-export-dispatch-last-position
6123 (point)
6124 (org-base-buffer (current-buffer)))
6125 ;; Get and store an export command
6126 (setq org-export-dispatch-last-action
6127 (org-export--dispatch-ui
6128 (list org-export-initial-scope
6129 (and org-export-in-background 'async))
6130 nil
6131 org-export-dispatch-use-expert-ui)))
6132 (and (get-buffer "*Org Export Dispatcher*")
6133 (kill-buffer "*Org Export Dispatcher*")))))))
6134 (action (car input))
6135 (optns (cdr input)))
6136 (unless (memq 'subtree optns)
6137 (move-marker org-export-dispatch-last-position nil))
6138 (case action
6139 ;; First handle special hard-coded actions.
6140 (template (org-export-insert-default-template nil optns))
6141 (stack (org-export-stack))
6142 (publish-current-file
6143 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6144 (publish-current-project
6145 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6146 (publish-choose-project
6147 (org-publish (assoc (org-icompleting-read
6148 "Publish project: "
6149 org-publish-project-alist nil t)
6150 org-publish-project-alist)
6151 (memq 'force optns)
6152 (memq 'async optns)))
6153 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6154 (otherwise
6155 (save-excursion
6156 (when arg
6157 ;; Repeating command, maybe move cursor to restore subtree
6158 ;; context.
6159 (if (eq (marker-buffer org-export-dispatch-last-position)
6160 (org-base-buffer (current-buffer)))
6161 (goto-char org-export-dispatch-last-position)
6162 ;; We are in a different buffer, forget position.
6163 (move-marker org-export-dispatch-last-position nil)))
6164 (funcall action
6165 ;; Return a symbol instead of a list to ease
6166 ;; asynchronous export macro use.
6167 (and (memq 'async optns) t)
6168 (and (memq 'subtree optns) t)
6169 (and (memq 'visible optns) t)
6170 (and (memq 'body optns) t)))))))
6172 (defun org-export--dispatch-ui (options first-key expertp)
6173 "Handle interface for `org-export-dispatch'.
6175 OPTIONS is a list containing current interactive options set for
6176 export. It can contain any of the following symbols:
6177 `body' toggles a body-only export
6178 `subtree' restricts export to current subtree
6179 `visible' restricts export to visible part of buffer.
6180 `force' force publishing files.
6181 `async' use asynchronous export process
6183 FIRST-KEY is the key pressed to select the first level menu. It
6184 is nil when this menu hasn't been selected yet.
6186 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6187 buffer is provided, but indications about currently active
6188 options are given in the prompt. Moreover, \[?] allows to switch
6189 back to standard interface."
6190 (let* ((fontify-key
6191 (lambda (key &optional access-key)
6192 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6193 ;; non-nil is the required first-level key to activate
6194 ;; KEY. When its value is t, activate KEY independently
6195 ;; on the first key, if any. A nil value means KEY will
6196 ;; only be activated at first level.
6197 (if (or (eq access-key t) (eq access-key first-key))
6198 (org-propertize key 'face 'org-warning)
6199 key)))
6200 (fontify-value
6201 (lambda (value)
6202 ;; Fontify VALUE string.
6203 (org-propertize value 'face 'font-lock-variable-name-face)))
6204 ;; Prepare menu entries by extracting them from registered
6205 ;; back-ends and sorting them by access key and by ordinal,
6206 ;; if any.
6207 (entries
6208 (sort (sort (delq nil
6209 (mapcar #'org-export-backend-menu
6210 org-export-registered-backends))
6211 (lambda (a b)
6212 (let ((key-a (nth 1 a))
6213 (key-b (nth 1 b)))
6214 (cond ((and (numberp key-a) (numberp key-b))
6215 (< key-a key-b))
6216 ((numberp key-b) t)))))
6217 'car-less-than-car))
6218 ;; Compute a list of allowed keys based on the first key
6219 ;; pressed, if any. Some keys
6220 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6221 ;; available.
6222 (allowed-keys
6223 (nconc (list 2 22 19 6 1)
6224 (if (not first-key) (org-uniquify (mapcar 'car entries))
6225 (let (sub-menu)
6226 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6227 (when (eq (car entry) first-key)
6228 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6229 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6230 ((not first-key) (list ?P)))
6231 (list ?& ?#)
6232 (when expertp (list ??))
6233 (list ?q)))
6234 ;; Build the help menu for standard UI.
6235 (help
6236 (unless expertp
6237 (concat
6238 ;; Options are hard-coded.
6239 (format "[%s] Body only: %s [%s] Visible only: %s
6240 \[%s] Export scope: %s [%s] Force publishing: %s
6242 (funcall fontify-key "C-b" t)
6243 (funcall fontify-value
6244 (if (memq 'body options) "On " "Off"))
6245 (funcall fontify-key "C-v" t)
6246 (funcall fontify-value
6247 (if (memq 'visible options) "On " "Off"))
6248 (funcall fontify-key "C-s" t)
6249 (funcall fontify-value
6250 (if (memq 'subtree options) "Subtree" "Buffer "))
6251 (funcall fontify-key "C-f" t)
6252 (funcall fontify-value
6253 (if (memq 'force options) "On " "Off"))
6254 (funcall fontify-key "C-a" t)
6255 (funcall fontify-value
6256 (if (memq 'async options) "On " "Off")))
6257 ;; Display registered back-end entries. When a key
6258 ;; appears for the second time, do not create another
6259 ;; entry, but append its sub-menu to existing menu.
6260 (let (last-key)
6261 (mapconcat
6262 (lambda (entry)
6263 (let ((top-key (car entry)))
6264 (concat
6265 (unless (eq top-key last-key)
6266 (setq last-key top-key)
6268 (funcall fontify-key (char-to-string top-key))
6269 (nth 1 entry)))
6270 (let ((sub-menu (nth 2 entry)))
6271 (unless (functionp sub-menu)
6272 ;; Split sub-menu into two columns.
6273 (let ((index -1))
6274 (concat
6275 (mapconcat
6276 (lambda (sub-entry)
6277 (incf index)
6278 (format
6279 (if (zerop (mod index 2)) " [%s] %-26s"
6281 (funcall fontify-key
6282 (char-to-string (car sub-entry))
6283 top-key)
6284 (nth 1 sub-entry)))
6285 sub-menu "")
6287 entries ""))
6288 ;; Publishing menu is hard-coded.
6290 [%s] Current file [%s] Current project
6292 (funcall fontify-key "P")
6293 (funcall fontify-key "f" ?P)
6294 (funcall fontify-key "p" ?P)
6295 (funcall fontify-key "x" ?P)
6296 (funcall fontify-key "a" ?P))
6298 (funcall fontify-key "&" t)
6299 (funcall fontify-key "#" t))
6300 (format "[%s] %s"
6301 (funcall fontify-key "q" t)
6302 (if first-key "Main menu" "Exit")))))
6303 ;; Build prompts for both standard and expert UI.
6304 (standard-prompt (unless expertp "Export command: "))
6305 (expert-prompt
6306 (when expertp
6307 (format
6308 "Export command (C-%s%s%s%s%s) [%s]: "
6309 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6310 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6311 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6312 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6313 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6314 (mapconcat (lambda (k)
6315 ;; Strip control characters.
6316 (unless (< k 27) (char-to-string k)))
6317 allowed-keys "")))))
6318 ;; With expert UI, just read key with a fancy prompt. In standard
6319 ;; UI, display an intrusive help buffer.
6320 (if expertp
6321 (org-export--dispatch-action
6322 expert-prompt allowed-keys entries options first-key expertp)
6323 ;; At first call, create frame layout in order to display menu.
6324 (unless (get-buffer "*Org Export Dispatcher*")
6325 (delete-other-windows)
6326 (org-switch-to-buffer-other-window
6327 (get-buffer-create "*Org Export Dispatcher*"))
6328 (setq cursor-type nil
6329 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6330 ;; Make sure that invisible cursor will not highlight square
6331 ;; brackets.
6332 (set-syntax-table (copy-syntax-table))
6333 (modify-syntax-entry ?\[ "w"))
6334 ;; At this point, the buffer containing the menu exists and is
6335 ;; visible in the current window. So, refresh it.
6336 (with-current-buffer "*Org Export Dispatcher*"
6337 ;; Refresh help. Maintain display continuity by re-visiting
6338 ;; previous window position.
6339 (let ((pos (window-start)))
6340 (erase-buffer)
6341 (insert help)
6342 (set-window-start nil pos)))
6343 (org-fit-window-to-buffer)
6344 (org-export--dispatch-action
6345 standard-prompt allowed-keys entries options first-key expertp))))
6347 (defun org-export--dispatch-action
6348 (prompt allowed-keys entries options first-key expertp)
6349 "Read a character from command input and act accordingly.
6351 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6352 a list of characters available at a given step in the process.
6353 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6354 EXPERTP are the same as defined in `org-export--dispatch-ui',
6355 which see.
6357 Toggle export options when required. Otherwise, return value is
6358 a list with action as CAR and a list of interactive export
6359 options as CDR."
6360 (let (key)
6361 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6362 ;; C-p, SPC, DEL).
6363 (while (and (setq key (read-char-exclusive prompt))
6364 (not expertp)
6365 (memq key '(14 16 ?\s ?\d)))
6366 (case key
6367 (14 (if (not (pos-visible-in-window-p (point-max)))
6368 (ignore-errors (scroll-up 1))
6369 (message "End of buffer")
6370 (sit-for 1)))
6371 (16 (if (not (pos-visible-in-window-p (point-min)))
6372 (ignore-errors (scroll-down 1))
6373 (message "Beginning of buffer")
6374 (sit-for 1)))
6375 (?\s (if (not (pos-visible-in-window-p (point-max)))
6376 (scroll-up nil)
6377 (message "End of buffer")
6378 (sit-for 1)))
6379 (?\d (if (not (pos-visible-in-window-p (point-min)))
6380 (scroll-down nil)
6381 (message "Beginning of buffer")
6382 (sit-for 1)))))
6383 (cond
6384 ;; Ignore undefined associations.
6385 ((not (memq key allowed-keys))
6386 (ding)
6387 (unless expertp (message "Invalid key") (sit-for 1))
6388 (org-export--dispatch-ui options first-key expertp))
6389 ;; q key at first level aborts export. At second level, cancel
6390 ;; first key instead.
6391 ((eq key ?q) (if (not first-key) (error "Export aborted")
6392 (org-export--dispatch-ui options nil expertp)))
6393 ;; Help key: Switch back to standard interface if expert UI was
6394 ;; active.
6395 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6396 ;; Send request for template insertion along with export scope.
6397 ((eq key ?#) (cons 'template (memq 'subtree options)))
6398 ;; Switch to asynchronous export stack.
6399 ((eq key ?&) '(stack))
6400 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6401 ((memq key '(2 22 19 6 1))
6402 (org-export--dispatch-ui
6403 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6404 (6 'force) (1 'async))))
6405 (if (memq option options) (remq option options)
6406 (cons option options)))
6407 first-key expertp))
6408 ;; Action selected: Send key and options back to
6409 ;; `org-export-dispatch'.
6410 ((or first-key (functionp (nth 2 (assq key entries))))
6411 (cons (cond
6412 ((not first-key) (nth 2 (assq key entries)))
6413 ;; Publishing actions are hard-coded. Send a special
6414 ;; signal to `org-export-dispatch'.
6415 ((eq first-key ?P)
6416 (case key
6417 (?f 'publish-current-file)
6418 (?p 'publish-current-project)
6419 (?x 'publish-choose-project)
6420 (?a 'publish-all)))
6421 ;; Return first action associated to FIRST-KEY + KEY
6422 ;; path. Indeed, derived backends can share the same
6423 ;; FIRST-KEY.
6424 (t (catch 'found
6425 (mapc (lambda (entry)
6426 (let ((match (assq key (nth 2 entry))))
6427 (when match (throw 'found (nth 2 match)))))
6428 (member (assq first-key entries) entries)))))
6429 options))
6430 ;; Otherwise, enter sub-menu.
6431 (t (org-export--dispatch-ui options key expertp)))))
6435 (provide 'ox)
6437 ;; Local variables:
6438 ;; generated-autoload-file: "org-loaddefs.el"
6439 ;; End:
6441 ;;; ox.el ends here