| blob | 42f7c068e9ba4443945292d303e2e4a1c531cd8f |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
90 \f
91 ;;; Internal Variables
92 ;;
93 ;; Among internal variables, the most important is
94 ;; `org-export-options-alist'. This variable define the global export
95 ;; options, shared between every exporter, and how they are acquired.
141 "Alist between export properties and ways to set them.
143 The CAR of the alist is the property name, and the CDR is a list
144 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
146 KEYWORD is a string representing a buffer keyword, or nil. Each
147 property defined this way can also be set, during subtree
148 export, through a headline property named after the keyword
150 property).
151 OPTION is a string that could be found in an #+OPTIONS: line.
152 DEFAULT is the default value for the property.
153 BEHAVIOR determines how Org should handle multiple keywords for
154 the same property. It is a symbol among:
155 nil Keep old value and discard the new one.
156 t Replace old value with the new one.
157 `space' Concatenate the values, separating them with a space.
158 `newline' Concatenate the values, separating them with
159 a newline.
160 `split' Split values at white spaces, and cons them to the
161 previous list.
163 Values set through KEYWORD and OPTION have precedence over
164 DEFAULT.
166 All these properties should be back-end agnostic. Back-end
167 specific properties are set through `org-export-define-backend'.
171 "List of in-buffer keywords that require special treatment.
172 These keywords are not directly associated to a property. The
173 way they are handled must be hard-coded into
233 "Alist between filters properties and initial values.
235 The key of each association is a property name accessible through
236 the communication channel. Its value is a configurable global
237 variable defining initial filters.
239 This list is meant to install user specified filters. Back-end
240 developers may install their own filters using
241 `org-export-define-backend'. Filters defined there will always
242 be prepended to the current list, so they always get applied
251 "Default rule for link matching an inline image.
252 This rule applies to links with no description. By default, it
253 will be considered as an inline image if it targets a local file
256 See `org-export-inline-image-p' for more information about
261 org-element--cache org-element--cache-objects org-element--cache-sync-keys
262 org-element--cache-sync-requests org-element--cache-sync-timer)
263 "List of variables not copied through upon buffer duplication.
264 Export process takes place on a copy of the original buffer.
265 When this copy is created, all Org related local variables not in
266 this list are copied to the new buffer. Variables with an
270 "Non-nil means asynchronous export process should leave data behind.
274 located in `temporary-file-directory'.
276 When non-nil, it will also set `debug-on-error' to a non-nil
280 "Record asynchronously generated export results and processes.
281 This is an alist: its CAR is the source of the
282 result (destination file or buffer for a finished process,
283 original buffer for a running one) and its CDR is a list
284 containing the back-end used, as a symbol, and either a process
285 or the time at which it finished. It is used to build the menu
289 "List of backends currently available in the exporter.
290 This variable is set with `org-export-define-backend' and
294 "Last command called from the dispatcher.
295 The value should be a list. Its CAR is the action, as a symbol,
299 "The position where the last export command was created using the dispatcher.
300 This marker will be used with `C-u C-c C-e' to make sure export repetition
303 ;; For compatibility with Org < 8
305 "Name, if any, of the back-end used during an export process.
307 Its value is a symbol such as `html', `latex', `ascii', or nil if
308 the back-end is anonymous (see `org-export-create-backend') or if
309 there is no export process in progress.
311 It can be used to teach Babel blocks how to act differently
315 \f
316 ;;; User-configurable Variables
317 ;;
318 ;; Configuration for the masses.
319 ;;
320 ;; They should never be accessed directly, as their value is to be
321 ;; stored in a property list (cf. `org-export-options-alist').
322 ;; Back-ends will read their value from there instead.
325 "Options for exporting Org mode files."
330 "General options for export engine."
335 "Whether sub-trees with the ARCHIVE tag should be exported.
337 This can have three different values:
338 nil Do not export, pretend this tree is not present.
339 t Do export the entire tree.
340 `headline' Only export the headline, but skip the tree below it.
342 This option can also be set with the OPTIONS keyword,
351 "Non-nil means insert author name into the exported file.
352 This option can also be set with the OPTIONS keyword,
358 "Non-nil means export CLOCK keywords.
359 This option can also be set with the OPTIONS keyword,
365 "Non-nil means the postamble should contain a creator sentence.
367 The sentence can be set in `org-export-creator-string' and
370 If the value is `comment' insert it as a comment."
378 "Non-nil means insert date in the exported document.
379 This option can also be set with the OPTIONS keyword,
385 "Time-stamp format string to use for DATE keyword.
387 The format string, when specified, only applies if date consists
388 in a single time-stamp. Otherwise its value will be ignored.
390 See `format-time-string' for details on how to build this
391 string."
399 emacs-version
401 "Information about the creator of the document.
402 This option can also be set on with the CREATOR keyword."
407 "Non-nil means export contents of standard drawers.
409 When t, all drawers are exported. This may also be a list of
410 drawer names to export, as strings. If that list starts with
411 `not', only drawers with such names will be ignored.
413 This variable doesn't apply to properties drawers. See
414 `org-export-with-properties' instead.
416 This option can also be set with the OPTIONS keyword,
429 :inline t
433 "Non-nil means insert author email into the exported file.
434 This option can also be set with the OPTIONS keyword,
440 "Non-nil means interpret *word*, /word/, _word_ and +word+.
442 If the export target supports emphasizing text, the word will be
443 typeset in bold, italic, with an underline or strike-through,
444 respectively.
446 This option can also be set with the OPTIONS keyword,
452 "Tags that exclude a tree from export.
454 All trees carrying any of these tags will be excluded from
455 export. This is without condition, so even subtrees inside that
456 carry one of the `org-export-select-tags' will be removed.
458 This option can also be set with the EXCLUDE_TAGS keyword."
464 This option can also be set with the OPTIONS keyword,
472 "Non-nil means Org footnotes should be exported.
473 This option can also be set with the OPTIONS keyword,
479 "Non-nil means process LaTeX environments and fragments.
481 This option can also be set with the OPTIONS line,
484 nil Ignore math snippets.
485 `verbatim' Keep everything in verbatim.
486 t Allow export of math snippets."
496 "The last level which is still exported as a headline.
498 Inferior levels will usually produce itemize or enumerate lists
499 when exported, but back-end behaviour may differ.
501 This option can also be set with the OPTIONS keyword,
507 "The default language for export and clocktable translations, as a string.
508 This may have an association in
509 `org-clock-clocktable-language-setup',
510 `org-export-smart-quotes-alist' and `org-export-dictionary'.
511 This option can also be set with the LANGUAGE keyword."
516 "Non-nil means preserve all line breaks when exporting.
517 This option can also be set with the OPTIONS keyword,
523 "Non-nil means interpret entities when exporting.
526 Å.
528 For a list of supported names, see the constant `org-entities'
529 and the user option `org-entities-user'.
531 This option can also be set with the OPTIONS keyword,
537 "Non-nil means inlinetasks should be exported.
538 This option can also be set with the OPTIONS keyword,
546 "Non-nil means include planning info in export.
548 Planning info is the line containing either SCHEDULED:,
549 DEADLINE:, CLOSED: time-stamps, or a combination of them.
551 This option can also be set with the OPTIONS keyword,
559 "Non-nil means include priority cookies in export.
560 This option can also be set with the OPTIONS keyword,
566 "Non-nil means export contents of properties drawers.
568 When t, all properties are exported. This may also be a list of
569 properties to export, as strings.
571 This option can also be set with the OPTIONS keyword,
583 "Non-nil means add section numbers to headlines when exporting.
585 When set to an integer n, numbering will only happen for
586 headlines whose relative level is higher or equal to n.
588 This option can also be set with the OPTIONS keyword,
594 "Tags that select a tree for export.
596 If any such tag is found in a buffer, all trees that do not carry
597 one of these tags will be ignored during export. Inside trees
598 that are selected like this, you can still deselect a subtree by
599 tagging it with one of the `org-export-exclude-tags'.
601 This option can also be set with the SELECT_TAGS keyword."
606 "Non-nil means activate smart quotes during export.
607 This option can also be set with the OPTIONS keyword,
610 When setting this to non-nil, you need to take care of
611 using the correct Babel package when exporting to LaTeX.
612 E.g., you can load Babel for french like this:
623 When this option is turned on, these strings will be exported as:
625 Org HTML LaTeX UTF-8
626 -----+----------+--------+-------
628 -- – -- –
629 --- — --- —
632 This option can also be set with the OPTIONS keyword,
638 "Non-nil means include statistics cookies in export.
639 This option can also be set with the OPTIONS keyword,
649 If you want to control how Org displays those characters, see
650 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
651 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
652 it is not anymore.
654 When this option is turned on, you can use TeX-like syntax for
655 sub- and superscripts and see them exported correctly.
657 You can also set the option with #+OPTIONS: ^:t
660 single item - so grouping with {} is normally not needed. For
661 example, the following things will be parsed as single sub- or
662 superscripts:
664 10^24 or 10^tau several digits will be considered 1 item.
665 10^-12 or 10^-tau a leading sign with digits or a word
666 x^2-y^3 will be read as x^2 - y^3, because items are
667 terminated by almost any nonword/nondigit char.
668 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
670 Still, ambiguity is possible. So when in doubt, use {} to enclose
671 the sub/superscript. If you set this variable to the symbol `{}',
672 the braces are *required* in order to trigger interpretations as
674 frequently in plain text."
684 "Non-nil means create a table of contents in exported files.
686 The TOC contains headlines with levels up
687 to`org-export-headline-levels'. When an integer, include levels
688 up to N in the toc, this may then be different from
689 `org-export-headline-levels', but it will not be allowed to be
690 larger than the number of headline levels. When nil, no table of
691 contents is made.
693 This option can also be set with the OPTIONS keyword,
702 "Non-nil means export tables.
703 This option can also be set with the OPTIONS keyword,
711 "If nil, do not export tags, just remove them from headlines.
713 If this is the symbol `not-in-toc', tags will be removed from
714 table of contents entries, but still be shown in the headlines of
715 the document.
717 This option can also be set with the OPTIONS keyword,
726 "Non-nil means include TODO items for export.
728 This may have the following values:
729 t include tasks independent of state.
730 `todo' include only tasks that are not yet done.
731 `done' include only tasks that are already done.
732 nil ignore all tasks.
733 list of keywords include tasks with these keywords.
735 This option can also be set with the OPTIONS keyword,
747 "Non-nil means insert a time stamp into the exported file.
748 The time stamp shows when the file was created. This option can
754 "Non nil means allow timestamps in export.
756 It can be set to any of the following values:
757 t export all timestamps.
758 `active' export active timestamps only.
759 `inactive' export inactive timestamps only.
760 nil do not export timestamps
762 This only applies to timestamps isolated in a paragraph
763 containing only timestamps. Other timestamps are always
764 exported.
766 This option can also be set with the OPTIONS keyword, e.g.
776 "Non-nil means include TODO keywords in export.
777 When nil, remove all these keywords from the export. This option
783 "Non-nil means BIND keywords can define local variable values.
784 This is a potential security risk, which is why the default value
785 is nil. You can also allow them through local buffer variables."
792 "Alist between export snippets back-ends and exporter back-ends.
794 This variable allows to provide shortcuts for export snippets.
798 HTML code while every other back-end will ignore it."
807 "Coding system for the exported file."
814 "Non-nil means pushing export output to the kill ring.
815 This variable is ignored during asynchronous export."
825 "The initial scope when exporting with `org-export-dispatch'.
826 This variable can be either set to `buffer' or `subtree'."
833 "Non-nil means show buffer after exporting to temp buffer.
834 When Org exports to a file, the buffer visiting that file is never
835 shown, but remains buried. However, when exporting to
836 a temporary buffer, that buffer is popped up in a second window.
837 When this variable is nil, the buffer remains buried also in
838 these cases."
843 "Non-nil means export and publishing commands will run in background.
844 Results from an asynchronous export are never displayed
852 "File used to initialize external export process.
854 Value must be either nil or an absolute file name. When nil, the
855 external process is launched like a regular Emacs session,
856 loading user's initialization file and any site specific
857 configuration. If a file is provided, it, and only it, is loaded
858 at start-up.
860 Therefore, using a specific configuration makes the process to
861 load faster and the export more portable."
870 "Non-nil means using a non-intrusive `org-export-dispatch'.
871 In that case, no help buffer is displayed. Though, an indicator
877 asynchronous). Also, \[?] allows to switch back to standard
878 mode."
885 \f
886 ;;; Defining Back-ends
887 ;;
888 ;; An export back-end is a structure with `org-export-backend' type
889 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
890 ;; and `menu' slots.
891 ;;
892 ;; At the lowest level, a back-end is created with
893 ;; `org-export-create-backend' function.
894 ;;
895 ;; A named back-end can be registered with
896 ;; `org-export-register-backend' function. A registered back-end can
897 ;; later be referred to by its name, with `org-export-get-backend'
898 ;; function. Also, such a back-end can become the parent of a derived
899 ;; back-end from which slot values will be inherited by default.
900 ;; `org-export-derived-backend-p' can check if a given back-end is
901 ;; derived from a list of back-end names.
902 ;;
903 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
904 ;; `org-export-get-all-filters' return the full alist of transcoders,
905 ;; options and filters, including those inherited from ancestors.
906 ;;
907 ;; At a higher level, `org-export-define-backend' is the standard way
908 ;; to define an export back-end. If the new back-end is similar to
909 ;; a registered back-end, `org-export-define-derived-backend' may be
910 ;; used instead.
911 ;;
912 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
913 ;; when a given back-end hasn't been registered yet.
917 name parent transcoders options filters blocks menu)
920 "Return export back-end named after NAME.
921 NAME is a symbol. Return nil if no such back-end is found."
928 "Register BACKEND as a known export back-end.
929 BACKEND is a structure with `org-export-backend' type."
930 ;; Refuse to register an unnamed back-end.
933 ;; Refuse to register a back-end with an unknown parent.
937 ;; Register dedicated export blocks in the parser.
941 ;; If a back-end with the same name as BACKEND is already
942 ;; registered, replace it with BACKEND. Otherwise, simply add
943 ;; BACKEND to the list of registered back-ends.
949 "Signal an error if BACKEND isn't defined."
954 "Non-nil if BACKEND is derived from one of BACKENDS.
955 BACKEND is an export back-end, as returned by, e.g.,
956 `org-export-create-backend', or a symbol referring to
957 a registered back-end. BACKENDS is constituted of symbols."
969 "Return full translation table for BACKEND.
971 BACKEND is an export back-end, as return by, e.g,,
972 `org-export-create-backend'. Return value is an alist where
973 keys are element or object types, as symbols, and values are
974 transcoders.
976 Unlike to `org-export-backend-transcoders', this function
977 also returns transcoders inherited from parent back-ends,
978 if any."
982 parent)
987 transcoders)))
990 "Return export options for BACKEND.
992 BACKEND is an export back-end, as return by, e.g,,
993 `org-export-create-backend'. See `org-export-options-alist'
994 for the shape of the return value.
996 Unlike to `org-export-backend-options', this function also
997 returns options inherited from parent back-ends, if any."
1001 parent)
1005 options)))
1008 "Return complete list of filters for BACKEND.
1010 BACKEND is an export back-end, as return by, e.g,,
1011 `org-export-create-backend'. Return value is an alist where
1012 keys are symbols and values lists of functions.
1014 Unlike to `org-export-backend-filters', this function also
1015 returns filters inherited from parent back-ends, if any."
1019 parent)
1023 filters)))
1026 "Define a new back-end BACKEND.
1028 TRANSCODERS is an alist between object or element types and
1029 functions handling them.
1031 These functions should return a string without any trailing
1032 space, or nil. They must accept three arguments: the object or
1033 element itself, its contents or nil when it isn't recursive and
1034 the property list used as a communication channel.
1036 Contents, when not nil, are stripped from any global indentation
1037 \(although the relative one is preserved). They also always end
1038 with a single newline character.
1040 If, for a given type, no function is found, that element or
1041 object type will simply be ignored, along with any blank line or
1042 white space at its end. The same will happen if the function
1043 returns the nil value. If that function returns the empty
1044 string, the type will be ignored, but the blank lines or white
1045 spaces will be kept.
1047 In addition to element and object types, one function can be
1048 associated to the `template' (or `inner-template') symbol and
1049 another one to the `plain-text' symbol.
1051 The former returns the final transcoded string, and can be used
1052 to add a preamble and a postamble to document's body. It must
1053 accept two arguments: the transcoded string and the property list
1054 containing export options. A function associated to `template'
1056 A function associated to `inner-template' is always applied.
1058 The latter, when defined, is to be called on every text not
1059 recognized as an element or an object. It must accept two
1060 arguments: the text string and the information channel. It is an
1061 appropriate place to protect special chars relative to the
1062 back-end.
1064 BODY can start with pre-defined keyword arguments. The following
1065 keywords are understood:
1067 :export-block
1069 String, or list of strings, representing block names that
1070 will not be parsed. This is used to specify blocks that will
1071 contain raw code specific to the back-end. These blocks
1072 still have to be handled by the relative `export-block' type
1073 translator.
1075 :filters-alist
1077 Alist between filters and function, or list of functions,
1078 specific to the back-end. See `org-export-filters-alist' for
1079 a list of all allowed filters. Filters defined here
1080 shouldn't make a back-end test, as it may prevent back-ends
1081 derived from this one to behave properly.
1083 :menu-entry
1085 Menu entry for the export dispatcher. It should be a list
1086 like:
1088 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1090 where :
1092 KEY is a free character selecting the back-end.
1094 DESCRIPTION-OR-ORDINAL is either a string or a number.
1096 If it is a string, is will be used to name the back-end in
1097 its menu entry. If it is a number, the following menu will
1098 be displayed as a sub-menu of the back-end with the same
1099 KEY. Also, the number will be used to determine in which
1100 order such sub-menus will appear (lowest first).
1102 ACTION-OR-MENU is either a function or an alist.
1104 If it is an action, it will be called with four
1105 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1106 BODY-ONLY. See `org-export-as' for further explanations on
1107 some of them.
1109 If it is an alist, associations should follow the
1110 pattern:
1112 '(KEY DESCRIPTION ACTION)
1114 where KEY, DESCRIPTION and ACTION are described above.
1116 Valid values include:
1120 or
1125 \(lambda (a s v b)
1126 \(if a (org-latex-export-to-pdf t s v b)
1127 \(org-open-file
1128 \(org-latex-export-to-pdf nil s v b)))))))
1130 or the following, which will be added to the previous
1131 sub-menu,
1133 '(?l 1
1137 :options-alist
1139 Alist between back-end specific properties introduced in
1140 communication channel and how their value are acquired. See
1141 `org-export-options-alist' for more information about
1142 structure of the values."
1157 :transcoders transcoders
1158 :options options
1159 :filters filters
1160 :blocks blocks
1164 "Create a new back-end as a variant of an existing one.
1166 CHILD is the name of the derived back-end. PARENT is the name of
1167 the parent back-end.
1169 BODY can start with pre-defined keyword arguments. The following
1170 keywords are understood:
1172 :export-block
1174 String, or list of strings, representing block names that
1175 will not be parsed. This is used to specify blocks that will
1176 contain raw code specific to the back-end. These blocks
1177 still have to be handled by the relative `export-block' type
1178 translator.
1180 :filters-alist
1182 Alist of filters that will overwrite or complete filters
1183 defined in PARENT back-end. See `org-export-filters-alist'
1184 for a list of allowed filters.
1186 :menu-entry
1188 Menu entry for the export dispatcher. See
1189 `org-export-define-backend' for more information about the
1190 expected value.
1192 :options-alist
1194 Alist of back-end specific properties that will overwrite or
1195 complete those defined in PARENT back-end. Refer to
1196 `org-export-options-alist' for more information about
1197 structure of the values.
1199 :translate-alist
1201 Alist of element and object types and transcoders that will
1202 overwrite or complete transcode table from PARENT back-end.
1203 Refer to `org-export-define-backend' for detailed information
1204 about transcoders.
1207 as a variant of `latex' back-end with a custom template function:
1209 \(org-export-define-derived-backend 'my-latex 'latex
1210 :translate-alist '((template . my-latex-template-fun)))
1212 The back-end could then be called with, for example:
1230 :parent parent
1231 :transcoders transcoders
1232 :options options
1233 :filters filters
1234 :blocks blocks
1238 \f
1239 ;;; The Communication Channel
1240 ;;
1241 ;; During export process, every function has access to a number of
1242 ;; properties. They are of two types:
1243 ;;
1244 ;; 1. Environment options are collected once at the very beginning of
1245 ;; the process, out of the original buffer and configuration.
1246 ;; Collecting them is handled by `org-export-get-environment'
1247 ;; function.
1248 ;;
1249 ;; Most environment options are defined through the
1250 ;; `org-export-options-alist' variable.
1251 ;;
1252 ;; 2. Tree properties are extracted directly from the parsed tree,
1253 ;; just before export, by `org-export-collect-tree-properties'.
1255 ;;;; Environment Options
1256 ;;
1257 ;; Environment options encompass all parameters defined outside the
1258 ;; scope of the parsed data. They come from five sources, in
1259 ;; increasing precedence order:
1260 ;;
1261 ;; - Global variables,
1262 ;; - Buffer's attributes,
1263 ;; - Options keyword symbols,
1264 ;; - Buffer keywords,
1265 ;; - Subtree properties.
1266 ;;
1267 ;; The central internal function with regards to environment options
1268 ;; is `org-export-get-environment'. It updates global variables with
1269 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1270 ;; the different sources.
1271 ;;
1272 ;; The internal functions doing the retrieval are:
1273 ;; `org-export--get-global-options',
1274 ;; `org-export--get-buffer-attributes',
1275 ;; `org-export--parse-option-keyword',
1276 ;; `org-export--get-subtree-options' and
1277 ;; `org-export--get-inbuffer-options'
1278 ;;
1279 ;; Also, `org-export--list-bound-variables' collects bound variables
1280 ;; along with their value in order to set them as buffer local
1281 ;; variables later in the process.
1284 "Collect export options from the current buffer.
1286 Optional argument BACKEND is an export back-end, as returned by
1287 `org-export-create-backend'.
1289 When optional argument SUBTREEP is non-nil, assume the export is
1290 done against the current sub-tree.
1292 Third optional argument EXT-PLIST is a property list with
1293 external parameters overriding Org default settings, but still
1294 inferior to file-local settings."
1295 ;; First install #+BIND variables since these must be set before
1296 ;; global options are read.
1299 ;; Get and prioritize export options...
1301 ;; ... from global variables...
1303 ;; ... from an external property list...
1304 ext-plist
1305 ;; ... from in-buffer settings...
1307 ;; ... and from subtree, when appropriate.
1309 ;; Eventually add misc. properties.
1311 :back-end
1312 backend
1314 :footnote-definition-alist
1315 ;; Footnotes definitions must be collected in the original
1316 ;; buffer, as there's no insurance that they will still be in
1317 ;; the parse tree, due to possible narrowing.
1333 alist))
1345 alist)))))))
1346 alist))
1347 :id-alist
1348 ;; Collect id references.
1359 alist))))
1362 "Parse an OPTIONS line and return values as a plist.
1363 Optional argument BACKEND is an export back-end, as returned by,
1364 e.g., `org-export-create-backend'. It specifies which back-end
1365 specific items to read, if any."
1367 ;; Priority is given to back-end specific options.
1369 org-export-options-alist))
1370 plist)
1379 options))
1381 property
1384 plist))
1387 "Get export options in subtree at point.
1388 Optional argument BACKEND is an export back-end, as returned by,
1389 e.g., `org-export-create-backend'. It specifies back-end used
1390 for export. Return options as a plist."
1391 ;; For each buffer keyword, create a headline property setting the
1392 ;; same property in communication channel. The name for the property
1393 ;; is the keyword with "EXPORT_" appended to it.
1396 ;; Make sure point is at a heading.
1398 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1399 ;; title (with no todo keyword, priority cookie or tag) as its
1400 ;; fallback value.
1406 plist :title
1409 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1413 ;; Handle other keywords. TITLE keyword is excluded as it has
1414 ;; been handled already.
1422 ;; Export properties are not case-sensitive.
1429 plist
1430 property
1432 ;; Parse VALUE if required.
1436 ;; If BEHAVIOR is `split' expected value is
1437 ;; a list of strings, not a string.
1440 ;; Look for both general keywords and back-end specific
1441 ;; options, with priority given to the latter.
1443 org-export-options-alist)))
1444 ;; Return value.
1445 plist)))
1448 "Return current buffer export options, as a plist.
1450 Optional argument BACKEND, when non-nil, is an export back-end,
1451 as returned by, e.g., `org-export-create-backend'. It specifies
1452 which back-end specific options should also be read in the
1453 process.
1455 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1457 get-options ; For byte-compiler.
1460 ;; Priority is given to back-end specific options.
1462 org-export-options-alist))
1465 org-export-special-keywords))))
1468 ;; Return all properties associated to KEYWORD.
1475 ;; Recursively read keywords in buffer. FILES is a list
1476 ;; of files read so far. PLIST is the current property
1477 ;; list obtained.
1486 ;; Options in `org-export-special-keywords'.
1490 ;; Avoid circular dependencies.
1500 plist
1505 plist
1511 ;; Options in `org-export-options-alist'.
1516 plist property
1517 ;; Handle value depending on specified
1518 ;; BEHAVIOR.
1524 " "
1537 ;; Return final value.
1538 plist))))
1539 ;; Read options in the current buffer.
1542 ;; Parse keywords specified in `org-element-document-properties'
1543 ;; and return PLIST.
1554 "Return properties related to buffer attributes, as a plist."
1559 "Return global export options as a plist.
1560 Optional argument BACKEND, if non-nil, is an export back-end, as
1561 returned by, e.g., `org-export-create-backend'. It specifies
1562 which back-end specific export options should also be read in the
1563 process."
1565 ;; Priority is given to back-end specific options.
1567 org-export-options-alist)))
1573 plist
1574 prop
1575 ;; Evaluate default value provided. If keyword is
1576 ;; a member of `org-element-document-properties',
1577 ;; parse it as a secondary string before storing it.
1581 org-element-document-properties))
1584 value)))))))))
1587 "Return variables bound from BIND keywords in current buffer.
1588 Also look for BIND keywords in setup files. The return value is
1589 an alist where associations are (VARIABLE-NAME VALUE)."
1594 ;; Return an alist between variable names and their
1595 ;; value. FILES is a list of setup files names read so
1596 ;; far, used to avoid circular dependencies. ALIST is
1597 ;; the alist collected so far.
1608 ;; Enter setup file.
1618 alist))))))))))
1619 alist)))))
1620 ;; Return value in appropriate order of appearance.
1623 ;; defsubst org-export-get-parent must be defined before first use,
1624 ;; was originally defined in the topology section
1627 "Return BLOB parent or nil.
1628 BLOB is the element or object considered."
1631 ;;;; Tree Properties
1632 ;;
1633 ;; Tree properties are information extracted from parse tree. They
1634 ;; are initialized at the beginning of the transcoding process by
1635 ;; `org-export-collect-tree-properties'.
1636 ;;
1637 ;; Dedicated functions focus on computing the value of specific tree
1638 ;; properties during initialization. Thus,
1639 ;; `org-export--populate-ignore-list' lists elements and objects that
1640 ;; should be skipped during export, `org-export--get-min-level' gets
1641 ;; the minimal exportable level, used as a basis to compute relative
1642 ;; level for headlines. Eventually
1643 ;; `org-export--collect-headline-numbering' builds an alist between
1644 ;; headlines and their numbering.
1647 "Extract tree properties from parse tree.
1649 DATA is the parse tree from which information is retrieved. INFO
1650 is a list holding export options.
1652 Following tree properties are set or updated:
1654 `:exported-data' Hash table used to memoize results from
1655 `org-export-data'.
1657 `:footnote-definition-alist' List of footnotes definitions in
1658 original buffer and current parse tree.
1660 `:headline-offset' Offset between true level of headlines and
1661 local level. An offset of -1 means a headline
1662 of level 2 should be considered as a level
1663 1 headline in the context.
1665 `:headline-numbering' Alist of all headlines as key an the
1666 associated numbering as value.
1668 Return updated plist."
1669 ;; Install the parse tree in the communication channel.
1671 ;; Compute `:headline-offset' in order to be able to use
1672 ;; `org-export-get-relative-level'.
1675 :headline-offset
1677 ;; Footnote definitions in parse tree override those stored in
1678 ;; `:footnote-definition-alist'. This way, any change to
1679 ;; a definition in the parse tree (e.g., through a parse tree
1680 ;; filter) propagates into the alist.
1687 defs))
1691 defs)))))
1693 ;; Properties order doesn't matter: get the rest of the tree
1694 ;; properties.
1699 info))
1702 "Return minimum exportable headline's level in DATA.
1703 DATA is parsed tree as returned by `org-element-parse-buffer'.
1704 OPTIONS is a plist holding export options."
1715 ;; If no headline was found, for the sake of consistency, set
1716 ;; minimum level to 1 nonetheless.
1720 "Return numbering of all exportable, numbered headlines in a parse tree.
1722 DATA is the parse tree. OPTIONS is the plist holding export
1723 options.
1725 Return an alist whose key is a headline and value is its
1726 associated numbering \(in the shape of a list of numbers\) or nil
1727 for a footnotes section."
1736 headline
1738 for idx from 0 to org-export-max-depth
1742 options)))
1745 "Return numbering of all exportable, unnumbered headlines.
1746 DATA is the parse tree. OPTIONS is the plist holding export
1747 options. Unnumbered headlines are numbered as a function of
1748 occurrence."
1756 "List headlines and inlinetasks with a select tag in their tree.
1757 DATA is parsed data as returned by `org-element-parse-buffer'.
1758 INFO is a plist holding export options."
1760 walk-data ; For byte-compiler.
1770 ;; When a select tag is found, mark full
1771 ;; genealogy and every headline within the tree
1772 ;; as acceptable.
1775 genealogy
1778 selected-trees))
1779 ;; If at a headline, continue searching in tree,
1780 ;; recursively.
1789 selected-trees))
1792 "Non-nil when element or object BLOB should be skipped during export.
1793 OPTIONS is the plist holding export options. SELECTED, when
1794 non-nil, is a list of headlines or inlinetasks belonging to
1795 a tree with a select tag."
1802 ;; If `:with-drawers' value starts with `not', ignore
1803 ;; every drawer whose name belong to that list.
1804 ;; Otherwise, ignore drawers whose name isn't in that
1805 ;; list.
1822 ;; Ignore subtrees with an exclude tag.
1825 ;; When a select tag is present in the buffer, ignore any tree
1826 ;; without it.
1828 ;; Ignore commented sub-trees.
1830 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1832 ;; Ignore tasks, if specified by `:with-tasks' property.
1844 properties-set))))))
1855 ;; `:with-timestamps' only applies to isolated timestamps
1856 ;; objects, i.e. timestamp objects in a paragraph containing only
1857 ;; timestamps and whitespaces.
1865 options t))))
1874 \f
1875 ;;; The Transcoder
1876 ;;
1877 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1878 ;; `org-element-parse-buffer') and transcodes it into a specified
1879 ;; back-end output. It takes care of filtering out elements or
1880 ;; objects according to export options and organizing the output blank
1881 ;; lines and white space are preserved. The function memoizes its
1882 ;; results, so it is cheap to call it within transcoders.
1883 ;;
1884 ;; It is possible to modify locally the back-end used by
1885 ;; `org-export-data' or even use a temporary back-end by using
1886 ;; `org-export-data-with-backend'.
1887 ;;
1888 ;; `org-export-transcoder' is an accessor returning appropriate
1889 ;; translator function for a given element or object.
1892 "Return appropriate transcoder for BLOB.
1893 INFO is a plist containing export directives."
1895 ;; Return contents only for complete parse trees.
1901 "Convert DATA into current back-end format.
1903 DATA is a parse tree, an element or an object or a secondary
1904 string. INFO is a plist holding export options.
1906 Return a string."
1911 ;; Ignored element/object.
1913 ;; Plain text.
1919 info))
1920 ;; Secondary string.
1923 ;; Element/Object without contents or, as a special
1924 ;; case, headline with archive tag and archived trees
1925 ;; restricted to title only.
1933 ;; Export snippets never return a nil value so
1934 ;; that white spaces following them are never
1935 ;; ignored.
1937 ;; Element/Object with contents.
1950 ;; Elements directly containing
1951 ;; objects must have their indentation
1952 ;; normalized first.
1954 data
1955 ;; When normalizing contents of the
1956 ;; first paragraph in an item or
1957 ;; a footnote definition, ignore
1958 ;; first line's indentation: there is
1959 ;; none and it might be misleading.
1964 data)
1971 info))))))))
1972 ;; Final result will be memoized before being returned.
1974 data
1978 ;; Append the same white space between elements or objects
1979 ;; as in the original buffer, and call appropriate filters.
1990 info)))
1991 results)))
1995 "Convert DATA into BACKEND format.
1997 DATA is an element, an object, a secondary string or a string.
1998 BACKEND is a symbol. INFO is a plist used as a communication
1999 channel.
2001 Unlike to `org-export-with-backend', this function will
2002 recursively convert DATA using BACKEND translation table."
2005 data
2006 ;; Set-up a new communication channel with translations defined in
2007 ;; BACKEND as the translate table and a new hash table for
2008 ;; memoization.
2010 info
2013 ;; Size of the hash table is reduced since this function
2014 ;; will probably be used on small trees.
2018 "Prune non exportable elements from DATA.
2019 DATA is the parse tree to traverse. INFO is the plist holding
2020 export info. Also set `:ignore-list' in INFO to a list of
2021 objects which should be ignored during export, but not removed
2022 from tree."
2024 ignore
2025 ;; First find trees containing a select tag, if any.
2029 ;; Prune non-exportable elements and objects from tree.
2030 ;; As a special case, special rows and cells from tables
2031 ;; are stored in IGNORE, as they still need to be accessed
2032 ;; during export.
2040 ;; If headline is archived but tree below has to
2041 ;; be skipped, remove contents.
2044 ;; Move into secondary string, if any.
2049 ;; Move into recursive objects/elements.
2051 ;; If a select tag is active, also ignore the section before the
2052 ;; first headline, if any.
2057 ;; Prune tree and communication channel.
2061 ;; Eventually set `:ignore-list'.
2065 "Change uninterpreted elements back into Org syntax.
2066 DATA is the parse tree. INFO is a plist containing export
2067 options. Each uninterpreted element or object is changed back
2068 into a string. Contents, if any, are not modified. The parse
2069 tree is modified by side effect."
2073 prop
2076 info))))
2079 "Change uninterpreted elements back into Org syntax.
2080 DATA is a parse tree or a secondary string. INFO is a plist
2081 containing export options. It is modified by side effect and
2082 returned by the function."
2085 subscript superscript underline)
2089 ;; ... entities...
2096 ?\s)))))
2097 ;; ... emphasis...
2109 marker
2113 ?\s)))))))
2114 ;; ... LaTeX environments and fragments...
2118 ;; ... sub/superscripts...
2127 "_"
2136 ?\s)))))))))))
2138 ;; Splice NEW at BLOB location in parse tree.
2141 info)
2142 ;; Return modified parse tree.
2143 data)
2146 "Expand a parsed element or object to its original state.
2148 BLOB is either an element or an object. CONTENTS is its
2149 contents, as a string or nil.
2151 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2152 keywords before output."
2157 blob contents))))
2160 \f
2161 ;;; The Filter System
2162 ;;
2163 ;; Filters allow end-users to tweak easily the transcoded output.
2164 ;; They are the functional counterpart of hooks, as every filter in
2165 ;; a set is applied to the return value of the previous one.
2166 ;;
2167 ;; Every set is back-end agnostic. Although, a filter is always
2168 ;; called, in addition to the string it applies to, with the back-end
2169 ;; used as argument, so it's easy for the end-user to add back-end
2170 ;; specific filters in the set. The communication channel, as
2171 ;; a plist, is required as the third argument.
2172 ;;
2173 ;; From the developer side, filters sets can be installed in the
2174 ;; process with the help of `org-export-define-backend', which
2175 ;; internally stores filters as an alist. Each association has a key
2176 ;; among the following symbols and a function or a list of functions
2177 ;; as value.
2178 ;;
2179 ;; - `:filter-options' applies to the property list containing export
2180 ;; options. Unlike to other filters, functions in this list accept
2181 ;; two arguments instead of three: the property list containing
2182 ;; export options and the back-end. Users can set its value through
2183 ;; `org-export-filter-options-functions' variable.
2184 ;;
2185 ;; - `:filter-parse-tree' applies directly to the complete parsed
2186 ;; tree. Users can set it through
2187 ;; `org-export-filter-parse-tree-functions' variable.
2188 ;;
2189 ;; - `:filter-body' applies to the body of the output, before template
2190 ;; translator chimes in. Users can set it through
2191 ;; `org-export-filter-body-functions' variable.
2192 ;;
2193 ;; - `:filter-final-output' applies to the final transcoded string.
2194 ;; Users can set it with `org-export-filter-final-output-functions'
2195 ;; variable.
2196 ;;
2197 ;; - `:filter-plain-text' applies to any string not recognized as Org
2198 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2199 ;; configure it.
2200 ;;
2201 ;; - `:filter-TYPE' applies on the string returned after an element or
2202 ;; object of type TYPE has been transcoded. A user can modify
2203 ;; `org-export-filter-TYPE-functions' to install these filters.
2204 ;;
2205 ;; All filters sets are applied with
2206 ;; `org-export-filter-apply-functions' function. Filters in a set are
2207 ;; applied in a LIFO fashion. It allows developers to be sure that
2208 ;; their filters will be applied first.
2209 ;;
2210 ;; Filters properties are installed in communication channel with
2211 ;; `org-export-install-filters' function.
2212 ;;
2213 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2214 ;; `org-export-before-parsing-hook') are run at the beginning of the
2215 ;; export process and just before parsing to allow for heavy structure
2216 ;; modifications.
2219 ;;;; Hooks
2222 "Hook run at the beginning of the export process.
2224 This is run before include keywords and macros are expanded and
2225 Babel code blocks executed, on a copy of the original buffer
2226 being exported. Visibility and narrowing are preserved. Point
2227 is at the beginning of the buffer.
2229 Every function in this hook will be called with one argument: the
2233 "Hook run before parsing an export buffer.
2235 This is run after include keywords and macros have been expanded
2236 and Babel code blocks executed, on a copy of the original buffer
2237 being exported. Visibility and narrowing are preserved. Point
2238 is at the beginning of the buffer.
2240 Every function in this hook will be called with one argument: the
2244 ;;;; Special Filters
2247 "List of functions applied to the export options.
2248 Each filter is called with two arguments: the export options, as
2249 a plist, and the back-end, as a symbol. It must return
2253 "List of functions applied to the parsed tree.
2254 Each filter is called with three arguments: the parse tree, as
2255 returned by `org-element-parse-buffer', the back-end, as
2256 a symbol, and the communication channel, as a plist. It must
2260 "List of functions applied to plain text.
2261 Each filter is called with three arguments: a string which
2262 contains no Org syntax, the back-end, as a symbol, and the
2263 communication channel, as a plist. It must return a string or
2267 "List of functions applied to transcoded body.
2268 Each filter is called with three arguments: a string which
2269 contains no Org syntax, the back-end, as a symbol, and the
2270 communication channel, as a plist. It must return a string or
2274 "List of functions applied to the transcoded string.
2275 Each filter is called with three arguments: the full transcoded
2276 string, the back-end, as a symbol, and the communication channel,
2277 as a plist. It must return a string that will be used as the
2281 ;;;; Elements Filters
2284 "List of functions applied to a transcoded babel-call.
2285 Each filter is called with three arguments: the transcoded data,
2286 as a string, the back-end, as a symbol, and the communication
2290 "List of functions applied to a transcoded center block.
2291 Each filter is called with three arguments: the transcoded data,
2292 as a string, the back-end, as a symbol, and the communication
2296 "List of functions applied to a transcoded clock.
2297 Each filter is called with three arguments: the transcoded data,
2298 as a string, the back-end, as a symbol, and the communication
2302 "List of functions applied to a transcoded comment.
2303 Each filter is called with three arguments: the transcoded data,
2304 as a string, the back-end, as a symbol, and the communication
2308 "List of functions applied to a transcoded comment-block.
2309 Each filter is called with three arguments: the transcoded data,
2310 as a string, the back-end, as a symbol, and the communication
2314 "List of functions applied to a transcoded diary-sexp.
2315 Each filter is called with three arguments: the transcoded data,
2316 as a string, the back-end, as a symbol, and the communication
2320 "List of functions applied to a transcoded drawer.
2321 Each filter is called with three arguments: the transcoded data,
2322 as a string, the back-end, as a symbol, and the communication
2326 "List of functions applied to a transcoded dynamic-block.
2327 Each filter is called with three arguments: the transcoded data,
2328 as a string, the back-end, as a symbol, and the communication
2332 "List of functions applied to a transcoded example-block.
2333 Each filter is called with three arguments: the transcoded data,
2334 as a string, the back-end, as a symbol, and the communication
2338 "List of functions applied to a transcoded export-block.
2339 Each filter is called with three arguments: the transcoded data,
2340 as a string, the back-end, as a symbol, and the communication
2344 "List of functions applied to a transcoded fixed-width.
2345 Each filter is called with three arguments: the transcoded data,
2346 as a string, the back-end, as a symbol, and the communication
2350 "List of functions applied to a transcoded footnote-definition.
2351 Each filter is called with three arguments: the transcoded data,
2352 as a string, the back-end, as a symbol, and the communication
2356 "List of functions applied to a transcoded headline.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 "List of functions applied to a transcoded horizontal-rule.
2363 Each filter is called with three arguments: the transcoded data,
2364 as a string, the back-end, as a symbol, and the communication
2368 "List of functions applied to a transcoded inlinetask.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded item.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 "List of functions applied to a transcoded keyword.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to a transcoded latex-environment.
2387 Each filter is called with three arguments: the transcoded data,
2388 as a string, the back-end, as a symbol, and the communication
2392 "List of functions applied to a transcoded node-property.
2393 Each filter is called with three arguments: the transcoded data,
2394 as a string, the back-end, as a symbol, and the communication
2398 "List of functions applied to a transcoded paragraph.
2399 Each filter is called with three arguments: the transcoded data,
2400 as a string, the back-end, as a symbol, and the communication
2404 "List of functions applied to a transcoded plain-list.
2405 Each filter is called with three arguments: the transcoded data,
2406 as a string, the back-end, as a symbol, and the communication
2410 "List of functions applied to a transcoded planning.
2411 Each filter is called with three arguments: the transcoded data,
2412 as a string, the back-end, as a symbol, and the communication
2416 "List of functions applied to a transcoded property-drawer.
2417 Each filter is called with three arguments: the transcoded data,
2418 as a string, the back-end, as a symbol, and the communication
2422 "List of functions applied to a transcoded quote block.
2423 Each filter is called with three arguments: the transcoded quote
2424 data, as a string, the back-end, as a symbol, and the
2425 communication channel, as a plist. It must return a string or
2429 "List of functions applied to a transcoded section.
2430 Each filter is called with three arguments: the transcoded data,
2431 as a string, the back-end, as a symbol, and the communication
2435 "List of functions applied to a transcoded special block.
2436 Each filter is called with three arguments: the transcoded data,
2437 as a string, the back-end, as a symbol, and the communication
2441 "List of functions applied to a transcoded src-block.
2442 Each filter is called with three arguments: the transcoded data,
2443 as a string, the back-end, as a symbol, and the communication
2447 "List of functions applied to a transcoded table.
2448 Each filter is called with three arguments: the transcoded data,
2449 as a string, the back-end, as a symbol, and the communication
2453 "List of functions applied to a transcoded table-cell.
2454 Each filter is called with three arguments: the transcoded data,
2455 as a string, the back-end, as a symbol, and the communication
2459 "List of functions applied to a transcoded table-row.
2460 Each filter is called with three arguments: the transcoded data,
2461 as a string, the back-end, as a symbol, and the communication
2465 "List of functions applied to a transcoded verse block.
2466 Each filter is called with three arguments: the transcoded data,
2467 as a string, the back-end, as a symbol, and the communication
2471 ;;;; Objects Filters
2474 "List of functions applied to transcoded bold text.
2475 Each filter is called with three arguments: the transcoded data,
2476 as a string, the back-end, as a symbol, and the communication
2480 "List of functions applied to transcoded code text.
2481 Each filter is called with three arguments: the transcoded data,
2482 as a string, the back-end, as a symbol, and the communication
2486 "List of functions applied to a transcoded entity.
2487 Each filter is called with three arguments: the transcoded data,
2488 as a string, the back-end, as a symbol, and the communication
2492 "List of functions applied to a transcoded export-snippet.
2493 Each filter is called with three arguments: the transcoded data,
2494 as a string, the back-end, as a symbol, and the communication
2498 "List of functions applied to a transcoded footnote-reference.
2499 Each filter is called with three arguments: the transcoded data,
2500 as a string, the back-end, as a symbol, and the communication
2504 "List of functions applied to a transcoded inline-babel-call.
2505 Each filter is called with three arguments: the transcoded data,
2506 as a string, the back-end, as a symbol, and the communication
2510 "List of functions applied to a transcoded inline-src-block.
2511 Each filter is called with three arguments: the transcoded data,
2512 as a string, the back-end, as a symbol, and the communication
2516 "List of functions applied to transcoded italic text.
2517 Each filter is called with three arguments: the transcoded data,
2518 as a string, the back-end, as a symbol, and the communication
2522 "List of functions applied to a transcoded latex-fragment.
2523 Each filter is called with three arguments: the transcoded data,
2524 as a string, the back-end, as a symbol, and the communication
2528 "List of functions applied to a transcoded line-break.
2529 Each filter is called with three arguments: the transcoded data,
2530 as a string, the back-end, as a symbol, and the communication
2534 "List of functions applied to a transcoded link.
2535 Each filter is called with three arguments: the transcoded data,
2536 as a string, the back-end, as a symbol, and the communication
2540 "List of functions applied to a transcoded radio-target.
2541 Each filter is called with three arguments: the transcoded data,
2542 as a string, the back-end, as a symbol, and the communication
2546 "List of functions applied to a transcoded statistics-cookie.
2547 Each filter is called with three arguments: the transcoded data,
2548 as a string, the back-end, as a symbol, and the communication
2552 "List of functions applied to transcoded strike-through text.
2553 Each filter is called with three arguments: the transcoded data,
2554 as a string, the back-end, as a symbol, and the communication
2558 "List of functions applied to a transcoded subscript.
2559 Each filter is called with three arguments: the transcoded data,
2560 as a string, the back-end, as a symbol, and the communication
2564 "List of functions applied to a transcoded superscript.
2565 Each filter is called with three arguments: the transcoded data,
2566 as a string, the back-end, as a symbol, and the communication
2570 "List of functions applied to a transcoded target.
2571 Each filter is called with three arguments: the transcoded data,
2572 as a string, the back-end, as a symbol, and the communication
2576 "List of functions applied to a transcoded timestamp.
2577 Each filter is called with three arguments: the transcoded data,
2578 as a string, the back-end, as a symbol, and the communication
2582 "List of functions applied to transcoded underline text.
2583 Each filter is called with three arguments: the transcoded data,
2584 as a string, the back-end, as a symbol, and the communication
2588 "List of functions applied to transcoded verbatim text.
2589 Each filter is called with three arguments: the transcoded data,
2590 as a string, the back-end, as a symbol, and the communication
2594 ;;;; Filters Tools
2595 ;;
2596 ;; Internal function `org-export-install-filters' installs filters
2597 ;; hard-coded in back-ends (developer filters) and filters from global
2598 ;; variables (user filters) in the communication channel.
2599 ;;
2600 ;; Internal function `org-export-filter-apply-functions' takes care
2601 ;; about applying each filter in order to a given data. It ignores
2602 ;; filters returning a nil value but stops whenever a filter returns
2603 ;; an empty string.
2606 "Call every function in FILTERS.
2608 Functions are called with arguments VALUE, current export
2609 back-end's name and INFO. A function returning a nil value will
2610 be skipped. If it returns the empty string, the process ends and
2611 VALUE is ignored.
2613 Call is done in a LIFO fashion, to be sure that developer
2614 specified filters, if any, are called first."
2625 "Install filters properties in communication channel.
2626 INFO is a plist containing the current communication channel.
2627 Return the updated communication channel."
2629 ;; Install user-defined filters with `org-export-filters-alist'
2630 ;; and filters already in INFO (through ext-plist mechanism).
2637 ;; Filters in INFO will be called
2638 ;; before those user provided.
2641 default-value)))))
2642 org-export-filters-alist)
2643 ;; Prepend back-end specific filters to that list.
2645 ;; Single values get consed, lists are appended.
2650 plist key
2654 ;; Return new communication channel.
2658 \f
2659 ;;; Core functions
2660 ;;
2661 ;; This is the room for the main function, `org-export-as', along with
2662 ;; its derivative, `org-export-string-as'.
2663 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2664 ;; function should be added to kill ring.
2665 ;;
2666 ;; Note that `org-export-as' doesn't really parse the current buffer,
2667 ;; but a copy of it (with the same buffer-local variables and
2668 ;; visibility), where macros and include keywords are expanded and
2669 ;; Babel blocks are executed, if appropriate.
2670 ;; `org-export-with-buffer-copy' macro prepares that copy.
2671 ;;
2672 ;; File inclusion is taken care of by
2673 ;; `org-export-expand-include-keyword' and
2674 ;; `org-export--prepare-file-contents'. Structure wise, including
2675 ;; a whole Org file in a buffer often makes little sense. For
2676 ;; example, if the file contains a headline and the include keyword
2677 ;; was within an item, the item should contain the headline. That's
2678 ;; why file inclusion should be done before any structure can be
2679 ;; associated to the file, that is before parsing.
2680 ;;
2681 ;; `org-export-insert-default-template' is a command to insert
2682 ;; a default template (or a back-end specific template) at point or in
2683 ;; current subtree.
2686 "Return a copy of the current buffer.
2687 The copy preserves Org buffer-local variables, visibility and
2688 narrowing."
2694 new-buf))
2697 "Apply BODY in a copy of the current buffer.
2698 The copy preserves local variables, visibility and contents of
2699 the original buffer. Point is at the beginning of the buffer
2700 when BODY is applied."
2709 ;; Kill copy without confirmation.
2715 "Generate a function duplicating BUFFER.
2717 The copy will preserve local variables, visibility, contents and
2718 narrowing of the original buffer. If a region was active in
2719 BUFFER, contents will be narrowed to that region instead.
2721 The resulting function can be evaluated at a later time, from
2722 another buffer, effectively cloning the original buffer there.
2724 The function assumes BUFFER's major mode is `org-mode'."
2728 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2729 ;; already in BUFFER.
2731 ;; Copy specific buffer local variables and variables set
2732 ;; through BIND keywords.
2734 vars)
2742 buffer-file-name
2743 buffer-file-coding-system))
2747 ;; Skip unreadable values, as they cannot be
2748 ;; sent to external process.
2752 vars))))))
2753 ;; Whole buffer contents.
2758 ;; Narrowing.
2762 ;; Current position of point.
2764 ;; Overlays with invisible property.
2774 ov-set))))
2776 ov-set)))))
2778 ;;;###autoload
2781 "Transcode current Org buffer into BACKEND code.
2783 BACKEND is either an export back-end, as returned by, e.g.,
2784 `org-export-create-backend', or a symbol referring to
2785 a registered back-end.
2787 If narrowing is active in the current buffer, only transcode its
2788 narrowed part.
2790 If a region is active, transcode that region.
2792 When optional argument SUBTREEP is non-nil, transcode the
2793 sub-tree at point, extracting information from the headline
2794 properties first.
2796 When optional argument VISIBLE-ONLY is non-nil, don't export
2797 contents of hidden elements.
2799 When optional argument BODY-ONLY is non-nil, only return body
2800 code, without surrounding template.
2802 Optional argument EXT-PLIST, when provided, is a property list
2803 with external parameters overriding Org default settings, but
2804 still inferior to file-local settings.
2806 Return code as a string."
2811 ;; Narrow buffer to an appropriate region or subtree for
2812 ;; parsing. If parsing subtree, be sure to remove main headline
2813 ;; too.
2821 ;; Initialize communication channel with original buffer
2822 ;; attributes, unavailable in its copy.
2831 tree)
2832 ;; Update communication channel and get parse tree. Buffer
2833 ;; isn't parsed directly. Instead, a temporary copy is
2834 ;; created, where include keywords, macros are expanded and
2835 ;; code blocks are evaluated.
2837 ;; Run first hook with current back-end's name as argument.
2841 ;; Update macro templates since #+INCLUDE keywords might have
2842 ;; added some new ones.
2846 ;; Update radio targets since keyword inclusion might have
2847 ;; added some more.
2849 ;; Run last hook with current back-end's name as argument.
2854 ;; Update communication channel with environment. Also
2855 ;; install user's and developer's filters.
2860 ;; Call options filters and update export options. We do not
2861 ;; use `org-export-filter-apply-functions' here since the
2862 ;; arity of such filters is different.
2867 ;; Expand export-specific set of macros: {{{author}}},
2868 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2869 ;; once regular macros have been expanded, since document
2870 ;; keywords may contain one of them.
2876 ;; EMAIL is not a parsed keyword: store it as-is.
2881 ;; Parse buffer.
2883 ;; Prune tree from non-exported elements and transform
2884 ;; uninterpreted elements or objects in both parse tree and
2885 ;; communication channel.
2888 ;; Parse buffer, handle uninterpreted elements or objects,
2889 ;; then call parse-tree filters.
2893 ;; Now tree is complete, compute its properties and add them
2894 ;; to communication channel.
2898 ;; Eventually transcode TREE. Wrap the resulting string into
2899 ;; a template.
2908 info))
2911 ;; Remove all text properties since they cannot be
2912 ;; retrieved from an external process. Finally call
2913 ;; final-output filter and return result.
2919 info))))))))
2921 ;;;###autoload
2923 "Transcode STRING into BACKEND code.
2925 BACKEND is either an export back-end, as returned by, e.g.,
2926 `org-export-create-backend', or a symbol referring to
2927 a registered back-end.
2929 When optional argument BODY-ONLY is non-nil, only return body
2930 code, without preamble nor postamble.
2932 Optional argument EXT-PLIST, when provided, is a property list
2933 with external parameters overriding Org default settings, but
2934 still inferior to file-local settings.
2936 Return code as a string."
2942 ;;;###autoload
2944 "Replace the active region by its export to BACKEND.
2945 BACKEND is either an export back-end, as returned by, e.g.,
2946 `org-export-create-backend', or a symbol referring to
2947 a registered back-end."
2957 ;;;###autoload
2959 "Insert all export keywords with default values at beginning of line.
2961 BACKEND is a symbol referring to the name of a registered export
2962 back-end, for which specific export options should be added to
2963 the template, or `default' for default template. When it is nil,
2964 the user will be prompted for a category.
2966 If SUBTREEP is non-nil, export configuration will be set up
2967 locally for the subtree through node properties."
2977 "Options category: "
2981 org-export--registered-backends))
2982 nil t))))
2983 options keywords)
2984 ;; Populate OPTIONS and KEYWORDS.
3001 ;; Move to an appropriate location in order to insert options.
3003 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3021 ;; Then the rest of keywords, in the order specified in either
3022 ;; `org-export-options-alist' or respective export back-ends.
3043 "Expand every include keyword in buffer.
3044 Optional argument INCLUDED is a list of included file names along
3045 with their line restriction, when appropriate. It is used to
3046 avoid infinite recursion. Optional argument DIR is the current
3047 working directory. It is used to properly resolve relative
3048 paths. Optional argument FOOTNOTES is a hash-table used for
3049 storing and resolving footnotes. It is created automatically."
3055 ;; If :minlevel is not set the text-property
3056 ;; `:org-include-induced-level' will be used to determine the
3057 ;; relative level when expanding INCLUDE.
3058 ;; Only affects included Org documents.
3062 :org-include-induced-level
3064 ;; Expand INCLUDE keywords.
3070 ;; Extract arguments from keyword's value.
3073 location
3085 matched)
3086 dir)))
3095 value)
3102 ;; Minimal level of included file defaults to the child
3103 ;; level of the current headline, if any, or one. It
3104 ;; only applies is the file is meant to be included as
3105 ;; an Org one.
3116 ;; Remove keyword.
3122 ;; Check if files has already been parsed. Look after
3123 ;; inclusion lines too, as different parts of the same file
3124 ;; can be included too.
3139 ind-str block arg-str contents ind-str block))))
3146 ind-str block contents ind-str block))))
3154 file location only-contents lines)
3155 lines)))
3158 file lines ind minlevel
3161 footnotes)))
3165 footnotes)
3167 ;; Expand footnotes after all files have been
3168 ;; included. Footnotes are stored at end of buffer.
3173 footnotes)))))))))))
3176 "Resolve absolute lines for an included file with file-link.
3178 FILE is string file-name of the file to include. LOCATION is a
3179 string name within FILE to be included (located via
3180 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3181 contents of the named element will be included, as determined
3182 Org-Element. If LINES is non-nil only those lines are included.
3184 Return a string of lines to be included in the format expected by
3185 `org-export--prepare-file-contents'."
3191 ;; Enforce consistent search.
3204 ;; Skip planning line and property-drawer.
3230 start-line
3232 (+ start-line
3235 counter))))))))
3238 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3240 REF-BEGIN corresponds to the property `:begin' of objects of type
3241 footnote-definition and footnote-reference.
3243 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3244 \[N] where N is one or more numbers.
3246 Return the new label."
3256 "Prepare contents of FILE for inclusion and return it as a string.
3258 When optional argument LINES is a string specifying a range of
3259 lines, include only those lines.
3261 Optional argument IND, when non-nil, is an integer specifying the
3262 global indentation of returned contents. Since its purpose is to
3263 allow an included file to stay in the same environment it was
3264 created \(i.e. a list item), it doesn't apply past the first
3265 headline encountered.
3267 Optional argument MINLEVEL, when non-nil, is an integer
3268 specifying the level that any top-level headline in the included
3269 file should have.
3270 Optional argument ID is an integer that will be inserted before
3271 each footnote definition and reference if FILE is an Org file.
3272 This is useful to avoid conflicts when more than one Org file
3273 with footnotes is included in a document.
3275 Optional argument FOOTNOTES is a hash-table to store footnotes in
3276 the included document.
3277 "
3293 ;; Remove blank lines at beginning and end of contents. The logic
3294 ;; behind that removal is that blank lines around include keyword
3295 ;; override blank lines in included file.
3304 ;; If IND is set, preserve indentation of include keyword until
3305 ;; the first headline encountered.
3312 ;; Do not move footnote definitions out of column 0.
3318 ;; When MINLEVEL is specified, compute minimal level for headlines
3319 ;; in the file (CUR-MIN), and remove stars to each headline so
3320 ;; that headlines with minimal level have a level of MINLEVEL.
3331 ;; Only change stars, don't bother moving whole
3332 ;; sections.
3336 ;; Append ID to all footnote references and definitions, so they
3337 ;; become file specific and cannot collide with footnotes in other
3338 ;; included files. Further, collect relevant footnotes outside of
3339 ;; LINES.
3349 ;; Update the footnote-reference at point and collect
3350 ;; the new label, which is only used for footnotes
3351 ;; outsides LINES.
3353 ;; If label is akin to [1] convert it to [fn:ID-1].
3354 ;; Otherwise add "ID-" after "fn:".
3364 ;; Store since footnote-definition is outside of LINES.
3367 footnotes)
3368 ;; Update label of definition since it is included directly.
3375 "Execute every Babel code in the visible part of current buffer."
3376 ;; Get a pristine copy of current buffer so Babel references can be
3377 ;; properly resolved.
3383 "Return a non-nil value when output should be added to the kill ring.
3384 See also `org-export-copy-to-kill-ring'."
3390 \f
3391 ;;; Tools For Back-Ends
3392 ;;
3393 ;; A whole set of tools is available to help build new exporters. Any
3394 ;; function general enough to have its use across many back-ends
3395 ;; should be added here.
3397 ;;;; For Affiliated Keywords
3398 ;;
3399 ;; `org-export-read-attribute' reads a property from a given element
3400 ;; as a plist. It can be used to normalize affiliated keywords'
3401 ;; syntax.
3402 ;;
3403 ;; Since captions can span over multiple lines and accept dual values,
3404 ;; their internal representation is a bit tricky. Therefore,
3405 ;; `org-export-get-caption' transparently returns a given element's
3406 ;; caption as a secondary string.
3409 "Turn ATTRIBUTE property from ELEMENT into a plist.
3411 When optional argument PROPERTY is non-nil, return the value of
3412 that property within attributes.
3416 properties.
3418 All values will become strings except the empty string and
3421 will become the empty string."
3435 s)
3440 ;; Ignore any string before first property with `cdr'.
3445 "Return caption from ELEMENT as a secondary string.
3447 When optional argument SHORTP is non-nil, return short caption,
3448 as a secondary string, instead.
3450 Caption lines are separated by a white space."
3458 ;;;; For Derived Back-ends
3459 ;;
3460 ;; `org-export-with-backend' is a function allowing to locally use
3461 ;; another back-end to transcode some object or element. In a derived
3462 ;; back-end, it may be used as a fall-back function once all specific
3463 ;; cases have been treated.
3466 "Call a transcoder from BACKEND on DATA.
3467 BACKEND is an export back-end, as returned by, e.g.,
3468 `org-export-create-backend', or a symbol referring to
3469 a registered back-end. DATA is an Org element, object, secondary
3470 string or string. CONTENTS, when non-nil, is the transcoded
3471 contents of DATA element, as a string. INFO, when non-nil, is
3472 the communication channel used for export, as a plist."
3482 transcoder data contents
3485 :translate-alist all-transcoders
3489 ;;;; For Export Snippets
3490 ;;
3491 ;; Every export snippet is transmitted to the back-end. Though, the
3492 ;; latter will only retain one type of export-snippet, ignoring
3493 ;; others, based on the former's target back-end. The function
3494 ;; `org-export-snippet-backend' returns that back-end for a given
3495 ;; export-snippet.
3498 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3499 Translation, with `org-export-snippet-translation-alist', is
3500 applied."
3504 back-end))))
3507 ;;;; For Footnotes
3508 ;;
3509 ;; `org-export-collect-footnote-definitions' is a tool to list
3510 ;; actually used footnotes definitions in the whole parse tree, or in
3511 ;; a headline, in order to add footnote listings throughout the
3512 ;; transcoded data.
3513 ;;
3514 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3515 ;; back-ends, when they need to attach the footnote definition only to
3516 ;; the first occurrence of the corresponding label.
3517 ;;
3518 ;; `org-export-get-footnote-definition' and
3519 ;; `org-export-get-footnote-number' provide easier access to
3520 ;; additional information relative to a footnote reference.
3523 "Return an alist between footnote numbers, labels and definitions.
3525 DATA is the parse tree from which definitions are collected.
3526 INFO is the plist used as a communication channel.
3528 Definitions are sorted by order of references. They either
3529 appear as Org data or as a secondary string for inlined
3530 footnotes. Unreferenced definitions are ignored."
3532 collect-fn ; for byte-compiler.
3536 ;; Collect footnote number, label and definition in DATA.
3544 def)
3545 num-alist)
3546 ;; Also search in definition for nested footnotes.
3549 ;; Don't enter footnote definitions since it will happen
3550 ;; when their first reference is found.
3556 "Non-nil when a footnote reference is the first one for its label.
3558 FOOTNOTE-REFERENCE is the footnote reference being considered.
3559 INFO is the plist used as a communication channel."
3561 ;; Anonymous footnotes are always a first reference.
3563 ;; Otherwise, return the first footnote with the same LABEL and
3564 ;; test if it is equal to FOOTNOTE-REFERENCE.
3574 ;; If FN isn't inlined, be sure to traverse its
3575 ;; definition before resuming search. See
3576 ;; comments in `org-export-get-footnote-number'
3577 ;; for more information.
3581 ;; Don't enter footnote definitions since it will
3582 ;; happen when their first reference is found.
3585 footnote-reference)))))
3588 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3589 INFO is the plist used as a communication channel. If no such
3590 definition can be found, raise an error."
3598 "Return number associated to a footnote.
3600 FOOTNOTE is either a footnote reference or a footnote definition.
3601 INFO is the plist used as a communication channel."
3603 seen-refs
3604 search-ref ; For byte-compiler.
3608 ;; Search footnote references through DATA, filling
3609 ;; SEEN-REFS along the way.
3614 ;; Anonymous footnote match: return number.
3617 ;; Labels match: return number.
3620 ;; Anonymous footnote: it's always a new one.
3621 ;; Also, be sure to return nil from the `cond' so
3622 ;; `first-match' doesn't get us out of the loop.
3624 ;; Label not seen so far: add it so SEEN-REFS.
3625 ;;
3626 ;; Also search for subsequent references in
3627 ;; footnote definition so numbering follows
3628 ;; reading logic. Note that we don't have to care
3629 ;; about inline definitions, since
3630 ;; `org-element-map' already traverses them at the
3631 ;; right time.
3632 ;;
3633 ;; Once again, return nil to stay in the loop.
3638 nil))))
3639 ;; Don't enter footnote definitions since it will
3640 ;; happen when their first reference is found.
3645 ;;;; For Headlines
3646 ;;
3647 ;; `org-export-get-relative-level' is a shortcut to get headline
3648 ;; level, relatively to the lower headline level in the parsed tree.
3649 ;;
3650 ;; `org-export-get-headline-number' returns the section number of an
3651 ;; headline, while `org-export-number-to-roman' allows to convert it
3652 ;; to roman numbers. With an optional argument,
3653 ;; `org-export-get-headline-number' returns a number to unnumbered
3654 ;; headlines (used for internal id).
3655 ;;
3656 ;; `org-export-get-headline-id' returns the unique internal id of a
3657 ;; headline.
3658 ;;
3659 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3660 ;; `org-export-last-sibling-p' are three useful predicates when it
3661 ;; comes to fulfill the `:headline-levels' property.
3662 ;;
3663 ;; `org-export-get-tags', `org-export-get-category' and
3664 ;; `org-export-get-node-property' extract useful information from an
3665 ;; headline or a parent headline. They all handle inheritance.
3666 ;;
3667 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3668 ;; as a secondary string, suitable for table of contents. It falls
3669 ;; back onto default title.
3672 "Return HEADLINE relative level within current parsed tree.
3673 INFO is a plist holding contextual information."
3678 "Non-nil when HEADLINE is considered as low level.
3680 INFO is a plist used as a communication channel.
3682 A low level headlines has a relative level greater than
3683 `:headline-levels' property value.
3685 Return value is the difference between HEADLINE relative level
3686 and the last level being considered as high enough, or nil."
3693 "Return a unique ID for HEADLINE.
3694 INFO is a plist holding contextual information."
3704 "Return numbered HEADLINE numbering as a list of numbers.
3705 INFO is a plist holding contextual information."
3710 "Return a non-nil value if HEADLINE element should be numbered.
3711 INFO is a plist used as a communication channel."
3720 "Convert integer N into a roman numeral."
3733 res)))
3736 "Return list of tags associated to ELEMENT.
3738 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3739 is a plist used as a communication channel.
3741 Select tags (see `org-export-select-tags') and exclude tags (see
3742 `org-export-exclude-tags') are removed from the list.
3744 When non-nil, optional argument TAGS should be a list of strings.
3745 Any tag belonging to this list will also be removed.
3747 When optional argument INHERITED is non-nil, tags can also be
3748 inherited from parent headlines and FILETAGS keywords."
3754 ;; Build complete list of inherited tags.
3761 ;; Add FILETAGS keywords and return results.
3765 "Return node PROPERTY value for BLOB.
3767 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3768 element or object.
3770 If optional argument INHERITED is non-nil, the value can be
3771 inherited from a parent headline.
3773 Return value is a string or nil."
3785 "Return category for element or object BLOB.
3787 INFO is a plist used as a communication channel.
3789 CATEGORY is automatically inherited from a parent headline, from
3790 #+CATEGORY: keyword or created out of original file name. If all
3803 "Return alternative title for HEADLINE, as a secondary string.
3804 INFO is a plist used as a communication channel. If no optional
3805 title is defined, fall-back to the regular title."
3810 "Non-nil when BLOB is the first sibling in its parent.
3811 BLOB is an element or an object. If BLOB is a headline, non-nil
3812 means it is the first sibling in the sub-tree. INFO is a plist
3813 used as a communication channel."
3818 "Non-nil when BLOB is the last sibling in its parent.
3819 BLOB is an element or an object. INFO is a plist used as
3820 a communication channel."
3824 ;;;; For Keywords
3825 ;;
3826 ;; `org-export-get-date' returns a date appropriate for the document
3827 ;; to about to be exported. In particular, it takes care of
3828 ;; `org-export-date-timestamp-format'.
3831 "Return date value for the current document.
3833 INFO is a plist used as a communication channel. FMT, when
3834 non-nil, is a time format string that will be applied on the date
3835 if it consists in a single timestamp object. It defaults to
3836 `org-export-date-timestamp-format' when nil.
3838 A proper date can be a secondary string, a string or nil. It is
3839 meant to be translated with `org-export-data' or alike."
3850 ;;;; For Links
3851 ;;
3852 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3853 ;; with `org-add-link-type', which see.
3854 ;;
3855 ;; `org-export-solidify-link-text' turns a string into a safer version
3856 ;; for links, replacing most non-standard characters with hyphens.
3857 ;;
3858 ;; `org-export-get-coderef-format' returns an appropriate format
3859 ;; string for coderefs.
3860 ;;
3861 ;; `org-export-inline-image-p' returns a non-nil value when the link
3862 ;; provided should be considered as an inline image.
3863 ;;
3864 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3865 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3866 ;; returns an appropriate unique identifier when found, or nil.
3867 ;;
3868 ;; `org-export-resolve-id-link' returns the first headline with
3869 ;; specified id or custom-id in parse tree, the path to the external
3870 ;; file with the id or nil when neither was found.
3871 ;;
3872 ;; `org-export-resolve-coderef' associates a reference to a line
3873 ;; number in the element it belongs, or returns the reference itself
3874 ;; when the element isn't numbered.
3877 "Take link text S and make a safe target out of it."
3882 "Try exporting LINK with a dedicated function.
3884 DESC is its description, as a string, or nil. INFO is the plist
3885 containing export state. Return output as a string, or nil if no
3886 protocol handles LINK.
3888 A custom protocol is expected to have precedence over regular
3889 back-end export. The function ignores links with an implicit
3900 desc
3901 backend))))))
3904 "Return format string for code reference link.
3905 PATH is the link path. DESC is its description."
3913 "Non-nil if LINK object points to an inline image.
3915 Optional argument is a set of RULES defining inline images. It
3916 is an alist where associations have the following shape:
3918 \(TYPE . REGEXP)
3920 Applying a rule means apply REGEXP against LINK's path when its
3921 type is TYPE. The function will return a non-nil value if any of
3922 the provided rules is non-nil. The default rule is
3923 `org-export-default-inline-image-rule'.
3925 This only applies to links without a description."
3936 "Resolve a code reference REF.
3938 INFO is a plist used as a communication channel.
3940 Return associated line number in source code, or REF itself,
3941 depending on src-block or example element's switches."
3948 org-coderef-label-format)))
3952 ;; Element containing REF is found. Resolve it to either
3953 ;; a label or a line number, as needed.
3963 "Return LINK destination.
3965 INFO is a plist holding contextual information.
3967 Return value can be an object, an element, or nil:
3969 - If LINK path matches a target object (i.e. <<path>>) return it.
3971 - If LINK path exactly matches the name affiliated keyword
3972 \(i.e. #+NAME: path) of an element, return that element.
3974 - If LINK path exactly matches any headline name, return that
3975 element. If more than one headline share that name, priority
3976 will be given to the one with the closest common ancestor, if
3977 any, or the first one in the parse tree otherwise.
3979 - Otherwise, return nil.
3982 significant."
3985 ;; Split PATH at white spaces so matches are space
3986 ;; insensitive.
3989 ;; Cache for destinations that are not position dependent.
3997 ;; Destination is not position dependent: use cached value.
3999 ;; First try to find a matching "<<path>>" unless user specified
4000 ;; he was looking for a headline (path starts with a "*"
4001 ;; character).
4007 path)
4008 blob))
4011 ;; Then try to find an element with a matching "#+NAME: path"
4012 ;; affiliated keyword.
4015 org-element-all-elements
4020 el)))
4023 ;; Last case: link either points to a headline or to nothingness.
4024 ;; Try to find the source, with priority given to headlines with
4025 ;; the closest common ancestor. If such candidate is found,
4026 ;; return it, otherwise return nil.
4030 ;; Return first headline whose `:raw-value' property is
4031 ;; NAME in parse tree DATA, or nil. Statistics cookies
4032 ;; are ignored.
4040 name)
4041 headline))
4043 ;; Search among headlines sharing an ancestor with link, from
4044 ;; closest to farthest.
4052 ;; No destination found: return nil.
4056 "Return headline referenced as LINK destination.
4058 INFO is a plist used as a communication channel.
4060 Return value can be the headline element matched in current parse
4064 ;; First check if id is within the current parse tree.
4069 headline))
4071 ;; Otherwise, look for external files.
4075 "Return radio-target object referenced as LINK destination.
4077 INFO is a plist used as a communication channel.
4079 Return value can be a radio-target object or nil. Assume LINK
4088 nil nil path nil nil t)
4089 t)
4090 radio))
4094 ;;;; For References
4095 ;;
4096 ;; `org-export-get-ordinal' associates a sequence number to any object
4097 ;; or element.
4100 "Return ordinal number of an element or object.
4102 ELEMENT is the element or object considered. INFO is the plist
4103 used as a communication channel.
4105 Optional argument TYPES, when non-nil, is a list of element or
4106 object types, as symbols, that should also be counted in.
4107 Otherwise, only provided element's type is considered.
4109 Optional argument PREDICATE is a function returning a non-nil
4110 value if the current element or object should be counted in. It
4111 accepts two arguments: the element or object being considered and
4112 the plist used as a communication channel. This allows to count
4113 only a certain type of objects (i.e. inline images).
4115 Return value is a list of numbers if ELEMENT is a headline or an
4116 item. It is nil for keywords. It represents the footnote number
4117 for footnote definitions and footnote references. If ELEMENT is
4118 a target, return the same value as if ELEMENT was the closest
4119 table, item or headline containing the target. In any other
4120 case, return the sequence number of ELEMENT among elements or
4121 objects of the same type."
4122 ;; Ordinal of a target object refer to the ordinal of the closest
4123 ;; table, item, or headline containing the object.
4127 element
4130 ;; Special case 1: A headline returns its number as a list.
4132 ;; Special case 2: An item returns its number as a list.
4136 struct
4143 ;; Increment counter until ELEMENT is found again.
4154 ;;;; For Src-Blocks
4155 ;;
4156 ;; `org-export-get-loc' counts number of code lines accumulated in
4157 ;; src-block or example-block elements with a "+n" switch until
4158 ;; a given element, excluded. Note: "-n" switches reset that count.
4159 ;;
4160 ;; `org-export-unravel-code' extracts source code (along with a code
4161 ;; references alist) from an `element-block' or `src-block' type
4162 ;; element.
4163 ;;
4164 ;; `org-export-format-code' applies a formatting function to each line
4165 ;; of code, providing relative line number and code reference when
4166 ;; appropriate. Since it doesn't access the original element from
4167 ;; which the source code is coming, it expects from the code calling
4168 ;; it to know if lines should be numbered and if code references
4169 ;; should appear.
4170 ;;
4171 ;; Eventually, `org-export-format-code-default' is a higher-level
4172 ;; function (it makes use of the two previous functions) which handles
4173 ;; line numbering and code references inclusion, and returns source
4174 ;; code in a format suitable for plain text or verbatim output.
4177 "Return accumulated lines of code up to ELEMENT.
4179 INFO is the plist used as a communication channel.
4181 ELEMENT is excluded from count."
4187 ;; ELEMENT is reached: Quit the loop.
4189 ;; Only count lines from src-block and example-block elements
4190 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4194 ;; Accumulate locs or reset them.
4198 ;; Return nil to stay in the loop.
4199 nil)))
4201 ;; Return value.
4202 loc))
4205 "Clean source code and extract references out of it.
4207 ELEMENT has either a `src-block' an `example-block' type.
4209 Return a cons cell whose CAR is the source code, cleaned from any
4210 reference, protective commas and spurious indentation, and CDR is
4211 an alist between relative line number (integer) and name of code
4212 reference on that line (string)."
4215 ;; Get code and clean it. Remove blank lines at its
4216 ;; beginning and end.
4223 value
4225 ;; Get format used for references.
4228 org-coderef-label-format)))
4229 ;; Build a regexp matching a loc with a reference.
4234 ;; Return value.
4236 ;; Code with references removed.
4242 ;; Ref line: remove ref, and signal its position in REFS.
4246 ;; Reference alist.
4247 refs)))
4250 "Format CODE by applying FUN line-wise and return it.
4252 CODE is a string representing the code to format. FUN is
4253 a function. It must accept three arguments: a line of
4254 code (string), the current line number (integer) or nil and the
4255 reference associated to the current line (string) or nil.
4257 Optional argument NUM-LINES can be an integer representing the
4258 number of code lines accumulated until the current code. Line
4259 numbers passed to FUN will take it into account. If it is nil,
4260 FUN's second argument will always be nil. This number can be
4261 obtained with `org-export-get-loc' function.
4263 Optional argument REF-ALIST can be an alist between relative line
4264 number (i.e. ignoring NUM-LINES) and the name of the code
4265 reference on it. If it is nil, FUN's third argument will always
4266 be nil. It can be obtained through the use of
4267 `org-export-unravel-code' function."
4279 "Return source code from ELEMENT, formatted in a standard way.
4281 ELEMENT is either a `src-block' or `example-block' element. INFO
4282 is a plist used as a communication channel.
4284 This function takes care of line numbering and code references
4285 inclusion. Line numbers, when applicable, appear at the
4286 beginning of the line, separated from the code by two white
4287 spaces. Code references, on the other hand, appear flushed to
4288 the right, separated by six white spaces from the widest line of
4289 code."
4290 ;; Extract code and references.
4297 ;; Handle line numbering.
4306 ;; Prepare references display, if required. Any reference
4307 ;; should start six columns after the widest line of code,
4308 ;; wrapped with parenthesis.
4313 code
4317 number-str
4318 loc
4324 num-start refs)))))
4327 ;;;; For Tables
4328 ;;
4329 ;; `org-export-table-has-special-column-p' and and
4330 ;; `org-export-table-row-is-special-p' are predicates used to look for
4331 ;; meta-information about the table structure.
4332 ;;
4333 ;; `org-table-has-header-p' tells when the rows before the first rule
4334 ;; should be considered as table's header.
4335 ;;
4336 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4337 ;; and `org-export-table-cell-borders' extract information from
4338 ;; a table-cell element.
4339 ;;
4340 ;; `org-export-table-dimensions' gives the number on rows and columns
4341 ;; in the table, ignoring horizontal rules and special columns.
4342 ;; `org-export-table-cell-address', given a table-cell object, returns
4343 ;; the absolute address of a cell. On the other hand,
4344 ;; `org-export-get-table-cell-at' does the contrary.
4345 ;;
4346 ;; `org-export-table-cell-starts-colgroup-p',
4347 ;; `org-export-table-cell-ends-colgroup-p',
4348 ;; `org-export-table-row-starts-rowgroup-p',
4349 ;; `org-export-table-row-ends-rowgroup-p',
4350 ;; `org-export-table-row-starts-header-p',
4351 ;; `org-export-table-row-ends-header-p' and
4352 ;; `org-export-table-row-in-header-p' indicate position of current row
4353 ;; or cell within the table.
4356 "Non-nil when TABLE has a special column.
4357 All special columns will be ignored during export."
4358 ;; The table has a special column when every first cell of every row
4359 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4360 ;; "*" "_" and "^". Though, do not consider a first row containing
4361 ;; only empty cells as special.
4377 "Non-nil when TABLE has a header.
4379 INFO is a plist used as a communication channel.
4381 A table has a header when it contains at least two row groups."
4390 table
4401 cache)))))
4404 "Non-nil if TABLE-ROW is considered special.
4406 INFO is a plist used as the communication channel.
4408 All special rows will be ignored during export."
4412 ;; A row is special either when...
4414 ;; ... it starts with a field only containing "/",
4416 ;; ... the table contains a special column and the row start
4417 ;; with a marking character among, "^", "_", "$" or "!",
4421 ;; ... it contains only alignment cookies and empty cells.
4427 ;; Since VALUE is a secondary string, the following
4428 ;; checks avoid expanding it with `org-export-data'.
4440 "Return TABLE-ROW's group number, as an integer.
4442 INFO is a plist used as the communication channel.
4444 Return value is the group number, as an integer, or nil for
4445 special rows and rows separators. First group is also table's
4446 header."
4464 "Return TABLE-CELL contents width.
4466 INFO is a plist used as the communication channel.
4468 Return value is the width given by the last width cookie in the
4469 same column as TABLE-CELL, or nil."
4488 ;; In a special row, try to find a width cookie at COLUMN.
4492 ;; The following checks avoid expanding unnecessarily
4493 ;; the cell with `org-export-data'.
4503 "Return TABLE-CELL contents alignment.
4505 INFO is a plist used as the communication channel.
4507 Return alignment as specified by the last alignment cookie in the
4508 same column as TABLE-CELL. If no such cookie is found, a default
4509 alignment value will be deduced from fraction of numbers in the
4510 column (see `org-table-number-fraction' for more information).
4511 Possible values are `left', `right' and `center'."
4512 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4529 cookie-align
4530 previous-cell-number-p)
4533 ;; In a special row, try to find an alignment cookie at
4534 ;; COLUMN.
4538 ;; Since VALUE is a secondary string, the following
4539 ;; checks avoid useless expansion through
4540 ;; `org-export-data'.
4548 ;; Ignore table rules.
4550 ;; In a standard row, check if cell's contents are
4551 ;; expressing some kind of number. Increase NUMBER-CELLS
4552 ;; accordingly. Though, don't bother if an alignment
4553 ;; cookie has already defined cell's alignment.
4558 info)))
4560 ;; Treat an empty cell as a number if it follows
4561 ;; a number.
4567 ;; Return value. Alignment specified by cookies has
4568 ;; precedence over alignment deduced from cell's contents.
4570 column
4575 org-table-number-fraction)
4580 "Return TABLE-CELL borders.
4582 INFO is a plist used as a communication channel.
4584 Return value is a list of symbols, or nil. Possible values are:
4585 `top', `bottom', `above', `below', `left' and `right'. Note:
4586 `top' (resp. `bottom') only happen for a cell in the first
4587 row (resp. last row) of the table, ignoring table rules, if any.
4589 Returned borders ignore special rows."
4592 borders)
4593 ;; Top/above border? TABLE-CELL has a border above when a rule
4594 ;; used to demarcate row groups can be found above. Hence,
4595 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4596 ;; another regular row has to be found above that rule.
4605 ;; Look at every row before the current one.
4607 ;; No rule above, or rule found starts the table (ignoring any
4608 ;; special row): TABLE-CELL is at the top of the table.
4611 ;; Bottom/below border? TABLE-CELL has a border below when next
4612 ;; non-regular row below is a rule.
4621 ;; Look at every row after the current one.
4623 ;; No rule below, or rule found ends the table (modulo some
4624 ;; special row): TABLE-CELL is at the bottom of the table.
4627 ;; Right/left borders? They can only be specified by column
4628 ;; groups. Column groups are defined in a row starting with "/".
4629 ;; Also a column groups row only contains "<", "<>", ">" or blank
4630 ;; cells.
4647 ;; There's a left border when previous cell, if
4648 ;; any, ends a group, or current one starts one.
4654 ;; There's a right border when next cell, if any,
4655 ;; starts a group, or current one ends one.
4662 ;; Table rows are read in reverse order so last column groups
4663 ;; row has precedence over any previous one.
4665 ;; Return value.
4666 borders))
4669 "Non-nil when TABLE-CELL is at the beginning of a column group.
4670 INFO is a plist used as a communication channel."
4671 ;; A cell starts a column group either when it is at the beginning
4672 ;; of a row (or after the special column, if any) or when it has
4673 ;; a left border.
4676 table-cell)
4680 "Non-nil when TABLE-CELL is at the end of a column group.
4681 INFO is a plist used as a communication channel."
4682 ;; A cell ends a column group either when it is at the end of a row
4683 ;; or when it has a right border.
4686 table-cell)
4690 "Non-nil when TABLE-ROW is at the beginning of a row group.
4691 INFO is a plist used as a communication channel."
4699 "Non-nil when TABLE-ROW is at the end of a row group.
4700 INFO is a plist used as a communication channel."
4708 "Non-nil when TABLE-ROW is located within table's header.
4709 INFO is a plist used as a communication channel. Always return
4710 nil for special rows and rows separators."
4716 "Non-nil when TABLE-ROW is the first table header's row.
4717 INFO is a plist used as a communication channel."
4722 "Non-nil when TABLE-ROW is the last table header's row.
4723 INFO is a plist used as a communication channel."
4728 "Return TABLE-ROW number.
4729 INFO is a plist used as a communication channel. Return value is
4730 zero-based and ignores separators. The function returns nil for
4731 special columns and separators."
4743 "Return TABLE dimensions.
4745 INFO is a plist used as a communication channel.
4747 Return value is a CONS like (ROWS . COLUMNS) where
4748 ROWS (resp. COLUMNS) is the number of exportable
4749 rows (resp. columns)."
4751 ;; Set number of rows, and extract first one.
4757 ;; Set number of columns.
4759 ;; Return value.
4763 "Return address of a regular TABLE-CELL object.
4765 TABLE-CELL is the cell considered. INFO is a plist used as
4766 a communication channel.
4768 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4769 zero-based index. Only exportable cells are considered. The
4770 function returns nil for other cells."
4782 "Return regular table-cell object at ADDRESS in TABLE.
4784 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4785 zero-based index. TABLE is a table type element. INFO is
4786 a plist used as a communication channel.
4788 If no table-cell, among exportable cells, is found at ADDRESS,
4789 return nil."
4792 ;; Row at (car address) or nil.
4800 'table-cell
4807 ;;;; For Tables Of Contents
4808 ;;
4809 ;; `org-export-collect-headlines' builds a list of all exportable
4810 ;; headline elements, maybe limited to a certain depth. One can then
4811 ;; easily parse it and transcode it.
4812 ;;
4813 ;; Building lists of tables, figures or listings is quite similar.
4814 ;; Once the generic function `org-export-collect-elements' is defined,
4815 ;; `org-export-collect-tables', `org-export-collect-figures' and
4816 ;; `org-export-collect-listings' can be derived from it.
4819 "Collect headlines in order to build a table of contents.
4821 INFO is a plist used as a communication channel.
4823 When optional argument N is an integer, it specifies the depth of
4824 the table of contents. Otherwise, it is set to the value of the
4825 last headline level. See `org-export-headline-levels' for more
4826 information.
4828 Optional argument SCOPE, when non-nil, is an element. If it is
4829 a headline, only children of SCOPE are collected. Otherwise,
4830 collect children of the headline containing provided element. If
4831 there is no such headline, collect all headlines. In any case,
4832 argument N becomes relative to the level of that headline.
4834 Return a list of all exportable headlines as parsed elements.
4835 Footnote sections are ignored."
4844 limit))))
4850 info)))
4853 "Collect referenceable elements of a determined type.
4855 TYPE can be a symbol or a list of symbols specifying element
4856 types to search. Only elements with a caption are collected.
4858 INFO is a plist used as a communication channel.
4860 When non-nil, optional argument PREDICATE is a function accepting
4861 one argument, an element of type TYPE. It returns a non-nil
4862 value when that element should be collected.
4864 Return a list of all elements found, in order of appearance."
4869 element))
4870 info))
4873 "Build a list of tables.
4874 INFO is a plist used as a communication channel.
4876 Return a list of table elements with a caption."
4880 "Build a list of figures.
4882 INFO is a plist used as a communication channel. PREDICATE is
4883 a function which accepts one argument: a paragraph element and
4884 whose return value is non-nil when that element should be
4885 collected.
4887 A figure is a paragraph type element, with a caption, verifying
4889 a vague concept that may depend on back-end.
4891 Return a list of elements recognized as figures."
4895 "Build a list of src blocks.
4897 INFO is a plist used as a communication channel.
4899 Return a list of src-block elements with a caption."
4903 ;;;; Smart Quotes
4904 ;;
4905 ;; The main function for the smart quotes sub-system is
4906 ;; `org-export-activate-smart-quotes', which replaces every quote in
4907 ;; a given string from the parse tree with its "smart" counterpart.
4908 ;;
4909 ;; Dictionary for smart quotes is stored in
4910 ;; `org-export-smart-quotes-alist'.
4911 ;;
4912 ;; Internally, regexps matching potential smart quotes (checks at
4913 ;; string boundaries are also necessary) are defined in
4914 ;; `org-export-smart-quotes-regexps'.
4918 ;; one may use: »...«, "...", ›...‹, or '...'.
4919 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4920 ;; LaTeX quotes require Babel!
4965 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4974 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4983 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4992 ;; 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
4993 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5004 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5010 )
5011 "Smart quotes translations.
5013 Alist whose CAR is a language string and CDR is an alist with
5014 quote type as key and a plist associating various encodings to
5015 their translation as value.
5017 A quote type can be any symbol among `opening-double-quote',
5018 `closing-double-quote', `opening-single-quote',
5019 `closing-single-quote' and `apostrophe'.
5021 Valid encodings include `:utf-8', `:html', `:latex' and
5022 `:texinfo'.
5028 ;; Possible opening quote at beginning of string.
5030 ;; Possible closing quote at beginning of string.
5032 ;; Possible apostrophe at beginning of string.
5034 ;; Opening single and double quotes.
5036 ;; Closing single and double quotes.
5038 ;; Apostrophe.
5040 ;; Possible opening quote at end of string.
5042 ;; Possible closing quote at end of string.
5044 ;; Possible apostrophe at end of string.
5046 "List of regexps matching a quote or an apostrophe.
5052 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5053 `:utf-8'. INFO is a plist used as a communication channel.
5055 The function has to retrieve information about string
5056 surroundings in parse tree. It can only happen with an
5057 unmodified string. Thus, if S has already been through another
5058 process, a non-nil ORIGINAL optional argument will provide that
5059 original string.
5061 Return the new string."
5064 ;; Try to be flexible when computing number of blanks
5065 ;; before object. The previous object may be a string
5066 ;; introduced by the back-end and not completely parsed.
5069 ;; A string with missing `:post-blank'
5070 ;; property.
5074 ;; Fallback value.
5079 ;; Return smart quote associated to a give quote Q, as
5080 ;; a string. TYPE is a symbol among `open', `close' and
5081 ;; `apostrophe'.
5091 org-export-smart-quotes-alist))))
5092 encoding)
5093 q)))))
5095 ;; Only a quote: no regexp can match. We have to check both
5096 ;; sides and decide what to do.
5104 ;; 1. Replace quote character at the beginning of S.
5106 ;; Apostrophe?
5112 ;; Closing quote?
5118 ;; Opening quote?
5124 ;; 2. Replace quotes in the middle of the string.
5126 ;; Opening quotes.
5132 ;; Closing quotes.
5138 ;; Apostrophes.
5143 ;; 3. Replace quote character at the end of S.
5145 ;; Apostrophe?
5150 ;; Closing quote?
5156 ;; Opening quote?
5161 ;; Return string with smart quotes.
5162 s))))
5164 ;;;; Topology
5165 ;;
5166 ;; Here are various functions to retrieve information about the
5167 ;; neighborhood of a given element or object. Neighbors of interest
5168 ;; are direct parent (`org-export-get-parent'), parent headline
5169 ;; (`org-export-get-parent-headline'), first element containing an
5170 ;; object, (`org-export-get-parent-element'), parent table
5171 ;; (`org-export-get-parent-table'), previous element or object
5172 ;; (`org-export-get-previous-element') and next element or object
5173 ;; (`org-export-get-next-element').
5175 ;; defsubst org-export-get-parent must be defined before first use
5181 "Return BLOB parent headline or nil.
5182 BLOB is the element or object being considered."
5186 "Return first element containing OBJECT or nil.
5187 OBJECT is the object to consider."
5191 "Return OBJECT parent table or nil.
5192 OBJECT is either a `table-cell' or `table-element' type object."
5196 "Return previous element or object.
5198 BLOB is an element or object. INFO is a plist used as
5199 a communication channel. Return previous exportable element or
5200 object, a string, or nil.
5202 When optional argument N is a positive integer, return a list
5203 containing up to N siblings before BLOB, from farthest to
5204 closest. With any other non-nil value, return a list containing
5205 all of them."
5211 prev)
5221 "Return next element or object.
5223 BLOB is an element or object. INFO is a plist used as
5224 a communication channel. Return next exportable element or
5225 object, a string, or nil.
5227 When optional argument N is a positive integer, return a list
5228 containing up to N siblings after BLOB, from closest to farthest.
5229 With any other non-nil value, return a list containing all of
5230 them."
5237 next)
5247 ;;;; Translation
5248 ;;
5249 ;; `org-export-translate' translates a string according to the language
5250 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5251 ;; the dictionary used for the translation.
5299 ("ru" :html "(Продолжение следует)"
5402 ("ru" :html "Список распечаток"
5416 ("ru" :html "Список таблиц"
5508 ("ru" :html "Неизвестная ссылка"
5511 "Dictionary for export engine.
5513 Alist whose car is the string to translate and cdr is an alist
5514 whose car is the language string and cdr is a plist whose
5515 properties are possible charsets and values translated terms.
5517 It is used as a database for `org-export-translate'. Since this
5518 function returns the string as-is if no translation was found,
5519 the variable only needs to record values different from the
5523 "Translate string S according to language specification.
5525 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5526 and `:utf-8'. INFO is a plist used as a communication channel.
5528 Translation depends on `:language' property. Return the
5529 translated string. If no translation is found, try to fall back
5530 to `:default' encoding. If it fails, return S."
5536 s)))
5539 \f
5540 ;;; Asynchronous Export
5541 ;;
5542 ;; `org-export-async-start' is the entry point for asynchronous
5543 ;; export. It recreates current buffer (including visibility,
5544 ;; narrowing and visited file) in an external Emacs process, and
5545 ;; evaluates a command there. It then applies a function on the
5546 ;; returned results in the current process.
5547 ;;
5548 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5549 ;; allow to export to a buffer or a file, asynchronously or not.
5550 ;;
5551 ;; `org-export-output-file-name' is an auxiliary function meant to be
5552 ;; used with `org-export-to-file'. With a given extension, it tries
5553 ;; to provide a canonical file name to write export output to.
5554 ;;
5555 ;; Asynchronously generated results are never displayed directly.
5556 ;; Instead, they are stored in `org-export-stack-contents'. They can
5557 ;; then be retrieved by calling `org-export-stack'.
5558 ;;
5559 ;; Export Stack is viewed through a dedicated major mode
5560 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5561 ;;`org-export-stack-delete', `org-export-stack-view' and
5562 ;;`org-export-stack-clear'.
5563 ;;
5564 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5565 ;; It should be used whenever `org-export-async-start' is called.
5568 "Call function FUN on the results returned by BODY evaluation.
5570 FUN is an anonymous function of one argument. BODY evaluation
5571 happens in an asynchronous process, from a buffer which is an
5572 exact copy of the current one.
5574 Use `org-export-add-to-stack' in FUN in order to register results
5575 in the stack.
5577 This is a low level function. See also `org-export-to-buffer'
5578 and `org-export-to-file' for more specialized functions."
5581 ;; Write the full sexp evaluating BODY in a copy of the current
5582 ;; buffer to a temporary file, as it may be too long for program
5583 ;; args in `start-process'.
5590 ;; Null characters (from variable values) are inserted
5591 ;; within the file. As a consequence, coding system for
5592 ;; buffer contents will not be recognized properly. So,
5593 ;; we make sure it is the same as the one used to display
5594 ;; the original buffer.
5596 ,coding
5599 ;; Ignore `kill-emacs-hook' and code evaluation
5600 ;; queries from Babel as we need a truly
5601 ;; non-interactive process.
5603 org-babel-confirm-evaluate-answer-no t)
5604 ;; Initialize export framework.
5606 ;; Re-create current buffer there.
5609 ;; Sexp to evaluate in the buffer.
5611 ;; Start external process.
5614 (,process
5616 #'start-process
5619 ,proc-buffer
5626 ;; Register running process in stack.
5628 ;; Set-up sentinel in order to catch results.
5631 ,process
5653 ;;;###autoload
5656 &optional async subtreep visible-only body-only ext-plist
5657 post-process)
5658 "Call `org-export-as' with output to a specified buffer.
5660 BACKEND is either an export back-end, as returned by, e.g.,
5661 `org-export-create-backend', or a symbol referring to
5662 a registered back-end.
5664 BUFFER is the name of the output buffer. If it already exists,
5665 it will be erased first, otherwise, it will be created.
5667 A non-nil optional argument ASYNC means the process should happen
5668 asynchronously. The resulting buffer should then be accessible
5669 through the `org-export-stack' interface. When ASYNC is nil, the
5670 buffer is displayed if `org-export-show-temporary-export-buffer'
5671 is non-nil.
5673 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5674 EXT-PLIST are similar to those used in `org-export-as', which
5675 see.
5677 Optional argument POST-PROCESS is a function which should accept
5678 no argument. It is always called within the current process,
5679 from BUFFER, with point at its beginning. Export back-ends can
5680 use it to set a major mode there, e.g,
5682 \(defun org-latex-export-as-latex
5683 \(&optional async subtreep visible-only body-only ext-plist)
5684 \(interactive)
5686 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5688 This function returns BUFFER."
5716 buffer)))
5718 ;;;###autoload
5721 post-process)
5722 "Call `org-export-as' with output to a specified file.
5724 BACKEND is either an export back-end, as returned by, e.g.,
5725 `org-export-create-backend', or a symbol referring to
5726 a registered back-end. FILE is the name of the output file, as
5727 a string.
5729 A non-nil optional argument ASYNC means the process should happen
5730 asynchronously. The resulting buffer will then be accessible
5731 through the `org-export-stack' interface.
5733 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5734 EXT-PLIST are similar to those used in `org-export-as', which
5735 see.
5737 Optional argument POST-PROCESS is called with FILE as its
5738 argument and happens asynchronously when ASYNC is non-nil. It
5739 has to return a file name, or nil. Export back-ends can use this
5740 to send the output file through additional processing, e.g,
5742 \(defun org-latex-export-to-latex
5743 \(&optional async subtreep visible-only body-only ext-plist)
5744 \(interactive)
5746 \(org-export-to-file 'latex outfile
5747 async subtreep visible-only body-only ext-plist
5748 \(lambda (file) (org-latex-compile file)))
5750 The function returns either a file name returned by POST-PROCESS,
5751 or FILE."
5770 backend subtreep visible-only body-only ext-plist)))
5777 ;; Get proper return value.
5779 file))))))
5782 "Return output file's name according to buffer specifications.
5784 EXTENSION is a string representing the output file extension,
5785 with the leading dot.
5787 With a non-nil optional argument SUBTREEP, try to determine
5789 of subtree at point.
5791 When optional argument PUB-DIR is set, use it as the publishing
5792 directory.
5794 When optional argument VISIBLE-ONLY is non-nil, don't export
5795 contents of hidden elements.
5797 Return file name as a string."
5800 ;; File name may come from EXPORT_FILE_NAME subtree
5801 ;; property, assuming point is at beginning of said
5802 ;; sub-tree.
5809 ;; File name may be extracted from buffer's associated
5810 ;; file, if any.
5812 ;; Can't determine file name on our own: Ask user.
5816 "Output file: " pub-dir nil nil nil
5820 ;; Build file name. Enforce EXTENSION over whatever user
5821 ;; may have come up with. PUB-DIR, if defined, always has
5822 ;; precedence over any provided path.
5827 extension))
5830 ;; If writing to OUTPUT-FILE would overwrite original file, append
5831 ;; EXTENSION another time to final name.
5834 output-file)))
5837 "Add a new result to export stack if not present already.
5839 SOURCE is a buffer or a file name containing export results.
5840 BACKEND is a symbol representing export back-end used to generate
5841 it.
5843 Entries already pointing to SOURCE and unavailable entries are
5844 removed beforehand. Return the new stack."
5850 "Menu for asynchronous export results and running processes."
5860 "Return source from export results at point in stack."
5867 source
5868 ;; SOURCE is not consistent with current line. The stack
5869 ;; view is outdated.
5873 "Remove all entries from export stack."
5878 "Refresh the asynchronous export stack.
5879 DUMMY is ignored. Unavailable sources are removed from the list.
5880 Return the new stack."
5890 ;; Back-end.
5892 ;; Age.
5895 ;; Compute age of the results.
5897 "%4h:%.2m "
5899 ;; Source.
5904 ;; Clear stack from exited processes, dead buffers or
5905 ;; non-existent files.
5917 "Remove export results at point from stack.
5918 If optional argument SOURCE is non-nil, remove it instead."
5923 org-export-stack-contents))))
5926 "View export results at point in stack.
5927 With an optional prefix argument IN-EMACS, force viewing files
5928 within Emacs."
5942 (define-key km "p" 'previous-line)
5943 (define-key km "\C-p" 'previous-line)
5944 (define-key km "\C-?" 'previous-line)
5945 (define-key km [up] 'previous-line)
5946 (define-key km "C" 'org-export-stack-clear)
5947 (define-key km "v" 'org-export-stack-view)
5948 (define-key km (kbd "RET") 'org-export-stack-view)
5949 (define-key km "d" 'org-export-stack-remove)
5950 km)
5951 "Keymap for Org Export Stack.")
5953 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5954 "Mode for displaying asynchronous export stack.
5957 stack.
5959 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5960 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5961 stack completely.
5963 Removing entries in an Org Export Stack buffer doesn't affect
5964 files or buffers, only the display.
5967 (abbrev-mode 0)
5968 (auto-fill-mode 0)
5969 (setq buffer-read-only t
5970 buffer-undo-list t
5971 truncate-lines t
5972 header-line-format
5973 '(:eval
5974 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5975 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5976 (set (make-local-variable 'revert-buffer-function)
5977 'org-export-stack-refresh))
5980 \f
5981 ;;; The Dispatcher
5982 ;;
5983 ;; `org-export-dispatch' is the standard interactive way to start an
5984 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5985 ;; for its interface, which, in turn, delegates response to key
5986 ;; pressed to `org-export--dispatch-action'.
5988 ;;;###autoload
5989 (defun org-export-dispatch (&optional arg)
5990 "Export dispatcher for Org mode.
5992 It provides an access to common export related tasks in a buffer.
5993 Its interface comes in two flavors: standard and expert.
5995 While both share the same set of bindings, only the former
5996 displays the valid keys associations in a dedicated buffer.
5997 Scrolling (resp. line-wise motion) in this buffer is done with
5998 SPC and DEL (resp. C-n and C-p) keys.
6000 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6001 flavor or the other.
6004 of options used back then, on the current buffer.
6006 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6007 (interactive "P")
6008 (let* ((input
6009 (cond ((equal arg '(16)) '(stack))
6010 ((and arg org-export-dispatch-last-action))
6011 (t (save-window-excursion
6012 (unwind-protect
6013 (progn
6014 ;; Remember where we are
6015 (move-marker org-export-dispatch-last-position
6016 (point)
6017 (org-base-buffer (current-buffer)))
6018 ;; Get and store an export command
6019 (setq org-export-dispatch-last-action
6020 (org-export--dispatch-ui
6021 (list org-export-initial-scope
6022 (and org-export-in-background 'async))
6023 nil
6024 org-export-dispatch-use-expert-ui)))
6025 (and (get-buffer "*Org Export Dispatcher*")
6026 (kill-buffer "*Org Export Dispatcher*")))))))
6027 (action (car input))
6028 (optns (cdr input)))
6029 (unless (memq 'subtree optns)
6030 (move-marker org-export-dispatch-last-position nil))
6031 (case action
6032 ;; First handle special hard-coded actions.
6033 (template (org-export-insert-default-template nil optns))
6034 (stack (org-export-stack))
6035 (publish-current-file
6036 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6037 (publish-current-project
6038 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6039 (publish-choose-project
6040 (org-publish (assoc (org-icompleting-read
6041 "Publish project: "
6042 org-publish-project-alist nil t)
6043 org-publish-project-alist)
6044 (memq 'force optns)
6045 (memq 'async optns)))
6046 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6047 (otherwise
6048 (save-excursion
6049 (when arg
6050 ;; Repeating command, maybe move cursor to restore subtree
6051 ;; context.
6052 (if (eq (marker-buffer org-export-dispatch-last-position)
6053 (org-base-buffer (current-buffer)))
6054 (goto-char org-export-dispatch-last-position)
6055 ;; We are in a different buffer, forget position.
6056 (move-marker org-export-dispatch-last-position nil)))
6057 (funcall action
6058 ;; Return a symbol instead of a list to ease
6059 ;; asynchronous export macro use.
6060 (and (memq 'async optns) t)
6061 (and (memq 'subtree optns) t)
6062 (and (memq 'visible optns) t)
6063 (and (memq 'body optns) t)))))))
6065 (defun org-export--dispatch-ui (options first-key expertp)
6066 "Handle interface for `org-export-dispatch'.
6068 OPTIONS is a list containing current interactive options set for
6069 export. It can contain any of the following symbols:
6070 `body' toggles a body-only export
6071 `subtree' restricts export to current subtree
6072 `visible' restricts export to visible part of buffer.
6073 `force' force publishing files.
6074 `async' use asynchronous export process
6076 FIRST-KEY is the key pressed to select the first level menu. It
6077 is nil when this menu hasn't been selected yet.
6079 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6080 buffer is provided, but indications about currently active
6081 options are given in the prompt. Moreover, \[?] allows to switch
6082 back to standard interface."
6083 (let* ((fontify-key
6084 (lambda (key &optional access-key)
6085 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6086 ;; non-nil is the required first-level key to activate
6087 ;; KEY. When its value is t, activate KEY independently
6088 ;; on the first key, if any. A nil value means KEY will
6089 ;; only be activated at first level.
6090 (if (or (eq access-key t) (eq access-key first-key))
6091 (org-propertize key 'face 'org-warning)
6092 key)))
6093 (fontify-value
6094 (lambda (value)
6095 ;; Fontify VALUE string.
6096 (org-propertize value 'face 'font-lock-variable-name-face)))
6097 ;; Prepare menu entries by extracting them from registered
6098 ;; back-ends and sorting them by access key and by ordinal,
6099 ;; if any.
6100 (entries
6101 (sort (sort (delq nil
6102 (mapcar 'org-export-backend-menu
6103 org-export--registered-backends))
6104 (lambda (a b)
6105 (let ((key-a (nth 1 a))
6106 (key-b (nth 1 b)))
6107 (cond ((and (numberp key-a) (numberp key-b))
6108 (< key-a key-b))
6109 ((numberp key-b) t)))))
6110 'car-less-than-car))
6111 ;; Compute a list of allowed keys based on the first key
6112 ;; pressed, if any. Some keys
6113 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6114 ;; available.
6115 (allowed-keys
6116 (nconc (list 2 22 19 6 1)
6117 (if (not first-key) (org-uniquify (mapcar 'car entries))
6118 (let (sub-menu)
6119 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6120 (when (eq (car entry) first-key)
6121 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6122 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6123 ((not first-key) (list ?P)))
6124 (list ?& ?#)
6125 (when expertp (list ??))
6126 (list ?q)))
6127 ;; Build the help menu for standard UI.
6128 (help
6129 (unless expertp
6130 (concat
6131 ;; Options are hard-coded.
6132 (format "[%s] Body only: %s [%s] Visible only: %s
6133 \[%s] Export scope: %s [%s] Force publishing: %s
6135 (funcall fontify-key "C-b" t)
6136 (funcall fontify-value
6137 (if (memq 'body options) "On " "Off"))
6138 (funcall fontify-key "C-v" t)
6139 (funcall fontify-value
6140 (if (memq 'visible options) "On " "Off"))
6141 (funcall fontify-key "C-s" t)
6142 (funcall fontify-value
6143 (if (memq 'subtree options) "Subtree" "Buffer "))
6144 (funcall fontify-key "C-f" t)
6145 (funcall fontify-value
6146 (if (memq 'force options) "On " "Off"))
6147 (funcall fontify-key "C-a" t)
6148 (funcall fontify-value
6149 (if (memq 'async options) "On " "Off")))
6150 ;; Display registered back-end entries. When a key
6151 ;; appears for the second time, do not create another
6152 ;; entry, but append its sub-menu to existing menu.
6153 (let (last-key)
6154 (mapconcat
6155 (lambda (entry)
6156 (let ((top-key (car entry)))
6157 (concat
6158 (unless (eq top-key last-key)
6159 (setq last-key top-key)
6161 (funcall fontify-key (char-to-string top-key))
6162 (nth 1 entry)))
6163 (let ((sub-menu (nth 2 entry)))
6164 (unless (functionp sub-menu)
6165 ;; Split sub-menu into two columns.
6166 (let ((index -1))
6167 (concat
6168 (mapconcat
6169 (lambda (sub-entry)
6170 (incf index)
6171 (format
6172 (if (zerop (mod index 2)) " [%s] %-26s"
6174 (funcall fontify-key
6175 (char-to-string (car sub-entry))
6176 top-key)
6177 (nth 1 sub-entry)))
6178 sub-menu "")
6180 entries ""))
6181 ;; Publishing menu is hard-coded.
6183 [%s] Current file [%s] Current project
6185 (funcall fontify-key "P")
6186 (funcall fontify-key "f" ?P)
6187 (funcall fontify-key "p" ?P)
6188 (funcall fontify-key "x" ?P)
6189 (funcall fontify-key "a" ?P))
6191 (funcall fontify-key "&" t)
6192 (funcall fontify-key "#" t))
6193 (format "[%s] %s"
6194 (funcall fontify-key "q" t)
6195 (if first-key "Main menu" "Exit")))))
6196 ;; Build prompts for both standard and expert UI.
6197 (standard-prompt (unless expertp "Export command: "))
6198 (expert-prompt
6199 (when expertp
6200 (format
6201 "Export command (C-%s%s%s%s%s) [%s]: "
6202 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6203 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6204 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6205 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6206 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6207 (mapconcat (lambda (k)
6208 ;; Strip control characters.
6209 (unless (< k 27) (char-to-string k)))
6210 allowed-keys "")))))
6211 ;; With expert UI, just read key with a fancy prompt. In standard
6212 ;; UI, display an intrusive help buffer.
6213 (if expertp
6214 (org-export--dispatch-action
6215 expert-prompt allowed-keys entries options first-key expertp)
6216 ;; At first call, create frame layout in order to display menu.
6217 (unless (get-buffer "*Org Export Dispatcher*")
6218 (delete-other-windows)
6219 (org-switch-to-buffer-other-window
6220 (get-buffer-create "*Org Export Dispatcher*"))
6221 (setq cursor-type nil
6222 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6223 ;; Make sure that invisible cursor will not highlight square
6224 ;; brackets.
6225 (set-syntax-table (copy-syntax-table))
6226 (modify-syntax-entry ?\[ "w"))
6227 ;; At this point, the buffer containing the menu exists and is
6228 ;; visible in the current window. So, refresh it.
6229 (with-current-buffer "*Org Export Dispatcher*"
6230 ;; Refresh help. Maintain display continuity by re-visiting
6231 ;; previous window position.
6232 (let ((pos (window-start)))
6233 (erase-buffer)
6234 (insert help)
6235 (set-window-start nil pos)))
6236 (org-fit-window-to-buffer)
6237 (org-export--dispatch-action
6238 standard-prompt allowed-keys entries options first-key expertp))))
6240 (defun org-export--dispatch-action
6241 (prompt allowed-keys entries options first-key expertp)
6242 "Read a character from command input and act accordingly.
6244 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6245 a list of characters available at a given step in the process.
6246 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6247 EXPERTP are the same as defined in `org-export--dispatch-ui',
6248 which see.
6250 Toggle export options when required. Otherwise, return value is
6251 a list with action as CAR and a list of interactive export
6252 options as CDR."
6253 (let (key)
6254 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6255 ;; C-p, SPC, DEL).
6256 (while (and (setq key (read-char-exclusive prompt))
6257 (not expertp)
6258 (memq key '(14 16 ?\s ?\d)))
6259 (case key
6260 (14 (if (not (pos-visible-in-window-p (point-max)))
6261 (ignore-errors (scroll-up 1))
6262 (message "End of buffer")
6263 (sit-for 1)))
6264 (16 (if (not (pos-visible-in-window-p (point-min)))
6265 (ignore-errors (scroll-down 1))
6266 (message "Beginning of buffer")
6267 (sit-for 1)))
6268 (?\s (if (not (pos-visible-in-window-p (point-max)))
6269 (scroll-up nil)
6270 (message "End of buffer")
6271 (sit-for 1)))
6272 (?\d (if (not (pos-visible-in-window-p (point-min)))
6273 (scroll-down nil)
6274 (message "Beginning of buffer")
6275 (sit-for 1)))))
6276 (cond
6277 ;; Ignore undefined associations.
6278 ((not (memq key allowed-keys))
6279 (ding)
6280 (unless expertp (message "Invalid key") (sit-for 1))
6281 (org-export--dispatch-ui options first-key expertp))
6282 ;; q key at first level aborts export. At second level, cancel
6283 ;; first key instead.
6284 ((eq key ?q) (if (not first-key) (error "Export aborted")
6285 (org-export--dispatch-ui options nil expertp)))
6286 ;; Help key: Switch back to standard interface if expert UI was
6287 ;; active.
6288 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6289 ;; Send request for template insertion along with export scope.
6290 ((eq key ?#) (cons 'template (memq 'subtree options)))
6291 ;; Switch to asynchronous export stack.
6292 ((eq key ?&) '(stack))
6293 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6294 ((memq key '(2 22 19 6 1))
6295 (org-export--dispatch-ui
6296 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6297 (6 'force) (1 'async))))
6298 (if (memq option options) (remq option options)
6299 (cons option options)))
6300 first-key expertp))
6301 ;; Action selected: Send key and options back to
6302 ;; `org-export-dispatch'.
6303 ((or first-key (functionp (nth 2 (assq key entries))))
6304 (cons (cond
6305 ((not first-key) (nth 2 (assq key entries)))
6306 ;; Publishing actions are hard-coded. Send a special
6307 ;; signal to `org-export-dispatch'.
6308 ((eq first-key ?P)
6309 (case key
6310 (?f 'publish-current-file)
6311 (?p 'publish-current-project)
6312 (?x 'publish-choose-project)
6313 (?a 'publish-all)))
6314 ;; Return first action associated to FIRST-KEY + KEY
6315 ;; path. Indeed, derived backends can share the same
6316 ;; FIRST-KEY.
6317 (t (catch 'found
6318 (mapc (lambda (entry)
6319 (let ((match (assq key (nth 2 entry))))
6320 (when match (throw 'found (nth 2 match)))))
6321 (member (assq first-key entries) entries)))))
6322 options))
6323 ;; Otherwise, enter sub-menu.
6324 (t (org-export--dispatch-ui options key expertp)))))
6328 (provide 'ox)
6330 ;; Local variables:
6331 ;; generated-autoload-file: "org-loaddefs.el"
6332 ;; End:
6334 ;;; ox.el ends here