| blob | 99244325688ed4c3eb44ec87363bfac36cc88eb9 |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2019 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 <https://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 <https://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
92 \f
93 ;;; Internal Variables
94 ;;
95 ;; Among internal variables, the most important is
96 ;; `org-export-options-alist'. This variable define the global export
97 ;; options, shared between every exporter, and how they are acquired.
143 "Alist between export properties and ways to set them.
145 The key of the alist is the property name, and the value is a list
146 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
148 KEYWORD is a string representing a buffer keyword, or nil. Each
149 property defined this way can also be set, during subtree
150 export, through a headline property named after the keyword
152 property).
153 OPTION is a string that could be found in an #+OPTIONS: line.
154 DEFAULT is the default value for the property.
155 BEHAVIOR determines how Org should handle multiple keywords for
156 the same property. It is a symbol among:
157 nil Keep old value and discard the new one.
158 t Replace old value with the new one.
159 `space' Concatenate the values, separating them with a space.
160 `newline' Concatenate the values, separating them with
161 a newline.
162 `split' Split values at white spaces, and cons them to the
163 previous list.
164 `parse' Parse value as a list of strings and Org objects,
165 which can then be transcoded with, e.g.,
166 `org-export-data'. It implies `space' behavior.
168 Values set through KEYWORD and OPTION have precedence over
169 DEFAULT.
171 All these properties should be back-end agnostic. Back-end
172 specific properties are set through `org-export-define-backend'.
176 "List of in-buffer keywords that require special treatment.
177 These keywords are not directly associated to a property. The
178 way they are handled must be hard-coded into
236 "Alist between filters properties and initial values.
238 The key of each association is a property name accessible through
239 the communication channel. Its value is a configurable global
240 variable defining initial filters.
242 This list is meant to install user specified filters. Back-end
243 developers may install their own filters using
244 `org-export-define-backend'. Filters defined there will always
245 be prepended to the current list, so they always get applied
254 "Default rule for link matching an inline image.
255 This rule applies to links with no description. By default, it
256 will be considered as an inline image if it targets a local file
259 See `org-export-inline-image-p' for more information about
264 org-element--cache org-element--cache-objects org-element--cache-sync-keys
265 org-element--cache-sync-requests org-element--cache-sync-timer)
266 "List of variables not copied through upon buffer duplication.
267 Export process takes place on a copy of the original buffer.
268 When this copy is created, all Org related local variables not in
269 this list are copied to the new buffer. Variables with an
273 "Non-nil means asynchronous export process should leave data behind.
277 located in `temporary-file-directory'.
279 When non-nil, it will also set `debug-on-error' to a non-nil
283 "Record asynchronously generated export results and processes.
284 This is an alist: its CAR is the source of the
285 result (destination file or buffer for a finished process,
286 original buffer for a running one) and its CDR is a list
287 containing the back-end used, as a symbol, and either a process
288 or the time at which it finished. It is used to build the menu
292 "List of backends currently available in the exporter.
293 This variable is set with `org-export-define-backend' and
297 "Last command called from the dispatcher.
298 The value should be a list. Its CAR is the action, as a symbol,
302 "The position where the last export command was created using the dispatcher.
303 This marker will be used with `C-u C-c C-e' to make sure export repetition
306 ;; For compatibility with Org < 8
308 "Name, if any, of the back-end used during an export process.
310 Its value is a symbol such as `html', `latex', `ascii', or nil if
311 the back-end is anonymous (see `org-export-create-backend') or if
312 there is no export process in progress.
314 It can be used to teach Babel blocks how to act differently
318 \f
319 ;;; User-configurable Variables
320 ;;
321 ;; Configuration for the masses.
322 ;;
323 ;; They should never be accessed directly, as their value is to be
324 ;; stored in a property list (cf. `org-export-options-alist').
325 ;; Back-ends will read their value from there instead.
328 "Options for exporting Org mode files."
333 "General options for export engine."
338 "Whether sub-trees with the ARCHIVE tag should be exported.
340 This can have three different values:
341 nil Do not export, pretend this tree is not present.
342 t Do export the entire tree.
343 `headline' Only export the headline, but skip the tree below it.
345 This option can also be set with the OPTIONS keyword,
355 "Non-nil means insert author name into the exported file.
356 This option can also be set with the OPTIONS keyword,
363 "Non-nil means export CLOCK keywords.
364 This option can also be set with the OPTIONS keyword,
371 "Non-nil means the postamble should contain a creator sentence.
373 The sentence can be set in `org-export-creator-string', which
374 see.
376 This option can also be set with the OPTIONS keyword, e.g.,
385 "Non-nil means insert date in the exported document.
386 This option can also be set with the OPTIONS keyword,
393 "Time-stamp format string to use for DATE keyword.
395 The format string, when specified, only applies if date consists
396 in a single time-stamp. Otherwise its value will be ignored.
398 See `format-time-string' for details on how to build this
399 string."
408 emacs-version
410 "Information about the creator of the document.
411 This option can also be set on with the CREATOR keyword."
417 "Non-nil means export contents of standard drawers.
419 When t, all drawers are exported. This may also be a list of
420 drawer names to export, as strings. If that list starts with
421 `not', only drawers with such names will be ignored.
423 This variable doesn't apply to properties drawers. See
424 `org-export-with-properties' instead.
426 This option can also be set with the OPTIONS keyword,
439 :inline t
444 "Non-nil means insert author email into the exported file.
445 This option can also be set with the OPTIONS keyword,
452 "Non-nil means interpret *word*, /word/, _word_ and +word+.
454 If the export target supports emphasizing text, the word will be
455 typeset in bold, italic, with an underline or strike-through,
456 respectively.
458 This option can also be set with the OPTIONS keyword,
465 "Tags that exclude a tree from export.
467 All trees carrying any of these tags will be excluded from
468 export. This is without condition, so even subtrees inside that
469 carry one of the `org-export-select-tags' will be removed.
471 This option can also be set with the EXCLUDE_TAGS keyword."
478 This option can also be set with the OPTIONS keyword,
487 "Non-nil means Org footnotes should be exported.
488 This option can also be set with the OPTIONS keyword,
495 "Non-nil means process LaTeX environments and fragments.
497 This option can also be set with the OPTIONS line,
500 nil Ignore math snippets.
501 `verbatim' Keep everything in verbatim.
502 t Allow export of math snippets."
513 "The last level which is still exported as a headline.
515 Inferior levels will usually produce itemize or enumerate lists
516 when exported, but back-end behavior may differ.
518 This option can also be set with the OPTIONS keyword,
525 "The default language for export and clocktable translations, as a string.
526 This may have an association in
527 `org-clock-clocktable-language-setup',
528 `org-export-smart-quotes-alist' and `org-export-dictionary'.
529 This option can also be set with the LANGUAGE keyword."
535 "Non-nil means preserve all line breaks when exporting.
536 This option can also be set with the OPTIONS keyword,
543 "Non-nil means interpret entities when exporting.
546 Å.
548 For a list of supported names, see the constant `org-entities'
549 and the user option `org-entities-user'.
551 This option can also be set with the OPTIONS keyword,
558 "Non-nil means inlinetasks should be exported.
559 This option can also be set with the OPTIONS keyword,
568 "Non-nil means include planning info in export.
570 Planning info is the line containing either SCHEDULED:,
571 DEADLINE:, CLOSED: time-stamps, or a combination of them.
573 This option can also be set with the OPTIONS keyword,
582 "Non-nil means include priority cookies in export.
583 This option can also be set with the OPTIONS keyword,
590 "Non-nil means export contents of properties drawers.
592 When t, all properties are exported. This may also be a list of
593 properties to export, as strings.
595 This option can also be set with the OPTIONS keyword,
609 "Non-nil means add section numbers to headlines when exporting.
611 When set to an integer n, numbering will only happen for
612 headlines whose relative level is higher or equal to n.
614 This option can also be set with the OPTIONS keyword,
621 "Tags that select a tree for export.
623 If any such tag is found in a buffer, all trees that do not carry
624 one of these tags will be ignored during export. Inside trees
625 that are selected like this, you can still deselect a subtree by
626 tagging it with one of the `org-export-exclude-tags'.
628 This option can also be set with the SELECT_TAGS keyword."
634 "Non-nil means activate smart quotes during export.
635 This option can also be set with the OPTIONS keyword,
638 When setting this to non-nil, you need to take care of
639 using the correct Babel package when exporting to LaTeX.
640 E.g., you can load Babel for french like this:
652 When this option is turned on, these strings will be exported as:
654 Org HTML LaTeX UTF-8
655 -----+----------+--------+-------
657 -- – -- –
658 --- — --- —
661 This option can also be set with the OPTIONS keyword,
668 "Non-nil means include statistics cookies in export.
669 This option can also be set with the OPTIONS keyword,
680 If you want to control how Org displays those characters, see
681 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
682 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
683 it is not anymore.
685 When this option is turned on, you can use TeX-like syntax for
686 sub- and superscripts and see them exported correctly.
688 You can also set the option with #+OPTIONS: ^:t
691 single item - so grouping with {} is normally not needed. For
692 example, the following things will be parsed as single sub- or
693 superscripts:
695 10^24 or 10^tau several digits will be considered 1 item.
696 10^-12 or 10^-tau a leading sign with digits or a word
697 x^2-y^3 will be read as x^2 - y^3, because items are
698 terminated by almost any nonword/nondigit char.
699 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
701 Still, ambiguity is possible. So when in doubt, use {} to enclose
702 the sub/superscript. If you set this variable to the symbol `{}',
703 the braces are *required* in order to trigger interpretations as
705 frequently in plain text."
716 "Non-nil means create a table of contents in exported files.
718 The table of contents contains headlines with levels up to
719 `org-export-headline-levels'.
721 When this variable is set to an integer N, include levels up to
722 N in the table of contents. Although it may then be different
723 from `org-export-headline-levels', it is cannot be larger than
724 the number of headline levels.
726 When nil, no table of contents is created.
728 This option can also be set with the OPTIONS keyword,
740 "Non-nil means export tables.
741 This option can also be set with the OPTIONS keyword,
750 "If nil, do not export tags, just remove them from headlines.
752 If this is the symbol `not-in-toc', tags will be removed from
753 table of contents entries, but still be shown in the headlines of
754 the document.
756 This option can also be set with the OPTIONS keyword,
766 "Non-nil means include TODO items for export.
768 This may have the following values:
769 t include tasks independent of state.
770 `todo' include only tasks that are not yet done.
771 `done' include only tasks that are already done.
772 nil ignore all tasks.
773 list of keywords include tasks with these keywords.
775 This option can also be set with the OPTIONS keyword,
790 "Non-nil means print title into the exported file.
791 This option can also be set with the OPTIONS keyword,
800 "Non-nil means insert a time stamp into the exported file.
801 The time stamp shows when the file was created. This option can
808 "Non nil means allow timestamps in export.
810 It can be set to any of the following values:
811 t export all timestamps.
812 `active' export active timestamps only.
813 `inactive' export inactive timestamps only.
814 nil do not export timestamps
816 This only applies to timestamps isolated in a paragraph
817 containing only timestamps. Other timestamps are always
818 exported.
820 This option can also be set with the OPTIONS keyword, e.g.
831 "Non-nil means include TODO keywords in export.
832 When nil, remove all these keywords from the export. This option
838 "Non-nil means BIND keywords can define local variable values.
839 This is a potential security risk, which is why the default value
840 is nil. You can also allow them through local buffer variables."
847 "Non-nil means do not raise an error on broken links.
849 When this variable is non-nil, broken links are ignored, without
850 stopping the export process. If it is set to `mark', broken
851 links are marked as such in the output, with a string like
853 [BROKEN LINK: path]
855 where PATH is the un-resolvable reference.
857 This option can also be set with the OPTIONS keyword, e.g.,
868 "Alist between export snippets back-ends and exporter back-ends.
870 This variable allows providing shortcuts for export snippets.
874 HTML code while every other back-end will ignore it."
888 "Alist between macro names and expansion templates.
890 This variable defines macro expansion templates available
891 globally. Associations follow the pattern
893 (NAME . TEMPLATE)
895 where NAME is a string beginning with a letter and consisting of
896 alphanumeric characters only.
898 TEMPLATE is the string to which the macro is going to be
900 macro's arguments. Moreover, if the template starts with
902 accordingly."
911 "Coding system for the exported file."
918 "Non-nil means pushing export output to the kill ring.
919 This variable is ignored during asynchronous export."
929 "The initial scope when exporting with `org-export-dispatch'.
930 This variable can be either set to `buffer' or `subtree'."
937 "Non-nil means show buffer after exporting to temp buffer.
938 When Org exports to a file, the buffer visiting that file is never
939 shown, but remains buried. However, when exporting to
940 a temporary buffer, that buffer is popped up in a second window.
941 When this variable is nil, the buffer remains buried also in
942 these cases."
947 "Non-nil means export and publishing commands will run in background.
948 Results from an asynchronous export are never displayed
956 "File used to initialize external export process.
958 Value must be either nil or an absolute file name. When nil, the
959 external process is launched like a regular Emacs session,
960 loading user's initialization file and any site specific
961 configuration. If a file is provided, it, and only it, is loaded
962 at start-up.
964 Therefore, using a specific configuration makes the process to
965 load faster and the export more portable."
974 "Non-nil means using a non-intrusive `org-export-dispatch'.
975 In that case, no help buffer is displayed. Though, an indicator
981 asynchronous). Also, [?] allows switching back to standard
982 mode."
989 \f
990 ;;; Defining Back-ends
991 ;;
992 ;; An export back-end is a structure with `org-export-backend' type
993 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
994 ;; and `menu' slots.
995 ;;
996 ;; At the lowest level, a back-end is created with
997 ;; `org-export-create-backend' function.
998 ;;
999 ;; A named back-end can be registered with
1000 ;; `org-export-register-backend' function. A registered back-end can
1001 ;; later be referred to by its name, with `org-export-get-backend'
1002 ;; function. Also, such a back-end can become the parent of a derived
1003 ;; back-end from which slot values will be inherited by default.
1004 ;; `org-export-derived-backend-p' can check if a given back-end is
1005 ;; derived from a list of back-end names.
1006 ;;
1007 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
1008 ;; `org-export-get-all-filters' return the full alist of transcoders,
1009 ;; options and filters, including those inherited from ancestors.
1010 ;;
1011 ;; At a higher level, `org-export-define-backend' is the standard way
1012 ;; to define an export back-end. If the new back-end is similar to
1013 ;; a registered back-end, `org-export-define-derived-backend' may be
1014 ;; used instead.
1015 ;;
1016 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
1017 ;; when a given back-end hasn't been registered yet.
1021 name parent transcoders options filters blocks menu)
1023 ;;;###autoload
1025 "Return export back-end named after NAME.
1026 NAME is a symbol. Return nil if no such back-end is found."
1028 org-export-registered-backends))
1031 "Register BACKEND as a known export back-end.
1032 BACKEND is a structure with `org-export-backend' type."
1033 ;; Refuse to register an unnamed back-end.
1036 ;; Refuse to register a back-end with an unknown parent.
1040 ;; If a back-end with the same name as BACKEND is already
1041 ;; registered, replace it with BACKEND. Otherwise, simply add
1042 ;; BACKEND to the list of registered back-ends.
1048 "Signal an error if BACKEND isn't defined."
1053 "Non-nil if BACKEND is derived from one of BACKENDS.
1054 BACKEND is an export back-end, as returned by, e.g.,
1055 `org-export-create-backend', or a symbol referring to
1056 a registered back-end. BACKENDS is constituted of symbols."
1068 "Return full translation table for BACKEND.
1070 BACKEND is an export back-end, as return by, e.g,,
1071 `org-export-create-backend'. Return value is an alist where
1072 keys are element or object types, as symbols, and values are
1073 transcoders.
1075 Unlike to `org-export-backend-transcoders', this function
1076 also returns transcoders inherited from parent back-ends,
1077 if any."
1081 parent)
1086 transcoders)))
1089 "Return export options for BACKEND.
1091 BACKEND is an export back-end, as return by, e.g,,
1092 `org-export-create-backend'. See `org-export-options-alist'
1093 for the shape of the return value.
1095 Unlike to `org-export-backend-options', this function also
1096 returns options inherited from parent back-ends, if any.
1098 Return nil if BACKEND is unknown."
1102 parent)
1106 options)))
1109 "Return complete list of filters for BACKEND.
1111 BACKEND is an export back-end, as return by, e.g,,
1112 `org-export-create-backend'. Return value is an alist where
1113 keys are symbols and values lists of functions.
1115 Unlike to `org-export-backend-filters', this function also
1116 returns filters inherited from parent back-ends, if any."
1120 parent)
1124 filters)))
1127 "Define a new back-end BACKEND.
1129 TRANSCODERS is an alist between object or element types and
1130 functions handling them.
1132 These functions should return a string without any trailing
1133 space, or nil. They must accept three arguments: the object or
1134 element itself, its contents or nil when it isn't recursive and
1135 the property list used as a communication channel.
1137 Contents, when not nil, are stripped from any global indentation
1138 \(although the relative one is preserved). They also always end
1139 with a single newline character.
1141 If, for a given type, no function is found, that element or
1142 object type will simply be ignored, along with any blank line or
1143 white space at its end. The same will happen if the function
1144 returns the nil value. If that function returns the empty
1145 string, the type will be ignored, but the blank lines or white
1146 spaces will be kept.
1148 In addition to element and object types, one function can be
1149 associated to the `template' (or `inner-template') symbol and
1150 another one to the `plain-text' symbol.
1152 The former returns the final transcoded string, and can be used
1153 to add a preamble and a postamble to document's body. It must
1154 accept two arguments: the transcoded string and the property list
1155 containing export options. A function associated to `template'
1157 A function associated to `inner-template' is always applied.
1159 The latter, when defined, is to be called on every text not
1160 recognized as an element or an object. It must accept two
1161 arguments: the text string and the information channel. It is an
1162 appropriate place to protect special chars relative to the
1163 back-end.
1165 BODY can start with pre-defined keyword arguments. The following
1166 keywords are understood:
1168 :filters-alist
1170 Alist between filters and function, or list of functions,
1171 specific to the back-end. See `org-export-filters-alist' for
1172 a list of all allowed filters. Filters defined here
1173 shouldn't make a back-end test, as it may prevent back-ends
1174 derived from this one to behave properly.
1176 :menu-entry
1178 Menu entry for the export dispatcher. It should be a list
1179 like:
1183 where :
1185 KEY is a free character selecting the back-end.
1187 DESCRIPTION-OR-ORDINAL is either a string or a number.
1189 If it is a string, is will be used to name the back-end in
1190 its menu entry. If it is a number, the following menu will
1191 be displayed as a sub-menu of the back-end with the same
1192 KEY. Also, the number will be used to determine in which
1193 order such sub-menus will appear (lowest first).
1195 ACTION-OR-MENU is either a function or an alist.
1197 If it is an action, it will be called with four
1198 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1199 BODY-ONLY. See `org-export-as' for further explanations on
1200 some of them.
1202 If it is an alist, associations should follow the
1203 pattern:
1207 where KEY, DESCRIPTION and ACTION are described above.
1209 Valid values include:
1213 or
1218 (lambda (a s v b)
1219 (if a (org-latex-export-to-pdf t s v b)
1220 (org-open-file
1221 (org-latex-export-to-pdf nil s v b)))))))
1223 or the following, which will be added to the previous
1224 sub-menu,
1230 :options-alist
1232 Alist between back-end specific properties introduced in
1233 communication channel and how their value are acquired. See
1234 `org-export-options-alist' for more information about
1235 structure of the values."
1247 :transcoders transcoders
1248 :options options
1249 :filters filters
1253 "Create a new back-end as a variant of an existing one.
1255 CHILD is the name of the derived back-end. PARENT is the name of
1256 the parent back-end.
1258 BODY can start with pre-defined keyword arguments. The following
1259 keywords are understood:
1261 :filters-alist
1263 Alist of filters that will overwrite or complete filters
1264 defined in PARENT back-end. See `org-export-filters-alist'
1265 for a list of allowed filters.
1267 :menu-entry
1269 Menu entry for the export dispatcher. See
1270 `org-export-define-backend' for more information about the
1271 expected value.
1273 :options-alist
1275 Alist of back-end specific properties that will overwrite or
1276 complete those defined in PARENT back-end. Refer to
1277 `org-export-options-alist' for more information about
1278 structure of the values.
1280 :translate-alist
1282 Alist of element and object types and transcoders that will
1283 overwrite or complete transcode table from PARENT back-end.
1284 Refer to `org-export-define-backend' for detailed information
1285 about transcoders.
1288 as a variant of `latex' back-end with a custom template function:
1293 The back-end could then be called with, for example:
1308 :parent parent
1309 :transcoders transcoders
1310 :options options
1311 :filters filters
1315 \f
1316 ;;; The Communication Channel
1317 ;;
1318 ;; During export process, every function has access to a number of
1319 ;; properties. They are of two types:
1320 ;;
1321 ;; 1. Environment options are collected once at the very beginning of
1322 ;; the process, out of the original buffer and configuration.
1323 ;; Collecting them is handled by `org-export-get-environment'
1324 ;; function.
1325 ;;
1326 ;; Most environment options are defined through the
1327 ;; `org-export-options-alist' variable.
1328 ;;
1329 ;; 2. Tree properties are extracted directly from the parsed tree,
1330 ;; just before export, by `org-export--collect-tree-properties'.
1332 ;;;; Environment Options
1333 ;;
1334 ;; Environment options encompass all parameters defined outside the
1335 ;; scope of the parsed data. They come from five sources, in
1336 ;; increasing precedence order:
1337 ;;
1338 ;; - Global variables,
1339 ;; - Buffer's attributes,
1340 ;; - Options keyword symbols,
1341 ;; - Buffer keywords,
1342 ;; - Subtree properties.
1343 ;;
1344 ;; The central internal function with regards to environment options
1345 ;; is `org-export-get-environment'. It updates global variables with
1346 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1347 ;; the different sources.
1348 ;;
1349 ;; The internal functions doing the retrieval are:
1350 ;; `org-export--get-global-options',
1351 ;; `org-export--get-buffer-attributes',
1352 ;; `org-export--parse-option-keyword',
1353 ;; `org-export--get-subtree-options' and
1354 ;; `org-export--get-inbuffer-options'
1355 ;;
1356 ;; Also, `org-export--list-bound-variables' collects bound variables
1357 ;; along with their value in order to set them as buffer local
1358 ;; variables later in the process.
1360 ;;;###autoload
1362 "Collect export options from the current buffer.
1364 Optional argument BACKEND is an export back-end, as returned by
1365 `org-export-create-backend'.
1367 When optional argument SUBTREEP is non-nil, assume the export is
1368 done against the current sub-tree.
1370 Third optional argument EXT-PLIST is a property list with
1371 external parameters overriding Org default settings, but still
1372 inferior to file-local settings."
1373 ;; First install #+BIND variables since these must be set before
1374 ;; global options are read.
1377 ;; Get and prioritize export options...
1379 ;; ... from global variables...
1381 ;; ... from an external property list...
1382 ext-plist
1383 ;; ... from in-buffer settings...
1385 ;; ... and from subtree, when appropriate.
1389 "Parse an OPTIONS line and return values as a plist.
1390 Optional argument BACKEND is an export back-end, as returned by,
1391 e.g., `org-export-create-backend'. It specifies which back-end
1392 specific items to read, if any."
1399 alist))
1400 alist))
1401 ;; Priority is given to back-end specific options.
1403 org-export-options-alist))
1413 "Get export options in subtree at point.
1414 Optional argument BACKEND is an export back-end, as returned by,
1415 e.g., `org-export-create-backend'. It specifies back-end used
1416 for export. Return options as a plist."
1417 ;; For each buffer keyword, create a headline property setting the
1418 ;; same property in communication channel. The name for the
1419 ;; property is the keyword with "EXPORT_" appended to it.
1421 ;; Make sure point is at a heading.
1424 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1425 ;; care of them right from the start.
1428 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1429 ;; headline's title (with no todo keyword, priority cookie or
1430 ;; tag) as its fallback value.
1437 ;; Look for both general keywords and back-end specific
1438 ;; options, with priority given to the latter.
1440 org-export-options-alist)))
1441 ;; Handle other keywords. Then return PLIST.
1455 property
1464 "Return current buffer export options, as a plist.
1466 Optional argument BACKEND, when non-nil, is an export back-end,
1467 as returned by, e.g., `org-export-create-backend'. It specifies
1468 which back-end specific options should also be read in the
1469 process.
1471 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1474 ;; Priority is given to back-end specific options.
1476 org-export-options-alist))
1479 org-export-special-keywords))))
1480 plist to-parse)
1483 ;; Return all properties associated to KEYWORD.
1490 ;; Recursively read keywords in buffer. FILES is
1491 ;; a list of files read so far. PLIST is the current
1492 ;; property list obtained.
1501 ;; Options in `org-export-special-keywords'.
1506 uri
1508 ;; Avoid circular dependencies.
1520 plist
1522 val backend))))
1526 plist
1533 ;; Options in `org-export-options-alist'.
1536 plist
1538 plist property
1539 ;; Handle value depending on specified
1540 ;; BEHAVIOR.
1545 ;; Even if `parse' implies `space'
1546 ;; behavior, we separate line with
1547 ;; "\n" so as to preserve
1548 ;; line-breaks. However, empty
1549 ;; lines are forbidden since `parse'
1550 ;; doesn't allow more than one
1551 ;; paragraph.
1560 " "
1573 ;; Read options in the current buffer and return value.
1575 ;; Parse properties in TO-PARSE. Remove newline characters not
1576 ;; involved in line breaks to simulate `space' behavior.
1577 ;; Finally return options.
1590 "Return properties related to export process, as a plist.
1591 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1592 are like the arguments with the same names of function
1593 `org-export-as'."
1598 :back-end backend
1603 "Return properties related to buffer attributes, as a plist."
1608 "Return global export options as a plist.
1609 Optional argument BACKEND, if non-nil, is an export back-end, as
1610 returned by, e.g., `org-export-create-backend'. It specifies
1611 which back-end specific export options should also be read in the
1612 process."
1614 ;; Priority is given to back-end specific options.
1616 org-export-options-alist)))
1622 plist
1623 prop
1624 ;; Evaluate default value provided.
1629 value)))))))))
1632 "Return variables bound from BIND keywords in current buffer.
1633 Also look for BIND keywords in setup files. The return value is
1634 an alist where associations are (VARIABLE-NAME VALUE)."
1638 ;; Return an alist between variable names and their
1639 ;; value. FILES is a list of setup files names read
1640 ;; so far, used to avoid circular dependencies. ALIST
1641 ;; is the alist collected so far.
1653 ;; Enter setup file.
1657 uri
1659 ;; Avoid circular dependencies.
1670 alist))))))))))
1671 alist)))))
1672 ;; Return value in appropriate order of appearance.
1675 ;; defsubst org-export-get-parent must be defined before first use,
1676 ;; was originally defined in the topology section
1679 "Return BLOB parent or nil.
1680 BLOB is the element or object considered."
1683 ;;;; Tree Properties
1684 ;;
1685 ;; Tree properties are information extracted from parse tree. They
1686 ;; are initialized at the beginning of the transcoding process by
1687 ;; `org-export--collect-tree-properties'.
1688 ;;
1689 ;; Dedicated functions focus on computing the value of specific tree
1690 ;; properties during initialization. Thus,
1691 ;; `org-export--populate-ignore-list' lists elements and objects that
1692 ;; should be skipped during export, `org-export--get-min-level' gets
1693 ;; the minimal exportable level, used as a basis to compute relative
1694 ;; level for headlines. Eventually
1695 ;; `org-export--collect-headline-numbering' builds an alist between
1696 ;; headlines and their numbering.
1699 "Extract tree properties from parse tree.
1701 DATA is the parse tree from which information is retrieved. INFO
1702 is a list holding export options.
1704 Following tree properties are set or updated:
1706 `:headline-offset' Offset between true level of headlines and
1707 local level. An offset of -1 means a headline
1708 of level 2 should be considered as a level
1709 1 headline in the context.
1711 `:headline-numbering' Alist of all headlines as key and the
1712 associated numbering as value.
1714 `:id-alist' Alist of all ID references as key and associated file
1715 as value.
1717 Return updated plist."
1718 ;; Install the parse tree in the communication channel.
1720 ;; Compute `:headline-offset' in order to be able to use
1721 ;; `org-export-get-relative-level'.
1724 :headline-offset
1726 ;; From now on, properties order doesn't matter: get the rest of the
1727 ;; tree properties.
1729 info
1731 :id-alist
1740 "Return minimum exportable headline's level in DATA.
1741 DATA is parsed tree as returned by `org-element-parse-buffer'.
1742 OPTIONS is a plist holding export options."
1751 ;; If no headline was found, for the sake of consistency, set
1752 ;; minimum level to 1 nonetheless.
1756 "Return numbering of all exportable, numbered headlines in a parse tree.
1758 DATA is the parse tree. OPTIONS is the plist holding export
1759 options.
1761 Return an alist whose key is a headline and value is its
1762 associated numbering \(in the shape of a list of numbers) or nil
1763 for a footnotes section."
1772 headline
1774 for n across numbering
1775 for idx from 0 to org-export-max-depth
1779 options)))
1782 "List headlines and inlinetasks with a select tag in their tree.
1783 DATA is parsed data as returned by `org-element-parse-buffer'.
1784 INFO is a plist holding export options."
1788 ;; If FILETAGS contains a select tag, every headline or
1789 ;; inlinetask is returned.
1799 ;; When a select tag is found, mark full
1800 ;; genealogy and every headline within the
1801 ;; tree as acceptable.
1804 genealogy
1807 selected-trees))
1808 ;; If at a headline, continue searching in
1809 ;; tree, recursively.
1818 selected-trees))))
1821 "Non-nil when element or object DATUM should be skipped during export.
1822 OPTIONS is the plist holding export options. SELECTED, when
1823 non-nil, is a list of headlines or inlinetasks belonging to
1824 a tree with a select tag. EXCLUDED is a list of tags, as
1825 strings. Any headline or inlinetask marked with one of those is
1826 not exported."
1829 ;; Skip all comments and comment blocks. Make to keep maximum
1830 ;; number of blank lines around the comment so as to preserve
1831 ;; local structure of the document upon interpreting it back into
1832 ;; Org syntax.
1838 t)
1844 ;; If `:with-drawers' value starts with `not', ignore
1845 ;; every drawer whose name belong to that list.
1846 ;; Otherwise, ignore drawers whose name isn't in that
1847 ;; list.
1864 ;; Ignore subtrees with an exclude tag.
1866 ;; When a select tag is present in the buffer, ignore any tree
1867 ;; without it.
1869 ;; Ignore commented sub-trees.
1871 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1873 ;; Ignore tasks, if specified by `:with-tasks' property.
1885 properties-set))))))
1896 ;; `:with-timestamps' only applies to isolated timestamps
1897 ;; objects, i.e. timestamp objects in a paragraph containing only
1898 ;; timestamps and whitespaces.
1906 options t))))
1915 \f
1916 ;;; The Transcoder
1917 ;;
1918 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1919 ;; `org-element-parse-buffer') and transcodes it into a specified
1920 ;; back-end output. It takes care of filtering out elements or
1921 ;; objects according to export options and organizing the output blank
1922 ;; lines and white space are preserved. The function memoizes its
1923 ;; results, so it is cheap to call it within transcoders.
1924 ;;
1925 ;; It is possible to modify locally the back-end used by
1926 ;; `org-export-data' or even use a temporary back-end by using
1927 ;; `org-export-data-with-backend'.
1928 ;;
1929 ;; `org-export-transcoder' is an accessor returning appropriate
1930 ;; translator function for a given element or object.
1933 "Return appropriate transcoder for BLOB.
1934 INFO is a plist containing export directives."
1936 ;; Return contents only for complete parse trees.
1942 "Convert DATA into current back-end format.
1944 DATA is a parse tree, an element or an object or a secondary
1945 string. INFO is a plist holding export options.
1947 Return a string."
1949 ;; Handle broken links according to
1950 ;; `org-export-with-broken-links'.
1966 ;; Ignored element/object.
1968 ;; Plain text.
1974 info))
1975 ;; Secondary string.
1978 ;; Element/Object without contents or, as a special
1979 ;; case, headline with archive tag and archived trees
1980 ;; restricted to title only.
1989 ;; Export snippets never return a nil value so
1990 ;; that white spaces following them are never
1991 ;; ignored.
1993 ;; Element/Object with contents.
2006 ;; Elements directly containing
2007 ;; objects must have their indentation
2008 ;; normalized first.
2010 data
2011 ;; When normalizing first paragraph
2012 ;; of an item or
2013 ;; a footnote-definition, ignore
2014 ;; first line's indentation.
2020 data)
2028 info)))))))))
2029 ;; Final result will be memoized before being returned.
2031 data
2035 ;; Append the same white space between elements or objects
2036 ;; as in the original buffer, and call appropriate filters.
2045 info)))
2049 "Convert DATA into BACKEND format.
2051 DATA is an element, an object, a secondary string or a string.
2052 BACKEND is a symbol. INFO is a plist used as a communication
2053 channel.
2055 Unlike to `org-export-with-backend', this function will
2056 recursively convert DATA using BACKEND translation table."
2058 ;; Set-up a new communication channel with translations defined in
2059 ;; BACKEND as the translate table and a new hash table for
2060 ;; memoization.
2063 info
2066 ;; Size of the hash table is reduced since this
2067 ;; function will probably be used on small trees.
2070 ;; Preserve `:internal-references', as those do not depend on
2071 ;; the back-end used; we need to make sure that any new
2072 ;; reference when the temporary back-end was active gets through
2073 ;; the default one.
2078 "Expand a parsed element or object to its original state.
2080 BLOB is either an element or an object. CONTENTS is its
2081 contents, as a string or nil.
2083 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2084 keywords before output."
2090 blob contents))))
2093 \f
2094 ;;; The Filter System
2095 ;;
2096 ;; Filters allow end-users to tweak easily the transcoded output.
2097 ;; They are the functional counterpart of hooks, as every filter in
2098 ;; a set is applied to the return value of the previous one.
2099 ;;
2100 ;; Every set is back-end agnostic. Although, a filter is always
2101 ;; called, in addition to the string it applies to, with the back-end
2102 ;; used as argument, so it's easy for the end-user to add back-end
2103 ;; specific filters in the set. The communication channel, as
2104 ;; a plist, is required as the third argument.
2105 ;;
2106 ;; From the developer side, filters sets can be installed in the
2107 ;; process with the help of `org-export-define-backend', which
2108 ;; internally stores filters as an alist. Each association has a key
2109 ;; among the following symbols and a function or a list of functions
2110 ;; as value.
2111 ;;
2112 ;; - `:filter-options' applies to the property list containing export
2113 ;; options. Unlike to other filters, functions in this list accept
2114 ;; two arguments instead of three: the property list containing
2115 ;; export options and the back-end. Users can set its value through
2116 ;; `org-export-filter-options-functions' variable.
2117 ;;
2118 ;; - `:filter-parse-tree' applies directly to the complete parsed
2119 ;; tree. Users can set it through
2120 ;; `org-export-filter-parse-tree-functions' variable.
2121 ;;
2122 ;; - `:filter-body' applies to the body of the output, before template
2123 ;; translator chimes in. Users can set it through
2124 ;; `org-export-filter-body-functions' variable.
2125 ;;
2126 ;; - `:filter-final-output' applies to the final transcoded string.
2127 ;; Users can set it with `org-export-filter-final-output-functions'
2128 ;; variable.
2129 ;;
2130 ;; - `:filter-plain-text' applies to any string not recognized as Org
2131 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2132 ;; configure it.
2133 ;;
2134 ;; - `:filter-TYPE' applies on the string returned after an element or
2135 ;; object of type TYPE has been transcoded. A user can modify
2136 ;; `org-export-filter-TYPE-functions' to install these filters.
2137 ;;
2138 ;; All filters sets are applied with
2139 ;; `org-export-filter-apply-functions' function. Filters in a set are
2140 ;; applied in a LIFO fashion. It allows developers to be sure that
2141 ;; their filters will be applied first.
2142 ;;
2143 ;; Filters properties are installed in communication channel with
2144 ;; `org-export-install-filters' function.
2145 ;;
2146 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2147 ;; `org-export-before-parsing-hook') are run at the beginning of the
2148 ;; export process and just before parsing to allow for heavy structure
2149 ;; modifications.
2152 ;;;; Hooks
2155 "Hook run at the beginning of the export process.
2157 This is run before include keywords and macros are expanded and
2158 Babel code blocks executed, on a copy of the original buffer
2159 being exported. Visibility and narrowing are preserved. Point
2160 is at the beginning of the buffer.
2162 Every function in this hook will be called with one argument: the
2166 "Hook run before parsing an export buffer.
2168 This is run after include keywords and macros have been expanded
2169 and Babel code blocks executed, on a copy of the original buffer
2170 being exported. Visibility and narrowing are preserved. Point
2171 is at the beginning of the buffer.
2173 Every function in this hook will be called with one argument: the
2177 ;;;; Special Filters
2180 "List of functions applied to the export options.
2181 Each filter is called with two arguments: the export options, as
2182 a plist, and the back-end, as a symbol. It must return
2186 "List of functions applied to the parsed tree.
2187 Each filter is called with three arguments: the parse tree, as
2188 returned by `org-element-parse-buffer', the back-end, as
2189 a symbol, and the communication channel, as a plist. It must
2193 "List of functions applied to plain text.
2194 Each filter is called with three arguments: a string which
2195 contains no Org syntax, the back-end, as a symbol, and the
2196 communication channel, as a plist. It must return a string or
2200 "List of functions applied to transcoded body.
2201 Each filter is called with three arguments: a string which
2202 contains no Org syntax, the back-end, as a symbol, and the
2203 communication channel, as a plist. It must return a string or
2207 "List of functions applied to the transcoded string.
2208 Each filter is called with three arguments: the full transcoded
2209 string, the back-end, as a symbol, and the communication channel,
2210 as a plist. It must return a string that will be used as the
2214 ;;;; Elements Filters
2217 "List of functions applied to a transcoded babel-call.
2218 Each filter is called with three arguments: the transcoded data,
2219 as a string, the back-end, as a symbol, and the communication
2223 "List of functions applied to a transcoded center block.
2224 Each filter is called with three arguments: the transcoded data,
2225 as a string, the back-end, as a symbol, and the communication
2229 "List of functions applied to a transcoded clock.
2230 Each filter is called with three arguments: the transcoded data,
2231 as a string, the back-end, as a symbol, and the communication
2235 "List of functions applied to a transcoded diary-sexp.
2236 Each filter is called with three arguments: the transcoded data,
2237 as a string, the back-end, as a symbol, and the communication
2241 "List of functions applied to a transcoded drawer.
2242 Each filter is called with three arguments: the transcoded data,
2243 as a string, the back-end, as a symbol, and the communication
2247 "List of functions applied to a transcoded dynamic-block.
2248 Each filter is called with three arguments: the transcoded data,
2249 as a string, the back-end, as a symbol, and the communication
2253 "List of functions applied to a transcoded example-block.
2254 Each filter is called with three arguments: the transcoded data,
2255 as a string, the back-end, as a symbol, and the communication
2259 "List of functions applied to a transcoded export-block.
2260 Each filter is called with three arguments: the transcoded data,
2261 as a string, the back-end, as a symbol, and the communication
2265 "List of functions applied to a transcoded fixed-width.
2266 Each filter is called with three arguments: the transcoded data,
2267 as a string, the back-end, as a symbol, and the communication
2271 "List of functions applied to a transcoded footnote-definition.
2272 Each filter is called with three arguments: the transcoded data,
2273 as a string, the back-end, as a symbol, and the communication
2277 "List of functions applied to a transcoded headline.
2278 Each filter is called with three arguments: the transcoded data,
2279 as a string, the back-end, as a symbol, and the communication
2283 "List of functions applied to a transcoded horizontal-rule.
2284 Each filter is called with three arguments: the transcoded data,
2285 as a string, the back-end, as a symbol, and the communication
2289 "List of functions applied to a transcoded inlinetask.
2290 Each filter is called with three arguments: the transcoded data,
2291 as a string, the back-end, as a symbol, and the communication
2295 "List of functions applied to a transcoded item.
2296 Each filter is called with three arguments: the transcoded data,
2297 as a string, the back-end, as a symbol, and the communication
2301 "List of functions applied to a transcoded keyword.
2302 Each filter is called with three arguments: the transcoded data,
2303 as a string, the back-end, as a symbol, and the communication
2307 "List of functions applied to a transcoded latex-environment.
2308 Each filter is called with three arguments: the transcoded data,
2309 as a string, the back-end, as a symbol, and the communication
2313 "List of functions applied to a transcoded node-property.
2314 Each filter is called with three arguments: the transcoded data,
2315 as a string, the back-end, as a symbol, and the communication
2319 "List of functions applied to a transcoded paragraph.
2320 Each filter is called with three arguments: the transcoded data,
2321 as a string, the back-end, as a symbol, and the communication
2325 "List of functions applied to a transcoded plain-list.
2326 Each filter is called with three arguments: the transcoded data,
2327 as a string, the back-end, as a symbol, and the communication
2331 "List of functions applied to a transcoded planning.
2332 Each filter is called with three arguments: the transcoded data,
2333 as a string, the back-end, as a symbol, and the communication
2337 "List of functions applied to a transcoded property-drawer.
2338 Each filter is called with three arguments: the transcoded data,
2339 as a string, the back-end, as a symbol, and the communication
2343 "List of functions applied to a transcoded quote block.
2344 Each filter is called with three arguments: the transcoded quote
2345 data, as a string, the back-end, as a symbol, and the
2346 communication channel, as a plist. It must return a string or
2350 "List of functions applied to a transcoded section.
2351 Each filter is called with three arguments: the transcoded data,
2352 as a string, the back-end, as a symbol, and the communication
2356 "List of functions applied to a transcoded special block.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 "List of functions applied to a transcoded src-block.
2363 Each filter is called with three arguments: the transcoded data,
2364 as a string, the back-end, as a symbol, and the communication
2368 "List of functions applied to a transcoded table.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded table-cell.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 "List of functions applied to a transcoded table-row.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to a transcoded verse block.
2387 Each filter is called with three arguments: the transcoded data,
2388 as a string, the back-end, as a symbol, and the communication
2392 ;;;; Objects Filters
2395 "List of functions applied to transcoded bold text.
2396 Each filter is called with three arguments: the transcoded data,
2397 as a string, the back-end, as a symbol, and the communication
2401 "List of functions applied to transcoded code text.
2402 Each filter is called with three arguments: the transcoded data,
2403 as a string, the back-end, as a symbol, and the communication
2407 "List of functions applied to a transcoded entity.
2408 Each filter is called with three arguments: the transcoded data,
2409 as a string, the back-end, as a symbol, and the communication
2413 "List of functions applied to a transcoded export-snippet.
2414 Each filter is called with three arguments: the transcoded data,
2415 as a string, the back-end, as a symbol, and the communication
2419 "List of functions applied to a transcoded footnote-reference.
2420 Each filter is called with three arguments: the transcoded data,
2421 as a string, the back-end, as a symbol, and the communication
2425 "List of functions applied to a transcoded inline-babel-call.
2426 Each filter is called with three arguments: the transcoded data,
2427 as a string, the back-end, as a symbol, and the communication
2431 "List of functions applied to a transcoded inline-src-block.
2432 Each filter is called with three arguments: the transcoded data,
2433 as a string, the back-end, as a symbol, and the communication
2437 "List of functions applied to transcoded italic text.
2438 Each filter is called with three arguments: the transcoded data,
2439 as a string, the back-end, as a symbol, and the communication
2443 "List of functions applied to a transcoded latex-fragment.
2444 Each filter is called with three arguments: the transcoded data,
2445 as a string, the back-end, as a symbol, and the communication
2449 "List of functions applied to a transcoded line-break.
2450 Each filter is called with three arguments: the transcoded data,
2451 as a string, the back-end, as a symbol, and the communication
2455 "List of functions applied to a transcoded link.
2456 Each filter is called with three arguments: the transcoded data,
2457 as a string, the back-end, as a symbol, and the communication
2461 "List of functions applied to a transcoded radio-target.
2462 Each filter is called with three arguments: the transcoded data,
2463 as a string, the back-end, as a symbol, and the communication
2467 "List of functions applied to a transcoded statistics-cookie.
2468 Each filter is called with three arguments: the transcoded data,
2469 as a string, the back-end, as a symbol, and the communication
2473 "List of functions applied to transcoded strike-through text.
2474 Each filter is called with three arguments: the transcoded data,
2475 as a string, the back-end, as a symbol, and the communication
2479 "List of functions applied to a transcoded subscript.
2480 Each filter is called with three arguments: the transcoded data,
2481 as a string, the back-end, as a symbol, and the communication
2485 "List of functions applied to a transcoded superscript.
2486 Each filter is called with three arguments: the transcoded data,
2487 as a string, the back-end, as a symbol, and the communication
2491 "List of functions applied to a transcoded target.
2492 Each filter is called with three arguments: the transcoded data,
2493 as a string, the back-end, as a symbol, and the communication
2497 "List of functions applied to a transcoded timestamp.
2498 Each filter is called with three arguments: the transcoded data,
2499 as a string, the back-end, as a symbol, and the communication
2503 "List of functions applied to transcoded underline text.
2504 Each filter is called with three arguments: the transcoded data,
2505 as a string, the back-end, as a symbol, and the communication
2509 "List of functions applied to transcoded verbatim text.
2510 Each filter is called with three arguments: the transcoded data,
2511 as a string, the back-end, as a symbol, and the communication
2515 ;;;; Filters Tools
2516 ;;
2517 ;; Internal function `org-export-install-filters' installs filters
2518 ;; hard-coded in back-ends (developer filters) and filters from global
2519 ;; variables (user filters) in the communication channel.
2520 ;;
2521 ;; Internal function `org-export-filter-apply-functions' takes care
2522 ;; about applying each filter in order to a given data. It ignores
2523 ;; filters returning a nil value but stops whenever a filter returns
2524 ;; an empty string.
2527 "Call every function in FILTERS.
2529 Functions are called with three arguments: a value, the export
2530 back-end name and the communication channel. First function in
2531 FILTERS is called with VALUE as its first argument. Second
2532 function in FILTERS is called with the previous result as its
2533 value, etc.
2535 Functions returning nil are skipped. Any function returning the
2536 empty string ends the process, which returns the empty string.
2538 Call is done in a LIFO fashion, to be sure that developer
2539 specified filters, if any, are called first."
2550 "Install filters properties in communication channel.
2551 INFO is a plist containing the current communication channel.
2552 Return the updated communication channel."
2554 ;; Install user-defined filters with `org-export-filters-alist'
2555 ;; and filters already in INFO (through ext-plist mechanism).
2562 ;; Filters in INFO will be called
2563 ;; before those user provided.
2566 default-value)))))
2567 ;; Prepend back-end specific filters to that list.
2569 ;; Single values get consed, lists are appended.
2574 plist key
2577 ;; Return new communication channel.
2581 \f
2582 ;;; Core functions
2583 ;;
2584 ;; This is the room for the main function, `org-export-as', along with
2585 ;; its derivative, `org-export-string-as'.
2586 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2587 ;; function should be added to kill ring.
2588 ;;
2589 ;; Note that `org-export-as' doesn't really parse the current buffer,
2590 ;; but a copy of it (with the same buffer-local variables and
2591 ;; visibility), where macros and include keywords are expanded and
2592 ;; Babel blocks are executed, if appropriate.
2593 ;; `org-export-with-buffer-copy' macro prepares that copy.
2594 ;;
2595 ;; File inclusion is taken care of by
2596 ;; `org-export-expand-include-keyword' and
2597 ;; `org-export--prepare-file-contents'. Structure wise, including
2598 ;; a whole Org file in a buffer often makes little sense. For
2599 ;; example, if the file contains a headline and the include keyword
2600 ;; was within an item, the item should contain the headline. That's
2601 ;; why file inclusion should be done before any structure can be
2602 ;; associated to the file, that is before parsing.
2603 ;;
2604 ;; `org-export-insert-default-template' is a command to insert
2605 ;; a default template (or a back-end specific template) at point or in
2606 ;; current subtree.
2609 "Return a copy of the current buffer.
2610 The copy preserves Org buffer-local variables, visibility and
2611 narrowing."
2617 new-buf))
2620 "Apply BODY in a copy of the current buffer.
2621 The copy preserves local variables, visibility and contents of
2622 the original buffer. Point is at the beginning of the buffer
2623 when BODY is applied."
2632 ;; Kill copy without confirmation.
2638 "Generate a function duplicating BUFFER.
2640 The copy will preserve local variables, visibility, contents and
2641 narrowing of the original buffer. If a region was active in
2642 BUFFER, contents will be narrowed to that region instead.
2644 The resulting function can be evaluated at a later time, from
2645 another buffer, effectively cloning the original buffer there.
2647 The function assumes BUFFER's major mode is `org-mode'."
2651 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2652 ;; already in BUFFER.
2654 ;; Copy specific buffer local variables and variables set
2655 ;; through BIND keywords.
2657 vars)
2665 buffer-file-name
2666 buffer-file-coding-system))
2670 ;; Skip unreadable values, as they cannot be
2671 ;; sent to external process.
2675 vars))))))
2676 ;; Whole buffer contents.
2678 ;; Narrowing.
2682 ;; Current position of point.
2684 ;; Overlays with invisible property.
2693 ov-set)))))))))
2696 "Delete commented trees and commented inlinetasks in the buffer.
2697 Narrowing, if any, is ignored."
2709 "Prune non exportable elements from DATA.
2710 DATA is the parse tree to traverse. INFO is the plist holding
2711 export info. Also set `:ignore-list' in INFO to a list of
2712 objects which should be ignored during export, but not removed
2713 from tree."
2715 ;; First find trees containing a select tag, if any.
2717 ;; List tags that prevent export of headlines.
2722 ;; Prune non-exportable elements and objects from tree.
2723 ;; As a special case, special rows and cells from tables
2724 ;; are stored in IGNORE, as they still need to be
2725 ;; accessed during export.
2735 ;; If headline is archived but tree below has
2736 ;; to be skipped, remove contents.
2738 ;; Move into recursive objects/elements.
2740 ;; Move into secondary string, if any.
2742 org-element-secondary-value-alist)))
2745 ;; Collect definitions before possibly pruning them so as
2746 ;; to avoid parsing them again if they are required.
2753 f)
2755 ;; If a select tag is active, also ignore the section before the
2756 ;; first headline, if any.
2761 ;; Prune tree and communication channel.
2764 ;; Priority is given to back-end specific options.
2766 org-export-options-alist))
2772 ;; Eventually set `:ignore-list'.
2776 "List footnote definitions missing from TREE.
2777 Missing definitions are searched within DEFINITIONS, which is
2778 a list of footnote definitions or in the widened buffer."
2781 ;; List all footnote labels encountered in DATA. Inline
2782 ;; footnote references are ignored.
2787 defined undefined missing-definitions)
2788 ;; Partition DIRECT-REFERENCES between DEFINED and UNDEFINED
2789 ;; references.
2796 seen)
2801 ;; Complete MISSING-DEFINITIONS by finding the definition of every
2802 ;; undefined label, first by looking into DEFINITIONS, then by
2803 ;; searching the widened buffer. This is a recursive process
2804 ;; since definitions found can themselves contain an undefined
2805 ;; reference.
2812 d))
2813 definitions))
2820 datum
2821 ;; Parse definition with contents.
2832 ;; Look for footnote references within DEFINITION, since
2833 ;; we may need to also find their definition.
2838 ;; MISSING-DEFINITIONS may contain footnote references with inline
2839 ;; definitions. Make sure those are changed into real footnote
2840 ;; definitions.
2847 missing-definitions)))
2850 "Install footnote definitions in tree.
2852 DEFINITIONS is the list of footnote definitions to install. TREE
2853 is the parse tree.
2855 If there is a footnote section in TREE, definitions found are
2856 appended to it. If `org-footnote-section' is non-nil, a new
2857 footnote section containing all definitions is inserted in TREE.
2858 Otherwise, definitions are appended at the end of the section
2859 containing their first reference."
2862 ;; If there is a footnote section, insert definitions there.
2866 nil t)))
2869 footnote-section
2871 ;; If there should be a footnote section, create one containing all
2872 ;; the definitions at the end of the tree.
2875 tree
2879 :title org-footnote-section
2882 'section
2883 nil
2885 ;; Otherwise add each definition at the end of the section where it
2886 ;; is first referenced.
2891 ;; Insert footnote definitions in the same section as
2892 ;; their first reference in DATA.
2903 label)
2904 d))
2905 definitions)))
2908 definition)
2909 ;; Also insert definitions for nested
2910 ;; references, if any.
2915 "Change uninterpreted elements back into Org syntax.
2916 DATA is a parse tree or a secondary string. INFO is a plist
2917 containing export options. It is modified by side effect and
2918 returned by the function."
2921 subscript superscript underline)
2925 ;; ... entities...
2932 ?\s)))))
2933 ;; ... emphasis...
2945 marker
2949 ?\s)))))))
2950 ;; ... LaTeX environments and fragments...
2954 ;; ... sub/superscripts...
2963 "_"
2972 ?\s)))))))))))
2974 ;; Splice NEW at DATUM location in parse tree.
2977 info nil nil t)
2978 ;; Return modified parse tree.
2979 data)
2981 ;;;###autoload
2984 "Transcode current Org buffer into BACKEND code.
2986 BACKEND is either an export back-end, as returned by, e.g.,
2987 `org-export-create-backend', or a symbol referring to
2988 a registered back-end.
2990 If narrowing is active in the current buffer, only transcode its
2991 narrowed part.
2993 If a region is active, transcode that region.
2995 When optional argument SUBTREEP is non-nil, transcode the
2996 sub-tree at point, extracting information from the headline
2997 properties first.
2999 When optional argument VISIBLE-ONLY is non-nil, don't export
3000 contents of hidden elements.
3002 When optional argument BODY-ONLY is non-nil, only return body
3003 code, without surrounding template.
3005 Optional argument EXT-PLIST, when provided, is a property list
3006 with external parameters overriding Org default settings, but
3007 still inferior to file-local settings.
3009 Return code as a string."
3014 ;; Narrow buffer to an appropriate region or subtree for
3015 ;; parsing. If parsing subtree, be sure to remove main
3016 ;; headline, planning data and property drawer.
3024 ;; Initialize communication channel with original buffer
3025 ;; attributes, unavailable in its copy.
3029 backend subtreep visible-only body-only)
3035 org-export-options-alist))))
3036 tree)
3037 ;; Update communication channel and get parse tree. Buffer
3038 ;; isn't parsed directly. Instead, all buffer modifications
3039 ;; and consequent parsing are undertaken in a temporary copy.
3041 ;; Run first hook with current back-end's name as argument.
3048 org-export-global-macros)
3049 parsed-keywords)
3050 ;; Refresh buffer properties and radio targets after previous
3051 ;; potentially invasive changes.
3054 ;; Possibly execute Babel code. Re-run a macro expansion
3055 ;; specifically for {{{results}}} since inline source blocks
3056 ;; may have generated some more. Refresh buffer properties
3057 ;; and radio targets another time.
3063 ;; Run last hook with current back-end's name as argument.
3064 ;; Update buffer properties and radio targets one last time
3065 ;; before parsing.
3072 ;; Update communication channel with environment.
3076 ;; De-activate uninterpreted data from parsed keywords.
3078 org-export-options-alist))
3083 p
3086 ;; Install user's and developer's filters.
3088 ;; Call options filters and update export options. We do not
3089 ;; use `org-export-filter-apply-functions' here since the
3090 ;; arity of such filters is different.
3095 ;; Parse buffer.
3097 ;; Prune tree from non-exported elements and transform
3098 ;; uninterpreted elements or objects in both parse tree and
3099 ;; communication channel.
3102 ;; Call parse tree filters.
3106 ;; Now tree is complete, compute its properties and add them
3107 ;; to communication channel.
3109 ;; Eventually transcode TREE. Wrap the resulting string into
3110 ;; a template.
3119 info))
3122 ;; Remove all text properties since they cannot be
3123 ;; retrieved from an external process. Finally call
3124 ;; final-output filter and return result.
3130 info))))))))
3132 ;;;###autoload
3134 "Transcode STRING into BACKEND code.
3136 BACKEND is either an export back-end, as returned by, e.g.,
3137 `org-export-create-backend', or a symbol referring to
3138 a registered back-end.
3140 When optional argument BODY-ONLY is non-nil, only return body
3141 code, without preamble nor postamble.
3143 Optional argument EXT-PLIST, when provided, is a property list
3144 with external parameters overriding Org default settings, but
3145 still inferior to file-local settings.
3147 Return code as a string."
3153 ;;;###autoload
3155 "Replace the active region by its export to BACKEND.
3156 BACKEND is either an export back-end, as returned by, e.g.,
3157 `org-export-create-backend', or a symbol referring to
3158 a registered back-end."
3164 ;;;###autoload
3166 "Insert all export keywords with default values at beginning of line.
3168 BACKEND is a symbol referring to the name of a registered export
3169 back-end, for which specific export options should be added to
3170 the template, or `default' for default template. When it is nil,
3171 the user will be prompted for a category.
3173 If SUBTREEP is non-nil, export configuration will be set up
3174 locally for the subtree through node properties."
3184 "Options category: "
3188 org-export-registered-backends))
3189 nil t))))
3190 options keywords)
3191 ;; Populate OPTIONS and KEYWORDS.
3208 ;; Move to an appropriate location in order to insert options.
3210 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3228 ;; Then the rest of keywords, in the order specified in either
3229 ;; `org-export-options-alist' or respective export back-ends.
3250 "Expand every include keyword in buffer.
3251 Optional argument INCLUDED is a list of included file names along
3252 with their line restriction, when appropriate. It is used to
3253 avoid infinite recursion. Optional argument DIR is the current
3254 working directory. It is used to properly resolve relative
3255 paths. Optional argument FOOTNOTES is a hash-table used for
3256 storing and resolving footnotes. It is created automatically."
3263 ;; If :minlevel is not set the text-property
3264 ;; `:org-include-induced-level' will be used to determine the
3265 ;; relative level when expanding INCLUDE.
3266 ;; Only affects included Org documents.
3270 :org-include-induced-level
3272 ;; Expand INCLUDE keywords.
3279 ;; Extract arguments from keyword's value.
3282 location
3287 coding-system-for-read))
3290 value)
3295 matched)
3300 dir)))
3304 value)
3310 value)
3319 ;; Minimal level of included file defaults to the
3320 ;; child level of the current headline, if any, or
3321 ;; one. It only applies is the file is meant to be
3322 ;; included as an Org one.
3333 ;; Remove keyword.
3339 ;; Check if files has already been parsed. Look after
3340 ;; inclusion lines too, as different parts of the same
3341 ;; file can be included too.
3354 ind-str block arg-str contents ind-str block))))
3361 ind-str block contents ind-str block))))
3369 file location only-contents lines)
3370 lines)))
3374 file lines ind minlevel
3378 file-prefix))
3379 footnotes
3380 includer-file)))
3384 footnotes)
3386 ;; Expand footnotes after all files have been
3387 ;; included. Footnotes are stored at end of buffer.
3393 footnotes))))))))))))
3396 "Resolve absolute lines for an included file with file-link.
3398 FILE is string file-name of the file to include. LOCATION is a
3399 string name within FILE to be included (located via
3400 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3401 contents of the named element will be included, as determined
3402 Org-Element. If LINES is non-nil only those lines are included.
3404 Return a string of lines to be included in the format expected by
3405 `org-export--prepare-file-contents'."
3411 ;; Enforce consistent search.
3424 ;; Skip planning line and property-drawer.
3450 start-line
3452 (+ start-line
3455 counter))))))))
3458 "Update relative file name of link at point, if possible.
3460 FILE-DIR is the directory of the file being included.
3461 INCLUDER-DIR is the directory of the file where the inclusion is
3462 going to happen.
3464 Move point after the link."
3472 includer-dir))
3485 "Prepare contents of FILE for inclusion and return it as a string.
3487 When optional argument LINES is a string specifying a range of
3488 lines, include only those lines.
3490 Optional argument IND, when non-nil, is an integer specifying the
3491 global indentation of returned contents. Since its purpose is to
3492 allow an included file to stay in the same environment it was
3493 created (e.g., a list item), it doesn't apply past the first
3494 headline encountered.
3496 Optional argument MINLEVEL, when non-nil, is an integer
3497 specifying the level that any top-level headline in the included
3498 file should have.
3500 Optional argument ID is an integer that will be inserted before
3501 each footnote definition and reference if FILE is an Org file.
3502 This is useful to avoid conflicts when more than one Org file
3503 with footnotes is included in a document.
3505 Optional argument FOOTNOTES is a hash-table to store footnotes in
3506 the included document.
3508 Optional argument INCLUDER is the file name where the inclusion
3509 is to happen."
3525 ;; Adapt all file links within the included document that contain
3526 ;; relative paths in order to make these paths relative to the
3527 ;; base document, or absolute.
3541 ;; Look for file links within link's description.
3542 ;; Org doesn't support such construct, but
3543 ;; `org-export-insert-image-links' may activate
3544 ;; them.
3554 file-dir includer-dir))
3556 ;; Update current link, if necessary.
3560 file-dir includer-dir))))))))))
3561 ;; Remove blank lines at beginning and end of contents. The logic
3562 ;; behind that removal is that blank lines around include keyword
3563 ;; override blank lines in included file.
3572 ;; If IND is set, preserve indentation of include keyword until
3573 ;; the first headline encountered.
3580 ;; Do not move footnote definitions out of column 0.
3586 ;; When MINLEVEL is specified, compute minimal level for headlines
3587 ;; in the file (CUR-MIN), and remove stars to each headline so
3588 ;; that headlines with minimal level have a level of MINLEVEL.
3599 ;; Only change stars, don't bother moving whole
3600 ;; sections.
3605 ;; Append ID to all footnote references and definitions, so they
3606 ;; become file specific and cannot collide with footnotes in other
3607 ;; included files. Further, collect relevant footnote definitions
3608 ;; outside of LINES, in order to reintroduce them later.
3614 ;; Generate new label from LABEL by prefixing it with
3615 ;; "-ID-".
3619 ;; Replace OLD label with NEW in footnote F.
3633 ;; Update the footnote-reference at point and collect
3634 ;; the new label, which is only used for footnotes
3635 ;; outsides LINES.
3647 ;; Store since footnote-definition is
3648 ;; outside of LINES.
3651 footnotes))))
3658 "Return a non-nil value when output should be added to the kill ring.
3659 See also `org-export-copy-to-kill-ring'."
3665 \f
3666 ;;; Tools For Back-Ends
3667 ;;
3668 ;; A whole set of tools is available to help build new exporters. Any
3669 ;; function general enough to have its use across many back-ends
3670 ;; should be added here.
3672 ;;;; For Affiliated Keywords
3673 ;;
3674 ;; `org-export-read-attribute' reads a property from a given element
3675 ;; as a plist. It can be used to normalize affiliated keywords'
3676 ;; syntax.
3677 ;;
3678 ;; Since captions can span over multiple lines and accept dual values,
3679 ;; their internal representation is a bit tricky. Therefore,
3680 ;; `org-export-get-caption' transparently returns a given element's
3681 ;; caption as a secondary string.
3684 "Turn ATTRIBUTE property from ELEMENT into a plist.
3686 When optional argument PROPERTY is non-nil, return the value of
3687 that property within attributes.
3691 properties.
3693 All values will become strings except the empty string and
3696 will become the empty string."
3710 s)
3715 ;; Ignore any string before first property with `cdr'.
3720 "Return caption from ELEMENT as a secondary string.
3722 When optional argument SHORTP is non-nil, return short caption,
3723 as a secondary string, instead.
3725 Caption lines are separated by a white space."
3733 ;;;; For Derived Back-ends
3734 ;;
3735 ;; `org-export-with-backend' is a function allowing to locally use
3736 ;; another back-end to transcode some object or element. In a derived
3737 ;; back-end, it may be used as a fall-back function once all specific
3738 ;; cases have been treated.
3741 "Call a transcoder from BACKEND on DATA.
3742 BACKEND is an export back-end, as returned by, e.g.,
3743 `org-export-create-backend', or a symbol referring to
3744 a registered back-end. DATA is an Org element, object, secondary
3745 string or string. CONTENTS, when non-nil, is the transcoded
3746 contents of DATA element, as a string. INFO, when non-nil, is
3747 the communication channel used for export, as a plist."
3758 :back-end backend
3759 :translate-alist all-transcoders
3761 ;; `:internal-references' are shared across back-ends.
3769 ;;;; For Export Snippets
3770 ;;
3771 ;; Every export snippet is transmitted to the back-end. Though, the
3772 ;; latter will only retain one type of export-snippet, ignoring
3773 ;; others, based on the former's target back-end. The function
3774 ;; `org-export-snippet-backend' returns that back-end for a given
3775 ;; export-snippet.
3778 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3779 Translation, with `org-export-snippet-translation-alist', is
3780 applied."
3784 back-end))))
3787 ;;;; For Footnotes
3788 ;;
3789 ;; `org-export-collect-footnote-definitions' is a tool to list
3790 ;; actually used footnotes definitions in the whole parse tree, or in
3791 ;; a headline, in order to add footnote listings throughout the
3792 ;; transcoded data.
3793 ;;
3794 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3795 ;; back-ends, when they need to attach the footnote definition only to
3796 ;; the first occurrence of the corresponding label.
3797 ;;
3798 ;; `org-export-get-footnote-definition' and
3799 ;; `org-export-get-footnote-number' provide easier access to
3800 ;; additional information relative to a footnote reference.
3803 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3804 INFO is the plist used as a communication channel. If no such
3805 definition can be found, raise an error."
3811 hash))))
3819 ;; Skip any footnote with a different label.
3820 ;; Also skip any standard footnote reference
3821 ;; with the same label since those cannot
3822 ;; contain a definition.
3826 ;; Even if the contents are empty, we can not
3827 ;; return nil since that would eventually raise
3828 ;; the error. Instead, return the equivalent
3829 ;; empty string.
3831 info t)
3832 cache)
3837 "Apply FUNCTION on every footnote reference in DATA.
3838 INFO is a plist containing export state. By default, as soon as
3839 a new footnote reference is encountered, FUNCTION is called onto
3840 its definition. However, if BODY-FIRST is non-nil, this step is
3841 delayed until the end of the process."
3846 ;; Search footnote references through DATA, filling
3847 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3848 ;; store footnote definitions so they can be entered
3849 ;; later.
3856 ;; Search for subsequent references in footnote
3857 ;; definition so numbering follows reading
3858 ;; logic, unless DELAYP in non-nil.
3862 definitions))
3863 ;; Do not force entering inline definitions,
3864 ;; since `org-element-map' already traverses
3865 ;; them at the right time.
3869 nil))))))
3870 info nil
3871 ;; Don't enter footnote definitions since it will
3872 ;; happen when their first reference is found.
3873 ;; Moreover, if DELAYP is non-nil, make sure we
3874 ;; postpone entering definitions of inline references.
3881 "Return an alist between footnote numbers, labels and definitions.
3883 INFO is the current export state, as a plist.
3885 Definitions are collected throughout the whole parse tree, or
3886 DATA when non-nil.
3888 Sorting is done by order of references. As soon as a new
3889 reference is encountered, other references are searched within
3890 its definition. However, if BODY-FIRST is non-nil, this step is
3891 delayed after the whole tree is checked. This alters results
3892 when references are found in footnote definitions.
3894 Definitions either appear as Org data or as a secondary string
3895 for inlined footnotes. Unreferenced definitions are ignored."
3899 ;; Collect footnote number, label and definition.
3910 "Non-nil when a footnote reference is the first one for its label.
3912 FOOTNOTE-REFERENCE is the footnote reference being considered.
3913 INFO is a plist containing current export state.
3915 Search is done throughout the whole parse tree, or DATA when
3916 non-nil.
3918 By default, as soon as a new footnote reference is encountered,
3919 other references are searched within its definition. However, if
3920 BODY-FIRST is non-nil, this step is delayed after the whole tree
3921 is checked. This alters results when references are found in
3922 footnote definitions."
3924 ;; Anonymous footnotes are always a first reference.
3935 "Return number associated to a footnote.
3937 FOOTNOTE is either a footnote reference or a footnote definition.
3938 INFO is the plist containing export state.
3940 Number is unique throughout the whole parse tree, or DATA, when
3941 non-nil.
3943 By default, as soon as a new footnote reference is encountered,
3944 counting process moves into its definition. However, if
3945 BODY-FIRST is non-nil, this step is delayed until the end of the
3946 process, leading to a different order when footnotes are nested."
3955 ;; Anonymous footnote match: return number.
3957 ;; Labels match: return number.
3959 ;; Otherwise store label and increase counter if label
3960 ;; wasn't encountered yet.
3966 ;;;; For Headlines
3967 ;;
3968 ;; `org-export-get-relative-level' is a shortcut to get headline
3969 ;; level, relatively to the lower headline level in the parsed tree.
3970 ;;
3971 ;; `org-export-get-headline-number' returns the section number of an
3972 ;; headline, while `org-export-number-to-roman' allows it to be
3973 ;; converted to roman numbers. With an optional argument,
3974 ;; `org-export-get-headline-number' returns a number to unnumbered
3975 ;; headlines (used for internal id).
3976 ;;
3977 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3978 ;; `org-export-last-sibling-p' are three useful predicates when it
3979 ;; comes to fulfill the `:headline-levels' property.
3980 ;;
3981 ;; `org-export-get-tags', `org-export-get-category' and
3982 ;; `org-export-get-node-property' extract useful information from an
3983 ;; headline or a parent headline. They all handle inheritance.
3984 ;;
3985 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3986 ;; as a secondary string, suitable for table of contents. It falls
3987 ;; back onto default title.
3990 "Return HEADLINE relative level within current parsed tree.
3991 INFO is a plist holding contextual information."
3996 "Non-nil when HEADLINE is considered as low level.
3998 INFO is a plist used as a communication channel.
4000 A low level headlines has a relative level greater than
4001 `:headline-levels' property value.
4003 Return value is the difference between HEADLINE relative level
4004 and the last level being considered as high enough, or nil."
4011 "Return numbered HEADLINE numbering as a list of numbers.
4012 INFO is a plist holding contextual information."
4017 "Return a non-nil value if HEADLINE element should be numbered.
4018 INFO is a plist used as a communication channel."
4025 "Convert integer N into a roman numeral."
4038 res)))
4041 "Return list of tags associated to ELEMENT.
4043 ELEMENT has either an `headline' or an `inlinetask' type. INFO
4044 is a plist used as a communication channel.
4046 When non-nil, optional argument TAGS should be a list of strings.
4047 Any tag belonging to this list will also be removed.
4049 When optional argument INHERITED is non-nil, tags can also be
4050 inherited from parent headlines and FILETAGS keywords."
4054 ;; Build complete list of inherited tags.
4061 ;; Add FILETAGS keywords and return results.
4065 "Return node PROPERTY value for DATUM.
4067 PROPERTY is an upcase symbol (e.g., `:COOKIE_DATA'). DATUM is an
4068 element or object.
4070 If optional argument INHERITED is non-nil, the value can be
4071 inherited from a parent headline.
4073 Return value is a string or nil."
4085 "Return category for element or object BLOB.
4087 INFO is a plist used as a communication channel.
4089 CATEGORY is automatically inherited from a parent headline, from
4090 #+CATEGORY: keyword or created out of original file name. If all
4103 "Return alternative title for HEADLINE, as a secondary string.
4104 If no optional title is defined, fall-back to the regular title."
4111 "Non-nil when BLOB is the first sibling in its parent.
4112 BLOB is an element or an object. If BLOB is a headline, non-nil
4113 means it is the first sibling in the sub-tree. INFO is a plist
4114 used as a communication channel."
4119 "Non-nil when DATUM is the last sibling in its parent.
4120 DATUM is an element or an object. INFO is a plist used as
4121 a communication channel."
4129 ;;;; For Keywords
4130 ;;
4131 ;; `org-export-get-date' returns a date appropriate for the document
4132 ;; to about to be exported. In particular, it takes care of
4133 ;; `org-export-date-timestamp-format'.
4136 "Return date value for the current document.
4138 INFO is a plist used as a communication channel. FMT, when
4139 non-nil, is a time format string that will be applied on the date
4140 if it consists in a single timestamp object. It defaults to
4141 `org-export-date-timestamp-format' when nil.
4143 A proper date can be a secondary string, a string or nil. It is
4144 meant to be translated with `org-export-data' or alike."
4155 ;;;; For Links
4156 ;;
4157 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4158 ;; in `org-link-parameters'.
4159 ;;
4160 ;; `org-export-get-coderef-format' returns an appropriate format
4161 ;; string for coderefs.
4162 ;;
4163 ;; `org-export-inline-image-p' returns a non-nil value when the link
4164 ;; provided should be considered as an inline image.
4165 ;;
4166 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4167 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4168 ;; returns an appropriate unique identifier.
4169 ;;
4170 ;; `org-export-resolve-id-link' returns the first headline with
4171 ;; specified id or custom-id in parse tree, the path to the external
4172 ;; file with the id.
4173 ;;
4174 ;; `org-export-resolve-coderef' associates a reference to a line
4175 ;; number in the element it belongs, or returns the reference itself
4176 ;; when the element isn't numbered.
4177 ;;
4178 ;; `org-export-file-uri' expands a filename as stored in :path value
4179 ;; of a "file" link into a file URI.
4180 ;;
4181 ;; Broken links raise a `org-link-broken' error, which is caught by
4182 ;; `org-export-data' for further processing, depending on
4183 ;; `org-export-with-broken-links' value.
4188 "Try exporting LINK with a dedicated function.
4190 DESC is its description, as a string, or nil. BACKEND is the
4191 back-end used for export, as a symbol.
4193 Return output as a string, or nil if no protocol handles LINK.
4195 A custom protocol has precedence over regular back-end export.
4196 The function ignores links with an implicit type (e.g.,
4205 desc
4206 backend))))))
4209 "Return format string for code reference link.
4210 PATH is the link path. DESC is its description."
4218 "Non-nil if LINK object points to an inline image.
4220 Optional argument is a set of RULES defining inline images. It
4221 is an alist where associations have the following shape:
4223 (TYPE . REGEXP)
4225 Applying a rule means apply REGEXP against LINK's path when its
4226 type is TYPE. The function will return a non-nil value if any of
4227 the provided rules is non-nil. The default rule is
4228 `org-export-default-inline-image-rule'.
4230 This only applies to links without a description."
4240 "Insert image links in DATA.
4242 Org syntax does not support nested links. Nevertheless, some
4243 export back-ends support images as descriptions of links. Since
4244 images are really links to image files, we need to make an
4245 exception about links nesting.
4247 This function recognizes links whose contents are really images
4248 and turn them into proper nested links. It is meant to be used
4249 as a parse tree filter in back-ends supporting such constructs.
4251 DATA is a parse tree. INFO is the current state of the export
4252 process, as a plist.
4254 A description is a valid images if it matches any rule in RULES,
4255 if non-nil, or `org-export-default-inline-image-rule' otherwise.
4256 See `org-export-inline-image-p' for more information about the
4257 structure of RULES.
4259 Return modified DATA."
4261 org-link-plain-re
4262 org-link-angle-re))
4275 ;; Replace contents with image link.
4281 info nil nil t))
4282 data)
4285 "Resolve a code reference REF.
4287 INFO is a plist used as a communication channel.
4289 Return associated line number in source code, or REF itself,
4290 depending on src-block or example element's switches. Throw an
4291 error if no block contains REF."
4297 org-coderef-label-format))
4299 ;; Element containing REF is found. Resolve it to
4300 ;; either a label or a line number, as needed.
4309 "List search cells for element or object DATUM.
4311 A search cell follows the pattern (TYPE . SEARCH) where
4313 TYPE is a symbol among `headline', `custom-id', `target' and
4314 `other'.
4316 SEARCH is the string a link is expected to match. More
4317 accurately, it is
4319 - headline's title, as a list of strings, if TYPE is
4320 `headline'.
4322 - CUSTOM_ID value, as a string, if TYPE is `custom-id'.
4324 - target's or radio-target's name as a list of strings if
4325 TYPE is `target'.
4327 - NAME affiliated keyword if TYPE is `other'.
4329 A search cell is the internal representation of a fuzzy link. It
4330 ignores white spaces and statistics cookies, if applicable."
4332 (`headline
4343 (`target
4351 "Return search cells associated to string S.
4352 S is either the path of a fuzzy link or a search option, i.e., it
4353 tries to match either a headline (through custom ID or title),
4354 a target or a named element."
4362 "Non-nil when DATUM matches search cells CELLS.
4363 DATUM is an element or object. CELLS is a list of search cells,
4364 as returned by `org-export-search-cells'."
4369 "Return LINK destination.
4371 INFO is a plist holding contextual information.
4373 Return value can be an object or an element:
4375 - If LINK path matches a target object (i.e. <<path>>) return it.
4377 - If LINK path exactly matches the name affiliated keyword
4378 (i.e. #+NAME: path) of an element, return that element.
4380 - If LINK path exactly matches any headline name, return that
4381 element.
4383 - Otherwise, throw an error.
4385 PSEUDO-TYPES are pseudo-elements types, i.e., elements defined
4386 specifically in an export back-end, that could have a name
4387 affiliated keyword.
4390 significant."
4396 table)))
4404 datum)))))
4408 search-cells
4409 ;; There can be multiple matches for un-typed searches, i.e.,
4410 ;; for searches not starting with # or *. In this case,
4411 ;; prioritize targets and names over headline titles.
4412 ;; Matching both a name and a target is not valid, and
4413 ;; therefore undefined.
4416 datum))
4417 matches)
4419 link-cache)))))
4422 "Return headline referenced as LINK destination.
4424 INFO is a plist used as a communication channel.
4426 Return value can be the headline element matched in current parse
4430 ;; First check if id is within the current parse tree.
4435 headline))
4437 ;; Otherwise, look for external files.
4442 "Return radio-target object referenced as LINK destination.
4444 INFO is a plist used as a communication channel.
4446 Return value can be a radio-target object or nil. Assume LINK
4455 nil nil path nil nil t)
4456 t)
4457 radio))
4461 "Return file URI associated to FILENAME."
4468 fullname)))))
4470 ;;;; For References
4471 ;;
4472 ;; `org-export-get-reference' associate a unique reference for any
4473 ;; object or element. It uses `org-export-new-reference' and
4474 ;; `org-export-format-reference' to, respectively, generate new
4475 ;; internal references and turn them into a string suitable for
4476 ;; output.
4477 ;;
4478 ;; `org-export-get-ordinal' associates a sequence number to any object
4479 ;; or element.
4482 "Return a unique reference, among REFERENCES.
4483 REFERENCES is an alist whose values are in-use references, as
4484 numbers. Returns a number, which is the internal representation
4485 of a reference. See also `org-export-format-reference'."
4486 ;; Generate random 7 digits hexadecimal numbers. Collisions
4487 ;; increase exponentially with the numbers of references. However,
4488 ;; the odds for encountering at least one collision with 1000 active
4489 ;; references in the same document are roughly 0.2%, so this
4490 ;; shouldn't be the bottleneck.
4493 new))
4496 "Format REFERENCE into a string.
4497 REFERENCE is a number representing a reference, as returned by
4498 `org-export-new-reference', which see."
4502 "Return a unique reference for DATUM, as a string.
4504 DATUM is either an element or an object. INFO is the current
4505 export state, as a plist.
4507 References for the current document are stored in
4508 `:internal-references' property. Its value is an alist with
4509 associations of the following types:
4511 (REFERENCE . DATUM) and (SEARCH-CELL . ID)
4513 REFERENCE is the reference string to be used for object or
4514 element DATUM. SEARCH-CELL is a search cell, as returned by
4515 `org-export-search-cells'. ID is a number or a string uniquely
4516 identifying DATUM within the document.
4518 This function also checks `:crossrefs' property for search cells
4519 matching DATUM before creating a new reference."
4524 ;; Preserve any pre-existing association between
4525 ;; a search cell and a reference, i.e., when some
4526 ;; previously published document referenced a location
4527 ;; within current file (see
4528 ;; `org-publish-resolve-external-link').
4529 ;;
4530 ;; However, there is no guarantee that search cells are
4531 ;; unique, e.g., there might be duplicate custom ID or
4532 ;; two headings with the same title in the file.
4533 ;;
4534 ;; As a consequence, before re-using any reference to
4535 ;; an element or object, we check that it doesn't refer
4536 ;; to a previous element or object.
4543 cells)
4546 ;; Cache contains both data already associated to
4547 ;; a reference and in-use internal references, so as to make
4548 ;; unique references.
4550 ;; Retain a direct association between reference string and
4551 ;; DATUM since (1) not every object or element can be given
4552 ;; a search cell (2) it permits quick lookup.
4555 reference-string))))
4558 "Return ordinal number of an element or object.
4560 ELEMENT is the element or object considered. INFO is the plist
4561 used as a communication channel.
4563 Optional argument TYPES, when non-nil, is a list of element or
4564 object types, as symbols, that should also be counted in.
4565 Otherwise, only provided element's type is considered.
4567 Optional argument PREDICATE is a function returning a non-nil
4568 value if the current element or object should be counted in. It
4569 accepts two arguments: the element or object being considered and
4570 the plist used as a communication channel. This allows counting
4571 only a certain type of object (i.e. inline images).
4573 Return value is a list of numbers if ELEMENT is a headline or an
4574 item. It is nil for keywords. It represents the footnote number
4575 for footnote definitions and footnote references. If ELEMENT is
4576 a target, return the same value as if ELEMENT was the closest
4577 table, item or headline containing the target. In any other
4578 case, return the sequence number of ELEMENT among elements or
4579 objects of the same type."
4580 ;; Ordinal of a target object refer to the ordinal of the closest
4581 ;; table, item, or headline containing the object.
4585 element
4588 ;; Special case 1: A headline returns its number as a list.
4590 ;; Special case 2: An item returns its number as a list.
4594 struct
4601 ;; Increment counter until ELEMENT is found again.
4612 ;;;; For Src-Blocks
4613 ;;
4614 ;; `org-export-get-loc' counts number of code lines accumulated in
4615 ;; src-block or example-block elements with a "+n" switch until
4616 ;; a given element, excluded. Note: "-n" switches reset that count.
4617 ;;
4618 ;; `org-export-unravel-code' extracts source code (along with a code
4619 ;; references alist) from an `element-block' or `src-block' type
4620 ;; element.
4621 ;;
4622 ;; `org-export-format-code' applies a formatting function to each line
4623 ;; of code, providing relative line number and code reference when
4624 ;; appropriate. Since it doesn't access the original element from
4625 ;; which the source code is coming, it expects from the code calling
4626 ;; it to know if lines should be numbered and if code references
4627 ;; should appear.
4628 ;;
4629 ;; Eventually, `org-export-format-code-default' is a higher-level
4630 ;; function (it makes use of the two previous functions) which handles
4631 ;; line numbering and code references inclusion, and returns source
4632 ;; code in a format suitable for plain text or verbatim output.
4635 "Return count of lines of code before ELEMENT.
4637 ELEMENT is an example-block or src-block element. INFO is the
4638 plist used as a communication channel.
4640 Count includes every line of code in example-block or src-block
4642 ELEMENT doesn't allow line numbering."
4649 ;; ELEMENT is reached: Quit loop and return locs.
4651 ;; Only count lines from src-block and example-block
4652 ;; elements with a "+n" or "-n" switch.
4657 ;; Accumulate locs or reset them.
4665 "Clean source code and extract references out of it.
4667 ELEMENT has either a `src-block' an `example-block' type.
4669 Return a cons cell whose CAR is the source code, cleaned from any
4670 reference, protective commas and spurious indentation, and CDR is
4671 an alist between relative line number (integer) and name of code
4672 reference on that line (string)."
4675 ;; Remove global indentation from code, if necessary. Also
4676 ;; remove final newline character, since it doesn't belongs
4677 ;; to the code proper.
4682 value
4684 ;; Build a regexp matching a loc with a reference.
4686 ;; Return value.
4688 ;; Code with references removed.
4693 ;; Ref line: remove ref, and add its position in REFS.
4697 ;; Reference alist.
4698 refs)))
4701 "Format CODE by applying FUN line-wise and return it.
4703 CODE is a string representing the code to format. FUN is
4704 a function. It must accept three arguments: a line of
4705 code (string), the current line number (integer) or nil and the
4706 reference associated to the current line (string) or nil.
4708 Optional argument NUM-LINES can be an integer representing the
4709 number of code lines accumulated until the current code. Line
4710 numbers passed to FUN will take it into account. If it is nil,
4711 FUN's second argument will always be nil. This number can be
4712 obtained with `org-export-get-loc' function.
4714 Optional argument REF-ALIST can be an alist between relative line
4715 number (i.e. ignoring NUM-LINES) and the name of the code
4716 reference on it. If it is nil, FUN's third argument will always
4717 be nil. It can be obtained through the use of
4718 `org-export-unravel-code' function."
4731 "Return source code from ELEMENT, formatted in a standard way.
4733 ELEMENT is either a `src-block' or `example-block' element. INFO
4734 is a plist used as a communication channel.
4736 This function takes care of line numbering and code references
4737 inclusion. Line numbers, when applicable, appear at the
4738 beginning of the line, separated from the code by two white
4739 spaces. Code references, on the other hand, appear flushed to
4740 the right, separated by six white spaces from the widest line of
4741 code."
4742 ;; Extract code and references.
4749 ;; Handle line numbering.
4756 ;; Prepare references display, if required. Any reference
4757 ;; should start six columns after the widest line of code,
4758 ;; wrapped with parenthesis.
4763 code
4767 number-str
4768 loc
4772 ?\s)
4774 num-start refs)))))
4777 ;;;; For Tables
4778 ;;
4779 ;; `org-export-table-has-special-column-p' and and
4780 ;; `org-export-table-row-is-special-p' are predicates used to look for
4781 ;; meta-information about the table structure.
4782 ;;
4783 ;; `org-table-has-header-p' tells when the rows before the first rule
4784 ;; should be considered as table's header.
4785 ;;
4786 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4787 ;; and `org-export-table-cell-borders' extract information from
4788 ;; a table-cell element.
4789 ;;
4790 ;; `org-export-table-dimensions' gives the number on rows and columns
4791 ;; in the table, ignoring horizontal rules and special columns.
4792 ;; `org-export-table-cell-address', given a table-cell object, returns
4793 ;; the absolute address of a cell. On the other hand,
4794 ;; `org-export-get-table-cell-at' does the contrary.
4795 ;;
4796 ;; `org-export-table-cell-starts-colgroup-p',
4797 ;; `org-export-table-cell-ends-colgroup-p',
4798 ;; `org-export-table-row-starts-rowgroup-p',
4799 ;; `org-export-table-row-ends-rowgroup-p',
4800 ;; `org-export-table-row-starts-header-p',
4801 ;; `org-export-table-row-ends-header-p' and
4802 ;; `org-export-table-row-in-header-p' indicate position of current row
4803 ;; or cell within the table.
4806 "Non-nil when TABLE has a special column.
4807 All special columns will be ignored during export."
4808 ;; The table has a special column when every first cell of every row
4809 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4810 ;; "*" "_" and "^". Though, do not consider a first column
4811 ;; containing only empty cells as special.
4826 "Non-nil when TABLE has a header.
4828 INFO is a plist used as a communication channel.
4830 A table has a header when it contains at least two row groups."
4834 table)))
4851 nil)))
4853 cache)))))
4856 "Non-nil if TABLE-ROW is considered special.
4857 All special rows will be ignored during export."
4861 ;; A row is special either when...
4863 ;; ... it starts with a field only containing "/",
4865 ;; ... the table contains a special column and the row start
4866 ;; with a marking character among, "^", "_", "$" or "!",
4870 ;; ... it contains only alignment cookies and empty cells.
4875 ;; Since VALUE is a secondary string, the following
4876 ;; checks avoid expanding it with `org-export-data'.
4887 "Return TABLE-ROW's group number, as an integer.
4889 INFO is a plist used as the communication channel.
4891 Return value is the group number, as an integer, or nil for
4892 special rows and rows separators. First group is also table's
4893 header."
4898 table)))
4901 ;; First time a row is queried, populate cache with all the
4902 ;; rows from the table.
4911 info))
4915 "Return TABLE-CELL contents width.
4917 INFO is a plist used as the communication channel.
4919 Return value is the width given by the last width cookie in the
4920 same column as TABLE-CELL, or nil."
4929 table)))
4938 ;; In a special row, try to find a width cookie at COLUMN.
4942 ;; The following checks avoid expanding unnecessarily
4943 ;; the cell with `org-export-data'.
4953 "Return TABLE-CELL contents alignment.
4955 INFO is a plist used as the communication channel.
4957 Return alignment as specified by the last alignment cookie in the
4958 same column as TABLE-CELL. If no such cookie is found, a default
4959 alignment value will be deduced from fraction of numbers in the
4960 column (see `org-table-number-fraction' for more information).
4961 Possible values are `left', `right' and `center'."
4962 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4972 table)))
4978 cookie-align
4979 previous-cell-number-p)
4982 ;; In a special row, try to find an alignment cookie at
4983 ;; COLUMN.
4987 ;; Since VALUE is a secondary string, the following
4988 ;; checks avoid useless expansion through
4989 ;; `org-export-data'.
4997 ;; Ignore table rules.
4999 ;; In a standard row, check if cell's contents are
5000 ;; expressing some kind of number. Increase NUMBER-CELLS
5001 ;; accordingly. Though, don't bother if an alignment
5002 ;; cookie has already defined cell's alignment.
5007 info)))
5009 ;; Treat an empty cell as a number if it follows
5010 ;; a number.
5016 ;; Return value. Alignment specified by cookies has
5017 ;; precedence over alignment deduced from cell's contents.
5019 column
5024 org-table-number-fraction)
5029 "Return TABLE-CELL borders.
5031 INFO is a plist used as a communication channel.
5033 Return value is a list of symbols, or nil. Possible values are:
5034 `top', `bottom', `above', `below', `left' and `right'. Note:
5035 `top' (resp. `bottom') only happen for a cell in the first
5036 row (resp. last row) of the table, ignoring table rules, if any.
5038 Returned borders ignore special rows."
5041 borders)
5042 ;; Top/above border? TABLE-CELL has a border above when a rule
5043 ;; used to demarcate row groups can be found above. Hence,
5044 ;; finding a rule isn't sufficient to push `above' in BORDERS:
5045 ;; another regular row has to be found above that rule.
5048 ;; Look at every row before the current one.
5056 ;; No rule above, or rule found starts the table (ignoring any
5057 ;; special row): TABLE-CELL is at the top of the table.
5060 ;; Bottom/below border? TABLE-CELL has a border below when next
5061 ;; non-regular row below is a rule.
5064 ;; Look at every row after the current one.
5072 ;; No rule below, or rule found ends the table (modulo some
5073 ;; special row): TABLE-CELL is at the bottom of the table.
5076 ;; Right/left borders? They can only be specified by column
5077 ;; groups. Column groups are defined in a row starting with "/".
5078 ;; Also a column groups row only contains "<", "<>", ">" or blank
5079 ;; cells.
5083 ;; Table rows are read in reverse order so last column groups
5084 ;; row has precedence over any previous one.
5097 ;; There's a left border when previous cell, if
5098 ;; any, ends a group, or current one starts one.
5104 ;; There's a right border when next cell, if any,
5105 ;; starts a group, or current one ends one.
5112 ;; Return value.
5113 borders))
5116 "Non-nil when TABLE-CELL is at the beginning of a column group.
5117 INFO is a plist used as a communication channel."
5118 ;; A cell starts a column group either when it is at the beginning
5119 ;; of a row (or after the special column, if any) or when it has
5120 ;; a left border.
5123 table-cell)
5127 "Non-nil when TABLE-CELL is at the end of a column group.
5128 INFO is a plist used as a communication channel."
5129 ;; A cell ends a column group either when it is at the end of a row
5130 ;; or when it has a right border.
5133 table-cell)
5137 "Non-nil when TABLE-ROW is at the beginning of a row group.
5138 INFO is a plist used as a communication channel."
5147 "Non-nil when TABLE-ROW is at the end of a row group.
5148 INFO is a plist used as a communication channel."
5157 "Non-nil when TABLE-ROW is located within table's header.
5158 INFO is a plist used as a communication channel. Always return
5159 nil for special rows and rows separators."
5165 "Non-nil when TABLE-ROW is the first table header's row.
5166 INFO is a plist used as a communication channel."
5171 "Non-nil when TABLE-ROW is the last table header's row.
5172 INFO is a plist used as a communication channel."
5177 "Return TABLE-ROW number.
5178 INFO is a plist used as a communication channel. Return value is
5179 zero-indexed and ignores separators. The function returns nil
5180 for special rows and separators."
5185 table)))
5188 ;; First time a row is queried, populate cache with all the
5189 ;; rows from the table.
5195 info))
5199 "Return TABLE dimensions.
5201 INFO is a plist used as a communication channel.
5203 Return value is a CONS like (ROWS . COLUMNS) where
5204 ROWS (resp. COLUMNS) is the number of exportable
5205 rows (resp. columns)."
5207 ;; Set number of rows, and extract first one.
5213 ;; Set number of columns.
5215 ;; Return value.
5219 "Return address of a regular TABLE-CELL object.
5221 TABLE-CELL is the cell considered. INFO is a plist used as
5222 a communication channel.
5224 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5225 zero-based index. Only exportable cells are considered. The
5226 function returns nil for other cells."
5238 "Return regular table-cell object at ADDRESS in TABLE.
5240 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5241 zero-based index. TABLE is a table type element. INFO is
5242 a plist used as a communication channel.
5244 If no table-cell, among exportable cells, is found at ADDRESS,
5245 return nil."
5248 ;; Row at (car address) or nil.
5256 'table-cell
5263 ;;;; For Tables of Contents
5264 ;;
5265 ;; `org-export-collect-headlines' builds a list of all exportable
5266 ;; headline elements, maybe limited to a certain depth. One can then
5267 ;; easily parse it and transcode it.
5268 ;;
5269 ;; Building lists of tables, figures or listings is quite similar.
5270 ;; Once the generic function `org-export-collect-elements' is defined,
5271 ;; `org-export-collect-tables', `org-export-collect-figures' and
5272 ;; `org-export-collect-listings' can be derived from it.
5273 ;;
5274 ;; `org-export-toc-entry-backend' builds a special anonymous back-end
5275 ;; useful to export table of contents' entries.
5278 "Collect headlines in order to build a table of contents.
5280 INFO is a plist used as a communication channel.
5282 When optional argument N is an integer, it specifies the depth of
5283 the table of contents. Otherwise, it is set to the value of the
5284 last headline level. See `org-export-headline-levels' for more
5285 information.
5287 Optional argument SCOPE, when non-nil, is an element. If it is
5288 a headline, only children of SCOPE are collected. Otherwise,
5289 collect children of the headline containing provided element. If
5290 there is no such headline, collect all headlines. In any case,
5291 argument N becomes relative to the level of that headline.
5293 Return a list of all exportable headlines as parsed elements.
5294 Footnote sections are ignored."
5303 limit))))
5310 h))
5311 info)))
5314 "Collect referenceable elements of a determined type.
5316 TYPE can be a symbol or a list of symbols specifying element
5317 types to search. Only elements with a caption are collected.
5319 INFO is a plist used as a communication channel.
5321 When non-nil, optional argument PREDICATE is a function accepting
5322 one argument, an element of type TYPE. It returns a non-nil
5323 value when that element should be collected.
5325 Return a list of all elements found, in order of appearance."
5330 element))
5331 info))
5334 "Build a list of tables.
5335 INFO is a plist used as a communication channel.
5337 Return a list of table elements with a caption."
5341 "Build a list of figures.
5343 INFO is a plist used as a communication channel. PREDICATE is
5344 a function which accepts one argument: a paragraph element and
5345 whose return value is non-nil when that element should be
5346 collected.
5348 A figure is a paragraph type element, with a caption, verifying
5350 a vague concept that may depend on back-end.
5352 Return a list of elements recognized as figures."
5356 "Build a list of source blocks.
5358 INFO is a plist used as a communication channel.
5360 Return a list of `src-block' elements with a caption."
5364 "Non-nil if HEADLINE should be excluded from tables of contents.
5366 INFO is a plist used as a communication channel.
5368 Note that such headlines are already excluded from
5369 `org-export-collect-headlines'. Therefore, this function is not
5370 necessary if you only need to list headlines in the table of
5371 contents. However, it is useful if some additional processing is
5372 required on headlines excluded from table of contents."
5378 "Return an export back-end appropriate for table of contents entries.
5380 PARENT is an export back-end the returned back-end should inherit
5381 from.
5383 By default, the back-end removes footnote references and targets.
5384 It also changes links and radio targets into regular text.
5385 TRANSCODERS optional argument, when non-nil, specifies additional
5386 transcoders. A transcoder follows the pattern (TYPE . FUNCTION)
5387 where type is an element or object type and FUNCTION the function
5388 transcoding it."
5391 :parent parent
5392 :transcoders
5399 i))))
5404 ;;;; Smart Quotes
5405 ;;
5406 ;; The main function for the smart quotes sub-system is
5407 ;; `org-export-activate-smart-quotes', which replaces every quote in
5408 ;; a given string from the parse tree with its "smart" counterpart.
5409 ;;
5410 ;; Dictionary for smart quotes is stored in
5411 ;; `org-export-smart-quotes-alist'.
5427 ;; one may use: »...«, "...", ›...‹, or '...'.
5428 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5429 ;; LaTeX quotes require Babel!
5489 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5500 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5511 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5522 ;; 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
5523 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5534 ;; Based on https://sl.wikipedia.org/wiki/Narekovaj
5545 ;; Based on https://sv.wikipedia.org/wiki/Citattecken
5551 "Smart quotes translations.
5553 Alist whose CAR is a language string and CDR is an alist with
5554 quote type as key and a plist associating various encodings to
5555 their translation as value.
5557 A quote type can be any symbol among `primary-opening',
5558 `primary-closing', `secondary-opening', `secondary-closing' and
5559 `apostrophe'.
5561 Valid encodings include `:utf-8', `:html', `:latex' and
5562 `:texinfo'.
5567 "Return smart quote status at the beginning of string S.
5568 INFO is the current export state, as a plist."
5573 table)))
5581 'plain-text
5590 ;; Not already in a level 1 quote: this is an
5591 ;; apostrophe.
5593 ;; Extract previous char and next char. As
5594 ;; a special case, they can also be set to `blank',
5595 ;; `no-blank' or nil. Then determine if current
5596 ;; match is allowed as an opening quote or a closing
5597 ;; quote.
5602 text info)))
5619 previous)
5630 next)
5637 current-status)
5641 info nil org-element-recursive-objects)
5648 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5649 `:utf-8'. INFO is a plist used as a communication channel.
5651 The function has to retrieve information about string
5652 surroundings in parse tree. It can only happen with an
5653 unmodified string. Thus, if S has already been through another
5654 process, a non-nil ORIGINAL optional argument will provide that
5655 original string.
5657 Return the new string."
5666 org-export-smart-quotes-alist))))
5667 encoding)
5668 match))
5669 s nil t)))
5671 ;;;; Topology
5672 ;;
5673 ;; Here are various functions to retrieve information about the
5674 ;; neighborhood of a given element or object. Neighbors of interest
5675 ;; are direct parent (`org-export-get-parent'), parent headline
5676 ;; (`org-export-get-parent-headline'), first element containing an
5677 ;; object, (`org-export-get-parent-element'), parent table
5678 ;; (`org-export-get-parent-table'), previous element or object
5679 ;; (`org-export-get-previous-element') and next element or object
5680 ;; (`org-export-get-next-element').
5682 ;; defsubst org-export-get-parent must be defined before first use
5685 "Return BLOB parent headline or nil.
5686 BLOB is the element or object being considered."
5690 "Return first element containing OBJECT or nil.
5691 OBJECT is the object to consider."
5695 "Return OBJECT parent table or nil.
5696 OBJECT is either a `table-cell' or `table-element' type object."
5700 "Return previous element or object.
5702 BLOB is an element or object. INFO is a plist used as
5703 a communication channel. Return previous exportable element or
5704 object, a string, or nil.
5706 When optional argument N is a positive integer, return a list
5707 containing up to N siblings before BLOB, from farthest to
5708 closest. With any other non-nil value, return a list containing
5709 all of them."
5715 prev)
5725 "Return next element or object.
5727 BLOB is an element or object. INFO is a plist used as
5728 a communication channel. Return next exportable element or
5729 object, a string, or nil.
5731 When optional argument N is a positive integer, return a list
5732 containing up to N siblings after BLOB, from closest to farthest.
5733 With any other non-nil value, return a list containing all of
5734 them."
5741 next)
5751 ;;;; Translation
5752 ;;
5753 ;; `org-export-translate' translates a string according to the language
5754 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5755 ;; the dictionary used for the translation.
5791 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5797 ("pt_BR" :html "Continuação da página anterior" :ascii "Continuacao da pagina anterior" :default "Continuação da página anterior")
5805 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5811 ("pt_BR" :html "Continua na próxima página" :ascii "Continua na proxima pagina" :default "Continua na próxima página")
5812 ("ru" :html "(Продолжение следует)"
5907 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5933 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5939 ("pt_BR" :html "Índice de Listagens" :default "Índice de Listagens" :ascii "Indice de Listagens")
5940 ("ru" :html "Список распечаток"
5958 ("pt_BR" :html "Índice de Tabelas" :default "Índice de Tabelas" :ascii "Indice de Tabelas")
5959 ("ru" :html "Список таблиц"
6114 ("pt_BR" :html "Referência desconhecida" :default "Referência desconhecida" :ascii "Referencia desconhecida")
6115 ("ru" :html "Неизвестная ссылка"
6119 "Dictionary for export engine.
6121 Alist whose car is the string to translate and cdr is an alist
6122 whose car is the language string and cdr is a plist whose
6123 properties are possible charsets and values translated terms.
6125 It is used as a database for `org-export-translate'. Since this
6126 function returns the string as-is if no translation was found,
6127 the variable only needs to record values different from the
6131 "Translate string S according to language specification.
6133 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
6134 and `:utf-8'. INFO is a plist used as a communication channel.
6136 Translation depends on `:language' property. Return the
6137 translated string. If no translation is found, try to fall back
6138 to `:default' encoding. If it fails, return S."
6144 s)))
6147 \f
6148 ;;; Asynchronous Export
6149 ;;
6150 ;; `org-export-async-start' is the entry point for asynchronous
6151 ;; export. It recreates current buffer (including visibility,
6152 ;; narrowing and visited file) in an external Emacs process, and
6153 ;; evaluates a command there. It then applies a function on the
6154 ;; returned results in the current process.
6155 ;;
6156 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
6157 ;; allow exporting to a buffer or a file, asynchronously or not.
6158 ;;
6159 ;; `org-export-output-file-name' is an auxiliary function meant to be
6160 ;; used with `org-export-to-file'. With a given extension, it tries
6161 ;; to provide a canonical file name to write export output to.
6162 ;;
6163 ;; Asynchronously generated results are never displayed directly.
6164 ;; Instead, they are stored in `org-export-stack-contents'. They can
6165 ;; then be retrieved by calling `org-export-stack'.
6166 ;;
6167 ;; Export Stack is viewed through a dedicated major mode
6168 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
6169 ;;`org-export-stack-delete', `org-export-stack-view' and
6170 ;;`org-export-stack-clear'.
6171 ;;
6172 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
6173 ;; It should be used whenever `org-export-async-start' is called.
6176 "Call function FUN on the results returned by BODY evaluation.
6178 FUN is an anonymous function of one argument. BODY evaluation
6179 happens in an asynchronous process, from a buffer which is an
6180 exact copy of the current one.
6182 Use `org-export-add-to-stack' in FUN in order to register results
6183 in the stack.
6185 This is a low level function. See also `org-export-to-buffer'
6186 and `org-export-to-file' for more specialized functions."
6189 ;; Write the full sexp evaluating BODY in a copy of the current
6190 ;; buffer to a temporary file, as it may be too long for program
6191 ;; args in `start-process'.
6198 ;; Null characters (from variable values) are inserted
6199 ;; within the file. As a consequence, coding system for
6200 ;; buffer contents will not be recognized properly. So,
6201 ;; we make sure it is the same as the one used to display
6202 ;; the original buffer.
6204 ,coding
6207 ;; Ignore `kill-emacs-hook' and code evaluation
6208 ;; queries from Babel as we need a truly
6209 ;; non-interactive process.
6211 org-babel-confirm-evaluate-answer-no t)
6212 ;; Initialize export framework.
6214 ;; Re-create current buffer there.
6217 ;; Sexp to evaluate in the buffer.
6219 ;; Start external process.
6222 (,process
6224 #'start-process
6227 ,proc-buffer
6234 ;; Register running process in stack.
6236 ;; Set-up sentinel in order to catch results.
6239 ,process
6261 ;;;###autoload
6264 &optional async subtreep visible-only body-only ext-plist
6265 post-process)
6266 "Call `org-export-as' with output to a specified buffer.
6268 BACKEND is either an export back-end, as returned by, e.g.,
6269 `org-export-create-backend', or a symbol referring to
6270 a registered back-end.
6272 BUFFER is the name of the output buffer. If it already exists,
6273 it will be erased first, otherwise, it will be created.
6275 A non-nil optional argument ASYNC means the process should happen
6276 asynchronously. The resulting buffer should then be accessible
6277 through the `org-export-stack' interface. When ASYNC is nil, the
6278 buffer is displayed if `org-export-show-temporary-export-buffer'
6279 is non-nil.
6281 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6282 EXT-PLIST are similar to those used in `org-export-as', which
6283 see.
6285 Optional argument POST-PROCESS is a function which should accept
6286 no argument. It is always called within the current process,
6287 from BUFFER, with point at its beginning. Export back-ends can
6288 use it to set a major mode there, e.g,
6290 (defun org-latex-export-as-latex
6291 (&optional async subtreep visible-only body-only ext-plist)
6292 (interactive)
6294 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
6296 This function returns BUFFER."
6324 buffer)))
6326 ;;;###autoload
6329 post-process)
6330 "Call `org-export-as' with output to a specified file.
6332 BACKEND is either an export back-end, as returned by, e.g.,
6333 `org-export-create-backend', or a symbol referring to
6334 a registered back-end. FILE is the name of the output file, as
6335 a string.
6337 A non-nil optional argument ASYNC means the process should happen
6338 asynchronously. The resulting buffer will then be accessible
6339 through the `org-export-stack' interface.
6341 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6342 EXT-PLIST are similar to those used in `org-export-as', which
6343 see.
6345 Optional argument POST-PROCESS is called with FILE as its
6346 argument and happens asynchronously when ASYNC is non-nil. It
6347 has to return a file name, or nil. Export back-ends can use this
6348 to send the output file through additional processing, e.g,
6350 (defun org-latex-export-to-latex
6351 (&optional async subtreep visible-only body-only ext-plist)
6352 (interactive)
6355 async subtreep visible-only body-only ext-plist
6356 (lambda (file) (org-latex-compile file)))
6358 The function returns either a file name returned by POST-PROCESS,
6359 or FILE."
6378 backend subtreep visible-only body-only ext-plist)))
6385 ;; Get proper return value.
6387 file))))))
6390 "Return output file's name according to buffer specifications.
6392 EXTENSION is a string representing the output file extension,
6393 with the leading dot.
6395 With a non-nil optional argument SUBTREEP, try to determine
6397 of subtree at point.
6399 When optional argument PUB-DIR is set, use it as the publishing
6400 directory.
6402 Return file name as a string."
6408 ;; Check EXPORT_FILE_NAME subtree property.
6410 ;; Check #+EXPORT_FILE_NAME keyword.
6420 ;; Extract from buffer's associated file, if any.
6422 ;; Can't determine file name on our own: ask user.
6424 "Output file: " pub-dir nil nil nil
6426 extension))
6428 ;; Build file name. Enforce EXTENSION over whatever user
6429 ;; may have come up with. PUB-DIR, if defined, always has
6430 ;; precedence over any provided path.
6436 ;; If writing to OUTPUT-FILE would overwrite original file, append
6437 ;; EXTENSION another time to final name.
6440 output-file)))
6443 "Add a new result to export stack if not present already.
6445 SOURCE is a buffer or a file name containing export results.
6446 BACKEND is a symbol representing export back-end used to generate
6447 it.
6449 Entries already pointing to SOURCE and unavailable entries are
6450 removed beforehand. Return the new stack."
6456 "Menu for asynchronous export results and running processes."
6466 "Remove all entries from export stack."
6471 "Refresh the export stack."
6476 "Remove export results at point from stack.
6477 If optional argument SOURCE is non-nil, remove it instead."
6482 org-export-stack-contents))))
6485 "View export results at point in stack.
6486 With an optional prefix argument IN-EMACS, force viewing files
6487 within Emacs."
6501 (define-key km "\C-p" 'previous-line)
6502 (define-key km "\C-?" 'previous-line)
6503 (define-key km [up] 'previous-line)
6504 (define-key km "C" 'org-export-stack-clear)
6505 (define-key km "v" 'org-export-stack-view)
6506 (define-key km (kbd "RET") 'org-export-stack-view)
6507 (define-key km "d" 'org-export-stack-remove)
6508 km)
6509 "Keymap for Org Export Stack.")
6511 (define-derived-mode org-export-stack-mode tabulated-list-mode "Org-Stack"
6512 "Mode for displaying asynchronous export stack.
6515 stack.
6517 In an Org Export Stack buffer, use \
6521 stack completely.
6523 Removing entries in a stack buffer does not affect files
6524 or buffers, only display.
6527 (setq tabulated-list-format
6528 (vector (list "#" 4 #'org-export--stack-num-predicate)
6529 (list "Back-End" 12 t)
6530 (list "Age" 6 nil)
6531 (list "Source" 0 nil)))
6532 (setq tabulated-list-sort-key (cons "#" nil))
6533 (setq tabulated-list-entries #'org-export--stack-generate)
6534 (add-hook 'tabulated-list-revert-hook #'org-export--stack-generate nil t)
6535 (add-hook 'post-command-hook #'org-export-stack-refresh nil t)
6536 (tabulated-list-init-header))
6538 (defun org-export--stack-generate ()
6539 "Generate the asynchronous export stack for display.
6540 Unavailable sources are removed from the list. Return a list
6541 appropriate for `tabulated-list-print'."
6542 ;; Clear stack from exited processes, dead buffers or non-existent
6543 ;; files.
6544 (setq org-export-stack-contents
6545 (cl-remove-if-not
6546 (lambda (el)
6547 (if (processp (nth 2 el))
6548 (buffer-live-p (process-buffer (nth 2 el)))
6549 (let ((source (car el)))
6550 (if (bufferp source) (buffer-live-p source)
6551 (file-exists-p source)))))
6552 org-export-stack-contents))
6553 ;; Update `tabulated-list-entries'.
6554 (let ((counter 0))
6555 (mapcar
6556 (lambda (entry)
6557 (let ((source (car entry)))
6558 (list source
6559 (vector
6560 ;; Counter.
6561 (number-to-string (cl-incf counter))
6562 ;; Back-End.
6563 (if (nth 1 entry) (symbol-name (nth 1 entry)) "")
6564 ;; Age.
6565 (let ((info (nth 2 entry)))
6566 (if (processp info) (symbol-name (process-status info))
6567 (format-seconds "%h:%.2m" (float-time (time-since info)))))
6568 ;; Source.
6569 (if (stringp source) source (buffer-name source))))))
6570 org-export-stack-contents)))
6572 (defun org-export--stack-num-predicate (a b)
6573 (< (string-to-number (aref (nth 1 a) 0))
6574 (string-to-number (aref (nth 1 b) 0))))
6576 (defun org-export--stack-source-at-point ()
6577 "Return source from export results at point in stack."
6578 (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
6579 (if (not source) (error "Source unavailable, please refresh buffer")
6580 (let ((source-name (if (stringp source) source (buffer-name source))))
6581 (if (save-excursion
6582 (beginning-of-line)
6583 (looking-at-p (concat ".* +" (regexp-quote source-name) "$")))
6584 source
6585 ;; SOURCE is not consistent with current line. The stack
6586 ;; view is outdated.
6587 (error (substitute-command-keys
6589 to refresh buffer")))))))
6592 \f
6593 ;;; The Dispatcher
6594 ;;
6595 ;; `org-export-dispatch' is the standard interactive way to start an
6596 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6597 ;; for its interface, which, in turn, delegates response to key
6598 ;; pressed to `org-export--dispatch-action'.
6600 ;;;###autoload
6601 (defun org-export-dispatch (&optional arg)
6602 "Export dispatcher for Org mode.
6604 It provides an access to common export related tasks in a buffer.
6605 Its interface comes in two flavors: standard and expert.
6607 While both share the same set of bindings, only the former
6608 displays the valid keys associations in a dedicated buffer.
6609 Scrolling (resp. line-wise motion) in this buffer is done with
6610 SPC and DEL (resp. C-n and C-p) keys.
6612 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6613 flavor or the other.
6616 same
6617 set of options used back then, on the current buffer.
6620 asynchronous export stack."
6621 (interactive "P")
6622 (let* ((input
6623 (cond ((equal arg '(16)) '(stack))
6624 ((and arg org-export-dispatch-last-action))
6625 (t (save-window-excursion
6626 (unwind-protect
6627 (progn
6628 ;; Remember where we are
6629 (move-marker org-export-dispatch-last-position
6630 (point)
6631 (org-base-buffer (current-buffer)))
6632 ;; Get and store an export command
6633 (setq org-export-dispatch-last-action
6634 (org-export--dispatch-ui
6635 (list org-export-initial-scope
6636 (and org-export-in-background 'async))
6637 nil
6638 org-export-dispatch-use-expert-ui)))
6639 (and (get-buffer "*Org Export Dispatcher*")
6640 (kill-buffer "*Org Export Dispatcher*")))))))
6641 (action (car input))
6642 (optns (cdr input)))
6643 (unless (memq 'subtree optns)
6644 (move-marker org-export-dispatch-last-position nil))
6645 (cl-case action
6646 ;; First handle special hard-coded actions.
6647 (template (org-export-insert-default-template nil optns))
6648 (stack (org-export-stack))
6649 (publish-current-file
6650 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6651 (publish-current-project
6652 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6653 (publish-choose-project
6654 (org-publish (assoc (completing-read
6655 "Publish project: "
6656 org-publish-project-alist nil t)
6657 org-publish-project-alist)
6658 (memq 'force optns)
6659 (memq 'async optns)))
6660 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6661 (otherwise
6662 (save-excursion
6663 (when arg
6664 ;; Repeating command, maybe move cursor to restore subtree
6665 ;; context.
6666 (if (eq (marker-buffer org-export-dispatch-last-position)
6667 (org-base-buffer (current-buffer)))
6668 (goto-char org-export-dispatch-last-position)
6669 ;; We are in a different buffer, forget position.
6670 (move-marker org-export-dispatch-last-position nil)))
6671 (funcall action
6672 ;; Return a symbol instead of a list to ease
6673 ;; asynchronous export macro use.
6674 (and (memq 'async optns) t)
6675 (and (memq 'subtree optns) t)
6676 (and (memq 'visible optns) t)
6677 (and (memq 'body optns) t)))))))
6679 (defun org-export--dispatch-ui (options first-key expertp)
6680 "Handle interface for `org-export-dispatch'.
6682 OPTIONS is a list containing current interactive options set for
6683 export. It can contain any of the following symbols:
6684 `body' toggles a body-only export
6685 `subtree' restricts export to current subtree
6686 `visible' restricts export to visible part of buffer.
6687 `force' force publishing files.
6688 `async' use asynchronous export process
6690 FIRST-KEY is the key pressed to select the first level menu. It
6691 is nil when this menu hasn't been selected yet.
6693 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6694 buffer is provided, but indications about currently active
6695 options are given in the prompt. Moreover, [?] allows switching
6696 back to standard interface."
6697 (let* ((fontify-key
6698 (lambda (key &optional access-key)
6699 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6700 ;; non-nil is the required first-level key to activate
6701 ;; KEY. When its value is t, activate KEY independently
6702 ;; on the first key, if any. A nil value means KEY will
6703 ;; only be activated at first level.
6704 (if (or (eq access-key t) (eq access-key first-key))
6705 (propertize key 'face 'org-warning)
6706 key)))
6707 (fontify-value
6708 (lambda (value)
6709 ;; Fontify VALUE string.
6710 (propertize value 'face 'font-lock-variable-name-face)))
6711 ;; Prepare menu entries by extracting them from registered
6712 ;; back-ends and sorting them by access key and by ordinal,
6713 ;; if any.
6714 (entries
6715 (sort (sort (delq nil
6716 (mapcar #'org-export-backend-menu
6717 org-export-registered-backends))
6718 (lambda (a b)
6719 (let ((key-a (nth 1 a))
6720 (key-b (nth 1 b)))
6721 (cond ((and (numberp key-a) (numberp key-b))
6722 (< key-a key-b))
6723 ((numberp key-b) t)))))
6724 'car-less-than-car))
6725 ;; Compute a list of allowed keys based on the first key
6726 ;; pressed, if any. Some keys
6727 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6728 ;; available.
6729 (allowed-keys
6730 (nconc (list 2 22 19 6 1)
6731 (if (not first-key) (org-uniquify (mapcar 'car entries))
6732 (let (sub-menu)
6733 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6734 (when (eq (car entry) first-key)
6735 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6736 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6737 ((not first-key) (list ?P)))
6738 (list ?& ?#)
6739 (when expertp (list ??))
6740 (list ?q)))
6741 ;; Build the help menu for standard UI.
6742 (help
6743 (unless expertp
6744 (concat
6745 ;; Options are hard-coded.
6746 (format "[%s] Body only: %s [%s] Visible only: %s
6747 \[%s] Export scope: %s [%s] Force publishing: %s
6749 (funcall fontify-key "C-b" t)
6750 (funcall fontify-value
6751 (if (memq 'body options) "On " "Off"))
6752 (funcall fontify-key "C-v" t)
6753 (funcall fontify-value
6754 (if (memq 'visible options) "On " "Off"))
6755 (funcall fontify-key "C-s" t)
6756 (funcall fontify-value
6757 (if (memq 'subtree options) "Subtree" "Buffer "))
6758 (funcall fontify-key "C-f" t)
6759 (funcall fontify-value
6760 (if (memq 'force options) "On " "Off"))
6761 (funcall fontify-key "C-a" t)
6762 (funcall fontify-value
6763 (if (memq 'async options) "On " "Off")))
6764 ;; Display registered back-end entries. When a key
6765 ;; appears for the second time, do not create another
6766 ;; entry, but append its sub-menu to existing menu.
6767 (let (last-key)
6768 (mapconcat
6769 (lambda (entry)
6770 (let ((top-key (car entry)))
6771 (concat
6772 (unless (eq top-key last-key)
6773 (setq last-key top-key)
6775 (funcall fontify-key (char-to-string top-key))
6776 (nth 1 entry)))
6777 (let ((sub-menu (nth 2 entry)))
6778 (unless (functionp sub-menu)
6779 ;; Split sub-menu into two columns.
6780 (let ((index -1))
6781 (concat
6782 (mapconcat
6783 (lambda (sub-entry)
6784 (cl-incf index)
6785 (format
6786 (if (zerop (mod index 2)) " [%s] %-26s"
6788 (funcall fontify-key
6789 (char-to-string (car sub-entry))
6790 top-key)
6791 (nth 1 sub-entry)))
6792 sub-menu "")
6794 entries ""))
6795 ;; Publishing menu is hard-coded.
6797 [%s] Current file [%s] Current project
6799 (funcall fontify-key "P")
6800 (funcall fontify-key "f" ?P)
6801 (funcall fontify-key "p" ?P)
6802 (funcall fontify-key "x" ?P)
6803 (funcall fontify-key "a" ?P))
6805 (funcall fontify-key "&" t)
6806 (funcall fontify-key "#" t))
6807 (format "[%s] %s"
6808 (funcall fontify-key "q" t)
6809 (if first-key "Main menu" "Exit")))))
6810 ;; Build prompts for both standard and expert UI.
6811 (standard-prompt (unless expertp "Export command: "))
6812 (expert-prompt
6813 (when expertp
6814 (format
6815 "Export command (C-%s%s%s%s%s) [%s]: "
6816 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6817 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6818 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6819 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6820 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6821 (mapconcat (lambda (k)
6822 ;; Strip control characters.
6823 (unless (< k 27) (char-to-string k)))
6824 allowed-keys "")))))
6825 ;; With expert UI, just read key with a fancy prompt. In standard
6826 ;; UI, display an intrusive help buffer.
6827 (if expertp
6828 (org-export--dispatch-action
6829 expert-prompt allowed-keys entries options first-key expertp)
6830 ;; At first call, create frame layout in order to display menu.
6831 (unless (get-buffer "*Org Export Dispatcher*")
6832 (delete-other-windows)
6833 (org-switch-to-buffer-other-window
6834 (get-buffer-create "*Org Export Dispatcher*"))
6835 (setq cursor-type nil
6836 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6837 ;; Make sure that invisible cursor will not highlight square
6838 ;; brackets.
6839 (set-syntax-table (copy-syntax-table))
6840 (modify-syntax-entry ?\[ "w"))
6841 ;; At this point, the buffer containing the menu exists and is
6842 ;; visible in the current window. So, refresh it.
6843 (with-current-buffer "*Org Export Dispatcher*"
6844 ;; Refresh help. Maintain display continuity by re-visiting
6845 ;; previous window position.
6846 (let ((pos (window-start)))
6847 (erase-buffer)
6848 (insert help)
6849 (set-window-start nil pos)))
6850 (org-fit-window-to-buffer)
6851 (org-export--dispatch-action
6852 standard-prompt allowed-keys entries options first-key expertp))))
6854 (defun org-export--dispatch-action
6855 (prompt allowed-keys entries options first-key expertp)
6856 "Read a character from command input and act accordingly.
6858 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6859 a list of characters available at a given step in the process.
6860 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6861 EXPERTP are the same as defined in `org-export--dispatch-ui',
6862 which see.
6864 Toggle export options when required. Otherwise, return value is
6865 a list with action as CAR and a list of interactive export
6866 options as CDR."
6867 (let (key)
6868 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6869 ;; C-p, SPC, DEL).
6870 (while (and (setq key (read-char-exclusive prompt))
6871 (not expertp)
6872 (memq key '(14 16 ?\s ?\d)))
6873 (cl-case key
6874 (14 (if (not (pos-visible-in-window-p (point-max)))
6875 (ignore-errors (scroll-up 1))
6876 (message "End of buffer")
6877 (sit-for 1)))
6878 (16 (if (not (pos-visible-in-window-p (point-min)))
6879 (ignore-errors (scroll-down 1))
6880 (message "Beginning of buffer")
6881 (sit-for 1)))
6882 (?\s (if (not (pos-visible-in-window-p (point-max)))
6883 (scroll-up nil)
6884 (message "End of buffer")
6885 (sit-for 1)))
6886 (?\d (if (not (pos-visible-in-window-p (point-min)))
6887 (scroll-down nil)
6888 (message "Beginning of buffer")
6889 (sit-for 1)))))
6890 (cond
6891 ;; Ignore undefined associations.
6892 ((not (memq key allowed-keys))
6893 (ding)
6894 (unless expertp (message "Invalid key") (sit-for 1))
6895 (org-export--dispatch-ui options first-key expertp))
6896 ;; q key at first level aborts export. At second level, cancel
6897 ;; first key instead.
6898 ((eq key ?q) (if (not first-key) (error "Export aborted")
6899 (org-export--dispatch-ui options nil expertp)))
6900 ;; Help key: Switch back to standard interface if expert UI was
6901 ;; active.
6902 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6903 ;; Send request for template insertion along with export scope.
6904 ((eq key ?#) (cons 'template (memq 'subtree options)))
6905 ;; Switch to asynchronous export stack.
6906 ((eq key ?&) '(stack))
6907 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6908 ((memq key '(2 22 19 6 1))
6909 (org-export--dispatch-ui
6910 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6911 (6 'force) (1 'async))))
6912 (if (memq option options) (remq option options)
6913 (cons option options)))
6914 first-key expertp))
6915 ;; Action selected: Send key and options back to
6916 ;; `org-export-dispatch'.
6917 ((or first-key (functionp (nth 2 (assq key entries))))
6918 (cons (cond
6919 ((not first-key) (nth 2 (assq key entries)))
6920 ;; Publishing actions are hard-coded. Send a special
6921 ;; signal to `org-export-dispatch'.
6922 ((eq first-key ?P)
6923 (cl-case key
6924 (?f 'publish-current-file)
6925 (?p 'publish-current-project)
6926 (?x 'publish-choose-project)
6927 (?a 'publish-all)))
6928 ;; Return first action associated to FIRST-KEY + KEY
6929 ;; path. Indeed, derived backends can share the same
6930 ;; FIRST-KEY.
6931 (t (catch 'found
6932 (dolist (entry (member (assq first-key entries) entries))
6933 (let ((match (assq key (nth 2 entry))))
6934 (when match (throw 'found (nth 2 match))))))))
6935 options))
6936 ;; Otherwise, enter sub-menu.
6937 (t (org-export--dispatch-ui options key expertp)))))
6941 (provide 'ox)
6943 ;; Local variables:
6944 ;; generated-autoload-file: "org-loaddefs.el"
6945 ;; End:
6947 ;;; ox.el ends here