| blob | 6a169974b9d062b2a6862b68c1cafd0bc72d953d |
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.
142 "Alist between export properties and ways to set them.
144 The CAR of the alist is the property name, and the CDR is a list
145 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
147 KEYWORD is a string representing a buffer keyword, or nil. Each
148 property defined this way can also be set, during subtree
149 export, through a headline property named after the keyword
151 property).
152 OPTION is a string that could be found in an #+OPTIONS: line.
153 DEFAULT is the default value for the property.
154 BEHAVIOR determines how Org should handle multiple keywords for
155 the same property. It is a symbol among:
156 nil Keep old value and discard the new one.
157 t Replace old value with the new one.
158 `space' Concatenate the values, separating them with a space.
159 `newline' Concatenate the values, separating them with
160 a newline.
161 `split' Split values at white spaces, and cons them to the
162 previous list.
164 Values set through KEYWORD and OPTION have precedence over
165 DEFAULT.
167 All these properties should be back-end agnostic. Back-end
168 specific properties are set through `org-export-define-backend'.
172 "List of in-buffer keywords that require special treatment.
173 These keywords are not directly associated to a property. The
174 way they are handled must be hard-coded into
234 "Alist between filters properties and initial values.
236 The key of each association is a property name accessible through
237 the communication channel. Its value is a configurable global
238 variable defining initial filters.
240 This list is meant to install user specified filters. Back-end
241 developers may install their own filters using
242 `org-export-define-backend'. Filters defined there will always
243 be prepended to the current list, so they always get applied
252 "Default rule for link matching an inline image.
253 This rule applies to links with no description. By default, it
254 will be considered as an inline image if it targets a local file
257 See `org-export-inline-image-p' for more information about
262 org-element--cache org-element--cache-objects org-element--cache-sync-keys
263 org-element--cache-sync-requests org-element--cache-sync-timer)
264 "List of variables not copied through upon buffer duplication.
265 Export process takes place on a copy of the original buffer.
266 When this copy is created, all Org related local variables not in
267 this list are copied to the new buffer. Variables with an
271 "Non-nil means asynchronous export process should leave data behind.
275 located in `temporary-file-directory'.
277 When non-nil, it will also set `debug-on-error' to a non-nil
281 "Record asynchronously generated export results and processes.
282 This is an alist: its CAR is the source of the
283 result (destination file or buffer for a finished process,
284 original buffer for a running one) and its CDR is a list
285 containing the back-end used, as a symbol, and either a process
286 or the time at which it finished. It is used to build the menu
290 "List of backends currently available in the exporter.
291 This variable is set with `org-export-define-backend' and
295 "Last command called from the dispatcher.
296 The value should be a list. Its CAR is the action, as a symbol,
300 "The position where the last export command was created using the dispatcher.
301 This marker will be used with `C-u C-c C-e' to make sure export repetition
304 ;; For compatibility with Org < 8
306 "Name, if any, of the back-end used during an export process.
308 Its value is a symbol such as `html', `latex', `ascii', or nil if
309 the back-end is anonymous (see `org-export-create-backend') or if
310 there is no export process in progress.
312 It can be used to teach Babel blocks how to act differently
316 \f
317 ;;; User-configurable Variables
318 ;;
319 ;; Configuration for the masses.
320 ;;
321 ;; They should never be accessed directly, as their value is to be
322 ;; stored in a property list (cf. `org-export-options-alist').
323 ;; Back-ends will read their value from there instead.
326 "Options for exporting Org mode files."
331 "General options for export engine."
336 "Whether sub-trees with the ARCHIVE tag should be exported.
338 This can have three different values:
339 nil Do not export, pretend this tree is not present.
340 t Do export the entire tree.
341 `headline' Only export the headline, but skip the tree below it.
343 This option can also be set with the OPTIONS keyword,
352 "Non-nil means insert author name into the exported file.
353 This option can also be set with the OPTIONS keyword,
359 "Non-nil means export CLOCK keywords.
360 This option can also be set with the OPTIONS keyword,
366 "Non-nil means the postamble should contain a creator sentence.
368 The sentence can be set in `org-export-creator-string' and
371 If the value is `comment' insert it as a comment."
379 "Non-nil means insert date in the exported document.
380 This option can also be set with the OPTIONS keyword,
386 "Time-stamp format string to use for DATE keyword.
388 The format string, when specified, only applies if date consists
389 in a single time-stamp. Otherwise its value will be ignored.
391 See `format-time-string' for details on how to build this
392 string."
400 emacs-version
402 "Information about the creator of the document.
403 This option can also be set on with the CREATOR keyword."
408 "Non-nil means export contents of standard drawers.
410 When t, all drawers are exported. This may also be a list of
411 drawer names to export, as strings. If that list starts with
412 `not', only drawers with such names will be ignored.
414 This variable doesn't apply to properties drawers. See
415 `org-export-with-properties' instead.
417 This option can also be set with the OPTIONS keyword,
430 :inline t
434 "Non-nil means insert author email into the exported file.
435 This option can also be set with the OPTIONS keyword,
441 "Non-nil means interpret *word*, /word/, _word_ and +word+.
443 If the export target supports emphasizing text, the word will be
444 typeset in bold, italic, with an underline or strike-through,
445 respectively.
447 This option can also be set with the OPTIONS keyword,
453 "Tags that exclude a tree from export.
455 All trees carrying any of these tags will be excluded from
456 export. This is without condition, so even subtrees inside that
457 carry one of the `org-export-select-tags' will be removed.
459 This option can also be set with the EXCLUDE_TAGS keyword."
465 This option can also be set with the OPTIONS keyword,
473 "Non-nil means Org footnotes should be exported.
474 This option can also be set with the OPTIONS keyword,
480 "Non-nil means process LaTeX environments and fragments.
482 This option can also be set with the OPTIONS line,
485 nil Ignore math snippets.
486 `verbatim' Keep everything in verbatim.
487 t Allow export of math snippets."
497 "The last level which is still exported as a headline.
499 Inferior levels will usually produce itemize or enumerate lists
500 when exported, but back-end behaviour may differ.
502 This option can also be set with the OPTIONS keyword,
508 "The default language for export and clocktable translations, as a string.
509 This may have an association in
510 `org-clock-clocktable-language-setup',
511 `org-export-smart-quotes-alist' and `org-export-dictionary'.
512 This option can also be set with the LANGUAGE keyword."
517 "Non-nil means preserve all line breaks when exporting.
518 This option can also be set with the OPTIONS keyword,
524 "Non-nil means interpret entities when exporting.
527 Å.
529 For a list of supported names, see the constant `org-entities'
530 and the user option `org-entities-user'.
532 This option can also be set with the OPTIONS keyword,
538 "Non-nil means inlinetasks should be exported.
539 This option can also be set with the OPTIONS keyword,
547 "Non-nil means include planning info in export.
549 Planning info is the line containing either SCHEDULED:,
550 DEADLINE:, CLOSED: time-stamps, or a combination of them.
552 This option can also be set with the OPTIONS keyword,
560 "Non-nil means include priority cookies in export.
561 This option can also be set with the OPTIONS keyword,
567 "Non-nil means export contents of properties drawers.
569 When t, all properties are exported. This may also be a list of
570 properties to export, as strings.
572 This option can also be set with the OPTIONS keyword,
584 "Non-nil means add section numbers to headlines when exporting.
586 When set to an integer n, numbering will only happen for
587 headlines whose relative level is higher or equal to n.
589 This option can also be set with the OPTIONS keyword,
595 "Tags that select a tree for export.
597 If any such tag is found in a buffer, all trees that do not carry
598 one of these tags will be ignored during export. Inside trees
599 that are selected like this, you can still deselect a subtree by
600 tagging it with one of the `org-export-exclude-tags'.
602 This option can also be set with the SELECT_TAGS keyword."
607 "Non-nil means activate smart quotes during export.
608 This option can also be set with the OPTIONS keyword,
611 When setting this to non-nil, you need to take care of
612 using the correct Babel package when exporting to LaTeX.
613 E.g., you can load Babel for french like this:
624 When this option is turned on, these strings will be exported as:
626 Org HTML LaTeX UTF-8
627 -----+----------+--------+-------
629 -- – -- –
630 --- — --- —
633 This option can also be set with the OPTIONS keyword,
639 "Non-nil means include statistics cookies in export.
640 This option can also be set with the OPTIONS keyword,
650 If you want to control how Org displays those characters, see
651 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
652 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
653 it is not anymore.
655 When this option is turned on, you can use TeX-like syntax for
656 sub- and superscripts and see them exported correctly.
658 You can also set the option with #+OPTIONS: ^:t
661 single item - so grouping with {} is normally not needed. For
662 example, the following things will be parsed as single sub- or
663 superscripts:
665 10^24 or 10^tau several digits will be considered 1 item.
666 10^-12 or 10^-tau a leading sign with digits or a word
667 x^2-y^3 will be read as x^2 - y^3, because items are
668 terminated by almost any nonword/nondigit char.
669 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
671 Still, ambiguity is possible. So when in doubt, use {} to enclose
672 the sub/superscript. If you set this variable to the symbol `{}',
673 the braces are *required* in order to trigger interpretations as
675 frequently in plain text."
685 "Non-nil means create a table of contents in exported files.
687 The TOC contains headlines with levels up
688 to`org-export-headline-levels'. When an integer, include levels
689 up to N in the toc, this may then be different from
690 `org-export-headline-levels', but it will not be allowed to be
691 larger than the number of headline levels. When nil, no table of
692 contents is made.
694 This option can also be set with the OPTIONS keyword,
703 "Non-nil means export tables.
704 This option can also be set with the OPTIONS keyword,
712 "If nil, do not export tags, just remove them from headlines.
714 If this is the symbol `not-in-toc', tags will be removed from
715 table of contents entries, but still be shown in the headlines of
716 the document.
718 This option can also be set with the OPTIONS keyword,
727 "Non-nil means include TODO items for export.
729 This may have the following values:
730 t include tasks independent of state.
731 `todo' include only tasks that are not yet done.
732 `done' include only tasks that are already done.
733 nil ignore all tasks.
734 list of keywords include tasks with these keywords.
736 This option can also be set with the OPTIONS keyword,
748 "Non-nil means print title into the exported file.
749 This option can also be set with the OPTIONS keyword,
757 "Non-nil means insert a time stamp into the exported file.
758 The time stamp shows when the file was created. This option can
764 "Non nil means allow timestamps in export.
766 It can be set to any of the following values:
767 t export all timestamps.
768 `active' export active timestamps only.
769 `inactive' export inactive timestamps only.
770 nil do not export timestamps
772 This only applies to timestamps isolated in a paragraph
773 containing only timestamps. Other timestamps are always
774 exported.
776 This option can also be set with the OPTIONS keyword, e.g.
786 "Non-nil means include TODO keywords in export.
787 When nil, remove all these keywords from the export. This option
793 "Non-nil means BIND keywords can define local variable values.
794 This is a potential security risk, which is why the default value
795 is nil. You can also allow them through local buffer variables."
802 "Alist between export snippets back-ends and exporter back-ends.
804 This variable allows to provide shortcuts for export snippets.
808 HTML code while every other back-end will ignore it."
817 "Coding system for the exported file."
824 "Non-nil means pushing export output to the kill ring.
825 This variable is ignored during asynchronous export."
835 "The initial scope when exporting with `org-export-dispatch'.
836 This variable can be either set to `buffer' or `subtree'."
843 "Non-nil means show buffer after exporting to temp buffer.
844 When Org exports to a file, the buffer visiting that file is never
845 shown, but remains buried. However, when exporting to
846 a temporary buffer, that buffer is popped up in a second window.
847 When this variable is nil, the buffer remains buried also in
848 these cases."
853 "Non-nil means export and publishing commands will run in background.
854 Results from an asynchronous export are never displayed
862 "File used to initialize external export process.
864 Value must be either nil or an absolute file name. When nil, the
865 external process is launched like a regular Emacs session,
866 loading user's initialization file and any site specific
867 configuration. If a file is provided, it, and only it, is loaded
868 at start-up.
870 Therefore, using a specific configuration makes the process to
871 load faster and the export more portable."
880 "Non-nil means using a non-intrusive `org-export-dispatch'.
881 In that case, no help buffer is displayed. Though, an indicator
887 asynchronous). Also, \[?] allows to switch back to standard
888 mode."
895 \f
896 ;;; Defining Back-ends
897 ;;
898 ;; An export back-end is a structure with `org-export-backend' type
899 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
900 ;; and `menu' slots.
901 ;;
902 ;; At the lowest level, a back-end is created with
903 ;; `org-export-create-backend' function.
904 ;;
905 ;; A named back-end can be registered with
906 ;; `org-export-register-backend' function. A registered back-end can
907 ;; later be referred to by its name, with `org-export-get-backend'
908 ;; function. Also, such a back-end can become the parent of a derived
909 ;; back-end from which slot values will be inherited by default.
910 ;; `org-export-derived-backend-p' can check if a given back-end is
911 ;; derived from a list of back-end names.
912 ;;
913 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
914 ;; `org-export-get-all-filters' return the full alist of transcoders,
915 ;; options and filters, including those inherited from ancestors.
916 ;;
917 ;; At a higher level, `org-export-define-backend' is the standard way
918 ;; to define an export back-end. If the new back-end is similar to
919 ;; a registered back-end, `org-export-define-derived-backend' may be
920 ;; used instead.
921 ;;
922 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
923 ;; when a given back-end hasn't been registered yet.
927 name parent transcoders options filters blocks menu)
930 "Return export back-end named after NAME.
931 NAME is a symbol. Return nil if no such back-end is found."
938 "Register BACKEND as a known export back-end.
939 BACKEND is a structure with `org-export-backend' type."
940 ;; Refuse to register an unnamed back-end.
943 ;; Refuse to register a back-end with an unknown parent.
947 ;; Register dedicated export blocks in the parser.
951 ;; If a back-end with the same name as BACKEND is already
952 ;; registered, replace it with BACKEND. Otherwise, simply add
953 ;; BACKEND to the list of registered back-ends.
959 "Signal an error if BACKEND isn't defined."
964 "Non-nil if BACKEND is derived from one of BACKENDS.
965 BACKEND is an export back-end, as returned by, e.g.,
966 `org-export-create-backend', or a symbol referring to
967 a registered back-end. BACKENDS is constituted of symbols."
979 "Return full translation table for BACKEND.
981 BACKEND is an export back-end, as return by, e.g,,
982 `org-export-create-backend'. Return value is an alist where
983 keys are element or object types, as symbols, and values are
984 transcoders.
986 Unlike to `org-export-backend-transcoders', this function
987 also returns transcoders inherited from parent back-ends,
988 if any."
992 parent)
997 transcoders)))
1000 "Return export options for BACKEND.
1002 BACKEND is an export back-end, as return by, e.g,,
1003 `org-export-create-backend'. See `org-export-options-alist'
1004 for the shape of the return value.
1006 Unlike to `org-export-backend-options', this function also
1007 returns options inherited from parent back-ends, if any."
1011 parent)
1015 options)))
1018 "Return complete list of filters for BACKEND.
1020 BACKEND is an export back-end, as return by, e.g,,
1021 `org-export-create-backend'. Return value is an alist where
1022 keys are symbols and values lists of functions.
1024 Unlike to `org-export-backend-filters', this function also
1025 returns filters inherited from parent back-ends, if any."
1029 parent)
1033 filters)))
1036 "Define a new back-end BACKEND.
1038 TRANSCODERS is an alist between object or element types and
1039 functions handling them.
1041 These functions should return a string without any trailing
1042 space, or nil. They must accept three arguments: the object or
1043 element itself, its contents or nil when it isn't recursive and
1044 the property list used as a communication channel.
1046 Contents, when not nil, are stripped from any global indentation
1047 \(although the relative one is preserved). They also always end
1048 with a single newline character.
1050 If, for a given type, no function is found, that element or
1051 object type will simply be ignored, along with any blank line or
1052 white space at its end. The same will happen if the function
1053 returns the nil value. If that function returns the empty
1054 string, the type will be ignored, but the blank lines or white
1055 spaces will be kept.
1057 In addition to element and object types, one function can be
1058 associated to the `template' (or `inner-template') symbol and
1059 another one to the `plain-text' symbol.
1061 The former returns the final transcoded string, and can be used
1062 to add a preamble and a postamble to document's body. It must
1063 accept two arguments: the transcoded string and the property list
1064 containing export options. A function associated to `template'
1066 A function associated to `inner-template' is always applied.
1068 The latter, when defined, is to be called on every text not
1069 recognized as an element or an object. It must accept two
1070 arguments: the text string and the information channel. It is an
1071 appropriate place to protect special chars relative to the
1072 back-end.
1074 BODY can start with pre-defined keyword arguments. The following
1075 keywords are understood:
1077 :export-block
1079 String, or list of strings, representing block names that
1080 will not be parsed. This is used to specify blocks that will
1081 contain raw code specific to the back-end. These blocks
1082 still have to be handled by the relative `export-block' type
1083 translator.
1085 :filters-alist
1087 Alist between filters and function, or list of functions,
1088 specific to the back-end. See `org-export-filters-alist' for
1089 a list of all allowed filters. Filters defined here
1090 shouldn't make a back-end test, as it may prevent back-ends
1091 derived from this one to behave properly.
1093 :menu-entry
1095 Menu entry for the export dispatcher. It should be a list
1096 like:
1098 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1100 where :
1102 KEY is a free character selecting the back-end.
1104 DESCRIPTION-OR-ORDINAL is either a string or a number.
1106 If it is a string, is will be used to name the back-end in
1107 its menu entry. If it is a number, the following menu will
1108 be displayed as a sub-menu of the back-end with the same
1109 KEY. Also, the number will be used to determine in which
1110 order such sub-menus will appear (lowest first).
1112 ACTION-OR-MENU is either a function or an alist.
1114 If it is an action, it will be called with four
1115 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1116 BODY-ONLY. See `org-export-as' for further explanations on
1117 some of them.
1119 If it is an alist, associations should follow the
1120 pattern:
1122 '(KEY DESCRIPTION ACTION)
1124 where KEY, DESCRIPTION and ACTION are described above.
1126 Valid values include:
1130 or
1135 \(lambda (a s v b)
1136 \(if a (org-latex-export-to-pdf t s v b)
1137 \(org-open-file
1138 \(org-latex-export-to-pdf nil s v b)))))))
1140 or the following, which will be added to the previous
1141 sub-menu,
1143 '(?l 1
1147 :options-alist
1149 Alist between back-end specific properties introduced in
1150 communication channel and how their value are acquired. See
1151 `org-export-options-alist' for more information about
1152 structure of the values."
1167 :transcoders transcoders
1168 :options options
1169 :filters filters
1170 :blocks blocks
1174 "Create a new back-end as a variant of an existing one.
1176 CHILD is the name of the derived back-end. PARENT is the name of
1177 the parent back-end.
1179 BODY can start with pre-defined keyword arguments. The following
1180 keywords are understood:
1182 :export-block
1184 String, or list of strings, representing block names that
1185 will not be parsed. This is used to specify blocks that will
1186 contain raw code specific to the back-end. These blocks
1187 still have to be handled by the relative `export-block' type
1188 translator.
1190 :filters-alist
1192 Alist of filters that will overwrite or complete filters
1193 defined in PARENT back-end. See `org-export-filters-alist'
1194 for a list of allowed filters.
1196 :menu-entry
1198 Menu entry for the export dispatcher. See
1199 `org-export-define-backend' for more information about the
1200 expected value.
1202 :options-alist
1204 Alist of back-end specific properties that will overwrite or
1205 complete those defined in PARENT back-end. Refer to
1206 `org-export-options-alist' for more information about
1207 structure of the values.
1209 :translate-alist
1211 Alist of element and object types and transcoders that will
1212 overwrite or complete transcode table from PARENT back-end.
1213 Refer to `org-export-define-backend' for detailed information
1214 about transcoders.
1217 as a variant of `latex' back-end with a custom template function:
1219 \(org-export-define-derived-backend 'my-latex 'latex
1220 :translate-alist '((template . my-latex-template-fun)))
1222 The back-end could then be called with, for example:
1240 :parent parent
1241 :transcoders transcoders
1242 :options options
1243 :filters filters
1244 :blocks blocks
1248 \f
1249 ;;; The Communication Channel
1250 ;;
1251 ;; During export process, every function has access to a number of
1252 ;; properties. They are of two types:
1253 ;;
1254 ;; 1. Environment options are collected once at the very beginning of
1255 ;; the process, out of the original buffer and configuration.
1256 ;; Collecting them is handled by `org-export-get-environment'
1257 ;; function.
1258 ;;
1259 ;; Most environment options are defined through the
1260 ;; `org-export-options-alist' variable.
1261 ;;
1262 ;; 2. Tree properties are extracted directly from the parsed tree,
1263 ;; just before export, by `org-export-collect-tree-properties'.
1265 ;;;; Environment Options
1266 ;;
1267 ;; Environment options encompass all parameters defined outside the
1268 ;; scope of the parsed data. They come from five sources, in
1269 ;; increasing precedence order:
1270 ;;
1271 ;; - Global variables,
1272 ;; - Buffer's attributes,
1273 ;; - Options keyword symbols,
1274 ;; - Buffer keywords,
1275 ;; - Subtree properties.
1276 ;;
1277 ;; The central internal function with regards to environment options
1278 ;; is `org-export-get-environment'. It updates global variables with
1279 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1280 ;; the different sources.
1281 ;;
1282 ;; The internal functions doing the retrieval are:
1283 ;; `org-export--get-global-options',
1284 ;; `org-export--get-buffer-attributes',
1285 ;; `org-export--parse-option-keyword',
1286 ;; `org-export--get-subtree-options' and
1287 ;; `org-export--get-inbuffer-options'
1288 ;;
1289 ;; Also, `org-export--list-bound-variables' collects bound variables
1290 ;; along with their value in order to set them as buffer local
1291 ;; variables later in the process.
1294 "Collect export options from the current buffer.
1296 Optional argument BACKEND is an export back-end, as returned by
1297 `org-export-create-backend'.
1299 When optional argument SUBTREEP is non-nil, assume the export is
1300 done against the current sub-tree.
1302 Third optional argument EXT-PLIST is a property list with
1303 external parameters overriding Org default settings, but still
1304 inferior to file-local settings."
1305 ;; First install #+BIND variables since these must be set before
1306 ;; global options are read.
1309 ;; Get and prioritize export options...
1311 ;; ... from global variables...
1313 ;; ... from an external property list...
1314 ext-plist
1315 ;; ... from in-buffer settings...
1317 ;; ... and from subtree, when appropriate.
1319 ;; Eventually add misc. properties.
1321 :back-end
1322 backend
1324 :footnote-definition-alist
1325 ;; Footnotes definitions must be collected in the original
1326 ;; buffer, as there's no insurance that they will still be in
1327 ;; the parse tree, due to possible narrowing.
1343 alist))
1355 alist)))))))
1356 alist))
1357 :id-alist
1358 ;; Collect id references.
1369 alist))))
1372 "Parse an OPTIONS line and return values as a plist.
1373 Optional argument BACKEND is an export back-end, as returned by,
1374 e.g., `org-export-create-backend'. It specifies which back-end
1375 specific items to read, if any."
1377 ;; Priority is given to back-end specific options.
1379 org-export-options-alist))
1380 plist)
1389 options))
1391 property
1394 plist))
1397 "Get export options in subtree at point.
1398 Optional argument BACKEND is an export back-end, as returned by,
1399 e.g., `org-export-create-backend'. It specifies back-end used
1400 for export. Return options as a plist."
1401 ;; For each buffer keyword, create a headline property setting the
1402 ;; same property in communication channel. The name for the property
1403 ;; is the keyword with "EXPORT_" appended to it.
1406 ;; Make sure point is at a heading.
1408 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1409 ;; title (with no todo keyword, priority cookie or tag) as its
1410 ;; fallback value.
1416 plist :title
1419 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1423 ;; Handle other keywords. TITLE keyword is excluded as it has
1424 ;; been handled already.
1432 ;; Export properties are not case-sensitive.
1439 plist
1440 property
1442 ;; Parse VALUE if required.
1446 ;; If BEHAVIOR is `split' expected value is
1447 ;; a list of strings, not a string.
1450 ;; Look for both general keywords and back-end specific
1451 ;; options, with priority given to the latter.
1453 org-export-options-alist)))
1454 ;; Return value.
1455 plist)))
1458 "Return current buffer export options, as a plist.
1460 Optional argument BACKEND, when non-nil, is an export back-end,
1461 as returned by, e.g., `org-export-create-backend'. It specifies
1462 which back-end specific options should also be read in the
1463 process.
1465 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1467 get-options ; For byte-compiler.
1470 ;; Priority is given to back-end specific options.
1472 org-export-options-alist))
1475 org-export-special-keywords))))
1478 ;; Return all properties associated to KEYWORD.
1485 ;; Recursively read keywords in buffer. FILES is a list
1486 ;; of files read so far. PLIST is the current property
1487 ;; list obtained.
1496 ;; Options in `org-export-special-keywords'.
1500 ;; Avoid circular dependencies.
1510 plist
1515 plist
1521 ;; Options in `org-export-options-alist'.
1526 plist property
1527 ;; Handle value depending on specified
1528 ;; BEHAVIOR.
1534 " "
1547 ;; Return final value.
1548 plist))))
1549 ;; Read options in the current buffer.
1552 ;; Parse keywords specified in `org-element-document-properties'
1553 ;; and return PLIST.
1564 "Return properties related to buffer attributes, as a plist."
1569 "Return global export options as a plist.
1570 Optional argument BACKEND, if non-nil, is an export back-end, as
1571 returned by, e.g., `org-export-create-backend'. It specifies
1572 which back-end specific export options should also be read in the
1573 process."
1575 ;; Priority is given to back-end specific options.
1577 org-export-options-alist)))
1583 plist
1584 prop
1585 ;; Evaluate default value provided. If keyword is
1586 ;; a member of `org-element-document-properties',
1587 ;; parse it as a secondary string before storing it.
1591 org-element-document-properties))
1594 value)))))))))
1597 "Return variables bound from BIND keywords in current buffer.
1598 Also look for BIND keywords in setup files. The return value is
1599 an alist where associations are (VARIABLE-NAME VALUE)."
1604 ;; Return an alist between variable names and their
1605 ;; value. FILES is a list of setup files names read so
1606 ;; far, used to avoid circular dependencies. ALIST is
1607 ;; the alist collected so far.
1618 ;; Enter setup file.
1628 alist))))))))))
1629 alist)))))
1630 ;; Return value in appropriate order of appearance.
1633 ;; defsubst org-export-get-parent must be defined before first use,
1634 ;; was originally defined in the topology section
1637 "Return BLOB parent or nil.
1638 BLOB is the element or object considered."
1641 ;;;; Tree Properties
1642 ;;
1643 ;; Tree properties are information extracted from parse tree. They
1644 ;; are initialized at the beginning of the transcoding process by
1645 ;; `org-export-collect-tree-properties'.
1646 ;;
1647 ;; Dedicated functions focus on computing the value of specific tree
1648 ;; properties during initialization. Thus,
1649 ;; `org-export--populate-ignore-list' lists elements and objects that
1650 ;; should be skipped during export, `org-export--get-min-level' gets
1651 ;; the minimal exportable level, used as a basis to compute relative
1652 ;; level for headlines. Eventually
1653 ;; `org-export--collect-headline-numbering' builds an alist between
1654 ;; headlines and their numbering.
1657 "Extract tree properties from parse tree.
1659 DATA is the parse tree from which information is retrieved. INFO
1660 is a list holding export options.
1662 Following tree properties are set or updated:
1664 `:exported-data' Hash table used to memoize results from
1665 `org-export-data'.
1667 `:footnote-definition-alist' List of footnotes definitions in
1668 original buffer and current parse tree.
1670 `:headline-offset' Offset between true level of headlines and
1671 local level. An offset of -1 means a headline
1672 of level 2 should be considered as a level
1673 1 headline in the context.
1675 `:headline-numbering' Alist of all headlines as key an the
1676 associated numbering as value.
1678 Return updated plist."
1679 ;; Install the parse tree in the communication channel.
1681 ;; Compute `:headline-offset' in order to be able to use
1682 ;; `org-export-get-relative-level'.
1685 :headline-offset
1687 ;; Footnote definitions in parse tree override those stored in
1688 ;; `:footnote-definition-alist'. This way, any change to
1689 ;; a definition in the parse tree (e.g., through a parse tree
1690 ;; filter) propagates into the alist.
1697 defs))
1701 defs)))))
1703 ;; Properties order doesn't matter: get the rest of the tree
1704 ;; properties.
1709 info))
1712 "Return minimum exportable headline's level in DATA.
1713 DATA is parsed tree as returned by `org-element-parse-buffer'.
1714 OPTIONS is a plist holding export options."
1725 ;; If no headline was found, for the sake of consistency, set
1726 ;; minimum level to 1 nonetheless.
1730 "Return numbering of all exportable, numbered headlines in a parse tree.
1732 DATA is the parse tree. OPTIONS is the plist holding export
1733 options.
1735 Return an alist whose key is a headline and value is its
1736 associated numbering \(in the shape of a list of numbers\) or nil
1737 for a footnotes section."
1746 headline
1748 for idx from 0 to org-export-max-depth
1752 options)))
1755 "Return numbering of all exportable, unnumbered headlines.
1756 DATA is the parse tree. OPTIONS is the plist holding export
1757 options. Unnumbered headlines are numbered as a function of
1758 occurrence."
1766 "List headlines and inlinetasks with a select tag in their tree.
1767 DATA is parsed data as returned by `org-element-parse-buffer'.
1768 INFO is a plist holding export options."
1770 walk-data ; For byte-compiler.
1780 ;; When a select tag is found, mark full
1781 ;; genealogy and every headline within the tree
1782 ;; as acceptable.
1785 genealogy
1788 selected-trees))
1789 ;; If at a headline, continue searching in tree,
1790 ;; recursively.
1799 selected-trees))
1802 "Non-nil when element or object BLOB should be skipped during export.
1803 OPTIONS is the plist holding export options. SELECTED, when
1804 non-nil, is a list of headlines or inlinetasks belonging to
1805 a tree with a select tag."
1812 ;; If `:with-drawers' value starts with `not', ignore
1813 ;; every drawer whose name belong to that list.
1814 ;; Otherwise, ignore drawers whose name isn't in that
1815 ;; list.
1832 ;; Ignore subtrees with an exclude tag.
1835 ;; When a select tag is present in the buffer, ignore any tree
1836 ;; without it.
1838 ;; Ignore commented sub-trees.
1840 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1842 ;; Ignore tasks, if specified by `:with-tasks' property.
1854 properties-set))))))
1865 ;; `:with-timestamps' only applies to isolated timestamps
1866 ;; objects, i.e. timestamp objects in a paragraph containing only
1867 ;; timestamps and whitespaces.
1875 options t))))
1884 \f
1885 ;;; The Transcoder
1886 ;;
1887 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1888 ;; `org-element-parse-buffer') and transcodes it into a specified
1889 ;; back-end output. It takes care of filtering out elements or
1890 ;; objects according to export options and organizing the output blank
1891 ;; lines and white space are preserved. The function memoizes its
1892 ;; results, so it is cheap to call it within transcoders.
1893 ;;
1894 ;; It is possible to modify locally the back-end used by
1895 ;; `org-export-data' or even use a temporary back-end by using
1896 ;; `org-export-data-with-backend'.
1897 ;;
1898 ;; `org-export-transcoder' is an accessor returning appropriate
1899 ;; translator function for a given element or object.
1902 "Return appropriate transcoder for BLOB.
1903 INFO is a plist containing export directives."
1905 ;; Return contents only for complete parse trees.
1911 "Convert DATA into current back-end format.
1913 DATA is a parse tree, an element or an object or a secondary
1914 string. INFO is a plist holding export options.
1916 Return a string."
1921 ;; Ignored element/object.
1923 ;; Plain text.
1929 info))
1930 ;; Secondary string.
1933 ;; Element/Object without contents or, as a special
1934 ;; case, headline with archive tag and archived trees
1935 ;; restricted to title only.
1943 ;; Export snippets never return a nil value so
1944 ;; that white spaces following them are never
1945 ;; ignored.
1947 ;; Element/Object with contents.
1960 ;; Elements directly containing
1961 ;; objects must have their indentation
1962 ;; normalized first.
1964 data
1965 ;; When normalizing contents of the
1966 ;; first paragraph in an item or
1967 ;; a footnote definition, ignore
1968 ;; first line's indentation: there is
1969 ;; none and it might be misleading.
1974 data)
1981 info))))))))
1982 ;; Final result will be memoized before being returned.
1984 data
1988 ;; Append the same white space between elements or objects
1989 ;; as in the original buffer, and call appropriate filters.
2000 info)))
2001 results)))
2005 "Convert DATA into BACKEND format.
2007 DATA is an element, an object, a secondary string or a string.
2008 BACKEND is a symbol. INFO is a plist used as a communication
2009 channel.
2011 Unlike to `org-export-with-backend', this function will
2012 recursively convert DATA using BACKEND translation table."
2015 data
2016 ;; Set-up a new communication channel with translations defined in
2017 ;; BACKEND as the translate table and a new hash table for
2018 ;; memoization.
2020 info
2023 ;; Size of the hash table is reduced since this function
2024 ;; will probably be used on small trees.
2028 "Prune non exportable elements from DATA.
2029 DATA is the parse tree to traverse. INFO is the plist holding
2030 export info. Also set `:ignore-list' in INFO to a list of
2031 objects which should be ignored during export, but not removed
2032 from tree."
2034 ignore
2035 ;; First find trees containing a select tag, if any.
2039 ;; Prune non-exportable elements and objects from tree.
2040 ;; As a special case, special rows and cells from tables
2041 ;; are stored in IGNORE, as they still need to be accessed
2042 ;; during export.
2050 ;; If headline is archived but tree below has to
2051 ;; be skipped, remove contents.
2054 ;; Move into secondary string, if any.
2059 ;; Move into recursive objects/elements.
2061 ;; If a select tag is active, also ignore the section before the
2062 ;; first headline, if any.
2067 ;; Prune tree and communication channel.
2071 ;; Eventually set `:ignore-list'.
2075 "Change uninterpreted elements back into Org syntax.
2076 DATA is the parse tree. INFO is a plist containing export
2077 options. Each uninterpreted element or object is changed back
2078 into a string. Contents, if any, are not modified. The parse
2079 tree is modified by side effect."
2083 prop
2086 info))))
2089 "Change uninterpreted elements back into Org syntax.
2090 DATA is a parse tree or a secondary string. INFO is a plist
2091 containing export options. It is modified by side effect and
2092 returned by the function."
2095 subscript superscript underline)
2099 ;; ... entities...
2106 ?\s)))))
2107 ;; ... emphasis...
2119 marker
2123 ?\s)))))))
2124 ;; ... LaTeX environments and fragments...
2128 ;; ... sub/superscripts...
2137 "_"
2146 ?\s)))))))))))
2148 ;; Splice NEW at BLOB location in parse tree.
2151 info)
2152 ;; Return modified parse tree.
2153 data)
2156 "Expand a parsed element or object to its original state.
2158 BLOB is either an element or an object. CONTENTS is its
2159 contents, as a string or nil.
2161 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2162 keywords before output."
2167 blob contents))))
2170 \f
2171 ;;; The Filter System
2172 ;;
2173 ;; Filters allow end-users to tweak easily the transcoded output.
2174 ;; They are the functional counterpart of hooks, as every filter in
2175 ;; a set is applied to the return value of the previous one.
2176 ;;
2177 ;; Every set is back-end agnostic. Although, a filter is always
2178 ;; called, in addition to the string it applies to, with the back-end
2179 ;; used as argument, so it's easy for the end-user to add back-end
2180 ;; specific filters in the set. The communication channel, as
2181 ;; a plist, is required as the third argument.
2182 ;;
2183 ;; From the developer side, filters sets can be installed in the
2184 ;; process with the help of `org-export-define-backend', which
2185 ;; internally stores filters as an alist. Each association has a key
2186 ;; among the following symbols and a function or a list of functions
2187 ;; as value.
2188 ;;
2189 ;; - `:filter-options' applies to the property list containing export
2190 ;; options. Unlike to other filters, functions in this list accept
2191 ;; two arguments instead of three: the property list containing
2192 ;; export options and the back-end. Users can set its value through
2193 ;; `org-export-filter-options-functions' variable.
2194 ;;
2195 ;; - `:filter-parse-tree' applies directly to the complete parsed
2196 ;; tree. Users can set it through
2197 ;; `org-export-filter-parse-tree-functions' variable.
2198 ;;
2199 ;; - `:filter-body' applies to the body of the output, before template
2200 ;; translator chimes in. Users can set it through
2201 ;; `org-export-filter-body-functions' variable.
2202 ;;
2203 ;; - `:filter-final-output' applies to the final transcoded string.
2204 ;; Users can set it with `org-export-filter-final-output-functions'
2205 ;; variable.
2206 ;;
2207 ;; - `:filter-plain-text' applies to any string not recognized as Org
2208 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2209 ;; configure it.
2210 ;;
2211 ;; - `:filter-TYPE' applies on the string returned after an element or
2212 ;; object of type TYPE has been transcoded. A user can modify
2213 ;; `org-export-filter-TYPE-functions' to install these filters.
2214 ;;
2215 ;; All filters sets are applied with
2216 ;; `org-export-filter-apply-functions' function. Filters in a set are
2217 ;; applied in a LIFO fashion. It allows developers to be sure that
2218 ;; their filters will be applied first.
2219 ;;
2220 ;; Filters properties are installed in communication channel with
2221 ;; `org-export-install-filters' function.
2222 ;;
2223 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2224 ;; `org-export-before-parsing-hook') are run at the beginning of the
2225 ;; export process and just before parsing to allow for heavy structure
2226 ;; modifications.
2229 ;;;; Hooks
2232 "Hook run at the beginning of the export process.
2234 This is run before include keywords and macros are expanded and
2235 Babel code blocks executed, on a copy of the original buffer
2236 being exported. Visibility and narrowing are preserved. Point
2237 is at the beginning of the buffer.
2239 Every function in this hook will be called with one argument: the
2243 "Hook run before parsing an export buffer.
2245 This is run after include keywords and macros have been expanded
2246 and Babel code blocks executed, on a copy of the original buffer
2247 being exported. Visibility and narrowing are preserved. Point
2248 is at the beginning of the buffer.
2250 Every function in this hook will be called with one argument: the
2254 ;;;; Special Filters
2257 "List of functions applied to the export options.
2258 Each filter is called with two arguments: the export options, as
2259 a plist, and the back-end, as a symbol. It must return
2263 "List of functions applied to the parsed tree.
2264 Each filter is called with three arguments: the parse tree, as
2265 returned by `org-element-parse-buffer', the back-end, as
2266 a symbol, and the communication channel, as a plist. It must
2270 "List of functions applied to plain text.
2271 Each filter is called with three arguments: a string which
2272 contains no Org syntax, the back-end, as a symbol, and the
2273 communication channel, as a plist. It must return a string or
2277 "List of functions applied to transcoded body.
2278 Each filter is called with three arguments: a string which
2279 contains no Org syntax, the back-end, as a symbol, and the
2280 communication channel, as a plist. It must return a string or
2284 "List of functions applied to the transcoded string.
2285 Each filter is called with three arguments: the full transcoded
2286 string, the back-end, as a symbol, and the communication channel,
2287 as a plist. It must return a string that will be used as the
2291 ;;;; Elements Filters
2294 "List of functions applied to a transcoded babel-call.
2295 Each filter is called with three arguments: the transcoded data,
2296 as a string, the back-end, as a symbol, and the communication
2300 "List of functions applied to a transcoded center block.
2301 Each filter is called with three arguments: the transcoded data,
2302 as a string, the back-end, as a symbol, and the communication
2306 "List of functions applied to a transcoded clock.
2307 Each filter is called with three arguments: the transcoded data,
2308 as a string, the back-end, as a symbol, and the communication
2312 "List of functions applied to a transcoded comment.
2313 Each filter is called with three arguments: the transcoded data,
2314 as a string, the back-end, as a symbol, and the communication
2318 "List of functions applied to a transcoded comment-block.
2319 Each filter is called with three arguments: the transcoded data,
2320 as a string, the back-end, as a symbol, and the communication
2324 "List of functions applied to a transcoded diary-sexp.
2325 Each filter is called with three arguments: the transcoded data,
2326 as a string, the back-end, as a symbol, and the communication
2330 "List of functions applied to a transcoded drawer.
2331 Each filter is called with three arguments: the transcoded data,
2332 as a string, the back-end, as a symbol, and the communication
2336 "List of functions applied to a transcoded dynamic-block.
2337 Each filter is called with three arguments: the transcoded data,
2338 as a string, the back-end, as a symbol, and the communication
2342 "List of functions applied to a transcoded example-block.
2343 Each filter is called with three arguments: the transcoded data,
2344 as a string, the back-end, as a symbol, and the communication
2348 "List of functions applied to a transcoded export-block.
2349 Each filter is called with three arguments: the transcoded data,
2350 as a string, the back-end, as a symbol, and the communication
2354 "List of functions applied to a transcoded fixed-width.
2355 Each filter is called with three arguments: the transcoded data,
2356 as a string, the back-end, as a symbol, and the communication
2360 "List of functions applied to a transcoded footnote-definition.
2361 Each filter is called with three arguments: the transcoded data,
2362 as a string, the back-end, as a symbol, and the communication
2366 "List of functions applied to a transcoded headline.
2367 Each filter is called with three arguments: the transcoded data,
2368 as a string, the back-end, as a symbol, and the communication
2372 "List of functions applied to a transcoded horizontal-rule.
2373 Each filter is called with three arguments: the transcoded data,
2374 as a string, the back-end, as a symbol, and the communication
2378 "List of functions applied to a transcoded inlinetask.
2379 Each filter is called with three arguments: the transcoded data,
2380 as a string, the back-end, as a symbol, and the communication
2384 "List of functions applied to a transcoded item.
2385 Each filter is called with three arguments: the transcoded data,
2386 as a string, the back-end, as a symbol, and the communication
2390 "List of functions applied to a transcoded keyword.
2391 Each filter is called with three arguments: the transcoded data,
2392 as a string, the back-end, as a symbol, and the communication
2396 "List of functions applied to a transcoded latex-environment.
2397 Each filter is called with three arguments: the transcoded data,
2398 as a string, the back-end, as a symbol, and the communication
2402 "List of functions applied to a transcoded node-property.
2403 Each filter is called with three arguments: the transcoded data,
2404 as a string, the back-end, as a symbol, and the communication
2408 "List of functions applied to a transcoded paragraph.
2409 Each filter is called with three arguments: the transcoded data,
2410 as a string, the back-end, as a symbol, and the communication
2414 "List of functions applied to a transcoded plain-list.
2415 Each filter is called with three arguments: the transcoded data,
2416 as a string, the back-end, as a symbol, and the communication
2420 "List of functions applied to a transcoded planning.
2421 Each filter is called with three arguments: the transcoded data,
2422 as a string, the back-end, as a symbol, and the communication
2426 "List of functions applied to a transcoded property-drawer.
2427 Each filter is called with three arguments: the transcoded data,
2428 as a string, the back-end, as a symbol, and the communication
2432 "List of functions applied to a transcoded quote block.
2433 Each filter is called with three arguments: the transcoded quote
2434 data, as a string, the back-end, as a symbol, and the
2435 communication channel, as a plist. It must return a string or
2439 "List of functions applied to a transcoded section.
2440 Each filter is called with three arguments: the transcoded data,
2441 as a string, the back-end, as a symbol, and the communication
2445 "List of functions applied to a transcoded special block.
2446 Each filter is called with three arguments: the transcoded data,
2447 as a string, the back-end, as a symbol, and the communication
2451 "List of functions applied to a transcoded src-block.
2452 Each filter is called with three arguments: the transcoded data,
2453 as a string, the back-end, as a symbol, and the communication
2457 "List of functions applied to a transcoded table.
2458 Each filter is called with three arguments: the transcoded data,
2459 as a string, the back-end, as a symbol, and the communication
2463 "List of functions applied to a transcoded table-cell.
2464 Each filter is called with three arguments: the transcoded data,
2465 as a string, the back-end, as a symbol, and the communication
2469 "List of functions applied to a transcoded table-row.
2470 Each filter is called with three arguments: the transcoded data,
2471 as a string, the back-end, as a symbol, and the communication
2475 "List of functions applied to a transcoded verse block.
2476 Each filter is called with three arguments: the transcoded data,
2477 as a string, the back-end, as a symbol, and the communication
2481 ;;;; Objects Filters
2484 "List of functions applied to transcoded bold text.
2485 Each filter is called with three arguments: the transcoded data,
2486 as a string, the back-end, as a symbol, and the communication
2490 "List of functions applied to transcoded code text.
2491 Each filter is called with three arguments: the transcoded data,
2492 as a string, the back-end, as a symbol, and the communication
2496 "List of functions applied to a transcoded entity.
2497 Each filter is called with three arguments: the transcoded data,
2498 as a string, the back-end, as a symbol, and the communication
2502 "List of functions applied to a transcoded export-snippet.
2503 Each filter is called with three arguments: the transcoded data,
2504 as a string, the back-end, as a symbol, and the communication
2508 "List of functions applied to a transcoded footnote-reference.
2509 Each filter is called with three arguments: the transcoded data,
2510 as a string, the back-end, as a symbol, and the communication
2514 "List of functions applied to a transcoded inline-babel-call.
2515 Each filter is called with three arguments: the transcoded data,
2516 as a string, the back-end, as a symbol, and the communication
2520 "List of functions applied to a transcoded inline-src-block.
2521 Each filter is called with three arguments: the transcoded data,
2522 as a string, the back-end, as a symbol, and the communication
2526 "List of functions applied to transcoded italic text.
2527 Each filter is called with three arguments: the transcoded data,
2528 as a string, the back-end, as a symbol, and the communication
2532 "List of functions applied to a transcoded latex-fragment.
2533 Each filter is called with three arguments: the transcoded data,
2534 as a string, the back-end, as a symbol, and the communication
2538 "List of functions applied to a transcoded line-break.
2539 Each filter is called with three arguments: the transcoded data,
2540 as a string, the back-end, as a symbol, and the communication
2544 "List of functions applied to a transcoded link.
2545 Each filter is called with three arguments: the transcoded data,
2546 as a string, the back-end, as a symbol, and the communication
2550 "List of functions applied to a transcoded radio-target.
2551 Each filter is called with three arguments: the transcoded data,
2552 as a string, the back-end, as a symbol, and the communication
2556 "List of functions applied to a transcoded statistics-cookie.
2557 Each filter is called with three arguments: the transcoded data,
2558 as a string, the back-end, as a symbol, and the communication
2562 "List of functions applied to transcoded strike-through text.
2563 Each filter is called with three arguments: the transcoded data,
2564 as a string, the back-end, as a symbol, and the communication
2568 "List of functions applied to a transcoded subscript.
2569 Each filter is called with three arguments: the transcoded data,
2570 as a string, the back-end, as a symbol, and the communication
2574 "List of functions applied to a transcoded superscript.
2575 Each filter is called with three arguments: the transcoded data,
2576 as a string, the back-end, as a symbol, and the communication
2580 "List of functions applied to a transcoded target.
2581 Each filter is called with three arguments: the transcoded data,
2582 as a string, the back-end, as a symbol, and the communication
2586 "List of functions applied to a transcoded timestamp.
2587 Each filter is called with three arguments: the transcoded data,
2588 as a string, the back-end, as a symbol, and the communication
2592 "List of functions applied to transcoded underline text.
2593 Each filter is called with three arguments: the transcoded data,
2594 as a string, the back-end, as a symbol, and the communication
2598 "List of functions applied to transcoded verbatim text.
2599 Each filter is called with three arguments: the transcoded data,
2600 as a string, the back-end, as a symbol, and the communication
2604 ;;;; Filters Tools
2605 ;;
2606 ;; Internal function `org-export-install-filters' installs filters
2607 ;; hard-coded in back-ends (developer filters) and filters from global
2608 ;; variables (user filters) in the communication channel.
2609 ;;
2610 ;; Internal function `org-export-filter-apply-functions' takes care
2611 ;; about applying each filter in order to a given data. It ignores
2612 ;; filters returning a nil value but stops whenever a filter returns
2613 ;; an empty string.
2616 "Call every function in FILTERS.
2618 Functions are called with arguments VALUE, current export
2619 back-end's name and INFO. A function returning a nil value will
2620 be skipped. If it returns the empty string, the process ends and
2621 VALUE is ignored.
2623 Call is done in a LIFO fashion, to be sure that developer
2624 specified filters, if any, are called first."
2635 "Install filters properties in communication channel.
2636 INFO is a plist containing the current communication channel.
2637 Return the updated communication channel."
2639 ;; Install user-defined filters with `org-export-filters-alist'
2640 ;; and filters already in INFO (through ext-plist mechanism).
2647 ;; Filters in INFO will be called
2648 ;; before those user provided.
2651 default-value)))))
2652 org-export-filters-alist)
2653 ;; Prepend back-end specific filters to that list.
2655 ;; Single values get consed, lists are appended.
2660 plist key
2664 ;; Return new communication channel.
2668 \f
2669 ;;; Core functions
2670 ;;
2671 ;; This is the room for the main function, `org-export-as', along with
2672 ;; its derivative, `org-export-string-as'.
2673 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2674 ;; function should be added to kill ring.
2675 ;;
2676 ;; Note that `org-export-as' doesn't really parse the current buffer,
2677 ;; but a copy of it (with the same buffer-local variables and
2678 ;; visibility), where macros and include keywords are expanded and
2679 ;; Babel blocks are executed, if appropriate.
2680 ;; `org-export-with-buffer-copy' macro prepares that copy.
2681 ;;
2682 ;; File inclusion is taken care of by
2683 ;; `org-export-expand-include-keyword' and
2684 ;; `org-export--prepare-file-contents'. Structure wise, including
2685 ;; a whole Org file in a buffer often makes little sense. For
2686 ;; example, if the file contains a headline and the include keyword
2687 ;; was within an item, the item should contain the headline. That's
2688 ;; why file inclusion should be done before any structure can be
2689 ;; associated to the file, that is before parsing.
2690 ;;
2691 ;; `org-export-insert-default-template' is a command to insert
2692 ;; a default template (or a back-end specific template) at point or in
2693 ;; current subtree.
2696 "Return a copy of the current buffer.
2697 The copy preserves Org buffer-local variables, visibility and
2698 narrowing."
2704 new-buf))
2707 "Apply BODY in a copy of the current buffer.
2708 The copy preserves local variables, visibility and contents of
2709 the original buffer. Point is at the beginning of the buffer
2710 when BODY is applied."
2719 ;; Kill copy without confirmation.
2725 "Generate a function duplicating BUFFER.
2727 The copy will preserve local variables, visibility, contents and
2728 narrowing of the original buffer. If a region was active in
2729 BUFFER, contents will be narrowed to that region instead.
2731 The resulting function can be evaluated at a later time, from
2732 another buffer, effectively cloning the original buffer there.
2734 The function assumes BUFFER's major mode is `org-mode'."
2738 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2739 ;; already in BUFFER.
2741 ;; Copy specific buffer local variables and variables set
2742 ;; through BIND keywords.
2744 vars)
2752 buffer-file-name
2753 buffer-file-coding-system))
2757 ;; Skip unreadable values, as they cannot be
2758 ;; sent to external process.
2762 vars))))))
2763 ;; Whole buffer contents.
2768 ;; Narrowing.
2772 ;; Current position of point.
2774 ;; Overlays with invisible property.
2784 ov-set))))
2786 ov-set)))))
2788 ;;;###autoload
2791 "Transcode current Org buffer into BACKEND code.
2793 BACKEND is either an export back-end, as returned by, e.g.,
2794 `org-export-create-backend', or a symbol referring to
2795 a registered back-end.
2797 If narrowing is active in the current buffer, only transcode its
2798 narrowed part.
2800 If a region is active, transcode that region.
2802 When optional argument SUBTREEP is non-nil, transcode the
2803 sub-tree at point, extracting information from the headline
2804 properties first.
2806 When optional argument VISIBLE-ONLY is non-nil, don't export
2807 contents of hidden elements.
2809 When optional argument BODY-ONLY is non-nil, only return body
2810 code, without surrounding template.
2812 Optional argument EXT-PLIST, when provided, is a property list
2813 with external parameters overriding Org default settings, but
2814 still inferior to file-local settings.
2816 Return code as a string."
2821 ;; Narrow buffer to an appropriate region or subtree for
2822 ;; parsing. If parsing subtree, be sure to remove main headline
2823 ;; too.
2831 ;; Initialize communication channel with original buffer
2832 ;; attributes, unavailable in its copy.
2841 tree)
2842 ;; Update communication channel and get parse tree. Buffer
2843 ;; isn't parsed directly. Instead, a temporary copy is
2844 ;; created, where include keywords, macros are expanded and
2845 ;; code blocks are evaluated.
2847 ;; Run first hook with current back-end's name as argument.
2851 ;; Update macro templates since #+INCLUDE keywords might have
2852 ;; added some new ones.
2856 ;; Update radio targets since keyword inclusion might have
2857 ;; added some more.
2859 ;; Run last hook with current back-end's name as argument.
2864 ;; Update communication channel with environment. Also
2865 ;; install user's and developer's filters.
2870 ;; Call options filters and update export options. We do not
2871 ;; use `org-export-filter-apply-functions' here since the
2872 ;; arity of such filters is different.
2877 ;; Expand export-specific set of macros: {{{author}}},
2878 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2879 ;; be done once regular macros have been expanded, since
2880 ;; document keywords may contain one of them.
2892 value)
2893 value)))
2894 ;; EMAIL is not a parsed keyword: store it as-is.
2900 ;; Parse buffer.
2902 ;; Prune tree from non-exported elements and transform
2903 ;; uninterpreted elements or objects in both parse tree and
2904 ;; communication channel.
2907 ;; Parse buffer, handle uninterpreted elements or objects,
2908 ;; then call parse-tree filters.
2912 ;; Now tree is complete, compute its properties and add them
2913 ;; to communication channel.
2917 ;; Eventually transcode TREE. Wrap the resulting string into
2918 ;; a template.
2927 info))
2930 ;; Remove all text properties since they cannot be
2931 ;; retrieved from an external process. Finally call
2932 ;; final-output filter and return result.
2938 info))))))))
2940 ;;;###autoload
2942 "Transcode STRING into BACKEND code.
2944 BACKEND is either an export back-end, as returned by, e.g.,
2945 `org-export-create-backend', or a symbol referring to
2946 a registered back-end.
2948 When optional argument BODY-ONLY is non-nil, only return body
2949 code, without preamble nor postamble.
2951 Optional argument EXT-PLIST, when provided, is a property list
2952 with external parameters overriding Org default settings, but
2953 still inferior to file-local settings.
2955 Return code as a string."
2961 ;;;###autoload
2963 "Replace the active region by its export to BACKEND.
2964 BACKEND is either an export back-end, as returned by, e.g.,
2965 `org-export-create-backend', or a symbol referring to
2966 a registered back-end."
2976 ;;;###autoload
2978 "Insert all export keywords with default values at beginning of line.
2980 BACKEND is a symbol referring to the name of a registered export
2981 back-end, for which specific export options should be added to
2982 the template, or `default' for default template. When it is nil,
2983 the user will be prompted for a category.
2985 If SUBTREEP is non-nil, export configuration will be set up
2986 locally for the subtree through node properties."
2996 "Options category: "
3000 org-export--registered-backends))
3001 nil t))))
3002 options keywords)
3003 ;; Populate OPTIONS and KEYWORDS.
3020 ;; Move to an appropriate location in order to insert options.
3022 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3040 ;; Then the rest of keywords, in the order specified in either
3041 ;; `org-export-options-alist' or respective export back-ends.
3062 "Expand every include keyword in buffer.
3063 Optional argument INCLUDED is a list of included file names along
3064 with their line restriction, when appropriate. It is used to
3065 avoid infinite recursion. Optional argument DIR is the current
3066 working directory. It is used to properly resolve relative
3067 paths. Optional argument FOOTNOTES is a hash-table used for
3068 storing and resolving footnotes. It is created automatically."
3074 ;; If :minlevel is not set the text-property
3075 ;; `:org-include-induced-level' will be used to determine the
3076 ;; relative level when expanding INCLUDE.
3077 ;; Only affects included Org documents.
3081 :org-include-induced-level
3083 ;; Expand INCLUDE keywords.
3089 ;; Extract arguments from keyword's value.
3092 location
3104 matched)
3105 dir)))
3114 value)
3121 ;; Minimal level of included file defaults to the child
3122 ;; level of the current headline, if any, or one. It
3123 ;; only applies is the file is meant to be included as
3124 ;; an Org one.
3135 ;; Remove keyword.
3141 ;; Check if files has already been parsed. Look after
3142 ;; inclusion lines too, as different parts of the same file
3143 ;; can be included too.
3158 ind-str block arg-str contents ind-str block))))
3165 ind-str block contents ind-str block))))
3173 file location only-contents lines)
3174 lines)))
3177 file lines ind minlevel
3180 footnotes)))
3184 footnotes)
3186 ;; Expand footnotes after all files have been
3187 ;; included. Footnotes are stored at end of buffer.
3192 footnotes)))))))))))
3195 "Resolve absolute lines for an included file with file-link.
3197 FILE is string file-name of the file to include. LOCATION is a
3198 string name within FILE to be included (located via
3199 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3200 contents of the named element will be included, as determined
3201 Org-Element. If LINES is non-nil only those lines are included.
3203 Return a string of lines to be included in the format expected by
3204 `org-export--prepare-file-contents'."
3210 ;; Enforce consistent search.
3223 ;; Skip planning line and property-drawer.
3249 start-line
3251 (+ start-line
3254 counter))))))))
3257 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3259 REF-BEGIN corresponds to the property `:begin' of objects of type
3260 footnote-definition and footnote-reference.
3262 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3263 \[N] where N is one or more numbers.
3265 Return the new label."
3275 "Prepare contents of FILE for inclusion and return it as a string.
3277 When optional argument LINES is a string specifying a range of
3278 lines, include only those lines.
3280 Optional argument IND, when non-nil, is an integer specifying the
3281 global indentation of returned contents. Since its purpose is to
3282 allow an included file to stay in the same environment it was
3283 created \(i.e. a list item), it doesn't apply past the first
3284 headline encountered.
3286 Optional argument MINLEVEL, when non-nil, is an integer
3287 specifying the level that any top-level headline in the included
3288 file should have.
3289 Optional argument ID is an integer that will be inserted before
3290 each footnote definition and reference if FILE is an Org file.
3291 This is useful to avoid conflicts when more than one Org file
3292 with footnotes is included in a document.
3294 Optional argument FOOTNOTES is a hash-table to store footnotes in
3295 the included document.
3296 "
3312 ;; Remove blank lines at beginning and end of contents. The logic
3313 ;; behind that removal is that blank lines around include keyword
3314 ;; override blank lines in included file.
3323 ;; If IND is set, preserve indentation of include keyword until
3324 ;; the first headline encountered.
3331 ;; Do not move footnote definitions out of column 0.
3337 ;; When MINLEVEL is specified, compute minimal level for headlines
3338 ;; in the file (CUR-MIN), and remove stars to each headline so
3339 ;; that headlines with minimal level have a level of MINLEVEL.
3350 ;; Only change stars, don't bother moving whole
3351 ;; sections.
3355 ;; Append ID to all footnote references and definitions, so they
3356 ;; become file specific and cannot collide with footnotes in other
3357 ;; included files. Further, collect relevant footnotes outside of
3358 ;; LINES.
3368 ;; Update the footnote-reference at point and collect
3369 ;; the new label, which is only used for footnotes
3370 ;; outsides LINES.
3372 ;; If label is akin to [1] convert it to [fn:ID-1].
3373 ;; Otherwise add "ID-" after "fn:".
3383 ;; Store since footnote-definition is outside of LINES.
3386 footnotes)
3387 ;; Update label of definition since it is included directly.
3394 "Execute every Babel code in the visible part of current buffer."
3395 ;; Get a pristine copy of current buffer so Babel references can be
3396 ;; properly resolved.
3402 "Return a non-nil value when output should be added to the kill ring.
3403 See also `org-export-copy-to-kill-ring'."
3409 \f
3410 ;;; Tools For Back-Ends
3411 ;;
3412 ;; A whole set of tools is available to help build new exporters. Any
3413 ;; function general enough to have its use across many back-ends
3414 ;; should be added here.
3416 ;;;; For Affiliated Keywords
3417 ;;
3418 ;; `org-export-read-attribute' reads a property from a given element
3419 ;; as a plist. It can be used to normalize affiliated keywords'
3420 ;; syntax.
3421 ;;
3422 ;; Since captions can span over multiple lines and accept dual values,
3423 ;; their internal representation is a bit tricky. Therefore,
3424 ;; `org-export-get-caption' transparently returns a given element's
3425 ;; caption as a secondary string.
3428 "Turn ATTRIBUTE property from ELEMENT into a plist.
3430 When optional argument PROPERTY is non-nil, return the value of
3431 that property within attributes.
3435 properties.
3437 All values will become strings except the empty string and
3440 will become the empty string."
3454 s)
3459 ;; Ignore any string before first property with `cdr'.
3464 "Return caption from ELEMENT as a secondary string.
3466 When optional argument SHORTP is non-nil, return short caption,
3467 as a secondary string, instead.
3469 Caption lines are separated by a white space."
3477 ;;;; For Derived Back-ends
3478 ;;
3479 ;; `org-export-with-backend' is a function allowing to locally use
3480 ;; another back-end to transcode some object or element. In a derived
3481 ;; back-end, it may be used as a fall-back function once all specific
3482 ;; cases have been treated.
3485 "Call a transcoder from BACKEND on DATA.
3486 BACKEND is an export back-end, as returned by, e.g.,
3487 `org-export-create-backend', or a symbol referring to
3488 a registered back-end. DATA is an Org element, object, secondary
3489 string or string. CONTENTS, when non-nil, is the transcoded
3490 contents of DATA element, as a string. INFO, when non-nil, is
3491 the communication channel used for export, as a plist."
3501 transcoder data contents
3504 :translate-alist all-transcoders
3508 ;;;; For Export Snippets
3509 ;;
3510 ;; Every export snippet is transmitted to the back-end. Though, the
3511 ;; latter will only retain one type of export-snippet, ignoring
3512 ;; others, based on the former's target back-end. The function
3513 ;; `org-export-snippet-backend' returns that back-end for a given
3514 ;; export-snippet.
3517 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3518 Translation, with `org-export-snippet-translation-alist', is
3519 applied."
3523 back-end))))
3526 ;;;; For Footnotes
3527 ;;
3528 ;; `org-export-collect-footnote-definitions' is a tool to list
3529 ;; actually used footnotes definitions in the whole parse tree, or in
3530 ;; a headline, in order to add footnote listings throughout the
3531 ;; transcoded data.
3532 ;;
3533 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3534 ;; back-ends, when they need to attach the footnote definition only to
3535 ;; the first occurrence of the corresponding label.
3536 ;;
3537 ;; `org-export-get-footnote-definition' and
3538 ;; `org-export-get-footnote-number' provide easier access to
3539 ;; additional information relative to a footnote reference.
3542 "Return an alist between footnote numbers, labels and definitions.
3544 DATA is the parse tree from which definitions are collected.
3545 INFO is the plist used as a communication channel.
3547 Definitions are sorted by order of references. They either
3548 appear as Org data or as a secondary string for inlined
3549 footnotes. Unreferenced definitions are ignored."
3551 collect-fn ; for byte-compiler.
3555 ;; Collect footnote number, label and definition in DATA.
3563 def)
3564 num-alist)
3565 ;; Also search in definition for nested footnotes.
3568 ;; Don't enter footnote definitions since it will happen
3569 ;; when their first reference is found.
3575 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3576 INFO is the plist used as a communication channel. If no such
3577 definition can be found, raise an error."
3585 "Apply FUNCTION on every footnote reference in parse tree.
3586 INFO is a plist containing export state. By default, as soon as
3587 a new footnote reference is encountered, FUNCTION is called onto
3588 its definition. However, if BODY-FIRST is non-nil, this step is
3589 delayed until the end of the process."
3595 ;; Search footnote references through DATA, filling
3596 ;; SEEN-REFS along the way. When DELAYP is non-nil, store
3597 ;; footnote definitions so they can be entered later.
3604 ;; Search for subsequent references in footnote
3605 ;; definition so numbering follows reading logic,
3606 ;; unless DELAYP in non-nil.
3610 definitions))
3611 ;; Do not force entering inline definitions,
3612 ;; since `org-element-map' already traverses them
3613 ;; at the right time.
3617 nil))))))
3618 info nil
3619 ;; Don't enter footnote definitions since it will happen
3620 ;; when their first reference is found. Moreover, if
3621 ;; DELAYP is non-nil, make sure we postpone entering
3622 ;; definitions of inline references.
3630 "Non-nil when a footnote reference is the first one for its label.
3632 FOOTNOTE-REFERENCE is the footnote reference being considered.
3633 INFO is a plist containing current export state.
3635 By default, as soon as a new footnote reference is encountered,
3636 other references are searched within its definition. However, if
3637 BODY-FIRST is non-nil, this step is delayed after the whole tree
3638 is checked. This alters results when references are found in
3639 footnote definitions."
3641 ;; Anonymous footnotes are always a first reference.
3649 info body-first)))))
3652 "Return number associated to a footnote.
3654 FOOTNOTE is either a footnote reference or a footnote definition.
3655 INFO is the plist containing export state.
3657 By default, as soon as a new footnote reference is encountered,
3658 counting process moves into its definition. However, if
3659 BODY-FIRST is non-nil, this step is delayed until the end of the
3660 process, leading to a different order when footnotes are nested."
3669 ;; Anonymous footnote match: return number.
3671 ;; Labels match: return number.
3673 ;; Otherwise store label and increase counter if label
3674 ;; wasn't encountered yet.
3677 info body-first))))
3680 ;;;; For Headlines
3681 ;;
3682 ;; `org-export-get-relative-level' is a shortcut to get headline
3683 ;; level, relatively to the lower headline level in the parsed tree.
3684 ;;
3685 ;; `org-export-get-headline-number' returns the section number of an
3686 ;; headline, while `org-export-number-to-roman' allows to convert it
3687 ;; to roman numbers. With an optional argument,
3688 ;; `org-export-get-headline-number' returns a number to unnumbered
3689 ;; headlines (used for internal id).
3690 ;;
3691 ;; `org-export-get-headline-id' returns the unique internal id of a
3692 ;; headline.
3693 ;;
3694 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3695 ;; `org-export-last-sibling-p' are three useful predicates when it
3696 ;; comes to fulfill the `:headline-levels' property.
3697 ;;
3698 ;; `org-export-get-tags', `org-export-get-category' and
3699 ;; `org-export-get-node-property' extract useful information from an
3700 ;; headline or a parent headline. They all handle inheritance.
3701 ;;
3702 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3703 ;; as a secondary string, suitable for table of contents. It falls
3704 ;; back onto default title.
3707 "Return HEADLINE relative level within current parsed tree.
3708 INFO is a plist holding contextual information."
3713 "Non-nil when HEADLINE is considered as low level.
3715 INFO is a plist used as a communication channel.
3717 A low level headlines has a relative level greater than
3718 `:headline-levels' property value.
3720 Return value is the difference between HEADLINE relative level
3721 and the last level being considered as high enough, or nil."
3728 "Return a unique ID for HEADLINE.
3729 INFO is a plist holding contextual information."
3739 "Return numbered HEADLINE numbering as a list of numbers.
3740 INFO is a plist holding contextual information."
3745 "Return a non-nil value if HEADLINE element should be numbered.
3746 INFO is a plist used as a communication channel."
3755 "Convert integer N into a roman numeral."
3768 res)))
3771 "Return list of tags associated to ELEMENT.
3773 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3774 is a plist used as a communication channel.
3776 Select tags (see `org-export-select-tags') and exclude tags (see
3777 `org-export-exclude-tags') are removed from the list.
3779 When non-nil, optional argument TAGS should be a list of strings.
3780 Any tag belonging to this list will also be removed.
3782 When optional argument INHERITED is non-nil, tags can also be
3783 inherited from parent headlines and FILETAGS keywords."
3789 ;; Build complete list of inherited tags.
3796 ;; Add FILETAGS keywords and return results.
3800 "Return node PROPERTY value for BLOB.
3802 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3803 element or object.
3805 If optional argument INHERITED is non-nil, the value can be
3806 inherited from a parent headline.
3808 Return value is a string or nil."
3820 "Return category for element or object BLOB.
3822 INFO is a plist used as a communication channel.
3824 CATEGORY is automatically inherited from a parent headline, from
3825 #+CATEGORY: keyword or created out of original file name. If all
3838 "Return alternative title for HEADLINE, as a secondary string.
3839 INFO is a plist used as a communication channel. If no optional
3840 title is defined, fall-back to the regular title."
3847 "Non-nil when BLOB is the first sibling in its parent.
3848 BLOB is an element or an object. If BLOB is a headline, non-nil
3849 means it is the first sibling in the sub-tree. INFO is a plist
3850 used as a communication channel."
3855 "Non-nil when BLOB is the last sibling in its parent.
3856 BLOB is an element or an object. INFO is a plist used as
3857 a communication channel."
3861 ;;;; For Keywords
3862 ;;
3863 ;; `org-export-get-date' returns a date appropriate for the document
3864 ;; to about to be exported. In particular, it takes care of
3865 ;; `org-export-date-timestamp-format'.
3868 "Return date value for the current document.
3870 INFO is a plist used as a communication channel. FMT, when
3871 non-nil, is a time format string that will be applied on the date
3872 if it consists in a single timestamp object. It defaults to
3873 `org-export-date-timestamp-format' when nil.
3875 A proper date can be a secondary string, a string or nil. It is
3876 meant to be translated with `org-export-data' or alike."
3887 ;;;; For Links
3888 ;;
3889 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3890 ;; with `org-add-link-type', which see.
3891 ;;
3892 ;; `org-export-solidify-link-text' turns a string into a safer version
3893 ;; for links, replacing most non-standard characters with hyphens.
3894 ;;
3895 ;; `org-export-get-coderef-format' returns an appropriate format
3896 ;; string for coderefs.
3897 ;;
3898 ;; `org-export-inline-image-p' returns a non-nil value when the link
3899 ;; provided should be considered as an inline image.
3900 ;;
3901 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3902 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3903 ;; returns an appropriate unique identifier when found, or nil.
3904 ;;
3905 ;; `org-export-resolve-id-link' returns the first headline with
3906 ;; specified id or custom-id in parse tree, the path to the external
3907 ;; file with the id or nil when neither was found.
3908 ;;
3909 ;; `org-export-resolve-coderef' associates a reference to a line
3910 ;; number in the element it belongs, or returns the reference itself
3911 ;; when the element isn't numbered.
3914 "Take link text S and make a safe target out of it."
3919 "Try exporting LINK with a dedicated function.
3921 DESC is its description, as a string, or nil. INFO is the plist
3922 containing export state. Return output as a string, or nil if no
3923 protocol handles LINK.
3925 A custom protocol is expected to have precedence over regular
3926 back-end export. The function ignores links with an implicit
3937 desc
3938 backend))))))
3941 "Return format string for code reference link.
3942 PATH is the link path. DESC is its description."
3950 "Non-nil if LINK object points to an inline image.
3952 Optional argument is a set of RULES defining inline images. It
3953 is an alist where associations have the following shape:
3955 \(TYPE . REGEXP)
3957 Applying a rule means apply REGEXP against LINK's path when its
3958 type is TYPE. The function will return a non-nil value if any of
3959 the provided rules is non-nil. The default rule is
3960 `org-export-default-inline-image-rule'.
3962 This only applies to links without a description."
3973 "Resolve a code reference REF.
3975 INFO is a plist used as a communication channel.
3977 Return associated line number in source code, or REF itself,
3978 depending on src-block or example element's switches."
3985 org-coderef-label-format)))
3989 ;; Element containing REF is found. Resolve it to either
3990 ;; a label or a line number, as needed.
4000 "Return LINK destination.
4002 INFO is a plist holding contextual information.
4004 Return value can be an object, an element, or nil:
4006 - If LINK path matches a target object (i.e. <<path>>) return it.
4008 - If LINK path exactly matches the name affiliated keyword
4009 \(i.e. #+NAME: path) of an element, return that element.
4011 - If LINK path exactly matches any headline name, return that
4012 element. If more than one headline share that name, priority
4013 will be given to the one with the closest common ancestor, if
4014 any, or the first one in the parse tree otherwise.
4016 - Otherwise, return nil.
4019 significant."
4022 ;; Split PATH at white spaces so matches are space
4023 ;; insensitive.
4026 ;; Cache for destinations that are not position dependent.
4034 ;; Destination is not position dependent: use cached value.
4036 ;; First try to find a matching "<<path>>" unless user specified
4037 ;; he was looking for a headline (path starts with a "*"
4038 ;; character).
4044 path)
4045 blob))
4048 ;; Then try to find an element with a matching "#+NAME: path"
4049 ;; affiliated keyword.
4052 org-element-all-elements
4057 el)))
4060 ;; Last case: link either points to a headline or to nothingness.
4061 ;; Try to find the source, with priority given to headlines with
4062 ;; the closest common ancestor. If such candidate is found,
4063 ;; return it, otherwise return nil.
4067 ;; Return first headline whose `:raw-value' property is
4068 ;; NAME in parse tree DATA, or nil. Statistics cookies
4069 ;; are ignored.
4077 name)
4078 headline))
4080 ;; Search among headlines sharing an ancestor with link, from
4081 ;; closest to farthest.
4089 ;; No destination found: return nil.
4093 "Return headline referenced as LINK destination.
4095 INFO is a plist used as a communication channel.
4097 Return value can be the headline element matched in current parse
4101 ;; First check if id is within the current parse tree.
4106 headline))
4108 ;; Otherwise, look for external files.
4112 "Return radio-target object referenced as LINK destination.
4114 INFO is a plist used as a communication channel.
4116 Return value can be a radio-target object or nil. Assume LINK
4125 nil nil path nil nil t)
4126 t)
4127 radio))
4131 ;;;; For References
4132 ;;
4133 ;; `org-export-get-ordinal' associates a sequence number to any object
4134 ;; or element.
4137 "Return ordinal number of an element or object.
4139 ELEMENT is the element or object considered. INFO is the plist
4140 used as a communication channel.
4142 Optional argument TYPES, when non-nil, is a list of element or
4143 object types, as symbols, that should also be counted in.
4144 Otherwise, only provided element's type is considered.
4146 Optional argument PREDICATE is a function returning a non-nil
4147 value if the current element or object should be counted in. It
4148 accepts two arguments: the element or object being considered and
4149 the plist used as a communication channel. This allows to count
4150 only a certain type of objects (i.e. inline images).
4152 Return value is a list of numbers if ELEMENT is a headline or an
4153 item. It is nil for keywords. It represents the footnote number
4154 for footnote definitions and footnote references. If ELEMENT is
4155 a target, return the same value as if ELEMENT was the closest
4156 table, item or headline containing the target. In any other
4157 case, return the sequence number of ELEMENT among elements or
4158 objects of the same type."
4159 ;; Ordinal of a target object refer to the ordinal of the closest
4160 ;; table, item, or headline containing the object.
4164 element
4167 ;; Special case 1: A headline returns its number as a list.
4169 ;; Special case 2: An item returns its number as a list.
4173 struct
4180 ;; Increment counter until ELEMENT is found again.
4191 ;;;; For Src-Blocks
4192 ;;
4193 ;; `org-export-get-loc' counts number of code lines accumulated in
4194 ;; src-block or example-block elements with a "+n" switch until
4195 ;; a given element, excluded. Note: "-n" switches reset that count.
4196 ;;
4197 ;; `org-export-unravel-code' extracts source code (along with a code
4198 ;; references alist) from an `element-block' or `src-block' type
4199 ;; element.
4200 ;;
4201 ;; `org-export-format-code' applies a formatting function to each line
4202 ;; of code, providing relative line number and code reference when
4203 ;; appropriate. Since it doesn't access the original element from
4204 ;; which the source code is coming, it expects from the code calling
4205 ;; it to know if lines should be numbered and if code references
4206 ;; should appear.
4207 ;;
4208 ;; Eventually, `org-export-format-code-default' is a higher-level
4209 ;; function (it makes use of the two previous functions) which handles
4210 ;; line numbering and code references inclusion, and returns source
4211 ;; code in a format suitable for plain text or verbatim output.
4214 "Return accumulated lines of code up to ELEMENT.
4216 INFO is the plist used as a communication channel.
4218 ELEMENT is excluded from count."
4224 ;; ELEMENT is reached: Quit the loop.
4226 ;; Only count lines from src-block and example-block elements
4227 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4231 ;; Accumulate locs or reset them.
4235 ;; Return nil to stay in the loop.
4236 nil)))
4238 ;; Return value.
4239 loc))
4242 "Clean source code and extract references out of it.
4244 ELEMENT has either a `src-block' an `example-block' type.
4246 Return a cons cell whose CAR is the source code, cleaned from any
4247 reference, protective commas and spurious indentation, and CDR is
4248 an alist between relative line number (integer) and name of code
4249 reference on that line (string)."
4252 ;; Get code and clean it. Remove blank lines at its
4253 ;; beginning and end.
4260 value
4262 ;; Get format used for references.
4265 org-coderef-label-format)))
4266 ;; Build a regexp matching a loc with a reference.
4271 ;; Return value.
4273 ;; Code with references removed.
4279 ;; Ref line: remove ref, and signal its position in REFS.
4283 ;; Reference alist.
4284 refs)))
4287 "Format CODE by applying FUN line-wise and return it.
4289 CODE is a string representing the code to format. FUN is
4290 a function. It must accept three arguments: a line of
4291 code (string), the current line number (integer) or nil and the
4292 reference associated to the current line (string) or nil.
4294 Optional argument NUM-LINES can be an integer representing the
4295 number of code lines accumulated until the current code. Line
4296 numbers passed to FUN will take it into account. If it is nil,
4297 FUN's second argument will always be nil. This number can be
4298 obtained with `org-export-get-loc' function.
4300 Optional argument REF-ALIST can be an alist between relative line
4301 number (i.e. ignoring NUM-LINES) and the name of the code
4302 reference on it. If it is nil, FUN's third argument will always
4303 be nil. It can be obtained through the use of
4304 `org-export-unravel-code' function."
4316 "Return source code from ELEMENT, formatted in a standard way.
4318 ELEMENT is either a `src-block' or `example-block' element. INFO
4319 is a plist used as a communication channel.
4321 This function takes care of line numbering and code references
4322 inclusion. Line numbers, when applicable, appear at the
4323 beginning of the line, separated from the code by two white
4324 spaces. Code references, on the other hand, appear flushed to
4325 the right, separated by six white spaces from the widest line of
4326 code."
4327 ;; Extract code and references.
4334 ;; Handle line numbering.
4343 ;; Prepare references display, if required. Any reference
4344 ;; should start six columns after the widest line of code,
4345 ;; wrapped with parenthesis.
4350 code
4354 number-str
4355 loc
4361 num-start refs)))))
4364 ;;;; For Tables
4365 ;;
4366 ;; `org-export-table-has-special-column-p' and and
4367 ;; `org-export-table-row-is-special-p' are predicates used to look for
4368 ;; meta-information about the table structure.
4369 ;;
4370 ;; `org-table-has-header-p' tells when the rows before the first rule
4371 ;; should be considered as table's header.
4372 ;;
4373 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4374 ;; and `org-export-table-cell-borders' extract information from
4375 ;; a table-cell element.
4376 ;;
4377 ;; `org-export-table-dimensions' gives the number on rows and columns
4378 ;; in the table, ignoring horizontal rules and special columns.
4379 ;; `org-export-table-cell-address', given a table-cell object, returns
4380 ;; the absolute address of a cell. On the other hand,
4381 ;; `org-export-get-table-cell-at' does the contrary.
4382 ;;
4383 ;; `org-export-table-cell-starts-colgroup-p',
4384 ;; `org-export-table-cell-ends-colgroup-p',
4385 ;; `org-export-table-row-starts-rowgroup-p',
4386 ;; `org-export-table-row-ends-rowgroup-p',
4387 ;; `org-export-table-row-starts-header-p',
4388 ;; `org-export-table-row-ends-header-p' and
4389 ;; `org-export-table-row-in-header-p' indicate position of current row
4390 ;; or cell within the table.
4393 "Non-nil when TABLE has a special column.
4394 All special columns will be ignored during export."
4395 ;; The table has a special column when every first cell of every row
4396 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4397 ;; "*" "_" and "^". Though, do not consider a first row containing
4398 ;; only empty cells as special.
4414 "Non-nil when TABLE has a header.
4416 INFO is a plist used as a communication channel.
4418 A table has a header when it contains at least two row groups."
4427 table
4438 cache)))))
4441 "Non-nil if TABLE-ROW is considered special.
4443 INFO is a plist used as the communication channel.
4445 All special rows will be ignored during export."
4449 ;; A row is special either when...
4451 ;; ... it starts with a field only containing "/",
4453 ;; ... the table contains a special column and the row start
4454 ;; with a marking character among, "^", "_", "$" or "!",
4458 ;; ... it contains only alignment cookies and empty cells.
4464 ;; Since VALUE is a secondary string, the following
4465 ;; checks avoid expanding it with `org-export-data'.
4477 "Return TABLE-ROW's group number, as an integer.
4479 INFO is a plist used as the communication channel.
4481 Return value is the group number, as an integer, or nil for
4482 special rows and rows separators. First group is also table's
4483 header."
4501 "Return TABLE-CELL contents width.
4503 INFO is a plist used as the communication channel.
4505 Return value is the width given by the last width cookie in the
4506 same column as TABLE-CELL, or nil."
4525 ;; In a special row, try to find a width cookie at COLUMN.
4529 ;; The following checks avoid expanding unnecessarily
4530 ;; the cell with `org-export-data'.
4540 "Return TABLE-CELL contents alignment.
4542 INFO is a plist used as the communication channel.
4544 Return alignment as specified by the last alignment cookie in the
4545 same column as TABLE-CELL. If no such cookie is found, a default
4546 alignment value will be deduced from fraction of numbers in the
4547 column (see `org-table-number-fraction' for more information).
4548 Possible values are `left', `right' and `center'."
4549 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4566 cookie-align
4567 previous-cell-number-p)
4570 ;; In a special row, try to find an alignment cookie at
4571 ;; COLUMN.
4575 ;; Since VALUE is a secondary string, the following
4576 ;; checks avoid useless expansion through
4577 ;; `org-export-data'.
4585 ;; Ignore table rules.
4587 ;; In a standard row, check if cell's contents are
4588 ;; expressing some kind of number. Increase NUMBER-CELLS
4589 ;; accordingly. Though, don't bother if an alignment
4590 ;; cookie has already defined cell's alignment.
4595 info)))
4597 ;; Treat an empty cell as a number if it follows
4598 ;; a number.
4604 ;; Return value. Alignment specified by cookies has
4605 ;; precedence over alignment deduced from cell's contents.
4607 column
4612 org-table-number-fraction)
4617 "Return TABLE-CELL borders.
4619 INFO is a plist used as a communication channel.
4621 Return value is a list of symbols, or nil. Possible values are:
4622 `top', `bottom', `above', `below', `left' and `right'. Note:
4623 `top' (resp. `bottom') only happen for a cell in the first
4624 row (resp. last row) of the table, ignoring table rules, if any.
4626 Returned borders ignore special rows."
4629 borders)
4630 ;; Top/above border? TABLE-CELL has a border above when a rule
4631 ;; used to demarcate row groups can be found above. Hence,
4632 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4633 ;; another regular row has to be found above that rule.
4642 ;; Look at every row before the current one.
4644 ;; No rule above, or rule found starts the table (ignoring any
4645 ;; special row): TABLE-CELL is at the top of the table.
4648 ;; Bottom/below border? TABLE-CELL has a border below when next
4649 ;; non-regular row below is a rule.
4658 ;; Look at every row after the current one.
4660 ;; No rule below, or rule found ends the table (modulo some
4661 ;; special row): TABLE-CELL is at the bottom of the table.
4664 ;; Right/left borders? They can only be specified by column
4665 ;; groups. Column groups are defined in a row starting with "/".
4666 ;; Also a column groups row only contains "<", "<>", ">" or blank
4667 ;; cells.
4684 ;; There's a left border when previous cell, if
4685 ;; any, ends a group, or current one starts one.
4691 ;; There's a right border when next cell, if any,
4692 ;; starts a group, or current one ends one.
4699 ;; Table rows are read in reverse order so last column groups
4700 ;; row has precedence over any previous one.
4702 ;; Return value.
4703 borders))
4706 "Non-nil when TABLE-CELL is at the beginning of a column group.
4707 INFO is a plist used as a communication channel."
4708 ;; A cell starts a column group either when it is at the beginning
4709 ;; of a row (or after the special column, if any) or when it has
4710 ;; a left border.
4713 table-cell)
4717 "Non-nil when TABLE-CELL is at the end of a column group.
4718 INFO is a plist used as a communication channel."
4719 ;; A cell ends a column group either when it is at the end of a row
4720 ;; or when it has a right border.
4723 table-cell)
4727 "Non-nil when TABLE-ROW is at the beginning of a row group.
4728 INFO is a plist used as a communication channel."
4736 "Non-nil when TABLE-ROW is at the end of a row group.
4737 INFO is a plist used as a communication channel."
4745 "Non-nil when TABLE-ROW is located within table's header.
4746 INFO is a plist used as a communication channel. Always return
4747 nil for special rows and rows separators."
4753 "Non-nil when TABLE-ROW is the first table header's row.
4754 INFO is a plist used as a communication channel."
4759 "Non-nil when TABLE-ROW is the last table header's row.
4760 INFO is a plist used as a communication channel."
4765 "Return TABLE-ROW number.
4766 INFO is a plist used as a communication channel. Return value is
4767 zero-based and ignores separators. The function returns nil for
4768 special columns and separators."
4780 "Return TABLE dimensions.
4782 INFO is a plist used as a communication channel.
4784 Return value is a CONS like (ROWS . COLUMNS) where
4785 ROWS (resp. COLUMNS) is the number of exportable
4786 rows (resp. columns)."
4788 ;; Set number of rows, and extract first one.
4794 ;; Set number of columns.
4796 ;; Return value.
4800 "Return address of a regular TABLE-CELL object.
4802 TABLE-CELL is the cell considered. INFO is a plist used as
4803 a communication channel.
4805 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4806 zero-based index. Only exportable cells are considered. The
4807 function returns nil for other cells."
4819 "Return regular table-cell object at ADDRESS in TABLE.
4821 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4822 zero-based index. TABLE is a table type element. INFO is
4823 a plist used as a communication channel.
4825 If no table-cell, among exportable cells, is found at ADDRESS,
4826 return nil."
4829 ;; Row at (car address) or nil.
4837 'table-cell
4844 ;;;; For Tables Of Contents
4845 ;;
4846 ;; `org-export-collect-headlines' builds a list of all exportable
4847 ;; headline elements, maybe limited to a certain depth. One can then
4848 ;; easily parse it and transcode it.
4849 ;;
4850 ;; Building lists of tables, figures or listings is quite similar.
4851 ;; Once the generic function `org-export-collect-elements' is defined,
4852 ;; `org-export-collect-tables', `org-export-collect-figures' and
4853 ;; `org-export-collect-listings' can be derived from it.
4856 "Collect headlines in order to build a table of contents.
4858 INFO is a plist used as a communication channel.
4860 When optional argument N is an integer, it specifies the depth of
4861 the table of contents. Otherwise, it is set to the value of the
4862 last headline level. See `org-export-headline-levels' for more
4863 information.
4865 Optional argument SCOPE, when non-nil, is an element. If it is
4866 a headline, only children of SCOPE are collected. Otherwise,
4867 collect children of the headline containing provided element. If
4868 there is no such headline, collect all headlines. In any case,
4869 argument N becomes relative to the level of that headline.
4871 Return a list of all exportable headlines as parsed elements.
4872 Footnote sections are ignored."
4881 limit))))
4887 info)))
4890 "Collect referenceable elements of a determined type.
4892 TYPE can be a symbol or a list of symbols specifying element
4893 types to search. Only elements with a caption are collected.
4895 INFO is a plist used as a communication channel.
4897 When non-nil, optional argument PREDICATE is a function accepting
4898 one argument, an element of type TYPE. It returns a non-nil
4899 value when that element should be collected.
4901 Return a list of all elements found, in order of appearance."
4906 element))
4907 info))
4910 "Build a list of tables.
4911 INFO is a plist used as a communication channel.
4913 Return a list of table elements with a caption."
4917 "Build a list of figures.
4919 INFO is a plist used as a communication channel. PREDICATE is
4920 a function which accepts one argument: a paragraph element and
4921 whose return value is non-nil when that element should be
4922 collected.
4924 A figure is a paragraph type element, with a caption, verifying
4926 a vague concept that may depend on back-end.
4928 Return a list of elements recognized as figures."
4932 "Build a list of src blocks.
4934 INFO is a plist used as a communication channel.
4936 Return a list of src-block elements with a caption."
4940 ;;;; Smart Quotes
4941 ;;
4942 ;; The main function for the smart quotes sub-system is
4943 ;; `org-export-activate-smart-quotes', which replaces every quote in
4944 ;; a given string from the parse tree with its "smart" counterpart.
4945 ;;
4946 ;; Dictionary for smart quotes is stored in
4947 ;; `org-export-smart-quotes-alist'.
4948 ;;
4949 ;; Internally, regexps matching potential smart quotes (checks at
4950 ;; string boundaries are also necessary) are defined in
4951 ;; `org-export-smart-quotes-regexps'.
4955 ;; one may use: »...«, "...", ›...‹, or '...'.
4956 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4957 ;; LaTeX quotes require Babel!
5002 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5011 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5020 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5029 ;; 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
5030 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5041 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5047 )
5048 "Smart quotes translations.
5050 Alist whose CAR is a language string and CDR is an alist with
5051 quote type as key and a plist associating various encodings to
5052 their translation as value.
5054 A quote type can be any symbol among `opening-double-quote',
5055 `closing-double-quote', `opening-single-quote',
5056 `closing-single-quote' and `apostrophe'.
5058 Valid encodings include `:utf-8', `:html', `:latex' and
5059 `:texinfo'.
5065 ;; Possible opening quote at beginning of string.
5067 ;; Possible closing quote at beginning of string.
5069 ;; Possible apostrophe at beginning of string.
5071 ;; Opening single and double quotes.
5073 ;; Closing single and double quotes.
5075 ;; Apostrophe.
5077 ;; Possible opening quote at end of string.
5079 ;; Possible closing quote at end of string.
5081 ;; Possible apostrophe at end of string.
5083 "List of regexps matching a quote or an apostrophe.
5089 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5090 `:utf-8'. INFO is a plist used as a communication channel.
5092 The function has to retrieve information about string
5093 surroundings in parse tree. It can only happen with an
5094 unmodified string. Thus, if S has already been through another
5095 process, a non-nil ORIGINAL optional argument will provide that
5096 original string.
5098 Return the new string."
5101 ;; Try to be flexible when computing number of blanks
5102 ;; before object. The previous object may be a string
5103 ;; introduced by the back-end and not completely parsed.
5106 ;; A string with missing `:post-blank'
5107 ;; property.
5111 ;; Fallback value.
5116 ;; Return smart quote associated to a give quote Q, as
5117 ;; a string. TYPE is a symbol among `open', `close' and
5118 ;; `apostrophe'.
5128 org-export-smart-quotes-alist))))
5129 encoding)
5130 q)))))
5132 ;; Only a quote: no regexp can match. We have to check both
5133 ;; sides and decide what to do.
5141 ;; 1. Replace quote character at the beginning of S.
5143 ;; Apostrophe?
5149 ;; Closing quote?
5155 ;; Opening quote?
5161 ;; 2. Replace quotes in the middle of the string.
5163 ;; Opening quotes.
5169 ;; Closing quotes.
5175 ;; Apostrophes.
5180 ;; 3. Replace quote character at the end of S.
5182 ;; Apostrophe?
5187 ;; Closing quote?
5193 ;; Opening quote?
5198 ;; Return string with smart quotes.
5199 s))))
5201 ;;;; Topology
5202 ;;
5203 ;; Here are various functions to retrieve information about the
5204 ;; neighborhood of a given element or object. Neighbors of interest
5205 ;; are direct parent (`org-export-get-parent'), parent headline
5206 ;; (`org-export-get-parent-headline'), first element containing an
5207 ;; object, (`org-export-get-parent-element'), parent table
5208 ;; (`org-export-get-parent-table'), previous element or object
5209 ;; (`org-export-get-previous-element') and next element or object
5210 ;; (`org-export-get-next-element').
5212 ;; defsubst org-export-get-parent must be defined before first use
5218 "Return BLOB parent headline or nil.
5219 BLOB is the element or object being considered."
5223 "Return first element containing OBJECT or nil.
5224 OBJECT is the object to consider."
5228 "Return OBJECT parent table or nil.
5229 OBJECT is either a `table-cell' or `table-element' type object."
5233 "Return previous element or object.
5235 BLOB is an element or object. INFO is a plist used as
5236 a communication channel. Return previous exportable element or
5237 object, a string, or nil.
5239 When optional argument N is a positive integer, return a list
5240 containing up to N siblings before BLOB, from farthest to
5241 closest. With any other non-nil value, return a list containing
5242 all of them."
5248 prev)
5258 "Return next element or object.
5260 BLOB is an element or object. INFO is a plist used as
5261 a communication channel. Return next exportable element or
5262 object, a string, or nil.
5264 When optional argument N is a positive integer, return a list
5265 containing up to N siblings after BLOB, from closest to farthest.
5266 With any other non-nil value, return a list containing all of
5267 them."
5274 next)
5284 ;;;; Translation
5285 ;;
5286 ;; `org-export-translate' translates a string according to the language
5287 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5288 ;; the dictionary used for the translation.
5336 ("ru" :html "(Продолжение следует)"
5439 ("ru" :html "Список распечаток"
5453 ("ru" :html "Список таблиц"
5545 ("ru" :html "Неизвестная ссылка"
5548 "Dictionary for export engine.
5550 Alist whose car is the string to translate and cdr is an alist
5551 whose car is the language string and cdr is a plist whose
5552 properties are possible charsets and values translated terms.
5554 It is used as a database for `org-export-translate'. Since this
5555 function returns the string as-is if no translation was found,
5556 the variable only needs to record values different from the
5560 "Translate string S according to language specification.
5562 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5563 and `:utf-8'. INFO is a plist used as a communication channel.
5565 Translation depends on `:language' property. Return the
5566 translated string. If no translation is found, try to fall back
5567 to `:default' encoding. If it fails, return S."
5573 s)))
5576 \f
5577 ;;; Asynchronous Export
5578 ;;
5579 ;; `org-export-async-start' is the entry point for asynchronous
5580 ;; export. It recreates current buffer (including visibility,
5581 ;; narrowing and visited file) in an external Emacs process, and
5582 ;; evaluates a command there. It then applies a function on the
5583 ;; returned results in the current process.
5584 ;;
5585 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5586 ;; allow to export to a buffer or a file, asynchronously or not.
5587 ;;
5588 ;; `org-export-output-file-name' is an auxiliary function meant to be
5589 ;; used with `org-export-to-file'. With a given extension, it tries
5590 ;; to provide a canonical file name to write export output to.
5591 ;;
5592 ;; Asynchronously generated results are never displayed directly.
5593 ;; Instead, they are stored in `org-export-stack-contents'. They can
5594 ;; then be retrieved by calling `org-export-stack'.
5595 ;;
5596 ;; Export Stack is viewed through a dedicated major mode
5597 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5598 ;;`org-export-stack-delete', `org-export-stack-view' and
5599 ;;`org-export-stack-clear'.
5600 ;;
5601 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5602 ;; It should be used whenever `org-export-async-start' is called.
5605 "Call function FUN on the results returned by BODY evaluation.
5607 FUN is an anonymous function of one argument. BODY evaluation
5608 happens in an asynchronous process, from a buffer which is an
5609 exact copy of the current one.
5611 Use `org-export-add-to-stack' in FUN in order to register results
5612 in the stack.
5614 This is a low level function. See also `org-export-to-buffer'
5615 and `org-export-to-file' for more specialized functions."
5618 ;; Write the full sexp evaluating BODY in a copy of the current
5619 ;; buffer to a temporary file, as it may be too long for program
5620 ;; args in `start-process'.
5627 ;; Null characters (from variable values) are inserted
5628 ;; within the file. As a consequence, coding system for
5629 ;; buffer contents will not be recognized properly. So,
5630 ;; we make sure it is the same as the one used to display
5631 ;; the original buffer.
5633 ,coding
5636 ;; Ignore `kill-emacs-hook' and code evaluation
5637 ;; queries from Babel as we need a truly
5638 ;; non-interactive process.
5640 org-babel-confirm-evaluate-answer-no t)
5641 ;; Initialize export framework.
5643 ;; Re-create current buffer there.
5646 ;; Sexp to evaluate in the buffer.
5648 ;; Start external process.
5651 (,process
5653 #'start-process
5656 ,proc-buffer
5663 ;; Register running process in stack.
5665 ;; Set-up sentinel in order to catch results.
5668 ,process
5690 ;;;###autoload
5693 &optional async subtreep visible-only body-only ext-plist
5694 post-process)
5695 "Call `org-export-as' with output to a specified buffer.
5697 BACKEND is either an export back-end, as returned by, e.g.,
5698 `org-export-create-backend', or a symbol referring to
5699 a registered back-end.
5701 BUFFER is the name of the output buffer. If it already exists,
5702 it will be erased first, otherwise, it will be created.
5704 A non-nil optional argument ASYNC means the process should happen
5705 asynchronously. The resulting buffer should then be accessible
5706 through the `org-export-stack' interface. When ASYNC is nil, the
5707 buffer is displayed if `org-export-show-temporary-export-buffer'
5708 is non-nil.
5710 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5711 EXT-PLIST are similar to those used in `org-export-as', which
5712 see.
5714 Optional argument POST-PROCESS is a function which should accept
5715 no argument. It is always called within the current process,
5716 from BUFFER, with point at its beginning. Export back-ends can
5717 use it to set a major mode there, e.g,
5719 \(defun org-latex-export-as-latex
5720 \(&optional async subtreep visible-only body-only ext-plist)
5721 \(interactive)
5723 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5725 This function returns BUFFER."
5753 buffer)))
5755 ;;;###autoload
5758 post-process)
5759 "Call `org-export-as' with output to a specified file.
5761 BACKEND is either an export back-end, as returned by, e.g.,
5762 `org-export-create-backend', or a symbol referring to
5763 a registered back-end. FILE is the name of the output file, as
5764 a string.
5766 A non-nil optional argument ASYNC means the process should happen
5767 asynchronously. The resulting buffer will then be accessible
5768 through the `org-export-stack' interface.
5770 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5771 EXT-PLIST are similar to those used in `org-export-as', which
5772 see.
5774 Optional argument POST-PROCESS is called with FILE as its
5775 argument and happens asynchronously when ASYNC is non-nil. It
5776 has to return a file name, or nil. Export back-ends can use this
5777 to send the output file through additional processing, e.g,
5779 \(defun org-latex-export-to-latex
5780 \(&optional async subtreep visible-only body-only ext-plist)
5781 \(interactive)
5783 \(org-export-to-file 'latex outfile
5784 async subtreep visible-only body-only ext-plist
5785 \(lambda (file) (org-latex-compile file)))
5787 The function returns either a file name returned by POST-PROCESS,
5788 or FILE."
5807 backend subtreep visible-only body-only ext-plist)))
5814 ;; Get proper return value.
5816 file))))))
5819 "Return output file's name according to buffer specifications.
5821 EXTENSION is a string representing the output file extension,
5822 with the leading dot.
5824 With a non-nil optional argument SUBTREEP, try to determine
5826 of subtree at point.
5828 When optional argument PUB-DIR is set, use it as the publishing
5829 directory.
5831 When optional argument VISIBLE-ONLY is non-nil, don't export
5832 contents of hidden elements.
5834 Return file name as a string."
5837 ;; File name may come from EXPORT_FILE_NAME subtree
5838 ;; property, assuming point is at beginning of said
5839 ;; sub-tree.
5846 ;; File name may be extracted from buffer's associated
5847 ;; file, if any.
5849 ;; Can't determine file name on our own: Ask user.
5853 "Output file: " pub-dir nil nil nil
5857 ;; Build file name. Enforce EXTENSION over whatever user
5858 ;; may have come up with. PUB-DIR, if defined, always has
5859 ;; precedence over any provided path.
5864 extension))
5867 ;; If writing to OUTPUT-FILE would overwrite original file, append
5868 ;; EXTENSION another time to final name.
5871 output-file)))
5874 "Add a new result to export stack if not present already.
5876 SOURCE is a buffer or a file name containing export results.
5877 BACKEND is a symbol representing export back-end used to generate
5878 it.
5880 Entries already pointing to SOURCE and unavailable entries are
5881 removed beforehand. Return the new stack."
5887 "Menu for asynchronous export results and running processes."
5897 "Return source from export results at point in stack."
5904 source
5905 ;; SOURCE is not consistent with current line. The stack
5906 ;; view is outdated.
5910 "Remove all entries from export stack."
5915 "Refresh the asynchronous export stack.
5916 DUMMY is ignored. Unavailable sources are removed from the list.
5917 Return the new stack."
5927 ;; Back-end.
5929 ;; Age.
5932 ;; Compute age of the results.
5934 "%4h:%.2m "
5936 ;; Source.
5941 ;; Clear stack from exited processes, dead buffers or
5942 ;; non-existent files.
5954 "Remove export results at point from stack.
5955 If optional argument SOURCE is non-nil, remove it instead."
5960 org-export-stack-contents))))
5963 "View export results at point in stack.
5964 With an optional prefix argument IN-EMACS, force viewing files
5965 within Emacs."
5979 (define-key km "p" 'previous-line)
5980 (define-key km "\C-p" 'previous-line)
5981 (define-key km "\C-?" 'previous-line)
5982 (define-key km [up] 'previous-line)
5983 (define-key km "C" 'org-export-stack-clear)
5984 (define-key km "v" 'org-export-stack-view)
5985 (define-key km (kbd "RET") 'org-export-stack-view)
5986 (define-key km "d" 'org-export-stack-remove)
5987 km)
5988 "Keymap for Org Export Stack.")
5990 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5991 "Mode for displaying asynchronous export stack.
5994 stack.
5996 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5997 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5998 stack completely.
6000 Removing entries in an Org Export Stack buffer doesn't affect
6001 files or buffers, only the display.
6004 (abbrev-mode 0)
6005 (auto-fill-mode 0)
6006 (setq buffer-read-only t
6007 buffer-undo-list t
6008 truncate-lines t
6009 header-line-format
6010 '(:eval
6011 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6012 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6013 (set (make-local-variable 'revert-buffer-function)
6014 'org-export-stack-refresh))
6017 \f
6018 ;;; The Dispatcher
6019 ;;
6020 ;; `org-export-dispatch' is the standard interactive way to start an
6021 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6022 ;; for its interface, which, in turn, delegates response to key
6023 ;; pressed to `org-export--dispatch-action'.
6025 ;;;###autoload
6026 (defun org-export-dispatch (&optional arg)
6027 "Export dispatcher for Org mode.
6029 It provides an access to common export related tasks in a buffer.
6030 Its interface comes in two flavors: standard and expert.
6032 While both share the same set of bindings, only the former
6033 displays the valid keys associations in a dedicated buffer.
6034 Scrolling (resp. line-wise motion) in this buffer is done with
6035 SPC and DEL (resp. C-n and C-p) keys.
6037 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6038 flavor or the other.
6041 of options used back then, on the current buffer.
6043 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6044 (interactive "P")
6045 (let* ((input
6046 (cond ((equal arg '(16)) '(stack))
6047 ((and arg org-export-dispatch-last-action))
6048 (t (save-window-excursion
6049 (unwind-protect
6050 (progn
6051 ;; Remember where we are
6052 (move-marker org-export-dispatch-last-position
6053 (point)
6054 (org-base-buffer (current-buffer)))
6055 ;; Get and store an export command
6056 (setq org-export-dispatch-last-action
6057 (org-export--dispatch-ui
6058 (list org-export-initial-scope
6059 (and org-export-in-background 'async))
6060 nil
6061 org-export-dispatch-use-expert-ui)))
6062 (and (get-buffer "*Org Export Dispatcher*")
6063 (kill-buffer "*Org Export Dispatcher*")))))))
6064 (action (car input))
6065 (optns (cdr input)))
6066 (unless (memq 'subtree optns)
6067 (move-marker org-export-dispatch-last-position nil))
6068 (case action
6069 ;; First handle special hard-coded actions.
6070 (template (org-export-insert-default-template nil optns))
6071 (stack (org-export-stack))
6072 (publish-current-file
6073 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6074 (publish-current-project
6075 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6076 (publish-choose-project
6077 (org-publish (assoc (org-icompleting-read
6078 "Publish project: "
6079 org-publish-project-alist nil t)
6080 org-publish-project-alist)
6081 (memq 'force optns)
6082 (memq 'async optns)))
6083 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6084 (otherwise
6085 (save-excursion
6086 (when arg
6087 ;; Repeating command, maybe move cursor to restore subtree
6088 ;; context.
6089 (if (eq (marker-buffer org-export-dispatch-last-position)
6090 (org-base-buffer (current-buffer)))
6091 (goto-char org-export-dispatch-last-position)
6092 ;; We are in a different buffer, forget position.
6093 (move-marker org-export-dispatch-last-position nil)))
6094 (funcall action
6095 ;; Return a symbol instead of a list to ease
6096 ;; asynchronous export macro use.
6097 (and (memq 'async optns) t)
6098 (and (memq 'subtree optns) t)
6099 (and (memq 'visible optns) t)
6100 (and (memq 'body optns) t)))))))
6102 (defun org-export--dispatch-ui (options first-key expertp)
6103 "Handle interface for `org-export-dispatch'.
6105 OPTIONS is a list containing current interactive options set for
6106 export. It can contain any of the following symbols:
6107 `body' toggles a body-only export
6108 `subtree' restricts export to current subtree
6109 `visible' restricts export to visible part of buffer.
6110 `force' force publishing files.
6111 `async' use asynchronous export process
6113 FIRST-KEY is the key pressed to select the first level menu. It
6114 is nil when this menu hasn't been selected yet.
6116 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6117 buffer is provided, but indications about currently active
6118 options are given in the prompt. Moreover, \[?] allows to switch
6119 back to standard interface."
6120 (let* ((fontify-key
6121 (lambda (key &optional access-key)
6122 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6123 ;; non-nil is the required first-level key to activate
6124 ;; KEY. When its value is t, activate KEY independently
6125 ;; on the first key, if any. A nil value means KEY will
6126 ;; only be activated at first level.
6127 (if (or (eq access-key t) (eq access-key first-key))
6128 (org-propertize key 'face 'org-warning)
6129 key)))
6130 (fontify-value
6131 (lambda (value)
6132 ;; Fontify VALUE string.
6133 (org-propertize value 'face 'font-lock-variable-name-face)))
6134 ;; Prepare menu entries by extracting them from registered
6135 ;; back-ends and sorting them by access key and by ordinal,
6136 ;; if any.
6137 (entries
6138 (sort (sort (delq nil
6139 (mapcar 'org-export-backend-menu
6140 org-export--registered-backends))
6141 (lambda (a b)
6142 (let ((key-a (nth 1 a))
6143 (key-b (nth 1 b)))
6144 (cond ((and (numberp key-a) (numberp key-b))
6145 (< key-a key-b))
6146 ((numberp key-b) t)))))
6147 'car-less-than-car))
6148 ;; Compute a list of allowed keys based on the first key
6149 ;; pressed, if any. Some keys
6150 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6151 ;; available.
6152 (allowed-keys
6153 (nconc (list 2 22 19 6 1)
6154 (if (not first-key) (org-uniquify (mapcar 'car entries))
6155 (let (sub-menu)
6156 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6157 (when (eq (car entry) first-key)
6158 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6159 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6160 ((not first-key) (list ?P)))
6161 (list ?& ?#)
6162 (when expertp (list ??))
6163 (list ?q)))
6164 ;; Build the help menu for standard UI.
6165 (help
6166 (unless expertp
6167 (concat
6168 ;; Options are hard-coded.
6169 (format "[%s] Body only: %s [%s] Visible only: %s
6170 \[%s] Export scope: %s [%s] Force publishing: %s
6172 (funcall fontify-key "C-b" t)
6173 (funcall fontify-value
6174 (if (memq 'body options) "On " "Off"))
6175 (funcall fontify-key "C-v" t)
6176 (funcall fontify-value
6177 (if (memq 'visible options) "On " "Off"))
6178 (funcall fontify-key "C-s" t)
6179 (funcall fontify-value
6180 (if (memq 'subtree options) "Subtree" "Buffer "))
6181 (funcall fontify-key "C-f" t)
6182 (funcall fontify-value
6183 (if (memq 'force options) "On " "Off"))
6184 (funcall fontify-key "C-a" t)
6185 (funcall fontify-value
6186 (if (memq 'async options) "On " "Off")))
6187 ;; Display registered back-end entries. When a key
6188 ;; appears for the second time, do not create another
6189 ;; entry, but append its sub-menu to existing menu.
6190 (let (last-key)
6191 (mapconcat
6192 (lambda (entry)
6193 (let ((top-key (car entry)))
6194 (concat
6195 (unless (eq top-key last-key)
6196 (setq last-key top-key)
6198 (funcall fontify-key (char-to-string top-key))
6199 (nth 1 entry)))
6200 (let ((sub-menu (nth 2 entry)))
6201 (unless (functionp sub-menu)
6202 ;; Split sub-menu into two columns.
6203 (let ((index -1))
6204 (concat
6205 (mapconcat
6206 (lambda (sub-entry)
6207 (incf index)
6208 (format
6209 (if (zerop (mod index 2)) " [%s] %-26s"
6211 (funcall fontify-key
6212 (char-to-string (car sub-entry))
6213 top-key)
6214 (nth 1 sub-entry)))
6215 sub-menu "")
6217 entries ""))
6218 ;; Publishing menu is hard-coded.
6220 [%s] Current file [%s] Current project
6222 (funcall fontify-key "P")
6223 (funcall fontify-key "f" ?P)
6224 (funcall fontify-key "p" ?P)
6225 (funcall fontify-key "x" ?P)
6226 (funcall fontify-key "a" ?P))
6228 (funcall fontify-key "&" t)
6229 (funcall fontify-key "#" t))
6230 (format "[%s] %s"
6231 (funcall fontify-key "q" t)
6232 (if first-key "Main menu" "Exit")))))
6233 ;; Build prompts for both standard and expert UI.
6234 (standard-prompt (unless expertp "Export command: "))
6235 (expert-prompt
6236 (when expertp
6237 (format
6238 "Export command (C-%s%s%s%s%s) [%s]: "
6239 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6240 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6241 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6242 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6243 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6244 (mapconcat (lambda (k)
6245 ;; Strip control characters.
6246 (unless (< k 27) (char-to-string k)))
6247 allowed-keys "")))))
6248 ;; With expert UI, just read key with a fancy prompt. In standard
6249 ;; UI, display an intrusive help buffer.
6250 (if expertp
6251 (org-export--dispatch-action
6252 expert-prompt allowed-keys entries options first-key expertp)
6253 ;; At first call, create frame layout in order to display menu.
6254 (unless (get-buffer "*Org Export Dispatcher*")
6255 (delete-other-windows)
6256 (org-switch-to-buffer-other-window
6257 (get-buffer-create "*Org Export Dispatcher*"))
6258 (setq cursor-type nil
6259 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6260 ;; Make sure that invisible cursor will not highlight square
6261 ;; brackets.
6262 (set-syntax-table (copy-syntax-table))
6263 (modify-syntax-entry ?\[ "w"))
6264 ;; At this point, the buffer containing the menu exists and is
6265 ;; visible in the current window. So, refresh it.
6266 (with-current-buffer "*Org Export Dispatcher*"
6267 ;; Refresh help. Maintain display continuity by re-visiting
6268 ;; previous window position.
6269 (let ((pos (window-start)))
6270 (erase-buffer)
6271 (insert help)
6272 (set-window-start nil pos)))
6273 (org-fit-window-to-buffer)
6274 (org-export--dispatch-action
6275 standard-prompt allowed-keys entries options first-key expertp))))
6277 (defun org-export--dispatch-action
6278 (prompt allowed-keys entries options first-key expertp)
6279 "Read a character from command input and act accordingly.
6281 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6282 a list of characters available at a given step in the process.
6283 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6284 EXPERTP are the same as defined in `org-export--dispatch-ui',
6285 which see.
6287 Toggle export options when required. Otherwise, return value is
6288 a list with action as CAR and a list of interactive export
6289 options as CDR."
6290 (let (key)
6291 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6292 ;; C-p, SPC, DEL).
6293 (while (and (setq key (read-char-exclusive prompt))
6294 (not expertp)
6295 (memq key '(14 16 ?\s ?\d)))
6296 (case key
6297 (14 (if (not (pos-visible-in-window-p (point-max)))
6298 (ignore-errors (scroll-up 1))
6299 (message "End of buffer")
6300 (sit-for 1)))
6301 (16 (if (not (pos-visible-in-window-p (point-min)))
6302 (ignore-errors (scroll-down 1))
6303 (message "Beginning of buffer")
6304 (sit-for 1)))
6305 (?\s (if (not (pos-visible-in-window-p (point-max)))
6306 (scroll-up nil)
6307 (message "End of buffer")
6308 (sit-for 1)))
6309 (?\d (if (not (pos-visible-in-window-p (point-min)))
6310 (scroll-down nil)
6311 (message "Beginning of buffer")
6312 (sit-for 1)))))
6313 (cond
6314 ;; Ignore undefined associations.
6315 ((not (memq key allowed-keys))
6316 (ding)
6317 (unless expertp (message "Invalid key") (sit-for 1))
6318 (org-export--dispatch-ui options first-key expertp))
6319 ;; q key at first level aborts export. At second level, cancel
6320 ;; first key instead.
6321 ((eq key ?q) (if (not first-key) (error "Export aborted")
6322 (org-export--dispatch-ui options nil expertp)))
6323 ;; Help key: Switch back to standard interface if expert UI was
6324 ;; active.
6325 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6326 ;; Send request for template insertion along with export scope.
6327 ((eq key ?#) (cons 'template (memq 'subtree options)))
6328 ;; Switch to asynchronous export stack.
6329 ((eq key ?&) '(stack))
6330 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6331 ((memq key '(2 22 19 6 1))
6332 (org-export--dispatch-ui
6333 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6334 (6 'force) (1 'async))))
6335 (if (memq option options) (remq option options)
6336 (cons option options)))
6337 first-key expertp))
6338 ;; Action selected: Send key and options back to
6339 ;; `org-export-dispatch'.
6340 ((or first-key (functionp (nth 2 (assq key entries))))
6341 (cons (cond
6342 ((not first-key) (nth 2 (assq key entries)))
6343 ;; Publishing actions are hard-coded. Send a special
6344 ;; signal to `org-export-dispatch'.
6345 ((eq first-key ?P)
6346 (case key
6347 (?f 'publish-current-file)
6348 (?p 'publish-current-project)
6349 (?x 'publish-choose-project)
6350 (?a 'publish-all)))
6351 ;; Return first action associated to FIRST-KEY + KEY
6352 ;; path. Indeed, derived backends can share the same
6353 ;; FIRST-KEY.
6354 (t (catch 'found
6355 (mapc (lambda (entry)
6356 (let ((match (assq key (nth 2 entry))))
6357 (when match (throw 'found (nth 2 match)))))
6358 (member (assq first-key entries) entries)))))
6359 options))
6360 ;; Otherwise, enter sub-menu.
6361 (t (org-export--dispatch-ui options key expertp)))))
6365 (provide 'ox)
6367 ;; Local variables:
6368 ;; generated-autoload-file: "org-loaddefs.el"
6369 ;; End:
6371 ;;; ox.el ends here