| blob | 929aa8c847d8fe91c11862fafd6ff172ee0c3018 |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 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:
89 \f
90 ;;; Internal Variables
91 ;;
92 ;; Among internal variables, the most important is
93 ;; `org-export-options-alist'. This variable define the global export
94 ;; 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,
352 "Non-nil means insert author name into the exported file.
353 This option can also be set with the OPTIONS keyword,
360 "Non-nil means export CLOCK keywords.
361 This option can also be set with the OPTIONS keyword,
368 "Non-nil means the postamble should contain a creator sentence.
370 The sentence can be set in `org-export-creator-string', which
371 see.
373 This option can also be set with the OPTIONS keyword, e.g.,
382 "Non-nil means insert date in the exported document.
383 This option can also be set with the OPTIONS keyword,
390 "Time-stamp format string to use for DATE keyword.
392 The format string, when specified, only applies if date consists
393 in a single time-stamp. Otherwise its value will be ignored.
395 See `format-time-string' for details on how to build this
396 string."
405 emacs-version
407 "Information about the creator of the document.
408 This option can also be set on with the CREATOR keyword."
414 "Non-nil means export contents of standard drawers.
416 When t, all drawers are exported. This may also be a list of
417 drawer names to export, as strings. If that list starts with
418 `not', only drawers with such names will be ignored.
420 This variable doesn't apply to properties drawers. See
421 `org-export-with-properties' instead.
423 This option can also be set with the OPTIONS keyword,
436 :inline t
445 "Non-nil means insert author email into the exported file.
446 This option can also be set with the OPTIONS keyword,
453 "Non-nil means interpret *word*, /word/, _word_ and +word+.
455 If the export target supports emphasizing text, the word will be
456 typeset in bold, italic, with an underline or strike-through,
457 respectively.
459 This option can also be set with the OPTIONS keyword,
466 "Tags that exclude a tree from export.
468 All trees carrying any of these tags will be excluded from
469 export. This is without condition, so even subtrees inside that
470 carry one of the `org-export-select-tags' will be removed.
472 This option can also be set with the EXCLUDE_TAGS keyword."
479 This option can also be set with the OPTIONS keyword,
488 "Non-nil means Org footnotes should be exported.
489 This option can also be set with the OPTIONS keyword,
496 "Non-nil means process LaTeX environments and fragments.
498 This option can also be set with the OPTIONS line,
501 nil Ignore math snippets.
502 `verbatim' Keep everything in verbatim.
503 t Allow export of math snippets."
514 "The last level which is still exported as a headline.
516 Inferior levels will usually produce itemize or enumerate lists
517 when exported, but back-end behavior may differ.
519 This option can also be set with the OPTIONS keyword,
526 "The default language for export and clocktable translations, as a string.
527 This may have an association in
528 `org-clock-clocktable-language-setup',
529 `org-export-smart-quotes-alist' and `org-export-dictionary'.
530 This option can also be set with the LANGUAGE keyword."
536 "Non-nil means preserve all line breaks when exporting.
537 This option can also be set with the OPTIONS keyword,
544 "Non-nil means interpret entities when exporting.
547 Å.
549 For a list of supported names, see the constant `org-entities'
550 and the user option `org-entities-user'.
552 This option can also be set with the OPTIONS keyword,
559 "Non-nil means inlinetasks should be exported.
560 This option can also be set with the OPTIONS keyword,
569 "Non-nil means include planning info in export.
571 Planning info is the line containing either SCHEDULED:,
572 DEADLINE:, CLOSED: time-stamps, or a combination of them.
574 This option can also be set with the OPTIONS keyword,
583 "Non-nil means include priority cookies in export.
584 This option can also be set with the OPTIONS keyword,
591 "Non-nil means export contents of properties drawers.
593 When t, all properties are exported. This may also be a list of
594 properties to export, as strings.
596 This option can also be set with the OPTIONS keyword,
610 "Non-nil means add section numbers to headlines when exporting.
612 When set to an integer n, numbering will only happen for
613 headlines whose relative level is higher or equal to n.
615 This option can also be set with the OPTIONS keyword,
622 "Tags that select a tree for export.
624 If any such tag is found in a buffer, all trees that do not carry
625 one of these tags will be ignored during export. Inside trees
626 that are selected like this, you can still deselect a subtree by
627 tagging it with one of the `org-export-exclude-tags'.
629 This option can also be set with the SELECT_TAGS keyword."
635 "Non-nil means activate smart quotes during export.
636 This option can also be set with the OPTIONS keyword,
639 When setting this to non-nil, you need to take care of
640 using the correct Babel package when exporting to LaTeX.
641 E.g., you can load Babel for french like this:
653 When this option is turned on, these strings will be exported as:
655 Org HTML LaTeX UTF-8
656 -----+----------+--------+-------
658 -- – -- –
659 --- — --- —
662 This option can also be set with the OPTIONS keyword,
669 "Non-nil means include statistics cookies in export.
670 This option can also be set with the OPTIONS keyword,
681 If you want to control how Org displays those characters, see
682 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
683 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
684 it is not anymore.
686 When this option is turned on, you can use TeX-like syntax for
687 sub- and superscripts and see them exported correctly.
689 You can also set the option with #+OPTIONS: ^:t
692 single item - so grouping with {} is normally not needed. For
693 example, the following things will be parsed as single sub- or
694 superscripts:
696 10^24 or 10^tau several digits will be considered 1 item.
697 10^-12 or 10^-tau a leading sign with digits or a word
698 x^2-y^3 will be read as x^2 - y^3, because items are
699 terminated by almost any nonword/nondigit char.
700 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
702 Still, ambiguity is possible. So when in doubt, use {} to enclose
703 the sub/superscript. If you set this variable to the symbol `{}',
704 the braces are *required* in order to trigger interpretations as
706 frequently in plain text."
717 "Non-nil means create a table of contents in exported files.
719 The TOC contains headlines with levels up
720 to`org-export-headline-levels'. When an integer, include levels
721 up to N in the toc, this may then be different from
722 `org-export-headline-levels', but it will not be allowed to be
723 larger than the number of headline levels. When nil, no table of
724 contents is made.
726 This option can also be set with the OPTIONS keyword,
737 "Non-nil means export tables.
738 This option can also be set with the OPTIONS keyword,
747 "If nil, do not export tags, just remove them from headlines.
749 If this is the symbol `not-in-toc', tags will be removed from
750 table of contents entries, but still be shown in the headlines of
751 the document.
753 This option can also be set with the OPTIONS keyword,
763 "Non-nil means include TODO items for export.
765 This may have the following values:
766 t include tasks independent of state.
767 `todo' include only tasks that are not yet done.
768 `done' include only tasks that are already done.
769 nil ignore all tasks.
770 list of keywords include tasks with these keywords.
772 This option can also be set with the OPTIONS keyword,
787 "Non-nil means print title into the exported file.
788 This option can also be set with the OPTIONS keyword,
797 "Non-nil means insert a time stamp into the exported file.
798 The time stamp shows when the file was created. This option can
805 "Non nil means allow timestamps in export.
807 It can be set to any of the following values:
808 t export all timestamps.
809 `active' export active timestamps only.
810 `inactive' export inactive timestamps only.
811 nil do not export timestamps
813 This only applies to timestamps isolated in a paragraph
814 containing only timestamps. Other timestamps are always
815 exported.
817 This option can also be set with the OPTIONS keyword, e.g.
828 "Non-nil means include TODO keywords in export.
829 When nil, remove all these keywords from the export. This option
835 "Non-nil means BIND keywords can define local variable values.
836 This is a potential security risk, which is why the default value
837 is nil. You can also allow them through local buffer variables."
844 "Non-nil means do not raise an error on broken links.
846 When this variable is non-nil, broken links are ignored, without
847 stopping the export process. If it is set to `mark', broken
848 links are marked as such in the output, with a string like
850 [BROKEN LINK: path]
852 where PATH is the un-resolvable reference.
854 This option can also be set with the OPTIONS keyword, e.g.,
865 "Alist between export snippets back-ends and exporter back-ends.
867 This variable allows providing shortcuts for export snippets.
871 HTML code while every other back-end will ignore it."
885 "Coding system for the exported file."
892 "Non-nil means pushing export output to the kill ring.
893 This variable is ignored during asynchronous export."
903 "The initial scope when exporting with `org-export-dispatch'.
904 This variable can be either set to `buffer' or `subtree'."
911 "Non-nil means show buffer after exporting to temp buffer.
912 When Org exports to a file, the buffer visiting that file is never
913 shown, but remains buried. However, when exporting to
914 a temporary buffer, that buffer is popped up in a second window.
915 When this variable is nil, the buffer remains buried also in
916 these cases."
921 "Non-nil means export and publishing commands will run in background.
922 Results from an asynchronous export are never displayed
930 "File used to initialize external export process.
932 Value must be either nil or an absolute file name. When nil, the
933 external process is launched like a regular Emacs session,
934 loading user's initialization file and any site specific
935 configuration. If a file is provided, it, and only it, is loaded
936 at start-up.
938 Therefore, using a specific configuration makes the process to
939 load faster and the export more portable."
948 "Non-nil means using a non-intrusive `org-export-dispatch'.
949 In that case, no help buffer is displayed. Though, an indicator
955 asynchronous). Also, [?] allows switching back to standard
956 mode."
963 \f
964 ;;; Defining Back-ends
965 ;;
966 ;; An export back-end is a structure with `org-export-backend' type
967 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
968 ;; and `menu' slots.
969 ;;
970 ;; At the lowest level, a back-end is created with
971 ;; `org-export-create-backend' function.
972 ;;
973 ;; A named back-end can be registered with
974 ;; `org-export-register-backend' function. A registered back-end can
975 ;; later be referred to by its name, with `org-export-get-backend'
976 ;; function. Also, such a back-end can become the parent of a derived
977 ;; back-end from which slot values will be inherited by default.
978 ;; `org-export-derived-backend-p' can check if a given back-end is
979 ;; derived from a list of back-end names.
980 ;;
981 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
982 ;; `org-export-get-all-filters' return the full alist of transcoders,
983 ;; options and filters, including those inherited from ancestors.
984 ;;
985 ;; At a higher level, `org-export-define-backend' is the standard way
986 ;; to define an export back-end. If the new back-end is similar to
987 ;; a registered back-end, `org-export-define-derived-backend' may be
988 ;; used instead.
989 ;;
990 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
991 ;; when a given back-end hasn't been registered yet.
995 name parent transcoders options filters blocks menu)
998 "Return export back-end named after NAME.
999 NAME is a symbol. Return nil if no such back-end is found."
1006 "Register BACKEND as a known export back-end.
1007 BACKEND is a structure with `org-export-backend' type."
1008 ;; Refuse to register an unnamed back-end.
1011 ;; Refuse to register a back-end with an unknown parent.
1015 ;; If a back-end with the same name as BACKEND is already
1016 ;; registered, replace it with BACKEND. Otherwise, simply add
1017 ;; BACKEND to the list of registered back-ends.
1023 "Signal an error if BACKEND isn't defined."
1028 "Non-nil if BACKEND is derived from one of BACKENDS.
1029 BACKEND is an export back-end, as returned by, e.g.,
1030 `org-export-create-backend', or a symbol referring to
1031 a registered back-end. BACKENDS is constituted of symbols."
1043 "Return full translation table for BACKEND.
1045 BACKEND is an export back-end, as return by, e.g,,
1046 `org-export-create-backend'. Return value is an alist where
1047 keys are element or object types, as symbols, and values are
1048 transcoders.
1050 Unlike to `org-export-backend-transcoders', this function
1051 also returns transcoders inherited from parent back-ends,
1052 if any."
1056 parent)
1061 transcoders)))
1064 "Return export options for BACKEND.
1066 BACKEND is an export back-end, as return by, e.g,,
1067 `org-export-create-backend'. See `org-export-options-alist'
1068 for the shape of the return value.
1070 Unlike to `org-export-backend-options', this function also
1071 returns options inherited from parent back-ends, if any."
1075 parent)
1079 options)))
1082 "Return complete list of filters for BACKEND.
1084 BACKEND is an export back-end, as return by, e.g,,
1085 `org-export-create-backend'. Return value is an alist where
1086 keys are symbols and values lists of functions.
1088 Unlike to `org-export-backend-filters', this function also
1089 returns filters inherited from parent back-ends, if any."
1093 parent)
1097 filters)))
1100 "Define a new back-end BACKEND.
1102 TRANSCODERS is an alist between object or element types and
1103 functions handling them.
1105 These functions should return a string without any trailing
1106 space, or nil. They must accept three arguments: the object or
1107 element itself, its contents or nil when it isn't recursive and
1108 the property list used as a communication channel.
1110 Contents, when not nil, are stripped from any global indentation
1111 \(although the relative one is preserved). They also always end
1112 with a single newline character.
1114 If, for a given type, no function is found, that element or
1115 object type will simply be ignored, along with any blank line or
1116 white space at its end. The same will happen if the function
1117 returns the nil value. If that function returns the empty
1118 string, the type will be ignored, but the blank lines or white
1119 spaces will be kept.
1121 In addition to element and object types, one function can be
1122 associated to the `template' (or `inner-template') symbol and
1123 another one to the `plain-text' symbol.
1125 The former returns the final transcoded string, and can be used
1126 to add a preamble and a postamble to document's body. It must
1127 accept two arguments: the transcoded string and the property list
1128 containing export options. A function associated to `template'
1130 A function associated to `inner-template' is always applied.
1132 The latter, when defined, is to be called on every text not
1133 recognized as an element or an object. It must accept two
1134 arguments: the text string and the information channel. It is an
1135 appropriate place to protect special chars relative to the
1136 back-end.
1138 BODY can start with pre-defined keyword arguments. The following
1139 keywords are understood:
1141 :filters-alist
1143 Alist between filters and function, or list of functions,
1144 specific to the back-end. See `org-export-filters-alist' for
1145 a list of all allowed filters. Filters defined here
1146 shouldn't make a back-end test, as it may prevent back-ends
1147 derived from this one to behave properly.
1149 :menu-entry
1151 Menu entry for the export dispatcher. It should be a list
1152 like:
1156 where :
1158 KEY is a free character selecting the back-end.
1160 DESCRIPTION-OR-ORDINAL is either a string or a number.
1162 If it is a string, is will be used to name the back-end in
1163 its menu entry. If it is a number, the following menu will
1164 be displayed as a sub-menu of the back-end with the same
1165 KEY. Also, the number will be used to determine in which
1166 order such sub-menus will appear (lowest first).
1168 ACTION-OR-MENU is either a function or an alist.
1170 If it is an action, it will be called with four
1171 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1172 BODY-ONLY. See `org-export-as' for further explanations on
1173 some of them.
1175 If it is an alist, associations should follow the
1176 pattern:
1180 where KEY, DESCRIPTION and ACTION are described above.
1182 Valid values include:
1186 or
1191 (lambda (a s v b)
1192 (if a (org-latex-export-to-pdf t s v b)
1193 (org-open-file
1194 (org-latex-export-to-pdf nil s v b)))))))
1196 or the following, which will be added to the previous
1197 sub-menu,
1203 :options-alist
1205 Alist between back-end specific properties introduced in
1206 communication channel and how their value are acquired. See
1207 `org-export-options-alist' for more information about
1208 structure of the values."
1220 :transcoders transcoders
1221 :options options
1222 :filters filters
1226 "Create a new back-end as a variant of an existing one.
1228 CHILD is the name of the derived back-end. PARENT is the name of
1229 the parent back-end.
1231 BODY can start with pre-defined keyword arguments. The following
1232 keywords are understood:
1234 :filters-alist
1236 Alist of filters that will overwrite or complete filters
1237 defined in PARENT back-end. See `org-export-filters-alist'
1238 for a list of allowed filters.
1240 :menu-entry
1242 Menu entry for the export dispatcher. See
1243 `org-export-define-backend' for more information about the
1244 expected value.
1246 :options-alist
1248 Alist of back-end specific properties that will overwrite or
1249 complete those defined in PARENT back-end. Refer to
1250 `org-export-options-alist' for more information about
1251 structure of the values.
1253 :translate-alist
1255 Alist of element and object types and transcoders that will
1256 overwrite or complete transcode table from PARENT back-end.
1257 Refer to `org-export-define-backend' for detailed information
1258 about transcoders.
1261 as a variant of `latex' back-end with a custom template function:
1266 The back-end could then be called with, for example:
1281 :parent parent
1282 :transcoders transcoders
1283 :options options
1284 :filters filters
1288 \f
1289 ;;; The Communication Channel
1290 ;;
1291 ;; During export process, every function has access to a number of
1292 ;; properties. They are of two types:
1293 ;;
1294 ;; 1. Environment options are collected once at the very beginning of
1295 ;; the process, out of the original buffer and configuration.
1296 ;; Collecting them is handled by `org-export-get-environment'
1297 ;; function.
1298 ;;
1299 ;; Most environment options are defined through the
1300 ;; `org-export-options-alist' variable.
1301 ;;
1302 ;; 2. Tree properties are extracted directly from the parsed tree,
1303 ;; just before export, by `org-export--collect-tree-properties'.
1305 ;;;; Environment Options
1306 ;;
1307 ;; Environment options encompass all parameters defined outside the
1308 ;; scope of the parsed data. They come from five sources, in
1309 ;; increasing precedence order:
1310 ;;
1311 ;; - Global variables,
1312 ;; - Buffer's attributes,
1313 ;; - Options keyword symbols,
1314 ;; - Buffer keywords,
1315 ;; - Subtree properties.
1316 ;;
1317 ;; The central internal function with regards to environment options
1318 ;; is `org-export-get-environment'. It updates global variables with
1319 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1320 ;; the different sources.
1321 ;;
1322 ;; The internal functions doing the retrieval are:
1323 ;; `org-export--get-global-options',
1324 ;; `org-export--get-buffer-attributes',
1325 ;; `org-export--parse-option-keyword',
1326 ;; `org-export--get-subtree-options' and
1327 ;; `org-export--get-inbuffer-options'
1328 ;;
1329 ;; Also, `org-export--list-bound-variables' collects bound variables
1330 ;; along with their value in order to set them as buffer local
1331 ;; variables later in the process.
1334 "Collect export options from the current buffer.
1336 Optional argument BACKEND is an export back-end, as returned by
1337 `org-export-create-backend'.
1339 When optional argument SUBTREEP is non-nil, assume the export is
1340 done against the current sub-tree.
1342 Third optional argument EXT-PLIST is a property list with
1343 external parameters overriding Org default settings, but still
1344 inferior to file-local settings."
1345 ;; First install #+BIND variables since these must be set before
1346 ;; global options are read.
1349 ;; Get and prioritize export options...
1351 ;; ... from global variables...
1353 ;; ... from an external property list...
1354 ext-plist
1355 ;; ... from in-buffer settings...
1357 ;; ... and from subtree, when appropriate.
1361 "Parse an OPTIONS line and return values as a plist.
1362 Optional argument BACKEND is an export back-end, as returned by,
1363 e.g., `org-export-create-backend'. It specifies which back-end
1364 specific items to read, if any."
1371 alist))
1372 alist))
1373 ;; Priority is given to back-end specific options.
1375 org-export-options-alist))
1385 "Get export options in subtree at point.
1386 Optional argument BACKEND is an export back-end, as returned by,
1387 e.g., `org-export-create-backend'. It specifies back-end used
1388 for export. Return options as a plist."
1389 ;; For each buffer keyword, create a headline property setting the
1390 ;; same property in communication channel. The name for the
1391 ;; property is the keyword with "EXPORT_" appended to it.
1393 ;; Make sure point is at a heading.
1396 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1397 ;; care of them right from the start.
1400 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1401 ;; headline's title (with no todo keyword, priority cookie or
1402 ;; tag) as its fallback value.
1408 ;; Look for both general keywords and back-end specific
1409 ;; options, with priority given to the latter.
1411 org-export-options-alist)))
1412 ;; Handle other keywords. Then return PLIST.
1426 property
1435 "Return current buffer export options, as a plist.
1437 Optional argument BACKEND, when non-nil, is an export back-end,
1438 as returned by, e.g., `org-export-create-backend'. It specifies
1439 which back-end specific options should also be read in the
1440 process.
1442 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1445 ;; Priority is given to back-end specific options.
1447 org-export-options-alist))
1450 org-export-special-keywords))))
1451 plist to-parse)
1454 ;; Return all properties associated to KEYWORD.
1461 ;; Recursively read keywords in buffer. FILES is
1462 ;; a list of files read so far. PLIST is the current
1463 ;; property list obtained.
1472 ;; Options in `org-export-special-keywords'.
1477 ;; Avoid circular dependencies.
1488 plist
1490 val backend))))
1494 plist
1501 ;; Options in `org-export-options-alist'.
1504 plist
1506 plist property
1507 ;; Handle value depending on specified
1508 ;; BEHAVIOR.
1513 ;; Even if `parse' implies `space'
1514 ;; behavior, we separate line with
1515 ;; "\n" so as to preserve
1516 ;; line-breaks. However, empty
1517 ;; lines are forbidden since `parse'
1518 ;; doesn't allow more than one
1519 ;; paragraph.
1528 " "
1541 ;; Read options in the current buffer and return value.
1543 ;; Parse properties in TO-PARSE. Remove newline characters not
1544 ;; involved in line breaks to simulate `space' behavior.
1545 ;; Finally return options.
1558 "Return properties related to export process, as a plist.
1559 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1560 are like the arguments with the same names of function
1561 `org-export-as'."
1566 :back-end backend
1571 "Return properties related to buffer attributes, as a plist."
1576 "Return global export options as a plist.
1577 Optional argument BACKEND, if non-nil, is an export back-end, as
1578 returned by, e.g., `org-export-create-backend'. It specifies
1579 which back-end specific export options should also be read in the
1580 process."
1582 ;; Priority is given to back-end specific options.
1584 org-export-options-alist)))
1590 plist
1591 prop
1592 ;; Evaluate default value provided.
1597 value)))))))))
1600 "Return variables bound from BIND keywords in current buffer.
1601 Also look for BIND keywords in setup files. The return value is
1602 an alist where associations are (VARIABLE-NAME VALUE)."
1606 ;; Return an alist between variable names and their
1607 ;; value. FILES is a list of setup files names read
1608 ;; so far, used to avoid circular dependencies. ALIST
1609 ;; is the alist collected so far.
1621 ;; Enter setup file.
1633 alist))))))))))
1634 alist)))))
1635 ;; Return value in appropriate order of appearance.
1638 ;; defsubst org-export-get-parent must be defined before first use,
1639 ;; was originally defined in the topology section
1642 "Return BLOB parent or nil.
1643 BLOB is the element or object considered."
1646 ;;;; Tree Properties
1647 ;;
1648 ;; Tree properties are information extracted from parse tree. They
1649 ;; are initialized at the beginning of the transcoding process by
1650 ;; `org-export--collect-tree-properties'.
1651 ;;
1652 ;; Dedicated functions focus on computing the value of specific tree
1653 ;; properties during initialization. Thus,
1654 ;; `org-export--populate-ignore-list' lists elements and objects that
1655 ;; should be skipped during export, `org-export--get-min-level' gets
1656 ;; the minimal exportable level, used as a basis to compute relative
1657 ;; level for headlines. Eventually
1658 ;; `org-export--collect-headline-numbering' builds an alist between
1659 ;; headlines and their numbering.
1662 "Extract tree properties from parse tree.
1664 DATA is the parse tree from which information is retrieved. INFO
1665 is a list holding export options.
1667 Following tree properties are set or updated:
1669 `:headline-offset' Offset between true level of headlines and
1670 local level. An offset of -1 means a headline
1671 of level 2 should be considered as a level
1672 1 headline in the context.
1674 `:headline-numbering' Alist of all headlines as key and the
1675 associated numbering as value.
1677 `:id-alist' Alist of all ID references as key and associated file
1678 as value.
1680 Return updated plist."
1681 ;; Install the parse tree in the communication channel.
1683 ;; Compute `:headline-offset' in order to be able to use
1684 ;; `org-export-get-relative-level'.
1687 :headline-offset
1689 ;; From now on, properties order doesn't matter: get the rest of the
1690 ;; tree properties.
1692 info
1694 :id-alist
1703 "Return minimum exportable headline's level in DATA.
1704 DATA is parsed tree as returned by `org-element-parse-buffer'.
1705 OPTIONS is a plist holding export options."
1714 ;; If no headline was found, for the sake of consistency, set
1715 ;; minimum level to 1 nonetheless.
1719 "Return numbering of all exportable, numbered headlines in a parse tree.
1721 DATA is the parse tree. OPTIONS is the plist holding export
1722 options.
1724 Return an alist whose key is a headline and value is its
1725 associated numbering \(in the shape of a list of numbers) or nil
1726 for a footnotes section."
1735 headline
1737 for n across numbering
1738 for idx from 0 to org-export-max-depth
1742 options)))
1745 "List headlines and inlinetasks with a select tag in their tree.
1746 DATA is parsed data as returned by `org-element-parse-buffer'.
1747 INFO is a plist holding export options."
1750 ;; If FILETAGS contains a select tag, every headline or
1751 ;; inlinetask is returned.
1761 ;; When a select tag is found, mark full
1762 ;; genealogy and every headline within the
1763 ;; tree as acceptable.
1766 genealogy
1769 selected-trees))
1770 ;; If at a headline, continue searching in
1771 ;; tree, recursively.
1780 selected-trees))))
1783 "Non-nil when element or object BLOB should be skipped during export.
1784 OPTIONS is the plist holding export options. SELECTED, when
1785 non-nil, is a list of headlines or inlinetasks belonging to
1786 a tree with a select tag."
1793 ;; If `:with-drawers' value starts with `not', ignore
1794 ;; every drawer whose name belong to that list.
1795 ;; Otherwise, ignore drawers whose name isn't in that
1796 ;; list.
1813 ;; Ignore subtrees with an exclude tag.
1816 ;; When a select tag is present in the buffer, ignore any tree
1817 ;; without it.
1819 ;; Ignore commented sub-trees.
1821 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1823 ;; Ignore tasks, if specified by `:with-tasks' property.
1835 properties-set))))))
1846 ;; `:with-timestamps' only applies to isolated timestamps
1847 ;; objects, i.e. timestamp objects in a paragraph containing only
1848 ;; timestamps and whitespaces.
1856 options t))))
1865 \f
1866 ;;; The Transcoder
1867 ;;
1868 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1869 ;; `org-element-parse-buffer') and transcodes it into a specified
1870 ;; back-end output. It takes care of filtering out elements or
1871 ;; objects according to export options and organizing the output blank
1872 ;; lines and white space are preserved. The function memoizes its
1873 ;; results, so it is cheap to call it within transcoders.
1874 ;;
1875 ;; It is possible to modify locally the back-end used by
1876 ;; `org-export-data' or even use a temporary back-end by using
1877 ;; `org-export-data-with-backend'.
1878 ;;
1879 ;; `org-export-transcoder' is an accessor returning appropriate
1880 ;; translator function for a given element or object.
1883 "Return appropriate transcoder for BLOB.
1884 INFO is a plist containing export directives."
1886 ;; Return contents only for complete parse trees.
1892 "Convert DATA into current back-end format.
1894 DATA is a parse tree, an element or an object or a secondary
1895 string. INFO is a plist holding export options.
1897 Return a string."
1899 ;; Handle broken links according to
1900 ;; `org-export-with-broken-links'.
1915 ;; Ignored element/object.
1917 ;; Plain text.
1923 info))
1924 ;; Secondary string.
1927 ;; Element/Object without contents or, as a special
1928 ;; case, headline with archive tag and archived trees
1929 ;; restricted to title only.
1938 ;; Export snippets never return a nil value so
1939 ;; that white spaces following them are never
1940 ;; ignored.
1942 ;; Element/Object with contents.
1955 ;; Elements directly containing
1956 ;; objects must have their indentation
1957 ;; normalized first.
1959 data
1960 ;; When normalizing contents of the
1961 ;; first paragraph in an item or
1962 ;; a footnote definition, ignore
1963 ;; first line's indentation: there is
1964 ;; none and it might be misleading.
1969 data)
1977 info)))))))))
1978 ;; Final result will be memoized before being returned.
1980 data
1984 ;; Append the same white space between elements or objects
1985 ;; as in the original buffer, and call appropriate filters.
1996 info)))
1997 results)))
2001 "Convert DATA into BACKEND format.
2003 DATA is an element, an object, a secondary string or a string.
2004 BACKEND is a symbol. INFO is a plist used as a communication
2005 channel.
2007 Unlike to `org-export-with-backend', this function will
2008 recursively convert DATA using BACKEND translation table."
2011 data
2012 ;; Set-up a new communication channel with translations defined in
2013 ;; BACKEND as the translate table and a new hash table for
2014 ;; memoization.
2016 info
2019 ;; Size of the hash table is reduced since this function
2020 ;; will probably be used on small trees.
2024 "Expand a parsed element or object to its original state.
2026 BLOB is either an element or an object. CONTENTS is its
2027 contents, as a string or nil.
2029 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2030 keywords before output."
2035 blob contents))))
2038 \f
2039 ;;; The Filter System
2040 ;;
2041 ;; Filters allow end-users to tweak easily the transcoded output.
2042 ;; They are the functional counterpart of hooks, as every filter in
2043 ;; a set is applied to the return value of the previous one.
2044 ;;
2045 ;; Every set is back-end agnostic. Although, a filter is always
2046 ;; called, in addition to the string it applies to, with the back-end
2047 ;; used as argument, so it's easy for the end-user to add back-end
2048 ;; specific filters in the set. The communication channel, as
2049 ;; a plist, is required as the third argument.
2050 ;;
2051 ;; From the developer side, filters sets can be installed in the
2052 ;; process with the help of `org-export-define-backend', which
2053 ;; internally stores filters as an alist. Each association has a key
2054 ;; among the following symbols and a function or a list of functions
2055 ;; as value.
2056 ;;
2057 ;; - `:filter-options' applies to the property list containing export
2058 ;; options. Unlike to other filters, functions in this list accept
2059 ;; two arguments instead of three: the property list containing
2060 ;; export options and the back-end. Users can set its value through
2061 ;; `org-export-filter-options-functions' variable.
2062 ;;
2063 ;; - `:filter-parse-tree' applies directly to the complete parsed
2064 ;; tree. Users can set it through
2065 ;; `org-export-filter-parse-tree-functions' variable.
2066 ;;
2067 ;; - `:filter-body' applies to the body of the output, before template
2068 ;; translator chimes in. Users can set it through
2069 ;; `org-export-filter-body-functions' variable.
2070 ;;
2071 ;; - `:filter-final-output' applies to the final transcoded string.
2072 ;; Users can set it with `org-export-filter-final-output-functions'
2073 ;; variable.
2074 ;;
2075 ;; - `:filter-plain-text' applies to any string not recognized as Org
2076 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2077 ;; configure it.
2078 ;;
2079 ;; - `:filter-TYPE' applies on the string returned after an element or
2080 ;; object of type TYPE has been transcoded. A user can modify
2081 ;; `org-export-filter-TYPE-functions' to install these filters.
2082 ;;
2083 ;; All filters sets are applied with
2084 ;; `org-export-filter-apply-functions' function. Filters in a set are
2085 ;; applied in a LIFO fashion. It allows developers to be sure that
2086 ;; their filters will be applied first.
2087 ;;
2088 ;; Filters properties are installed in communication channel with
2089 ;; `org-export-install-filters' function.
2090 ;;
2091 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2092 ;; `org-export-before-parsing-hook') are run at the beginning of the
2093 ;; export process and just before parsing to allow for heavy structure
2094 ;; modifications.
2097 ;;;; Hooks
2100 "Hook run at the beginning of the export process.
2102 This is run before include keywords and macros are expanded and
2103 Babel code blocks executed, on a copy of the original buffer
2104 being exported. Visibility and narrowing are preserved. Point
2105 is at the beginning of the buffer.
2107 Every function in this hook will be called with one argument: the
2111 "Hook run before parsing an export buffer.
2113 This is run after include keywords and macros have been expanded
2114 and Babel code blocks executed, on a copy of the original buffer
2115 being exported. Visibility and narrowing are preserved. Point
2116 is at the beginning of the buffer.
2118 Every function in this hook will be called with one argument: the
2122 ;;;; Special Filters
2125 "List of functions applied to the export options.
2126 Each filter is called with two arguments: the export options, as
2127 a plist, and the back-end, as a symbol. It must return
2131 "List of functions applied to the parsed tree.
2132 Each filter is called with three arguments: the parse tree, as
2133 returned by `org-element-parse-buffer', the back-end, as
2134 a symbol, and the communication channel, as a plist. It must
2138 "List of functions applied to plain text.
2139 Each filter is called with three arguments: a string which
2140 contains no Org syntax, the back-end, as a symbol, and the
2141 communication channel, as a plist. It must return a string or
2145 "List of functions applied to transcoded body.
2146 Each filter is called with three arguments: a string which
2147 contains no Org syntax, the back-end, as a symbol, and the
2148 communication channel, as a plist. It must return a string or
2152 "List of functions applied to the transcoded string.
2153 Each filter is called with three arguments: the full transcoded
2154 string, the back-end, as a symbol, and the communication channel,
2155 as a plist. It must return a string that will be used as the
2159 ;;;; Elements Filters
2162 "List of functions applied to a transcoded babel-call.
2163 Each filter is called with three arguments: the transcoded data,
2164 as a string, the back-end, as a symbol, and the communication
2168 "List of functions applied to a transcoded center block.
2169 Each filter is called with three arguments: the transcoded data,
2170 as a string, the back-end, as a symbol, and the communication
2174 "List of functions applied to a transcoded clock.
2175 Each filter is called with three arguments: the transcoded data,
2176 as a string, the back-end, as a symbol, and the communication
2180 "List of functions applied to a transcoded diary-sexp.
2181 Each filter is called with three arguments: the transcoded data,
2182 as a string, the back-end, as a symbol, and the communication
2186 "List of functions applied to a transcoded drawer.
2187 Each filter is called with three arguments: the transcoded data,
2188 as a string, the back-end, as a symbol, and the communication
2192 "List of functions applied to a transcoded dynamic-block.
2193 Each filter is called with three arguments: the transcoded data,
2194 as a string, the back-end, as a symbol, and the communication
2198 "List of functions applied to a transcoded example-block.
2199 Each filter is called with three arguments: the transcoded data,
2200 as a string, the back-end, as a symbol, and the communication
2204 "List of functions applied to a transcoded export-block.
2205 Each filter is called with three arguments: the transcoded data,
2206 as a string, the back-end, as a symbol, and the communication
2210 "List of functions applied to a transcoded fixed-width.
2211 Each filter is called with three arguments: the transcoded data,
2212 as a string, the back-end, as a symbol, and the communication
2216 "List of functions applied to a transcoded footnote-definition.
2217 Each filter is called with three arguments: the transcoded data,
2218 as a string, the back-end, as a symbol, and the communication
2222 "List of functions applied to a transcoded headline.
2223 Each filter is called with three arguments: the transcoded data,
2224 as a string, the back-end, as a symbol, and the communication
2228 "List of functions applied to a transcoded horizontal-rule.
2229 Each filter is called with three arguments: the transcoded data,
2230 as a string, the back-end, as a symbol, and the communication
2234 "List of functions applied to a transcoded inlinetask.
2235 Each filter is called with three arguments: the transcoded data,
2236 as a string, the back-end, as a symbol, and the communication
2240 "List of functions applied to a transcoded item.
2241 Each filter is called with three arguments: the transcoded data,
2242 as a string, the back-end, as a symbol, and the communication
2246 "List of functions applied to a transcoded keyword.
2247 Each filter is called with three arguments: the transcoded data,
2248 as a string, the back-end, as a symbol, and the communication
2252 "List of functions applied to a transcoded latex-environment.
2253 Each filter is called with three arguments: the transcoded data,
2254 as a string, the back-end, as a symbol, and the communication
2258 "List of functions applied to a transcoded node-property.
2259 Each filter is called with three arguments: the transcoded data,
2260 as a string, the back-end, as a symbol, and the communication
2264 "List of functions applied to a transcoded paragraph.
2265 Each filter is called with three arguments: the transcoded data,
2266 as a string, the back-end, as a symbol, and the communication
2270 "List of functions applied to a transcoded plain-list.
2271 Each filter is called with three arguments: the transcoded data,
2272 as a string, the back-end, as a symbol, and the communication
2276 "List of functions applied to a transcoded planning.
2277 Each filter is called with three arguments: the transcoded data,
2278 as a string, the back-end, as a symbol, and the communication
2282 "List of functions applied to a transcoded property-drawer.
2283 Each filter is called with three arguments: the transcoded data,
2284 as a string, the back-end, as a symbol, and the communication
2288 "List of functions applied to a transcoded quote block.
2289 Each filter is called with three arguments: the transcoded quote
2290 data, as a string, the back-end, as a symbol, and the
2291 communication channel, as a plist. It must return a string or
2295 "List of functions applied to a transcoded section.
2296 Each filter is called with three arguments: the transcoded data,
2297 as a string, the back-end, as a symbol, and the communication
2301 "List of functions applied to a transcoded special block.
2302 Each filter is called with three arguments: the transcoded data,
2303 as a string, the back-end, as a symbol, and the communication
2307 "List of functions applied to a transcoded src-block.
2308 Each filter is called with three arguments: the transcoded data,
2309 as a string, the back-end, as a symbol, and the communication
2313 "List of functions applied to a transcoded table.
2314 Each filter is called with three arguments: the transcoded data,
2315 as a string, the back-end, as a symbol, and the communication
2319 "List of functions applied to a transcoded table-cell.
2320 Each filter is called with three arguments: the transcoded data,
2321 as a string, the back-end, as a symbol, and the communication
2325 "List of functions applied to a transcoded table-row.
2326 Each filter is called with three arguments: the transcoded data,
2327 as a string, the back-end, as a symbol, and the communication
2331 "List of functions applied to a transcoded verse block.
2332 Each filter is called with three arguments: the transcoded data,
2333 as a string, the back-end, as a symbol, and the communication
2337 ;;;; Objects Filters
2340 "List of functions applied to transcoded bold text.
2341 Each filter is called with three arguments: the transcoded data,
2342 as a string, the back-end, as a symbol, and the communication
2346 "List of functions applied to transcoded code text.
2347 Each filter is called with three arguments: the transcoded data,
2348 as a string, the back-end, as a symbol, and the communication
2352 "List of functions applied to a transcoded entity.
2353 Each filter is called with three arguments: the transcoded data,
2354 as a string, the back-end, as a symbol, and the communication
2358 "List of functions applied to a transcoded export-snippet.
2359 Each filter is called with three arguments: the transcoded data,
2360 as a string, the back-end, as a symbol, and the communication
2364 "List of functions applied to a transcoded footnote-reference.
2365 Each filter is called with three arguments: the transcoded data,
2366 as a string, the back-end, as a symbol, and the communication
2370 "List of functions applied to a transcoded inline-babel-call.
2371 Each filter is called with three arguments: the transcoded data,
2372 as a string, the back-end, as a symbol, and the communication
2376 "List of functions applied to a transcoded inline-src-block.
2377 Each filter is called with three arguments: the transcoded data,
2378 as a string, the back-end, as a symbol, and the communication
2382 "List of functions applied to transcoded italic text.
2383 Each filter is called with three arguments: the transcoded data,
2384 as a string, the back-end, as a symbol, and the communication
2388 "List of functions applied to a transcoded latex-fragment.
2389 Each filter is called with three arguments: the transcoded data,
2390 as a string, the back-end, as a symbol, and the communication
2394 "List of functions applied to a transcoded line-break.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2400 "List of functions applied to a transcoded link.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2406 "List of functions applied to a transcoded radio-target.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2412 "List of functions applied to a transcoded statistics-cookie.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2418 "List of functions applied to transcoded strike-through text.
2419 Each filter is called with three arguments: the transcoded data,
2420 as a string, the back-end, as a symbol, and the communication
2424 "List of functions applied to a transcoded subscript.
2425 Each filter is called with three arguments: the transcoded data,
2426 as a string, the back-end, as a symbol, and the communication
2430 "List of functions applied to a transcoded superscript.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2436 "List of functions applied to a transcoded target.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2442 "List of functions applied to a transcoded timestamp.
2443 Each filter is called with three arguments: the transcoded data,
2444 as a string, the back-end, as a symbol, and the communication
2448 "List of functions applied to transcoded underline text.
2449 Each filter is called with three arguments: the transcoded data,
2450 as a string, the back-end, as a symbol, and the communication
2454 "List of functions applied to transcoded verbatim text.
2455 Each filter is called with three arguments: the transcoded data,
2456 as a string, the back-end, as a symbol, and the communication
2460 ;;;; Filters Tools
2461 ;;
2462 ;; Internal function `org-export-install-filters' installs filters
2463 ;; hard-coded in back-ends (developer filters) and filters from global
2464 ;; variables (user filters) in the communication channel.
2465 ;;
2466 ;; Internal function `org-export-filter-apply-functions' takes care
2467 ;; about applying each filter in order to a given data. It ignores
2468 ;; filters returning a nil value but stops whenever a filter returns
2469 ;; an empty string.
2472 "Call every function in FILTERS.
2474 Functions are called with arguments VALUE, current export
2475 back-end's name and INFO. A function returning a nil value will
2476 be skipped. If it returns the empty string, the process ends and
2477 VALUE is ignored.
2479 Call is done in a LIFO fashion, to be sure that developer
2480 specified filters, if any, are called first."
2491 "Install filters properties in communication channel.
2492 INFO is a plist containing the current communication channel.
2493 Return the updated communication channel."
2495 ;; Install user-defined filters with `org-export-filters-alist'
2496 ;; and filters already in INFO (through ext-plist mechanism).
2503 ;; Filters in INFO will be called
2504 ;; before those user provided.
2507 default-value)))))
2508 ;; Prepend back-end specific filters to that list.
2510 ;; Single values get consed, lists are appended.
2515 plist key
2518 ;; Return new communication channel.
2522 \f
2523 ;;; Core functions
2524 ;;
2525 ;; This is the room for the main function, `org-export-as', along with
2526 ;; its derivative, `org-export-string-as'.
2527 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2528 ;; function should be added to kill ring.
2529 ;;
2530 ;; Note that `org-export-as' doesn't really parse the current buffer,
2531 ;; but a copy of it (with the same buffer-local variables and
2532 ;; visibility), where macros and include keywords are expanded and
2533 ;; Babel blocks are executed, if appropriate.
2534 ;; `org-export-with-buffer-copy' macro prepares that copy.
2535 ;;
2536 ;; File inclusion is taken care of by
2537 ;; `org-export-expand-include-keyword' and
2538 ;; `org-export--prepare-file-contents'. Structure wise, including
2539 ;; a whole Org file in a buffer often makes little sense. For
2540 ;; example, if the file contains a headline and the include keyword
2541 ;; was within an item, the item should contain the headline. That's
2542 ;; why file inclusion should be done before any structure can be
2543 ;; associated to the file, that is before parsing.
2544 ;;
2545 ;; `org-export-insert-default-template' is a command to insert
2546 ;; a default template (or a back-end specific template) at point or in
2547 ;; current subtree.
2550 "Return a copy of the current buffer.
2551 The copy preserves Org buffer-local variables, visibility and
2552 narrowing."
2558 new-buf))
2561 "Apply BODY in a copy of the current buffer.
2562 The copy preserves local variables, visibility and contents of
2563 the original buffer. Point is at the beginning of the buffer
2564 when BODY is applied."
2573 ;; Kill copy without confirmation.
2579 "Generate a function duplicating BUFFER.
2581 The copy will preserve local variables, visibility, contents and
2582 narrowing of the original buffer. If a region was active in
2583 BUFFER, contents will be narrowed to that region instead.
2585 The resulting function can be evaluated at a later time, from
2586 another buffer, effectively cloning the original buffer there.
2588 The function assumes BUFFER's major mode is `org-mode'."
2592 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2593 ;; already in BUFFER.
2595 ;; Copy specific buffer local variables and variables set
2596 ;; through BIND keywords.
2598 vars)
2606 buffer-file-name
2607 buffer-file-coding-system))
2611 ;; Skip unreadable values, as they cannot be
2612 ;; sent to external process.
2616 vars))))))
2617 ;; Whole buffer contents.
2622 ;; Narrowing.
2626 ;; Current position of point.
2628 ;; Overlays with invisible property.
2637 ov-set)))))))))
2640 "Delete commented areas in the buffer.
2641 Commented areas are comments, comment blocks, commented trees and
2642 inlinetasks. Trailing blank lines after a comment or a comment
2643 block are removed, as long as it doesn't alter the structure of
2644 the document. Narrowing, if any, is ignored."
2650 comment-re)))
2662 ;; We remove trailing blank lines. Doing so could
2663 ;; modify the structure of the document. Therefore
2664 ;; we ensure that any comment between elements is
2665 ;; replaced with one empty line, so as to keep them
2666 ;; separated.
2672 start)
2674 end)
2684 "Prune non exportable elements from DATA.
2685 DATA is the parse tree to traverse. INFO is the plist holding
2686 export info. Also set `:ignore-list' in INFO to a list of
2687 objects which should be ignored during export, but not removed
2688 from tree."
2690 ;; First find trees containing a select tag, if any.
2694 ;; Prune non-exportable elements and objects from tree.
2695 ;; As a special case, special rows and cells from tables
2696 ;; are stored in IGNORE, as they still need to be
2697 ;; accessed during export.
2707 ;; If headline is archived but tree below has
2708 ;; to be skipped, remove contents.
2710 ;; Move into recursive objects/elements.
2712 ;; Move into secondary string, if any.
2714 org-element-secondary-value-alist)))
2717 ;; Collect definitions before possibly pruning them so as
2718 ;; to avoid parsing them again if they are required.
2727 #'org-element-create
2730 ;; If a select tag is active, also ignore the section before the
2731 ;; first headline, if any.
2736 ;; Prune tree and communication channel.
2739 ;; Priority is given to back-end specific options.
2741 org-export-options-alist))
2747 ;; Eventually set `:ignore-list'.
2751 "List footnote definitions missing from TREE.
2752 Missing definitions are searched within DEFINITIONS, which is
2753 a list of footnote definitions or in the widened buffer."
2756 ;; List all footnote labels encountered in DATA. Inline
2757 ;; footnote references are ignored.
2762 defined undefined missing-definitions)
2763 ;; Partition DIRECT-REFERENCES between DEFINED and UNDEFINED
2764 ;; references.
2771 seen)
2776 ;; Complete MISSING-DEFINITIONS by finding the definition of every
2777 ;; undefined label, first by looking into DEFINITIONS, then by
2778 ;; searching the widened buffer. This is a recursive process
2779 ;; since definitions found can themselves contain an undefined
2780 ;; reference.
2787 d))
2788 definitions))
2795 datum
2796 ;; Parse definition with contents.
2807 ;; Look for footnote references within DEFINITION, since
2808 ;; we may need to also find their definition.
2813 ;; MISSING-DEFINITIONS may contain footnote references with inline
2814 ;; definitions. Make sure those are changed into real footnote
2815 ;; definitions.
2822 missing-definitions)))
2825 "Install footnote definitions in tree.
2827 DEFINITIONS is the list of footnote definitions to install. TREE
2828 is the parse tree.
2830 If there is a footnote section in TREE, definitions found are
2831 appended to it. If `org-footnote-section' is non-nil, a new
2832 footnote section containing all definitions is inserted in TREE.
2833 Otherwise, definitions are appended at the end of the section
2834 containing their first reference."
2837 ;; If there is a footnote section, insert definitions there.
2841 nil t)))
2844 footnote-section
2846 ;; If there should be a footnote section, create one containing all
2847 ;; the definitions at the end of the tree.
2850 tree
2856 'section
2857 nil
2859 ;; Otherwise add each definition at the end of the section where it
2860 ;; is first referenced.
2865 ;; Insert footnote definitions in the same section as
2866 ;; their first reference in DATA.
2877 label)
2878 d))
2879 definitions)))
2882 definition)
2883 ;; Also insert definitions for nested
2884 ;; references, if any.
2889 "Change uninterpreted elements back into Org syntax.
2890 DATA is the parse tree. INFO is a plist containing export
2891 options. Each uninterpreted element or object is changed back
2892 into a string. Contents, if any, are not modified. The parse
2893 tree is modified by side effect."
2899 p
2902 info))))))
2905 "Change uninterpreted elements back into Org syntax.
2906 DATA is a parse tree or a secondary string. INFO is a plist
2907 containing export options. It is modified by side effect and
2908 returned by the function."
2911 subscript superscript underline)
2915 ;; ... entities...
2922 ?\s)))))
2923 ;; ... emphasis...
2935 marker
2939 ?\s)))))))
2940 ;; ... LaTeX environments and fragments...
2944 ;; ... sub/superscripts...
2953 "_"
2962 ?\s)))))))))))
2964 ;; Splice NEW at BLOB location in parse tree.
2967 info nil nil t)
2968 ;; Return modified parse tree.
2969 data)
2971 ;;;###autoload
2974 "Transcode current Org buffer into BACKEND code.
2976 BACKEND is either an export back-end, as returned by, e.g.,
2977 `org-export-create-backend', or a symbol referring to
2978 a registered back-end.
2980 If narrowing is active in the current buffer, only transcode its
2981 narrowed part.
2983 If a region is active, transcode that region.
2985 When optional argument SUBTREEP is non-nil, transcode the
2986 sub-tree at point, extracting information from the headline
2987 properties first.
2989 When optional argument VISIBLE-ONLY is non-nil, don't export
2990 contents of hidden elements.
2992 When optional argument BODY-ONLY is non-nil, only return body
2993 code, without surrounding template.
2995 Optional argument EXT-PLIST, when provided, is a property list
2996 with external parameters overriding Org default settings, but
2997 still inferior to file-local settings.
2999 Return code as a string."
3004 ;; Narrow buffer to an appropriate region or subtree for
3005 ;; parsing. If parsing subtree, be sure to remove main headline
3006 ;; too.
3014 ;; Initialize communication channel with original buffer
3015 ;; attributes, unavailable in its copy.
3019 backend subtreep visible-only body-only)
3025 org-export-options-alist))))
3026 tree)
3027 ;; Update communication channel and get parse tree. Buffer
3028 ;; isn't parsed directly. Instead, all buffer modifications
3029 ;; and consequent parsing are undertaken in a temporary copy.
3031 ;; Run first hook with current back-end's name as argument.
3034 ;; Include files, delete comments and expand macros.
3039 ;; Refresh buffer properties and radio targets after
3040 ;; potentially invasive previous changes. Likewise, do it
3041 ;; again after executing Babel code.
3048 ;; Run last hook with current back-end's name as argument.
3049 ;; Update buffer properties and radio targets one last time
3050 ;; before parsing.
3057 ;; Update communication channel with environment. Also
3058 ;; install user's and developer's filters.
3063 ;; Call options filters and update export options. We do not
3064 ;; use `org-export-filter-apply-functions' here since the
3065 ;; arity of such filters is different.
3070 ;; Expand export-specific set of macros: {{{author}}},
3071 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
3072 ;; be done once regular macros have been expanded, since
3073 ;; parsed keywords may contain one of them.
3086 value)
3087 value)))
3091 'finalize
3092 parsed-keywords)
3093 ;; Parse buffer.
3095 ;; Prune tree from non-exported elements and transform
3096 ;; uninterpreted elements or objects in both parse tree and
3097 ;; communication channel.
3100 ;; Call parse tree filters.
3104 ;; Now tree is complete, compute its properties and add them
3105 ;; to communication channel.
3107 ;; Eventually transcode TREE. Wrap the resulting string into
3108 ;; a template.
3117 info))
3120 ;; Remove all text properties since they cannot be
3121 ;; retrieved from an external process. Finally call
3122 ;; final-output filter and return result.
3128 info))))))))
3130 ;;;###autoload
3132 "Transcode STRING into BACKEND code.
3134 BACKEND is either an export back-end, as returned by, e.g.,
3135 `org-export-create-backend', or a symbol referring to
3136 a registered back-end.
3138 When optional argument BODY-ONLY is non-nil, only return body
3139 code, without preamble nor postamble.
3141 Optional argument EXT-PLIST, when provided, is a property list
3142 with external parameters overriding Org default settings, but
3143 still inferior to file-local settings.
3145 Return code as a string."
3151 ;;;###autoload
3153 "Replace the active region by its export to BACKEND.
3154 BACKEND is either an export back-end, as returned by, e.g.,
3155 `org-export-create-backend', or a symbol referring to
3156 a registered back-end."
3162 ;;;###autoload
3164 "Insert all export keywords with default values at beginning of line.
3166 BACKEND is a symbol referring to the name of a registered export
3167 back-end, for which specific export options should be added to
3168 the template, or `default' for default template. When it is nil,
3169 the user will be prompted for a category.
3171 If SUBTREEP is non-nil, export configuration will be set up
3172 locally for the subtree through node properties."
3182 "Options category: "
3186 org-export-registered-backends))
3187 nil t))))
3188 options keywords)
3189 ;; Populate OPTIONS and KEYWORDS.
3206 ;; Move to an appropriate location in order to insert options.
3208 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3226 ;; Then the rest of keywords, in the order specified in either
3227 ;; `org-export-options-alist' or respective export back-ends.
3248 "Expand every include keyword in buffer.
3249 Optional argument INCLUDED is a list of included file names along
3250 with their line restriction, when appropriate. It is used to
3251 avoid infinite recursion. Optional argument DIR is the current
3252 working directory. It is used to properly resolve relative
3253 paths. Optional argument FOOTNOTES is a hash-table used for
3254 storing and resolving footnotes. It is created automatically."
3260 ;; If :minlevel is not set the text-property
3261 ;; `:org-include-induced-level' will be used to determine the
3262 ;; relative level when expanding INCLUDE.
3263 ;; Only affects included Org documents.
3267 :org-include-induced-level
3269 ;; Expand INCLUDE keywords.
3275 ;; Extract arguments from keyword's value.
3278 location
3286 matched)
3292 matched)
3293 dir)))
3297 value)
3303 value)
3312 ;; Minimal level of included file defaults to the child
3313 ;; level of the current headline, if any, or one. It
3314 ;; only applies is the file is meant to be included as
3315 ;; an Org one.
3326 ;; Remove keyword.
3332 ;; Check if files has already been parsed. Look after
3333 ;; inclusion lines too, as different parts of the same file
3334 ;; can be included too.
3347 ind-str block arg-str contents ind-str block))))
3354 ind-str block contents ind-str block))))
3362 file location only-contents lines)
3363 lines)))
3367 file lines ind minlevel
3370 footnotes)))
3374 footnotes)
3376 ;; Expand footnotes after all files have been included.
3377 ;; Footnotes are stored at end of buffer.
3382 footnotes)))))))))))
3385 "Resolve absolute lines for an included file with file-link.
3387 FILE is string file-name of the file to include. LOCATION is a
3388 string name within FILE to be included (located via
3389 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3390 contents of the named element will be included, as determined
3391 Org-Element. If LINES is non-nil only those lines are included.
3393 Return a string of lines to be included in the format expected by
3394 `org-export--prepare-file-contents'."
3400 ;; Enforce consistent search.
3413 ;; Skip planning line and property-drawer.
3439 start-line
3441 (+ start-line
3444 counter))))))))
3448 "Prepare contents of FILE for inclusion and return it as a string.
3450 When optional argument LINES is a string specifying a range of
3451 lines, include only those lines.
3453 Optional argument IND, when non-nil, is an integer specifying the
3454 global indentation of returned contents. Since its purpose is to
3455 allow an included file to stay in the same environment it was
3456 created (e.g., a list item), it doesn't apply past the first
3457 headline encountered.
3459 Optional argument MINLEVEL, when non-nil, is an integer
3460 specifying the level that any top-level headline in the included
3461 file should have.
3463 Optional argument ID is an integer that will be inserted before
3464 each footnote definition and reference if FILE is an Org file.
3465 This is useful to avoid conflicts when more than one Org file
3466 with footnotes is included in a document.
3468 Optional argument FOOTNOTES is a hash-table to store footnotes in
3469 the included document."
3485 ;; Remove blank lines at beginning and end of contents. The logic
3486 ;; behind that removal is that blank lines around include keyword
3487 ;; override blank lines in included file.
3496 ;; If IND is set, preserve indentation of include keyword until
3497 ;; the first headline encountered.
3504 ;; Do not move footnote definitions out of column 0.
3510 ;; When MINLEVEL is specified, compute minimal level for headlines
3511 ;; in the file (CUR-MIN), and remove stars to each headline so
3512 ;; that headlines with minimal level have a level of MINLEVEL.
3523 ;; Only change stars, don't bother moving whole
3524 ;; sections.
3529 ;; Append ID to all footnote references and definitions, so they
3530 ;; become file specific and cannot collide with footnotes in other
3531 ;; included files. Further, collect relevant footnote definitions
3532 ;; outside of LINES, in order to reintroduce them later.
3538 ;; Generate new label from LABEL by prefixing it with
3539 ;; "-ID-".
3543 ;; Replace OLD label with NEW in footnote F.
3557 ;; Update the footnote-reference at point and collect
3558 ;; the new label, which is only used for footnotes
3559 ;; outsides LINES.
3571 ;; Store since footnote-definition is
3572 ;; outside of LINES.
3575 footnotes))))
3582 "Return a non-nil value when output should be added to the kill ring.
3583 See also `org-export-copy-to-kill-ring'."
3589 \f
3590 ;;; Tools For Back-Ends
3591 ;;
3592 ;; A whole set of tools is available to help build new exporters. Any
3593 ;; function general enough to have its use across many back-ends
3594 ;; should be added here.
3596 ;;;; For Affiliated Keywords
3597 ;;
3598 ;; `org-export-read-attribute' reads a property from a given element
3599 ;; as a plist. It can be used to normalize affiliated keywords'
3600 ;; syntax.
3601 ;;
3602 ;; Since captions can span over multiple lines and accept dual values,
3603 ;; their internal representation is a bit tricky. Therefore,
3604 ;; `org-export-get-caption' transparently returns a given element's
3605 ;; caption as a secondary string.
3608 "Turn ATTRIBUTE property from ELEMENT into a plist.
3610 When optional argument PROPERTY is non-nil, return the value of
3611 that property within attributes.
3615 properties.
3617 All values will become strings except the empty string and
3620 will become the empty string."
3634 s)
3639 ;; Ignore any string before first property with `cdr'.
3644 "Return caption from ELEMENT as a secondary string.
3646 When optional argument SHORTP is non-nil, return short caption,
3647 as a secondary string, instead.
3649 Caption lines are separated by a white space."
3657 ;;;; For Derived Back-ends
3658 ;;
3659 ;; `org-export-with-backend' is a function allowing to locally use
3660 ;; another back-end to transcode some object or element. In a derived
3661 ;; back-end, it may be used as a fall-back function once all specific
3662 ;; cases have been treated.
3665 "Call a transcoder from BACKEND on DATA.
3666 BACKEND is an export back-end, as returned by, e.g.,
3667 `org-export-create-backend', or a symbol referring to
3668 a registered back-end. DATA is an Org element, object, secondary
3669 string or string. CONTENTS, when non-nil, is the transcoded
3670 contents of DATA element, as a string. INFO, when non-nil, is
3671 the communication channel used for export, as a plist."
3681 transcoder data contents
3684 :back-end backend
3685 :translate-alist all-transcoders
3689 ;;;; For Export Snippets
3690 ;;
3691 ;; Every export snippet is transmitted to the back-end. Though, the
3692 ;; latter will only retain one type of export-snippet, ignoring
3693 ;; others, based on the former's target back-end. The function
3694 ;; `org-export-snippet-backend' returns that back-end for a given
3695 ;; export-snippet.
3698 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3699 Translation, with `org-export-snippet-translation-alist', is
3700 applied."
3704 back-end))))
3707 ;;;; For Footnotes
3708 ;;
3709 ;; `org-export-collect-footnote-definitions' is a tool to list
3710 ;; actually used footnotes definitions in the whole parse tree, or in
3711 ;; a headline, in order to add footnote listings throughout the
3712 ;; transcoded data.
3713 ;;
3714 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3715 ;; back-ends, when they need to attach the footnote definition only to
3716 ;; the first occurrence of the corresponding label.
3717 ;;
3718 ;; `org-export-get-footnote-definition' and
3719 ;; `org-export-get-footnote-number' provide easier access to
3720 ;; additional information relative to a footnote reference.
3723 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3724 INFO is the plist used as a communication channel. If no such
3725 definition can be found, raise an error."
3731 hash))))
3739 ;; Skip any footnote with a different label.
3740 ;; Also skip any standard footnote reference
3741 ;; with the same label since those cannot
3742 ;; contain a definition.
3746 ;; Even if the contents are empty, we can not
3747 ;; return nil since that would eventually raise
3748 ;; the error. Instead, return the equivalent
3749 ;; empty string.
3751 info t)
3752 cache)
3757 "Apply FUNCTION on every footnote reference in DATA.
3758 INFO is a plist containing export state. By default, as soon as
3759 a new footnote reference is encountered, FUNCTION is called onto
3760 its definition. However, if BODY-FIRST is non-nil, this step is
3761 delayed until the end of the process."
3766 ;; Search footnote references through DATA, filling
3767 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3768 ;; store footnote definitions so they can be entered
3769 ;; later.
3776 ;; Search for subsequent references in footnote
3777 ;; definition so numbering follows reading
3778 ;; logic, unless DELAYP in non-nil.
3782 definitions))
3783 ;; Do not force entering inline definitions,
3784 ;; since `org-element-map' already traverses
3785 ;; them at the right time.
3789 nil))))))
3790 info nil
3791 ;; Don't enter footnote definitions since it will
3792 ;; happen when their first reference is found.
3793 ;; Moreover, if DELAYP is non-nil, make sure we
3794 ;; postpone entering definitions of inline references.
3801 "Return an alist between footnote numbers, labels and definitions.
3803 INFO is the current export state, as a plist.
3805 Definitions are collected throughout the whole parse tree, or
3806 DATA when non-nil.
3808 Sorting is done by order of references. As soon as a new
3809 reference is encountered, other references are searched within
3810 its definition. However, if BODY-FIRST is non-nil, this step is
3811 delayed after the whole tree is checked. This alters results
3812 when references are found in footnote definitions.
3814 Definitions either appear as Org data or as a secondary string
3815 for inlined footnotes. Unreferenced definitions are ignored."
3819 ;; Collect footnote number, label and definition.
3830 "Non-nil when a footnote reference is the first one for its label.
3832 FOOTNOTE-REFERENCE is the footnote reference being considered.
3833 INFO is a plist containing current export state.
3835 Search is done throughout the whole parse tree, or DATA when
3836 non-nil.
3838 By default, as soon as a new footnote reference is encountered,
3839 other references are searched within its definition. However, if
3840 BODY-FIRST is non-nil, this step is delayed after the whole tree
3841 is checked. This alters results when references are found in
3842 footnote definitions."
3844 ;; Anonymous footnotes are always a first reference.
3855 "Return number associated to a footnote.
3857 FOOTNOTE is either a footnote reference or a footnote definition.
3858 INFO is the plist containing export state.
3860 Number is unique throughout the whole parse tree, or DATA, when
3861 non-nil.
3863 By default, as soon as a new footnote reference is encountered,
3864 counting process moves into its definition. However, if
3865 BODY-FIRST is non-nil, this step is delayed until the end of the
3866 process, leading to a different order when footnotes are nested."
3875 ;; Anonymous footnote match: return number.
3877 ;; Labels match: return number.
3879 ;; Otherwise store label and increase counter if label
3880 ;; wasn't encountered yet.
3886 ;;;; For Headlines
3887 ;;
3888 ;; `org-export-get-relative-level' is a shortcut to get headline
3889 ;; level, relatively to the lower headline level in the parsed tree.
3890 ;;
3891 ;; `org-export-get-headline-number' returns the section number of an
3892 ;; headline, while `org-export-number-to-roman' allows it to be
3893 ;; converted to roman numbers. With an optional argument,
3894 ;; `org-export-get-headline-number' returns a number to unnumbered
3895 ;; headlines (used for internal id).
3896 ;;
3897 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3898 ;; `org-export-last-sibling-p' are three useful predicates when it
3899 ;; comes to fulfill the `:headline-levels' property.
3900 ;;
3901 ;; `org-export-get-tags', `org-export-get-category' and
3902 ;; `org-export-get-node-property' extract useful information from an
3903 ;; headline or a parent headline. They all handle inheritance.
3904 ;;
3905 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3906 ;; as a secondary string, suitable for table of contents. It falls
3907 ;; back onto default title.
3910 "Return HEADLINE relative level within current parsed tree.
3911 INFO is a plist holding contextual information."
3916 "Non-nil when HEADLINE is considered as low level.
3918 INFO is a plist used as a communication channel.
3920 A low level headlines has a relative level greater than
3921 `:headline-levels' property value.
3923 Return value is the difference between HEADLINE relative level
3924 and the last level being considered as high enough, or nil."
3931 "Return numbered HEADLINE numbering as a list of numbers.
3932 INFO is a plist holding contextual information."
3937 "Return a non-nil value if HEADLINE element should be numbered.
3938 INFO is a plist used as a communication channel."
3947 "Convert integer N into a roman numeral."
3960 res)))
3963 "Return list of tags associated to ELEMENT.
3965 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3966 is a plist used as a communication channel.
3968 When non-nil, optional argument TAGS should be a list of strings.
3969 Any tag belonging to this list will also be removed.
3971 When optional argument INHERITED is non-nil, tags can also be
3972 inherited from parent headlines and FILETAGS keywords."
3976 ;; Build complete list of inherited tags.
3983 ;; Add FILETAGS keywords and return results.
3987 "Return node PROPERTY value for BLOB.
3989 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3990 element or object.
3992 If optional argument INHERITED is non-nil, the value can be
3993 inherited from a parent headline.
3995 Return value is a string or nil."
4007 "Return category for element or object BLOB.
4009 INFO is a plist used as a communication channel.
4011 CATEGORY is automatically inherited from a parent headline, from
4012 #+CATEGORY: keyword or created out of original file name. If all
4025 "Return alternative title for HEADLINE, as a secondary string.
4026 If no optional title is defined, fall-back to the regular title."
4033 "Non-nil when BLOB is the first sibling in its parent.
4034 BLOB is an element or an object. If BLOB is a headline, non-nil
4035 means it is the first sibling in the sub-tree. INFO is a plist
4036 used as a communication channel."
4041 "Non-nil when BLOB is the last sibling in its parent.
4042 BLOB is an element or an object. INFO is a plist used as
4043 a communication channel."
4047 ;;;; For Keywords
4048 ;;
4049 ;; `org-export-get-date' returns a date appropriate for the document
4050 ;; to about to be exported. In particular, it takes care of
4051 ;; `org-export-date-timestamp-format'.
4054 "Return date value for the current document.
4056 INFO is a plist used as a communication channel. FMT, when
4057 non-nil, is a time format string that will be applied on the date
4058 if it consists in a single timestamp object. It defaults to
4059 `org-export-date-timestamp-format' when nil.
4061 A proper date can be a secondary string, a string or nil. It is
4062 meant to be translated with `org-export-data' or alike."
4073 ;;;; For Links
4074 ;;
4075 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4076 ;; in `org-link-parameters'.
4077 ;;
4078 ;; `org-export-get-coderef-format' returns an appropriate format
4079 ;; string for coderefs.
4080 ;;
4081 ;; `org-export-inline-image-p' returns a non-nil value when the link
4082 ;; provided should be considered as an inline image.
4083 ;;
4084 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4085 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4086 ;; returns an appropriate unique identifier.
4087 ;;
4088 ;; `org-export-resolve-id-link' returns the first headline with
4089 ;; specified id or custom-id in parse tree, the path to the external
4090 ;; file with the id.
4091 ;;
4092 ;; `org-export-resolve-coderef' associates a reference to a line
4093 ;; number in the element it belongs, or returns the reference itself
4094 ;; when the element isn't numbered.
4095 ;;
4096 ;; `org-export-file-uri' expands a filename as stored in :path value
4097 ;; of a "file" link into a file URI.
4098 ;;
4099 ;; Broken links raise a `org-link-broken' error, which is caught by
4100 ;; `org-export-data' for further processing, depending on
4101 ;; `org-export-with-broken-links' value.
4106 "Try exporting LINK with a dedicated function.
4108 DESC is its description, as a string, or nil. BACKEND is the
4109 back-end used for export, as a symbol.
4111 Return output as a string, or nil if no protocol handles LINK.
4113 A custom protocol has precedence over regular back-end export.
4114 The function ignores links with an implicit type (e.g.,
4123 desc
4124 backend))))))
4127 "Return format string for code reference link.
4128 PATH is the link path. DESC is its description."
4136 "Non-nil if LINK object points to an inline image.
4138 Optional argument is a set of RULES defining inline images. It
4139 is an alist where associations have the following shape:
4141 (TYPE . REGEXP)
4143 Applying a rule means apply REGEXP against LINK's path when its
4144 type is TYPE. The function will return a non-nil value if any of
4145 the provided rules is non-nil. The default rule is
4146 `org-export-default-inline-image-rule'.
4148 This only applies to links without a description."
4159 "Resolve a code reference REF.
4161 INFO is a plist used as a communication channel.
4163 Return associated line number in source code, or REF itself,
4164 depending on src-block or example element's switches. Throw an
4165 error if no block contains REF."
4172 org-coderef-label-format)))
4176 ;; Element containing REF is found. Resolve it to
4177 ;; either a label or a line number, as needed.
4186 "List search cells for element or object DATUM.
4188 A search cell follows the pattern (TYPE . SEARCH) where
4190 TYPE is a symbol among `headline', `custom-id', `target' and
4191 `other'.
4193 SEARCH is the string a link is expected to match. More
4194 accurately, it is
4196 - headline's title, as a list of strings, if TYPE is
4197 `headline'.
4199 - CUSTOM_ID value, as a string, if TYPE is `custom-id'.
4201 - target's or radio-target's name as a list of strings if
4202 TYPE is `target'.
4204 - NAME affiliated keyword is TYPE is `other'.
4206 A search cell is the internal representation of a fuzzy link. It
4207 ignores white spaces and statistics cookies, if applicable."
4209 (`headline
4220 (`target
4228 "Return search cells associated to string S.
4229 S is either the path of a fuzzy link or a search option, i.e., it
4230 tries to match either a headline (through custom ID or title),
4231 a target or a named element."
4239 "Non-nil when DATUM matches search cells CELLS.
4240 DATUM is an element or object. CELLS is a list of search cells,
4241 as returned by `org-export-search-cells'."
4246 "Return LINK destination.
4248 INFO is a plist holding contextual information.
4250 Return value can be an object or an element:
4252 - If LINK path matches a target object (i.e. <<path>>) return it.
4254 - If LINK path exactly matches the name affiliated keyword
4255 (i.e. #+NAME: path) of an element, return that element.
4257 - If LINK path exactly matches any headline name, return that
4258 element.
4260 - Otherwise, throw an error.
4263 significant."
4269 :resolve-fuzzy-link-cache
4279 datum)))))
4284 search-cells
4285 ;; There can be multiple matches for un-typed searches, i.e.,
4286 ;; for searches not starting with # or *. In this case,
4287 ;; prioritize targets and names over headline titles.
4288 ;; Matching both a name and a target is not valid, and
4289 ;; therefore undefined.
4292 datum))
4293 matches)
4295 link-cache)))))
4298 "Return headline referenced as LINK destination.
4300 INFO is a plist used as a communication channel.
4302 Return value can be the headline element matched in current parse
4306 ;; First check if id is within the current parse tree.
4311 headline))
4313 ;; Otherwise, look for external files.
4318 "Return radio-target object referenced as LINK destination.
4320 INFO is a plist used as a communication channel.
4322 Return value can be a radio-target object or nil. Assume LINK
4331 nil nil path nil nil t)
4332 t)
4333 radio))
4337 "Return file URI associated to FILENAME."
4344 ;;;; For References
4345 ;;
4346 ;; `org-export-get-reference' associate a unique reference for any
4347 ;; object or element. It uses `org-export-new-reference' and
4348 ;; `org-export-format-reference' to, respectively, generate new
4349 ;; internal references and turn them into a string suitable for
4350 ;; output.
4351 ;;
4352 ;; `org-export-get-ordinal' associates a sequence number to any object
4353 ;; or element.
4356 "Return a unique reference, among REFERENCES.
4357 REFERENCES is an alist whose values are in-use references, as
4358 numbers. Returns a number, which is the internal representation
4359 of a reference. See also `org-export-format-reference'."
4360 ;; Generate random 7 digits hexadecimal numbers. Collisions
4361 ;; increase exponentially with the numbers of references. However,
4362 ;; the odds for encountering at least one collision with 1000 active
4363 ;; references in the same document are roughly 0.2%, so this
4364 ;; shouldn't be the bottleneck.
4367 new))
4370 "Format REFERENCE into a string.
4371 REFERENCE is a number representing a reference, as returned by
4372 `org-export-new-reference', which see."
4376 "Return a unique reference for DATUM, as a string.
4378 DATUM is either an element or an object. INFO is the current
4379 export state, as a plist.
4381 This function checks `:crossrefs' property in INFO for search
4382 cells matching DATUM before creating a new reference. Returned
4383 reference consists of alphanumeric characters only."
4388 ;; If any other published document relies on an
4389 ;; association between a search cell and a reference,
4390 ;; make sure to preserve it. See
4391 ;; `org-publish-resolve-external-link' for details.
4395 ;; Cache contains both data already associated to
4396 ;; a reference and in-use internal references, so as to make
4397 ;; unique references.
4399 ;; Keep an associated related to DATUM as not every object
4400 ;; and element can be associated to a search cell.
4403 reference-string))))
4406 "Return ordinal number of an element or object.
4408 ELEMENT is the element or object considered. INFO is the plist
4409 used as a communication channel.
4411 Optional argument TYPES, when non-nil, is a list of element or
4412 object types, as symbols, that should also be counted in.
4413 Otherwise, only provided element's type is considered.
4415 Optional argument PREDICATE is a function returning a non-nil
4416 value if the current element or object should be counted in. It
4417 accepts two arguments: the element or object being considered and
4418 the plist used as a communication channel. This allows counting
4419 only a certain type of object (i.e. inline images).
4421 Return value is a list of numbers if ELEMENT is a headline or an
4422 item. It is nil for keywords. It represents the footnote number
4423 for footnote definitions and footnote references. If ELEMENT is
4424 a target, return the same value as if ELEMENT was the closest
4425 table, item or headline containing the target. In any other
4426 case, return the sequence number of ELEMENT among elements or
4427 objects of the same type."
4428 ;; Ordinal of a target object refer to the ordinal of the closest
4429 ;; table, item, or headline containing the object.
4433 element
4436 ;; Special case 1: A headline returns its number as a list.
4438 ;; Special case 2: An item returns its number as a list.
4442 struct
4449 ;; Increment counter until ELEMENT is found again.
4460 ;;;; For Src-Blocks
4461 ;;
4462 ;; `org-export-get-loc' counts number of code lines accumulated in
4463 ;; src-block or example-block elements with a "+n" switch until
4464 ;; a given element, excluded. Note: "-n" switches reset that count.
4465 ;;
4466 ;; `org-export-unravel-code' extracts source code (along with a code
4467 ;; references alist) from an `element-block' or `src-block' type
4468 ;; element.
4469 ;;
4470 ;; `org-export-format-code' applies a formatting function to each line
4471 ;; of code, providing relative line number and code reference when
4472 ;; appropriate. Since it doesn't access the original element from
4473 ;; which the source code is coming, it expects from the code calling
4474 ;; it to know if lines should be numbered and if code references
4475 ;; should appear.
4476 ;;
4477 ;; Eventually, `org-export-format-code-default' is a higher-level
4478 ;; function (it makes use of the two previous functions) which handles
4479 ;; line numbering and code references inclusion, and returns source
4480 ;; code in a format suitable for plain text or verbatim output.
4483 "Return count of lines of code before ELEMENT.
4485 ELEMENT is an example-block or src-block element. INFO is the
4486 plist used as a communication channel.
4488 Count includes every line of code in example-block or src-block
4490 ELEMENT doesn't allow line numbering."
4497 ;; ELEMENT is reached: Quit loop and return locs.
4499 ;; Only count lines from src-block and example-block
4500 ;; elements with a "+n" or "-n" switch.
4505 ;; Accumulate locs or reset them.
4513 "Clean source code and extract references out of it.
4515 ELEMENT has either a `src-block' an `example-block' type.
4517 Return a cons cell whose CAR is the source code, cleaned from any
4518 reference, protective commas and spurious indentation, and CDR is
4519 an alist between relative line number (integer) and name of code
4520 reference on that line (string)."
4523 ;; Get code and clean it. Remove blank lines at its
4524 ;; beginning and end.
4531 value
4533 ;; Get format used for references.
4536 org-coderef-label-format)))
4537 ;; Build a regexp matching a loc with a reference.
4542 ;; Return value.
4544 ;; Code with references removed.
4550 ;; Ref line: remove ref, and signal its position in REFS.
4554 ;; Reference alist.
4555 refs)))
4558 "Format CODE by applying FUN line-wise and return it.
4560 CODE is a string representing the code to format. FUN is
4561 a function. It must accept three arguments: a line of
4562 code (string), the current line number (integer) or nil and the
4563 reference associated to the current line (string) or nil.
4565 Optional argument NUM-LINES can be an integer representing the
4566 number of code lines accumulated until the current code. Line
4567 numbers passed to FUN will take it into account. If it is nil,
4568 FUN's second argument will always be nil. This number can be
4569 obtained with `org-export-get-loc' function.
4571 Optional argument REF-ALIST can be an alist between relative line
4572 number (i.e. ignoring NUM-LINES) and the name of the code
4573 reference on it. If it is nil, FUN's third argument will always
4574 be nil. It can be obtained through the use of
4575 `org-export-unravel-code' function."
4587 "Return source code from ELEMENT, formatted in a standard way.
4589 ELEMENT is either a `src-block' or `example-block' element. INFO
4590 is a plist used as a communication channel.
4592 This function takes care of line numbering and code references
4593 inclusion. Line numbers, when applicable, appear at the
4594 beginning of the line, separated from the code by two white
4595 spaces. Code references, on the other hand, appear flushed to
4596 the right, separated by six white spaces from the widest line of
4597 code."
4598 ;; Extract code and references.
4605 ;; Handle line numbering.
4612 ;; Prepare references display, if required. Any reference
4613 ;; should start six columns after the widest line of code,
4614 ;; wrapped with parenthesis.
4619 code
4623 number-str
4624 loc
4630 num-start refs)))))
4633 ;;;; For Tables
4634 ;;
4635 ;; `org-export-table-has-special-column-p' and and
4636 ;; `org-export-table-row-is-special-p' are predicates used to look for
4637 ;; meta-information about the table structure.
4638 ;;
4639 ;; `org-table-has-header-p' tells when the rows before the first rule
4640 ;; should be considered as table's header.
4641 ;;
4642 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4643 ;; and `org-export-table-cell-borders' extract information from
4644 ;; a table-cell element.
4645 ;;
4646 ;; `org-export-table-dimensions' gives the number on rows and columns
4647 ;; in the table, ignoring horizontal rules and special columns.
4648 ;; `org-export-table-cell-address', given a table-cell object, returns
4649 ;; the absolute address of a cell. On the other hand,
4650 ;; `org-export-get-table-cell-at' does the contrary.
4651 ;;
4652 ;; `org-export-table-cell-starts-colgroup-p',
4653 ;; `org-export-table-cell-ends-colgroup-p',
4654 ;; `org-export-table-row-starts-rowgroup-p',
4655 ;; `org-export-table-row-ends-rowgroup-p',
4656 ;; `org-export-table-row-starts-header-p',
4657 ;; `org-export-table-row-ends-header-p' and
4658 ;; `org-export-table-row-in-header-p' indicate position of current row
4659 ;; or cell within the table.
4662 "Non-nil when TABLE has a special column.
4663 All special columns will be ignored during export."
4664 ;; The table has a special column when every first cell of every row
4665 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4666 ;; "*" "_" and "^". Though, do not consider a first row containing
4667 ;; only empty cells as special.
4681 "Non-nil when TABLE has a header.
4683 INFO is a plist used as a communication channel.
4685 A table has a header when it contains at least two row groups."
4694 table
4705 cache)))))
4708 "Non-nil if TABLE-ROW is considered special.
4709 All special rows will be ignored during export."
4713 ;; A row is special either when...
4715 ;; ... it starts with a field only containing "/",
4717 ;; ... the table contains a special column and the row start
4718 ;; with a marking character among, "^", "_", "$" or "!",
4722 ;; ... it contains only alignment cookies and empty cells.
4727 ;; Since VALUE is a secondary string, the following
4728 ;; checks avoid expanding it with `org-export-data'.
4739 "Return TABLE-ROW's group number, as an integer.
4741 INFO is a plist used as the communication channel.
4743 Return value is the group number, as an integer, or nil for
4744 special rows and rows separators. First group is also table's
4745 header."
4763 "Return TABLE-CELL contents width.
4765 INFO is a plist used as the communication channel.
4767 Return value is the width given by the last width cookie in the
4768 same column as TABLE-CELL, or nil."
4787 ;; In a special row, try to find a width cookie at COLUMN.
4791 ;; The following checks avoid expanding unnecessarily
4792 ;; the cell with `org-export-data'.
4802 "Return TABLE-CELL contents alignment.
4804 INFO is a plist used as the communication channel.
4806 Return alignment as specified by the last alignment cookie in the
4807 same column as TABLE-CELL. If no such cookie is found, a default
4808 alignment value will be deduced from fraction of numbers in the
4809 column (see `org-table-number-fraction' for more information).
4810 Possible values are `left', `right' and `center'."
4811 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4828 cookie-align
4829 previous-cell-number-p)
4832 ;; In a special row, try to find an alignment cookie at
4833 ;; COLUMN.
4837 ;; Since VALUE is a secondary string, the following
4838 ;; checks avoid useless expansion through
4839 ;; `org-export-data'.
4847 ;; Ignore table rules.
4849 ;; In a standard row, check if cell's contents are
4850 ;; expressing some kind of number. Increase NUMBER-CELLS
4851 ;; accordingly. Though, don't bother if an alignment
4852 ;; cookie has already defined cell's alignment.
4857 info)))
4859 ;; Treat an empty cell as a number if it follows
4860 ;; a number.
4866 ;; Return value. Alignment specified by cookies has
4867 ;; precedence over alignment deduced from cell's contents.
4869 column
4874 org-table-number-fraction)
4879 "Return TABLE-CELL borders.
4881 INFO is a plist used as a communication channel.
4883 Return value is a list of symbols, or nil. Possible values are:
4884 `top', `bottom', `above', `below', `left' and `right'. Note:
4885 `top' (resp. `bottom') only happen for a cell in the first
4886 row (resp. last row) of the table, ignoring table rules, if any.
4888 Returned borders ignore special rows."
4891 borders)
4892 ;; Top/above border? TABLE-CELL has a border above when a rule
4893 ;; used to demarcate row groups can be found above. Hence,
4894 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4895 ;; another regular row has to be found above that rule.
4898 ;; Look at every row before the current one.
4905 ;; No rule above, or rule found starts the table (ignoring any
4906 ;; special row): TABLE-CELL is at the top of the table.
4909 ;; Bottom/below border? TABLE-CELL has a border below when next
4910 ;; non-regular row below is a rule.
4913 ;; Look at every row after the current one.
4920 ;; No rule below, or rule found ends the table (modulo some
4921 ;; special row): TABLE-CELL is at the bottom of the table.
4924 ;; Right/left borders? They can only be specified by column
4925 ;; groups. Column groups are defined in a row starting with "/".
4926 ;; Also a column groups row only contains "<", "<>", ">" or blank
4927 ;; cells.
4931 ;; Table rows are read in reverse order so last column groups
4932 ;; row has precedence over any previous one.
4945 ;; There's a left border when previous cell, if
4946 ;; any, ends a group, or current one starts one.
4952 ;; There's a right border when next cell, if any,
4953 ;; starts a group, or current one ends one.
4960 ;; Return value.
4961 borders))
4964 "Non-nil when TABLE-CELL is at the beginning of a column group.
4965 INFO is a plist used as a communication channel."
4966 ;; A cell starts a column group either when it is at the beginning
4967 ;; of a row (or after the special column, if any) or when it has
4968 ;; a left border.
4971 table-cell)
4975 "Non-nil when TABLE-CELL is at the end of a column group.
4976 INFO is a plist used as a communication channel."
4977 ;; A cell ends a column group either when it is at the end of a row
4978 ;; or when it has a right border.
4981 table-cell)
4985 "Non-nil when TABLE-ROW is at the beginning of a row group.
4986 INFO is a plist used as a communication channel."
4994 "Non-nil when TABLE-ROW is at the end of a row group.
4995 INFO is a plist used as a communication channel."
5003 "Non-nil when TABLE-ROW is located within table's header.
5004 INFO is a plist used as a communication channel. Always return
5005 nil for special rows and rows separators."
5011 "Non-nil when TABLE-ROW is the first table header's row.
5012 INFO is a plist used as a communication channel."
5017 "Non-nil when TABLE-ROW is the last table header's row.
5018 INFO is a plist used as a communication channel."
5023 "Return TABLE-ROW number.
5024 INFO is a plist used as a communication channel. Return value is
5025 zero-based and ignores separators. The function returns nil for
5026 special columns and separators."
5038 "Return TABLE dimensions.
5040 INFO is a plist used as a communication channel.
5042 Return value is a CONS like (ROWS . COLUMNS) where
5043 ROWS (resp. COLUMNS) is the number of exportable
5044 rows (resp. columns)."
5046 ;; Set number of rows, and extract first one.
5052 ;; Set number of columns.
5054 ;; Return value.
5058 "Return address of a regular TABLE-CELL object.
5060 TABLE-CELL is the cell considered. INFO is a plist used as
5061 a communication channel.
5063 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5064 zero-based index. Only exportable cells are considered. The
5065 function returns nil for other cells."
5077 "Return regular table-cell object at ADDRESS in TABLE.
5079 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5080 zero-based index. TABLE is a table type element. INFO is
5081 a plist used as a communication channel.
5083 If no table-cell, among exportable cells, is found at ADDRESS,
5084 return nil."
5087 ;; Row at (car address) or nil.
5095 'table-cell
5102 ;;;; For Tables Of Contents
5103 ;;
5104 ;; `org-export-collect-headlines' builds a list of all exportable
5105 ;; headline elements, maybe limited to a certain depth. One can then
5106 ;; easily parse it and transcode it.
5107 ;;
5108 ;; Building lists of tables, figures or listings is quite similar.
5109 ;; Once the generic function `org-export-collect-elements' is defined,
5110 ;; `org-export-collect-tables', `org-export-collect-figures' and
5111 ;; `org-export-collect-listings' can be derived from it.
5114 "Collect headlines in order to build a table of contents.
5116 INFO is a plist used as a communication channel.
5118 When optional argument N is an integer, it specifies the depth of
5119 the table of contents. Otherwise, it is set to the value of the
5120 last headline level. See `org-export-headline-levels' for more
5121 information.
5123 Optional argument SCOPE, when non-nil, is an element. If it is
5124 a headline, only children of SCOPE are collected. Otherwise,
5125 collect children of the headline containing provided element. If
5126 there is no such headline, collect all headlines. In any case,
5127 argument N becomes relative to the level of that headline.
5129 Return a list of all exportable headlines as parsed elements.
5130 Footnote sections are ignored."
5139 limit))))
5145 info)))
5148 "Collect referenceable elements of a determined type.
5150 TYPE can be a symbol or a list of symbols specifying element
5151 types to search. Only elements with a caption are collected.
5153 INFO is a plist used as a communication channel.
5155 When non-nil, optional argument PREDICATE is a function accepting
5156 one argument, an element of type TYPE. It returns a non-nil
5157 value when that element should be collected.
5159 Return a list of all elements found, in order of appearance."
5164 element))
5165 info))
5168 "Build a list of tables.
5169 INFO is a plist used as a communication channel.
5171 Return a list of table elements with a caption."
5175 "Build a list of figures.
5177 INFO is a plist used as a communication channel. PREDICATE is
5178 a function which accepts one argument: a paragraph element and
5179 whose return value is non-nil when that element should be
5180 collected.
5182 A figure is a paragraph type element, with a caption, verifying
5184 a vague concept that may depend on back-end.
5186 Return a list of elements recognized as figures."
5190 "Build a list of src blocks.
5192 INFO is a plist used as a communication channel.
5194 Return a list of src-block elements with a caption."
5198 ;;;; Smart Quotes
5199 ;;
5200 ;; The main function for the smart quotes sub-system is
5201 ;; `org-export-activate-smart-quotes', which replaces every quote in
5202 ;; a given string from the parse tree with its "smart" counterpart.
5203 ;;
5204 ;; Dictionary for smart quotes is stored in
5205 ;; `org-export-smart-quotes-alist'.
5209 ;; one may use: »...«, "...", ›...‹, or '...'.
5210 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5211 ;; LaTeX quotes require Babel!
5261 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5272 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5283 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5294 ;; 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
5295 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5306 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5312 "Smart quotes translations.
5314 Alist whose CAR is a language string and CDR is an alist with
5315 quote type as key and a plist associating various encodings to
5316 their translation as value.
5318 A quote type can be any symbol among `primary-opening',
5319 `primary-closing', `secondary-opening', `secondary-closing' and
5320 `apostrophe'.
5322 Valid encodings include `:utf-8', `:html', `:latex' and
5323 `:texinfo'.
5328 "Return smart quote status at the beginning of string S.
5329 INFO is the current export state, as a plist."
5334 table)))
5342 'plain-text
5351 ;; Not already in a level 1 quote: this is an
5352 ;; apostrophe.
5354 ;; Extract previous char and next char. As
5355 ;; a special case, they can also be set to `blank',
5356 ;; `no-blank' or nil. Then determine if current
5357 ;; match is allowed as an opening quote or a closing
5358 ;; quote.
5363 text info)))
5380 previous)
5391 next)
5398 current-status)
5402 info nil org-element-recursive-objects)
5409 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5410 `:utf-8'. INFO is a plist used as a communication channel.
5412 The function has to retrieve information about string
5413 surroundings in parse tree. It can only happen with an
5414 unmodified string. Thus, if S has already been through another
5415 process, a non-nil ORIGINAL optional argument will provide that
5416 original string.
5418 Return the new string."
5427 org-export-smart-quotes-alist))))
5428 encoding)
5429 match))
5430 s nil t)))
5432 ;;;; Topology
5433 ;;
5434 ;; Here are various functions to retrieve information about the
5435 ;; neighborhood of a given element or object. Neighbors of interest
5436 ;; are direct parent (`org-export-get-parent'), parent headline
5437 ;; (`org-export-get-parent-headline'), first element containing an
5438 ;; object, (`org-export-get-parent-element'), parent table
5439 ;; (`org-export-get-parent-table'), previous element or object
5440 ;; (`org-export-get-previous-element') and next element or object
5441 ;; (`org-export-get-next-element').
5443 ;; defsubst org-export-get-parent must be defined before first use
5446 "Return BLOB parent headline or nil.
5447 BLOB is the element or object being considered."
5451 "Return first element containing OBJECT or nil.
5452 OBJECT is the object to consider."
5456 "Return OBJECT parent table or nil.
5457 OBJECT is either a `table-cell' or `table-element' type object."
5461 "Return previous element or object.
5463 BLOB is an element or object. INFO is a plist used as
5464 a communication channel. Return previous exportable element or
5465 object, a string, or nil.
5467 When optional argument N is a positive integer, return a list
5468 containing up to N siblings before BLOB, from farthest to
5469 closest. With any other non-nil value, return a list containing
5470 all of them."
5476 prev)
5486 "Return next element or object.
5488 BLOB is an element or object. INFO is a plist used as
5489 a communication channel. Return next exportable element or
5490 object, a string, or nil.
5492 When optional argument N is a positive integer, return a list
5493 containing up to N siblings after BLOB, from closest to farthest.
5494 With any other non-nil value, return a list containing all of
5495 them."
5502 next)
5512 ;;;; Translation
5513 ;;
5514 ;; `org-export-translate' translates a string according to the language
5515 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5516 ;; the dictionary used for the translation.
5548 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5558 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5564 ("ru" :html "(Продолжение следует)"
5638 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5661 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5667 ("ru" :html "Список распечаток"
5681 ("ru" :html "Список таблиц"
5787 ("ru" :html "Неизвестная ссылка"
5790 "Dictionary for export engine.
5792 Alist whose car is the string to translate and cdr is an alist
5793 whose car is the language string and cdr is a plist whose
5794 properties are possible charsets and values translated terms.
5796 It is used as a database for `org-export-translate'. Since this
5797 function returns the string as-is if no translation was found,
5798 the variable only needs to record values different from the
5802 "Translate string S according to language specification.
5804 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5805 and `:utf-8'. INFO is a plist used as a communication channel.
5807 Translation depends on `:language' property. Return the
5808 translated string. If no translation is found, try to fall back
5809 to `:default' encoding. If it fails, return S."
5815 s)))
5818 \f
5819 ;;; Asynchronous Export
5820 ;;
5821 ;; `org-export-async-start' is the entry point for asynchronous
5822 ;; export. It recreates current buffer (including visibility,
5823 ;; narrowing and visited file) in an external Emacs process, and
5824 ;; evaluates a command there. It then applies a function on the
5825 ;; returned results in the current process.
5826 ;;
5827 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5828 ;; allow exporting to a buffer or a file, asynchronously or not.
5829 ;;
5830 ;; `org-export-output-file-name' is an auxiliary function meant to be
5831 ;; used with `org-export-to-file'. With a given extension, it tries
5832 ;; to provide a canonical file name to write export output to.
5833 ;;
5834 ;; Asynchronously generated results are never displayed directly.
5835 ;; Instead, they are stored in `org-export-stack-contents'. They can
5836 ;; then be retrieved by calling `org-export-stack'.
5837 ;;
5838 ;; Export Stack is viewed through a dedicated major mode
5839 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5840 ;;`org-export-stack-delete', `org-export-stack-view' and
5841 ;;`org-export-stack-clear'.
5842 ;;
5843 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5844 ;; It should be used whenever `org-export-async-start' is called.
5847 "Call function FUN on the results returned by BODY evaluation.
5849 FUN is an anonymous function of one argument. BODY evaluation
5850 happens in an asynchronous process, from a buffer which is an
5851 exact copy of the current one.
5853 Use `org-export-add-to-stack' in FUN in order to register results
5854 in the stack.
5856 This is a low level function. See also `org-export-to-buffer'
5857 and `org-export-to-file' for more specialized functions."
5860 ;; Write the full sexp evaluating BODY in a copy of the current
5861 ;; buffer to a temporary file, as it may be too long for program
5862 ;; args in `start-process'.
5869 ;; Null characters (from variable values) are inserted
5870 ;; within the file. As a consequence, coding system for
5871 ;; buffer contents will not be recognized properly. So,
5872 ;; we make sure it is the same as the one used to display
5873 ;; the original buffer.
5875 ,coding
5878 ;; Ignore `kill-emacs-hook' and code evaluation
5879 ;; queries from Babel as we need a truly
5880 ;; non-interactive process.
5882 org-babel-confirm-evaluate-answer-no t)
5883 ;; Initialize export framework.
5885 ;; Re-create current buffer there.
5888 ;; Sexp to evaluate in the buffer.
5890 ;; Start external process.
5893 (,process
5895 #'start-process
5898 ,proc-buffer
5905 ;; Register running process in stack.
5907 ;; Set-up sentinel in order to catch results.
5910 ,process
5932 ;;;###autoload
5935 &optional async subtreep visible-only body-only ext-plist
5936 post-process)
5937 "Call `org-export-as' with output to a specified buffer.
5939 BACKEND is either an export back-end, as returned by, e.g.,
5940 `org-export-create-backend', or a symbol referring to
5941 a registered back-end.
5943 BUFFER is the name of the output buffer. If it already exists,
5944 it will be erased first, otherwise, it will be created.
5946 A non-nil optional argument ASYNC means the process should happen
5947 asynchronously. The resulting buffer should then be accessible
5948 through the `org-export-stack' interface. When ASYNC is nil, the
5949 buffer is displayed if `org-export-show-temporary-export-buffer'
5950 is non-nil.
5952 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5953 EXT-PLIST are similar to those used in `org-export-as', which
5954 see.
5956 Optional argument POST-PROCESS is a function which should accept
5957 no argument. It is always called within the current process,
5958 from BUFFER, with point at its beginning. Export back-ends can
5959 use it to set a major mode there, e.g,
5961 (defun org-latex-export-as-latex
5962 (&optional async subtreep visible-only body-only ext-plist)
5963 (interactive)
5965 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5967 This function returns BUFFER."
5995 buffer)))
5997 ;;;###autoload
6000 post-process)
6001 "Call `org-export-as' with output to a specified file.
6003 BACKEND is either an export back-end, as returned by, e.g.,
6004 `org-export-create-backend', or a symbol referring to
6005 a registered back-end. FILE is the name of the output file, as
6006 a string.
6008 A non-nil optional argument ASYNC means the process should happen
6009 asynchronously. The resulting buffer will then be accessible
6010 through the `org-export-stack' interface.
6012 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6013 EXT-PLIST are similar to those used in `org-export-as', which
6014 see.
6016 Optional argument POST-PROCESS is called with FILE as its
6017 argument and happens asynchronously when ASYNC is non-nil. It
6018 has to return a file name, or nil. Export back-ends can use this
6019 to send the output file through additional processing, e.g,
6021 (defun org-latex-export-to-latex
6022 (&optional async subtreep visible-only body-only ext-plist)
6023 (interactive)
6026 async subtreep visible-only body-only ext-plist
6027 (lambda (file) (org-latex-compile file)))
6029 The function returns either a file name returned by POST-PROCESS,
6030 or FILE."
6049 backend subtreep visible-only body-only ext-plist)))
6056 ;; Get proper return value.
6058 file))))))
6061 "Return output file's name according to buffer specifications.
6063 EXTENSION is a string representing the output file extension,
6064 with the leading dot.
6066 With a non-nil optional argument SUBTREEP, try to determine
6068 of subtree at point.
6070 When optional argument PUB-DIR is set, use it as the publishing
6071 directory.
6073 Return file name as a string."
6076 ;; File name may come from EXPORT_FILE_NAME subtree
6077 ;; property.
6080 ;; File name may be extracted from buffer's associated
6081 ;; file, if any.
6083 ;; Can't determine file name on our own: Ask user.
6085 "Output file: " pub-dir nil nil nil
6089 ;; Build file name. Enforce EXTENSION over whatever user
6090 ;; may have come up with. PUB-DIR, if defined, always has
6091 ;; precedence over any provided path.
6096 extension))
6099 ;; If writing to OUTPUT-FILE would overwrite original file, append
6100 ;; EXTENSION another time to final name.
6103 output-file)))
6106 "Add a new result to export stack if not present already.
6108 SOURCE is a buffer or a file name containing export results.
6109 BACKEND is a symbol representing export back-end used to generate
6110 it.
6112 Entries already pointing to SOURCE and unavailable entries are
6113 removed beforehand. Return the new stack."
6119 "Menu for asynchronous export results and running processes."
6129 "Return source from export results at point in stack."
6136 source
6137 ;; SOURCE is not consistent with current line. The stack
6138 ;; view is outdated.
6142 "Remove all entries from export stack."
6147 "Refresh the asynchronous export stack.
6148 Unavailable sources are removed from the list. Return the new
6149 stack."
6158 ;; Back-end.
6160 ;; Age.
6163 ;; Compute age of the results.
6166 ;; Source.
6171 ;; Clear stack from exited processes, dead buffers or
6172 ;; non-existent files.
6184 "Remove export results at point from stack.
6185 If optional argument SOURCE is non-nil, remove it instead."
6190 org-export-stack-contents))))
6193 "View export results at point in stack.
6194 With an optional prefix argument IN-EMACS, force viewing files
6195 within Emacs."
6209 (define-key km "p" 'previous-line)
6210 (define-key km "\C-p" 'previous-line)
6211 (define-key km "\C-?" 'previous-line)
6212 (define-key km [up] 'previous-line)
6213 (define-key km "C" 'org-export-stack-clear)
6214 (define-key km "v" 'org-export-stack-view)
6215 (define-key km (kbd "RET") 'org-export-stack-view)
6216 (define-key km "d" 'org-export-stack-remove)
6217 km)
6218 "Keymap for Org Export Stack.")
6220 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6221 "Mode for displaying asynchronous export stack.
6224 stack.
6226 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6227 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6228 stack completely.
6230 Removing entries in an Org Export Stack buffer doesn't affect
6231 files or buffers, only the display.
6234 (abbrev-mode 0)
6235 (auto-fill-mode 0)
6236 (setq buffer-read-only t
6237 buffer-undo-list t
6238 truncate-lines t
6239 header-line-format
6240 '(:eval
6241 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6242 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6243 (setq-local revert-buffer-function
6244 'org-export-stack-refresh))
6247 \f
6248 ;;; The Dispatcher
6249 ;;
6250 ;; `org-export-dispatch' is the standard interactive way to start an
6251 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6252 ;; for its interface, which, in turn, delegates response to key
6253 ;; pressed to `org-export--dispatch-action'.
6255 ;;;###autoload
6256 (defun org-export-dispatch (&optional arg)
6257 "Export dispatcher for Org mode.
6259 It provides an access to common export related tasks in a buffer.
6260 Its interface comes in two flavors: standard and expert.
6262 While both share the same set of bindings, only the former
6263 displays the valid keys associations in a dedicated buffer.
6264 Scrolling (resp. line-wise motion) in this buffer is done with
6265 SPC and DEL (resp. C-n and C-p) keys.
6267 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6268 flavor or the other.
6271 of options used back then, on the current buffer.
6273 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6274 (interactive "P")
6275 (let* ((input
6276 (cond ((equal arg '(16)) '(stack))
6277 ((and arg org-export-dispatch-last-action))
6278 (t (save-window-excursion
6279 (unwind-protect
6280 (progn
6281 ;; Remember where we are
6282 (move-marker org-export-dispatch-last-position
6283 (point)
6284 (org-base-buffer (current-buffer)))
6285 ;; Get and store an export command
6286 (setq org-export-dispatch-last-action
6287 (org-export--dispatch-ui
6288 (list org-export-initial-scope
6289 (and org-export-in-background 'async))
6290 nil
6291 org-export-dispatch-use-expert-ui)))
6292 (and (get-buffer "*Org Export Dispatcher*")
6293 (kill-buffer "*Org Export Dispatcher*")))))))
6294 (action (car input))
6295 (optns (cdr input)))
6296 (unless (memq 'subtree optns)
6297 (move-marker org-export-dispatch-last-position nil))
6298 (cl-case action
6299 ;; First handle special hard-coded actions.
6300 (template (org-export-insert-default-template nil optns))
6301 (stack (org-export-stack))
6302 (publish-current-file
6303 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6304 (publish-current-project
6305 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6306 (publish-choose-project
6307 (org-publish (assoc (completing-read
6308 "Publish project: "
6309 org-publish-project-alist nil t)
6310 org-publish-project-alist)
6311 (memq 'force optns)
6312 (memq 'async optns)))
6313 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6314 (otherwise
6315 (save-excursion
6316 (when arg
6317 ;; Repeating command, maybe move cursor to restore subtree
6318 ;; context.
6319 (if (eq (marker-buffer org-export-dispatch-last-position)
6320 (org-base-buffer (current-buffer)))
6321 (goto-char org-export-dispatch-last-position)
6322 ;; We are in a different buffer, forget position.
6323 (move-marker org-export-dispatch-last-position nil)))
6324 (funcall action
6325 ;; Return a symbol instead of a list to ease
6326 ;; asynchronous export macro use.
6327 (and (memq 'async optns) t)
6328 (and (memq 'subtree optns) t)
6329 (and (memq 'visible optns) t)
6330 (and (memq 'body optns) t)))))))
6332 (defun org-export--dispatch-ui (options first-key expertp)
6333 "Handle interface for `org-export-dispatch'.
6335 OPTIONS is a list containing current interactive options set for
6336 export. It can contain any of the following symbols:
6337 `body' toggles a body-only export
6338 `subtree' restricts export to current subtree
6339 `visible' restricts export to visible part of buffer.
6340 `force' force publishing files.
6341 `async' use asynchronous export process
6343 FIRST-KEY is the key pressed to select the first level menu. It
6344 is nil when this menu hasn't been selected yet.
6346 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6347 buffer is provided, but indications about currently active
6348 options are given in the prompt. Moreover, [?] allows switching
6349 back to standard interface."
6350 (let* ((fontify-key
6351 (lambda (key &optional access-key)
6352 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6353 ;; non-nil is the required first-level key to activate
6354 ;; KEY. When its value is t, activate KEY independently
6355 ;; on the first key, if any. A nil value means KEY will
6356 ;; only be activated at first level.
6357 (if (or (eq access-key t) (eq access-key first-key))
6358 (propertize key 'face 'org-warning)
6359 key)))
6360 (fontify-value
6361 (lambda (value)
6362 ;; Fontify VALUE string.
6363 (propertize value 'face 'font-lock-variable-name-face)))
6364 ;; Prepare menu entries by extracting them from registered
6365 ;; back-ends and sorting them by access key and by ordinal,
6366 ;; if any.
6367 (entries
6368 (sort (sort (delq nil
6369 (mapcar #'org-export-backend-menu
6370 org-export-registered-backends))
6371 (lambda (a b)
6372 (let ((key-a (nth 1 a))
6373 (key-b (nth 1 b)))
6374 (cond ((and (numberp key-a) (numberp key-b))
6375 (< key-a key-b))
6376 ((numberp key-b) t)))))
6377 'car-less-than-car))
6378 ;; Compute a list of allowed keys based on the first key
6379 ;; pressed, if any. Some keys
6380 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6381 ;; available.
6382 (allowed-keys
6383 (nconc (list 2 22 19 6 1)
6384 (if (not first-key) (org-uniquify (mapcar 'car entries))
6385 (let (sub-menu)
6386 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6387 (when (eq (car entry) first-key)
6388 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6389 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6390 ((not first-key) (list ?P)))
6391 (list ?& ?#)
6392 (when expertp (list ??))
6393 (list ?q)))
6394 ;; Build the help menu for standard UI.
6395 (help
6396 (unless expertp
6397 (concat
6398 ;; Options are hard-coded.
6399 (format "[%s] Body only: %s [%s] Visible only: %s
6400 \[%s] Export scope: %s [%s] Force publishing: %s
6402 (funcall fontify-key "C-b" t)
6403 (funcall fontify-value
6404 (if (memq 'body options) "On " "Off"))
6405 (funcall fontify-key "C-v" t)
6406 (funcall fontify-value
6407 (if (memq 'visible options) "On " "Off"))
6408 (funcall fontify-key "C-s" t)
6409 (funcall fontify-value
6410 (if (memq 'subtree options) "Subtree" "Buffer "))
6411 (funcall fontify-key "C-f" t)
6412 (funcall fontify-value
6413 (if (memq 'force options) "On " "Off"))
6414 (funcall fontify-key "C-a" t)
6415 (funcall fontify-value
6416 (if (memq 'async options) "On " "Off")))
6417 ;; Display registered back-end entries. When a key
6418 ;; appears for the second time, do not create another
6419 ;; entry, but append its sub-menu to existing menu.
6420 (let (last-key)
6421 (mapconcat
6422 (lambda (entry)
6423 (let ((top-key (car entry)))
6424 (concat
6425 (unless (eq top-key last-key)
6426 (setq last-key top-key)
6428 (funcall fontify-key (char-to-string top-key))
6429 (nth 1 entry)))
6430 (let ((sub-menu (nth 2 entry)))
6431 (unless (functionp sub-menu)
6432 ;; Split sub-menu into two columns.
6433 (let ((index -1))
6434 (concat
6435 (mapconcat
6436 (lambda (sub-entry)
6437 (cl-incf index)
6438 (format
6439 (if (zerop (mod index 2)) " [%s] %-26s"
6441 (funcall fontify-key
6442 (char-to-string (car sub-entry))
6443 top-key)
6444 (nth 1 sub-entry)))
6445 sub-menu "")
6447 entries ""))
6448 ;; Publishing menu is hard-coded.
6450 [%s] Current file [%s] Current project
6452 (funcall fontify-key "P")
6453 (funcall fontify-key "f" ?P)
6454 (funcall fontify-key "p" ?P)
6455 (funcall fontify-key "x" ?P)
6456 (funcall fontify-key "a" ?P))
6458 (funcall fontify-key "&" t)
6459 (funcall fontify-key "#" t))
6460 (format "[%s] %s"
6461 (funcall fontify-key "q" t)
6462 (if first-key "Main menu" "Exit")))))
6463 ;; Build prompts for both standard and expert UI.
6464 (standard-prompt (unless expertp "Export command: "))
6465 (expert-prompt
6466 (when expertp
6467 (format
6468 "Export command (C-%s%s%s%s%s) [%s]: "
6469 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6470 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6471 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6472 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6473 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6474 (mapconcat (lambda (k)
6475 ;; Strip control characters.
6476 (unless (< k 27) (char-to-string k)))
6477 allowed-keys "")))))
6478 ;; With expert UI, just read key with a fancy prompt. In standard
6479 ;; UI, display an intrusive help buffer.
6480 (if expertp
6481 (org-export--dispatch-action
6482 expert-prompt allowed-keys entries options first-key expertp)
6483 ;; At first call, create frame layout in order to display menu.
6484 (unless (get-buffer "*Org Export Dispatcher*")
6485 (delete-other-windows)
6486 (org-switch-to-buffer-other-window
6487 (get-buffer-create "*Org Export Dispatcher*"))
6488 (setq cursor-type nil
6489 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6490 ;; Make sure that invisible cursor will not highlight square
6491 ;; brackets.
6492 (set-syntax-table (copy-syntax-table))
6493 (modify-syntax-entry ?\[ "w"))
6494 ;; At this point, the buffer containing the menu exists and is
6495 ;; visible in the current window. So, refresh it.
6496 (with-current-buffer "*Org Export Dispatcher*"
6497 ;; Refresh help. Maintain display continuity by re-visiting
6498 ;; previous window position.
6499 (let ((pos (window-start)))
6500 (erase-buffer)
6501 (insert help)
6502 (set-window-start nil pos)))
6503 (org-fit-window-to-buffer)
6504 (org-export--dispatch-action
6505 standard-prompt allowed-keys entries options first-key expertp))))
6507 (defun org-export--dispatch-action
6508 (prompt allowed-keys entries options first-key expertp)
6509 "Read a character from command input and act accordingly.
6511 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6512 a list of characters available at a given step in the process.
6513 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6514 EXPERTP are the same as defined in `org-export--dispatch-ui',
6515 which see.
6517 Toggle export options when required. Otherwise, return value is
6518 a list with action as CAR and a list of interactive export
6519 options as CDR."
6520 (let (key)
6521 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6522 ;; C-p, SPC, DEL).
6523 (while (and (setq key (read-char-exclusive prompt))
6524 (not expertp)
6525 (memq key '(14 16 ?\s ?\d)))
6526 (cl-case key
6527 (14 (if (not (pos-visible-in-window-p (point-max)))
6528 (ignore-errors (scroll-up 1))
6529 (message "End of buffer")
6530 (sit-for 1)))
6531 (16 (if (not (pos-visible-in-window-p (point-min)))
6532 (ignore-errors (scroll-down 1))
6533 (message "Beginning of buffer")
6534 (sit-for 1)))
6535 (?\s (if (not (pos-visible-in-window-p (point-max)))
6536 (scroll-up nil)
6537 (message "End of buffer")
6538 (sit-for 1)))
6539 (?\d (if (not (pos-visible-in-window-p (point-min)))
6540 (scroll-down nil)
6541 (message "Beginning of buffer")
6542 (sit-for 1)))))
6543 (cond
6544 ;; Ignore undefined associations.
6545 ((not (memq key allowed-keys))
6546 (ding)
6547 (unless expertp (message "Invalid key") (sit-for 1))
6548 (org-export--dispatch-ui options first-key expertp))
6549 ;; q key at first level aborts export. At second level, cancel
6550 ;; first key instead.
6551 ((eq key ?q) (if (not first-key) (error "Export aborted")
6552 (org-export--dispatch-ui options nil expertp)))
6553 ;; Help key: Switch back to standard interface if expert UI was
6554 ;; active.
6555 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6556 ;; Send request for template insertion along with export scope.
6557 ((eq key ?#) (cons 'template (memq 'subtree options)))
6558 ;; Switch to asynchronous export stack.
6559 ((eq key ?&) '(stack))
6560 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6561 ((memq key '(2 22 19 6 1))
6562 (org-export--dispatch-ui
6563 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6564 (6 'force) (1 'async))))
6565 (if (memq option options) (remq option options)
6566 (cons option options)))
6567 first-key expertp))
6568 ;; Action selected: Send key and options back to
6569 ;; `org-export-dispatch'.
6570 ((or first-key (functionp (nth 2 (assq key entries))))
6571 (cons (cond
6572 ((not first-key) (nth 2 (assq key entries)))
6573 ;; Publishing actions are hard-coded. Send a special
6574 ;; signal to `org-export-dispatch'.
6575 ((eq first-key ?P)
6576 (cl-case key
6577 (?f 'publish-current-file)
6578 (?p 'publish-current-project)
6579 (?x 'publish-choose-project)
6580 (?a 'publish-all)))
6581 ;; Return first action associated to FIRST-KEY + KEY
6582 ;; path. Indeed, derived backends can share the same
6583 ;; FIRST-KEY.
6584 (t (catch 'found
6585 (dolist (entry (member (assq first-key entries) entries))
6586 (let ((match (assq key (nth 2 entry))))
6587 (when match (throw 'found (nth 2 match))))))))
6588 options))
6589 ;; Otherwise, enter sub-menu.
6590 (t (org-export--dispatch-ui options key expertp)))))
6594 (provide 'ox)
6596 ;; Local variables:
6597 ;; generated-autoload-file: "org-loaddefs.el"
6598 ;; End:
6600 ;;; ox.el ends here