| blob | cb2c903bae8baee7ae4fdf84fdd94ec1dc2d1f12 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
90 \f
91 ;;; Internal Variables
92 ;;
93 ;; Among internal variables, the most important is
94 ;; `org-export-options-alist'. This variable define the global export
95 ;; options, shared between every exporter, and how they are acquired.
142 "Alist between export properties and ways to set them.
144 The CAR of the alist is the property name, and the CDR is a list
145 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
147 KEYWORD is a string representing a buffer keyword, or nil. Each
148 property defined this way can also be set, during subtree
149 export, through a headline property named after the keyword
151 property).
152 OPTION is a string that could be found in an #+OPTIONS: line.
153 DEFAULT is the default value for the property.
154 BEHAVIOR determines how Org should handle multiple keywords for
155 the same property. It is a symbol among:
156 nil Keep old value and discard the new one.
157 t Replace old value with the new one.
158 `space' Concatenate the values, separating them with a space.
159 `newline' Concatenate the values, separating them with
160 a newline.
161 `split' Split values at white spaces, and cons them to the
162 previous list.
164 Values set through KEYWORD and OPTION have precedence over
165 DEFAULT.
167 All these properties should be back-end agnostic. Back-end
168 specific properties are set through `org-export-define-backend'.
172 "List of in-buffer keywords that require special treatment.
173 These keywords are not directly associated to a property. The
174 way they are handled must be hard-coded into
182 org-export-options-alist))
240 "Alist between filters properties and initial values.
242 The key of each association is a property name accessible through
243 the communication channel. Its value is a configurable global
244 variable defining initial filters.
246 This list is meant to install user specified filters. Back-end
247 developers may install their own filters using
248 `org-export-define-backend'. Filters defined there will always
249 be prepended to the current list, so they always get applied
258 "Default rule for link matching an inline image.
259 This rule applies to links with no description. By default, it
260 will be considered as an inline image if it targets a local file
263 See `org-export-inline-image-p' for more information about
268 org-element--cache org-element--cache-objects org-element--cache-sync-keys
269 org-element--cache-sync-requests org-element--cache-sync-timer)
270 "List of variables not copied through upon buffer duplication.
271 Export process takes place on a copy of the original buffer.
272 When this copy is created, all Org related local variables not in
273 this list are copied to the new buffer. Variables with an
277 "Non-nil means asynchronous export process should leave data behind.
281 located in `temporary-file-directory'.
283 When non-nil, it will also set `debug-on-error' to a non-nil
287 "Record asynchronously generated export results and processes.
288 This is an alist: its CAR is the source of the
289 result (destination file or buffer for a finished process,
290 original buffer for a running one) and its CDR is a list
291 containing the back-end used, as a symbol, and either a process
292 or the time at which it finished. It is used to build the menu
296 "List of backends currently available in the exporter.
297 This variable is set with `org-export-define-backend' and
301 "Last command called from the dispatcher.
302 The value should be a list. Its CAR is the action, as a symbol,
306 "The position where the last export command was created using the dispatcher.
307 This marker will be used with `C-u C-c C-e' to make sure export repetition
310 ;; For compatibility with Org < 8
312 "Name, if any, of the back-end used during an export process.
314 Its value is a symbol such as `html', `latex', `ascii', or nil if
315 the back-end is anonymous (see `org-export-create-backend') or if
316 there is no export process in progress.
318 It can be used to teach Babel blocks how to act differently
322 \f
323 ;;; User-configurable Variables
324 ;;
325 ;; Configuration for the masses.
326 ;;
327 ;; They should never be accessed directly, as their value is to be
328 ;; stored in a property list (cf. `org-export-options-alist').
329 ;; Back-ends will read their value from there instead.
332 "Options for exporting Org mode files."
337 "General options for export engine."
342 "Whether sub-trees with the ARCHIVE tag should be exported.
344 This can have three different values:
345 nil Do not export, pretend this tree is not present.
346 t Do export the entire tree.
347 `headline' Only export the headline, but skip the tree below it.
349 This option can also be set with the OPTIONS keyword,
358 "Non-nil means insert author name into the exported file.
359 This option can also be set with the OPTIONS keyword,
365 "Non-nil means export CLOCK keywords.
366 This option can also be set with the OPTIONS keyword,
372 "Non-nil means the postamble should contain a creator sentence.
374 The sentence can be set in `org-export-creator-string', which
375 see.
377 This option can also be set with the OPTIONS keyword, e.g.,
385 "Non-nil means insert date in the exported document.
386 This option can also be set with the OPTIONS keyword,
392 "Time-stamp format string to use for DATE keyword.
394 The format string, when specified, only applies if date consists
395 in a single time-stamp. Otherwise its value will be ignored.
397 See `format-time-string' for details on how to build this
398 string."
406 emacs-version
408 "Information about the creator of the document.
409 This option can also be set on with the CREATOR keyword."
414 "Non-nil means export contents of standard drawers.
416 When t, all drawers are exported. This may also be a list of
417 drawer names to export, as strings. If that list starts with
418 `not', only drawers with such names will be ignored.
420 This variable doesn't apply to properties drawers. See
421 `org-export-with-properties' instead.
423 This option can also be set with the OPTIONS keyword,
436 :inline t
440 "Non-nil means insert author email into the exported file.
441 This option can also be set with the OPTIONS keyword,
447 "Non-nil means interpret *word*, /word/, _word_ and +word+.
449 If the export target supports emphasizing text, the word will be
450 typeset in bold, italic, with an underline or strike-through,
451 respectively.
453 This option can also be set with the OPTIONS keyword,
459 "Tags that exclude a tree from export.
461 All trees carrying any of these tags will be excluded from
462 export. This is without condition, so even subtrees inside that
463 carry one of the `org-export-select-tags' will be removed.
465 This option can also be set with the EXCLUDE_TAGS keyword."
471 This option can also be set with the OPTIONS keyword,
479 "Non-nil means Org footnotes should be exported.
480 This option can also be set with the OPTIONS keyword,
486 "Non-nil means process LaTeX environments and fragments.
488 This option can also be set with the OPTIONS line,
491 nil Ignore math snippets.
492 `verbatim' Keep everything in verbatim.
493 t Allow export of math snippets."
503 "The last level which is still exported as a headline.
505 Inferior levels will usually produce itemize or enumerate lists
506 when exported, but back-end behaviour may differ.
508 This option can also be set with the OPTIONS keyword,
514 "The default language for export and clocktable translations, as a string.
515 This may have an association in
516 `org-clock-clocktable-language-setup',
517 `org-export-smart-quotes-alist' and `org-export-dictionary'.
518 This option can also be set with the LANGUAGE keyword."
523 "Non-nil means preserve all line breaks when exporting.
524 This option can also be set with the OPTIONS keyword,
530 "Non-nil means interpret entities when exporting.
533 Å.
535 For a list of supported names, see the constant `org-entities'
536 and the user option `org-entities-user'.
538 This option can also be set with the OPTIONS keyword,
544 "Non-nil means inlinetasks should be exported.
545 This option can also be set with the OPTIONS keyword,
553 "Non-nil means include planning info in export.
555 Planning info is the line containing either SCHEDULED:,
556 DEADLINE:, CLOSED: time-stamps, or a combination of them.
558 This option can also be set with the OPTIONS keyword,
566 "Non-nil means include priority cookies in export.
567 This option can also be set with the OPTIONS keyword,
573 "Non-nil means export contents of properties drawers.
575 When t, all properties are exported. This may also be a list of
576 properties to export, as strings.
578 This option can also be set with the OPTIONS keyword,
590 "Non-nil means add section numbers to headlines when exporting.
592 When set to an integer n, numbering will only happen for
593 headlines whose relative level is higher or equal to n.
595 This option can also be set with the OPTIONS keyword,
601 "Tags that select a tree for export.
603 If any such tag is found in a buffer, all trees that do not carry
604 one of these tags will be ignored during export. Inside trees
605 that are selected like this, you can still deselect a subtree by
606 tagging it with one of the `org-export-exclude-tags'.
608 This option can also be set with the SELECT_TAGS keyword."
613 "Non-nil means activate smart quotes during export.
614 This option can also be set with the OPTIONS keyword,
617 When setting this to non-nil, you need to take care of
618 using the correct Babel package when exporting to LaTeX.
619 E.g., you can load Babel for french like this:
630 When this option is turned on, these strings will be exported as:
632 Org HTML LaTeX UTF-8
633 -----+----------+--------+-------
635 -- – -- –
636 --- — --- —
639 This option can also be set with the OPTIONS keyword,
645 "Non-nil means include statistics cookies in export.
646 This option can also be set with the OPTIONS keyword,
656 If you want to control how Org displays those characters, see
657 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
658 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
659 it is not anymore.
661 When this option is turned on, you can use TeX-like syntax for
662 sub- and superscripts and see them exported correctly.
664 You can also set the option with #+OPTIONS: ^:t
667 single item - so grouping with {} is normally not needed. For
668 example, the following things will be parsed as single sub- or
669 superscripts:
671 10^24 or 10^tau several digits will be considered 1 item.
672 10^-12 or 10^-tau a leading sign with digits or a word
673 x^2-y^3 will be read as x^2 - y^3, because items are
674 terminated by almost any nonword/nondigit char.
675 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
677 Still, ambiguity is possible. So when in doubt, use {} to enclose
678 the sub/superscript. If you set this variable to the symbol `{}',
679 the braces are *required* in order to trigger interpretations as
681 frequently in plain text."
691 "Non-nil means create a table of contents in exported files.
693 The TOC contains headlines with levels up
694 to`org-export-headline-levels'. When an integer, include levels
695 up to N in the toc, this may then be different from
696 `org-export-headline-levels', but it will not be allowed to be
697 larger than the number of headline levels. When nil, no table of
698 contents is made.
700 This option can also be set with the OPTIONS keyword,
709 "Non-nil means export tables.
710 This option can also be set with the OPTIONS keyword,
718 "If nil, do not export tags, just remove them from headlines.
720 If this is the symbol `not-in-toc', tags will be removed from
721 table of contents entries, but still be shown in the headlines of
722 the document.
724 This option can also be set with the OPTIONS keyword,
733 "Non-nil means include TODO items for export.
735 This may have the following values:
736 t include tasks independent of state.
737 `todo' include only tasks that are not yet done.
738 `done' include only tasks that are already done.
739 nil ignore all tasks.
740 list of keywords include tasks with these keywords.
742 This option can also be set with the OPTIONS keyword,
754 "Non-nil means print title into the exported file.
755 This option can also be set with the OPTIONS keyword,
763 "Non-nil means insert a time stamp into the exported file.
764 The time stamp shows when the file was created. This option can
770 "Non nil means allow timestamps in export.
772 It can be set to any of the following values:
773 t export all timestamps.
774 `active' export active timestamps only.
775 `inactive' export inactive timestamps only.
776 nil do not export timestamps
778 This only applies to timestamps isolated in a paragraph
779 containing only timestamps. Other timestamps are always
780 exported.
782 This option can also be set with the OPTIONS keyword, e.g.
792 "Non-nil means include TODO keywords in export.
793 When nil, remove all these keywords from the export. This option
799 "Non-nil means BIND keywords can define local variable values.
800 This is a potential security risk, which is why the default value
801 is nil. You can also allow them through local buffer variables."
808 "Alist between export snippets back-ends and exporter back-ends.
810 This variable allows to provide shortcuts for export snippets.
814 HTML code while every other back-end will ignore it."
823 "Coding system for the exported file."
830 "Non-nil means pushing export output to the kill ring.
831 This variable is ignored during asynchronous export."
841 "The initial scope when exporting with `org-export-dispatch'.
842 This variable can be either set to `buffer' or `subtree'."
849 "Non-nil means show buffer after exporting to temp buffer.
850 When Org exports to a file, the buffer visiting that file is never
851 shown, but remains buried. However, when exporting to
852 a temporary buffer, that buffer is popped up in a second window.
853 When this variable is nil, the buffer remains buried also in
854 these cases."
859 "Non-nil means export and publishing commands will run in background.
860 Results from an asynchronous export are never displayed
868 "File used to initialize external export process.
870 Value must be either nil or an absolute file name. When nil, the
871 external process is launched like a regular Emacs session,
872 loading user's initialization file and any site specific
873 configuration. If a file is provided, it, and only it, is loaded
874 at start-up.
876 Therefore, using a specific configuration makes the process to
877 load faster and the export more portable."
886 "Non-nil means using a non-intrusive `org-export-dispatch'.
887 In that case, no help buffer is displayed. Though, an indicator
893 asynchronous). Also, \[?] allows to switch back to standard
894 mode."
901 \f
902 ;;; Defining Back-ends
903 ;;
904 ;; An export back-end is a structure with `org-export-backend' type
905 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
906 ;; and `menu' slots.
907 ;;
908 ;; At the lowest level, a back-end is created with
909 ;; `org-export-create-backend' function.
910 ;;
911 ;; A named back-end can be registered with
912 ;; `org-export-register-backend' function. A registered back-end can
913 ;; later be referred to by its name, with `org-export-get-backend'
914 ;; function. Also, such a back-end can become the parent of a derived
915 ;; back-end from which slot values will be inherited by default.
916 ;; `org-export-derived-backend-p' can check if a given back-end is
917 ;; derived from a list of back-end names.
918 ;;
919 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
920 ;; `org-export-get-all-filters' return the full alist of transcoders,
921 ;; options and filters, including those inherited from ancestors.
922 ;;
923 ;; At a higher level, `org-export-define-backend' is the standard way
924 ;; to define an export back-end. If the new back-end is similar to
925 ;; a registered back-end, `org-export-define-derived-backend' may be
926 ;; used instead.
927 ;;
928 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
929 ;; when a given back-end hasn't been registered yet.
933 name parent transcoders options filters blocks menu)
936 "Return export back-end named after NAME.
937 NAME is a symbol. Return nil if no such back-end is found."
944 "Register BACKEND as a known export back-end.
945 BACKEND is a structure with `org-export-backend' type."
946 ;; Refuse to register an unnamed back-end.
949 ;; Refuse to register a back-end with an unknown parent.
953 ;; Register dedicated export blocks in the parser.
957 ;; If a back-end with the same name as BACKEND is already
958 ;; registered, replace it with BACKEND. Otherwise, simply add
959 ;; BACKEND to the list of registered back-ends.
965 "Signal an error if BACKEND isn't defined."
970 "Non-nil if BACKEND is derived from one of BACKENDS.
971 BACKEND is an export back-end, as returned by, e.g.,
972 `org-export-create-backend', or a symbol referring to
973 a registered back-end. BACKENDS is constituted of symbols."
985 "Return full translation table for BACKEND.
987 BACKEND is an export back-end, as return by, e.g,,
988 `org-export-create-backend'. Return value is an alist where
989 keys are element or object types, as symbols, and values are
990 transcoders.
992 Unlike to `org-export-backend-transcoders', this function
993 also returns transcoders inherited from parent back-ends,
994 if any."
998 parent)
1003 transcoders)))
1006 "Return export options for BACKEND.
1008 BACKEND is an export back-end, as return by, e.g,,
1009 `org-export-create-backend'. See `org-export-options-alist'
1010 for the shape of the return value.
1012 Unlike to `org-export-backend-options', this function also
1013 returns options inherited from parent back-ends, if any."
1017 parent)
1021 options)))
1024 "Return complete list of filters for BACKEND.
1026 BACKEND is an export back-end, as return by, e.g,,
1027 `org-export-create-backend'. Return value is an alist where
1028 keys are symbols and values lists of functions.
1030 Unlike to `org-export-backend-filters', this function also
1031 returns filters inherited from parent back-ends, if any."
1035 parent)
1039 filters)))
1042 "Define a new back-end BACKEND.
1044 TRANSCODERS is an alist between object or element types and
1045 functions handling them.
1047 These functions should return a string without any trailing
1048 space, or nil. They must accept three arguments: the object or
1049 element itself, its contents or nil when it isn't recursive and
1050 the property list used as a communication channel.
1052 Contents, when not nil, are stripped from any global indentation
1053 \(although the relative one is preserved). They also always end
1054 with a single newline character.
1056 If, for a given type, no function is found, that element or
1057 object type will simply be ignored, along with any blank line or
1058 white space at its end. The same will happen if the function
1059 returns the nil value. If that function returns the empty
1060 string, the type will be ignored, but the blank lines or white
1061 spaces will be kept.
1063 In addition to element and object types, one function can be
1064 associated to the `template' (or `inner-template') symbol and
1065 another one to the `plain-text' symbol.
1067 The former returns the final transcoded string, and can be used
1068 to add a preamble and a postamble to document's body. It must
1069 accept two arguments: the transcoded string and the property list
1070 containing export options. A function associated to `template'
1072 A function associated to `inner-template' is always applied.
1074 The latter, when defined, is to be called on every text not
1075 recognized as an element or an object. It must accept two
1076 arguments: the text string and the information channel. It is an
1077 appropriate place to protect special chars relative to the
1078 back-end.
1080 BODY can start with pre-defined keyword arguments. The following
1081 keywords are understood:
1083 :export-block
1085 String, or list of strings, representing block names that
1086 will not be parsed. This is used to specify blocks that will
1087 contain raw code specific to the back-end. These blocks
1088 still have to be handled by the relative `export-block' type
1089 translator.
1091 :filters-alist
1093 Alist between filters and function, or list of functions,
1094 specific to the back-end. See `org-export-filters-alist' for
1095 a list of all allowed filters. Filters defined here
1096 shouldn't make a back-end test, as it may prevent back-ends
1097 derived from this one to behave properly.
1099 :menu-entry
1101 Menu entry for the export dispatcher. It should be a list
1102 like:
1104 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1106 where :
1108 KEY is a free character selecting the back-end.
1110 DESCRIPTION-OR-ORDINAL is either a string or a number.
1112 If it is a string, is will be used to name the back-end in
1113 its menu entry. If it is a number, the following menu will
1114 be displayed as a sub-menu of the back-end with the same
1115 KEY. Also, the number will be used to determine in which
1116 order such sub-menus will appear (lowest first).
1118 ACTION-OR-MENU is either a function or an alist.
1120 If it is an action, it will be called with four
1121 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1122 BODY-ONLY. See `org-export-as' for further explanations on
1123 some of them.
1125 If it is an alist, associations should follow the
1126 pattern:
1128 '(KEY DESCRIPTION ACTION)
1130 where KEY, DESCRIPTION and ACTION are described above.
1132 Valid values include:
1136 or
1141 \(lambda (a s v b)
1142 \(if a (org-latex-export-to-pdf t s v b)
1143 \(org-open-file
1144 \(org-latex-export-to-pdf nil s v b)))))))
1146 or the following, which will be added to the previous
1147 sub-menu,
1149 '(?l 1
1153 :options-alist
1155 Alist between back-end specific properties introduced in
1156 communication channel and how their value are acquired. See
1157 `org-export-options-alist' for more information about
1158 structure of the values."
1173 :transcoders transcoders
1174 :options options
1175 :filters filters
1176 :blocks blocks
1180 "Create a new back-end as a variant of an existing one.
1182 CHILD is the name of the derived back-end. PARENT is the name of
1183 the parent back-end.
1185 BODY can start with pre-defined keyword arguments. The following
1186 keywords are understood:
1188 :export-block
1190 String, or list of strings, representing block names that
1191 will not be parsed. This is used to specify blocks that will
1192 contain raw code specific to the back-end. These blocks
1193 still have to be handled by the relative `export-block' type
1194 translator.
1196 :filters-alist
1198 Alist of filters that will overwrite or complete filters
1199 defined in PARENT back-end. See `org-export-filters-alist'
1200 for a list of allowed filters.
1202 :menu-entry
1204 Menu entry for the export dispatcher. See
1205 `org-export-define-backend' for more information about the
1206 expected value.
1208 :options-alist
1210 Alist of back-end specific properties that will overwrite or
1211 complete those defined in PARENT back-end. Refer to
1212 `org-export-options-alist' for more information about
1213 structure of the values.
1215 :translate-alist
1217 Alist of element and object types and transcoders that will
1218 overwrite or complete transcode table from PARENT back-end.
1219 Refer to `org-export-define-backend' for detailed information
1220 about transcoders.
1223 as a variant of `latex' back-end with a custom template function:
1225 \(org-export-define-derived-backend 'my-latex 'latex
1226 :translate-alist '((template . my-latex-template-fun)))
1228 The back-end could then be called with, for example:
1246 :parent parent
1247 :transcoders transcoders
1248 :options options
1249 :filters filters
1250 :blocks blocks
1254 \f
1255 ;;; The Communication Channel
1256 ;;
1257 ;; During export process, every function has access to a number of
1258 ;; properties. They are of two types:
1259 ;;
1260 ;; 1. Environment options are collected once at the very beginning of
1261 ;; the process, out of the original buffer and configuration.
1262 ;; Collecting them is handled by `org-export-get-environment'
1263 ;; function.
1264 ;;
1265 ;; Most environment options are defined through the
1266 ;; `org-export-options-alist' variable.
1267 ;;
1268 ;; 2. Tree properties are extracted directly from the parsed tree,
1269 ;; just before export, by `org-export-collect-tree-properties'.
1271 ;;;; Environment Options
1272 ;;
1273 ;; Environment options encompass all parameters defined outside the
1274 ;; scope of the parsed data. They come from five sources, in
1275 ;; increasing precedence order:
1276 ;;
1277 ;; - Global variables,
1278 ;; - Buffer's attributes,
1279 ;; - Options keyword symbols,
1280 ;; - Buffer keywords,
1281 ;; - Subtree properties.
1282 ;;
1283 ;; The central internal function with regards to environment options
1284 ;; is `org-export-get-environment'. It updates global variables with
1285 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1286 ;; the different sources.
1287 ;;
1288 ;; The internal functions doing the retrieval are:
1289 ;; `org-export--get-global-options',
1290 ;; `org-export--get-buffer-attributes',
1291 ;; `org-export--parse-option-keyword',
1292 ;; `org-export--get-subtree-options' and
1293 ;; `org-export--get-inbuffer-options'
1294 ;;
1295 ;; Also, `org-export--list-bound-variables' collects bound variables
1296 ;; along with their value in order to set them as buffer local
1297 ;; variables later in the process.
1300 "Collect export options from the current buffer.
1302 Optional argument BACKEND is an export back-end, as returned by
1303 `org-export-create-backend'.
1305 When optional argument SUBTREEP is non-nil, assume the export is
1306 done against the current sub-tree.
1308 Third optional argument EXT-PLIST is a property list with
1309 external parameters overriding Org default settings, but still
1310 inferior to file-local settings."
1311 ;; First install #+BIND variables since these must be set before
1312 ;; global options are read.
1315 ;; Get and prioritize export options...
1317 ;; ... from global variables...
1319 ;; ... from an external property list...
1320 ext-plist
1321 ;; ... from in-buffer settings...
1323 ;; ... and from subtree, when appropriate.
1325 ;; Eventually add misc. properties.
1327 :back-end
1328 backend
1330 :footnote-definition-alist
1331 ;; Footnotes definitions must be collected in the original
1332 ;; buffer, as there's no insurance that they will still be in
1333 ;; the parse tree, due to possible narrowing.
1349 alist))
1361 alist)))))))
1362 alist))
1363 :id-alist
1364 ;; Collect id references.
1375 alist))))
1378 "Parse an OPTIONS line and return values as a plist.
1379 Optional argument BACKEND is an export back-end, as returned by,
1380 e.g., `org-export-create-backend'. It specifies which back-end
1381 specific items to read, if any."
1383 ;; Priority is given to back-end specific options.
1385 org-export-options-alist))
1386 plist)
1395 options))
1397 property
1400 plist))
1403 "Get export options in subtree at point.
1404 Optional argument BACKEND is an export back-end, as returned by,
1405 e.g., `org-export-create-backend'. It specifies back-end used
1406 for export. Return options as a plist."
1407 ;; For each buffer keyword, create a headline property setting the
1408 ;; same property in communication channel. The name for the property
1409 ;; is the keyword with "EXPORT_" appended to it.
1412 ;; Make sure point is at a heading.
1414 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1415 ;; title (with no todo keyword, priority cookie or tag) as its
1416 ;; fallback value.
1422 plist :title
1425 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1429 ;; Handle other keywords. TITLE keyword is excluded as it has
1430 ;; been handled already.
1438 ;; Export properties are not case-sensitive.
1445 plist
1446 property
1448 ;; Parse VALUE if required.
1452 ;; If BEHAVIOR is `split' expected value is
1453 ;; a list of strings, not a string.
1456 ;; Look for both general keywords and back-end specific
1457 ;; options, with priority given to the latter.
1459 org-export-options-alist)))
1460 ;; Return value.
1461 plist)))
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."
1473 get-options ; For byte-compiler.
1476 ;; Priority is given to back-end specific options.
1478 org-export-options-alist))
1481 org-export-special-keywords))))
1484 ;; Return all properties associated to KEYWORD.
1491 ;; Recursively read keywords in buffer. FILES is a list
1492 ;; of files read so far. PLIST is the current property
1493 ;; list obtained.
1502 ;; Options in `org-export-special-keywords'.
1506 ;; Avoid circular dependencies.
1516 plist
1521 plist
1527 ;; Options in `org-export-options-alist'.
1532 plist property
1533 ;; Handle value depending on specified
1534 ;; BEHAVIOR.
1540 " "
1553 ;; Return final value.
1554 plist))))
1555 ;; Read options in the current buffer.
1558 ;; Parse keywords specified in `org-element-document-properties'
1559 ;; and return PLIST.
1570 "Return properties related to buffer attributes, as a plist."
1575 "Return global export options as a plist.
1576 Optional argument BACKEND, if non-nil, is an export back-end, as
1577 returned by, e.g., `org-export-create-backend'. It specifies
1578 which back-end specific export options should also be read in the
1579 process."
1581 ;; Priority is given to back-end specific options.
1583 org-export-options-alist)))
1589 plist
1590 prop
1591 ;; Evaluate default value provided. If keyword is
1592 ;; a member of `org-element-document-properties',
1593 ;; parse it as a secondary string before storing it.
1597 org-element-document-properties))
1600 value)))))))))
1603 "Return variables bound from BIND keywords in current buffer.
1604 Also look for BIND keywords in setup files. The return value is
1605 an alist where associations are (VARIABLE-NAME VALUE)."
1610 ;; Return an alist between variable names and their
1611 ;; value. FILES is a list of setup files names read so
1612 ;; far, used to avoid circular dependencies. ALIST is
1613 ;; the alist collected so far.
1624 ;; Enter setup file.
1634 alist))))))))))
1635 alist)))))
1636 ;; Return value in appropriate order of appearance.
1639 ;; defsubst org-export-get-parent must be defined before first use,
1640 ;; was originally defined in the topology section
1643 "Return BLOB parent or nil.
1644 BLOB is the element or object considered."
1647 ;;;; Tree Properties
1648 ;;
1649 ;; Tree properties are information extracted from parse tree. They
1650 ;; are initialized at the beginning of the transcoding process by
1651 ;; `org-export-collect-tree-properties'.
1652 ;;
1653 ;; Dedicated functions focus on computing the value of specific tree
1654 ;; properties during initialization. Thus,
1655 ;; `org-export--populate-ignore-list' lists elements and objects that
1656 ;; should be skipped during export, `org-export--get-min-level' gets
1657 ;; the minimal exportable level, used as a basis to compute relative
1658 ;; level for headlines. Eventually
1659 ;; `org-export--collect-headline-numbering' builds an alist between
1660 ;; headlines and their numbering.
1663 "Extract tree properties from parse tree.
1665 DATA is the parse tree from which information is retrieved. INFO
1666 is a list holding export options.
1668 Following tree properties are set or updated:
1670 `:exported-data' Hash table used to memoize results from
1671 `org-export-data'.
1673 `:footnote-definition-alist' List of footnotes definitions in
1674 original buffer and current parse tree.
1676 `:headline-offset' Offset between true level of headlines and
1677 local level. An offset of -1 means a headline
1678 of level 2 should be considered as a level
1679 1 headline in the context.
1681 `:headline-numbering' Alist of all headlines as key an the
1682 associated numbering as value.
1684 Return updated plist."
1685 ;; Install the parse tree in the communication channel.
1687 ;; Compute `:headline-offset' in order to be able to use
1688 ;; `org-export-get-relative-level'.
1691 :headline-offset
1693 ;; Footnote definitions in parse tree override those stored in
1694 ;; `:footnote-definition-alist'. This way, any change to
1695 ;; a definition in the parse tree (e.g., through a parse tree
1696 ;; filter) propagates into the alist.
1703 defs))
1707 defs)))))
1709 ;; Properties order doesn't matter: get the rest of the tree
1710 ;; properties.
1715 info))
1718 "Return minimum exportable headline's level in DATA.
1719 DATA is parsed tree as returned by `org-element-parse-buffer'.
1720 OPTIONS is a plist holding export options."
1731 ;; If no headline was found, for the sake of consistency, set
1732 ;; minimum level to 1 nonetheless.
1736 "Return numbering of all exportable, numbered headlines in a parse tree.
1738 DATA is the parse tree. OPTIONS is the plist holding export
1739 options.
1741 Return an alist whose key is a headline and value is its
1742 associated numbering \(in the shape of a list of numbers\) or nil
1743 for a footnotes section."
1752 headline
1754 for idx from 0 to org-export-max-depth
1758 options)))
1761 "Return numbering of all exportable, unnumbered headlines.
1762 DATA is the parse tree. OPTIONS is the plist holding export
1763 options. Unnumbered headlines are numbered as a function of
1764 occurrence."
1772 "List headlines and inlinetasks with a select tag in their tree.
1773 DATA is parsed data as returned by `org-element-parse-buffer'.
1774 INFO is a plist holding export options."
1776 walk-data ; For byte-compiler.
1786 ;; When a select tag is found, mark full
1787 ;; genealogy and every headline within the tree
1788 ;; 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."
1927 ;; Ignored element/object.
1929 ;; Plain text.
1935 info))
1936 ;; Secondary string.
1939 ;; Element/Object without contents or, as a special
1940 ;; case, headline with archive tag and archived trees
1941 ;; restricted to title only.
1949 ;; Export snippets never return a nil value so
1950 ;; that white spaces following them are never
1951 ;; ignored.
1953 ;; Element/Object with contents.
1966 ;; Elements directly containing
1967 ;; objects must have their indentation
1968 ;; normalized first.
1970 data
1971 ;; When normalizing contents of the
1972 ;; first paragraph in an item or
1973 ;; a footnote definition, ignore
1974 ;; first line's indentation: there is
1975 ;; none and it might be misleading.
1980 data)
1987 info))))))))
1988 ;; Final result will be memoized before being returned.
1990 data
1994 ;; Append the same white space between elements or objects
1995 ;; as in the original buffer, and call appropriate filters.
2006 info)))
2007 results)))
2011 "Convert DATA into BACKEND format.
2013 DATA is an element, an object, a secondary string or a string.
2014 BACKEND is a symbol. INFO is a plist used as a communication
2015 channel.
2017 Unlike to `org-export-with-backend', this function will
2018 recursively convert DATA using BACKEND translation table."
2021 data
2022 ;; Set-up a new communication channel with translations defined in
2023 ;; BACKEND as the translate table and a new hash table for
2024 ;; memoization.
2026 info
2029 ;; Size of the hash table is reduced since this function
2030 ;; will probably be used on small trees.
2034 "Expand a parsed element or object to its original state.
2036 BLOB is either an element or an object. CONTENTS is its
2037 contents, as a string or nil.
2039 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2040 keywords before output."
2045 blob contents))))
2048 \f
2049 ;;; The Filter System
2050 ;;
2051 ;; Filters allow end-users to tweak easily the transcoded output.
2052 ;; They are the functional counterpart of hooks, as every filter in
2053 ;; a set is applied to the return value of the previous one.
2054 ;;
2055 ;; Every set is back-end agnostic. Although, a filter is always
2056 ;; called, in addition to the string it applies to, with the back-end
2057 ;; used as argument, so it's easy for the end-user to add back-end
2058 ;; specific filters in the set. The communication channel, as
2059 ;; a plist, is required as the third argument.
2060 ;;
2061 ;; From the developer side, filters sets can be installed in the
2062 ;; process with the help of `org-export-define-backend', which
2063 ;; internally stores filters as an alist. Each association has a key
2064 ;; among the following symbols and a function or a list of functions
2065 ;; as value.
2066 ;;
2067 ;; - `:filter-options' applies to the property list containing export
2068 ;; options. Unlike to other filters, functions in this list accept
2069 ;; two arguments instead of three: the property list containing
2070 ;; export options and the back-end. Users can set its value through
2071 ;; `org-export-filter-options-functions' variable.
2072 ;;
2073 ;; - `:filter-parse-tree' applies directly to the complete parsed
2074 ;; tree. Users can set it through
2075 ;; `org-export-filter-parse-tree-functions' variable.
2076 ;;
2077 ;; - `:filter-body' applies to the body of the output, before template
2078 ;; translator chimes in. Users can set it through
2079 ;; `org-export-filter-body-functions' variable.
2080 ;;
2081 ;; - `:filter-final-output' applies to the final transcoded string.
2082 ;; Users can set it with `org-export-filter-final-output-functions'
2083 ;; variable.
2084 ;;
2085 ;; - `:filter-plain-text' applies to any string not recognized as Org
2086 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2087 ;; configure it.
2088 ;;
2089 ;; - `:filter-TYPE' applies on the string returned after an element or
2090 ;; object of type TYPE has been transcoded. A user can modify
2091 ;; `org-export-filter-TYPE-functions' to install these filters.
2092 ;;
2093 ;; All filters sets are applied with
2094 ;; `org-export-filter-apply-functions' function. Filters in a set are
2095 ;; applied in a LIFO fashion. It allows developers to be sure that
2096 ;; their filters will be applied first.
2097 ;;
2098 ;; Filters properties are installed in communication channel with
2099 ;; `org-export-install-filters' function.
2100 ;;
2101 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2102 ;; `org-export-before-parsing-hook') are run at the beginning of the
2103 ;; export process and just before parsing to allow for heavy structure
2104 ;; modifications.
2107 ;;;; Hooks
2110 "Hook run at the beginning of the export process.
2112 This is run before include keywords and macros are expanded and
2113 Babel code blocks executed, on a copy of the original buffer
2114 being exported. Visibility and narrowing are preserved. Point
2115 is at the beginning of the buffer.
2117 Every function in this hook will be called with one argument: the
2121 "Hook run before parsing an export buffer.
2123 This is run after include keywords and macros have been expanded
2124 and Babel code blocks executed, on a copy of the original buffer
2125 being exported. Visibility and narrowing are preserved. Point
2126 is at the beginning of the buffer.
2128 Every function in this hook will be called with one argument: the
2132 ;;;; Special Filters
2135 "List of functions applied to the export options.
2136 Each filter is called with two arguments: the export options, as
2137 a plist, and the back-end, as a symbol. It must return
2141 "List of functions applied to the parsed tree.
2142 Each filter is called with three arguments: the parse tree, as
2143 returned by `org-element-parse-buffer', the back-end, as
2144 a symbol, and the communication channel, as a plist. It must
2148 "List of functions applied to plain text.
2149 Each filter is called with three arguments: a string which
2150 contains no Org syntax, the back-end, as a symbol, and the
2151 communication channel, as a plist. It must return a string or
2155 "List of functions applied to transcoded body.
2156 Each filter is called with three arguments: a string which
2157 contains no Org syntax, the back-end, as a symbol, and the
2158 communication channel, as a plist. It must return a string or
2162 "List of functions applied to the transcoded string.
2163 Each filter is called with three arguments: the full transcoded
2164 string, the back-end, as a symbol, and the communication channel,
2165 as a plist. It must return a string that will be used as the
2169 ;;;; Elements Filters
2172 "List of functions applied to a transcoded babel-call.
2173 Each filter is called with three arguments: the transcoded data,
2174 as a string, the back-end, as a symbol, and the communication
2178 "List of functions applied to a transcoded center block.
2179 Each filter is called with three arguments: the transcoded data,
2180 as a string, the back-end, as a symbol, and the communication
2184 "List of functions applied to a transcoded clock.
2185 Each filter is called with three arguments: the transcoded data,
2186 as a string, the back-end, as a symbol, and the communication
2190 "List of functions applied to a transcoded diary-sexp.
2191 Each filter is called with three arguments: the transcoded data,
2192 as a string, the back-end, as a symbol, and the communication
2196 "List of functions applied to a transcoded drawer.
2197 Each filter is called with three arguments: the transcoded data,
2198 as a string, the back-end, as a symbol, and the communication
2202 "List of functions applied to a transcoded dynamic-block.
2203 Each filter is called with three arguments: the transcoded data,
2204 as a string, the back-end, as a symbol, and the communication
2208 "List of functions applied to a transcoded example-block.
2209 Each filter is called with three arguments: the transcoded data,
2210 as a string, the back-end, as a symbol, and the communication
2214 "List of functions applied to a transcoded export-block.
2215 Each filter is called with three arguments: the transcoded data,
2216 as a string, the back-end, as a symbol, and the communication
2220 "List of functions applied to a transcoded fixed-width.
2221 Each filter is called with three arguments: the transcoded data,
2222 as a string, the back-end, as a symbol, and the communication
2226 "List of functions applied to a transcoded footnote-definition.
2227 Each filter is called with three arguments: the transcoded data,
2228 as a string, the back-end, as a symbol, and the communication
2232 "List of functions applied to a transcoded headline.
2233 Each filter is called with three arguments: the transcoded data,
2234 as a string, the back-end, as a symbol, and the communication
2238 "List of functions applied to a transcoded horizontal-rule.
2239 Each filter is called with three arguments: the transcoded data,
2240 as a string, the back-end, as a symbol, and the communication
2244 "List of functions applied to a transcoded inlinetask.
2245 Each filter is called with three arguments: the transcoded data,
2246 as a string, the back-end, as a symbol, and the communication
2250 "List of functions applied to a transcoded item.
2251 Each filter is called with three arguments: the transcoded data,
2252 as a string, the back-end, as a symbol, and the communication
2256 "List of functions applied to a transcoded keyword.
2257 Each filter is called with three arguments: the transcoded data,
2258 as a string, the back-end, as a symbol, and the communication
2262 "List of functions applied to a transcoded latex-environment.
2263 Each filter is called with three arguments: the transcoded data,
2264 as a string, the back-end, as a symbol, and the communication
2268 "List of functions applied to a transcoded node-property.
2269 Each filter is called with three arguments: the transcoded data,
2270 as a string, the back-end, as a symbol, and the communication
2274 "List of functions applied to a transcoded paragraph.
2275 Each filter is called with three arguments: the transcoded data,
2276 as a string, the back-end, as a symbol, and the communication
2280 "List of functions applied to a transcoded plain-list.
2281 Each filter is called with three arguments: the transcoded data,
2282 as a string, the back-end, as a symbol, and the communication
2286 "List of functions applied to a transcoded planning.
2287 Each filter is called with three arguments: the transcoded data,
2288 as a string, the back-end, as a symbol, and the communication
2292 "List of functions applied to a transcoded property-drawer.
2293 Each filter is called with three arguments: the transcoded data,
2294 as a string, the back-end, as a symbol, and the communication
2298 "List of functions applied to a transcoded quote block.
2299 Each filter is called with three arguments: the transcoded quote
2300 data, as a string, the back-end, as a symbol, and the
2301 communication channel, as a plist. It must return a string or
2305 "List of functions applied to a transcoded section.
2306 Each filter is called with three arguments: the transcoded data,
2307 as a string, the back-end, as a symbol, and the communication
2311 "List of functions applied to a transcoded special block.
2312 Each filter is called with three arguments: the transcoded data,
2313 as a string, the back-end, as a symbol, and the communication
2317 "List of functions applied to a transcoded src-block.
2318 Each filter is called with three arguments: the transcoded data,
2319 as a string, the back-end, as a symbol, and the communication
2323 "List of functions applied to a transcoded table.
2324 Each filter is called with three arguments: the transcoded data,
2325 as a string, the back-end, as a symbol, and the communication
2329 "List of functions applied to a transcoded table-cell.
2330 Each filter is called with three arguments: the transcoded data,
2331 as a string, the back-end, as a symbol, and the communication
2335 "List of functions applied to a transcoded table-row.
2336 Each filter is called with three arguments: the transcoded data,
2337 as a string, the back-end, as a symbol, and the communication
2341 "List of functions applied to a transcoded verse block.
2342 Each filter is called with three arguments: the transcoded data,
2343 as a string, the back-end, as a symbol, and the communication
2347 ;;;; Objects Filters
2350 "List of functions applied to transcoded bold text.
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 transcoded code text.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 "List of functions applied to a transcoded entity.
2363 Each filter is called with three arguments: the transcoded data,
2364 as a string, the back-end, as a symbol, and the communication
2368 "List of functions applied to a transcoded export-snippet.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded footnote-reference.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 "List of functions applied to a transcoded inline-babel-call.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to a transcoded inline-src-block.
2387 Each filter is called with three arguments: the transcoded data,
2388 as a string, the back-end, as a symbol, and the communication
2392 "List of functions applied to transcoded italic text.
2393 Each filter is called with three arguments: the transcoded data,
2394 as a string, the back-end, as a symbol, and the communication
2398 "List of functions applied to a transcoded latex-fragment.
2399 Each filter is called with three arguments: the transcoded data,
2400 as a string, the back-end, as a symbol, and the communication
2404 "List of functions applied to a transcoded line-break.
2405 Each filter is called with three arguments: the transcoded data,
2406 as a string, the back-end, as a symbol, and the communication
2410 "List of functions applied to a transcoded link.
2411 Each filter is called with three arguments: the transcoded data,
2412 as a string, the back-end, as a symbol, and the communication
2416 "List of functions applied to a transcoded radio-target.
2417 Each filter is called with three arguments: the transcoded data,
2418 as a string, the back-end, as a symbol, and the communication
2422 "List of functions applied to a transcoded statistics-cookie.
2423 Each filter is called with three arguments: the transcoded data,
2424 as a string, the back-end, as a symbol, and the communication
2428 "List of functions applied to transcoded strike-through text.
2429 Each filter is called with three arguments: the transcoded data,
2430 as a string, the back-end, as a symbol, and the communication
2434 "List of functions applied to a transcoded subscript.
2435 Each filter is called with three arguments: the transcoded data,
2436 as a string, the back-end, as a symbol, and the communication
2440 "List of functions applied to a transcoded superscript.
2441 Each filter is called with three arguments: the transcoded data,
2442 as a string, the back-end, as a symbol, and the communication
2446 "List of functions applied to a transcoded target.
2447 Each filter is called with three arguments: the transcoded data,
2448 as a string, the back-end, as a symbol, and the communication
2452 "List of functions applied to a transcoded timestamp.
2453 Each filter is called with three arguments: the transcoded data,
2454 as a string, the back-end, as a symbol, and the communication
2458 "List of functions applied to transcoded underline text.
2459 Each filter is called with three arguments: the transcoded data,
2460 as a string, the back-end, as a symbol, and the communication
2464 "List of functions applied to transcoded verbatim text.
2465 Each filter is called with three arguments: the transcoded data,
2466 as a string, the back-end, as a symbol, and the communication
2470 ;;;; Filters Tools
2471 ;;
2472 ;; Internal function `org-export-install-filters' installs filters
2473 ;; hard-coded in back-ends (developer filters) and filters from global
2474 ;; variables (user filters) in the communication channel.
2475 ;;
2476 ;; Internal function `org-export-filter-apply-functions' takes care
2477 ;; about applying each filter in order to a given data. It ignores
2478 ;; filters returning a nil value but stops whenever a filter returns
2479 ;; an empty string.
2482 "Call every function in FILTERS.
2484 Functions are called with arguments VALUE, current export
2485 back-end's name and INFO. A function returning a nil value will
2486 be skipped. If it returns the empty string, the process ends and
2487 VALUE is ignored.
2489 Call is done in a LIFO fashion, to be sure that developer
2490 specified filters, if any, are called first."
2501 "Install filters properties in communication channel.
2502 INFO is a plist containing the current communication channel.
2503 Return the updated communication channel."
2505 ;; Install user-defined filters with `org-export-filters-alist'
2506 ;; and filters already in INFO (through ext-plist mechanism).
2513 ;; Filters in INFO will be called
2514 ;; before those user provided.
2517 default-value)))))
2518 org-export-filters-alist)
2519 ;; Prepend back-end specific filters to that list.
2521 ;; Single values get consed, lists are appended.
2526 plist key
2530 ;; Return new communication channel.
2534 \f
2535 ;;; Core functions
2536 ;;
2537 ;; This is the room for the main function, `org-export-as', along with
2538 ;; its derivative, `org-export-string-as'.
2539 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2540 ;; function should be added to kill ring.
2541 ;;
2542 ;; Note that `org-export-as' doesn't really parse the current buffer,
2543 ;; but a copy of it (with the same buffer-local variables and
2544 ;; visibility), where macros and include keywords are expanded and
2545 ;; Babel blocks are executed, if appropriate.
2546 ;; `org-export-with-buffer-copy' macro prepares that copy.
2547 ;;
2548 ;; File inclusion is taken care of by
2549 ;; `org-export-expand-include-keyword' and
2550 ;; `org-export--prepare-file-contents'. Structure wise, including
2551 ;; a whole Org file in a buffer often makes little sense. For
2552 ;; example, if the file contains a headline and the include keyword
2553 ;; was within an item, the item should contain the headline. That's
2554 ;; why file inclusion should be done before any structure can be
2555 ;; associated to the file, that is before parsing.
2556 ;;
2557 ;; `org-export-insert-default-template' is a command to insert
2558 ;; a default template (or a back-end specific template) at point or in
2559 ;; current subtree.
2562 "Return a copy of the current buffer.
2563 The copy preserves Org buffer-local variables, visibility and
2564 narrowing."
2570 new-buf))
2573 "Apply BODY in a copy of the current buffer.
2574 The copy preserves local variables, visibility and contents of
2575 the original buffer. Point is at the beginning of the buffer
2576 when BODY is applied."
2585 ;; Kill copy without confirmation.
2591 "Generate a function duplicating BUFFER.
2593 The copy will preserve local variables, visibility, contents and
2594 narrowing of the original buffer. If a region was active in
2595 BUFFER, contents will be narrowed to that region instead.
2597 The resulting function can be evaluated at a later time, from
2598 another buffer, effectively cloning the original buffer there.
2600 The function assumes BUFFER's major mode is `org-mode'."
2604 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2605 ;; already in BUFFER.
2607 ;; Copy specific buffer local variables and variables set
2608 ;; through BIND keywords.
2610 vars)
2618 buffer-file-name
2619 buffer-file-coding-system))
2623 ;; Skip unreadable values, as they cannot be
2624 ;; sent to external process.
2628 vars))))))
2629 ;; Whole buffer contents.
2634 ;; Narrowing.
2638 ;; Current position of point.
2640 ;; Overlays with invisible property.
2650 ov-set))))
2652 ov-set)))))
2655 "Delete commented areas in the buffer.
2656 Commented areas are comments, comment blocks, commented trees and
2657 inlinetasks. Trailing blank lines after a comment or a comment
2658 block are preserved. Narrowing, if any, is ignored."
2679 "Prune non exportable elements from DATA.
2680 DATA is the parse tree to traverse. INFO is the plist holding
2681 export info. Also set `:ignore-list' in INFO to a list of
2682 objects which should be ignored during export, but not removed
2683 from tree."
2685 ignore
2686 ;; First find trees containing a select tag, if any.
2690 ;; Prune non-exportable elements and objects from tree.
2691 ;; As a special case, special rows and cells from tables
2692 ;; are stored in IGNORE, as they still need to be accessed
2693 ;; during export.
2701 ;; If headline is archived but tree below has to
2702 ;; be skipped, remove contents.
2704 ;; Move into secondary string, if any.
2709 ;; Move into recursive objects/elements.
2711 ;; If a select tag is active, also ignore the section before the
2712 ;; first headline, if any.
2717 ;; Prune tree and communication channel.
2721 ;; Eventually set `:ignore-list'.
2725 "Change uninterpreted elements back into Org syntax.
2726 DATA is the parse tree. INFO is a plist containing export
2727 options. Each uninterpreted element or object is changed back
2728 into a string. Contents, if any, are not modified. The parse
2729 tree is modified by side effect."
2733 prop
2736 info))))
2739 "Change uninterpreted elements back into Org syntax.
2740 DATA is a parse tree or a secondary string. INFO is a plist
2741 containing export options. It is modified by side effect and
2742 returned by the function."
2745 subscript superscript underline)
2749 ;; ... entities...
2756 ?\s)))))
2757 ;; ... emphasis...
2769 marker
2773 ?\s)))))))
2774 ;; ... LaTeX environments and fragments...
2778 ;; ... sub/superscripts...
2787 "_"
2796 ?\s)))))))))))
2798 ;; Splice NEW at BLOB location in parse tree.
2801 info)
2802 ;; Return modified parse tree.
2803 data)
2805 ;;;###autoload
2808 "Transcode current Org buffer into BACKEND code.
2810 BACKEND is either an export back-end, as returned by, e.g.,
2811 `org-export-create-backend', or a symbol referring to
2812 a registered back-end.
2814 If narrowing is active in the current buffer, only transcode its
2815 narrowed part.
2817 If a region is active, transcode that region.
2819 When optional argument SUBTREEP is non-nil, transcode the
2820 sub-tree at point, extracting information from the headline
2821 properties first.
2823 When optional argument VISIBLE-ONLY is non-nil, don't export
2824 contents of hidden elements.
2826 When optional argument BODY-ONLY is non-nil, only return body
2827 code, without surrounding template.
2829 Optional argument EXT-PLIST, when provided, is a property list
2830 with external parameters overriding Org default settings, but
2831 still inferior to file-local settings.
2833 Return code as a string."
2838 ;; Narrow buffer to an appropriate region or subtree for
2839 ;; parsing. If parsing subtree, be sure to remove main headline
2840 ;; too.
2848 ;; Initialize communication channel with original buffer
2849 ;; attributes, unavailable in its copy.
2858 tree)
2859 ;; Update communication channel and get parse tree. Buffer
2860 ;; isn't parsed directly. Instead, a temporary copy is
2861 ;; created, where include keywords, macros are expanded and
2862 ;; code blocks are evaluated.
2864 ;; Run first hook with current back-end's name as argument.
2869 ;; Update macro templates since #+INCLUDE keywords might have
2870 ;; added some new ones.
2874 ;; Update radio targets since keyword inclusion might have
2875 ;; added some more.
2877 ;; Run last hook with current back-end's name as argument.
2882 ;; Update communication channel with environment. Also
2883 ;; install user's and developer's filters.
2888 ;; Call options filters and update export options. We do not
2889 ;; use `org-export-filter-apply-functions' here since the
2890 ;; arity of such filters is different.
2895 ;; Expand export-specific set of macros: {{{author}}},
2896 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2897 ;; be done once regular macros have been expanded, since
2898 ;; document keywords may contain one of them.
2910 value)
2911 value)))
2912 ;; EMAIL is not a parsed keyword: store it as-is.
2918 ;; Parse buffer.
2920 ;; Prune tree from non-exported elements and transform
2921 ;; uninterpreted elements or objects in both parse tree and
2922 ;; communication channel.
2925 ;; Parse buffer, handle uninterpreted elements or objects,
2926 ;; then call parse-tree filters.
2930 ;; Now tree is complete, compute its properties and add them
2931 ;; to communication channel.
2935 ;; Eventually transcode TREE. Wrap the resulting string into
2936 ;; a template.
2945 info))
2948 ;; Remove all text properties since they cannot be
2949 ;; retrieved from an external process. Finally call
2950 ;; final-output filter and return result.
2956 info))))))))
2958 ;;;###autoload
2960 "Transcode STRING into BACKEND code.
2962 BACKEND is either an export back-end, as returned by, e.g.,
2963 `org-export-create-backend', or a symbol referring to
2964 a registered back-end.
2966 When optional argument BODY-ONLY is non-nil, only return body
2967 code, without preamble nor postamble.
2969 Optional argument EXT-PLIST, when provided, is a property list
2970 with external parameters overriding Org default settings, but
2971 still inferior to file-local settings.
2973 Return code as a string."
2979 ;;;###autoload
2981 "Replace the active region by its export to BACKEND.
2982 BACKEND is either an export back-end, as returned by, e.g.,
2983 `org-export-create-backend', or a symbol referring to
2984 a registered back-end."
2994 ;;;###autoload
2996 "Insert all export keywords with default values at beginning of line.
2998 BACKEND is a symbol referring to the name of a registered export
2999 back-end, for which specific export options should be added to
3000 the template, or `default' for default template. When it is nil,
3001 the user will be prompted for a category.
3003 If SUBTREEP is non-nil, export configuration will be set up
3004 locally for the subtree through node properties."
3014 "Options category: "
3018 org-export--registered-backends))
3019 nil t))))
3020 options keywords)
3021 ;; Populate OPTIONS and KEYWORDS.
3038 ;; Move to an appropriate location in order to insert options.
3040 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3058 ;; Then the rest of keywords, in the order specified in either
3059 ;; `org-export-options-alist' or respective export back-ends.
3080 "Expand every include keyword in buffer.
3081 Optional argument INCLUDED is a list of included file names along
3082 with their line restriction, when appropriate. It is used to
3083 avoid infinite recursion. Optional argument DIR is the current
3084 working directory. It is used to properly resolve relative
3085 paths. Optional argument FOOTNOTES is a hash-table used for
3086 storing and resolving footnotes. It is created automatically."
3092 ;; If :minlevel is not set the text-property
3093 ;; `:org-include-induced-level' will be used to determine the
3094 ;; relative level when expanding INCLUDE.
3095 ;; Only affects included Org documents.
3099 :org-include-induced-level
3101 ;; Expand INCLUDE keywords.
3107 ;; Extract arguments from keyword's value.
3110 location
3122 matched)
3123 dir)))
3132 value)
3139 ;; Minimal level of included file defaults to the child
3140 ;; level of the current headline, if any, or one. It
3141 ;; only applies is the file is meant to be included as
3142 ;; an Org one.
3153 ;; Remove keyword.
3159 ;; Check if files has already been parsed. Look after
3160 ;; inclusion lines too, as different parts of the same file
3161 ;; can be included too.
3176 ind-str block arg-str contents ind-str block))))
3183 ind-str block contents ind-str block))))
3191 file location only-contents lines)
3192 lines)))
3195 file lines ind minlevel
3198 footnotes)))
3202 footnotes)
3204 ;; Expand footnotes after all files have been
3205 ;; included. Footnotes are stored at end of buffer.
3210 footnotes)))))))))))
3213 "Resolve absolute lines for an included file with file-link.
3215 FILE is string file-name of the file to include. LOCATION is a
3216 string name within FILE to be included (located via
3217 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3218 contents of the named element will be included, as determined
3219 Org-Element. If LINES is non-nil only those lines are included.
3221 Return a string of lines to be included in the format expected by
3222 `org-export--prepare-file-contents'."
3228 ;; Enforce consistent search.
3241 ;; Skip planning line and property-drawer.
3267 start-line
3269 (+ start-line
3272 counter))))))))
3275 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3277 REF-BEGIN corresponds to the property `:begin' of objects of type
3278 footnote-definition and footnote-reference.
3280 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3281 \[N] where N is one or more numbers.
3283 Return the new label."
3293 "Prepare contents of FILE for inclusion and return it as a string.
3295 When optional argument LINES is a string specifying a range of
3296 lines, include only those lines.
3298 Optional argument IND, when non-nil, is an integer specifying the
3299 global indentation of returned contents. Since its purpose is to
3300 allow an included file to stay in the same environment it was
3301 created \(i.e. a list item), it doesn't apply past the first
3302 headline encountered.
3304 Optional argument MINLEVEL, when non-nil, is an integer
3305 specifying the level that any top-level headline in the included
3306 file should have.
3307 Optional argument ID is an integer that will be inserted before
3308 each footnote definition and reference if FILE is an Org file.
3309 This is useful to avoid conflicts when more than one Org file
3310 with footnotes is included in a document.
3312 Optional argument FOOTNOTES is a hash-table to store footnotes in
3313 the included document.
3314 "
3330 ;; Remove blank lines at beginning and end of contents. The logic
3331 ;; behind that removal is that blank lines around include keyword
3332 ;; override blank lines in included file.
3341 ;; If IND is set, preserve indentation of include keyword until
3342 ;; the first headline encountered.
3349 ;; Do not move footnote definitions out of column 0.
3355 ;; When MINLEVEL is specified, compute minimal level for headlines
3356 ;; in the file (CUR-MIN), and remove stars to each headline so
3357 ;; that headlines with minimal level have a level of MINLEVEL.
3368 ;; Only change stars, don't bother moving whole
3369 ;; sections.
3373 ;; Append ID to all footnote references and definitions, so they
3374 ;; become file specific and cannot collide with footnotes in other
3375 ;; included files. Further, collect relevant footnotes outside of
3376 ;; LINES.
3386 ;; Update the footnote-reference at point and collect
3387 ;; the new label, which is only used for footnotes
3388 ;; outsides LINES.
3390 ;; If label is akin to [1] convert it to [fn:ID-1].
3391 ;; Otherwise add "ID-" after "fn:".
3401 ;; Store since footnote-definition is outside of LINES.
3404 footnotes)
3405 ;; Update label of definition since it is included directly.
3412 "Execute every Babel code in the visible part of current buffer."
3413 ;; Get a pristine copy of current buffer so Babel references can be
3414 ;; properly resolved.
3420 "Return a non-nil value when output should be added to the kill ring.
3421 See also `org-export-copy-to-kill-ring'."
3427 \f
3428 ;;; Tools For Back-Ends
3429 ;;
3430 ;; A whole set of tools is available to help build new exporters. Any
3431 ;; function general enough to have its use across many back-ends
3432 ;; should be added here.
3434 ;;;; For Affiliated Keywords
3435 ;;
3436 ;; `org-export-read-attribute' reads a property from a given element
3437 ;; as a plist. It can be used to normalize affiliated keywords'
3438 ;; syntax.
3439 ;;
3440 ;; Since captions can span over multiple lines and accept dual values,
3441 ;; their internal representation is a bit tricky. Therefore,
3442 ;; `org-export-get-caption' transparently returns a given element's
3443 ;; caption as a secondary string.
3446 "Turn ATTRIBUTE property from ELEMENT into a plist.
3448 When optional argument PROPERTY is non-nil, return the value of
3449 that property within attributes.
3453 properties.
3455 All values will become strings except the empty string and
3458 will become the empty string."
3472 s)
3477 ;; Ignore any string before first property with `cdr'.
3482 "Return caption from ELEMENT as a secondary string.
3484 When optional argument SHORTP is non-nil, return short caption,
3485 as a secondary string, instead.
3487 Caption lines are separated by a white space."
3495 ;;;; For Derived Back-ends
3496 ;;
3497 ;; `org-export-with-backend' is a function allowing to locally use
3498 ;; another back-end to transcode some object or element. In a derived
3499 ;; back-end, it may be used as a fall-back function once all specific
3500 ;; cases have been treated.
3503 "Call a transcoder from BACKEND on DATA.
3504 BACKEND is an export back-end, as returned by, e.g.,
3505 `org-export-create-backend', or a symbol referring to
3506 a registered back-end. DATA is an Org element, object, secondary
3507 string or string. CONTENTS, when non-nil, is the transcoded
3508 contents of DATA element, as a string. INFO, when non-nil, is
3509 the communication channel used for export, as a plist."
3519 transcoder data contents
3522 :translate-alist all-transcoders
3526 ;;;; For Export Snippets
3527 ;;
3528 ;; Every export snippet is transmitted to the back-end. Though, the
3529 ;; latter will only retain one type of export-snippet, ignoring
3530 ;; others, based on the former's target back-end. The function
3531 ;; `org-export-snippet-backend' returns that back-end for a given
3532 ;; export-snippet.
3535 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3536 Translation, with `org-export-snippet-translation-alist', is
3537 applied."
3541 back-end))))
3544 ;;;; For Footnotes
3545 ;;
3546 ;; `org-export-collect-footnote-definitions' is a tool to list
3547 ;; actually used footnotes definitions in the whole parse tree, or in
3548 ;; a headline, in order to add footnote listings throughout the
3549 ;; transcoded data.
3550 ;;
3551 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3552 ;; back-ends, when they need to attach the footnote definition only to
3553 ;; the first occurrence of the corresponding label.
3554 ;;
3555 ;; `org-export-get-footnote-definition' and
3556 ;; `org-export-get-footnote-number' provide easier access to
3557 ;; additional information relative to a footnote reference.
3560 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3561 INFO is the plist used as a communication channel. If no such
3562 definition can be found, raise an error."
3571 "Apply FUNCTION on every footnote reference in DATA.
3572 INFO is a plist containing export state. By default, as soon as
3573 a new footnote reference is encountered, FUNCTION is called onto
3574 its definition. However, if BODY-FIRST is non-nil, this step is
3575 delayed until the end of the process."
3581 ;; Search footnote references through DATA, filling
3582 ;; SEEN-REFS along the way. When DELAYP is non-nil, store
3583 ;; footnote definitions so they can be entered later.
3590 ;; Search for subsequent references in footnote
3591 ;; definition so numbering follows reading logic,
3592 ;; unless DELAYP in non-nil.
3596 definitions))
3597 ;; Do not force entering inline definitions,
3598 ;; since `org-element-map' already traverses them
3599 ;; at the right time.
3603 nil))))))
3604 info nil
3605 ;; Don't enter footnote definitions since it will happen
3606 ;; when their first reference is found. Moreover, if
3607 ;; DELAYP is non-nil, make sure we postpone entering
3608 ;; definitions of inline references.
3615 "Return an alist between footnote numbers, labels and definitions.
3617 INFO is the current export state, as a plist.
3619 Definitions are collected throughout the whole parse tree, or
3620 DATA when non-nil.
3622 Sorting is done by order of references. As soon as a new
3623 reference is encountered, other references are searched within
3624 its definition. However, if BODY-FIRST is non-nil, this step is
3625 delayed after the whole tree is checked. This alters results
3626 when references are found in footnote definitions.
3628 Definitions either appear as Org data or as a secondary string
3629 for inlined footnotes. Unreferenced definitions are ignored."
3633 ;; Collect footnote number, label and definition.
3644 "Non-nil when a footnote reference is the first one for its label.
3646 FOOTNOTE-REFERENCE is the footnote reference being considered.
3647 INFO is a plist containing current export state.
3649 Search is done throughout the whole parse tree, or DATA when
3650 non-nil.
3652 By default, as soon as a new footnote reference is encountered,
3653 other references are searched within its definition. However, if
3654 BODY-FIRST is non-nil, this step is delayed after the whole tree
3655 is checked. This alters results when references are found in
3656 footnote definitions."
3658 ;; Anonymous footnotes are always a first reference.
3669 "Return number associated to a footnote.
3671 FOOTNOTE is either a footnote reference or a footnote definition.
3672 INFO is the plist containing export state.
3674 Number is unique throughout the whole parse tree, or DATA, when
3675 non-nil.
3677 By default, as soon as a new footnote reference is encountered,
3678 counting process moves into its definition. However, if
3679 BODY-FIRST is non-nil, this step is delayed until the end of the
3680 process, leading to a different order when footnotes are nested."
3689 ;; Anonymous footnote match: return number.
3691 ;; Labels match: return number.
3693 ;; Otherwise store label and increase counter if label
3694 ;; wasn't encountered yet.
3700 ;;;; For Headlines
3701 ;;
3702 ;; `org-export-get-relative-level' is a shortcut to get headline
3703 ;; level, relatively to the lower headline level in the parsed tree.
3704 ;;
3705 ;; `org-export-get-headline-number' returns the section number of an
3706 ;; headline, while `org-export-number-to-roman' allows to convert it
3707 ;; to roman numbers. With an optional argument,
3708 ;; `org-export-get-headline-number' returns a number to unnumbered
3709 ;; headlines (used for internal id).
3710 ;;
3711 ;; `org-export-get-headline-id' returns the unique internal id of a
3712 ;; headline.
3713 ;;
3714 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3715 ;; `org-export-last-sibling-p' are three useful predicates when it
3716 ;; comes to fulfill the `:headline-levels' property.
3717 ;;
3718 ;; `org-export-get-tags', `org-export-get-category' and
3719 ;; `org-export-get-node-property' extract useful information from an
3720 ;; headline or a parent headline. They all handle inheritance.
3721 ;;
3722 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3723 ;; as a secondary string, suitable for table of contents. It falls
3724 ;; back onto default title.
3727 "Return HEADLINE relative level within current parsed tree.
3728 INFO is a plist holding contextual information."
3733 "Non-nil when HEADLINE is considered as low level.
3735 INFO is a plist used as a communication channel.
3737 A low level headlines has a relative level greater than
3738 `:headline-levels' property value.
3740 Return value is the difference between HEADLINE relative level
3741 and the last level being considered as high enough, or nil."
3748 "Return a unique ID for HEADLINE.
3749 INFO is a plist holding contextual information."
3759 "Return numbered HEADLINE numbering as a list of numbers.
3760 INFO is a plist holding contextual information."
3765 "Return a non-nil value if HEADLINE element should be numbered.
3766 INFO is a plist used as a communication channel."
3775 "Convert integer N into a roman numeral."
3788 res)))
3791 "Return list of tags associated to ELEMENT.
3793 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3794 is a plist used as a communication channel.
3796 Select tags (see `org-export-select-tags') and exclude tags (see
3797 `org-export-exclude-tags') are removed from the list.
3799 When non-nil, optional argument TAGS should be a list of strings.
3800 Any tag belonging to this list will also be removed.
3802 When optional argument INHERITED is non-nil, tags can also be
3803 inherited from parent headlines and FILETAGS keywords."
3809 ;; Build complete list of inherited tags.
3816 ;; Add FILETAGS keywords and return results.
3820 "Return node PROPERTY value for BLOB.
3822 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3823 element or object.
3825 If optional argument INHERITED is non-nil, the value can be
3826 inherited from a parent headline.
3828 Return value is a string or nil."
3840 "Return category for element or object BLOB.
3842 INFO is a plist used as a communication channel.
3844 CATEGORY is automatically inherited from a parent headline, from
3845 #+CATEGORY: keyword or created out of original file name. If all
3858 "Return alternative title for HEADLINE, as a secondary string.
3859 INFO is a plist used as a communication channel. If no optional
3860 title is defined, fall-back to the regular title."
3867 "Non-nil when BLOB is the first sibling in its parent.
3868 BLOB is an element or an object. If BLOB is a headline, non-nil
3869 means it is the first sibling in the sub-tree. INFO is a plist
3870 used as a communication channel."
3875 "Non-nil when BLOB is the last sibling in its parent.
3876 BLOB is an element or an object. INFO is a plist used as
3877 a communication channel."
3881 ;;;; For Keywords
3882 ;;
3883 ;; `org-export-get-date' returns a date appropriate for the document
3884 ;; to about to be exported. In particular, it takes care of
3885 ;; `org-export-date-timestamp-format'.
3888 "Return date value for the current document.
3890 INFO is a plist used as a communication channel. FMT, when
3891 non-nil, is a time format string that will be applied on the date
3892 if it consists in a single timestamp object. It defaults to
3893 `org-export-date-timestamp-format' when nil.
3895 A proper date can be a secondary string, a string or nil. It is
3896 meant to be translated with `org-export-data' or alike."
3907 ;;;; For Links
3908 ;;
3909 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3910 ;; with `org-add-link-type', which see.
3911 ;;
3912 ;; `org-export-solidify-link-text' turns a string into a safer version
3913 ;; for links, replacing most non-standard characters with hyphens.
3914 ;;
3915 ;; `org-export-get-coderef-format' returns an appropriate format
3916 ;; string for coderefs.
3917 ;;
3918 ;; `org-export-inline-image-p' returns a non-nil value when the link
3919 ;; provided should be considered as an inline image.
3920 ;;
3921 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3922 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3923 ;; returns an appropriate unique identifier when found, or nil.
3924 ;;
3925 ;; `org-export-resolve-id-link' returns the first headline with
3926 ;; specified id or custom-id in parse tree, the path to the external
3927 ;; file with the id or nil when neither was found.
3928 ;;
3929 ;; `org-export-resolve-coderef' associates a reference to a line
3930 ;; number in the element it belongs, or returns the reference itself
3931 ;; when the element isn't numbered.
3934 "Take link text S and make a safe target out of it."
3939 "Try exporting LINK with a dedicated function.
3941 DESC is its description, as a string, or nil. BACKEND is the
3942 back-end used for export, as a symbol.
3944 Return output as a string, or nil if no protocol handles LINK.
3946 A custom protocol has precedence over regular back-end export.
3947 The function ignores links with an implicit type (e.g.,
3956 desc
3957 backend))))))
3960 "Return format string for code reference link.
3961 PATH is the link path. DESC is its description."
3969 "Non-nil if LINK object points to an inline image.
3971 Optional argument is a set of RULES defining inline images. It
3972 is an alist where associations have the following shape:
3974 \(TYPE . REGEXP)
3976 Applying a rule means apply REGEXP against LINK's path when its
3977 type is TYPE. The function will return a non-nil value if any of
3978 the provided rules is non-nil. The default rule is
3979 `org-export-default-inline-image-rule'.
3981 This only applies to links without a description."
3992 "Resolve a code reference REF.
3994 INFO is a plist used as a communication channel.
3996 Return associated line number in source code, or REF itself,
3997 depending on src-block or example element's switches. Throw an
3998 error if no block contains REF."
4005 org-coderef-label-format)))
4009 ;; Element containing REF is found. Resolve it to
4010 ;; either a label or a line number, as needed.
4021 "Return LINK destination.
4023 INFO is a plist holding contextual information.
4025 Return value can be an object, an element, or nil:
4027 - If LINK path matches a target object (i.e. <<path>>) return it.
4029 - If LINK path exactly matches the name affiliated keyword
4030 \(i.e. #+NAME: path) of an element, return that element.
4032 - If LINK path exactly matches any headline name, return that
4033 element. If more than one headline share that name, priority
4034 will be given to the one with the closest common ancestor, if
4035 any, or the first one in the parse tree otherwise.
4037 - Otherwise, throw an error.
4040 significant."
4043 ;; Split PATH at white spaces so matches are space
4044 ;; insensitive.
4047 ;; Cache for destinations that are not position dependent.
4055 ;; Destination is not position dependent: use cached value.
4057 ;; First try to find a matching "<<path>>" unless user specified
4058 ;; he was looking for a headline (path starts with a "*"
4059 ;; character).
4065 path)
4066 blob))
4069 ;; Then try to find an element with a matching "#+NAME: path"
4070 ;; affiliated keyword.
4073 org-element-all-elements
4078 el)))
4081 ;; Last case: link either points to a headline or to nothingness.
4082 ;; Try to find the source, with priority given to headlines with
4083 ;; the closest common ancestor. If such candidate is found,
4084 ;; return it, otherwise signal an error.
4088 ;; Return first headline whose `:raw-value' property is
4089 ;; NAME in parse tree DATA, or nil. Statistics cookies
4090 ;; are ignored.
4098 name)
4099 headline))
4101 ;; Search among headlines sharing an ancestor with link, from
4102 ;; closest to farthest.
4110 ;; No destination found: error.
4114 "Return headline referenced as LINK destination.
4116 INFO is a plist used as a communication channel.
4118 Return value can be the headline element matched in current parse
4122 ;; First check if id is within the current parse tree.
4127 headline))
4129 ;; Otherwise, look for external files.
4134 "Return radio-target object referenced as LINK destination.
4136 INFO is a plist used as a communication channel.
4138 Return value can be a radio-target object or nil. Assume LINK
4147 nil nil path nil nil t)
4148 t)
4149 radio))
4153 ;;;; For References
4154 ;;
4155 ;; `org-export-get-ordinal' associates a sequence number to any object
4156 ;; or element.
4159 "Return ordinal number of an element or object.
4161 ELEMENT is the element or object considered. INFO is the plist
4162 used as a communication channel.
4164 Optional argument TYPES, when non-nil, is a list of element or
4165 object types, as symbols, that should also be counted in.
4166 Otherwise, only provided element's type is considered.
4168 Optional argument PREDICATE is a function returning a non-nil
4169 value if the current element or object should be counted in. It
4170 accepts two arguments: the element or object being considered and
4171 the plist used as a communication channel. This allows to count
4172 only a certain type of objects (i.e. inline images).
4174 Return value is a list of numbers if ELEMENT is a headline or an
4175 item. It is nil for keywords. It represents the footnote number
4176 for footnote definitions and footnote references. If ELEMENT is
4177 a target, return the same value as if ELEMENT was the closest
4178 table, item or headline containing the target. In any other
4179 case, return the sequence number of ELEMENT among elements or
4180 objects of the same type."
4181 ;; Ordinal of a target object refer to the ordinal of the closest
4182 ;; table, item, or headline containing the object.
4186 element
4189 ;; Special case 1: A headline returns its number as a list.
4191 ;; Special case 2: An item returns its number as a list.
4195 struct
4202 ;; Increment counter until ELEMENT is found again.
4213 ;;;; For Src-Blocks
4214 ;;
4215 ;; `org-export-get-loc' counts number of code lines accumulated in
4216 ;; src-block or example-block elements with a "+n" switch until
4217 ;; a given element, excluded. Note: "-n" switches reset that count.
4218 ;;
4219 ;; `org-export-unravel-code' extracts source code (along with a code
4220 ;; references alist) from an `element-block' or `src-block' type
4221 ;; element.
4222 ;;
4223 ;; `org-export-format-code' applies a formatting function to each line
4224 ;; of code, providing relative line number and code reference when
4225 ;; appropriate. Since it doesn't access the original element from
4226 ;; which the source code is coming, it expects from the code calling
4227 ;; it to know if lines should be numbered and if code references
4228 ;; should appear.
4229 ;;
4230 ;; Eventually, `org-export-format-code-default' is a higher-level
4231 ;; function (it makes use of the two previous functions) which handles
4232 ;; line numbering and code references inclusion, and returns source
4233 ;; code in a format suitable for plain text or verbatim output.
4236 "Return accumulated lines of code up to ELEMENT.
4238 INFO is the plist used as a communication channel.
4240 ELEMENT is excluded from count."
4246 ;; ELEMENT is reached: Quit the loop.
4248 ;; Only count lines from src-block and example-block elements
4249 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4253 ;; Accumulate locs or reset them.
4257 ;; Return nil to stay in the loop.
4258 nil)))
4260 ;; Return value.
4261 loc))
4264 "Clean source code and extract references out of it.
4266 ELEMENT has either a `src-block' an `example-block' type.
4268 Return a cons cell whose CAR is the source code, cleaned from any
4269 reference, protective commas and spurious indentation, and CDR is
4270 an alist between relative line number (integer) and name of code
4271 reference on that line (string)."
4274 ;; Get code and clean it. Remove blank lines at its
4275 ;; beginning and end.
4282 value
4284 ;; Get format used for references.
4287 org-coderef-label-format)))
4288 ;; Build a regexp matching a loc with a reference.
4293 ;; Return value.
4295 ;; Code with references removed.
4301 ;; Ref line: remove ref, and signal its position in REFS.
4305 ;; Reference alist.
4306 refs)))
4309 "Format CODE by applying FUN line-wise and return it.
4311 CODE is a string representing the code to format. FUN is
4312 a function. It must accept three arguments: a line of
4313 code (string), the current line number (integer) or nil and the
4314 reference associated to the current line (string) or nil.
4316 Optional argument NUM-LINES can be an integer representing the
4317 number of code lines accumulated until the current code. Line
4318 numbers passed to FUN will take it into account. If it is nil,
4319 FUN's second argument will always be nil. This number can be
4320 obtained with `org-export-get-loc' function.
4322 Optional argument REF-ALIST can be an alist between relative line
4323 number (i.e. ignoring NUM-LINES) and the name of the code
4324 reference on it. If it is nil, FUN's third argument will always
4325 be nil. It can be obtained through the use of
4326 `org-export-unravel-code' function."
4338 "Return source code from ELEMENT, formatted in a standard way.
4340 ELEMENT is either a `src-block' or `example-block' element. INFO
4341 is a plist used as a communication channel.
4343 This function takes care of line numbering and code references
4344 inclusion. Line numbers, when applicable, appear at the
4345 beginning of the line, separated from the code by two white
4346 spaces. Code references, on the other hand, appear flushed to
4347 the right, separated by six white spaces from the widest line of
4348 code."
4349 ;; Extract code and references.
4356 ;; Handle line numbering.
4365 ;; Prepare references display, if required. Any reference
4366 ;; should start six columns after the widest line of code,
4367 ;; wrapped with parenthesis.
4372 code
4376 number-str
4377 loc
4383 num-start refs)))))
4386 ;;;; For Tables
4387 ;;
4388 ;; `org-export-table-has-special-column-p' and and
4389 ;; `org-export-table-row-is-special-p' are predicates used to look for
4390 ;; meta-information about the table structure.
4391 ;;
4392 ;; `org-table-has-header-p' tells when the rows before the first rule
4393 ;; should be considered as table's header.
4394 ;;
4395 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4396 ;; and `org-export-table-cell-borders' extract information from
4397 ;; a table-cell element.
4398 ;;
4399 ;; `org-export-table-dimensions' gives the number on rows and columns
4400 ;; in the table, ignoring horizontal rules and special columns.
4401 ;; `org-export-table-cell-address', given a table-cell object, returns
4402 ;; the absolute address of a cell. On the other hand,
4403 ;; `org-export-get-table-cell-at' does the contrary.
4404 ;;
4405 ;; `org-export-table-cell-starts-colgroup-p',
4406 ;; `org-export-table-cell-ends-colgroup-p',
4407 ;; `org-export-table-row-starts-rowgroup-p',
4408 ;; `org-export-table-row-ends-rowgroup-p',
4409 ;; `org-export-table-row-starts-header-p',
4410 ;; `org-export-table-row-ends-header-p' and
4411 ;; `org-export-table-row-in-header-p' indicate position of current row
4412 ;; or cell within the table.
4415 "Non-nil when TABLE has a special column.
4416 All special columns will be ignored during export."
4417 ;; The table has a special column when every first cell of every row
4418 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4419 ;; "*" "_" and "^". Though, do not consider a first row containing
4420 ;; only empty cells as special.
4436 "Non-nil when TABLE has a header.
4438 INFO is a plist used as a communication channel.
4440 A table has a header when it contains at least two row groups."
4449 table
4460 cache)))))
4463 "Non-nil if TABLE-ROW is considered special.
4465 INFO is a plist used as the communication channel.
4467 All special rows will be ignored during export."
4471 ;; A row is special either when...
4473 ;; ... it starts with a field only containing "/",
4475 ;; ... the table contains a special column and the row start
4476 ;; with a marking character among, "^", "_", "$" or "!",
4480 ;; ... it contains only alignment cookies and empty cells.
4486 ;; Since VALUE is a secondary string, the following
4487 ;; checks avoid expanding it with `org-export-data'.
4499 "Return TABLE-ROW's group number, as an integer.
4501 INFO is a plist used as the communication channel.
4503 Return value is the group number, as an integer, or nil for
4504 special rows and rows separators. First group is also table's
4505 header."
4523 "Return TABLE-CELL contents width.
4525 INFO is a plist used as the communication channel.
4527 Return value is the width given by the last width cookie in the
4528 same column as TABLE-CELL, or nil."
4547 ;; In a special row, try to find a width cookie at COLUMN.
4551 ;; The following checks avoid expanding unnecessarily
4552 ;; the cell with `org-export-data'.
4562 "Return TABLE-CELL contents alignment.
4564 INFO is a plist used as the communication channel.
4566 Return alignment as specified by the last alignment cookie in the
4567 same column as TABLE-CELL. If no such cookie is found, a default
4568 alignment value will be deduced from fraction of numbers in the
4569 column (see `org-table-number-fraction' for more information).
4570 Possible values are `left', `right' and `center'."
4571 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4588 cookie-align
4589 previous-cell-number-p)
4592 ;; In a special row, try to find an alignment cookie at
4593 ;; COLUMN.
4597 ;; Since VALUE is a secondary string, the following
4598 ;; checks avoid useless expansion through
4599 ;; `org-export-data'.
4607 ;; Ignore table rules.
4609 ;; In a standard row, check if cell's contents are
4610 ;; expressing some kind of number. Increase NUMBER-CELLS
4611 ;; accordingly. Though, don't bother if an alignment
4612 ;; cookie has already defined cell's alignment.
4617 info)))
4619 ;; Treat an empty cell as a number if it follows
4620 ;; a number.
4626 ;; Return value. Alignment specified by cookies has
4627 ;; precedence over alignment deduced from cell's contents.
4629 column
4634 org-table-number-fraction)
4639 "Return TABLE-CELL borders.
4641 INFO is a plist used as a communication channel.
4643 Return value is a list of symbols, or nil. Possible values are:
4644 `top', `bottom', `above', `below', `left' and `right'. Note:
4645 `top' (resp. `bottom') only happen for a cell in the first
4646 row (resp. last row) of the table, ignoring table rules, if any.
4648 Returned borders ignore special rows."
4651 borders)
4652 ;; Top/above border? TABLE-CELL has a border above when a rule
4653 ;; used to demarcate row groups can be found above. Hence,
4654 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4655 ;; another regular row has to be found above that rule.
4664 ;; Look at every row before the current one.
4666 ;; No rule above, or rule found starts the table (ignoring any
4667 ;; special row): TABLE-CELL is at the top of the table.
4670 ;; Bottom/below border? TABLE-CELL has a border below when next
4671 ;; non-regular row below is a rule.
4680 ;; Look at every row after the current one.
4682 ;; No rule below, or rule found ends the table (modulo some
4683 ;; special row): TABLE-CELL is at the bottom of the table.
4686 ;; Right/left borders? They can only be specified by column
4687 ;; groups. Column groups are defined in a row starting with "/".
4688 ;; Also a column groups row only contains "<", "<>", ">" or blank
4689 ;; cells.
4706 ;; There's a left border when previous cell, if
4707 ;; any, ends a group, or current one starts one.
4713 ;; There's a right border when next cell, if any,
4714 ;; starts a group, or current one ends one.
4721 ;; Table rows are read in reverse order so last column groups
4722 ;; row has precedence over any previous one.
4724 ;; Return value.
4725 borders))
4728 "Non-nil when TABLE-CELL is at the beginning of a column group.
4729 INFO is a plist used as a communication channel."
4730 ;; A cell starts a column group either when it is at the beginning
4731 ;; of a row (or after the special column, if any) or when it has
4732 ;; a left border.
4735 table-cell)
4739 "Non-nil when TABLE-CELL is at the end of a column group.
4740 INFO is a plist used as a communication channel."
4741 ;; A cell ends a column group either when it is at the end of a row
4742 ;; or when it has a right border.
4745 table-cell)
4749 "Non-nil when TABLE-ROW is at the beginning of a row group.
4750 INFO is a plist used as a communication channel."
4758 "Non-nil when TABLE-ROW is at the end of a row group.
4759 INFO is a plist used as a communication channel."
4767 "Non-nil when TABLE-ROW is located within table's header.
4768 INFO is a plist used as a communication channel. Always return
4769 nil for special rows and rows separators."
4775 "Non-nil when TABLE-ROW is the first table header's row.
4776 INFO is a plist used as a communication channel."
4781 "Non-nil when TABLE-ROW is the last table header's row.
4782 INFO is a plist used as a communication channel."
4787 "Return TABLE-ROW number.
4788 INFO is a plist used as a communication channel. Return value is
4789 zero-based and ignores separators. The function returns nil for
4790 special columns and separators."
4802 "Return TABLE dimensions.
4804 INFO is a plist used as a communication channel.
4806 Return value is a CONS like (ROWS . COLUMNS) where
4807 ROWS (resp. COLUMNS) is the number of exportable
4808 rows (resp. columns)."
4810 ;; Set number of rows, and extract first one.
4816 ;; Set number of columns.
4818 ;; Return value.
4822 "Return address of a regular TABLE-CELL object.
4824 TABLE-CELL is the cell considered. INFO is a plist used as
4825 a communication channel.
4827 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4828 zero-based index. Only exportable cells are considered. The
4829 function returns nil for other cells."
4841 "Return regular table-cell object at ADDRESS in TABLE.
4843 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4844 zero-based index. TABLE is a table type element. INFO is
4845 a plist used as a communication channel.
4847 If no table-cell, among exportable cells, is found at ADDRESS,
4848 return nil."
4851 ;; Row at (car address) or nil.
4859 'table-cell
4866 ;;;; For Tables Of Contents
4867 ;;
4868 ;; `org-export-collect-headlines' builds a list of all exportable
4869 ;; headline elements, maybe limited to a certain depth. One can then
4870 ;; easily parse it and transcode it.
4871 ;;
4872 ;; Building lists of tables, figures or listings is quite similar.
4873 ;; Once the generic function `org-export-collect-elements' is defined,
4874 ;; `org-export-collect-tables', `org-export-collect-figures' and
4875 ;; `org-export-collect-listings' can be derived from it.
4878 "Collect headlines in order to build a table of contents.
4880 INFO is a plist used as a communication channel.
4882 When optional argument N is an integer, it specifies the depth of
4883 the table of contents. Otherwise, it is set to the value of the
4884 last headline level. See `org-export-headline-levels' for more
4885 information.
4887 Optional argument SCOPE, when non-nil, is an element. If it is
4888 a headline, only children of SCOPE are collected. Otherwise,
4889 collect children of the headline containing provided element. If
4890 there is no such headline, collect all headlines. In any case,
4891 argument N becomes relative to the level of that headline.
4893 Return a list of all exportable headlines as parsed elements.
4894 Footnote sections are ignored."
4903 limit))))
4909 info)))
4912 "Collect referenceable elements of a determined type.
4914 TYPE can be a symbol or a list of symbols specifying element
4915 types to search. Only elements with a caption are collected.
4917 INFO is a plist used as a communication channel.
4919 When non-nil, optional argument PREDICATE is a function accepting
4920 one argument, an element of type TYPE. It returns a non-nil
4921 value when that element should be collected.
4923 Return a list of all elements found, in order of appearance."
4928 element))
4929 info))
4932 "Build a list of tables.
4933 INFO is a plist used as a communication channel.
4935 Return a list of table elements with a caption."
4939 "Build a list of figures.
4941 INFO is a plist used as a communication channel. PREDICATE is
4942 a function which accepts one argument: a paragraph element and
4943 whose return value is non-nil when that element should be
4944 collected.
4946 A figure is a paragraph type element, with a caption, verifying
4948 a vague concept that may depend on back-end.
4950 Return a list of elements recognized as figures."
4954 "Build a list of src blocks.
4956 INFO is a plist used as a communication channel.
4958 Return a list of src-block elements with a caption."
4962 ;;;; Smart Quotes
4963 ;;
4964 ;; The main function for the smart quotes sub-system is
4965 ;; `org-export-activate-smart-quotes', which replaces every quote in
4966 ;; a given string from the parse tree with its "smart" counterpart.
4967 ;;
4968 ;; Dictionary for smart quotes is stored in
4969 ;; `org-export-smart-quotes-alist'.
4970 ;;
4971 ;; Internally, regexps matching potential smart quotes (checks at
4972 ;; string boundaries are also necessary) are defined in
4973 ;; `org-export-smart-quotes-regexps'.
4977 ;; one may use: »...«, "...", ›...‹, or '...'.
4978 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4979 ;; LaTeX quotes require Babel!
5024 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5033 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5042 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5051 ;; 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
5052 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5063 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5069 )
5070 "Smart quotes translations.
5072 Alist whose CAR is a language string and CDR is an alist with
5073 quote type as key and a plist associating various encodings to
5074 their translation as value.
5076 A quote type can be any symbol among `opening-double-quote',
5077 `closing-double-quote', `opening-single-quote',
5078 `closing-single-quote' and `apostrophe'.
5080 Valid encodings include `:utf-8', `:html', `:latex' and
5081 `:texinfo'.
5086 "Return smart quote status at the beginning of string S.
5087 INFO is the current export state, as a plist."
5092 table)))
5107 ;; Not already in a level 1 quote: this is an
5108 ;; apostrophe.
5110 ;; Apostrophe.
5112 ;; Apostrophe at the beginning of a string. Check
5113 ;; white space at the end of the last object.
5122 ;; Apostrophe at the end of a string. Check white
5123 ;; space at the beginning of the next object, which
5124 ;; can only happen if that object is a string.
5131 ;; Lonesome apostrophe. Check white space around
5132 ;; both ends.
5144 n))))))))
5146 ;; Else, consider it as a level 2 quote.
5150 current-status))
5153 info nil org-element-recursive-objects)
5160 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5161 `:utf-8'. INFO is a plist used as a communication channel.
5163 The function has to retrieve information about string
5164 surroundings in parse tree. It can only happen with an
5165 unmodified string. Thus, if S has already been through another
5166 process, a non-nil ORIGINAL optional argument will provide that
5167 original string.
5169 Return the new string."
5178 org-export-smart-quotes-alist))))
5179 encoding)
5180 match))
5181 s nil t)))
5183 ;;;; Topology
5184 ;;
5185 ;; Here are various functions to retrieve information about the
5186 ;; neighborhood of a given element or object. Neighbors of interest
5187 ;; are direct parent (`org-export-get-parent'), parent headline
5188 ;; (`org-export-get-parent-headline'), first element containing an
5189 ;; object, (`org-export-get-parent-element'), parent table
5190 ;; (`org-export-get-parent-table'), previous element or object
5191 ;; (`org-export-get-previous-element') and next element or object
5192 ;; (`org-export-get-next-element').
5194 ;; defsubst org-export-get-parent must be defined before first use
5200 "Return BLOB parent headline or nil.
5201 BLOB is the element or object being considered."
5205 "Return first element containing OBJECT or nil.
5206 OBJECT is the object to consider."
5210 "Return OBJECT parent table or nil.
5211 OBJECT is either a `table-cell' or `table-element' type object."
5215 "Return previous element or object.
5217 BLOB is an element or object. INFO is a plist used as
5218 a communication channel. Return previous exportable element or
5219 object, a string, or nil.
5221 When optional argument N is a positive integer, return a list
5222 containing up to N siblings before BLOB, from farthest to
5223 closest. With any other non-nil value, return a list containing
5224 all of them."
5230 prev)
5240 "Return next element or object.
5242 BLOB is an element or object. INFO is a plist used as
5243 a communication channel. Return next exportable element or
5244 object, a string, or nil.
5246 When optional argument N is a positive integer, return a list
5247 containing up to N siblings after BLOB, from closest to farthest.
5248 With any other non-nil value, return a list containing all of
5249 them."
5256 next)
5266 ;;;; Translation
5267 ;;
5268 ;; `org-export-translate' translates a string according to the language
5269 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5270 ;; the dictionary used for the translation.
5318 ("ru" :html "(Продолжение следует)"
5421 ("ru" :html "Список распечаток"
5435 ("ru" :html "Список таблиц"
5527 ("ru" :html "Неизвестная ссылка"
5530 "Dictionary for export engine.
5532 Alist whose car is the string to translate and cdr is an alist
5533 whose car is the language string and cdr is a plist whose
5534 properties are possible charsets and values translated terms.
5536 It is used as a database for `org-export-translate'. Since this
5537 function returns the string as-is if no translation was found,
5538 the variable only needs to record values different from the
5542 "Translate string S according to language specification.
5544 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5545 and `:utf-8'. INFO is a plist used as a communication channel.
5547 Translation depends on `:language' property. Return the
5548 translated string. If no translation is found, try to fall back
5549 to `:default' encoding. If it fails, return S."
5555 s)))
5558 \f
5559 ;;; Asynchronous Export
5560 ;;
5561 ;; `org-export-async-start' is the entry point for asynchronous
5562 ;; export. It recreates current buffer (including visibility,
5563 ;; narrowing and visited file) in an external Emacs process, and
5564 ;; evaluates a command there. It then applies a function on the
5565 ;; returned results in the current process.
5566 ;;
5567 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5568 ;; allow to export to a buffer or a file, asynchronously or not.
5569 ;;
5570 ;; `org-export-output-file-name' is an auxiliary function meant to be
5571 ;; used with `org-export-to-file'. With a given extension, it tries
5572 ;; to provide a canonical file name to write export output to.
5573 ;;
5574 ;; Asynchronously generated results are never displayed directly.
5575 ;; Instead, they are stored in `org-export-stack-contents'. They can
5576 ;; then be retrieved by calling `org-export-stack'.
5577 ;;
5578 ;; Export Stack is viewed through a dedicated major mode
5579 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5580 ;;`org-export-stack-delete', `org-export-stack-view' and
5581 ;;`org-export-stack-clear'.
5582 ;;
5583 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5584 ;; It should be used whenever `org-export-async-start' is called.
5587 "Call function FUN on the results returned by BODY evaluation.
5589 FUN is an anonymous function of one argument. BODY evaluation
5590 happens in an asynchronous process, from a buffer which is an
5591 exact copy of the current one.
5593 Use `org-export-add-to-stack' in FUN in order to register results
5594 in the stack.
5596 This is a low level function. See also `org-export-to-buffer'
5597 and `org-export-to-file' for more specialized functions."
5600 ;; Write the full sexp evaluating BODY in a copy of the current
5601 ;; buffer to a temporary file, as it may be too long for program
5602 ;; args in `start-process'.
5609 ;; Null characters (from variable values) are inserted
5610 ;; within the file. As a consequence, coding system for
5611 ;; buffer contents will not be recognized properly. So,
5612 ;; we make sure it is the same as the one used to display
5613 ;; the original buffer.
5615 ,coding
5618 ;; Ignore `kill-emacs-hook' and code evaluation
5619 ;; queries from Babel as we need a truly
5620 ;; non-interactive process.
5622 org-babel-confirm-evaluate-answer-no t)
5623 ;; Initialize export framework.
5625 ;; Re-create current buffer there.
5628 ;; Sexp to evaluate in the buffer.
5630 ;; Start external process.
5633 (,process
5635 #'start-process
5638 ,proc-buffer
5645 ;; Register running process in stack.
5647 ;; Set-up sentinel in order to catch results.
5650 ,process
5672 ;;;###autoload
5675 &optional async subtreep visible-only body-only ext-plist
5676 post-process)
5677 "Call `org-export-as' with output to a specified buffer.
5679 BACKEND is either an export back-end, as returned by, e.g.,
5680 `org-export-create-backend', or a symbol referring to
5681 a registered back-end.
5683 BUFFER is the name of the output buffer. If it already exists,
5684 it will be erased first, otherwise, it will be created.
5686 A non-nil optional argument ASYNC means the process should happen
5687 asynchronously. The resulting buffer should then be accessible
5688 through the `org-export-stack' interface. When ASYNC is nil, the
5689 buffer is displayed if `org-export-show-temporary-export-buffer'
5690 is non-nil.
5692 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5693 EXT-PLIST are similar to those used in `org-export-as', which
5694 see.
5696 Optional argument POST-PROCESS is a function which should accept
5697 no argument. It is always called within the current process,
5698 from BUFFER, with point at its beginning. Export back-ends can
5699 use it to set a major mode there, e.g,
5701 \(defun org-latex-export-as-latex
5702 \(&optional async subtreep visible-only body-only ext-plist)
5703 \(interactive)
5705 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5707 This function returns BUFFER."
5735 buffer)))
5737 ;;;###autoload
5740 post-process)
5741 "Call `org-export-as' with output to a specified file.
5743 BACKEND is either an export back-end, as returned by, e.g.,
5744 `org-export-create-backend', or a symbol referring to
5745 a registered back-end. FILE is the name of the output file, as
5746 a string.
5748 A non-nil optional argument ASYNC means the process should happen
5749 asynchronously. The resulting buffer will then be accessible
5750 through the `org-export-stack' interface.
5752 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5753 EXT-PLIST are similar to those used in `org-export-as', which
5754 see.
5756 Optional argument POST-PROCESS is called with FILE as its
5757 argument and happens asynchronously when ASYNC is non-nil. It
5758 has to return a file name, or nil. Export back-ends can use this
5759 to send the output file through additional processing, e.g,
5761 \(defun org-latex-export-to-latex
5762 \(&optional async subtreep visible-only body-only ext-plist)
5763 \(interactive)
5765 \(org-export-to-file 'latex outfile
5766 async subtreep visible-only body-only ext-plist
5767 \(lambda (file) (org-latex-compile file)))
5769 The function returns either a file name returned by POST-PROCESS,
5770 or FILE."
5789 backend subtreep visible-only body-only ext-plist)))
5796 ;; Get proper return value.
5798 file))))))
5801 "Return output file's name according to buffer specifications.
5803 EXTENSION is a string representing the output file extension,
5804 with the leading dot.
5806 With a non-nil optional argument SUBTREEP, try to determine
5808 of subtree at point.
5810 When optional argument PUB-DIR is set, use it as the publishing
5811 directory.
5813 When optional argument VISIBLE-ONLY is non-nil, don't export
5814 contents of hidden elements.
5816 Return file name as a string."
5819 ;; File name may come from EXPORT_FILE_NAME subtree
5820 ;; property, assuming point is at beginning of said
5821 ;; sub-tree.
5828 ;; File name may be extracted from buffer's associated
5829 ;; file, if any.
5831 ;; Can't determine file name on our own: Ask user.
5835 "Output file: " pub-dir nil nil nil
5839 ;; Build file name. Enforce EXTENSION over whatever user
5840 ;; may have come up with. PUB-DIR, if defined, always has
5841 ;; precedence over any provided path.
5846 extension))
5849 ;; If writing to OUTPUT-FILE would overwrite original file, append
5850 ;; EXTENSION another time to final name.
5853 output-file)))
5856 "Add a new result to export stack if not present already.
5858 SOURCE is a buffer or a file name containing export results.
5859 BACKEND is a symbol representing export back-end used to generate
5860 it.
5862 Entries already pointing to SOURCE and unavailable entries are
5863 removed beforehand. Return the new stack."
5869 "Menu for asynchronous export results and running processes."
5879 "Return source from export results at point in stack."
5886 source
5887 ;; SOURCE is not consistent with current line. The stack
5888 ;; view is outdated.
5892 "Remove all entries from export stack."
5897 "Refresh the asynchronous export stack.
5898 DUMMY is ignored. Unavailable sources are removed from the list.
5899 Return the new stack."
5909 ;; Back-end.
5911 ;; Age.
5914 ;; Compute age of the results.
5916 "%4h:%.2m "
5918 ;; Source.
5923 ;; Clear stack from exited processes, dead buffers or
5924 ;; non-existent files.
5936 "Remove export results at point from stack.
5937 If optional argument SOURCE is non-nil, remove it instead."
5942 org-export-stack-contents))))
5945 "View export results at point in stack.
5946 With an optional prefix argument IN-EMACS, force viewing files
5947 within Emacs."
5961 (define-key km "p" 'previous-line)
5962 (define-key km "\C-p" 'previous-line)
5963 (define-key km "\C-?" 'previous-line)
5964 (define-key km [up] 'previous-line)
5965 (define-key km "C" 'org-export-stack-clear)
5966 (define-key km "v" 'org-export-stack-view)
5967 (define-key km (kbd "RET") 'org-export-stack-view)
5968 (define-key km "d" 'org-export-stack-remove)
5969 km)
5970 "Keymap for Org Export Stack.")
5972 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5973 "Mode for displaying asynchronous export stack.
5976 stack.
5978 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5979 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5980 stack completely.
5982 Removing entries in an Org Export Stack buffer doesn't affect
5983 files or buffers, only the display.
5986 (abbrev-mode 0)
5987 (auto-fill-mode 0)
5988 (setq buffer-read-only t
5989 buffer-undo-list t
5990 truncate-lines t
5991 header-line-format
5992 '(:eval
5993 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5994 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5995 (set (make-local-variable 'revert-buffer-function)
5996 'org-export-stack-refresh))
5999 \f
6000 ;;; The Dispatcher
6001 ;;
6002 ;; `org-export-dispatch' is the standard interactive way to start an
6003 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6004 ;; for its interface, which, in turn, delegates response to key
6005 ;; pressed to `org-export--dispatch-action'.
6007 ;;;###autoload
6008 (defun org-export-dispatch (&optional arg)
6009 "Export dispatcher for Org mode.
6011 It provides an access to common export related tasks in a buffer.
6012 Its interface comes in two flavors: standard and expert.
6014 While both share the same set of bindings, only the former
6015 displays the valid keys associations in a dedicated buffer.
6016 Scrolling (resp. line-wise motion) in this buffer is done with
6017 SPC and DEL (resp. C-n and C-p) keys.
6019 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6020 flavor or the other.
6023 of options used back then, on the current buffer.
6025 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6026 (interactive "P")
6027 (let* ((input
6028 (cond ((equal arg '(16)) '(stack))
6029 ((and arg org-export-dispatch-last-action))
6030 (t (save-window-excursion
6031 (unwind-protect
6032 (progn
6033 ;; Remember where we are
6034 (move-marker org-export-dispatch-last-position
6035 (point)
6036 (org-base-buffer (current-buffer)))
6037 ;; Get and store an export command
6038 (setq org-export-dispatch-last-action
6039 (org-export--dispatch-ui
6040 (list org-export-initial-scope
6041 (and org-export-in-background 'async))
6042 nil
6043 org-export-dispatch-use-expert-ui)))
6044 (and (get-buffer "*Org Export Dispatcher*")
6045 (kill-buffer "*Org Export Dispatcher*")))))))
6046 (action (car input))
6047 (optns (cdr input)))
6048 (unless (memq 'subtree optns)
6049 (move-marker org-export-dispatch-last-position nil))
6050 (case action
6051 ;; First handle special hard-coded actions.
6052 (template (org-export-insert-default-template nil optns))
6053 (stack (org-export-stack))
6054 (publish-current-file
6055 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6056 (publish-current-project
6057 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6058 (publish-choose-project
6059 (org-publish (assoc (org-icompleting-read
6060 "Publish project: "
6061 org-publish-project-alist nil t)
6062 org-publish-project-alist)
6063 (memq 'force optns)
6064 (memq 'async optns)))
6065 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6066 (otherwise
6067 (save-excursion
6068 (when arg
6069 ;; Repeating command, maybe move cursor to restore subtree
6070 ;; context.
6071 (if (eq (marker-buffer org-export-dispatch-last-position)
6072 (org-base-buffer (current-buffer)))
6073 (goto-char org-export-dispatch-last-position)
6074 ;; We are in a different buffer, forget position.
6075 (move-marker org-export-dispatch-last-position nil)))
6076 (funcall action
6077 ;; Return a symbol instead of a list to ease
6078 ;; asynchronous export macro use.
6079 (and (memq 'async optns) t)
6080 (and (memq 'subtree optns) t)
6081 (and (memq 'visible optns) t)
6082 (and (memq 'body optns) t)))))))
6084 (defun org-export--dispatch-ui (options first-key expertp)
6085 "Handle interface for `org-export-dispatch'.
6087 OPTIONS is a list containing current interactive options set for
6088 export. It can contain any of the following symbols:
6089 `body' toggles a body-only export
6090 `subtree' restricts export to current subtree
6091 `visible' restricts export to visible part of buffer.
6092 `force' force publishing files.
6093 `async' use asynchronous export process
6095 FIRST-KEY is the key pressed to select the first level menu. It
6096 is nil when this menu hasn't been selected yet.
6098 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6099 buffer is provided, but indications about currently active
6100 options are given in the prompt. Moreover, \[?] allows to switch
6101 back to standard interface."
6102 (let* ((fontify-key
6103 (lambda (key &optional access-key)
6104 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6105 ;; non-nil is the required first-level key to activate
6106 ;; KEY. When its value is t, activate KEY independently
6107 ;; on the first key, if any. A nil value means KEY will
6108 ;; only be activated at first level.
6109 (if (or (eq access-key t) (eq access-key first-key))
6110 (org-propertize key 'face 'org-warning)
6111 key)))
6112 (fontify-value
6113 (lambda (value)
6114 ;; Fontify VALUE string.
6115 (org-propertize value 'face 'font-lock-variable-name-face)))
6116 ;; Prepare menu entries by extracting them from registered
6117 ;; back-ends and sorting them by access key and by ordinal,
6118 ;; if any.
6119 (entries
6120 (sort (sort (delq nil
6121 (mapcar 'org-export-backend-menu
6122 org-export--registered-backends))
6123 (lambda (a b)
6124 (let ((key-a (nth 1 a))
6125 (key-b (nth 1 b)))
6126 (cond ((and (numberp key-a) (numberp key-b))
6127 (< key-a key-b))
6128 ((numberp key-b) t)))))
6129 'car-less-than-car))
6130 ;; Compute a list of allowed keys based on the first key
6131 ;; pressed, if any. Some keys
6132 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6133 ;; available.
6134 (allowed-keys
6135 (nconc (list 2 22 19 6 1)
6136 (if (not first-key) (org-uniquify (mapcar 'car entries))
6137 (let (sub-menu)
6138 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6139 (when (eq (car entry) first-key)
6140 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6141 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6142 ((not first-key) (list ?P)))
6143 (list ?& ?#)
6144 (when expertp (list ??))
6145 (list ?q)))
6146 ;; Build the help menu for standard UI.
6147 (help
6148 (unless expertp
6149 (concat
6150 ;; Options are hard-coded.
6151 (format "[%s] Body only: %s [%s] Visible only: %s
6152 \[%s] Export scope: %s [%s] Force publishing: %s
6154 (funcall fontify-key "C-b" t)
6155 (funcall fontify-value
6156 (if (memq 'body options) "On " "Off"))
6157 (funcall fontify-key "C-v" t)
6158 (funcall fontify-value
6159 (if (memq 'visible options) "On " "Off"))
6160 (funcall fontify-key "C-s" t)
6161 (funcall fontify-value
6162 (if (memq 'subtree options) "Subtree" "Buffer "))
6163 (funcall fontify-key "C-f" t)
6164 (funcall fontify-value
6165 (if (memq 'force options) "On " "Off"))
6166 (funcall fontify-key "C-a" t)
6167 (funcall fontify-value
6168 (if (memq 'async options) "On " "Off")))
6169 ;; Display registered back-end entries. When a key
6170 ;; appears for the second time, do not create another
6171 ;; entry, but append its sub-menu to existing menu.
6172 (let (last-key)
6173 (mapconcat
6174 (lambda (entry)
6175 (let ((top-key (car entry)))
6176 (concat
6177 (unless (eq top-key last-key)
6178 (setq last-key top-key)
6180 (funcall fontify-key (char-to-string top-key))
6181 (nth 1 entry)))
6182 (let ((sub-menu (nth 2 entry)))
6183 (unless (functionp sub-menu)
6184 ;; Split sub-menu into two columns.
6185 (let ((index -1))
6186 (concat
6187 (mapconcat
6188 (lambda (sub-entry)
6189 (incf index)
6190 (format
6191 (if (zerop (mod index 2)) " [%s] %-26s"
6193 (funcall fontify-key
6194 (char-to-string (car sub-entry))
6195 top-key)
6196 (nth 1 sub-entry)))
6197 sub-menu "")
6199 entries ""))
6200 ;; Publishing menu is hard-coded.
6202 [%s] Current file [%s] Current project
6204 (funcall fontify-key "P")
6205 (funcall fontify-key "f" ?P)
6206 (funcall fontify-key "p" ?P)
6207 (funcall fontify-key "x" ?P)
6208 (funcall fontify-key "a" ?P))
6210 (funcall fontify-key "&" t)
6211 (funcall fontify-key "#" t))
6212 (format "[%s] %s"
6213 (funcall fontify-key "q" t)
6214 (if first-key "Main menu" "Exit")))))
6215 ;; Build prompts for both standard and expert UI.
6216 (standard-prompt (unless expertp "Export command: "))
6217 (expert-prompt
6218 (when expertp
6219 (format
6220 "Export command (C-%s%s%s%s%s) [%s]: "
6221 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6222 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6223 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6224 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6225 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6226 (mapconcat (lambda (k)
6227 ;; Strip control characters.
6228 (unless (< k 27) (char-to-string k)))
6229 allowed-keys "")))))
6230 ;; With expert UI, just read key with a fancy prompt. In standard
6231 ;; UI, display an intrusive help buffer.
6232 (if expertp
6233 (org-export--dispatch-action
6234 expert-prompt allowed-keys entries options first-key expertp)
6235 ;; At first call, create frame layout in order to display menu.
6236 (unless (get-buffer "*Org Export Dispatcher*")
6237 (delete-other-windows)
6238 (org-switch-to-buffer-other-window
6239 (get-buffer-create "*Org Export Dispatcher*"))
6240 (setq cursor-type nil
6241 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6242 ;; Make sure that invisible cursor will not highlight square
6243 ;; brackets.
6244 (set-syntax-table (copy-syntax-table))
6245 (modify-syntax-entry ?\[ "w"))
6246 ;; At this point, the buffer containing the menu exists and is
6247 ;; visible in the current window. So, refresh it.
6248 (with-current-buffer "*Org Export Dispatcher*"
6249 ;; Refresh help. Maintain display continuity by re-visiting
6250 ;; previous window position.
6251 (let ((pos (window-start)))
6252 (erase-buffer)
6253 (insert help)
6254 (set-window-start nil pos)))
6255 (org-fit-window-to-buffer)
6256 (org-export--dispatch-action
6257 standard-prompt allowed-keys entries options first-key expertp))))
6259 (defun org-export--dispatch-action
6260 (prompt allowed-keys entries options first-key expertp)
6261 "Read a character from command input and act accordingly.
6263 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6264 a list of characters available at a given step in the process.
6265 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6266 EXPERTP are the same as defined in `org-export--dispatch-ui',
6267 which see.
6269 Toggle export options when required. Otherwise, return value is
6270 a list with action as CAR and a list of interactive export
6271 options as CDR."
6272 (let (key)
6273 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6274 ;; C-p, SPC, DEL).
6275 (while (and (setq key (read-char-exclusive prompt))
6276 (not expertp)
6277 (memq key '(14 16 ?\s ?\d)))
6278 (case key
6279 (14 (if (not (pos-visible-in-window-p (point-max)))
6280 (ignore-errors (scroll-up 1))
6281 (message "End of buffer")
6282 (sit-for 1)))
6283 (16 (if (not (pos-visible-in-window-p (point-min)))
6284 (ignore-errors (scroll-down 1))
6285 (message "Beginning of buffer")
6286 (sit-for 1)))
6287 (?\s (if (not (pos-visible-in-window-p (point-max)))
6288 (scroll-up nil)
6289 (message "End of buffer")
6290 (sit-for 1)))
6291 (?\d (if (not (pos-visible-in-window-p (point-min)))
6292 (scroll-down nil)
6293 (message "Beginning of buffer")
6294 (sit-for 1)))))
6295 (cond
6296 ;; Ignore undefined associations.
6297 ((not (memq key allowed-keys))
6298 (ding)
6299 (unless expertp (message "Invalid key") (sit-for 1))
6300 (org-export--dispatch-ui options first-key expertp))
6301 ;; q key at first level aborts export. At second level, cancel
6302 ;; first key instead.
6303 ((eq key ?q) (if (not first-key) (error "Export aborted")
6304 (org-export--dispatch-ui options nil expertp)))
6305 ;; Help key: Switch back to standard interface if expert UI was
6306 ;; active.
6307 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6308 ;; Send request for template insertion along with export scope.
6309 ((eq key ?#) (cons 'template (memq 'subtree options)))
6310 ;; Switch to asynchronous export stack.
6311 ((eq key ?&) '(stack))
6312 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6313 ((memq key '(2 22 19 6 1))
6314 (org-export--dispatch-ui
6315 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6316 (6 'force) (1 'async))))
6317 (if (memq option options) (remq option options)
6318 (cons option options)))
6319 first-key expertp))
6320 ;; Action selected: Send key and options back to
6321 ;; `org-export-dispatch'.
6322 ((or first-key (functionp (nth 2 (assq key entries))))
6323 (cons (cond
6324 ((not first-key) (nth 2 (assq key entries)))
6325 ;; Publishing actions are hard-coded. Send a special
6326 ;; signal to `org-export-dispatch'.
6327 ((eq first-key ?P)
6328 (case key
6329 (?f 'publish-current-file)
6330 (?p 'publish-current-project)
6331 (?x 'publish-choose-project)
6332 (?a 'publish-all)))
6333 ;; Return first action associated to FIRST-KEY + KEY
6334 ;; path. Indeed, derived backends can share the same
6335 ;; FIRST-KEY.
6336 (t (catch 'found
6337 (mapc (lambda (entry)
6338 (let ((match (assq key (nth 2 entry))))
6339 (when match (throw 'found (nth 2 match)))))
6340 (member (assq first-key entries) entries)))))
6341 options))
6342 ;; Otherwise, enter sub-menu.
6343 (t (org-export--dispatch-ui options key expertp)))))
6347 (provide 'ox)
6349 ;; Local variables:
6350 ;; generated-autoload-file: "org-loaddefs.el"
6351 ;; End:
6353 ;;; ox.el ends here