| blob | b6528d90c9c472a275ef35df870a6b3626496d83 |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2017 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
91 \f
92 ;;; Internal Variables
93 ;;
94 ;; Among internal variables, the most important is
95 ;; `org-export-options-alist'. This variable define the global export
96 ;; options, shared between every exporter, and how they are acquired.
142 "Alist between export properties and ways to set them.
144 The key of the alist is the property name, and the value is a list
145 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
147 KEYWORD is a string representing a buffer keyword, or nil. Each
148 property defined this way can also be set, during subtree
149 export, through a headline property named after the keyword
151 property).
152 OPTION is a string that could be found in an #+OPTIONS: line.
153 DEFAULT is the default value for the property.
154 BEHAVIOR determines how Org should handle multiple keywords for
155 the same property. It is a symbol among:
156 nil Keep old value and discard the new one.
157 t Replace old value with the new one.
158 `space' Concatenate the values, separating them with a space.
159 `newline' Concatenate the values, separating them with
160 a newline.
161 `split' Split values at white spaces, and cons them to the
162 previous list.
163 `parse' Parse value as a list of strings and Org objects,
164 which can then be transcoded with, e.g.,
165 `org-export-data'. It implies `space' behavior.
167 Values set through KEYWORD and OPTION have precedence over
168 DEFAULT.
170 All these properties should be back-end agnostic. Back-end
171 specific properties are set through `org-export-define-backend'.
175 "List of in-buffer keywords that require special treatment.
176 These keywords are not directly associated to a property. The
177 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
263 org-element--cache org-element--cache-objects org-element--cache-sync-keys
264 org-element--cache-sync-requests org-element--cache-sync-timer)
265 "List of variables not copied through upon buffer duplication.
266 Export process takes place on a copy of the original buffer.
267 When this copy is created, all Org related local variables not in
268 this list are copied to the new buffer. Variables with an
272 "Non-nil means asynchronous export process should leave data behind.
276 located in `temporary-file-directory'.
278 When non-nil, it will also set `debug-on-error' to a non-nil
282 "Record asynchronously generated export results and processes.
283 This is an alist: its CAR is the source of the
284 result (destination file or buffer for a finished process,
285 original buffer for a running one) and its CDR is a list
286 containing the back-end used, as a symbol, and either a process
287 or the time at which it finished. It is used to build the menu
291 "List of backends currently available in the exporter.
292 This variable is set with `org-export-define-backend' and
296 "Last command called from the dispatcher.
297 The value should be a list. Its CAR is the action, as a symbol,
301 "The position where the last export command was created using the dispatcher.
302 This marker will be used with `C-u C-c C-e' to make sure export repetition
305 ;; For compatibility with Org < 8
307 "Name, if any, of the back-end used during an export process.
309 Its value is a symbol such as `html', `latex', `ascii', or nil if
310 the back-end is anonymous (see `org-export-create-backend') or if
311 there is no export process in progress.
313 It can be used to teach Babel blocks how to act differently
317 \f
318 ;;; User-configurable Variables
319 ;;
320 ;; Configuration for the masses.
321 ;;
322 ;; They should never be accessed directly, as their value is to be
323 ;; stored in a property list (cf. `org-export-options-alist').
324 ;; Back-ends will read their value from there instead.
327 "Options for exporting Org mode files."
332 "General options for export engine."
337 "Whether sub-trees with the ARCHIVE tag should be exported.
339 This can have three different values:
340 nil Do not export, pretend this tree is not present.
341 t Do export the entire tree.
342 `headline' Only export the headline, but skip the tree below it.
344 This option can also be set with the OPTIONS keyword,
354 "Non-nil means insert author name into the exported file.
355 This option can also be set with the OPTIONS keyword,
362 "Non-nil means export CLOCK keywords.
363 This option can also be set with the OPTIONS keyword,
370 "Non-nil means the postamble should contain a creator sentence.
372 The sentence can be set in `org-export-creator-string', which
373 see.
375 This option can also be set with the OPTIONS keyword, e.g.,
384 "Non-nil means insert date in the exported document.
385 This option can also be set with the OPTIONS keyword,
392 "Time-stamp format string to use for DATE keyword.
394 The format string, when specified, only applies if date consists
395 in a single time-stamp. Otherwise its value will be ignored.
397 See `format-time-string' for details on how to build this
398 string."
407 emacs-version
409 "Information about the creator of the document.
410 This option can also be set on with the CREATOR keyword."
416 "Non-nil means export contents of standard drawers.
418 When t, all drawers are exported. This may also be a list of
419 drawer names to export, as strings. If that list starts with
420 `not', only drawers with such names will be ignored.
422 This variable doesn't apply to properties drawers. See
423 `org-export-with-properties' instead.
425 This option can also be set with the OPTIONS keyword,
438 :inline t
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 TOC contains headlines with levels up
718 to`org-export-headline-levels'. When an integer, include levels
719 up to N in the toc, this may then be different from
720 `org-export-headline-levels', but it will not be allowed to be
721 larger than the number of headline levels. When nil, no table of
722 contents is made.
724 This option can also be set with the OPTIONS keyword,
735 "Non-nil means export tables.
736 This option can also be set with the OPTIONS keyword,
745 "If nil, do not export tags, just remove them from headlines.
747 If this is the symbol `not-in-toc', tags will be removed from
748 table of contents entries, but still be shown in the headlines of
749 the document.
751 This option can also be set with the OPTIONS keyword,
761 "Non-nil means include TODO items for export.
763 This may have the following values:
764 t include tasks independent of state.
765 `todo' include only tasks that are not yet done.
766 `done' include only tasks that are already done.
767 nil ignore all tasks.
768 list of keywords include tasks with these keywords.
770 This option can also be set with the OPTIONS keyword,
785 "Non-nil means print title into the exported file.
786 This option can also be set with the OPTIONS keyword,
795 "Non-nil means insert a time stamp into the exported file.
796 The time stamp shows when the file was created. This option can
803 "Non nil means allow timestamps in export.
805 It can be set to any of the following values:
806 t export all timestamps.
807 `active' export active timestamps only.
808 `inactive' export inactive timestamps only.
809 nil do not export timestamps
811 This only applies to timestamps isolated in a paragraph
812 containing only timestamps. Other timestamps are always
813 exported.
815 This option can also be set with the OPTIONS keyword, e.g.
826 "Non-nil means include TODO keywords in export.
827 When nil, remove all these keywords from the export. This option
833 "Non-nil means BIND keywords can define local variable values.
834 This is a potential security risk, which is why the default value
835 is nil. You can also allow them through local buffer variables."
842 "Non-nil means do not raise an error on broken links.
844 When this variable is non-nil, broken links are ignored, without
845 stopping the export process. If it is set to `mark', broken
846 links are marked as such in the output, with a string like
848 [BROKEN LINK: path]
850 where PATH is the un-resolvable reference.
852 This option can also be set with the OPTIONS keyword, e.g.,
863 "Alist between export snippets back-ends and exporter back-ends.
865 This variable allows providing shortcuts for export snippets.
869 HTML code while every other back-end will ignore it."
883 "Alist between macro names and expansion templates.
885 This variable defines macro expansion templates available
886 globally. Associations follow the pattern
888 (NAME . TEMPLATE)
890 where NAME is a string beginning with a letter and consisting of
891 alphanumeric characters only.
893 TEMPLATE is the string to which the macro is going to be
895 macro's arguments. Moreover, if the template starts with
897 accordingly."
906 "Coding system for the exported file."
913 "Non-nil means pushing export output to the kill ring.
914 This variable is ignored during asynchronous export."
924 "The initial scope when exporting with `org-export-dispatch'.
925 This variable can be either set to `buffer' or `subtree'."
932 "Non-nil means show buffer after exporting to temp buffer.
933 When Org exports to a file, the buffer visiting that file is never
934 shown, but remains buried. However, when exporting to
935 a temporary buffer, that buffer is popped up in a second window.
936 When this variable is nil, the buffer remains buried also in
937 these cases."
942 "Non-nil means export and publishing commands will run in background.
943 Results from an asynchronous export are never displayed
951 "File used to initialize external export process.
953 Value must be either nil or an absolute file name. When nil, the
954 external process is launched like a regular Emacs session,
955 loading user's initialization file and any site specific
956 configuration. If a file is provided, it, and only it, is loaded
957 at start-up.
959 Therefore, using a specific configuration makes the process to
960 load faster and the export more portable."
969 "Non-nil means using a non-intrusive `org-export-dispatch'.
970 In that case, no help buffer is displayed. Though, an indicator
976 asynchronous). Also, [?] allows switching back to standard
977 mode."
984 \f
985 ;;; Defining Back-ends
986 ;;
987 ;; An export back-end is a structure with `org-export-backend' type
988 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
989 ;; and `menu' slots.
990 ;;
991 ;; At the lowest level, a back-end is created with
992 ;; `org-export-create-backend' function.
993 ;;
994 ;; A named back-end can be registered with
995 ;; `org-export-register-backend' function. A registered back-end can
996 ;; later be referred to by its name, with `org-export-get-backend'
997 ;; function. Also, such a back-end can become the parent of a derived
998 ;; back-end from which slot values will be inherited by default.
999 ;; `org-export-derived-backend-p' can check if a given back-end is
1000 ;; derived from a list of back-end names.
1001 ;;
1002 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
1003 ;; `org-export-get-all-filters' return the full alist of transcoders,
1004 ;; options and filters, including those inherited from ancestors.
1005 ;;
1006 ;; At a higher level, `org-export-define-backend' is the standard way
1007 ;; to define an export back-end. If the new back-end is similar to
1008 ;; a registered back-end, `org-export-define-derived-backend' may be
1009 ;; used instead.
1010 ;;
1011 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
1012 ;; when a given back-end hasn't been registered yet.
1016 name parent transcoders options filters blocks menu)
1018 ;;;###autoload
1020 "Return export back-end named after NAME.
1021 NAME is a symbol. Return nil if no such back-end is found."
1023 org-export-registered-backends))
1026 "Register BACKEND as a known export back-end.
1027 BACKEND is a structure with `org-export-backend' type."
1028 ;; Refuse to register an unnamed back-end.
1031 ;; Refuse to register a back-end with an unknown parent.
1035 ;; If a back-end with the same name as BACKEND is already
1036 ;; registered, replace it with BACKEND. Otherwise, simply add
1037 ;; BACKEND to the list of registered back-ends.
1043 "Signal an error if BACKEND isn't defined."
1048 "Non-nil if BACKEND is derived from one of BACKENDS.
1049 BACKEND is an export back-end, as returned by, e.g.,
1050 `org-export-create-backend', or a symbol referring to
1051 a registered back-end. BACKENDS is constituted of symbols."
1063 "Return full translation table for BACKEND.
1065 BACKEND is an export back-end, as return by, e.g,,
1066 `org-export-create-backend'. Return value is an alist where
1067 keys are element or object types, as symbols, and values are
1068 transcoders.
1070 Unlike to `org-export-backend-transcoders', this function
1071 also returns transcoders inherited from parent back-ends,
1072 if any."
1076 parent)
1081 transcoders)))
1084 "Return export options for BACKEND.
1086 BACKEND is an export back-end, as return by, e.g,,
1087 `org-export-create-backend'. See `org-export-options-alist'
1088 for the shape of the return value.
1090 Unlike to `org-export-backend-options', this function also
1091 returns options inherited from parent back-ends, if any.
1093 Return nil if BACKEND is unknown."
1097 parent)
1101 options)))
1104 "Return complete list of filters for BACKEND.
1106 BACKEND is an export back-end, as return by, e.g,,
1107 `org-export-create-backend'. Return value is an alist where
1108 keys are symbols and values lists of functions.
1110 Unlike to `org-export-backend-filters', this function also
1111 returns filters inherited from parent back-ends, if any."
1115 parent)
1119 filters)))
1122 "Define a new back-end BACKEND.
1124 TRANSCODERS is an alist between object or element types and
1125 functions handling them.
1127 These functions should return a string without any trailing
1128 space, or nil. They must accept three arguments: the object or
1129 element itself, its contents or nil when it isn't recursive and
1130 the property list used as a communication channel.
1132 Contents, when not nil, are stripped from any global indentation
1133 \(although the relative one is preserved). They also always end
1134 with a single newline character.
1136 If, for a given type, no function is found, that element or
1137 object type will simply be ignored, along with any blank line or
1138 white space at its end. The same will happen if the function
1139 returns the nil value. If that function returns the empty
1140 string, the type will be ignored, but the blank lines or white
1141 spaces will be kept.
1143 In addition to element and object types, one function can be
1144 associated to the `template' (or `inner-template') symbol and
1145 another one to the `plain-text' symbol.
1147 The former returns the final transcoded string, and can be used
1148 to add a preamble and a postamble to document's body. It must
1149 accept two arguments: the transcoded string and the property list
1150 containing export options. A function associated to `template'
1152 A function associated to `inner-template' is always applied.
1154 The latter, when defined, is to be called on every text not
1155 recognized as an element or an object. It must accept two
1156 arguments: the text string and the information channel. It is an
1157 appropriate place to protect special chars relative to the
1158 back-end.
1160 BODY can start with pre-defined keyword arguments. The following
1161 keywords are understood:
1163 :filters-alist
1165 Alist between filters and function, or list of functions,
1166 specific to the back-end. See `org-export-filters-alist' for
1167 a list of all allowed filters. Filters defined here
1168 shouldn't make a back-end test, as it may prevent back-ends
1169 derived from this one to behave properly.
1171 :menu-entry
1173 Menu entry for the export dispatcher. It should be a list
1174 like:
1178 where :
1180 KEY is a free character selecting the back-end.
1182 DESCRIPTION-OR-ORDINAL is either a string or a number.
1184 If it is a string, is will be used to name the back-end in
1185 its menu entry. If it is a number, the following menu will
1186 be displayed as a sub-menu of the back-end with the same
1187 KEY. Also, the number will be used to determine in which
1188 order such sub-menus will appear (lowest first).
1190 ACTION-OR-MENU is either a function or an alist.
1192 If it is an action, it will be called with four
1193 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1194 BODY-ONLY. See `org-export-as' for further explanations on
1195 some of them.
1197 If it is an alist, associations should follow the
1198 pattern:
1202 where KEY, DESCRIPTION and ACTION are described above.
1204 Valid values include:
1208 or
1213 (lambda (a s v b)
1214 (if a (org-latex-export-to-pdf t s v b)
1215 (org-open-file
1216 (org-latex-export-to-pdf nil s v b)))))))
1218 or the following, which will be added to the previous
1219 sub-menu,
1225 :options-alist
1227 Alist between back-end specific properties introduced in
1228 communication channel and how their value are acquired. See
1229 `org-export-options-alist' for more information about
1230 structure of the values."
1242 :transcoders transcoders
1243 :options options
1244 :filters filters
1248 "Create a new back-end as a variant of an existing one.
1250 CHILD is the name of the derived back-end. PARENT is the name of
1251 the parent back-end.
1253 BODY can start with pre-defined keyword arguments. The following
1254 keywords are understood:
1256 :filters-alist
1258 Alist of filters that will overwrite or complete filters
1259 defined in PARENT back-end. See `org-export-filters-alist'
1260 for a list of allowed filters.
1262 :menu-entry
1264 Menu entry for the export dispatcher. See
1265 `org-export-define-backend' for more information about the
1266 expected value.
1268 :options-alist
1270 Alist of back-end specific properties that will overwrite or
1271 complete those defined in PARENT back-end. Refer to
1272 `org-export-options-alist' for more information about
1273 structure of the values.
1275 :translate-alist
1277 Alist of element and object types and transcoders that will
1278 overwrite or complete transcode table from PARENT back-end.
1279 Refer to `org-export-define-backend' for detailed information
1280 about transcoders.
1283 as a variant of `latex' back-end with a custom template function:
1288 The back-end could then be called with, for example:
1303 :parent parent
1304 :transcoders transcoders
1305 :options options
1306 :filters filters
1310 \f
1311 ;;; The Communication Channel
1312 ;;
1313 ;; During export process, every function has access to a number of
1314 ;; properties. They are of two types:
1315 ;;
1316 ;; 1. Environment options are collected once at the very beginning of
1317 ;; the process, out of the original buffer and configuration.
1318 ;; Collecting them is handled by `org-export-get-environment'
1319 ;; function.
1320 ;;
1321 ;; Most environment options are defined through the
1322 ;; `org-export-options-alist' variable.
1323 ;;
1324 ;; 2. Tree properties are extracted directly from the parsed tree,
1325 ;; just before export, by `org-export--collect-tree-properties'.
1327 ;;;; Environment Options
1328 ;;
1329 ;; Environment options encompass all parameters defined outside the
1330 ;; scope of the parsed data. They come from five sources, in
1331 ;; increasing precedence order:
1332 ;;
1333 ;; - Global variables,
1334 ;; - Buffer's attributes,
1335 ;; - Options keyword symbols,
1336 ;; - Buffer keywords,
1337 ;; - Subtree properties.
1338 ;;
1339 ;; The central internal function with regards to environment options
1340 ;; is `org-export-get-environment'. It updates global variables with
1341 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1342 ;; the different sources.
1343 ;;
1344 ;; The internal functions doing the retrieval are:
1345 ;; `org-export--get-global-options',
1346 ;; `org-export--get-buffer-attributes',
1347 ;; `org-export--parse-option-keyword',
1348 ;; `org-export--get-subtree-options' and
1349 ;; `org-export--get-inbuffer-options'
1350 ;;
1351 ;; Also, `org-export--list-bound-variables' collects bound variables
1352 ;; along with their value in order to set them as buffer local
1353 ;; variables later in the process.
1355 ;;;###autoload
1357 "Collect export options from the current buffer.
1359 Optional argument BACKEND is an export back-end, as returned by
1360 `org-export-create-backend'.
1362 When optional argument SUBTREEP is non-nil, assume the export is
1363 done against the current sub-tree.
1365 Third optional argument EXT-PLIST is a property list with
1366 external parameters overriding Org default settings, but still
1367 inferior to file-local settings."
1368 ;; First install #+BIND variables since these must be set before
1369 ;; global options are read.
1372 ;; Get and prioritize export options...
1374 ;; ... from global variables...
1376 ;; ... from an external property list...
1377 ext-plist
1378 ;; ... from in-buffer settings...
1380 ;; ... and from subtree, when appropriate.
1384 "Parse an OPTIONS line and return values as a plist.
1385 Optional argument BACKEND is an export back-end, as returned by,
1386 e.g., `org-export-create-backend'. It specifies which back-end
1387 specific items to read, if any."
1394 alist))
1395 alist))
1396 ;; Priority is given to back-end specific options.
1398 org-export-options-alist))
1408 "Get export options in subtree at point.
1409 Optional argument BACKEND is an export back-end, as returned by,
1410 e.g., `org-export-create-backend'. It specifies back-end used
1411 for export. Return options as a plist."
1412 ;; For each buffer keyword, create a headline property setting the
1413 ;; same property in communication channel. The name for the
1414 ;; property is the keyword with "EXPORT_" appended to it.
1416 ;; Make sure point is at a heading.
1419 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1420 ;; care of them right from the start.
1423 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1424 ;; headline's title (with no todo keyword, priority cookie or
1425 ;; tag) as its fallback value.
1432 ;; Look for both general keywords and back-end specific
1433 ;; options, with priority given to the latter.
1435 org-export-options-alist)))
1436 ;; Handle other keywords. Then return PLIST.
1450 property
1459 "Return current buffer export options, as a plist.
1461 Optional argument BACKEND, when non-nil, is an export back-end,
1462 as returned by, e.g., `org-export-create-backend'. It specifies
1463 which back-end specific options should also be read in the
1464 process.
1466 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1469 ;; Priority is given to back-end specific options.
1471 org-export-options-alist))
1474 org-export-special-keywords))))
1475 plist to-parse)
1478 ;; Return all properties associated to KEYWORD.
1485 ;; Recursively read keywords in buffer. FILES is
1486 ;; a list of files read so far. PLIST is the current
1487 ;; property list obtained.
1496 ;; Options in `org-export-special-keywords'.
1501 uri
1503 ;; Avoid circular dependencies.
1515 plist
1517 val backend))))
1521 plist
1528 ;; Options in `org-export-options-alist'.
1531 plist
1533 plist property
1534 ;; Handle value depending on specified
1535 ;; BEHAVIOR.
1540 ;; Even if `parse' implies `space'
1541 ;; behavior, we separate line with
1542 ;; "\n" so as to preserve
1543 ;; line-breaks. However, empty
1544 ;; lines are forbidden since `parse'
1545 ;; doesn't allow more than one
1546 ;; paragraph.
1555 " "
1568 ;; Read options in the current buffer and return value.
1570 ;; Parse properties in TO-PARSE. Remove newline characters not
1571 ;; involved in line breaks to simulate `space' behavior.
1572 ;; Finally return options.
1585 "Return properties related to export process, as a plist.
1586 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1587 are like the arguments with the same names of function
1588 `org-export-as'."
1593 :back-end backend
1598 "Return properties related to buffer attributes, as a plist."
1603 "Return global export options as a plist.
1604 Optional argument BACKEND, if non-nil, is an export back-end, as
1605 returned by, e.g., `org-export-create-backend'. It specifies
1606 which back-end specific export options should also be read in the
1607 process."
1609 ;; Priority is given to back-end specific options.
1611 org-export-options-alist)))
1617 plist
1618 prop
1619 ;; Evaluate default value provided.
1624 value)))))))))
1627 "Return variables bound from BIND keywords in current buffer.
1628 Also look for BIND keywords in setup files. The return value is
1629 an alist where associations are (VARIABLE-NAME VALUE)."
1633 ;; Return an alist between variable names and their
1634 ;; value. FILES is a list of setup files names read
1635 ;; so far, used to avoid circular dependencies. ALIST
1636 ;; is the alist collected so far.
1648 ;; Enter setup file.
1652 uri
1654 ;; Avoid circular dependencies.
1665 alist))))))))))
1666 alist)))))
1667 ;; Return value in appropriate order of appearance.
1670 ;; defsubst org-export-get-parent must be defined before first use,
1671 ;; was originally defined in the topology section
1674 "Return BLOB parent or nil.
1675 BLOB is the element or object considered."
1678 ;;;; Tree Properties
1679 ;;
1680 ;; Tree properties are information extracted from parse tree. They
1681 ;; are initialized at the beginning of the transcoding process by
1682 ;; `org-export--collect-tree-properties'.
1683 ;;
1684 ;; Dedicated functions focus on computing the value of specific tree
1685 ;; properties during initialization. Thus,
1686 ;; `org-export--populate-ignore-list' lists elements and objects that
1687 ;; should be skipped during export, `org-export--get-min-level' gets
1688 ;; the minimal exportable level, used as a basis to compute relative
1689 ;; level for headlines. Eventually
1690 ;; `org-export--collect-headline-numbering' builds an alist between
1691 ;; headlines and their numbering.
1694 "Extract tree properties from parse tree.
1696 DATA is the parse tree from which information is retrieved. INFO
1697 is a list holding export options.
1699 Following tree properties are set or updated:
1701 `:headline-offset' Offset between true level of headlines and
1702 local level. An offset of -1 means a headline
1703 of level 2 should be considered as a level
1704 1 headline in the context.
1706 `:headline-numbering' Alist of all headlines as key and the
1707 associated numbering as value.
1709 `:id-alist' Alist of all ID references as key and associated file
1710 as value.
1712 Return updated plist."
1713 ;; Install the parse tree in the communication channel.
1715 ;; Compute `:headline-offset' in order to be able to use
1716 ;; `org-export-get-relative-level'.
1719 :headline-offset
1721 ;; From now on, properties order doesn't matter: get the rest of the
1722 ;; tree properties.
1724 info
1726 :id-alist
1735 "Return minimum exportable headline's level in DATA.
1736 DATA is parsed tree as returned by `org-element-parse-buffer'.
1737 OPTIONS is a plist holding export options."
1746 ;; If no headline was found, for the sake of consistency, set
1747 ;; minimum level to 1 nonetheless.
1751 "Return numbering of all exportable, numbered headlines in a parse tree.
1753 DATA is the parse tree. OPTIONS is the plist holding export
1754 options.
1756 Return an alist whose key is a headline and value is its
1757 associated numbering \(in the shape of a list of numbers) or nil
1758 for a footnotes section."
1767 headline
1769 for n across numbering
1770 for idx from 0 to org-export-max-depth
1774 options)))
1777 "List headlines and inlinetasks with a select tag in their tree.
1778 DATA is parsed data as returned by `org-element-parse-buffer'.
1779 INFO is a plist holding export options."
1782 ;; If FILETAGS contains a select tag, every headline or
1783 ;; inlinetask is returned.
1793 ;; When a select tag is found, mark full
1794 ;; genealogy and every headline within the
1795 ;; tree as acceptable.
1798 genealogy
1801 selected-trees))
1802 ;; If at a headline, continue searching in
1803 ;; tree, recursively.
1812 selected-trees))))
1815 "Non-nil when element or object DATUM should be skipped during export.
1816 OPTIONS is the plist holding export options. SELECTED, when
1817 non-nil, is a list of headlines or inlinetasks belonging to
1818 a tree with a select tag."
1821 ;; Skip all comments and comment blocks. Make to keep maximum
1822 ;; number of blank lines around the comment so as to preserve
1823 ;; local structure of the document upon interpreting it back into
1824 ;; Org syntax.
1830 t)
1836 ;; If `:with-drawers' value starts with `not', ignore
1837 ;; every drawer whose name belong to that list.
1838 ;; Otherwise, ignore drawers whose name isn't in that
1839 ;; list.
1856 ;; Ignore subtrees with an exclude tag.
1859 ;; When a select tag is present in the buffer, ignore any tree
1860 ;; without it.
1862 ;; Ignore commented sub-trees.
1864 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1866 ;; Ignore tasks, if specified by `:with-tasks' property.
1878 properties-set))))))
1889 ;; `:with-timestamps' only applies to isolated timestamps
1890 ;; objects, i.e. timestamp objects in a paragraph containing only
1891 ;; timestamps and whitespaces.
1899 options t))))
1908 \f
1909 ;;; The Transcoder
1910 ;;
1911 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1912 ;; `org-element-parse-buffer') and transcodes it into a specified
1913 ;; back-end output. It takes care of filtering out elements or
1914 ;; objects according to export options and organizing the output blank
1915 ;; lines and white space are preserved. The function memoizes its
1916 ;; results, so it is cheap to call it within transcoders.
1917 ;;
1918 ;; It is possible to modify locally the back-end used by
1919 ;; `org-export-data' or even use a temporary back-end by using
1920 ;; `org-export-data-with-backend'.
1921 ;;
1922 ;; `org-export-transcoder' is an accessor returning appropriate
1923 ;; translator function for a given element or object.
1926 "Return appropriate transcoder for BLOB.
1927 INFO is a plist containing export directives."
1929 ;; Return contents only for complete parse trees.
1935 "Convert DATA into current back-end format.
1937 DATA is a parse tree, an element or an object or a secondary
1938 string. INFO is a plist holding export options.
1940 Return a string."
1942 ;; Handle broken links according to
1943 ;; `org-export-with-broken-links'.
1959 ;; Ignored element/object.
1961 ;; Plain text.
1967 info))
1968 ;; Secondary string.
1971 ;; Element/Object without contents or, as a special
1972 ;; case, headline with archive tag and archived trees
1973 ;; restricted to title only.
1982 ;; Export snippets never return a nil value so
1983 ;; that white spaces following them are never
1984 ;; ignored.
1986 ;; Element/Object with contents.
1999 ;; Elements directly containing
2000 ;; objects must have their indentation
2001 ;; normalized first.
2003 data
2004 ;; When normalizing contents of the
2005 ;; first paragraph in an item or
2006 ;; a footnote definition, ignore
2007 ;; first line's indentation: there is
2008 ;; none and it might be misleading.
2012 data)
2020 info)))))))))
2021 ;; Final result will be memoized before being returned.
2023 data
2027 ;; Append the same white space between elements or objects
2028 ;; as in the original buffer, and call appropriate filters.
2037 info)))
2041 "Convert DATA into BACKEND format.
2043 DATA is an element, an object, a secondary string or a string.
2044 BACKEND is a symbol. INFO is a plist used as a communication
2045 channel.
2047 Unlike to `org-export-with-backend', this function will
2048 recursively convert DATA using BACKEND translation table."
2050 ;; Set-up a new communication channel with translations defined in
2051 ;; BACKEND as the translate table and a new hash table for
2052 ;; memoization.
2055 info
2058 ;; Size of the hash table is reduced since this
2059 ;; function will probably be used on small trees.
2062 ;; Preserve `:internal-references', as those do not depend on
2063 ;; the back-end used; we need to make sure that any new
2064 ;; reference when the temporary back-end was active gets through
2065 ;; the default one.
2070 "Expand a parsed element or object to its original state.
2072 BLOB is either an element or an object. CONTENTS is its
2073 contents, as a string or nil.
2075 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2076 keywords before output."
2082 blob contents))))
2085 \f
2086 ;;; The Filter System
2087 ;;
2088 ;; Filters allow end-users to tweak easily the transcoded output.
2089 ;; They are the functional counterpart of hooks, as every filter in
2090 ;; a set is applied to the return value of the previous one.
2091 ;;
2092 ;; Every set is back-end agnostic. Although, a filter is always
2093 ;; called, in addition to the string it applies to, with the back-end
2094 ;; used as argument, so it's easy for the end-user to add back-end
2095 ;; specific filters in the set. The communication channel, as
2096 ;; a plist, is required as the third argument.
2097 ;;
2098 ;; From the developer side, filters sets can be installed in the
2099 ;; process with the help of `org-export-define-backend', which
2100 ;; internally stores filters as an alist. Each association has a key
2101 ;; among the following symbols and a function or a list of functions
2102 ;; as value.
2103 ;;
2104 ;; - `:filter-options' applies to the property list containing export
2105 ;; options. Unlike to other filters, functions in this list accept
2106 ;; two arguments instead of three: the property list containing
2107 ;; export options and the back-end. Users can set its value through
2108 ;; `org-export-filter-options-functions' variable.
2109 ;;
2110 ;; - `:filter-parse-tree' applies directly to the complete parsed
2111 ;; tree. Users can set it through
2112 ;; `org-export-filter-parse-tree-functions' variable.
2113 ;;
2114 ;; - `:filter-body' applies to the body of the output, before template
2115 ;; translator chimes in. Users can set it through
2116 ;; `org-export-filter-body-functions' variable.
2117 ;;
2118 ;; - `:filter-final-output' applies to the final transcoded string.
2119 ;; Users can set it with `org-export-filter-final-output-functions'
2120 ;; variable.
2121 ;;
2122 ;; - `:filter-plain-text' applies to any string not recognized as Org
2123 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2124 ;; configure it.
2125 ;;
2126 ;; - `:filter-TYPE' applies on the string returned after an element or
2127 ;; object of type TYPE has been transcoded. A user can modify
2128 ;; `org-export-filter-TYPE-functions' to install these filters.
2129 ;;
2130 ;; All filters sets are applied with
2131 ;; `org-export-filter-apply-functions' function. Filters in a set are
2132 ;; applied in a LIFO fashion. It allows developers to be sure that
2133 ;; their filters will be applied first.
2134 ;;
2135 ;; Filters properties are installed in communication channel with
2136 ;; `org-export-install-filters' function.
2137 ;;
2138 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2139 ;; `org-export-before-parsing-hook') are run at the beginning of the
2140 ;; export process and just before parsing to allow for heavy structure
2141 ;; modifications.
2144 ;;;; Hooks
2147 "Hook run at the beginning of the export process.
2149 This is run before include keywords and macros are expanded and
2150 Babel code blocks executed, on a copy of the original buffer
2151 being exported. Visibility and narrowing are preserved. Point
2152 is at the beginning of the buffer.
2154 Every function in this hook will be called with one argument: the
2158 "Hook run before parsing an export buffer.
2160 This is run after include keywords and macros have been expanded
2161 and Babel code blocks executed, on a copy of the original buffer
2162 being exported. Visibility and narrowing are preserved. Point
2163 is at the beginning of the buffer.
2165 Every function in this hook will be called with one argument: the
2169 ;;;; Special Filters
2172 "List of functions applied to the export options.
2173 Each filter is called with two arguments: the export options, as
2174 a plist, and the back-end, as a symbol. It must return
2178 "List of functions applied to the parsed tree.
2179 Each filter is called with three arguments: the parse tree, as
2180 returned by `org-element-parse-buffer', the back-end, as
2181 a symbol, and the communication channel, as a plist. It must
2185 "List of functions applied to plain text.
2186 Each filter is called with three arguments: a string which
2187 contains no Org syntax, the back-end, as a symbol, and the
2188 communication channel, as a plist. It must return a string or
2192 "List of functions applied to transcoded body.
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 the transcoded string.
2200 Each filter is called with three arguments: the full transcoded
2201 string, the back-end, as a symbol, and the communication channel,
2202 as a plist. It must return a string that will be used as the
2206 ;;;; Elements Filters
2209 "List of functions applied to a transcoded babel-call.
2210 Each filter is called with three arguments: the transcoded data,
2211 as a string, the back-end, as a symbol, and the communication
2215 "List of functions applied to a transcoded center block.
2216 Each filter is called with three arguments: the transcoded data,
2217 as a string, the back-end, as a symbol, and the communication
2221 "List of functions applied to a transcoded clock.
2222 Each filter is called with three arguments: the transcoded data,
2223 as a string, the back-end, as a symbol, and the communication
2227 "List of functions applied to a transcoded diary-sexp.
2228 Each filter is called with three arguments: the transcoded data,
2229 as a string, the back-end, as a symbol, and the communication
2233 "List of functions applied to a transcoded drawer.
2234 Each filter is called with three arguments: the transcoded data,
2235 as a string, the back-end, as a symbol, and the communication
2239 "List of functions applied to a transcoded dynamic-block.
2240 Each filter is called with three arguments: the transcoded data,
2241 as a string, the back-end, as a symbol, and the communication
2245 "List of functions applied to a transcoded example-block.
2246 Each filter is called with three arguments: the transcoded data,
2247 as a string, the back-end, as a symbol, and the communication
2251 "List of functions applied to a transcoded export-block.
2252 Each filter is called with three arguments: the transcoded data,
2253 as a string, the back-end, as a symbol, and the communication
2257 "List of functions applied to a transcoded fixed-width.
2258 Each filter is called with three arguments: the transcoded data,
2259 as a string, the back-end, as a symbol, and the communication
2263 "List of functions applied to a transcoded footnote-definition.
2264 Each filter is called with three arguments: the transcoded data,
2265 as a string, the back-end, as a symbol, and the communication
2269 "List of functions applied to a transcoded headline.
2270 Each filter is called with three arguments: the transcoded data,
2271 as a string, the back-end, as a symbol, and the communication
2275 "List of functions applied to a transcoded horizontal-rule.
2276 Each filter is called with three arguments: the transcoded data,
2277 as a string, the back-end, as a symbol, and the communication
2281 "List of functions applied to a transcoded inlinetask.
2282 Each filter is called with three arguments: the transcoded data,
2283 as a string, the back-end, as a symbol, and the communication
2287 "List of functions applied to a transcoded item.
2288 Each filter is called with three arguments: the transcoded data,
2289 as a string, the back-end, as a symbol, and the communication
2293 "List of functions applied to a transcoded keyword.
2294 Each filter is called with three arguments: the transcoded data,
2295 as a string, the back-end, as a symbol, and the communication
2299 "List of functions applied to a transcoded latex-environment.
2300 Each filter is called with three arguments: the transcoded data,
2301 as a string, the back-end, as a symbol, and the communication
2305 "List of functions applied to a transcoded node-property.
2306 Each filter is called with three arguments: the transcoded data,
2307 as a string, the back-end, as a symbol, and the communication
2311 "List of functions applied to a transcoded paragraph.
2312 Each filter is called with three arguments: the transcoded data,
2313 as a string, the back-end, as a symbol, and the communication
2317 "List of functions applied to a transcoded plain-list.
2318 Each filter is called with three arguments: the transcoded data,
2319 as a string, the back-end, as a symbol, and the communication
2323 "List of functions applied to a transcoded planning.
2324 Each filter is called with three arguments: the transcoded data,
2325 as a string, the back-end, as a symbol, and the communication
2329 "List of functions applied to a transcoded property-drawer.
2330 Each filter is called with three arguments: the transcoded data,
2331 as a string, the back-end, as a symbol, and the communication
2335 "List of functions applied to a transcoded quote block.
2336 Each filter is called with three arguments: the transcoded quote
2337 data, as a string, the back-end, as a symbol, and the
2338 communication channel, as a plist. It must return a string or
2342 "List of functions applied to a transcoded section.
2343 Each filter is called with three arguments: the transcoded data,
2344 as a string, the back-end, as a symbol, and the communication
2348 "List of functions applied to a transcoded special block.
2349 Each filter is called with three arguments: the transcoded data,
2350 as a string, the back-end, as a symbol, and the communication
2354 "List of functions applied to a transcoded src-block.
2355 Each filter is called with three arguments: the transcoded data,
2356 as a string, the back-end, as a symbol, and the communication
2360 "List of functions applied to a transcoded table.
2361 Each filter is called with three arguments: the transcoded data,
2362 as a string, the back-end, as a symbol, and the communication
2366 "List of functions applied to a transcoded table-cell.
2367 Each filter is called with three arguments: the transcoded data,
2368 as a string, the back-end, as a symbol, and the communication
2372 "List of functions applied to a transcoded table-row.
2373 Each filter is called with three arguments: the transcoded data,
2374 as a string, the back-end, as a symbol, and the communication
2378 "List of functions applied to a transcoded verse block.
2379 Each filter is called with three arguments: the transcoded data,
2380 as a string, the back-end, as a symbol, and the communication
2384 ;;;; Objects Filters
2387 "List of functions applied to transcoded bold text.
2388 Each filter is called with three arguments: the transcoded data,
2389 as a string, the back-end, as a symbol, and the communication
2393 "List of functions applied to transcoded code text.
2394 Each filter is called with three arguments: the transcoded data,
2395 as a string, the back-end, as a symbol, and the communication
2399 "List of functions applied to a transcoded entity.
2400 Each filter is called with three arguments: the transcoded data,
2401 as a string, the back-end, as a symbol, and the communication
2405 "List of functions applied to a transcoded export-snippet.
2406 Each filter is called with three arguments: the transcoded data,
2407 as a string, the back-end, as a symbol, and the communication
2411 "List of functions applied to a transcoded footnote-reference.
2412 Each filter is called with three arguments: the transcoded data,
2413 as a string, the back-end, as a symbol, and the communication
2417 "List of functions applied to a transcoded inline-babel-call.
2418 Each filter is called with three arguments: the transcoded data,
2419 as a string, the back-end, as a symbol, and the communication
2423 "List of functions applied to a transcoded inline-src-block.
2424 Each filter is called with three arguments: the transcoded data,
2425 as a string, the back-end, as a symbol, and the communication
2429 "List of functions applied to transcoded italic text.
2430 Each filter is called with three arguments: the transcoded data,
2431 as a string, the back-end, as a symbol, and the communication
2435 "List of functions applied to a transcoded latex-fragment.
2436 Each filter is called with three arguments: the transcoded data,
2437 as a string, the back-end, as a symbol, and the communication
2441 "List of functions applied to a transcoded line-break.
2442 Each filter is called with three arguments: the transcoded data,
2443 as a string, the back-end, as a symbol, and the communication
2447 "List of functions applied to a transcoded link.
2448 Each filter is called with three arguments: the transcoded data,
2449 as a string, the back-end, as a symbol, and the communication
2453 "List of functions applied to a transcoded radio-target.
2454 Each filter is called with three arguments: the transcoded data,
2455 as a string, the back-end, as a symbol, and the communication
2459 "List of functions applied to a transcoded statistics-cookie.
2460 Each filter is called with three arguments: the transcoded data,
2461 as a string, the back-end, as a symbol, and the communication
2465 "List of functions applied to transcoded strike-through text.
2466 Each filter is called with three arguments: the transcoded data,
2467 as a string, the back-end, as a symbol, and the communication
2471 "List of functions applied to a transcoded subscript.
2472 Each filter is called with three arguments: the transcoded data,
2473 as a string, the back-end, as a symbol, and the communication
2477 "List of functions applied to a transcoded superscript.
2478 Each filter is called with three arguments: the transcoded data,
2479 as a string, the back-end, as a symbol, and the communication
2483 "List of functions applied to a transcoded target.
2484 Each filter is called with three arguments: the transcoded data,
2485 as a string, the back-end, as a symbol, and the communication
2489 "List of functions applied to a transcoded timestamp.
2490 Each filter is called with three arguments: the transcoded data,
2491 as a string, the back-end, as a symbol, and the communication
2495 "List of functions applied to transcoded underline text.
2496 Each filter is called with three arguments: the transcoded data,
2497 as a string, the back-end, as a symbol, and the communication
2501 "List of functions applied to transcoded verbatim text.
2502 Each filter is called with three arguments: the transcoded data,
2503 as a string, the back-end, as a symbol, and the communication
2507 ;;;; Filters Tools
2508 ;;
2509 ;; Internal function `org-export-install-filters' installs filters
2510 ;; hard-coded in back-ends (developer filters) and filters from global
2511 ;; variables (user filters) in the communication channel.
2512 ;;
2513 ;; Internal function `org-export-filter-apply-functions' takes care
2514 ;; about applying each filter in order to a given data. It ignores
2515 ;; filters returning a nil value but stops whenever a filter returns
2516 ;; an empty string.
2519 "Call every function in FILTERS.
2521 Functions are called with three arguments: a value, the export
2522 back-end name and the communication channel. First function in
2523 FILTERS is called with VALUE as its first argument. Second
2524 function in FILTERS is called with the previous result as its
2525 value, etc.
2527 Functions returning nil are skipped. Any function returning the
2528 empty string ends the process, which returns the empty string.
2530 Call is done in a LIFO fashion, to be sure that developer
2531 specified filters, if any, are called first."
2542 "Install filters properties in communication channel.
2543 INFO is a plist containing the current communication channel.
2544 Return the updated communication channel."
2546 ;; Install user-defined filters with `org-export-filters-alist'
2547 ;; and filters already in INFO (through ext-plist mechanism).
2554 ;; Filters in INFO will be called
2555 ;; before those user provided.
2558 default-value)))))
2559 ;; Prepend back-end specific filters to that list.
2561 ;; Single values get consed, lists are appended.
2566 plist key
2569 ;; Return new communication channel.
2573 \f
2574 ;;; Core functions
2575 ;;
2576 ;; This is the room for the main function, `org-export-as', along with
2577 ;; its derivative, `org-export-string-as'.
2578 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2579 ;; function should be added to kill ring.
2580 ;;
2581 ;; Note that `org-export-as' doesn't really parse the current buffer,
2582 ;; but a copy of it (with the same buffer-local variables and
2583 ;; visibility), where macros and include keywords are expanded and
2584 ;; Babel blocks are executed, if appropriate.
2585 ;; `org-export-with-buffer-copy' macro prepares that copy.
2586 ;;
2587 ;; File inclusion is taken care of by
2588 ;; `org-export-expand-include-keyword' and
2589 ;; `org-export--prepare-file-contents'. Structure wise, including
2590 ;; a whole Org file in a buffer often makes little sense. For
2591 ;; example, if the file contains a headline and the include keyword
2592 ;; was within an item, the item should contain the headline. That's
2593 ;; why file inclusion should be done before any structure can be
2594 ;; associated to the file, that is before parsing.
2595 ;;
2596 ;; `org-export-insert-default-template' is a command to insert
2597 ;; a default template (or a back-end specific template) at point or in
2598 ;; current subtree.
2601 "Return a copy of the current buffer.
2602 The copy preserves Org buffer-local variables, visibility and
2603 narrowing."
2609 new-buf))
2612 "Apply BODY in a copy of the current buffer.
2613 The copy preserves local variables, visibility and contents of
2614 the original buffer. Point is at the beginning of the buffer
2615 when BODY is applied."
2624 ;; Kill copy without confirmation.
2630 "Generate a function duplicating BUFFER.
2632 The copy will preserve local variables, visibility, contents and
2633 narrowing of the original buffer. If a region was active in
2634 BUFFER, contents will be narrowed to that region instead.
2636 The resulting function can be evaluated at a later time, from
2637 another buffer, effectively cloning the original buffer there.
2639 The function assumes BUFFER's major mode is `org-mode'."
2643 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2644 ;; already in BUFFER.
2646 ;; Copy specific buffer local variables and variables set
2647 ;; through BIND keywords.
2649 vars)
2657 buffer-file-name
2658 buffer-file-coding-system))
2662 ;; Skip unreadable values, as they cannot be
2663 ;; sent to external process.
2667 vars))))))
2668 ;; Whole buffer contents.
2673 ;; Narrowing.
2677 ;; Current position of point.
2679 ;; Overlays with invisible property.
2688 ov-set)))))))))
2691 "Delete commented trees and commented inlinetasks in the buffer.
2692 Narrowing, if any, is ignored."
2704 "Prune non exportable elements from DATA.
2705 DATA is the parse tree to traverse. INFO is the plist holding
2706 export info. Also set `:ignore-list' in INFO to a list of
2707 objects which should be ignored during export, but not removed
2708 from tree."
2710 ;; First find trees containing a select tag, if any.
2714 ;; Prune non-exportable elements and objects from tree.
2715 ;; As a special case, special rows and cells from tables
2716 ;; are stored in IGNORE, as they still need to be
2717 ;; accessed during export.
2727 ;; If headline is archived but tree below has
2728 ;; to be skipped, remove contents.
2730 ;; Move into recursive objects/elements.
2732 ;; Move into secondary string, if any.
2734 org-element-secondary-value-alist)))
2737 ;; Collect definitions before possibly pruning them so as
2738 ;; to avoid parsing them again if they are required.
2745 f)
2747 ;; If a select tag is active, also ignore the section before the
2748 ;; first headline, if any.
2753 ;; Prune tree and communication channel.
2756 ;; Priority is given to back-end specific options.
2758 org-export-options-alist))
2764 ;; Eventually set `:ignore-list'.
2768 "List footnote definitions missing from TREE.
2769 Missing definitions are searched within DEFINITIONS, which is
2770 a list of footnote definitions or in the widened buffer."
2773 ;; List all footnote labels encountered in DATA. Inline
2774 ;; footnote references are ignored.
2779 defined undefined missing-definitions)
2780 ;; Partition DIRECT-REFERENCES between DEFINED and UNDEFINED
2781 ;; references.
2788 seen)
2793 ;; Complete MISSING-DEFINITIONS by finding the definition of every
2794 ;; undefined label, first by looking into DEFINITIONS, then by
2795 ;; searching the widened buffer. This is a recursive process
2796 ;; since definitions found can themselves contain an undefined
2797 ;; reference.
2804 d))
2805 definitions))
2812 datum
2813 ;; Parse definition with contents.
2824 ;; Look for footnote references within DEFINITION, since
2825 ;; we may need to also find their definition.
2830 ;; MISSING-DEFINITIONS may contain footnote references with inline
2831 ;; definitions. Make sure those are changed into real footnote
2832 ;; definitions.
2839 missing-definitions)))
2842 "Install footnote definitions in tree.
2844 DEFINITIONS is the list of footnote definitions to install. TREE
2845 is the parse tree.
2847 If there is a footnote section in TREE, definitions found are
2848 appended to it. If `org-footnote-section' is non-nil, a new
2849 footnote section containing all definitions is inserted in TREE.
2850 Otherwise, definitions are appended at the end of the section
2851 containing their first reference."
2854 ;; If there is a footnote section, insert definitions there.
2858 nil t)))
2861 footnote-section
2863 ;; If there should be a footnote section, create one containing all
2864 ;; the definitions at the end of the tree.
2867 tree
2871 :title org-footnote-section
2874 'section
2875 nil
2877 ;; Otherwise add each definition at the end of the section where it
2878 ;; is first referenced.
2883 ;; Insert footnote definitions in the same section as
2884 ;; their first reference in DATA.
2895 label)
2896 d))
2897 definitions)))
2900 definition)
2901 ;; Also insert definitions for nested
2902 ;; references, if any.
2907 "Change uninterpreted elements back into Org syntax.
2908 DATA is a parse tree or a secondary string. INFO is a plist
2909 containing export options. It is modified by side effect and
2910 returned by the function."
2913 subscript superscript underline)
2917 ;; ... entities...
2924 ?\s)))))
2925 ;; ... emphasis...
2937 marker
2941 ?\s)))))))
2942 ;; ... LaTeX environments and fragments...
2946 ;; ... sub/superscripts...
2955 "_"
2964 ?\s)))))))))))
2966 ;; Splice NEW at DATUM location in parse tree.
2969 info nil nil t)
2970 ;; Return modified parse tree.
2971 data)
2973 ;;;###autoload
2976 "Transcode current Org buffer into BACKEND code.
2978 BACKEND is either an export back-end, as returned by, e.g.,
2979 `org-export-create-backend', or a symbol referring to
2980 a registered back-end.
2982 If narrowing is active in the current buffer, only transcode its
2983 narrowed part.
2985 If a region is active, transcode that region.
2987 When optional argument SUBTREEP is non-nil, transcode the
2988 sub-tree at point, extracting information from the headline
2989 properties first.
2991 When optional argument VISIBLE-ONLY is non-nil, don't export
2992 contents of hidden elements.
2994 When optional argument BODY-ONLY is non-nil, only return body
2995 code, without surrounding template.
2997 Optional argument EXT-PLIST, when provided, is a property list
2998 with external parameters overriding Org default settings, but
2999 still inferior to file-local settings.
3001 Return code as a string."
3006 ;; Narrow buffer to an appropriate region or subtree for
3007 ;; parsing. If parsing subtree, be sure to remove main
3008 ;; headline, planning data and property drawer.
3016 ;; Initialize communication channel with original buffer
3017 ;; attributes, unavailable in its copy.
3021 backend subtreep visible-only body-only)
3027 org-export-options-alist))))
3028 tree)
3029 ;; Update communication channel and get parse tree. Buffer
3030 ;; isn't parsed directly. Instead, all buffer modifications
3031 ;; and consequent parsing are undertaken in a temporary copy.
3033 ;; Run first hook with current back-end's name as argument.
3036 ;; Include files, delete comments and expand macros.
3042 nil parsed-keywords)
3043 ;; Refresh buffer properties and radio targets after
3044 ;; potentially invasive previous changes. Likewise, do it
3045 ;; again after executing Babel code.
3052 ;; Run last hook with current back-end's name as argument.
3053 ;; Update buffer properties and radio targets one last time
3054 ;; before parsing.
3061 ;; Update communication channel with environment.
3065 ;; De-activate uninterpreted data from parsed keywords.
3067 org-export-options-alist))
3072 p
3075 ;; Install user's and developer's filters.
3077 ;; Call options filters and update export options. We do not
3078 ;; use `org-export-filter-apply-functions' here since the
3079 ;; arity of such filters is different.
3084 ;; Expand export-specific set of macros: {{{author}}},
3085 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
3086 ;; be done once regular macros have been expanded, since
3087 ;; parsed keywords may contain one of them.
3100 value)
3101 value)))
3105 'finalize
3106 parsed-keywords)
3107 ;; Parse buffer.
3109 ;; Prune tree from non-exported elements and transform
3110 ;; uninterpreted elements or objects in both parse tree and
3111 ;; communication channel.
3114 ;; Call parse tree filters.
3118 ;; Now tree is complete, compute its properties and add them
3119 ;; to communication channel.
3121 ;; Eventually transcode TREE. Wrap the resulting string into
3122 ;; a template.
3131 info))
3134 ;; Remove all text properties since they cannot be
3135 ;; retrieved from an external process. Finally call
3136 ;; final-output filter and return result.
3142 info))))))))
3144 ;;;###autoload
3146 "Transcode STRING into BACKEND code.
3148 BACKEND is either an export back-end, as returned by, e.g.,
3149 `org-export-create-backend', or a symbol referring to
3150 a registered back-end.
3152 When optional argument BODY-ONLY is non-nil, only return body
3153 code, without preamble nor postamble.
3155 Optional argument EXT-PLIST, when provided, is a property list
3156 with external parameters overriding Org default settings, but
3157 still inferior to file-local settings.
3159 Return code as a string."
3165 ;;;###autoload
3167 "Replace the active region by its export to BACKEND.
3168 BACKEND is either an export back-end, as returned by, e.g.,
3169 `org-export-create-backend', or a symbol referring to
3170 a registered back-end."
3176 ;;;###autoload
3178 "Insert all export keywords with default values at beginning of line.
3180 BACKEND is a symbol referring to the name of a registered export
3181 back-end, for which specific export options should be added to
3182 the template, or `default' for default template. When it is nil,
3183 the user will be prompted for a category.
3185 If SUBTREEP is non-nil, export configuration will be set up
3186 locally for the subtree through node properties."
3196 "Options category: "
3200 org-export-registered-backends))
3201 nil t))))
3202 options keywords)
3203 ;; Populate OPTIONS and KEYWORDS.
3220 ;; Move to an appropriate location in order to insert options.
3222 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3240 ;; Then the rest of keywords, in the order specified in either
3241 ;; `org-export-options-alist' or respective export back-ends.
3262 "Expand every include keyword in buffer.
3263 Optional argument INCLUDED is a list of included file names along
3264 with their line restriction, when appropriate. It is used to
3265 avoid infinite recursion. Optional argument DIR is the current
3266 working directory. It is used to properly resolve relative
3267 paths. Optional argument FOOTNOTES is a hash-table used for
3268 storing and resolving footnotes. It is created automatically."
3274 ;; If :minlevel is not set the text-property
3275 ;; `:org-include-induced-level' will be used to determine the
3276 ;; relative level when expanding INCLUDE.
3277 ;; Only affects included Org documents.
3281 :org-include-induced-level
3283 ;; Expand INCLUDE keywords.
3290 ;; Extract arguments from keyword's value.
3293 location
3301 matched)
3307 dir)))
3311 value)
3317 value)
3326 ;; Minimal level of included file defaults to the
3327 ;; child level of the current headline, if any, or
3328 ;; one. It only applies is the file is meant to be
3329 ;; included as an Org one.
3340 ;; Remove keyword.
3346 ;; Check if files has already been parsed. Look after
3347 ;; inclusion lines too, as different parts of the same
3348 ;; file can be included too.
3361 ind-str block arg-str contents ind-str block))))
3368 ind-str block contents ind-str block))))
3376 file location only-contents lines)
3377 lines)))
3381 file lines ind minlevel
3385 footnotes)))
3389 footnotes)
3391 ;; Expand footnotes after all files have been
3392 ;; included. Footnotes are stored at end of buffer.
3398 footnotes))))))))))))
3401 "Resolve absolute lines for an included file with file-link.
3403 FILE is string file-name of the file to include. LOCATION is a
3404 string name within FILE to be included (located via
3405 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3406 contents of the named element will be included, as determined
3407 Org-Element. If LINES is non-nil only those lines are included.
3409 Return a string of lines to be included in the format expected by
3410 `org-export--prepare-file-contents'."
3416 ;; Enforce consistent search.
3429 ;; Skip planning line and property-drawer.
3455 start-line
3457 (+ start-line
3460 counter))))))))
3464 "Prepare contents of FILE for inclusion and return it as a string.
3466 When optional argument LINES is a string specifying a range of
3467 lines, include only those lines.
3469 Optional argument IND, when non-nil, is an integer specifying the
3470 global indentation of returned contents. Since its purpose is to
3471 allow an included file to stay in the same environment it was
3472 created (e.g., a list item), it doesn't apply past the first
3473 headline encountered.
3475 Optional argument MINLEVEL, when non-nil, is an integer
3476 specifying the level that any top-level headline in the included
3477 file should have.
3479 Optional argument ID is an integer that will be inserted before
3480 each footnote definition and reference if FILE is an Org file.
3481 This is useful to avoid conflicts when more than one Org file
3482 with footnotes is included in a document.
3484 Optional argument FOOTNOTES is a hash-table to store footnotes in
3485 the included document."
3501 ;; Remove blank lines at beginning and end of contents. The logic
3502 ;; behind that removal is that blank lines around include keyword
3503 ;; override blank lines in included file.
3512 ;; If IND is set, preserve indentation of include keyword until
3513 ;; the first headline encountered.
3520 ;; Do not move footnote definitions out of column 0.
3526 ;; When MINLEVEL is specified, compute minimal level for headlines
3527 ;; in the file (CUR-MIN), and remove stars to each headline so
3528 ;; that headlines with minimal level have a level of MINLEVEL.
3539 ;; Only change stars, don't bother moving whole
3540 ;; sections.
3545 ;; Append ID to all footnote references and definitions, so they
3546 ;; become file specific and cannot collide with footnotes in other
3547 ;; included files. Further, collect relevant footnote definitions
3548 ;; outside of LINES, in order to reintroduce them later.
3554 ;; Generate new label from LABEL by prefixing it with
3555 ;; "-ID-".
3559 ;; Replace OLD label with NEW in footnote F.
3573 ;; Update the footnote-reference at point and collect
3574 ;; the new label, which is only used for footnotes
3575 ;; outsides LINES.
3587 ;; Store since footnote-definition is
3588 ;; outside of LINES.
3591 footnotes))))
3598 "Return a non-nil value when output should be added to the kill ring.
3599 See also `org-export-copy-to-kill-ring'."
3605 \f
3606 ;;; Tools For Back-Ends
3607 ;;
3608 ;; A whole set of tools is available to help build new exporters. Any
3609 ;; function general enough to have its use across many back-ends
3610 ;; should be added here.
3612 ;;;; For Affiliated Keywords
3613 ;;
3614 ;; `org-export-read-attribute' reads a property from a given element
3615 ;; as a plist. It can be used to normalize affiliated keywords'
3616 ;; syntax.
3617 ;;
3618 ;; Since captions can span over multiple lines and accept dual values,
3619 ;; their internal representation is a bit tricky. Therefore,
3620 ;; `org-export-get-caption' transparently returns a given element's
3621 ;; caption as a secondary string.
3624 "Turn ATTRIBUTE property from ELEMENT into a plist.
3626 When optional argument PROPERTY is non-nil, return the value of
3627 that property within attributes.
3631 properties.
3633 All values will become strings except the empty string and
3636 will become the empty string."
3650 s)
3655 ;; Ignore any string before first property with `cdr'.
3660 "Return caption from ELEMENT as a secondary string.
3662 When optional argument SHORTP is non-nil, return short caption,
3663 as a secondary string, instead.
3665 Caption lines are separated by a white space."
3673 ;;;; For Derived Back-ends
3674 ;;
3675 ;; `org-export-with-backend' is a function allowing to locally use
3676 ;; another back-end to transcode some object or element. In a derived
3677 ;; back-end, it may be used as a fall-back function once all specific
3678 ;; cases have been treated.
3681 "Call a transcoder from BACKEND on DATA.
3682 BACKEND is an export back-end, as returned by, e.g.,
3683 `org-export-create-backend', or a symbol referring to
3684 a registered back-end. DATA is an Org element, object, secondary
3685 string or string. CONTENTS, when non-nil, is the transcoded
3686 contents of DATA element, as a string. INFO, when non-nil, is
3687 the communication channel used for export, as a plist."
3698 :back-end backend
3699 :translate-alist all-transcoders
3701 ;; `:internal-references' are shared across back-ends.
3707 ;;;; For Export Snippets
3708 ;;
3709 ;; Every export snippet is transmitted to the back-end. Though, the
3710 ;; latter will only retain one type of export-snippet, ignoring
3711 ;; others, based on the former's target back-end. The function
3712 ;; `org-export-snippet-backend' returns that back-end for a given
3713 ;; export-snippet.
3716 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3717 Translation, with `org-export-snippet-translation-alist', is
3718 applied."
3722 back-end))))
3725 ;;;; For Footnotes
3726 ;;
3727 ;; `org-export-collect-footnote-definitions' is a tool to list
3728 ;; actually used footnotes definitions in the whole parse tree, or in
3729 ;; a headline, in order to add footnote listings throughout the
3730 ;; transcoded data.
3731 ;;
3732 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3733 ;; back-ends, when they need to attach the footnote definition only to
3734 ;; the first occurrence of the corresponding label.
3735 ;;
3736 ;; `org-export-get-footnote-definition' and
3737 ;; `org-export-get-footnote-number' provide easier access to
3738 ;; additional information relative to a footnote reference.
3741 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3742 INFO is the plist used as a communication channel. If no such
3743 definition can be found, raise an error."
3749 hash))))
3757 ;; Skip any footnote with a different label.
3758 ;; Also skip any standard footnote reference
3759 ;; with the same label since those cannot
3760 ;; contain a definition.
3764 ;; Even if the contents are empty, we can not
3765 ;; return nil since that would eventually raise
3766 ;; the error. Instead, return the equivalent
3767 ;; empty string.
3769 info t)
3770 cache)
3775 "Apply FUNCTION on every footnote reference in DATA.
3776 INFO is a plist containing export state. By default, as soon as
3777 a new footnote reference is encountered, FUNCTION is called onto
3778 its definition. However, if BODY-FIRST is non-nil, this step is
3779 delayed until the end of the process."
3784 ;; Search footnote references through DATA, filling
3785 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3786 ;; store footnote definitions so they can be entered
3787 ;; later.
3794 ;; Search for subsequent references in footnote
3795 ;; definition so numbering follows reading
3796 ;; logic, unless DELAYP in non-nil.
3800 definitions))
3801 ;; Do not force entering inline definitions,
3802 ;; since `org-element-map' already traverses
3803 ;; them at the right time.
3807 nil))))))
3808 info nil
3809 ;; Don't enter footnote definitions since it will
3810 ;; happen when their first reference is found.
3811 ;; Moreover, if DELAYP is non-nil, make sure we
3812 ;; postpone entering definitions of inline references.
3819 "Return an alist between footnote numbers, labels and definitions.
3821 INFO is the current export state, as a plist.
3823 Definitions are collected throughout the whole parse tree, or
3824 DATA when non-nil.
3826 Sorting is done by order of references. As soon as a new
3827 reference is encountered, other references are searched within
3828 its definition. However, if BODY-FIRST is non-nil, this step is
3829 delayed after the whole tree is checked. This alters results
3830 when references are found in footnote definitions.
3832 Definitions either appear as Org data or as a secondary string
3833 for inlined footnotes. Unreferenced definitions are ignored."
3837 ;; Collect footnote number, label and definition.
3848 "Non-nil when a footnote reference is the first one for its label.
3850 FOOTNOTE-REFERENCE is the footnote reference being considered.
3851 INFO is a plist containing current export state.
3853 Search is done throughout the whole parse tree, or DATA when
3854 non-nil.
3856 By default, as soon as a new footnote reference is encountered,
3857 other references are searched within its definition. However, if
3858 BODY-FIRST is non-nil, this step is delayed after the whole tree
3859 is checked. This alters results when references are found in
3860 footnote definitions."
3862 ;; Anonymous footnotes are always a first reference.
3873 "Return number associated to a footnote.
3875 FOOTNOTE is either a footnote reference or a footnote definition.
3876 INFO is the plist containing export state.
3878 Number is unique throughout the whole parse tree, or DATA, when
3879 non-nil.
3881 By default, as soon as a new footnote reference is encountered,
3882 counting process moves into its definition. However, if
3883 BODY-FIRST is non-nil, this step is delayed until the end of the
3884 process, leading to a different order when footnotes are nested."
3893 ;; Anonymous footnote match: return number.
3895 ;; Labels match: return number.
3897 ;; Otherwise store label and increase counter if label
3898 ;; wasn't encountered yet.
3904 ;;;; For Headlines
3905 ;;
3906 ;; `org-export-get-relative-level' is a shortcut to get headline
3907 ;; level, relatively to the lower headline level in the parsed tree.
3908 ;;
3909 ;; `org-export-get-headline-number' returns the section number of an
3910 ;; headline, while `org-export-number-to-roman' allows it to be
3911 ;; converted to roman numbers. With an optional argument,
3912 ;; `org-export-get-headline-number' returns a number to unnumbered
3913 ;; headlines (used for internal id).
3914 ;;
3915 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3916 ;; `org-export-last-sibling-p' are three useful predicates when it
3917 ;; comes to fulfill the `:headline-levels' property.
3918 ;;
3919 ;; `org-export-get-tags', `org-export-get-category' and
3920 ;; `org-export-get-node-property' extract useful information from an
3921 ;; headline or a parent headline. They all handle inheritance.
3922 ;;
3923 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3924 ;; as a secondary string, suitable for table of contents. It falls
3925 ;; back onto default title.
3928 "Return HEADLINE relative level within current parsed tree.
3929 INFO is a plist holding contextual information."
3934 "Non-nil when HEADLINE is considered as low level.
3936 INFO is a plist used as a communication channel.
3938 A low level headlines has a relative level greater than
3939 `:headline-levels' property value.
3941 Return value is the difference between HEADLINE relative level
3942 and the last level being considered as high enough, or nil."
3949 "Return numbered HEADLINE numbering as a list of numbers.
3950 INFO is a plist holding contextual information."
3955 "Return a non-nil value if HEADLINE element should be numbered.
3956 INFO is a plist used as a communication channel."
3965 "Convert integer N into a roman numeral."
3978 res)))
3981 "Return list of tags associated to ELEMENT.
3983 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3984 is a plist used as a communication channel.
3986 When non-nil, optional argument TAGS should be a list of strings.
3987 Any tag belonging to this list will also be removed.
3989 When optional argument INHERITED is non-nil, tags can also be
3990 inherited from parent headlines and FILETAGS keywords."
3994 ;; Build complete list of inherited tags.
4001 ;; Add FILETAGS keywords and return results.
4005 "Return node PROPERTY value for BLOB.
4007 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
4008 element or object.
4010 If optional argument INHERITED is non-nil, the value can be
4011 inherited from a parent headline.
4013 Return value is a string or nil."
4025 "Return category for element or object BLOB.
4027 INFO is a plist used as a communication channel.
4029 CATEGORY is automatically inherited from a parent headline, from
4030 #+CATEGORY: keyword or created out of original file name. If all
4043 "Return alternative title for HEADLINE, as a secondary string.
4044 If no optional title is defined, fall-back to the regular title."
4051 "Non-nil when BLOB is the first sibling in its parent.
4052 BLOB is an element or an object. If BLOB is a headline, non-nil
4053 means it is the first sibling in the sub-tree. INFO is a plist
4054 used as a communication channel."
4059 "Non-nil when BLOB is the last sibling in its parent.
4060 BLOB is an element or an object. INFO is a plist used as
4061 a communication channel."
4065 ;;;; For Keywords
4066 ;;
4067 ;; `org-export-get-date' returns a date appropriate for the document
4068 ;; to about to be exported. In particular, it takes care of
4069 ;; `org-export-date-timestamp-format'.
4072 "Return date value for the current document.
4074 INFO is a plist used as a communication channel. FMT, when
4075 non-nil, is a time format string that will be applied on the date
4076 if it consists in a single timestamp object. It defaults to
4077 `org-export-date-timestamp-format' when nil.
4079 A proper date can be a secondary string, a string or nil. It is
4080 meant to be translated with `org-export-data' or alike."
4091 ;;;; For Links
4092 ;;
4093 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4094 ;; in `org-link-parameters'.
4095 ;;
4096 ;; `org-export-get-coderef-format' returns an appropriate format
4097 ;; string for coderefs.
4098 ;;
4099 ;; `org-export-inline-image-p' returns a non-nil value when the link
4100 ;; provided should be considered as an inline image.
4101 ;;
4102 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4103 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4104 ;; returns an appropriate unique identifier.
4105 ;;
4106 ;; `org-export-resolve-id-link' returns the first headline with
4107 ;; specified id or custom-id in parse tree, the path to the external
4108 ;; file with the id.
4109 ;;
4110 ;; `org-export-resolve-coderef' associates a reference to a line
4111 ;; number in the element it belongs, or returns the reference itself
4112 ;; when the element isn't numbered.
4113 ;;
4114 ;; `org-export-file-uri' expands a filename as stored in :path value
4115 ;; of a "file" link into a file URI.
4116 ;;
4117 ;; Broken links raise a `org-link-broken' error, which is caught by
4118 ;; `org-export-data' for further processing, depending on
4119 ;; `org-export-with-broken-links' value.
4124 "Try exporting LINK with a dedicated function.
4126 DESC is its description, as a string, or nil. BACKEND is the
4127 back-end used for export, as a symbol.
4129 Return output as a string, or nil if no protocol handles LINK.
4131 A custom protocol has precedence over regular back-end export.
4132 The function ignores links with an implicit type (e.g.,
4141 desc
4142 backend))))))
4145 "Return format string for code reference link.
4146 PATH is the link path. DESC is its description."
4154 "Non-nil if LINK object points to an inline image.
4156 Optional argument is a set of RULES defining inline images. It
4157 is an alist where associations have the following shape:
4159 (TYPE . REGEXP)
4161 Applying a rule means apply REGEXP against LINK's path when its
4162 type is TYPE. The function will return a non-nil value if any of
4163 the provided rules is non-nil. The default rule is
4164 `org-export-default-inline-image-rule'.
4166 This only applies to links without a description."
4176 "Insert image links in DATA.
4178 Org syntax does not support nested links. Nevertheless, some
4179 export back-ends support images as descriptions of links. Since
4180 images are really links to image files, we need to make an
4181 exception about links nesting.
4183 This function recognizes links whose contents are really images
4184 and turn them into proper nested links. It is meant to be used
4185 as a parse tree filter in back-ends supporting such constructs.
4187 DATA is a parse tree. INFO is the current state of the export
4188 process, as a plist.
4190 A description is a valid images if it matches any rule in RULES,
4191 if non-nil, or `org-export-default-inline-image-rule' otherwise.
4192 See `org-export-inline-image-p' for more information about the
4193 structure of RULES.
4195 Return modified DATA."
4197 org-plain-link-re
4198 org-angle-link-re))
4211 ;; Replace contents with image link.
4217 info nil nil t))
4218 data)
4221 "Resolve a code reference REF.
4223 INFO is a plist used as a communication channel.
4225 Return associated line number in source code, or REF itself,
4226 depending on src-block or example element's switches. Throw an
4227 error if no block contains REF."
4233 org-coderef-label-format))
4235 ;; Element containing REF is found. Resolve it to
4236 ;; either a label or a line number, as needed.
4245 "List search cells for element or object DATUM.
4247 A search cell follows the pattern (TYPE . SEARCH) where
4249 TYPE is a symbol among `headline', `custom-id', `target' and
4250 `other'.
4252 SEARCH is the string a link is expected to match. More
4253 accurately, it is
4255 - headline's title, as a list of strings, if TYPE is
4256 `headline'.
4258 - CUSTOM_ID value, as a string, if TYPE is `custom-id'.
4260 - target's or radio-target's name as a list of strings if
4261 TYPE is `target'.
4263 - NAME affiliated keyword is TYPE is `other'.
4265 A search cell is the internal representation of a fuzzy link. It
4266 ignores white spaces and statistics cookies, if applicable."
4268 (`headline
4279 (`target
4287 "Return search cells associated to string S.
4288 S is either the path of a fuzzy link or a search option, i.e., it
4289 tries to match either a headline (through custom ID or title),
4290 a target or a named element."
4298 "Non-nil when DATUM matches search cells CELLS.
4299 DATUM is an element or object. CELLS is a list of search cells,
4300 as returned by `org-export-search-cells'."
4305 "Return LINK destination.
4307 INFO is a plist holding contextual information.
4309 Return value can be an object or an element:
4311 - If LINK path matches a target object (i.e. <<path>>) return it.
4313 - If LINK path exactly matches the name affiliated keyword
4314 (i.e. #+NAME: path) of an element, return that element.
4316 - If LINK path exactly matches any headline name, return that
4317 element.
4319 - Otherwise, throw an error.
4322 significant."
4328 table)))
4336 datum)))))
4340 search-cells
4341 ;; There can be multiple matches for un-typed searches, i.e.,
4342 ;; for searches not starting with # or *. In this case,
4343 ;; prioritize targets and names over headline titles.
4344 ;; Matching both a name and a target is not valid, and
4345 ;; therefore undefined.
4348 datum))
4349 matches)
4351 link-cache)))))
4354 "Return headline referenced as LINK destination.
4356 INFO is a plist used as a communication channel.
4358 Return value can be the headline element matched in current parse
4362 ;; First check if id is within the current parse tree.
4367 headline))
4369 ;; Otherwise, look for external files.
4374 "Return radio-target object referenced as LINK destination.
4376 INFO is a plist used as a communication channel.
4378 Return value can be a radio-target object or nil. Assume LINK
4387 nil nil path nil nil t)
4388 t)
4389 radio))
4393 "Return file URI associated to FILENAME."
4400 fullname)))))
4402 ;;;; For References
4403 ;;
4404 ;; `org-export-get-reference' associate a unique reference for any
4405 ;; object or element. It uses `org-export-new-reference' and
4406 ;; `org-export-format-reference' to, respectively, generate new
4407 ;; internal references and turn them into a string suitable for
4408 ;; output.
4409 ;;
4410 ;; `org-export-get-ordinal' associates a sequence number to any object
4411 ;; or element.
4414 "Return a unique reference, among REFERENCES.
4415 REFERENCES is an alist whose values are in-use references, as
4416 numbers. Returns a number, which is the internal representation
4417 of a reference. See also `org-export-format-reference'."
4418 ;; Generate random 7 digits hexadecimal numbers. Collisions
4419 ;; increase exponentially with the numbers of references. However,
4420 ;; the odds for encountering at least one collision with 1000 active
4421 ;; references in the same document are roughly 0.2%, so this
4422 ;; shouldn't be the bottleneck.
4425 new))
4428 "Format REFERENCE into a string.
4429 REFERENCE is a number representing a reference, as returned by
4430 `org-export-new-reference', which see."
4434 "Return a unique reference for DATUM, as a string.
4436 DATUM is either an element or an object. INFO is the current
4437 export state, as a plist.
4439 This function checks `:crossrefs' property in INFO for search
4440 cells matching DATUM before creating a new reference. Returned
4441 reference consists of alphanumeric characters only."
4446 ;; Preserve any pre-existing association between
4447 ;; a search cell and a reference, i.e., when some
4448 ;; previously published document referenced a location
4449 ;; within current file (see
4450 ;; `org-publish-resolve-external-link').
4451 ;;
4452 ;; However, there is no guarantee that search cells are
4453 ;; unique, e.g., there might be duplicate custom ID or
4454 ;; two headings with the same title in the file.
4455 ;;
4456 ;; As a consequence, before re-using any reference to
4457 ;; an element or object, we check that it doesn't refer
4458 ;; to a previous element or object.
4465 cells)
4468 ;; Cache contains both data already associated to
4469 ;; a reference and in-use internal references, so as to make
4470 ;; unique references.
4472 ;; Retain a direct association between reference string and
4473 ;; DATUM since (1) not every object or element can be given
4474 ;; a search cell (2) it permits quick lookup.
4477 reference-string))))
4480 "Return ordinal number of an element or object.
4482 ELEMENT is the element or object considered. INFO is the plist
4483 used as a communication channel.
4485 Optional argument TYPES, when non-nil, is a list of element or
4486 object types, as symbols, that should also be counted in.
4487 Otherwise, only provided element's type is considered.
4489 Optional argument PREDICATE is a function returning a non-nil
4490 value if the current element or object should be counted in. It
4491 accepts two arguments: the element or object being considered and
4492 the plist used as a communication channel. This allows counting
4493 only a certain type of object (i.e. inline images).
4495 Return value is a list of numbers if ELEMENT is a headline or an
4496 item. It is nil for keywords. It represents the footnote number
4497 for footnote definitions and footnote references. If ELEMENT is
4498 a target, return the same value as if ELEMENT was the closest
4499 table, item or headline containing the target. In any other
4500 case, return the sequence number of ELEMENT among elements or
4501 objects of the same type."
4502 ;; Ordinal of a target object refer to the ordinal of the closest
4503 ;; table, item, or headline containing the object.
4507 element
4510 ;; Special case 1: A headline returns its number as a list.
4512 ;; Special case 2: An item returns its number as a list.
4516 struct
4523 ;; Increment counter until ELEMENT is found again.
4534 ;;;; For Src-Blocks
4535 ;;
4536 ;; `org-export-get-loc' counts number of code lines accumulated in
4537 ;; src-block or example-block elements with a "+n" switch until
4538 ;; a given element, excluded. Note: "-n" switches reset that count.
4539 ;;
4540 ;; `org-export-unravel-code' extracts source code (along with a code
4541 ;; references alist) from an `element-block' or `src-block' type
4542 ;; element.
4543 ;;
4544 ;; `org-export-format-code' applies a formatting function to each line
4545 ;; of code, providing relative line number and code reference when
4546 ;; appropriate. Since it doesn't access the original element from
4547 ;; which the source code is coming, it expects from the code calling
4548 ;; it to know if lines should be numbered and if code references
4549 ;; should appear.
4550 ;;
4551 ;; Eventually, `org-export-format-code-default' is a higher-level
4552 ;; function (it makes use of the two previous functions) which handles
4553 ;; line numbering and code references inclusion, and returns source
4554 ;; code in a format suitable for plain text or verbatim output.
4557 "Return count of lines of code before ELEMENT.
4559 ELEMENT is an example-block or src-block element. INFO is the
4560 plist used as a communication channel.
4562 Count includes every line of code in example-block or src-block
4564 ELEMENT doesn't allow line numbering."
4571 ;; ELEMENT is reached: Quit loop and return locs.
4573 ;; Only count lines from src-block and example-block
4574 ;; elements with a "+n" or "-n" switch.
4579 ;; Accumulate locs or reset them.
4587 "Clean source code and extract references out of it.
4589 ELEMENT has either a `src-block' an `example-block' type.
4591 Return a cons cell whose CAR is the source code, cleaned from any
4592 reference, protective commas and spurious indentation, and CDR is
4593 an alist between relative line number (integer) and name of code
4594 reference on that line (string)."
4597 ;; Remove global indentation from code, if necessary. Also
4598 ;; remove final newline character, since it doesn't belongs
4599 ;; to the code proper.
4604 value
4606 ;; Build a regexp matching a loc with a reference.
4608 ;; Return value.
4610 ;; Code with references removed.
4615 ;; Ref line: remove ref, and add its position in REFS.
4619 ;; Reference alist.
4620 refs)))
4623 "Format CODE by applying FUN line-wise and return it.
4625 CODE is a string representing the code to format. FUN is
4626 a function. It must accept three arguments: a line of
4627 code (string), the current line number (integer) or nil and the
4628 reference associated to the current line (string) or nil.
4630 Optional argument NUM-LINES can be an integer representing the
4631 number of code lines accumulated until the current code. Line
4632 numbers passed to FUN will take it into account. If it is nil,
4633 FUN's second argument will always be nil. This number can be
4634 obtained with `org-export-get-loc' function.
4636 Optional argument REF-ALIST can be an alist between relative line
4637 number (i.e. ignoring NUM-LINES) and the name of the code
4638 reference on it. If it is nil, FUN's third argument will always
4639 be nil. It can be obtained through the use of
4640 `org-export-unravel-code' function."
4653 "Return source code from ELEMENT, formatted in a standard way.
4655 ELEMENT is either a `src-block' or `example-block' element. INFO
4656 is a plist used as a communication channel.
4658 This function takes care of line numbering and code references
4659 inclusion. Line numbers, when applicable, appear at the
4660 beginning of the line, separated from the code by two white
4661 spaces. Code references, on the other hand, appear flushed to
4662 the right, separated by six white spaces from the widest line of
4663 code."
4664 ;; Extract code and references.
4671 ;; Handle line numbering.
4678 ;; Prepare references display, if required. Any reference
4679 ;; should start six columns after the widest line of code,
4680 ;; wrapped with parenthesis.
4685 code
4689 number-str
4690 loc
4694 ?\s)
4696 num-start refs)))))
4699 ;;;; For Tables
4700 ;;
4701 ;; `org-export-table-has-special-column-p' and and
4702 ;; `org-export-table-row-is-special-p' are predicates used to look for
4703 ;; meta-information about the table structure.
4704 ;;
4705 ;; `org-table-has-header-p' tells when the rows before the first rule
4706 ;; should be considered as table's header.
4707 ;;
4708 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4709 ;; and `org-export-table-cell-borders' extract information from
4710 ;; a table-cell element.
4711 ;;
4712 ;; `org-export-table-dimensions' gives the number on rows and columns
4713 ;; in the table, ignoring horizontal rules and special columns.
4714 ;; `org-export-table-cell-address', given a table-cell object, returns
4715 ;; the absolute address of a cell. On the other hand,
4716 ;; `org-export-get-table-cell-at' does the contrary.
4717 ;;
4718 ;; `org-export-table-cell-starts-colgroup-p',
4719 ;; `org-export-table-cell-ends-colgroup-p',
4720 ;; `org-export-table-row-starts-rowgroup-p',
4721 ;; `org-export-table-row-ends-rowgroup-p',
4722 ;; `org-export-table-row-starts-header-p',
4723 ;; `org-export-table-row-ends-header-p' and
4724 ;; `org-export-table-row-in-header-p' indicate position of current row
4725 ;; or cell within the table.
4728 "Non-nil when TABLE has a special column.
4729 All special columns will be ignored during export."
4730 ;; The table has a special column when every first cell of every row
4731 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4732 ;; "*" "_" and "^". Though, do not consider a first column
4733 ;; containing only empty cells as special.
4748 "Non-nil when TABLE has a header.
4750 INFO is a plist used as a communication channel.
4752 A table has a header when it contains at least two row groups."
4756 table)))
4772 nil)))
4774 cache)))))
4777 "Non-nil if TABLE-ROW is considered special.
4778 All special rows will be ignored during export."
4782 ;; A row is special either when...
4784 ;; ... it starts with a field only containing "/",
4786 ;; ... the table contains a special column and the row start
4787 ;; with a marking character among, "^", "_", "$" or "!",
4791 ;; ... it contains only alignment cookies and empty cells.
4796 ;; Since VALUE is a secondary string, the following
4797 ;; checks avoid expanding it with `org-export-data'.
4808 "Return TABLE-ROW's group number, as an integer.
4810 INFO is a plist used as the communication channel.
4812 Return value is the group number, as an integer, or nil for
4813 special rows and rows separators. First group is also table's
4814 header."
4819 table)))
4822 ;; First time a row is queried, populate cache with all the
4823 ;; rows from the table.
4831 info))
4835 "Return TABLE-CELL contents width.
4837 INFO is a plist used as the communication channel.
4839 Return value is the width given by the last width cookie in the
4840 same column as TABLE-CELL, or nil."
4849 table)))
4858 ;; In a special row, try to find a width cookie at COLUMN.
4862 ;; The following checks avoid expanding unnecessarily
4863 ;; the cell with `org-export-data'.
4873 "Return TABLE-CELL contents alignment.
4875 INFO is a plist used as the communication channel.
4877 Return alignment as specified by the last alignment cookie in the
4878 same column as TABLE-CELL. If no such cookie is found, a default
4879 alignment value will be deduced from fraction of numbers in the
4880 column (see `org-table-number-fraction' for more information).
4881 Possible values are `left', `right' and `center'."
4882 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4892 table)))
4898 cookie-align
4899 previous-cell-number-p)
4902 ;; In a special row, try to find an alignment cookie at
4903 ;; COLUMN.
4907 ;; Since VALUE is a secondary string, the following
4908 ;; checks avoid useless expansion through
4909 ;; `org-export-data'.
4917 ;; Ignore table rules.
4919 ;; In a standard row, check if cell's contents are
4920 ;; expressing some kind of number. Increase NUMBER-CELLS
4921 ;; accordingly. Though, don't bother if an alignment
4922 ;; cookie has already defined cell's alignment.
4927 info)))
4929 ;; Treat an empty cell as a number if it follows
4930 ;; a number.
4936 ;; Return value. Alignment specified by cookies has
4937 ;; precedence over alignment deduced from cell's contents.
4939 column
4944 org-table-number-fraction)
4949 "Return TABLE-CELL borders.
4951 INFO is a plist used as a communication channel.
4953 Return value is a list of symbols, or nil. Possible values are:
4954 `top', `bottom', `above', `below', `left' and `right'. Note:
4955 `top' (resp. `bottom') only happen for a cell in the first
4956 row (resp. last row) of the table, ignoring table rules, if any.
4958 Returned borders ignore special rows."
4961 borders)
4962 ;; Top/above border? TABLE-CELL has a border above when a rule
4963 ;; used to demarcate row groups can be found above. Hence,
4964 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4965 ;; another regular row has to be found above that rule.
4968 ;; Look at every row before the current one.
4975 ;; No rule above, or rule found starts the table (ignoring any
4976 ;; special row): TABLE-CELL is at the top of the table.
4979 ;; Bottom/below border? TABLE-CELL has a border below when next
4980 ;; non-regular row below is a rule.
4983 ;; Look at every row after the current one.
4990 ;; No rule below, or rule found ends the table (modulo some
4991 ;; special row): TABLE-CELL is at the bottom of the table.
4994 ;; Right/left borders? They can only be specified by column
4995 ;; groups. Column groups are defined in a row starting with "/".
4996 ;; Also a column groups row only contains "<", "<>", ">" or blank
4997 ;; cells.
5001 ;; Table rows are read in reverse order so last column groups
5002 ;; row has precedence over any previous one.
5015 ;; There's a left border when previous cell, if
5016 ;; any, ends a group, or current one starts one.
5022 ;; There's a right border when next cell, if any,
5023 ;; starts a group, or current one ends one.
5030 ;; Return value.
5031 borders))
5034 "Non-nil when TABLE-CELL is at the beginning of a column group.
5035 INFO is a plist used as a communication channel."
5036 ;; A cell starts a column group either when it is at the beginning
5037 ;; of a row (or after the special column, if any) or when it has
5038 ;; a left border.
5041 table-cell)
5045 "Non-nil when TABLE-CELL is at the end of a column group.
5046 INFO is a plist used as a communication channel."
5047 ;; A cell ends a column group either when it is at the end of a row
5048 ;; or when it has a right border.
5051 table-cell)
5055 "Non-nil when TABLE-ROW is at the beginning of a row group.
5056 INFO is a plist used as a communication channel."
5064 "Non-nil when TABLE-ROW is at the end of a row group.
5065 INFO is a plist used as a communication channel."
5073 "Non-nil when TABLE-ROW is located within table's header.
5074 INFO is a plist used as a communication channel. Always return
5075 nil for special rows and rows separators."
5081 "Non-nil when TABLE-ROW is the first table header's row.
5082 INFO is a plist used as a communication channel."
5087 "Non-nil when TABLE-ROW is the last table header's row.
5088 INFO is a plist used as a communication channel."
5093 "Return TABLE-ROW number.
5094 INFO is a plist used as a communication channel. Return value is
5095 zero-indexed and ignores separators. The function returns nil
5096 for special rows and separators."
5101 table)))
5104 ;; First time a row is queried, populate cache with all the
5105 ;; rows from the table.
5111 info))
5115 "Return TABLE dimensions.
5117 INFO is a plist used as a communication channel.
5119 Return value is a CONS like (ROWS . COLUMNS) where
5120 ROWS (resp. COLUMNS) is the number of exportable
5121 rows (resp. columns)."
5123 ;; Set number of rows, and extract first one.
5129 ;; Set number of columns.
5131 ;; Return value.
5135 "Return address of a regular TABLE-CELL object.
5137 TABLE-CELL is the cell considered. INFO is a plist used as
5138 a communication channel.
5140 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5141 zero-based index. Only exportable cells are considered. The
5142 function returns nil for other cells."
5154 "Return regular table-cell object at ADDRESS in TABLE.
5156 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5157 zero-based index. TABLE is a table type element. INFO is
5158 a plist used as a communication channel.
5160 If no table-cell, among exportable cells, is found at ADDRESS,
5161 return nil."
5164 ;; Row at (car address) or nil.
5172 'table-cell
5179 ;;;; For Tables Of Contents
5180 ;;
5181 ;; `org-export-collect-headlines' builds a list of all exportable
5182 ;; headline elements, maybe limited to a certain depth. One can then
5183 ;; easily parse it and transcode it.
5184 ;;
5185 ;; Building lists of tables, figures or listings is quite similar.
5186 ;; Once the generic function `org-export-collect-elements' is defined,
5187 ;; `org-export-collect-tables', `org-export-collect-figures' and
5188 ;; `org-export-collect-listings' can be derived from it.
5191 "Collect headlines in order to build a table of contents.
5193 INFO is a plist used as a communication channel.
5195 When optional argument N is an integer, it specifies the depth of
5196 the table of contents. Otherwise, it is set to the value of the
5197 last headline level. See `org-export-headline-levels' for more
5198 information.
5200 Optional argument SCOPE, when non-nil, is an element. If it is
5201 a headline, only children of SCOPE are collected. Otherwise,
5202 collect children of the headline containing provided element. If
5203 there is no such headline, collect all headlines. In any case,
5204 argument N becomes relative to the level of that headline.
5206 Return a list of all exportable headlines as parsed elements.
5207 Footnote sections are ignored."
5216 limit))))
5222 info)))
5225 "Collect referenceable elements of a determined type.
5227 TYPE can be a symbol or a list of symbols specifying element
5228 types to search. Only elements with a caption are collected.
5230 INFO is a plist used as a communication channel.
5232 When non-nil, optional argument PREDICATE is a function accepting
5233 one argument, an element of type TYPE. It returns a non-nil
5234 value when that element should be collected.
5236 Return a list of all elements found, in order of appearance."
5241 element))
5242 info))
5245 "Build a list of tables.
5246 INFO is a plist used as a communication channel.
5248 Return a list of table elements with a caption."
5252 "Build a list of figures.
5254 INFO is a plist used as a communication channel. PREDICATE is
5255 a function which accepts one argument: a paragraph element and
5256 whose return value is non-nil when that element should be
5257 collected.
5259 A figure is a paragraph type element, with a caption, verifying
5261 a vague concept that may depend on back-end.
5263 Return a list of elements recognized as figures."
5267 "Build a list of src blocks.
5269 INFO is a plist used as a communication channel.
5271 Return a list of src-block elements with a caption."
5275 ;;;; Smart Quotes
5276 ;;
5277 ;; The main function for the smart quotes sub-system is
5278 ;; `org-export-activate-smart-quotes', which replaces every quote in
5279 ;; a given string from the parse tree with its "smart" counterpart.
5280 ;;
5281 ;; Dictionary for smart quotes is stored in
5282 ;; `org-export-smart-quotes-alist'.
5298 ;; one may use: »...«, "...", ›...‹, or '...'.
5299 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5300 ;; LaTeX quotes require Babel!
5360 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5371 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5382 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5393 ;; 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
5394 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5405 ;; Based on https://sl.wikipedia.org/wiki/Narekovaj
5416 ;; Based on https://sv.wikipedia.org/wiki/Citattecken
5422 "Smart quotes translations.
5424 Alist whose CAR is a language string and CDR is an alist with
5425 quote type as key and a plist associating various encodings to
5426 their translation as value.
5428 A quote type can be any symbol among `primary-opening',
5429 `primary-closing', `secondary-opening', `secondary-closing' and
5430 `apostrophe'.
5432 Valid encodings include `:utf-8', `:html', `:latex' and
5433 `:texinfo'.
5438 "Return smart quote status at the beginning of string S.
5439 INFO is the current export state, as a plist."
5444 table)))
5452 'plain-text
5461 ;; Not already in a level 1 quote: this is an
5462 ;; apostrophe.
5464 ;; Extract previous char and next char. As
5465 ;; a special case, they can also be set to `blank',
5466 ;; `no-blank' or nil. Then determine if current
5467 ;; match is allowed as an opening quote or a closing
5468 ;; quote.
5473 text info)))
5490 previous)
5501 next)
5508 current-status)
5512 info nil org-element-recursive-objects)
5519 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5520 `:utf-8'. INFO is a plist used as a communication channel.
5522 The function has to retrieve information about string
5523 surroundings in parse tree. It can only happen with an
5524 unmodified string. Thus, if S has already been through another
5525 process, a non-nil ORIGINAL optional argument will provide that
5526 original string.
5528 Return the new string."
5537 org-export-smart-quotes-alist))))
5538 encoding)
5539 match))
5540 s nil t)))
5542 ;;;; Topology
5543 ;;
5544 ;; Here are various functions to retrieve information about the
5545 ;; neighborhood of a given element or object. Neighbors of interest
5546 ;; are direct parent (`org-export-get-parent'), parent headline
5547 ;; (`org-export-get-parent-headline'), first element containing an
5548 ;; object, (`org-export-get-parent-element'), parent table
5549 ;; (`org-export-get-parent-table'), previous element or object
5550 ;; (`org-export-get-previous-element') and next element or object
5551 ;; (`org-export-get-next-element').
5553 ;; defsubst org-export-get-parent must be defined before first use
5556 "Return BLOB parent headline or nil.
5557 BLOB is the element or object being considered."
5561 "Return first element containing OBJECT or nil.
5562 OBJECT is the object to consider."
5566 "Return OBJECT parent table or nil.
5567 OBJECT is either a `table-cell' or `table-element' type object."
5571 "Return previous element or object.
5573 BLOB is an element or object. INFO is a plist used as
5574 a communication channel. Return previous exportable element or
5575 object, a string, or nil.
5577 When optional argument N is a positive integer, return a list
5578 containing up to N siblings before BLOB, from farthest to
5579 closest. With any other non-nil value, return a list containing
5580 all of them."
5586 prev)
5596 "Return next element or object.
5598 BLOB is an element or object. INFO is a plist used as
5599 a communication channel. Return next exportable element or
5600 object, a string, or nil.
5602 When optional argument N is a positive integer, return a list
5603 containing up to N siblings after BLOB, from closest to farthest.
5604 With any other non-nil value, return a list containing all of
5605 them."
5612 next)
5622 ;;;; Translation
5623 ;;
5624 ;; `org-export-translate' translates a string according to the language
5625 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5626 ;; the dictionary used for the translation.
5661 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5673 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5679 ("ru" :html "(Продолжение следует)"
5767 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5792 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5798 ("ru" :html "Список распечаток"
5815 ("ru" :html "Список таблиц"
5950 ("ru" :html "Неизвестная ссылка"
5954 "Dictionary for export engine.
5956 Alist whose car is the string to translate and cdr is an alist
5957 whose car is the language string and cdr is a plist whose
5958 properties are possible charsets and values translated terms.
5960 It is used as a database for `org-export-translate'. Since this
5961 function returns the string as-is if no translation was found,
5962 the variable only needs to record values different from the
5966 "Translate string S according to language specification.
5968 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5969 and `:utf-8'. INFO is a plist used as a communication channel.
5971 Translation depends on `:language' property. Return the
5972 translated string. If no translation is found, try to fall back
5973 to `:default' encoding. If it fails, return S."
5979 s)))
5982 \f
5983 ;;; Asynchronous Export
5984 ;;
5985 ;; `org-export-async-start' is the entry point for asynchronous
5986 ;; export. It recreates current buffer (including visibility,
5987 ;; narrowing and visited file) in an external Emacs process, and
5988 ;; evaluates a command there. It then applies a function on the
5989 ;; returned results in the current process.
5990 ;;
5991 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5992 ;; allow exporting to a buffer or a file, asynchronously or not.
5993 ;;
5994 ;; `org-export-output-file-name' is an auxiliary function meant to be
5995 ;; used with `org-export-to-file'. With a given extension, it tries
5996 ;; to provide a canonical file name to write export output to.
5997 ;;
5998 ;; Asynchronously generated results are never displayed directly.
5999 ;; Instead, they are stored in `org-export-stack-contents'. They can
6000 ;; then be retrieved by calling `org-export-stack'.
6001 ;;
6002 ;; Export Stack is viewed through a dedicated major mode
6003 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
6004 ;;`org-export-stack-delete', `org-export-stack-view' and
6005 ;;`org-export-stack-clear'.
6006 ;;
6007 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
6008 ;; It should be used whenever `org-export-async-start' is called.
6011 "Call function FUN on the results returned by BODY evaluation.
6013 FUN is an anonymous function of one argument. BODY evaluation
6014 happens in an asynchronous process, from a buffer which is an
6015 exact copy of the current one.
6017 Use `org-export-add-to-stack' in FUN in order to register results
6018 in the stack.
6020 This is a low level function. See also `org-export-to-buffer'
6021 and `org-export-to-file' for more specialized functions."
6024 ;; Write the full sexp evaluating BODY in a copy of the current
6025 ;; buffer to a temporary file, as it may be too long for program
6026 ;; args in `start-process'.
6033 ;; Null characters (from variable values) are inserted
6034 ;; within the file. As a consequence, coding system for
6035 ;; buffer contents will not be recognized properly. So,
6036 ;; we make sure it is the same as the one used to display
6037 ;; the original buffer.
6039 ,coding
6042 ;; Ignore `kill-emacs-hook' and code evaluation
6043 ;; queries from Babel as we need a truly
6044 ;; non-interactive process.
6046 org-babel-confirm-evaluate-answer-no t)
6047 ;; Initialize export framework.
6049 ;; Re-create current buffer there.
6052 ;; Sexp to evaluate in the buffer.
6054 ;; Start external process.
6057 (,process
6059 #'start-process
6062 ,proc-buffer
6069 ;; Register running process in stack.
6071 ;; Set-up sentinel in order to catch results.
6074 ,process
6096 ;;;###autoload
6099 &optional async subtreep visible-only body-only ext-plist
6100 post-process)
6101 "Call `org-export-as' with output to a specified buffer.
6103 BACKEND is either an export back-end, as returned by, e.g.,
6104 `org-export-create-backend', or a symbol referring to
6105 a registered back-end.
6107 BUFFER is the name of the output buffer. If it already exists,
6108 it will be erased first, otherwise, it will be created.
6110 A non-nil optional argument ASYNC means the process should happen
6111 asynchronously. The resulting buffer should then be accessible
6112 through the `org-export-stack' interface. When ASYNC is nil, the
6113 buffer is displayed if `org-export-show-temporary-export-buffer'
6114 is non-nil.
6116 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6117 EXT-PLIST are similar to those used in `org-export-as', which
6118 see.
6120 Optional argument POST-PROCESS is a function which should accept
6121 no argument. It is always called within the current process,
6122 from BUFFER, with point at its beginning. Export back-ends can
6123 use it to set a major mode there, e.g,
6125 (defun org-latex-export-as-latex
6126 (&optional async subtreep visible-only body-only ext-plist)
6127 (interactive)
6129 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
6131 This function returns BUFFER."
6159 buffer)))
6161 ;;;###autoload
6164 post-process)
6165 "Call `org-export-as' with output to a specified file.
6167 BACKEND is either an export back-end, as returned by, e.g.,
6168 `org-export-create-backend', or a symbol referring to
6169 a registered back-end. FILE is the name of the output file, as
6170 a string.
6172 A non-nil optional argument ASYNC means the process should happen
6173 asynchronously. The resulting buffer will then be accessible
6174 through the `org-export-stack' interface.
6176 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6177 EXT-PLIST are similar to those used in `org-export-as', which
6178 see.
6180 Optional argument POST-PROCESS is called with FILE as its
6181 argument and happens asynchronously when ASYNC is non-nil. It
6182 has to return a file name, or nil. Export back-ends can use this
6183 to send the output file through additional processing, e.g,
6185 (defun org-latex-export-to-latex
6186 (&optional async subtreep visible-only body-only ext-plist)
6187 (interactive)
6190 async subtreep visible-only body-only ext-plist
6191 (lambda (file) (org-latex-compile file)))
6193 The function returns either a file name returned by POST-PROCESS,
6194 or FILE."
6213 backend subtreep visible-only body-only ext-plist)))
6220 ;; Get proper return value.
6222 file))))))
6225 "Return output file's name according to buffer specifications.
6227 EXTENSION is a string representing the output file extension,
6228 with the leading dot.
6230 With a non-nil optional argument SUBTREEP, try to determine
6232 of subtree at point.
6234 When optional argument PUB-DIR is set, use it as the publishing
6235 directory.
6237 Return file name as a string."
6243 ;; Check EXPORT_FILE_NAME subtree property.
6245 ;; Check #+EXPORT_FILE_NAME keyword.
6255 ;; Extract from buffer's associated file, if any.
6257 ;; Can't determine file name on our own: ask user.
6259 "Output file: " pub-dir nil nil nil
6261 extension))
6263 ;; Build file name. Enforce EXTENSION over whatever user
6264 ;; may have come up with. PUB-DIR, if defined, always has
6265 ;; precedence over any provided path.
6271 ;; If writing to OUTPUT-FILE would overwrite original file, append
6272 ;; EXTENSION another time to final name.
6275 output-file)))
6278 "Add a new result to export stack if not present already.
6280 SOURCE is a buffer or a file name containing export results.
6281 BACKEND is a symbol representing export back-end used to generate
6282 it.
6284 Entries already pointing to SOURCE and unavailable entries are
6285 removed beforehand. Return the new stack."
6291 "Menu for asynchronous export results and running processes."
6301 "Remove all entries from export stack."
6306 "Refresh the export stack."
6311 "Remove export results at point from stack.
6312 If optional argument SOURCE is non-nil, remove it instead."
6317 org-export-stack-contents))))
6320 "View export results at point in stack.
6321 With an optional prefix argument IN-EMACS, force viewing files
6322 within Emacs."
6336 (define-key km "\C-p" 'previous-line)
6337 (define-key km "\C-?" 'previous-line)
6338 (define-key km [up] 'previous-line)
6339 (define-key km "C" 'org-export-stack-clear)
6340 (define-key km "v" 'org-export-stack-view)
6341 (define-key km (kbd "RET") 'org-export-stack-view)
6342 (define-key km "d" 'org-export-stack-remove)
6343 km)
6344 "Keymap for Org Export Stack.")
6346 (define-derived-mode org-export-stack-mode tabulated-list-mode "Org-Stack"
6347 "Mode for displaying asynchronous export stack.
6350 stack.
6352 In an Org Export Stack buffer, use \
6356 stack completely.
6358 Removing entries in a stack buffer does not affect files
6359 or buffers, only display.
6362 (setq tabulated-list-format
6363 (vector (list "#" 4 #'org-export--stack-num-predicate)
6364 (list "Back-End" 12 t)
6365 (list "Age" 6 nil)
6366 (list "Source" 0 nil)))
6367 (setq tabulated-list-sort-key (cons "#" nil))
6368 (setq tabulated-list-entries #'org-export--stack-generate)
6369 (add-hook 'tabulated-list-revert-hook #'org-export--stack-generate nil t)
6370 (add-hook 'post-command-hook #'org-export-stack-refresh nil t)
6371 (tabulated-list-init-header))
6373 (defun org-export--stack-generate ()
6374 "Generate the asynchronous export stack for display.
6375 Unavailable sources are removed from the list. Return a list
6376 appropriate for `tabulated-list-print'."
6377 ;; Clear stack from exited processes, dead buffers or non-existent
6378 ;; files.
6379 (setq org-export-stack-contents
6380 (cl-remove-if-not
6381 (lambda (el)
6382 (if (processp (nth 2 el))
6383 (buffer-live-p (process-buffer (nth 2 el)))
6384 (let ((source (car el)))
6385 (if (bufferp source) (buffer-live-p source)
6386 (file-exists-p source)))))
6387 org-export-stack-contents))
6388 ;; Update `tabulated-list-entries'.
6389 (let ((counter 0))
6390 (mapcar
6391 (lambda (entry)
6392 (let ((source (car entry)))
6393 (list source
6394 (vector
6395 ;; Counter.
6396 (number-to-string (cl-incf counter))
6397 ;; Back-End.
6398 (if (nth 1 entry) (symbol-name (nth 1 entry)) "")
6399 ;; Age.
6400 (let ((info (nth 2 entry)))
6401 (if (processp info) (symbol-name (process-status info))
6402 (format-seconds "%h:%.2m" (float-time (time-since info)))))
6403 ;; Source.
6404 (if (stringp source) source (buffer-name source))))))
6405 org-export-stack-contents)))
6407 (defun org-export--stack-num-predicate (a b)
6408 (< (string-to-number (aref (nth 1 a) 0))
6409 (string-to-number (aref (nth 1 b) 0))))
6411 (defun org-export--stack-source-at-point ()
6412 "Return source from export results at point in stack."
6413 (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
6414 (if (not source) (error "Source unavailable, please refresh buffer")
6415 (let ((source-name (if (stringp source) source (buffer-name source))))
6416 (if (save-excursion
6417 (beginning-of-line)
6418 (looking-at-p (concat ".* +" (regexp-quote source-name) "$")))
6419 source
6420 ;; SOURCE is not consistent with current line. The stack
6421 ;; view is outdated.
6422 (error (substitute-command-keys
6424 to refresh buffer")))))))
6427 \f
6428 ;;; The Dispatcher
6429 ;;
6430 ;; `org-export-dispatch' is the standard interactive way to start an
6431 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6432 ;; for its interface, which, in turn, delegates response to key
6433 ;; pressed to `org-export--dispatch-action'.
6435 ;;;###autoload
6436 (defun org-export-dispatch (&optional arg)
6437 "Export dispatcher for Org mode.
6439 It provides an access to common export related tasks in a buffer.
6440 Its interface comes in two flavors: standard and expert.
6442 While both share the same set of bindings, only the former
6443 displays the valid keys associations in a dedicated buffer.
6444 Scrolling (resp. line-wise motion) in this buffer is done with
6445 SPC and DEL (resp. C-n and C-p) keys.
6447 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6448 flavor or the other.
6451 same
6452 set of options used back then, on the current buffer.
6455 asynchronous export stack."
6456 (interactive "P")
6457 (let* ((input
6458 (cond ((equal arg '(16)) '(stack))
6459 ((and arg org-export-dispatch-last-action))
6460 (t (save-window-excursion
6461 (unwind-protect
6462 (progn
6463 ;; Remember where we are
6464 (move-marker org-export-dispatch-last-position
6465 (point)
6466 (org-base-buffer (current-buffer)))
6467 ;; Get and store an export command
6468 (setq org-export-dispatch-last-action
6469 (org-export--dispatch-ui
6470 (list org-export-initial-scope
6471 (and org-export-in-background 'async))
6472 nil
6473 org-export-dispatch-use-expert-ui)))
6474 (and (get-buffer "*Org Export Dispatcher*")
6475 (kill-buffer "*Org Export Dispatcher*")))))))
6476 (action (car input))
6477 (optns (cdr input)))
6478 (unless (memq 'subtree optns)
6479 (move-marker org-export-dispatch-last-position nil))
6480 (cl-case action
6481 ;; First handle special hard-coded actions.
6482 (template (org-export-insert-default-template nil optns))
6483 (stack (org-export-stack))
6484 (publish-current-file
6485 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6486 (publish-current-project
6487 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6488 (publish-choose-project
6489 (org-publish (assoc (completing-read
6490 "Publish project: "
6491 org-publish-project-alist nil t)
6492 org-publish-project-alist)
6493 (memq 'force optns)
6494 (memq 'async optns)))
6495 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6496 (otherwise
6497 (save-excursion
6498 (when arg
6499 ;; Repeating command, maybe move cursor to restore subtree
6500 ;; context.
6501 (if (eq (marker-buffer org-export-dispatch-last-position)
6502 (org-base-buffer (current-buffer)))
6503 (goto-char org-export-dispatch-last-position)
6504 ;; We are in a different buffer, forget position.
6505 (move-marker org-export-dispatch-last-position nil)))
6506 (funcall action
6507 ;; Return a symbol instead of a list to ease
6508 ;; asynchronous export macro use.
6509 (and (memq 'async optns) t)
6510 (and (memq 'subtree optns) t)
6511 (and (memq 'visible optns) t)
6512 (and (memq 'body optns) t)))))))
6514 (defun org-export--dispatch-ui (options first-key expertp)
6515 "Handle interface for `org-export-dispatch'.
6517 OPTIONS is a list containing current interactive options set for
6518 export. It can contain any of the following symbols:
6519 `body' toggles a body-only export
6520 `subtree' restricts export to current subtree
6521 `visible' restricts export to visible part of buffer.
6522 `force' force publishing files.
6523 `async' use asynchronous export process
6525 FIRST-KEY is the key pressed to select the first level menu. It
6526 is nil when this menu hasn't been selected yet.
6528 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6529 buffer is provided, but indications about currently active
6530 options are given in the prompt. Moreover, [?] allows switching
6531 back to standard interface."
6532 (let* ((fontify-key
6533 (lambda (key &optional access-key)
6534 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6535 ;; non-nil is the required first-level key to activate
6536 ;; KEY. When its value is t, activate KEY independently
6537 ;; on the first key, if any. A nil value means KEY will
6538 ;; only be activated at first level.
6539 (if (or (eq access-key t) (eq access-key first-key))
6540 (propertize key 'face 'org-warning)
6541 key)))
6542 (fontify-value
6543 (lambda (value)
6544 ;; Fontify VALUE string.
6545 (propertize value 'face 'font-lock-variable-name-face)))
6546 ;; Prepare menu entries by extracting them from registered
6547 ;; back-ends and sorting them by access key and by ordinal,
6548 ;; if any.
6549 (entries
6550 (sort (sort (delq nil
6551 (mapcar #'org-export-backend-menu
6552 org-export-registered-backends))
6553 (lambda (a b)
6554 (let ((key-a (nth 1 a))
6555 (key-b (nth 1 b)))
6556 (cond ((and (numberp key-a) (numberp key-b))
6557 (< key-a key-b))
6558 ((numberp key-b) t)))))
6559 'car-less-than-car))
6560 ;; Compute a list of allowed keys based on the first key
6561 ;; pressed, if any. Some keys
6562 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6563 ;; available.
6564 (allowed-keys
6565 (nconc (list 2 22 19 6 1)
6566 (if (not first-key) (org-uniquify (mapcar 'car entries))
6567 (let (sub-menu)
6568 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6569 (when (eq (car entry) first-key)
6570 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6571 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6572 ((not first-key) (list ?P)))
6573 (list ?& ?#)
6574 (when expertp (list ??))
6575 (list ?q)))
6576 ;; Build the help menu for standard UI.
6577 (help
6578 (unless expertp
6579 (concat
6580 ;; Options are hard-coded.
6581 (format "[%s] Body only: %s [%s] Visible only: %s
6582 \[%s] Export scope: %s [%s] Force publishing: %s
6584 (funcall fontify-key "C-b" t)
6585 (funcall fontify-value
6586 (if (memq 'body options) "On " "Off"))
6587 (funcall fontify-key "C-v" t)
6588 (funcall fontify-value
6589 (if (memq 'visible options) "On " "Off"))
6590 (funcall fontify-key "C-s" t)
6591 (funcall fontify-value
6592 (if (memq 'subtree options) "Subtree" "Buffer "))
6593 (funcall fontify-key "C-f" t)
6594 (funcall fontify-value
6595 (if (memq 'force options) "On " "Off"))
6596 (funcall fontify-key "C-a" t)
6597 (funcall fontify-value
6598 (if (memq 'async options) "On " "Off")))
6599 ;; Display registered back-end entries. When a key
6600 ;; appears for the second time, do not create another
6601 ;; entry, but append its sub-menu to existing menu.
6602 (let (last-key)
6603 (mapconcat
6604 (lambda (entry)
6605 (let ((top-key (car entry)))
6606 (concat
6607 (unless (eq top-key last-key)
6608 (setq last-key top-key)
6610 (funcall fontify-key (char-to-string top-key))
6611 (nth 1 entry)))
6612 (let ((sub-menu (nth 2 entry)))
6613 (unless (functionp sub-menu)
6614 ;; Split sub-menu into two columns.
6615 (let ((index -1))
6616 (concat
6617 (mapconcat
6618 (lambda (sub-entry)
6619 (cl-incf index)
6620 (format
6621 (if (zerop (mod index 2)) " [%s] %-26s"
6623 (funcall fontify-key
6624 (char-to-string (car sub-entry))
6625 top-key)
6626 (nth 1 sub-entry)))
6627 sub-menu "")
6629 entries ""))
6630 ;; Publishing menu is hard-coded.
6632 [%s] Current file [%s] Current project
6634 (funcall fontify-key "P")
6635 (funcall fontify-key "f" ?P)
6636 (funcall fontify-key "p" ?P)
6637 (funcall fontify-key "x" ?P)
6638 (funcall fontify-key "a" ?P))
6640 (funcall fontify-key "&" t)
6641 (funcall fontify-key "#" t))
6642 (format "[%s] %s"
6643 (funcall fontify-key "q" t)
6644 (if first-key "Main menu" "Exit")))))
6645 ;; Build prompts for both standard and expert UI.
6646 (standard-prompt (unless expertp "Export command: "))
6647 (expert-prompt
6648 (when expertp
6649 (format
6650 "Export command (C-%s%s%s%s%s) [%s]: "
6651 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6652 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6653 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6654 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6655 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6656 (mapconcat (lambda (k)
6657 ;; Strip control characters.
6658 (unless (< k 27) (char-to-string k)))
6659 allowed-keys "")))))
6660 ;; With expert UI, just read key with a fancy prompt. In standard
6661 ;; UI, display an intrusive help buffer.
6662 (if expertp
6663 (org-export--dispatch-action
6664 expert-prompt allowed-keys entries options first-key expertp)
6665 ;; At first call, create frame layout in order to display menu.
6666 (unless (get-buffer "*Org Export Dispatcher*")
6667 (delete-other-windows)
6668 (org-switch-to-buffer-other-window
6669 (get-buffer-create "*Org Export Dispatcher*"))
6670 (setq cursor-type nil
6671 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6672 ;; Make sure that invisible cursor will not highlight square
6673 ;; brackets.
6674 (set-syntax-table (copy-syntax-table))
6675 (modify-syntax-entry ?\[ "w"))
6676 ;; At this point, the buffer containing the menu exists and is
6677 ;; visible in the current window. So, refresh it.
6678 (with-current-buffer "*Org Export Dispatcher*"
6679 ;; Refresh help. Maintain display continuity by re-visiting
6680 ;; previous window position.
6681 (let ((pos (window-start)))
6682 (erase-buffer)
6683 (insert help)
6684 (set-window-start nil pos)))
6685 (org-fit-window-to-buffer)
6686 (org-export--dispatch-action
6687 standard-prompt allowed-keys entries options first-key expertp))))
6689 (defun org-export--dispatch-action
6690 (prompt allowed-keys entries options first-key expertp)
6691 "Read a character from command input and act accordingly.
6693 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6694 a list of characters available at a given step in the process.
6695 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6696 EXPERTP are the same as defined in `org-export--dispatch-ui',
6697 which see.
6699 Toggle export options when required. Otherwise, return value is
6700 a list with action as CAR and a list of interactive export
6701 options as CDR."
6702 (let (key)
6703 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6704 ;; C-p, SPC, DEL).
6705 (while (and (setq key (read-char-exclusive prompt))
6706 (not expertp)
6707 (memq key '(14 16 ?\s ?\d)))
6708 (cl-case key
6709 (14 (if (not (pos-visible-in-window-p (point-max)))
6710 (ignore-errors (scroll-up 1))
6711 (message "End of buffer")
6712 (sit-for 1)))
6713 (16 (if (not (pos-visible-in-window-p (point-min)))
6714 (ignore-errors (scroll-down 1))
6715 (message "Beginning of buffer")
6716 (sit-for 1)))
6717 (?\s (if (not (pos-visible-in-window-p (point-max)))
6718 (scroll-up nil)
6719 (message "End of buffer")
6720 (sit-for 1)))
6721 (?\d (if (not (pos-visible-in-window-p (point-min)))
6722 (scroll-down nil)
6723 (message "Beginning of buffer")
6724 (sit-for 1)))))
6725 (cond
6726 ;; Ignore undefined associations.
6727 ((not (memq key allowed-keys))
6728 (ding)
6729 (unless expertp (message "Invalid key") (sit-for 1))
6730 (org-export--dispatch-ui options first-key expertp))
6731 ;; q key at first level aborts export. At second level, cancel
6732 ;; first key instead.
6733 ((eq key ?q) (if (not first-key) (error "Export aborted")
6734 (org-export--dispatch-ui options nil expertp)))
6735 ;; Help key: Switch back to standard interface if expert UI was
6736 ;; active.
6737 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6738 ;; Send request for template insertion along with export scope.
6739 ((eq key ?#) (cons 'template (memq 'subtree options)))
6740 ;; Switch to asynchronous export stack.
6741 ((eq key ?&) '(stack))
6742 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6743 ((memq key '(2 22 19 6 1))
6744 (org-export--dispatch-ui
6745 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6746 (6 'force) (1 'async))))
6747 (if (memq option options) (remq option options)
6748 (cons option options)))
6749 first-key expertp))
6750 ;; Action selected: Send key and options back to
6751 ;; `org-export-dispatch'.
6752 ((or first-key (functionp (nth 2 (assq key entries))))
6753 (cons (cond
6754 ((not first-key) (nth 2 (assq key entries)))
6755 ;; Publishing actions are hard-coded. Send a special
6756 ;; signal to `org-export-dispatch'.
6757 ((eq first-key ?P)
6758 (cl-case key
6759 (?f 'publish-current-file)
6760 (?p 'publish-current-project)
6761 (?x 'publish-choose-project)
6762 (?a 'publish-all)))
6763 ;; Return first action associated to FIRST-KEY + KEY
6764 ;; path. Indeed, derived backends can share the same
6765 ;; FIRST-KEY.
6766 (t (catch 'found
6767 (dolist (entry (member (assq first-key entries) entries))
6768 (let ((match (assq key (nth 2 entry))))
6769 (when match (throw 'found (nth 2 match))))))))
6770 options))
6771 ;; Otherwise, enter sub-menu.
6772 (t (org-export--dispatch-ui options key expertp)))))
6776 (provide 'ox)
6778 ;; Local variables:
6779 ;; generated-autoload-file: "org-loaddefs.el"
6780 ;; End:
6782 ;;; ox.el ends here