| blob | c897b1a6621363729ab0b7c2c30703901ab46b05 |
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,
353 "Non-nil means insert author name into the exported file.
354 This option can also be set with the OPTIONS keyword,
361 "Non-nil means export CLOCK keywords.
362 This option can also be set with the OPTIONS keyword,
369 "Non-nil means the postamble should contain a creator sentence.
371 The sentence can be set in `org-export-creator-string', which
372 see.
374 This option can also be set with the OPTIONS keyword, e.g.,
383 "Non-nil means insert date in the exported document.
384 This option can also be set with the OPTIONS keyword,
391 "Time-stamp format string to use for DATE keyword.
393 The format string, when specified, only applies if date consists
394 in a single time-stamp. Otherwise its value will be ignored.
396 See `format-time-string' for details on how to build this
397 string."
406 emacs-version
408 "Information about the creator of the document.
409 This option can also be set on with the CREATOR keyword."
415 "Non-nil means export contents of standard drawers.
417 When t, all drawers are exported. This may also be a list of
418 drawer names to export, as strings. If that list starts with
419 `not', only drawers with such names will be ignored.
421 This variable doesn't apply to properties drawers. See
422 `org-export-with-properties' instead.
424 This option can also be set with the OPTIONS keyword,
437 :inline t
446 "Non-nil means insert author email into the exported file.
447 This option can also be set with the OPTIONS keyword,
454 "Non-nil means interpret *word*, /word/, _word_ and +word+.
456 If the export target supports emphasizing text, the word will be
457 typeset in bold, italic, with an underline or strike-through,
458 respectively.
460 This option can also be set with the OPTIONS keyword,
467 "Tags that exclude a tree from export.
469 All trees carrying any of these tags will be excluded from
470 export. This is without condition, so even subtrees inside that
471 carry one of the `org-export-select-tags' will be removed.
473 This option can also be set with the EXCLUDE_TAGS keyword."
480 This option can also be set with the OPTIONS keyword,
489 "Non-nil means Org footnotes should be exported.
490 This option can also be set with the OPTIONS keyword,
497 "Non-nil means process LaTeX environments and fragments.
499 This option can also be set with the OPTIONS line,
502 nil Ignore math snippets.
503 `verbatim' Keep everything in verbatim.
504 t Allow export of math snippets."
515 "The last level which is still exported as a headline.
517 Inferior levels will usually produce itemize or enumerate lists
518 when exported, but back-end behavior may differ.
520 This option can also be set with the OPTIONS keyword,
527 "The default language for export and clocktable translations, as a string.
528 This may have an association in
529 `org-clock-clocktable-language-setup',
530 `org-export-smart-quotes-alist' and `org-export-dictionary'.
531 This option can also be set with the LANGUAGE keyword."
537 "Non-nil means preserve all line breaks when exporting.
538 This option can also be set with the OPTIONS keyword,
545 "Non-nil means interpret entities when exporting.
548 Å.
550 For a list of supported names, see the constant `org-entities'
551 and the user option `org-entities-user'.
553 This option can also be set with the OPTIONS keyword,
560 "Non-nil means inlinetasks should be exported.
561 This option can also be set with the OPTIONS keyword,
570 "Non-nil means include planning info in export.
572 Planning info is the line containing either SCHEDULED:,
573 DEADLINE:, CLOSED: time-stamps, or a combination of them.
575 This option can also be set with the OPTIONS keyword,
584 "Non-nil means include priority cookies in export.
585 This option can also be set with the OPTIONS keyword,
592 "Non-nil means export contents of properties drawers.
594 When t, all properties are exported. This may also be a list of
595 properties to export, as strings.
597 This option can also be set with the OPTIONS keyword,
611 "Non-nil means add section numbers to headlines when exporting.
613 When set to an integer n, numbering will only happen for
614 headlines whose relative level is higher or equal to n.
616 This option can also be set with the OPTIONS keyword,
623 "Tags that select a tree for export.
625 If any such tag is found in a buffer, all trees that do not carry
626 one of these tags will be ignored during export. Inside trees
627 that are selected like this, you can still deselect a subtree by
628 tagging it with one of the `org-export-exclude-tags'.
630 This option can also be set with the SELECT_TAGS keyword."
636 "Non-nil means activate smart quotes during export.
637 This option can also be set with the OPTIONS keyword,
640 When setting this to non-nil, you need to take care of
641 using the correct Babel package when exporting to LaTeX.
642 E.g., you can load Babel for french like this:
654 When this option is turned on, these strings will be exported as:
656 Org HTML LaTeX UTF-8
657 -----+----------+--------+-------
659 -- – -- –
660 --- — --- —
663 This option can also be set with the OPTIONS keyword,
670 "Non-nil means include statistics cookies in export.
671 This option can also be set with the OPTIONS keyword,
682 If you want to control how Org displays those characters, see
683 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
684 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
685 it is not anymore.
687 When this option is turned on, you can use TeX-like syntax for
688 sub- and superscripts and see them exported correctly.
690 You can also set the option with #+OPTIONS: ^:t
693 single item - so grouping with {} is normally not needed. For
694 example, the following things will be parsed as single sub- or
695 superscripts:
697 10^24 or 10^tau several digits will be considered 1 item.
698 10^-12 or 10^-tau a leading sign with digits or a word
699 x^2-y^3 will be read as x^2 - y^3, because items are
700 terminated by almost any nonword/nondigit char.
701 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
703 Still, ambiguity is possible. So when in doubt, use {} to enclose
704 the sub/superscript. If you set this variable to the symbol `{}',
705 the braces are *required* in order to trigger interpretations as
707 frequently in plain text."
718 "Non-nil means create a table of contents in exported files.
720 The TOC contains headlines with levels up
721 to`org-export-headline-levels'. When an integer, include levels
722 up to N in the toc, this may then be different from
723 `org-export-headline-levels', but it will not be allowed to be
724 larger than the number of headline levels. When nil, no table of
725 contents is made.
727 This option can also be set with the OPTIONS keyword,
738 "Non-nil means export tables.
739 This option can also be set with the OPTIONS keyword,
748 "If nil, do not export tags, just remove them from headlines.
750 If this is the symbol `not-in-toc', tags will be removed from
751 table of contents entries, but still be shown in the headlines of
752 the document.
754 This option can also be set with the OPTIONS keyword,
764 "Non-nil means include TODO items for export.
766 This may have the following values:
767 t include tasks independent of state.
768 `todo' include only tasks that are not yet done.
769 `done' include only tasks that are already done.
770 nil ignore all tasks.
771 list of keywords include tasks with these keywords.
773 This option can also be set with the OPTIONS keyword,
788 "Non-nil means print title into the exported file.
789 This option can also be set with the OPTIONS keyword,
798 "Non-nil means insert a time stamp into the exported file.
799 The time stamp shows when the file was created. This option can
806 "Non nil means allow timestamps in export.
808 It can be set to any of the following values:
809 t export all timestamps.
810 `active' export active timestamps only.
811 `inactive' export inactive timestamps only.
812 nil do not export timestamps
814 This only applies to timestamps isolated in a paragraph
815 containing only timestamps. Other timestamps are always
816 exported.
818 This option can also be set with the OPTIONS keyword, e.g.
829 "Non-nil means include TODO keywords in export.
830 When nil, remove all these keywords from the export. This option
836 "Non-nil means BIND keywords can define local variable values.
837 This is a potential security risk, which is why the default value
838 is nil. You can also allow them through local buffer variables."
845 "Non-nil means do not raise an error on broken links.
847 When this variable is non-nil, broken links are ignored, without
848 stopping the export process. If it is set to `mark', broken
849 links are marked as such in the output, with a string like
851 [BROKEN LINK: path]
853 where PATH is the un-resolvable reference.
855 This option can also be set with the OPTIONS keyword, e.g.,
866 "Alist between export snippets back-ends and exporter back-ends.
868 This variable allows to provide shortcuts for export snippets.
872 HTML code while every other back-end will ignore it."
886 "Coding system for the exported file."
893 "Non-nil means pushing export output to the kill ring.
894 This variable is ignored during asynchronous export."
904 "The initial scope when exporting with `org-export-dispatch'.
905 This variable can be either set to `buffer' or `subtree'."
912 "Non-nil means show buffer after exporting to temp buffer.
913 When Org exports to a file, the buffer visiting that file is never
914 shown, but remains buried. However, when exporting to
915 a temporary buffer, that buffer is popped up in a second window.
916 When this variable is nil, the buffer remains buried also in
917 these cases."
922 "Non-nil means export and publishing commands will run in background.
923 Results from an asynchronous export are never displayed
931 "File used to initialize external export process.
933 Value must be either nil or an absolute file name. When nil, the
934 external process is launched like a regular Emacs session,
935 loading user's initialization file and any site specific
936 configuration. If a file is provided, it, and only it, is loaded
937 at start-up.
939 Therefore, using a specific configuration makes the process to
940 load faster and the export more portable."
949 "Non-nil means using a non-intrusive `org-export-dispatch'.
950 In that case, no help buffer is displayed. Though, an indicator
956 asynchronous). Also, [?] allows to switch back to standard
957 mode."
964 \f
965 ;;; Defining Back-ends
966 ;;
967 ;; An export back-end is a structure with `org-export-backend' type
968 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
969 ;; and `menu' slots.
970 ;;
971 ;; At the lowest level, a back-end is created with
972 ;; `org-export-create-backend' function.
973 ;;
974 ;; A named back-end can be registered with
975 ;; `org-export-register-backend' function. A registered back-end can
976 ;; later be referred to by its name, with `org-export-get-backend'
977 ;; function. Also, such a back-end can become the parent of a derived
978 ;; back-end from which slot values will be inherited by default.
979 ;; `org-export-derived-backend-p' can check if a given back-end is
980 ;; derived from a list of back-end names.
981 ;;
982 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
983 ;; `org-export-get-all-filters' return the full alist of transcoders,
984 ;; options and filters, including those inherited from ancestors.
985 ;;
986 ;; At a higher level, `org-export-define-backend' is the standard way
987 ;; to define an export back-end. If the new back-end is similar to
988 ;; a registered back-end, `org-export-define-derived-backend' may be
989 ;; used instead.
990 ;;
991 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
992 ;; when a given back-end hasn't been registered yet.
996 name parent transcoders options filters blocks menu)
999 "Return export back-end named after NAME.
1000 NAME is a symbol. Return nil if no such back-end is found."
1007 "Register BACKEND as a known export back-end.
1008 BACKEND is a structure with `org-export-backend' type."
1009 ;; Refuse to register an unnamed back-end.
1012 ;; Refuse to register a back-end with an unknown parent.
1016 ;; Register dedicated export blocks in the parser.
1020 ;; If a back-end with the same name as BACKEND is already
1021 ;; registered, replace it with BACKEND. Otherwise, simply add
1022 ;; BACKEND to the list of registered back-ends.
1028 "Signal an error if BACKEND isn't defined."
1033 "Non-nil if BACKEND is derived from one of BACKENDS.
1034 BACKEND is an export back-end, as returned by, e.g.,
1035 `org-export-create-backend', or a symbol referring to
1036 a registered back-end. BACKENDS is constituted of symbols."
1048 "Return full translation table for BACKEND.
1050 BACKEND is an export back-end, as return by, e.g,,
1051 `org-export-create-backend'. Return value is an alist where
1052 keys are element or object types, as symbols, and values are
1053 transcoders.
1055 Unlike to `org-export-backend-transcoders', this function
1056 also returns transcoders inherited from parent back-ends,
1057 if any."
1061 parent)
1066 transcoders)))
1069 "Return export options for BACKEND.
1071 BACKEND is an export back-end, as return by, e.g,,
1072 `org-export-create-backend'. See `org-export-options-alist'
1073 for the shape of the return value.
1075 Unlike to `org-export-backend-options', this function also
1076 returns options inherited from parent back-ends, if any."
1080 parent)
1084 options)))
1087 "Return complete list of filters for BACKEND.
1089 BACKEND is an export back-end, as return by, e.g,,
1090 `org-export-create-backend'. Return value is an alist where
1091 keys are symbols and values lists of functions.
1093 Unlike to `org-export-backend-filters', this function also
1094 returns filters inherited from parent back-ends, if any."
1098 parent)
1102 filters)))
1105 "Define a new back-end BACKEND.
1107 TRANSCODERS is an alist between object or element types and
1108 functions handling them.
1110 These functions should return a string without any trailing
1111 space, or nil. They must accept three arguments: the object or
1112 element itself, its contents or nil when it isn't recursive and
1113 the property list used as a communication channel.
1115 Contents, when not nil, are stripped from any global indentation
1116 \(although the relative one is preserved). They also always end
1117 with a single newline character.
1119 If, for a given type, no function is found, that element or
1120 object type will simply be ignored, along with any blank line or
1121 white space at its end. The same will happen if the function
1122 returns the nil value. If that function returns the empty
1123 string, the type will be ignored, but the blank lines or white
1124 spaces will be kept.
1126 In addition to element and object types, one function can be
1127 associated to the `template' (or `inner-template') symbol and
1128 another one to the `plain-text' symbol.
1130 The former returns the final transcoded string, and can be used
1131 to add a preamble and a postamble to document's body. It must
1132 accept two arguments: the transcoded string and the property list
1133 containing export options. A function associated to `template'
1135 A function associated to `inner-template' is always applied.
1137 The latter, when defined, is to be called on every text not
1138 recognized as an element or an object. It must accept two
1139 arguments: the text string and the information channel. It is an
1140 appropriate place to protect special chars relative to the
1141 back-end.
1143 BODY can start with pre-defined keyword arguments. The following
1144 keywords are understood:
1146 :export-block
1148 String, or list of strings, representing block names that
1149 will not be parsed. This is used to specify blocks that will
1150 contain raw code specific to the back-end. These blocks
1151 still have to be handled by the relative `export-block' type
1152 translator.
1154 :filters-alist
1156 Alist between filters and function, or list of functions,
1157 specific to the back-end. See `org-export-filters-alist' for
1158 a list of all allowed filters. Filters defined here
1159 shouldn't make a back-end test, as it may prevent back-ends
1160 derived from this one to behave properly.
1162 :menu-entry
1164 Menu entry for the export dispatcher. It should be a list
1165 like:
1169 where :
1171 KEY is a free character selecting the back-end.
1173 DESCRIPTION-OR-ORDINAL is either a string or a number.
1175 If it is a string, is will be used to name the back-end in
1176 its menu entry. If it is a number, the following menu will
1177 be displayed as a sub-menu of the back-end with the same
1178 KEY. Also, the number will be used to determine in which
1179 order such sub-menus will appear (lowest first).
1181 ACTION-OR-MENU is either a function or an alist.
1183 If it is an action, it will be called with four
1184 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1185 BODY-ONLY. See `org-export-as' for further explanations on
1186 some of them.
1188 If it is an alist, associations should follow the
1189 pattern:
1193 where KEY, DESCRIPTION and ACTION are described above.
1195 Valid values include:
1199 or
1204 (lambda (a s v b)
1205 (if a (org-latex-export-to-pdf t s v b)
1206 (org-open-file
1207 (org-latex-export-to-pdf nil s v b)))))))
1209 or the following, which will be added to the previous
1210 sub-menu,
1216 :options-alist
1218 Alist between back-end specific properties introduced in
1219 communication channel and how their value are acquired. See
1220 `org-export-options-alist' for more information about
1221 structure of the values."
1236 :transcoders transcoders
1237 :options options
1238 :filters filters
1239 :blocks blocks
1243 "Create a new back-end as a variant of an existing one.
1245 CHILD is the name of the derived back-end. PARENT is the name of
1246 the parent back-end.
1248 BODY can start with pre-defined keyword arguments. The following
1249 keywords are understood:
1251 :export-block
1253 String, or list of strings, representing block names that
1254 will not be parsed. This is used to specify blocks that will
1255 contain raw code specific to the back-end. These blocks
1256 still have to be handled by the relative `export-block' type
1257 translator.
1259 :filters-alist
1261 Alist of filters that will overwrite or complete filters
1262 defined in PARENT back-end. See `org-export-filters-alist'
1263 for a list of allowed filters.
1265 :menu-entry
1267 Menu entry for the export dispatcher. See
1268 `org-export-define-backend' for more information about the
1269 expected value.
1271 :options-alist
1273 Alist of back-end specific properties that will overwrite or
1274 complete those defined in PARENT back-end. Refer to
1275 `org-export-options-alist' for more information about
1276 structure of the values.
1278 :translate-alist
1280 Alist of element and object types and transcoders that will
1281 overwrite or complete transcode table from PARENT back-end.
1282 Refer to `org-export-define-backend' for detailed information
1283 about transcoders.
1286 as a variant of `latex' back-end with a custom template function:
1291 The back-end could then be called with, for example:
1309 :parent parent
1310 :transcoders transcoders
1311 :options options
1312 :filters filters
1313 :blocks blocks
1317 \f
1318 ;;; The Communication Channel
1319 ;;
1320 ;; During export process, every function has access to a number of
1321 ;; properties. They are of two types:
1322 ;;
1323 ;; 1. Environment options are collected once at the very beginning of
1324 ;; the process, out of the original buffer and configuration.
1325 ;; Collecting them is handled by `org-export-get-environment'
1326 ;; function.
1327 ;;
1328 ;; Most environment options are defined through the
1329 ;; `org-export-options-alist' variable.
1330 ;;
1331 ;; 2. Tree properties are extracted directly from the parsed tree,
1332 ;; just before export, by `org-export--collect-tree-properties'.
1334 ;;;; Environment Options
1335 ;;
1336 ;; Environment options encompass all parameters defined outside the
1337 ;; scope of the parsed data. They come from five sources, in
1338 ;; increasing precedence order:
1339 ;;
1340 ;; - Global variables,
1341 ;; - Buffer's attributes,
1342 ;; - Options keyword symbols,
1343 ;; - Buffer keywords,
1344 ;; - Subtree properties.
1345 ;;
1346 ;; The central internal function with regards to environment options
1347 ;; is `org-export-get-environment'. It updates global variables with
1348 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1349 ;; the different sources.
1350 ;;
1351 ;; The internal functions doing the retrieval are:
1352 ;; `org-export--get-global-options',
1353 ;; `org-export--get-buffer-attributes',
1354 ;; `org-export--parse-option-keyword',
1355 ;; `org-export--get-subtree-options' and
1356 ;; `org-export--get-inbuffer-options'
1357 ;;
1358 ;; Also, `org-export--list-bound-variables' collects bound variables
1359 ;; along with their value in order to set them as buffer local
1360 ;; variables later in the process.
1363 "Collect export options from the current buffer.
1365 Optional argument BACKEND is an export back-end, as returned by
1366 `org-export-create-backend'.
1368 When optional argument SUBTREEP is non-nil, assume the export is
1369 done against the current sub-tree.
1371 Third optional argument EXT-PLIST is a property list with
1372 external parameters overriding Org default settings, but still
1373 inferior to file-local settings."
1374 ;; First install #+BIND variables since these must be set before
1375 ;; global options are read.
1378 ;; Get and prioritize export options...
1380 ;; ... from global variables...
1382 ;; ... from an external property list...
1383 ext-plist
1384 ;; ... from in-buffer settings...
1386 ;; ... and from subtree, when appropriate.
1390 "Parse an OPTIONS line and return values as a plist.
1391 Optional argument BACKEND is an export back-end, as returned by,
1392 e.g., `org-export-create-backend'. It specifies which back-end
1393 specific items to read, if any."
1400 alist))
1401 alist))
1402 ;; Priority is given to back-end specific options.
1404 org-export-options-alist))
1414 "Get export options in subtree at point.
1415 Optional argument BACKEND is an export back-end, as returned by,
1416 e.g., `org-export-create-backend'. It specifies back-end used
1417 for export. Return options as a plist."
1418 ;; For each buffer keyword, create a headline property setting the
1419 ;; same property in communication channel. The name for the
1420 ;; property is the keyword with "EXPORT_" appended to it.
1422 ;; Make sure point is at a heading.
1425 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1426 ;; care of them right from the start.
1429 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1430 ;; headline's title (with no todo keyword, priority cookie or
1431 ;; tag) as its fallback value.
1437 ;; Look for both general keywords and back-end specific
1438 ;; options, with priority given to the latter.
1440 org-export-options-alist)))
1441 ;; Handle other keywords. Then return PLIST.
1455 property
1464 "Return current buffer export options, as a plist.
1466 Optional argument BACKEND, when non-nil, is an export back-end,
1467 as returned by, e.g., `org-export-create-backend'. It specifies
1468 which back-end specific options should also be read in the
1469 process.
1471 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1474 ;; Priority is given to back-end specific options.
1476 org-export-options-alist))
1479 org-export-special-keywords))))
1480 plist to-parse)
1483 ;; Return all properties associated to KEYWORD.
1490 ;; Recursively read keywords in buffer. FILES is
1491 ;; a list of files read so far. PLIST is the current
1492 ;; property list obtained.
1501 ;; Options in `org-export-special-keywords'.
1506 ;; Avoid circular dependencies.
1517 plist
1519 val backend))))
1523 plist
1530 ;; Options in `org-export-options-alist'.
1533 plist
1535 plist property
1536 ;; Handle value depending on specified
1537 ;; BEHAVIOR.
1542 ;; Even if `parse' implies `space'
1543 ;; behavior, we separate line with
1544 ;; "\n" so as to preserve
1545 ;; line-breaks. However, empty
1546 ;; lines are forbidden since `parse'
1547 ;; doesn't allow more than one
1548 ;; paragraph.
1557 " "
1570 ;; Read options in the current buffer and return value.
1572 ;; Parse properties in TO-PARSE. Remove newline characters not
1573 ;; involved in line breaks to simulate `space' behavior.
1574 ;; Finally return options.
1587 "Return properties related to export process, as a plist.
1588 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1589 are like the arguments with the same names of function
1590 `org-export-as'."
1595 :back-end backend
1600 "Return properties related to buffer attributes, as a plist."
1605 "Return global export options as a plist.
1606 Optional argument BACKEND, if non-nil, is an export back-end, as
1607 returned by, e.g., `org-export-create-backend'. It specifies
1608 which back-end specific export options should also be read in the
1609 process."
1611 ;; Priority is given to back-end specific options.
1613 org-export-options-alist)))
1619 plist
1620 prop
1621 ;; Evaluate default value provided.
1626 value)))))))))
1629 "Return variables bound from BIND keywords in current buffer.
1630 Also look for BIND keywords in setup files. The return value is
1631 an alist where associations are (VARIABLE-NAME VALUE)."
1635 ;; Return an alist between variable names and their
1636 ;; value. FILES is a list of setup files names read
1637 ;; so far, used to avoid circular dependencies. ALIST
1638 ;; is the alist collected so far.
1650 ;; Enter setup file.
1662 alist))))))))))
1663 alist)))))
1664 ;; Return value in appropriate order of appearance.
1667 ;; defsubst org-export-get-parent must be defined before first use,
1668 ;; was originally defined in the topology section
1671 "Return BLOB parent or nil.
1672 BLOB is the element or object considered."
1675 ;;;; Tree Properties
1676 ;;
1677 ;; Tree properties are information extracted from parse tree. They
1678 ;; are initialized at the beginning of the transcoding process by
1679 ;; `org-export--collect-tree-properties'.
1680 ;;
1681 ;; Dedicated functions focus on computing the value of specific tree
1682 ;; properties during initialization. Thus,
1683 ;; `org-export--populate-ignore-list' lists elements and objects that
1684 ;; should be skipped during export, `org-export--get-min-level' gets
1685 ;; the minimal exportable level, used as a basis to compute relative
1686 ;; level for headlines. Eventually
1687 ;; `org-export--collect-headline-numbering' builds an alist between
1688 ;; headlines and their numbering.
1691 "Extract tree properties from parse tree.
1693 DATA is the parse tree from which information is retrieved. INFO
1694 is a list holding export options.
1696 Following tree properties are set or updated:
1698 `:headline-offset' Offset between true level of headlines and
1699 local level. An offset of -1 means a headline
1700 of level 2 should be considered as a level
1701 1 headline in the context.
1703 `:headline-numbering' Alist of all headlines as key and the
1704 associated numbering as value.
1706 `:id-alist' Alist of all ID references as key and associated file
1707 as value.
1709 Return updated plist."
1710 ;; Install the parse tree in the communication channel.
1712 ;; Compute `:headline-offset' in order to be able to use
1713 ;; `org-export-get-relative-level'.
1716 :headline-offset
1718 ;; From now on, properties order doesn't matter: get the rest of the
1719 ;; tree properties.
1721 info
1723 :id-alist
1732 "Return minimum exportable headline's level in DATA.
1733 DATA is parsed tree as returned by `org-element-parse-buffer'.
1734 OPTIONS is a plist holding export options."
1743 ;; If no headline was found, for the sake of consistency, set
1744 ;; minimum level to 1 nonetheless.
1748 "Return numbering of all exportable, numbered headlines in a parse tree.
1750 DATA is the parse tree. OPTIONS is the plist holding export
1751 options.
1753 Return an alist whose key is a headline and value is its
1754 associated numbering \(in the shape of a list of numbers) or nil
1755 for a footnotes section."
1764 headline
1766 for n across numbering
1767 for idx from 0 to org-export-max-depth
1771 options)))
1774 "List headlines and inlinetasks with a select tag in their tree.
1775 DATA is parsed data as returned by `org-element-parse-buffer'.
1776 INFO is a plist holding export options."
1786 ;; When a select tag is found, mark full
1787 ;; genealogy and every headline within the
1788 ;; tree as acceptable.
1791 genealogy
1794 selected-trees))
1795 ;; If at a headline, continue searching in tree,
1796 ;; recursively.
1805 selected-trees))
1808 "Non-nil when element or object BLOB should be skipped during export.
1809 OPTIONS is the plist holding export options. SELECTED, when
1810 non-nil, is a list of headlines or inlinetasks belonging to
1811 a tree with a select tag."
1818 ;; If `:with-drawers' value starts with `not', ignore
1819 ;; every drawer whose name belong to that list.
1820 ;; Otherwise, ignore drawers whose name isn't in that
1821 ;; list.
1838 ;; Ignore subtrees with an exclude tag.
1841 ;; When a select tag is present in the buffer, ignore any tree
1842 ;; without it.
1844 ;; Ignore commented sub-trees.
1846 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1848 ;; Ignore tasks, if specified by `:with-tasks' property.
1860 properties-set))))))
1871 ;; `:with-timestamps' only applies to isolated timestamps
1872 ;; objects, i.e. timestamp objects in a paragraph containing only
1873 ;; timestamps and whitespaces.
1881 options t))))
1890 \f
1891 ;;; The Transcoder
1892 ;;
1893 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1894 ;; `org-element-parse-buffer') and transcodes it into a specified
1895 ;; back-end output. It takes care of filtering out elements or
1896 ;; objects according to export options and organizing the output blank
1897 ;; lines and white space are preserved. The function memoizes its
1898 ;; results, so it is cheap to call it within transcoders.
1899 ;;
1900 ;; It is possible to modify locally the back-end used by
1901 ;; `org-export-data' or even use a temporary back-end by using
1902 ;; `org-export-data-with-backend'.
1903 ;;
1904 ;; `org-export-transcoder' is an accessor returning appropriate
1905 ;; translator function for a given element or object.
1908 "Return appropriate transcoder for BLOB.
1909 INFO is a plist containing export directives."
1911 ;; Return contents only for complete parse trees.
1917 "Convert DATA into current back-end format.
1919 DATA is a parse tree, an element or an object or a secondary
1920 string. INFO is a plist holding export options.
1922 Return a string."
1924 ;; Handle broken links according to
1925 ;; `org-export-with-broken-links'.
1940 ;; Ignored element/object.
1942 ;; Plain text.
1948 info))
1949 ;; Secondary string.
1952 ;; Element/Object without contents or, as a special
1953 ;; case, headline with archive tag and archived trees
1954 ;; restricted to title only.
1963 ;; Export snippets never return a nil value so
1964 ;; that white spaces following them are never
1965 ;; ignored.
1967 ;; Element/Object with contents.
1980 ;; Elements directly containing
1981 ;; objects must have their indentation
1982 ;; normalized first.
1984 data
1985 ;; When normalizing contents of the
1986 ;; first paragraph in an item or
1987 ;; a footnote definition, ignore
1988 ;; first line's indentation: there is
1989 ;; none and it might be misleading.
1994 data)
2002 info)))))))))
2003 ;; Final result will be memoized before being returned.
2005 data
2009 ;; Append the same white space between elements or objects
2010 ;; as in the original buffer, and call appropriate filters.
2021 info)))
2022 results)))
2026 "Convert DATA into BACKEND format.
2028 DATA is an element, an object, a secondary string or a string.
2029 BACKEND is a symbol. INFO is a plist used as a communication
2030 channel.
2032 Unlike to `org-export-with-backend', this function will
2033 recursively convert DATA using BACKEND translation table."
2036 data
2037 ;; Set-up a new communication channel with translations defined in
2038 ;; BACKEND as the translate table and a new hash table for
2039 ;; memoization.
2041 info
2044 ;; Size of the hash table is reduced since this function
2045 ;; will probably be used on small trees.
2049 "Expand a parsed element or object to its original state.
2051 BLOB is either an element or an object. CONTENTS is its
2052 contents, as a string or nil.
2054 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2055 keywords before output."
2060 blob contents))))
2063 \f
2064 ;;; The Filter System
2065 ;;
2066 ;; Filters allow end-users to tweak easily the transcoded output.
2067 ;; They are the functional counterpart of hooks, as every filter in
2068 ;; a set is applied to the return value of the previous one.
2069 ;;
2070 ;; Every set is back-end agnostic. Although, a filter is always
2071 ;; called, in addition to the string it applies to, with the back-end
2072 ;; used as argument, so it's easy for the end-user to add back-end
2073 ;; specific filters in the set. The communication channel, as
2074 ;; a plist, is required as the third argument.
2075 ;;
2076 ;; From the developer side, filters sets can be installed in the
2077 ;; process with the help of `org-export-define-backend', which
2078 ;; internally stores filters as an alist. Each association has a key
2079 ;; among the following symbols and a function or a list of functions
2080 ;; as value.
2081 ;;
2082 ;; - `:filter-options' applies to the property list containing export
2083 ;; options. Unlike to other filters, functions in this list accept
2084 ;; two arguments instead of three: the property list containing
2085 ;; export options and the back-end. Users can set its value through
2086 ;; `org-export-filter-options-functions' variable.
2087 ;;
2088 ;; - `:filter-parse-tree' applies directly to the complete parsed
2089 ;; tree. Users can set it through
2090 ;; `org-export-filter-parse-tree-functions' variable.
2091 ;;
2092 ;; - `:filter-body' applies to the body of the output, before template
2093 ;; translator chimes in. Users can set it through
2094 ;; `org-export-filter-body-functions' variable.
2095 ;;
2096 ;; - `:filter-final-output' applies to the final transcoded string.
2097 ;; Users can set it with `org-export-filter-final-output-functions'
2098 ;; variable.
2099 ;;
2100 ;; - `:filter-plain-text' applies to any string not recognized as Org
2101 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2102 ;; configure it.
2103 ;;
2104 ;; - `:filter-TYPE' applies on the string returned after an element or
2105 ;; object of type TYPE has been transcoded. A user can modify
2106 ;; `org-export-filter-TYPE-functions' to install these filters.
2107 ;;
2108 ;; All filters sets are applied with
2109 ;; `org-export-filter-apply-functions' function. Filters in a set are
2110 ;; applied in a LIFO fashion. It allows developers to be sure that
2111 ;; their filters will be applied first.
2112 ;;
2113 ;; Filters properties are installed in communication channel with
2114 ;; `org-export-install-filters' function.
2115 ;;
2116 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2117 ;; `org-export-before-parsing-hook') are run at the beginning of the
2118 ;; export process and just before parsing to allow for heavy structure
2119 ;; modifications.
2122 ;;;; Hooks
2125 "Hook run at the beginning of the export process.
2127 This is run before include keywords and macros are expanded and
2128 Babel code blocks executed, on a copy of the original buffer
2129 being exported. Visibility and narrowing are preserved. Point
2130 is at the beginning of the buffer.
2132 Every function in this hook will be called with one argument: the
2136 "Hook run before parsing an export buffer.
2138 This is run after include keywords and macros have been expanded
2139 and Babel code blocks executed, on a copy of the original buffer
2140 being exported. Visibility and narrowing are preserved. Point
2141 is at the beginning of the buffer.
2143 Every function in this hook will be called with one argument: the
2147 ;;;; Special Filters
2150 "List of functions applied to the export options.
2151 Each filter is called with two arguments: the export options, as
2152 a plist, and the back-end, as a symbol. It must return
2156 "List of functions applied to the parsed tree.
2157 Each filter is called with three arguments: the parse tree, as
2158 returned by `org-element-parse-buffer', the back-end, as
2159 a symbol, and the communication channel, as a plist. It must
2163 "List of functions applied to plain text.
2164 Each filter is called with three arguments: a string which
2165 contains no Org syntax, the back-end, as a symbol, and the
2166 communication channel, as a plist. It must return a string or
2170 "List of functions applied to transcoded body.
2171 Each filter is called with three arguments: a string which
2172 contains no Org syntax, the back-end, as a symbol, and the
2173 communication channel, as a plist. It must return a string or
2177 "List of functions applied to the transcoded string.
2178 Each filter is called with three arguments: the full transcoded
2179 string, the back-end, as a symbol, and the communication channel,
2180 as a plist. It must return a string that will be used as the
2184 ;;;; Elements Filters
2187 "List of functions applied to a transcoded babel-call.
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 center block.
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 clock.
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 diary-sexp.
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 drawer.
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 dynamic-block.
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 example-block.
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 export-block.
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 fixed-width.
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 footnote-definition.
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 headline.
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 horizontal-rule.
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 inlinetask.
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 item.
2266 Each filter is called with three arguments: the transcoded data,
2267 as a string, the back-end, as a symbol, and the communication
2271 "List of functions applied to a transcoded keyword.
2272 Each filter is called with three arguments: the transcoded data,
2273 as a string, the back-end, as a symbol, and the communication
2277 "List of functions applied to a transcoded latex-environment.
2278 Each filter is called with three arguments: the transcoded data,
2279 as a string, the back-end, as a symbol, and the communication
2283 "List of functions applied to a transcoded node-property.
2284 Each filter is called with three arguments: the transcoded data,
2285 as a string, the back-end, as a symbol, and the communication
2289 "List of functions applied to a transcoded paragraph.
2290 Each filter is called with three arguments: the transcoded data,
2291 as a string, the back-end, as a symbol, and the communication
2295 "List of functions applied to a transcoded plain-list.
2296 Each filter is called with three arguments: the transcoded data,
2297 as a string, the back-end, as a symbol, and the communication
2301 "List of functions applied to a transcoded planning.
2302 Each filter is called with three arguments: the transcoded data,
2303 as a string, the back-end, as a symbol, and the communication
2307 "List of functions applied to a transcoded property-drawer.
2308 Each filter is called with three arguments: the transcoded data,
2309 as a string, the back-end, as a symbol, and the communication
2313 "List of functions applied to a transcoded quote block.
2314 Each filter is called with three arguments: the transcoded quote
2315 data, as a string, the back-end, as a symbol, and the
2316 communication channel, as a plist. It must return a string or
2320 "List of functions applied to a transcoded section.
2321 Each filter is called with three arguments: the transcoded data,
2322 as a string, the back-end, as a symbol, and the communication
2326 "List of functions applied to a transcoded special block.
2327 Each filter is called with three arguments: the transcoded data,
2328 as a string, the back-end, as a symbol, and the communication
2332 "List of functions applied to a transcoded src-block.
2333 Each filter is called with three arguments: the transcoded data,
2334 as a string, the back-end, as a symbol, and the communication
2338 "List of functions applied to a transcoded table.
2339 Each filter is called with three arguments: the transcoded data,
2340 as a string, the back-end, as a symbol, and the communication
2344 "List of functions applied to a transcoded table-cell.
2345 Each filter is called with three arguments: the transcoded data,
2346 as a string, the back-end, as a symbol, and the communication
2350 "List of functions applied to a transcoded table-row.
2351 Each filter is called with three arguments: the transcoded data,
2352 as a string, the back-end, as a symbol, and the communication
2356 "List of functions applied to a transcoded verse block.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 ;;;; Objects Filters
2365 "List of functions applied to transcoded bold text.
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 transcoded code text.
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 entity.
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 export-snippet.
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 footnote-reference.
2390 Each filter is called with three arguments: the transcoded data,
2391 as a string, the back-end, as a symbol, and the communication
2395 "List of functions applied to a transcoded inline-babel-call.
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 inline-src-block.
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 transcoded italic text.
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 latex-fragment.
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 line-break.
2420 Each filter is called with three arguments: the transcoded data,
2421 as a string, the back-end, as a symbol, and the communication
2425 "List of functions applied to a transcoded link.
2426 Each filter is called with three arguments: the transcoded data,
2427 as a string, the back-end, as a symbol, and the communication
2431 "List of functions applied to a transcoded radio-target.
2432 Each filter is called with three arguments: the transcoded data,
2433 as a string, the back-end, as a symbol, and the communication
2437 "List of functions applied to a transcoded statistics-cookie.
2438 Each filter is called with three arguments: the transcoded data,
2439 as a string, the back-end, as a symbol, and the communication
2443 "List of functions applied to transcoded strike-through text.
2444 Each filter is called with three arguments: the transcoded data,
2445 as a string, the back-end, as a symbol, and the communication
2449 "List of functions applied to a transcoded subscript.
2450 Each filter is called with three arguments: the transcoded data,
2451 as a string, the back-end, as a symbol, and the communication
2455 "List of functions applied to a transcoded superscript.
2456 Each filter is called with three arguments: the transcoded data,
2457 as a string, the back-end, as a symbol, and the communication
2461 "List of functions applied to a transcoded target.
2462 Each filter is called with three arguments: the transcoded data,
2463 as a string, the back-end, as a symbol, and the communication
2467 "List of functions applied to a transcoded timestamp.
2468 Each filter is called with three arguments: the transcoded data,
2469 as a string, the back-end, as a symbol, and the communication
2473 "List of functions applied to transcoded underline text.
2474 Each filter is called with three arguments: the transcoded data,
2475 as a string, the back-end, as a symbol, and the communication
2479 "List of functions applied to transcoded verbatim text.
2480 Each filter is called with three arguments: the transcoded data,
2481 as a string, the back-end, as a symbol, and the communication
2485 ;;;; Filters Tools
2486 ;;
2487 ;; Internal function `org-export-install-filters' installs filters
2488 ;; hard-coded in back-ends (developer filters) and filters from global
2489 ;; variables (user filters) in the communication channel.
2490 ;;
2491 ;; Internal function `org-export-filter-apply-functions' takes care
2492 ;; about applying each filter in order to a given data. It ignores
2493 ;; filters returning a nil value but stops whenever a filter returns
2494 ;; an empty string.
2497 "Call every function in FILTERS.
2499 Functions are called with arguments VALUE, current export
2500 back-end's name and INFO. A function returning a nil value will
2501 be skipped. If it returns the empty string, the process ends and
2502 VALUE is ignored.
2504 Call is done in a LIFO fashion, to be sure that developer
2505 specified filters, if any, are called first."
2516 "Install filters properties in communication channel.
2517 INFO is a plist containing the current communication channel.
2518 Return the updated communication channel."
2520 ;; Install user-defined filters with `org-export-filters-alist'
2521 ;; and filters already in INFO (through ext-plist mechanism).
2528 ;; Filters in INFO will be called
2529 ;; before those user provided.
2532 default-value)))))
2533 ;; Prepend back-end specific filters to that list.
2535 ;; Single values get consed, lists are appended.
2540 plist key
2543 ;; Return new communication channel.
2547 \f
2548 ;;; Core functions
2549 ;;
2550 ;; This is the room for the main function, `org-export-as', along with
2551 ;; its derivative, `org-export-string-as'.
2552 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2553 ;; function should be added to kill ring.
2554 ;;
2555 ;; Note that `org-export-as' doesn't really parse the current buffer,
2556 ;; but a copy of it (with the same buffer-local variables and
2557 ;; visibility), where macros and include keywords are expanded and
2558 ;; Babel blocks are executed, if appropriate.
2559 ;; `org-export-with-buffer-copy' macro prepares that copy.
2560 ;;
2561 ;; File inclusion is taken care of by
2562 ;; `org-export-expand-include-keyword' and
2563 ;; `org-export--prepare-file-contents'. Structure wise, including
2564 ;; a whole Org file in a buffer often makes little sense. For
2565 ;; example, if the file contains a headline and the include keyword
2566 ;; was within an item, the item should contain the headline. That's
2567 ;; why file inclusion should be done before any structure can be
2568 ;; associated to the file, that is before parsing.
2569 ;;
2570 ;; `org-export-insert-default-template' is a command to insert
2571 ;; a default template (or a back-end specific template) at point or in
2572 ;; current subtree.
2575 "Return a copy of the current buffer.
2576 The copy preserves Org buffer-local variables, visibility and
2577 narrowing."
2583 new-buf))
2586 "Apply BODY in a copy of the current buffer.
2587 The copy preserves local variables, visibility and contents of
2588 the original buffer. Point is at the beginning of the buffer
2589 when BODY is applied."
2598 ;; Kill copy without confirmation.
2604 "Generate a function duplicating BUFFER.
2606 The copy will preserve local variables, visibility, contents and
2607 narrowing of the original buffer. If a region was active in
2608 BUFFER, contents will be narrowed to that region instead.
2610 The resulting function can be evaluated at a later time, from
2611 another buffer, effectively cloning the original buffer there.
2613 The function assumes BUFFER's major mode is `org-mode'."
2617 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2618 ;; already in BUFFER.
2620 ;; Copy specific buffer local variables and variables set
2621 ;; through BIND keywords.
2623 vars)
2631 buffer-file-name
2632 buffer-file-coding-system))
2636 ;; Skip unreadable values, as they cannot be
2637 ;; sent to external process.
2641 vars))))))
2642 ;; Whole buffer contents.
2647 ;; Narrowing.
2651 ;; Current position of point.
2653 ;; Overlays with invisible property.
2662 ov-set)))))))))
2665 "Delete commented areas in the buffer.
2666 Commented areas are comments, comment blocks, commented trees and
2667 inlinetasks. Trailing blank lines after a comment or a comment
2668 block are preserved. Narrowing, if any, is ignored."
2689 "Prune non exportable elements from DATA.
2690 DATA is the parse tree to traverse. INFO is the plist holding
2691 export info. Also set `:ignore-list' in INFO to a list of
2692 objects which should be ignored during export, but not removed
2693 from tree."
2695 ;; First find trees containing a select tag, if any.
2699 ;; Prune non-exportable elements and objects from tree.
2700 ;; As a special case, special rows and cells from tables
2701 ;; are stored in IGNORE, as they still need to be
2702 ;; accessed during export.
2712 ;; If headline is archived but tree below has
2713 ;; to be skipped, remove contents.
2715 ;; Move into recursive objects/elements.
2717 ;; Move into secondary string, if any.
2719 org-element-secondary-value-alist)))
2721 ;; If a select tag is active, also ignore the section before the
2722 ;; first headline, if any.
2727 ;; Prune tree and communication channel.
2731 ;; Priority is given to back-end specific options.
2733 org-export-options-alist))
2736 ;; Eventually set `:ignore-list'.
2740 "Change uninterpreted elements back into Org syntax.
2741 DATA is the parse tree. INFO is a plist containing export
2742 options. Each uninterpreted element or object is changed back
2743 into a string. Contents, if any, are not modified. The parse
2744 tree is modified by side effect."
2750 p
2753 info))))))
2756 "Change uninterpreted elements back into Org syntax.
2757 DATA is a parse tree or a secondary string. INFO is a plist
2758 containing export options. It is modified by side effect and
2759 returned by the function."
2762 subscript superscript underline)
2766 ;; ... entities...
2773 ?\s)))))
2774 ;; ... emphasis...
2786 marker
2790 ?\s)))))))
2791 ;; ... LaTeX environments and fragments...
2795 ;; ... sub/superscripts...
2804 "_"
2813 ?\s)))))))))))
2815 ;; Splice NEW at BLOB location in parse tree.
2818 info nil nil t)
2819 ;; Return modified parse tree.
2820 data)
2823 "Insert footnote definitions outside parsing scope in TREE.
2825 If there is a footnote section in TREE, definitions found are
2826 appended to it. If `org-footnote-section' is non-nil, a new
2827 footnote section containing all definitions is inserted in TREE.
2828 Otherwise, definitions are appended at the end of the section
2829 containing their first reference.
2831 Only definitions actually referred to within TREE, directly or
2832 not, are considered."
2851 definitions))
2859 'footnote-definition
2865 definitions))))))))
2866 ;; Collect all out of scope definitions.
2876 ;; Filter out definitions referenced neither in the original
2877 ;; tree nor in the external definitions.
2882 definitions))
2885 referenced-labels)))
2890 definitions)))
2891 ;; Install definitions in subtree.
2894 ;; If there is a footnote section, insert them here.
2899 nil t)))
2902 ;; If there should be a footnote section, create one containing
2903 ;; all the definitions at the end of the tree.
2906 tree
2912 'section
2913 nil
2915 ;; Otherwise add each definition at the end of the section where
2916 ;; it is first referenced.
2921 ;; Insert definitions in the same section as
2922 ;; their first reference in DATA.
2934 d)
2935 label)
2942 definition)
2944 definition)))))))))))
2947 ;;;###autoload
2950 "Transcode current Org buffer into BACKEND code.
2952 BACKEND is either an export back-end, as returned by, e.g.,
2953 `org-export-create-backend', or a symbol referring to
2954 a registered back-end.
2956 If narrowing is active in the current buffer, only transcode its
2957 narrowed part.
2959 If a region is active, transcode that region.
2961 When optional argument SUBTREEP is non-nil, transcode the
2962 sub-tree at point, extracting information from the headline
2963 properties first.
2965 When optional argument VISIBLE-ONLY is non-nil, don't export
2966 contents of hidden elements.
2968 When optional argument BODY-ONLY is non-nil, only return body
2969 code, without surrounding template.
2971 Optional argument EXT-PLIST, when provided, is a property list
2972 with external parameters overriding Org default settings, but
2973 still inferior to file-local settings.
2975 Return code as a string."
2980 ;; Narrow buffer to an appropriate region or subtree for
2981 ;; parsing. If parsing subtree, be sure to remove main headline
2982 ;; too.
2990 ;; Initialize communication channel with original buffer
2991 ;; attributes, unavailable in its copy.
2995 backend subtreep visible-only body-only)
3001 org-export-options-alist))))
3002 tree)
3003 ;; Update communication channel and get parse tree. Buffer
3004 ;; isn't parsed directly. Instead, all buffer modifications
3005 ;; and consequent parsing are undertaken in a temporary copy.
3007 ;; Run first hook with current back-end's name as argument.
3010 ;; Include files, delete comments and expand macros.
3015 ;; Refresh buffer properties and radio targets after
3016 ;; potentially invasive previous changes. Likewise, do it
3017 ;; again after executing Babel code.
3023 ;; Run last hook with current back-end's name as argument.
3024 ;; Update buffer properties and radio targets one last time
3025 ;; before parsing.
3032 ;; Update communication channel with environment. Also
3033 ;; install user's and developer's filters.
3038 ;; Call options filters and update export options. We do not
3039 ;; use `org-export-filter-apply-functions' here since the
3040 ;; arity of such filters is different.
3045 ;; Expand export-specific set of macros: {{{author}}},
3046 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
3047 ;; be done once regular macros have been expanded, since
3048 ;; parsed keywords may contain one of them.
3061 value)
3062 value)))
3066 'finalize
3067 parsed-keywords)
3068 ;; Parse buffer.
3070 ;; Merge footnote definitions outside scope into parse tree.
3072 ;; Prune tree from non-exported elements and transform
3073 ;; uninterpreted elements or objects in both parse tree and
3074 ;; communication channel.
3077 ;; Call parse tree filters.
3081 ;; Now tree is complete, compute its properties and add them
3082 ;; to communication channel.
3084 ;; Eventually transcode TREE. Wrap the resulting string into
3085 ;; a template.
3094 info))
3097 ;; Remove all text properties since they cannot be
3098 ;; retrieved from an external process. Finally call
3099 ;; final-output filter and return result.
3105 info))))))))
3107 ;;;###autoload
3109 "Transcode STRING into BACKEND code.
3111 BACKEND is either an export back-end, as returned by, e.g.,
3112 `org-export-create-backend', or a symbol referring to
3113 a registered back-end.
3115 When optional argument BODY-ONLY is non-nil, only return body
3116 code, without preamble nor postamble.
3118 Optional argument EXT-PLIST, when provided, is a property list
3119 with external parameters overriding Org default settings, but
3120 still inferior to file-local settings.
3122 Return code as a string."
3128 ;;;###autoload
3130 "Replace the active region by its export to BACKEND.
3131 BACKEND is either an export back-end, as returned by, e.g.,
3132 `org-export-create-backend', or a symbol referring to
3133 a registered back-end."
3139 ;;;###autoload
3141 "Insert all export keywords with default values at beginning of line.
3143 BACKEND is a symbol referring to the name of a registered export
3144 back-end, for which specific export options should be added to
3145 the template, or `default' for default template. When it is nil,
3146 the user will be prompted for a category.
3148 If SUBTREEP is non-nil, export configuration will be set up
3149 locally for the subtree through node properties."
3159 "Options category: "
3163 org-export-registered-backends))
3164 nil t))))
3165 options keywords)
3166 ;; Populate OPTIONS and KEYWORDS.
3183 ;; Move to an appropriate location in order to insert options.
3185 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3203 ;; Then the rest of keywords, in the order specified in either
3204 ;; `org-export-options-alist' or respective export back-ends.
3225 "Expand every include keyword in buffer.
3226 Optional argument INCLUDED is a list of included file names along
3227 with their line restriction, when appropriate. It is used to
3228 avoid infinite recursion. Optional argument DIR is the current
3229 working directory. It is used to properly resolve relative
3230 paths. Optional argument FOOTNOTES is a hash-table used for
3231 storing and resolving footnotes. It is created automatically."
3237 ;; If :minlevel is not set the text-property
3238 ;; `:org-include-induced-level' will be used to determine the
3239 ;; relative level when expanding INCLUDE.
3240 ;; Only affects included Org documents.
3244 :org-include-induced-level
3246 ;; Expand INCLUDE keywords.
3252 ;; Extract arguments from keyword's value.
3255 location
3263 matched)
3269 matched)
3270 dir)))
3274 value)
3280 value)
3287 ;; Minimal level of included file defaults to the child
3288 ;; level of the current headline, if any, or one. It
3289 ;; only applies is the file is meant to be included as
3290 ;; an Org one.
3302 ;; Remove keyword.
3308 ;; Check if files has already been parsed. Look after
3309 ;; inclusion lines too, as different parts of the same file
3310 ;; can be included too.
3325 ind-str block arg-str contents ind-str block))))
3332 ind-str block contents ind-str block))))
3340 file location only-contents lines)
3341 lines)))
3345 file lines ind minlevel
3348 footnotes)))
3352 footnotes)
3354 ;; Expand footnotes after all files have been included.
3355 ;; Footnotes are stored at end of buffer.
3360 footnotes)))))))))))
3363 "Resolve absolute lines for an included file with file-link.
3365 FILE is string file-name of the file to include. LOCATION is a
3366 string name within FILE to be included (located via
3367 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3368 contents of the named element will be included, as determined
3369 Org-Element. If LINES is non-nil only those lines are included.
3371 Return a string of lines to be included in the format expected by
3372 `org-export--prepare-file-contents'."
3378 ;; Enforce consistent search.
3391 ;; Skip planning line and property-drawer.
3417 start-line
3419 (+ start-line
3422 counter))))))))
3426 "Prepare contents of FILE for inclusion and return it as a string.
3428 When optional argument LINES is a string specifying a range of
3429 lines, include only those lines.
3431 Optional argument IND, when non-nil, is an integer specifying the
3432 global indentation of returned contents. Since its purpose is to
3433 allow an included file to stay in the same environment it was
3434 created (e.g., a list item), it doesn't apply past the first
3435 headline encountered.
3437 Optional argument MINLEVEL, when non-nil, is an integer
3438 specifying the level that any top-level headline in the included
3439 file should have.
3441 Optional argument ID is an integer that will be inserted before
3442 each footnote definition and reference if FILE is an Org file.
3443 This is useful to avoid conflicts when more than one Org file
3444 with footnotes is included in a document.
3446 Optional argument FOOTNOTES is a hash-table to store footnotes in
3447 the included document."
3463 ;; Remove blank lines at beginning and end of contents. The logic
3464 ;; behind that removal is that blank lines around include keyword
3465 ;; override blank lines in included file.
3474 ;; If IND is set, preserve indentation of include keyword until
3475 ;; the first headline encountered.
3482 ;; Do not move footnote definitions out of column 0.
3488 ;; When MINLEVEL is specified, compute minimal level for headlines
3489 ;; in the file (CUR-MIN), and remove stars to each headline so
3490 ;; that headlines with minimal level have a level of MINLEVEL.
3501 ;; Only change stars, don't bother moving whole
3502 ;; sections.
3507 ;; Append ID to all footnote references and definitions, so they
3508 ;; become file specific and cannot collide with footnotes in other
3509 ;; included files. Further, collect relevant footnote definitions
3510 ;; outside of LINES, in order to reintroduce them later.
3516 ;; Generate new label from LABEL. If LABEL is akin to
3517 ;; [1] convert it to [fn:--ID-1]. Otherwise add "-ID-"
3518 ;; after "fn:".
3524 ;; Replace OLD label with NEW in footnote F.
3538 ;; Update the footnote-reference at point and collect
3539 ;; the new label, which is only used for footnotes
3540 ;; outsides LINES.
3552 ;; Store since footnote-definition is
3553 ;; outside of LINES.
3556 footnotes))))
3563 "Execute every Babel code in the visible part of current buffer."
3564 ;; Get a pristine copy of current buffer so Babel references can be
3565 ;; properly resolved.
3571 "Return a non-nil value when output should be added to the kill ring.
3572 See also `org-export-copy-to-kill-ring'."
3578 \f
3579 ;;; Tools For Back-Ends
3580 ;;
3581 ;; A whole set of tools is available to help build new exporters. Any
3582 ;; function general enough to have its use across many back-ends
3583 ;; should be added here.
3585 ;;;; For Affiliated Keywords
3586 ;;
3587 ;; `org-export-read-attribute' reads a property from a given element
3588 ;; as a plist. It can be used to normalize affiliated keywords'
3589 ;; syntax.
3590 ;;
3591 ;; Since captions can span over multiple lines and accept dual values,
3592 ;; their internal representation is a bit tricky. Therefore,
3593 ;; `org-export-get-caption' transparently returns a given element's
3594 ;; caption as a secondary string.
3597 "Turn ATTRIBUTE property from ELEMENT into a plist.
3599 When optional argument PROPERTY is non-nil, return the value of
3600 that property within attributes.
3604 properties.
3606 All values will become strings except the empty string and
3609 will become the empty string."
3623 s)
3628 ;; Ignore any string before first property with `cdr'.
3633 "Return caption from ELEMENT as a secondary string.
3635 When optional argument SHORTP is non-nil, return short caption,
3636 as a secondary string, instead.
3638 Caption lines are separated by a white space."
3646 ;;;; For Derived Back-ends
3647 ;;
3648 ;; `org-export-with-backend' is a function allowing to locally use
3649 ;; another back-end to transcode some object or element. In a derived
3650 ;; back-end, it may be used as a fall-back function once all specific
3651 ;; cases have been treated.
3654 "Call a transcoder from BACKEND on DATA.
3655 BACKEND is an export back-end, as returned by, e.g.,
3656 `org-export-create-backend', or a symbol referring to
3657 a registered back-end. DATA is an Org element, object, secondary
3658 string or string. CONTENTS, when non-nil, is the transcoded
3659 contents of DATA element, as a string. INFO, when non-nil, is
3660 the communication channel used for export, as a plist."
3670 transcoder data contents
3673 :back-end backend
3674 :translate-alist all-transcoders
3678 ;;;; For Export Snippets
3679 ;;
3680 ;; Every export snippet is transmitted to the back-end. Though, the
3681 ;; latter will only retain one type of export-snippet, ignoring
3682 ;; others, based on the former's target back-end. The function
3683 ;; `org-export-snippet-backend' returns that back-end for a given
3684 ;; export-snippet.
3687 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3688 Translation, with `org-export-snippet-translation-alist', is
3689 applied."
3693 back-end))))
3696 ;;;; For Footnotes
3697 ;;
3698 ;; `org-export-collect-footnote-definitions' is a tool to list
3699 ;; actually used footnotes definitions in the whole parse tree, or in
3700 ;; a headline, in order to add footnote listings throughout the
3701 ;; transcoded data.
3702 ;;
3703 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3704 ;; back-ends, when they need to attach the footnote definition only to
3705 ;; the first occurrence of the corresponding label.
3706 ;;
3707 ;; `org-export-get-footnote-definition' and
3708 ;; `org-export-get-footnote-number' provide easier access to
3709 ;; additional information relative to a footnote reference.
3712 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3713 INFO is the plist used as a communication channel. If no such
3714 definition can be found, raise an error."
3720 hash))))
3728 info t)
3729 cache)
3734 "Apply FUNCTION on every footnote reference in DATA.
3735 INFO is a plist containing export state. By default, as soon as
3736 a new footnote reference is encountered, FUNCTION is called onto
3737 its definition. However, if BODY-FIRST is non-nil, this step is
3738 delayed until the end of the process."
3743 ;; Search footnote references through DATA, filling
3744 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3745 ;; store footnote definitions so they can be entered
3746 ;; later.
3753 ;; Search for subsequent references in footnote
3754 ;; definition so numbering follows reading
3755 ;; logic, unless DELAYP in non-nil.
3759 definitions))
3760 ;; Do not force entering inline definitions,
3761 ;; since `org-element-map' already traverses
3762 ;; them at the right time.
3766 nil))))))
3767 info nil
3768 ;; Don't enter footnote definitions since it will
3769 ;; happen when their first reference is found.
3770 ;; Moreover, if DELAYP is non-nil, make sure we
3771 ;; postpone entering definitions of inline references.
3778 "Return an alist between footnote numbers, labels and definitions.
3780 INFO is the current export state, as a plist.
3782 Definitions are collected throughout the whole parse tree, or
3783 DATA when non-nil.
3785 Sorting is done by order of references. As soon as a new
3786 reference is encountered, other references are searched within
3787 its definition. However, if BODY-FIRST is non-nil, this step is
3788 delayed after the whole tree is checked. This alters results
3789 when references are found in footnote definitions.
3791 Definitions either appear as Org data or as a secondary string
3792 for inlined footnotes. Unreferenced definitions are ignored."
3796 ;; Collect footnote number, label and definition.
3807 "Non-nil when a footnote reference is the first one for its label.
3809 FOOTNOTE-REFERENCE is the footnote reference being considered.
3810 INFO is a plist containing current export state.
3812 Search is done throughout the whole parse tree, or DATA when
3813 non-nil.
3815 By default, as soon as a new footnote reference is encountered,
3816 other references are searched within its definition. However, if
3817 BODY-FIRST is non-nil, this step is delayed after the whole tree
3818 is checked. This alters results when references are found in
3819 footnote definitions."
3821 ;; Anonymous footnotes are always a first reference.
3832 "Return number associated to a footnote.
3834 FOOTNOTE is either a footnote reference or a footnote definition.
3835 INFO is the plist containing export state.
3837 Number is unique throughout the whole parse tree, or DATA, when
3838 non-nil.
3840 By default, as soon as a new footnote reference is encountered,
3841 counting process moves into its definition. However, if
3842 BODY-FIRST is non-nil, this step is delayed until the end of the
3843 process, leading to a different order when footnotes are nested."
3852 ;; Anonymous footnote match: return number.
3854 ;; Labels match: return number.
3856 ;; Otherwise store label and increase counter if label
3857 ;; wasn't encountered yet.
3863 ;;;; For Headlines
3864 ;;
3865 ;; `org-export-get-relative-level' is a shortcut to get headline
3866 ;; level, relatively to the lower headline level in the parsed tree.
3867 ;;
3868 ;; `org-export-get-headline-number' returns the section number of an
3869 ;; headline, while `org-export-number-to-roman' allows to convert it
3870 ;; to roman numbers. With an optional argument,
3871 ;; `org-export-get-headline-number' returns a number to unnumbered
3872 ;; headlines (used for internal id).
3873 ;;
3874 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3875 ;; `org-export-last-sibling-p' are three useful predicates when it
3876 ;; comes to fulfill the `:headline-levels' property.
3877 ;;
3878 ;; `org-export-get-tags', `org-export-get-category' and
3879 ;; `org-export-get-node-property' extract useful information from an
3880 ;; headline or a parent headline. They all handle inheritance.
3881 ;;
3882 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3883 ;; as a secondary string, suitable for table of contents. It falls
3884 ;; back onto default title.
3887 "Return HEADLINE relative level within current parsed tree.
3888 INFO is a plist holding contextual information."
3893 "Non-nil when HEADLINE is considered as low level.
3895 INFO is a plist used as a communication channel.
3897 A low level headlines has a relative level greater than
3898 `:headline-levels' property value.
3900 Return value is the difference between HEADLINE relative level
3901 and the last level being considered as high enough, or nil."
3908 "Return numbered HEADLINE numbering as a list of numbers.
3909 INFO is a plist holding contextual information."
3914 "Return a non-nil value if HEADLINE element should be numbered.
3915 INFO is a plist used as a communication channel."
3924 "Convert integer N into a roman numeral."
3937 res)))
3940 "Return list of tags associated to ELEMENT.
3942 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3943 is a plist used as a communication channel.
3945 Select tags (see `org-export-select-tags') and exclude tags (see
3946 `org-export-exclude-tags') are removed from the list.
3948 When non-nil, optional argument TAGS should be a list of strings.
3949 Any tag belonging to this list will also be removed.
3951 When optional argument INHERITED is non-nil, tags can also be
3952 inherited from parent headlines and FILETAGS keywords."
3958 ;; Build complete list of inherited tags.
3965 ;; Add FILETAGS keywords and return results.
3969 "Return node PROPERTY value for BLOB.
3971 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3972 element or object.
3974 If optional argument INHERITED is non-nil, the value can be
3975 inherited from a parent headline.
3977 Return value is a string or nil."
3989 "Return category for element or object BLOB.
3991 INFO is a plist used as a communication channel.
3993 CATEGORY is automatically inherited from a parent headline, from
3994 #+CATEGORY: keyword or created out of original file name. If all
4007 "Return alternative title for HEADLINE, as a secondary string.
4008 If no optional title is defined, fall-back to the regular title."
4015 "Non-nil when BLOB is the first sibling in its parent.
4016 BLOB is an element or an object. If BLOB is a headline, non-nil
4017 means it is the first sibling in the sub-tree. INFO is a plist
4018 used as a communication channel."
4023 "Non-nil when BLOB is the last sibling in its parent.
4024 BLOB is an element or an object. INFO is a plist used as
4025 a communication channel."
4029 ;;;; For Keywords
4030 ;;
4031 ;; `org-export-get-date' returns a date appropriate for the document
4032 ;; to about to be exported. In particular, it takes care of
4033 ;; `org-export-date-timestamp-format'.
4036 "Return date value for the current document.
4038 INFO is a plist used as a communication channel. FMT, when
4039 non-nil, is a time format string that will be applied on the date
4040 if it consists in a single timestamp object. It defaults to
4041 `org-export-date-timestamp-format' when nil.
4043 A proper date can be a secondary string, a string or nil. It is
4044 meant to be translated with `org-export-data' or alike."
4055 ;;;; For Links
4056 ;;
4057 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4058 ;; with `org-add-link-type', which see.
4059 ;;
4060 ;; `org-export-get-coderef-format' returns an appropriate format
4061 ;; string for coderefs.
4062 ;;
4063 ;; `org-export-inline-image-p' returns a non-nil value when the link
4064 ;; provided should be considered as an inline image.
4065 ;;
4066 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4067 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4068 ;; returns an appropriate unique identifier.
4069 ;;
4070 ;; `org-export-resolve-id-link' returns the first headline with
4071 ;; specified id or custom-id in parse tree, the path to the external
4072 ;; file with the id.
4073 ;;
4074 ;; `org-export-resolve-coderef' associates a reference to a line
4075 ;; number in the element it belongs, or returns the reference itself
4076 ;; when the element isn't numbered.
4077 ;;
4078 ;; `org-export-file-uri' expands a filename as stored in :path value
4079 ;; of a "file" link into a file URI.
4080 ;;
4081 ;; Broken links raise a `org-link-broken' error, which is caught by
4082 ;; `org-export-data' for further processing, depending on
4083 ;; `org-export-with-broken-links' value.
4088 "Try exporting LINK with a dedicated function.
4090 DESC is its description, as a string, or nil. BACKEND is the
4091 back-end used for export, as a symbol.
4093 Return output as a string, or nil if no protocol handles LINK.
4095 A custom protocol has precedence over regular back-end export.
4096 The function ignores links with an implicit type (e.g.,
4105 desc
4106 backend))))))
4109 "Return format string for code reference link.
4110 PATH is the link path. DESC is its description."
4118 "Non-nil if LINK object points to an inline image.
4120 Optional argument is a set of RULES defining inline images. It
4121 is an alist where associations have the following shape:
4123 (TYPE . REGEXP)
4125 Applying a rule means apply REGEXP against LINK's path when its
4126 type is TYPE. The function will return a non-nil value if any of
4127 the provided rules is non-nil. The default rule is
4128 `org-export-default-inline-image-rule'.
4130 This only applies to links without a description."
4141 "Resolve a code reference REF.
4143 INFO is a plist used as a communication channel.
4145 Return associated line number in source code, or REF itself,
4146 depending on src-block or example element's switches. Throw an
4147 error if no block contains REF."
4154 org-coderef-label-format)))
4158 ;; Element containing REF is found. Resolve it to
4159 ;; either a label or a line number, as needed.
4170 "Return LINK destination.
4172 INFO is a plist holding contextual information.
4174 Return value can be an object or an element:
4176 - If LINK path matches a target object (i.e. <<path>>) return it.
4178 - If LINK path exactly matches the name affiliated keyword
4179 (i.e. #+NAME: path) of an element, return that element.
4181 - If LINK path exactly matches any headline name, return that
4182 element.
4184 - Otherwise, throw an error.
4187 significant."
4190 ;; Split PATH at white spaces so matches are space
4191 ;; insensitive.
4197 :resolve-fuzzy-link-cache
4204 path
4206 ;; First try to find a matching "<<path>>" unless user
4207 ;; specified he was looking for a headline (path starts with
4208 ;; a "*" character).
4214 path)
4215 datum))
4217 ;; Then try to find an element with a matching "#+NAME: path"
4218 ;; affiliated keyword.
4225 ;; Try to find a matching headline.
4232 path)
4233 h))
4236 link-cache)))))
4239 "Return headline referenced as LINK destination.
4241 INFO is a plist used as a communication channel.
4243 Return value can be the headline element matched in current parse
4247 ;; First check if id is within the current parse tree.
4252 headline))
4254 ;; Otherwise, look for external files.
4259 "Return radio-target object referenced as LINK destination.
4261 INFO is a plist used as a communication channel.
4263 Return value can be a radio-target object or nil. Assume LINK
4272 nil nil path nil nil t)
4273 t)
4274 radio))
4278 "Return file URI associated to FILENAME."
4285 ;;;; For References
4286 ;;
4287 ;; `org-export-get-reference' associate a unique reference for any
4288 ;; object or element.
4289 ;;
4290 ;; `org-export-get-ordinal' associates a sequence number to any object
4291 ;; or element.
4294 "Return a unique reference for DATUM, as a string.
4295 DATUM is either an element or an object. INFO is the current
4296 export state, as a plist. Returned reference consists of
4297 alphanumeric characters only."
4302 h))))
4310 cache))))
4313 "Return ordinal number of an element or object.
4315 ELEMENT is the element or object considered. INFO is the plist
4316 used as a communication channel.
4318 Optional argument TYPES, when non-nil, is a list of element or
4319 object types, as symbols, that should also be counted in.
4320 Otherwise, only provided element's type is considered.
4322 Optional argument PREDICATE is a function returning a non-nil
4323 value if the current element or object should be counted in. It
4324 accepts two arguments: the element or object being considered and
4325 the plist used as a communication channel. This allows to count
4326 only a certain type of objects (i.e. inline images).
4328 Return value is a list of numbers if ELEMENT is a headline or an
4329 item. It is nil for keywords. It represents the footnote number
4330 for footnote definitions and footnote references. If ELEMENT is
4331 a target, return the same value as if ELEMENT was the closest
4332 table, item or headline containing the target. In any other
4333 case, return the sequence number of ELEMENT among elements or
4334 objects of the same type."
4335 ;; Ordinal of a target object refer to the ordinal of the closest
4336 ;; table, item, or headline containing the object.
4340 element
4343 ;; Special case 1: A headline returns its number as a list.
4345 ;; Special case 2: An item returns its number as a list.
4349 struct
4356 ;; Increment counter until ELEMENT is found again.
4367 ;;;; For Src-Blocks
4368 ;;
4369 ;; `org-export-get-loc' counts number of code lines accumulated in
4370 ;; src-block or example-block elements with a "+n" switch until
4371 ;; a given element, excluded. Note: "-n" switches reset that count.
4372 ;;
4373 ;; `org-export-unravel-code' extracts source code (along with a code
4374 ;; references alist) from an `element-block' or `src-block' type
4375 ;; element.
4376 ;;
4377 ;; `org-export-format-code' applies a formatting function to each line
4378 ;; of code, providing relative line number and code reference when
4379 ;; appropriate. Since it doesn't access the original element from
4380 ;; which the source code is coming, it expects from the code calling
4381 ;; it to know if lines should be numbered and if code references
4382 ;; should appear.
4383 ;;
4384 ;; Eventually, `org-export-format-code-default' is a higher-level
4385 ;; function (it makes use of the two previous functions) which handles
4386 ;; line numbering and code references inclusion, and returns source
4387 ;; code in a format suitable for plain text or verbatim output.
4390 "Return accumulated lines of code up to ELEMENT.
4392 INFO is the plist used as a communication channel.
4394 ELEMENT is excluded from count."
4400 ;; ELEMENT is reached: Quit the loop.
4402 ;; Only count lines from src-block and example-block elements
4403 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4407 ;; Accumulate locs or reset them.
4411 ;; Return nil to stay in the loop.
4412 nil)))
4414 ;; Return value.
4415 loc))
4418 "Clean source code and extract references out of it.
4420 ELEMENT has either a `src-block' an `example-block' type.
4422 Return a cons cell whose CAR is the source code, cleaned from any
4423 reference, protective commas and spurious indentation, and CDR is
4424 an alist between relative line number (integer) and name of code
4425 reference on that line (string)."
4428 ;; Get code and clean it. Remove blank lines at its
4429 ;; beginning and end.
4436 value
4438 ;; Get format used for references.
4441 org-coderef-label-format)))
4442 ;; Build a regexp matching a loc with a reference.
4447 ;; Return value.
4449 ;; Code with references removed.
4455 ;; Ref line: remove ref, and signal its position in REFS.
4459 ;; Reference alist.
4460 refs)))
4463 "Format CODE by applying FUN line-wise and return it.
4465 CODE is a string representing the code to format. FUN is
4466 a function. It must accept three arguments: a line of
4467 code (string), the current line number (integer) or nil and the
4468 reference associated to the current line (string) or nil.
4470 Optional argument NUM-LINES can be an integer representing the
4471 number of code lines accumulated until the current code. Line
4472 numbers passed to FUN will take it into account. If it is nil,
4473 FUN's second argument will always be nil. This number can be
4474 obtained with `org-export-get-loc' function.
4476 Optional argument REF-ALIST can be an alist between relative line
4477 number (i.e. ignoring NUM-LINES) and the name of the code
4478 reference on it. If it is nil, FUN's third argument will always
4479 be nil. It can be obtained through the use of
4480 `org-export-unravel-code' function."
4492 "Return source code from ELEMENT, formatted in a standard way.
4494 ELEMENT is either a `src-block' or `example-block' element. INFO
4495 is a plist used as a communication channel.
4497 This function takes care of line numbering and code references
4498 inclusion. Line numbers, when applicable, appear at the
4499 beginning of the line, separated from the code by two white
4500 spaces. Code references, on the other hand, appear flushed to
4501 the right, separated by six white spaces from the widest line of
4502 code."
4503 ;; Extract code and references.
4510 ;; Handle line numbering.
4519 ;; Prepare references display, if required. Any reference
4520 ;; should start six columns after the widest line of code,
4521 ;; wrapped with parenthesis.
4526 code
4530 number-str
4531 loc
4537 num-start refs)))))
4540 ;;;; For Tables
4541 ;;
4542 ;; `org-export-table-has-special-column-p' and and
4543 ;; `org-export-table-row-is-special-p' are predicates used to look for
4544 ;; meta-information about the table structure.
4545 ;;
4546 ;; `org-table-has-header-p' tells when the rows before the first rule
4547 ;; should be considered as table's header.
4548 ;;
4549 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4550 ;; and `org-export-table-cell-borders' extract information from
4551 ;; a table-cell element.
4552 ;;
4553 ;; `org-export-table-dimensions' gives the number on rows and columns
4554 ;; in the table, ignoring horizontal rules and special columns.
4555 ;; `org-export-table-cell-address', given a table-cell object, returns
4556 ;; the absolute address of a cell. On the other hand,
4557 ;; `org-export-get-table-cell-at' does the contrary.
4558 ;;
4559 ;; `org-export-table-cell-starts-colgroup-p',
4560 ;; `org-export-table-cell-ends-colgroup-p',
4561 ;; `org-export-table-row-starts-rowgroup-p',
4562 ;; `org-export-table-row-ends-rowgroup-p',
4563 ;; `org-export-table-row-starts-header-p',
4564 ;; `org-export-table-row-ends-header-p' and
4565 ;; `org-export-table-row-in-header-p' indicate position of current row
4566 ;; or cell within the table.
4569 "Non-nil when TABLE has a special column.
4570 All special columns will be ignored during export."
4571 ;; The table has a special column when every first cell of every row
4572 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4573 ;; "*" "_" and "^". Though, do not consider a first row containing
4574 ;; only empty cells as special.
4588 "Non-nil when TABLE has a header.
4590 INFO is a plist used as a communication channel.
4592 A table has a header when it contains at least two row groups."
4601 table
4612 cache)))))
4615 "Non-nil if TABLE-ROW is considered special.
4616 All special rows will be ignored during export."
4620 ;; A row is special either when...
4622 ;; ... it starts with a field only containing "/",
4624 ;; ... the table contains a special column and the row start
4625 ;; with a marking character among, "^", "_", "$" or "!",
4629 ;; ... it contains only alignment cookies and empty cells.
4634 ;; Since VALUE is a secondary string, the following
4635 ;; checks avoid expanding it with `org-export-data'.
4646 "Return TABLE-ROW's group number, as an integer.
4648 INFO is a plist used as the communication channel.
4650 Return value is the group number, as an integer, or nil for
4651 special rows and rows separators. First group is also table's
4652 header."
4670 "Return TABLE-CELL contents width.
4672 INFO is a plist used as the communication channel.
4674 Return value is the width given by the last width cookie in the
4675 same column as TABLE-CELL, or nil."
4694 ;; In a special row, try to find a width cookie at COLUMN.
4698 ;; The following checks avoid expanding unnecessarily
4699 ;; the cell with `org-export-data'.
4709 "Return TABLE-CELL contents alignment.
4711 INFO is a plist used as the communication channel.
4713 Return alignment as specified by the last alignment cookie in the
4714 same column as TABLE-CELL. If no such cookie is found, a default
4715 alignment value will be deduced from fraction of numbers in the
4716 column (see `org-table-number-fraction' for more information).
4717 Possible values are `left', `right' and `center'."
4718 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4735 cookie-align
4736 previous-cell-number-p)
4739 ;; In a special row, try to find an alignment cookie at
4740 ;; COLUMN.
4744 ;; Since VALUE is a secondary string, the following
4745 ;; checks avoid useless expansion through
4746 ;; `org-export-data'.
4754 ;; Ignore table rules.
4756 ;; In a standard row, check if cell's contents are
4757 ;; expressing some kind of number. Increase NUMBER-CELLS
4758 ;; accordingly. Though, don't bother if an alignment
4759 ;; cookie has already defined cell's alignment.
4764 info)))
4766 ;; Treat an empty cell as a number if it follows
4767 ;; a number.
4773 ;; Return value. Alignment specified by cookies has
4774 ;; precedence over alignment deduced from cell's contents.
4776 column
4781 org-table-number-fraction)
4786 "Return TABLE-CELL borders.
4788 INFO is a plist used as a communication channel.
4790 Return value is a list of symbols, or nil. Possible values are:
4791 `top', `bottom', `above', `below', `left' and `right'. Note:
4792 `top' (resp. `bottom') only happen for a cell in the first
4793 row (resp. last row) of the table, ignoring table rules, if any.
4795 Returned borders ignore special rows."
4798 borders)
4799 ;; Top/above border? TABLE-CELL has a border above when a rule
4800 ;; used to demarcate row groups can be found above. Hence,
4801 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4802 ;; another regular row has to be found above that rule.
4805 ;; Look at every row before the current one.
4812 ;; No rule above, or rule found starts the table (ignoring any
4813 ;; special row): TABLE-CELL is at the top of the table.
4816 ;; Bottom/below border? TABLE-CELL has a border below when next
4817 ;; non-regular row below is a rule.
4820 ;; Look at every row after the current one.
4827 ;; No rule below, or rule found ends the table (modulo some
4828 ;; special row): TABLE-CELL is at the bottom of the table.
4831 ;; Right/left borders? They can only be specified by column
4832 ;; groups. Column groups are defined in a row starting with "/".
4833 ;; Also a column groups row only contains "<", "<>", ">" or blank
4834 ;; cells.
4838 ;; Table rows are read in reverse order so last column groups
4839 ;; row has precedence over any previous one.
4852 ;; There's a left border when previous cell, if
4853 ;; any, ends a group, or current one starts one.
4859 ;; There's a right border when next cell, if any,
4860 ;; starts a group, or current one ends one.
4867 ;; Return value.
4868 borders))
4871 "Non-nil when TABLE-CELL is at the beginning of a column group.
4872 INFO is a plist used as a communication channel."
4873 ;; A cell starts a column group either when it is at the beginning
4874 ;; of a row (or after the special column, if any) or when it has
4875 ;; a left border.
4878 table-cell)
4882 "Non-nil when TABLE-CELL is at the end of a column group.
4883 INFO is a plist used as a communication channel."
4884 ;; A cell ends a column group either when it is at the end of a row
4885 ;; or when it has a right border.
4888 table-cell)
4892 "Non-nil when TABLE-ROW is at the beginning of a row group.
4893 INFO is a plist used as a communication channel."
4901 "Non-nil when TABLE-ROW is at the end of a row group.
4902 INFO is a plist used as a communication channel."
4910 "Non-nil when TABLE-ROW is located within table's header.
4911 INFO is a plist used as a communication channel. Always return
4912 nil for special rows and rows separators."
4918 "Non-nil when TABLE-ROW is the first table header's row.
4919 INFO is a plist used as a communication channel."
4924 "Non-nil when TABLE-ROW is the last table header's row.
4925 INFO is a plist used as a communication channel."
4930 "Return TABLE-ROW number.
4931 INFO is a plist used as a communication channel. Return value is
4932 zero-based and ignores separators. The function returns nil for
4933 special columns and separators."
4945 "Return TABLE dimensions.
4947 INFO is a plist used as a communication channel.
4949 Return value is a CONS like (ROWS . COLUMNS) where
4950 ROWS (resp. COLUMNS) is the number of exportable
4951 rows (resp. columns)."
4953 ;; Set number of rows, and extract first one.
4959 ;; Set number of columns.
4961 ;; Return value.
4965 "Return address of a regular TABLE-CELL object.
4967 TABLE-CELL is the cell considered. INFO is a plist used as
4968 a communication channel.
4970 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4971 zero-based index. Only exportable cells are considered. The
4972 function returns nil for other cells."
4984 "Return regular table-cell object at ADDRESS in TABLE.
4986 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4987 zero-based index. TABLE is a table type element. INFO is
4988 a plist used as a communication channel.
4990 If no table-cell, among exportable cells, is found at ADDRESS,
4991 return nil."
4994 ;; Row at (car address) or nil.
5002 'table-cell
5009 ;;;; For Tables Of Contents
5010 ;;
5011 ;; `org-export-collect-headlines' builds a list of all exportable
5012 ;; headline elements, maybe limited to a certain depth. One can then
5013 ;; easily parse it and transcode it.
5014 ;;
5015 ;; Building lists of tables, figures or listings is quite similar.
5016 ;; Once the generic function `org-export-collect-elements' is defined,
5017 ;; `org-export-collect-tables', `org-export-collect-figures' and
5018 ;; `org-export-collect-listings' can be derived from it.
5021 "Collect headlines in order to build a table of contents.
5023 INFO is a plist used as a communication channel.
5025 When optional argument N is an integer, it specifies the depth of
5026 the table of contents. Otherwise, it is set to the value of the
5027 last headline level. See `org-export-headline-levels' for more
5028 information.
5030 Optional argument SCOPE, when non-nil, is an element. If it is
5031 a headline, only children of SCOPE are collected. Otherwise,
5032 collect children of the headline containing provided element. If
5033 there is no such headline, collect all headlines. In any case,
5034 argument N becomes relative to the level of that headline.
5036 Return a list of all exportable headlines as parsed elements.
5037 Footnote sections are ignored."
5046 limit))))
5052 info)))
5055 "Collect referenceable elements of a determined type.
5057 TYPE can be a symbol or a list of symbols specifying element
5058 types to search. Only elements with a caption are collected.
5060 INFO is a plist used as a communication channel.
5062 When non-nil, optional argument PREDICATE is a function accepting
5063 one argument, an element of type TYPE. It returns a non-nil
5064 value when that element should be collected.
5066 Return a list of all elements found, in order of appearance."
5071 element))
5072 info))
5075 "Build a list of tables.
5076 INFO is a plist used as a communication channel.
5078 Return a list of table elements with a caption."
5082 "Build a list of figures.
5084 INFO is a plist used as a communication channel. PREDICATE is
5085 a function which accepts one argument: a paragraph element and
5086 whose return value is non-nil when that element should be
5087 collected.
5089 A figure is a paragraph type element, with a caption, verifying
5091 a vague concept that may depend on back-end.
5093 Return a list of elements recognized as figures."
5097 "Build a list of src blocks.
5099 INFO is a plist used as a communication channel.
5101 Return a list of src-block elements with a caption."
5105 ;;;; Smart Quotes
5106 ;;
5107 ;; The main function for the smart quotes sub-system is
5108 ;; `org-export-activate-smart-quotes', which replaces every quote in
5109 ;; a given string from the parse tree with its "smart" counterpart.
5110 ;;
5111 ;; Dictionary for smart quotes is stored in
5112 ;; `org-export-smart-quotes-alist'.
5116 ;; one may use: »...«, "...", ›...‹, or '...'.
5117 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5118 ;; LaTeX quotes require Babel!
5168 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5179 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5190 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5201 ;; 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
5202 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5213 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5219 "Smart quotes translations.
5221 Alist whose CAR is a language string and CDR is an alist with
5222 quote type as key and a plist associating various encodings to
5223 their translation as value.
5225 A quote type can be any symbol among `primary-opening',
5226 `primary-closing', `secondary-opening', `secondary-closing' and
5227 `apostrophe'.
5229 Valid encodings include `:utf-8', `:html', `:latex' and
5230 `:texinfo'.
5235 "Return smart quote status at the beginning of string S.
5236 INFO is the current export state, as a plist."
5241 table)))
5254 ;; Not already in a level 1 quote: this is an
5255 ;; apostrophe.
5257 ;; Extract previous char and next char. As
5258 ;; a special case, they can also be set to `blank',
5259 ;; `no-blank' or nil. Then determine if current
5260 ;; match is allowed as an opening quote or a closing
5261 ;; quote.
5266 text info)))
5283 previous)
5294 next)
5301 current-status)
5305 info nil org-element-recursive-objects)
5312 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5313 `:utf-8'. INFO is a plist used as a communication channel.
5315 The function has to retrieve information about string
5316 surroundings in parse tree. It can only happen with an
5317 unmodified string. Thus, if S has already been through another
5318 process, a non-nil ORIGINAL optional argument will provide that
5319 original string.
5321 Return the new string."
5330 org-export-smart-quotes-alist))))
5331 encoding)
5332 match))
5333 s nil t)))
5335 ;;;; Topology
5336 ;;
5337 ;; Here are various functions to retrieve information about the
5338 ;; neighborhood of a given element or object. Neighbors of interest
5339 ;; are direct parent (`org-export-get-parent'), parent headline
5340 ;; (`org-export-get-parent-headline'), first element containing an
5341 ;; object, (`org-export-get-parent-element'), parent table
5342 ;; (`org-export-get-parent-table'), previous element or object
5343 ;; (`org-export-get-previous-element') and next element or object
5344 ;; (`org-export-get-next-element').
5346 ;; defsubst org-export-get-parent must be defined before first use
5352 "Return BLOB parent headline or nil.
5353 BLOB is the element or object being considered."
5357 "Return first element containing OBJECT or nil.
5358 OBJECT is the object to consider."
5362 "Return OBJECT parent table or nil.
5363 OBJECT is either a `table-cell' or `table-element' type object."
5367 "Return previous element or object.
5369 BLOB is an element or object. INFO is a plist used as
5370 a communication channel. Return previous exportable element or
5371 object, a string, or nil.
5373 When optional argument N is a positive integer, return a list
5374 containing up to N siblings before BLOB, from farthest to
5375 closest. With any other non-nil value, return a list containing
5376 all of them."
5382 prev)
5392 "Return next element or object.
5394 BLOB is an element or object. INFO is a plist used as
5395 a communication channel. Return next exportable element or
5396 object, a string, or nil.
5398 When optional argument N is a positive integer, return a list
5399 containing up to N siblings after BLOB, from closest to farthest.
5400 With any other non-nil value, return a list containing all of
5401 them."
5408 next)
5418 ;;;; Translation
5419 ;;
5420 ;; `org-export-translate' translates a string according to the language
5421 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5422 ;; the dictionary used for the translation.
5454 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5464 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5470 ("ru" :html "(Продолжение следует)"
5544 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5567 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5573 ("ru" :html "Список распечаток"
5587 ("ru" :html "Список таблиц"
5693 ("ru" :html "Неизвестная ссылка"
5696 "Dictionary for export engine.
5698 Alist whose car is the string to translate and cdr is an alist
5699 whose car is the language string and cdr is a plist whose
5700 properties are possible charsets and values translated terms.
5702 It is used as a database for `org-export-translate'. Since this
5703 function returns the string as-is if no translation was found,
5704 the variable only needs to record values different from the
5708 "Translate string S according to language specification.
5710 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5711 and `:utf-8'. INFO is a plist used as a communication channel.
5713 Translation depends on `:language' property. Return the
5714 translated string. If no translation is found, try to fall back
5715 to `:default' encoding. If it fails, return S."
5721 s)))
5724 \f
5725 ;;; Asynchronous Export
5726 ;;
5727 ;; `org-export-async-start' is the entry point for asynchronous
5728 ;; export. It recreates current buffer (including visibility,
5729 ;; narrowing and visited file) in an external Emacs process, and
5730 ;; evaluates a command there. It then applies a function on the
5731 ;; returned results in the current process.
5732 ;;
5733 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5734 ;; allow to export to a buffer or a file, asynchronously or not.
5735 ;;
5736 ;; `org-export-output-file-name' is an auxiliary function meant to be
5737 ;; used with `org-export-to-file'. With a given extension, it tries
5738 ;; to provide a canonical file name to write export output to.
5739 ;;
5740 ;; Asynchronously generated results are never displayed directly.
5741 ;; Instead, they are stored in `org-export-stack-contents'. They can
5742 ;; then be retrieved by calling `org-export-stack'.
5743 ;;
5744 ;; Export Stack is viewed through a dedicated major mode
5745 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5746 ;;`org-export-stack-delete', `org-export-stack-view' and
5747 ;;`org-export-stack-clear'.
5748 ;;
5749 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5750 ;; It should be used whenever `org-export-async-start' is called.
5753 "Call function FUN on the results returned by BODY evaluation.
5755 FUN is an anonymous function of one argument. BODY evaluation
5756 happens in an asynchronous process, from a buffer which is an
5757 exact copy of the current one.
5759 Use `org-export-add-to-stack' in FUN in order to register results
5760 in the stack.
5762 This is a low level function. See also `org-export-to-buffer'
5763 and `org-export-to-file' for more specialized functions."
5766 ;; Write the full sexp evaluating BODY in a copy of the current
5767 ;; buffer to a temporary file, as it may be too long for program
5768 ;; args in `start-process'.
5775 ;; Null characters (from variable values) are inserted
5776 ;; within the file. As a consequence, coding system for
5777 ;; buffer contents will not be recognized properly. So,
5778 ;; we make sure it is the same as the one used to display
5779 ;; the original buffer.
5781 ,coding
5784 ;; Ignore `kill-emacs-hook' and code evaluation
5785 ;; queries from Babel as we need a truly
5786 ;; non-interactive process.
5788 org-babel-confirm-evaluate-answer-no t)
5789 ;; Initialize export framework.
5791 ;; Re-create current buffer there.
5794 ;; Sexp to evaluate in the buffer.
5796 ;; Start external process.
5799 (,process
5801 #'start-process
5804 ,proc-buffer
5811 ;; Register running process in stack.
5813 ;; Set-up sentinel in order to catch results.
5816 ,process
5838 ;;;###autoload
5841 &optional async subtreep visible-only body-only ext-plist
5842 post-process)
5843 "Call `org-export-as' with output to a specified buffer.
5845 BACKEND is either an export back-end, as returned by, e.g.,
5846 `org-export-create-backend', or a symbol referring to
5847 a registered back-end.
5849 BUFFER is the name of the output buffer. If it already exists,
5850 it will be erased first, otherwise, it will be created.
5852 A non-nil optional argument ASYNC means the process should happen
5853 asynchronously. The resulting buffer should then be accessible
5854 through the `org-export-stack' interface. When ASYNC is nil, the
5855 buffer is displayed if `org-export-show-temporary-export-buffer'
5856 is non-nil.
5858 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5859 EXT-PLIST are similar to those used in `org-export-as', which
5860 see.
5862 Optional argument POST-PROCESS is a function which should accept
5863 no argument. It is always called within the current process,
5864 from BUFFER, with point at its beginning. Export back-ends can
5865 use it to set a major mode there, e.g,
5867 (defun org-latex-export-as-latex
5868 (&optional async subtreep visible-only body-only ext-plist)
5869 (interactive)
5871 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5873 This function returns BUFFER."
5901 buffer)))
5903 ;;;###autoload
5906 post-process)
5907 "Call `org-export-as' with output to a specified file.
5909 BACKEND is either an export back-end, as returned by, e.g.,
5910 `org-export-create-backend', or a symbol referring to
5911 a registered back-end. FILE is the name of the output file, as
5912 a string.
5914 A non-nil optional argument ASYNC means the process should happen
5915 asynchronously. The resulting buffer will then be accessible
5916 through the `org-export-stack' interface.
5918 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5919 EXT-PLIST are similar to those used in `org-export-as', which
5920 see.
5922 Optional argument POST-PROCESS is called with FILE as its
5923 argument and happens asynchronously when ASYNC is non-nil. It
5924 has to return a file name, or nil. Export back-ends can use this
5925 to send the output file through additional processing, e.g,
5927 (defun org-latex-export-to-latex
5928 (&optional async subtreep visible-only body-only ext-plist)
5929 (interactive)
5932 async subtreep visible-only body-only ext-plist
5933 (lambda (file) (org-latex-compile file)))
5935 The function returns either a file name returned by POST-PROCESS,
5936 or FILE."
5955 backend subtreep visible-only body-only ext-plist)))
5962 ;; Get proper return value.
5964 file))))))
5967 "Return output file's name according to buffer specifications.
5969 EXTENSION is a string representing the output file extension,
5970 with the leading dot.
5972 With a non-nil optional argument SUBTREEP, try to determine
5974 of subtree at point.
5976 When optional argument PUB-DIR is set, use it as the publishing
5977 directory.
5979 Return file name as a string."
5982 ;; File name may come from EXPORT_FILE_NAME subtree
5983 ;; property.
5986 ;; File name may be extracted from buffer's associated
5987 ;; file, if any.
5989 ;; Can't determine file name on our own: Ask user.
5991 "Output file: " pub-dir nil nil nil
5995 ;; Build file name. Enforce EXTENSION over whatever user
5996 ;; may have come up with. PUB-DIR, if defined, always has
5997 ;; precedence over any provided path.
6002 extension))
6005 ;; If writing to OUTPUT-FILE would overwrite original file, append
6006 ;; EXTENSION another time to final name.
6009 output-file)))
6012 "Add a new result to export stack if not present already.
6014 SOURCE is a buffer or a file name containing export results.
6015 BACKEND is a symbol representing export back-end used to generate
6016 it.
6018 Entries already pointing to SOURCE and unavailable entries are
6019 removed beforehand. Return the new stack."
6025 "Menu for asynchronous export results and running processes."
6035 "Return source from export results at point in stack."
6042 source
6043 ;; SOURCE is not consistent with current line. The stack
6044 ;; view is outdated.
6048 "Remove all entries from export stack."
6053 "Refresh the asynchronous export stack.
6054 Unavailable sources are removed from the list. Return the new
6055 stack."
6064 ;; Back-end.
6066 ;; Age.
6069 ;; Compute age of the results.
6071 "%4h:%.2m "
6073 ;; Source.
6078 ;; Clear stack from exited processes, dead buffers or
6079 ;; non-existent files.
6091 "Remove export results at point from stack.
6092 If optional argument SOURCE is non-nil, remove it instead."
6097 org-export-stack-contents))))
6100 "View export results at point in stack.
6101 With an optional prefix argument IN-EMACS, force viewing files
6102 within Emacs."
6116 (define-key km "p" 'previous-line)
6117 (define-key km "\C-p" 'previous-line)
6118 (define-key km "\C-?" 'previous-line)
6119 (define-key km [up] 'previous-line)
6120 (define-key km "C" 'org-export-stack-clear)
6121 (define-key km "v" 'org-export-stack-view)
6122 (define-key km (kbd "RET") 'org-export-stack-view)
6123 (define-key km "d" 'org-export-stack-remove)
6124 km)
6125 "Keymap for Org Export Stack.")
6127 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6128 "Mode for displaying asynchronous export stack.
6131 stack.
6133 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6134 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6135 stack completely.
6137 Removing entries in an Org Export Stack buffer doesn't affect
6138 files or buffers, only the display.
6141 (abbrev-mode 0)
6142 (auto-fill-mode 0)
6143 (setq buffer-read-only t
6144 buffer-undo-list t
6145 truncate-lines t
6146 header-line-format
6147 '(:eval
6148 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6149 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6150 (setq-local revert-buffer-function
6151 'org-export-stack-refresh))
6154 \f
6155 ;;; The Dispatcher
6156 ;;
6157 ;; `org-export-dispatch' is the standard interactive way to start an
6158 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6159 ;; for its interface, which, in turn, delegates response to key
6160 ;; pressed to `org-export--dispatch-action'.
6162 ;;;###autoload
6163 (defun org-export-dispatch (&optional arg)
6164 "Export dispatcher for Org mode.
6166 It provides an access to common export related tasks in a buffer.
6167 Its interface comes in two flavors: standard and expert.
6169 While both share the same set of bindings, only the former
6170 displays the valid keys associations in a dedicated buffer.
6171 Scrolling (resp. line-wise motion) in this buffer is done with
6172 SPC and DEL (resp. C-n and C-p) keys.
6174 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6175 flavor or the other.
6178 of options used back then, on the current buffer.
6180 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6181 (interactive "P")
6182 (let* ((input
6183 (cond ((equal arg '(16)) '(stack))
6184 ((and arg org-export-dispatch-last-action))
6185 (t (save-window-excursion
6186 (unwind-protect
6187 (progn
6188 ;; Remember where we are
6189 (move-marker org-export-dispatch-last-position
6190 (point)
6191 (org-base-buffer (current-buffer)))
6192 ;; Get and store an export command
6193 (setq org-export-dispatch-last-action
6194 (org-export--dispatch-ui
6195 (list org-export-initial-scope
6196 (and org-export-in-background 'async))
6197 nil
6198 org-export-dispatch-use-expert-ui)))
6199 (and (get-buffer "*Org Export Dispatcher*")
6200 (kill-buffer "*Org Export Dispatcher*")))))))
6201 (action (car input))
6202 (optns (cdr input)))
6203 (unless (memq 'subtree optns)
6204 (move-marker org-export-dispatch-last-position nil))
6205 (cl-case action
6206 ;; First handle special hard-coded actions.
6207 (template (org-export-insert-default-template nil optns))
6208 (stack (org-export-stack))
6209 (publish-current-file
6210 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6211 (publish-current-project
6212 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6213 (publish-choose-project
6214 (org-publish (assoc (org-icompleting-read
6215 "Publish project: "
6216 org-publish-project-alist nil t)
6217 org-publish-project-alist)
6218 (memq 'force optns)
6219 (memq 'async optns)))
6220 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6221 (otherwise
6222 (save-excursion
6223 (when arg
6224 ;; Repeating command, maybe move cursor to restore subtree
6225 ;; context.
6226 (if (eq (marker-buffer org-export-dispatch-last-position)
6227 (org-base-buffer (current-buffer)))
6228 (goto-char org-export-dispatch-last-position)
6229 ;; We are in a different buffer, forget position.
6230 (move-marker org-export-dispatch-last-position nil)))
6231 (funcall action
6232 ;; Return a symbol instead of a list to ease
6233 ;; asynchronous export macro use.
6234 (and (memq 'async optns) t)
6235 (and (memq 'subtree optns) t)
6236 (and (memq 'visible optns) t)
6237 (and (memq 'body optns) t)))))))
6239 (defun org-export--dispatch-ui (options first-key expertp)
6240 "Handle interface for `org-export-dispatch'.
6242 OPTIONS is a list containing current interactive options set for
6243 export. It can contain any of the following symbols:
6244 `body' toggles a body-only export
6245 `subtree' restricts export to current subtree
6246 `visible' restricts export to visible part of buffer.
6247 `force' force publishing files.
6248 `async' use asynchronous export process
6250 FIRST-KEY is the key pressed to select the first level menu. It
6251 is nil when this menu hasn't been selected yet.
6253 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6254 buffer is provided, but indications about currently active
6255 options are given in the prompt. Moreover, [?] allows to switch
6256 back to standard interface."
6257 (let* ((fontify-key
6258 (lambda (key &optional access-key)
6259 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6260 ;; non-nil is the required first-level key to activate
6261 ;; KEY. When its value is t, activate KEY independently
6262 ;; on the first key, if any. A nil value means KEY will
6263 ;; only be activated at first level.
6264 (if (or (eq access-key t) (eq access-key first-key))
6265 (org-propertize key 'face 'org-warning)
6266 key)))
6267 (fontify-value
6268 (lambda (value)
6269 ;; Fontify VALUE string.
6270 (org-propertize value 'face 'font-lock-variable-name-face)))
6271 ;; Prepare menu entries by extracting them from registered
6272 ;; back-ends and sorting them by access key and by ordinal,
6273 ;; if any.
6274 (entries
6275 (sort (sort (delq nil
6276 (mapcar #'org-export-backend-menu
6277 org-export-registered-backends))
6278 (lambda (a b)
6279 (let ((key-a (nth 1 a))
6280 (key-b (nth 1 b)))
6281 (cond ((and (numberp key-a) (numberp key-b))
6282 (< key-a key-b))
6283 ((numberp key-b) t)))))
6284 'car-less-than-car))
6285 ;; Compute a list of allowed keys based on the first key
6286 ;; pressed, if any. Some keys
6287 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6288 ;; available.
6289 (allowed-keys
6290 (nconc (list 2 22 19 6 1)
6291 (if (not first-key) (org-uniquify (mapcar 'car entries))
6292 (let (sub-menu)
6293 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6294 (when (eq (car entry) first-key)
6295 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6296 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6297 ((not first-key) (list ?P)))
6298 (list ?& ?#)
6299 (when expertp (list ??))
6300 (list ?q)))
6301 ;; Build the help menu for standard UI.
6302 (help
6303 (unless expertp
6304 (concat
6305 ;; Options are hard-coded.
6306 (format "[%s] Body only: %s [%s] Visible only: %s
6307 \[%s] Export scope: %s [%s] Force publishing: %s
6309 (funcall fontify-key "C-b" t)
6310 (funcall fontify-value
6311 (if (memq 'body options) "On " "Off"))
6312 (funcall fontify-key "C-v" t)
6313 (funcall fontify-value
6314 (if (memq 'visible options) "On " "Off"))
6315 (funcall fontify-key "C-s" t)
6316 (funcall fontify-value
6317 (if (memq 'subtree options) "Subtree" "Buffer "))
6318 (funcall fontify-key "C-f" t)
6319 (funcall fontify-value
6320 (if (memq 'force options) "On " "Off"))
6321 (funcall fontify-key "C-a" t)
6322 (funcall fontify-value
6323 (if (memq 'async options) "On " "Off")))
6324 ;; Display registered back-end entries. When a key
6325 ;; appears for the second time, do not create another
6326 ;; entry, but append its sub-menu to existing menu.
6327 (let (last-key)
6328 (mapconcat
6329 (lambda (entry)
6330 (let ((top-key (car entry)))
6331 (concat
6332 (unless (eq top-key last-key)
6333 (setq last-key top-key)
6335 (funcall fontify-key (char-to-string top-key))
6336 (nth 1 entry)))
6337 (let ((sub-menu (nth 2 entry)))
6338 (unless (functionp sub-menu)
6339 ;; Split sub-menu into two columns.
6340 (let ((index -1))
6341 (concat
6342 (mapconcat
6343 (lambda (sub-entry)
6344 (cl-incf index)
6345 (format
6346 (if (zerop (mod index 2)) " [%s] %-26s"
6348 (funcall fontify-key
6349 (char-to-string (car sub-entry))
6350 top-key)
6351 (nth 1 sub-entry)))
6352 sub-menu "")
6354 entries ""))
6355 ;; Publishing menu is hard-coded.
6357 [%s] Current file [%s] Current project
6359 (funcall fontify-key "P")
6360 (funcall fontify-key "f" ?P)
6361 (funcall fontify-key "p" ?P)
6362 (funcall fontify-key "x" ?P)
6363 (funcall fontify-key "a" ?P))
6365 (funcall fontify-key "&" t)
6366 (funcall fontify-key "#" t))
6367 (format "[%s] %s"
6368 (funcall fontify-key "q" t)
6369 (if first-key "Main menu" "Exit")))))
6370 ;; Build prompts for both standard and expert UI.
6371 (standard-prompt (unless expertp "Export command: "))
6372 (expert-prompt
6373 (when expertp
6374 (format
6375 "Export command (C-%s%s%s%s%s) [%s]: "
6376 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6377 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6378 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6379 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6380 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6381 (mapconcat (lambda (k)
6382 ;; Strip control characters.
6383 (unless (< k 27) (char-to-string k)))
6384 allowed-keys "")))))
6385 ;; With expert UI, just read key with a fancy prompt. In standard
6386 ;; UI, display an intrusive help buffer.
6387 (if expertp
6388 (org-export--dispatch-action
6389 expert-prompt allowed-keys entries options first-key expertp)
6390 ;; At first call, create frame layout in order to display menu.
6391 (unless (get-buffer "*Org Export Dispatcher*")
6392 (delete-other-windows)
6393 (org-switch-to-buffer-other-window
6394 (get-buffer-create "*Org Export Dispatcher*"))
6395 (setq cursor-type nil
6396 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6397 ;; Make sure that invisible cursor will not highlight square
6398 ;; brackets.
6399 (set-syntax-table (copy-syntax-table))
6400 (modify-syntax-entry ?\[ "w"))
6401 ;; At this point, the buffer containing the menu exists and is
6402 ;; visible in the current window. So, refresh it.
6403 (with-current-buffer "*Org Export Dispatcher*"
6404 ;; Refresh help. Maintain display continuity by re-visiting
6405 ;; previous window position.
6406 (let ((pos (window-start)))
6407 (erase-buffer)
6408 (insert help)
6409 (set-window-start nil pos)))
6410 (org-fit-window-to-buffer)
6411 (org-export--dispatch-action
6412 standard-prompt allowed-keys entries options first-key expertp))))
6414 (defun org-export--dispatch-action
6415 (prompt allowed-keys entries options first-key expertp)
6416 "Read a character from command input and act accordingly.
6418 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6419 a list of characters available at a given step in the process.
6420 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6421 EXPERTP are the same as defined in `org-export--dispatch-ui',
6422 which see.
6424 Toggle export options when required. Otherwise, return value is
6425 a list with action as CAR and a list of interactive export
6426 options as CDR."
6427 (let (key)
6428 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6429 ;; C-p, SPC, DEL).
6430 (while (and (setq key (read-char-exclusive prompt))
6431 (not expertp)
6432 (memq key '(14 16 ?\s ?\d)))
6433 (cl-case key
6434 (14 (if (not (pos-visible-in-window-p (point-max)))
6435 (ignore-errors (scroll-up 1))
6436 (message "End of buffer")
6437 (sit-for 1)))
6438 (16 (if (not (pos-visible-in-window-p (point-min)))
6439 (ignore-errors (scroll-down 1))
6440 (message "Beginning of buffer")
6441 (sit-for 1)))
6442 (?\s (if (not (pos-visible-in-window-p (point-max)))
6443 (scroll-up nil)
6444 (message "End of buffer")
6445 (sit-for 1)))
6446 (?\d (if (not (pos-visible-in-window-p (point-min)))
6447 (scroll-down nil)
6448 (message "Beginning of buffer")
6449 (sit-for 1)))))
6450 (cond
6451 ;; Ignore undefined associations.
6452 ((not (memq key allowed-keys))
6453 (ding)
6454 (unless expertp (message "Invalid key") (sit-for 1))
6455 (org-export--dispatch-ui options first-key expertp))
6456 ;; q key at first level aborts export. At second level, cancel
6457 ;; first key instead.
6458 ((eq key ?q) (if (not first-key) (error "Export aborted")
6459 (org-export--dispatch-ui options nil expertp)))
6460 ;; Help key: Switch back to standard interface if expert UI was
6461 ;; active.
6462 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6463 ;; Send request for template insertion along with export scope.
6464 ((eq key ?#) (cons 'template (memq 'subtree options)))
6465 ;; Switch to asynchronous export stack.
6466 ((eq key ?&) '(stack))
6467 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6468 ((memq key '(2 22 19 6 1))
6469 (org-export--dispatch-ui
6470 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6471 (6 'force) (1 'async))))
6472 (if (memq option options) (remq option options)
6473 (cons option options)))
6474 first-key expertp))
6475 ;; Action selected: Send key and options back to
6476 ;; `org-export-dispatch'.
6477 ((or first-key (functionp (nth 2 (assq key entries))))
6478 (cons (cond
6479 ((not first-key) (nth 2 (assq key entries)))
6480 ;; Publishing actions are hard-coded. Send a special
6481 ;; signal to `org-export-dispatch'.
6482 ((eq first-key ?P)
6483 (cl-case key
6484 (?f 'publish-current-file)
6485 (?p 'publish-current-project)
6486 (?x 'publish-choose-project)
6487 (?a 'publish-all)))
6488 ;; Return first action associated to FIRST-KEY + KEY
6489 ;; path. Indeed, derived backends can share the same
6490 ;; FIRST-KEY.
6491 (t (catch 'found
6492 (dolist (entry (member (assq first-key entries) entries))
6493 (let ((match (assq key (nth 2 entry))))
6494 (when match (throw 'found (nth 2 match))))))))
6495 options))
6496 ;; Otherwise, enter sub-menu.
6497 (t (org-export--dispatch-ui options key expertp)))))
6501 (provide 'ox)
6503 ;; Local variables:
6504 ;; generated-autoload-file: "org-loaddefs.el"
6505 ;; End:
6507 ;;; ox.el ends here