| blob | 80cbc375c84c0a1f31adb4ab06120326c190162c |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2015 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
90 \f
91 ;;; Internal Variables
92 ;;
93 ;; Among internal variables, the most important is
94 ;; `org-export-options-alist'. This variable define the global export
95 ;; options, shared between every exporter, and how they are acquired.
141 "Alist between export properties and ways to set them.
143 The key of the alist is the property name, and the value is a list
144 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
146 KEYWORD is a string representing a buffer keyword, or nil. Each
147 property defined this way can also be set, during subtree
148 export, through a headline property named after the keyword
150 property).
151 OPTION is a string that could be found in an #+OPTIONS: line.
152 DEFAULT is the default value for the property.
153 BEHAVIOR determines how Org should handle multiple keywords for
154 the same property. It is a symbol among:
155 nil Keep old value and discard the new one.
156 t Replace old value with the new one.
157 `space' Concatenate the values, separating them with a space.
158 `newline' Concatenate the values, separating them with
159 a newline.
160 `split' Split values at white spaces, and cons them to the
161 previous list.
162 `parse' Parse value as a list of strings and Org objects,
163 which can then be transcoded with, e.g.,
164 `org-export-data'. It implies `space' behavior.
166 Values set through KEYWORD and OPTION have precedence over
167 DEFAULT.
169 All these properties should be back-end agnostic. Back-end
170 specific properties are set through `org-export-define-backend'.
174 "List of in-buffer keywords that require special treatment.
175 These keywords are not directly associated to a property. The
176 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', which
369 see.
371 This option can also be set with the OPTIONS keyword, e.g.,
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 behavior 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 "Non-nil means do not raise an error on broken links.
804 When this variable is non-nil, broken links are ignored, without
805 stopping the export process. If it is set to `mark', broken
806 links are marked as such in the output, with a string like
808 [BROKEN LINK: path]
810 where PATH is the un-resolvable reference.
812 This option can also be set with the OPTIONS keyword, e.g.,
823 "Alist between export snippets back-ends and exporter back-ends.
825 This variable allows to provide shortcuts for export snippets.
829 HTML code while every other back-end will ignore it."
838 "Coding system for the exported file."
845 "Non-nil means pushing export output to the kill ring.
846 This variable is ignored during asynchronous export."
856 "The initial scope when exporting with `org-export-dispatch'.
857 This variable can be either set to `buffer' or `subtree'."
864 "Non-nil means show buffer after exporting to temp buffer.
865 When Org exports to a file, the buffer visiting that file is never
866 shown, but remains buried. However, when exporting to
867 a temporary buffer, that buffer is popped up in a second window.
868 When this variable is nil, the buffer remains buried also in
869 these cases."
874 "Non-nil means export and publishing commands will run in background.
875 Results from an asynchronous export are never displayed
883 "File used to initialize external export process.
885 Value must be either nil or an absolute file name. When nil, the
886 external process is launched like a regular Emacs session,
887 loading user's initialization file and any site specific
888 configuration. If a file is provided, it, and only it, is loaded
889 at start-up.
891 Therefore, using a specific configuration makes the process to
892 load faster and the export more portable."
901 "Non-nil means using a non-intrusive `org-export-dispatch'.
902 In that case, no help buffer is displayed. Though, an indicator
908 asynchronous). Also, [?] allows to switch back to standard
909 mode."
916 \f
917 ;;; Defining Back-ends
918 ;;
919 ;; An export back-end is a structure with `org-export-backend' type
920 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
921 ;; and `menu' slots.
922 ;;
923 ;; At the lowest level, a back-end is created with
924 ;; `org-export-create-backend' function.
925 ;;
926 ;; A named back-end can be registered with
927 ;; `org-export-register-backend' function. A registered back-end can
928 ;; later be referred to by its name, with `org-export-get-backend'
929 ;; function. Also, such a back-end can become the parent of a derived
930 ;; back-end from which slot values will be inherited by default.
931 ;; `org-export-derived-backend-p' can check if a given back-end is
932 ;; derived from a list of back-end names.
933 ;;
934 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
935 ;; `org-export-get-all-filters' return the full alist of transcoders,
936 ;; options and filters, including those inherited from ancestors.
937 ;;
938 ;; At a higher level, `org-export-define-backend' is the standard way
939 ;; to define an export back-end. If the new back-end is similar to
940 ;; a registered back-end, `org-export-define-derived-backend' may be
941 ;; used instead.
942 ;;
943 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
944 ;; when a given back-end hasn't been registered yet.
948 name parent transcoders options filters blocks menu)
951 "Return export back-end named after NAME.
952 NAME is a symbol. Return nil if no such back-end is found."
959 "Register BACKEND as a known export back-end.
960 BACKEND is a structure with `org-export-backend' type."
961 ;; Refuse to register an unnamed back-end.
964 ;; Refuse to register a back-end with an unknown parent.
968 ;; Register dedicated export blocks in the parser.
972 ;; If a back-end with the same name as BACKEND is already
973 ;; registered, replace it with BACKEND. Otherwise, simply add
974 ;; BACKEND to the list of registered back-ends.
980 "Signal an error if BACKEND isn't defined."
985 "Non-nil if BACKEND is derived from one of BACKENDS.
986 BACKEND is an export back-end, as returned by, e.g.,
987 `org-export-create-backend', or a symbol referring to
988 a registered back-end. BACKENDS is constituted of symbols."
1000 "Return full translation table for BACKEND.
1002 BACKEND is an export back-end, as return by, e.g,,
1003 `org-export-create-backend'. Return value is an alist where
1004 keys are element or object types, as symbols, and values are
1005 transcoders.
1007 Unlike to `org-export-backend-transcoders', this function
1008 also returns transcoders inherited from parent back-ends,
1009 if any."
1013 parent)
1018 transcoders)))
1021 "Return export options for BACKEND.
1023 BACKEND is an export back-end, as return by, e.g,,
1024 `org-export-create-backend'. See `org-export-options-alist'
1025 for the shape of the return value.
1027 Unlike to `org-export-backend-options', this function also
1028 returns options inherited from parent back-ends, if any."
1032 parent)
1036 options)))
1039 "Return complete list of filters for BACKEND.
1041 BACKEND is an export back-end, as return by, e.g,,
1042 `org-export-create-backend'. Return value is an alist where
1043 keys are symbols and values lists of functions.
1045 Unlike to `org-export-backend-filters', this function also
1046 returns filters inherited from parent back-ends, if any."
1050 parent)
1054 filters)))
1057 "Define a new back-end BACKEND.
1059 TRANSCODERS is an alist between object or element types and
1060 functions handling them.
1062 These functions should return a string without any trailing
1063 space, or nil. They must accept three arguments: the object or
1064 element itself, its contents or nil when it isn't recursive and
1065 the property list used as a communication channel.
1067 Contents, when not nil, are stripped from any global indentation
1068 \(although the relative one is preserved). They also always end
1069 with a single newline character.
1071 If, for a given type, no function is found, that element or
1072 object type will simply be ignored, along with any blank line or
1073 white space at its end. The same will happen if the function
1074 returns the nil value. If that function returns the empty
1075 string, the type will be ignored, but the blank lines or white
1076 spaces will be kept.
1078 In addition to element and object types, one function can be
1079 associated to the `template' (or `inner-template') symbol and
1080 another one to the `plain-text' symbol.
1082 The former returns the final transcoded string, and can be used
1083 to add a preamble and a postamble to document's body. It must
1084 accept two arguments: the transcoded string and the property list
1085 containing export options. A function associated to `template'
1087 A function associated to `inner-template' is always applied.
1089 The latter, when defined, is to be called on every text not
1090 recognized as an element or an object. It must accept two
1091 arguments: the text string and the information channel. It is an
1092 appropriate place to protect special chars relative to the
1093 back-end.
1095 BODY can start with pre-defined keyword arguments. The following
1096 keywords are understood:
1098 :export-block
1100 String, or list of strings, representing block names that
1101 will not be parsed. This is used to specify blocks that will
1102 contain raw code specific to the back-end. These blocks
1103 still have to be handled by the relative `export-block' type
1104 translator.
1106 :filters-alist
1108 Alist between filters and function, or list of functions,
1109 specific to the back-end. See `org-export-filters-alist' for
1110 a list of all allowed filters. Filters defined here
1111 shouldn't make a back-end test, as it may prevent back-ends
1112 derived from this one to behave properly.
1114 :menu-entry
1116 Menu entry for the export dispatcher. It should be a list
1117 like:
1121 where :
1123 KEY is a free character selecting the back-end.
1125 DESCRIPTION-OR-ORDINAL is either a string or a number.
1127 If it is a string, is will be used to name the back-end in
1128 its menu entry. If it is a number, the following menu will
1129 be displayed as a sub-menu of the back-end with the same
1130 KEY. Also, the number will be used to determine in which
1131 order such sub-menus will appear (lowest first).
1133 ACTION-OR-MENU is either a function or an alist.
1135 If it is an action, it will be called with four
1136 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1137 BODY-ONLY. See `org-export-as' for further explanations on
1138 some of them.
1140 If it is an alist, associations should follow the
1141 pattern:
1145 where KEY, DESCRIPTION and ACTION are described above.
1147 Valid values include:
1151 or
1156 (lambda (a s v b)
1157 (if a (org-latex-export-to-pdf t s v b)
1158 (org-open-file
1159 (org-latex-export-to-pdf nil s v b)))))))
1161 or the following, which will be added to the previous
1162 sub-menu,
1168 :options-alist
1170 Alist between back-end specific properties introduced in
1171 communication channel and how their value are acquired. See
1172 `org-export-options-alist' for more information about
1173 structure of the values."
1188 :transcoders transcoders
1189 :options options
1190 :filters filters
1191 :blocks blocks
1195 "Create a new back-end as a variant of an existing one.
1197 CHILD is the name of the derived back-end. PARENT is the name of
1198 the parent back-end.
1200 BODY can start with pre-defined keyword arguments. The following
1201 keywords are understood:
1203 :export-block
1205 String, or list of strings, representing block names that
1206 will not be parsed. This is used to specify blocks that will
1207 contain raw code specific to the back-end. These blocks
1208 still have to be handled by the relative `export-block' type
1209 translator.
1211 :filters-alist
1213 Alist of filters that will overwrite or complete filters
1214 defined in PARENT back-end. See `org-export-filters-alist'
1215 for a list of allowed filters.
1217 :menu-entry
1219 Menu entry for the export dispatcher. See
1220 `org-export-define-backend' for more information about the
1221 expected value.
1223 :options-alist
1225 Alist of back-end specific properties that will overwrite or
1226 complete those defined in PARENT back-end. Refer to
1227 `org-export-options-alist' for more information about
1228 structure of the values.
1230 :translate-alist
1232 Alist of element and object types and transcoders that will
1233 overwrite or complete transcode table from PARENT back-end.
1234 Refer to `org-export-define-backend' for detailed information
1235 about transcoders.
1238 as a variant of `latex' back-end with a custom template function:
1243 The back-end could then be called with, for example:
1261 :parent parent
1262 :transcoders transcoders
1263 :options options
1264 :filters filters
1265 :blocks blocks
1269 \f
1270 ;;; The Communication Channel
1271 ;;
1272 ;; During export process, every function has access to a number of
1273 ;; properties. They are of two types:
1274 ;;
1275 ;; 1. Environment options are collected once at the very beginning of
1276 ;; the process, out of the original buffer and configuration.
1277 ;; Collecting them is handled by `org-export-get-environment'
1278 ;; function.
1279 ;;
1280 ;; Most environment options are defined through the
1281 ;; `org-export-options-alist' variable.
1282 ;;
1283 ;; 2. Tree properties are extracted directly from the parsed tree,
1284 ;; just before export, by `org-export-collect-tree-properties'.
1286 ;;;; Environment Options
1287 ;;
1288 ;; Environment options encompass all parameters defined outside the
1289 ;; scope of the parsed data. They come from five sources, in
1290 ;; increasing precedence order:
1291 ;;
1292 ;; - Global variables,
1293 ;; - Buffer's attributes,
1294 ;; - Options keyword symbols,
1295 ;; - Buffer keywords,
1296 ;; - Subtree properties.
1297 ;;
1298 ;; The central internal function with regards to environment options
1299 ;; is `org-export-get-environment'. It updates global variables with
1300 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1301 ;; the different sources.
1302 ;;
1303 ;; The internal functions doing the retrieval are:
1304 ;; `org-export--get-global-options',
1305 ;; `org-export--get-buffer-attributes',
1306 ;; `org-export--parse-option-keyword',
1307 ;; `org-export--get-subtree-options' and
1308 ;; `org-export--get-inbuffer-options'
1309 ;;
1310 ;; Also, `org-export--list-bound-variables' collects bound variables
1311 ;; along with their value in order to set them as buffer local
1312 ;; variables later in the process.
1315 "Collect export options from the current buffer.
1317 Optional argument BACKEND is an export back-end, as returned by
1318 `org-export-create-backend'.
1320 When optional argument SUBTREEP is non-nil, assume the export is
1321 done against the current sub-tree.
1323 Third optional argument EXT-PLIST is a property list with
1324 external parameters overriding Org default settings, but still
1325 inferior to file-local settings."
1326 ;; First install #+BIND variables since these must be set before
1327 ;; global options are read.
1330 ;; Get and prioritize export options...
1332 ;; ... from global variables...
1334 ;; ... from an external property list...
1335 ext-plist
1336 ;; ... from in-buffer settings...
1338 ;; ... and from subtree, when appropriate.
1340 ;; Eventually add misc. properties.
1342 :back-end
1343 backend
1345 :id-alist
1346 ;; Collect id references.
1357 alist))))
1360 "Parse an OPTIONS line and return values as a plist.
1361 Optional argument BACKEND is an export back-end, as returned by,
1362 e.g., `org-export-create-backend'. It specifies which back-end
1363 specific items to read, if any."
1370 alist))
1371 alist))
1372 ;; Priority is given to back-end specific options.
1374 org-export-options-alist))
1384 "Get export options in subtree at point.
1385 Optional argument BACKEND is an export back-end, as returned by,
1386 e.g., `org-export-create-backend'. It specifies back-end used
1387 for export. Return options as a plist."
1388 ;; For each buffer keyword, create a headline property setting the
1389 ;; same property in communication channel. The name for the
1390 ;; property is the keyword with "EXPORT_" appended to it.
1392 ;; Make sure point is at a heading.
1395 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1396 ;; care of them right from the start.
1399 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1400 ;; headline's title (with no todo keyword, priority cookie or
1401 ;; tag) as its fallback value.
1407 ;; Look for both general keywords and back-end specific
1408 ;; options, with priority given to the latter.
1410 org-export-options-alist)))
1411 ;; Handle other keywords. Then return PLIST.
1425 property
1434 "Return current buffer export options, as a plist.
1436 Optional argument BACKEND, when non-nil, is an export back-end,
1437 as returned by, e.g., `org-export-create-backend'. It specifies
1438 which back-end specific options should also be read in the
1439 process.
1441 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1444 ;; Priority is given to back-end specific options.
1446 org-export-options-alist))
1449 org-export-special-keywords))))
1450 plist to-parse)
1453 ;; Return all properties associated to KEYWORD.
1460 ;; Recursively read keywords in buffer. FILES is
1461 ;; a list of files read so far. PLIST is the current
1462 ;; property list obtained.
1471 ;; Options in `org-export-special-keywords'.
1476 ;; Avoid circular dependencies.
1487 plist
1489 val backend))))
1493 plist
1500 ;; Options in `org-export-options-alist'.
1503 plist
1505 plist property
1506 ;; Handle value depending on specified
1507 ;; BEHAVIOR.
1512 ;; Even if `parse' implies `space'
1513 ;; behavior, we separate line with
1514 ;; "\n" so as to preserve
1515 ;; line-breaks. However, empty
1516 ;; lines are forbidden since `parse'
1517 ;; doesn't allow more than one
1518 ;; paragraph.
1527 " "
1540 ;; Read options in the current buffer and return value.
1542 ;; Parse properties in TO-PARSE. Remove newline characters not
1543 ;; involved in line breaks to simulate `space' behavior.
1544 ;; Finally return options.
1556 "Return properties related to buffer attributes, as a plist."
1561 "Return global export options as a plist.
1562 Optional argument BACKEND, if non-nil, is an export back-end, as
1563 returned by, e.g., `org-export-create-backend'. It specifies
1564 which back-end specific export options should also be read in the
1565 process."
1567 ;; Priority is given to back-end specific options.
1569 org-export-options-alist)))
1575 plist
1576 prop
1577 ;; Evaluate default value provided.
1582 value)))))))))
1585 "Return variables bound from BIND keywords in current buffer.
1586 Also look for BIND keywords in setup files. The return value is
1587 an alist where associations are (VARIABLE-NAME VALUE)."
1591 ;; Return an alist between variable names and their
1592 ;; value. FILES is a list of setup files names read
1593 ;; so far, used to avoid circular dependencies. ALIST
1594 ;; is the alist collected so far.
1606 ;; Enter setup file.
1618 alist))))))))))
1619 alist)))))
1620 ;; Return value in appropriate order of appearance.
1623 ;; defsubst org-export-get-parent must be defined before first use,
1624 ;; was originally defined in the topology section
1627 "Return BLOB parent or nil.
1628 BLOB is the element or object considered."
1631 ;;;; Tree Properties
1632 ;;
1633 ;; Tree properties are information extracted from parse tree. They
1634 ;; are initialized at the beginning of the transcoding process by
1635 ;; `org-export-collect-tree-properties'.
1636 ;;
1637 ;; Dedicated functions focus on computing the value of specific tree
1638 ;; properties during initialization. Thus,
1639 ;; `org-export--populate-ignore-list' lists elements and objects that
1640 ;; should be skipped during export, `org-export--get-min-level' gets
1641 ;; the minimal exportable level, used as a basis to compute relative
1642 ;; level for headlines. Eventually
1643 ;; `org-export--collect-headline-numbering' builds an alist between
1644 ;; headlines and their numbering.
1647 "Extract tree properties from parse tree.
1649 DATA is the parse tree from which information is retrieved. INFO
1650 is a list holding export options.
1652 Following tree properties are set or updated:
1654 `:exported-data' Hash table used to memoize results from
1655 `org-export-data'.
1657 `:headline-offset' Offset between true level of headlines and
1658 local level. An offset of -1 means a headline
1659 of level 2 should be considered as a level
1660 1 headline in the context.
1662 `:headline-numbering' Alist of all headlines as key an the
1663 associated numbering as value.
1665 Return updated plist."
1666 ;; Install the parse tree in the communication channel.
1668 ;; Compute `:headline-offset' in order to be able to use
1669 ;; `org-export-get-relative-level'.
1672 :headline-offset
1674 ;; Properties order doesn't matter: get the rest of the tree
1675 ;; properties.
1679 info))
1682 "Return minimum exportable headline's level in DATA.
1683 DATA is parsed tree as returned by `org-element-parse-buffer'.
1684 OPTIONS is a plist holding export options."
1695 ;; If no headline was found, for the sake of consistency, set
1696 ;; minimum level to 1 nonetheless.
1700 "Return numbering of all exportable, numbered headlines in a parse tree.
1702 DATA is the parse tree. OPTIONS is the plist holding export
1703 options.
1705 Return an alist whose key is a headline and value is its
1706 associated numbering \(in the shape of a list of numbers) or nil
1707 for a footnotes section."
1716 headline
1718 for n across numbering
1719 for idx from 0 to org-export-max-depth
1723 options)))
1726 "List headlines and inlinetasks with a select tag in their tree.
1727 DATA is parsed data as returned by `org-element-parse-buffer'.
1728 INFO is a plist holding export options."
1738 ;; When a select tag is found, mark full
1739 ;; genealogy and every headline within the
1740 ;; tree as acceptable.
1743 genealogy
1746 selected-trees))
1747 ;; If at a headline, continue searching in tree,
1748 ;; recursively.
1757 selected-trees))
1760 "Non-nil when element or object BLOB should be skipped during export.
1761 OPTIONS is the plist holding export options. SELECTED, when
1762 non-nil, is a list of headlines or inlinetasks belonging to
1763 a tree with a select tag."
1770 ;; If `:with-drawers' value starts with `not', ignore
1771 ;; every drawer whose name belong to that list.
1772 ;; Otherwise, ignore drawers whose name isn't in that
1773 ;; list.
1790 ;; Ignore subtrees with an exclude tag.
1793 ;; When a select tag is present in the buffer, ignore any tree
1794 ;; without it.
1796 ;; Ignore commented sub-trees.
1798 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1800 ;; Ignore tasks, if specified by `:with-tasks' property.
1812 properties-set))))))
1823 ;; `:with-timestamps' only applies to isolated timestamps
1824 ;; objects, i.e. timestamp objects in a paragraph containing only
1825 ;; timestamps and whitespaces.
1833 options t))))
1842 \f
1843 ;;; The Transcoder
1844 ;;
1845 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1846 ;; `org-element-parse-buffer') and transcodes it into a specified
1847 ;; back-end output. It takes care of filtering out elements or
1848 ;; objects according to export options and organizing the output blank
1849 ;; lines and white space are preserved. The function memoizes its
1850 ;; results, so it is cheap to call it within transcoders.
1851 ;;
1852 ;; It is possible to modify locally the back-end used by
1853 ;; `org-export-data' or even use a temporary back-end by using
1854 ;; `org-export-data-with-backend'.
1855 ;;
1856 ;; `org-export-transcoder' is an accessor returning appropriate
1857 ;; translator function for a given element or object.
1860 "Return appropriate transcoder for BLOB.
1861 INFO is a plist containing export directives."
1863 ;; Return contents only for complete parse trees.
1869 "Convert DATA into current back-end format.
1871 DATA is a parse tree, an element or an object or a secondary
1872 string. INFO is a plist holding export options.
1874 Return a string."
1876 ;; Handle broken links according to
1877 ;; `org-export-with-broken-links'.
1892 ;; Ignored element/object.
1894 ;; Plain text.
1900 info))
1901 ;; Secondary string.
1904 ;; Element/Object without contents or, as a special
1905 ;; case, headline with archive tag and archived trees
1906 ;; restricted to title only.
1915 ;; Export snippets never return a nil value so
1916 ;; that white spaces following them are never
1917 ;; ignored.
1919 ;; Element/Object with contents.
1932 ;; Elements directly containing
1933 ;; objects must have their indentation
1934 ;; normalized first.
1936 data
1937 ;; When normalizing contents of the
1938 ;; first paragraph in an item or
1939 ;; a footnote definition, ignore
1940 ;; first line's indentation: there is
1941 ;; none and it might be misleading.
1946 data)
1954 info)))))))))
1955 ;; Final result will be memoized before being returned.
1957 data
1961 ;; Append the same white space between elements or objects
1962 ;; as in the original buffer, and call appropriate filters.
1973 info)))
1974 results)))
1978 "Convert DATA into BACKEND format.
1980 DATA is an element, an object, a secondary string or a string.
1981 BACKEND is a symbol. INFO is a plist used as a communication
1982 channel.
1984 Unlike to `org-export-with-backend', this function will
1985 recursively convert DATA using BACKEND translation table."
1988 data
1989 ;; Set-up a new communication channel with translations defined in
1990 ;; BACKEND as the translate table and a new hash table for
1991 ;; memoization.
1993 info
1996 ;; Size of the hash table is reduced since this function
1997 ;; will probably be used on small trees.
2001 "Expand a parsed element or object to its original state.
2003 BLOB is either an element or an object. CONTENTS is its
2004 contents, as a string or nil.
2006 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2007 keywords before output."
2012 blob contents))))
2015 \f
2016 ;;; The Filter System
2017 ;;
2018 ;; Filters allow end-users to tweak easily the transcoded output.
2019 ;; They are the functional counterpart of hooks, as every filter in
2020 ;; a set is applied to the return value of the previous one.
2021 ;;
2022 ;; Every set is back-end agnostic. Although, a filter is always
2023 ;; called, in addition to the string it applies to, with the back-end
2024 ;; used as argument, so it's easy for the end-user to add back-end
2025 ;; specific filters in the set. The communication channel, as
2026 ;; a plist, is required as the third argument.
2027 ;;
2028 ;; From the developer side, filters sets can be installed in the
2029 ;; process with the help of `org-export-define-backend', which
2030 ;; internally stores filters as an alist. Each association has a key
2031 ;; among the following symbols and a function or a list of functions
2032 ;; as value.
2033 ;;
2034 ;; - `:filter-options' applies to the property list containing export
2035 ;; options. Unlike to other filters, functions in this list accept
2036 ;; two arguments instead of three: the property list containing
2037 ;; export options and the back-end. Users can set its value through
2038 ;; `org-export-filter-options-functions' variable.
2039 ;;
2040 ;; - `:filter-parse-tree' applies directly to the complete parsed
2041 ;; tree. Users can set it through
2042 ;; `org-export-filter-parse-tree-functions' variable.
2043 ;;
2044 ;; - `:filter-body' applies to the body of the output, before template
2045 ;; translator chimes in. Users can set it through
2046 ;; `org-export-filter-body-functions' variable.
2047 ;;
2048 ;; - `:filter-final-output' applies to the final transcoded string.
2049 ;; Users can set it with `org-export-filter-final-output-functions'
2050 ;; variable.
2051 ;;
2052 ;; - `:filter-plain-text' applies to any string not recognized as Org
2053 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2054 ;; configure it.
2055 ;;
2056 ;; - `:filter-TYPE' applies on the string returned after an element or
2057 ;; object of type TYPE has been transcoded. A user can modify
2058 ;; `org-export-filter-TYPE-functions' to install these filters.
2059 ;;
2060 ;; All filters sets are applied with
2061 ;; `org-export-filter-apply-functions' function. Filters in a set are
2062 ;; applied in a LIFO fashion. It allows developers to be sure that
2063 ;; their filters will be applied first.
2064 ;;
2065 ;; Filters properties are installed in communication channel with
2066 ;; `org-export-install-filters' function.
2067 ;;
2068 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2069 ;; `org-export-before-parsing-hook') are run at the beginning of the
2070 ;; export process and just before parsing to allow for heavy structure
2071 ;; modifications.
2074 ;;;; Hooks
2077 "Hook run at the beginning of the export process.
2079 This is run before include keywords and macros are expanded and
2080 Babel code blocks executed, on a copy of the original buffer
2081 being exported. Visibility and narrowing are preserved. Point
2082 is at the beginning of the buffer.
2084 Every function in this hook will be called with one argument: the
2088 "Hook run before parsing an export buffer.
2090 This is run after include keywords and macros have been expanded
2091 and Babel code blocks executed, on a copy of the original buffer
2092 being exported. Visibility and narrowing are preserved. Point
2093 is at the beginning of the buffer.
2095 Every function in this hook will be called with one argument: the
2099 ;;;; Special Filters
2102 "List of functions applied to the export options.
2103 Each filter is called with two arguments: the export options, as
2104 a plist, and the back-end, as a symbol. It must return
2108 "List of functions applied to the parsed tree.
2109 Each filter is called with three arguments: the parse tree, as
2110 returned by `org-element-parse-buffer', the back-end, as
2111 a symbol, and the communication channel, as a plist. It must
2115 "List of functions applied to plain text.
2116 Each filter is called with three arguments: a string which
2117 contains no Org syntax, the back-end, as a symbol, and the
2118 communication channel, as a plist. It must return a string or
2122 "List of functions applied to transcoded body.
2123 Each filter is called with three arguments: a string which
2124 contains no Org syntax, the back-end, as a symbol, and the
2125 communication channel, as a plist. It must return a string or
2129 "List of functions applied to the transcoded string.
2130 Each filter is called with three arguments: the full transcoded
2131 string, the back-end, as a symbol, and the communication channel,
2132 as a plist. It must return a string that will be used as the
2136 ;;;; Elements Filters
2139 "List of functions applied to a transcoded babel-call.
2140 Each filter is called with three arguments: the transcoded data,
2141 as a string, the back-end, as a symbol, and the communication
2145 "List of functions applied to a transcoded center block.
2146 Each filter is called with three arguments: the transcoded data,
2147 as a string, the back-end, as a symbol, and the communication
2151 "List of functions applied to a transcoded clock.
2152 Each filter is called with three arguments: the transcoded data,
2153 as a string, the back-end, as a symbol, and the communication
2157 "List of functions applied to a transcoded diary-sexp.
2158 Each filter is called with three arguments: the transcoded data,
2159 as a string, the back-end, as a symbol, and the communication
2163 "List of functions applied to a transcoded drawer.
2164 Each filter is called with three arguments: the transcoded data,
2165 as a string, the back-end, as a symbol, and the communication
2169 "List of functions applied to a transcoded dynamic-block.
2170 Each filter is called with three arguments: the transcoded data,
2171 as a string, the back-end, as a symbol, and the communication
2175 "List of functions applied to a transcoded example-block.
2176 Each filter is called with three arguments: the transcoded data,
2177 as a string, the back-end, as a symbol, and the communication
2181 "List of functions applied to a transcoded export-block.
2182 Each filter is called with three arguments: the transcoded data,
2183 as a string, the back-end, as a symbol, and the communication
2187 "List of functions applied to a transcoded fixed-width.
2188 Each filter is called with three arguments: the transcoded data,
2189 as a string, the back-end, as a symbol, and the communication
2193 "List of functions applied to a transcoded footnote-definition.
2194 Each filter is called with three arguments: the transcoded data,
2195 as a string, the back-end, as a symbol, and the communication
2199 "List of functions applied to a transcoded headline.
2200 Each filter is called with three arguments: the transcoded data,
2201 as a string, the back-end, as a symbol, and the communication
2205 "List of functions applied to a transcoded horizontal-rule.
2206 Each filter is called with three arguments: the transcoded data,
2207 as a string, the back-end, as a symbol, and the communication
2211 "List of functions applied to a transcoded inlinetask.
2212 Each filter is called with three arguments: the transcoded data,
2213 as a string, the back-end, as a symbol, and the communication
2217 "List of functions applied to a transcoded item.
2218 Each filter is called with three arguments: the transcoded data,
2219 as a string, the back-end, as a symbol, and the communication
2223 "List of functions applied to a transcoded keyword.
2224 Each filter is called with three arguments: the transcoded data,
2225 as a string, the back-end, as a symbol, and the communication
2229 "List of functions applied to a transcoded latex-environment.
2230 Each filter is called with three arguments: the transcoded data,
2231 as a string, the back-end, as a symbol, and the communication
2235 "List of functions applied to a transcoded node-property.
2236 Each filter is called with three arguments: the transcoded data,
2237 as a string, the back-end, as a symbol, and the communication
2241 "List of functions applied to a transcoded paragraph.
2242 Each filter is called with three arguments: the transcoded data,
2243 as a string, the back-end, as a symbol, and the communication
2247 "List of functions applied to a transcoded plain-list.
2248 Each filter is called with three arguments: the transcoded data,
2249 as a string, the back-end, as a symbol, and the communication
2253 "List of functions applied to a transcoded planning.
2254 Each filter is called with three arguments: the transcoded data,
2255 as a string, the back-end, as a symbol, and the communication
2259 "List of functions applied to a transcoded property-drawer.
2260 Each filter is called with three arguments: the transcoded data,
2261 as a string, the back-end, as a symbol, and the communication
2265 "List of functions applied to a transcoded quote block.
2266 Each filter is called with three arguments: the transcoded quote
2267 data, as a string, the back-end, as a symbol, and the
2268 communication channel, as a plist. It must return a string or
2272 "List of functions applied to a transcoded section.
2273 Each filter is called with three arguments: the transcoded data,
2274 as a string, the back-end, as a symbol, and the communication
2278 "List of functions applied to a transcoded special block.
2279 Each filter is called with three arguments: the transcoded data,
2280 as a string, the back-end, as a symbol, and the communication
2284 "List of functions applied to a transcoded src-block.
2285 Each filter is called with three arguments: the transcoded data,
2286 as a string, the back-end, as a symbol, and the communication
2290 "List of functions applied to a transcoded table.
2291 Each filter is called with three arguments: the transcoded data,
2292 as a string, the back-end, as a symbol, and the communication
2296 "List of functions applied to a transcoded table-cell.
2297 Each filter is called with three arguments: the transcoded data,
2298 as a string, the back-end, as a symbol, and the communication
2302 "List of functions applied to a transcoded table-row.
2303 Each filter is called with three arguments: the transcoded data,
2304 as a string, the back-end, as a symbol, and the communication
2308 "List of functions applied to a transcoded verse block.
2309 Each filter is called with three arguments: the transcoded data,
2310 as a string, the back-end, as a symbol, and the communication
2314 ;;;; Objects Filters
2317 "List of functions applied to transcoded bold text.
2318 Each filter is called with three arguments: the transcoded data,
2319 as a string, the back-end, as a symbol, and the communication
2323 "List of functions applied to transcoded code text.
2324 Each filter is called with three arguments: the transcoded data,
2325 as a string, the back-end, as a symbol, and the communication
2329 "List of functions applied to a transcoded entity.
2330 Each filter is called with three arguments: the transcoded data,
2331 as a string, the back-end, as a symbol, and the communication
2335 "List of functions applied to a transcoded export-snippet.
2336 Each filter is called with three arguments: the transcoded data,
2337 as a string, the back-end, as a symbol, and the communication
2341 "List of functions applied to a transcoded footnote-reference.
2342 Each filter is called with three arguments: the transcoded data,
2343 as a string, the back-end, as a symbol, and the communication
2347 "List of functions applied to a transcoded inline-babel-call.
2348 Each filter is called with three arguments: the transcoded data,
2349 as a string, the back-end, as a symbol, and the communication
2353 "List of functions applied to a transcoded inline-src-block.
2354 Each filter is called with three arguments: the transcoded data,
2355 as a string, the back-end, as a symbol, and the communication
2359 "List of functions applied to transcoded italic text.
2360 Each filter is called with three arguments: the transcoded data,
2361 as a string, the back-end, as a symbol, and the communication
2365 "List of functions applied to a transcoded latex-fragment.
2366 Each filter is called with three arguments: the transcoded data,
2367 as a string, the back-end, as a symbol, and the communication
2371 "List of functions applied to a transcoded line-break.
2372 Each filter is called with three arguments: the transcoded data,
2373 as a string, the back-end, as a symbol, and the communication
2377 "List of functions applied to a transcoded link.
2378 Each filter is called with three arguments: the transcoded data,
2379 as a string, the back-end, as a symbol, and the communication
2383 "List of functions applied to a transcoded radio-target.
2384 Each filter is called with three arguments: the transcoded data,
2385 as a string, the back-end, as a symbol, and the communication
2389 "List of functions applied to a transcoded statistics-cookie.
2390 Each filter is called with three arguments: the transcoded data,
2391 as a string, the back-end, as a symbol, and the communication
2395 "List of functions applied to transcoded strike-through text.
2396 Each filter is called with three arguments: the transcoded data,
2397 as a string, the back-end, as a symbol, and the communication
2401 "List of functions applied to a transcoded subscript.
2402 Each filter is called with three arguments: the transcoded data,
2403 as a string, the back-end, as a symbol, and the communication
2407 "List of functions applied to a transcoded superscript.
2408 Each filter is called with three arguments: the transcoded data,
2409 as a string, the back-end, as a symbol, and the communication
2413 "List of functions applied to a transcoded target.
2414 Each filter is called with three arguments: the transcoded data,
2415 as a string, the back-end, as a symbol, and the communication
2419 "List of functions applied to a transcoded timestamp.
2420 Each filter is called with three arguments: the transcoded data,
2421 as a string, the back-end, as a symbol, and the communication
2425 "List of functions applied to transcoded underline text.
2426 Each filter is called with three arguments: the transcoded data,
2427 as a string, the back-end, as a symbol, and the communication
2431 "List of functions applied to transcoded verbatim text.
2432 Each filter is called with three arguments: the transcoded data,
2433 as a string, the back-end, as a symbol, and the communication
2437 ;;;; Filters Tools
2438 ;;
2439 ;; Internal function `org-export-install-filters' installs filters
2440 ;; hard-coded in back-ends (developer filters) and filters from global
2441 ;; variables (user filters) in the communication channel.
2442 ;;
2443 ;; Internal function `org-export-filter-apply-functions' takes care
2444 ;; about applying each filter in order to a given data. It ignores
2445 ;; filters returning a nil value but stops whenever a filter returns
2446 ;; an empty string.
2449 "Call every function in FILTERS.
2451 Functions are called with arguments VALUE, current export
2452 back-end's name and INFO. A function returning a nil value will
2453 be skipped. If it returns the empty string, the process ends and
2454 VALUE is ignored.
2456 Call is done in a LIFO fashion, to be sure that developer
2457 specified filters, if any, are called first."
2468 "Install filters properties in communication channel.
2469 INFO is a plist containing the current communication channel.
2470 Return the updated communication channel."
2472 ;; Install user-defined filters with `org-export-filters-alist'
2473 ;; and filters already in INFO (through ext-plist mechanism).
2480 ;; Filters in INFO will be called
2481 ;; before those user provided.
2484 default-value)))))
2485 org-export-filters-alist)
2486 ;; Prepend back-end specific filters to that list.
2488 ;; Single values get consed, lists are appended.
2493 plist key
2497 ;; Return new communication channel.
2501 \f
2502 ;;; Core functions
2503 ;;
2504 ;; This is the room for the main function, `org-export-as', along with
2505 ;; its derivative, `org-export-string-as'.
2506 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2507 ;; function should be added to kill ring.
2508 ;;
2509 ;; Note that `org-export-as' doesn't really parse the current buffer,
2510 ;; but a copy of it (with the same buffer-local variables and
2511 ;; visibility), where macros and include keywords are expanded and
2512 ;; Babel blocks are executed, if appropriate.
2513 ;; `org-export-with-buffer-copy' macro prepares that copy.
2514 ;;
2515 ;; File inclusion is taken care of by
2516 ;; `org-export-expand-include-keyword' and
2517 ;; `org-export--prepare-file-contents'. Structure wise, including
2518 ;; a whole Org file in a buffer often makes little sense. For
2519 ;; example, if the file contains a headline and the include keyword
2520 ;; was within an item, the item should contain the headline. That's
2521 ;; why file inclusion should be done before any structure can be
2522 ;; associated to the file, that is before parsing.
2523 ;;
2524 ;; `org-export-insert-default-template' is a command to insert
2525 ;; a default template (or a back-end specific template) at point or in
2526 ;; current subtree.
2529 "Return a copy of the current buffer.
2530 The copy preserves Org buffer-local variables, visibility and
2531 narrowing."
2537 new-buf))
2540 "Apply BODY in a copy of the current buffer.
2541 The copy preserves local variables, visibility and contents of
2542 the original buffer. Point is at the beginning of the buffer
2543 when BODY is applied."
2552 ;; Kill copy without confirmation.
2558 "Generate a function duplicating BUFFER.
2560 The copy will preserve local variables, visibility, contents and
2561 narrowing of the original buffer. If a region was active in
2562 BUFFER, contents will be narrowed to that region instead.
2564 The resulting function can be evaluated at a later time, from
2565 another buffer, effectively cloning the original buffer there.
2567 The function assumes BUFFER's major mode is `org-mode'."
2571 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2572 ;; already in BUFFER.
2574 ;; Copy specific buffer local variables and variables set
2575 ;; through BIND keywords.
2577 vars)
2585 buffer-file-name
2586 buffer-file-coding-system))
2590 ;; Skip unreadable values, as they cannot be
2591 ;; sent to external process.
2595 vars))))))
2596 ;; Whole buffer contents.
2601 ;; Narrowing.
2605 ;; Current position of point.
2607 ;; Overlays with invisible property.
2617 ov-set))))
2619 ov-set)))))
2622 "Delete commented areas in the buffer.
2623 Commented areas are comments, comment blocks, commented trees and
2624 inlinetasks. Trailing blank lines after a comment or a comment
2625 block are preserved. Narrowing, if any, is ignored."
2646 "Prune non exportable elements from DATA.
2647 DATA is the parse tree to traverse. INFO is the plist holding
2648 export info. Also set `:ignore-list' in INFO to a list of
2649 objects which should be ignored during export, but not removed
2650 from tree."
2652 ;; First find trees containing a select tag, if any.
2656 ;; Prune non-exportable elements and objects from tree.
2657 ;; As a special case, special rows and cells from tables
2658 ;; are stored in IGNORE, as they still need to be
2659 ;; accessed during export.
2669 ;; If headline is archived but tree below has
2670 ;; to be skipped, remove contents.
2672 ;; Move into recursive objects/elements.
2674 ;; Move into secondary string, if any.
2676 org-element-secondary-value-alist)))
2678 ;; If a select tag is active, also ignore the section before the
2679 ;; first headline, if any.
2684 ;; Prune tree and communication channel.
2688 ;; Priority is given to back-end specific options.
2690 org-export-options-alist))
2693 ;; Eventually set `:ignore-list'.
2697 "Change uninterpreted elements back into Org syntax.
2698 DATA is the parse tree. INFO is a plist containing export
2699 options. Each uninterpreted element or object is changed back
2700 into a string. Contents, if any, are not modified. The parse
2701 tree is modified by side effect."
2707 p
2710 info))))))
2713 "Change uninterpreted elements back into Org syntax.
2714 DATA is a parse tree or a secondary string. INFO is a plist
2715 containing export options. It is modified by side effect and
2716 returned by the function."
2719 subscript superscript underline)
2723 ;; ... entities...
2730 ?\s)))))
2731 ;; ... emphasis...
2743 marker
2747 ?\s)))))))
2748 ;; ... LaTeX environments and fragments...
2752 ;; ... sub/superscripts...
2761 "_"
2770 ?\s)))))))))))
2772 ;; Splice NEW at BLOB location in parse tree.
2775 info nil nil t)
2776 ;; Return modified parse tree.
2777 data)
2780 "Insert footnote definitions outside parsing scope in TREE.
2782 If there is a footnote section in TREE, definitions found are
2783 appended to it. If `org-footnote-section' is non-nil, a new
2784 footnote section containing all definitions is inserted in TREE.
2785 Otherwise, definitions are appended at the end of the section
2786 containing their first reference.
2788 Only definitions actually referred to within TREE, directly or
2789 not, are considered."
2808 definitions))
2816 'footnote-definition
2822 definitions))))))))
2823 ;; Collect all out of scope definitions.
2833 ;; Filter out definitions referenced neither in the original
2834 ;; tree nor in the external definitions.
2839 definitions))
2842 referenced-labels)))
2847 definitions)))
2848 ;; Install definitions in subtree.
2851 ;; If there is a footnote section, insert them here.
2856 nil t)))
2859 ;; If there should be a footnote section, create one containing
2860 ;; all the definitions at the end of the tree.
2863 tree
2869 'section
2870 nil
2872 ;; Otherwise add each definition at the end of the section where
2873 ;; it is first referenced.
2878 ;; Insert definitions in the same section as
2879 ;; their first reference in DATA.
2891 d)
2892 label)
2899 definition)
2901 definition)))))))))))
2904 ;;;###autoload
2907 "Transcode current Org buffer into BACKEND code.
2909 BACKEND is either an export back-end, as returned by, e.g.,
2910 `org-export-create-backend', or a symbol referring to
2911 a registered back-end.
2913 If narrowing is active in the current buffer, only transcode its
2914 narrowed part.
2916 If a region is active, transcode that region.
2918 When optional argument SUBTREEP is non-nil, transcode the
2919 sub-tree at point, extracting information from the headline
2920 properties first.
2922 When optional argument VISIBLE-ONLY is non-nil, don't export
2923 contents of hidden elements.
2925 When optional argument BODY-ONLY is non-nil, only return body
2926 code, without surrounding template.
2928 Optional argument EXT-PLIST, when provided, is a property list
2929 with external parameters overriding Org default settings, but
2930 still inferior to file-local settings.
2932 Return code as a string."
2937 ;; Narrow buffer to an appropriate region or subtree for
2938 ;; parsing. If parsing subtree, be sure to remove main headline
2939 ;; too.
2947 ;; Initialize communication channel with original buffer
2948 ;; attributes, unavailable in its copy.
2961 org-export-options-alist))))
2962 tree)
2963 ;; Update communication channel and get parse tree. Buffer
2964 ;; isn't parsed directly. Instead, all buffer modifications
2965 ;; and consequent parsing are undertaken in a temporary copy.
2967 ;; Run first hook with current back-end's name as argument.
2970 ;; Include files, delete comments and expand macros.
2975 ;; Refresh buffer properties and radio targets after
2976 ;; potentially invasive previous changes. Likewise, do it
2977 ;; again after executing Babel code.
2983 ;; Run last hook with current back-end's name as argument.
2984 ;; Update buffer properties and radio targets one last time
2985 ;; before parsing.
2992 ;; Update communication channel with environment. Also
2993 ;; install user's and developer's filters.
2998 ;; Call options filters and update export options. We do not
2999 ;; use `org-export-filter-apply-functions' here since the
3000 ;; arity of such filters is different.
3005 ;; Expand export-specific set of macros: {{{author}}},
3006 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
3007 ;; be done once regular macros have been expanded, since
3008 ;; parsed keywords may contain one of them.
3021 value)
3022 value)))
3026 'finalize
3027 parsed-keywords)
3028 ;; Parse buffer.
3030 ;; Merge footnote definitions outside scope into parse tree.
3032 ;; Prune tree from non-exported elements and transform
3033 ;; uninterpreted elements or objects in both parse tree and
3034 ;; communication channel.
3037 ;; Call parse tree filters.
3041 ;; Now tree is complete, compute its properties and add them
3042 ;; to communication channel.
3046 ;; Eventually transcode TREE. Wrap the resulting string into
3047 ;; a template.
3056 info))
3059 ;; Remove all text properties since they cannot be
3060 ;; retrieved from an external process. Finally call
3061 ;; final-output filter and return result.
3067 info))))))))
3069 ;;;###autoload
3071 "Transcode STRING into BACKEND code.
3073 BACKEND is either an export back-end, as returned by, e.g.,
3074 `org-export-create-backend', or a symbol referring to
3075 a registered back-end.
3077 When optional argument BODY-ONLY is non-nil, only return body
3078 code, without preamble nor postamble.
3080 Optional argument EXT-PLIST, when provided, is a property list
3081 with external parameters overriding Org default settings, but
3082 still inferior to file-local settings.
3084 Return code as a string."
3090 ;;;###autoload
3092 "Replace the active region by its export to BACKEND.
3093 BACKEND is either an export back-end, as returned by, e.g.,
3094 `org-export-create-backend', or a symbol referring to
3095 a registered back-end."
3101 ;;;###autoload
3103 "Insert all export keywords with default values at beginning of line.
3105 BACKEND is a symbol referring to the name of a registered export
3106 back-end, for which specific export options should be added to
3107 the template, or `default' for default template. When it is nil,
3108 the user will be prompted for a category.
3110 If SUBTREEP is non-nil, export configuration will be set up
3111 locally for the subtree through node properties."
3121 "Options category: "
3125 org-export-registered-backends))
3126 nil t))))
3127 options keywords)
3128 ;; Populate OPTIONS and KEYWORDS.
3145 ;; Move to an appropriate location in order to insert options.
3147 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3165 ;; Then the rest of keywords, in the order specified in either
3166 ;; `org-export-options-alist' or respective export back-ends.
3187 "Expand every include keyword in buffer.
3188 Optional argument INCLUDED is a list of included file names along
3189 with their line restriction, when appropriate. It is used to
3190 avoid infinite recursion. Optional argument DIR is the current
3191 working directory. It is used to properly resolve relative
3192 paths. Optional argument FOOTNOTES is a hash-table used for
3193 storing and resolving footnotes. It is created automatically."
3199 ;; If :minlevel is not set the text-property
3200 ;; `:org-include-induced-level' will be used to determine the
3201 ;; relative level when expanding INCLUDE.
3202 ;; Only affects included Org documents.
3206 :org-include-induced-level
3208 ;; Expand INCLUDE keywords.
3214 ;; Extract arguments from keyword's value.
3217 location
3225 matched)
3231 matched)
3232 dir)))
3236 value)
3242 value)
3249 ;; Minimal level of included file defaults to the child
3250 ;; level of the current headline, if any, or one. It
3251 ;; only applies is the file is meant to be included as
3252 ;; an Org one.
3264 ;; Remove keyword.
3270 ;; Check if files has already been parsed. Look after
3271 ;; inclusion lines too, as different parts of the same file
3272 ;; can be included too.
3287 ind-str block arg-str contents ind-str block))))
3294 ind-str block contents ind-str block))))
3302 file location only-contents lines)
3303 lines)))
3307 file lines ind minlevel
3310 footnotes)))
3314 footnotes)
3316 ;; Expand footnotes after all files have been included.
3317 ;; Footnotes are stored at end of buffer.
3322 footnotes)))))))))))
3325 "Resolve absolute lines for an included file with file-link.
3327 FILE is string file-name of the file to include. LOCATION is a
3328 string name within FILE to be included (located via
3329 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3330 contents of the named element will be included, as determined
3331 Org-Element. If LINES is non-nil only those lines are included.
3333 Return a string of lines to be included in the format expected by
3334 `org-export--prepare-file-contents'."
3340 ;; Enforce consistent search.
3353 ;; Skip planning line and property-drawer.
3379 start-line
3381 (+ start-line
3384 counter))))))))
3388 "Prepare contents of FILE for inclusion and return it as a string.
3390 When optional argument LINES is a string specifying a range of
3391 lines, include only those lines.
3393 Optional argument IND, when non-nil, is an integer specifying the
3394 global indentation of returned contents. Since its purpose is to
3395 allow an included file to stay in the same environment it was
3396 created (e.g., a list item), it doesn't apply past the first
3397 headline encountered.
3399 Optional argument MINLEVEL, when non-nil, is an integer
3400 specifying the level that any top-level headline in the included
3401 file should have.
3403 Optional argument ID is an integer that will be inserted before
3404 each footnote definition and reference if FILE is an Org file.
3405 This is useful to avoid conflicts when more than one Org file
3406 with footnotes is included in a document.
3408 Optional argument FOOTNOTES is a hash-table to store footnotes in
3409 the included document."
3425 ;; Remove blank lines at beginning and end of contents. The logic
3426 ;; behind that removal is that blank lines around include keyword
3427 ;; override blank lines in included file.
3436 ;; If IND is set, preserve indentation of include keyword until
3437 ;; the first headline encountered.
3444 ;; Do not move footnote definitions out of column 0.
3450 ;; When MINLEVEL is specified, compute minimal level for headlines
3451 ;; in the file (CUR-MIN), and remove stars to each headline so
3452 ;; that headlines with minimal level have a level of MINLEVEL.
3463 ;; Only change stars, don't bother moving whole
3464 ;; sections.
3469 ;; Append ID to all footnote references and definitions, so they
3470 ;; become file specific and cannot collide with footnotes in other
3471 ;; included files. Further, collect relevant footnote definitions
3472 ;; outside of LINES, in order to reintroduce them later.
3478 ;; Generate new label from LABEL. If LABEL is akin to
3479 ;; [1] convert it to [fn:--ID-1]. Otherwise add "-ID-"
3480 ;; after "fn:".
3486 ;; Replace OLD label with NEW in footnote F.
3500 ;; Update the footnote-reference at point and collect
3501 ;; the new label, which is only used for footnotes
3502 ;; outsides LINES.
3514 ;; Store since footnote-definition is
3515 ;; outside of LINES.
3518 footnotes))))
3525 "Execute every Babel code in the visible part of current buffer."
3526 ;; Get a pristine copy of current buffer so Babel references can be
3527 ;; properly resolved.
3533 "Return a non-nil value when output should be added to the kill ring.
3534 See also `org-export-copy-to-kill-ring'."
3540 \f
3541 ;;; Tools For Back-Ends
3542 ;;
3543 ;; A whole set of tools is available to help build new exporters. Any
3544 ;; function general enough to have its use across many back-ends
3545 ;; should be added here.
3547 ;;;; For Affiliated Keywords
3548 ;;
3549 ;; `org-export-read-attribute' reads a property from a given element
3550 ;; as a plist. It can be used to normalize affiliated keywords'
3551 ;; syntax.
3552 ;;
3553 ;; Since captions can span over multiple lines and accept dual values,
3554 ;; their internal representation is a bit tricky. Therefore,
3555 ;; `org-export-get-caption' transparently returns a given element's
3556 ;; caption as a secondary string.
3559 "Turn ATTRIBUTE property from ELEMENT into a plist.
3561 When optional argument PROPERTY is non-nil, return the value of
3562 that property within attributes.
3566 properties.
3568 All values will become strings except the empty string and
3571 will become the empty string."
3585 s)
3590 ;; Ignore any string before first property with `cdr'.
3595 "Return caption from ELEMENT as a secondary string.
3597 When optional argument SHORTP is non-nil, return short caption,
3598 as a secondary string, instead.
3600 Caption lines are separated by a white space."
3608 ;;;; For Derived Back-ends
3609 ;;
3610 ;; `org-export-with-backend' is a function allowing to locally use
3611 ;; another back-end to transcode some object or element. In a derived
3612 ;; back-end, it may be used as a fall-back function once all specific
3613 ;; cases have been treated.
3616 "Call a transcoder from BACKEND on DATA.
3617 BACKEND is an export back-end, as returned by, e.g.,
3618 `org-export-create-backend', or a symbol referring to
3619 a registered back-end. DATA is an Org element, object, secondary
3620 string or string. CONTENTS, when non-nil, is the transcoded
3621 contents of DATA element, as a string. INFO, when non-nil, is
3622 the communication channel used for export, as a plist."
3632 transcoder data contents
3635 :back-end backend
3636 :translate-alist all-transcoders
3640 ;;;; For Export Snippets
3641 ;;
3642 ;; Every export snippet is transmitted to the back-end. Though, the
3643 ;; latter will only retain one type of export-snippet, ignoring
3644 ;; others, based on the former's target back-end. The function
3645 ;; `org-export-snippet-backend' returns that back-end for a given
3646 ;; export-snippet.
3649 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3650 Translation, with `org-export-snippet-translation-alist', is
3651 applied."
3655 back-end))))
3658 ;;;; For Footnotes
3659 ;;
3660 ;; `org-export-collect-footnote-definitions' is a tool to list
3661 ;; actually used footnotes definitions in the whole parse tree, or in
3662 ;; a headline, in order to add footnote listings throughout the
3663 ;; transcoded data.
3664 ;;
3665 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3666 ;; back-ends, when they need to attach the footnote definition only to
3667 ;; the first occurrence of the corresponding label.
3668 ;;
3669 ;; `org-export-get-footnote-definition' and
3670 ;; `org-export-get-footnote-number' provide easier access to
3671 ;; additional information relative to a footnote reference.
3674 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3675 INFO is the plist used as a communication channel. If no such
3676 definition can be found, raise an error."
3682 hash))))
3690 info t)
3691 cache)
3696 "Apply FUNCTION on every footnote reference in DATA.
3697 INFO is a plist containing export state. By default, as soon as
3698 a new footnote reference is encountered, FUNCTION is called onto
3699 its definition. However, if BODY-FIRST is non-nil, this step is
3700 delayed until the end of the process."
3705 ;; Search footnote references through DATA, filling
3706 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3707 ;; store footnote definitions so they can be entered
3708 ;; later.
3715 ;; Search for subsequent references in footnote
3716 ;; definition so numbering follows reading
3717 ;; logic, unless DELAYP in non-nil.
3721 definitions))
3722 ;; Do not force entering inline definitions,
3723 ;; since `org-element-map' already traverses
3724 ;; them at the right time.
3728 nil))))))
3729 info nil
3730 ;; Don't enter footnote definitions since it will
3731 ;; happen when their first reference is found.
3732 ;; Moreover, if DELAYP is non-nil, make sure we
3733 ;; postpone entering definitions of inline references.
3740 "Return an alist between footnote numbers, labels and definitions.
3742 INFO is the current export state, as a plist.
3744 Definitions are collected throughout the whole parse tree, or
3745 DATA when non-nil.
3747 Sorting is done by order of references. As soon as a new
3748 reference is encountered, other references are searched within
3749 its definition. However, if BODY-FIRST is non-nil, this step is
3750 delayed after the whole tree is checked. This alters results
3751 when references are found in footnote definitions.
3753 Definitions either appear as Org data or as a secondary string
3754 for inlined footnotes. Unreferenced definitions are ignored."
3758 ;; Collect footnote number, label and definition.
3769 "Non-nil when a footnote reference is the first one for its label.
3771 FOOTNOTE-REFERENCE is the footnote reference being considered.
3772 INFO is a plist containing current export state.
3774 Search is done throughout the whole parse tree, or DATA when
3775 non-nil.
3777 By default, as soon as a new footnote reference is encountered,
3778 other references are searched within its definition. However, if
3779 BODY-FIRST is non-nil, this step is delayed after the whole tree
3780 is checked. This alters results when references are found in
3781 footnote definitions."
3783 ;; Anonymous footnotes are always a first reference.
3794 "Return number associated to a footnote.
3796 FOOTNOTE is either a footnote reference or a footnote definition.
3797 INFO is the plist containing export state.
3799 Number is unique throughout the whole parse tree, or DATA, when
3800 non-nil.
3802 By default, as soon as a new footnote reference is encountered,
3803 counting process moves into its definition. However, if
3804 BODY-FIRST is non-nil, this step is delayed until the end of the
3805 process, leading to a different order when footnotes are nested."
3814 ;; Anonymous footnote match: return number.
3816 ;; Labels match: return number.
3818 ;; Otherwise store label and increase counter if label
3819 ;; wasn't encountered yet.
3825 ;;;; For Headlines
3826 ;;
3827 ;; `org-export-get-relative-level' is a shortcut to get headline
3828 ;; level, relatively to the lower headline level in the parsed tree.
3829 ;;
3830 ;; `org-export-get-headline-number' returns the section number of an
3831 ;; headline, while `org-export-number-to-roman' allows to convert it
3832 ;; to roman numbers. With an optional argument,
3833 ;; `org-export-get-headline-number' returns a number to unnumbered
3834 ;; headlines (used for internal id).
3835 ;;
3836 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3837 ;; `org-export-last-sibling-p' are three useful predicates when it
3838 ;; comes to fulfill the `:headline-levels' property.
3839 ;;
3840 ;; `org-export-get-tags', `org-export-get-category' and
3841 ;; `org-export-get-node-property' extract useful information from an
3842 ;; headline or a parent headline. They all handle inheritance.
3843 ;;
3844 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3845 ;; as a secondary string, suitable for table of contents. It falls
3846 ;; back onto default title.
3849 "Return HEADLINE relative level within current parsed tree.
3850 INFO is a plist holding contextual information."
3855 "Non-nil when HEADLINE is considered as low level.
3857 INFO is a plist used as a communication channel.
3859 A low level headlines has a relative level greater than
3860 `:headline-levels' property value.
3862 Return value is the difference between HEADLINE relative level
3863 and the last level being considered as high enough, or nil."
3870 "Return numbered HEADLINE numbering as a list of numbers.
3871 INFO is a plist holding contextual information."
3876 "Return a non-nil value if HEADLINE element should be numbered.
3877 INFO is a plist used as a communication channel."
3886 "Convert integer N into a roman numeral."
3899 res)))
3902 "Return list of tags associated to ELEMENT.
3904 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3905 is a plist used as a communication channel.
3907 Select tags (see `org-export-select-tags') and exclude tags (see
3908 `org-export-exclude-tags') are removed from the list.
3910 When non-nil, optional argument TAGS should be a list of strings.
3911 Any tag belonging to this list will also be removed.
3913 When optional argument INHERITED is non-nil, tags can also be
3914 inherited from parent headlines and FILETAGS keywords."
3920 ;; Build complete list of inherited tags.
3927 ;; Add FILETAGS keywords and return results.
3931 "Return node PROPERTY value for BLOB.
3933 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3934 element or object.
3936 If optional argument INHERITED is non-nil, the value can be
3937 inherited from a parent headline.
3939 Return value is a string or nil."
3951 "Return category for element or object BLOB.
3953 INFO is a plist used as a communication channel.
3955 CATEGORY is automatically inherited from a parent headline, from
3956 #+CATEGORY: keyword or created out of original file name. If all
3969 "Return alternative title for HEADLINE, as a secondary string.
3970 If no optional title is defined, fall-back to the regular title."
3977 "Non-nil when BLOB is the first sibling in its parent.
3978 BLOB is an element or an object. If BLOB is a headline, non-nil
3979 means it is the first sibling in the sub-tree. INFO is a plist
3980 used as a communication channel."
3985 "Non-nil when BLOB is the last sibling in its parent.
3986 BLOB is an element or an object. INFO is a plist used as
3987 a communication channel."
3991 ;;;; For Keywords
3992 ;;
3993 ;; `org-export-get-date' returns a date appropriate for the document
3994 ;; to about to be exported. In particular, it takes care of
3995 ;; `org-export-date-timestamp-format'.
3998 "Return date value for the current document.
4000 INFO is a plist used as a communication channel. FMT, when
4001 non-nil, is a time format string that will be applied on the date
4002 if it consists in a single timestamp object. It defaults to
4003 `org-export-date-timestamp-format' when nil.
4005 A proper date can be a secondary string, a string or nil. It is
4006 meant to be translated with `org-export-data' or alike."
4017 ;;;; For Links
4018 ;;
4019 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4020 ;; with `org-add-link-type', which see.
4021 ;;
4022 ;; `org-export-get-coderef-format' returns an appropriate format
4023 ;; string for coderefs.
4024 ;;
4025 ;; `org-export-inline-image-p' returns a non-nil value when the link
4026 ;; provided should be considered as an inline image.
4027 ;;
4028 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4029 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4030 ;; returns an appropriate unique identifier.
4031 ;;
4032 ;; `org-export-resolve-id-link' returns the first headline with
4033 ;; specified id or custom-id in parse tree, the path to the external
4034 ;; file with the id.
4035 ;;
4036 ;; `org-export-resolve-coderef' associates a reference to a line
4037 ;; number in the element it belongs, or returns the reference itself
4038 ;; when the element isn't numbered.
4039 ;;
4040 ;; `org-export-file-uri' expands a filename as stored in :path value
4041 ;; of a "file" link into a file URI.
4042 ;;
4043 ;; Broken links raise a `org-link-broken' error, which is caught by
4044 ;; `org-export-data' for further processing, depending on
4045 ;; `org-export-with-broken-links' value.
4047 ;; FIXME: Remove this when support for Emacsen < 24.4 is dropped.
4054 "Try exporting LINK with a dedicated function.
4056 DESC is its description, as a string, or nil. BACKEND is the
4057 back-end used for export, as a symbol.
4059 Return output as a string, or nil if no protocol handles LINK.
4061 A custom protocol has precedence over regular back-end export.
4062 The function ignores links with an implicit type (e.g.,
4071 desc
4072 backend))))))
4075 "Return format string for code reference link.
4076 PATH is the link path. DESC is its description."
4084 "Non-nil if LINK object points to an inline image.
4086 Optional argument is a set of RULES defining inline images. It
4087 is an alist where associations have the following shape:
4089 (TYPE . REGEXP)
4091 Applying a rule means apply REGEXP against LINK's path when its
4092 type is TYPE. The function will return a non-nil value if any of
4093 the provided rules is non-nil. The default rule is
4094 `org-export-default-inline-image-rule'.
4096 This only applies to links without a description."
4107 "Resolve a code reference REF.
4109 INFO is a plist used as a communication channel.
4111 Return associated line number in source code, or REF itself,
4112 depending on src-block or example element's switches. Throw an
4113 error if no block contains REF."
4120 org-coderef-label-format)))
4124 ;; Element containing REF is found. Resolve it to
4125 ;; either a label or a line number, as needed.
4136 "Return LINK destination.
4138 INFO is a plist holding contextual information.
4140 Return value can be an object or an element:
4142 - If LINK path matches a target object (i.e. <<path>>) return it.
4144 - If LINK path exactly matches the name affiliated keyword
4145 (i.e. #+NAME: path) of an element, return that element.
4147 - If LINK path exactly matches any headline name, return that
4148 element.
4150 - Otherwise, throw an error.
4153 significant."
4156 ;; Split PATH at white spaces so matches are space
4157 ;; insensitive.
4163 :resolve-fuzzy-link-cache
4170 path
4172 ;; First try to find a matching "<<path>>" unless user
4173 ;; specified he was looking for a headline (path starts with
4174 ;; a "*" character).
4180 path)
4181 datum))
4183 ;; Then try to find an element with a matching "#+NAME: path"
4184 ;; affiliated keyword.
4191 ;; Try to find a matching headline.
4198 path)
4199 h))
4202 link-cache)))))
4205 "Return headline referenced as LINK destination.
4207 INFO is a plist used as a communication channel.
4209 Return value can be the headline element matched in current parse
4213 ;; First check if id is within the current parse tree.
4218 headline))
4220 ;; Otherwise, look for external files.
4225 "Return radio-target object referenced as LINK destination.
4227 INFO is a plist used as a communication channel.
4229 Return value can be a radio-target object or nil. Assume LINK
4238 nil nil path nil nil t)
4239 t)
4240 radio))
4244 "Return file URI associated to FILENAME."
4251 ;;;; For References
4252 ;;
4253 ;; `org-export-get-reference' associate a unique reference for any
4254 ;; object or element.
4255 ;;
4256 ;; `org-export-get-ordinal' associates a sequence number to any object
4257 ;; or element.
4260 "Return a unique reference for DATUM, as a string.
4261 DATUM is either an element or an object. INFO is the current
4262 export state, as a plist. Returned reference consists of
4263 alphanumeric characters only."
4268 h))))
4276 cache))))
4279 "Return ordinal number of an element or object.
4281 ELEMENT is the element or object considered. INFO is the plist
4282 used as a communication channel.
4284 Optional argument TYPES, when non-nil, is a list of element or
4285 object types, as symbols, that should also be counted in.
4286 Otherwise, only provided element's type is considered.
4288 Optional argument PREDICATE is a function returning a non-nil
4289 value if the current element or object should be counted in. It
4290 accepts two arguments: the element or object being considered and
4291 the plist used as a communication channel. This allows to count
4292 only a certain type of objects (i.e. inline images).
4294 Return value is a list of numbers if ELEMENT is a headline or an
4295 item. It is nil for keywords. It represents the footnote number
4296 for footnote definitions and footnote references. If ELEMENT is
4297 a target, return the same value as if ELEMENT was the closest
4298 table, item or headline containing the target. In any other
4299 case, return the sequence number of ELEMENT among elements or
4300 objects of the same type."
4301 ;; Ordinal of a target object refer to the ordinal of the closest
4302 ;; table, item, or headline containing the object.
4306 element
4309 ;; Special case 1: A headline returns its number as a list.
4311 ;; Special case 2: An item returns its number as a list.
4315 struct
4322 ;; Increment counter until ELEMENT is found again.
4333 ;;;; For Src-Blocks
4334 ;;
4335 ;; `org-export-get-loc' counts number of code lines accumulated in
4336 ;; src-block or example-block elements with a "+n" switch until
4337 ;; a given element, excluded. Note: "-n" switches reset that count.
4338 ;;
4339 ;; `org-export-unravel-code' extracts source code (along with a code
4340 ;; references alist) from an `element-block' or `src-block' type
4341 ;; element.
4342 ;;
4343 ;; `org-export-format-code' applies a formatting function to each line
4344 ;; of code, providing relative line number and code reference when
4345 ;; appropriate. Since it doesn't access the original element from
4346 ;; which the source code is coming, it expects from the code calling
4347 ;; it to know if lines should be numbered and if code references
4348 ;; should appear.
4349 ;;
4350 ;; Eventually, `org-export-format-code-default' is a higher-level
4351 ;; function (it makes use of the two previous functions) which handles
4352 ;; line numbering and code references inclusion, and returns source
4353 ;; code in a format suitable for plain text or verbatim output.
4356 "Return accumulated lines of code up to ELEMENT.
4358 INFO is the plist used as a communication channel.
4360 ELEMENT is excluded from count."
4366 ;; ELEMENT is reached: Quit the loop.
4368 ;; Only count lines from src-block and example-block elements
4369 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4373 ;; Accumulate locs or reset them.
4377 ;; Return nil to stay in the loop.
4378 nil)))
4380 ;; Return value.
4381 loc))
4384 "Clean source code and extract references out of it.
4386 ELEMENT has either a `src-block' an `example-block' type.
4388 Return a cons cell whose CAR is the source code, cleaned from any
4389 reference, protective commas and spurious indentation, and CDR is
4390 an alist between relative line number (integer) and name of code
4391 reference on that line (string)."
4394 ;; Get code and clean it. Remove blank lines at its
4395 ;; beginning and end.
4402 value
4404 ;; Get format used for references.
4407 org-coderef-label-format)))
4408 ;; Build a regexp matching a loc with a reference.
4413 ;; Return value.
4415 ;; Code with references removed.
4421 ;; Ref line: remove ref, and signal its position in REFS.
4425 ;; Reference alist.
4426 refs)))
4429 "Format CODE by applying FUN line-wise and return it.
4431 CODE is a string representing the code to format. FUN is
4432 a function. It must accept three arguments: a line of
4433 code (string), the current line number (integer) or nil and the
4434 reference associated to the current line (string) or nil.
4436 Optional argument NUM-LINES can be an integer representing the
4437 number of code lines accumulated until the current code. Line
4438 numbers passed to FUN will take it into account. If it is nil,
4439 FUN's second argument will always be nil. This number can be
4440 obtained with `org-export-get-loc' function.
4442 Optional argument REF-ALIST can be an alist between relative line
4443 number (i.e. ignoring NUM-LINES) and the name of the code
4444 reference on it. If it is nil, FUN's third argument will always
4445 be nil. It can be obtained through the use of
4446 `org-export-unravel-code' function."
4458 "Return source code from ELEMENT, formatted in a standard way.
4460 ELEMENT is either a `src-block' or `example-block' element. INFO
4461 is a plist used as a communication channel.
4463 This function takes care of line numbering and code references
4464 inclusion. Line numbers, when applicable, appear at the
4465 beginning of the line, separated from the code by two white
4466 spaces. Code references, on the other hand, appear flushed to
4467 the right, separated by six white spaces from the widest line of
4468 code."
4469 ;; Extract code and references.
4476 ;; Handle line numbering.
4485 ;; Prepare references display, if required. Any reference
4486 ;; should start six columns after the widest line of code,
4487 ;; wrapped with parenthesis.
4492 code
4496 number-str
4497 loc
4503 num-start refs)))))
4506 ;;;; For Tables
4507 ;;
4508 ;; `org-export-table-has-special-column-p' and and
4509 ;; `org-export-table-row-is-special-p' are predicates used to look for
4510 ;; meta-information about the table structure.
4511 ;;
4512 ;; `org-table-has-header-p' tells when the rows before the first rule
4513 ;; should be considered as table's header.
4514 ;;
4515 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4516 ;; and `org-export-table-cell-borders' extract information from
4517 ;; a table-cell element.
4518 ;;
4519 ;; `org-export-table-dimensions' gives the number on rows and columns
4520 ;; in the table, ignoring horizontal rules and special columns.
4521 ;; `org-export-table-cell-address', given a table-cell object, returns
4522 ;; the absolute address of a cell. On the other hand,
4523 ;; `org-export-get-table-cell-at' does the contrary.
4524 ;;
4525 ;; `org-export-table-cell-starts-colgroup-p',
4526 ;; `org-export-table-cell-ends-colgroup-p',
4527 ;; `org-export-table-row-starts-rowgroup-p',
4528 ;; `org-export-table-row-ends-rowgroup-p',
4529 ;; `org-export-table-row-starts-header-p',
4530 ;; `org-export-table-row-ends-header-p' and
4531 ;; `org-export-table-row-in-header-p' indicate position of current row
4532 ;; or cell within the table.
4535 "Non-nil when TABLE has a special column.
4536 All special columns will be ignored during export."
4537 ;; The table has a special column when every first cell of every row
4538 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4539 ;; "*" "_" and "^". Though, do not consider a first row containing
4540 ;; only empty cells as special.
4556 "Non-nil when TABLE has a header.
4558 INFO is a plist used as a communication channel.
4560 A table has a header when it contains at least two row groups."
4569 table
4580 cache)))))
4583 "Non-nil if TABLE-ROW is considered special.
4584 All special rows will be ignored during export."
4588 ;; A row is special either when...
4590 ;; ... it starts with a field only containing "/",
4592 ;; ... the table contains a special column and the row start
4593 ;; with a marking character among, "^", "_", "$" or "!",
4597 ;; ... it contains only alignment cookies and empty cells.
4603 ;; Since VALUE is a secondary string, the following
4604 ;; checks avoid expanding it with `org-export-data'.
4616 "Return TABLE-ROW's group number, as an integer.
4618 INFO is a plist used as the communication channel.
4620 Return value is the group number, as an integer, or nil for
4621 special rows and rows separators. First group is also table's
4622 header."
4640 "Return TABLE-CELL contents width.
4642 INFO is a plist used as the communication channel.
4644 Return value is the width given by the last width cookie in the
4645 same column as TABLE-CELL, or nil."
4664 ;; In a special row, try to find a width cookie at COLUMN.
4668 ;; The following checks avoid expanding unnecessarily
4669 ;; the cell with `org-export-data'.
4679 "Return TABLE-CELL contents alignment.
4681 INFO is a plist used as the communication channel.
4683 Return alignment as specified by the last alignment cookie in the
4684 same column as TABLE-CELL. If no such cookie is found, a default
4685 alignment value will be deduced from fraction of numbers in the
4686 column (see `org-table-number-fraction' for more information).
4687 Possible values are `left', `right' and `center'."
4688 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4705 cookie-align
4706 previous-cell-number-p)
4709 ;; In a special row, try to find an alignment cookie at
4710 ;; COLUMN.
4714 ;; Since VALUE is a secondary string, the following
4715 ;; checks avoid useless expansion through
4716 ;; `org-export-data'.
4724 ;; Ignore table rules.
4726 ;; In a standard row, check if cell's contents are
4727 ;; expressing some kind of number. Increase NUMBER-CELLS
4728 ;; accordingly. Though, don't bother if an alignment
4729 ;; cookie has already defined cell's alignment.
4734 info)))
4736 ;; Treat an empty cell as a number if it follows
4737 ;; a number.
4743 ;; Return value. Alignment specified by cookies has
4744 ;; precedence over alignment deduced from cell's contents.
4746 column
4751 org-table-number-fraction)
4756 "Return TABLE-CELL borders.
4758 INFO is a plist used as a communication channel.
4760 Return value is a list of symbols, or nil. Possible values are:
4761 `top', `bottom', `above', `below', `left' and `right'. Note:
4762 `top' (resp. `bottom') only happen for a cell in the first
4763 row (resp. last row) of the table, ignoring table rules, if any.
4765 Returned borders ignore special rows."
4768 borders)
4769 ;; Top/above border? TABLE-CELL has a border above when a rule
4770 ;; used to demarcate row groups can be found above. Hence,
4771 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4772 ;; another regular row has to be found above that rule.
4781 ;; Look at every row before the current one.
4783 ;; No rule above, or rule found starts the table (ignoring any
4784 ;; special row): TABLE-CELL is at the top of the table.
4787 ;; Bottom/below border? TABLE-CELL has a border below when next
4788 ;; non-regular row below is a rule.
4797 ;; Look at every row after the current one.
4799 ;; No rule below, or rule found ends the table (modulo some
4800 ;; special row): TABLE-CELL is at the bottom of the table.
4803 ;; Right/left borders? They can only be specified by column
4804 ;; groups. Column groups are defined in a row starting with "/".
4805 ;; Also a column groups row only contains "<", "<>", ">" or blank
4806 ;; cells.
4823 ;; There's a left border when previous cell, if
4824 ;; any, ends a group, or current one starts one.
4830 ;; There's a right border when next cell, if any,
4831 ;; starts a group, or current one ends one.
4838 ;; Table rows are read in reverse order so last column groups
4839 ;; row has precedence over any previous one.
4841 ;; Return value.
4842 borders))
4845 "Non-nil when TABLE-CELL is at the beginning of a column group.
4846 INFO is a plist used as a communication channel."
4847 ;; A cell starts a column group either when it is at the beginning
4848 ;; of a row (or after the special column, if any) or when it has
4849 ;; a left border.
4852 table-cell)
4856 "Non-nil when TABLE-CELL is at the end of a column group.
4857 INFO is a plist used as a communication channel."
4858 ;; A cell ends a column group either when it is at the end of a row
4859 ;; or when it has a right border.
4862 table-cell)
4866 "Non-nil when TABLE-ROW is at the beginning of a row group.
4867 INFO is a plist used as a communication channel."
4875 "Non-nil when TABLE-ROW is at the end of a row group.
4876 INFO is a plist used as a communication channel."
4884 "Non-nil when TABLE-ROW is located within table's header.
4885 INFO is a plist used as a communication channel. Always return
4886 nil for special rows and rows separators."
4892 "Non-nil when TABLE-ROW is the first table header's row.
4893 INFO is a plist used as a communication channel."
4898 "Non-nil when TABLE-ROW is the last table header's row.
4899 INFO is a plist used as a communication channel."
4904 "Return TABLE-ROW number.
4905 INFO is a plist used as a communication channel. Return value is
4906 zero-based and ignores separators. The function returns nil for
4907 special columns and separators."
4919 "Return TABLE dimensions.
4921 INFO is a plist used as a communication channel.
4923 Return value is a CONS like (ROWS . COLUMNS) where
4924 ROWS (resp. COLUMNS) is the number of exportable
4925 rows (resp. columns)."
4927 ;; Set number of rows, and extract first one.
4933 ;; Set number of columns.
4935 ;; Return value.
4939 "Return address of a regular TABLE-CELL object.
4941 TABLE-CELL is the cell considered. INFO is a plist used as
4942 a communication channel.
4944 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4945 zero-based index. Only exportable cells are considered. The
4946 function returns nil for other cells."
4958 "Return regular table-cell object at ADDRESS in TABLE.
4960 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4961 zero-based index. TABLE is a table type element. INFO is
4962 a plist used as a communication channel.
4964 If no table-cell, among exportable cells, is found at ADDRESS,
4965 return nil."
4968 ;; Row at (car address) or nil.
4976 'table-cell
4983 ;;;; For Tables Of Contents
4984 ;;
4985 ;; `org-export-collect-headlines' builds a list of all exportable
4986 ;; headline elements, maybe limited to a certain depth. One can then
4987 ;; easily parse it and transcode it.
4988 ;;
4989 ;; Building lists of tables, figures or listings is quite similar.
4990 ;; Once the generic function `org-export-collect-elements' is defined,
4991 ;; `org-export-collect-tables', `org-export-collect-figures' and
4992 ;; `org-export-collect-listings' can be derived from it.
4995 "Collect headlines in order to build a table of contents.
4997 INFO is a plist used as a communication channel.
4999 When optional argument N is an integer, it specifies the depth of
5000 the table of contents. Otherwise, it is set to the value of the
5001 last headline level. See `org-export-headline-levels' for more
5002 information.
5004 Optional argument SCOPE, when non-nil, is an element. If it is
5005 a headline, only children of SCOPE are collected. Otherwise,
5006 collect children of the headline containing provided element. If
5007 there is no such headline, collect all headlines. In any case,
5008 argument N becomes relative to the level of that headline.
5010 Return a list of all exportable headlines as parsed elements.
5011 Footnote sections are ignored."
5020 limit))))
5026 info)))
5029 "Collect referenceable elements of a determined type.
5031 TYPE can be a symbol or a list of symbols specifying element
5032 types to search. Only elements with a caption are collected.
5034 INFO is a plist used as a communication channel.
5036 When non-nil, optional argument PREDICATE is a function accepting
5037 one argument, an element of type TYPE. It returns a non-nil
5038 value when that element should be collected.
5040 Return a list of all elements found, in order of appearance."
5045 element))
5046 info))
5049 "Build a list of tables.
5050 INFO is a plist used as a communication channel.
5052 Return a list of table elements with a caption."
5056 "Build a list of figures.
5058 INFO is a plist used as a communication channel. PREDICATE is
5059 a function which accepts one argument: a paragraph element and
5060 whose return value is non-nil when that element should be
5061 collected.
5063 A figure is a paragraph type element, with a caption, verifying
5065 a vague concept that may depend on back-end.
5067 Return a list of elements recognized as figures."
5071 "Build a list of src blocks.
5073 INFO is a plist used as a communication channel.
5075 Return a list of src-block elements with a caption."
5079 ;;;; Smart Quotes
5080 ;;
5081 ;; The main function for the smart quotes sub-system is
5082 ;; `org-export-activate-smart-quotes', which replaces every quote in
5083 ;; a given string from the parse tree with its "smart" counterpart.
5084 ;;
5085 ;; Dictionary for smart quotes is stored in
5086 ;; `org-export-smart-quotes-alist'.
5090 ;; one may use: »...«, "...", ›...‹, or '...'.
5091 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5092 ;; LaTeX quotes require Babel!
5142 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5153 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5164 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5175 ;; 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
5176 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5187 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5193 "Smart quotes translations.
5195 Alist whose CAR is a language string and CDR is an alist with
5196 quote type as key and a plist associating various encodings to
5197 their translation as value.
5199 A quote type can be any symbol among `primary-opening',
5200 `primary-closing', `secondary-opening', `secondary-closing' and
5201 `apostrophe'.
5203 Valid encodings include `:utf-8', `:html', `:latex' and
5204 `:texinfo'.
5209 "Return smart quote status at the beginning of string S.
5210 INFO is the current export state, as a plist."
5215 table)))
5228 ;; Not already in a level 1 quote: this is an
5229 ;; apostrophe.
5231 ;; Extract previous char and next char. As
5232 ;; a special case, they can also be set to `blank',
5233 ;; `no-blank' or nil. Then determine if current
5234 ;; match is allowed as an opening quote or a closing
5235 ;; quote.
5240 text info)))
5257 previous)
5268 next)
5275 current-status)
5279 info nil org-element-recursive-objects)
5286 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5287 `:utf-8'. INFO is a plist used as a communication channel.
5289 The function has to retrieve information about string
5290 surroundings in parse tree. It can only happen with an
5291 unmodified string. Thus, if S has already been through another
5292 process, a non-nil ORIGINAL optional argument will provide that
5293 original string.
5295 Return the new string."
5304 org-export-smart-quotes-alist))))
5305 encoding)
5306 match))
5307 s nil t)))
5309 ;;;; Topology
5310 ;;
5311 ;; Here are various functions to retrieve information about the
5312 ;; neighborhood of a given element or object. Neighbors of interest
5313 ;; are direct parent (`org-export-get-parent'), parent headline
5314 ;; (`org-export-get-parent-headline'), first element containing an
5315 ;; object, (`org-export-get-parent-element'), parent table
5316 ;; (`org-export-get-parent-table'), previous element or object
5317 ;; (`org-export-get-previous-element') and next element or object
5318 ;; (`org-export-get-next-element').
5320 ;; defsubst org-export-get-parent must be defined before first use
5326 "Return BLOB parent headline or nil.
5327 BLOB is the element or object being considered."
5331 "Return first element containing OBJECT or nil.
5332 OBJECT is the object to consider."
5336 "Return OBJECT parent table or nil.
5337 OBJECT is either a `table-cell' or `table-element' type object."
5341 "Return previous element or object.
5343 BLOB is an element or object. INFO is a plist used as
5344 a communication channel. Return previous exportable element or
5345 object, a string, or nil.
5347 When optional argument N is a positive integer, return a list
5348 containing up to N siblings before BLOB, from farthest to
5349 closest. With any other non-nil value, return a list containing
5350 all of them."
5356 prev)
5366 "Return next element or object.
5368 BLOB is an element or object. INFO is a plist used as
5369 a communication channel. Return next exportable element or
5370 object, a string, or nil.
5372 When optional argument N is a positive integer, return a list
5373 containing up to N siblings after BLOB, from closest to farthest.
5374 With any other non-nil value, return a list containing all of
5375 them."
5382 next)
5392 ;;;; Translation
5393 ;;
5394 ;; `org-export-translate' translates a string according to the language
5395 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5396 ;; the dictionary used for the translation.
5428 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5438 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5444 ("ru" :html "(Продолжение следует)"
5518 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5541 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5547 ("ru" :html "Список распечаток"
5561 ("ru" :html "Список таблиц"
5667 ("ru" :html "Неизвестная ссылка"
5670 "Dictionary for export engine.
5672 Alist whose car is the string to translate and cdr is an alist
5673 whose car is the language string and cdr is a plist whose
5674 properties are possible charsets and values translated terms.
5676 It is used as a database for `org-export-translate'. Since this
5677 function returns the string as-is if no translation was found,
5678 the variable only needs to record values different from the
5682 "Translate string S according to language specification.
5684 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5685 and `:utf-8'. INFO is a plist used as a communication channel.
5687 Translation depends on `:language' property. Return the
5688 translated string. If no translation is found, try to fall back
5689 to `:default' encoding. If it fails, return S."
5695 s)))
5698 \f
5699 ;;; Asynchronous Export
5700 ;;
5701 ;; `org-export-async-start' is the entry point for asynchronous
5702 ;; export. It recreates current buffer (including visibility,
5703 ;; narrowing and visited file) in an external Emacs process, and
5704 ;; evaluates a command there. It then applies a function on the
5705 ;; returned results in the current process.
5706 ;;
5707 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5708 ;; allow to export to a buffer or a file, asynchronously or not.
5709 ;;
5710 ;; `org-export-output-file-name' is an auxiliary function meant to be
5711 ;; used with `org-export-to-file'. With a given extension, it tries
5712 ;; to provide a canonical file name to write export output to.
5713 ;;
5714 ;; Asynchronously generated results are never displayed directly.
5715 ;; Instead, they are stored in `org-export-stack-contents'. They can
5716 ;; then be retrieved by calling `org-export-stack'.
5717 ;;
5718 ;; Export Stack is viewed through a dedicated major mode
5719 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5720 ;;`org-export-stack-delete', `org-export-stack-view' and
5721 ;;`org-export-stack-clear'.
5722 ;;
5723 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5724 ;; It should be used whenever `org-export-async-start' is called.
5727 "Call function FUN on the results returned by BODY evaluation.
5729 FUN is an anonymous function of one argument. BODY evaluation
5730 happens in an asynchronous process, from a buffer which is an
5731 exact copy of the current one.
5733 Use `org-export-add-to-stack' in FUN in order to register results
5734 in the stack.
5736 This is a low level function. See also `org-export-to-buffer'
5737 and `org-export-to-file' for more specialized functions."
5740 ;; Write the full sexp evaluating BODY in a copy of the current
5741 ;; buffer to a temporary file, as it may be too long for program
5742 ;; args in `start-process'.
5749 ;; Null characters (from variable values) are inserted
5750 ;; within the file. As a consequence, coding system for
5751 ;; buffer contents will not be recognized properly. So,
5752 ;; we make sure it is the same as the one used to display
5753 ;; the original buffer.
5755 ,coding
5758 ;; Ignore `kill-emacs-hook' and code evaluation
5759 ;; queries from Babel as we need a truly
5760 ;; non-interactive process.
5762 org-babel-confirm-evaluate-answer-no t)
5763 ;; Initialize export framework.
5765 ;; Re-create current buffer there.
5768 ;; Sexp to evaluate in the buffer.
5770 ;; Start external process.
5773 (,process
5775 #'start-process
5778 ,proc-buffer
5785 ;; Register running process in stack.
5787 ;; Set-up sentinel in order to catch results.
5790 ,process
5812 ;;;###autoload
5815 &optional async subtreep visible-only body-only ext-plist
5816 post-process)
5817 "Call `org-export-as' with output to a specified buffer.
5819 BACKEND is either an export back-end, as returned by, e.g.,
5820 `org-export-create-backend', or a symbol referring to
5821 a registered back-end.
5823 BUFFER is the name of the output buffer. If it already exists,
5824 it will be erased first, otherwise, it will be created.
5826 A non-nil optional argument ASYNC means the process should happen
5827 asynchronously. The resulting buffer should then be accessible
5828 through the `org-export-stack' interface. When ASYNC is nil, the
5829 buffer is displayed if `org-export-show-temporary-export-buffer'
5830 is non-nil.
5832 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5833 EXT-PLIST are similar to those used in `org-export-as', which
5834 see.
5836 Optional argument POST-PROCESS is a function which should accept
5837 no argument. It is always called within the current process,
5838 from BUFFER, with point at its beginning. Export back-ends can
5839 use it to set a major mode there, e.g,
5841 (defun org-latex-export-as-latex
5842 (&optional async subtreep visible-only body-only ext-plist)
5843 (interactive)
5845 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5847 This function returns BUFFER."
5875 buffer)))
5877 ;;;###autoload
5880 post-process)
5881 "Call `org-export-as' with output to a specified file.
5883 BACKEND is either an export back-end, as returned by, e.g.,
5884 `org-export-create-backend', or a symbol referring to
5885 a registered back-end. FILE is the name of the output file, as
5886 a string.
5888 A non-nil optional argument ASYNC means the process should happen
5889 asynchronously. The resulting buffer will then be accessible
5890 through the `org-export-stack' interface.
5892 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5893 EXT-PLIST are similar to those used in `org-export-as', which
5894 see.
5896 Optional argument POST-PROCESS is called with FILE as its
5897 argument and happens asynchronously when ASYNC is non-nil. It
5898 has to return a file name, or nil. Export back-ends can use this
5899 to send the output file through additional processing, e.g,
5901 (defun org-latex-export-to-latex
5902 (&optional async subtreep visible-only body-only ext-plist)
5903 (interactive)
5906 async subtreep visible-only body-only ext-plist
5907 (lambda (file) (org-latex-compile file)))
5909 The function returns either a file name returned by POST-PROCESS,
5910 or FILE."
5929 backend subtreep visible-only body-only ext-plist)))
5936 ;; Get proper return value.
5938 file))))))
5941 "Return output file's name according to buffer specifications.
5943 EXTENSION is a string representing the output file extension,
5944 with the leading dot.
5946 With a non-nil optional argument SUBTREEP, try to determine
5948 of subtree at point.
5950 When optional argument PUB-DIR is set, use it as the publishing
5951 directory.
5953 Return file name as a string."
5956 ;; File name may come from EXPORT_FILE_NAME subtree
5957 ;; property, assuming point is at beginning of said
5958 ;; sub-tree.
5965 ;; File name may be extracted from buffer's associated
5966 ;; file, if any.
5968 ;; Can't determine file name on our own: Ask user.
5972 "Output file: " pub-dir nil nil nil
5976 ;; Build file name. Enforce EXTENSION over whatever user
5977 ;; may have come up with. PUB-DIR, if defined, always has
5978 ;; precedence over any provided path.
5983 extension))
5986 ;; If writing to OUTPUT-FILE would overwrite original file, append
5987 ;; EXTENSION another time to final name.
5990 output-file)))
5993 "Add a new result to export stack if not present already.
5995 SOURCE is a buffer or a file name containing export results.
5996 BACKEND is a symbol representing export back-end used to generate
5997 it.
5999 Entries already pointing to SOURCE and unavailable entries are
6000 removed beforehand. Return the new stack."
6006 "Menu for asynchronous export results and running processes."
6016 "Return source from export results at point in stack."
6023 source
6024 ;; SOURCE is not consistent with current line. The stack
6025 ;; view is outdated.
6029 "Remove all entries from export stack."
6034 "Refresh the asynchronous export stack.
6035 Unavailable sources are removed from the list. Return the new
6036 stack."
6045 ;; Back-end.
6047 ;; Age.
6050 ;; Compute age of the results.
6052 "%4h:%.2m "
6054 ;; Source.
6059 ;; Clear stack from exited processes, dead buffers or
6060 ;; non-existent files.
6072 "Remove export results at point from stack.
6073 If optional argument SOURCE is non-nil, remove it instead."
6078 org-export-stack-contents))))
6081 "View export results at point in stack.
6082 With an optional prefix argument IN-EMACS, force viewing files
6083 within Emacs."
6097 (define-key km "p" 'previous-line)
6098 (define-key km "\C-p" 'previous-line)
6099 (define-key km "\C-?" 'previous-line)
6100 (define-key km [up] 'previous-line)
6101 (define-key km "C" 'org-export-stack-clear)
6102 (define-key km "v" 'org-export-stack-view)
6103 (define-key km (kbd "RET") 'org-export-stack-view)
6104 (define-key km "d" 'org-export-stack-remove)
6105 km)
6106 "Keymap for Org Export Stack.")
6108 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6109 "Mode for displaying asynchronous export stack.
6112 stack.
6114 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6115 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6116 stack completely.
6118 Removing entries in an Org Export Stack buffer doesn't affect
6119 files or buffers, only the display.
6122 (abbrev-mode 0)
6123 (auto-fill-mode 0)
6124 (setq buffer-read-only t
6125 buffer-undo-list t
6126 truncate-lines t
6127 header-line-format
6128 '(:eval
6129 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6130 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6131 (set (make-local-variable 'revert-buffer-function)
6132 'org-export-stack-refresh))
6135 \f
6136 ;;; The Dispatcher
6137 ;;
6138 ;; `org-export-dispatch' is the standard interactive way to start an
6139 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6140 ;; for its interface, which, in turn, delegates response to key
6141 ;; pressed to `org-export--dispatch-action'.
6143 ;;;###autoload
6144 (defun org-export-dispatch (&optional arg)
6145 "Export dispatcher for Org mode.
6147 It provides an access to common export related tasks in a buffer.
6148 Its interface comes in two flavors: standard and expert.
6150 While both share the same set of bindings, only the former
6151 displays the valid keys associations in a dedicated buffer.
6152 Scrolling (resp. line-wise motion) in this buffer is done with
6153 SPC and DEL (resp. C-n and C-p) keys.
6155 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6156 flavor or the other.
6159 of options used back then, on the current buffer.
6161 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6162 (interactive "P")
6163 (let* ((input
6164 (cond ((equal arg '(16)) '(stack))
6165 ((and arg org-export-dispatch-last-action))
6166 (t (save-window-excursion
6167 (unwind-protect
6168 (progn
6169 ;; Remember where we are
6170 (move-marker org-export-dispatch-last-position
6171 (point)
6172 (org-base-buffer (current-buffer)))
6173 ;; Get and store an export command
6174 (setq org-export-dispatch-last-action
6175 (org-export--dispatch-ui
6176 (list org-export-initial-scope
6177 (and org-export-in-background 'async))
6178 nil
6179 org-export-dispatch-use-expert-ui)))
6180 (and (get-buffer "*Org Export Dispatcher*")
6181 (kill-buffer "*Org Export Dispatcher*")))))))
6182 (action (car input))
6183 (optns (cdr input)))
6184 (unless (memq 'subtree optns)
6185 (move-marker org-export-dispatch-last-position nil))
6186 (cl-case action
6187 ;; First handle special hard-coded actions.
6188 (template (org-export-insert-default-template nil optns))
6189 (stack (org-export-stack))
6190 (publish-current-file
6191 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6192 (publish-current-project
6193 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6194 (publish-choose-project
6195 (org-publish (assoc (org-icompleting-read
6196 "Publish project: "
6197 org-publish-project-alist nil t)
6198 org-publish-project-alist)
6199 (memq 'force optns)
6200 (memq 'async optns)))
6201 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6202 (otherwise
6203 (save-excursion
6204 (when arg
6205 ;; Repeating command, maybe move cursor to restore subtree
6206 ;; context.
6207 (if (eq (marker-buffer org-export-dispatch-last-position)
6208 (org-base-buffer (current-buffer)))
6209 (goto-char org-export-dispatch-last-position)
6210 ;; We are in a different buffer, forget position.
6211 (move-marker org-export-dispatch-last-position nil)))
6212 (funcall action
6213 ;; Return a symbol instead of a list to ease
6214 ;; asynchronous export macro use.
6215 (and (memq 'async optns) t)
6216 (and (memq 'subtree optns) t)
6217 (and (memq 'visible optns) t)
6218 (and (memq 'body optns) t)))))))
6220 (defun org-export--dispatch-ui (options first-key expertp)
6221 "Handle interface for `org-export-dispatch'.
6223 OPTIONS is a list containing current interactive options set for
6224 export. It can contain any of the following symbols:
6225 `body' toggles a body-only export
6226 `subtree' restricts export to current subtree
6227 `visible' restricts export to visible part of buffer.
6228 `force' force publishing files.
6229 `async' use asynchronous export process
6231 FIRST-KEY is the key pressed to select the first level menu. It
6232 is nil when this menu hasn't been selected yet.
6234 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6235 buffer is provided, but indications about currently active
6236 options are given in the prompt. Moreover, [?] allows to switch
6237 back to standard interface."
6238 (let* ((fontify-key
6239 (lambda (key &optional access-key)
6240 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6241 ;; non-nil is the required first-level key to activate
6242 ;; KEY. When its value is t, activate KEY independently
6243 ;; on the first key, if any. A nil value means KEY will
6244 ;; only be activated at first level.
6245 (if (or (eq access-key t) (eq access-key first-key))
6246 (org-propertize key 'face 'org-warning)
6247 key)))
6248 (fontify-value
6249 (lambda (value)
6250 ;; Fontify VALUE string.
6251 (org-propertize value 'face 'font-lock-variable-name-face)))
6252 ;; Prepare menu entries by extracting them from registered
6253 ;; back-ends and sorting them by access key and by ordinal,
6254 ;; if any.
6255 (entries
6256 (sort (sort (delq nil
6257 (mapcar #'org-export-backend-menu
6258 org-export-registered-backends))
6259 (lambda (a b)
6260 (let ((key-a (nth 1 a))
6261 (key-b (nth 1 b)))
6262 (cond ((and (numberp key-a) (numberp key-b))
6263 (< key-a key-b))
6264 ((numberp key-b) t)))))
6265 'car-less-than-car))
6266 ;; Compute a list of allowed keys based on the first key
6267 ;; pressed, if any. Some keys
6268 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6269 ;; available.
6270 (allowed-keys
6271 (nconc (list 2 22 19 6 1)
6272 (if (not first-key) (org-uniquify (mapcar 'car entries))
6273 (let (sub-menu)
6274 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6275 (when (eq (car entry) first-key)
6276 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6277 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6278 ((not first-key) (list ?P)))
6279 (list ?& ?#)
6280 (when expertp (list ??))
6281 (list ?q)))
6282 ;; Build the help menu for standard UI.
6283 (help
6284 (unless expertp
6285 (concat
6286 ;; Options are hard-coded.
6287 (format "[%s] Body only: %s [%s] Visible only: %s
6288 \[%s] Export scope: %s [%s] Force publishing: %s
6290 (funcall fontify-key "C-b" t)
6291 (funcall fontify-value
6292 (if (memq 'body options) "On " "Off"))
6293 (funcall fontify-key "C-v" t)
6294 (funcall fontify-value
6295 (if (memq 'visible options) "On " "Off"))
6296 (funcall fontify-key "C-s" t)
6297 (funcall fontify-value
6298 (if (memq 'subtree options) "Subtree" "Buffer "))
6299 (funcall fontify-key "C-f" t)
6300 (funcall fontify-value
6301 (if (memq 'force options) "On " "Off"))
6302 (funcall fontify-key "C-a" t)
6303 (funcall fontify-value
6304 (if (memq 'async options) "On " "Off")))
6305 ;; Display registered back-end entries. When a key
6306 ;; appears for the second time, do not create another
6307 ;; entry, but append its sub-menu to existing menu.
6308 (let (last-key)
6309 (mapconcat
6310 (lambda (entry)
6311 (let ((top-key (car entry)))
6312 (concat
6313 (unless (eq top-key last-key)
6314 (setq last-key top-key)
6316 (funcall fontify-key (char-to-string top-key))
6317 (nth 1 entry)))
6318 (let ((sub-menu (nth 2 entry)))
6319 (unless (functionp sub-menu)
6320 ;; Split sub-menu into two columns.
6321 (let ((index -1))
6322 (concat
6323 (mapconcat
6324 (lambda (sub-entry)
6325 (cl-incf index)
6326 (format
6327 (if (zerop (mod index 2)) " [%s] %-26s"
6329 (funcall fontify-key
6330 (char-to-string (car sub-entry))
6331 top-key)
6332 (nth 1 sub-entry)))
6333 sub-menu "")
6335 entries ""))
6336 ;; Publishing menu is hard-coded.
6338 [%s] Current file [%s] Current project
6340 (funcall fontify-key "P")
6341 (funcall fontify-key "f" ?P)
6342 (funcall fontify-key "p" ?P)
6343 (funcall fontify-key "x" ?P)
6344 (funcall fontify-key "a" ?P))
6346 (funcall fontify-key "&" t)
6347 (funcall fontify-key "#" t))
6348 (format "[%s] %s"
6349 (funcall fontify-key "q" t)
6350 (if first-key "Main menu" "Exit")))))
6351 ;; Build prompts for both standard and expert UI.
6352 (standard-prompt (unless expertp "Export command: "))
6353 (expert-prompt
6354 (when expertp
6355 (format
6356 "Export command (C-%s%s%s%s%s) [%s]: "
6357 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6358 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6359 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6360 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6361 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6362 (mapconcat (lambda (k)
6363 ;; Strip control characters.
6364 (unless (< k 27) (char-to-string k)))
6365 allowed-keys "")))))
6366 ;; With expert UI, just read key with a fancy prompt. In standard
6367 ;; UI, display an intrusive help buffer.
6368 (if expertp
6369 (org-export--dispatch-action
6370 expert-prompt allowed-keys entries options first-key expertp)
6371 ;; At first call, create frame layout in order to display menu.
6372 (unless (get-buffer "*Org Export Dispatcher*")
6373 (delete-other-windows)
6374 (org-switch-to-buffer-other-window
6375 (get-buffer-create "*Org Export Dispatcher*"))
6376 (setq cursor-type nil
6377 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6378 ;; Make sure that invisible cursor will not highlight square
6379 ;; brackets.
6380 (set-syntax-table (copy-syntax-table))
6381 (modify-syntax-entry ?\[ "w"))
6382 ;; At this point, the buffer containing the menu exists and is
6383 ;; visible in the current window. So, refresh it.
6384 (with-current-buffer "*Org Export Dispatcher*"
6385 ;; Refresh help. Maintain display continuity by re-visiting
6386 ;; previous window position.
6387 (let ((pos (window-start)))
6388 (erase-buffer)
6389 (insert help)
6390 (set-window-start nil pos)))
6391 (org-fit-window-to-buffer)
6392 (org-export--dispatch-action
6393 standard-prompt allowed-keys entries options first-key expertp))))
6395 (defun org-export--dispatch-action
6396 (prompt allowed-keys entries options first-key expertp)
6397 "Read a character from command input and act accordingly.
6399 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6400 a list of characters available at a given step in the process.
6401 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6402 EXPERTP are the same as defined in `org-export--dispatch-ui',
6403 which see.
6405 Toggle export options when required. Otherwise, return value is
6406 a list with action as CAR and a list of interactive export
6407 options as CDR."
6408 (let (key)
6409 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6410 ;; C-p, SPC, DEL).
6411 (while (and (setq key (read-char-exclusive prompt))
6412 (not expertp)
6413 (memq key '(14 16 ?\s ?\d)))
6414 (cl-case key
6415 (14 (if (not (pos-visible-in-window-p (point-max)))
6416 (ignore-errors (scroll-up 1))
6417 (message "End of buffer")
6418 (sit-for 1)))
6419 (16 (if (not (pos-visible-in-window-p (point-min)))
6420 (ignore-errors (scroll-down 1))
6421 (message "Beginning of buffer")
6422 (sit-for 1)))
6423 (?\s (if (not (pos-visible-in-window-p (point-max)))
6424 (scroll-up nil)
6425 (message "End of buffer")
6426 (sit-for 1)))
6427 (?\d (if (not (pos-visible-in-window-p (point-min)))
6428 (scroll-down nil)
6429 (message "Beginning of buffer")
6430 (sit-for 1)))))
6431 (cond
6432 ;; Ignore undefined associations.
6433 ((not (memq key allowed-keys))
6434 (ding)
6435 (unless expertp (message "Invalid key") (sit-for 1))
6436 (org-export--dispatch-ui options first-key expertp))
6437 ;; q key at first level aborts export. At second level, cancel
6438 ;; first key instead.
6439 ((eq key ?q) (if (not first-key) (error "Export aborted")
6440 (org-export--dispatch-ui options nil expertp)))
6441 ;; Help key: Switch back to standard interface if expert UI was
6442 ;; active.
6443 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6444 ;; Send request for template insertion along with export scope.
6445 ((eq key ?#) (cons 'template (memq 'subtree options)))
6446 ;; Switch to asynchronous export stack.
6447 ((eq key ?&) '(stack))
6448 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6449 ((memq key '(2 22 19 6 1))
6450 (org-export--dispatch-ui
6451 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6452 (6 'force) (1 'async))))
6453 (if (memq option options) (remq option options)
6454 (cons option options)))
6455 first-key expertp))
6456 ;; Action selected: Send key and options back to
6457 ;; `org-export-dispatch'.
6458 ((or first-key (functionp (nth 2 (assq key entries))))
6459 (cons (cond
6460 ((not first-key) (nth 2 (assq key entries)))
6461 ;; Publishing actions are hard-coded. Send a special
6462 ;; signal to `org-export-dispatch'.
6463 ((eq first-key ?P)
6464 (cl-case key
6465 (?f 'publish-current-file)
6466 (?p 'publish-current-project)
6467 (?x 'publish-choose-project)
6468 (?a 'publish-all)))
6469 ;; Return first action associated to FIRST-KEY + KEY
6470 ;; path. Indeed, derived backends can share the same
6471 ;; FIRST-KEY.
6472 (t (catch 'found
6473 (mapc (lambda (entry)
6474 (let ((match (assq key (nth 2 entry))))
6475 (when match (throw 'found (nth 2 match)))))
6476 (member (assq first-key entries) entries)))))
6477 options))
6478 ;; Otherwise, enter sub-menu.
6479 (t (org-export--dispatch-ui options key expertp)))))
6483 (provide 'ox)
6485 ;; Local variables:
6486 ;; generated-autoload-file: "org-loaddefs.el"
6487 ;; End:
6489 ;;; ox.el ends here