| blob | bd49a8a26ef7c8fbd268d9b43b96319c5a5b13ba |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2018 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:
91 \f
92 ;;; Internal Variables
93 ;;
94 ;; Among internal variables, the most important is
95 ;; `org-export-options-alist'. This variable define the global export
96 ;; options, shared between every exporter, and how they are acquired.
142 "Alist between export properties and ways to set them.
144 The key of the alist is the property name, and the value is a list
145 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
147 KEYWORD is a string representing a buffer keyword, or nil. Each
148 property defined this way can also be set, during subtree
149 export, through a headline property named after the keyword
151 property).
152 OPTION is a string that could be found in an #+OPTIONS: line.
153 DEFAULT is the default value for the property.
154 BEHAVIOR determines how Org should handle multiple keywords for
155 the same property. It is a symbol among:
156 nil Keep old value and discard the new one.
157 t Replace old value with the new one.
158 `space' Concatenate the values, separating them with a space.
159 `newline' Concatenate the values, separating them with
160 a newline.
161 `split' Split values at white spaces, and cons them to the
162 previous list.
163 `parse' Parse value as a list of strings and Org objects,
164 which can then be transcoded with, e.g.,
165 `org-export-data'. It implies `space' behavior.
167 Values set through KEYWORD and OPTION have precedence over
168 DEFAULT.
170 All these properties should be back-end agnostic. Back-end
171 specific properties are set through `org-export-define-backend'.
175 "List of in-buffer keywords that require special treatment.
176 These keywords are not directly associated to a property. The
177 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
263 org-element--cache org-element--cache-objects org-element--cache-sync-keys
264 org-element--cache-sync-requests org-element--cache-sync-timer)
265 "List of variables not copied through upon buffer duplication.
266 Export process takes place on a copy of the original buffer.
267 When this copy is created, all Org related local variables not in
268 this list are copied to the new buffer. Variables with an
272 "Non-nil means asynchronous export process should leave data behind.
276 located in `temporary-file-directory'.
278 When non-nil, it will also set `debug-on-error' to a non-nil
282 "Record asynchronously generated export results and processes.
283 This is an alist: its CAR is the source of the
284 result (destination file or buffer for a finished process,
285 original buffer for a running one) and its CDR is a list
286 containing the back-end used, as a symbol, and either a process
287 or the time at which it finished. It is used to build the menu
291 "List of backends currently available in the exporter.
292 This variable is set with `org-export-define-backend' and
296 "Last command called from the dispatcher.
297 The value should be a list. Its CAR is the action, as a symbol,
301 "The position where the last export command was created using the dispatcher.
302 This marker will be used with `C-u C-c C-e' to make sure export repetition
305 ;; For compatibility with Org < 8
307 "Name, if any, of the back-end used during an export process.
309 Its value is a symbol such as `html', `latex', `ascii', or nil if
310 the back-end is anonymous (see `org-export-create-backend') or if
311 there is no export process in progress.
313 It can be used to teach Babel blocks how to act differently
317 \f
318 ;;; User-configurable Variables
319 ;;
320 ;; Configuration for the masses.
321 ;;
322 ;; They should never be accessed directly, as their value is to be
323 ;; stored in a property list (cf. `org-export-options-alist').
324 ;; Back-ends will read their value from there instead.
327 "Options for exporting Org mode files."
332 "General options for export engine."
337 "Whether sub-trees with the ARCHIVE tag should be exported.
339 This can have three different values:
340 nil Do not export, pretend this tree is not present.
341 t Do export the entire tree.
342 `headline' Only export the headline, but skip the tree below it.
344 This option can also be set with the OPTIONS keyword,
354 "Non-nil means insert author name into the exported file.
355 This option can also be set with the OPTIONS keyword,
362 "Non-nil means export CLOCK keywords.
363 This option can also be set with the OPTIONS keyword,
370 "Non-nil means the postamble should contain a creator sentence.
372 The sentence can be set in `org-export-creator-string', which
373 see.
375 This option can also be set with the OPTIONS keyword, e.g.,
384 "Non-nil means insert date in the exported document.
385 This option can also be set with the OPTIONS keyword,
392 "Time-stamp format string to use for DATE keyword.
394 The format string, when specified, only applies if date consists
395 in a single time-stamp. Otherwise its value will be ignored.
397 See `format-time-string' for details on how to build this
398 string."
407 emacs-version
409 "Information about the creator of the document.
410 This option can also be set on with the CREATOR keyword."
416 "Non-nil means export contents of standard drawers.
418 When t, all drawers are exported. This may also be a list of
419 drawer names to export, as strings. If that list starts with
420 `not', only drawers with such names will be ignored.
422 This variable doesn't apply to properties drawers. See
423 `org-export-with-properties' instead.
425 This option can also be set with the OPTIONS keyword,
438 :inline t
443 "Non-nil means insert author email into the exported file.
444 This option can also be set with the OPTIONS keyword,
451 "Non-nil means interpret *word*, /word/, _word_ and +word+.
453 If the export target supports emphasizing text, the word will be
454 typeset in bold, italic, with an underline or strike-through,
455 respectively.
457 This option can also be set with the OPTIONS keyword,
464 "Tags that exclude a tree from export.
466 All trees carrying any of these tags will be excluded from
467 export. This is without condition, so even subtrees inside that
468 carry one of the `org-export-select-tags' will be removed.
470 This option can also be set with the EXCLUDE_TAGS keyword."
477 This option can also be set with the OPTIONS keyword,
486 "Non-nil means Org footnotes should be exported.
487 This option can also be set with the OPTIONS keyword,
494 "Non-nil means process LaTeX environments and fragments.
496 This option can also be set with the OPTIONS line,
499 nil Ignore math snippets.
500 `verbatim' Keep everything in verbatim.
501 t Allow export of math snippets."
512 "The last level which is still exported as a headline.
514 Inferior levels will usually produce itemize or enumerate lists
515 when exported, but back-end behavior may differ.
517 This option can also be set with the OPTIONS keyword,
524 "The default language for export and clocktable translations, as a string.
525 This may have an association in
526 `org-clock-clocktable-language-setup',
527 `org-export-smart-quotes-alist' and `org-export-dictionary'.
528 This option can also be set with the LANGUAGE keyword."
534 "Non-nil means preserve all line breaks when exporting.
535 This option can also be set with the OPTIONS keyword,
542 "Non-nil means interpret entities when exporting.
545 Å.
547 For a list of supported names, see the constant `org-entities'
548 and the user option `org-entities-user'.
550 This option can also be set with the OPTIONS keyword,
557 "Non-nil means inlinetasks should be exported.
558 This option can also be set with the OPTIONS keyword,
567 "Non-nil means include planning info in export.
569 Planning info is the line containing either SCHEDULED:,
570 DEADLINE:, CLOSED: time-stamps, or a combination of them.
572 This option can also be set with the OPTIONS keyword,
581 "Non-nil means include priority cookies in export.
582 This option can also be set with the OPTIONS keyword,
589 "Non-nil means export contents of properties drawers.
591 When t, all properties are exported. This may also be a list of
592 properties to export, as strings.
594 This option can also be set with the OPTIONS keyword,
608 "Non-nil means add section numbers to headlines when exporting.
610 When set to an integer n, numbering will only happen for
611 headlines whose relative level is higher or equal to n.
613 This option can also be set with the OPTIONS keyword,
620 "Tags that select a tree for export.
622 If any such tag is found in a buffer, all trees that do not carry
623 one of these tags will be ignored during export. Inside trees
624 that are selected like this, you can still deselect a subtree by
625 tagging it with one of the `org-export-exclude-tags'.
627 This option can also be set with the SELECT_TAGS keyword."
633 "Non-nil means activate smart quotes during export.
634 This option can also be set with the OPTIONS keyword,
637 When setting this to non-nil, you need to take care of
638 using the correct Babel package when exporting to LaTeX.
639 E.g., you can load Babel for french like this:
651 When this option is turned on, these strings will be exported as:
653 Org HTML LaTeX UTF-8
654 -----+----------+--------+-------
656 -- – -- –
657 --- — --- —
660 This option can also be set with the OPTIONS keyword,
667 "Non-nil means include statistics cookies in export.
668 This option can also be set with the OPTIONS keyword,
679 If you want to control how Org displays those characters, see
680 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
681 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
682 it is not anymore.
684 When this option is turned on, you can use TeX-like syntax for
685 sub- and superscripts and see them exported correctly.
687 You can also set the option with #+OPTIONS: ^:t
690 single item - so grouping with {} is normally not needed. For
691 example, the following things will be parsed as single sub- or
692 superscripts:
694 10^24 or 10^tau several digits will be considered 1 item.
695 10^-12 or 10^-tau a leading sign with digits or a word
696 x^2-y^3 will be read as x^2 - y^3, because items are
697 terminated by almost any nonword/nondigit char.
698 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
700 Still, ambiguity is possible. So when in doubt, use {} to enclose
701 the sub/superscript. If you set this variable to the symbol `{}',
702 the braces are *required* in order to trigger interpretations as
704 frequently in plain text."
715 "Non-nil means create a table of contents in exported files.
717 The table of contents contains headlines with levels up to
718 `org-export-headline-levels'.
720 When this variable is set to an integer N, include levels up to
721 N in the table of contents. Although it may then be different
722 from `org-export-headline-levels', it is cannot be larger than
723 the number of headline levels.
725 When nil, no table of contents is created.
727 This option can also be set with the OPTIONS keyword,
739 "Non-nil means export tables.
740 This option can also be set with the OPTIONS keyword,
749 "If nil, do not export tags, just remove them from headlines.
751 If this is the symbol `not-in-toc', tags will be removed from
752 table of contents entries, but still be shown in the headlines of
753 the document.
755 This option can also be set with the OPTIONS keyword,
765 "Non-nil means include TODO items for export.
767 This may have the following values:
768 t include tasks independent of state.
769 `todo' include only tasks that are not yet done.
770 `done' include only tasks that are already done.
771 nil ignore all tasks.
772 list of keywords include tasks with these keywords.
774 This option can also be set with the OPTIONS keyword,
789 "Non-nil means print title into the exported file.
790 This option can also be set with the OPTIONS keyword,
799 "Non-nil means insert a time stamp into the exported file.
800 The time stamp shows when the file was created. This option can
807 "Non nil means allow timestamps in export.
809 It can be set to any of the following values:
810 t export all timestamps.
811 `active' export active timestamps only.
812 `inactive' export inactive timestamps only.
813 nil do not export timestamps
815 This only applies to timestamps isolated in a paragraph
816 containing only timestamps. Other timestamps are always
817 exported.
819 This option can also be set with the OPTIONS keyword, e.g.
830 "Non-nil means include TODO keywords in export.
831 When nil, remove all these keywords from the export. This option
837 "Non-nil means BIND keywords can define local variable values.
838 This is a potential security risk, which is why the default value
839 is nil. You can also allow them through local buffer variables."
846 "Non-nil means do not raise an error on broken links.
848 When this variable is non-nil, broken links are ignored, without
849 stopping the export process. If it is set to `mark', broken
850 links are marked as such in the output, with a string like
852 [BROKEN LINK: path]
854 where PATH is the un-resolvable reference.
856 This option can also be set with the OPTIONS keyword, e.g.,
867 "Alist between export snippets back-ends and exporter back-ends.
869 This variable allows providing shortcuts for export snippets.
873 HTML code while every other back-end will ignore it."
887 "Alist between macro names and expansion templates.
889 This variable defines macro expansion templates available
890 globally. Associations follow the pattern
892 (NAME . TEMPLATE)
894 where NAME is a string beginning with a letter and consisting of
895 alphanumeric characters only.
897 TEMPLATE is the string to which the macro is going to be
899 macro's arguments. Moreover, if the template starts with
901 accordingly."
910 "Coding system for the exported file."
917 "Non-nil means pushing export output to the kill ring.
918 This variable is ignored during asynchronous export."
928 "The initial scope when exporting with `org-export-dispatch'.
929 This variable can be either set to `buffer' or `subtree'."
936 "Non-nil means show buffer after exporting to temp buffer.
937 When Org exports to a file, the buffer visiting that file is never
938 shown, but remains buried. However, when exporting to
939 a temporary buffer, that buffer is popped up in a second window.
940 When this variable is nil, the buffer remains buried also in
941 these cases."
946 "Non-nil means export and publishing commands will run in background.
947 Results from an asynchronous export are never displayed
955 "File used to initialize external export process.
957 Value must be either nil or an absolute file name. When nil, the
958 external process is launched like a regular Emacs session,
959 loading user's initialization file and any site specific
960 configuration. If a file is provided, it, and only it, is loaded
961 at start-up.
963 Therefore, using a specific configuration makes the process to
964 load faster and the export more portable."
973 "Non-nil means using a non-intrusive `org-export-dispatch'.
974 In that case, no help buffer is displayed. Though, an indicator
980 asynchronous). Also, [?] allows switching back to standard
981 mode."
988 \f
989 ;;; Defining Back-ends
990 ;;
991 ;; An export back-end is a structure with `org-export-backend' type
992 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
993 ;; and `menu' slots.
994 ;;
995 ;; At the lowest level, a back-end is created with
996 ;; `org-export-create-backend' function.
997 ;;
998 ;; A named back-end can be registered with
999 ;; `org-export-register-backend' function. A registered back-end can
1000 ;; later be referred to by its name, with `org-export-get-backend'
1001 ;; function. Also, such a back-end can become the parent of a derived
1002 ;; back-end from which slot values will be inherited by default.
1003 ;; `org-export-derived-backend-p' can check if a given back-end is
1004 ;; derived from a list of back-end names.
1005 ;;
1006 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
1007 ;; `org-export-get-all-filters' return the full alist of transcoders,
1008 ;; options and filters, including those inherited from ancestors.
1009 ;;
1010 ;; At a higher level, `org-export-define-backend' is the standard way
1011 ;; to define an export back-end. If the new back-end is similar to
1012 ;; a registered back-end, `org-export-define-derived-backend' may be
1013 ;; used instead.
1014 ;;
1015 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
1016 ;; when a given back-end hasn't been registered yet.
1020 name parent transcoders options filters blocks menu)
1022 ;;;###autoload
1024 "Return export back-end named after NAME.
1025 NAME is a symbol. Return nil if no such back-end is found."
1027 org-export-registered-backends))
1030 "Register BACKEND as a known export back-end.
1031 BACKEND is a structure with `org-export-backend' type."
1032 ;; Refuse to register an unnamed back-end.
1035 ;; Refuse to register a back-end with an unknown parent.
1039 ;; If a back-end with the same name as BACKEND is already
1040 ;; registered, replace it with BACKEND. Otherwise, simply add
1041 ;; BACKEND to the list of registered back-ends.
1047 "Signal an error if BACKEND isn't defined."
1052 "Non-nil if BACKEND is derived from one of BACKENDS.
1053 BACKEND is an export back-end, as returned by, e.g.,
1054 `org-export-create-backend', or a symbol referring to
1055 a registered back-end. BACKENDS is constituted of symbols."
1067 "Return full translation table for BACKEND.
1069 BACKEND is an export back-end, as return by, e.g,,
1070 `org-export-create-backend'. Return value is an alist where
1071 keys are element or object types, as symbols, and values are
1072 transcoders.
1074 Unlike to `org-export-backend-transcoders', this function
1075 also returns transcoders inherited from parent back-ends,
1076 if any."
1080 parent)
1085 transcoders)))
1088 "Return export options for BACKEND.
1090 BACKEND is an export back-end, as return by, e.g,,
1091 `org-export-create-backend'. See `org-export-options-alist'
1092 for the shape of the return value.
1094 Unlike to `org-export-backend-options', this function also
1095 returns options inherited from parent back-ends, if any.
1097 Return nil if BACKEND is unknown."
1101 parent)
1105 options)))
1108 "Return complete list of filters for BACKEND.
1110 BACKEND is an export back-end, as return by, e.g,,
1111 `org-export-create-backend'. Return value is an alist where
1112 keys are symbols and values lists of functions.
1114 Unlike to `org-export-backend-filters', this function also
1115 returns filters inherited from parent back-ends, if any."
1119 parent)
1123 filters)))
1126 "Define a new back-end BACKEND.
1128 TRANSCODERS is an alist between object or element types and
1129 functions handling them.
1131 These functions should return a string without any trailing
1132 space, or nil. They must accept three arguments: the object or
1133 element itself, its contents or nil when it isn't recursive and
1134 the property list used as a communication channel.
1136 Contents, when not nil, are stripped from any global indentation
1137 \(although the relative one is preserved). They also always end
1138 with a single newline character.
1140 If, for a given type, no function is found, that element or
1141 object type will simply be ignored, along with any blank line or
1142 white space at its end. The same will happen if the function
1143 returns the nil value. If that function returns the empty
1144 string, the type will be ignored, but the blank lines or white
1145 spaces will be kept.
1147 In addition to element and object types, one function can be
1148 associated to the `template' (or `inner-template') symbol and
1149 another one to the `plain-text' symbol.
1151 The former returns the final transcoded string, and can be used
1152 to add a preamble and a postamble to document's body. It must
1153 accept two arguments: the transcoded string and the property list
1154 containing export options. A function associated to `template'
1156 A function associated to `inner-template' is always applied.
1158 The latter, when defined, is to be called on every text not
1159 recognized as an element or an object. It must accept two
1160 arguments: the text string and the information channel. It is an
1161 appropriate place to protect special chars relative to the
1162 back-end.
1164 BODY can start with pre-defined keyword arguments. The following
1165 keywords are understood:
1167 :filters-alist
1169 Alist between filters and function, or list of functions,
1170 specific to the back-end. See `org-export-filters-alist' for
1171 a list of all allowed filters. Filters defined here
1172 shouldn't make a back-end test, as it may prevent back-ends
1173 derived from this one to behave properly.
1175 :menu-entry
1177 Menu entry for the export dispatcher. It should be a list
1178 like:
1182 where :
1184 KEY is a free character selecting the back-end.
1186 DESCRIPTION-OR-ORDINAL is either a string or a number.
1188 If it is a string, is will be used to name the back-end in
1189 its menu entry. If it is a number, the following menu will
1190 be displayed as a sub-menu of the back-end with the same
1191 KEY. Also, the number will be used to determine in which
1192 order such sub-menus will appear (lowest first).
1194 ACTION-OR-MENU is either a function or an alist.
1196 If it is an action, it will be called with four
1197 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1198 BODY-ONLY. See `org-export-as' for further explanations on
1199 some of them.
1201 If it is an alist, associations should follow the
1202 pattern:
1206 where KEY, DESCRIPTION and ACTION are described above.
1208 Valid values include:
1212 or
1217 (lambda (a s v b)
1218 (if a (org-latex-export-to-pdf t s v b)
1219 (org-open-file
1220 (org-latex-export-to-pdf nil s v b)))))))
1222 or the following, which will be added to the previous
1223 sub-menu,
1229 :options-alist
1231 Alist between back-end specific properties introduced in
1232 communication channel and how their value are acquired. See
1233 `org-export-options-alist' for more information about
1234 structure of the values."
1246 :transcoders transcoders
1247 :options options
1248 :filters filters
1252 "Create a new back-end as a variant of an existing one.
1254 CHILD is the name of the derived back-end. PARENT is the name of
1255 the parent back-end.
1257 BODY can start with pre-defined keyword arguments. The following
1258 keywords are understood:
1260 :filters-alist
1262 Alist of filters that will overwrite or complete filters
1263 defined in PARENT back-end. See `org-export-filters-alist'
1264 for a list of allowed filters.
1266 :menu-entry
1268 Menu entry for the export dispatcher. See
1269 `org-export-define-backend' for more information about the
1270 expected value.
1272 :options-alist
1274 Alist of back-end specific properties that will overwrite or
1275 complete those defined in PARENT back-end. Refer to
1276 `org-export-options-alist' for more information about
1277 structure of the values.
1279 :translate-alist
1281 Alist of element and object types and transcoders that will
1282 overwrite or complete transcode table from PARENT back-end.
1283 Refer to `org-export-define-backend' for detailed information
1284 about transcoders.
1287 as a variant of `latex' back-end with a custom template function:
1292 The back-end could then be called with, for example:
1307 :parent parent
1308 :transcoders transcoders
1309 :options options
1310 :filters filters
1314 \f
1315 ;;; The Communication Channel
1316 ;;
1317 ;; During export process, every function has access to a number of
1318 ;; properties. They are of two types:
1319 ;;
1320 ;; 1. Environment options are collected once at the very beginning of
1321 ;; the process, out of the original buffer and configuration.
1322 ;; Collecting them is handled by `org-export-get-environment'
1323 ;; function.
1324 ;;
1325 ;; Most environment options are defined through the
1326 ;; `org-export-options-alist' variable.
1327 ;;
1328 ;; 2. Tree properties are extracted directly from the parsed tree,
1329 ;; just before export, by `org-export--collect-tree-properties'.
1331 ;;;; Environment Options
1332 ;;
1333 ;; Environment options encompass all parameters defined outside the
1334 ;; scope of the parsed data. They come from five sources, in
1335 ;; increasing precedence order:
1336 ;;
1337 ;; - Global variables,
1338 ;; - Buffer's attributes,
1339 ;; - Options keyword symbols,
1340 ;; - Buffer keywords,
1341 ;; - Subtree properties.
1342 ;;
1343 ;; The central internal function with regards to environment options
1344 ;; is `org-export-get-environment'. It updates global variables with
1345 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1346 ;; the different sources.
1347 ;;
1348 ;; The internal functions doing the retrieval are:
1349 ;; `org-export--get-global-options',
1350 ;; `org-export--get-buffer-attributes',
1351 ;; `org-export--parse-option-keyword',
1352 ;; `org-export--get-subtree-options' and
1353 ;; `org-export--get-inbuffer-options'
1354 ;;
1355 ;; Also, `org-export--list-bound-variables' collects bound variables
1356 ;; along with their value in order to set them as buffer local
1357 ;; variables later in the process.
1359 ;;;###autoload
1361 "Collect export options from the current buffer.
1363 Optional argument BACKEND is an export back-end, as returned by
1364 `org-export-create-backend'.
1366 When optional argument SUBTREEP is non-nil, assume the export is
1367 done against the current sub-tree.
1369 Third optional argument EXT-PLIST is a property list with
1370 external parameters overriding Org default settings, but still
1371 inferior to file-local settings."
1372 ;; First install #+BIND variables since these must be set before
1373 ;; global options are read.
1376 ;; Get and prioritize export options...
1378 ;; ... from global variables...
1380 ;; ... from an external property list...
1381 ext-plist
1382 ;; ... from in-buffer settings...
1384 ;; ... and from subtree, when appropriate.
1388 "Parse an OPTIONS line and return values as a plist.
1389 Optional argument BACKEND is an export back-end, as returned by,
1390 e.g., `org-export-create-backend'. It specifies which back-end
1391 specific items to read, if any."
1398 alist))
1399 alist))
1400 ;; Priority is given to back-end specific options.
1402 org-export-options-alist))
1412 "Get export options in subtree at point.
1413 Optional argument BACKEND is an export back-end, as returned by,
1414 e.g., `org-export-create-backend'. It specifies back-end used
1415 for export. Return options as a plist."
1416 ;; For each buffer keyword, create a headline property setting the
1417 ;; same property in communication channel. The name for the
1418 ;; property is the keyword with "EXPORT_" appended to it.
1420 ;; Make sure point is at a heading.
1423 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1424 ;; care of them right from the start.
1427 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1428 ;; headline's title (with no todo keyword, priority cookie or
1429 ;; tag) as its fallback value.
1436 ;; Look for both general keywords and back-end specific
1437 ;; options, with priority given to the latter.
1439 org-export-options-alist)))
1440 ;; Handle other keywords. Then return PLIST.
1454 property
1463 "Return current buffer export options, as a plist.
1465 Optional argument BACKEND, when non-nil, is an export back-end,
1466 as returned by, e.g., `org-export-create-backend'. It specifies
1467 which back-end specific options should also be read in the
1468 process.
1470 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1473 ;; Priority is given to back-end specific options.
1475 org-export-options-alist))
1478 org-export-special-keywords))))
1479 plist to-parse)
1482 ;; Return all properties associated to KEYWORD.
1489 ;; Recursively read keywords in buffer. FILES is
1490 ;; a list of files read so far. PLIST is the current
1491 ;; property list obtained.
1500 ;; Options in `org-export-special-keywords'.
1505 uri
1507 ;; Avoid circular dependencies.
1519 plist
1521 val backend))))
1525 plist
1532 ;; Options in `org-export-options-alist'.
1535 plist
1537 plist property
1538 ;; Handle value depending on specified
1539 ;; BEHAVIOR.
1544 ;; Even if `parse' implies `space'
1545 ;; behavior, we separate line with
1546 ;; "\n" so as to preserve
1547 ;; line-breaks. However, empty
1548 ;; lines are forbidden since `parse'
1549 ;; doesn't allow more than one
1550 ;; paragraph.
1559 " "
1572 ;; Read options in the current buffer and return value.
1574 ;; Parse properties in TO-PARSE. Remove newline characters not
1575 ;; involved in line breaks to simulate `space' behavior.
1576 ;; Finally return options.
1589 "Return properties related to export process, as a plist.
1590 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1591 are like the arguments with the same names of function
1592 `org-export-as'."
1597 :back-end backend
1602 "Return properties related to buffer attributes, as a plist."
1607 "Return global export options as a plist.
1608 Optional argument BACKEND, if non-nil, is an export back-end, as
1609 returned by, e.g., `org-export-create-backend'. It specifies
1610 which back-end specific export options should also be read in the
1611 process."
1613 ;; Priority is given to back-end specific options.
1615 org-export-options-alist)))
1621 plist
1622 prop
1623 ;; Evaluate default value provided.
1628 value)))))))))
1631 "Return variables bound from BIND keywords in current buffer.
1632 Also look for BIND keywords in setup files. The return value is
1633 an alist where associations are (VARIABLE-NAME VALUE)."
1637 ;; Return an alist between variable names and their
1638 ;; value. FILES is a list of setup files names read
1639 ;; so far, used to avoid circular dependencies. ALIST
1640 ;; is the alist collected so far.
1652 ;; Enter setup file.
1656 uri
1658 ;; Avoid circular dependencies.
1669 alist))))))))))
1670 alist)))))
1671 ;; Return value in appropriate order of appearance.
1674 ;; defsubst org-export-get-parent must be defined before first use,
1675 ;; was originally defined in the topology section
1678 "Return BLOB parent or nil.
1679 BLOB is the element or object considered."
1682 ;;;; Tree Properties
1683 ;;
1684 ;; Tree properties are information extracted from parse tree. They
1685 ;; are initialized at the beginning of the transcoding process by
1686 ;; `org-export--collect-tree-properties'.
1687 ;;
1688 ;; Dedicated functions focus on computing the value of specific tree
1689 ;; properties during initialization. Thus,
1690 ;; `org-export--populate-ignore-list' lists elements and objects that
1691 ;; should be skipped during export, `org-export--get-min-level' gets
1692 ;; the minimal exportable level, used as a basis to compute relative
1693 ;; level for headlines. Eventually
1694 ;; `org-export--collect-headline-numbering' builds an alist between
1695 ;; headlines and their numbering.
1698 "Extract tree properties from parse tree.
1700 DATA is the parse tree from which information is retrieved. INFO
1701 is a list holding export options.
1703 Following tree properties are set or updated:
1705 `:headline-offset' Offset between true level of headlines and
1706 local level. An offset of -1 means a headline
1707 of level 2 should be considered as a level
1708 1 headline in the context.
1710 `:headline-numbering' Alist of all headlines as key and the
1711 associated numbering as value.
1713 `:id-alist' Alist of all ID references as key and associated file
1714 as value.
1716 Return updated plist."
1717 ;; Install the parse tree in the communication channel.
1719 ;; Compute `:headline-offset' in order to be able to use
1720 ;; `org-export-get-relative-level'.
1723 :headline-offset
1725 ;; From now on, properties order doesn't matter: get the rest of the
1726 ;; tree properties.
1728 info
1730 :id-alist
1739 "Return minimum exportable headline's level in DATA.
1740 DATA is parsed tree as returned by `org-element-parse-buffer'.
1741 OPTIONS is a plist holding export options."
1750 ;; If no headline was found, for the sake of consistency, set
1751 ;; minimum level to 1 nonetheless.
1755 "Return numbering of all exportable, numbered headlines in a parse tree.
1757 DATA is the parse tree. OPTIONS is the plist holding export
1758 options.
1760 Return an alist whose key is a headline and value is its
1761 associated numbering \(in the shape of a list of numbers) or nil
1762 for a footnotes section."
1771 headline
1773 for n across numbering
1774 for idx from 0 to org-export-max-depth
1778 options)))
1781 "List headlines and inlinetasks with a select tag in their tree.
1782 DATA is parsed data as returned by `org-element-parse-buffer'.
1783 INFO is a plist holding export options."
1787 ;; If FILETAGS contains a select tag, every headline or
1788 ;; inlinetask is returned.
1798 ;; When a select tag is found, mark full
1799 ;; genealogy and every headline within the
1800 ;; tree as acceptable.
1803 genealogy
1806 selected-trees))
1807 ;; If at a headline, continue searching in
1808 ;; tree, recursively.
1817 selected-trees))))
1820 "Non-nil when element or object DATUM should be skipped during export.
1821 OPTIONS is the plist holding export options. SELECTED, when
1822 non-nil, is a list of headlines or inlinetasks belonging to
1823 a tree with a select tag. EXCLUDED is a list of tags, as
1824 strings. Any headline or inlinetask marked with one of those is
1825 not exported."
1828 ;; Skip all comments and comment blocks. Make to keep maximum
1829 ;; number of blank lines around the comment so as to preserve
1830 ;; local structure of the document upon interpreting it back into
1831 ;; Org syntax.
1837 t)
1843 ;; If `:with-drawers' value starts with `not', ignore
1844 ;; every drawer whose name belong to that list.
1845 ;; Otherwise, ignore drawers whose name isn't in that
1846 ;; list.
1863 ;; Ignore subtrees with an exclude tag.
1865 ;; When a select tag is present in the buffer, ignore any tree
1866 ;; without it.
1868 ;; Ignore commented sub-trees.
1870 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1872 ;; Ignore tasks, if specified by `:with-tasks' property.
1884 properties-set))))))
1895 ;; `:with-timestamps' only applies to isolated timestamps
1896 ;; objects, i.e. timestamp objects in a paragraph containing only
1897 ;; timestamps and whitespaces.
1905 options t))))
1914 \f
1915 ;;; The Transcoder
1916 ;;
1917 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1918 ;; `org-element-parse-buffer') and transcodes it into a specified
1919 ;; back-end output. It takes care of filtering out elements or
1920 ;; objects according to export options and organizing the output blank
1921 ;; lines and white space are preserved. The function memoizes its
1922 ;; results, so it is cheap to call it within transcoders.
1923 ;;
1924 ;; It is possible to modify locally the back-end used by
1925 ;; `org-export-data' or even use a temporary back-end by using
1926 ;; `org-export-data-with-backend'.
1927 ;;
1928 ;; `org-export-transcoder' is an accessor returning appropriate
1929 ;; translator function for a given element or object.
1932 "Return appropriate transcoder for BLOB.
1933 INFO is a plist containing export directives."
1935 ;; Return contents only for complete parse trees.
1941 "Convert DATA into current back-end format.
1943 DATA is a parse tree, an element or an object or a secondary
1944 string. INFO is a plist holding export options.
1946 Return a string."
1948 ;; Handle broken links according to
1949 ;; `org-export-with-broken-links'.
1965 ;; Ignored element/object.
1967 ;; Plain text.
1973 info))
1974 ;; Secondary string.
1977 ;; Element/Object without contents or, as a special
1978 ;; case, headline with archive tag and archived trees
1979 ;; restricted to title only.
1988 ;; Export snippets never return a nil value so
1989 ;; that white spaces following them are never
1990 ;; ignored.
1992 ;; Element/Object with contents.
2005 ;; Elements directly containing
2006 ;; objects must have their indentation
2007 ;; normalized first.
2009 data
2010 ;; When normalizing first paragraph
2011 ;; of an item or
2012 ;; a footnote-definition, ignore
2013 ;; first line's indentation.
2019 data)
2027 info)))))))))
2028 ;; Final result will be memoized before being returned.
2030 data
2034 ;; Append the same white space between elements or objects
2035 ;; as in the original buffer, and call appropriate filters.
2044 info)))
2048 "Convert DATA into BACKEND format.
2050 DATA is an element, an object, a secondary string or a string.
2051 BACKEND is a symbol. INFO is a plist used as a communication
2052 channel.
2054 Unlike to `org-export-with-backend', this function will
2055 recursively convert DATA using BACKEND translation table."
2057 ;; Set-up a new communication channel with translations defined in
2058 ;; BACKEND as the translate table and a new hash table for
2059 ;; memoization.
2062 info
2065 ;; Size of the hash table is reduced since this
2066 ;; function will probably be used on small trees.
2069 ;; Preserve `:internal-references', as those do not depend on
2070 ;; the back-end used; we need to make sure that any new
2071 ;; reference when the temporary back-end was active gets through
2072 ;; the default one.
2077 "Expand a parsed element or object to its original state.
2079 BLOB is either an element or an object. CONTENTS is its
2080 contents, as a string or nil.
2082 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2083 keywords before output."
2089 blob contents))))
2092 \f
2093 ;;; The Filter System
2094 ;;
2095 ;; Filters allow end-users to tweak easily the transcoded output.
2096 ;; They are the functional counterpart of hooks, as every filter in
2097 ;; a set is applied to the return value of the previous one.
2098 ;;
2099 ;; Every set is back-end agnostic. Although, a filter is always
2100 ;; called, in addition to the string it applies to, with the back-end
2101 ;; used as argument, so it's easy for the end-user to add back-end
2102 ;; specific filters in the set. The communication channel, as
2103 ;; a plist, is required as the third argument.
2104 ;;
2105 ;; From the developer side, filters sets can be installed in the
2106 ;; process with the help of `org-export-define-backend', which
2107 ;; internally stores filters as an alist. Each association has a key
2108 ;; among the following symbols and a function or a list of functions
2109 ;; as value.
2110 ;;
2111 ;; - `:filter-options' applies to the property list containing export
2112 ;; options. Unlike to other filters, functions in this list accept
2113 ;; two arguments instead of three: the property list containing
2114 ;; export options and the back-end. Users can set its value through
2115 ;; `org-export-filter-options-functions' variable.
2116 ;;
2117 ;; - `:filter-parse-tree' applies directly to the complete parsed
2118 ;; tree. Users can set it through
2119 ;; `org-export-filter-parse-tree-functions' variable.
2120 ;;
2121 ;; - `:filter-body' applies to the body of the output, before template
2122 ;; translator chimes in. Users can set it through
2123 ;; `org-export-filter-body-functions' variable.
2124 ;;
2125 ;; - `:filter-final-output' applies to the final transcoded string.
2126 ;; Users can set it with `org-export-filter-final-output-functions'
2127 ;; variable.
2128 ;;
2129 ;; - `:filter-plain-text' applies to any string not recognized as Org
2130 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2131 ;; configure it.
2132 ;;
2133 ;; - `:filter-TYPE' applies on the string returned after an element or
2134 ;; object of type TYPE has been transcoded. A user can modify
2135 ;; `org-export-filter-TYPE-functions' to install these filters.
2136 ;;
2137 ;; All filters sets are applied with
2138 ;; `org-export-filter-apply-functions' function. Filters in a set are
2139 ;; applied in a LIFO fashion. It allows developers to be sure that
2140 ;; their filters will be applied first.
2141 ;;
2142 ;; Filters properties are installed in communication channel with
2143 ;; `org-export-install-filters' function.
2144 ;;
2145 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2146 ;; `org-export-before-parsing-hook') are run at the beginning of the
2147 ;; export process and just before parsing to allow for heavy structure
2148 ;; modifications.
2151 ;;;; Hooks
2154 "Hook run at the beginning of the export process.
2156 This is run before include keywords and macros are expanded and
2157 Babel code blocks executed, on a copy of the original buffer
2158 being exported. Visibility and narrowing are preserved. Point
2159 is at the beginning of the buffer.
2161 Every function in this hook will be called with one argument: the
2165 "Hook run before parsing an export buffer.
2167 This is run after include keywords and macros have been expanded
2168 and Babel code blocks executed, on a copy of the original buffer
2169 being exported. Visibility and narrowing are preserved. Point
2170 is at the beginning of the buffer.
2172 Every function in this hook will be called with one argument: the
2176 ;;;; Special Filters
2179 "List of functions applied to the export options.
2180 Each filter is called with two arguments: the export options, as
2181 a plist, and the back-end, as a symbol. It must return
2185 "List of functions applied to the parsed tree.
2186 Each filter is called with three arguments: the parse tree, as
2187 returned by `org-element-parse-buffer', the back-end, as
2188 a symbol, and the communication channel, as a plist. It must
2192 "List of functions applied to plain text.
2193 Each filter is called with three arguments: a string which
2194 contains no Org syntax, the back-end, as a symbol, and the
2195 communication channel, as a plist. It must return a string or
2199 "List of functions applied to transcoded body.
2200 Each filter is called with three arguments: a string which
2201 contains no Org syntax, the back-end, as a symbol, and the
2202 communication channel, as a plist. It must return a string or
2206 "List of functions applied to the transcoded string.
2207 Each filter is called with three arguments: the full transcoded
2208 string, the back-end, as a symbol, and the communication channel,
2209 as a plist. It must return a string that will be used as the
2213 ;;;; Elements Filters
2216 "List of functions applied to a transcoded babel-call.
2217 Each filter is called with three arguments: the transcoded data,
2218 as a string, the back-end, as a symbol, and the communication
2222 "List of functions applied to a transcoded center block.
2223 Each filter is called with three arguments: the transcoded data,
2224 as a string, the back-end, as a symbol, and the communication
2228 "List of functions applied to a transcoded clock.
2229 Each filter is called with three arguments: the transcoded data,
2230 as a string, the back-end, as a symbol, and the communication
2234 "List of functions applied to a transcoded diary-sexp.
2235 Each filter is called with three arguments: the transcoded data,
2236 as a string, the back-end, as a symbol, and the communication
2240 "List of functions applied to a transcoded drawer.
2241 Each filter is called with three arguments: the transcoded data,
2242 as a string, the back-end, as a symbol, and the communication
2246 "List of functions applied to a transcoded dynamic-block.
2247 Each filter is called with three arguments: the transcoded data,
2248 as a string, the back-end, as a symbol, and the communication
2252 "List of functions applied to a transcoded example-block.
2253 Each filter is called with three arguments: the transcoded data,
2254 as a string, the back-end, as a symbol, and the communication
2258 "List of functions applied to a transcoded export-block.
2259 Each filter is called with three arguments: the transcoded data,
2260 as a string, the back-end, as a symbol, and the communication
2264 "List of functions applied to a transcoded fixed-width.
2265 Each filter is called with three arguments: the transcoded data,
2266 as a string, the back-end, as a symbol, and the communication
2270 "List of functions applied to a transcoded footnote-definition.
2271 Each filter is called with three arguments: the transcoded data,
2272 as a string, the back-end, as a symbol, and the communication
2276 "List of functions applied to a transcoded headline.
2277 Each filter is called with three arguments: the transcoded data,
2278 as a string, the back-end, as a symbol, and the communication
2282 "List of functions applied to a transcoded horizontal-rule.
2283 Each filter is called with three arguments: the transcoded data,
2284 as a string, the back-end, as a symbol, and the communication
2288 "List of functions applied to a transcoded inlinetask.
2289 Each filter is called with three arguments: the transcoded data,
2290 as a string, the back-end, as a symbol, and the communication
2294 "List of functions applied to a transcoded item.
2295 Each filter is called with three arguments: the transcoded data,
2296 as a string, the back-end, as a symbol, and the communication
2300 "List of functions applied to a transcoded keyword.
2301 Each filter is called with three arguments: the transcoded data,
2302 as a string, the back-end, as a symbol, and the communication
2306 "List of functions applied to a transcoded latex-environment.
2307 Each filter is called with three arguments: the transcoded data,
2308 as a string, the back-end, as a symbol, and the communication
2312 "List of functions applied to a transcoded node-property.
2313 Each filter is called with three arguments: the transcoded data,
2314 as a string, the back-end, as a symbol, and the communication
2318 "List of functions applied to a transcoded paragraph.
2319 Each filter is called with three arguments: the transcoded data,
2320 as a string, the back-end, as a symbol, and the communication
2324 "List of functions applied to a transcoded plain-list.
2325 Each filter is called with three arguments: the transcoded data,
2326 as a string, the back-end, as a symbol, and the communication
2330 "List of functions applied to a transcoded planning.
2331 Each filter is called with three arguments: the transcoded data,
2332 as a string, the back-end, as a symbol, and the communication
2336 "List of functions applied to a transcoded property-drawer.
2337 Each filter is called with three arguments: the transcoded data,
2338 as a string, the back-end, as a symbol, and the communication
2342 "List of functions applied to a transcoded quote block.
2343 Each filter is called with three arguments: the transcoded quote
2344 data, as a string, the back-end, as a symbol, and the
2345 communication channel, as a plist. It must return a string or
2349 "List of functions applied to a transcoded section.
2350 Each filter is called with three arguments: the transcoded data,
2351 as a string, the back-end, as a symbol, and the communication
2355 "List of functions applied to a transcoded special block.
2356 Each filter is called with three arguments: the transcoded data,
2357 as a string, the back-end, as a symbol, and the communication
2361 "List of functions applied to a transcoded src-block.
2362 Each filter is called with three arguments: the transcoded data,
2363 as a string, the back-end, as a symbol, and the communication
2367 "List of functions applied to a transcoded table.
2368 Each filter is called with three arguments: the transcoded data,
2369 as a string, the back-end, as a symbol, and the communication
2373 "List of functions applied to a transcoded table-cell.
2374 Each filter is called with three arguments: the transcoded data,
2375 as a string, the back-end, as a symbol, and the communication
2379 "List of functions applied to a transcoded table-row.
2380 Each filter is called with three arguments: the transcoded data,
2381 as a string, the back-end, as a symbol, and the communication
2385 "List of functions applied to a transcoded verse block.
2386 Each filter is called with three arguments: the transcoded data,
2387 as a string, the back-end, as a symbol, and the communication
2391 ;;;; Objects Filters
2394 "List of functions applied to transcoded bold text.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2400 "List of functions applied to transcoded code text.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2406 "List of functions applied to a transcoded entity.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2412 "List of functions applied to a transcoded export-snippet.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2418 "List of functions applied to a transcoded footnote-reference.
2419 Each filter is called with three arguments: the transcoded data,
2420 as a string, the back-end, as a symbol, and the communication
2424 "List of functions applied to a transcoded inline-babel-call.
2425 Each filter is called with three arguments: the transcoded data,
2426 as a string, the back-end, as a symbol, and the communication
2430 "List of functions applied to a transcoded inline-src-block.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2436 "List of functions applied to transcoded italic text.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2442 "List of functions applied to a transcoded latex-fragment.
2443 Each filter is called with three arguments: the transcoded data,
2444 as a string, the back-end, as a symbol, and the communication
2448 "List of functions applied to a transcoded line-break.
2449 Each filter is called with three arguments: the transcoded data,
2450 as a string, the back-end, as a symbol, and the communication
2454 "List of functions applied to a transcoded link.
2455 Each filter is called with three arguments: the transcoded data,
2456 as a string, the back-end, as a symbol, and the communication
2460 "List of functions applied to a transcoded radio-target.
2461 Each filter is called with three arguments: the transcoded data,
2462 as a string, the back-end, as a symbol, and the communication
2466 "List of functions applied to a transcoded statistics-cookie.
2467 Each filter is called with three arguments: the transcoded data,
2468 as a string, the back-end, as a symbol, and the communication
2472 "List of functions applied to transcoded strike-through text.
2473 Each filter is called with three arguments: the transcoded data,
2474 as a string, the back-end, as a symbol, and the communication
2478 "List of functions applied to a transcoded subscript.
2479 Each filter is called with three arguments: the transcoded data,
2480 as a string, the back-end, as a symbol, and the communication
2484 "List of functions applied to a transcoded superscript.
2485 Each filter is called with three arguments: the transcoded data,
2486 as a string, the back-end, as a symbol, and the communication
2490 "List of functions applied to a transcoded target.
2491 Each filter is called with three arguments: the transcoded data,
2492 as a string, the back-end, as a symbol, and the communication
2496 "List of functions applied to a transcoded timestamp.
2497 Each filter is called with three arguments: the transcoded data,
2498 as a string, the back-end, as a symbol, and the communication
2502 "List of functions applied to transcoded underline text.
2503 Each filter is called with three arguments: the transcoded data,
2504 as a string, the back-end, as a symbol, and the communication
2508 "List of functions applied to transcoded verbatim text.
2509 Each filter is called with three arguments: the transcoded data,
2510 as a string, the back-end, as a symbol, and the communication
2514 ;;;; Filters Tools
2515 ;;
2516 ;; Internal function `org-export-install-filters' installs filters
2517 ;; hard-coded in back-ends (developer filters) and filters from global
2518 ;; variables (user filters) in the communication channel.
2519 ;;
2520 ;; Internal function `org-export-filter-apply-functions' takes care
2521 ;; about applying each filter in order to a given data. It ignores
2522 ;; filters returning a nil value but stops whenever a filter returns
2523 ;; an empty string.
2526 "Call every function in FILTERS.
2528 Functions are called with three arguments: a value, the export
2529 back-end name and the communication channel. First function in
2530 FILTERS is called with VALUE as its first argument. Second
2531 function in FILTERS is called with the previous result as its
2532 value, etc.
2534 Functions returning nil are skipped. Any function returning the
2535 empty string ends the process, which returns the empty string.
2537 Call is done in a LIFO fashion, to be sure that developer
2538 specified filters, if any, are called first."
2549 "Install filters properties in communication channel.
2550 INFO is a plist containing the current communication channel.
2551 Return the updated communication channel."
2553 ;; Install user-defined filters with `org-export-filters-alist'
2554 ;; and filters already in INFO (through ext-plist mechanism).
2561 ;; Filters in INFO will be called
2562 ;; before those user provided.
2565 default-value)))))
2566 ;; Prepend back-end specific filters to that list.
2568 ;; Single values get consed, lists are appended.
2573 plist key
2576 ;; Return new communication channel.
2580 \f
2581 ;;; Core functions
2582 ;;
2583 ;; This is the room for the main function, `org-export-as', along with
2584 ;; its derivative, `org-export-string-as'.
2585 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2586 ;; function should be added to kill ring.
2587 ;;
2588 ;; Note that `org-export-as' doesn't really parse the current buffer,
2589 ;; but a copy of it (with the same buffer-local variables and
2590 ;; visibility), where macros and include keywords are expanded and
2591 ;; Babel blocks are executed, if appropriate.
2592 ;; `org-export-with-buffer-copy' macro prepares that copy.
2593 ;;
2594 ;; File inclusion is taken care of by
2595 ;; `org-export-expand-include-keyword' and
2596 ;; `org-export--prepare-file-contents'. Structure wise, including
2597 ;; a whole Org file in a buffer often makes little sense. For
2598 ;; example, if the file contains a headline and the include keyword
2599 ;; was within an item, the item should contain the headline. That's
2600 ;; why file inclusion should be done before any structure can be
2601 ;; associated to the file, that is before parsing.
2602 ;;
2603 ;; `org-export-insert-default-template' is a command to insert
2604 ;; a default template (or a back-end specific template) at point or in
2605 ;; current subtree.
2608 "Return a copy of the current buffer.
2609 The copy preserves Org buffer-local variables, visibility and
2610 narrowing."
2616 new-buf))
2619 "Apply BODY in a copy of the current buffer.
2620 The copy preserves local variables, visibility and contents of
2621 the original buffer. Point is at the beginning of the buffer
2622 when BODY is applied."
2631 ;; Kill copy without confirmation.
2637 "Generate a function duplicating BUFFER.
2639 The copy will preserve local variables, visibility, contents and
2640 narrowing of the original buffer. If a region was active in
2641 BUFFER, contents will be narrowed to that region instead.
2643 The resulting function can be evaluated at a later time, from
2644 another buffer, effectively cloning the original buffer there.
2646 The function assumes BUFFER's major mode is `org-mode'."
2650 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2651 ;; already in BUFFER.
2653 ;; Copy specific buffer local variables and variables set
2654 ;; through BIND keywords.
2656 vars)
2664 buffer-file-name
2665 buffer-file-coding-system))
2669 ;; Skip unreadable values, as they cannot be
2670 ;; sent to external process.
2674 vars))))))
2675 ;; Whole buffer contents.
2680 ;; Narrowing.
2684 ;; Current position of point.
2686 ;; Overlays with invisible property.
2695 ov-set)))))))))
2698 "Delete commented trees and commented inlinetasks in the buffer.
2699 Narrowing, if any, is ignored."
2711 "Prune non exportable elements from DATA.
2712 DATA is the parse tree to traverse. INFO is the plist holding
2713 export info. Also set `:ignore-list' in INFO to a list of
2714 objects which should be ignored during export, but not removed
2715 from tree."
2717 ;; First find trees containing a select tag, if any.
2719 ;; List tags that prevent export of headlines.
2724 ;; Prune non-exportable elements and objects from tree.
2725 ;; As a special case, special rows and cells from tables
2726 ;; are stored in IGNORE, as they still need to be
2727 ;; accessed during export.
2737 ;; If headline is archived but tree below has
2738 ;; to be skipped, remove contents.
2740 ;; Move into recursive objects/elements.
2742 ;; Move into secondary string, if any.
2744 org-element-secondary-value-alist)))
2747 ;; Collect definitions before possibly pruning them so as
2748 ;; to avoid parsing them again if they are required.
2755 f)
2757 ;; If a select tag is active, also ignore the section before the
2758 ;; first headline, if any.
2763 ;; Prune tree and communication channel.
2766 ;; Priority is given to back-end specific options.
2768 org-export-options-alist))
2774 ;; Eventually set `:ignore-list'.
2778 "List footnote definitions missing from TREE.
2779 Missing definitions are searched within DEFINITIONS, which is
2780 a list of footnote definitions or in the widened buffer."
2783 ;; List all footnote labels encountered in DATA. Inline
2784 ;; footnote references are ignored.
2789 defined undefined missing-definitions)
2790 ;; Partition DIRECT-REFERENCES between DEFINED and UNDEFINED
2791 ;; references.
2798 seen)
2803 ;; Complete MISSING-DEFINITIONS by finding the definition of every
2804 ;; undefined label, first by looking into DEFINITIONS, then by
2805 ;; searching the widened buffer. This is a recursive process
2806 ;; since definitions found can themselves contain an undefined
2807 ;; reference.
2814 d))
2815 definitions))
2822 datum
2823 ;; Parse definition with contents.
2834 ;; Look for footnote references within DEFINITION, since
2835 ;; we may need to also find their definition.
2840 ;; MISSING-DEFINITIONS may contain footnote references with inline
2841 ;; definitions. Make sure those are changed into real footnote
2842 ;; definitions.
2849 missing-definitions)))
2852 "Install footnote definitions in tree.
2854 DEFINITIONS is the list of footnote definitions to install. TREE
2855 is the parse tree.
2857 If there is a footnote section in TREE, definitions found are
2858 appended to it. If `org-footnote-section' is non-nil, a new
2859 footnote section containing all definitions is inserted in TREE.
2860 Otherwise, definitions are appended at the end of the section
2861 containing their first reference."
2864 ;; If there is a footnote section, insert definitions there.
2868 nil t)))
2871 footnote-section
2873 ;; If there should be a footnote section, create one containing all
2874 ;; the definitions at the end of the tree.
2877 tree
2881 :title org-footnote-section
2884 'section
2885 nil
2887 ;; Otherwise add each definition at the end of the section where it
2888 ;; is first referenced.
2893 ;; Insert footnote definitions in the same section as
2894 ;; their first reference in DATA.
2905 label)
2906 d))
2907 definitions)))
2910 definition)
2911 ;; Also insert definitions for nested
2912 ;; references, if any.
2917 "Change uninterpreted elements back into Org syntax.
2918 DATA is a parse tree or a secondary string. INFO is a plist
2919 containing export options. It is modified by side effect and
2920 returned by the function."
2923 subscript superscript underline)
2927 ;; ... entities...
2934 ?\s)))))
2935 ;; ... emphasis...
2947 marker
2951 ?\s)))))))
2952 ;; ... LaTeX environments and fragments...
2956 ;; ... sub/superscripts...
2965 "_"
2974 ?\s)))))))))))
2976 ;; Splice NEW at DATUM location in parse tree.
2979 info nil nil t)
2980 ;; Return modified parse tree.
2981 data)
2983 ;;;###autoload
2986 "Transcode current Org buffer into BACKEND code.
2988 BACKEND is either an export back-end, as returned by, e.g.,
2989 `org-export-create-backend', or a symbol referring to
2990 a registered back-end.
2992 If narrowing is active in the current buffer, only transcode its
2993 narrowed part.
2995 If a region is active, transcode that region.
2997 When optional argument SUBTREEP is non-nil, transcode the
2998 sub-tree at point, extracting information from the headline
2999 properties first.
3001 When optional argument VISIBLE-ONLY is non-nil, don't export
3002 contents of hidden elements.
3004 When optional argument BODY-ONLY is non-nil, only return body
3005 code, without surrounding template.
3007 Optional argument EXT-PLIST, when provided, is a property list
3008 with external parameters overriding Org default settings, but
3009 still inferior to file-local settings.
3011 Return code as a string."
3016 ;; Narrow buffer to an appropriate region or subtree for
3017 ;; parsing. If parsing subtree, be sure to remove main
3018 ;; headline, planning data and property drawer.
3026 ;; Initialize communication channel with original buffer
3027 ;; attributes, unavailable in its copy.
3031 backend subtreep visible-only body-only)
3037 org-export-options-alist))))
3038 tree)
3039 ;; Update communication channel and get parse tree. Buffer
3040 ;; isn't parsed directly. Instead, all buffer modifications
3041 ;; and consequent parsing are undertaken in a temporary copy.
3043 ;; Run first hook with current back-end's name as argument.
3046 ;; Include files, delete comments and expand macros. Refresh
3047 ;; buffer properties and radio targets after these
3048 ;; potentially invasive changes.
3053 org-export-global-macros)
3054 parsed-keywords)
3057 ;; Possibly execute Babel code. Re-run a macro expansion
3058 ;; specifically for {{{results}}} since inline source blocks
3059 ;; may have generated some more. Refresh buffer properties
3060 ;; and radio targets another time.
3066 ;; Run last hook with current back-end's name as argument.
3067 ;; Update buffer properties and radio targets one last time
3068 ;; before parsing.
3075 ;; Update communication channel with environment.
3079 ;; De-activate uninterpreted data from parsed keywords.
3081 org-export-options-alist))
3086 p
3089 ;; Install user's and developer's filters.
3091 ;; Call options filters and update export options. We do not
3092 ;; use `org-export-filter-apply-functions' here since the
3093 ;; arity of such filters is different.
3098 ;; Parse buffer.
3100 ;; Prune tree from non-exported elements and transform
3101 ;; uninterpreted elements or objects in both parse tree and
3102 ;; communication channel.
3105 ;; Call parse tree filters.
3109 ;; Now tree is complete, compute its properties and add them
3110 ;; to communication channel.
3112 ;; Eventually transcode TREE. Wrap the resulting string into
3113 ;; a template.
3122 info))
3125 ;; Remove all text properties since they cannot be
3126 ;; retrieved from an external process. Finally call
3127 ;; final-output filter and return result.
3133 info))))))))
3135 ;;;###autoload
3137 "Transcode STRING into BACKEND code.
3139 BACKEND is either an export back-end, as returned by, e.g.,
3140 `org-export-create-backend', or a symbol referring to
3141 a registered back-end.
3143 When optional argument BODY-ONLY is non-nil, only return body
3144 code, without preamble nor postamble.
3146 Optional argument EXT-PLIST, when provided, is a property list
3147 with external parameters overriding Org default settings, but
3148 still inferior to file-local settings.
3150 Return code as a string."
3156 ;;;###autoload
3158 "Replace the active region by its export to BACKEND.
3159 BACKEND is either an export back-end, as returned by, e.g.,
3160 `org-export-create-backend', or a symbol referring to
3161 a registered back-end."
3167 ;;;###autoload
3169 "Insert all export keywords with default values at beginning of line.
3171 BACKEND is a symbol referring to the name of a registered export
3172 back-end, for which specific export options should be added to
3173 the template, or `default' for default template. When it is nil,
3174 the user will be prompted for a category.
3176 If SUBTREEP is non-nil, export configuration will be set up
3177 locally for the subtree through node properties."
3187 "Options category: "
3191 org-export-registered-backends))
3192 nil t))))
3193 options keywords)
3194 ;; Populate OPTIONS and KEYWORDS.
3211 ;; Move to an appropriate location in order to insert options.
3213 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3231 ;; Then the rest of keywords, in the order specified in either
3232 ;; `org-export-options-alist' or respective export back-ends.
3253 "Expand every include keyword in buffer.
3254 Optional argument INCLUDED is a list of included file names along
3255 with their line restriction, when appropriate. It is used to
3256 avoid infinite recursion. Optional argument DIR is the current
3257 working directory. It is used to properly resolve relative
3258 paths. Optional argument FOOTNOTES is a hash-table used for
3259 storing and resolving footnotes. It is created automatically."
3265 ;; If :minlevel is not set the text-property
3266 ;; `:org-include-induced-level' will be used to determine the
3267 ;; relative level when expanding INCLUDE.
3268 ;; Only affects included Org documents.
3272 :org-include-induced-level
3274 ;; Expand INCLUDE keywords.
3281 ;; Extract arguments from keyword's value.
3284 location
3292 matched)
3298 dir)))
3302 value)
3308 value)
3317 ;; Minimal level of included file defaults to the
3318 ;; child level of the current headline, if any, or
3319 ;; one. It only applies is the file is meant to be
3320 ;; included as an Org one.
3331 ;; Remove keyword.
3337 ;; Check if files has already been parsed. Look after
3338 ;; inclusion lines too, as different parts of the same
3339 ;; file can be included too.
3352 ind-str block arg-str contents ind-str block))))
3359 ind-str block contents ind-str block))))
3367 file location only-contents lines)
3368 lines)))
3372 file lines ind minlevel
3376 footnotes)))
3380 footnotes)
3382 ;; Expand footnotes after all files have been
3383 ;; included. Footnotes are stored at end of buffer.
3389 footnotes))))))))))))
3392 "Resolve absolute lines for an included file with file-link.
3394 FILE is string file-name of the file to include. LOCATION is a
3395 string name within FILE to be included (located via
3396 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3397 contents of the named element will be included, as determined
3398 Org-Element. If LINES is non-nil only those lines are included.
3400 Return a string of lines to be included in the format expected by
3401 `org-export--prepare-file-contents'."
3407 ;; Enforce consistent search.
3420 ;; Skip planning line and property-drawer.
3446 start-line
3448 (+ start-line
3451 counter))))))))
3455 "Prepare contents of FILE for inclusion and return it as a string.
3457 When optional argument LINES is a string specifying a range of
3458 lines, include only those lines.
3460 Optional argument IND, when non-nil, is an integer specifying the
3461 global indentation of returned contents. Since its purpose is to
3462 allow an included file to stay in the same environment it was
3463 created (e.g., a list item), it doesn't apply past the first
3464 headline encountered.
3466 Optional argument MINLEVEL, when non-nil, is an integer
3467 specifying the level that any top-level headline in the included
3468 file should have.
3470 Optional argument ID is an integer that will be inserted before
3471 each footnote definition and reference if FILE is an Org file.
3472 This is useful to avoid conflicts when more than one Org file
3473 with footnotes is included in a document.
3475 Optional argument FOOTNOTES is a hash-table to store footnotes in
3476 the included document."
3492 ;; Remove blank lines at beginning and end of contents. The logic
3493 ;; behind that removal is that blank lines around include keyword
3494 ;; override blank lines in included file.
3503 ;; If IND is set, preserve indentation of include keyword until
3504 ;; the first headline encountered.
3511 ;; Do not move footnote definitions out of column 0.
3517 ;; When MINLEVEL is specified, compute minimal level for headlines
3518 ;; in the file (CUR-MIN), and remove stars to each headline so
3519 ;; that headlines with minimal level have a level of MINLEVEL.
3530 ;; Only change stars, don't bother moving whole
3531 ;; sections.
3536 ;; Append ID to all footnote references and definitions, so they
3537 ;; become file specific and cannot collide with footnotes in other
3538 ;; included files. Further, collect relevant footnote definitions
3539 ;; outside of LINES, in order to reintroduce them later.
3545 ;; Generate new label from LABEL by prefixing it with
3546 ;; "-ID-".
3550 ;; Replace OLD label with NEW in footnote F.
3564 ;; Update the footnote-reference at point and collect
3565 ;; the new label, which is only used for footnotes
3566 ;; outsides LINES.
3578 ;; Store since footnote-definition is
3579 ;; outside of LINES.
3582 footnotes))))
3589 "Return a non-nil value when output should be added to the kill ring.
3590 See also `org-export-copy-to-kill-ring'."
3596 \f
3597 ;;; Tools For Back-Ends
3598 ;;
3599 ;; A whole set of tools is available to help build new exporters. Any
3600 ;; function general enough to have its use across many back-ends
3601 ;; should be added here.
3603 ;;;; For Affiliated Keywords
3604 ;;
3605 ;; `org-export-read-attribute' reads a property from a given element
3606 ;; as a plist. It can be used to normalize affiliated keywords'
3607 ;; syntax.
3608 ;;
3609 ;; Since captions can span over multiple lines and accept dual values,
3610 ;; their internal representation is a bit tricky. Therefore,
3611 ;; `org-export-get-caption' transparently returns a given element's
3612 ;; caption as a secondary string.
3615 "Turn ATTRIBUTE property from ELEMENT into a plist.
3617 When optional argument PROPERTY is non-nil, return the value of
3618 that property within attributes.
3622 properties.
3624 All values will become strings except the empty string and
3627 will become the empty string."
3641 s)
3646 ;; Ignore any string before first property with `cdr'.
3651 "Return caption from ELEMENT as a secondary string.
3653 When optional argument SHORTP is non-nil, return short caption,
3654 as a secondary string, instead.
3656 Caption lines are separated by a white space."
3664 ;;;; For Derived Back-ends
3665 ;;
3666 ;; `org-export-with-backend' is a function allowing to locally use
3667 ;; another back-end to transcode some object or element. In a derived
3668 ;; back-end, it may be used as a fall-back function once all specific
3669 ;; cases have been treated.
3672 "Call a transcoder from BACKEND on DATA.
3673 BACKEND is an export back-end, as returned by, e.g.,
3674 `org-export-create-backend', or a symbol referring to
3675 a registered back-end. DATA is an Org element, object, secondary
3676 string or string. CONTENTS, when non-nil, is the transcoded
3677 contents of DATA element, as a string. INFO, when non-nil, is
3678 the communication channel used for export, as a plist."
3689 :back-end backend
3690 :translate-alist all-transcoders
3692 ;; `:internal-references' are shared across back-ends.
3700 ;;;; For Export Snippets
3701 ;;
3702 ;; Every export snippet is transmitted to the back-end. Though, the
3703 ;; latter will only retain one type of export-snippet, ignoring
3704 ;; others, based on the former's target back-end. The function
3705 ;; `org-export-snippet-backend' returns that back-end for a given
3706 ;; export-snippet.
3709 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3710 Translation, with `org-export-snippet-translation-alist', is
3711 applied."
3715 back-end))))
3718 ;;;; For Footnotes
3719 ;;
3720 ;; `org-export-collect-footnote-definitions' is a tool to list
3721 ;; actually used footnotes definitions in the whole parse tree, or in
3722 ;; a headline, in order to add footnote listings throughout the
3723 ;; transcoded data.
3724 ;;
3725 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3726 ;; back-ends, when they need to attach the footnote definition only to
3727 ;; the first occurrence of the corresponding label.
3728 ;;
3729 ;; `org-export-get-footnote-definition' and
3730 ;; `org-export-get-footnote-number' provide easier access to
3731 ;; additional information relative to a footnote reference.
3734 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3735 INFO is the plist used as a communication channel. If no such
3736 definition can be found, raise an error."
3742 hash))))
3750 ;; Skip any footnote with a different label.
3751 ;; Also skip any standard footnote reference
3752 ;; with the same label since those cannot
3753 ;; contain a definition.
3757 ;; Even if the contents are empty, we can not
3758 ;; return nil since that would eventually raise
3759 ;; the error. Instead, return the equivalent
3760 ;; empty string.
3762 info t)
3763 cache)
3768 "Apply FUNCTION on every footnote reference in DATA.
3769 INFO is a plist containing export state. By default, as soon as
3770 a new footnote reference is encountered, FUNCTION is called onto
3771 its definition. However, if BODY-FIRST is non-nil, this step is
3772 delayed until the end of the process."
3777 ;; Search footnote references through DATA, filling
3778 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3779 ;; store footnote definitions so they can be entered
3780 ;; later.
3787 ;; Search for subsequent references in footnote
3788 ;; definition so numbering follows reading
3789 ;; logic, unless DELAYP in non-nil.
3793 definitions))
3794 ;; Do not force entering inline definitions,
3795 ;; since `org-element-map' already traverses
3796 ;; them at the right time.
3800 nil))))))
3801 info nil
3802 ;; Don't enter footnote definitions since it will
3803 ;; happen when their first reference is found.
3804 ;; Moreover, if DELAYP is non-nil, make sure we
3805 ;; postpone entering definitions of inline references.
3812 "Return an alist between footnote numbers, labels and definitions.
3814 INFO is the current export state, as a plist.
3816 Definitions are collected throughout the whole parse tree, or
3817 DATA when non-nil.
3819 Sorting is done by order of references. As soon as a new
3820 reference is encountered, other references are searched within
3821 its definition. However, if BODY-FIRST is non-nil, this step is
3822 delayed after the whole tree is checked. This alters results
3823 when references are found in footnote definitions.
3825 Definitions either appear as Org data or as a secondary string
3826 for inlined footnotes. Unreferenced definitions are ignored."
3830 ;; Collect footnote number, label and definition.
3841 "Non-nil when a footnote reference is the first one for its label.
3843 FOOTNOTE-REFERENCE is the footnote reference being considered.
3844 INFO is a plist containing current export state.
3846 Search is done throughout the whole parse tree, or DATA when
3847 non-nil.
3849 By default, as soon as a new footnote reference is encountered,
3850 other references are searched within its definition. However, if
3851 BODY-FIRST is non-nil, this step is delayed after the whole tree
3852 is checked. This alters results when references are found in
3853 footnote definitions."
3855 ;; Anonymous footnotes are always a first reference.
3866 "Return number associated to a footnote.
3868 FOOTNOTE is either a footnote reference or a footnote definition.
3869 INFO is the plist containing export state.
3871 Number is unique throughout the whole parse tree, or DATA, when
3872 non-nil.
3874 By default, as soon as a new footnote reference is encountered,
3875 counting process moves into its definition. However, if
3876 BODY-FIRST is non-nil, this step is delayed until the end of the
3877 process, leading to a different order when footnotes are nested."
3886 ;; Anonymous footnote match: return number.
3888 ;; Labels match: return number.
3890 ;; Otherwise store label and increase counter if label
3891 ;; wasn't encountered yet.
3897 ;;;; For Headlines
3898 ;;
3899 ;; `org-export-get-relative-level' is a shortcut to get headline
3900 ;; level, relatively to the lower headline level in the parsed tree.
3901 ;;
3902 ;; `org-export-get-headline-number' returns the section number of an
3903 ;; headline, while `org-export-number-to-roman' allows it to be
3904 ;; converted to roman numbers. With an optional argument,
3905 ;; `org-export-get-headline-number' returns a number to unnumbered
3906 ;; headlines (used for internal id).
3907 ;;
3908 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3909 ;; `org-export-last-sibling-p' are three useful predicates when it
3910 ;; comes to fulfill the `:headline-levels' property.
3911 ;;
3912 ;; `org-export-get-tags', `org-export-get-category' and
3913 ;; `org-export-get-node-property' extract useful information from an
3914 ;; headline or a parent headline. They all handle inheritance.
3915 ;;
3916 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3917 ;; as a secondary string, suitable for table of contents. It falls
3918 ;; back onto default title.
3921 "Return HEADLINE relative level within current parsed tree.
3922 INFO is a plist holding contextual information."
3927 "Non-nil when HEADLINE is considered as low level.
3929 INFO is a plist used as a communication channel.
3931 A low level headlines has a relative level greater than
3932 `:headline-levels' property value.
3934 Return value is the difference between HEADLINE relative level
3935 and the last level being considered as high enough, or nil."
3942 "Return numbered HEADLINE numbering as a list of numbers.
3943 INFO is a plist holding contextual information."
3948 "Return a non-nil value if HEADLINE element should be numbered.
3949 INFO is a plist used as a communication channel."
3956 "Convert integer N into a roman numeral."
3969 res)))
3972 "Return list of tags associated to ELEMENT.
3974 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3975 is a plist used as a communication channel.
3977 When non-nil, optional argument TAGS should be a list of strings.
3978 Any tag belonging to this list will also be removed.
3980 When optional argument INHERITED is non-nil, tags can also be
3981 inherited from parent headlines and FILETAGS keywords."
3985 ;; Build complete list of inherited tags.
3992 ;; Add FILETAGS keywords and return results.
3996 "Return node PROPERTY value for BLOB.
3998 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3999 element or object.
4001 If optional argument INHERITED is non-nil, the value can be
4002 inherited from a parent headline.
4004 Return value is a string or nil."
4016 "Return category for element or object BLOB.
4018 INFO is a plist used as a communication channel.
4020 CATEGORY is automatically inherited from a parent headline, from
4021 #+CATEGORY: keyword or created out of original file name. If all
4034 "Return alternative title for HEADLINE, as a secondary string.
4035 If no optional title is defined, fall-back to the regular title."
4042 "Non-nil when BLOB is the first sibling in its parent.
4043 BLOB is an element or an object. If BLOB is a headline, non-nil
4044 means it is the first sibling in the sub-tree. INFO is a plist
4045 used as a communication channel."
4050 "Non-nil when DATUM is the last sibling in its parent.
4051 DATUM is an element or an object. INFO is a plist used as
4052 a communication channel."
4060 ;;;; For Keywords
4061 ;;
4062 ;; `org-export-get-date' returns a date appropriate for the document
4063 ;; to about to be exported. In particular, it takes care of
4064 ;; `org-export-date-timestamp-format'.
4067 "Return date value for the current document.
4069 INFO is a plist used as a communication channel. FMT, when
4070 non-nil, is a time format string that will be applied on the date
4071 if it consists in a single timestamp object. It defaults to
4072 `org-export-date-timestamp-format' when nil.
4074 A proper date can be a secondary string, a string or nil. It is
4075 meant to be translated with `org-export-data' or alike."
4086 ;;;; For Links
4087 ;;
4088 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4089 ;; in `org-link-parameters'.
4090 ;;
4091 ;; `org-export-get-coderef-format' returns an appropriate format
4092 ;; string for coderefs.
4093 ;;
4094 ;; `org-export-inline-image-p' returns a non-nil value when the link
4095 ;; provided should be considered as an inline image.
4096 ;;
4097 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4098 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4099 ;; returns an appropriate unique identifier.
4100 ;;
4101 ;; `org-export-resolve-id-link' returns the first headline with
4102 ;; specified id or custom-id in parse tree, the path to the external
4103 ;; file with the id.
4104 ;;
4105 ;; `org-export-resolve-coderef' associates a reference to a line
4106 ;; number in the element it belongs, or returns the reference itself
4107 ;; when the element isn't numbered.
4108 ;;
4109 ;; `org-export-file-uri' expands a filename as stored in :path value
4110 ;; of a "file" link into a file URI.
4111 ;;
4112 ;; Broken links raise a `org-link-broken' error, which is caught by
4113 ;; `org-export-data' for further processing, depending on
4114 ;; `org-export-with-broken-links' value.
4119 "Try exporting LINK with a dedicated function.
4121 DESC is its description, as a string, or nil. BACKEND is the
4122 back-end used for export, as a symbol.
4124 Return output as a string, or nil if no protocol handles LINK.
4126 A custom protocol has precedence over regular back-end export.
4127 The function ignores links with an implicit type (e.g.,
4136 desc
4137 backend))))))
4140 "Return format string for code reference link.
4141 PATH is the link path. DESC is its description."
4149 "Non-nil if LINK object points to an inline image.
4151 Optional argument is a set of RULES defining inline images. It
4152 is an alist where associations have the following shape:
4154 (TYPE . REGEXP)
4156 Applying a rule means apply REGEXP against LINK's path when its
4157 type is TYPE. The function will return a non-nil value if any of
4158 the provided rules is non-nil. The default rule is
4159 `org-export-default-inline-image-rule'.
4161 This only applies to links without a description."
4171 "Insert image links in DATA.
4173 Org syntax does not support nested links. Nevertheless, some
4174 export back-ends support images as descriptions of links. Since
4175 images are really links to image files, we need to make an
4176 exception about links nesting.
4178 This function recognizes links whose contents are really images
4179 and turn them into proper nested links. It is meant to be used
4180 as a parse tree filter in back-ends supporting such constructs.
4182 DATA is a parse tree. INFO is the current state of the export
4183 process, as a plist.
4185 A description is a valid images if it matches any rule in RULES,
4186 if non-nil, or `org-export-default-inline-image-rule' otherwise.
4187 See `org-export-inline-image-p' for more information about the
4188 structure of RULES.
4190 Return modified DATA."
4192 org-plain-link-re
4193 org-angle-link-re))
4206 ;; Replace contents with image link.
4212 info nil nil t))
4213 data)
4216 "Resolve a code reference REF.
4218 INFO is a plist used as a communication channel.
4220 Return associated line number in source code, or REF itself,
4221 depending on src-block or example element's switches. Throw an
4222 error if no block contains REF."
4228 org-coderef-label-format))
4230 ;; Element containing REF is found. Resolve it to
4231 ;; either a label or a line number, as needed.
4240 "List search cells for element or object DATUM.
4242 A search cell follows the pattern (TYPE . SEARCH) where
4244 TYPE is a symbol among `headline', `custom-id', `target' and
4245 `other'.
4247 SEARCH is the string a link is expected to match. More
4248 accurately, it is
4250 - headline's title, as a list of strings, if TYPE is
4251 `headline'.
4253 - CUSTOM_ID value, as a string, if TYPE is `custom-id'.
4255 - target's or radio-target's name as a list of strings if
4256 TYPE is `target'.
4258 - NAME affiliated keyword if TYPE is `other'.
4260 A search cell is the internal representation of a fuzzy link. It
4261 ignores white spaces and statistics cookies, if applicable."
4263 (`headline
4274 (`target
4282 "Return search cells associated to string S.
4283 S is either the path of a fuzzy link or a search option, i.e., it
4284 tries to match either a headline (through custom ID or title),
4285 a target or a named element."
4293 "Non-nil when DATUM matches search cells CELLS.
4294 DATUM is an element or object. CELLS is a list of search cells,
4295 as returned by `org-export-search-cells'."
4300 "Return LINK destination.
4302 INFO is a plist holding contextual information.
4304 Return value can be an object or an element:
4306 - If LINK path matches a target object (i.e. <<path>>) return it.
4308 - If LINK path exactly matches the name affiliated keyword
4309 (i.e. #+NAME: path) of an element, return that element.
4311 - If LINK path exactly matches any headline name, return that
4312 element.
4314 - Otherwise, throw an error.
4317 significant."
4323 table)))
4331 datum)))))
4335 search-cells
4336 ;; There can be multiple matches for un-typed searches, i.e.,
4337 ;; for searches not starting with # or *. In this case,
4338 ;; prioritize targets and names over headline titles.
4339 ;; Matching both a name and a target is not valid, and
4340 ;; therefore undefined.
4343 datum))
4344 matches)
4346 link-cache)))))
4349 "Return headline referenced as LINK destination.
4351 INFO is a plist used as a communication channel.
4353 Return value can be the headline element matched in current parse
4357 ;; First check if id is within the current parse tree.
4362 headline))
4364 ;; Otherwise, look for external files.
4369 "Return radio-target object referenced as LINK destination.
4371 INFO is a plist used as a communication channel.
4373 Return value can be a radio-target object or nil. Assume LINK
4382 nil nil path nil nil t)
4383 t)
4384 radio))
4388 "Return file URI associated to FILENAME."
4395 fullname)))))
4397 ;;;; For References
4398 ;;
4399 ;; `org-export-get-reference' associate a unique reference for any
4400 ;; object or element. It uses `org-export-new-reference' and
4401 ;; `org-export-format-reference' to, respectively, generate new
4402 ;; internal references and turn them into a string suitable for
4403 ;; output.
4404 ;;
4405 ;; `org-export-get-ordinal' associates a sequence number to any object
4406 ;; or element.
4409 "Return a unique reference, among REFERENCES.
4410 REFERENCES is an alist whose values are in-use references, as
4411 numbers. Returns a number, which is the internal representation
4412 of a reference. See also `org-export-format-reference'."
4413 ;; Generate random 7 digits hexadecimal numbers. Collisions
4414 ;; increase exponentially with the numbers of references. However,
4415 ;; the odds for encountering at least one collision with 1000 active
4416 ;; references in the same document are roughly 0.2%, so this
4417 ;; shouldn't be the bottleneck.
4420 new))
4423 "Format REFERENCE into a string.
4424 REFERENCE is a number representing a reference, as returned by
4425 `org-export-new-reference', which see."
4429 "Return a unique reference for DATUM, as a string.
4431 DATUM is either an element or an object. INFO is the current
4432 export state, as a plist.
4434 References for the current document are stored in
4435 `:internal-references' property. Its value is an alist with
4436 associations of the following types:
4438 (REFERENCE . DATUM) and (SEARCH-CELL . ID)
4440 REFERENCE is the reference string to be used for object or
4441 element DATUM. SEARCH-CELL is a search cell, as returned by
4442 `org-export-search-cells'. ID is a number or a string uniquely
4443 identifying DATUM within the document.
4445 This function also checks `:crossrefs' property for search cells
4446 matching DATUM before creating a new reference."
4451 ;; Preserve any pre-existing association between
4452 ;; a search cell and a reference, i.e., when some
4453 ;; previously published document referenced a location
4454 ;; within current file (see
4455 ;; `org-publish-resolve-external-link').
4456 ;;
4457 ;; However, there is no guarantee that search cells are
4458 ;; unique, e.g., there might be duplicate custom ID or
4459 ;; two headings with the same title in the file.
4460 ;;
4461 ;; As a consequence, before re-using any reference to
4462 ;; an element or object, we check that it doesn't refer
4463 ;; to a previous element or object.
4470 cells)
4473 ;; Cache contains both data already associated to
4474 ;; a reference and in-use internal references, so as to make
4475 ;; unique references.
4477 ;; Retain a direct association between reference string and
4478 ;; DATUM since (1) not every object or element can be given
4479 ;; a search cell (2) it permits quick lookup.
4482 reference-string))))
4485 "Return ordinal number of an element or object.
4487 ELEMENT is the element or object considered. INFO is the plist
4488 used as a communication channel.
4490 Optional argument TYPES, when non-nil, is a list of element or
4491 object types, as symbols, that should also be counted in.
4492 Otherwise, only provided element's type is considered.
4494 Optional argument PREDICATE is a function returning a non-nil
4495 value if the current element or object should be counted in. It
4496 accepts two arguments: the element or object being considered and
4497 the plist used as a communication channel. This allows counting
4498 only a certain type of object (i.e. inline images).
4500 Return value is a list of numbers if ELEMENT is a headline or an
4501 item. It is nil for keywords. It represents the footnote number
4502 for footnote definitions and footnote references. If ELEMENT is
4503 a target, return the same value as if ELEMENT was the closest
4504 table, item or headline containing the target. In any other
4505 case, return the sequence number of ELEMENT among elements or
4506 objects of the same type."
4507 ;; Ordinal of a target object refer to the ordinal of the closest
4508 ;; table, item, or headline containing the object.
4512 element
4515 ;; Special case 1: A headline returns its number as a list.
4517 ;; Special case 2: An item returns its number as a list.
4521 struct
4528 ;; Increment counter until ELEMENT is found again.
4539 ;;;; For Src-Blocks
4540 ;;
4541 ;; `org-export-get-loc' counts number of code lines accumulated in
4542 ;; src-block or example-block elements with a "+n" switch until
4543 ;; a given element, excluded. Note: "-n" switches reset that count.
4544 ;;
4545 ;; `org-export-unravel-code' extracts source code (along with a code
4546 ;; references alist) from an `element-block' or `src-block' type
4547 ;; element.
4548 ;;
4549 ;; `org-export-format-code' applies a formatting function to each line
4550 ;; of code, providing relative line number and code reference when
4551 ;; appropriate. Since it doesn't access the original element from
4552 ;; which the source code is coming, it expects from the code calling
4553 ;; it to know if lines should be numbered and if code references
4554 ;; should appear.
4555 ;;
4556 ;; Eventually, `org-export-format-code-default' is a higher-level
4557 ;; function (it makes use of the two previous functions) which handles
4558 ;; line numbering and code references inclusion, and returns source
4559 ;; code in a format suitable for plain text or verbatim output.
4562 "Return count of lines of code before ELEMENT.
4564 ELEMENT is an example-block or src-block element. INFO is the
4565 plist used as a communication channel.
4567 Count includes every line of code in example-block or src-block
4569 ELEMENT doesn't allow line numbering."
4576 ;; ELEMENT is reached: Quit loop and return locs.
4578 ;; Only count lines from src-block and example-block
4579 ;; elements with a "+n" or "-n" switch.
4584 ;; Accumulate locs or reset them.
4592 "Clean source code and extract references out of it.
4594 ELEMENT has either a `src-block' an `example-block' type.
4596 Return a cons cell whose CAR is the source code, cleaned from any
4597 reference, protective commas and spurious indentation, and CDR is
4598 an alist between relative line number (integer) and name of code
4599 reference on that line (string)."
4602 ;; Remove global indentation from code, if necessary. Also
4603 ;; remove final newline character, since it doesn't belongs
4604 ;; to the code proper.
4609 value
4611 ;; Build a regexp matching a loc with a reference.
4613 ;; Return value.
4615 ;; Code with references removed.
4620 ;; Ref line: remove ref, and add its position in REFS.
4624 ;; Reference alist.
4625 refs)))
4628 "Format CODE by applying FUN line-wise and return it.
4630 CODE is a string representing the code to format. FUN is
4631 a function. It must accept three arguments: a line of
4632 code (string), the current line number (integer) or nil and the
4633 reference associated to the current line (string) or nil.
4635 Optional argument NUM-LINES can be an integer representing the
4636 number of code lines accumulated until the current code. Line
4637 numbers passed to FUN will take it into account. If it is nil,
4638 FUN's second argument will always be nil. This number can be
4639 obtained with `org-export-get-loc' function.
4641 Optional argument REF-ALIST can be an alist between relative line
4642 number (i.e. ignoring NUM-LINES) and the name of the code
4643 reference on it. If it is nil, FUN's third argument will always
4644 be nil. It can be obtained through the use of
4645 `org-export-unravel-code' function."
4658 "Return source code from ELEMENT, formatted in a standard way.
4660 ELEMENT is either a `src-block' or `example-block' element. INFO
4661 is a plist used as a communication channel.
4663 This function takes care of line numbering and code references
4664 inclusion. Line numbers, when applicable, appear at the
4665 beginning of the line, separated from the code by two white
4666 spaces. Code references, on the other hand, appear flushed to
4667 the right, separated by six white spaces from the widest line of
4668 code."
4669 ;; Extract code and references.
4676 ;; Handle line numbering.
4683 ;; Prepare references display, if required. Any reference
4684 ;; should start six columns after the widest line of code,
4685 ;; wrapped with parenthesis.
4690 code
4694 number-str
4695 loc
4699 ?\s)
4701 num-start refs)))))
4704 ;;;; For Tables
4705 ;;
4706 ;; `org-export-table-has-special-column-p' and and
4707 ;; `org-export-table-row-is-special-p' are predicates used to look for
4708 ;; meta-information about the table structure.
4709 ;;
4710 ;; `org-table-has-header-p' tells when the rows before the first rule
4711 ;; should be considered as table's header.
4712 ;;
4713 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4714 ;; and `org-export-table-cell-borders' extract information from
4715 ;; a table-cell element.
4716 ;;
4717 ;; `org-export-table-dimensions' gives the number on rows and columns
4718 ;; in the table, ignoring horizontal rules and special columns.
4719 ;; `org-export-table-cell-address', given a table-cell object, returns
4720 ;; the absolute address of a cell. On the other hand,
4721 ;; `org-export-get-table-cell-at' does the contrary.
4722 ;;
4723 ;; `org-export-table-cell-starts-colgroup-p',
4724 ;; `org-export-table-cell-ends-colgroup-p',
4725 ;; `org-export-table-row-starts-rowgroup-p',
4726 ;; `org-export-table-row-ends-rowgroup-p',
4727 ;; `org-export-table-row-starts-header-p',
4728 ;; `org-export-table-row-ends-header-p' and
4729 ;; `org-export-table-row-in-header-p' indicate position of current row
4730 ;; or cell within the table.
4733 "Non-nil when TABLE has a special column.
4734 All special columns will be ignored during export."
4735 ;; The table has a special column when every first cell of every row
4736 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4737 ;; "*" "_" and "^". Though, do not consider a first column
4738 ;; containing only empty cells as special.
4753 "Non-nil when TABLE has a header.
4755 INFO is a plist used as a communication channel.
4757 A table has a header when it contains at least two row groups."
4761 table)))
4777 nil)))
4779 cache)))))
4782 "Non-nil if TABLE-ROW is considered special.
4783 All special rows will be ignored during export."
4787 ;; A row is special either when...
4789 ;; ... it starts with a field only containing "/",
4791 ;; ... the table contains a special column and the row start
4792 ;; with a marking character among, "^", "_", "$" or "!",
4796 ;; ... it contains only alignment cookies and empty cells.
4801 ;; Since VALUE is a secondary string, the following
4802 ;; checks avoid expanding it with `org-export-data'.
4813 "Return TABLE-ROW's group number, as an integer.
4815 INFO is a plist used as the communication channel.
4817 Return value is the group number, as an integer, or nil for
4818 special rows and rows separators. First group is also table's
4819 header."
4824 table)))
4827 ;; First time a row is queried, populate cache with all the
4828 ;; rows from the table.
4836 info))
4840 "Return TABLE-CELL contents width.
4842 INFO is a plist used as the communication channel.
4844 Return value is the width given by the last width cookie in the
4845 same column as TABLE-CELL, or nil."
4854 table)))
4863 ;; In a special row, try to find a width cookie at COLUMN.
4867 ;; The following checks avoid expanding unnecessarily
4868 ;; the cell with `org-export-data'.
4878 "Return TABLE-CELL contents alignment.
4880 INFO is a plist used as the communication channel.
4882 Return alignment as specified by the last alignment cookie in the
4883 same column as TABLE-CELL. If no such cookie is found, a default
4884 alignment value will be deduced from fraction of numbers in the
4885 column (see `org-table-number-fraction' for more information).
4886 Possible values are `left', `right' and `center'."
4887 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4897 table)))
4903 cookie-align
4904 previous-cell-number-p)
4907 ;; In a special row, try to find an alignment cookie at
4908 ;; COLUMN.
4912 ;; Since VALUE is a secondary string, the following
4913 ;; checks avoid useless expansion through
4914 ;; `org-export-data'.
4922 ;; Ignore table rules.
4924 ;; In a standard row, check if cell's contents are
4925 ;; expressing some kind of number. Increase NUMBER-CELLS
4926 ;; accordingly. Though, don't bother if an alignment
4927 ;; cookie has already defined cell's alignment.
4932 info)))
4934 ;; Treat an empty cell as a number if it follows
4935 ;; a number.
4941 ;; Return value. Alignment specified by cookies has
4942 ;; precedence over alignment deduced from cell's contents.
4944 column
4949 org-table-number-fraction)
4954 "Return TABLE-CELL borders.
4956 INFO is a plist used as a communication channel.
4958 Return value is a list of symbols, or nil. Possible values are:
4959 `top', `bottom', `above', `below', `left' and `right'. Note:
4960 `top' (resp. `bottom') only happen for a cell in the first
4961 row (resp. last row) of the table, ignoring table rules, if any.
4963 Returned borders ignore special rows."
4966 borders)
4967 ;; Top/above border? TABLE-CELL has a border above when a rule
4968 ;; used to demarcate row groups can be found above. Hence,
4969 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4970 ;; another regular row has to be found above that rule.
4973 ;; Look at every row before the current one.
4980 ;; No rule above, or rule found starts the table (ignoring any
4981 ;; special row): TABLE-CELL is at the top of the table.
4984 ;; Bottom/below border? TABLE-CELL has a border below when next
4985 ;; non-regular row below is a rule.
4988 ;; Look at every row after the current one.
4995 ;; No rule below, or rule found ends the table (modulo some
4996 ;; special row): TABLE-CELL is at the bottom of the table.
4999 ;; Right/left borders? They can only be specified by column
5000 ;; groups. Column groups are defined in a row starting with "/".
5001 ;; Also a column groups row only contains "<", "<>", ">" or blank
5002 ;; cells.
5006 ;; Table rows are read in reverse order so last column groups
5007 ;; row has precedence over any previous one.
5020 ;; There's a left border when previous cell, if
5021 ;; any, ends a group, or current one starts one.
5027 ;; There's a right border when next cell, if any,
5028 ;; starts a group, or current one ends one.
5035 ;; Return value.
5036 borders))
5039 "Non-nil when TABLE-CELL is at the beginning of a column group.
5040 INFO is a plist used as a communication channel."
5041 ;; A cell starts a column group either when it is at the beginning
5042 ;; of a row (or after the special column, if any) or when it has
5043 ;; a left border.
5046 table-cell)
5050 "Non-nil when TABLE-CELL is at the end of a column group.
5051 INFO is a plist used as a communication channel."
5052 ;; A cell ends a column group either when it is at the end of a row
5053 ;; or when it has a right border.
5056 table-cell)
5060 "Non-nil when TABLE-ROW is at the beginning of a row group.
5061 INFO is a plist used as a communication channel."
5069 "Non-nil when TABLE-ROW is at the end of a row group.
5070 INFO is a plist used as a communication channel."
5078 "Non-nil when TABLE-ROW is located within table's header.
5079 INFO is a plist used as a communication channel. Always return
5080 nil for special rows and rows separators."
5086 "Non-nil when TABLE-ROW is the first table header's row.
5087 INFO is a plist used as a communication channel."
5092 "Non-nil when TABLE-ROW is the last table header's row.
5093 INFO is a plist used as a communication channel."
5098 "Return TABLE-ROW number.
5099 INFO is a plist used as a communication channel. Return value is
5100 zero-indexed and ignores separators. The function returns nil
5101 for special rows and separators."
5106 table)))
5109 ;; First time a row is queried, populate cache with all the
5110 ;; rows from the table.
5116 info))
5120 "Return TABLE dimensions.
5122 INFO is a plist used as a communication channel.
5124 Return value is a CONS like (ROWS . COLUMNS) where
5125 ROWS (resp. COLUMNS) is the number of exportable
5126 rows (resp. columns)."
5128 ;; Set number of rows, and extract first one.
5134 ;; Set number of columns.
5136 ;; Return value.
5140 "Return address of a regular TABLE-CELL object.
5142 TABLE-CELL is the cell considered. INFO is a plist used as
5143 a communication channel.
5145 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5146 zero-based index. Only exportable cells are considered. The
5147 function returns nil for other cells."
5159 "Return regular table-cell object at ADDRESS in TABLE.
5161 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5162 zero-based index. TABLE is a table type element. INFO is
5163 a plist used as a communication channel.
5165 If no table-cell, among exportable cells, is found at ADDRESS,
5166 return nil."
5169 ;; Row at (car address) or nil.
5177 'table-cell
5184 ;;;; For Tables of Contents
5185 ;;
5186 ;; `org-export-collect-headlines' builds a list of all exportable
5187 ;; headline elements, maybe limited to a certain depth. One can then
5188 ;; easily parse it and transcode it.
5189 ;;
5190 ;; Building lists of tables, figures or listings is quite similar.
5191 ;; Once the generic function `org-export-collect-elements' is defined,
5192 ;; `org-export-collect-tables', `org-export-collect-figures' and
5193 ;; `org-export-collect-listings' can be derived from it.
5194 ;;
5195 ;; `org-export-toc-entry-backend' builds a special anonymous back-end
5196 ;; useful to export table of contents' entries.
5199 "Collect headlines in order to build a table of contents.
5201 INFO is a plist used as a communication channel.
5203 When optional argument N is an integer, it specifies the depth of
5204 the table of contents. Otherwise, it is set to the value of the
5205 last headline level. See `org-export-headline-levels' for more
5206 information.
5208 Optional argument SCOPE, when non-nil, is an element. If it is
5209 a headline, only children of SCOPE are collected. Otherwise,
5210 collect children of the headline containing provided element. If
5211 there is no such headline, collect all headlines. In any case,
5212 argument N becomes relative to the level of that headline.
5214 Return a list of all exportable headlines as parsed elements.
5215 Footnote sections are ignored."
5224 limit))))
5231 h))
5232 info)))
5235 "Collect referenceable elements of a determined type.
5237 TYPE can be a symbol or a list of symbols specifying element
5238 types to search. Only elements with a caption are collected.
5240 INFO is a plist used as a communication channel.
5242 When non-nil, optional argument PREDICATE is a function accepting
5243 one argument, an element of type TYPE. It returns a non-nil
5244 value when that element should be collected.
5246 Return a list of all elements found, in order of appearance."
5251 element))
5252 info))
5255 "Build a list of tables.
5256 INFO is a plist used as a communication channel.
5258 Return a list of table elements with a caption."
5262 "Build a list of figures.
5264 INFO is a plist used as a communication channel. PREDICATE is
5265 a function which accepts one argument: a paragraph element and
5266 whose return value is non-nil when that element should be
5267 collected.
5269 A figure is a paragraph type element, with a caption, verifying
5271 a vague concept that may depend on back-end.
5273 Return a list of elements recognized as figures."
5277 "Build a list of src blocks.
5279 INFO is a plist used as a communication channel.
5281 Return a list of src-block elements with a caption."
5285 "Non-nil if HEADLINE should be excluded from tables of contents.
5287 INFO is a plist used as a communication channel.
5289 Note that such headlines are already excluded from
5290 `org-export-collect-headlines'. Therefore, this function is not
5291 necessary if you only need to list headlines in the table of
5292 contents. However, it is useful if some additional processing is
5293 required on headlines excluded from table of contents."
5299 "Return an export back-end appropriate for table of contents entries.
5301 PARENT is an export back-end the returned back-end should inherit
5302 from.
5304 By default, the back-end removes footnote references and targets.
5305 It also changes links and radio targets into regular text.
5306 TRANSCODERS optional argument, when non-nil, specifies additional
5307 transcoders. A transcoder follows the pattern (TYPE . FUNCTION)
5308 where type is an element or object type and FUNCTION the function
5309 transcoding it."
5312 :parent parent
5313 :transcoders
5320 i))))
5325 ;;;; Smart Quotes
5326 ;;
5327 ;; The main function for the smart quotes sub-system is
5328 ;; `org-export-activate-smart-quotes', which replaces every quote in
5329 ;; a given string from the parse tree with its "smart" counterpart.
5330 ;;
5331 ;; Dictionary for smart quotes is stored in
5332 ;; `org-export-smart-quotes-alist'.
5348 ;; one may use: »...«, "...", ›...‹, or '...'.
5349 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5350 ;; LaTeX quotes require Babel!
5410 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5421 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5432 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5443 ;; 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
5444 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5455 ;; Based on https://sl.wikipedia.org/wiki/Narekovaj
5466 ;; Based on https://sv.wikipedia.org/wiki/Citattecken
5472 "Smart quotes translations.
5474 Alist whose CAR is a language string and CDR is an alist with
5475 quote type as key and a plist associating various encodings to
5476 their translation as value.
5478 A quote type can be any symbol among `primary-opening',
5479 `primary-closing', `secondary-opening', `secondary-closing' and
5480 `apostrophe'.
5482 Valid encodings include `:utf-8', `:html', `:latex' and
5483 `:texinfo'.
5488 "Return smart quote status at the beginning of string S.
5489 INFO is the current export state, as a plist."
5494 table)))
5502 'plain-text
5511 ;; Not already in a level 1 quote: this is an
5512 ;; apostrophe.
5514 ;; Extract previous char and next char. As
5515 ;; a special case, they can also be set to `blank',
5516 ;; `no-blank' or nil. Then determine if current
5517 ;; match is allowed as an opening quote or a closing
5518 ;; quote.
5523 text info)))
5540 previous)
5551 next)
5558 current-status)
5562 info nil org-element-recursive-objects)
5569 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5570 `:utf-8'. INFO is a plist used as a communication channel.
5572 The function has to retrieve information about string
5573 surroundings in parse tree. It can only happen with an
5574 unmodified string. Thus, if S has already been through another
5575 process, a non-nil ORIGINAL optional argument will provide that
5576 original string.
5578 Return the new string."
5587 org-export-smart-quotes-alist))))
5588 encoding)
5589 match))
5590 s nil t)))
5592 ;;;; Topology
5593 ;;
5594 ;; Here are various functions to retrieve information about the
5595 ;; neighborhood of a given element or object. Neighbors of interest
5596 ;; are direct parent (`org-export-get-parent'), parent headline
5597 ;; (`org-export-get-parent-headline'), first element containing an
5598 ;; object, (`org-export-get-parent-element'), parent table
5599 ;; (`org-export-get-parent-table'), previous element or object
5600 ;; (`org-export-get-previous-element') and next element or object
5601 ;; (`org-export-get-next-element').
5603 ;; defsubst org-export-get-parent must be defined before first use
5606 "Return BLOB parent headline or nil.
5607 BLOB is the element or object being considered."
5611 "Return first element containing OBJECT or nil.
5612 OBJECT is the object to consider."
5616 "Return OBJECT parent table or nil.
5617 OBJECT is either a `table-cell' or `table-element' type object."
5621 "Return previous element or object.
5623 BLOB is an element or object. INFO is a plist used as
5624 a communication channel. Return previous exportable element or
5625 object, a string, or nil.
5627 When optional argument N is a positive integer, return a list
5628 containing up to N siblings before BLOB, from farthest to
5629 closest. With any other non-nil value, return a list containing
5630 all of them."
5636 prev)
5646 "Return next element or object.
5648 BLOB is an element or object. INFO is a plist used as
5649 a communication channel. Return next exportable element or
5650 object, a string, or nil.
5652 When optional argument N is a positive integer, return a list
5653 containing up to N siblings after BLOB, from closest to farthest.
5654 With any other non-nil value, return a list containing all of
5655 them."
5662 next)
5672 ;;;; Translation
5673 ;;
5674 ;; `org-export-translate' translates a string according to the language
5675 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5676 ;; the dictionary used for the translation.
5712 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5725 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5731 ("ru" :html "(Продолжение следует)"
5823 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5849 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5855 ("ru" :html "Список распечаток"
5873 ("ru" :html "Список таблиц"
6017 ("ru" :html "Неизвестная ссылка"
6021 "Dictionary for export engine.
6023 Alist whose car is the string to translate and cdr is an alist
6024 whose car is the language string and cdr is a plist whose
6025 properties are possible charsets and values translated terms.
6027 It is used as a database for `org-export-translate'. Since this
6028 function returns the string as-is if no translation was found,
6029 the variable only needs to record values different from the
6033 "Translate string S according to language specification.
6035 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
6036 and `:utf-8'. INFO is a plist used as a communication channel.
6038 Translation depends on `:language' property. Return the
6039 translated string. If no translation is found, try to fall back
6040 to `:default' encoding. If it fails, return S."
6046 s)))
6049 \f
6050 ;;; Asynchronous Export
6051 ;;
6052 ;; `org-export-async-start' is the entry point for asynchronous
6053 ;; export. It recreates current buffer (including visibility,
6054 ;; narrowing and visited file) in an external Emacs process, and
6055 ;; evaluates a command there. It then applies a function on the
6056 ;; returned results in the current process.
6057 ;;
6058 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
6059 ;; allow exporting to a buffer or a file, asynchronously or not.
6060 ;;
6061 ;; `org-export-output-file-name' is an auxiliary function meant to be
6062 ;; used with `org-export-to-file'. With a given extension, it tries
6063 ;; to provide a canonical file name to write export output to.
6064 ;;
6065 ;; Asynchronously generated results are never displayed directly.
6066 ;; Instead, they are stored in `org-export-stack-contents'. They can
6067 ;; then be retrieved by calling `org-export-stack'.
6068 ;;
6069 ;; Export Stack is viewed through a dedicated major mode
6070 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
6071 ;;`org-export-stack-delete', `org-export-stack-view' and
6072 ;;`org-export-stack-clear'.
6073 ;;
6074 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
6075 ;; It should be used whenever `org-export-async-start' is called.
6078 "Call function FUN on the results returned by BODY evaluation.
6080 FUN is an anonymous function of one argument. BODY evaluation
6081 happens in an asynchronous process, from a buffer which is an
6082 exact copy of the current one.
6084 Use `org-export-add-to-stack' in FUN in order to register results
6085 in the stack.
6087 This is a low level function. See also `org-export-to-buffer'
6088 and `org-export-to-file' for more specialized functions."
6091 ;; Write the full sexp evaluating BODY in a copy of the current
6092 ;; buffer to a temporary file, as it may be too long for program
6093 ;; args in `start-process'.
6100 ;; Null characters (from variable values) are inserted
6101 ;; within the file. As a consequence, coding system for
6102 ;; buffer contents will not be recognized properly. So,
6103 ;; we make sure it is the same as the one used to display
6104 ;; the original buffer.
6106 ,coding
6109 ;; Ignore `kill-emacs-hook' and code evaluation
6110 ;; queries from Babel as we need a truly
6111 ;; non-interactive process.
6113 org-babel-confirm-evaluate-answer-no t)
6114 ;; Initialize export framework.
6116 ;; Re-create current buffer there.
6119 ;; Sexp to evaluate in the buffer.
6121 ;; Start external process.
6124 (,process
6126 #'start-process
6129 ,proc-buffer
6136 ;; Register running process in stack.
6138 ;; Set-up sentinel in order to catch results.
6141 ,process
6163 ;;;###autoload
6166 &optional async subtreep visible-only body-only ext-plist
6167 post-process)
6168 "Call `org-export-as' with output to a specified buffer.
6170 BACKEND is either an export back-end, as returned by, e.g.,
6171 `org-export-create-backend', or a symbol referring to
6172 a registered back-end.
6174 BUFFER is the name of the output buffer. If it already exists,
6175 it will be erased first, otherwise, it will be created.
6177 A non-nil optional argument ASYNC means the process should happen
6178 asynchronously. The resulting buffer should then be accessible
6179 through the `org-export-stack' interface. When ASYNC is nil, the
6180 buffer is displayed if `org-export-show-temporary-export-buffer'
6181 is non-nil.
6183 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6184 EXT-PLIST are similar to those used in `org-export-as', which
6185 see.
6187 Optional argument POST-PROCESS is a function which should accept
6188 no argument. It is always called within the current process,
6189 from BUFFER, with point at its beginning. Export back-ends can
6190 use it to set a major mode there, e.g,
6192 (defun org-latex-export-as-latex
6193 (&optional async subtreep visible-only body-only ext-plist)
6194 (interactive)
6196 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
6198 This function returns BUFFER."
6226 buffer)))
6228 ;;;###autoload
6231 post-process)
6232 "Call `org-export-as' with output to a specified file.
6234 BACKEND is either an export back-end, as returned by, e.g.,
6235 `org-export-create-backend', or a symbol referring to
6236 a registered back-end. FILE is the name of the output file, as
6237 a string.
6239 A non-nil optional argument ASYNC means the process should happen
6240 asynchronously. The resulting buffer will then be accessible
6241 through the `org-export-stack' interface.
6243 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6244 EXT-PLIST are similar to those used in `org-export-as', which
6245 see.
6247 Optional argument POST-PROCESS is called with FILE as its
6248 argument and happens asynchronously when ASYNC is non-nil. It
6249 has to return a file name, or nil. Export back-ends can use this
6250 to send the output file through additional processing, e.g,
6252 (defun org-latex-export-to-latex
6253 (&optional async subtreep visible-only body-only ext-plist)
6254 (interactive)
6257 async subtreep visible-only body-only ext-plist
6258 (lambda (file) (org-latex-compile file)))
6260 The function returns either a file name returned by POST-PROCESS,
6261 or FILE."
6280 backend subtreep visible-only body-only ext-plist)))
6287 ;; Get proper return value.
6289 file))))))
6292 "Return output file's name according to buffer specifications.
6294 EXTENSION is a string representing the output file extension,
6295 with the leading dot.
6297 With a non-nil optional argument SUBTREEP, try to determine
6299 of subtree at point.
6301 When optional argument PUB-DIR is set, use it as the publishing
6302 directory.
6304 Return file name as a string."
6310 ;; Check EXPORT_FILE_NAME subtree property.
6312 ;; Check #+EXPORT_FILE_NAME keyword.
6322 ;; Extract from buffer's associated file, if any.
6324 ;; Can't determine file name on our own: ask user.
6326 "Output file: " pub-dir nil nil nil
6328 extension))
6330 ;; Build file name. Enforce EXTENSION over whatever user
6331 ;; may have come up with. PUB-DIR, if defined, always has
6332 ;; precedence over any provided path.
6338 ;; If writing to OUTPUT-FILE would overwrite original file, append
6339 ;; EXTENSION another time to final name.
6342 output-file)))
6345 "Add a new result to export stack if not present already.
6347 SOURCE is a buffer or a file name containing export results.
6348 BACKEND is a symbol representing export back-end used to generate
6349 it.
6351 Entries already pointing to SOURCE and unavailable entries are
6352 removed beforehand. Return the new stack."
6358 "Menu for asynchronous export results and running processes."
6368 "Remove all entries from export stack."
6373 "Refresh the export stack."
6378 "Remove export results at point from stack.
6379 If optional argument SOURCE is non-nil, remove it instead."
6384 org-export-stack-contents))))
6387 "View export results at point in stack.
6388 With an optional prefix argument IN-EMACS, force viewing files
6389 within Emacs."
6403 (define-key km "\C-p" 'previous-line)
6404 (define-key km "\C-?" 'previous-line)
6405 (define-key km [up] 'previous-line)
6406 (define-key km "C" 'org-export-stack-clear)
6407 (define-key km "v" 'org-export-stack-view)
6408 (define-key km (kbd "RET") 'org-export-stack-view)
6409 (define-key km "d" 'org-export-stack-remove)
6410 km)
6411 "Keymap for Org Export Stack.")
6413 (define-derived-mode org-export-stack-mode tabulated-list-mode "Org-Stack"
6414 "Mode for displaying asynchronous export stack.
6417 stack.
6419 In an Org Export Stack buffer, use \
6423 stack completely.
6425 Removing entries in a stack buffer does not affect files
6426 or buffers, only display.
6429 (setq tabulated-list-format
6430 (vector (list "#" 4 #'org-export--stack-num-predicate)
6431 (list "Back-End" 12 t)
6432 (list "Age" 6 nil)
6433 (list "Source" 0 nil)))
6434 (setq tabulated-list-sort-key (cons "#" nil))
6435 (setq tabulated-list-entries #'org-export--stack-generate)
6436 (add-hook 'tabulated-list-revert-hook #'org-export--stack-generate nil t)
6437 (add-hook 'post-command-hook #'org-export-stack-refresh nil t)
6438 (tabulated-list-init-header))
6440 (defun org-export--stack-generate ()
6441 "Generate the asynchronous export stack for display.
6442 Unavailable sources are removed from the list. Return a list
6443 appropriate for `tabulated-list-print'."
6444 ;; Clear stack from exited processes, dead buffers or non-existent
6445 ;; files.
6446 (setq org-export-stack-contents
6447 (cl-remove-if-not
6448 (lambda (el)
6449 (if (processp (nth 2 el))
6450 (buffer-live-p (process-buffer (nth 2 el)))
6451 (let ((source (car el)))
6452 (if (bufferp source) (buffer-live-p source)
6453 (file-exists-p source)))))
6454 org-export-stack-contents))
6455 ;; Update `tabulated-list-entries'.
6456 (let ((counter 0))
6457 (mapcar
6458 (lambda (entry)
6459 (let ((source (car entry)))
6460 (list source
6461 (vector
6462 ;; Counter.
6463 (number-to-string (cl-incf counter))
6464 ;; Back-End.
6465 (if (nth 1 entry) (symbol-name (nth 1 entry)) "")
6466 ;; Age.
6467 (let ((info (nth 2 entry)))
6468 (if (processp info) (symbol-name (process-status info))
6469 (format-seconds "%h:%.2m" (float-time (time-since info)))))
6470 ;; Source.
6471 (if (stringp source) source (buffer-name source))))))
6472 org-export-stack-contents)))
6474 (defun org-export--stack-num-predicate (a b)
6475 (< (string-to-number (aref (nth 1 a) 0))
6476 (string-to-number (aref (nth 1 b) 0))))
6478 (defun org-export--stack-source-at-point ()
6479 "Return source from export results at point in stack."
6480 (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
6481 (if (not source) (error "Source unavailable, please refresh buffer")
6482 (let ((source-name (if (stringp source) source (buffer-name source))))
6483 (if (save-excursion
6484 (beginning-of-line)
6485 (looking-at-p (concat ".* +" (regexp-quote source-name) "$")))
6486 source
6487 ;; SOURCE is not consistent with current line. The stack
6488 ;; view is outdated.
6489 (error (substitute-command-keys
6491 to refresh buffer")))))))
6494 \f
6495 ;;; The Dispatcher
6496 ;;
6497 ;; `org-export-dispatch' is the standard interactive way to start an
6498 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6499 ;; for its interface, which, in turn, delegates response to key
6500 ;; pressed to `org-export--dispatch-action'.
6502 ;;;###autoload
6503 (defun org-export-dispatch (&optional arg)
6504 "Export dispatcher for Org mode.
6506 It provides an access to common export related tasks in a buffer.
6507 Its interface comes in two flavors: standard and expert.
6509 While both share the same set of bindings, only the former
6510 displays the valid keys associations in a dedicated buffer.
6511 Scrolling (resp. line-wise motion) in this buffer is done with
6512 SPC and DEL (resp. C-n and C-p) keys.
6514 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6515 flavor or the other.
6518 same
6519 set of options used back then, on the current buffer.
6522 asynchronous export stack."
6523 (interactive "P")
6524 (let* ((input
6525 (cond ((equal arg '(16)) '(stack))
6526 ((and arg org-export-dispatch-last-action))
6527 (t (save-window-excursion
6528 (unwind-protect
6529 (progn
6530 ;; Remember where we are
6531 (move-marker org-export-dispatch-last-position
6532 (point)
6533 (org-base-buffer (current-buffer)))
6534 ;; Get and store an export command
6535 (setq org-export-dispatch-last-action
6536 (org-export--dispatch-ui
6537 (list org-export-initial-scope
6538 (and org-export-in-background 'async))
6539 nil
6540 org-export-dispatch-use-expert-ui)))
6541 (and (get-buffer "*Org Export Dispatcher*")
6542 (kill-buffer "*Org Export Dispatcher*")))))))
6543 (action (car input))
6544 (optns (cdr input)))
6545 (unless (memq 'subtree optns)
6546 (move-marker org-export-dispatch-last-position nil))
6547 (cl-case action
6548 ;; First handle special hard-coded actions.
6549 (template (org-export-insert-default-template nil optns))
6550 (stack (org-export-stack))
6551 (publish-current-file
6552 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6553 (publish-current-project
6554 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6555 (publish-choose-project
6556 (org-publish (assoc (completing-read
6557 "Publish project: "
6558 org-publish-project-alist nil t)
6559 org-publish-project-alist)
6560 (memq 'force optns)
6561 (memq 'async optns)))
6562 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6563 (otherwise
6564 (save-excursion
6565 (when arg
6566 ;; Repeating command, maybe move cursor to restore subtree
6567 ;; context.
6568 (if (eq (marker-buffer org-export-dispatch-last-position)
6569 (org-base-buffer (current-buffer)))
6570 (goto-char org-export-dispatch-last-position)
6571 ;; We are in a different buffer, forget position.
6572 (move-marker org-export-dispatch-last-position nil)))
6573 (funcall action
6574 ;; Return a symbol instead of a list to ease
6575 ;; asynchronous export macro use.
6576 (and (memq 'async optns) t)
6577 (and (memq 'subtree optns) t)
6578 (and (memq 'visible optns) t)
6579 (and (memq 'body optns) t)))))))
6581 (defun org-export--dispatch-ui (options first-key expertp)
6582 "Handle interface for `org-export-dispatch'.
6584 OPTIONS is a list containing current interactive options set for
6585 export. It can contain any of the following symbols:
6586 `body' toggles a body-only export
6587 `subtree' restricts export to current subtree
6588 `visible' restricts export to visible part of buffer.
6589 `force' force publishing files.
6590 `async' use asynchronous export process
6592 FIRST-KEY is the key pressed to select the first level menu. It
6593 is nil when this menu hasn't been selected yet.
6595 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6596 buffer is provided, but indications about currently active
6597 options are given in the prompt. Moreover, [?] allows switching
6598 back to standard interface."
6599 (let* ((fontify-key
6600 (lambda (key &optional access-key)
6601 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6602 ;; non-nil is the required first-level key to activate
6603 ;; KEY. When its value is t, activate KEY independently
6604 ;; on the first key, if any. A nil value means KEY will
6605 ;; only be activated at first level.
6606 (if (or (eq access-key t) (eq access-key first-key))
6607 (propertize key 'face 'org-warning)
6608 key)))
6609 (fontify-value
6610 (lambda (value)
6611 ;; Fontify VALUE string.
6612 (propertize value 'face 'font-lock-variable-name-face)))
6613 ;; Prepare menu entries by extracting them from registered
6614 ;; back-ends and sorting them by access key and by ordinal,
6615 ;; if any.
6616 (entries
6617 (sort (sort (delq nil
6618 (mapcar #'org-export-backend-menu
6619 org-export-registered-backends))
6620 (lambda (a b)
6621 (let ((key-a (nth 1 a))
6622 (key-b (nth 1 b)))
6623 (cond ((and (numberp key-a) (numberp key-b))
6624 (< key-a key-b))
6625 ((numberp key-b) t)))))
6626 'car-less-than-car))
6627 ;; Compute a list of allowed keys based on the first key
6628 ;; pressed, if any. Some keys
6629 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6630 ;; available.
6631 (allowed-keys
6632 (nconc (list 2 22 19 6 1)
6633 (if (not first-key) (org-uniquify (mapcar 'car entries))
6634 (let (sub-menu)
6635 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6636 (when (eq (car entry) first-key)
6637 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6638 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6639 ((not first-key) (list ?P)))
6640 (list ?& ?#)
6641 (when expertp (list ??))
6642 (list ?q)))
6643 ;; Build the help menu for standard UI.
6644 (help
6645 (unless expertp
6646 (concat
6647 ;; Options are hard-coded.
6648 (format "[%s] Body only: %s [%s] Visible only: %s
6649 \[%s] Export scope: %s [%s] Force publishing: %s
6651 (funcall fontify-key "C-b" t)
6652 (funcall fontify-value
6653 (if (memq 'body options) "On " "Off"))
6654 (funcall fontify-key "C-v" t)
6655 (funcall fontify-value
6656 (if (memq 'visible options) "On " "Off"))
6657 (funcall fontify-key "C-s" t)
6658 (funcall fontify-value
6659 (if (memq 'subtree options) "Subtree" "Buffer "))
6660 (funcall fontify-key "C-f" t)
6661 (funcall fontify-value
6662 (if (memq 'force options) "On " "Off"))
6663 (funcall fontify-key "C-a" t)
6664 (funcall fontify-value
6665 (if (memq 'async options) "On " "Off")))
6666 ;; Display registered back-end entries. When a key
6667 ;; appears for the second time, do not create another
6668 ;; entry, but append its sub-menu to existing menu.
6669 (let (last-key)
6670 (mapconcat
6671 (lambda (entry)
6672 (let ((top-key (car entry)))
6673 (concat
6674 (unless (eq top-key last-key)
6675 (setq last-key top-key)
6677 (funcall fontify-key (char-to-string top-key))
6678 (nth 1 entry)))
6679 (let ((sub-menu (nth 2 entry)))
6680 (unless (functionp sub-menu)
6681 ;; Split sub-menu into two columns.
6682 (let ((index -1))
6683 (concat
6684 (mapconcat
6685 (lambda (sub-entry)
6686 (cl-incf index)
6687 (format
6688 (if (zerop (mod index 2)) " [%s] %-26s"
6690 (funcall fontify-key
6691 (char-to-string (car sub-entry))
6692 top-key)
6693 (nth 1 sub-entry)))
6694 sub-menu "")
6696 entries ""))
6697 ;; Publishing menu is hard-coded.
6699 [%s] Current file [%s] Current project
6701 (funcall fontify-key "P")
6702 (funcall fontify-key "f" ?P)
6703 (funcall fontify-key "p" ?P)
6704 (funcall fontify-key "x" ?P)
6705 (funcall fontify-key "a" ?P))
6707 (funcall fontify-key "&" t)
6708 (funcall fontify-key "#" t))
6709 (format "[%s] %s"
6710 (funcall fontify-key "q" t)
6711 (if first-key "Main menu" "Exit")))))
6712 ;; Build prompts for both standard and expert UI.
6713 (standard-prompt (unless expertp "Export command: "))
6714 (expert-prompt
6715 (when expertp
6716 (format
6717 "Export command (C-%s%s%s%s%s) [%s]: "
6718 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6719 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6720 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6721 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6722 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6723 (mapconcat (lambda (k)
6724 ;; Strip control characters.
6725 (unless (< k 27) (char-to-string k)))
6726 allowed-keys "")))))
6727 ;; With expert UI, just read key with a fancy prompt. In standard
6728 ;; UI, display an intrusive help buffer.
6729 (if expertp
6730 (org-export--dispatch-action
6731 expert-prompt allowed-keys entries options first-key expertp)
6732 ;; At first call, create frame layout in order to display menu.
6733 (unless (get-buffer "*Org Export Dispatcher*")
6734 (delete-other-windows)
6735 (org-switch-to-buffer-other-window
6736 (get-buffer-create "*Org Export Dispatcher*"))
6737 (setq cursor-type nil
6738 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6739 ;; Make sure that invisible cursor will not highlight square
6740 ;; brackets.
6741 (set-syntax-table (copy-syntax-table))
6742 (modify-syntax-entry ?\[ "w"))
6743 ;; At this point, the buffer containing the menu exists and is
6744 ;; visible in the current window. So, refresh it.
6745 (with-current-buffer "*Org Export Dispatcher*"
6746 ;; Refresh help. Maintain display continuity by re-visiting
6747 ;; previous window position.
6748 (let ((pos (window-start)))
6749 (erase-buffer)
6750 (insert help)
6751 (set-window-start nil pos)))
6752 (org-fit-window-to-buffer)
6753 (org-export--dispatch-action
6754 standard-prompt allowed-keys entries options first-key expertp))))
6756 (defun org-export--dispatch-action
6757 (prompt allowed-keys entries options first-key expertp)
6758 "Read a character from command input and act accordingly.
6760 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6761 a list of characters available at a given step in the process.
6762 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6763 EXPERTP are the same as defined in `org-export--dispatch-ui',
6764 which see.
6766 Toggle export options when required. Otherwise, return value is
6767 a list with action as CAR and a list of interactive export
6768 options as CDR."
6769 (let (key)
6770 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6771 ;; C-p, SPC, DEL).
6772 (while (and (setq key (read-char-exclusive prompt))
6773 (not expertp)
6774 (memq key '(14 16 ?\s ?\d)))
6775 (cl-case key
6776 (14 (if (not (pos-visible-in-window-p (point-max)))
6777 (ignore-errors (scroll-up 1))
6778 (message "End of buffer")
6779 (sit-for 1)))
6780 (16 (if (not (pos-visible-in-window-p (point-min)))
6781 (ignore-errors (scroll-down 1))
6782 (message "Beginning of buffer")
6783 (sit-for 1)))
6784 (?\s (if (not (pos-visible-in-window-p (point-max)))
6785 (scroll-up nil)
6786 (message "End of buffer")
6787 (sit-for 1)))
6788 (?\d (if (not (pos-visible-in-window-p (point-min)))
6789 (scroll-down nil)
6790 (message "Beginning of buffer")
6791 (sit-for 1)))))
6792 (cond
6793 ;; Ignore undefined associations.
6794 ((not (memq key allowed-keys))
6795 (ding)
6796 (unless expertp (message "Invalid key") (sit-for 1))
6797 (org-export--dispatch-ui options first-key expertp))
6798 ;; q key at first level aborts export. At second level, cancel
6799 ;; first key instead.
6800 ((eq key ?q) (if (not first-key) (error "Export aborted")
6801 (org-export--dispatch-ui options nil expertp)))
6802 ;; Help key: Switch back to standard interface if expert UI was
6803 ;; active.
6804 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6805 ;; Send request for template insertion along with export scope.
6806 ((eq key ?#) (cons 'template (memq 'subtree options)))
6807 ;; Switch to asynchronous export stack.
6808 ((eq key ?&) '(stack))
6809 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6810 ((memq key '(2 22 19 6 1))
6811 (org-export--dispatch-ui
6812 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6813 (6 'force) (1 'async))))
6814 (if (memq option options) (remq option options)
6815 (cons option options)))
6816 first-key expertp))
6817 ;; Action selected: Send key and options back to
6818 ;; `org-export-dispatch'.
6819 ((or first-key (functionp (nth 2 (assq key entries))))
6820 (cons (cond
6821 ((not first-key) (nth 2 (assq key entries)))
6822 ;; Publishing actions are hard-coded. Send a special
6823 ;; signal to `org-export-dispatch'.
6824 ((eq first-key ?P)
6825 (cl-case key
6826 (?f 'publish-current-file)
6827 (?p 'publish-current-project)
6828 (?x 'publish-choose-project)
6829 (?a 'publish-all)))
6830 ;; Return first action associated to FIRST-KEY + KEY
6831 ;; path. Indeed, derived backends can share the same
6832 ;; FIRST-KEY.
6833 (t (catch 'found
6834 (dolist (entry (member (assq first-key entries) entries))
6835 (let ((match (assq key (nth 2 entry))))
6836 (when match (throw 'found (nth 2 match))))))))
6837 options))
6838 ;; Otherwise, enter sub-menu.
6839 (t (org-export--dispatch-ui options key expertp)))))
6843 (provide 'ox)
6845 ;; Local variables:
6846 ;; generated-autoload-file: "org-loaddefs.el"
6847 ;; End:
6849 ;;; ox.el ends here