| blob | 2a7e45dded840ac0f0d76fcdb9433627869b7890 |
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.
140 "Alist between export properties and ways to set them.
142 The key of the alist is the property name, and the value is a list
143 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
145 KEYWORD is a string representing a buffer keyword, or nil. Each
146 property defined this way can also be set, during subtree
147 export, through a headline property named after the keyword
149 property).
150 OPTION is a string that could be found in an #+OPTIONS: line.
151 DEFAULT is the default value for the property.
152 BEHAVIOR determines how Org should handle multiple keywords for
153 the same property. It is a symbol among:
154 nil Keep old value and discard the new one.
155 t Replace old value with the new one.
156 `space' Concatenate the values, separating them with a space.
157 `newline' Concatenate the values, separating them with
158 a newline.
159 `split' Split values at white spaces, and cons them to the
160 previous list.
161 `parse' Parse value as a list of strings and Org objects,
162 which can then be transcoded with, e.g.,
163 `org-export-data'. It implies `space' behavior.
165 Values set through KEYWORD and OPTION have precedence over
166 DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
233 "Alist between filters properties and initial values.
235 The key of each association is a property name accessible through
236 the communication channel. Its value is a configurable global
237 variable defining initial filters.
239 This list is meant to install user specified filters. Back-end
240 developers may install their own filters using
241 `org-export-define-backend'. Filters defined there will always
242 be prepended to the current list, so they always get applied
251 "Default rule for link matching an inline image.
252 This rule applies to links with no description. By default, it
253 will be considered as an inline image if it targets a local file
256 See `org-export-inline-image-p' for more information about
261 org-element--cache org-element--cache-objects org-element--cache-sync-keys
262 org-element--cache-sync-requests org-element--cache-sync-timer)
263 "List of variables not copied through upon buffer duplication.
264 Export process takes place on a copy of the original buffer.
265 When this copy is created, all Org related local variables not in
266 this list are copied to the new buffer. Variables with an
270 "Non-nil means asynchronous export process should leave data behind.
274 located in `temporary-file-directory'.
276 When non-nil, it will also set `debug-on-error' to a non-nil
280 "Record asynchronously generated export results and processes.
281 This is an alist: its CAR is the source of the
282 result (destination file or buffer for a finished process,
283 original buffer for a running one) and its CDR is a list
284 containing the back-end used, as a symbol, and either a process
285 or the time at which it finished. It is used to build the menu
289 "List of backends currently available in the exporter.
290 This variable is set with `org-export-define-backend' and
294 "Last command called from the dispatcher.
295 The value should be a list. Its CAR is the action, as a symbol,
299 "The position where the last export command was created using the dispatcher.
300 This marker will be used with `C-u C-c C-e' to make sure export repetition
303 ;; For compatibility with Org < 8
305 "Name, if any, of the back-end used during an export process.
307 Its value is a symbol such as `html', `latex', `ascii', or nil if
308 the back-end is anonymous (see `org-export-create-backend') or if
309 there is no export process in progress.
311 It can be used to teach Babel blocks how to act differently
315 \f
316 ;;; User-configurable Variables
317 ;;
318 ;; Configuration for the masses.
319 ;;
320 ;; They should never be accessed directly, as their value is to be
321 ;; stored in a property list (cf. `org-export-options-alist').
322 ;; Back-ends will read their value from there instead.
325 "Options for exporting Org mode files."
330 "General options for export engine."
335 "Whether sub-trees with the ARCHIVE tag should be exported.
337 This can have three different values:
338 nil Do not export, pretend this tree is not present.
339 t Do export the entire tree.
340 `headline' Only export the headline, but skip the tree below it.
342 This option can also be set with the OPTIONS keyword,
351 "Non-nil means insert author name into the exported file.
352 This option can also be set with the OPTIONS keyword,
358 "Non-nil means export CLOCK keywords.
359 This option can also be set with the OPTIONS keyword,
365 "Non-nil means the postamble should contain a creator sentence.
367 The sentence can be set in `org-export-creator-string', which
368 see.
370 This option can also be set with the OPTIONS keyword, e.g.,
378 "Non-nil means insert date in the exported document.
379 This option can also be set with the OPTIONS keyword,
385 "Time-stamp format string to use for DATE keyword.
387 The format string, when specified, only applies if date consists
388 in a single time-stamp. Otherwise its value will be ignored.
390 See `format-time-string' for details on how to build this
391 string."
399 emacs-version
401 "Information about the creator of the document.
402 This option can also be set on with the CREATOR keyword."
407 "Non-nil means export contents of standard drawers.
409 When t, all drawers are exported. This may also be a list of
410 drawer names to export, as strings. If that list starts with
411 `not', only drawers with such names will be ignored.
413 This variable doesn't apply to properties drawers. See
414 `org-export-with-properties' instead.
416 This option can also be set with the OPTIONS keyword,
429 :inline t
433 "Non-nil means insert author email into the exported file.
434 This option can also be set with the OPTIONS keyword,
440 "Non-nil means interpret *word*, /word/, _word_ and +word+.
442 If the export target supports emphasizing text, the word will be
443 typeset in bold, italic, with an underline or strike-through,
444 respectively.
446 This option can also be set with the OPTIONS keyword,
452 "Tags that exclude a tree from export.
454 All trees carrying any of these tags will be excluded from
455 export. This is without condition, so even subtrees inside that
456 carry one of the `org-export-select-tags' will be removed.
458 This option can also be set with the EXCLUDE_TAGS keyword."
464 This option can also be set with the OPTIONS keyword,
472 "Non-nil means Org footnotes should be exported.
473 This option can also be set with the OPTIONS keyword,
479 "Non-nil means process LaTeX environments and fragments.
481 This option can also be set with the OPTIONS line,
484 nil Ignore math snippets.
485 `verbatim' Keep everything in verbatim.
486 t Allow export of math snippets."
496 "The last level which is still exported as a headline.
498 Inferior levels will usually produce itemize or enumerate lists
499 when exported, but back-end behaviour may differ.
501 This option can also be set with the OPTIONS keyword,
507 "The default language for export and clocktable translations, as a string.
508 This may have an association in
509 `org-clock-clocktable-language-setup',
510 `org-export-smart-quotes-alist' and `org-export-dictionary'.
511 This option can also be set with the LANGUAGE keyword."
516 "Non-nil means preserve all line breaks when exporting.
517 This option can also be set with the OPTIONS keyword,
523 "Non-nil means interpret entities when exporting.
526 Å.
528 For a list of supported names, see the constant `org-entities'
529 and the user option `org-entities-user'.
531 This option can also be set with the OPTIONS keyword,
537 "Non-nil means inlinetasks should be exported.
538 This option can also be set with the OPTIONS keyword,
546 "Non-nil means include planning info in export.
548 Planning info is the line containing either SCHEDULED:,
549 DEADLINE:, CLOSED: time-stamps, or a combination of them.
551 This option can also be set with the OPTIONS keyword,
559 "Non-nil means include priority cookies in export.
560 This option can also be set with the OPTIONS keyword,
566 "Non-nil means export contents of properties drawers.
568 When t, all properties are exported. This may also be a list of
569 properties to export, as strings.
571 This option can also be set with the OPTIONS keyword,
583 "Non-nil means add section numbers to headlines when exporting.
585 When set to an integer n, numbering will only happen for
586 headlines whose relative level is higher or equal to n.
588 This option can also be set with the OPTIONS keyword,
594 "Tags that select a tree for export.
596 If any such tag is found in a buffer, all trees that do not carry
597 one of these tags will be ignored during export. Inside trees
598 that are selected like this, you can still deselect a subtree by
599 tagging it with one of the `org-export-exclude-tags'.
601 This option can also be set with the SELECT_TAGS keyword."
606 "Non-nil means activate smart quotes during export.
607 This option can also be set with the OPTIONS keyword,
610 When setting this to non-nil, you need to take care of
611 using the correct Babel package when exporting to LaTeX.
612 E.g., you can load Babel for french like this:
623 When this option is turned on, these strings will be exported as:
625 Org HTML LaTeX UTF-8
626 -----+----------+--------+-------
628 -- – -- –
629 --- — --- —
632 This option can also be set with the OPTIONS keyword,
638 "Non-nil means include statistics cookies in export.
639 This option can also be set with the OPTIONS keyword,
649 If you want to control how Org displays those characters, see
650 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
651 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
652 it is not anymore.
654 When this option is turned on, you can use TeX-like syntax for
655 sub- and superscripts and see them exported correctly.
657 You can also set the option with #+OPTIONS: ^:t
660 single item - so grouping with {} is normally not needed. For
661 example, the following things will be parsed as single sub- or
662 superscripts:
664 10^24 or 10^tau several digits will be considered 1 item.
665 10^-12 or 10^-tau a leading sign with digits or a word
666 x^2-y^3 will be read as x^2 - y^3, because items are
667 terminated by almost any nonword/nondigit char.
668 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
670 Still, ambiguity is possible. So when in doubt, use {} to enclose
671 the sub/superscript. If you set this variable to the symbol `{}',
672 the braces are *required* in order to trigger interpretations as
674 frequently in plain text."
684 "Non-nil means create a table of contents in exported files.
686 The TOC contains headlines with levels up
687 to`org-export-headline-levels'. When an integer, include levels
688 up to N in the toc, this may then be different from
689 `org-export-headline-levels', but it will not be allowed to be
690 larger than the number of headline levels. When nil, no table of
691 contents is made.
693 This option can also be set with the OPTIONS keyword,
702 "Non-nil means export tables.
703 This option can also be set with the OPTIONS keyword,
711 "If nil, do not export tags, just remove them from headlines.
713 If this is the symbol `not-in-toc', tags will be removed from
714 table of contents entries, but still be shown in the headlines of
715 the document.
717 This option can also be set with the OPTIONS keyword,
726 "Non-nil means include TODO items for export.
728 This may have the following values:
729 t include tasks independent of state.
730 `todo' include only tasks that are not yet done.
731 `done' include only tasks that are already done.
732 nil ignore all tasks.
733 list of keywords include tasks with these keywords.
735 This option can also be set with the OPTIONS keyword,
747 "Non-nil means print title into the exported file.
748 This option can also be set with the OPTIONS keyword,
756 "Non-nil means insert a time stamp into the exported file.
757 The time stamp shows when the file was created. This option can
763 "Non nil means allow timestamps in export.
765 It can be set to any of the following values:
766 t export all timestamps.
767 `active' export active timestamps only.
768 `inactive' export inactive timestamps only.
769 nil do not export timestamps
771 This only applies to timestamps isolated in a paragraph
772 containing only timestamps. Other timestamps are always
773 exported.
775 This option can also be set with the OPTIONS keyword, e.g.
785 "Non-nil means include TODO keywords in export.
786 When nil, remove all these keywords from the export. This option
792 "Non-nil means BIND keywords can define local variable values.
793 This is a potential security risk, which is why the default value
794 is nil. You can also allow them through local buffer variables."
801 "Alist between export snippets back-ends and exporter back-ends.
803 This variable allows to provide shortcuts for export snippets.
807 HTML code while every other back-end will ignore it."
816 "Coding system for the exported file."
823 "Non-nil means pushing export output to the kill ring.
824 This variable is ignored during asynchronous export."
834 "The initial scope when exporting with `org-export-dispatch'.
835 This variable can be either set to `buffer' or `subtree'."
842 "Non-nil means show buffer after exporting to temp buffer.
843 When Org exports to a file, the buffer visiting that file is never
844 shown, but remains buried. However, when exporting to
845 a temporary buffer, that buffer is popped up in a second window.
846 When this variable is nil, the buffer remains buried also in
847 these cases."
852 "Non-nil means export and publishing commands will run in background.
853 Results from an asynchronous export are never displayed
861 "File used to initialize external export process.
863 Value must be either nil or an absolute file name. When nil, the
864 external process is launched like a regular Emacs session,
865 loading user's initialization file and any site specific
866 configuration. If a file is provided, it, and only it, is loaded
867 at start-up.
869 Therefore, using a specific configuration makes the process to
870 load faster and the export more portable."
879 "Non-nil means using a non-intrusive `org-export-dispatch'.
880 In that case, no help buffer is displayed. Though, an indicator
886 asynchronous). Also, \[?] allows to switch back to standard
887 mode."
894 \f
895 ;;; Defining Back-ends
896 ;;
897 ;; An export back-end is a structure with `org-export-backend' type
898 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
899 ;; and `menu' slots.
900 ;;
901 ;; At the lowest level, a back-end is created with
902 ;; `org-export-create-backend' function.
903 ;;
904 ;; A named back-end can be registered with
905 ;; `org-export-register-backend' function. A registered back-end can
906 ;; later be referred to by its name, with `org-export-get-backend'
907 ;; function. Also, such a back-end can become the parent of a derived
908 ;; back-end from which slot values will be inherited by default.
909 ;; `org-export-derived-backend-p' can check if a given back-end is
910 ;; derived from a list of back-end names.
911 ;;
912 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
913 ;; `org-export-get-all-filters' return the full alist of transcoders,
914 ;; options and filters, including those inherited from ancestors.
915 ;;
916 ;; At a higher level, `org-export-define-backend' is the standard way
917 ;; to define an export back-end. If the new back-end is similar to
918 ;; a registered back-end, `org-export-define-derived-backend' may be
919 ;; used instead.
920 ;;
921 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
922 ;; when a given back-end hasn't been registered yet.
926 name parent transcoders options filters blocks menu)
929 "Return export back-end named after NAME.
930 NAME is a symbol. Return nil if no such back-end is found."
937 "Register BACKEND as a known export back-end.
938 BACKEND is a structure with `org-export-backend' type."
939 ;; Refuse to register an unnamed back-end.
942 ;; Refuse to register a back-end with an unknown parent.
946 ;; Register dedicated export blocks in the parser.
950 ;; If a back-end with the same name as BACKEND is already
951 ;; registered, replace it with BACKEND. Otherwise, simply add
952 ;; BACKEND to the list of registered back-ends.
958 "Signal an error if BACKEND isn't defined."
963 "Non-nil if BACKEND is derived from one of BACKENDS.
964 BACKEND is an export back-end, as returned by, e.g.,
965 `org-export-create-backend', or a symbol referring to
966 a registered back-end. BACKENDS is constituted of symbols."
978 "Return full translation table for BACKEND.
980 BACKEND is an export back-end, as return by, e.g,,
981 `org-export-create-backend'. Return value is an alist where
982 keys are element or object types, as symbols, and values are
983 transcoders.
985 Unlike to `org-export-backend-transcoders', this function
986 also returns transcoders inherited from parent back-ends,
987 if any."
991 parent)
996 transcoders)))
999 "Return export options for BACKEND.
1001 BACKEND is an export back-end, as return by, e.g,,
1002 `org-export-create-backend'. See `org-export-options-alist'
1003 for the shape of the return value.
1005 Unlike to `org-export-backend-options', this function also
1006 returns options inherited from parent back-ends, if any."
1010 parent)
1014 options)))
1017 "Return complete list of filters for BACKEND.
1019 BACKEND is an export back-end, as return by, e.g,,
1020 `org-export-create-backend'. Return value is an alist where
1021 keys are symbols and values lists of functions.
1023 Unlike to `org-export-backend-filters', this function also
1024 returns filters inherited from parent back-ends, if any."
1028 parent)
1032 filters)))
1035 "Define a new back-end BACKEND.
1037 TRANSCODERS is an alist between object or element types and
1038 functions handling them.
1040 These functions should return a string without any trailing
1041 space, or nil. They must accept three arguments: the object or
1042 element itself, its contents or nil when it isn't recursive and
1043 the property list used as a communication channel.
1045 Contents, when not nil, are stripped from any global indentation
1046 \(although the relative one is preserved). They also always end
1047 with a single newline character.
1049 If, for a given type, no function is found, that element or
1050 object type will simply be ignored, along with any blank line or
1051 white space at its end. The same will happen if the function
1052 returns the nil value. If that function returns the empty
1053 string, the type will be ignored, but the blank lines or white
1054 spaces will be kept.
1056 In addition to element and object types, one function can be
1057 associated to the `template' (or `inner-template') symbol and
1058 another one to the `plain-text' symbol.
1060 The former returns the final transcoded string, and can be used
1061 to add a preamble and a postamble to document's body. It must
1062 accept two arguments: the transcoded string and the property list
1063 containing export options. A function associated to `template'
1065 A function associated to `inner-template' is always applied.
1067 The latter, when defined, is to be called on every text not
1068 recognized as an element or an object. It must accept two
1069 arguments: the text string and the information channel. It is an
1070 appropriate place to protect special chars relative to the
1071 back-end.
1073 BODY can start with pre-defined keyword arguments. The following
1074 keywords are understood:
1076 :export-block
1078 String, or list of strings, representing block names that
1079 will not be parsed. This is used to specify blocks that will
1080 contain raw code specific to the back-end. These blocks
1081 still have to be handled by the relative `export-block' type
1082 translator.
1084 :filters-alist
1086 Alist between filters and function, or list of functions,
1087 specific to the back-end. See `org-export-filters-alist' for
1088 a list of all allowed filters. Filters defined here
1089 shouldn't make a back-end test, as it may prevent back-ends
1090 derived from this one to behave properly.
1092 :menu-entry
1094 Menu entry for the export dispatcher. It should be a list
1095 like:
1097 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1099 where :
1101 KEY is a free character selecting the back-end.
1103 DESCRIPTION-OR-ORDINAL is either a string or a number.
1105 If it is a string, is will be used to name the back-end in
1106 its menu entry. If it is a number, the following menu will
1107 be displayed as a sub-menu of the back-end with the same
1108 KEY. Also, the number will be used to determine in which
1109 order such sub-menus will appear (lowest first).
1111 ACTION-OR-MENU is either a function or an alist.
1113 If it is an action, it will be called with four
1114 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1115 BODY-ONLY. See `org-export-as' for further explanations on
1116 some of them.
1118 If it is an alist, associations should follow the
1119 pattern:
1121 '(KEY DESCRIPTION ACTION)
1123 where KEY, DESCRIPTION and ACTION are described above.
1125 Valid values include:
1129 or
1134 \(lambda (a s v b)
1135 \(if a (org-latex-export-to-pdf t s v b)
1136 \(org-open-file
1137 \(org-latex-export-to-pdf nil s v b)))))))
1139 or the following, which will be added to the previous
1140 sub-menu,
1142 '(?l 1
1146 :options-alist
1148 Alist between back-end specific properties introduced in
1149 communication channel and how their value are acquired. See
1150 `org-export-options-alist' for more information about
1151 structure of the values."
1166 :transcoders transcoders
1167 :options options
1168 :filters filters
1169 :blocks blocks
1173 "Create a new back-end as a variant of an existing one.
1175 CHILD is the name of the derived back-end. PARENT is the name of
1176 the parent back-end.
1178 BODY can start with pre-defined keyword arguments. The following
1179 keywords are understood:
1181 :export-block
1183 String, or list of strings, representing block names that
1184 will not be parsed. This is used to specify blocks that will
1185 contain raw code specific to the back-end. These blocks
1186 still have to be handled by the relative `export-block' type
1187 translator.
1189 :filters-alist
1191 Alist of filters that will overwrite or complete filters
1192 defined in PARENT back-end. See `org-export-filters-alist'
1193 for a list of allowed filters.
1195 :menu-entry
1197 Menu entry for the export dispatcher. See
1198 `org-export-define-backend' for more information about the
1199 expected value.
1201 :options-alist
1203 Alist of back-end specific properties that will overwrite or
1204 complete those defined in PARENT back-end. Refer to
1205 `org-export-options-alist' for more information about
1206 structure of the values.
1208 :translate-alist
1210 Alist of element and object types and transcoders that will
1211 overwrite or complete transcode table from PARENT back-end.
1212 Refer to `org-export-define-backend' for detailed information
1213 about transcoders.
1216 as a variant of `latex' back-end with a custom template function:
1218 \(org-export-define-derived-backend 'my-latex 'latex
1219 :translate-alist '((template . my-latex-template-fun)))
1221 The back-end could then be called with, for example:
1239 :parent parent
1240 :transcoders transcoders
1241 :options options
1242 :filters filters
1243 :blocks blocks
1247 \f
1248 ;;; The Communication Channel
1249 ;;
1250 ;; During export process, every function has access to a number of
1251 ;; properties. They are of two types:
1252 ;;
1253 ;; 1. Environment options are collected once at the very beginning of
1254 ;; the process, out of the original buffer and configuration.
1255 ;; Collecting them is handled by `org-export-get-environment'
1256 ;; function.
1257 ;;
1258 ;; Most environment options are defined through the
1259 ;; `org-export-options-alist' variable.
1260 ;;
1261 ;; 2. Tree properties are extracted directly from the parsed tree,
1262 ;; just before export, by `org-export-collect-tree-properties'.
1264 ;;;; Environment Options
1265 ;;
1266 ;; Environment options encompass all parameters defined outside the
1267 ;; scope of the parsed data. They come from five sources, in
1268 ;; increasing precedence order:
1269 ;;
1270 ;; - Global variables,
1271 ;; - Buffer's attributes,
1272 ;; - Options keyword symbols,
1273 ;; - Buffer keywords,
1274 ;; - Subtree properties.
1275 ;;
1276 ;; The central internal function with regards to environment options
1277 ;; is `org-export-get-environment'. It updates global variables with
1278 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1279 ;; the different sources.
1280 ;;
1281 ;; The internal functions doing the retrieval are:
1282 ;; `org-export--get-global-options',
1283 ;; `org-export--get-buffer-attributes',
1284 ;; `org-export--parse-option-keyword',
1285 ;; `org-export--get-subtree-options' and
1286 ;; `org-export--get-inbuffer-options'
1287 ;;
1288 ;; Also, `org-export--list-bound-variables' collects bound variables
1289 ;; along with their value in order to set them as buffer local
1290 ;; variables later in the process.
1293 "Collect export options from the current buffer.
1295 Optional argument BACKEND is an export back-end, as returned by
1296 `org-export-create-backend'.
1298 When optional argument SUBTREEP is non-nil, assume the export is
1299 done against the current sub-tree.
1301 Third optional argument EXT-PLIST is a property list with
1302 external parameters overriding Org default settings, but still
1303 inferior to file-local settings."
1304 ;; First install #+BIND variables since these must be set before
1305 ;; global options are read.
1308 ;; Get and prioritize export options...
1310 ;; ... from global variables...
1312 ;; ... from an external property list...
1313 ext-plist
1314 ;; ... from in-buffer settings...
1316 ;; ... and from subtree, when appropriate.
1318 ;; Eventually add misc. properties.
1320 :back-end
1321 backend
1323 :footnote-definition-alist
1324 ;; Footnotes definitions must be collected in the original
1325 ;; buffer, as there's no insurance that they will still be in
1326 ;; the parse tree, due to possible narrowing.
1342 alist))
1354 alist)))))))
1355 alist))
1356 :id-alist
1357 ;; Collect id references.
1368 alist))))
1371 "Parse an OPTIONS line and return values as a plist.
1372 Optional argument BACKEND is an export back-end, as returned by,
1373 e.g., `org-export-create-backend'. It specifies which back-end
1374 specific items to read, if any."
1376 ;; Priority is given to back-end specific options.
1378 org-export-options-alist))
1379 plist)
1388 options))
1390 property
1393 plist))
1396 "Get export options in subtree at point.
1397 Optional argument BACKEND is an export back-end, as returned by,
1398 e.g., `org-export-create-backend'. It specifies back-end used
1399 for export. Return options as a plist."
1400 ;; For each buffer keyword, create a headline property setting the
1401 ;; same property in communication channel. The name for the property
1402 ;; is the keyword with "EXPORT_" appended to it.
1405 ;; Look for both general keywords and back-end specific
1406 ;; options, with priority given to the latter.
1408 org-export-options-alist)))
1409 ;; Make sure point is at a heading.
1411 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1412 ;; title (with no todo keyword, priority cookie or tag) as its
1413 ;; fallback value.
1419 plist :title
1423 title))))
1424 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1429 ;; Handle other keywords. TITLE keyword is excluded as it has
1430 ;; been handled already. Then return PLIST.
1442 plist
1443 property
1452 "Return current buffer export options, as a plist.
1454 Optional argument BACKEND, when non-nil, is an export back-end,
1455 as returned by, e.g., `org-export-create-backend'. It specifies
1456 which back-end specific options should also be read in the
1457 process.
1459 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1461 get-options ; For byte-compiler.
1464 ;; Priority is given to back-end specific options.
1466 org-export-options-alist))
1469 org-export-special-keywords))))
1472 ;; Return all properties associated to KEYWORD.
1477 to-parse
1480 ;; Recursively read keywords in buffer. FILES is a list
1481 ;; of files read so far. PLIST is the current property
1482 ;; list obtained.
1491 ;; Options in `org-export-special-keywords'.
1495 ;; Avoid circular dependencies.
1505 plist
1510 plist
1516 ;; Options in `org-export-options-alist'.
1519 plist
1521 plist property
1522 ;; Handle value depending on specified
1523 ;; BEHAVIOR.
1528 ;; Even if `parse' implies `space'
1529 ;; behavior, we separate line with "\n"
1530 ;; so as to preserve line-breaks.
1531 ;; However, empty lines are forbidden
1532 ;; since `parse' doesn't allow more than
1533 ;; one paragraph.
1542 " "
1555 plist))))
1556 ;; Read options in the current buffer and return value.
1559 nil)))
1560 ;; Parse properties in TO-PARSE. Remove newline characters not
1561 ;; involved in line breaks to simulate `space' behaviour.
1562 ;; Finally return options.
1574 "Return properties related to buffer attributes, as a plist."
1579 "Return global export options as a plist.
1580 Optional argument BACKEND, if non-nil, is an export back-end, as
1581 returned by, e.g., `org-export-create-backend'. It specifies
1582 which back-end specific export options should also be read in the
1583 process."
1585 ;; Priority is given to back-end specific options.
1587 org-export-options-alist)))
1593 plist
1594 prop
1595 ;; Evaluate default value provided.
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.
2702 ;; If headline is archived but tree below has to
2703 ;; be skipped, remove contents.
2705 ;; Move into secondary string, if any.
2710 ;; Move into recursive objects/elements.
2712 ;; If a select tag is active, also ignore the section before the
2713 ;; first headline, if any.
2718 ;; Prune tree and communication channel.
2722 ;; Priority is given to back-end specific options.
2724 org-export-options-alist))
2727 ;; Eventually set `:ignore-list'.
2731 "Change uninterpreted elements back into Org syntax.
2732 DATA is the parse tree. INFO is a plist containing export
2733 options. Each uninterpreted element or object is changed back
2734 into a string. Contents, if any, are not modified. The parse
2735 tree is modified by side effect."
2741 p
2744 info))))))
2747 "Change uninterpreted elements back into Org syntax.
2748 DATA is a parse tree or a secondary string. INFO is a plist
2749 containing export options. It is modified by side effect and
2750 returned by the function."
2753 subscript superscript underline)
2757 ;; ... entities...
2764 ?\s)))))
2765 ;; ... emphasis...
2777 marker
2781 ?\s)))))))
2782 ;; ... LaTeX environments and fragments...
2786 ;; ... sub/superscripts...
2795 "_"
2804 ?\s)))))))))))
2806 ;; Splice NEW at BLOB location in parse tree.
2809 info)
2810 ;; Return modified parse tree.
2811 data)
2813 ;;;###autoload
2816 "Transcode current Org buffer into BACKEND code.
2818 BACKEND is either an export back-end, as returned by, e.g.,
2819 `org-export-create-backend', or a symbol referring to
2820 a registered back-end.
2822 If narrowing is active in the current buffer, only transcode its
2823 narrowed part.
2825 If a region is active, transcode that region.
2827 When optional argument SUBTREEP is non-nil, transcode the
2828 sub-tree at point, extracting information from the headline
2829 properties first.
2831 When optional argument VISIBLE-ONLY is non-nil, don't export
2832 contents of hidden elements.
2834 When optional argument BODY-ONLY is non-nil, only return body
2835 code, without surrounding template.
2837 Optional argument EXT-PLIST, when provided, is a property list
2838 with external parameters overriding Org default settings, but
2839 still inferior to file-local settings.
2841 Return code as a string."
2846 ;; Narrow buffer to an appropriate region or subtree for
2847 ;; parsing. If parsing subtree, be sure to remove main headline
2848 ;; too.
2856 ;; Initialize communication channel with original buffer
2857 ;; attributes, unavailable in its copy.
2870 org-export-options-alist))))
2871 tree)
2872 ;; Update communication channel and get parse tree. Buffer
2873 ;; isn't parsed directly. Instead, a temporary copy is
2874 ;; created, where include keywords, macros are expanded and
2875 ;; code blocks are evaluated.
2877 ;; Run first hook with current back-end's name as argument.
2882 ;; Update macro templates since #+INCLUDE keywords might have
2883 ;; added some new ones.
2887 ;; Update radio targets since keyword inclusion might have
2888 ;; added some more.
2890 ;; Run last hook with current back-end's name as argument.
2895 ;; Update communication channel with environment. Also
2896 ;; install user's and developer's filters.
2901 ;; Call options filters and update export options. We do not
2902 ;; use `org-export-filter-apply-functions' here since the
2903 ;; arity of such filters is different.
2908 ;; Expand export-specific set of macros: {{{author}}},
2909 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2910 ;; be done once regular macros have been expanded, since
2911 ;; parsed keywords may contain one of them.
2924 value)
2925 value)))
2929 'finalize
2930 parsed-keywords)
2931 ;; Parse buffer.
2933 ;; Prune tree from non-exported elements and transform
2934 ;; uninterpreted elements or objects in both parse tree and
2935 ;; communication channel.
2938 ;; Parse buffer, handle uninterpreted elements or objects,
2939 ;; then call parse-tree filters.
2943 ;; Now tree is complete, compute its properties and add them
2944 ;; to communication channel.
2948 ;; Eventually transcode TREE. Wrap the resulting string into
2949 ;; a template.
2958 info))
2961 ;; Remove all text properties since they cannot be
2962 ;; retrieved from an external process. Finally call
2963 ;; final-output filter and return result.
2969 info))))))))
2971 ;;;###autoload
2973 "Transcode STRING into BACKEND code.
2975 BACKEND is either an export back-end, as returned by, e.g.,
2976 `org-export-create-backend', or a symbol referring to
2977 a registered back-end.
2979 When optional argument BODY-ONLY is non-nil, only return body
2980 code, without preamble nor postamble.
2982 Optional argument EXT-PLIST, when provided, is a property list
2983 with external parameters overriding Org default settings, but
2984 still inferior to file-local settings.
2986 Return code as a string."
2992 ;;;###autoload
2994 "Replace the active region by its export to BACKEND.
2995 BACKEND is either an export back-end, as returned by, e.g.,
2996 `org-export-create-backend', or a symbol referring to
2997 a registered back-end."
3007 ;;;###autoload
3009 "Insert all export keywords with default values at beginning of line.
3011 BACKEND is a symbol referring to the name of a registered export
3012 back-end, for which specific export options should be added to
3013 the template, or `default' for default template. When it is nil,
3014 the user will be prompted for a category.
3016 If SUBTREEP is non-nil, export configuration will be set up
3017 locally for the subtree through node properties."
3027 "Options category: "
3031 org-export--registered-backends))
3032 nil t))))
3033 options keywords)
3034 ;; Populate OPTIONS and KEYWORDS.
3051 ;; Move to an appropriate location in order to insert options.
3053 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3071 ;; Then the rest of keywords, in the order specified in either
3072 ;; `org-export-options-alist' or respective export back-ends.
3093 "Expand every include keyword in buffer.
3094 Optional argument INCLUDED is a list of included file names along
3095 with their line restriction, when appropriate. It is used to
3096 avoid infinite recursion. Optional argument DIR is the current
3097 working directory. It is used to properly resolve relative
3098 paths. Optional argument FOOTNOTES is a hash-table used for
3099 storing and resolving footnotes. It is created automatically."
3105 ;; If :minlevel is not set the text-property
3106 ;; `:org-include-induced-level' will be used to determine the
3107 ;; relative level when expanding INCLUDE.
3108 ;; Only affects included Org documents.
3112 :org-include-induced-level
3114 ;; Expand INCLUDE keywords.
3120 ;; Extract arguments from keyword's value.
3123 location
3135 matched)
3136 dir)))
3145 value)
3152 ;; Minimal level of included file defaults to the child
3153 ;; level of the current headline, if any, or one. It
3154 ;; only applies is the file is meant to be included as
3155 ;; an Org one.
3166 ;; Remove keyword.
3172 ;; Check if files has already been parsed. Look after
3173 ;; inclusion lines too, as different parts of the same file
3174 ;; can be included too.
3189 ind-str block arg-str contents ind-str block))))
3196 ind-str block contents ind-str block))))
3204 file location only-contents lines)
3205 lines)))
3208 file lines ind minlevel
3211 footnotes)))
3215 footnotes)
3217 ;; Expand footnotes after all files have been
3218 ;; included. Footnotes are stored at end of buffer.
3223 footnotes)))))))))))
3226 "Resolve absolute lines for an included file with file-link.
3228 FILE is string file-name of the file to include. LOCATION is a
3229 string name within FILE to be included (located via
3230 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3231 contents of the named element will be included, as determined
3232 Org-Element. If LINES is non-nil only those lines are included.
3234 Return a string of lines to be included in the format expected by
3235 `org-export--prepare-file-contents'."
3241 ;; Enforce consistent search.
3254 ;; Skip planning line and property-drawer.
3280 start-line
3282 (+ start-line
3285 counter))))))))
3288 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3290 REF-BEGIN corresponds to the property `:begin' of objects of type
3291 footnote-definition and footnote-reference.
3293 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3294 \[N] where N is one or more numbers.
3296 Return the new label."
3306 "Prepare contents of FILE for inclusion and return it as a string.
3308 When optional argument LINES is a string specifying a range of
3309 lines, include only those lines.
3311 Optional argument IND, when non-nil, is an integer specifying the
3312 global indentation of returned contents. Since its purpose is to
3313 allow an included file to stay in the same environment it was
3314 created \(i.e. a list item), it doesn't apply past the first
3315 headline encountered.
3317 Optional argument MINLEVEL, when non-nil, is an integer
3318 specifying the level that any top-level headline in the included
3319 file should have.
3320 Optional argument ID is an integer that will be inserted before
3321 each footnote definition and reference if FILE is an Org file.
3322 This is useful to avoid conflicts when more than one Org file
3323 with footnotes is included in a document.
3325 Optional argument FOOTNOTES is a hash-table to store footnotes in
3326 the included document.
3327 "
3343 ;; Remove blank lines at beginning and end of contents. The logic
3344 ;; behind that removal is that blank lines around include keyword
3345 ;; override blank lines in included file.
3354 ;; If IND is set, preserve indentation of include keyword until
3355 ;; the first headline encountered.
3362 ;; Do not move footnote definitions out of column 0.
3368 ;; When MINLEVEL is specified, compute minimal level for headlines
3369 ;; in the file (CUR-MIN), and remove stars to each headline so
3370 ;; that headlines with minimal level have a level of MINLEVEL.
3381 ;; Only change stars, don't bother moving whole
3382 ;; sections.
3386 ;; Append ID to all footnote references and definitions, so they
3387 ;; become file specific and cannot collide with footnotes in other
3388 ;; included files. Further, collect relevant footnotes outside of
3389 ;; LINES.
3399 ;; Update the footnote-reference at point and collect
3400 ;; the new label, which is only used for footnotes
3401 ;; outsides LINES.
3403 ;; If label is akin to [1] convert it to [fn:ID-1].
3404 ;; Otherwise add "ID-" after "fn:".
3414 ;; Store since footnote-definition is outside of LINES.
3417 footnotes)
3418 ;; Update label of definition since it is included directly.
3425 "Execute every Babel code in the visible part of current buffer."
3426 ;; Get a pristine copy of current buffer so Babel references can be
3427 ;; properly resolved.
3433 "Return a non-nil value when output should be added to the kill ring.
3434 See also `org-export-copy-to-kill-ring'."
3440 \f
3441 ;;; Tools For Back-Ends
3442 ;;
3443 ;; A whole set of tools is available to help build new exporters. Any
3444 ;; function general enough to have its use across many back-ends
3445 ;; should be added here.
3447 ;;;; For Affiliated Keywords
3448 ;;
3449 ;; `org-export-read-attribute' reads a property from a given element
3450 ;; as a plist. It can be used to normalize affiliated keywords'
3451 ;; syntax.
3452 ;;
3453 ;; Since captions can span over multiple lines and accept dual values,
3454 ;; their internal representation is a bit tricky. Therefore,
3455 ;; `org-export-get-caption' transparently returns a given element's
3456 ;; caption as a secondary string.
3459 "Turn ATTRIBUTE property from ELEMENT into a plist.
3461 When optional argument PROPERTY is non-nil, return the value of
3462 that property within attributes.
3466 properties.
3468 All values will become strings except the empty string and
3471 will become the empty string."
3485 s)
3490 ;; Ignore any string before first property with `cdr'.
3495 "Return caption from ELEMENT as a secondary string.
3497 When optional argument SHORTP is non-nil, return short caption,
3498 as a secondary string, instead.
3500 Caption lines are separated by a white space."
3508 ;;;; For Derived Back-ends
3509 ;;
3510 ;; `org-export-with-backend' is a function allowing to locally use
3511 ;; another back-end to transcode some object or element. In a derived
3512 ;; back-end, it may be used as a fall-back function once all specific
3513 ;; cases have been treated.
3516 "Call a transcoder from BACKEND on DATA.
3517 BACKEND is an export back-end, as returned by, e.g.,
3518 `org-export-create-backend', or a symbol referring to
3519 a registered back-end. DATA is an Org element, object, secondary
3520 string or string. CONTENTS, when non-nil, is the transcoded
3521 contents of DATA element, as a string. INFO, when non-nil, is
3522 the communication channel used for export, as a plist."
3532 transcoder data contents
3535 :translate-alist all-transcoders
3539 ;;;; For Export Snippets
3540 ;;
3541 ;; Every export snippet is transmitted to the back-end. Though, the
3542 ;; latter will only retain one type of export-snippet, ignoring
3543 ;; others, based on the former's target back-end. The function
3544 ;; `org-export-snippet-backend' returns that back-end for a given
3545 ;; export-snippet.
3548 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3549 Translation, with `org-export-snippet-translation-alist', is
3550 applied."
3554 back-end))))
3557 ;;;; For Footnotes
3558 ;;
3559 ;; `org-export-collect-footnote-definitions' is a tool to list
3560 ;; actually used footnotes definitions in the whole parse tree, or in
3561 ;; a headline, in order to add footnote listings throughout the
3562 ;; transcoded data.
3563 ;;
3564 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3565 ;; back-ends, when they need to attach the footnote definition only to
3566 ;; the first occurrence of the corresponding label.
3567 ;;
3568 ;; `org-export-get-footnote-definition' and
3569 ;; `org-export-get-footnote-number' provide easier access to
3570 ;; additional information relative to a footnote reference.
3573 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3574 INFO is the plist used as a communication channel. If no such
3575 definition can be found, raise an error."
3584 "Apply FUNCTION on every footnote reference in DATA.
3585 INFO is a plist containing export state. By default, as soon as
3586 a new footnote reference is encountered, FUNCTION is called onto
3587 its definition. However, if BODY-FIRST is non-nil, this step is
3588 delayed until the end of the process."
3594 ;; Search footnote references through DATA, filling
3595 ;; SEEN-REFS along the way. When DELAYP is non-nil, store
3596 ;; footnote definitions so they can be entered later.
3603 ;; Search for subsequent references in footnote
3604 ;; definition so numbering follows reading logic,
3605 ;; unless DELAYP in non-nil.
3609 definitions))
3610 ;; Do not force entering inline definitions,
3611 ;; since `org-element-map' already traverses them
3612 ;; at the right time.
3616 nil))))))
3617 info nil
3618 ;; Don't enter footnote definitions since it will happen
3619 ;; when their first reference is found. Moreover, if
3620 ;; DELAYP is non-nil, make sure we postpone entering
3621 ;; definitions of inline references.
3628 "Return an alist between footnote numbers, labels and definitions.
3630 INFO is the current export state, as a plist.
3632 Definitions are collected throughout the whole parse tree, or
3633 DATA when non-nil.
3635 Sorting is done by order of references. As soon as a new
3636 reference is encountered, other references are searched within
3637 its definition. However, if BODY-FIRST is non-nil, this step is
3638 delayed after the whole tree is checked. This alters results
3639 when references are found in footnote definitions.
3641 Definitions either appear as Org data or as a secondary string
3642 for inlined footnotes. Unreferenced definitions are ignored."
3646 ;; Collect footnote number, label and definition.
3657 "Non-nil when a footnote reference is the first one for its label.
3659 FOOTNOTE-REFERENCE is the footnote reference being considered.
3660 INFO is a plist containing current export state.
3662 Search is done throughout the whole parse tree, or DATA when
3663 non-nil.
3665 By default, as soon as a new footnote reference is encountered,
3666 other references are searched within its definition. However, if
3667 BODY-FIRST is non-nil, this step is delayed after the whole tree
3668 is checked. This alters results when references are found in
3669 footnote definitions."
3671 ;; Anonymous footnotes are always a first reference.
3682 "Return number associated to a footnote.
3684 FOOTNOTE is either a footnote reference or a footnote definition.
3685 INFO is the plist containing export state.
3687 Number is unique throughout the whole parse tree, or DATA, when
3688 non-nil.
3690 By default, as soon as a new footnote reference is encountered,
3691 counting process moves into its definition. However, if
3692 BODY-FIRST is non-nil, this step is delayed until the end of the
3693 process, leading to a different order when footnotes are nested."
3702 ;; Anonymous footnote match: return number.
3704 ;; Labels match: return number.
3706 ;; Otherwise store label and increase counter if label
3707 ;; wasn't encountered yet.
3713 ;;;; For Headlines
3714 ;;
3715 ;; `org-export-get-relative-level' is a shortcut to get headline
3716 ;; level, relatively to the lower headline level in the parsed tree.
3717 ;;
3718 ;; `org-export-get-headline-number' returns the section number of an
3719 ;; headline, while `org-export-number-to-roman' allows to convert it
3720 ;; to roman numbers. With an optional argument,
3721 ;; `org-export-get-headline-number' returns a number to unnumbered
3722 ;; headlines (used for internal id).
3723 ;;
3724 ;; `org-export-get-headline-id' returns the unique internal id of a
3725 ;; headline.
3726 ;;
3727 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3728 ;; `org-export-last-sibling-p' are three useful predicates when it
3729 ;; comes to fulfill the `:headline-levels' property.
3730 ;;
3731 ;; `org-export-get-tags', `org-export-get-category' and
3732 ;; `org-export-get-node-property' extract useful information from an
3733 ;; headline or a parent headline. They all handle inheritance.
3734 ;;
3735 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3736 ;; as a secondary string, suitable for table of contents. It falls
3737 ;; back onto default title.
3740 "Return HEADLINE relative level within current parsed tree.
3741 INFO is a plist holding contextual information."
3746 "Non-nil when HEADLINE is considered as low level.
3748 INFO is a plist used as a communication channel.
3750 A low level headlines has a relative level greater than
3751 `:headline-levels' property value.
3753 Return value is the difference between HEADLINE relative level
3754 and the last level being considered as high enough, or nil."
3761 "Return a unique ID for HEADLINE.
3762 INFO is a plist holding contextual information."
3772 "Return numbered HEADLINE numbering as a list of numbers.
3773 INFO is a plist holding contextual information."
3778 "Return a non-nil value if HEADLINE element should be numbered.
3779 INFO is a plist used as a communication channel."
3788 "Convert integer N into a roman numeral."
3801 res)))
3804 "Return list of tags associated to ELEMENT.
3806 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3807 is a plist used as a communication channel.
3809 Select tags (see `org-export-select-tags') and exclude tags (see
3810 `org-export-exclude-tags') are removed from the list.
3812 When non-nil, optional argument TAGS should be a list of strings.
3813 Any tag belonging to this list will also be removed.
3815 When optional argument INHERITED is non-nil, tags can also be
3816 inherited from parent headlines and FILETAGS keywords."
3822 ;; Build complete list of inherited tags.
3829 ;; Add FILETAGS keywords and return results.
3833 "Return node PROPERTY value for BLOB.
3835 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3836 element or object.
3838 If optional argument INHERITED is non-nil, the value can be
3839 inherited from a parent headline.
3841 Return value is a string or nil."
3853 "Return category for element or object BLOB.
3855 INFO is a plist used as a communication channel.
3857 CATEGORY is automatically inherited from a parent headline, from
3858 #+CATEGORY: keyword or created out of original file name. If all
3871 "Return alternative title for HEADLINE, as a secondary string.
3872 INFO is a plist used as a communication channel. If no optional
3873 title is defined, fall-back to the regular title."
3880 "Non-nil when BLOB is the first sibling in its parent.
3881 BLOB is an element or an object. If BLOB is a headline, non-nil
3882 means it is the first sibling in the sub-tree. INFO is a plist
3883 used as a communication channel."
3888 "Non-nil when BLOB is the last sibling in its parent.
3889 BLOB is an element or an object. INFO is a plist used as
3890 a communication channel."
3894 ;;;; For Keywords
3895 ;;
3896 ;; `org-export-get-date' returns a date appropriate for the document
3897 ;; to about to be exported. In particular, it takes care of
3898 ;; `org-export-date-timestamp-format'.
3901 "Return date value for the current document.
3903 INFO is a plist used as a communication channel. FMT, when
3904 non-nil, is a time format string that will be applied on the date
3905 if it consists in a single timestamp object. It defaults to
3906 `org-export-date-timestamp-format' when nil.
3908 A proper date can be a secondary string, a string or nil. It is
3909 meant to be translated with `org-export-data' or alike."
3920 ;;;; For Links
3921 ;;
3922 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3923 ;; with `org-add-link-type', which see.
3924 ;;
3925 ;; `org-export-solidify-link-text' turns a string into a safer version
3926 ;; for links, replacing most non-standard characters with hyphens.
3927 ;;
3928 ;; `org-export-get-coderef-format' returns an appropriate format
3929 ;; string for coderefs.
3930 ;;
3931 ;; `org-export-inline-image-p' returns a non-nil value when the link
3932 ;; provided should be considered as an inline image.
3933 ;;
3934 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3935 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3936 ;; returns an appropriate unique identifier when found, or nil.
3937 ;;
3938 ;; `org-export-resolve-id-link' returns the first headline with
3939 ;; specified id or custom-id in parse tree, the path to the external
3940 ;; file with the id or nil when neither was found.
3941 ;;
3942 ;; `org-export-resolve-coderef' associates a reference to a line
3943 ;; number in the element it belongs, or returns the reference itself
3944 ;; when the element isn't numbered.
3947 "Take link text S and make a safe target out of it."
3952 "Try exporting LINK with a dedicated function.
3954 DESC is its description, as a string, or nil. BACKEND is the
3955 back-end used for export, as a symbol.
3957 Return output as a string, or nil if no protocol handles LINK.
3959 A custom protocol has precedence over regular back-end export.
3960 The function ignores links with an implicit type (e.g.,
3969 desc
3970 backend))))))
3973 "Return format string for code reference link.
3974 PATH is the link path. DESC is its description."
3982 "Non-nil if LINK object points to an inline image.
3984 Optional argument is a set of RULES defining inline images. It
3985 is an alist where associations have the following shape:
3987 \(TYPE . REGEXP)
3989 Applying a rule means apply REGEXP against LINK's path when its
3990 type is TYPE. The function will return a non-nil value if any of
3991 the provided rules is non-nil. The default rule is
3992 `org-export-default-inline-image-rule'.
3994 This only applies to links without a description."
4005 "Resolve a code reference REF.
4007 INFO is a plist used as a communication channel.
4009 Return associated line number in source code, or REF itself,
4010 depending on src-block or example element's switches. Throw an
4011 error if no block contains REF."
4018 org-coderef-label-format)))
4022 ;; Element containing REF is found. Resolve it to
4023 ;; either a label or a line number, as needed.
4034 "Return LINK destination.
4036 INFO is a plist holding contextual information.
4038 Return value can be an object, an element, or nil:
4040 - If LINK path matches a target object (i.e. <<path>>) return it.
4042 - If LINK path exactly matches the name affiliated keyword
4043 \(i.e. #+NAME: path) of an element, return that element.
4045 - If LINK path exactly matches any headline name, return that
4046 element. If more than one headline share that name, priority
4047 will be given to the one with the closest common ancestor, if
4048 any, or the first one in the parse tree otherwise.
4050 - Otherwise, throw an error.
4053 significant."
4056 ;; Split PATH at white spaces so matches are space
4057 ;; insensitive.
4060 ;; Cache for destinations that are not position dependent.
4068 ;; Destination is not position dependent: use cached value.
4070 ;; First try to find a matching "<<path>>" unless user specified
4071 ;; he was looking for a headline (path starts with a "*"
4072 ;; character).
4078 path)
4079 blob))
4082 ;; Then try to find an element with a matching "#+NAME: path"
4083 ;; affiliated keyword.
4086 org-element-all-elements
4091 el)))
4094 ;; Last case: link either points to a headline or to nothingness.
4095 ;; Try to find the source, with priority given to headlines with
4096 ;; the closest common ancestor. If such candidate is found,
4097 ;; return it, otherwise signal an error.
4101 ;; Return first headline whose `:raw-value' property is
4102 ;; NAME in parse tree DATA, or nil. Statistics cookies
4103 ;; are ignored.
4111 name)
4112 headline))
4114 ;; Search among headlines sharing an ancestor with link, from
4115 ;; closest to farthest.
4123 ;; No destination found: error.
4127 "Return headline referenced as LINK destination.
4129 INFO is a plist used as a communication channel.
4131 Return value can be the headline element matched in current parse
4135 ;; First check if id is within the current parse tree.
4140 headline))
4142 ;; Otherwise, look for external files.
4147 "Return radio-target object referenced as LINK destination.
4149 INFO is a plist used as a communication channel.
4151 Return value can be a radio-target object or nil. Assume LINK
4160 nil nil path nil nil t)
4161 t)
4162 radio))
4166 ;;;; For References
4167 ;;
4168 ;; `org-export-get-reference' associate a unique reference for any
4169 ;; object or element.
4170 ;;
4171 ;; `org-export-get-ordinal' associates a sequence number to any object
4172 ;; or element.
4175 "Return a unique reference for DATUM, as a string.
4176 DATUM is either an element or an object. INFO is the current
4177 export state, as a plist. Returned reference consists of
4178 alphanumeric characters only."
4183 h))))
4191 cache))))
4194 "Return ordinal number of an element or object.
4196 ELEMENT is the element or object considered. INFO is the plist
4197 used as a communication channel.
4199 Optional argument TYPES, when non-nil, is a list of element or
4200 object types, as symbols, that should also be counted in.
4201 Otherwise, only provided element's type is considered.
4203 Optional argument PREDICATE is a function returning a non-nil
4204 value if the current element or object should be counted in. It
4205 accepts two arguments: the element or object being considered and
4206 the plist used as a communication channel. This allows to count
4207 only a certain type of objects (i.e. inline images).
4209 Return value is a list of numbers if ELEMENT is a headline or an
4210 item. It is nil for keywords. It represents the footnote number
4211 for footnote definitions and footnote references. If ELEMENT is
4212 a target, return the same value as if ELEMENT was the closest
4213 table, item or headline containing the target. In any other
4214 case, return the sequence number of ELEMENT among elements or
4215 objects of the same type."
4216 ;; Ordinal of a target object refer to the ordinal of the closest
4217 ;; table, item, or headline containing the object.
4221 element
4224 ;; Special case 1: A headline returns its number as a list.
4226 ;; Special case 2: An item returns its number as a list.
4230 struct
4237 ;; Increment counter until ELEMENT is found again.
4248 ;;;; For Src-Blocks
4249 ;;
4250 ;; `org-export-get-loc' counts number of code lines accumulated in
4251 ;; src-block or example-block elements with a "+n" switch until
4252 ;; a given element, excluded. Note: "-n" switches reset that count.
4253 ;;
4254 ;; `org-export-unravel-code' extracts source code (along with a code
4255 ;; references alist) from an `element-block' or `src-block' type
4256 ;; element.
4257 ;;
4258 ;; `org-export-format-code' applies a formatting function to each line
4259 ;; of code, providing relative line number and code reference when
4260 ;; appropriate. Since it doesn't access the original element from
4261 ;; which the source code is coming, it expects from the code calling
4262 ;; it to know if lines should be numbered and if code references
4263 ;; should appear.
4264 ;;
4265 ;; Eventually, `org-export-format-code-default' is a higher-level
4266 ;; function (it makes use of the two previous functions) which handles
4267 ;; line numbering and code references inclusion, and returns source
4268 ;; code in a format suitable for plain text or verbatim output.
4271 "Return accumulated lines of code up to ELEMENT.
4273 INFO is the plist used as a communication channel.
4275 ELEMENT is excluded from count."
4281 ;; ELEMENT is reached: Quit the loop.
4283 ;; Only count lines from src-block and example-block elements
4284 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4288 ;; Accumulate locs or reset them.
4292 ;; Return nil to stay in the loop.
4293 nil)))
4295 ;; Return value.
4296 loc))
4299 "Clean source code and extract references out of it.
4301 ELEMENT has either a `src-block' an `example-block' type.
4303 Return a cons cell whose CAR is the source code, cleaned from any
4304 reference, protective commas and spurious indentation, and CDR is
4305 an alist between relative line number (integer) and name of code
4306 reference on that line (string)."
4309 ;; Get code and clean it. Remove blank lines at its
4310 ;; beginning and end.
4317 value
4319 ;; Get format used for references.
4322 org-coderef-label-format)))
4323 ;; Build a regexp matching a loc with a reference.
4328 ;; Return value.
4330 ;; Code with references removed.
4336 ;; Ref line: remove ref, and signal its position in REFS.
4340 ;; Reference alist.
4341 refs)))
4344 "Format CODE by applying FUN line-wise and return it.
4346 CODE is a string representing the code to format. FUN is
4347 a function. It must accept three arguments: a line of
4348 code (string), the current line number (integer) or nil and the
4349 reference associated to the current line (string) or nil.
4351 Optional argument NUM-LINES can be an integer representing the
4352 number of code lines accumulated until the current code. Line
4353 numbers passed to FUN will take it into account. If it is nil,
4354 FUN's second argument will always be nil. This number can be
4355 obtained with `org-export-get-loc' function.
4357 Optional argument REF-ALIST can be an alist between relative line
4358 number (i.e. ignoring NUM-LINES) and the name of the code
4359 reference on it. If it is nil, FUN's third argument will always
4360 be nil. It can be obtained through the use of
4361 `org-export-unravel-code' function."
4373 "Return source code from ELEMENT, formatted in a standard way.
4375 ELEMENT is either a `src-block' or `example-block' element. INFO
4376 is a plist used as a communication channel.
4378 This function takes care of line numbering and code references
4379 inclusion. Line numbers, when applicable, appear at the
4380 beginning of the line, separated from the code by two white
4381 spaces. Code references, on the other hand, appear flushed to
4382 the right, separated by six white spaces from the widest line of
4383 code."
4384 ;; Extract code and references.
4391 ;; Handle line numbering.
4400 ;; Prepare references display, if required. Any reference
4401 ;; should start six columns after the widest line of code,
4402 ;; wrapped with parenthesis.
4407 code
4411 number-str
4412 loc
4418 num-start refs)))))
4421 ;;;; For Tables
4422 ;;
4423 ;; `org-export-table-has-special-column-p' and and
4424 ;; `org-export-table-row-is-special-p' are predicates used to look for
4425 ;; meta-information about the table structure.
4426 ;;
4427 ;; `org-table-has-header-p' tells when the rows before the first rule
4428 ;; should be considered as table's header.
4429 ;;
4430 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4431 ;; and `org-export-table-cell-borders' extract information from
4432 ;; a table-cell element.
4433 ;;
4434 ;; `org-export-table-dimensions' gives the number on rows and columns
4435 ;; in the table, ignoring horizontal rules and special columns.
4436 ;; `org-export-table-cell-address', given a table-cell object, returns
4437 ;; the absolute address of a cell. On the other hand,
4438 ;; `org-export-get-table-cell-at' does the contrary.
4439 ;;
4440 ;; `org-export-table-cell-starts-colgroup-p',
4441 ;; `org-export-table-cell-ends-colgroup-p',
4442 ;; `org-export-table-row-starts-rowgroup-p',
4443 ;; `org-export-table-row-ends-rowgroup-p',
4444 ;; `org-export-table-row-starts-header-p',
4445 ;; `org-export-table-row-ends-header-p' and
4446 ;; `org-export-table-row-in-header-p' indicate position of current row
4447 ;; or cell within the table.
4450 "Non-nil when TABLE has a special column.
4451 All special columns will be ignored during export."
4452 ;; The table has a special column when every first cell of every row
4453 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4454 ;; "*" "_" and "^". Though, do not consider a first row containing
4455 ;; only empty cells as special.
4471 "Non-nil when TABLE has a header.
4473 INFO is a plist used as a communication channel.
4475 A table has a header when it contains at least two row groups."
4484 table
4495 cache)))))
4498 "Non-nil if TABLE-ROW is considered special.
4500 INFO is a plist used as the communication channel.
4502 All special rows will be ignored during export."
4506 ;; A row is special either when...
4508 ;; ... it starts with a field only containing "/",
4510 ;; ... the table contains a special column and the row start
4511 ;; with a marking character among, "^", "_", "$" or "!",
4515 ;; ... it contains only alignment cookies and empty cells.
4521 ;; Since VALUE is a secondary string, the following
4522 ;; checks avoid expanding it with `org-export-data'.
4534 "Return TABLE-ROW's group number, as an integer.
4536 INFO is a plist used as the communication channel.
4538 Return value is the group number, as an integer, or nil for
4539 special rows and rows separators. First group is also table's
4540 header."
4558 "Return TABLE-CELL contents width.
4560 INFO is a plist used as the communication channel.
4562 Return value is the width given by the last width cookie in the
4563 same column as TABLE-CELL, or nil."
4582 ;; In a special row, try to find a width cookie at COLUMN.
4586 ;; The following checks avoid expanding unnecessarily
4587 ;; the cell with `org-export-data'.
4597 "Return TABLE-CELL contents alignment.
4599 INFO is a plist used as the communication channel.
4601 Return alignment as specified by the last alignment cookie in the
4602 same column as TABLE-CELL. If no such cookie is found, a default
4603 alignment value will be deduced from fraction of numbers in the
4604 column (see `org-table-number-fraction' for more information).
4605 Possible values are `left', `right' and `center'."
4606 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4623 cookie-align
4624 previous-cell-number-p)
4627 ;; In a special row, try to find an alignment cookie at
4628 ;; COLUMN.
4632 ;; Since VALUE is a secondary string, the following
4633 ;; checks avoid useless expansion through
4634 ;; `org-export-data'.
4642 ;; Ignore table rules.
4644 ;; In a standard row, check if cell's contents are
4645 ;; expressing some kind of number. Increase NUMBER-CELLS
4646 ;; accordingly. Though, don't bother if an alignment
4647 ;; cookie has already defined cell's alignment.
4652 info)))
4654 ;; Treat an empty cell as a number if it follows
4655 ;; a number.
4661 ;; Return value. Alignment specified by cookies has
4662 ;; precedence over alignment deduced from cell's contents.
4664 column
4669 org-table-number-fraction)
4674 "Return TABLE-CELL borders.
4676 INFO is a plist used as a communication channel.
4678 Return value is a list of symbols, or nil. Possible values are:
4679 `top', `bottom', `above', `below', `left' and `right'. Note:
4680 `top' (resp. `bottom') only happen for a cell in the first
4681 row (resp. last row) of the table, ignoring table rules, if any.
4683 Returned borders ignore special rows."
4686 borders)
4687 ;; Top/above border? TABLE-CELL has a border above when a rule
4688 ;; used to demarcate row groups can be found above. Hence,
4689 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4690 ;; another regular row has to be found above that rule.
4699 ;; Look at every row before the current one.
4701 ;; No rule above, or rule found starts the table (ignoring any
4702 ;; special row): TABLE-CELL is at the top of the table.
4705 ;; Bottom/below border? TABLE-CELL has a border below when next
4706 ;; non-regular row below is a rule.
4715 ;; Look at every row after the current one.
4717 ;; No rule below, or rule found ends the table (modulo some
4718 ;; special row): TABLE-CELL is at the bottom of the table.
4721 ;; Right/left borders? They can only be specified by column
4722 ;; groups. Column groups are defined in a row starting with "/".
4723 ;; Also a column groups row only contains "<", "<>", ">" or blank
4724 ;; cells.
4741 ;; There's a left border when previous cell, if
4742 ;; any, ends a group, or current one starts one.
4748 ;; There's a right border when next cell, if any,
4749 ;; starts a group, or current one ends one.
4756 ;; Table rows are read in reverse order so last column groups
4757 ;; row has precedence over any previous one.
4759 ;; Return value.
4760 borders))
4763 "Non-nil when TABLE-CELL is at the beginning of a column group.
4764 INFO is a plist used as a communication channel."
4765 ;; A cell starts a column group either when it is at the beginning
4766 ;; of a row (or after the special column, if any) or when it has
4767 ;; a left border.
4770 table-cell)
4774 "Non-nil when TABLE-CELL is at the end of a column group.
4775 INFO is a plist used as a communication channel."
4776 ;; A cell ends a column group either when it is at the end of a row
4777 ;; or when it has a right border.
4780 table-cell)
4784 "Non-nil when TABLE-ROW is at the beginning of a row group.
4785 INFO is a plist used as a communication channel."
4793 "Non-nil when TABLE-ROW is at the end of a row group.
4794 INFO is a plist used as a communication channel."
4802 "Non-nil when TABLE-ROW is located within table's header.
4803 INFO is a plist used as a communication channel. Always return
4804 nil for special rows and rows separators."
4810 "Non-nil when TABLE-ROW is the first table header's row.
4811 INFO is a plist used as a communication channel."
4816 "Non-nil when TABLE-ROW is the last table header's row.
4817 INFO is a plist used as a communication channel."
4822 "Return TABLE-ROW number.
4823 INFO is a plist used as a communication channel. Return value is
4824 zero-based and ignores separators. The function returns nil for
4825 special columns and separators."
4837 "Return TABLE dimensions.
4839 INFO is a plist used as a communication channel.
4841 Return value is a CONS like (ROWS . COLUMNS) where
4842 ROWS (resp. COLUMNS) is the number of exportable
4843 rows (resp. columns)."
4845 ;; Set number of rows, and extract first one.
4851 ;; Set number of columns.
4853 ;; Return value.
4857 "Return address of a regular TABLE-CELL object.
4859 TABLE-CELL is the cell considered. INFO is a plist used as
4860 a communication channel.
4862 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4863 zero-based index. Only exportable cells are considered. The
4864 function returns nil for other cells."
4876 "Return regular table-cell object at ADDRESS in TABLE.
4878 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4879 zero-based index. TABLE is a table type element. INFO is
4880 a plist used as a communication channel.
4882 If no table-cell, among exportable cells, is found at ADDRESS,
4883 return nil."
4886 ;; Row at (car address) or nil.
4894 'table-cell
4901 ;;;; For Tables Of Contents
4902 ;;
4903 ;; `org-export-collect-headlines' builds a list of all exportable
4904 ;; headline elements, maybe limited to a certain depth. One can then
4905 ;; easily parse it and transcode it.
4906 ;;
4907 ;; Building lists of tables, figures or listings is quite similar.
4908 ;; Once the generic function `org-export-collect-elements' is defined,
4909 ;; `org-export-collect-tables', `org-export-collect-figures' and
4910 ;; `org-export-collect-listings' can be derived from it.
4913 "Collect headlines in order to build a table of contents.
4915 INFO is a plist used as a communication channel.
4917 When optional argument N is an integer, it specifies the depth of
4918 the table of contents. Otherwise, it is set to the value of the
4919 last headline level. See `org-export-headline-levels' for more
4920 information.
4922 Optional argument SCOPE, when non-nil, is an element. If it is
4923 a headline, only children of SCOPE are collected. Otherwise,
4924 collect children of the headline containing provided element. If
4925 there is no such headline, collect all headlines. In any case,
4926 argument N becomes relative to the level of that headline.
4928 Return a list of all exportable headlines as parsed elements.
4929 Footnote sections are ignored."
4938 limit))))
4944 info)))
4947 "Collect referenceable elements of a determined type.
4949 TYPE can be a symbol or a list of symbols specifying element
4950 types to search. Only elements with a caption are collected.
4952 INFO is a plist used as a communication channel.
4954 When non-nil, optional argument PREDICATE is a function accepting
4955 one argument, an element of type TYPE. It returns a non-nil
4956 value when that element should be collected.
4958 Return a list of all elements found, in order of appearance."
4963 element))
4964 info))
4967 "Build a list of tables.
4968 INFO is a plist used as a communication channel.
4970 Return a list of table elements with a caption."
4974 "Build a list of figures.
4976 INFO is a plist used as a communication channel. PREDICATE is
4977 a function which accepts one argument: a paragraph element and
4978 whose return value is non-nil when that element should be
4979 collected.
4981 A figure is a paragraph type element, with a caption, verifying
4983 a vague concept that may depend on back-end.
4985 Return a list of elements recognized as figures."
4989 "Build a list of src blocks.
4991 INFO is a plist used as a communication channel.
4993 Return a list of src-block elements with a caption."
4997 ;;;; Smart Quotes
4998 ;;
4999 ;; The main function for the smart quotes sub-system is
5000 ;; `org-export-activate-smart-quotes', which replaces every quote in
5001 ;; a given string from the parse tree with its "smart" counterpart.
5002 ;;
5003 ;; Dictionary for smart quotes is stored in
5004 ;; `org-export-smart-quotes-alist'.
5005 ;;
5006 ;; Internally, regexps matching potential smart quotes (checks at
5007 ;; string boundaries are also necessary) are defined in
5008 ;; `org-export-smart-quotes-regexps'.
5012 ;; one may use: »...«, "...", ›...‹, or '...'.
5013 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5014 ;; LaTeX quotes require Babel!
5059 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5068 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5077 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5086 ;; 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
5087 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5098 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5104 )
5105 "Smart quotes translations.
5107 Alist whose CAR is a language string and CDR is an alist with
5108 quote type as key and a plist associating various encodings to
5109 their translation as value.
5111 A quote type can be any symbol among `opening-double-quote',
5112 `closing-double-quote', `opening-single-quote',
5113 `closing-single-quote' and `apostrophe'.
5115 Valid encodings include `:utf-8', `:html', `:latex' and
5116 `:texinfo'.
5121 "Return smart quote status at the beginning of string S.
5122 INFO is the current export state, as a plist."
5127 table)))
5142 ;; Not already in a level 1 quote: this is an
5143 ;; apostrophe.
5145 ;; Apostrophe.
5147 ;; Apostrophe at the beginning of a string. Check
5148 ;; white space at the end of the last object.
5157 ;; Apostrophe at the end of a string. Check white
5158 ;; space at the beginning of the next object, which
5159 ;; can only happen if that object is a string.
5166 ;; Lonesome apostrophe. Check white space around
5167 ;; both ends.
5179 n))))))))
5181 ;; Else, consider it as a level 2 quote.
5185 current-status))
5188 info nil org-element-recursive-objects)
5195 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5196 `:utf-8'. INFO is a plist used as a communication channel.
5198 The function has to retrieve information about string
5199 surroundings in parse tree. It can only happen with an
5200 unmodified string. Thus, if S has already been through another
5201 process, a non-nil ORIGINAL optional argument will provide that
5202 original string.
5204 Return the new string."
5213 org-export-smart-quotes-alist))))
5214 encoding)
5215 match))
5216 s nil t)))
5218 ;;;; Topology
5219 ;;
5220 ;; Here are various functions to retrieve information about the
5221 ;; neighborhood of a given element or object. Neighbors of interest
5222 ;; are direct parent (`org-export-get-parent'), parent headline
5223 ;; (`org-export-get-parent-headline'), first element containing an
5224 ;; object, (`org-export-get-parent-element'), parent table
5225 ;; (`org-export-get-parent-table'), previous element or object
5226 ;; (`org-export-get-previous-element') and next element or object
5227 ;; (`org-export-get-next-element').
5229 ;; defsubst org-export-get-parent must be defined before first use
5235 "Return BLOB parent headline or nil.
5236 BLOB is the element or object being considered."
5240 "Return first element containing OBJECT or nil.
5241 OBJECT is the object to consider."
5245 "Return OBJECT parent table or nil.
5246 OBJECT is either a `table-cell' or `table-element' type object."
5250 "Return previous element or object.
5252 BLOB is an element or object. INFO is a plist used as
5253 a communication channel. Return previous exportable element or
5254 object, a string, or nil.
5256 When optional argument N is a positive integer, return a list
5257 containing up to N siblings before BLOB, from farthest to
5258 closest. With any other non-nil value, return a list containing
5259 all of them."
5265 prev)
5275 "Return next element or object.
5277 BLOB is an element or object. INFO is a plist used as
5278 a communication channel. Return next exportable element or
5279 object, a string, or nil.
5281 When optional argument N is a positive integer, return a list
5282 containing up to N siblings after BLOB, from closest to farthest.
5283 With any other non-nil value, return a list containing all of
5284 them."
5291 next)
5301 ;;;; Translation
5302 ;;
5303 ;; `org-export-translate' translates a string according to the language
5304 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5305 ;; the dictionary used for the translation.
5337 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5347 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5353 ("ru" :html "(Продолжение следует)"
5427 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5450 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5456 ("ru" :html "Список распечаток"
5470 ("ru" :html "Список таблиц"
5563 ("ru" :html "Неизвестная ссылка"
5566 "Dictionary for export engine.
5568 Alist whose car is the string to translate and cdr is an alist
5569 whose car is the language string and cdr is a plist whose
5570 properties are possible charsets and values translated terms.
5572 It is used as a database for `org-export-translate'. Since this
5573 function returns the string as-is if no translation was found,
5574 the variable only needs to record values different from the
5578 "Translate string S according to language specification.
5580 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5581 and `:utf-8'. INFO is a plist used as a communication channel.
5583 Translation depends on `:language' property. Return the
5584 translated string. If no translation is found, try to fall back
5585 to `:default' encoding. If it fails, return S."
5591 s)))
5594 \f
5595 ;;; Asynchronous Export
5596 ;;
5597 ;; `org-export-async-start' is the entry point for asynchronous
5598 ;; export. It recreates current buffer (including visibility,
5599 ;; narrowing and visited file) in an external Emacs process, and
5600 ;; evaluates a command there. It then applies a function on the
5601 ;; returned results in the current process.
5602 ;;
5603 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5604 ;; allow to export to a buffer or a file, asynchronously or not.
5605 ;;
5606 ;; `org-export-output-file-name' is an auxiliary function meant to be
5607 ;; used with `org-export-to-file'. With a given extension, it tries
5608 ;; to provide a canonical file name to write export output to.
5609 ;;
5610 ;; Asynchronously generated results are never displayed directly.
5611 ;; Instead, they are stored in `org-export-stack-contents'. They can
5612 ;; then be retrieved by calling `org-export-stack'.
5613 ;;
5614 ;; Export Stack is viewed through a dedicated major mode
5615 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5616 ;;`org-export-stack-delete', `org-export-stack-view' and
5617 ;;`org-export-stack-clear'.
5618 ;;
5619 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5620 ;; It should be used whenever `org-export-async-start' is called.
5623 "Call function FUN on the results returned by BODY evaluation.
5625 FUN is an anonymous function of one argument. BODY evaluation
5626 happens in an asynchronous process, from a buffer which is an
5627 exact copy of the current one.
5629 Use `org-export-add-to-stack' in FUN in order to register results
5630 in the stack.
5632 This is a low level function. See also `org-export-to-buffer'
5633 and `org-export-to-file' for more specialized functions."
5636 ;; Write the full sexp evaluating BODY in a copy of the current
5637 ;; buffer to a temporary file, as it may be too long for program
5638 ;; args in `start-process'.
5645 ;; Null characters (from variable values) are inserted
5646 ;; within the file. As a consequence, coding system for
5647 ;; buffer contents will not be recognized properly. So,
5648 ;; we make sure it is the same as the one used to display
5649 ;; the original buffer.
5651 ,coding
5654 ;; Ignore `kill-emacs-hook' and code evaluation
5655 ;; queries from Babel as we need a truly
5656 ;; non-interactive process.
5658 org-babel-confirm-evaluate-answer-no t)
5659 ;; Initialize export framework.
5661 ;; Re-create current buffer there.
5664 ;; Sexp to evaluate in the buffer.
5666 ;; Start external process.
5669 (,process
5671 #'start-process
5674 ,proc-buffer
5681 ;; Register running process in stack.
5683 ;; Set-up sentinel in order to catch results.
5686 ,process
5708 ;;;###autoload
5711 &optional async subtreep visible-only body-only ext-plist
5712 post-process)
5713 "Call `org-export-as' with output to a specified buffer.
5715 BACKEND is either an export back-end, as returned by, e.g.,
5716 `org-export-create-backend', or a symbol referring to
5717 a registered back-end.
5719 BUFFER is the name of the output buffer. If it already exists,
5720 it will be erased first, otherwise, it will be created.
5722 A non-nil optional argument ASYNC means the process should happen
5723 asynchronously. The resulting buffer should then be accessible
5724 through the `org-export-stack' interface. When ASYNC is nil, the
5725 buffer is displayed if `org-export-show-temporary-export-buffer'
5726 is non-nil.
5728 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5729 EXT-PLIST are similar to those used in `org-export-as', which
5730 see.
5732 Optional argument POST-PROCESS is a function which should accept
5733 no argument. It is always called within the current process,
5734 from BUFFER, with point at its beginning. Export back-ends can
5735 use it to set a major mode there, e.g,
5737 \(defun org-latex-export-as-latex
5738 \(&optional async subtreep visible-only body-only ext-plist)
5739 \(interactive)
5741 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5743 This function returns BUFFER."
5771 buffer)))
5773 ;;;###autoload
5776 post-process)
5777 "Call `org-export-as' with output to a specified file.
5779 BACKEND is either an export back-end, as returned by, e.g.,
5780 `org-export-create-backend', or a symbol referring to
5781 a registered back-end. FILE is the name of the output file, as
5782 a string.
5784 A non-nil optional argument ASYNC means the process should happen
5785 asynchronously. The resulting buffer will then be accessible
5786 through the `org-export-stack' interface.
5788 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5789 EXT-PLIST are similar to those used in `org-export-as', which
5790 see.
5792 Optional argument POST-PROCESS is called with FILE as its
5793 argument and happens asynchronously when ASYNC is non-nil. It
5794 has to return a file name, or nil. Export back-ends can use this
5795 to send the output file through additional processing, e.g,
5797 \(defun org-latex-export-to-latex
5798 \(&optional async subtreep visible-only body-only ext-plist)
5799 \(interactive)
5801 \(org-export-to-file 'latex outfile
5802 async subtreep visible-only body-only ext-plist
5803 \(lambda (file) (org-latex-compile file)))
5805 The function returns either a file name returned by POST-PROCESS,
5806 or FILE."
5825 backend subtreep visible-only body-only ext-plist)))
5832 ;; Get proper return value.
5834 file))))))
5837 "Return output file's name according to buffer specifications.
5839 EXTENSION is a string representing the output file extension,
5840 with the leading dot.
5842 With a non-nil optional argument SUBTREEP, try to determine
5844 of subtree at point.
5846 When optional argument PUB-DIR is set, use it as the publishing
5847 directory.
5849 When optional argument VISIBLE-ONLY is non-nil, don't export
5850 contents of hidden elements.
5852 Return file name as a string."
5855 ;; File name may come from EXPORT_FILE_NAME subtree
5856 ;; property, assuming point is at beginning of said
5857 ;; sub-tree.
5864 ;; File name may be extracted from buffer's associated
5865 ;; file, if any.
5867 ;; Can't determine file name on our own: Ask user.
5871 "Output file: " pub-dir nil nil nil
5875 ;; Build file name. Enforce EXTENSION over whatever user
5876 ;; may have come up with. PUB-DIR, if defined, always has
5877 ;; precedence over any provided path.
5882 extension))
5885 ;; If writing to OUTPUT-FILE would overwrite original file, append
5886 ;; EXTENSION another time to final name.
5889 output-file)))
5892 "Add a new result to export stack if not present already.
5894 SOURCE is a buffer or a file name containing export results.
5895 BACKEND is a symbol representing export back-end used to generate
5896 it.
5898 Entries already pointing to SOURCE and unavailable entries are
5899 removed beforehand. Return the new stack."
5905 "Menu for asynchronous export results and running processes."
5915 "Return source from export results at point in stack."
5922 source
5923 ;; SOURCE is not consistent with current line. The stack
5924 ;; view is outdated.
5928 "Remove all entries from export stack."
5933 "Refresh the asynchronous export stack.
5934 DUMMY is ignored. Unavailable sources are removed from the list.
5935 Return the new stack."
5945 ;; Back-end.
5947 ;; Age.
5950 ;; Compute age of the results.
5952 "%4h:%.2m "
5954 ;; Source.
5959 ;; Clear stack from exited processes, dead buffers or
5960 ;; non-existent files.
5972 "Remove export results at point from stack.
5973 If optional argument SOURCE is non-nil, remove it instead."
5978 org-export-stack-contents))))
5981 "View export results at point in stack.
5982 With an optional prefix argument IN-EMACS, force viewing files
5983 within Emacs."
5997 (define-key km "p" 'previous-line)
5998 (define-key km "\C-p" 'previous-line)
5999 (define-key km "\C-?" 'previous-line)
6000 (define-key km [up] 'previous-line)
6001 (define-key km "C" 'org-export-stack-clear)
6002 (define-key km "v" 'org-export-stack-view)
6003 (define-key km (kbd "RET") 'org-export-stack-view)
6004 (define-key km "d" 'org-export-stack-remove)
6005 km)
6006 "Keymap for Org Export Stack.")
6008 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6009 "Mode for displaying asynchronous export stack.
6012 stack.
6014 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6015 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6016 stack completely.
6018 Removing entries in an Org Export Stack buffer doesn't affect
6019 files or buffers, only the display.
6022 (abbrev-mode 0)
6023 (auto-fill-mode 0)
6024 (setq buffer-read-only t
6025 buffer-undo-list t
6026 truncate-lines t
6027 header-line-format
6028 '(:eval
6029 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6030 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6031 (set (make-local-variable 'revert-buffer-function)
6032 'org-export-stack-refresh))
6035 \f
6036 ;;; The Dispatcher
6037 ;;
6038 ;; `org-export-dispatch' is the standard interactive way to start an
6039 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6040 ;; for its interface, which, in turn, delegates response to key
6041 ;; pressed to `org-export--dispatch-action'.
6043 ;;;###autoload
6044 (defun org-export-dispatch (&optional arg)
6045 "Export dispatcher for Org mode.
6047 It provides an access to common export related tasks in a buffer.
6048 Its interface comes in two flavors: standard and expert.
6050 While both share the same set of bindings, only the former
6051 displays the valid keys associations in a dedicated buffer.
6052 Scrolling (resp. line-wise motion) in this buffer is done with
6053 SPC and DEL (resp. C-n and C-p) keys.
6055 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6056 flavor or the other.
6059 of options used back then, on the current buffer.
6061 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6062 (interactive "P")
6063 (let* ((input
6064 (cond ((equal arg '(16)) '(stack))
6065 ((and arg org-export-dispatch-last-action))
6066 (t (save-window-excursion
6067 (unwind-protect
6068 (progn
6069 ;; Remember where we are
6070 (move-marker org-export-dispatch-last-position
6071 (point)
6072 (org-base-buffer (current-buffer)))
6073 ;; Get and store an export command
6074 (setq org-export-dispatch-last-action
6075 (org-export--dispatch-ui
6076 (list org-export-initial-scope
6077 (and org-export-in-background 'async))
6078 nil
6079 org-export-dispatch-use-expert-ui)))
6080 (and (get-buffer "*Org Export Dispatcher*")
6081 (kill-buffer "*Org Export Dispatcher*")))))))
6082 (action (car input))
6083 (optns (cdr input)))
6084 (unless (memq 'subtree optns)
6085 (move-marker org-export-dispatch-last-position nil))
6086 (case action
6087 ;; First handle special hard-coded actions.
6088 (template (org-export-insert-default-template nil optns))
6089 (stack (org-export-stack))
6090 (publish-current-file
6091 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6092 (publish-current-project
6093 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6094 (publish-choose-project
6095 (org-publish (assoc (org-icompleting-read
6096 "Publish project: "
6097 org-publish-project-alist nil t)
6098 org-publish-project-alist)
6099 (memq 'force optns)
6100 (memq 'async optns)))
6101 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6102 (otherwise
6103 (save-excursion
6104 (when arg
6105 ;; Repeating command, maybe move cursor to restore subtree
6106 ;; context.
6107 (if (eq (marker-buffer org-export-dispatch-last-position)
6108 (org-base-buffer (current-buffer)))
6109 (goto-char org-export-dispatch-last-position)
6110 ;; We are in a different buffer, forget position.
6111 (move-marker org-export-dispatch-last-position nil)))
6112 (funcall action
6113 ;; Return a symbol instead of a list to ease
6114 ;; asynchronous export macro use.
6115 (and (memq 'async optns) t)
6116 (and (memq 'subtree optns) t)
6117 (and (memq 'visible optns) t)
6118 (and (memq 'body optns) t)))))))
6120 (defun org-export--dispatch-ui (options first-key expertp)
6121 "Handle interface for `org-export-dispatch'.
6123 OPTIONS is a list containing current interactive options set for
6124 export. It can contain any of the following symbols:
6125 `body' toggles a body-only export
6126 `subtree' restricts export to current subtree
6127 `visible' restricts export to visible part of buffer.
6128 `force' force publishing files.
6129 `async' use asynchronous export process
6131 FIRST-KEY is the key pressed to select the first level menu. It
6132 is nil when this menu hasn't been selected yet.
6134 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6135 buffer is provided, but indications about currently active
6136 options are given in the prompt. Moreover, \[?] allows to switch
6137 back to standard interface."
6138 (let* ((fontify-key
6139 (lambda (key &optional access-key)
6140 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6141 ;; non-nil is the required first-level key to activate
6142 ;; KEY. When its value is t, activate KEY independently
6143 ;; on the first key, if any. A nil value means KEY will
6144 ;; only be activated at first level.
6145 (if (or (eq access-key t) (eq access-key first-key))
6146 (org-propertize key 'face 'org-warning)
6147 key)))
6148 (fontify-value
6149 (lambda (value)
6150 ;; Fontify VALUE string.
6151 (org-propertize value 'face 'font-lock-variable-name-face)))
6152 ;; Prepare menu entries by extracting them from registered
6153 ;; back-ends and sorting them by access key and by ordinal,
6154 ;; if any.
6155 (entries
6156 (sort (sort (delq nil
6157 (mapcar 'org-export-backend-menu
6158 org-export--registered-backends))
6159 (lambda (a b)
6160 (let ((key-a (nth 1 a))
6161 (key-b (nth 1 b)))
6162 (cond ((and (numberp key-a) (numberp key-b))
6163 (< key-a key-b))
6164 ((numberp key-b) t)))))
6165 'car-less-than-car))
6166 ;; Compute a list of allowed keys based on the first key
6167 ;; pressed, if any. Some keys
6168 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6169 ;; available.
6170 (allowed-keys
6171 (nconc (list 2 22 19 6 1)
6172 (if (not first-key) (org-uniquify (mapcar 'car entries))
6173 (let (sub-menu)
6174 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6175 (when (eq (car entry) first-key)
6176 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6177 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6178 ((not first-key) (list ?P)))
6179 (list ?& ?#)
6180 (when expertp (list ??))
6181 (list ?q)))
6182 ;; Build the help menu for standard UI.
6183 (help
6184 (unless expertp
6185 (concat
6186 ;; Options are hard-coded.
6187 (format "[%s] Body only: %s [%s] Visible only: %s
6188 \[%s] Export scope: %s [%s] Force publishing: %s
6190 (funcall fontify-key "C-b" t)
6191 (funcall fontify-value
6192 (if (memq 'body options) "On " "Off"))
6193 (funcall fontify-key "C-v" t)
6194 (funcall fontify-value
6195 (if (memq 'visible options) "On " "Off"))
6196 (funcall fontify-key "C-s" t)
6197 (funcall fontify-value
6198 (if (memq 'subtree options) "Subtree" "Buffer "))
6199 (funcall fontify-key "C-f" t)
6200 (funcall fontify-value
6201 (if (memq 'force options) "On " "Off"))
6202 (funcall fontify-key "C-a" t)
6203 (funcall fontify-value
6204 (if (memq 'async options) "On " "Off")))
6205 ;; Display registered back-end entries. When a key
6206 ;; appears for the second time, do not create another
6207 ;; entry, but append its sub-menu to existing menu.
6208 (let (last-key)
6209 (mapconcat
6210 (lambda (entry)
6211 (let ((top-key (car entry)))
6212 (concat
6213 (unless (eq top-key last-key)
6214 (setq last-key top-key)
6216 (funcall fontify-key (char-to-string top-key))
6217 (nth 1 entry)))
6218 (let ((sub-menu (nth 2 entry)))
6219 (unless (functionp sub-menu)
6220 ;; Split sub-menu into two columns.
6221 (let ((index -1))
6222 (concat
6223 (mapconcat
6224 (lambda (sub-entry)
6225 (incf index)
6226 (format
6227 (if (zerop (mod index 2)) " [%s] %-26s"
6229 (funcall fontify-key
6230 (char-to-string (car sub-entry))
6231 top-key)
6232 (nth 1 sub-entry)))
6233 sub-menu "")
6235 entries ""))
6236 ;; Publishing menu is hard-coded.
6238 [%s] Current file [%s] Current project
6240 (funcall fontify-key "P")
6241 (funcall fontify-key "f" ?P)
6242 (funcall fontify-key "p" ?P)
6243 (funcall fontify-key "x" ?P)
6244 (funcall fontify-key "a" ?P))
6246 (funcall fontify-key "&" t)
6247 (funcall fontify-key "#" t))
6248 (format "[%s] %s"
6249 (funcall fontify-key "q" t)
6250 (if first-key "Main menu" "Exit")))))
6251 ;; Build prompts for both standard and expert UI.
6252 (standard-prompt (unless expertp "Export command: "))
6253 (expert-prompt
6254 (when expertp
6255 (format
6256 "Export command (C-%s%s%s%s%s) [%s]: "
6257 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6258 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6259 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6260 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6261 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6262 (mapconcat (lambda (k)
6263 ;; Strip control characters.
6264 (unless (< k 27) (char-to-string k)))
6265 allowed-keys "")))))
6266 ;; With expert UI, just read key with a fancy prompt. In standard
6267 ;; UI, display an intrusive help buffer.
6268 (if expertp
6269 (org-export--dispatch-action
6270 expert-prompt allowed-keys entries options first-key expertp)
6271 ;; At first call, create frame layout in order to display menu.
6272 (unless (get-buffer "*Org Export Dispatcher*")
6273 (delete-other-windows)
6274 (org-switch-to-buffer-other-window
6275 (get-buffer-create "*Org Export Dispatcher*"))
6276 (setq cursor-type nil
6277 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6278 ;; Make sure that invisible cursor will not highlight square
6279 ;; brackets.
6280 (set-syntax-table (copy-syntax-table))
6281 (modify-syntax-entry ?\[ "w"))
6282 ;; At this point, the buffer containing the menu exists and is
6283 ;; visible in the current window. So, refresh it.
6284 (with-current-buffer "*Org Export Dispatcher*"
6285 ;; Refresh help. Maintain display continuity by re-visiting
6286 ;; previous window position.
6287 (let ((pos (window-start)))
6288 (erase-buffer)
6289 (insert help)
6290 (set-window-start nil pos)))
6291 (org-fit-window-to-buffer)
6292 (org-export--dispatch-action
6293 standard-prompt allowed-keys entries options first-key expertp))))
6295 (defun org-export--dispatch-action
6296 (prompt allowed-keys entries options first-key expertp)
6297 "Read a character from command input and act accordingly.
6299 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6300 a list of characters available at a given step in the process.
6301 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6302 EXPERTP are the same as defined in `org-export--dispatch-ui',
6303 which see.
6305 Toggle export options when required. Otherwise, return value is
6306 a list with action as CAR and a list of interactive export
6307 options as CDR."
6308 (let (key)
6309 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6310 ;; C-p, SPC, DEL).
6311 (while (and (setq key (read-char-exclusive prompt))
6312 (not expertp)
6313 (memq key '(14 16 ?\s ?\d)))
6314 (case key
6315 (14 (if (not (pos-visible-in-window-p (point-max)))
6316 (ignore-errors (scroll-up 1))
6317 (message "End of buffer")
6318 (sit-for 1)))
6319 (16 (if (not (pos-visible-in-window-p (point-min)))
6320 (ignore-errors (scroll-down 1))
6321 (message "Beginning of buffer")
6322 (sit-for 1)))
6323 (?\s (if (not (pos-visible-in-window-p (point-max)))
6324 (scroll-up nil)
6325 (message "End of buffer")
6326 (sit-for 1)))
6327 (?\d (if (not (pos-visible-in-window-p (point-min)))
6328 (scroll-down nil)
6329 (message "Beginning of buffer")
6330 (sit-for 1)))))
6331 (cond
6332 ;; Ignore undefined associations.
6333 ((not (memq key allowed-keys))
6334 (ding)
6335 (unless expertp (message "Invalid key") (sit-for 1))
6336 (org-export--dispatch-ui options first-key expertp))
6337 ;; q key at first level aborts export. At second level, cancel
6338 ;; first key instead.
6339 ((eq key ?q) (if (not first-key) (error "Export aborted")
6340 (org-export--dispatch-ui options nil expertp)))
6341 ;; Help key: Switch back to standard interface if expert UI was
6342 ;; active.
6343 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6344 ;; Send request for template insertion along with export scope.
6345 ((eq key ?#) (cons 'template (memq 'subtree options)))
6346 ;; Switch to asynchronous export stack.
6347 ((eq key ?&) '(stack))
6348 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6349 ((memq key '(2 22 19 6 1))
6350 (org-export--dispatch-ui
6351 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6352 (6 'force) (1 'async))))
6353 (if (memq option options) (remq option options)
6354 (cons option options)))
6355 first-key expertp))
6356 ;; Action selected: Send key and options back to
6357 ;; `org-export-dispatch'.
6358 ((or first-key (functionp (nth 2 (assq key entries))))
6359 (cons (cond
6360 ((not first-key) (nth 2 (assq key entries)))
6361 ;; Publishing actions are hard-coded. Send a special
6362 ;; signal to `org-export-dispatch'.
6363 ((eq first-key ?P)
6364 (case key
6365 (?f 'publish-current-file)
6366 (?p 'publish-current-project)
6367 (?x 'publish-choose-project)
6368 (?a 'publish-all)))
6369 ;; Return first action associated to FIRST-KEY + KEY
6370 ;; path. Indeed, derived backends can share the same
6371 ;; FIRST-KEY.
6372 (t (catch 'found
6373 (mapc (lambda (entry)
6374 (let ((match (assq key (nth 2 entry))))
6375 (when match (throw 'found (nth 2 match)))))
6376 (member (assq first-key entries) entries)))))
6377 options))
6378 ;; Otherwise, enter sub-menu.
6379 (t (org-export--dispatch-ui options key expertp)))))
6383 (provide 'ox)
6385 ;; Local variables:
6386 ;; generated-autoload-file: "org-loaddefs.el"
6387 ;; End:
6389 ;;; ox.el ends here