| blob | 55ad101c1e7682b79f123215b7fc666f23a7c05c |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2017 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:
91 \f
92 ;;; Internal Variables
93 ;;
94 ;; Among internal variables, the most important is
95 ;; `org-export-options-alist'. This variable define the global export
96 ;; options, shared between every exporter, and how they are acquired.
142 "Alist between export properties and ways to set them.
144 The key of the alist is the property name, and the value is a list
145 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
147 KEYWORD is a string representing a buffer keyword, or nil. Each
148 property defined this way can also be set, during subtree
149 export, through a headline property named after the keyword
151 property).
152 OPTION is a string that could be found in an #+OPTIONS: line.
153 DEFAULT is the default value for the property.
154 BEHAVIOR determines how Org should handle multiple keywords for
155 the same property. It is a symbol among:
156 nil Keep old value and discard the new one.
157 t Replace old value with the new one.
158 `space' Concatenate the values, separating them with a space.
159 `newline' Concatenate the values, separating them with
160 a newline.
161 `split' Split values at white spaces, and cons them to the
162 previous list.
163 `parse' Parse value as a list of strings and Org objects,
164 which can then be transcoded with, e.g.,
165 `org-export-data'. It implies `space' behavior.
167 Values set through KEYWORD and OPTION have precedence over
168 DEFAULT.
170 All these properties should be back-end agnostic. Back-end
171 specific properties are set through `org-export-define-backend'.
175 "List of in-buffer keywords that require special treatment.
176 These keywords are not directly associated to a property. The
177 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
263 org-element--cache org-element--cache-objects org-element--cache-sync-keys
264 org-element--cache-sync-requests org-element--cache-sync-timer)
265 "List of variables not copied through upon buffer duplication.
266 Export process takes place on a copy of the original buffer.
267 When this copy is created, all Org related local variables not in
268 this list are copied to the new buffer. Variables with an
272 "Non-nil means asynchronous export process should leave data behind.
276 located in `temporary-file-directory'.
278 When non-nil, it will also set `debug-on-error' to a non-nil
282 "Record asynchronously generated export results and processes.
283 This is an alist: its CAR is the source of the
284 result (destination file or buffer for a finished process,
285 original buffer for a running one) and its CDR is a list
286 containing the back-end used, as a symbol, and either a process
287 or the time at which it finished. It is used to build the menu
291 "List of backends currently available in the exporter.
292 This variable is set with `org-export-define-backend' and
296 "Last command called from the dispatcher.
297 The value should be a list. Its CAR is the action, as a symbol,
301 "The position where the last export command was created using the dispatcher.
302 This marker will be used with `C-u C-c C-e' to make sure export repetition
305 ;; For compatibility with Org < 8
307 "Name, if any, of the back-end used during an export process.
309 Its value is a symbol such as `html', `latex', `ascii', or nil if
310 the back-end is anonymous (see `org-export-create-backend') or if
311 there is no export process in progress.
313 It can be used to teach Babel blocks how to act differently
317 \f
318 ;;; User-configurable Variables
319 ;;
320 ;; Configuration for the masses.
321 ;;
322 ;; They should never be accessed directly, as their value is to be
323 ;; stored in a property list (cf. `org-export-options-alist').
324 ;; Back-ends will read their value from there instead.
327 "Options for exporting Org mode files."
332 "General options for export engine."
337 "Whether sub-trees with the ARCHIVE tag should be exported.
339 This can have three different values:
340 nil Do not export, pretend this tree is not present.
341 t Do export the entire tree.
342 `headline' Only export the headline, but skip the tree below it.
344 This option can also be set with the OPTIONS keyword,
354 "Non-nil means insert author name into the exported file.
355 This option can also be set with the OPTIONS keyword,
362 "Non-nil means export CLOCK keywords.
363 This option can also be set with the OPTIONS keyword,
370 "Non-nil means the postamble should contain a creator sentence.
372 The sentence can be set in `org-export-creator-string', which
373 see.
375 This option can also be set with the OPTIONS keyword, e.g.,
384 "Non-nil means insert date in the exported document.
385 This option can also be set with the OPTIONS keyword,
392 "Time-stamp format string to use for DATE keyword.
394 The format string, when specified, only applies if date consists
395 in a single time-stamp. Otherwise its value will be ignored.
397 See `format-time-string' for details on how to build this
398 string."
407 emacs-version
409 "Information about the creator of the document.
410 This option can also be set on with the CREATOR keyword."
416 "Non-nil means export contents of standard drawers.
418 When t, all drawers are exported. This may also be a list of
419 drawer names to export, as strings. If that list starts with
420 `not', only drawers with such names will be ignored.
422 This variable doesn't apply to properties drawers. See
423 `org-export-with-properties' instead.
425 This option can also be set with the OPTIONS keyword,
438 :inline t
447 "Non-nil means insert author email into the exported file.
448 This option can also be set with the OPTIONS keyword,
455 "Non-nil means interpret *word*, /word/, _word_ and +word+.
457 If the export target supports emphasizing text, the word will be
458 typeset in bold, italic, with an underline or strike-through,
459 respectively.
461 This option can also be set with the OPTIONS keyword,
468 "Tags that exclude a tree from export.
470 All trees carrying any of these tags will be excluded from
471 export. This is without condition, so even subtrees inside that
472 carry one of the `org-export-select-tags' will be removed.
474 This option can also be set with the EXCLUDE_TAGS keyword."
481 This option can also be set with the OPTIONS keyword,
490 "Non-nil means Org footnotes should be exported.
491 This option can also be set with the OPTIONS keyword,
498 "Non-nil means process LaTeX environments and fragments.
500 This option can also be set with the OPTIONS line,
503 nil Ignore math snippets.
504 `verbatim' Keep everything in verbatim.
505 t Allow export of math snippets."
516 "The last level which is still exported as a headline.
518 Inferior levels will usually produce itemize or enumerate lists
519 when exported, but back-end behavior may differ.
521 This option can also be set with the OPTIONS keyword,
528 "The default language for export and clocktable translations, as a string.
529 This may have an association in
530 `org-clock-clocktable-language-setup',
531 `org-export-smart-quotes-alist' and `org-export-dictionary'.
532 This option can also be set with the LANGUAGE keyword."
538 "Non-nil means preserve all line breaks when exporting.
539 This option can also be set with the OPTIONS keyword,
546 "Non-nil means interpret entities when exporting.
549 Å.
551 For a list of supported names, see the constant `org-entities'
552 and the user option `org-entities-user'.
554 This option can also be set with the OPTIONS keyword,
561 "Non-nil means inlinetasks should be exported.
562 This option can also be set with the OPTIONS keyword,
571 "Non-nil means include planning info in export.
573 Planning info is the line containing either SCHEDULED:,
574 DEADLINE:, CLOSED: time-stamps, or a combination of them.
576 This option can also be set with the OPTIONS keyword,
585 "Non-nil means include priority cookies in export.
586 This option can also be set with the OPTIONS keyword,
593 "Non-nil means export contents of properties drawers.
595 When t, all properties are exported. This may also be a list of
596 properties to export, as strings.
598 This option can also be set with the OPTIONS keyword,
612 "Non-nil means add section numbers to headlines when exporting.
614 When set to an integer n, numbering will only happen for
615 headlines whose relative level is higher or equal to n.
617 This option can also be set with the OPTIONS keyword,
624 "Tags that select a tree for export.
626 If any such tag is found in a buffer, all trees that do not carry
627 one of these tags will be ignored during export. Inside trees
628 that are selected like this, you can still deselect a subtree by
629 tagging it with one of the `org-export-exclude-tags'.
631 This option can also be set with the SELECT_TAGS keyword."
637 "Non-nil means activate smart quotes during export.
638 This option can also be set with the OPTIONS keyword,
641 When setting this to non-nil, you need to take care of
642 using the correct Babel package when exporting to LaTeX.
643 E.g., you can load Babel for french like this:
655 When this option is turned on, these strings will be exported as:
657 Org HTML LaTeX UTF-8
658 -----+----------+--------+-------
660 -- – -- –
661 --- — --- —
664 This option can also be set with the OPTIONS keyword,
671 "Non-nil means include statistics cookies in export.
672 This option can also be set with the OPTIONS keyword,
683 If you want to control how Org displays those characters, see
684 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
685 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
686 it is not anymore.
688 When this option is turned on, you can use TeX-like syntax for
689 sub- and superscripts and see them exported correctly.
691 You can also set the option with #+OPTIONS: ^:t
694 single item - so grouping with {} is normally not needed. For
695 example, the following things will be parsed as single sub- or
696 superscripts:
698 10^24 or 10^tau several digits will be considered 1 item.
699 10^-12 or 10^-tau a leading sign with digits or a word
700 x^2-y^3 will be read as x^2 - y^3, because items are
701 terminated by almost any nonword/nondigit char.
702 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
704 Still, ambiguity is possible. So when in doubt, use {} to enclose
705 the sub/superscript. If you set this variable to the symbol `{}',
706 the braces are *required* in order to trigger interpretations as
708 frequently in plain text."
719 "Non-nil means create a table of contents in exported files.
721 The TOC contains headlines with levels up
722 to`org-export-headline-levels'. When an integer, include levels
723 up to N in the toc, this may then be different from
724 `org-export-headline-levels', but it will not be allowed to be
725 larger than the number of headline levels. When nil, no table of
726 contents is made.
728 This option can also be set with the OPTIONS keyword,
739 "Non-nil means export tables.
740 This option can also be set with the OPTIONS keyword,
749 "If nil, do not export tags, just remove them from headlines.
751 If this is the symbol `not-in-toc', tags will be removed from
752 table of contents entries, but still be shown in the headlines of
753 the document.
755 This option can also be set with the OPTIONS keyword,
765 "Non-nil means include TODO items for export.
767 This may have the following values:
768 t include tasks independent of state.
769 `todo' include only tasks that are not yet done.
770 `done' include only tasks that are already done.
771 nil ignore all tasks.
772 list of keywords include tasks with these keywords.
774 This option can also be set with the OPTIONS keyword,
789 "Non-nil means print title into the exported file.
790 This option can also be set with the OPTIONS keyword,
799 "Non-nil means insert a time stamp into the exported file.
800 The time stamp shows when the file was created. This option can
807 "Non nil means allow timestamps in export.
809 It can be set to any of the following values:
810 t export all timestamps.
811 `active' export active timestamps only.
812 `inactive' export inactive timestamps only.
813 nil do not export timestamps
815 This only applies to timestamps isolated in a paragraph
816 containing only timestamps. Other timestamps are always
817 exported.
819 This option can also be set with the OPTIONS keyword, e.g.
830 "Non-nil means include TODO keywords in export.
831 When nil, remove all these keywords from the export. This option
837 "Non-nil means BIND keywords can define local variable values.
838 This is a potential security risk, which is why the default value
839 is nil. You can also allow them through local buffer variables."
846 "Non-nil means do not raise an error on broken links.
848 When this variable is non-nil, broken links are ignored, without
849 stopping the export process. If it is set to `mark', broken
850 links are marked as such in the output, with a string like
852 [BROKEN LINK: path]
854 where PATH is the un-resolvable reference.
856 This option can also be set with the OPTIONS keyword, e.g.,
867 "Alist between export snippets back-ends and exporter back-ends.
869 This variable allows providing shortcuts for export snippets.
873 HTML code while every other back-end will ignore it."
887 "Coding system for the exported file."
894 "Non-nil means pushing export output to the kill ring.
895 This variable is ignored during asynchronous export."
905 "The initial scope when exporting with `org-export-dispatch'.
906 This variable can be either set to `buffer' or `subtree'."
913 "Non-nil means show buffer after exporting to temp buffer.
914 When Org exports to a file, the buffer visiting that file is never
915 shown, but remains buried. However, when exporting to
916 a temporary buffer, that buffer is popped up in a second window.
917 When this variable is nil, the buffer remains buried also in
918 these cases."
923 "Non-nil means export and publishing commands will run in background.
924 Results from an asynchronous export are never displayed
932 "File used to initialize external export process.
934 Value must be either nil or an absolute file name. When nil, the
935 external process is launched like a regular Emacs session,
936 loading user's initialization file and any site specific
937 configuration. If a file is provided, it, and only it, is loaded
938 at start-up.
940 Therefore, using a specific configuration makes the process to
941 load faster and the export more portable."
950 "Non-nil means using a non-intrusive `org-export-dispatch'.
951 In that case, no help buffer is displayed. Though, an indicator
957 asynchronous). Also, [?] allows switching back to standard
958 mode."
965 \f
966 ;;; Defining Back-ends
967 ;;
968 ;; An export back-end is a structure with `org-export-backend' type
969 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
970 ;; and `menu' slots.
971 ;;
972 ;; At the lowest level, a back-end is created with
973 ;; `org-export-create-backend' function.
974 ;;
975 ;; A named back-end can be registered with
976 ;; `org-export-register-backend' function. A registered back-end can
977 ;; later be referred to by its name, with `org-export-get-backend'
978 ;; function. Also, such a back-end can become the parent of a derived
979 ;; back-end from which slot values will be inherited by default.
980 ;; `org-export-derived-backend-p' can check if a given back-end is
981 ;; derived from a list of back-end names.
982 ;;
983 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
984 ;; `org-export-get-all-filters' return the full alist of transcoders,
985 ;; options and filters, including those inherited from ancestors.
986 ;;
987 ;; At a higher level, `org-export-define-backend' is the standard way
988 ;; to define an export back-end. If the new back-end is similar to
989 ;; a registered back-end, `org-export-define-derived-backend' may be
990 ;; used instead.
991 ;;
992 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
993 ;; when a given back-end hasn't been registered yet.
997 name parent transcoders options filters blocks menu)
999 ;;;###autoload
1001 "Return export back-end named after NAME.
1002 NAME is a symbol. Return nil if no such back-end is found."
1004 org-export-registered-backends))
1007 "Register BACKEND as a known export back-end.
1008 BACKEND is a structure with `org-export-backend' type."
1009 ;; Refuse to register an unnamed back-end.
1012 ;; Refuse to register a back-end with an unknown parent.
1016 ;; If a back-end with the same name as BACKEND is already
1017 ;; registered, replace it with BACKEND. Otherwise, simply add
1018 ;; BACKEND to the list of registered back-ends.
1024 "Signal an error if BACKEND isn't defined."
1029 "Non-nil if BACKEND is derived from one of BACKENDS.
1030 BACKEND is an export back-end, as returned by, e.g.,
1031 `org-export-create-backend', or a symbol referring to
1032 a registered back-end. BACKENDS is constituted of symbols."
1044 "Return full translation table for BACKEND.
1046 BACKEND is an export back-end, as return by, e.g,,
1047 `org-export-create-backend'. Return value is an alist where
1048 keys are element or object types, as symbols, and values are
1049 transcoders.
1051 Unlike to `org-export-backend-transcoders', this function
1052 also returns transcoders inherited from parent back-ends,
1053 if any."
1057 parent)
1062 transcoders)))
1065 "Return export options for BACKEND.
1067 BACKEND is an export back-end, as return by, e.g,,
1068 `org-export-create-backend'. See `org-export-options-alist'
1069 for the shape of the return value.
1071 Unlike to `org-export-backend-options', this function also
1072 returns options inherited from parent back-ends, if any."
1076 parent)
1080 options)))
1083 "Return complete list of filters for BACKEND.
1085 BACKEND is an export back-end, as return by, e.g,,
1086 `org-export-create-backend'. Return value is an alist where
1087 keys are symbols and values lists of functions.
1089 Unlike to `org-export-backend-filters', this function also
1090 returns filters inherited from parent back-ends, if any."
1094 parent)
1098 filters)))
1101 "Define a new back-end BACKEND.
1103 TRANSCODERS is an alist between object or element types and
1104 functions handling them.
1106 These functions should return a string without any trailing
1107 space, or nil. They must accept three arguments: the object or
1108 element itself, its contents or nil when it isn't recursive and
1109 the property list used as a communication channel.
1111 Contents, when not nil, are stripped from any global indentation
1112 \(although the relative one is preserved). They also always end
1113 with a single newline character.
1115 If, for a given type, no function is found, that element or
1116 object type will simply be ignored, along with any blank line or
1117 white space at its end. The same will happen if the function
1118 returns the nil value. If that function returns the empty
1119 string, the type will be ignored, but the blank lines or white
1120 spaces will be kept.
1122 In addition to element and object types, one function can be
1123 associated to the `template' (or `inner-template') symbol and
1124 another one to the `plain-text' symbol.
1126 The former returns the final transcoded string, and can be used
1127 to add a preamble and a postamble to document's body. It must
1128 accept two arguments: the transcoded string and the property list
1129 containing export options. A function associated to `template'
1131 A function associated to `inner-template' is always applied.
1133 The latter, when defined, is to be called on every text not
1134 recognized as an element or an object. It must accept two
1135 arguments: the text string and the information channel. It is an
1136 appropriate place to protect special chars relative to the
1137 back-end.
1139 BODY can start with pre-defined keyword arguments. The following
1140 keywords are understood:
1142 :filters-alist
1144 Alist between filters and function, or list of functions,
1145 specific to the back-end. See `org-export-filters-alist' for
1146 a list of all allowed filters. Filters defined here
1147 shouldn't make a back-end test, as it may prevent back-ends
1148 derived from this one to behave properly.
1150 :menu-entry
1152 Menu entry for the export dispatcher. It should be a list
1153 like:
1157 where :
1159 KEY is a free character selecting the back-end.
1161 DESCRIPTION-OR-ORDINAL is either a string or a number.
1163 If it is a string, is will be used to name the back-end in
1164 its menu entry. If it is a number, the following menu will
1165 be displayed as a sub-menu of the back-end with the same
1166 KEY. Also, the number will be used to determine in which
1167 order such sub-menus will appear (lowest first).
1169 ACTION-OR-MENU is either a function or an alist.
1171 If it is an action, it will be called with four
1172 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1173 BODY-ONLY. See `org-export-as' for further explanations on
1174 some of them.
1176 If it is an alist, associations should follow the
1177 pattern:
1181 where KEY, DESCRIPTION and ACTION are described above.
1183 Valid values include:
1187 or
1192 (lambda (a s v b)
1193 (if a (org-latex-export-to-pdf t s v b)
1194 (org-open-file
1195 (org-latex-export-to-pdf nil s v b)))))))
1197 or the following, which will be added to the previous
1198 sub-menu,
1204 :options-alist
1206 Alist between back-end specific properties introduced in
1207 communication channel and how their value are acquired. See
1208 `org-export-options-alist' for more information about
1209 structure of the values."
1221 :transcoders transcoders
1222 :options options
1223 :filters filters
1227 "Create a new back-end as a variant of an existing one.
1229 CHILD is the name of the derived back-end. PARENT is the name of
1230 the parent back-end.
1232 BODY can start with pre-defined keyword arguments. The following
1233 keywords are understood:
1235 :filters-alist
1237 Alist of filters that will overwrite or complete filters
1238 defined in PARENT back-end. See `org-export-filters-alist'
1239 for a list of allowed filters.
1241 :menu-entry
1243 Menu entry for the export dispatcher. See
1244 `org-export-define-backend' for more information about the
1245 expected value.
1247 :options-alist
1249 Alist of back-end specific properties that will overwrite or
1250 complete those defined in PARENT back-end. Refer to
1251 `org-export-options-alist' for more information about
1252 structure of the values.
1254 :translate-alist
1256 Alist of element and object types and transcoders that will
1257 overwrite or complete transcode table from PARENT back-end.
1258 Refer to `org-export-define-backend' for detailed information
1259 about transcoders.
1262 as a variant of `latex' back-end with a custom template function:
1267 The back-end could then be called with, for example:
1282 :parent parent
1283 :transcoders transcoders
1284 :options options
1285 :filters filters
1289 \f
1290 ;;; The Communication Channel
1291 ;;
1292 ;; During export process, every function has access to a number of
1293 ;; properties. They are of two types:
1294 ;;
1295 ;; 1. Environment options are collected once at the very beginning of
1296 ;; the process, out of the original buffer and configuration.
1297 ;; Collecting them is handled by `org-export-get-environment'
1298 ;; function.
1299 ;;
1300 ;; Most environment options are defined through the
1301 ;; `org-export-options-alist' variable.
1302 ;;
1303 ;; 2. Tree properties are extracted directly from the parsed tree,
1304 ;; just before export, by `org-export--collect-tree-properties'.
1306 ;;;; Environment Options
1307 ;;
1308 ;; Environment options encompass all parameters defined outside the
1309 ;; scope of the parsed data. They come from five sources, in
1310 ;; increasing precedence order:
1311 ;;
1312 ;; - Global variables,
1313 ;; - Buffer's attributes,
1314 ;; - Options keyword symbols,
1315 ;; - Buffer keywords,
1316 ;; - Subtree properties.
1317 ;;
1318 ;; The central internal function with regards to environment options
1319 ;; is `org-export-get-environment'. It updates global variables with
1320 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1321 ;; the different sources.
1322 ;;
1323 ;; The internal functions doing the retrieval are:
1324 ;; `org-export--get-global-options',
1325 ;; `org-export--get-buffer-attributes',
1326 ;; `org-export--parse-option-keyword',
1327 ;; `org-export--get-subtree-options' and
1328 ;; `org-export--get-inbuffer-options'
1329 ;;
1330 ;; Also, `org-export--list-bound-variables' collects bound variables
1331 ;; along with their value in order to set them as buffer local
1332 ;; variables later in the process.
1334 ;;;###autoload
1336 "Collect export options from the current buffer.
1338 Optional argument BACKEND is an export back-end, as returned by
1339 `org-export-create-backend'.
1341 When optional argument SUBTREEP is non-nil, assume the export is
1342 done against the current sub-tree.
1344 Third optional argument EXT-PLIST is a property list with
1345 external parameters overriding Org default settings, but still
1346 inferior to file-local settings."
1347 ;; First install #+BIND variables since these must be set before
1348 ;; global options are read.
1351 ;; Get and prioritize export options...
1353 ;; ... from global variables...
1355 ;; ... from an external property list...
1356 ext-plist
1357 ;; ... from in-buffer settings...
1359 ;; ... and from subtree, when appropriate.
1363 "Parse an OPTIONS line and return values as a plist.
1364 Optional argument BACKEND is an export back-end, as returned by,
1365 e.g., `org-export-create-backend'. It specifies which back-end
1366 specific items to read, if any."
1373 alist))
1374 alist))
1375 ;; Priority is given to back-end specific options.
1377 org-export-options-alist))
1387 "Get export options in subtree at point.
1388 Optional argument BACKEND is an export back-end, as returned by,
1389 e.g., `org-export-create-backend'. It specifies back-end used
1390 for export. Return options as a plist."
1391 ;; For each buffer keyword, create a headline property setting the
1392 ;; same property in communication channel. The name for the
1393 ;; property is the keyword with "EXPORT_" appended to it.
1395 ;; Make sure point is at a heading.
1398 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1399 ;; care of them right from the start.
1402 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1403 ;; headline's title (with no todo keyword, priority cookie or
1404 ;; tag) as its fallback value.
1411 ;; Look for both general keywords and back-end specific
1412 ;; options, with priority given to the latter.
1414 org-export-options-alist)))
1415 ;; Handle other keywords. Then return PLIST.
1429 property
1438 "Return current buffer export options, as a plist.
1440 Optional argument BACKEND, when non-nil, is an export back-end,
1441 as returned by, e.g., `org-export-create-backend'. It specifies
1442 which back-end specific options should also be read in the
1443 process.
1445 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1448 ;; Priority is given to back-end specific options.
1450 org-export-options-alist))
1453 org-export-special-keywords))))
1454 plist to-parse)
1457 ;; Return all properties associated to KEYWORD.
1464 ;; Recursively read keywords in buffer. FILES is
1465 ;; a list of files read so far. PLIST is the current
1466 ;; property list obtained.
1475 ;; Options in `org-export-special-keywords'.
1480 ;; Avoid circular dependencies.
1491 plist
1493 val backend))))
1497 plist
1504 ;; Options in `org-export-options-alist'.
1507 plist
1509 plist property
1510 ;; Handle value depending on specified
1511 ;; BEHAVIOR.
1516 ;; Even if `parse' implies `space'
1517 ;; behavior, we separate line with
1518 ;; "\n" so as to preserve
1519 ;; line-breaks. However, empty
1520 ;; lines are forbidden since `parse'
1521 ;; doesn't allow more than one
1522 ;; paragraph.
1531 " "
1544 ;; Read options in the current buffer and return value.
1546 ;; Parse properties in TO-PARSE. Remove newline characters not
1547 ;; involved in line breaks to simulate `space' behavior.
1548 ;; Finally return options.
1561 "Return properties related to export process, as a plist.
1562 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1563 are like the arguments with the same names of function
1564 `org-export-as'."
1569 :back-end backend
1574 "Return properties related to buffer attributes, as a plist."
1579 "Return global export options as a plist.
1580 Optional argument BACKEND, if non-nil, is an export back-end, as
1581 returned by, e.g., `org-export-create-backend'. It specifies
1582 which back-end specific export options should also be read in the
1583 process."
1585 ;; Priority is given to back-end specific options.
1587 org-export-options-alist)))
1593 plist
1594 prop
1595 ;; Evaluate default value provided.
1600 value)))))))))
1603 "Return variables bound from BIND keywords in current buffer.
1604 Also look for BIND keywords in setup files. The return value is
1605 an alist where associations are (VARIABLE-NAME VALUE)."
1609 ;; Return an alist between variable names and their
1610 ;; value. FILES is a list of setup files names read
1611 ;; so far, used to avoid circular dependencies. ALIST
1612 ;; is the alist collected so far.
1624 ;; Enter setup file.
1636 alist))))))))))
1637 alist)))))
1638 ;; Return value in appropriate order of appearance.
1641 ;; defsubst org-export-get-parent must be defined before first use,
1642 ;; was originally defined in the topology section
1645 "Return BLOB parent or nil.
1646 BLOB is the element or object considered."
1649 ;;;; Tree Properties
1650 ;;
1651 ;; Tree properties are information extracted from parse tree. They
1652 ;; are initialized at the beginning of the transcoding process by
1653 ;; `org-export--collect-tree-properties'.
1654 ;;
1655 ;; Dedicated functions focus on computing the value of specific tree
1656 ;; properties during initialization. Thus,
1657 ;; `org-export--populate-ignore-list' lists elements and objects that
1658 ;; should be skipped during export, `org-export--get-min-level' gets
1659 ;; the minimal exportable level, used as a basis to compute relative
1660 ;; level for headlines. Eventually
1661 ;; `org-export--collect-headline-numbering' builds an alist between
1662 ;; headlines and their numbering.
1665 "Extract tree properties from parse tree.
1667 DATA is the parse tree from which information is retrieved. INFO
1668 is a list holding export options.
1670 Following tree properties are set or updated:
1672 `:headline-offset' Offset between true level of headlines and
1673 local level. An offset of -1 means a headline
1674 of level 2 should be considered as a level
1675 1 headline in the context.
1677 `:headline-numbering' Alist of all headlines as key and the
1678 associated numbering as value.
1680 `:id-alist' Alist of all ID references as key and associated file
1681 as value.
1683 Return updated plist."
1684 ;; Install the parse tree in the communication channel.
1686 ;; Compute `:headline-offset' in order to be able to use
1687 ;; `org-export-get-relative-level'.
1690 :headline-offset
1692 ;; From now on, properties order doesn't matter: get the rest of the
1693 ;; tree properties.
1695 info
1697 :id-alist
1706 "Return minimum exportable headline's level in DATA.
1707 DATA is parsed tree as returned by `org-element-parse-buffer'.
1708 OPTIONS is a plist holding export options."
1717 ;; If no headline was found, for the sake of consistency, set
1718 ;; minimum level to 1 nonetheless.
1722 "Return numbering of all exportable, numbered headlines in a parse tree.
1724 DATA is the parse tree. OPTIONS is the plist holding export
1725 options.
1727 Return an alist whose key is a headline and value is its
1728 associated numbering \(in the shape of a list of numbers) or nil
1729 for a footnotes section."
1738 headline
1740 for n across numbering
1741 for idx from 0 to org-export-max-depth
1745 options)))
1748 "List headlines and inlinetasks with a select tag in their tree.
1749 DATA is parsed data as returned by `org-element-parse-buffer'.
1750 INFO is a plist holding export options."
1753 ;; If FILETAGS contains a select tag, every headline or
1754 ;; inlinetask is returned.
1764 ;; When a select tag is found, mark full
1765 ;; genealogy and every headline within the
1766 ;; tree as acceptable.
1769 genealogy
1772 selected-trees))
1773 ;; If at a headline, continue searching in
1774 ;; tree, recursively.
1783 selected-trees))))
1786 "Non-nil when element or object DATUM should be skipped during export.
1787 OPTIONS is the plist holding export options. SELECTED, when
1788 non-nil, is a list of headlines or inlinetasks belonging to
1789 a tree with a select tag."
1792 ;; Skip all comments and comment blocks. Make to keep maximum
1793 ;; number of blank lines around the comment so as to preserve
1794 ;; local structure of the document upon interpreting it back into
1795 ;; Org syntax.
1801 t)
1807 ;; If `:with-drawers' value starts with `not', ignore
1808 ;; every drawer whose name belong to that list.
1809 ;; Otherwise, ignore drawers whose name isn't in that
1810 ;; list.
1827 ;; Ignore subtrees with an exclude tag.
1830 ;; When a select tag is present in the buffer, ignore any tree
1831 ;; without it.
1833 ;; Ignore commented sub-trees.
1835 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1837 ;; Ignore tasks, if specified by `:with-tasks' property.
1849 properties-set))))))
1860 ;; `:with-timestamps' only applies to isolated timestamps
1861 ;; objects, i.e. timestamp objects in a paragraph containing only
1862 ;; timestamps and whitespaces.
1870 options t))))
1879 \f
1880 ;;; The Transcoder
1881 ;;
1882 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1883 ;; `org-element-parse-buffer') and transcodes it into a specified
1884 ;; back-end output. It takes care of filtering out elements or
1885 ;; objects according to export options and organizing the output blank
1886 ;; lines and white space are preserved. The function memoizes its
1887 ;; results, so it is cheap to call it within transcoders.
1888 ;;
1889 ;; It is possible to modify locally the back-end used by
1890 ;; `org-export-data' or even use a temporary back-end by using
1891 ;; `org-export-data-with-backend'.
1892 ;;
1893 ;; `org-export-transcoder' is an accessor returning appropriate
1894 ;; translator function for a given element or object.
1897 "Return appropriate transcoder for BLOB.
1898 INFO is a plist containing export directives."
1900 ;; Return contents only for complete parse trees.
1906 "Convert DATA into current back-end format.
1908 DATA is a parse tree, an element or an object or a secondary
1909 string. INFO is a plist holding export options.
1911 Return a string."
1913 ;; Handle broken links according to
1914 ;; `org-export-with-broken-links'.
1930 ;; Ignored element/object.
1932 ;; Plain text.
1938 info))
1939 ;; Secondary string.
1942 ;; Element/Object without contents or, as a special
1943 ;; case, headline with archive tag and archived trees
1944 ;; restricted to title only.
1953 ;; Export snippets never return a nil value so
1954 ;; that white spaces following them are never
1955 ;; ignored.
1957 ;; Element/Object with contents.
1970 ;; Elements directly containing
1971 ;; objects must have their indentation
1972 ;; normalized first.
1974 data
1975 ;; When normalizing contents of the
1976 ;; first paragraph in an item or
1977 ;; a footnote definition, ignore
1978 ;; first line's indentation: there is
1979 ;; none and it might be misleading.
1983 data)
1991 info)))))))))
1992 ;; Final result will be memoized before being returned.
1994 data
1998 ;; Append the same white space between elements or objects
1999 ;; as in the original buffer, and call appropriate filters.
2008 info)))
2012 "Convert DATA into BACKEND format.
2014 DATA is an element, an object, a secondary string or a string.
2015 BACKEND is a symbol. INFO is a plist used as a communication
2016 channel.
2018 Unlike to `org-export-with-backend', this function will
2019 recursively convert DATA using BACKEND translation table."
2021 ;; Set-up a new communication channel with translations defined in
2022 ;; BACKEND as the translate table and a new hash table for
2023 ;; memoization.
2026 info
2029 ;; Size of the hash table is reduced since this
2030 ;; function will probably be used on small trees.
2033 ;; Preserve `:internal-references', as those do not depend on
2034 ;; the back-end used; we need to make sure that any new
2035 ;; reference when the temporary back-end was active gets through
2036 ;; the default one.
2041 "Expand a parsed element or object to its original state.
2043 BLOB is either an element or an object. CONTENTS is its
2044 contents, as a string or nil.
2046 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2047 keywords before output."
2053 blob contents))))
2056 \f
2057 ;;; The Filter System
2058 ;;
2059 ;; Filters allow end-users to tweak easily the transcoded output.
2060 ;; They are the functional counterpart of hooks, as every filter in
2061 ;; a set is applied to the return value of the previous one.
2062 ;;
2063 ;; Every set is back-end agnostic. Although, a filter is always
2064 ;; called, in addition to the string it applies to, with the back-end
2065 ;; used as argument, so it's easy for the end-user to add back-end
2066 ;; specific filters in the set. The communication channel, as
2067 ;; a plist, is required as the third argument.
2068 ;;
2069 ;; From the developer side, filters sets can be installed in the
2070 ;; process with the help of `org-export-define-backend', which
2071 ;; internally stores filters as an alist. Each association has a key
2072 ;; among the following symbols and a function or a list of functions
2073 ;; as value.
2074 ;;
2075 ;; - `:filter-options' applies to the property list containing export
2076 ;; options. Unlike to other filters, functions in this list accept
2077 ;; two arguments instead of three: the property list containing
2078 ;; export options and the back-end. Users can set its value through
2079 ;; `org-export-filter-options-functions' variable.
2080 ;;
2081 ;; - `:filter-parse-tree' applies directly to the complete parsed
2082 ;; tree. Users can set it through
2083 ;; `org-export-filter-parse-tree-functions' variable.
2084 ;;
2085 ;; - `:filter-body' applies to the body of the output, before template
2086 ;; translator chimes in. Users can set it through
2087 ;; `org-export-filter-body-functions' variable.
2088 ;;
2089 ;; - `:filter-final-output' applies to the final transcoded string.
2090 ;; Users can set it with `org-export-filter-final-output-functions'
2091 ;; variable.
2092 ;;
2093 ;; - `:filter-plain-text' applies to any string not recognized as Org
2094 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2095 ;; configure it.
2096 ;;
2097 ;; - `:filter-TYPE' applies on the string returned after an element or
2098 ;; object of type TYPE has been transcoded. A user can modify
2099 ;; `org-export-filter-TYPE-functions' to install these filters.
2100 ;;
2101 ;; All filters sets are applied with
2102 ;; `org-export-filter-apply-functions' function. Filters in a set are
2103 ;; applied in a LIFO fashion. It allows developers to be sure that
2104 ;; their filters will be applied first.
2105 ;;
2106 ;; Filters properties are installed in communication channel with
2107 ;; `org-export-install-filters' function.
2108 ;;
2109 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2110 ;; `org-export-before-parsing-hook') are run at the beginning of the
2111 ;; export process and just before parsing to allow for heavy structure
2112 ;; modifications.
2115 ;;;; Hooks
2118 "Hook run at the beginning of the export process.
2120 This is run before include keywords and macros are expanded and
2121 Babel code blocks executed, on a copy of the original buffer
2122 being exported. Visibility and narrowing are preserved. Point
2123 is at the beginning of the buffer.
2125 Every function in this hook will be called with one argument: the
2129 "Hook run before parsing an export buffer.
2131 This is run after include keywords and macros have been expanded
2132 and Babel code blocks executed, on a copy of the original buffer
2133 being exported. Visibility and narrowing are preserved. Point
2134 is at the beginning of the buffer.
2136 Every function in this hook will be called with one argument: the
2140 ;;;; Special Filters
2143 "List of functions applied to the export options.
2144 Each filter is called with two arguments: the export options, as
2145 a plist, and the back-end, as a symbol. It must return
2149 "List of functions applied to the parsed tree.
2150 Each filter is called with three arguments: the parse tree, as
2151 returned by `org-element-parse-buffer', the back-end, as
2152 a symbol, and the communication channel, as a plist. It must
2156 "List of functions applied to plain text.
2157 Each filter is called with three arguments: a string which
2158 contains no Org syntax, the back-end, as a symbol, and the
2159 communication channel, as a plist. It must return a string or
2163 "List of functions applied to transcoded body.
2164 Each filter is called with three arguments: a string which
2165 contains no Org syntax, the back-end, as a symbol, and the
2166 communication channel, as a plist. It must return a string or
2170 "List of functions applied to the transcoded string.
2171 Each filter is called with three arguments: the full transcoded
2172 string, the back-end, as a symbol, and the communication channel,
2173 as a plist. It must return a string that will be used as the
2177 ;;;; Elements Filters
2180 "List of functions applied to a transcoded babel-call.
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 center block.
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 clock.
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 diary-sexp.
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 drawer.
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 dynamic-block.
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 example-block.
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 export-block.
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 fixed-width.
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 footnote-definition.
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 headline.
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 horizontal-rule.
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 inlinetask.
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 item.
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 keyword.
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 latex-environment.
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 node-property.
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 paragraph.
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 plain-list.
2289 Each filter is called with three arguments: the transcoded data,
2290 as a string, the back-end, as a symbol, and the communication
2294 "List of functions applied to a transcoded planning.
2295 Each filter is called with three arguments: the transcoded data,
2296 as a string, the back-end, as a symbol, and the communication
2300 "List of functions applied to a transcoded property-drawer.
2301 Each filter is called with three arguments: the transcoded data,
2302 as a string, the back-end, as a symbol, and the communication
2306 "List of functions applied to a transcoded quote block.
2307 Each filter is called with three arguments: the transcoded quote
2308 data, as a string, the back-end, as a symbol, and the
2309 communication channel, as a plist. It must return a string or
2313 "List of functions applied to a transcoded section.
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 special block.
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 src-block.
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 table.
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 "List of functions applied to a transcoded table-cell.
2338 Each filter is called with three arguments: the transcoded data,
2339 as a string, the back-end, as a symbol, and the communication
2343 "List of functions applied to a transcoded table-row.
2344 Each filter is called with three arguments: the transcoded data,
2345 as a string, the back-end, as a symbol, and the communication
2349 "List of functions applied to a transcoded verse block.
2350 Each filter is called with three arguments: the transcoded data,
2351 as a string, the back-end, as a symbol, and the communication
2355 ;;;; Objects Filters
2358 "List of functions applied to transcoded bold text.
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 transcoded code text.
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 entity.
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 export-snippet.
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 a transcoded footnote-reference.
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 inline-babel-call.
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 inline-src-block.
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 transcoded italic text.
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 latex-fragment.
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 line-break.
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 a transcoded link.
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 radio-target.
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 statistics-cookie.
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 transcoded strike-through text.
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 subscript.
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 a transcoded superscript.
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 a transcoded target.
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 "List of functions applied to a transcoded timestamp.
2461 Each filter is called with three arguments: the transcoded data,
2462 as a string, the back-end, as a symbol, and the communication
2466 "List of functions applied to transcoded underline text.
2467 Each filter is called with three arguments: the transcoded data,
2468 as a string, the back-end, as a symbol, and the communication
2472 "List of functions applied to transcoded verbatim text.
2473 Each filter is called with three arguments: the transcoded data,
2474 as a string, the back-end, as a symbol, and the communication
2478 ;;;; Filters Tools
2479 ;;
2480 ;; Internal function `org-export-install-filters' installs filters
2481 ;; hard-coded in back-ends (developer filters) and filters from global
2482 ;; variables (user filters) in the communication channel.
2483 ;;
2484 ;; Internal function `org-export-filter-apply-functions' takes care
2485 ;; about applying each filter in order to a given data. It ignores
2486 ;; filters returning a nil value but stops whenever a filter returns
2487 ;; an empty string.
2490 "Call every function in FILTERS.
2492 Functions are called with three arguments: a value, the export
2493 back-end name and the communication channel. First function in
2494 FILTERS is called with VALUE as its first argument. Second
2495 function in FILTERS is called with the previous result as its
2496 value, etc.
2498 Functions returning nil are skipped. Any function returning the
2499 empty string ends the process, which returns the empty string.
2501 Call is done in a LIFO fashion, to be sure that developer
2502 specified filters, if any, are called first."
2513 "Install filters properties in communication channel.
2514 INFO is a plist containing the current communication channel.
2515 Return the updated communication channel."
2517 ;; Install user-defined filters with `org-export-filters-alist'
2518 ;; and filters already in INFO (through ext-plist mechanism).
2525 ;; Filters in INFO will be called
2526 ;; before those user provided.
2529 default-value)))))
2530 ;; Prepend back-end specific filters to that list.
2532 ;; Single values get consed, lists are appended.
2537 plist key
2540 ;; Return new communication channel.
2544 \f
2545 ;;; Core functions
2546 ;;
2547 ;; This is the room for the main function, `org-export-as', along with
2548 ;; its derivative, `org-export-string-as'.
2549 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2550 ;; function should be added to kill ring.
2551 ;;
2552 ;; Note that `org-export-as' doesn't really parse the current buffer,
2553 ;; but a copy of it (with the same buffer-local variables and
2554 ;; visibility), where macros and include keywords are expanded and
2555 ;; Babel blocks are executed, if appropriate.
2556 ;; `org-export-with-buffer-copy' macro prepares that copy.
2557 ;;
2558 ;; File inclusion is taken care of by
2559 ;; `org-export-expand-include-keyword' and
2560 ;; `org-export--prepare-file-contents'. Structure wise, including
2561 ;; a whole Org file in a buffer often makes little sense. For
2562 ;; example, if the file contains a headline and the include keyword
2563 ;; was within an item, the item should contain the headline. That's
2564 ;; why file inclusion should be done before any structure can be
2565 ;; associated to the file, that is before parsing.
2566 ;;
2567 ;; `org-export-insert-default-template' is a command to insert
2568 ;; a default template (or a back-end specific template) at point or in
2569 ;; current subtree.
2572 "Return a copy of the current buffer.
2573 The copy preserves Org buffer-local variables, visibility and
2574 narrowing."
2580 new-buf))
2583 "Apply BODY in a copy of the current buffer.
2584 The copy preserves local variables, visibility and contents of
2585 the original buffer. Point is at the beginning of the buffer
2586 when BODY is applied."
2595 ;; Kill copy without confirmation.
2601 "Generate a function duplicating BUFFER.
2603 The copy will preserve local variables, visibility, contents and
2604 narrowing of the original buffer. If a region was active in
2605 BUFFER, contents will be narrowed to that region instead.
2607 The resulting function can be evaluated at a later time, from
2608 another buffer, effectively cloning the original buffer there.
2610 The function assumes BUFFER's major mode is `org-mode'."
2614 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2615 ;; already in BUFFER.
2617 ;; Copy specific buffer local variables and variables set
2618 ;; through BIND keywords.
2620 vars)
2628 buffer-file-name
2629 buffer-file-coding-system))
2633 ;; Skip unreadable values, as they cannot be
2634 ;; sent to external process.
2638 vars))))))
2639 ;; Whole buffer contents.
2644 ;; Narrowing.
2648 ;; Current position of point.
2650 ;; Overlays with invisible property.
2659 ov-set)))))))))
2662 "Delete commented trees and commented inlinetasks in the buffer.
2663 Narrowing, if any, is ignored."
2675 "Prune non exportable elements from DATA.
2676 DATA is the parse tree to traverse. INFO is the plist holding
2677 export info. Also set `:ignore-list' in INFO to a list of
2678 objects which should be ignored during export, but not removed
2679 from tree."
2681 ;; First find trees containing a select tag, if any.
2685 ;; Prune non-exportable elements and objects from tree.
2686 ;; As a special case, special rows and cells from tables
2687 ;; are stored in IGNORE, as they still need to be
2688 ;; accessed during export.
2698 ;; If headline is archived but tree below has
2699 ;; to be skipped, remove contents.
2701 ;; Move into recursive objects/elements.
2703 ;; Move into secondary string, if any.
2705 org-element-secondary-value-alist)))
2708 ;; Collect definitions before possibly pruning them so as
2709 ;; to avoid parsing them again if they are required.
2718 #'org-element-create
2721 ;; If a select tag is active, also ignore the section before the
2722 ;; first headline, if any.
2727 ;; Prune tree and communication channel.
2730 ;; Priority is given to back-end specific options.
2732 org-export-options-alist))
2738 ;; Eventually set `:ignore-list'.
2742 "List footnote definitions missing from TREE.
2743 Missing definitions are searched within DEFINITIONS, which is
2744 a list of footnote definitions or in the widened buffer."
2747 ;; List all footnote labels encountered in DATA. Inline
2748 ;; footnote references are ignored.
2753 defined undefined missing-definitions)
2754 ;; Partition DIRECT-REFERENCES between DEFINED and UNDEFINED
2755 ;; references.
2762 seen)
2767 ;; Complete MISSING-DEFINITIONS by finding the definition of every
2768 ;; undefined label, first by looking into DEFINITIONS, then by
2769 ;; searching the widened buffer. This is a recursive process
2770 ;; since definitions found can themselves contain an undefined
2771 ;; reference.
2778 d))
2779 definitions))
2786 datum
2787 ;; Parse definition with contents.
2798 ;; Look for footnote references within DEFINITION, since
2799 ;; we may need to also find their definition.
2804 ;; MISSING-DEFINITIONS may contain footnote references with inline
2805 ;; definitions. Make sure those are changed into real footnote
2806 ;; definitions.
2813 missing-definitions)))
2816 "Install footnote definitions in tree.
2818 DEFINITIONS is the list of footnote definitions to install. TREE
2819 is the parse tree.
2821 If there is a footnote section in TREE, definitions found are
2822 appended to it. If `org-footnote-section' is non-nil, a new
2823 footnote section containing all definitions is inserted in TREE.
2824 Otherwise, definitions are appended at the end of the section
2825 containing their first reference."
2828 ;; If there is a footnote section, insert definitions there.
2832 nil t)))
2835 footnote-section
2837 ;; If there should be a footnote section, create one containing all
2838 ;; the definitions at the end of the tree.
2841 tree
2847 'section
2848 nil
2850 ;; Otherwise add each definition at the end of the section where it
2851 ;; is first referenced.
2856 ;; Insert footnote definitions in the same section as
2857 ;; their first reference in DATA.
2868 label)
2869 d))
2870 definitions)))
2873 definition)
2874 ;; Also insert definitions for nested
2875 ;; references, if any.
2880 "Change uninterpreted elements back into Org syntax.
2881 DATA is the parse tree. INFO is a plist containing export
2882 options. Each uninterpreted element or object is changed back
2883 into a string. Contents, if any, are not modified. The parse
2884 tree is modified by side effect."
2890 p
2893 info))))))
2896 "Change uninterpreted elements back into Org syntax.
2897 DATA is a parse tree or a secondary string. INFO is a plist
2898 containing export options. It is modified by side effect and
2899 returned by the function."
2902 subscript superscript underline)
2906 ;; ... entities...
2913 ?\s)))))
2914 ;; ... emphasis...
2926 marker
2930 ?\s)))))))
2931 ;; ... LaTeX environments and fragments...
2935 ;; ... sub/superscripts...
2944 "_"
2953 ?\s)))))))))))
2955 ;; Splice NEW at BLOB location in parse tree.
2958 info nil nil t)
2959 ;; Return modified parse tree.
2960 data)
2962 ;;;###autoload
2965 "Transcode current Org buffer into BACKEND code.
2967 BACKEND is either an export back-end, as returned by, e.g.,
2968 `org-export-create-backend', or a symbol referring to
2969 a registered back-end.
2971 If narrowing is active in the current buffer, only transcode its
2972 narrowed part.
2974 If a region is active, transcode that region.
2976 When optional argument SUBTREEP is non-nil, transcode the
2977 sub-tree at point, extracting information from the headline
2978 properties first.
2980 When optional argument VISIBLE-ONLY is non-nil, don't export
2981 contents of hidden elements.
2983 When optional argument BODY-ONLY is non-nil, only return body
2984 code, without surrounding template.
2986 Optional argument EXT-PLIST, when provided, is a property list
2987 with external parameters overriding Org default settings, but
2988 still inferior to file-local settings.
2990 Return code as a string."
2995 ;; Narrow buffer to an appropriate region or subtree for
2996 ;; parsing. If parsing subtree, be sure to remove main
2997 ;; headline, planning data and property drawer.
3005 ;; Initialize communication channel with original buffer
3006 ;; attributes, unavailable in its copy.
3010 backend subtreep visible-only body-only)
3016 org-export-options-alist))))
3017 tree)
3018 ;; Update communication channel and get parse tree. Buffer
3019 ;; isn't parsed directly. Instead, all buffer modifications
3020 ;; and consequent parsing are undertaken in a temporary copy.
3022 ;; Run first hook with current back-end's name as argument.
3025 ;; Include files, delete comments and expand macros.
3030 ;; Refresh buffer properties and radio targets after
3031 ;; potentially invasive previous changes. Likewise, do it
3032 ;; again after executing Babel code.
3039 ;; Run last hook with current back-end's name as argument.
3040 ;; Update buffer properties and radio targets one last time
3041 ;; before parsing.
3048 ;; Update communication channel with environment. Also
3049 ;; install user's and developer's filters.
3054 ;; Call options filters and update export options. We do not
3055 ;; use `org-export-filter-apply-functions' here since the
3056 ;; arity of such filters is different.
3061 ;; Expand export-specific set of macros: {{{author}}},
3062 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
3063 ;; be done once regular macros have been expanded, since
3064 ;; parsed keywords may contain one of them.
3077 value)
3078 value)))
3082 'finalize
3083 parsed-keywords)
3084 ;; Parse buffer.
3086 ;; Prune tree from non-exported elements and transform
3087 ;; uninterpreted elements or objects in both parse tree and
3088 ;; communication channel.
3091 ;; Call parse tree filters.
3095 ;; Now tree is complete, compute its properties and add them
3096 ;; to communication channel.
3098 ;; Eventually transcode TREE. Wrap the resulting string into
3099 ;; a template.
3108 info))
3111 ;; Remove all text properties since they cannot be
3112 ;; retrieved from an external process. Finally call
3113 ;; final-output filter and return result.
3119 info))))))))
3121 ;;;###autoload
3123 "Transcode STRING into BACKEND code.
3125 BACKEND is either an export back-end, as returned by, e.g.,
3126 `org-export-create-backend', or a symbol referring to
3127 a registered back-end.
3129 When optional argument BODY-ONLY is non-nil, only return body
3130 code, without preamble nor postamble.
3132 Optional argument EXT-PLIST, when provided, is a property list
3133 with external parameters overriding Org default settings, but
3134 still inferior to file-local settings.
3136 Return code as a string."
3142 ;;;###autoload
3144 "Replace the active region by its export to BACKEND.
3145 BACKEND is either an export back-end, as returned by, e.g.,
3146 `org-export-create-backend', or a symbol referring to
3147 a registered back-end."
3153 ;;;###autoload
3155 "Insert all export keywords with default values at beginning of line.
3157 BACKEND is a symbol referring to the name of a registered export
3158 back-end, for which specific export options should be added to
3159 the template, or `default' for default template. When it is nil,
3160 the user will be prompted for a category.
3162 If SUBTREEP is non-nil, export configuration will be set up
3163 locally for the subtree through node properties."
3173 "Options category: "
3177 org-export-registered-backends))
3178 nil t))))
3179 options keywords)
3180 ;; Populate OPTIONS and KEYWORDS.
3197 ;; Move to an appropriate location in order to insert options.
3199 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3217 ;; Then the rest of keywords, in the order specified in either
3218 ;; `org-export-options-alist' or respective export back-ends.
3239 "Expand every include keyword in buffer.
3240 Optional argument INCLUDED is a list of included file names along
3241 with their line restriction, when appropriate. It is used to
3242 avoid infinite recursion. Optional argument DIR is the current
3243 working directory. It is used to properly resolve relative
3244 paths. Optional argument FOOTNOTES is a hash-table used for
3245 storing and resolving footnotes. It is created automatically."
3251 ;; If :minlevel is not set the text-property
3252 ;; `:org-include-induced-level' will be used to determine the
3253 ;; relative level when expanding INCLUDE.
3254 ;; Only affects included Org documents.
3258 :org-include-induced-level
3260 ;; Expand INCLUDE keywords.
3266 ;; Extract arguments from keyword's value.
3269 location
3277 matched)
3283 dir)))
3287 value)
3293 value)
3302 ;; Minimal level of included file defaults to the child
3303 ;; level of the current headline, if any, or one. It
3304 ;; only applies is the file is meant to be included as
3305 ;; an Org one.
3316 ;; Remove keyword.
3322 ;; Check if files has already been parsed. Look after
3323 ;; inclusion lines too, as different parts of the same file
3324 ;; can be included too.
3337 ind-str block arg-str contents ind-str block))))
3344 ind-str block contents ind-str block))))
3352 file location only-contents lines)
3353 lines)))
3357 file lines ind minlevel
3360 footnotes)))
3364 footnotes)
3366 ;; Expand footnotes after all files have been included.
3367 ;; Footnotes are stored at end of buffer.
3372 footnotes)))))))))))
3375 "Resolve absolute lines for an included file with file-link.
3377 FILE is string file-name of the file to include. LOCATION is a
3378 string name within FILE to be included (located via
3379 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3380 contents of the named element will be included, as determined
3381 Org-Element. If LINES is non-nil only those lines are included.
3383 Return a string of lines to be included in the format expected by
3384 `org-export--prepare-file-contents'."
3390 ;; Enforce consistent search.
3403 ;; Skip planning line and property-drawer.
3429 start-line
3431 (+ start-line
3434 counter))))))))
3438 "Prepare contents of FILE for inclusion and return it as a string.
3440 When optional argument LINES is a string specifying a range of
3441 lines, include only those lines.
3443 Optional argument IND, when non-nil, is an integer specifying the
3444 global indentation of returned contents. Since its purpose is to
3445 allow an included file to stay in the same environment it was
3446 created (e.g., a list item), it doesn't apply past the first
3447 headline encountered.
3449 Optional argument MINLEVEL, when non-nil, is an integer
3450 specifying the level that any top-level headline in the included
3451 file should have.
3453 Optional argument ID is an integer that will be inserted before
3454 each footnote definition and reference if FILE is an Org file.
3455 This is useful to avoid conflicts when more than one Org file
3456 with footnotes is included in a document.
3458 Optional argument FOOTNOTES is a hash-table to store footnotes in
3459 the included document."
3475 ;; Remove blank lines at beginning and end of contents. The logic
3476 ;; behind that removal is that blank lines around include keyword
3477 ;; override blank lines in included file.
3486 ;; If IND is set, preserve indentation of include keyword until
3487 ;; the first headline encountered.
3494 ;; Do not move footnote definitions out of column 0.
3500 ;; When MINLEVEL is specified, compute minimal level for headlines
3501 ;; in the file (CUR-MIN), and remove stars to each headline so
3502 ;; that headlines with minimal level have a level of MINLEVEL.
3513 ;; Only change stars, don't bother moving whole
3514 ;; sections.
3519 ;; Append ID to all footnote references and definitions, so they
3520 ;; become file specific and cannot collide with footnotes in other
3521 ;; included files. Further, collect relevant footnote definitions
3522 ;; outside of LINES, in order to reintroduce them later.
3528 ;; Generate new label from LABEL by prefixing it with
3529 ;; "-ID-".
3533 ;; Replace OLD label with NEW in footnote F.
3547 ;; Update the footnote-reference at point and collect
3548 ;; the new label, which is only used for footnotes
3549 ;; outsides LINES.
3561 ;; Store since footnote-definition is
3562 ;; outside of LINES.
3565 footnotes))))
3572 "Return a non-nil value when output should be added to the kill ring.
3573 See also `org-export-copy-to-kill-ring'."
3579 \f
3580 ;;; Tools For Back-Ends
3581 ;;
3582 ;; A whole set of tools is available to help build new exporters. Any
3583 ;; function general enough to have its use across many back-ends
3584 ;; should be added here.
3586 ;;;; For Affiliated Keywords
3587 ;;
3588 ;; `org-export-read-attribute' reads a property from a given element
3589 ;; as a plist. It can be used to normalize affiliated keywords'
3590 ;; syntax.
3591 ;;
3592 ;; Since captions can span over multiple lines and accept dual values,
3593 ;; their internal representation is a bit tricky. Therefore,
3594 ;; `org-export-get-caption' transparently returns a given element's
3595 ;; caption as a secondary string.
3598 "Turn ATTRIBUTE property from ELEMENT into a plist.
3600 When optional argument PROPERTY is non-nil, return the value of
3601 that property within attributes.
3605 properties.
3607 All values will become strings except the empty string and
3610 will become the empty string."
3624 s)
3629 ;; Ignore any string before first property with `cdr'.
3634 "Return caption from ELEMENT as a secondary string.
3636 When optional argument SHORTP is non-nil, return short caption,
3637 as a secondary string, instead.
3639 Caption lines are separated by a white space."
3647 ;;;; For Derived Back-ends
3648 ;;
3649 ;; `org-export-with-backend' is a function allowing to locally use
3650 ;; another back-end to transcode some object or element. In a derived
3651 ;; back-end, it may be used as a fall-back function once all specific
3652 ;; cases have been treated.
3655 "Call a transcoder from BACKEND on DATA.
3656 BACKEND is an export back-end, as returned by, e.g.,
3657 `org-export-create-backend', or a symbol referring to
3658 a registered back-end. DATA is an Org element, object, secondary
3659 string or string. CONTENTS, when non-nil, is the transcoded
3660 contents of DATA element, as a string. INFO, when non-nil, is
3661 the communication channel used for export, as a plist."
3672 :back-end backend
3673 :translate-alist all-transcoders
3675 ;; `:internal-references' are shared across back-ends.
3681 ;;;; For Export Snippets
3682 ;;
3683 ;; Every export snippet is transmitted to the back-end. Though, the
3684 ;; latter will only retain one type of export-snippet, ignoring
3685 ;; others, based on the former's target back-end. The function
3686 ;; `org-export-snippet-backend' returns that back-end for a given
3687 ;; export-snippet.
3690 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3691 Translation, with `org-export-snippet-translation-alist', is
3692 applied."
3696 back-end))))
3699 ;;;; For Footnotes
3700 ;;
3701 ;; `org-export-collect-footnote-definitions' is a tool to list
3702 ;; actually used footnotes definitions in the whole parse tree, or in
3703 ;; a headline, in order to add footnote listings throughout the
3704 ;; transcoded data.
3705 ;;
3706 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3707 ;; back-ends, when they need to attach the footnote definition only to
3708 ;; the first occurrence of the corresponding label.
3709 ;;
3710 ;; `org-export-get-footnote-definition' and
3711 ;; `org-export-get-footnote-number' provide easier access to
3712 ;; additional information relative to a footnote reference.
3715 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3716 INFO is the plist used as a communication channel. If no such
3717 definition can be found, raise an error."
3723 hash))))
3731 ;; Skip any footnote with a different label.
3732 ;; Also skip any standard footnote reference
3733 ;; with the same label since those cannot
3734 ;; contain a definition.
3738 ;; Even if the contents are empty, we can not
3739 ;; return nil since that would eventually raise
3740 ;; the error. Instead, return the equivalent
3741 ;; empty string.
3743 info t)
3744 cache)
3749 "Apply FUNCTION on every footnote reference in DATA.
3750 INFO is a plist containing export state. By default, as soon as
3751 a new footnote reference is encountered, FUNCTION is called onto
3752 its definition. However, if BODY-FIRST is non-nil, this step is
3753 delayed until the end of the process."
3758 ;; Search footnote references through DATA, filling
3759 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3760 ;; store footnote definitions so they can be entered
3761 ;; later.
3768 ;; Search for subsequent references in footnote
3769 ;; definition so numbering follows reading
3770 ;; logic, unless DELAYP in non-nil.
3774 definitions))
3775 ;; Do not force entering inline definitions,
3776 ;; since `org-element-map' already traverses
3777 ;; them at the right time.
3781 nil))))))
3782 info nil
3783 ;; Don't enter footnote definitions since it will
3784 ;; happen when their first reference is found.
3785 ;; Moreover, if DELAYP is non-nil, make sure we
3786 ;; postpone entering definitions of inline references.
3793 "Return an alist between footnote numbers, labels and definitions.
3795 INFO is the current export state, as a plist.
3797 Definitions are collected throughout the whole parse tree, or
3798 DATA when non-nil.
3800 Sorting is done by order of references. As soon as a new
3801 reference is encountered, other references are searched within
3802 its definition. However, if BODY-FIRST is non-nil, this step is
3803 delayed after the whole tree is checked. This alters results
3804 when references are found in footnote definitions.
3806 Definitions either appear as Org data or as a secondary string
3807 for inlined footnotes. Unreferenced definitions are ignored."
3811 ;; Collect footnote number, label and definition.
3822 "Non-nil when a footnote reference is the first one for its label.
3824 FOOTNOTE-REFERENCE is the footnote reference being considered.
3825 INFO is a plist containing current export state.
3827 Search is done throughout the whole parse tree, or DATA when
3828 non-nil.
3830 By default, as soon as a new footnote reference is encountered,
3831 other references are searched within its definition. However, if
3832 BODY-FIRST is non-nil, this step is delayed after the whole tree
3833 is checked. This alters results when references are found in
3834 footnote definitions."
3836 ;; Anonymous footnotes are always a first reference.
3847 "Return number associated to a footnote.
3849 FOOTNOTE is either a footnote reference or a footnote definition.
3850 INFO is the plist containing export state.
3852 Number is unique throughout the whole parse tree, or DATA, when
3853 non-nil.
3855 By default, as soon as a new footnote reference is encountered,
3856 counting process moves into its definition. However, if
3857 BODY-FIRST is non-nil, this step is delayed until the end of the
3858 process, leading to a different order when footnotes are nested."
3867 ;; Anonymous footnote match: return number.
3869 ;; Labels match: return number.
3871 ;; Otherwise store label and increase counter if label
3872 ;; wasn't encountered yet.
3878 ;;;; For Headlines
3879 ;;
3880 ;; `org-export-get-relative-level' is a shortcut to get headline
3881 ;; level, relatively to the lower headline level in the parsed tree.
3882 ;;
3883 ;; `org-export-get-headline-number' returns the section number of an
3884 ;; headline, while `org-export-number-to-roman' allows it to be
3885 ;; converted to roman numbers. With an optional argument,
3886 ;; `org-export-get-headline-number' returns a number to unnumbered
3887 ;; headlines (used for internal id).
3888 ;;
3889 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3890 ;; `org-export-last-sibling-p' are three useful predicates when it
3891 ;; comes to fulfill the `:headline-levels' property.
3892 ;;
3893 ;; `org-export-get-tags', `org-export-get-category' and
3894 ;; `org-export-get-node-property' extract useful information from an
3895 ;; headline or a parent headline. They all handle inheritance.
3896 ;;
3897 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3898 ;; as a secondary string, suitable for table of contents. It falls
3899 ;; back onto default title.
3902 "Return HEADLINE relative level within current parsed tree.
3903 INFO is a plist holding contextual information."
3908 "Non-nil when HEADLINE is considered as low level.
3910 INFO is a plist used as a communication channel.
3912 A low level headlines has a relative level greater than
3913 `:headline-levels' property value.
3915 Return value is the difference between HEADLINE relative level
3916 and the last level being considered as high enough, or nil."
3923 "Return numbered HEADLINE numbering as a list of numbers.
3924 INFO is a plist holding contextual information."
3929 "Return a non-nil value if HEADLINE element should be numbered.
3930 INFO is a plist used as a communication channel."
3939 "Convert integer N into a roman numeral."
3952 res)))
3955 "Return list of tags associated to ELEMENT.
3957 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3958 is a plist used as a communication channel.
3960 When non-nil, optional argument TAGS should be a list of strings.
3961 Any tag belonging to this list will also be removed.
3963 When optional argument INHERITED is non-nil, tags can also be
3964 inherited from parent headlines and FILETAGS keywords."
3968 ;; Build complete list of inherited tags.
3975 ;; Add FILETAGS keywords and return results.
3979 "Return node PROPERTY value for BLOB.
3981 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3982 element or object.
3984 If optional argument INHERITED is non-nil, the value can be
3985 inherited from a parent headline.
3987 Return value is a string or nil."
3999 "Return category for element or object BLOB.
4001 INFO is a plist used as a communication channel.
4003 CATEGORY is automatically inherited from a parent headline, from
4004 #+CATEGORY: keyword or created out of original file name. If all
4017 "Return alternative title for HEADLINE, as a secondary string.
4018 If no optional title is defined, fall-back to the regular title."
4025 "Non-nil when BLOB is the first sibling in its parent.
4026 BLOB is an element or an object. If BLOB is a headline, non-nil
4027 means it is the first sibling in the sub-tree. INFO is a plist
4028 used as a communication channel."
4033 "Non-nil when BLOB is the last sibling in its parent.
4034 BLOB is an element or an object. INFO is a plist used as
4035 a communication channel."
4039 ;;;; For Keywords
4040 ;;
4041 ;; `org-export-get-date' returns a date appropriate for the document
4042 ;; to about to be exported. In particular, it takes care of
4043 ;; `org-export-date-timestamp-format'.
4046 "Return date value for the current document.
4048 INFO is a plist used as a communication channel. FMT, when
4049 non-nil, is a time format string that will be applied on the date
4050 if it consists in a single timestamp object. It defaults to
4051 `org-export-date-timestamp-format' when nil.
4053 A proper date can be a secondary string, a string or nil. It is
4054 meant to be translated with `org-export-data' or alike."
4065 ;;;; For Links
4066 ;;
4067 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4068 ;; in `org-link-parameters'.
4069 ;;
4070 ;; `org-export-get-coderef-format' returns an appropriate format
4071 ;; string for coderefs.
4072 ;;
4073 ;; `org-export-inline-image-p' returns a non-nil value when the link
4074 ;; provided should be considered as an inline image.
4075 ;;
4076 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4077 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4078 ;; returns an appropriate unique identifier.
4079 ;;
4080 ;; `org-export-resolve-id-link' returns the first headline with
4081 ;; specified id or custom-id in parse tree, the path to the external
4082 ;; file with the id.
4083 ;;
4084 ;; `org-export-resolve-coderef' associates a reference to a line
4085 ;; number in the element it belongs, or returns the reference itself
4086 ;; when the element isn't numbered.
4087 ;;
4088 ;; `org-export-file-uri' expands a filename as stored in :path value
4089 ;; of a "file" link into a file URI.
4090 ;;
4091 ;; Broken links raise a `org-link-broken' error, which is caught by
4092 ;; `org-export-data' for further processing, depending on
4093 ;; `org-export-with-broken-links' value.
4098 "Try exporting LINK with a dedicated function.
4100 DESC is its description, as a string, or nil. BACKEND is the
4101 back-end used for export, as a symbol.
4103 Return output as a string, or nil if no protocol handles LINK.
4105 A custom protocol has precedence over regular back-end export.
4106 The function ignores links with an implicit type (e.g.,
4115 desc
4116 backend))))))
4119 "Return format string for code reference link.
4120 PATH is the link path. DESC is its description."
4128 "Non-nil if LINK object points to an inline image.
4130 Optional argument is a set of RULES defining inline images. It
4131 is an alist where associations have the following shape:
4133 (TYPE . REGEXP)
4135 Applying a rule means apply REGEXP against LINK's path when its
4136 type is TYPE. The function will return a non-nil value if any of
4137 the provided rules is non-nil. The default rule is
4138 `org-export-default-inline-image-rule'.
4140 This only applies to links without a description."
4151 "Resolve a code reference REF.
4153 INFO is a plist used as a communication channel.
4155 Return associated line number in source code, or REF itself,
4156 depending on src-block or example element's switches. Throw an
4157 error if no block contains REF."
4163 org-coderef-label-format))
4165 ;; Element containing REF is found. Resolve it to
4166 ;; either a label or a line number, as needed.
4175 "List search cells for element or object DATUM.
4177 A search cell follows the pattern (TYPE . SEARCH) where
4179 TYPE is a symbol among `headline', `custom-id', `target' and
4180 `other'.
4182 SEARCH is the string a link is expected to match. More
4183 accurately, it is
4185 - headline's title, as a list of strings, if TYPE is
4186 `headline'.
4188 - CUSTOM_ID value, as a string, if TYPE is `custom-id'.
4190 - target's or radio-target's name as a list of strings if
4191 TYPE is `target'.
4193 - NAME affiliated keyword is TYPE is `other'.
4195 A search cell is the internal representation of a fuzzy link. It
4196 ignores white spaces and statistics cookies, if applicable."
4198 (`headline
4209 (`target
4217 "Return search cells associated to string S.
4218 S is either the path of a fuzzy link or a search option, i.e., it
4219 tries to match either a headline (through custom ID or title),
4220 a target or a named element."
4228 "Non-nil when DATUM matches search cells CELLS.
4229 DATUM is an element or object. CELLS is a list of search cells,
4230 as returned by `org-export-search-cells'."
4235 "Return LINK destination.
4237 INFO is a plist holding contextual information.
4239 Return value can be an object or an element:
4241 - If LINK path matches a target object (i.e. <<path>>) return it.
4243 - If LINK path exactly matches the name affiliated keyword
4244 (i.e. #+NAME: path) of an element, return that element.
4246 - If LINK path exactly matches any headline name, return that
4247 element.
4249 - Otherwise, throw an error.
4252 significant."
4258 :resolve-fuzzy-link-cache
4268 datum)))))
4272 search-cells
4273 ;; There can be multiple matches for un-typed searches, i.e.,
4274 ;; for searches not starting with # or *. In this case,
4275 ;; prioritize targets and names over headline titles.
4276 ;; Matching both a name and a target is not valid, and
4277 ;; therefore undefined.
4280 datum))
4281 matches)
4283 link-cache)))))
4286 "Return headline referenced as LINK destination.
4288 INFO is a plist used as a communication channel.
4290 Return value can be the headline element matched in current parse
4294 ;; First check if id is within the current parse tree.
4299 headline))
4301 ;; Otherwise, look for external files.
4306 "Return radio-target object referenced as LINK destination.
4308 INFO is a plist used as a communication channel.
4310 Return value can be a radio-target object or nil. Assume LINK
4319 nil nil path nil nil t)
4320 t)
4321 radio))
4325 "Return file URI associated to FILENAME."
4332 fullname)))))
4334 ;;;; For References
4335 ;;
4336 ;; `org-export-get-reference' associate a unique reference for any
4337 ;; object or element. It uses `org-export-new-reference' and
4338 ;; `org-export-format-reference' to, respectively, generate new
4339 ;; internal references and turn them into a string suitable for
4340 ;; output.
4341 ;;
4342 ;; `org-export-get-ordinal' associates a sequence number to any object
4343 ;; or element.
4346 "Return a unique reference, among REFERENCES.
4347 REFERENCES is an alist whose values are in-use references, as
4348 numbers. Returns a number, which is the internal representation
4349 of a reference. See also `org-export-format-reference'."
4350 ;; Generate random 7 digits hexadecimal numbers. Collisions
4351 ;; increase exponentially with the numbers of references. However,
4352 ;; the odds for encountering at least one collision with 1000 active
4353 ;; references in the same document are roughly 0.2%, so this
4354 ;; shouldn't be the bottleneck.
4357 new))
4360 "Format REFERENCE into a string.
4361 REFERENCE is a number representing a reference, as returned by
4362 `org-export-new-reference', which see."
4366 "Return a unique reference for DATUM, as a string.
4368 DATUM is either an element or an object. INFO is the current
4369 export state, as a plist.
4371 This function checks `:crossrefs' property in INFO for search
4372 cells matching DATUM before creating a new reference. Returned
4373 reference consists of alphanumeric characters only."
4378 ;; Preserve any pre-existing association between
4379 ;; a search cell and a reference, i.e., when some
4380 ;; previously published document referenced a location
4381 ;; within current file (see
4382 ;; `org-publish-resolve-external-link').
4383 ;;
4384 ;; However, there is no guarantee that search cells are
4385 ;; unique, e.g., there might be duplicate custom ID or
4386 ;; two headings with the same title in the file.
4387 ;;
4388 ;; As a consequence, before re-using any reference to
4389 ;; an element or object, we check that it doesn't refer
4390 ;; to a previous element or object.
4397 cells)
4400 ;; Cache contains both data already associated to
4401 ;; a reference and in-use internal references, so as to make
4402 ;; unique references.
4404 ;; Retain a direct association between reference string and
4405 ;; DATUM since (1) not every object or element can be given
4406 ;; a search cell (2) it permits quick lookup.
4409 reference-string))))
4412 "Return ordinal number of an element or object.
4414 ELEMENT is the element or object considered. INFO is the plist
4415 used as a communication channel.
4417 Optional argument TYPES, when non-nil, is a list of element or
4418 object types, as symbols, that should also be counted in.
4419 Otherwise, only provided element's type is considered.
4421 Optional argument PREDICATE is a function returning a non-nil
4422 value if the current element or object should be counted in. It
4423 accepts two arguments: the element or object being considered and
4424 the plist used as a communication channel. This allows counting
4425 only a certain type of object (i.e. inline images).
4427 Return value is a list of numbers if ELEMENT is a headline or an
4428 item. It is nil for keywords. It represents the footnote number
4429 for footnote definitions and footnote references. If ELEMENT is
4430 a target, return the same value as if ELEMENT was the closest
4431 table, item or headline containing the target. In any other
4432 case, return the sequence number of ELEMENT among elements or
4433 objects of the same type."
4434 ;; Ordinal of a target object refer to the ordinal of the closest
4435 ;; table, item, or headline containing the object.
4439 element
4442 ;; Special case 1: A headline returns its number as a list.
4444 ;; Special case 2: An item returns its number as a list.
4448 struct
4455 ;; Increment counter until ELEMENT is found again.
4466 ;;;; For Src-Blocks
4467 ;;
4468 ;; `org-export-get-loc' counts number of code lines accumulated in
4469 ;; src-block or example-block elements with a "+n" switch until
4470 ;; a given element, excluded. Note: "-n" switches reset that count.
4471 ;;
4472 ;; `org-export-unravel-code' extracts source code (along with a code
4473 ;; references alist) from an `element-block' or `src-block' type
4474 ;; element.
4475 ;;
4476 ;; `org-export-format-code' applies a formatting function to each line
4477 ;; of code, providing relative line number and code reference when
4478 ;; appropriate. Since it doesn't access the original element from
4479 ;; which the source code is coming, it expects from the code calling
4480 ;; it to know if lines should be numbered and if code references
4481 ;; should appear.
4482 ;;
4483 ;; Eventually, `org-export-format-code-default' is a higher-level
4484 ;; function (it makes use of the two previous functions) which handles
4485 ;; line numbering and code references inclusion, and returns source
4486 ;; code in a format suitable for plain text or verbatim output.
4489 "Return count of lines of code before ELEMENT.
4491 ELEMENT is an example-block or src-block element. INFO is the
4492 plist used as a communication channel.
4494 Count includes every line of code in example-block or src-block
4496 ELEMENT doesn't allow line numbering."
4503 ;; ELEMENT is reached: Quit loop and return locs.
4505 ;; Only count lines from src-block and example-block
4506 ;; elements with a "+n" or "-n" switch.
4511 ;; Accumulate locs or reset them.
4519 "Clean source code and extract references out of it.
4521 ELEMENT has either a `src-block' an `example-block' type.
4523 Return a cons cell whose CAR is the source code, cleaned from any
4524 reference, protective commas and spurious indentation, and CDR is
4525 an alist between relative line number (integer) and name of code
4526 reference on that line (string)."
4529 ;; Get code and clean it. Remove blank lines at its
4530 ;; beginning and end.
4537 value
4539 ;; Build a regexp matching a loc with a reference.
4541 ;; Return value.
4543 ;; Code with references removed.
4549 ;; Ref line: remove ref, and signal its position in REFS.
4553 ;; Reference alist.
4554 refs)))
4557 "Format CODE by applying FUN line-wise and return it.
4559 CODE is a string representing the code to format. FUN is
4560 a function. It must accept three arguments: a line of
4561 code (string), the current line number (integer) or nil and the
4562 reference associated to the current line (string) or nil.
4564 Optional argument NUM-LINES can be an integer representing the
4565 number of code lines accumulated until the current code. Line
4566 numbers passed to FUN will take it into account. If it is nil,
4567 FUN's second argument will always be nil. This number can be
4568 obtained with `org-export-get-loc' function.
4570 Optional argument REF-ALIST can be an alist between relative line
4571 number (i.e. ignoring NUM-LINES) and the name of the code
4572 reference on it. If it is nil, FUN's third argument will always
4573 be nil. It can be obtained through the use of
4574 `org-export-unravel-code' function."
4586 "Return source code from ELEMENT, formatted in a standard way.
4588 ELEMENT is either a `src-block' or `example-block' element. INFO
4589 is a plist used as a communication channel.
4591 This function takes care of line numbering and code references
4592 inclusion. Line numbers, when applicable, appear at the
4593 beginning of the line, separated from the code by two white
4594 spaces. Code references, on the other hand, appear flushed to
4595 the right, separated by six white spaces from the widest line of
4596 code."
4597 ;; Extract code and references.
4604 ;; Handle line numbering.
4611 ;; Prepare references display, if required. Any reference
4612 ;; should start six columns after the widest line of code,
4613 ;; wrapped with parenthesis.
4618 code
4622 number-str
4623 loc
4629 num-start refs)))))
4632 ;;;; For Tables
4633 ;;
4634 ;; `org-export-table-has-special-column-p' and and
4635 ;; `org-export-table-row-is-special-p' are predicates used to look for
4636 ;; meta-information about the table structure.
4637 ;;
4638 ;; `org-table-has-header-p' tells when the rows before the first rule
4639 ;; should be considered as table's header.
4640 ;;
4641 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4642 ;; and `org-export-table-cell-borders' extract information from
4643 ;; a table-cell element.
4644 ;;
4645 ;; `org-export-table-dimensions' gives the number on rows and columns
4646 ;; in the table, ignoring horizontal rules and special columns.
4647 ;; `org-export-table-cell-address', given a table-cell object, returns
4648 ;; the absolute address of a cell. On the other hand,
4649 ;; `org-export-get-table-cell-at' does the contrary.
4650 ;;
4651 ;; `org-export-table-cell-starts-colgroup-p',
4652 ;; `org-export-table-cell-ends-colgroup-p',
4653 ;; `org-export-table-row-starts-rowgroup-p',
4654 ;; `org-export-table-row-ends-rowgroup-p',
4655 ;; `org-export-table-row-starts-header-p',
4656 ;; `org-export-table-row-ends-header-p' and
4657 ;; `org-export-table-row-in-header-p' indicate position of current row
4658 ;; or cell within the table.
4661 "Non-nil when TABLE has a special column.
4662 All special columns will be ignored during export."
4663 ;; The table has a special column when every first cell of every row
4664 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4665 ;; "*" "_" and "^". Though, do not consider a first row containing
4666 ;; only empty cells as special.
4680 "Non-nil when TABLE has a header.
4682 INFO is a plist used as a communication channel.
4684 A table has a header when it contains at least two row groups."
4693 table
4704 cache)))))
4707 "Non-nil if TABLE-ROW is considered special.
4708 All special rows will be ignored during export."
4712 ;; A row is special either when...
4714 ;; ... it starts with a field only containing "/",
4716 ;; ... the table contains a special column and the row start
4717 ;; with a marking character among, "^", "_", "$" or "!",
4721 ;; ... it contains only alignment cookies and empty cells.
4726 ;; Since VALUE is a secondary string, the following
4727 ;; checks avoid expanding it with `org-export-data'.
4738 "Return TABLE-ROW's group number, as an integer.
4740 INFO is a plist used as the communication channel.
4742 Return value is the group number, as an integer, or nil for
4743 special rows and rows separators. First group is also table's
4744 header."
4762 "Return TABLE-CELL contents width.
4764 INFO is a plist used as the communication channel.
4766 Return value is the width given by the last width cookie in the
4767 same column as TABLE-CELL, or nil."
4786 ;; In a special row, try to find a width cookie at COLUMN.
4790 ;; The following checks avoid expanding unnecessarily
4791 ;; the cell with `org-export-data'.
4801 "Return TABLE-CELL contents alignment.
4803 INFO is a plist used as the communication channel.
4805 Return alignment as specified by the last alignment cookie in the
4806 same column as TABLE-CELL. If no such cookie is found, a default
4807 alignment value will be deduced from fraction of numbers in the
4808 column (see `org-table-number-fraction' for more information).
4809 Possible values are `left', `right' and `center'."
4810 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4827 cookie-align
4828 previous-cell-number-p)
4831 ;; In a special row, try to find an alignment cookie at
4832 ;; COLUMN.
4836 ;; Since VALUE is a secondary string, the following
4837 ;; checks avoid useless expansion through
4838 ;; `org-export-data'.
4846 ;; Ignore table rules.
4848 ;; In a standard row, check if cell's contents are
4849 ;; expressing some kind of number. Increase NUMBER-CELLS
4850 ;; accordingly. Though, don't bother if an alignment
4851 ;; cookie has already defined cell's alignment.
4856 info)))
4858 ;; Treat an empty cell as a number if it follows
4859 ;; a number.
4865 ;; Return value. Alignment specified by cookies has
4866 ;; precedence over alignment deduced from cell's contents.
4868 column
4873 org-table-number-fraction)
4878 "Return TABLE-CELL borders.
4880 INFO is a plist used as a communication channel.
4882 Return value is a list of symbols, or nil. Possible values are:
4883 `top', `bottom', `above', `below', `left' and `right'. Note:
4884 `top' (resp. `bottom') only happen for a cell in the first
4885 row (resp. last row) of the table, ignoring table rules, if any.
4887 Returned borders ignore special rows."
4890 borders)
4891 ;; Top/above border? TABLE-CELL has a border above when a rule
4892 ;; used to demarcate row groups can be found above. Hence,
4893 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4894 ;; another regular row has to be found above that rule.
4897 ;; Look at every row before the current one.
4904 ;; No rule above, or rule found starts the table (ignoring any
4905 ;; special row): TABLE-CELL is at the top of the table.
4908 ;; Bottom/below border? TABLE-CELL has a border below when next
4909 ;; non-regular row below is a rule.
4912 ;; Look at every row after the current one.
4919 ;; No rule below, or rule found ends the table (modulo some
4920 ;; special row): TABLE-CELL is at the bottom of the table.
4923 ;; Right/left borders? They can only be specified by column
4924 ;; groups. Column groups are defined in a row starting with "/".
4925 ;; Also a column groups row only contains "<", "<>", ">" or blank
4926 ;; cells.
4930 ;; Table rows are read in reverse order so last column groups
4931 ;; row has precedence over any previous one.
4944 ;; There's a left border when previous cell, if
4945 ;; any, ends a group, or current one starts one.
4951 ;; There's a right border when next cell, if any,
4952 ;; starts a group, or current one ends one.
4959 ;; Return value.
4960 borders))
4963 "Non-nil when TABLE-CELL is at the beginning of a column group.
4964 INFO is a plist used as a communication channel."
4965 ;; A cell starts a column group either when it is at the beginning
4966 ;; of a row (or after the special column, if any) or when it has
4967 ;; a left border.
4970 table-cell)
4974 "Non-nil when TABLE-CELL is at the end of a column group.
4975 INFO is a plist used as a communication channel."
4976 ;; A cell ends a column group either when it is at the end of a row
4977 ;; or when it has a right border.
4980 table-cell)
4984 "Non-nil when TABLE-ROW is at the beginning of a row group.
4985 INFO is a plist used as a communication channel."
4993 "Non-nil when TABLE-ROW is at the end of a row group.
4994 INFO is a plist used as a communication channel."
5002 "Non-nil when TABLE-ROW is located within table's header.
5003 INFO is a plist used as a communication channel. Always return
5004 nil for special rows and rows separators."
5010 "Non-nil when TABLE-ROW is the first table header's row.
5011 INFO is a plist used as a communication channel."
5016 "Non-nil when TABLE-ROW is the last table header's row.
5017 INFO is a plist used as a communication channel."
5022 "Return TABLE-ROW number.
5023 INFO is a plist used as a communication channel. Return value is
5024 zero-based and ignores separators. The function returns nil for
5025 special columns and separators."
5037 "Return TABLE dimensions.
5039 INFO is a plist used as a communication channel.
5041 Return value is a CONS like (ROWS . COLUMNS) where
5042 ROWS (resp. COLUMNS) is the number of exportable
5043 rows (resp. columns)."
5045 ;; Set number of rows, and extract first one.
5051 ;; Set number of columns.
5053 ;; Return value.
5057 "Return address of a regular TABLE-CELL object.
5059 TABLE-CELL is the cell considered. INFO is a plist used as
5060 a communication channel.
5062 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5063 zero-based index. Only exportable cells are considered. The
5064 function returns nil for other cells."
5076 "Return regular table-cell object at ADDRESS in TABLE.
5078 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5079 zero-based index. TABLE is a table type element. INFO is
5080 a plist used as a communication channel.
5082 If no table-cell, among exportable cells, is found at ADDRESS,
5083 return nil."
5086 ;; Row at (car address) or nil.
5094 'table-cell
5101 ;;;; For Tables Of Contents
5102 ;;
5103 ;; `org-export-collect-headlines' builds a list of all exportable
5104 ;; headline elements, maybe limited to a certain depth. One can then
5105 ;; easily parse it and transcode it.
5106 ;;
5107 ;; Building lists of tables, figures or listings is quite similar.
5108 ;; Once the generic function `org-export-collect-elements' is defined,
5109 ;; `org-export-collect-tables', `org-export-collect-figures' and
5110 ;; `org-export-collect-listings' can be derived from it.
5113 "Collect headlines in order to build a table of contents.
5115 INFO is a plist used as a communication channel.
5117 When optional argument N is an integer, it specifies the depth of
5118 the table of contents. Otherwise, it is set to the value of the
5119 last headline level. See `org-export-headline-levels' for more
5120 information.
5122 Optional argument SCOPE, when non-nil, is an element. If it is
5123 a headline, only children of SCOPE are collected. Otherwise,
5124 collect children of the headline containing provided element. If
5125 there is no such headline, collect all headlines. In any case,
5126 argument N becomes relative to the level of that headline.
5128 Return a list of all exportable headlines as parsed elements.
5129 Footnote sections are ignored."
5138 limit))))
5144 info)))
5147 "Collect referenceable elements of a determined type.
5149 TYPE can be a symbol or a list of symbols specifying element
5150 types to search. Only elements with a caption are collected.
5152 INFO is a plist used as a communication channel.
5154 When non-nil, optional argument PREDICATE is a function accepting
5155 one argument, an element of type TYPE. It returns a non-nil
5156 value when that element should be collected.
5158 Return a list of all elements found, in order of appearance."
5163 element))
5164 info))
5167 "Build a list of tables.
5168 INFO is a plist used as a communication channel.
5170 Return a list of table elements with a caption."
5174 "Build a list of figures.
5176 INFO is a plist used as a communication channel. PREDICATE is
5177 a function which accepts one argument: a paragraph element and
5178 whose return value is non-nil when that element should be
5179 collected.
5181 A figure is a paragraph type element, with a caption, verifying
5183 a vague concept that may depend on back-end.
5185 Return a list of elements recognized as figures."
5189 "Build a list of src blocks.
5191 INFO is a plist used as a communication channel.
5193 Return a list of src-block elements with a caption."
5197 ;;;; Smart Quotes
5198 ;;
5199 ;; The main function for the smart quotes sub-system is
5200 ;; `org-export-activate-smart-quotes', which replaces every quote in
5201 ;; a given string from the parse tree with its "smart" counterpart.
5202 ;;
5203 ;; Dictionary for smart quotes is stored in
5204 ;; `org-export-smart-quotes-alist'.
5208 ;; one may use: »...«, "...", ›...‹, or '...'.
5209 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5210 ;; LaTeX quotes require Babel!
5270 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5281 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5292 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5303 ;; 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
5304 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5315 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5321 "Smart quotes translations.
5323 Alist whose CAR is a language string and CDR is an alist with
5324 quote type as key and a plist associating various encodings to
5325 their translation as value.
5327 A quote type can be any symbol among `primary-opening',
5328 `primary-closing', `secondary-opening', `secondary-closing' and
5329 `apostrophe'.
5331 Valid encodings include `:utf-8', `:html', `:latex' and
5332 `:texinfo'.
5337 "Return smart quote status at the beginning of string S.
5338 INFO is the current export state, as a plist."
5343 table)))
5351 'plain-text
5360 ;; Not already in a level 1 quote: this is an
5361 ;; apostrophe.
5363 ;; Extract previous char and next char. As
5364 ;; a special case, they can also be set to `blank',
5365 ;; `no-blank' or nil. Then determine if current
5366 ;; match is allowed as an opening quote or a closing
5367 ;; quote.
5372 text info)))
5389 previous)
5400 next)
5407 current-status)
5411 info nil org-element-recursive-objects)
5418 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5419 `:utf-8'. INFO is a plist used as a communication channel.
5421 The function has to retrieve information about string
5422 surroundings in parse tree. It can only happen with an
5423 unmodified string. Thus, if S has already been through another
5424 process, a non-nil ORIGINAL optional argument will provide that
5425 original string.
5427 Return the new string."
5436 org-export-smart-quotes-alist))))
5437 encoding)
5438 match))
5439 s nil t)))
5441 ;;;; Topology
5442 ;;
5443 ;; Here are various functions to retrieve information about the
5444 ;; neighborhood of a given element or object. Neighbors of interest
5445 ;; are direct parent (`org-export-get-parent'), parent headline
5446 ;; (`org-export-get-parent-headline'), first element containing an
5447 ;; object, (`org-export-get-parent-element'), parent table
5448 ;; (`org-export-get-parent-table'), previous element or object
5449 ;; (`org-export-get-previous-element') and next element or object
5450 ;; (`org-export-get-next-element').
5452 ;; defsubst org-export-get-parent must be defined before first use
5455 "Return BLOB parent headline or nil.
5456 BLOB is the element or object being considered."
5460 "Return first element containing OBJECT or nil.
5461 OBJECT is the object to consider."
5465 "Return OBJECT parent table or nil.
5466 OBJECT is either a `table-cell' or `table-element' type object."
5470 "Return previous element or object.
5472 BLOB is an element or object. INFO is a plist used as
5473 a communication channel. Return previous exportable element or
5474 object, a string, or nil.
5476 When optional argument N is a positive integer, return a list
5477 containing up to N siblings before BLOB, from farthest to
5478 closest. With any other non-nil value, return a list containing
5479 all of them."
5485 prev)
5495 "Return next element or object.
5497 BLOB is an element or object. INFO is a plist used as
5498 a communication channel. Return next exportable element or
5499 object, a string, or nil.
5501 When optional argument N is a positive integer, return a list
5502 containing up to N siblings after BLOB, from closest to farthest.
5503 With any other non-nil value, return a list containing all of
5504 them."
5511 next)
5521 ;;;; Translation
5522 ;;
5523 ;; `org-export-translate' translates a string according to the language
5524 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5525 ;; the dictionary used for the translation.
5557 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5567 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5573 ("ru" :html "(Продолжение следует)"
5650 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5673 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5679 ("ru" :html "Список распечаток"
5694 ("ru" :html "Список таблиц"
5811 ("ru" :html "Неизвестная ссылка"
5814 "Dictionary for export engine.
5816 Alist whose car is the string to translate and cdr is an alist
5817 whose car is the language string and cdr is a plist whose
5818 properties are possible charsets and values translated terms.
5820 It is used as a database for `org-export-translate'. Since this
5821 function returns the string as-is if no translation was found,
5822 the variable only needs to record values different from the
5826 "Translate string S according to language specification.
5828 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5829 and `:utf-8'. INFO is a plist used as a communication channel.
5831 Translation depends on `:language' property. Return the
5832 translated string. If no translation is found, try to fall back
5833 to `:default' encoding. If it fails, return S."
5839 s)))
5842 \f
5843 ;;; Asynchronous Export
5844 ;;
5845 ;; `org-export-async-start' is the entry point for asynchronous
5846 ;; export. It recreates current buffer (including visibility,
5847 ;; narrowing and visited file) in an external Emacs process, and
5848 ;; evaluates a command there. It then applies a function on the
5849 ;; returned results in the current process.
5850 ;;
5851 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5852 ;; allow exporting to a buffer or a file, asynchronously or not.
5853 ;;
5854 ;; `org-export-output-file-name' is an auxiliary function meant to be
5855 ;; used with `org-export-to-file'. With a given extension, it tries
5856 ;; to provide a canonical file name to write export output to.
5857 ;;
5858 ;; Asynchronously generated results are never displayed directly.
5859 ;; Instead, they are stored in `org-export-stack-contents'. They can
5860 ;; then be retrieved by calling `org-export-stack'.
5861 ;;
5862 ;; Export Stack is viewed through a dedicated major mode
5863 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5864 ;;`org-export-stack-delete', `org-export-stack-view' and
5865 ;;`org-export-stack-clear'.
5866 ;;
5867 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5868 ;; It should be used whenever `org-export-async-start' is called.
5871 "Call function FUN on the results returned by BODY evaluation.
5873 FUN is an anonymous function of one argument. BODY evaluation
5874 happens in an asynchronous process, from a buffer which is an
5875 exact copy of the current one.
5877 Use `org-export-add-to-stack' in FUN in order to register results
5878 in the stack.
5880 This is a low level function. See also `org-export-to-buffer'
5881 and `org-export-to-file' for more specialized functions."
5884 ;; Write the full sexp evaluating BODY in a copy of the current
5885 ;; buffer to a temporary file, as it may be too long for program
5886 ;; args in `start-process'.
5893 ;; Null characters (from variable values) are inserted
5894 ;; within the file. As a consequence, coding system for
5895 ;; buffer contents will not be recognized properly. So,
5896 ;; we make sure it is the same as the one used to display
5897 ;; the original buffer.
5899 ,coding
5902 ;; Ignore `kill-emacs-hook' and code evaluation
5903 ;; queries from Babel as we need a truly
5904 ;; non-interactive process.
5906 org-babel-confirm-evaluate-answer-no t)
5907 ;; Initialize export framework.
5909 ;; Re-create current buffer there.
5912 ;; Sexp to evaluate in the buffer.
5914 ;; Start external process.
5917 (,process
5919 #'start-process
5922 ,proc-buffer
5929 ;; Register running process in stack.
5931 ;; Set-up sentinel in order to catch results.
5934 ,process
5956 ;;;###autoload
5959 &optional async subtreep visible-only body-only ext-plist
5960 post-process)
5961 "Call `org-export-as' with output to a specified buffer.
5963 BACKEND is either an export back-end, as returned by, e.g.,
5964 `org-export-create-backend', or a symbol referring to
5965 a registered back-end.
5967 BUFFER is the name of the output buffer. If it already exists,
5968 it will be erased first, otherwise, it will be created.
5970 A non-nil optional argument ASYNC means the process should happen
5971 asynchronously. The resulting buffer should then be accessible
5972 through the `org-export-stack' interface. When ASYNC is nil, the
5973 buffer is displayed if `org-export-show-temporary-export-buffer'
5974 is non-nil.
5976 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5977 EXT-PLIST are similar to those used in `org-export-as', which
5978 see.
5980 Optional argument POST-PROCESS is a function which should accept
5981 no argument. It is always called within the current process,
5982 from BUFFER, with point at its beginning. Export back-ends can
5983 use it to set a major mode there, e.g,
5985 (defun org-latex-export-as-latex
5986 (&optional async subtreep visible-only body-only ext-plist)
5987 (interactive)
5989 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5991 This function returns BUFFER."
6019 buffer)))
6021 ;;;###autoload
6024 post-process)
6025 "Call `org-export-as' with output to a specified file.
6027 BACKEND is either an export back-end, as returned by, e.g.,
6028 `org-export-create-backend', or a symbol referring to
6029 a registered back-end. FILE is the name of the output file, as
6030 a string.
6032 A non-nil optional argument ASYNC means the process should happen
6033 asynchronously. The resulting buffer will then be accessible
6034 through the `org-export-stack' interface.
6036 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6037 EXT-PLIST are similar to those used in `org-export-as', which
6038 see.
6040 Optional argument POST-PROCESS is called with FILE as its
6041 argument and happens asynchronously when ASYNC is non-nil. It
6042 has to return a file name, or nil. Export back-ends can use this
6043 to send the output file through additional processing, e.g,
6045 (defun org-latex-export-to-latex
6046 (&optional async subtreep visible-only body-only ext-plist)
6047 (interactive)
6050 async subtreep visible-only body-only ext-plist
6051 (lambda (file) (org-latex-compile file)))
6053 The function returns either a file name returned by POST-PROCESS,
6054 or FILE."
6073 backend subtreep visible-only body-only ext-plist)))
6080 ;; Get proper return value.
6082 file))))))
6085 "Return output file's name according to buffer specifications.
6087 EXTENSION is a string representing the output file extension,
6088 with the leading dot.
6090 With a non-nil optional argument SUBTREEP, try to determine
6092 of subtree at point.
6094 When optional argument PUB-DIR is set, use it as the publishing
6095 directory.
6097 Return file name as a string."
6100 ;; File name may come from EXPORT_FILE_NAME subtree
6101 ;; property.
6104 ;; File name may be extracted from buffer's associated
6105 ;; file, if any.
6107 ;; Can't determine file name on our own: Ask user.
6109 "Output file: " pub-dir nil nil nil
6113 ;; Build file name. Enforce EXTENSION over whatever user
6114 ;; may have come up with. PUB-DIR, if defined, always has
6115 ;; precedence over any provided path.
6120 extension))
6123 ;; If writing to OUTPUT-FILE would overwrite original file, append
6124 ;; EXTENSION another time to final name.
6127 output-file)))
6130 "Add a new result to export stack if not present already.
6132 SOURCE is a buffer or a file name containing export results.
6133 BACKEND is a symbol representing export back-end used to generate
6134 it.
6136 Entries already pointing to SOURCE and unavailable entries are
6137 removed beforehand. Return the new stack."
6143 "Menu for asynchronous export results and running processes."
6153 "Remove all entries from export stack."
6158 "Refresh the export stack."
6163 "Remove export results at point from stack.
6164 If optional argument SOURCE is non-nil, remove it instead."
6169 org-export-stack-contents))))
6172 "View export results at point in stack.
6173 With an optional prefix argument IN-EMACS, force viewing files
6174 within Emacs."
6188 (define-key km "\C-p" 'previous-line)
6189 (define-key km "\C-?" 'previous-line)
6190 (define-key km [up] 'previous-line)
6191 (define-key km "C" 'org-export-stack-clear)
6192 (define-key km "v" 'org-export-stack-view)
6193 (define-key km (kbd "RET") 'org-export-stack-view)
6194 (define-key km "d" 'org-export-stack-remove)
6195 km)
6196 "Keymap for Org Export Stack.")
6198 (define-derived-mode org-export-stack-mode tabulated-list-mode "Org-Stack"
6199 "Mode for displaying asynchronous export stack.
6202 stack.
6204 In an Org Export Stack buffer, use \
6208 stack completely.
6210 Removing entries in a stack buffer does not affect files
6211 or buffers, only display.
6214 (setq tabulated-list-format
6215 (vector (list "#" 4 #'org-export--stack-num-predicate)
6216 (list "Back-End" 12 t)
6217 (list "Age" 6 nil)
6218 (list "Source" 0 nil)))
6219 (setq tabulated-list-sort-key (cons "#" nil))
6220 (setq tabulated-list-entries #'org-export--stack-generate)
6221 (add-hook 'tabulated-list-revert-hook #'org-export--stack-generate nil t)
6222 (add-hook 'post-command-hook #'org-export-stack-refresh nil t)
6223 (tabulated-list-init-header))
6225 (defun org-export--stack-generate ()
6226 "Generate the asynchronous export stack for display.
6227 Unavailable sources are removed from the list. Return a list
6228 appropriate for `tabulated-list-print'."
6229 ;; Clear stack from exited processes, dead buffers or non-existent
6230 ;; files.
6231 (setq org-export-stack-contents
6232 (cl-remove-if-not
6233 (lambda (el)
6234 (if (processp (nth 2 el))
6235 (buffer-live-p (process-buffer (nth 2 el)))
6236 (let ((source (car el)))
6237 (if (bufferp source) (buffer-live-p source)
6238 (file-exists-p source)))))
6239 org-export-stack-contents))
6240 ;; Update `tabulated-list-entries'.
6241 (let ((counter 0))
6242 (mapcar
6243 (lambda (entry)
6244 (let ((source (car entry)))
6245 (list source
6246 (vector
6247 ;; Counter.
6248 (number-to-string (cl-incf counter))
6249 ;; Back-End.
6250 (if (nth 1 entry) (symbol-name (nth 1 entry)) "")
6251 ;; Age.
6252 (let ((info (nth 2 entry)))
6253 (if (processp info) (symbol-name (process-status info))
6254 (format-seconds "%h:%.2m" (float-time (time-since info)))))
6255 ;; Source.
6256 (if (stringp source) source (buffer-name source))))))
6257 org-export-stack-contents)))
6259 (defun org-export--stack-num-predicate (a b)
6260 (< (string-to-number (aref (nth 1 a) 0))
6261 (string-to-number (aref (nth 1 b) 0))))
6263 (defun org-export--stack-source-at-point ()
6264 "Return source from export results at point in stack."
6265 (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
6266 (if (not source) (error "Source unavailable, please refresh buffer")
6267 (let ((source-name (if (stringp source) source (buffer-name source))))
6268 (if (save-excursion
6269 (beginning-of-line)
6270 (looking-at-p (concat ".* +" (regexp-quote source-name) "$")))
6271 source
6272 ;; SOURCE is not consistent with current line. The stack
6273 ;; view is outdated.
6274 (error (substitute-command-keys
6276 to refresh buffer")))))))
6279 \f
6280 ;;; The Dispatcher
6281 ;;
6282 ;; `org-export-dispatch' is the standard interactive way to start an
6283 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6284 ;; for its interface, which, in turn, delegates response to key
6285 ;; pressed to `org-export--dispatch-action'.
6287 ;;;###autoload
6288 (defun org-export-dispatch (&optional arg)
6289 "Export dispatcher for Org mode.
6291 It provides an access to common export related tasks in a buffer.
6292 Its interface comes in two flavors: standard and expert.
6294 While both share the same set of bindings, only the former
6295 displays the valid keys associations in a dedicated buffer.
6296 Scrolling (resp. line-wise motion) in this buffer is done with
6297 SPC and DEL (resp. C-n and C-p) keys.
6299 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6300 flavor or the other.
6303 same
6304 set of options used back then, on the current buffer.
6307 asynchronous export stack."
6308 (interactive "P")
6309 (let* ((input
6310 (cond ((equal arg '(16)) '(stack))
6311 ((and arg org-export-dispatch-last-action))
6312 (t (save-window-excursion
6313 (unwind-protect
6314 (progn
6315 ;; Remember where we are
6316 (move-marker org-export-dispatch-last-position
6317 (point)
6318 (org-base-buffer (current-buffer)))
6319 ;; Get and store an export command
6320 (setq org-export-dispatch-last-action
6321 (org-export--dispatch-ui
6322 (list org-export-initial-scope
6323 (and org-export-in-background 'async))
6324 nil
6325 org-export-dispatch-use-expert-ui)))
6326 (and (get-buffer "*Org Export Dispatcher*")
6327 (kill-buffer "*Org Export Dispatcher*")))))))
6328 (action (car input))
6329 (optns (cdr input)))
6330 (unless (memq 'subtree optns)
6331 (move-marker org-export-dispatch-last-position nil))
6332 (cl-case action
6333 ;; First handle special hard-coded actions.
6334 (template (org-export-insert-default-template nil optns))
6335 (stack (org-export-stack))
6336 (publish-current-file
6337 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6338 (publish-current-project
6339 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6340 (publish-choose-project
6341 (org-publish (assoc (completing-read
6342 "Publish project: "
6343 org-publish-project-alist nil t)
6344 org-publish-project-alist)
6345 (memq 'force optns)
6346 (memq 'async optns)))
6347 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6348 (otherwise
6349 (save-excursion
6350 (when arg
6351 ;; Repeating command, maybe move cursor to restore subtree
6352 ;; context.
6353 (if (eq (marker-buffer org-export-dispatch-last-position)
6354 (org-base-buffer (current-buffer)))
6355 (goto-char org-export-dispatch-last-position)
6356 ;; We are in a different buffer, forget position.
6357 (move-marker org-export-dispatch-last-position nil)))
6358 (funcall action
6359 ;; Return a symbol instead of a list to ease
6360 ;; asynchronous export macro use.
6361 (and (memq 'async optns) t)
6362 (and (memq 'subtree optns) t)
6363 (and (memq 'visible optns) t)
6364 (and (memq 'body optns) t)))))))
6366 (defun org-export--dispatch-ui (options first-key expertp)
6367 "Handle interface for `org-export-dispatch'.
6369 OPTIONS is a list containing current interactive options set for
6370 export. It can contain any of the following symbols:
6371 `body' toggles a body-only export
6372 `subtree' restricts export to current subtree
6373 `visible' restricts export to visible part of buffer.
6374 `force' force publishing files.
6375 `async' use asynchronous export process
6377 FIRST-KEY is the key pressed to select the first level menu. It
6378 is nil when this menu hasn't been selected yet.
6380 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6381 buffer is provided, but indications about currently active
6382 options are given in the prompt. Moreover, [?] allows switching
6383 back to standard interface."
6384 (let* ((fontify-key
6385 (lambda (key &optional access-key)
6386 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6387 ;; non-nil is the required first-level key to activate
6388 ;; KEY. When its value is t, activate KEY independently
6389 ;; on the first key, if any. A nil value means KEY will
6390 ;; only be activated at first level.
6391 (if (or (eq access-key t) (eq access-key first-key))
6392 (propertize key 'face 'org-warning)
6393 key)))
6394 (fontify-value
6395 (lambda (value)
6396 ;; Fontify VALUE string.
6397 (propertize value 'face 'font-lock-variable-name-face)))
6398 ;; Prepare menu entries by extracting them from registered
6399 ;; back-ends and sorting them by access key and by ordinal,
6400 ;; if any.
6401 (entries
6402 (sort (sort (delq nil
6403 (mapcar #'org-export-backend-menu
6404 org-export-registered-backends))
6405 (lambda (a b)
6406 (let ((key-a (nth 1 a))
6407 (key-b (nth 1 b)))
6408 (cond ((and (numberp key-a) (numberp key-b))
6409 (< key-a key-b))
6410 ((numberp key-b) t)))))
6411 'car-less-than-car))
6412 ;; Compute a list of allowed keys based on the first key
6413 ;; pressed, if any. Some keys
6414 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6415 ;; available.
6416 (allowed-keys
6417 (nconc (list 2 22 19 6 1)
6418 (if (not first-key) (org-uniquify (mapcar 'car entries))
6419 (let (sub-menu)
6420 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6421 (when (eq (car entry) first-key)
6422 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6423 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6424 ((not first-key) (list ?P)))
6425 (list ?& ?#)
6426 (when expertp (list ??))
6427 (list ?q)))
6428 ;; Build the help menu for standard UI.
6429 (help
6430 (unless expertp
6431 (concat
6432 ;; Options are hard-coded.
6433 (format "[%s] Body only: %s [%s] Visible only: %s
6434 \[%s] Export scope: %s [%s] Force publishing: %s
6436 (funcall fontify-key "C-b" t)
6437 (funcall fontify-value
6438 (if (memq 'body options) "On " "Off"))
6439 (funcall fontify-key "C-v" t)
6440 (funcall fontify-value
6441 (if (memq 'visible options) "On " "Off"))
6442 (funcall fontify-key "C-s" t)
6443 (funcall fontify-value
6444 (if (memq 'subtree options) "Subtree" "Buffer "))
6445 (funcall fontify-key "C-f" t)
6446 (funcall fontify-value
6447 (if (memq 'force options) "On " "Off"))
6448 (funcall fontify-key "C-a" t)
6449 (funcall fontify-value
6450 (if (memq 'async options) "On " "Off")))
6451 ;; Display registered back-end entries. When a key
6452 ;; appears for the second time, do not create another
6453 ;; entry, but append its sub-menu to existing menu.
6454 (let (last-key)
6455 (mapconcat
6456 (lambda (entry)
6457 (let ((top-key (car entry)))
6458 (concat
6459 (unless (eq top-key last-key)
6460 (setq last-key top-key)
6462 (funcall fontify-key (char-to-string top-key))
6463 (nth 1 entry)))
6464 (let ((sub-menu (nth 2 entry)))
6465 (unless (functionp sub-menu)
6466 ;; Split sub-menu into two columns.
6467 (let ((index -1))
6468 (concat
6469 (mapconcat
6470 (lambda (sub-entry)
6471 (cl-incf index)
6472 (format
6473 (if (zerop (mod index 2)) " [%s] %-26s"
6475 (funcall fontify-key
6476 (char-to-string (car sub-entry))
6477 top-key)
6478 (nth 1 sub-entry)))
6479 sub-menu "")
6481 entries ""))
6482 ;; Publishing menu is hard-coded.
6484 [%s] Current file [%s] Current project
6486 (funcall fontify-key "P")
6487 (funcall fontify-key "f" ?P)
6488 (funcall fontify-key "p" ?P)
6489 (funcall fontify-key "x" ?P)
6490 (funcall fontify-key "a" ?P))
6492 (funcall fontify-key "&" t)
6493 (funcall fontify-key "#" t))
6494 (format "[%s] %s"
6495 (funcall fontify-key "q" t)
6496 (if first-key "Main menu" "Exit")))))
6497 ;; Build prompts for both standard and expert UI.
6498 (standard-prompt (unless expertp "Export command: "))
6499 (expert-prompt
6500 (when expertp
6501 (format
6502 "Export command (C-%s%s%s%s%s) [%s]: "
6503 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6504 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6505 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6506 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6507 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6508 (mapconcat (lambda (k)
6509 ;; Strip control characters.
6510 (unless (< k 27) (char-to-string k)))
6511 allowed-keys "")))))
6512 ;; With expert UI, just read key with a fancy prompt. In standard
6513 ;; UI, display an intrusive help buffer.
6514 (if expertp
6515 (org-export--dispatch-action
6516 expert-prompt allowed-keys entries options first-key expertp)
6517 ;; At first call, create frame layout in order to display menu.
6518 (unless (get-buffer "*Org Export Dispatcher*")
6519 (delete-other-windows)
6520 (org-switch-to-buffer-other-window
6521 (get-buffer-create "*Org Export Dispatcher*"))
6522 (setq cursor-type nil
6523 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6524 ;; Make sure that invisible cursor will not highlight square
6525 ;; brackets.
6526 (set-syntax-table (copy-syntax-table))
6527 (modify-syntax-entry ?\[ "w"))
6528 ;; At this point, the buffer containing the menu exists and is
6529 ;; visible in the current window. So, refresh it.
6530 (with-current-buffer "*Org Export Dispatcher*"
6531 ;; Refresh help. Maintain display continuity by re-visiting
6532 ;; previous window position.
6533 (let ((pos (window-start)))
6534 (erase-buffer)
6535 (insert help)
6536 (set-window-start nil pos)))
6537 (org-fit-window-to-buffer)
6538 (org-export--dispatch-action
6539 standard-prompt allowed-keys entries options first-key expertp))))
6541 (defun org-export--dispatch-action
6542 (prompt allowed-keys entries options first-key expertp)
6543 "Read a character from command input and act accordingly.
6545 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6546 a list of characters available at a given step in the process.
6547 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6548 EXPERTP are the same as defined in `org-export--dispatch-ui',
6549 which see.
6551 Toggle export options when required. Otherwise, return value is
6552 a list with action as CAR and a list of interactive export
6553 options as CDR."
6554 (let (key)
6555 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6556 ;; C-p, SPC, DEL).
6557 (while (and (setq key (read-char-exclusive prompt))
6558 (not expertp)
6559 (memq key '(14 16 ?\s ?\d)))
6560 (cl-case key
6561 (14 (if (not (pos-visible-in-window-p (point-max)))
6562 (ignore-errors (scroll-up 1))
6563 (message "End of buffer")
6564 (sit-for 1)))
6565 (16 (if (not (pos-visible-in-window-p (point-min)))
6566 (ignore-errors (scroll-down 1))
6567 (message "Beginning of buffer")
6568 (sit-for 1)))
6569 (?\s (if (not (pos-visible-in-window-p (point-max)))
6570 (scroll-up nil)
6571 (message "End of buffer")
6572 (sit-for 1)))
6573 (?\d (if (not (pos-visible-in-window-p (point-min)))
6574 (scroll-down nil)
6575 (message "Beginning of buffer")
6576 (sit-for 1)))))
6577 (cond
6578 ;; Ignore undefined associations.
6579 ((not (memq key allowed-keys))
6580 (ding)
6581 (unless expertp (message "Invalid key") (sit-for 1))
6582 (org-export--dispatch-ui options first-key expertp))
6583 ;; q key at first level aborts export. At second level, cancel
6584 ;; first key instead.
6585 ((eq key ?q) (if (not first-key) (error "Export aborted")
6586 (org-export--dispatch-ui options nil expertp)))
6587 ;; Help key: Switch back to standard interface if expert UI was
6588 ;; active.
6589 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6590 ;; Send request for template insertion along with export scope.
6591 ((eq key ?#) (cons 'template (memq 'subtree options)))
6592 ;; Switch to asynchronous export stack.
6593 ((eq key ?&) '(stack))
6594 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6595 ((memq key '(2 22 19 6 1))
6596 (org-export--dispatch-ui
6597 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6598 (6 'force) (1 'async))))
6599 (if (memq option options) (remq option options)
6600 (cons option options)))
6601 first-key expertp))
6602 ;; Action selected: Send key and options back to
6603 ;; `org-export-dispatch'.
6604 ((or first-key (functionp (nth 2 (assq key entries))))
6605 (cons (cond
6606 ((not first-key) (nth 2 (assq key entries)))
6607 ;; Publishing actions are hard-coded. Send a special
6608 ;; signal to `org-export-dispatch'.
6609 ((eq first-key ?P)
6610 (cl-case key
6611 (?f 'publish-current-file)
6612 (?p 'publish-current-project)
6613 (?x 'publish-choose-project)
6614 (?a 'publish-all)))
6615 ;; Return first action associated to FIRST-KEY + KEY
6616 ;; path. Indeed, derived backends can share the same
6617 ;; FIRST-KEY.
6618 (t (catch 'found
6619 (dolist (entry (member (assq first-key entries) entries))
6620 (let ((match (assq key (nth 2 entry))))
6621 (when match (throw 'found (nth 2 match))))))))
6622 options))
6623 ;; Otherwise, enter sub-menu.
6624 (t (org-export--dispatch-ui options key expertp)))))
6628 (provide 'ox)
6630 ;; Local variables:
6631 ;; generated-autoload-file: "org-loaddefs.el"
6632 ;; End:
6634 ;;; ox.el ends here