| blob | 3b793a00f2d10476055c23bcafae3bfd5847a022 |
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 "Alist between macro names and expansion templates.
889 This variable defines macro expansion templates available
890 globally. Associations follow the pattern
892 (NAME . TEMPLATE)
894 where NAME is a string beginning with a letter and consisting of
895 alphanumeric characters only.
897 TEMPLATE is the string to which the macro is going to be
899 macro's arguments. Moreover, if the template starts with
901 accordingly."
910 "Coding system for the exported file."
917 "Non-nil means pushing export output to the kill ring.
918 This variable is ignored during asynchronous export."
928 "The initial scope when exporting with `org-export-dispatch'.
929 This variable can be either set to `buffer' or `subtree'."
936 "Non-nil means show buffer after exporting to temp buffer.
937 When Org exports to a file, the buffer visiting that file is never
938 shown, but remains buried. However, when exporting to
939 a temporary buffer, that buffer is popped up in a second window.
940 When this variable is nil, the buffer remains buried also in
941 these cases."
946 "Non-nil means export and publishing commands will run in background.
947 Results from an asynchronous export are never displayed
955 "File used to initialize external export process.
957 Value must be either nil or an absolute file name. When nil, the
958 external process is launched like a regular Emacs session,
959 loading user's initialization file and any site specific
960 configuration. If a file is provided, it, and only it, is loaded
961 at start-up.
963 Therefore, using a specific configuration makes the process to
964 load faster and the export more portable."
973 "Non-nil means using a non-intrusive `org-export-dispatch'.
974 In that case, no help buffer is displayed. Though, an indicator
980 asynchronous). Also, [?] allows switching back to standard
981 mode."
988 \f
989 ;;; Defining Back-ends
990 ;;
991 ;; An export back-end is a structure with `org-export-backend' type
992 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
993 ;; and `menu' slots.
994 ;;
995 ;; At the lowest level, a back-end is created with
996 ;; `org-export-create-backend' function.
997 ;;
998 ;; A named back-end can be registered with
999 ;; `org-export-register-backend' function. A registered back-end can
1000 ;; later be referred to by its name, with `org-export-get-backend'
1001 ;; function. Also, such a back-end can become the parent of a derived
1002 ;; back-end from which slot values will be inherited by default.
1003 ;; `org-export-derived-backend-p' can check if a given back-end is
1004 ;; derived from a list of back-end names.
1005 ;;
1006 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
1007 ;; `org-export-get-all-filters' return the full alist of transcoders,
1008 ;; options and filters, including those inherited from ancestors.
1009 ;;
1010 ;; At a higher level, `org-export-define-backend' is the standard way
1011 ;; to define an export back-end. If the new back-end is similar to
1012 ;; a registered back-end, `org-export-define-derived-backend' may be
1013 ;; used instead.
1014 ;;
1015 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
1016 ;; when a given back-end hasn't been registered yet.
1020 name parent transcoders options filters blocks menu)
1022 ;;;###autoload
1024 "Return export back-end named after NAME.
1025 NAME is a symbol. Return nil if no such back-end is found."
1027 org-export-registered-backends))
1030 "Register BACKEND as a known export back-end.
1031 BACKEND is a structure with `org-export-backend' type."
1032 ;; Refuse to register an unnamed back-end.
1035 ;; Refuse to register a back-end with an unknown parent.
1039 ;; If a back-end with the same name as BACKEND is already
1040 ;; registered, replace it with BACKEND. Otherwise, simply add
1041 ;; BACKEND to the list of registered back-ends.
1047 "Signal an error if BACKEND isn't defined."
1052 "Non-nil if BACKEND is derived from one of BACKENDS.
1053 BACKEND is an export back-end, as returned by, e.g.,
1054 `org-export-create-backend', or a symbol referring to
1055 a registered back-end. BACKENDS is constituted of symbols."
1067 "Return full translation table for BACKEND.
1069 BACKEND is an export back-end, as return by, e.g,,
1070 `org-export-create-backend'. Return value is an alist where
1071 keys are element or object types, as symbols, and values are
1072 transcoders.
1074 Unlike to `org-export-backend-transcoders', this function
1075 also returns transcoders inherited from parent back-ends,
1076 if any."
1080 parent)
1085 transcoders)))
1088 "Return export options for BACKEND.
1090 BACKEND is an export back-end, as return by, e.g,,
1091 `org-export-create-backend'. See `org-export-options-alist'
1092 for the shape of the return value.
1094 Unlike to `org-export-backend-options', this function also
1095 returns options inherited from parent back-ends, if any.
1097 Return nil if BACKEND is unknown."
1101 parent)
1105 options)))
1108 "Return complete list of filters for BACKEND.
1110 BACKEND is an export back-end, as return by, e.g,,
1111 `org-export-create-backend'. Return value is an alist where
1112 keys are symbols and values lists of functions.
1114 Unlike to `org-export-backend-filters', this function also
1115 returns filters inherited from parent back-ends, if any."
1119 parent)
1123 filters)))
1126 "Define a new back-end BACKEND.
1128 TRANSCODERS is an alist between object or element types and
1129 functions handling them.
1131 These functions should return a string without any trailing
1132 space, or nil. They must accept three arguments: the object or
1133 element itself, its contents or nil when it isn't recursive and
1134 the property list used as a communication channel.
1136 Contents, when not nil, are stripped from any global indentation
1137 \(although the relative one is preserved). They also always end
1138 with a single newline character.
1140 If, for a given type, no function is found, that element or
1141 object type will simply be ignored, along with any blank line or
1142 white space at its end. The same will happen if the function
1143 returns the nil value. If that function returns the empty
1144 string, the type will be ignored, but the blank lines or white
1145 spaces will be kept.
1147 In addition to element and object types, one function can be
1148 associated to the `template' (or `inner-template') symbol and
1149 another one to the `plain-text' symbol.
1151 The former returns the final transcoded string, and can be used
1152 to add a preamble and a postamble to document's body. It must
1153 accept two arguments: the transcoded string and the property list
1154 containing export options. A function associated to `template'
1156 A function associated to `inner-template' is always applied.
1158 The latter, when defined, is to be called on every text not
1159 recognized as an element or an object. It must accept two
1160 arguments: the text string and the information channel. It is an
1161 appropriate place to protect special chars relative to the
1162 back-end.
1164 BODY can start with pre-defined keyword arguments. The following
1165 keywords are understood:
1167 :filters-alist
1169 Alist between filters and function, or list of functions,
1170 specific to the back-end. See `org-export-filters-alist' for
1171 a list of all allowed filters. Filters defined here
1172 shouldn't make a back-end test, as it may prevent back-ends
1173 derived from this one to behave properly.
1175 :menu-entry
1177 Menu entry for the export dispatcher. It should be a list
1178 like:
1182 where :
1184 KEY is a free character selecting the back-end.
1186 DESCRIPTION-OR-ORDINAL is either a string or a number.
1188 If it is a string, is will be used to name the back-end in
1189 its menu entry. If it is a number, the following menu will
1190 be displayed as a sub-menu of the back-end with the same
1191 KEY. Also, the number will be used to determine in which
1192 order such sub-menus will appear (lowest first).
1194 ACTION-OR-MENU is either a function or an alist.
1196 If it is an action, it will be called with four
1197 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1198 BODY-ONLY. See `org-export-as' for further explanations on
1199 some of them.
1201 If it is an alist, associations should follow the
1202 pattern:
1206 where KEY, DESCRIPTION and ACTION are described above.
1208 Valid values include:
1212 or
1217 (lambda (a s v b)
1218 (if a (org-latex-export-to-pdf t s v b)
1219 (org-open-file
1220 (org-latex-export-to-pdf nil s v b)))))))
1222 or the following, which will be added to the previous
1223 sub-menu,
1229 :options-alist
1231 Alist between back-end specific properties introduced in
1232 communication channel and how their value are acquired. See
1233 `org-export-options-alist' for more information about
1234 structure of the values."
1246 :transcoders transcoders
1247 :options options
1248 :filters filters
1252 "Create a new back-end as a variant of an existing one.
1254 CHILD is the name of the derived back-end. PARENT is the name of
1255 the parent back-end.
1257 BODY can start with pre-defined keyword arguments. The following
1258 keywords are understood:
1260 :filters-alist
1262 Alist of filters that will overwrite or complete filters
1263 defined in PARENT back-end. See `org-export-filters-alist'
1264 for a list of allowed filters.
1266 :menu-entry
1268 Menu entry for the export dispatcher. See
1269 `org-export-define-backend' for more information about the
1270 expected value.
1272 :options-alist
1274 Alist of back-end specific properties that will overwrite or
1275 complete those defined in PARENT back-end. Refer to
1276 `org-export-options-alist' for more information about
1277 structure of the values.
1279 :translate-alist
1281 Alist of element and object types and transcoders that will
1282 overwrite or complete transcode table from PARENT back-end.
1283 Refer to `org-export-define-backend' for detailed information
1284 about transcoders.
1287 as a variant of `latex' back-end with a custom template function:
1292 The back-end could then be called with, for example:
1307 :parent parent
1308 :transcoders transcoders
1309 :options options
1310 :filters filters
1314 \f
1315 ;;; The Communication Channel
1316 ;;
1317 ;; During export process, every function has access to a number of
1318 ;; properties. They are of two types:
1319 ;;
1320 ;; 1. Environment options are collected once at the very beginning of
1321 ;; the process, out of the original buffer and configuration.
1322 ;; Collecting them is handled by `org-export-get-environment'
1323 ;; function.
1324 ;;
1325 ;; Most environment options are defined through the
1326 ;; `org-export-options-alist' variable.
1327 ;;
1328 ;; 2. Tree properties are extracted directly from the parsed tree,
1329 ;; just before export, by `org-export--collect-tree-properties'.
1331 ;;;; Environment Options
1332 ;;
1333 ;; Environment options encompass all parameters defined outside the
1334 ;; scope of the parsed data. They come from five sources, in
1335 ;; increasing precedence order:
1336 ;;
1337 ;; - Global variables,
1338 ;; - Buffer's attributes,
1339 ;; - Options keyword symbols,
1340 ;; - Buffer keywords,
1341 ;; - Subtree properties.
1342 ;;
1343 ;; The central internal function with regards to environment options
1344 ;; is `org-export-get-environment'. It updates global variables with
1345 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1346 ;; the different sources.
1347 ;;
1348 ;; The internal functions doing the retrieval are:
1349 ;; `org-export--get-global-options',
1350 ;; `org-export--get-buffer-attributes',
1351 ;; `org-export--parse-option-keyword',
1352 ;; `org-export--get-subtree-options' and
1353 ;; `org-export--get-inbuffer-options'
1354 ;;
1355 ;; Also, `org-export--list-bound-variables' collects bound variables
1356 ;; along with their value in order to set them as buffer local
1357 ;; variables later in the process.
1359 ;;;###autoload
1361 "Collect export options from the current buffer.
1363 Optional argument BACKEND is an export back-end, as returned by
1364 `org-export-create-backend'.
1366 When optional argument SUBTREEP is non-nil, assume the export is
1367 done against the current sub-tree.
1369 Third optional argument EXT-PLIST is a property list with
1370 external parameters overriding Org default settings, but still
1371 inferior to file-local settings."
1372 ;; First install #+BIND variables since these must be set before
1373 ;; global options are read.
1376 ;; Get and prioritize export options...
1378 ;; ... from global variables...
1380 ;; ... from an external property list...
1381 ext-plist
1382 ;; ... from in-buffer settings...
1384 ;; ... and from subtree, when appropriate.
1388 "Parse an OPTIONS line and return values as a plist.
1389 Optional argument BACKEND is an export back-end, as returned by,
1390 e.g., `org-export-create-backend'. It specifies which back-end
1391 specific items to read, if any."
1398 alist))
1399 alist))
1400 ;; Priority is given to back-end specific options.
1402 org-export-options-alist))
1412 "Get export options in subtree at point.
1413 Optional argument BACKEND is an export back-end, as returned by,
1414 e.g., `org-export-create-backend'. It specifies back-end used
1415 for export. Return options as a plist."
1416 ;; For each buffer keyword, create a headline property setting the
1417 ;; same property in communication channel. The name for the
1418 ;; property is the keyword with "EXPORT_" appended to it.
1420 ;; Make sure point is at a heading.
1423 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1424 ;; care of them right from the start.
1427 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1428 ;; headline's title (with no todo keyword, priority cookie or
1429 ;; tag) as its fallback value.
1436 ;; Look for both general keywords and back-end specific
1437 ;; options, with priority given to the latter.
1439 org-export-options-alist)))
1440 ;; Handle other keywords. Then return PLIST.
1454 property
1463 "Return current buffer export options, as a plist.
1465 Optional argument BACKEND, when non-nil, is an export back-end,
1466 as returned by, e.g., `org-export-create-backend'. It specifies
1467 which back-end specific options should also be read in the
1468 process.
1470 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1473 ;; Priority is given to back-end specific options.
1475 org-export-options-alist))
1478 org-export-special-keywords))))
1479 plist to-parse)
1482 ;; Return all properties associated to KEYWORD.
1489 ;; Recursively read keywords in buffer. FILES is
1490 ;; a list of files read so far. PLIST is the current
1491 ;; property list obtained.
1500 ;; Options in `org-export-special-keywords'.
1505 uri
1507 ;; Avoid circular dependencies.
1519 plist
1521 val backend))))
1525 plist
1532 ;; Options in `org-export-options-alist'.
1535 plist
1537 plist property
1538 ;; Handle value depending on specified
1539 ;; BEHAVIOR.
1544 ;; Even if `parse' implies `space'
1545 ;; behavior, we separate line with
1546 ;; "\n" so as to preserve
1547 ;; line-breaks. However, empty
1548 ;; lines are forbidden since `parse'
1549 ;; doesn't allow more than one
1550 ;; paragraph.
1559 " "
1572 ;; Read options in the current buffer and return value.
1574 ;; Parse properties in TO-PARSE. Remove newline characters not
1575 ;; involved in line breaks to simulate `space' behavior.
1576 ;; Finally return options.
1589 "Return properties related to export process, as a plist.
1590 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1591 are like the arguments with the same names of function
1592 `org-export-as'."
1597 :back-end backend
1602 "Return properties related to buffer attributes, as a plist."
1607 "Return global export options as a plist.
1608 Optional argument BACKEND, if non-nil, is an export back-end, as
1609 returned by, e.g., `org-export-create-backend'. It specifies
1610 which back-end specific export options should also be read in the
1611 process."
1613 ;; Priority is given to back-end specific options.
1615 org-export-options-alist)))
1621 plist
1622 prop
1623 ;; Evaluate default value provided.
1628 value)))))))))
1631 "Return variables bound from BIND keywords in current buffer.
1632 Also look for BIND keywords in setup files. The return value is
1633 an alist where associations are (VARIABLE-NAME VALUE)."
1637 ;; Return an alist between variable names and their
1638 ;; value. FILES is a list of setup files names read
1639 ;; so far, used to avoid circular dependencies. ALIST
1640 ;; is the alist collected so far.
1652 ;; Enter setup file.
1656 uri
1658 ;; Avoid circular dependencies.
1669 alist))))))))))
1670 alist)))))
1671 ;; Return value in appropriate order of appearance.
1674 ;; defsubst org-export-get-parent must be defined before first use,
1675 ;; was originally defined in the topology section
1678 "Return BLOB parent or nil.
1679 BLOB is the element or object considered."
1682 ;;;; Tree Properties
1683 ;;
1684 ;; Tree properties are information extracted from parse tree. They
1685 ;; are initialized at the beginning of the transcoding process by
1686 ;; `org-export--collect-tree-properties'.
1687 ;;
1688 ;; Dedicated functions focus on computing the value of specific tree
1689 ;; properties during initialization. Thus,
1690 ;; `org-export--populate-ignore-list' lists elements and objects that
1691 ;; should be skipped during export, `org-export--get-min-level' gets
1692 ;; the minimal exportable level, used as a basis to compute relative
1693 ;; level for headlines. Eventually
1694 ;; `org-export--collect-headline-numbering' builds an alist between
1695 ;; headlines and their numbering.
1698 "Extract tree properties from parse tree.
1700 DATA is the parse tree from which information is retrieved. INFO
1701 is a list holding export options.
1703 Following tree properties are set or updated:
1705 `:headline-offset' Offset between true level of headlines and
1706 local level. An offset of -1 means a headline
1707 of level 2 should be considered as a level
1708 1 headline in the context.
1710 `:headline-numbering' Alist of all headlines as key and the
1711 associated numbering as value.
1713 `:id-alist' Alist of all ID references as key and associated file
1714 as value.
1716 Return updated plist."
1717 ;; Install the parse tree in the communication channel.
1719 ;; Compute `:headline-offset' in order to be able to use
1720 ;; `org-export-get-relative-level'.
1723 :headline-offset
1725 ;; From now on, properties order doesn't matter: get the rest of the
1726 ;; tree properties.
1728 info
1730 :id-alist
1739 "Return minimum exportable headline's level in DATA.
1740 DATA is parsed tree as returned by `org-element-parse-buffer'.
1741 OPTIONS is a plist holding export options."
1750 ;; If no headline was found, for the sake of consistency, set
1751 ;; minimum level to 1 nonetheless.
1755 "Return numbering of all exportable, numbered headlines in a parse tree.
1757 DATA is the parse tree. OPTIONS is the plist holding export
1758 options.
1760 Return an alist whose key is a headline and value is its
1761 associated numbering \(in the shape of a list of numbers) or nil
1762 for a footnotes section."
1771 headline
1773 for n across numbering
1774 for idx from 0 to org-export-max-depth
1778 options)))
1781 "List headlines and inlinetasks with a select tag in their tree.
1782 DATA is parsed data as returned by `org-element-parse-buffer'.
1783 INFO is a plist holding export options."
1786 ;; If FILETAGS contains a select tag, every headline or
1787 ;; inlinetask is returned.
1797 ;; When a select tag is found, mark full
1798 ;; genealogy and every headline within the
1799 ;; tree as acceptable.
1802 genealogy
1805 selected-trees))
1806 ;; If at a headline, continue searching in
1807 ;; tree, recursively.
1816 selected-trees))))
1819 "Non-nil when element or object DATUM should be skipped during export.
1820 OPTIONS is the plist holding export options. SELECTED, when
1821 non-nil, is a list of headlines or inlinetasks belonging to
1822 a tree with a select tag."
1825 ;; Skip all comments and comment blocks. Make to keep maximum
1826 ;; number of blank lines around the comment so as to preserve
1827 ;; local structure of the document upon interpreting it back into
1828 ;; Org syntax.
1834 t)
1840 ;; If `:with-drawers' value starts with `not', ignore
1841 ;; every drawer whose name belong to that list.
1842 ;; Otherwise, ignore drawers whose name isn't in that
1843 ;; list.
1860 ;; Ignore subtrees with an exclude tag.
1863 ;; When a select tag is present in the buffer, ignore any tree
1864 ;; without it.
1866 ;; Ignore commented sub-trees.
1868 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1870 ;; Ignore tasks, if specified by `:with-tasks' property.
1882 properties-set))))))
1893 ;; `:with-timestamps' only applies to isolated timestamps
1894 ;; objects, i.e. timestamp objects in a paragraph containing only
1895 ;; timestamps and whitespaces.
1903 options t))))
1912 \f
1913 ;;; The Transcoder
1914 ;;
1915 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1916 ;; `org-element-parse-buffer') and transcodes it into a specified
1917 ;; back-end output. It takes care of filtering out elements or
1918 ;; objects according to export options and organizing the output blank
1919 ;; lines and white space are preserved. The function memoizes its
1920 ;; results, so it is cheap to call it within transcoders.
1921 ;;
1922 ;; It is possible to modify locally the back-end used by
1923 ;; `org-export-data' or even use a temporary back-end by using
1924 ;; `org-export-data-with-backend'.
1925 ;;
1926 ;; `org-export-transcoder' is an accessor returning appropriate
1927 ;; translator function for a given element or object.
1930 "Return appropriate transcoder for BLOB.
1931 INFO is a plist containing export directives."
1933 ;; Return contents only for complete parse trees.
1939 "Convert DATA into current back-end format.
1941 DATA is a parse tree, an element or an object or a secondary
1942 string. INFO is a plist holding export options.
1944 Return a string."
1946 ;; Handle broken links according to
1947 ;; `org-export-with-broken-links'.
1963 ;; Ignored element/object.
1965 ;; Plain text.
1971 info))
1972 ;; Secondary string.
1975 ;; Element/Object without contents or, as a special
1976 ;; case, headline with archive tag and archived trees
1977 ;; restricted to title only.
1986 ;; Export snippets never return a nil value so
1987 ;; that white spaces following them are never
1988 ;; ignored.
1990 ;; Element/Object with contents.
2003 ;; Elements directly containing
2004 ;; objects must have their indentation
2005 ;; normalized first.
2007 data
2008 ;; When normalizing contents of the
2009 ;; first paragraph in an item or
2010 ;; a footnote definition, ignore
2011 ;; first line's indentation: there is
2012 ;; none and it might be misleading.
2016 data)
2024 info)))))))))
2025 ;; Final result will be memoized before being returned.
2027 data
2031 ;; Append the same white space between elements or objects
2032 ;; as in the original buffer, and call appropriate filters.
2041 info)))
2045 "Convert DATA into BACKEND format.
2047 DATA is an element, an object, a secondary string or a string.
2048 BACKEND is a symbol. INFO is a plist used as a communication
2049 channel.
2051 Unlike to `org-export-with-backend', this function will
2052 recursively convert DATA using BACKEND translation table."
2054 ;; Set-up a new communication channel with translations defined in
2055 ;; BACKEND as the translate table and a new hash table for
2056 ;; memoization.
2059 info
2062 ;; Size of the hash table is reduced since this
2063 ;; function will probably be used on small trees.
2066 ;; Preserve `:internal-references', as those do not depend on
2067 ;; the back-end used; we need to make sure that any new
2068 ;; reference when the temporary back-end was active gets through
2069 ;; the default one.
2074 "Expand a parsed element or object to its original state.
2076 BLOB is either an element or an object. CONTENTS is its
2077 contents, as a string or nil.
2079 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2080 keywords before output."
2086 blob contents))))
2089 \f
2090 ;;; The Filter System
2091 ;;
2092 ;; Filters allow end-users to tweak easily the transcoded output.
2093 ;; They are the functional counterpart of hooks, as every filter in
2094 ;; a set is applied to the return value of the previous one.
2095 ;;
2096 ;; Every set is back-end agnostic. Although, a filter is always
2097 ;; called, in addition to the string it applies to, with the back-end
2098 ;; used as argument, so it's easy for the end-user to add back-end
2099 ;; specific filters in the set. The communication channel, as
2100 ;; a plist, is required as the third argument.
2101 ;;
2102 ;; From the developer side, filters sets can be installed in the
2103 ;; process with the help of `org-export-define-backend', which
2104 ;; internally stores filters as an alist. Each association has a key
2105 ;; among the following symbols and a function or a list of functions
2106 ;; as value.
2107 ;;
2108 ;; - `:filter-options' applies to the property list containing export
2109 ;; options. Unlike to other filters, functions in this list accept
2110 ;; two arguments instead of three: the property list containing
2111 ;; export options and the back-end. Users can set its value through
2112 ;; `org-export-filter-options-functions' variable.
2113 ;;
2114 ;; - `:filter-parse-tree' applies directly to the complete parsed
2115 ;; tree. Users can set it through
2116 ;; `org-export-filter-parse-tree-functions' variable.
2117 ;;
2118 ;; - `:filter-body' applies to the body of the output, before template
2119 ;; translator chimes in. Users can set it through
2120 ;; `org-export-filter-body-functions' variable.
2121 ;;
2122 ;; - `:filter-final-output' applies to the final transcoded string.
2123 ;; Users can set it with `org-export-filter-final-output-functions'
2124 ;; variable.
2125 ;;
2126 ;; - `:filter-plain-text' applies to any string not recognized as Org
2127 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2128 ;; configure it.
2129 ;;
2130 ;; - `:filter-TYPE' applies on the string returned after an element or
2131 ;; object of type TYPE has been transcoded. A user can modify
2132 ;; `org-export-filter-TYPE-functions' to install these filters.
2133 ;;
2134 ;; All filters sets are applied with
2135 ;; `org-export-filter-apply-functions' function. Filters in a set are
2136 ;; applied in a LIFO fashion. It allows developers to be sure that
2137 ;; their filters will be applied first.
2138 ;;
2139 ;; Filters properties are installed in communication channel with
2140 ;; `org-export-install-filters' function.
2141 ;;
2142 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2143 ;; `org-export-before-parsing-hook') are run at the beginning of the
2144 ;; export process and just before parsing to allow for heavy structure
2145 ;; modifications.
2148 ;;;; Hooks
2151 "Hook run at the beginning of the export process.
2153 This is run before include keywords and macros are expanded and
2154 Babel code blocks executed, on a copy of the original buffer
2155 being exported. Visibility and narrowing are preserved. Point
2156 is at the beginning of the buffer.
2158 Every function in this hook will be called with one argument: the
2162 "Hook run before parsing an export buffer.
2164 This is run after include keywords and macros have been expanded
2165 and Babel code blocks executed, on a copy of the original buffer
2166 being exported. Visibility and narrowing are preserved. Point
2167 is at the beginning of the buffer.
2169 Every function in this hook will be called with one argument: the
2173 ;;;; Special Filters
2176 "List of functions applied to the export options.
2177 Each filter is called with two arguments: the export options, as
2178 a plist, and the back-end, as a symbol. It must return
2182 "List of functions applied to the parsed tree.
2183 Each filter is called with three arguments: the parse tree, as
2184 returned by `org-element-parse-buffer', the back-end, as
2185 a symbol, and the communication channel, as a plist. It must
2189 "List of functions applied to plain text.
2190 Each filter is called with three arguments: a string which
2191 contains no Org syntax, the back-end, as a symbol, and the
2192 communication channel, as a plist. It must return a string or
2196 "List of functions applied to transcoded body.
2197 Each filter is called with three arguments: a string which
2198 contains no Org syntax, the back-end, as a symbol, and the
2199 communication channel, as a plist. It must return a string or
2203 "List of functions applied to the transcoded string.
2204 Each filter is called with three arguments: the full transcoded
2205 string, the back-end, as a symbol, and the communication channel,
2206 as a plist. It must return a string that will be used as the
2210 ;;;; Elements Filters
2213 "List of functions applied to a transcoded babel-call.
2214 Each filter is called with three arguments: the transcoded data,
2215 as a string, the back-end, as a symbol, and the communication
2219 "List of functions applied to a transcoded center block.
2220 Each filter is called with three arguments: the transcoded data,
2221 as a string, the back-end, as a symbol, and the communication
2225 "List of functions applied to a transcoded clock.
2226 Each filter is called with three arguments: the transcoded data,
2227 as a string, the back-end, as a symbol, and the communication
2231 "List of functions applied to a transcoded diary-sexp.
2232 Each filter is called with three arguments: the transcoded data,
2233 as a string, the back-end, as a symbol, and the communication
2237 "List of functions applied to a transcoded drawer.
2238 Each filter is called with three arguments: the transcoded data,
2239 as a string, the back-end, as a symbol, and the communication
2243 "List of functions applied to a transcoded dynamic-block.
2244 Each filter is called with three arguments: the transcoded data,
2245 as a string, the back-end, as a symbol, and the communication
2249 "List of functions applied to a transcoded example-block.
2250 Each filter is called with three arguments: the transcoded data,
2251 as a string, the back-end, as a symbol, and the communication
2255 "List of functions applied to a transcoded export-block.
2256 Each filter is called with three arguments: the transcoded data,
2257 as a string, the back-end, as a symbol, and the communication
2261 "List of functions applied to a transcoded fixed-width.
2262 Each filter is called with three arguments: the transcoded data,
2263 as a string, the back-end, as a symbol, and the communication
2267 "List of functions applied to a transcoded footnote-definition.
2268 Each filter is called with three arguments: the transcoded data,
2269 as a string, the back-end, as a symbol, and the communication
2273 "List of functions applied to a transcoded headline.
2274 Each filter is called with three arguments: the transcoded data,
2275 as a string, the back-end, as a symbol, and the communication
2279 "List of functions applied to a transcoded horizontal-rule.
2280 Each filter is called with three arguments: the transcoded data,
2281 as a string, the back-end, as a symbol, and the communication
2285 "List of functions applied to a transcoded inlinetask.
2286 Each filter is called with three arguments: the transcoded data,
2287 as a string, the back-end, as a symbol, and the communication
2291 "List of functions applied to a transcoded item.
2292 Each filter is called with three arguments: the transcoded data,
2293 as a string, the back-end, as a symbol, and the communication
2297 "List of functions applied to a transcoded keyword.
2298 Each filter is called with three arguments: the transcoded data,
2299 as a string, the back-end, as a symbol, and the communication
2303 "List of functions applied to a transcoded latex-environment.
2304 Each filter is called with three arguments: the transcoded data,
2305 as a string, the back-end, as a symbol, and the communication
2309 "List of functions applied to a transcoded node-property.
2310 Each filter is called with three arguments: the transcoded data,
2311 as a string, the back-end, as a symbol, and the communication
2315 "List of functions applied to a transcoded paragraph.
2316 Each filter is called with three arguments: the transcoded data,
2317 as a string, the back-end, as a symbol, and the communication
2321 "List of functions applied to a transcoded plain-list.
2322 Each filter is called with three arguments: the transcoded data,
2323 as a string, the back-end, as a symbol, and the communication
2327 "List of functions applied to a transcoded planning.
2328 Each filter is called with three arguments: the transcoded data,
2329 as a string, the back-end, as a symbol, and the communication
2333 "List of functions applied to a transcoded property-drawer.
2334 Each filter is called with three arguments: the transcoded data,
2335 as a string, the back-end, as a symbol, and the communication
2339 "List of functions applied to a transcoded quote block.
2340 Each filter is called with three arguments: the transcoded quote
2341 data, as a string, the back-end, as a symbol, and the
2342 communication channel, as a plist. It must return a string or
2346 "List of functions applied to a transcoded section.
2347 Each filter is called with three arguments: the transcoded data,
2348 as a string, the back-end, as a symbol, and the communication
2352 "List of functions applied to a transcoded special block.
2353 Each filter is called with three arguments: the transcoded data,
2354 as a string, the back-end, as a symbol, and the communication
2358 "List of functions applied to a transcoded src-block.
2359 Each filter is called with three arguments: the transcoded data,
2360 as a string, the back-end, as a symbol, and the communication
2364 "List of functions applied to a transcoded table.
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 table-cell.
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 table-row.
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 verse block.
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 ;;;; Objects Filters
2391 "List of functions applied to transcoded bold text.
2392 Each filter is called with three arguments: the transcoded data,
2393 as a string, the back-end, as a symbol, and the communication
2397 "List of functions applied to transcoded code text.
2398 Each filter is called with three arguments: the transcoded data,
2399 as a string, the back-end, as a symbol, and the communication
2403 "List of functions applied to a transcoded entity.
2404 Each filter is called with three arguments: the transcoded data,
2405 as a string, the back-end, as a symbol, and the communication
2409 "List of functions applied to a transcoded export-snippet.
2410 Each filter is called with three arguments: the transcoded data,
2411 as a string, the back-end, as a symbol, and the communication
2415 "List of functions applied to a transcoded footnote-reference.
2416 Each filter is called with three arguments: the transcoded data,
2417 as a string, the back-end, as a symbol, and the communication
2421 "List of functions applied to a transcoded inline-babel-call.
2422 Each filter is called with three arguments: the transcoded data,
2423 as a string, the back-end, as a symbol, and the communication
2427 "List of functions applied to a transcoded inline-src-block.
2428 Each filter is called with three arguments: the transcoded data,
2429 as a string, the back-end, as a symbol, and the communication
2433 "List of functions applied to transcoded italic text.
2434 Each filter is called with three arguments: the transcoded data,
2435 as a string, the back-end, as a symbol, and the communication
2439 "List of functions applied to a transcoded latex-fragment.
2440 Each filter is called with three arguments: the transcoded data,
2441 as a string, the back-end, as a symbol, and the communication
2445 "List of functions applied to a transcoded line-break.
2446 Each filter is called with three arguments: the transcoded data,
2447 as a string, the back-end, as a symbol, and the communication
2451 "List of functions applied to a transcoded link.
2452 Each filter is called with three arguments: the transcoded data,
2453 as a string, the back-end, as a symbol, and the communication
2457 "List of functions applied to a transcoded radio-target.
2458 Each filter is called with three arguments: the transcoded data,
2459 as a string, the back-end, as a symbol, and the communication
2463 "List of functions applied to a transcoded statistics-cookie.
2464 Each filter is called with three arguments: the transcoded data,
2465 as a string, the back-end, as a symbol, and the communication
2469 "List of functions applied to transcoded strike-through text.
2470 Each filter is called with three arguments: the transcoded data,
2471 as a string, the back-end, as a symbol, and the communication
2475 "List of functions applied to a transcoded subscript.
2476 Each filter is called with three arguments: the transcoded data,
2477 as a string, the back-end, as a symbol, and the communication
2481 "List of functions applied to a transcoded superscript.
2482 Each filter is called with three arguments: the transcoded data,
2483 as a string, the back-end, as a symbol, and the communication
2487 "List of functions applied to a transcoded target.
2488 Each filter is called with three arguments: the transcoded data,
2489 as a string, the back-end, as a symbol, and the communication
2493 "List of functions applied to a transcoded timestamp.
2494 Each filter is called with three arguments: the transcoded data,
2495 as a string, the back-end, as a symbol, and the communication
2499 "List of functions applied to transcoded underline text.
2500 Each filter is called with three arguments: the transcoded data,
2501 as a string, the back-end, as a symbol, and the communication
2505 "List of functions applied to transcoded verbatim text.
2506 Each filter is called with three arguments: the transcoded data,
2507 as a string, the back-end, as a symbol, and the communication
2511 ;;;; Filters Tools
2512 ;;
2513 ;; Internal function `org-export-install-filters' installs filters
2514 ;; hard-coded in back-ends (developer filters) and filters from global
2515 ;; variables (user filters) in the communication channel.
2516 ;;
2517 ;; Internal function `org-export-filter-apply-functions' takes care
2518 ;; about applying each filter in order to a given data. It ignores
2519 ;; filters returning a nil value but stops whenever a filter returns
2520 ;; an empty string.
2523 "Call every function in FILTERS.
2525 Functions are called with three arguments: a value, the export
2526 back-end name and the communication channel. First function in
2527 FILTERS is called with VALUE as its first argument. Second
2528 function in FILTERS is called with the previous result as its
2529 value, etc.
2531 Functions returning nil are skipped. Any function returning the
2532 empty string ends the process, which returns the empty string.
2534 Call is done in a LIFO fashion, to be sure that developer
2535 specified filters, if any, are called first."
2546 "Install filters properties in communication channel.
2547 INFO is a plist containing the current communication channel.
2548 Return the updated communication channel."
2550 ;; Install user-defined filters with `org-export-filters-alist'
2551 ;; and filters already in INFO (through ext-plist mechanism).
2558 ;; Filters in INFO will be called
2559 ;; before those user provided.
2562 default-value)))))
2563 ;; Prepend back-end specific filters to that list.
2565 ;; Single values get consed, lists are appended.
2570 plist key
2573 ;; Return new communication channel.
2577 \f
2578 ;;; Core functions
2579 ;;
2580 ;; This is the room for the main function, `org-export-as', along with
2581 ;; its derivative, `org-export-string-as'.
2582 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2583 ;; function should be added to kill ring.
2584 ;;
2585 ;; Note that `org-export-as' doesn't really parse the current buffer,
2586 ;; but a copy of it (with the same buffer-local variables and
2587 ;; visibility), where macros and include keywords are expanded and
2588 ;; Babel blocks are executed, if appropriate.
2589 ;; `org-export-with-buffer-copy' macro prepares that copy.
2590 ;;
2591 ;; File inclusion is taken care of by
2592 ;; `org-export-expand-include-keyword' and
2593 ;; `org-export--prepare-file-contents'. Structure wise, including
2594 ;; a whole Org file in a buffer often makes little sense. For
2595 ;; example, if the file contains a headline and the include keyword
2596 ;; was within an item, the item should contain the headline. That's
2597 ;; why file inclusion should be done before any structure can be
2598 ;; associated to the file, that is before parsing.
2599 ;;
2600 ;; `org-export-insert-default-template' is a command to insert
2601 ;; a default template (or a back-end specific template) at point or in
2602 ;; current subtree.
2605 "Return a copy of the current buffer.
2606 The copy preserves Org buffer-local variables, visibility and
2607 narrowing."
2613 new-buf))
2616 "Apply BODY in a copy of the current buffer.
2617 The copy preserves local variables, visibility and contents of
2618 the original buffer. Point is at the beginning of the buffer
2619 when BODY is applied."
2628 ;; Kill copy without confirmation.
2634 "Generate a function duplicating BUFFER.
2636 The copy will preserve local variables, visibility, contents and
2637 narrowing of the original buffer. If a region was active in
2638 BUFFER, contents will be narrowed to that region instead.
2640 The resulting function can be evaluated at a later time, from
2641 another buffer, effectively cloning the original buffer there.
2643 The function assumes BUFFER's major mode is `org-mode'."
2647 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2648 ;; already in BUFFER.
2650 ;; Copy specific buffer local variables and variables set
2651 ;; through BIND keywords.
2653 vars)
2661 buffer-file-name
2662 buffer-file-coding-system))
2666 ;; Skip unreadable values, as they cannot be
2667 ;; sent to external process.
2671 vars))))))
2672 ;; Whole buffer contents.
2677 ;; Narrowing.
2681 ;; Current position of point.
2683 ;; Overlays with invisible property.
2692 ov-set)))))))))
2695 "Delete commented trees and commented inlinetasks in the buffer.
2696 Narrowing, if any, is ignored."
2708 "Prune non exportable elements from DATA.
2709 DATA is the parse tree to traverse. INFO is the plist holding
2710 export info. Also set `:ignore-list' in INFO to a list of
2711 objects which should be ignored during export, but not removed
2712 from tree."
2714 ;; First find trees containing a select tag, if any.
2718 ;; Prune non-exportable elements and objects from tree.
2719 ;; As a special case, special rows and cells from tables
2720 ;; are stored in IGNORE, as they still need to be
2721 ;; accessed during export.
2731 ;; If headline is archived but tree below has
2732 ;; to be skipped, remove contents.
2734 ;; Move into recursive objects/elements.
2736 ;; Move into secondary string, if any.
2738 org-element-secondary-value-alist)))
2741 ;; Collect definitions before possibly pruning them so as
2742 ;; to avoid parsing them again if they are required.
2751 #'org-element-create
2754 ;; If a select tag is active, also ignore the section before the
2755 ;; first headline, if any.
2760 ;; Prune tree and communication channel.
2763 ;; Priority is given to back-end specific options.
2765 org-export-options-alist))
2771 ;; Eventually set `:ignore-list'.
2775 "List footnote definitions missing from TREE.
2776 Missing definitions are searched within DEFINITIONS, which is
2777 a list of footnote definitions or in the widened buffer."
2780 ;; List all footnote labels encountered in DATA. Inline
2781 ;; footnote references are ignored.
2786 defined undefined missing-definitions)
2787 ;; Partition DIRECT-REFERENCES between DEFINED and UNDEFINED
2788 ;; references.
2795 seen)
2800 ;; Complete MISSING-DEFINITIONS by finding the definition of every
2801 ;; undefined label, first by looking into DEFINITIONS, then by
2802 ;; searching the widened buffer. This is a recursive process
2803 ;; since definitions found can themselves contain an undefined
2804 ;; reference.
2811 d))
2812 definitions))
2819 datum
2820 ;; Parse definition with contents.
2831 ;; Look for footnote references within DEFINITION, since
2832 ;; we may need to also find their definition.
2837 ;; MISSING-DEFINITIONS may contain footnote references with inline
2838 ;; definitions. Make sure those are changed into real footnote
2839 ;; definitions.
2846 missing-definitions)))
2849 "Install footnote definitions in tree.
2851 DEFINITIONS is the list of footnote definitions to install. TREE
2852 is the parse tree.
2854 If there is a footnote section in TREE, definitions found are
2855 appended to it. If `org-footnote-section' is non-nil, a new
2856 footnote section containing all definitions is inserted in TREE.
2857 Otherwise, definitions are appended at the end of the section
2858 containing their first reference."
2861 ;; If there is a footnote section, insert definitions there.
2865 nil t)))
2868 footnote-section
2870 ;; If there should be a footnote section, create one containing all
2871 ;; the definitions at the end of the tree.
2874 tree
2878 :title org-footnote-section
2881 'section
2882 nil
2884 ;; Otherwise add each definition at the end of the section where it
2885 ;; is first referenced.
2890 ;; Insert footnote definitions in the same section as
2891 ;; their first reference in DATA.
2902 label)
2903 d))
2904 definitions)))
2907 definition)
2908 ;; Also insert definitions for nested
2909 ;; references, if any.
2914 "Change uninterpreted elements back into Org syntax.
2915 DATA is a parse tree or a secondary string. INFO is a plist
2916 containing export options. It is modified by side effect and
2917 returned by the function."
2920 subscript superscript underline)
2924 ;; ... entities...
2931 ?\s)))))
2932 ;; ... emphasis...
2944 marker
2948 ?\s)))))))
2949 ;; ... LaTeX environments and fragments...
2953 ;; ... sub/superscripts...
2962 "_"
2971 ?\s)))))))))))
2973 ;; Splice NEW at DATUM location in parse tree.
2976 info nil nil t)
2977 ;; Return modified parse tree.
2978 data)
2980 ;;;###autoload
2983 "Transcode current Org buffer into BACKEND code.
2985 BACKEND is either an export back-end, as returned by, e.g.,
2986 `org-export-create-backend', or a symbol referring to
2987 a registered back-end.
2989 If narrowing is active in the current buffer, only transcode its
2990 narrowed part.
2992 If a region is active, transcode that region.
2994 When optional argument SUBTREEP is non-nil, transcode the
2995 sub-tree at point, extracting information from the headline
2996 properties first.
2998 When optional argument VISIBLE-ONLY is non-nil, don't export
2999 contents of hidden elements.
3001 When optional argument BODY-ONLY is non-nil, only return body
3002 code, without surrounding template.
3004 Optional argument EXT-PLIST, when provided, is a property list
3005 with external parameters overriding Org default settings, but
3006 still inferior to file-local settings.
3008 Return code as a string."
3013 ;; Narrow buffer to an appropriate region or subtree for
3014 ;; parsing. If parsing subtree, be sure to remove main
3015 ;; headline, planning data and property drawer.
3023 ;; Initialize communication channel with original buffer
3024 ;; attributes, unavailable in its copy.
3028 backend subtreep visible-only body-only)
3034 org-export-options-alist))))
3035 tree)
3036 ;; Update communication channel and get parse tree. Buffer
3037 ;; isn't parsed directly. Instead, all buffer modifications
3038 ;; and consequent parsing are undertaken in a temporary copy.
3040 ;; Run first hook with current back-end's name as argument.
3043 ;; Include files, delete comments and expand macros.
3049 nil parsed-keywords)
3050 ;; Refresh buffer properties and radio targets after
3051 ;; potentially invasive previous changes. Likewise, do it
3052 ;; again after executing Babel code.
3059 ;; Run last hook with current back-end's name as argument.
3060 ;; Update buffer properties and radio targets one last time
3061 ;; before parsing.
3068 ;; Update communication channel with environment.
3072 ;; De-activate uninterpreted data from parsed keywords.
3074 org-export-options-alist))
3079 p
3082 ;; Install user's and developer's filters.
3084 ;; Call options filters and update export options. We do not
3085 ;; use `org-export-filter-apply-functions' here since the
3086 ;; arity of such filters is different.
3091 ;; Expand export-specific set of macros: {{{author}}},
3092 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
3093 ;; be done once regular macros have been expanded, since
3094 ;; parsed keywords may contain one of them.
3107 value)
3108 value)))
3112 'finalize
3113 parsed-keywords)
3114 ;; Parse buffer.
3116 ;; Prune tree from non-exported elements and transform
3117 ;; uninterpreted elements or objects in both parse tree and
3118 ;; communication channel.
3121 ;; Call parse tree filters.
3125 ;; Now tree is complete, compute its properties and add them
3126 ;; to communication channel.
3128 ;; Eventually transcode TREE. Wrap the resulting string into
3129 ;; a template.
3138 info))
3141 ;; Remove all text properties since they cannot be
3142 ;; retrieved from an external process. Finally call
3143 ;; final-output filter and return result.
3149 info))))))))
3151 ;;;###autoload
3153 "Transcode STRING into BACKEND code.
3155 BACKEND is either an export back-end, as returned by, e.g.,
3156 `org-export-create-backend', or a symbol referring to
3157 a registered back-end.
3159 When optional argument BODY-ONLY is non-nil, only return body
3160 code, without preamble nor postamble.
3162 Optional argument EXT-PLIST, when provided, is a property list
3163 with external parameters overriding Org default settings, but
3164 still inferior to file-local settings.
3166 Return code as a string."
3172 ;;;###autoload
3174 "Replace the active region by its export to BACKEND.
3175 BACKEND is either an export back-end, as returned by, e.g.,
3176 `org-export-create-backend', or a symbol referring to
3177 a registered back-end."
3183 ;;;###autoload
3185 "Insert all export keywords with default values at beginning of line.
3187 BACKEND is a symbol referring to the name of a registered export
3188 back-end, for which specific export options should be added to
3189 the template, or `default' for default template. When it is nil,
3190 the user will be prompted for a category.
3192 If SUBTREEP is non-nil, export configuration will be set up
3193 locally for the subtree through node properties."
3203 "Options category: "
3207 org-export-registered-backends))
3208 nil t))))
3209 options keywords)
3210 ;; Populate OPTIONS and KEYWORDS.
3227 ;; Move to an appropriate location in order to insert options.
3229 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3247 ;; Then the rest of keywords, in the order specified in either
3248 ;; `org-export-options-alist' or respective export back-ends.
3269 "Expand every include keyword in buffer.
3270 Optional argument INCLUDED is a list of included file names along
3271 with their line restriction, when appropriate. It is used to
3272 avoid infinite recursion. Optional argument DIR is the current
3273 working directory. It is used to properly resolve relative
3274 paths. Optional argument FOOTNOTES is a hash-table used for
3275 storing and resolving footnotes. It is created automatically."
3281 ;; If :minlevel is not set the text-property
3282 ;; `:org-include-induced-level' will be used to determine the
3283 ;; relative level when expanding INCLUDE.
3284 ;; Only affects included Org documents.
3288 :org-include-induced-level
3290 ;; Expand INCLUDE keywords.
3297 ;; Extract arguments from keyword's value.
3300 location
3308 matched)
3314 dir)))
3318 value)
3324 value)
3333 ;; Minimal level of included file defaults to the
3334 ;; child level of the current headline, if any, or
3335 ;; one. It only applies is the file is meant to be
3336 ;; included as an Org one.
3347 ;; Remove keyword.
3353 ;; Check if files has already been parsed. Look after
3354 ;; inclusion lines too, as different parts of the same
3355 ;; file can be included too.
3368 ind-str block arg-str contents ind-str block))))
3375 ind-str block contents ind-str block))))
3383 file location only-contents lines)
3384 lines)))
3388 file lines ind minlevel
3392 footnotes)))
3396 footnotes)
3398 ;; Expand footnotes after all files have been
3399 ;; included. Footnotes are stored at end of buffer.
3405 footnotes))))))))))))
3408 "Resolve absolute lines for an included file with file-link.
3410 FILE is string file-name of the file to include. LOCATION is a
3411 string name within FILE to be included (located via
3412 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3413 contents of the named element will be included, as determined
3414 Org-Element. If LINES is non-nil only those lines are included.
3416 Return a string of lines to be included in the format expected by
3417 `org-export--prepare-file-contents'."
3423 ;; Enforce consistent search.
3436 ;; Skip planning line and property-drawer.
3462 start-line
3464 (+ start-line
3467 counter))))))))
3471 "Prepare contents of FILE for inclusion and return it as a string.
3473 When optional argument LINES is a string specifying a range of
3474 lines, include only those lines.
3476 Optional argument IND, when non-nil, is an integer specifying the
3477 global indentation of returned contents. Since its purpose is to
3478 allow an included file to stay in the same environment it was
3479 created (e.g., a list item), it doesn't apply past the first
3480 headline encountered.
3482 Optional argument MINLEVEL, when non-nil, is an integer
3483 specifying the level that any top-level headline in the included
3484 file should have.
3486 Optional argument ID is an integer that will be inserted before
3487 each footnote definition and reference if FILE is an Org file.
3488 This is useful to avoid conflicts when more than one Org file
3489 with footnotes is included in a document.
3491 Optional argument FOOTNOTES is a hash-table to store footnotes in
3492 the included document."
3508 ;; Remove blank lines at beginning and end of contents. The logic
3509 ;; behind that removal is that blank lines around include keyword
3510 ;; override blank lines in included file.
3519 ;; If IND is set, preserve indentation of include keyword until
3520 ;; the first headline encountered.
3527 ;; Do not move footnote definitions out of column 0.
3533 ;; When MINLEVEL is specified, compute minimal level for headlines
3534 ;; in the file (CUR-MIN), and remove stars to each headline so
3535 ;; that headlines with minimal level have a level of MINLEVEL.
3546 ;; Only change stars, don't bother moving whole
3547 ;; sections.
3552 ;; Append ID to all footnote references and definitions, so they
3553 ;; become file specific and cannot collide with footnotes in other
3554 ;; included files. Further, collect relevant footnote definitions
3555 ;; outside of LINES, in order to reintroduce them later.
3561 ;; Generate new label from LABEL by prefixing it with
3562 ;; "-ID-".
3566 ;; Replace OLD label with NEW in footnote F.
3580 ;; Update the footnote-reference at point and collect
3581 ;; the new label, which is only used for footnotes
3582 ;; outsides LINES.
3594 ;; Store since footnote-definition is
3595 ;; outside of LINES.
3598 footnotes))))
3605 "Return a non-nil value when output should be added to the kill ring.
3606 See also `org-export-copy-to-kill-ring'."
3612 \f
3613 ;;; Tools For Back-Ends
3614 ;;
3615 ;; A whole set of tools is available to help build new exporters. Any
3616 ;; function general enough to have its use across many back-ends
3617 ;; should be added here.
3619 ;;;; For Affiliated Keywords
3620 ;;
3621 ;; `org-export-read-attribute' reads a property from a given element
3622 ;; as a plist. It can be used to normalize affiliated keywords'
3623 ;; syntax.
3624 ;;
3625 ;; Since captions can span over multiple lines and accept dual values,
3626 ;; their internal representation is a bit tricky. Therefore,
3627 ;; `org-export-get-caption' transparently returns a given element's
3628 ;; caption as a secondary string.
3631 "Turn ATTRIBUTE property from ELEMENT into a plist.
3633 When optional argument PROPERTY is non-nil, return the value of
3634 that property within attributes.
3638 properties.
3640 All values will become strings except the empty string and
3643 will become the empty string."
3657 s)
3662 ;; Ignore any string before first property with `cdr'.
3667 "Return caption from ELEMENT as a secondary string.
3669 When optional argument SHORTP is non-nil, return short caption,
3670 as a secondary string, instead.
3672 Caption lines are separated by a white space."
3680 ;;;; For Derived Back-ends
3681 ;;
3682 ;; `org-export-with-backend' is a function allowing to locally use
3683 ;; another back-end to transcode some object or element. In a derived
3684 ;; back-end, it may be used as a fall-back function once all specific
3685 ;; cases have been treated.
3688 "Call a transcoder from BACKEND on DATA.
3689 BACKEND is an export back-end, as returned by, e.g.,
3690 `org-export-create-backend', or a symbol referring to
3691 a registered back-end. DATA is an Org element, object, secondary
3692 string or string. CONTENTS, when non-nil, is the transcoded
3693 contents of DATA element, as a string. INFO, when non-nil, is
3694 the communication channel used for export, as a plist."
3705 :back-end backend
3706 :translate-alist all-transcoders
3708 ;; `:internal-references' are shared across back-ends.
3714 ;;;; For Export Snippets
3715 ;;
3716 ;; Every export snippet is transmitted to the back-end. Though, the
3717 ;; latter will only retain one type of export-snippet, ignoring
3718 ;; others, based on the former's target back-end. The function
3719 ;; `org-export-snippet-backend' returns that back-end for a given
3720 ;; export-snippet.
3723 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3724 Translation, with `org-export-snippet-translation-alist', is
3725 applied."
3729 back-end))))
3732 ;;;; For Footnotes
3733 ;;
3734 ;; `org-export-collect-footnote-definitions' is a tool to list
3735 ;; actually used footnotes definitions in the whole parse tree, or in
3736 ;; a headline, in order to add footnote listings throughout the
3737 ;; transcoded data.
3738 ;;
3739 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3740 ;; back-ends, when they need to attach the footnote definition only to
3741 ;; the first occurrence of the corresponding label.
3742 ;;
3743 ;; `org-export-get-footnote-definition' and
3744 ;; `org-export-get-footnote-number' provide easier access to
3745 ;; additional information relative to a footnote reference.
3748 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3749 INFO is the plist used as a communication channel. If no such
3750 definition can be found, raise an error."
3756 hash))))
3764 ;; Skip any footnote with a different label.
3765 ;; Also skip any standard footnote reference
3766 ;; with the same label since those cannot
3767 ;; contain a definition.
3771 ;; Even if the contents are empty, we can not
3772 ;; return nil since that would eventually raise
3773 ;; the error. Instead, return the equivalent
3774 ;; empty string.
3776 info t)
3777 cache)
3782 "Apply FUNCTION on every footnote reference in DATA.
3783 INFO is a plist containing export state. By default, as soon as
3784 a new footnote reference is encountered, FUNCTION is called onto
3785 its definition. However, if BODY-FIRST is non-nil, this step is
3786 delayed until the end of the process."
3791 ;; Search footnote references through DATA, filling
3792 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3793 ;; store footnote definitions so they can be entered
3794 ;; later.
3801 ;; Search for subsequent references in footnote
3802 ;; definition so numbering follows reading
3803 ;; logic, unless DELAYP in non-nil.
3807 definitions))
3808 ;; Do not force entering inline definitions,
3809 ;; since `org-element-map' already traverses
3810 ;; them at the right time.
3814 nil))))))
3815 info nil
3816 ;; Don't enter footnote definitions since it will
3817 ;; happen when their first reference is found.
3818 ;; Moreover, if DELAYP is non-nil, make sure we
3819 ;; postpone entering definitions of inline references.
3826 "Return an alist between footnote numbers, labels and definitions.
3828 INFO is the current export state, as a plist.
3830 Definitions are collected throughout the whole parse tree, or
3831 DATA when non-nil.
3833 Sorting is done by order of references. As soon as a new
3834 reference is encountered, other references are searched within
3835 its definition. However, if BODY-FIRST is non-nil, this step is
3836 delayed after the whole tree is checked. This alters results
3837 when references are found in footnote definitions.
3839 Definitions either appear as Org data or as a secondary string
3840 for inlined footnotes. Unreferenced definitions are ignored."
3844 ;; Collect footnote number, label and definition.
3855 "Non-nil when a footnote reference is the first one for its label.
3857 FOOTNOTE-REFERENCE is the footnote reference being considered.
3858 INFO is a plist containing current export state.
3860 Search is done throughout the whole parse tree, or DATA when
3861 non-nil.
3863 By default, as soon as a new footnote reference is encountered,
3864 other references are searched within its definition. However, if
3865 BODY-FIRST is non-nil, this step is delayed after the whole tree
3866 is checked. This alters results when references are found in
3867 footnote definitions."
3869 ;; Anonymous footnotes are always a first reference.
3880 "Return number associated to a footnote.
3882 FOOTNOTE is either a footnote reference or a footnote definition.
3883 INFO is the plist containing export state.
3885 Number is unique throughout the whole parse tree, or DATA, when
3886 non-nil.
3888 By default, as soon as a new footnote reference is encountered,
3889 counting process moves into its definition. However, if
3890 BODY-FIRST is non-nil, this step is delayed until the end of the
3891 process, leading to a different order when footnotes are nested."
3900 ;; Anonymous footnote match: return number.
3902 ;; Labels match: return number.
3904 ;; Otherwise store label and increase counter if label
3905 ;; wasn't encountered yet.
3911 ;;;; For Headlines
3912 ;;
3913 ;; `org-export-get-relative-level' is a shortcut to get headline
3914 ;; level, relatively to the lower headline level in the parsed tree.
3915 ;;
3916 ;; `org-export-get-headline-number' returns the section number of an
3917 ;; headline, while `org-export-number-to-roman' allows it to be
3918 ;; converted to roman numbers. With an optional argument,
3919 ;; `org-export-get-headline-number' returns a number to unnumbered
3920 ;; headlines (used for internal id).
3921 ;;
3922 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3923 ;; `org-export-last-sibling-p' are three useful predicates when it
3924 ;; comes to fulfill the `:headline-levels' property.
3925 ;;
3926 ;; `org-export-get-tags', `org-export-get-category' and
3927 ;; `org-export-get-node-property' extract useful information from an
3928 ;; headline or a parent headline. They all handle inheritance.
3929 ;;
3930 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3931 ;; as a secondary string, suitable for table of contents. It falls
3932 ;; back onto default title.
3935 "Return HEADLINE relative level within current parsed tree.
3936 INFO is a plist holding contextual information."
3941 "Non-nil when HEADLINE is considered as low level.
3943 INFO is a plist used as a communication channel.
3945 A low level headlines has a relative level greater than
3946 `:headline-levels' property value.
3948 Return value is the difference between HEADLINE relative level
3949 and the last level being considered as high enough, or nil."
3956 "Return numbered HEADLINE numbering as a list of numbers.
3957 INFO is a plist holding contextual information."
3962 "Return a non-nil value if HEADLINE element should be numbered.
3963 INFO is a plist used as a communication channel."
3972 "Convert integer N into a roman numeral."
3985 res)))
3988 "Return list of tags associated to ELEMENT.
3990 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3991 is a plist used as a communication channel.
3993 When non-nil, optional argument TAGS should be a list of strings.
3994 Any tag belonging to this list will also be removed.
3996 When optional argument INHERITED is non-nil, tags can also be
3997 inherited from parent headlines and FILETAGS keywords."
4001 ;; Build complete list of inherited tags.
4008 ;; Add FILETAGS keywords and return results.
4012 "Return node PROPERTY value for BLOB.
4014 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
4015 element or object.
4017 If optional argument INHERITED is non-nil, the value can be
4018 inherited from a parent headline.
4020 Return value is a string or nil."
4032 "Return category for element or object BLOB.
4034 INFO is a plist used as a communication channel.
4036 CATEGORY is automatically inherited from a parent headline, from
4037 #+CATEGORY: keyword or created out of original file name. If all
4050 "Return alternative title for HEADLINE, as a secondary string.
4051 If no optional title is defined, fall-back to the regular title."
4058 "Non-nil when BLOB is the first sibling in its parent.
4059 BLOB is an element or an object. If BLOB is a headline, non-nil
4060 means it is the first sibling in the sub-tree. INFO is a plist
4061 used as a communication channel."
4066 "Non-nil when BLOB is the last sibling in its parent.
4067 BLOB is an element or an object. INFO is a plist used as
4068 a communication channel."
4072 ;;;; For Keywords
4073 ;;
4074 ;; `org-export-get-date' returns a date appropriate for the document
4075 ;; to about to be exported. In particular, it takes care of
4076 ;; `org-export-date-timestamp-format'.
4079 "Return date value for the current document.
4081 INFO is a plist used as a communication channel. FMT, when
4082 non-nil, is a time format string that will be applied on the date
4083 if it consists in a single timestamp object. It defaults to
4084 `org-export-date-timestamp-format' when nil.
4086 A proper date can be a secondary string, a string or nil. It is
4087 meant to be translated with `org-export-data' or alike."
4098 ;;;; For Links
4099 ;;
4100 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4101 ;; in `org-link-parameters'.
4102 ;;
4103 ;; `org-export-get-coderef-format' returns an appropriate format
4104 ;; string for coderefs.
4105 ;;
4106 ;; `org-export-inline-image-p' returns a non-nil value when the link
4107 ;; provided should be considered as an inline image.
4108 ;;
4109 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4110 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4111 ;; returns an appropriate unique identifier.
4112 ;;
4113 ;; `org-export-resolve-id-link' returns the first headline with
4114 ;; specified id or custom-id in parse tree, the path to the external
4115 ;; file with the id.
4116 ;;
4117 ;; `org-export-resolve-coderef' associates a reference to a line
4118 ;; number in the element it belongs, or returns the reference itself
4119 ;; when the element isn't numbered.
4120 ;;
4121 ;; `org-export-file-uri' expands a filename as stored in :path value
4122 ;; of a "file" link into a file URI.
4123 ;;
4124 ;; Broken links raise a `org-link-broken' error, which is caught by
4125 ;; `org-export-data' for further processing, depending on
4126 ;; `org-export-with-broken-links' value.
4131 "Try exporting LINK with a dedicated function.
4133 DESC is its description, as a string, or nil. BACKEND is the
4134 back-end used for export, as a symbol.
4136 Return output as a string, or nil if no protocol handles LINK.
4138 A custom protocol has precedence over regular back-end export.
4139 The function ignores links with an implicit type (e.g.,
4148 desc
4149 backend))))))
4152 "Return format string for code reference link.
4153 PATH is the link path. DESC is its description."
4161 "Non-nil if LINK object points to an inline image.
4163 Optional argument is a set of RULES defining inline images. It
4164 is an alist where associations have the following shape:
4166 (TYPE . REGEXP)
4168 Applying a rule means apply REGEXP against LINK's path when its
4169 type is TYPE. The function will return a non-nil value if any of
4170 the provided rules is non-nil. The default rule is
4171 `org-export-default-inline-image-rule'.
4173 This only applies to links without a description."
4183 "Insert image links in DATA.
4185 Org syntax does not support nested links. Nevertheless, some
4186 export back-ends support images as descriptions of links. Since
4187 images are really links to image files, we need to make an
4188 exception about links nesting.
4190 This function recognizes links whose contents are really images
4191 and turn them into proper nested links. It is meant to be used
4192 as a parse tree filter in back-ends supporting such constructs.
4194 DATA is a parse tree. INFO is the current state of the export
4195 process, as a plist.
4197 A description is a valid images if it matches any rule in RULES,
4198 if non-nil, or `org-export-default-inline-image-rule' otherwise.
4199 See `org-export-inline-image-p' for more information about the
4200 structure of RULES.
4202 Return modified DATA."
4204 org-plain-link-re
4205 org-angle-link-re))
4218 ;; Replace contents with image link.
4224 info nil nil t))
4225 data)
4228 "Resolve a code reference REF.
4230 INFO is a plist used as a communication channel.
4232 Return associated line number in source code, or REF itself,
4233 depending on src-block or example element's switches. Throw an
4234 error if no block contains REF."
4240 org-coderef-label-format))
4242 ;; Element containing REF is found. Resolve it to
4243 ;; either a label or a line number, as needed.
4252 "List search cells for element or object DATUM.
4254 A search cell follows the pattern (TYPE . SEARCH) where
4256 TYPE is a symbol among `headline', `custom-id', `target' and
4257 `other'.
4259 SEARCH is the string a link is expected to match. More
4260 accurately, it is
4262 - headline's title, as a list of strings, if TYPE is
4263 `headline'.
4265 - CUSTOM_ID value, as a string, if TYPE is `custom-id'.
4267 - target's or radio-target's name as a list of strings if
4268 TYPE is `target'.
4270 - NAME affiliated keyword is TYPE is `other'.
4272 A search cell is the internal representation of a fuzzy link. It
4273 ignores white spaces and statistics cookies, if applicable."
4275 (`headline
4286 (`target
4294 "Return search cells associated to string S.
4295 S is either the path of a fuzzy link or a search option, i.e., it
4296 tries to match either a headline (through custom ID or title),
4297 a target or a named element."
4305 "Non-nil when DATUM matches search cells CELLS.
4306 DATUM is an element or object. CELLS is a list of search cells,
4307 as returned by `org-export-search-cells'."
4312 "Return LINK destination.
4314 INFO is a plist holding contextual information.
4316 Return value can be an object or an element:
4318 - If LINK path matches a target object (i.e. <<path>>) return it.
4320 - If LINK path exactly matches the name affiliated keyword
4321 (i.e. #+NAME: path) of an element, return that element.
4323 - If LINK path exactly matches any headline name, return that
4324 element.
4326 - Otherwise, throw an error.
4329 significant."
4335 table)))
4343 datum)))))
4347 search-cells
4348 ;; There can be multiple matches for un-typed searches, i.e.,
4349 ;; for searches not starting with # or *. In this case,
4350 ;; prioritize targets and names over headline titles.
4351 ;; Matching both a name and a target is not valid, and
4352 ;; therefore undefined.
4355 datum))
4356 matches)
4358 link-cache)))))
4361 "Return headline referenced as LINK destination.
4363 INFO is a plist used as a communication channel.
4365 Return value can be the headline element matched in current parse
4369 ;; First check if id is within the current parse tree.
4374 headline))
4376 ;; Otherwise, look for external files.
4381 "Return radio-target object referenced as LINK destination.
4383 INFO is a plist used as a communication channel.
4385 Return value can be a radio-target object or nil. Assume LINK
4394 nil nil path nil nil t)
4395 t)
4396 radio))
4400 "Return file URI associated to FILENAME."
4407 fullname)))))
4409 ;;;; For References
4410 ;;
4411 ;; `org-export-get-reference' associate a unique reference for any
4412 ;; object or element. It uses `org-export-new-reference' and
4413 ;; `org-export-format-reference' to, respectively, generate new
4414 ;; internal references and turn them into a string suitable for
4415 ;; output.
4416 ;;
4417 ;; `org-export-get-ordinal' associates a sequence number to any object
4418 ;; or element.
4421 "Return a unique reference, among REFERENCES.
4422 REFERENCES is an alist whose values are in-use references, as
4423 numbers. Returns a number, which is the internal representation
4424 of a reference. See also `org-export-format-reference'."
4425 ;; Generate random 7 digits hexadecimal numbers. Collisions
4426 ;; increase exponentially with the numbers of references. However,
4427 ;; the odds for encountering at least one collision with 1000 active
4428 ;; references in the same document are roughly 0.2%, so this
4429 ;; shouldn't be the bottleneck.
4432 new))
4435 "Format REFERENCE into a string.
4436 REFERENCE is a number representing a reference, as returned by
4437 `org-export-new-reference', which see."
4441 "Return a unique reference for DATUM, as a string.
4443 DATUM is either an element or an object. INFO is the current
4444 export state, as a plist.
4446 This function checks `:crossrefs' property in INFO for search
4447 cells matching DATUM before creating a new reference. Returned
4448 reference consists of alphanumeric characters only."
4453 ;; Preserve any pre-existing association between
4454 ;; a search cell and a reference, i.e., when some
4455 ;; previously published document referenced a location
4456 ;; within current file (see
4457 ;; `org-publish-resolve-external-link').
4458 ;;
4459 ;; However, there is no guarantee that search cells are
4460 ;; unique, e.g., there might be duplicate custom ID or
4461 ;; two headings with the same title in the file.
4462 ;;
4463 ;; As a consequence, before re-using any reference to
4464 ;; an element or object, we check that it doesn't refer
4465 ;; to a previous element or object.
4472 cells)
4475 ;; Cache contains both data already associated to
4476 ;; a reference and in-use internal references, so as to make
4477 ;; unique references.
4479 ;; Retain a direct association between reference string and
4480 ;; DATUM since (1) not every object or element can be given
4481 ;; a search cell (2) it permits quick lookup.
4484 reference-string))))
4487 "Return ordinal number of an element or object.
4489 ELEMENT is the element or object considered. INFO is the plist
4490 used as a communication channel.
4492 Optional argument TYPES, when non-nil, is a list of element or
4493 object types, as symbols, that should also be counted in.
4494 Otherwise, only provided element's type is considered.
4496 Optional argument PREDICATE is a function returning a non-nil
4497 value if the current element or object should be counted in. It
4498 accepts two arguments: the element or object being considered and
4499 the plist used as a communication channel. This allows counting
4500 only a certain type of object (i.e. inline images).
4502 Return value is a list of numbers if ELEMENT is a headline or an
4503 item. It is nil for keywords. It represents the footnote number
4504 for footnote definitions and footnote references. If ELEMENT is
4505 a target, return the same value as if ELEMENT was the closest
4506 table, item or headline containing the target. In any other
4507 case, return the sequence number of ELEMENT among elements or
4508 objects of the same type."
4509 ;; Ordinal of a target object refer to the ordinal of the closest
4510 ;; table, item, or headline containing the object.
4514 element
4517 ;; Special case 1: A headline returns its number as a list.
4519 ;; Special case 2: An item returns its number as a list.
4523 struct
4530 ;; Increment counter until ELEMENT is found again.
4541 ;;;; For Src-Blocks
4542 ;;
4543 ;; `org-export-get-loc' counts number of code lines accumulated in
4544 ;; src-block or example-block elements with a "+n" switch until
4545 ;; a given element, excluded. Note: "-n" switches reset that count.
4546 ;;
4547 ;; `org-export-unravel-code' extracts source code (along with a code
4548 ;; references alist) from an `element-block' or `src-block' type
4549 ;; element.
4550 ;;
4551 ;; `org-export-format-code' applies a formatting function to each line
4552 ;; of code, providing relative line number and code reference when
4553 ;; appropriate. Since it doesn't access the original element from
4554 ;; which the source code is coming, it expects from the code calling
4555 ;; it to know if lines should be numbered and if code references
4556 ;; should appear.
4557 ;;
4558 ;; Eventually, `org-export-format-code-default' is a higher-level
4559 ;; function (it makes use of the two previous functions) which handles
4560 ;; line numbering and code references inclusion, and returns source
4561 ;; code in a format suitable for plain text or verbatim output.
4564 "Return count of lines of code before ELEMENT.
4566 ELEMENT is an example-block or src-block element. INFO is the
4567 plist used as a communication channel.
4569 Count includes every line of code in example-block or src-block
4571 ELEMENT doesn't allow line numbering."
4578 ;; ELEMENT is reached: Quit loop and return locs.
4580 ;; Only count lines from src-block and example-block
4581 ;; elements with a "+n" or "-n" switch.
4586 ;; Accumulate locs or reset them.
4594 "Clean source code and extract references out of it.
4596 ELEMENT has either a `src-block' an `example-block' type.
4598 Return a cons cell whose CAR is the source code, cleaned from any
4599 reference, protective commas and spurious indentation, and CDR is
4600 an alist between relative line number (integer) and name of code
4601 reference on that line (string)."
4604 ;; Remove global indentation from code, if necessary. Also
4605 ;; remove final newline character, since it doesn't belongs
4606 ;; to the code proper.
4611 value
4613 ;; Build a regexp matching a loc with a reference.
4615 ;; Return value.
4617 ;; Code with references removed.
4622 ;; Ref line: remove ref, and add its position in REFS.
4626 ;; Reference alist.
4627 refs)))
4630 "Format CODE by applying FUN line-wise and return it.
4632 CODE is a string representing the code to format. FUN is
4633 a function. It must accept three arguments: a line of
4634 code (string), the current line number (integer) or nil and the
4635 reference associated to the current line (string) or nil.
4637 Optional argument NUM-LINES can be an integer representing the
4638 number of code lines accumulated until the current code. Line
4639 numbers passed to FUN will take it into account. If it is nil,
4640 FUN's second argument will always be nil. This number can be
4641 obtained with `org-export-get-loc' function.
4643 Optional argument REF-ALIST can be an alist between relative line
4644 number (i.e. ignoring NUM-LINES) and the name of the code
4645 reference on it. If it is nil, FUN's third argument will always
4646 be nil. It can be obtained through the use of
4647 `org-export-unravel-code' function."
4660 "Return source code from ELEMENT, formatted in a standard way.
4662 ELEMENT is either a `src-block' or `example-block' element. INFO
4663 is a plist used as a communication channel.
4665 This function takes care of line numbering and code references
4666 inclusion. Line numbers, when applicable, appear at the
4667 beginning of the line, separated from the code by two white
4668 spaces. Code references, on the other hand, appear flushed to
4669 the right, separated by six white spaces from the widest line of
4670 code."
4671 ;; Extract code and references.
4678 ;; Handle line numbering.
4685 ;; Prepare references display, if required. Any reference
4686 ;; should start six columns after the widest line of code,
4687 ;; wrapped with parenthesis.
4692 code
4696 number-str
4697 loc
4701 ?\s)
4703 num-start refs)))))
4706 ;;;; For Tables
4707 ;;
4708 ;; `org-export-table-has-special-column-p' and and
4709 ;; `org-export-table-row-is-special-p' are predicates used to look for
4710 ;; meta-information about the table structure.
4711 ;;
4712 ;; `org-table-has-header-p' tells when the rows before the first rule
4713 ;; should be considered as table's header.
4714 ;;
4715 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4716 ;; and `org-export-table-cell-borders' extract information from
4717 ;; a table-cell element.
4718 ;;
4719 ;; `org-export-table-dimensions' gives the number on rows and columns
4720 ;; in the table, ignoring horizontal rules and special columns.
4721 ;; `org-export-table-cell-address', given a table-cell object, returns
4722 ;; the absolute address of a cell. On the other hand,
4723 ;; `org-export-get-table-cell-at' does the contrary.
4724 ;;
4725 ;; `org-export-table-cell-starts-colgroup-p',
4726 ;; `org-export-table-cell-ends-colgroup-p',
4727 ;; `org-export-table-row-starts-rowgroup-p',
4728 ;; `org-export-table-row-ends-rowgroup-p',
4729 ;; `org-export-table-row-starts-header-p',
4730 ;; `org-export-table-row-ends-header-p' and
4731 ;; `org-export-table-row-in-header-p' indicate position of current row
4732 ;; or cell within the table.
4735 "Non-nil when TABLE has a special column.
4736 All special columns will be ignored during export."
4737 ;; The table has a special column when every first cell of every row
4738 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4739 ;; "*" "_" and "^". Though, do not consider a first column
4740 ;; containing only empty cells as special.
4755 "Non-nil when TABLE has a header.
4757 INFO is a plist used as a communication channel.
4759 A table has a header when it contains at least two row groups."
4763 table)))
4779 nil)))
4781 cache)))))
4784 "Non-nil if TABLE-ROW is considered special.
4785 All special rows will be ignored during export."
4789 ;; A row is special either when...
4791 ;; ... it starts with a field only containing "/",
4793 ;; ... the table contains a special column and the row start
4794 ;; with a marking character among, "^", "_", "$" or "!",
4798 ;; ... it contains only alignment cookies and empty cells.
4803 ;; Since VALUE is a secondary string, the following
4804 ;; checks avoid expanding it with `org-export-data'.
4815 "Return TABLE-ROW's group number, as an integer.
4817 INFO is a plist used as the communication channel.
4819 Return value is the group number, as an integer, or nil for
4820 special rows and rows separators. First group is also table's
4821 header."
4826 table)))
4829 ;; First time a row is queried, populate cache with all the
4830 ;; rows from the table.
4838 info))
4842 "Return TABLE-CELL contents width.
4844 INFO is a plist used as the communication channel.
4846 Return value is the width given by the last width cookie in the
4847 same column as TABLE-CELL, or nil."
4856 table)))
4865 ;; In a special row, try to find a width cookie at COLUMN.
4869 ;; The following checks avoid expanding unnecessarily
4870 ;; the cell with `org-export-data'.
4880 "Return TABLE-CELL contents alignment.
4882 INFO is a plist used as the communication channel.
4884 Return alignment as specified by the last alignment cookie in the
4885 same column as TABLE-CELL. If no such cookie is found, a default
4886 alignment value will be deduced from fraction of numbers in the
4887 column (see `org-table-number-fraction' for more information).
4888 Possible values are `left', `right' and `center'."
4889 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4899 table)))
4905 cookie-align
4906 previous-cell-number-p)
4909 ;; In a special row, try to find an alignment cookie at
4910 ;; COLUMN.
4914 ;; Since VALUE is a secondary string, the following
4915 ;; checks avoid useless expansion through
4916 ;; `org-export-data'.
4924 ;; Ignore table rules.
4926 ;; In a standard row, check if cell's contents are
4927 ;; expressing some kind of number. Increase NUMBER-CELLS
4928 ;; accordingly. Though, don't bother if an alignment
4929 ;; cookie has already defined cell's alignment.
4934 info)))
4936 ;; Treat an empty cell as a number if it follows
4937 ;; a number.
4943 ;; Return value. Alignment specified by cookies has
4944 ;; precedence over alignment deduced from cell's contents.
4946 column
4951 org-table-number-fraction)
4956 "Return TABLE-CELL borders.
4958 INFO is a plist used as a communication channel.
4960 Return value is a list of symbols, or nil. Possible values are:
4961 `top', `bottom', `above', `below', `left' and `right'. Note:
4962 `top' (resp. `bottom') only happen for a cell in the first
4963 row (resp. last row) of the table, ignoring table rules, if any.
4965 Returned borders ignore special rows."
4968 borders)
4969 ;; Top/above border? TABLE-CELL has a border above when a rule
4970 ;; used to demarcate row groups can be found above. Hence,
4971 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4972 ;; another regular row has to be found above that rule.
4975 ;; Look at every row before the current one.
4982 ;; No rule above, or rule found starts the table (ignoring any
4983 ;; special row): TABLE-CELL is at the top of the table.
4986 ;; Bottom/below border? TABLE-CELL has a border below when next
4987 ;; non-regular row below is a rule.
4990 ;; Look at every row after the current one.
4997 ;; No rule below, or rule found ends the table (modulo some
4998 ;; special row): TABLE-CELL is at the bottom of the table.
5001 ;; Right/left borders? They can only be specified by column
5002 ;; groups. Column groups are defined in a row starting with "/".
5003 ;; Also a column groups row only contains "<", "<>", ">" or blank
5004 ;; cells.
5008 ;; Table rows are read in reverse order so last column groups
5009 ;; row has precedence over any previous one.
5022 ;; There's a left border when previous cell, if
5023 ;; any, ends a group, or current one starts one.
5029 ;; There's a right border when next cell, if any,
5030 ;; starts a group, or current one ends one.
5037 ;; Return value.
5038 borders))
5041 "Non-nil when TABLE-CELL is at the beginning of a column group.
5042 INFO is a plist used as a communication channel."
5043 ;; A cell starts a column group either when it is at the beginning
5044 ;; of a row (or after the special column, if any) or when it has
5045 ;; a left border.
5048 table-cell)
5052 "Non-nil when TABLE-CELL is at the end of a column group.
5053 INFO is a plist used as a communication channel."
5054 ;; A cell ends a column group either when it is at the end of a row
5055 ;; or when it has a right border.
5058 table-cell)
5062 "Non-nil when TABLE-ROW is at the beginning of a row group.
5063 INFO is a plist used as a communication channel."
5071 "Non-nil when TABLE-ROW is at the end of a row group.
5072 INFO is a plist used as a communication channel."
5080 "Non-nil when TABLE-ROW is located within table's header.
5081 INFO is a plist used as a communication channel. Always return
5082 nil for special rows and rows separators."
5088 "Non-nil when TABLE-ROW is the first table header's row.
5089 INFO is a plist used as a communication channel."
5094 "Non-nil when TABLE-ROW is the last table header's row.
5095 INFO is a plist used as a communication channel."
5100 "Return TABLE-ROW number.
5101 INFO is a plist used as a communication channel. Return value is
5102 zero-indexed and ignores separators. The function returns nil
5103 for special rows and separators."
5108 table)))
5111 ;; First time a row is queried, populate cache with all the
5112 ;; rows from the table.
5118 info))
5122 "Return TABLE dimensions.
5124 INFO is a plist used as a communication channel.
5126 Return value is a CONS like (ROWS . COLUMNS) where
5127 ROWS (resp. COLUMNS) is the number of exportable
5128 rows (resp. columns)."
5130 ;; Set number of rows, and extract first one.
5136 ;; Set number of columns.
5138 ;; Return value.
5142 "Return address of a regular TABLE-CELL object.
5144 TABLE-CELL is the cell considered. INFO is a plist used as
5145 a communication channel.
5147 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5148 zero-based index. Only exportable cells are considered. The
5149 function returns nil for other cells."
5161 "Return regular table-cell object at ADDRESS in TABLE.
5163 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5164 zero-based index. TABLE is a table type element. INFO is
5165 a plist used as a communication channel.
5167 If no table-cell, among exportable cells, is found at ADDRESS,
5168 return nil."
5171 ;; Row at (car address) or nil.
5179 'table-cell
5186 ;;;; For Tables Of Contents
5187 ;;
5188 ;; `org-export-collect-headlines' builds a list of all exportable
5189 ;; headline elements, maybe limited to a certain depth. One can then
5190 ;; easily parse it and transcode it.
5191 ;;
5192 ;; Building lists of tables, figures or listings is quite similar.
5193 ;; Once the generic function `org-export-collect-elements' is defined,
5194 ;; `org-export-collect-tables', `org-export-collect-figures' and
5195 ;; `org-export-collect-listings' can be derived from it.
5198 "Collect headlines in order to build a table of contents.
5200 INFO is a plist used as a communication channel.
5202 When optional argument N is an integer, it specifies the depth of
5203 the table of contents. Otherwise, it is set to the value of the
5204 last headline level. See `org-export-headline-levels' for more
5205 information.
5207 Optional argument SCOPE, when non-nil, is an element. If it is
5208 a headline, only children of SCOPE are collected. Otherwise,
5209 collect children of the headline containing provided element. If
5210 there is no such headline, collect all headlines. In any case,
5211 argument N becomes relative to the level of that headline.
5213 Return a list of all exportable headlines as parsed elements.
5214 Footnote sections are ignored."
5223 limit))))
5229 info)))
5232 "Collect referenceable elements of a determined type.
5234 TYPE can be a symbol or a list of symbols specifying element
5235 types to search. Only elements with a caption are collected.
5237 INFO is a plist used as a communication channel.
5239 When non-nil, optional argument PREDICATE is a function accepting
5240 one argument, an element of type TYPE. It returns a non-nil
5241 value when that element should be collected.
5243 Return a list of all elements found, in order of appearance."
5248 element))
5249 info))
5252 "Build a list of tables.
5253 INFO is a plist used as a communication channel.
5255 Return a list of table elements with a caption."
5259 "Build a list of figures.
5261 INFO is a plist used as a communication channel. PREDICATE is
5262 a function which accepts one argument: a paragraph element and
5263 whose return value is non-nil when that element should be
5264 collected.
5266 A figure is a paragraph type element, with a caption, verifying
5268 a vague concept that may depend on back-end.
5270 Return a list of elements recognized as figures."
5274 "Build a list of src blocks.
5276 INFO is a plist used as a communication channel.
5278 Return a list of src-block elements with a caption."
5282 ;;;; Smart Quotes
5283 ;;
5284 ;; The main function for the smart quotes sub-system is
5285 ;; `org-export-activate-smart-quotes', which replaces every quote in
5286 ;; a given string from the parse tree with its "smart" counterpart.
5287 ;;
5288 ;; Dictionary for smart quotes is stored in
5289 ;; `org-export-smart-quotes-alist'.
5305 ;; one may use: »...«, "...", ›...‹, or '...'.
5306 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5307 ;; LaTeX quotes require Babel!
5367 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5378 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5389 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5400 ;; 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
5401 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5412 ;; Based on https://sl.wikipedia.org/wiki/Narekovaj
5423 ;; Based on https://sv.wikipedia.org/wiki/Citattecken
5429 "Smart quotes translations.
5431 Alist whose CAR is a language string and CDR is an alist with
5432 quote type as key and a plist associating various encodings to
5433 their translation as value.
5435 A quote type can be any symbol among `primary-opening',
5436 `primary-closing', `secondary-opening', `secondary-closing' and
5437 `apostrophe'.
5439 Valid encodings include `:utf-8', `:html', `:latex' and
5440 `:texinfo'.
5445 "Return smart quote status at the beginning of string S.
5446 INFO is the current export state, as a plist."
5451 table)))
5459 'plain-text
5468 ;; Not already in a level 1 quote: this is an
5469 ;; apostrophe.
5471 ;; Extract previous char and next char. As
5472 ;; a special case, they can also be set to `blank',
5473 ;; `no-blank' or nil. Then determine if current
5474 ;; match is allowed as an opening quote or a closing
5475 ;; quote.
5480 text info)))
5497 previous)
5508 next)
5515 current-status)
5519 info nil org-element-recursive-objects)
5526 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5527 `:utf-8'. INFO is a plist used as a communication channel.
5529 The function has to retrieve information about string
5530 surroundings in parse tree. It can only happen with an
5531 unmodified string. Thus, if S has already been through another
5532 process, a non-nil ORIGINAL optional argument will provide that
5533 original string.
5535 Return the new string."
5544 org-export-smart-quotes-alist))))
5545 encoding)
5546 match))
5547 s nil t)))
5549 ;;;; Topology
5550 ;;
5551 ;; Here are various functions to retrieve information about the
5552 ;; neighborhood of a given element or object. Neighbors of interest
5553 ;; are direct parent (`org-export-get-parent'), parent headline
5554 ;; (`org-export-get-parent-headline'), first element containing an
5555 ;; object, (`org-export-get-parent-element'), parent table
5556 ;; (`org-export-get-parent-table'), previous element or object
5557 ;; (`org-export-get-previous-element') and next element or object
5558 ;; (`org-export-get-next-element').
5560 ;; defsubst org-export-get-parent must be defined before first use
5563 "Return BLOB parent headline or nil.
5564 BLOB is the element or object being considered."
5568 "Return first element containing OBJECT or nil.
5569 OBJECT is the object to consider."
5573 "Return OBJECT parent table or nil.
5574 OBJECT is either a `table-cell' or `table-element' type object."
5578 "Return previous element or object.
5580 BLOB is an element or object. INFO is a plist used as
5581 a communication channel. Return previous exportable element or
5582 object, a string, or nil.
5584 When optional argument N is a positive integer, return a list
5585 containing up to N siblings before BLOB, from farthest to
5586 closest. With any other non-nil value, return a list containing
5587 all of them."
5593 prev)
5603 "Return next element or object.
5605 BLOB is an element or object. INFO is a plist used as
5606 a communication channel. Return next exportable element or
5607 object, a string, or nil.
5609 When optional argument N is a positive integer, return a list
5610 containing up to N siblings after BLOB, from closest to farthest.
5611 With any other non-nil value, return a list containing all of
5612 them."
5619 next)
5629 ;;;; Translation
5630 ;;
5631 ;; `org-export-translate' translates a string according to the language
5632 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5633 ;; the dictionary used for the translation.
5668 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5680 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5686 ("ru" :html "(Продолжение следует)"
5774 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5799 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5805 ("ru" :html "Список распечаток"
5822 ("ru" :html "Список таблиц"
5957 ("ru" :html "Неизвестная ссылка"
5961 "Dictionary for export engine.
5963 Alist whose car is the string to translate and cdr is an alist
5964 whose car is the language string and cdr is a plist whose
5965 properties are possible charsets and values translated terms.
5967 It is used as a database for `org-export-translate'. Since this
5968 function returns the string as-is if no translation was found,
5969 the variable only needs to record values different from the
5973 "Translate string S according to language specification.
5975 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5976 and `:utf-8'. INFO is a plist used as a communication channel.
5978 Translation depends on `:language' property. Return the
5979 translated string. If no translation is found, try to fall back
5980 to `:default' encoding. If it fails, return S."
5986 s)))
5989 \f
5990 ;;; Asynchronous Export
5991 ;;
5992 ;; `org-export-async-start' is the entry point for asynchronous
5993 ;; export. It recreates current buffer (including visibility,
5994 ;; narrowing and visited file) in an external Emacs process, and
5995 ;; evaluates a command there. It then applies a function on the
5996 ;; returned results in the current process.
5997 ;;
5998 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5999 ;; allow exporting to a buffer or a file, asynchronously or not.
6000 ;;
6001 ;; `org-export-output-file-name' is an auxiliary function meant to be
6002 ;; used with `org-export-to-file'. With a given extension, it tries
6003 ;; to provide a canonical file name to write export output to.
6004 ;;
6005 ;; Asynchronously generated results are never displayed directly.
6006 ;; Instead, they are stored in `org-export-stack-contents'. They can
6007 ;; then be retrieved by calling `org-export-stack'.
6008 ;;
6009 ;; Export Stack is viewed through a dedicated major mode
6010 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
6011 ;;`org-export-stack-delete', `org-export-stack-view' and
6012 ;;`org-export-stack-clear'.
6013 ;;
6014 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
6015 ;; It should be used whenever `org-export-async-start' is called.
6018 "Call function FUN on the results returned by BODY evaluation.
6020 FUN is an anonymous function of one argument. BODY evaluation
6021 happens in an asynchronous process, from a buffer which is an
6022 exact copy of the current one.
6024 Use `org-export-add-to-stack' in FUN in order to register results
6025 in the stack.
6027 This is a low level function. See also `org-export-to-buffer'
6028 and `org-export-to-file' for more specialized functions."
6031 ;; Write the full sexp evaluating BODY in a copy of the current
6032 ;; buffer to a temporary file, as it may be too long for program
6033 ;; args in `start-process'.
6040 ;; Null characters (from variable values) are inserted
6041 ;; within the file. As a consequence, coding system for
6042 ;; buffer contents will not be recognized properly. So,
6043 ;; we make sure it is the same as the one used to display
6044 ;; the original buffer.
6046 ,coding
6049 ;; Ignore `kill-emacs-hook' and code evaluation
6050 ;; queries from Babel as we need a truly
6051 ;; non-interactive process.
6053 org-babel-confirm-evaluate-answer-no t)
6054 ;; Initialize export framework.
6056 ;; Re-create current buffer there.
6059 ;; Sexp to evaluate in the buffer.
6061 ;; Start external process.
6064 (,process
6066 #'start-process
6069 ,proc-buffer
6076 ;; Register running process in stack.
6078 ;; Set-up sentinel in order to catch results.
6081 ,process
6103 ;;;###autoload
6106 &optional async subtreep visible-only body-only ext-plist
6107 post-process)
6108 "Call `org-export-as' with output to a specified buffer.
6110 BACKEND is either an export back-end, as returned by, e.g.,
6111 `org-export-create-backend', or a symbol referring to
6112 a registered back-end.
6114 BUFFER is the name of the output buffer. If it already exists,
6115 it will be erased first, otherwise, it will be created.
6117 A non-nil optional argument ASYNC means the process should happen
6118 asynchronously. The resulting buffer should then be accessible
6119 through the `org-export-stack' interface. When ASYNC is nil, the
6120 buffer is displayed if `org-export-show-temporary-export-buffer'
6121 is non-nil.
6123 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6124 EXT-PLIST are similar to those used in `org-export-as', which
6125 see.
6127 Optional argument POST-PROCESS is a function which should accept
6128 no argument. It is always called within the current process,
6129 from BUFFER, with point at its beginning. Export back-ends can
6130 use it to set a major mode there, e.g,
6132 (defun org-latex-export-as-latex
6133 (&optional async subtreep visible-only body-only ext-plist)
6134 (interactive)
6136 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
6138 This function returns BUFFER."
6166 buffer)))
6168 ;;;###autoload
6171 post-process)
6172 "Call `org-export-as' with output to a specified file.
6174 BACKEND is either an export back-end, as returned by, e.g.,
6175 `org-export-create-backend', or a symbol referring to
6176 a registered back-end. FILE is the name of the output file, as
6177 a string.
6179 A non-nil optional argument ASYNC means the process should happen
6180 asynchronously. The resulting buffer will then be accessible
6181 through the `org-export-stack' interface.
6183 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6184 EXT-PLIST are similar to those used in `org-export-as', which
6185 see.
6187 Optional argument POST-PROCESS is called with FILE as its
6188 argument and happens asynchronously when ASYNC is non-nil. It
6189 has to return a file name, or nil. Export back-ends can use this
6190 to send the output file through additional processing, e.g,
6192 (defun org-latex-export-to-latex
6193 (&optional async subtreep visible-only body-only ext-plist)
6194 (interactive)
6197 async subtreep visible-only body-only ext-plist
6198 (lambda (file) (org-latex-compile file)))
6200 The function returns either a file name returned by POST-PROCESS,
6201 or FILE."
6220 backend subtreep visible-only body-only ext-plist)))
6227 ;; Get proper return value.
6229 file))))))
6232 "Return output file's name according to buffer specifications.
6234 EXTENSION is a string representing the output file extension,
6235 with the leading dot.
6237 With a non-nil optional argument SUBTREEP, try to determine
6239 of subtree at point.
6241 When optional argument PUB-DIR is set, use it as the publishing
6242 directory.
6244 Return file name as a string."
6250 ;; Check EXPORT_FILE_NAME subtree property.
6252 ;; Check #+EXPORT_FILE_NAME keyword.
6262 ;; Extract from buffer's associated file, if any.
6264 ;; Can't determine file name on our own: ask user.
6266 "Output file: " pub-dir nil nil nil
6268 extension))
6270 ;; Build file name. Enforce EXTENSION over whatever user
6271 ;; may have come up with. PUB-DIR, if defined, always has
6272 ;; precedence over any provided path.
6278 ;; If writing to OUTPUT-FILE would overwrite original file, append
6279 ;; EXTENSION another time to final name.
6282 output-file)))
6285 "Add a new result to export stack if not present already.
6287 SOURCE is a buffer or a file name containing export results.
6288 BACKEND is a symbol representing export back-end used to generate
6289 it.
6291 Entries already pointing to SOURCE and unavailable entries are
6292 removed beforehand. Return the new stack."
6298 "Menu for asynchronous export results and running processes."
6308 "Remove all entries from export stack."
6313 "Refresh the export stack."
6318 "Remove export results at point from stack.
6319 If optional argument SOURCE is non-nil, remove it instead."
6324 org-export-stack-contents))))
6327 "View export results at point in stack.
6328 With an optional prefix argument IN-EMACS, force viewing files
6329 within Emacs."
6343 (define-key km "\C-p" 'previous-line)
6344 (define-key km "\C-?" 'previous-line)
6345 (define-key km [up] 'previous-line)
6346 (define-key km "C" 'org-export-stack-clear)
6347 (define-key km "v" 'org-export-stack-view)
6348 (define-key km (kbd "RET") 'org-export-stack-view)
6349 (define-key km "d" 'org-export-stack-remove)
6350 km)
6351 "Keymap for Org Export Stack.")
6353 (define-derived-mode org-export-stack-mode tabulated-list-mode "Org-Stack"
6354 "Mode for displaying asynchronous export stack.
6357 stack.
6359 In an Org Export Stack buffer, use \
6363 stack completely.
6365 Removing entries in a stack buffer does not affect files
6366 or buffers, only display.
6369 (setq tabulated-list-format
6370 (vector (list "#" 4 #'org-export--stack-num-predicate)
6371 (list "Back-End" 12 t)
6372 (list "Age" 6 nil)
6373 (list "Source" 0 nil)))
6374 (setq tabulated-list-sort-key (cons "#" nil))
6375 (setq tabulated-list-entries #'org-export--stack-generate)
6376 (add-hook 'tabulated-list-revert-hook #'org-export--stack-generate nil t)
6377 (add-hook 'post-command-hook #'org-export-stack-refresh nil t)
6378 (tabulated-list-init-header))
6380 (defun org-export--stack-generate ()
6381 "Generate the asynchronous export stack for display.
6382 Unavailable sources are removed from the list. Return a list
6383 appropriate for `tabulated-list-print'."
6384 ;; Clear stack from exited processes, dead buffers or non-existent
6385 ;; files.
6386 (setq org-export-stack-contents
6387 (cl-remove-if-not
6388 (lambda (el)
6389 (if (processp (nth 2 el))
6390 (buffer-live-p (process-buffer (nth 2 el)))
6391 (let ((source (car el)))
6392 (if (bufferp source) (buffer-live-p source)
6393 (file-exists-p source)))))
6394 org-export-stack-contents))
6395 ;; Update `tabulated-list-entries'.
6396 (let ((counter 0))
6397 (mapcar
6398 (lambda (entry)
6399 (let ((source (car entry)))
6400 (list source
6401 (vector
6402 ;; Counter.
6403 (number-to-string (cl-incf counter))
6404 ;; Back-End.
6405 (if (nth 1 entry) (symbol-name (nth 1 entry)) "")
6406 ;; Age.
6407 (let ((info (nth 2 entry)))
6408 (if (processp info) (symbol-name (process-status info))
6409 (format-seconds "%h:%.2m" (float-time (time-since info)))))
6410 ;; Source.
6411 (if (stringp source) source (buffer-name source))))))
6412 org-export-stack-contents)))
6414 (defun org-export--stack-num-predicate (a b)
6415 (< (string-to-number (aref (nth 1 a) 0))
6416 (string-to-number (aref (nth 1 b) 0))))
6418 (defun org-export--stack-source-at-point ()
6419 "Return source from export results at point in stack."
6420 (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
6421 (if (not source) (error "Source unavailable, please refresh buffer")
6422 (let ((source-name (if (stringp source) source (buffer-name source))))
6423 (if (save-excursion
6424 (beginning-of-line)
6425 (looking-at-p (concat ".* +" (regexp-quote source-name) "$")))
6426 source
6427 ;; SOURCE is not consistent with current line. The stack
6428 ;; view is outdated.
6429 (error (substitute-command-keys
6431 to refresh buffer")))))))
6434 \f
6435 ;;; The Dispatcher
6436 ;;
6437 ;; `org-export-dispatch' is the standard interactive way to start an
6438 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6439 ;; for its interface, which, in turn, delegates response to key
6440 ;; pressed to `org-export--dispatch-action'.
6442 ;;;###autoload
6443 (defun org-export-dispatch (&optional arg)
6444 "Export dispatcher for Org mode.
6446 It provides an access to common export related tasks in a buffer.
6447 Its interface comes in two flavors: standard and expert.
6449 While both share the same set of bindings, only the former
6450 displays the valid keys associations in a dedicated buffer.
6451 Scrolling (resp. line-wise motion) in this buffer is done with
6452 SPC and DEL (resp. C-n and C-p) keys.
6454 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6455 flavor or the other.
6458 same
6459 set of options used back then, on the current buffer.
6462 asynchronous export stack."
6463 (interactive "P")
6464 (let* ((input
6465 (cond ((equal arg '(16)) '(stack))
6466 ((and arg org-export-dispatch-last-action))
6467 (t (save-window-excursion
6468 (unwind-protect
6469 (progn
6470 ;; Remember where we are
6471 (move-marker org-export-dispatch-last-position
6472 (point)
6473 (org-base-buffer (current-buffer)))
6474 ;; Get and store an export command
6475 (setq org-export-dispatch-last-action
6476 (org-export--dispatch-ui
6477 (list org-export-initial-scope
6478 (and org-export-in-background 'async))
6479 nil
6480 org-export-dispatch-use-expert-ui)))
6481 (and (get-buffer "*Org Export Dispatcher*")
6482 (kill-buffer "*Org Export Dispatcher*")))))))
6483 (action (car input))
6484 (optns (cdr input)))
6485 (unless (memq 'subtree optns)
6486 (move-marker org-export-dispatch-last-position nil))
6487 (cl-case action
6488 ;; First handle special hard-coded actions.
6489 (template (org-export-insert-default-template nil optns))
6490 (stack (org-export-stack))
6491 (publish-current-file
6492 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6493 (publish-current-project
6494 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6495 (publish-choose-project
6496 (org-publish (assoc (completing-read
6497 "Publish project: "
6498 org-publish-project-alist nil t)
6499 org-publish-project-alist)
6500 (memq 'force optns)
6501 (memq 'async optns)))
6502 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6503 (otherwise
6504 (save-excursion
6505 (when arg
6506 ;; Repeating command, maybe move cursor to restore subtree
6507 ;; context.
6508 (if (eq (marker-buffer org-export-dispatch-last-position)
6509 (org-base-buffer (current-buffer)))
6510 (goto-char org-export-dispatch-last-position)
6511 ;; We are in a different buffer, forget position.
6512 (move-marker org-export-dispatch-last-position nil)))
6513 (funcall action
6514 ;; Return a symbol instead of a list to ease
6515 ;; asynchronous export macro use.
6516 (and (memq 'async optns) t)
6517 (and (memq 'subtree optns) t)
6518 (and (memq 'visible optns) t)
6519 (and (memq 'body optns) t)))))))
6521 (defun org-export--dispatch-ui (options first-key expertp)
6522 "Handle interface for `org-export-dispatch'.
6524 OPTIONS is a list containing current interactive options set for
6525 export. It can contain any of the following symbols:
6526 `body' toggles a body-only export
6527 `subtree' restricts export to current subtree
6528 `visible' restricts export to visible part of buffer.
6529 `force' force publishing files.
6530 `async' use asynchronous export process
6532 FIRST-KEY is the key pressed to select the first level menu. It
6533 is nil when this menu hasn't been selected yet.
6535 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6536 buffer is provided, but indications about currently active
6537 options are given in the prompt. Moreover, [?] allows switching
6538 back to standard interface."
6539 (let* ((fontify-key
6540 (lambda (key &optional access-key)
6541 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6542 ;; non-nil is the required first-level key to activate
6543 ;; KEY. When its value is t, activate KEY independently
6544 ;; on the first key, if any. A nil value means KEY will
6545 ;; only be activated at first level.
6546 (if (or (eq access-key t) (eq access-key first-key))
6547 (propertize key 'face 'org-warning)
6548 key)))
6549 (fontify-value
6550 (lambda (value)
6551 ;; Fontify VALUE string.
6552 (propertize value 'face 'font-lock-variable-name-face)))
6553 ;; Prepare menu entries by extracting them from registered
6554 ;; back-ends and sorting them by access key and by ordinal,
6555 ;; if any.
6556 (entries
6557 (sort (sort (delq nil
6558 (mapcar #'org-export-backend-menu
6559 org-export-registered-backends))
6560 (lambda (a b)
6561 (let ((key-a (nth 1 a))
6562 (key-b (nth 1 b)))
6563 (cond ((and (numberp key-a) (numberp key-b))
6564 (< key-a key-b))
6565 ((numberp key-b) t)))))
6566 'car-less-than-car))
6567 ;; Compute a list of allowed keys based on the first key
6568 ;; pressed, if any. Some keys
6569 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6570 ;; available.
6571 (allowed-keys
6572 (nconc (list 2 22 19 6 1)
6573 (if (not first-key) (org-uniquify (mapcar 'car entries))
6574 (let (sub-menu)
6575 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6576 (when (eq (car entry) first-key)
6577 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6578 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6579 ((not first-key) (list ?P)))
6580 (list ?& ?#)
6581 (when expertp (list ??))
6582 (list ?q)))
6583 ;; Build the help menu for standard UI.
6584 (help
6585 (unless expertp
6586 (concat
6587 ;; Options are hard-coded.
6588 (format "[%s] Body only: %s [%s] Visible only: %s
6589 \[%s] Export scope: %s [%s] Force publishing: %s
6591 (funcall fontify-key "C-b" t)
6592 (funcall fontify-value
6593 (if (memq 'body options) "On " "Off"))
6594 (funcall fontify-key "C-v" t)
6595 (funcall fontify-value
6596 (if (memq 'visible options) "On " "Off"))
6597 (funcall fontify-key "C-s" t)
6598 (funcall fontify-value
6599 (if (memq 'subtree options) "Subtree" "Buffer "))
6600 (funcall fontify-key "C-f" t)
6601 (funcall fontify-value
6602 (if (memq 'force options) "On " "Off"))
6603 (funcall fontify-key "C-a" t)
6604 (funcall fontify-value
6605 (if (memq 'async options) "On " "Off")))
6606 ;; Display registered back-end entries. When a key
6607 ;; appears for the second time, do not create another
6608 ;; entry, but append its sub-menu to existing menu.
6609 (let (last-key)
6610 (mapconcat
6611 (lambda (entry)
6612 (let ((top-key (car entry)))
6613 (concat
6614 (unless (eq top-key last-key)
6615 (setq last-key top-key)
6617 (funcall fontify-key (char-to-string top-key))
6618 (nth 1 entry)))
6619 (let ((sub-menu (nth 2 entry)))
6620 (unless (functionp sub-menu)
6621 ;; Split sub-menu into two columns.
6622 (let ((index -1))
6623 (concat
6624 (mapconcat
6625 (lambda (sub-entry)
6626 (cl-incf index)
6627 (format
6628 (if (zerop (mod index 2)) " [%s] %-26s"
6630 (funcall fontify-key
6631 (char-to-string (car sub-entry))
6632 top-key)
6633 (nth 1 sub-entry)))
6634 sub-menu "")
6636 entries ""))
6637 ;; Publishing menu is hard-coded.
6639 [%s] Current file [%s] Current project
6641 (funcall fontify-key "P")
6642 (funcall fontify-key "f" ?P)
6643 (funcall fontify-key "p" ?P)
6644 (funcall fontify-key "x" ?P)
6645 (funcall fontify-key "a" ?P))
6647 (funcall fontify-key "&" t)
6648 (funcall fontify-key "#" t))
6649 (format "[%s] %s"
6650 (funcall fontify-key "q" t)
6651 (if first-key "Main menu" "Exit")))))
6652 ;; Build prompts for both standard and expert UI.
6653 (standard-prompt (unless expertp "Export command: "))
6654 (expert-prompt
6655 (when expertp
6656 (format
6657 "Export command (C-%s%s%s%s%s) [%s]: "
6658 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6659 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6660 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6661 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6662 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6663 (mapconcat (lambda (k)
6664 ;; Strip control characters.
6665 (unless (< k 27) (char-to-string k)))
6666 allowed-keys "")))))
6667 ;; With expert UI, just read key with a fancy prompt. In standard
6668 ;; UI, display an intrusive help buffer.
6669 (if expertp
6670 (org-export--dispatch-action
6671 expert-prompt allowed-keys entries options first-key expertp)
6672 ;; At first call, create frame layout in order to display menu.
6673 (unless (get-buffer "*Org Export Dispatcher*")
6674 (delete-other-windows)
6675 (org-switch-to-buffer-other-window
6676 (get-buffer-create "*Org Export Dispatcher*"))
6677 (setq cursor-type nil
6678 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6679 ;; Make sure that invisible cursor will not highlight square
6680 ;; brackets.
6681 (set-syntax-table (copy-syntax-table))
6682 (modify-syntax-entry ?\[ "w"))
6683 ;; At this point, the buffer containing the menu exists and is
6684 ;; visible in the current window. So, refresh it.
6685 (with-current-buffer "*Org Export Dispatcher*"
6686 ;; Refresh help. Maintain display continuity by re-visiting
6687 ;; previous window position.
6688 (let ((pos (window-start)))
6689 (erase-buffer)
6690 (insert help)
6691 (set-window-start nil pos)))
6692 (org-fit-window-to-buffer)
6693 (org-export--dispatch-action
6694 standard-prompt allowed-keys entries options first-key expertp))))
6696 (defun org-export--dispatch-action
6697 (prompt allowed-keys entries options first-key expertp)
6698 "Read a character from command input and act accordingly.
6700 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6701 a list of characters available at a given step in the process.
6702 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6703 EXPERTP are the same as defined in `org-export--dispatch-ui',
6704 which see.
6706 Toggle export options when required. Otherwise, return value is
6707 a list with action as CAR and a list of interactive export
6708 options as CDR."
6709 (let (key)
6710 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6711 ;; C-p, SPC, DEL).
6712 (while (and (setq key (read-char-exclusive prompt))
6713 (not expertp)
6714 (memq key '(14 16 ?\s ?\d)))
6715 (cl-case key
6716 (14 (if (not (pos-visible-in-window-p (point-max)))
6717 (ignore-errors (scroll-up 1))
6718 (message "End of buffer")
6719 (sit-for 1)))
6720 (16 (if (not (pos-visible-in-window-p (point-min)))
6721 (ignore-errors (scroll-down 1))
6722 (message "Beginning of buffer")
6723 (sit-for 1)))
6724 (?\s (if (not (pos-visible-in-window-p (point-max)))
6725 (scroll-up nil)
6726 (message "End of buffer")
6727 (sit-for 1)))
6728 (?\d (if (not (pos-visible-in-window-p (point-min)))
6729 (scroll-down nil)
6730 (message "Beginning of buffer")
6731 (sit-for 1)))))
6732 (cond
6733 ;; Ignore undefined associations.
6734 ((not (memq key allowed-keys))
6735 (ding)
6736 (unless expertp (message "Invalid key") (sit-for 1))
6737 (org-export--dispatch-ui options first-key expertp))
6738 ;; q key at first level aborts export. At second level, cancel
6739 ;; first key instead.
6740 ((eq key ?q) (if (not first-key) (error "Export aborted")
6741 (org-export--dispatch-ui options nil expertp)))
6742 ;; Help key: Switch back to standard interface if expert UI was
6743 ;; active.
6744 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6745 ;; Send request for template insertion along with export scope.
6746 ((eq key ?#) (cons 'template (memq 'subtree options)))
6747 ;; Switch to asynchronous export stack.
6748 ((eq key ?&) '(stack))
6749 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6750 ((memq key '(2 22 19 6 1))
6751 (org-export--dispatch-ui
6752 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6753 (6 'force) (1 'async))))
6754 (if (memq option options) (remq option options)
6755 (cons option options)))
6756 first-key expertp))
6757 ;; Action selected: Send key and options back to
6758 ;; `org-export-dispatch'.
6759 ((or first-key (functionp (nth 2 (assq key entries))))
6760 (cons (cond
6761 ((not first-key) (nth 2 (assq key entries)))
6762 ;; Publishing actions are hard-coded. Send a special
6763 ;; signal to `org-export-dispatch'.
6764 ((eq first-key ?P)
6765 (cl-case key
6766 (?f 'publish-current-file)
6767 (?p 'publish-current-project)
6768 (?x 'publish-choose-project)
6769 (?a 'publish-all)))
6770 ;; Return first action associated to FIRST-KEY + KEY
6771 ;; path. Indeed, derived backends can share the same
6772 ;; FIRST-KEY.
6773 (t (catch 'found
6774 (dolist (entry (member (assq first-key entries) entries))
6775 (let ((match (assq key (nth 2 entry))))
6776 (when match (throw 'found (nth 2 match))))))))
6777 options))
6778 ;; Otherwise, enter sub-menu.
6779 (t (org-export--dispatch-ui options key expertp)))))
6783 (provide 'ox)
6785 ;; Local variables:
6786 ;; generated-autoload-file: "org-loaddefs.el"
6787 ;; End:
6789 ;;; ox.el ends here