| blob | 5c72fb575227b7954683cf801b081bd3eb2c4d00 |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
91 \f
92 ;;; Internal Variables
93 ;;
94 ;; Among internal variables, the most important is
95 ;; `org-export-options-alist'. This variable define the global export
96 ;; options, shared between every exporter, and how they are acquired.
142 "Alist between export properties and ways to set them.
144 The key of the alist is the property name, and the value is a list
145 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
147 KEYWORD is a string representing a buffer keyword, or nil. Each
148 property defined this way can also be set, during subtree
149 export, through a headline property named after the keyword
151 property).
152 OPTION is a string that could be found in an #+OPTIONS: line.
153 DEFAULT is the default value for the property.
154 BEHAVIOR determines how Org should handle multiple keywords for
155 the same property. It is a symbol among:
156 nil Keep old value and discard the new one.
157 t Replace old value with the new one.
158 `space' Concatenate the values, separating them with a space.
159 `newline' Concatenate the values, separating them with
160 a newline.
161 `split' Split values at white spaces, and cons them to the
162 previous list.
163 `parse' Parse value as a list of strings and Org objects,
164 which can then be transcoded with, e.g.,
165 `org-export-data'. It implies `space' behavior.
167 Values set through KEYWORD and OPTION have precedence over
168 DEFAULT.
170 All these properties should be back-end agnostic. Back-end
171 specific properties are set through `org-export-define-backend'.
175 "List of in-buffer keywords that require special treatment.
176 These keywords are not directly associated to a property. The
177 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
263 org-element--cache org-element--cache-objects org-element--cache-sync-keys
264 org-element--cache-sync-requests org-element--cache-sync-timer)
265 "List of variables not copied through upon buffer duplication.
266 Export process takes place on a copy of the original buffer.
267 When this copy is created, all Org related local variables not in
268 this list are copied to the new buffer. Variables with an
272 "Non-nil means asynchronous export process should leave data behind.
276 located in `temporary-file-directory'.
278 When non-nil, it will also set `debug-on-error' to a non-nil
282 "Record asynchronously generated export results and processes.
283 This is an alist: its CAR is the source of the
284 result (destination file or buffer for a finished process,
285 original buffer for a running one) and its CDR is a list
286 containing the back-end used, as a symbol, and either a process
287 or the time at which it finished. It is used to build the menu
291 "List of backends currently available in the exporter.
292 This variable is set with `org-export-define-backend' and
296 "Last command called from the dispatcher.
297 The value should be a list. Its CAR is the action, as a symbol,
301 "The position where the last export command was created using the dispatcher.
302 This marker will be used with `C-u C-c C-e' to make sure export repetition
305 ;; For compatibility with Org < 8
307 "Name, if any, of the back-end used during an export process.
309 Its value is a symbol such as `html', `latex', `ascii', or nil if
310 the back-end is anonymous (see `org-export-create-backend') or if
311 there is no export process in progress.
313 It can be used to teach Babel blocks how to act differently
317 \f
318 ;;; User-configurable Variables
319 ;;
320 ;; Configuration for the masses.
321 ;;
322 ;; They should never be accessed directly, as their value is to be
323 ;; stored in a property list (cf. `org-export-options-alist').
324 ;; Back-ends will read their value from there instead.
327 "Options for exporting Org mode files."
332 "General options for export engine."
337 "Whether sub-trees with the ARCHIVE tag should be exported.
339 This can have three different values:
340 nil Do not export, pretend this tree is not present.
341 t Do export the entire tree.
342 `headline' Only export the headline, but skip the tree below it.
344 This option can also be set with the OPTIONS keyword,
354 "Non-nil means insert author name into the exported file.
355 This option can also be set with the OPTIONS keyword,
362 "Non-nil means export CLOCK keywords.
363 This option can also be set with the OPTIONS keyword,
370 "Non-nil means the postamble should contain a creator sentence.
372 The sentence can be set in `org-export-creator-string', which
373 see.
375 This option can also be set with the OPTIONS keyword, e.g.,
384 "Non-nil means insert date in the exported document.
385 This option can also be set with the OPTIONS keyword,
392 "Time-stamp format string to use for DATE keyword.
394 The format string, when specified, only applies if date consists
395 in a single time-stamp. Otherwise its value will be ignored.
397 See `format-time-string' for details on how to build this
398 string."
407 emacs-version
409 "Information about the creator of the document.
410 This option can also be set on with the CREATOR keyword."
416 "Non-nil means export contents of standard drawers.
418 When t, all drawers are exported. This may also be a list of
419 drawer names to export, as strings. If that list starts with
420 `not', only drawers with such names will be ignored.
422 This variable doesn't apply to properties drawers. See
423 `org-export-with-properties' instead.
425 This option can also be set with the OPTIONS keyword,
438 :inline t
447 "Non-nil means insert author email into the exported file.
448 This option can also be set with the OPTIONS keyword,
455 "Non-nil means interpret *word*, /word/, _word_ and +word+.
457 If the export target supports emphasizing text, the word will be
458 typeset in bold, italic, with an underline or strike-through,
459 respectively.
461 This option can also be set with the OPTIONS keyword,
468 "Tags that exclude a tree from export.
470 All trees carrying any of these tags will be excluded from
471 export. This is without condition, so even subtrees inside that
472 carry one of the `org-export-select-tags' will be removed.
474 This option can also be set with the EXCLUDE_TAGS keyword."
481 This option can also be set with the OPTIONS keyword,
490 "Non-nil means Org footnotes should be exported.
491 This option can also be set with the OPTIONS keyword,
498 "Non-nil means process LaTeX environments and fragments.
500 This option can also be set with the OPTIONS line,
503 nil Ignore math snippets.
504 `verbatim' Keep everything in verbatim.
505 t Allow export of math snippets."
516 "The last level which is still exported as a headline.
518 Inferior levels will usually produce itemize or enumerate lists
519 when exported, but back-end behavior may differ.
521 This option can also be set with the OPTIONS keyword,
528 "The default language for export and clocktable translations, as a string.
529 This may have an association in
530 `org-clock-clocktable-language-setup',
531 `org-export-smart-quotes-alist' and `org-export-dictionary'.
532 This option can also be set with the LANGUAGE keyword."
538 "Non-nil means preserve all line breaks when exporting.
539 This option can also be set with the OPTIONS keyword,
546 "Non-nil means interpret entities when exporting.
549 Å.
551 For a list of supported names, see the constant `org-entities'
552 and the user option `org-entities-user'.
554 This option can also be set with the OPTIONS keyword,
561 "Non-nil means inlinetasks should be exported.
562 This option can also be set with the OPTIONS keyword,
571 "Non-nil means include planning info in export.
573 Planning info is the line containing either SCHEDULED:,
574 DEADLINE:, CLOSED: time-stamps, or a combination of them.
576 This option can also be set with the OPTIONS keyword,
585 "Non-nil means include priority cookies in export.
586 This option can also be set with the OPTIONS keyword,
593 "Non-nil means export contents of properties drawers.
595 When t, all properties are exported. This may also be a list of
596 properties to export, as strings.
598 This option can also be set with the OPTIONS keyword,
612 "Non-nil means add section numbers to headlines when exporting.
614 When set to an integer n, numbering will only happen for
615 headlines whose relative level is higher or equal to n.
617 This option can also be set with the OPTIONS keyword,
624 "Tags that select a tree for export.
626 If any such tag is found in a buffer, all trees that do not carry
627 one of these tags will be ignored during export. Inside trees
628 that are selected like this, you can still deselect a subtree by
629 tagging it with one of the `org-export-exclude-tags'.
631 This option can also be set with the SELECT_TAGS keyword."
637 "Non-nil means activate smart quotes during export.
638 This option can also be set with the OPTIONS keyword,
641 When setting this to non-nil, you need to take care of
642 using the correct Babel package when exporting to LaTeX.
643 E.g., you can load Babel for french like this:
655 When this option is turned on, these strings will be exported as:
657 Org HTML LaTeX UTF-8
658 -----+----------+--------+-------
660 -- – -- –
661 --- — --- —
664 This option can also be set with the OPTIONS keyword,
671 "Non-nil means include statistics cookies in export.
672 This option can also be set with the OPTIONS keyword,
683 If you want to control how Org displays those characters, see
684 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
685 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
686 it is not anymore.
688 When this option is turned on, you can use TeX-like syntax for
689 sub- and superscripts and see them exported correctly.
691 You can also set the option with #+OPTIONS: ^:t
694 single item - so grouping with {} is normally not needed. For
695 example, the following things will be parsed as single sub- or
696 superscripts:
698 10^24 or 10^tau several digits will be considered 1 item.
699 10^-12 or 10^-tau a leading sign with digits or a word
700 x^2-y^3 will be read as x^2 - y^3, because items are
701 terminated by almost any nonword/nondigit char.
702 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
704 Still, ambiguity is possible. So when in doubt, use {} to enclose
705 the sub/superscript. If you set this variable to the symbol `{}',
706 the braces are *required* in order to trigger interpretations as
708 frequently in plain text."
719 "Non-nil means create a table of contents in exported files.
721 The TOC contains headlines with levels up
722 to`org-export-headline-levels'. When an integer, include levels
723 up to N in the toc, this may then be different from
724 `org-export-headline-levels', but it will not be allowed to be
725 larger than the number of headline levels. When nil, no table of
726 contents is made.
728 This option can also be set with the OPTIONS keyword,
739 "Non-nil means export tables.
740 This option can also be set with the OPTIONS keyword,
749 "If nil, do not export tags, just remove them from headlines.
751 If this is the symbol `not-in-toc', tags will be removed from
752 table of contents entries, but still be shown in the headlines of
753 the document.
755 This option can also be set with the OPTIONS keyword,
765 "Non-nil means include TODO items for export.
767 This may have the following values:
768 t include tasks independent of state.
769 `todo' include only tasks that are not yet done.
770 `done' include only tasks that are already done.
771 nil ignore all tasks.
772 list of keywords include tasks with these keywords.
774 This option can also be set with the OPTIONS keyword,
789 "Non-nil means print title into the exported file.
790 This option can also be set with the OPTIONS keyword,
799 "Non-nil means insert a time stamp into the exported file.
800 The time stamp shows when the file was created. This option can
807 "Non nil means allow timestamps in export.
809 It can be set to any of the following values:
810 t export all timestamps.
811 `active' export active timestamps only.
812 `inactive' export inactive timestamps only.
813 nil do not export timestamps
815 This only applies to timestamps isolated in a paragraph
816 containing only timestamps. Other timestamps are always
817 exported.
819 This option can also be set with the OPTIONS keyword, e.g.
830 "Non-nil means include TODO keywords in export.
831 When nil, remove all these keywords from the export. This option
837 "Non-nil means BIND keywords can define local variable values.
838 This is a potential security risk, which is why the default value
839 is nil. You can also allow them through local buffer variables."
846 "Non-nil means do not raise an error on broken links.
848 When this variable is non-nil, broken links are ignored, without
849 stopping the export process. If it is set to `mark', broken
850 links are marked as such in the output, with a string like
852 [BROKEN LINK: path]
854 where PATH is the un-resolvable reference.
856 This option can also be set with the OPTIONS keyword, e.g.,
867 "Alist between export snippets back-ends and exporter back-ends.
869 This variable allows providing shortcuts for export snippets.
873 HTML code while every other back-end will ignore it."
887 "Coding system for the exported file."
894 "Non-nil means pushing export output to the kill ring.
895 This variable is ignored during asynchronous export."
905 "The initial scope when exporting with `org-export-dispatch'.
906 This variable can be either set to `buffer' or `subtree'."
913 "Non-nil means show buffer after exporting to temp buffer.
914 When Org exports to a file, the buffer visiting that file is never
915 shown, but remains buried. However, when exporting to
916 a temporary buffer, that buffer is popped up in a second window.
917 When this variable is nil, the buffer remains buried also in
918 these cases."
923 "Non-nil means export and publishing commands will run in background.
924 Results from an asynchronous export are never displayed
932 "File used to initialize external export process.
934 Value must be either nil or an absolute file name. When nil, the
935 external process is launched like a regular Emacs session,
936 loading user's initialization file and any site specific
937 configuration. If a file is provided, it, and only it, is loaded
938 at start-up.
940 Therefore, using a specific configuration makes the process to
941 load faster and the export more portable."
950 "Non-nil means using a non-intrusive `org-export-dispatch'.
951 In that case, no help buffer is displayed. Though, an indicator
957 asynchronous). Also, [?] allows switching back to standard
958 mode."
965 \f
966 ;;; Defining Back-ends
967 ;;
968 ;; An export back-end is a structure with `org-export-backend' type
969 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
970 ;; and `menu' slots.
971 ;;
972 ;; At the lowest level, a back-end is created with
973 ;; `org-export-create-backend' function.
974 ;;
975 ;; A named back-end can be registered with
976 ;; `org-export-register-backend' function. A registered back-end can
977 ;; later be referred to by its name, with `org-export-get-backend'
978 ;; function. Also, such a back-end can become the parent of a derived
979 ;; back-end from which slot values will be inherited by default.
980 ;; `org-export-derived-backend-p' can check if a given back-end is
981 ;; derived from a list of back-end names.
982 ;;
983 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
984 ;; `org-export-get-all-filters' return the full alist of transcoders,
985 ;; options and filters, including those inherited from ancestors.
986 ;;
987 ;; At a higher level, `org-export-define-backend' is the standard way
988 ;; to define an export back-end. If the new back-end is similar to
989 ;; a registered back-end, `org-export-define-derived-backend' may be
990 ;; used instead.
991 ;;
992 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
993 ;; when a given back-end hasn't been registered yet.
997 name parent transcoders options filters blocks menu)
1000 "Return export back-end named after NAME.
1001 NAME is a symbol. Return nil if no such back-end is found."
1008 "Register BACKEND as a known export back-end.
1009 BACKEND is a structure with `org-export-backend' type."
1010 ;; Refuse to register an unnamed back-end.
1013 ;; Refuse to register a back-end with an unknown parent.
1017 ;; If a back-end with the same name as BACKEND is already
1018 ;; registered, replace it with BACKEND. Otherwise, simply add
1019 ;; BACKEND to the list of registered back-ends.
1025 "Signal an error if BACKEND isn't defined."
1030 "Non-nil if BACKEND is derived from one of BACKENDS.
1031 BACKEND is an export back-end, as returned by, e.g.,
1032 `org-export-create-backend', or a symbol referring to
1033 a registered back-end. BACKENDS is constituted of symbols."
1045 "Return full translation table for BACKEND.
1047 BACKEND is an export back-end, as return by, e.g,,
1048 `org-export-create-backend'. Return value is an alist where
1049 keys are element or object types, as symbols, and values are
1050 transcoders.
1052 Unlike to `org-export-backend-transcoders', this function
1053 also returns transcoders inherited from parent back-ends,
1054 if any."
1058 parent)
1063 transcoders)))
1066 "Return export options for BACKEND.
1068 BACKEND is an export back-end, as return by, e.g,,
1069 `org-export-create-backend'. See `org-export-options-alist'
1070 for the shape of the return value.
1072 Unlike to `org-export-backend-options', this function also
1073 returns options inherited from parent back-ends, if any."
1077 parent)
1081 options)))
1084 "Return complete list of filters for BACKEND.
1086 BACKEND is an export back-end, as return by, e.g,,
1087 `org-export-create-backend'. Return value is an alist where
1088 keys are symbols and values lists of functions.
1090 Unlike to `org-export-backend-filters', this function also
1091 returns filters inherited from parent back-ends, if any."
1095 parent)
1099 filters)))
1102 "Define a new back-end BACKEND.
1104 TRANSCODERS is an alist between object or element types and
1105 functions handling them.
1107 These functions should return a string without any trailing
1108 space, or nil. They must accept three arguments: the object or
1109 element itself, its contents or nil when it isn't recursive and
1110 the property list used as a communication channel.
1112 Contents, when not nil, are stripped from any global indentation
1113 \(although the relative one is preserved). They also always end
1114 with a single newline character.
1116 If, for a given type, no function is found, that element or
1117 object type will simply be ignored, along with any blank line or
1118 white space at its end. The same will happen if the function
1119 returns the nil value. If that function returns the empty
1120 string, the type will be ignored, but the blank lines or white
1121 spaces will be kept.
1123 In addition to element and object types, one function can be
1124 associated to the `template' (or `inner-template') symbol and
1125 another one to the `plain-text' symbol.
1127 The former returns the final transcoded string, and can be used
1128 to add a preamble and a postamble to document's body. It must
1129 accept two arguments: the transcoded string and the property list
1130 containing export options. A function associated to `template'
1132 A function associated to `inner-template' is always applied.
1134 The latter, when defined, is to be called on every text not
1135 recognized as an element or an object. It must accept two
1136 arguments: the text string and the information channel. It is an
1137 appropriate place to protect special chars relative to the
1138 back-end.
1140 BODY can start with pre-defined keyword arguments. The following
1141 keywords are understood:
1143 :filters-alist
1145 Alist between filters and function, or list of functions,
1146 specific to the back-end. See `org-export-filters-alist' for
1147 a list of all allowed filters. Filters defined here
1148 shouldn't make a back-end test, as it may prevent back-ends
1149 derived from this one to behave properly.
1151 :menu-entry
1153 Menu entry for the export dispatcher. It should be a list
1154 like:
1158 where :
1160 KEY is a free character selecting the back-end.
1162 DESCRIPTION-OR-ORDINAL is either a string or a number.
1164 If it is a string, is will be used to name the back-end in
1165 its menu entry. If it is a number, the following menu will
1166 be displayed as a sub-menu of the back-end with the same
1167 KEY. Also, the number will be used to determine in which
1168 order such sub-menus will appear (lowest first).
1170 ACTION-OR-MENU is either a function or an alist.
1172 If it is an action, it will be called with four
1173 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1174 BODY-ONLY. See `org-export-as' for further explanations on
1175 some of them.
1177 If it is an alist, associations should follow the
1178 pattern:
1182 where KEY, DESCRIPTION and ACTION are described above.
1184 Valid values include:
1188 or
1193 (lambda (a s v b)
1194 (if a (org-latex-export-to-pdf t s v b)
1195 (org-open-file
1196 (org-latex-export-to-pdf nil s v b)))))))
1198 or the following, which will be added to the previous
1199 sub-menu,
1205 :options-alist
1207 Alist between back-end specific properties introduced in
1208 communication channel and how their value are acquired. See
1209 `org-export-options-alist' for more information about
1210 structure of the values."
1222 :transcoders transcoders
1223 :options options
1224 :filters filters
1228 "Create a new back-end as a variant of an existing one.
1230 CHILD is the name of the derived back-end. PARENT is the name of
1231 the parent back-end.
1233 BODY can start with pre-defined keyword arguments. The following
1234 keywords are understood:
1236 :filters-alist
1238 Alist of filters that will overwrite or complete filters
1239 defined in PARENT back-end. See `org-export-filters-alist'
1240 for a list of allowed filters.
1242 :menu-entry
1244 Menu entry for the export dispatcher. See
1245 `org-export-define-backend' for more information about the
1246 expected value.
1248 :options-alist
1250 Alist of back-end specific properties that will overwrite or
1251 complete those defined in PARENT back-end. Refer to
1252 `org-export-options-alist' for more information about
1253 structure of the values.
1255 :translate-alist
1257 Alist of element and object types and transcoders that will
1258 overwrite or complete transcode table from PARENT back-end.
1259 Refer to `org-export-define-backend' for detailed information
1260 about transcoders.
1263 as a variant of `latex' back-end with a custom template function:
1268 The back-end could then be called with, for example:
1283 :parent parent
1284 :transcoders transcoders
1285 :options options
1286 :filters filters
1290 \f
1291 ;;; The Communication Channel
1292 ;;
1293 ;; During export process, every function has access to a number of
1294 ;; properties. They are of two types:
1295 ;;
1296 ;; 1. Environment options are collected once at the very beginning of
1297 ;; the process, out of the original buffer and configuration.
1298 ;; Collecting them is handled by `org-export-get-environment'
1299 ;; function.
1300 ;;
1301 ;; Most environment options are defined through the
1302 ;; `org-export-options-alist' variable.
1303 ;;
1304 ;; 2. Tree properties are extracted directly from the parsed tree,
1305 ;; just before export, by `org-export--collect-tree-properties'.
1307 ;;;; Environment Options
1308 ;;
1309 ;; Environment options encompass all parameters defined outside the
1310 ;; scope of the parsed data. They come from five sources, in
1311 ;; increasing precedence order:
1312 ;;
1313 ;; - Global variables,
1314 ;; - Buffer's attributes,
1315 ;; - Options keyword symbols,
1316 ;; - Buffer keywords,
1317 ;; - Subtree properties.
1318 ;;
1319 ;; The central internal function with regards to environment options
1320 ;; is `org-export-get-environment'. It updates global variables with
1321 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1322 ;; the different sources.
1323 ;;
1324 ;; The internal functions doing the retrieval are:
1325 ;; `org-export--get-global-options',
1326 ;; `org-export--get-buffer-attributes',
1327 ;; `org-export--parse-option-keyword',
1328 ;; `org-export--get-subtree-options' and
1329 ;; `org-export--get-inbuffer-options'
1330 ;;
1331 ;; Also, `org-export--list-bound-variables' collects bound variables
1332 ;; along with their value in order to set them as buffer local
1333 ;; variables later in the process.
1336 "Collect export options from the current buffer.
1338 Optional argument BACKEND is an export back-end, as returned by
1339 `org-export-create-backend'.
1341 When optional argument SUBTREEP is non-nil, assume the export is
1342 done against the current sub-tree.
1344 Third optional argument EXT-PLIST is a property list with
1345 external parameters overriding Org default settings, but still
1346 inferior to file-local settings."
1347 ;; First install #+BIND variables since these must be set before
1348 ;; global options are read.
1351 ;; Get and prioritize export options...
1353 ;; ... from global variables...
1355 ;; ... from an external property list...
1356 ext-plist
1357 ;; ... from in-buffer settings...
1359 ;; ... and from subtree, when appropriate.
1363 "Parse an OPTIONS line and return values as a plist.
1364 Optional argument BACKEND is an export back-end, as returned by,
1365 e.g., `org-export-create-backend'. It specifies which back-end
1366 specific items to read, if any."
1373 alist))
1374 alist))
1375 ;; Priority is given to back-end specific options.
1377 org-export-options-alist))
1387 "Get export options in subtree at point.
1388 Optional argument BACKEND is an export back-end, as returned by,
1389 e.g., `org-export-create-backend'. It specifies back-end used
1390 for export. Return options as a plist."
1391 ;; For each buffer keyword, create a headline property setting the
1392 ;; same property in communication channel. The name for the
1393 ;; property is the keyword with "EXPORT_" appended to it.
1395 ;; Make sure point is at a heading.
1398 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1399 ;; care of them right from the start.
1402 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1403 ;; headline's title (with no todo keyword, priority cookie or
1404 ;; tag) as its fallback value.
1411 ;; Look for both general keywords and back-end specific
1412 ;; options, with priority given to the latter.
1414 org-export-options-alist)))
1415 ;; Handle other keywords. Then return PLIST.
1429 property
1438 "Return current buffer export options, as a plist.
1440 Optional argument BACKEND, when non-nil, is an export back-end,
1441 as returned by, e.g., `org-export-create-backend'. It specifies
1442 which back-end specific options should also be read in the
1443 process.
1445 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1448 ;; Priority is given to back-end specific options.
1450 org-export-options-alist))
1453 org-export-special-keywords))))
1454 plist to-parse)
1457 ;; Return all properties associated to KEYWORD.
1464 ;; Recursively read keywords in buffer. FILES is
1465 ;; a list of files read so far. PLIST is the current
1466 ;; property list obtained.
1475 ;; Options in `org-export-special-keywords'.
1480 ;; Avoid circular dependencies.
1491 plist
1493 val backend))))
1497 plist
1504 ;; Options in `org-export-options-alist'.
1507 plist
1509 plist property
1510 ;; Handle value depending on specified
1511 ;; BEHAVIOR.
1516 ;; Even if `parse' implies `space'
1517 ;; behavior, we separate line with
1518 ;; "\n" so as to preserve
1519 ;; line-breaks. However, empty
1520 ;; lines are forbidden since `parse'
1521 ;; doesn't allow more than one
1522 ;; paragraph.
1531 " "
1544 ;; Read options in the current buffer and return value.
1546 ;; Parse properties in TO-PARSE. Remove newline characters not
1547 ;; involved in line breaks to simulate `space' behavior.
1548 ;; Finally return options.
1561 "Return properties related to export process, as a plist.
1562 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1563 are like the arguments with the same names of function
1564 `org-export-as'."
1569 :back-end backend
1574 "Return properties related to buffer attributes, as a plist."
1579 "Return global export options as a plist.
1580 Optional argument BACKEND, if non-nil, is an export back-end, as
1581 returned by, e.g., `org-export-create-backend'. It specifies
1582 which back-end specific export options should also be read in the
1583 process."
1585 ;; Priority is given to back-end specific options.
1587 org-export-options-alist)))
1593 plist
1594 prop
1595 ;; Evaluate default value provided.
1600 value)))))))))
1603 "Return variables bound from BIND keywords in current buffer.
1604 Also look for BIND keywords in setup files. The return value is
1605 an alist where associations are (VARIABLE-NAME VALUE)."
1609 ;; Return an alist between variable names and their
1610 ;; value. FILES is a list of setup files names read
1611 ;; so far, used to avoid circular dependencies. ALIST
1612 ;; is the alist collected so far.
1624 ;; Enter setup file.
1636 alist))))))))))
1637 alist)))))
1638 ;; Return value in appropriate order of appearance.
1641 ;; defsubst org-export-get-parent must be defined before first use,
1642 ;; was originally defined in the topology section
1645 "Return BLOB parent or nil.
1646 BLOB is the element or object considered."
1649 ;;;; Tree Properties
1650 ;;
1651 ;; Tree properties are information extracted from parse tree. They
1652 ;; are initialized at the beginning of the transcoding process by
1653 ;; `org-export--collect-tree-properties'.
1654 ;;
1655 ;; Dedicated functions focus on computing the value of specific tree
1656 ;; properties during initialization. Thus,
1657 ;; `org-export--populate-ignore-list' lists elements and objects that
1658 ;; should be skipped during export, `org-export--get-min-level' gets
1659 ;; the minimal exportable level, used as a basis to compute relative
1660 ;; level for headlines. Eventually
1661 ;; `org-export--collect-headline-numbering' builds an alist between
1662 ;; headlines and their numbering.
1665 "Extract tree properties from parse tree.
1667 DATA is the parse tree from which information is retrieved. INFO
1668 is a list holding export options.
1670 Following tree properties are set or updated:
1672 `:headline-offset' Offset between true level of headlines and
1673 local level. An offset of -1 means a headline
1674 of level 2 should be considered as a level
1675 1 headline in the context.
1677 `:headline-numbering' Alist of all headlines as key and the
1678 associated numbering as value.
1680 `:id-alist' Alist of all ID references as key and associated file
1681 as value.
1683 Return updated plist."
1684 ;; Install the parse tree in the communication channel.
1686 ;; Compute `:headline-offset' in order to be able to use
1687 ;; `org-export-get-relative-level'.
1690 :headline-offset
1692 ;; From now on, properties order doesn't matter: get the rest of the
1693 ;; tree properties.
1695 info
1697 :id-alist
1706 "Return minimum exportable headline's level in DATA.
1707 DATA is parsed tree as returned by `org-element-parse-buffer'.
1708 OPTIONS is a plist holding export options."
1717 ;; If no headline was found, for the sake of consistency, set
1718 ;; minimum level to 1 nonetheless.
1722 "Return numbering of all exportable, numbered headlines in a parse tree.
1724 DATA is the parse tree. OPTIONS is the plist holding export
1725 options.
1727 Return an alist whose key is a headline and value is its
1728 associated numbering \(in the shape of a list of numbers) or nil
1729 for a footnotes section."
1738 headline
1740 for n across numbering
1741 for idx from 0 to org-export-max-depth
1745 options)))
1748 "List headlines and inlinetasks with a select tag in their tree.
1749 DATA is parsed data as returned by `org-element-parse-buffer'.
1750 INFO is a plist holding export options."
1753 ;; If FILETAGS contains a select tag, every headline or
1754 ;; inlinetask is returned.
1764 ;; When a select tag is found, mark full
1765 ;; genealogy and every headline within the
1766 ;; tree as acceptable.
1769 genealogy
1772 selected-trees))
1773 ;; If at a headline, continue searching in
1774 ;; tree, recursively.
1783 selected-trees))))
1786 "Non-nil when element or object BLOB should be skipped during export.
1787 OPTIONS is the plist holding export options. SELECTED, when
1788 non-nil, is a list of headlines or inlinetasks belonging to
1789 a tree with a select tag."
1796 ;; If `:with-drawers' value starts with `not', ignore
1797 ;; every drawer whose name belong to that list.
1798 ;; Otherwise, ignore drawers whose name isn't in that
1799 ;; list.
1816 ;; Ignore subtrees with an exclude tag.
1819 ;; When a select tag is present in the buffer, ignore any tree
1820 ;; without it.
1822 ;; Ignore commented sub-trees.
1824 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1826 ;; Ignore tasks, if specified by `:with-tasks' property.
1838 properties-set))))))
1849 ;; `:with-timestamps' only applies to isolated timestamps
1850 ;; objects, i.e. timestamp objects in a paragraph containing only
1851 ;; timestamps and whitespaces.
1859 options t))))
1868 \f
1869 ;;; The Transcoder
1870 ;;
1871 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1872 ;; `org-element-parse-buffer') and transcodes it into a specified
1873 ;; back-end output. It takes care of filtering out elements or
1874 ;; objects according to export options and organizing the output blank
1875 ;; lines and white space are preserved. The function memoizes its
1876 ;; results, so it is cheap to call it within transcoders.
1877 ;;
1878 ;; It is possible to modify locally the back-end used by
1879 ;; `org-export-data' or even use a temporary back-end by using
1880 ;; `org-export-data-with-backend'.
1881 ;;
1882 ;; `org-export-transcoder' is an accessor returning appropriate
1883 ;; translator function for a given element or object.
1886 "Return appropriate transcoder for BLOB.
1887 INFO is a plist containing export directives."
1889 ;; Return contents only for complete parse trees.
1895 "Convert DATA into current back-end format.
1897 DATA is a parse tree, an element or an object or a secondary
1898 string. INFO is a plist holding export options.
1900 Return a string."
1902 ;; Handle broken links according to
1903 ;; `org-export-with-broken-links'.
1919 ;; Ignored element/object.
1921 ;; Plain text.
1927 info))
1928 ;; Secondary string.
1931 ;; Element/Object without contents or, as a special
1932 ;; case, headline with archive tag and archived trees
1933 ;; restricted to title only.
1942 ;; Export snippets never return a nil value so
1943 ;; that white spaces following them are never
1944 ;; ignored.
1946 ;; Element/Object with contents.
1959 ;; Elements directly containing
1960 ;; objects must have their indentation
1961 ;; normalized first.
1963 data
1964 ;; When normalizing contents of the
1965 ;; first paragraph in an item or
1966 ;; a footnote definition, ignore
1967 ;; first line's indentation: there is
1968 ;; none and it might be misleading.
1972 data)
1980 info)))))))))
1981 ;; Final result will be memoized before being returned.
1983 data
1987 ;; Append the same white space between elements or objects
1988 ;; as in the original buffer, and call appropriate filters.
1997 info)))
2001 "Convert DATA into BACKEND format.
2003 DATA is an element, an object, a secondary string or a string.
2004 BACKEND is a symbol. INFO is a plist used as a communication
2005 channel.
2007 Unlike to `org-export-with-backend', this function will
2008 recursively convert DATA using BACKEND translation table."
2010 ;; Set-up a new communication channel with translations defined in
2011 ;; BACKEND as the translate table and a new hash table for
2012 ;; memoization.
2015 info
2018 ;; Size of the hash table is reduced since this
2019 ;; function will probably be used on small trees.
2022 ;; Preserve `:internal-references', as those do not depend on
2023 ;; the back-end used; we need to make sure that any new
2024 ;; reference when the temporary back-end was active gets through
2025 ;; the default one.
2030 "Expand a parsed element or object to its original state.
2032 BLOB is either an element or an object. CONTENTS is its
2033 contents, as a string or nil.
2035 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2036 keywords before output."
2042 blob contents))))
2045 \f
2046 ;;; The Filter System
2047 ;;
2048 ;; Filters allow end-users to tweak easily the transcoded output.
2049 ;; They are the functional counterpart of hooks, as every filter in
2050 ;; a set is applied to the return value of the previous one.
2051 ;;
2052 ;; Every set is back-end agnostic. Although, a filter is always
2053 ;; called, in addition to the string it applies to, with the back-end
2054 ;; used as argument, so it's easy for the end-user to add back-end
2055 ;; specific filters in the set. The communication channel, as
2056 ;; a plist, is required as the third argument.
2057 ;;
2058 ;; From the developer side, filters sets can be installed in the
2059 ;; process with the help of `org-export-define-backend', which
2060 ;; internally stores filters as an alist. Each association has a key
2061 ;; among the following symbols and a function or a list of functions
2062 ;; as value.
2063 ;;
2064 ;; - `:filter-options' applies to the property list containing export
2065 ;; options. Unlike to other filters, functions in this list accept
2066 ;; two arguments instead of three: the property list containing
2067 ;; export options and the back-end. Users can set its value through
2068 ;; `org-export-filter-options-functions' variable.
2069 ;;
2070 ;; - `:filter-parse-tree' applies directly to the complete parsed
2071 ;; tree. Users can set it through
2072 ;; `org-export-filter-parse-tree-functions' variable.
2073 ;;
2074 ;; - `:filter-body' applies to the body of the output, before template
2075 ;; translator chimes in. Users can set it through
2076 ;; `org-export-filter-body-functions' variable.
2077 ;;
2078 ;; - `:filter-final-output' applies to the final transcoded string.
2079 ;; Users can set it with `org-export-filter-final-output-functions'
2080 ;; variable.
2081 ;;
2082 ;; - `:filter-plain-text' applies to any string not recognized as Org
2083 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2084 ;; configure it.
2085 ;;
2086 ;; - `:filter-TYPE' applies on the string returned after an element or
2087 ;; object of type TYPE has been transcoded. A user can modify
2088 ;; `org-export-filter-TYPE-functions' to install these filters.
2089 ;;
2090 ;; All filters sets are applied with
2091 ;; `org-export-filter-apply-functions' function. Filters in a set are
2092 ;; applied in a LIFO fashion. It allows developers to be sure that
2093 ;; their filters will be applied first.
2094 ;;
2095 ;; Filters properties are installed in communication channel with
2096 ;; `org-export-install-filters' function.
2097 ;;
2098 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2099 ;; `org-export-before-parsing-hook') are run at the beginning of the
2100 ;; export process and just before parsing to allow for heavy structure
2101 ;; modifications.
2104 ;;;; Hooks
2107 "Hook run at the beginning of the export process.
2109 This is run before include keywords and macros are expanded and
2110 Babel code blocks executed, on a copy of the original buffer
2111 being exported. Visibility and narrowing are preserved. Point
2112 is at the beginning of the buffer.
2114 Every function in this hook will be called with one argument: the
2118 "Hook run before parsing an export buffer.
2120 This is run after include keywords and macros have been expanded
2121 and Babel code blocks executed, on a copy of the original buffer
2122 being exported. Visibility and narrowing are preserved. Point
2123 is at the beginning of the buffer.
2125 Every function in this hook will be called with one argument: the
2129 ;;;; Special Filters
2132 "List of functions applied to the export options.
2133 Each filter is called with two arguments: the export options, as
2134 a plist, and the back-end, as a symbol. It must return
2138 "List of functions applied to the parsed tree.
2139 Each filter is called with three arguments: the parse tree, as
2140 returned by `org-element-parse-buffer', the back-end, as
2141 a symbol, and the communication channel, as a plist. It must
2145 "List of functions applied to plain text.
2146 Each filter is called with three arguments: a string which
2147 contains no Org syntax, the back-end, as a symbol, and the
2148 communication channel, as a plist. It must return a string or
2152 "List of functions applied to transcoded body.
2153 Each filter is called with three arguments: a string which
2154 contains no Org syntax, the back-end, as a symbol, and the
2155 communication channel, as a plist. It must return a string or
2159 "List of functions applied to the transcoded string.
2160 Each filter is called with three arguments: the full transcoded
2161 string, the back-end, as a symbol, and the communication channel,
2162 as a plist. It must return a string that will be used as the
2166 ;;;; Elements Filters
2169 "List of functions applied to a transcoded babel-call.
2170 Each filter is called with three arguments: the transcoded data,
2171 as a string, the back-end, as a symbol, and the communication
2175 "List of functions applied to a transcoded center block.
2176 Each filter is called with three arguments: the transcoded data,
2177 as a string, the back-end, as a symbol, and the communication
2181 "List of functions applied to a transcoded clock.
2182 Each filter is called with three arguments: the transcoded data,
2183 as a string, the back-end, as a symbol, and the communication
2187 "List of functions applied to a transcoded diary-sexp.
2188 Each filter is called with three arguments: the transcoded data,
2189 as a string, the back-end, as a symbol, and the communication
2193 "List of functions applied to a transcoded drawer.
2194 Each filter is called with three arguments: the transcoded data,
2195 as a string, the back-end, as a symbol, and the communication
2199 "List of functions applied to a transcoded dynamic-block.
2200 Each filter is called with three arguments: the transcoded data,
2201 as a string, the back-end, as a symbol, and the communication
2205 "List of functions applied to a transcoded example-block.
2206 Each filter is called with three arguments: the transcoded data,
2207 as a string, the back-end, as a symbol, and the communication
2211 "List of functions applied to a transcoded export-block.
2212 Each filter is called with three arguments: the transcoded data,
2213 as a string, the back-end, as a symbol, and the communication
2217 "List of functions applied to a transcoded fixed-width.
2218 Each filter is called with three arguments: the transcoded data,
2219 as a string, the back-end, as a symbol, and the communication
2223 "List of functions applied to a transcoded footnote-definition.
2224 Each filter is called with three arguments: the transcoded data,
2225 as a string, the back-end, as a symbol, and the communication
2229 "List of functions applied to a transcoded headline.
2230 Each filter is called with three arguments: the transcoded data,
2231 as a string, the back-end, as a symbol, and the communication
2235 "List of functions applied to a transcoded horizontal-rule.
2236 Each filter is called with three arguments: the transcoded data,
2237 as a string, the back-end, as a symbol, and the communication
2241 "List of functions applied to a transcoded inlinetask.
2242 Each filter is called with three arguments: the transcoded data,
2243 as a string, the back-end, as a symbol, and the communication
2247 "List of functions applied to a transcoded item.
2248 Each filter is called with three arguments: the transcoded data,
2249 as a string, the back-end, as a symbol, and the communication
2253 "List of functions applied to a transcoded keyword.
2254 Each filter is called with three arguments: the transcoded data,
2255 as a string, the back-end, as a symbol, and the communication
2259 "List of functions applied to a transcoded latex-environment.
2260 Each filter is called with three arguments: the transcoded data,
2261 as a string, the back-end, as a symbol, and the communication
2265 "List of functions applied to a transcoded node-property.
2266 Each filter is called with three arguments: the transcoded data,
2267 as a string, the back-end, as a symbol, and the communication
2271 "List of functions applied to a transcoded paragraph.
2272 Each filter is called with three arguments: the transcoded data,
2273 as a string, the back-end, as a symbol, and the communication
2277 "List of functions applied to a transcoded plain-list.
2278 Each filter is called with three arguments: the transcoded data,
2279 as a string, the back-end, as a symbol, and the communication
2283 "List of functions applied to a transcoded planning.
2284 Each filter is called with three arguments: the transcoded data,
2285 as a string, the back-end, as a symbol, and the communication
2289 "List of functions applied to a transcoded property-drawer.
2290 Each filter is called with three arguments: the transcoded data,
2291 as a string, the back-end, as a symbol, and the communication
2295 "List of functions applied to a transcoded quote block.
2296 Each filter is called with three arguments: the transcoded quote
2297 data, as a string, the back-end, as a symbol, and the
2298 communication channel, as a plist. It must return a string or
2302 "List of functions applied to a transcoded section.
2303 Each filter is called with three arguments: the transcoded data,
2304 as a string, the back-end, as a symbol, and the communication
2308 "List of functions applied to a transcoded special block.
2309 Each filter is called with three arguments: the transcoded data,
2310 as a string, the back-end, as a symbol, and the communication
2314 "List of functions applied to a transcoded src-block.
2315 Each filter is called with three arguments: the transcoded data,
2316 as a string, the back-end, as a symbol, and the communication
2320 "List of functions applied to a transcoded table.
2321 Each filter is called with three arguments: the transcoded data,
2322 as a string, the back-end, as a symbol, and the communication
2326 "List of functions applied to a transcoded table-cell.
2327 Each filter is called with three arguments: the transcoded data,
2328 as a string, the back-end, as a symbol, and the communication
2332 "List of functions applied to a transcoded table-row.
2333 Each filter is called with three arguments: the transcoded data,
2334 as a string, the back-end, as a symbol, and the communication
2338 "List of functions applied to a transcoded verse block.
2339 Each filter is called with three arguments: the transcoded data,
2340 as a string, the back-end, as a symbol, and the communication
2344 ;;;; Objects Filters
2347 "List of functions applied to transcoded bold text.
2348 Each filter is called with three arguments: the transcoded data,
2349 as a string, the back-end, as a symbol, and the communication
2353 "List of functions applied to transcoded code text.
2354 Each filter is called with three arguments: the transcoded data,
2355 as a string, the back-end, as a symbol, and the communication
2359 "List of functions applied to a transcoded entity.
2360 Each filter is called with three arguments: the transcoded data,
2361 as a string, the back-end, as a symbol, and the communication
2365 "List of functions applied to a transcoded export-snippet.
2366 Each filter is called with three arguments: the transcoded data,
2367 as a string, the back-end, as a symbol, and the communication
2371 "List of functions applied to a transcoded footnote-reference.
2372 Each filter is called with three arguments: the transcoded data,
2373 as a string, the back-end, as a symbol, and the communication
2377 "List of functions applied to a transcoded inline-babel-call.
2378 Each filter is called with three arguments: the transcoded data,
2379 as a string, the back-end, as a symbol, and the communication
2383 "List of functions applied to a transcoded inline-src-block.
2384 Each filter is called with three arguments: the transcoded data,
2385 as a string, the back-end, as a symbol, and the communication
2389 "List of functions applied to transcoded italic text.
2390 Each filter is called with three arguments: the transcoded data,
2391 as a string, the back-end, as a symbol, and the communication
2395 "List of functions applied to a transcoded latex-fragment.
2396 Each filter is called with three arguments: the transcoded data,
2397 as a string, the back-end, as a symbol, and the communication
2401 "List of functions applied to a transcoded line-break.
2402 Each filter is called with three arguments: the transcoded data,
2403 as a string, the back-end, as a symbol, and the communication
2407 "List of functions applied to a transcoded link.
2408 Each filter is called with three arguments: the transcoded data,
2409 as a string, the back-end, as a symbol, and the communication
2413 "List of functions applied to a transcoded radio-target.
2414 Each filter is called with three arguments: the transcoded data,
2415 as a string, the back-end, as a symbol, and the communication
2419 "List of functions applied to a transcoded statistics-cookie.
2420 Each filter is called with three arguments: the transcoded data,
2421 as a string, the back-end, as a symbol, and the communication
2425 "List of functions applied to transcoded strike-through text.
2426 Each filter is called with three arguments: the transcoded data,
2427 as a string, the back-end, as a symbol, and the communication
2431 "List of functions applied to a transcoded subscript.
2432 Each filter is called with three arguments: the transcoded data,
2433 as a string, the back-end, as a symbol, and the communication
2437 "List of functions applied to a transcoded superscript.
2438 Each filter is called with three arguments: the transcoded data,
2439 as a string, the back-end, as a symbol, and the communication
2443 "List of functions applied to a transcoded target.
2444 Each filter is called with three arguments: the transcoded data,
2445 as a string, the back-end, as a symbol, and the communication
2449 "List of functions applied to a transcoded timestamp.
2450 Each filter is called with three arguments: the transcoded data,
2451 as a string, the back-end, as a symbol, and the communication
2455 "List of functions applied to transcoded underline text.
2456 Each filter is called with three arguments: the transcoded data,
2457 as a string, the back-end, as a symbol, and the communication
2461 "List of functions applied to transcoded verbatim text.
2462 Each filter is called with three arguments: the transcoded data,
2463 as a string, the back-end, as a symbol, and the communication
2467 ;;;; Filters Tools
2468 ;;
2469 ;; Internal function `org-export-install-filters' installs filters
2470 ;; hard-coded in back-ends (developer filters) and filters from global
2471 ;; variables (user filters) in the communication channel.
2472 ;;
2473 ;; Internal function `org-export-filter-apply-functions' takes care
2474 ;; about applying each filter in order to a given data. It ignores
2475 ;; filters returning a nil value but stops whenever a filter returns
2476 ;; an empty string.
2479 "Call every function in FILTERS.
2481 Functions are called with three arguments: a value, the export
2482 back-end name and the communication channel. First function in
2483 FILTERS is called with VALUE as its first argument. Second
2484 function in FILTERS is called with the previous result as its
2485 value, etc.
2487 Functions returning nil are skipped. Any function returning the
2488 empty string ends the process, which returns the empty string.
2490 Call is done in a LIFO fashion, to be sure that developer
2491 specified filters, if any, are called first."
2502 "Install filters properties in communication channel.
2503 INFO is a plist containing the current communication channel.
2504 Return the updated communication channel."
2506 ;; Install user-defined filters with `org-export-filters-alist'
2507 ;; and filters already in INFO (through ext-plist mechanism).
2514 ;; Filters in INFO will be called
2515 ;; before those user provided.
2518 default-value)))))
2519 ;; Prepend back-end specific filters to that list.
2521 ;; Single values get consed, lists are appended.
2526 plist key
2529 ;; Return new communication channel.
2533 \f
2534 ;;; Core functions
2535 ;;
2536 ;; This is the room for the main function, `org-export-as', along with
2537 ;; its derivative, `org-export-string-as'.
2538 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2539 ;; function should be added to kill ring.
2540 ;;
2541 ;; Note that `org-export-as' doesn't really parse the current buffer,
2542 ;; but a copy of it (with the same buffer-local variables and
2543 ;; visibility), where macros and include keywords are expanded and
2544 ;; Babel blocks are executed, if appropriate.
2545 ;; `org-export-with-buffer-copy' macro prepares that copy.
2546 ;;
2547 ;; File inclusion is taken care of by
2548 ;; `org-export-expand-include-keyword' and
2549 ;; `org-export--prepare-file-contents'. Structure wise, including
2550 ;; a whole Org file in a buffer often makes little sense. For
2551 ;; example, if the file contains a headline and the include keyword
2552 ;; was within an item, the item should contain the headline. That's
2553 ;; why file inclusion should be done before any structure can be
2554 ;; associated to the file, that is before parsing.
2555 ;;
2556 ;; `org-export-insert-default-template' is a command to insert
2557 ;; a default template (or a back-end specific template) at point or in
2558 ;; current subtree.
2561 "Return a copy of the current buffer.
2562 The copy preserves Org buffer-local variables, visibility and
2563 narrowing."
2569 new-buf))
2572 "Apply BODY in a copy of the current buffer.
2573 The copy preserves local variables, visibility and contents of
2574 the original buffer. Point is at the beginning of the buffer
2575 when BODY is applied."
2584 ;; Kill copy without confirmation.
2590 "Generate a function duplicating BUFFER.
2592 The copy will preserve local variables, visibility, contents and
2593 narrowing of the original buffer. If a region was active in
2594 BUFFER, contents will be narrowed to that region instead.
2596 The resulting function can be evaluated at a later time, from
2597 another buffer, effectively cloning the original buffer there.
2599 The function assumes BUFFER's major mode is `org-mode'."
2603 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2604 ;; already in BUFFER.
2606 ;; Copy specific buffer local variables and variables set
2607 ;; through BIND keywords.
2609 vars)
2617 buffer-file-name
2618 buffer-file-coding-system))
2622 ;; Skip unreadable values, as they cannot be
2623 ;; sent to external process.
2627 vars))))))
2628 ;; Whole buffer contents.
2633 ;; Narrowing.
2637 ;; Current position of point.
2639 ;; Overlays with invisible property.
2648 ov-set)))))))))
2651 "Delete commented areas in the buffer.
2652 Commented areas are comments, comment blocks, commented trees and
2653 inlinetasks. Trailing blank lines after a comment or a comment
2654 block are removed, as long as it doesn't alter the structure of
2655 the document. Narrowing, if any, is ignored."
2661 comment-re)))
2673 ;; We remove trailing blank lines. Doing so could
2674 ;; modify the structure of the document. Therefore
2675 ;; we ensure that any comment between elements is
2676 ;; replaced with one empty line, so as to keep them
2677 ;; separated.
2683 start)
2685 end)
2695 "Prune non exportable elements from DATA.
2696 DATA is the parse tree to traverse. INFO is the plist holding
2697 export info. Also set `:ignore-list' in INFO to a list of
2698 objects which should be ignored during export, but not removed
2699 from tree."
2701 ;; First find trees containing a select tag, if any.
2705 ;; Prune non-exportable elements and objects from tree.
2706 ;; As a special case, special rows and cells from tables
2707 ;; are stored in IGNORE, as they still need to be
2708 ;; accessed during export.
2718 ;; If headline is archived but tree below has
2719 ;; to be skipped, remove contents.
2721 ;; Move into recursive objects/elements.
2723 ;; Move into secondary string, if any.
2725 org-element-secondary-value-alist)))
2728 ;; Collect definitions before possibly pruning them so as
2729 ;; to avoid parsing them again if they are required.
2738 #'org-element-create
2741 ;; If a select tag is active, also ignore the section before the
2742 ;; first headline, if any.
2747 ;; Prune tree and communication channel.
2750 ;; Priority is given to back-end specific options.
2752 org-export-options-alist))
2758 ;; Eventually set `:ignore-list'.
2762 "List footnote definitions missing from TREE.
2763 Missing definitions are searched within DEFINITIONS, which is
2764 a list of footnote definitions or in the widened buffer."
2767 ;; List all footnote labels encountered in DATA. Inline
2768 ;; footnote references are ignored.
2773 defined undefined missing-definitions)
2774 ;; Partition DIRECT-REFERENCES between DEFINED and UNDEFINED
2775 ;; references.
2782 seen)
2787 ;; Complete MISSING-DEFINITIONS by finding the definition of every
2788 ;; undefined label, first by looking into DEFINITIONS, then by
2789 ;; searching the widened buffer. This is a recursive process
2790 ;; since definitions found can themselves contain an undefined
2791 ;; reference.
2798 d))
2799 definitions))
2806 datum
2807 ;; Parse definition with contents.
2818 ;; Look for footnote references within DEFINITION, since
2819 ;; we may need to also find their definition.
2824 ;; MISSING-DEFINITIONS may contain footnote references with inline
2825 ;; definitions. Make sure those are changed into real footnote
2826 ;; definitions.
2833 missing-definitions)))
2836 "Install footnote definitions in tree.
2838 DEFINITIONS is the list of footnote definitions to install. TREE
2839 is the parse tree.
2841 If there is a footnote section in TREE, definitions found are
2842 appended to it. If `org-footnote-section' is non-nil, a new
2843 footnote section containing all definitions is inserted in TREE.
2844 Otherwise, definitions are appended at the end of the section
2845 containing their first reference."
2848 ;; If there is a footnote section, insert definitions there.
2852 nil t)))
2855 footnote-section
2857 ;; If there should be a footnote section, create one containing all
2858 ;; the definitions at the end of the tree.
2861 tree
2867 'section
2868 nil
2870 ;; Otherwise add each definition at the end of the section where it
2871 ;; is first referenced.
2876 ;; Insert footnote definitions in the same section as
2877 ;; their first reference in DATA.
2888 label)
2889 d))
2890 definitions)))
2893 definition)
2894 ;; Also insert definitions for nested
2895 ;; references, if any.
2900 "Change uninterpreted elements back into Org syntax.
2901 DATA is the parse tree. INFO is a plist containing export
2902 options. Each uninterpreted element or object is changed back
2903 into a string. Contents, if any, are not modified. The parse
2904 tree is modified by side effect."
2910 p
2913 info))))))
2916 "Change uninterpreted elements back into Org syntax.
2917 DATA is a parse tree or a secondary string. INFO is a plist
2918 containing export options. It is modified by side effect and
2919 returned by the function."
2922 subscript superscript underline)
2926 ;; ... entities...
2933 ?\s)))))
2934 ;; ... emphasis...
2946 marker
2950 ?\s)))))))
2951 ;; ... LaTeX environments and fragments...
2955 ;; ... sub/superscripts...
2964 "_"
2973 ?\s)))))))))))
2975 ;; Splice NEW at BLOB location in parse tree.
2978 info nil nil t)
2979 ;; Return modified parse tree.
2980 data)
2982 ;;;###autoload
2985 "Transcode current Org buffer into BACKEND code.
2987 BACKEND is either an export back-end, as returned by, e.g.,
2988 `org-export-create-backend', or a symbol referring to
2989 a registered back-end.
2991 If narrowing is active in the current buffer, only transcode its
2992 narrowed part.
2994 If a region is active, transcode that region.
2996 When optional argument SUBTREEP is non-nil, transcode the
2997 sub-tree at point, extracting information from the headline
2998 properties first.
3000 When optional argument VISIBLE-ONLY is non-nil, don't export
3001 contents of hidden elements.
3003 When optional argument BODY-ONLY is non-nil, only return body
3004 code, without surrounding template.
3006 Optional argument EXT-PLIST, when provided, is a property list
3007 with external parameters overriding Org default settings, but
3008 still inferior to file-local settings.
3010 Return code as a string."
3015 ;; Narrow buffer to an appropriate region or subtree for
3016 ;; parsing. If parsing subtree, be sure to remove main
3017 ;; headline, planning data and property drawer.
3025 ;; Initialize communication channel with original buffer
3026 ;; attributes, unavailable in its copy.
3030 backend subtreep visible-only body-only)
3036 org-export-options-alist))))
3037 tree)
3038 ;; Update communication channel and get parse tree. Buffer
3039 ;; isn't parsed directly. Instead, all buffer modifications
3040 ;; and consequent parsing are undertaken in a temporary copy.
3042 ;; Run first hook with current back-end's name as argument.
3045 ;; Include files, delete comments and expand macros.
3050 ;; Refresh buffer properties and radio targets after
3051 ;; potentially invasive previous changes. Likewise, do it
3052 ;; again after executing Babel code.
3059 ;; Run last hook with current back-end's name as argument.
3060 ;; Update buffer properties and radio targets one last time
3061 ;; before parsing.
3068 ;; Update communication channel with environment. Also
3069 ;; install user's and developer's filters.
3074 ;; Call options filters and update export options. We do not
3075 ;; use `org-export-filter-apply-functions' here since the
3076 ;; arity of such filters is different.
3081 ;; Expand export-specific set of macros: {{{author}}},
3082 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
3083 ;; be done once regular macros have been expanded, since
3084 ;; parsed keywords may contain one of them.
3097 value)
3098 value)))
3102 'finalize
3103 parsed-keywords)
3104 ;; Parse buffer.
3106 ;; Prune tree from non-exported elements and transform
3107 ;; uninterpreted elements or objects in both parse tree and
3108 ;; communication channel.
3111 ;; Call parse tree filters.
3115 ;; Now tree is complete, compute its properties and add them
3116 ;; to communication channel.
3118 ;; Eventually transcode TREE. Wrap the resulting string into
3119 ;; a template.
3128 info))
3131 ;; Remove all text properties since they cannot be
3132 ;; retrieved from an external process. Finally call
3133 ;; final-output filter and return result.
3139 info))))))))
3141 ;;;###autoload
3143 "Transcode STRING into BACKEND code.
3145 BACKEND is either an export back-end, as returned by, e.g.,
3146 `org-export-create-backend', or a symbol referring to
3147 a registered back-end.
3149 When optional argument BODY-ONLY is non-nil, only return body
3150 code, without preamble nor postamble.
3152 Optional argument EXT-PLIST, when provided, is a property list
3153 with external parameters overriding Org default settings, but
3154 still inferior to file-local settings.
3156 Return code as a string."
3162 ;;;###autoload
3164 "Replace the active region by its export to BACKEND.
3165 BACKEND is either an export back-end, as returned by, e.g.,
3166 `org-export-create-backend', or a symbol referring to
3167 a registered back-end."
3173 ;;;###autoload
3175 "Insert all export keywords with default values at beginning of line.
3177 BACKEND is a symbol referring to the name of a registered export
3178 back-end, for which specific export options should be added to
3179 the template, or `default' for default template. When it is nil,
3180 the user will be prompted for a category.
3182 If SUBTREEP is non-nil, export configuration will be set up
3183 locally for the subtree through node properties."
3193 "Options category: "
3197 org-export-registered-backends))
3198 nil t))))
3199 options keywords)
3200 ;; Populate OPTIONS and KEYWORDS.
3217 ;; Move to an appropriate location in order to insert options.
3219 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3237 ;; Then the rest of keywords, in the order specified in either
3238 ;; `org-export-options-alist' or respective export back-ends.
3259 "Expand every include keyword in buffer.
3260 Optional argument INCLUDED is a list of included file names along
3261 with their line restriction, when appropriate. It is used to
3262 avoid infinite recursion. Optional argument DIR is the current
3263 working directory. It is used to properly resolve relative
3264 paths. Optional argument FOOTNOTES is a hash-table used for
3265 storing and resolving footnotes. It is created automatically."
3271 ;; If :minlevel is not set the text-property
3272 ;; `:org-include-induced-level' will be used to determine the
3273 ;; relative level when expanding INCLUDE.
3274 ;; Only affects included Org documents.
3278 :org-include-induced-level
3280 ;; Expand INCLUDE keywords.
3286 ;; Extract arguments from keyword's value.
3289 location
3297 matched)
3303 dir)))
3307 value)
3313 value)
3322 ;; Minimal level of included file defaults to the child
3323 ;; level of the current headline, if any, or one. It
3324 ;; only applies is the file is meant to be included as
3325 ;; an Org one.
3336 ;; Remove keyword.
3342 ;; Check if files has already been parsed. Look after
3343 ;; inclusion lines too, as different parts of the same file
3344 ;; can be included too.
3357 ind-str block arg-str contents ind-str block))))
3364 ind-str block contents ind-str block))))
3372 file location only-contents lines)
3373 lines)))
3377 file lines ind minlevel
3380 footnotes)))
3384 footnotes)
3386 ;; Expand footnotes after all files have been included.
3387 ;; Footnotes are stored at end of buffer.
3392 footnotes)))))))))))
3395 "Resolve absolute lines for an included file with file-link.
3397 FILE is string file-name of the file to include. LOCATION is a
3398 string name within FILE to be included (located via
3399 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3400 contents of the named element will be included, as determined
3401 Org-Element. If LINES is non-nil only those lines are included.
3403 Return a string of lines to be included in the format expected by
3404 `org-export--prepare-file-contents'."
3410 ;; Enforce consistent search.
3423 ;; Skip planning line and property-drawer.
3449 start-line
3451 (+ start-line
3454 counter))))))))
3458 "Prepare contents of FILE for inclusion and return it as a string.
3460 When optional argument LINES is a string specifying a range of
3461 lines, include only those lines.
3463 Optional argument IND, when non-nil, is an integer specifying the
3464 global indentation of returned contents. Since its purpose is to
3465 allow an included file to stay in the same environment it was
3466 created (e.g., a list item), it doesn't apply past the first
3467 headline encountered.
3469 Optional argument MINLEVEL, when non-nil, is an integer
3470 specifying the level that any top-level headline in the included
3471 file should have.
3473 Optional argument ID is an integer that will be inserted before
3474 each footnote definition and reference if FILE is an Org file.
3475 This is useful to avoid conflicts when more than one Org file
3476 with footnotes is included in a document.
3478 Optional argument FOOTNOTES is a hash-table to store footnotes in
3479 the included document."
3495 ;; Remove blank lines at beginning and end of contents. The logic
3496 ;; behind that removal is that blank lines around include keyword
3497 ;; override blank lines in included file.
3506 ;; If IND is set, preserve indentation of include keyword until
3507 ;; the first headline encountered.
3514 ;; Do not move footnote definitions out of column 0.
3520 ;; When MINLEVEL is specified, compute minimal level for headlines
3521 ;; in the file (CUR-MIN), and remove stars to each headline so
3522 ;; that headlines with minimal level have a level of MINLEVEL.
3533 ;; Only change stars, don't bother moving whole
3534 ;; sections.
3539 ;; Append ID to all footnote references and definitions, so they
3540 ;; become file specific and cannot collide with footnotes in other
3541 ;; included files. Further, collect relevant footnote definitions
3542 ;; outside of LINES, in order to reintroduce them later.
3548 ;; Generate new label from LABEL by prefixing it with
3549 ;; "-ID-".
3553 ;; Replace OLD label with NEW in footnote F.
3567 ;; Update the footnote-reference at point and collect
3568 ;; the new label, which is only used for footnotes
3569 ;; outsides LINES.
3581 ;; Store since footnote-definition is
3582 ;; outside of LINES.
3585 footnotes))))
3592 "Return a non-nil value when output should be added to the kill ring.
3593 See also `org-export-copy-to-kill-ring'."
3599 \f
3600 ;;; Tools For Back-Ends
3601 ;;
3602 ;; A whole set of tools is available to help build new exporters. Any
3603 ;; function general enough to have its use across many back-ends
3604 ;; should be added here.
3606 ;;;; For Affiliated Keywords
3607 ;;
3608 ;; `org-export-read-attribute' reads a property from a given element
3609 ;; as a plist. It can be used to normalize affiliated keywords'
3610 ;; syntax.
3611 ;;
3612 ;; Since captions can span over multiple lines and accept dual values,
3613 ;; their internal representation is a bit tricky. Therefore,
3614 ;; `org-export-get-caption' transparently returns a given element's
3615 ;; caption as a secondary string.
3618 "Turn ATTRIBUTE property from ELEMENT into a plist.
3620 When optional argument PROPERTY is non-nil, return the value of
3621 that property within attributes.
3625 properties.
3627 All values will become strings except the empty string and
3630 will become the empty string."
3644 s)
3649 ;; Ignore any string before first property with `cdr'.
3654 "Return caption from ELEMENT as a secondary string.
3656 When optional argument SHORTP is non-nil, return short caption,
3657 as a secondary string, instead.
3659 Caption lines are separated by a white space."
3667 ;;;; For Derived Back-ends
3668 ;;
3669 ;; `org-export-with-backend' is a function allowing to locally use
3670 ;; another back-end to transcode some object or element. In a derived
3671 ;; back-end, it may be used as a fall-back function once all specific
3672 ;; cases have been treated.
3675 "Call a transcoder from BACKEND on DATA.
3676 BACKEND is an export back-end, as returned by, e.g.,
3677 `org-export-create-backend', or a symbol referring to
3678 a registered back-end. DATA is an Org element, object, secondary
3679 string or string. CONTENTS, when non-nil, is the transcoded
3680 contents of DATA element, as a string. INFO, when non-nil, is
3681 the communication channel used for export, as a plist."
3692 :back-end backend
3693 :translate-alist all-transcoders
3695 ;; `:internal-references' are shared across back-ends.
3701 ;;;; For Export Snippets
3702 ;;
3703 ;; Every export snippet is transmitted to the back-end. Though, the
3704 ;; latter will only retain one type of export-snippet, ignoring
3705 ;; others, based on the former's target back-end. The function
3706 ;; `org-export-snippet-backend' returns that back-end for a given
3707 ;; export-snippet.
3710 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3711 Translation, with `org-export-snippet-translation-alist', is
3712 applied."
3716 back-end))))
3719 ;;;; For Footnotes
3720 ;;
3721 ;; `org-export-collect-footnote-definitions' is a tool to list
3722 ;; actually used footnotes definitions in the whole parse tree, or in
3723 ;; a headline, in order to add footnote listings throughout the
3724 ;; transcoded data.
3725 ;;
3726 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3727 ;; back-ends, when they need to attach the footnote definition only to
3728 ;; the first occurrence of the corresponding label.
3729 ;;
3730 ;; `org-export-get-footnote-definition' and
3731 ;; `org-export-get-footnote-number' provide easier access to
3732 ;; additional information relative to a footnote reference.
3735 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3736 INFO is the plist used as a communication channel. If no such
3737 definition can be found, raise an error."
3743 hash))))
3751 ;; Skip any footnote with a different label.
3752 ;; Also skip any standard footnote reference
3753 ;; with the same label since those cannot
3754 ;; contain a definition.
3758 ;; Even if the contents are empty, we can not
3759 ;; return nil since that would eventually raise
3760 ;; the error. Instead, return the equivalent
3761 ;; empty string.
3763 info t)
3764 cache)
3769 "Apply FUNCTION on every footnote reference in DATA.
3770 INFO is a plist containing export state. By default, as soon as
3771 a new footnote reference is encountered, FUNCTION is called onto
3772 its definition. However, if BODY-FIRST is non-nil, this step is
3773 delayed until the end of the process."
3778 ;; Search footnote references through DATA, filling
3779 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3780 ;; store footnote definitions so they can be entered
3781 ;; later.
3788 ;; Search for subsequent references in footnote
3789 ;; definition so numbering follows reading
3790 ;; logic, unless DELAYP in non-nil.
3794 definitions))
3795 ;; Do not force entering inline definitions,
3796 ;; since `org-element-map' already traverses
3797 ;; them at the right time.
3801 nil))))))
3802 info nil
3803 ;; Don't enter footnote definitions since it will
3804 ;; happen when their first reference is found.
3805 ;; Moreover, if DELAYP is non-nil, make sure we
3806 ;; postpone entering definitions of inline references.
3813 "Return an alist between footnote numbers, labels and definitions.
3815 INFO is the current export state, as a plist.
3817 Definitions are collected throughout the whole parse tree, or
3818 DATA when non-nil.
3820 Sorting is done by order of references. As soon as a new
3821 reference is encountered, other references are searched within
3822 its definition. However, if BODY-FIRST is non-nil, this step is
3823 delayed after the whole tree is checked. This alters results
3824 when references are found in footnote definitions.
3826 Definitions either appear as Org data or as a secondary string
3827 for inlined footnotes. Unreferenced definitions are ignored."
3831 ;; Collect footnote number, label and definition.
3842 "Non-nil when a footnote reference is the first one for its label.
3844 FOOTNOTE-REFERENCE is the footnote reference being considered.
3845 INFO is a plist containing current export state.
3847 Search is done throughout the whole parse tree, or DATA when
3848 non-nil.
3850 By default, as soon as a new footnote reference is encountered,
3851 other references are searched within its definition. However, if
3852 BODY-FIRST is non-nil, this step is delayed after the whole tree
3853 is checked. This alters results when references are found in
3854 footnote definitions."
3856 ;; Anonymous footnotes are always a first reference.
3867 "Return number associated to a footnote.
3869 FOOTNOTE is either a footnote reference or a footnote definition.
3870 INFO is the plist containing export state.
3872 Number is unique throughout the whole parse tree, or DATA, when
3873 non-nil.
3875 By default, as soon as a new footnote reference is encountered,
3876 counting process moves into its definition. However, if
3877 BODY-FIRST is non-nil, this step is delayed until the end of the
3878 process, leading to a different order when footnotes are nested."
3887 ;; Anonymous footnote match: return number.
3889 ;; Labels match: return number.
3891 ;; Otherwise store label and increase counter if label
3892 ;; wasn't encountered yet.
3898 ;;;; For Headlines
3899 ;;
3900 ;; `org-export-get-relative-level' is a shortcut to get headline
3901 ;; level, relatively to the lower headline level in the parsed tree.
3902 ;;
3903 ;; `org-export-get-headline-number' returns the section number of an
3904 ;; headline, while `org-export-number-to-roman' allows it to be
3905 ;; converted to roman numbers. With an optional argument,
3906 ;; `org-export-get-headline-number' returns a number to unnumbered
3907 ;; headlines (used for internal id).
3908 ;;
3909 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3910 ;; `org-export-last-sibling-p' are three useful predicates when it
3911 ;; comes to fulfill the `:headline-levels' property.
3912 ;;
3913 ;; `org-export-get-tags', `org-export-get-category' and
3914 ;; `org-export-get-node-property' extract useful information from an
3915 ;; headline or a parent headline. They all handle inheritance.
3916 ;;
3917 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3918 ;; as a secondary string, suitable for table of contents. It falls
3919 ;; back onto default title.
3922 "Return HEADLINE relative level within current parsed tree.
3923 INFO is a plist holding contextual information."
3928 "Non-nil when HEADLINE is considered as low level.
3930 INFO is a plist used as a communication channel.
3932 A low level headlines has a relative level greater than
3933 `:headline-levels' property value.
3935 Return value is the difference between HEADLINE relative level
3936 and the last level being considered as high enough, or nil."
3943 "Return numbered HEADLINE numbering as a list of numbers.
3944 INFO is a plist holding contextual information."
3949 "Return a non-nil value if HEADLINE element should be numbered.
3950 INFO is a plist used as a communication channel."
3959 "Convert integer N into a roman numeral."
3972 res)))
3975 "Return list of tags associated to ELEMENT.
3977 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3978 is a plist used as a communication channel.
3980 When non-nil, optional argument TAGS should be a list of strings.
3981 Any tag belonging to this list will also be removed.
3983 When optional argument INHERITED is non-nil, tags can also be
3984 inherited from parent headlines and FILETAGS keywords."
3988 ;; Build complete list of inherited tags.
3995 ;; Add FILETAGS keywords and return results.
3999 "Return node PROPERTY value for BLOB.
4001 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
4002 element or object.
4004 If optional argument INHERITED is non-nil, the value can be
4005 inherited from a parent headline.
4007 Return value is a string or nil."
4019 "Return category for element or object BLOB.
4021 INFO is a plist used as a communication channel.
4023 CATEGORY is automatically inherited from a parent headline, from
4024 #+CATEGORY: keyword or created out of original file name. If all
4037 "Return alternative title for HEADLINE, as a secondary string.
4038 If no optional title is defined, fall-back to the regular title."
4045 "Non-nil when BLOB is the first sibling in its parent.
4046 BLOB is an element or an object. If BLOB is a headline, non-nil
4047 means it is the first sibling in the sub-tree. INFO is a plist
4048 used as a communication channel."
4053 "Non-nil when BLOB is the last sibling in its parent.
4054 BLOB is an element or an object. INFO is a plist used as
4055 a communication channel."
4059 ;;;; For Keywords
4060 ;;
4061 ;; `org-export-get-date' returns a date appropriate for the document
4062 ;; to about to be exported. In particular, it takes care of
4063 ;; `org-export-date-timestamp-format'.
4066 "Return date value for the current document.
4068 INFO is a plist used as a communication channel. FMT, when
4069 non-nil, is a time format string that will be applied on the date
4070 if it consists in a single timestamp object. It defaults to
4071 `org-export-date-timestamp-format' when nil.
4073 A proper date can be a secondary string, a string or nil. It is
4074 meant to be translated with `org-export-data' or alike."
4085 ;;;; For Links
4086 ;;
4087 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4088 ;; in `org-link-parameters'.
4089 ;;
4090 ;; `org-export-get-coderef-format' returns an appropriate format
4091 ;; string for coderefs.
4092 ;;
4093 ;; `org-export-inline-image-p' returns a non-nil value when the link
4094 ;; provided should be considered as an inline image.
4095 ;;
4096 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4097 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4098 ;; returns an appropriate unique identifier.
4099 ;;
4100 ;; `org-export-resolve-id-link' returns the first headline with
4101 ;; specified id or custom-id in parse tree, the path to the external
4102 ;; file with the id.
4103 ;;
4104 ;; `org-export-resolve-coderef' associates a reference to a line
4105 ;; number in the element it belongs, or returns the reference itself
4106 ;; when the element isn't numbered.
4107 ;;
4108 ;; `org-export-file-uri' expands a filename as stored in :path value
4109 ;; of a "file" link into a file URI.
4110 ;;
4111 ;; Broken links raise a `org-link-broken' error, which is caught by
4112 ;; `org-export-data' for further processing, depending on
4113 ;; `org-export-with-broken-links' value.
4118 "Try exporting LINK with a dedicated function.
4120 DESC is its description, as a string, or nil. BACKEND is the
4121 back-end used for export, as a symbol.
4123 Return output as a string, or nil if no protocol handles LINK.
4125 A custom protocol has precedence over regular back-end export.
4126 The function ignores links with an implicit type (e.g.,
4135 desc
4136 backend))))))
4139 "Return format string for code reference link.
4140 PATH is the link path. DESC is its description."
4148 "Non-nil if LINK object points to an inline image.
4150 Optional argument is a set of RULES defining inline images. It
4151 is an alist where associations have the following shape:
4153 (TYPE . REGEXP)
4155 Applying a rule means apply REGEXP against LINK's path when its
4156 type is TYPE. The function will return a non-nil value if any of
4157 the provided rules is non-nil. The default rule is
4158 `org-export-default-inline-image-rule'.
4160 This only applies to links without a description."
4171 "Resolve a code reference REF.
4173 INFO is a plist used as a communication channel.
4175 Return associated line number in source code, or REF itself,
4176 depending on src-block or example element's switches. Throw an
4177 error if no block contains REF."
4183 org-coderef-label-format))
4185 ;; Element containing REF is found. Resolve it to
4186 ;; either a label or a line number, as needed.
4195 "List search cells for element or object DATUM.
4197 A search cell follows the pattern (TYPE . SEARCH) where
4199 TYPE is a symbol among `headline', `custom-id', `target' and
4200 `other'.
4202 SEARCH is the string a link is expected to match. More
4203 accurately, it is
4205 - headline's title, as a list of strings, if TYPE is
4206 `headline'.
4208 - CUSTOM_ID value, as a string, if TYPE is `custom-id'.
4210 - target's or radio-target's name as a list of strings if
4211 TYPE is `target'.
4213 - NAME affiliated keyword is TYPE is `other'.
4215 A search cell is the internal representation of a fuzzy link. It
4216 ignores white spaces and statistics cookies, if applicable."
4218 (`headline
4229 (`target
4237 "Return search cells associated to string S.
4238 S is either the path of a fuzzy link or a search option, i.e., it
4239 tries to match either a headline (through custom ID or title),
4240 a target or a named element."
4248 "Non-nil when DATUM matches search cells CELLS.
4249 DATUM is an element or object. CELLS is a list of search cells,
4250 as returned by `org-export-search-cells'."
4255 "Return LINK destination.
4257 INFO is a plist holding contextual information.
4259 Return value can be an object or an element:
4261 - If LINK path matches a target object (i.e. <<path>>) return it.
4263 - If LINK path exactly matches the name affiliated keyword
4264 (i.e. #+NAME: path) of an element, return that element.
4266 - If LINK path exactly matches any headline name, return that
4267 element.
4269 - Otherwise, throw an error.
4272 significant."
4278 :resolve-fuzzy-link-cache
4288 datum)))))
4293 search-cells
4294 ;; There can be multiple matches for un-typed searches, i.e.,
4295 ;; for searches not starting with # or *. In this case,
4296 ;; prioritize targets and names over headline titles.
4297 ;; Matching both a name and a target is not valid, and
4298 ;; therefore undefined.
4301 datum))
4302 matches)
4304 link-cache)))))
4307 "Return headline referenced as LINK destination.
4309 INFO is a plist used as a communication channel.
4311 Return value can be the headline element matched in current parse
4315 ;; First check if id is within the current parse tree.
4320 headline))
4322 ;; Otherwise, look for external files.
4327 "Return radio-target object referenced as LINK destination.
4329 INFO is a plist used as a communication channel.
4331 Return value can be a radio-target object or nil. Assume LINK
4340 nil nil path nil nil t)
4341 t)
4342 radio))
4346 "Return file URI associated to FILENAME."
4353 ;;;; For References
4354 ;;
4355 ;; `org-export-get-reference' associate a unique reference for any
4356 ;; object or element. It uses `org-export-new-reference' and
4357 ;; `org-export-format-reference' to, respectively, generate new
4358 ;; internal references and turn them into a string suitable for
4359 ;; output.
4360 ;;
4361 ;; `org-export-get-ordinal' associates a sequence number to any object
4362 ;; or element.
4365 "Return a unique reference, among REFERENCES.
4366 REFERENCES is an alist whose values are in-use references, as
4367 numbers. Returns a number, which is the internal representation
4368 of a reference. See also `org-export-format-reference'."
4369 ;; Generate random 7 digits hexadecimal numbers. Collisions
4370 ;; increase exponentially with the numbers of references. However,
4371 ;; the odds for encountering at least one collision with 1000 active
4372 ;; references in the same document are roughly 0.2%, so this
4373 ;; shouldn't be the bottleneck.
4376 new))
4379 "Format REFERENCE into a string.
4380 REFERENCE is a number representing a reference, as returned by
4381 `org-export-new-reference', which see."
4385 "Return a unique reference for DATUM, as a string.
4387 DATUM is either an element or an object. INFO is the current
4388 export state, as a plist.
4390 This function checks `:crossrefs' property in INFO for search
4391 cells matching DATUM before creating a new reference. Returned
4392 reference consists of alphanumeric characters only."
4397 ;; Preserve any pre-existing association between
4398 ;; a search cell and a reference, i.e., when some
4399 ;; previously published document referenced a location
4400 ;; within current file (see
4401 ;; `org-publish-resolve-external-link').
4402 ;;
4403 ;; However, there is no guarantee that search cells are
4404 ;; unique, e.g., there might be duplicate custom ID or
4405 ;; two headings with the same title in the file.
4406 ;;
4407 ;; As a consequence, before re-using any reference to
4408 ;; an element or object, we check that it doesn't refer
4409 ;; to a previous element or object.
4416 cells)
4419 ;; Cache contains both data already associated to
4420 ;; a reference and in-use internal references, so as to make
4421 ;; unique references.
4423 ;; Retain a direct association between reference string and
4424 ;; DATUM since (1) not every object or element can be given
4425 ;; a search cell (2) it permits quick lookup.
4428 reference-string))))
4431 "Return ordinal number of an element or object.
4433 ELEMENT is the element or object considered. INFO is the plist
4434 used as a communication channel.
4436 Optional argument TYPES, when non-nil, is a list of element or
4437 object types, as symbols, that should also be counted in.
4438 Otherwise, only provided element's type is considered.
4440 Optional argument PREDICATE is a function returning a non-nil
4441 value if the current element or object should be counted in. It
4442 accepts two arguments: the element or object being considered and
4443 the plist used as a communication channel. This allows counting
4444 only a certain type of object (i.e. inline images).
4446 Return value is a list of numbers if ELEMENT is a headline or an
4447 item. It is nil for keywords. It represents the footnote number
4448 for footnote definitions and footnote references. If ELEMENT is
4449 a target, return the same value as if ELEMENT was the closest
4450 table, item or headline containing the target. In any other
4451 case, return the sequence number of ELEMENT among elements or
4452 objects of the same type."
4453 ;; Ordinal of a target object refer to the ordinal of the closest
4454 ;; table, item, or headline containing the object.
4458 element
4461 ;; Special case 1: A headline returns its number as a list.
4463 ;; Special case 2: An item returns its number as a list.
4467 struct
4474 ;; Increment counter until ELEMENT is found again.
4485 ;;;; For Src-Blocks
4486 ;;
4487 ;; `org-export-get-loc' counts number of code lines accumulated in
4488 ;; src-block or example-block elements with a "+n" switch until
4489 ;; a given element, excluded. Note: "-n" switches reset that count.
4490 ;;
4491 ;; `org-export-unravel-code' extracts source code (along with a code
4492 ;; references alist) from an `element-block' or `src-block' type
4493 ;; element.
4494 ;;
4495 ;; `org-export-format-code' applies a formatting function to each line
4496 ;; of code, providing relative line number and code reference when
4497 ;; appropriate. Since it doesn't access the original element from
4498 ;; which the source code is coming, it expects from the code calling
4499 ;; it to know if lines should be numbered and if code references
4500 ;; should appear.
4501 ;;
4502 ;; Eventually, `org-export-format-code-default' is a higher-level
4503 ;; function (it makes use of the two previous functions) which handles
4504 ;; line numbering and code references inclusion, and returns source
4505 ;; code in a format suitable for plain text or verbatim output.
4508 "Return count of lines of code before ELEMENT.
4510 ELEMENT is an example-block or src-block element. INFO is the
4511 plist used as a communication channel.
4513 Count includes every line of code in example-block or src-block
4515 ELEMENT doesn't allow line numbering."
4522 ;; ELEMENT is reached: Quit loop and return locs.
4524 ;; Only count lines from src-block and example-block
4525 ;; elements with a "+n" or "-n" switch.
4530 ;; Accumulate locs or reset them.
4538 "Clean source code and extract references out of it.
4540 ELEMENT has either a `src-block' an `example-block' type.
4542 Return a cons cell whose CAR is the source code, cleaned from any
4543 reference, protective commas and spurious indentation, and CDR is
4544 an alist between relative line number (integer) and name of code
4545 reference on that line (string)."
4548 ;; Get code and clean it. Remove blank lines at its
4549 ;; beginning and end.
4556 value
4558 ;; Build a regexp matching a loc with a reference.
4560 ;; Return value.
4562 ;; Code with references removed.
4568 ;; Ref line: remove ref, and signal its position in REFS.
4572 ;; Reference alist.
4573 refs)))
4576 "Format CODE by applying FUN line-wise and return it.
4578 CODE is a string representing the code to format. FUN is
4579 a function. It must accept three arguments: a line of
4580 code (string), the current line number (integer) or nil and the
4581 reference associated to the current line (string) or nil.
4583 Optional argument NUM-LINES can be an integer representing the
4584 number of code lines accumulated until the current code. Line
4585 numbers passed to FUN will take it into account. If it is nil,
4586 FUN's second argument will always be nil. This number can be
4587 obtained with `org-export-get-loc' function.
4589 Optional argument REF-ALIST can be an alist between relative line
4590 number (i.e. ignoring NUM-LINES) and the name of the code
4591 reference on it. If it is nil, FUN's third argument will always
4592 be nil. It can be obtained through the use of
4593 `org-export-unravel-code' function."
4605 "Return source code from ELEMENT, formatted in a standard way.
4607 ELEMENT is either a `src-block' or `example-block' element. INFO
4608 is a plist used as a communication channel.
4610 This function takes care of line numbering and code references
4611 inclusion. Line numbers, when applicable, appear at the
4612 beginning of the line, separated from the code by two white
4613 spaces. Code references, on the other hand, appear flushed to
4614 the right, separated by six white spaces from the widest line of
4615 code."
4616 ;; Extract code and references.
4623 ;; Handle line numbering.
4630 ;; Prepare references display, if required. Any reference
4631 ;; should start six columns after the widest line of code,
4632 ;; wrapped with parenthesis.
4637 code
4641 number-str
4642 loc
4648 num-start refs)))))
4651 ;;;; For Tables
4652 ;;
4653 ;; `org-export-table-has-special-column-p' and and
4654 ;; `org-export-table-row-is-special-p' are predicates used to look for
4655 ;; meta-information about the table structure.
4656 ;;
4657 ;; `org-table-has-header-p' tells when the rows before the first rule
4658 ;; should be considered as table's header.
4659 ;;
4660 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4661 ;; and `org-export-table-cell-borders' extract information from
4662 ;; a table-cell element.
4663 ;;
4664 ;; `org-export-table-dimensions' gives the number on rows and columns
4665 ;; in the table, ignoring horizontal rules and special columns.
4666 ;; `org-export-table-cell-address', given a table-cell object, returns
4667 ;; the absolute address of a cell. On the other hand,
4668 ;; `org-export-get-table-cell-at' does the contrary.
4669 ;;
4670 ;; `org-export-table-cell-starts-colgroup-p',
4671 ;; `org-export-table-cell-ends-colgroup-p',
4672 ;; `org-export-table-row-starts-rowgroup-p',
4673 ;; `org-export-table-row-ends-rowgroup-p',
4674 ;; `org-export-table-row-starts-header-p',
4675 ;; `org-export-table-row-ends-header-p' and
4676 ;; `org-export-table-row-in-header-p' indicate position of current row
4677 ;; or cell within the table.
4680 "Non-nil when TABLE has a special column.
4681 All special columns will be ignored during export."
4682 ;; The table has a special column when every first cell of every row
4683 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4684 ;; "*" "_" and "^". Though, do not consider a first row containing
4685 ;; only empty cells as special.
4699 "Non-nil when TABLE has a header.
4701 INFO is a plist used as a communication channel.
4703 A table has a header when it contains at least two row groups."
4712 table
4723 cache)))))
4726 "Non-nil if TABLE-ROW is considered special.
4727 All special rows will be ignored during export."
4731 ;; A row is special either when...
4733 ;; ... it starts with a field only containing "/",
4735 ;; ... the table contains a special column and the row start
4736 ;; with a marking character among, "^", "_", "$" or "!",
4740 ;; ... it contains only alignment cookies and empty cells.
4745 ;; Since VALUE is a secondary string, the following
4746 ;; checks avoid expanding it with `org-export-data'.
4757 "Return TABLE-ROW's group number, as an integer.
4759 INFO is a plist used as the communication channel.
4761 Return value is the group number, as an integer, or nil for
4762 special rows and rows separators. First group is also table's
4763 header."
4781 "Return TABLE-CELL contents width.
4783 INFO is a plist used as the communication channel.
4785 Return value is the width given by the last width cookie in the
4786 same column as TABLE-CELL, or nil."
4805 ;; In a special row, try to find a width cookie at COLUMN.
4809 ;; The following checks avoid expanding unnecessarily
4810 ;; the cell with `org-export-data'.
4820 "Return TABLE-CELL contents alignment.
4822 INFO is a plist used as the communication channel.
4824 Return alignment as specified by the last alignment cookie in the
4825 same column as TABLE-CELL. If no such cookie is found, a default
4826 alignment value will be deduced from fraction of numbers in the
4827 column (see `org-table-number-fraction' for more information).
4828 Possible values are `left', `right' and `center'."
4829 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4846 cookie-align
4847 previous-cell-number-p)
4850 ;; In a special row, try to find an alignment cookie at
4851 ;; COLUMN.
4855 ;; Since VALUE is a secondary string, the following
4856 ;; checks avoid useless expansion through
4857 ;; `org-export-data'.
4865 ;; Ignore table rules.
4867 ;; In a standard row, check if cell's contents are
4868 ;; expressing some kind of number. Increase NUMBER-CELLS
4869 ;; accordingly. Though, don't bother if an alignment
4870 ;; cookie has already defined cell's alignment.
4875 info)))
4877 ;; Treat an empty cell as a number if it follows
4878 ;; a number.
4884 ;; Return value. Alignment specified by cookies has
4885 ;; precedence over alignment deduced from cell's contents.
4887 column
4892 org-table-number-fraction)
4897 "Return TABLE-CELL borders.
4899 INFO is a plist used as a communication channel.
4901 Return value is a list of symbols, or nil. Possible values are:
4902 `top', `bottom', `above', `below', `left' and `right'. Note:
4903 `top' (resp. `bottom') only happen for a cell in the first
4904 row (resp. last row) of the table, ignoring table rules, if any.
4906 Returned borders ignore special rows."
4909 borders)
4910 ;; Top/above border? TABLE-CELL has a border above when a rule
4911 ;; used to demarcate row groups can be found above. Hence,
4912 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4913 ;; another regular row has to be found above that rule.
4916 ;; Look at every row before the current one.
4923 ;; No rule above, or rule found starts the table (ignoring any
4924 ;; special row): TABLE-CELL is at the top of the table.
4927 ;; Bottom/below border? TABLE-CELL has a border below when next
4928 ;; non-regular row below is a rule.
4931 ;; Look at every row after the current one.
4938 ;; No rule below, or rule found ends the table (modulo some
4939 ;; special row): TABLE-CELL is at the bottom of the table.
4942 ;; Right/left borders? They can only be specified by column
4943 ;; groups. Column groups are defined in a row starting with "/".
4944 ;; Also a column groups row only contains "<", "<>", ">" or blank
4945 ;; cells.
4949 ;; Table rows are read in reverse order so last column groups
4950 ;; row has precedence over any previous one.
4963 ;; There's a left border when previous cell, if
4964 ;; any, ends a group, or current one starts one.
4970 ;; There's a right border when next cell, if any,
4971 ;; starts a group, or current one ends one.
4978 ;; Return value.
4979 borders))
4982 "Non-nil when TABLE-CELL is at the beginning of a column group.
4983 INFO is a plist used as a communication channel."
4984 ;; A cell starts a column group either when it is at the beginning
4985 ;; of a row (or after the special column, if any) or when it has
4986 ;; a left border.
4989 table-cell)
4993 "Non-nil when TABLE-CELL is at the end of a column group.
4994 INFO is a plist used as a communication channel."
4995 ;; A cell ends a column group either when it is at the end of a row
4996 ;; or when it has a right border.
4999 table-cell)
5003 "Non-nil when TABLE-ROW is at the beginning of a row group.
5004 INFO is a plist used as a communication channel."
5012 "Non-nil when TABLE-ROW is at the end of a row group.
5013 INFO is a plist used as a communication channel."
5021 "Non-nil when TABLE-ROW is located within table's header.
5022 INFO is a plist used as a communication channel. Always return
5023 nil for special rows and rows separators."
5029 "Non-nil when TABLE-ROW is the first table header's row.
5030 INFO is a plist used as a communication channel."
5035 "Non-nil when TABLE-ROW is the last table header's row.
5036 INFO is a plist used as a communication channel."
5041 "Return TABLE-ROW number.
5042 INFO is a plist used as a communication channel. Return value is
5043 zero-based and ignores separators. The function returns nil for
5044 special columns and separators."
5056 "Return TABLE dimensions.
5058 INFO is a plist used as a communication channel.
5060 Return value is a CONS like (ROWS . COLUMNS) where
5061 ROWS (resp. COLUMNS) is the number of exportable
5062 rows (resp. columns)."
5064 ;; Set number of rows, and extract first one.
5070 ;; Set number of columns.
5072 ;; Return value.
5076 "Return address of a regular TABLE-CELL object.
5078 TABLE-CELL is the cell considered. INFO is a plist used as
5079 a communication channel.
5081 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5082 zero-based index. Only exportable cells are considered. The
5083 function returns nil for other cells."
5095 "Return regular table-cell object at ADDRESS in TABLE.
5097 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5098 zero-based index. TABLE is a table type element. INFO is
5099 a plist used as a communication channel.
5101 If no table-cell, among exportable cells, is found at ADDRESS,
5102 return nil."
5105 ;; Row at (car address) or nil.
5113 'table-cell
5120 ;;;; For Tables Of Contents
5121 ;;
5122 ;; `org-export-collect-headlines' builds a list of all exportable
5123 ;; headline elements, maybe limited to a certain depth. One can then
5124 ;; easily parse it and transcode it.
5125 ;;
5126 ;; Building lists of tables, figures or listings is quite similar.
5127 ;; Once the generic function `org-export-collect-elements' is defined,
5128 ;; `org-export-collect-tables', `org-export-collect-figures' and
5129 ;; `org-export-collect-listings' can be derived from it.
5132 "Collect headlines in order to build a table of contents.
5134 INFO is a plist used as a communication channel.
5136 When optional argument N is an integer, it specifies the depth of
5137 the table of contents. Otherwise, it is set to the value of the
5138 last headline level. See `org-export-headline-levels' for more
5139 information.
5141 Optional argument SCOPE, when non-nil, is an element. If it is
5142 a headline, only children of SCOPE are collected. Otherwise,
5143 collect children of the headline containing provided element. If
5144 there is no such headline, collect all headlines. In any case,
5145 argument N becomes relative to the level of that headline.
5147 Return a list of all exportable headlines as parsed elements.
5148 Footnote sections are ignored."
5157 limit))))
5163 info)))
5166 "Collect referenceable elements of a determined type.
5168 TYPE can be a symbol or a list of symbols specifying element
5169 types to search. Only elements with a caption are collected.
5171 INFO is a plist used as a communication channel.
5173 When non-nil, optional argument PREDICATE is a function accepting
5174 one argument, an element of type TYPE. It returns a non-nil
5175 value when that element should be collected.
5177 Return a list of all elements found, in order of appearance."
5182 element))
5183 info))
5186 "Build a list of tables.
5187 INFO is a plist used as a communication channel.
5189 Return a list of table elements with a caption."
5193 "Build a list of figures.
5195 INFO is a plist used as a communication channel. PREDICATE is
5196 a function which accepts one argument: a paragraph element and
5197 whose return value is non-nil when that element should be
5198 collected.
5200 A figure is a paragraph type element, with a caption, verifying
5202 a vague concept that may depend on back-end.
5204 Return a list of elements recognized as figures."
5208 "Build a list of src blocks.
5210 INFO is a plist used as a communication channel.
5212 Return a list of src-block elements with a caption."
5216 ;;;; Smart Quotes
5217 ;;
5218 ;; The main function for the smart quotes sub-system is
5219 ;; `org-export-activate-smart-quotes', which replaces every quote in
5220 ;; a given string from the parse tree with its "smart" counterpart.
5221 ;;
5222 ;; Dictionary for smart quotes is stored in
5223 ;; `org-export-smart-quotes-alist'.
5227 ;; one may use: »...«, "...", ›...‹, or '...'.
5228 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5229 ;; LaTeX quotes require Babel!
5289 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5300 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5311 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5322 ;; 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
5323 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5334 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5340 "Smart quotes translations.
5342 Alist whose CAR is a language string and CDR is an alist with
5343 quote type as key and a plist associating various encodings to
5344 their translation as value.
5346 A quote type can be any symbol among `primary-opening',
5347 `primary-closing', `secondary-opening', `secondary-closing' and
5348 `apostrophe'.
5350 Valid encodings include `:utf-8', `:html', `:latex' and
5351 `:texinfo'.
5356 "Return smart quote status at the beginning of string S.
5357 INFO is the current export state, as a plist."
5362 table)))
5370 'plain-text
5379 ;; Not already in a level 1 quote: this is an
5380 ;; apostrophe.
5382 ;; Extract previous char and next char. As
5383 ;; a special case, they can also be set to `blank',
5384 ;; `no-blank' or nil. Then determine if current
5385 ;; match is allowed as an opening quote or a closing
5386 ;; quote.
5391 text info)))
5408 previous)
5419 next)
5426 current-status)
5430 info nil org-element-recursive-objects)
5437 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5438 `:utf-8'. INFO is a plist used as a communication channel.
5440 The function has to retrieve information about string
5441 surroundings in parse tree. It can only happen with an
5442 unmodified string. Thus, if S has already been through another
5443 process, a non-nil ORIGINAL optional argument will provide that
5444 original string.
5446 Return the new string."
5455 org-export-smart-quotes-alist))))
5456 encoding)
5457 match))
5458 s nil t)))
5460 ;;;; Topology
5461 ;;
5462 ;; Here are various functions to retrieve information about the
5463 ;; neighborhood of a given element or object. Neighbors of interest
5464 ;; are direct parent (`org-export-get-parent'), parent headline
5465 ;; (`org-export-get-parent-headline'), first element containing an
5466 ;; object, (`org-export-get-parent-element'), parent table
5467 ;; (`org-export-get-parent-table'), previous element or object
5468 ;; (`org-export-get-previous-element') and next element or object
5469 ;; (`org-export-get-next-element').
5471 ;; defsubst org-export-get-parent must be defined before first use
5474 "Return BLOB parent headline or nil.
5475 BLOB is the element or object being considered."
5479 "Return first element containing OBJECT or nil.
5480 OBJECT is the object to consider."
5484 "Return OBJECT parent table or nil.
5485 OBJECT is either a `table-cell' or `table-element' type object."
5489 "Return previous element or object.
5491 BLOB is an element or object. INFO is a plist used as
5492 a communication channel. Return previous exportable element or
5493 object, a string, or nil.
5495 When optional argument N is a positive integer, return a list
5496 containing up to N siblings before BLOB, from farthest to
5497 closest. With any other non-nil value, return a list containing
5498 all of them."
5504 prev)
5514 "Return next element or object.
5516 BLOB is an element or object. INFO is a plist used as
5517 a communication channel. Return next exportable element or
5518 object, a string, or nil.
5520 When optional argument N is a positive integer, return a list
5521 containing up to N siblings after BLOB, from closest to farthest.
5522 With any other non-nil value, return a list containing all of
5523 them."
5530 next)
5540 ;;;; Translation
5541 ;;
5542 ;; `org-export-translate' translates a string according to the language
5543 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5544 ;; the dictionary used for the translation.
5576 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5586 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5592 ("ru" :html "(Продолжение следует)"
5669 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5692 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5698 ("ru" :html "Список распечаток"
5713 ("ru" :html "Список таблиц"
5821 ("ru" :html "Неизвестная ссылка"
5824 "Dictionary for export engine.
5826 Alist whose car is the string to translate and cdr is an alist
5827 whose car is the language string and cdr is a plist whose
5828 properties are possible charsets and values translated terms.
5830 It is used as a database for `org-export-translate'. Since this
5831 function returns the string as-is if no translation was found,
5832 the variable only needs to record values different from the
5836 "Translate string S according to language specification.
5838 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5839 and `:utf-8'. INFO is a plist used as a communication channel.
5841 Translation depends on `:language' property. Return the
5842 translated string. If no translation is found, try to fall back
5843 to `:default' encoding. If it fails, return S."
5849 s)))
5852 \f
5853 ;;; Asynchronous Export
5854 ;;
5855 ;; `org-export-async-start' is the entry point for asynchronous
5856 ;; export. It recreates current buffer (including visibility,
5857 ;; narrowing and visited file) in an external Emacs process, and
5858 ;; evaluates a command there. It then applies a function on the
5859 ;; returned results in the current process.
5860 ;;
5861 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5862 ;; allow exporting to a buffer or a file, asynchronously or not.
5863 ;;
5864 ;; `org-export-output-file-name' is an auxiliary function meant to be
5865 ;; used with `org-export-to-file'. With a given extension, it tries
5866 ;; to provide a canonical file name to write export output to.
5867 ;;
5868 ;; Asynchronously generated results are never displayed directly.
5869 ;; Instead, they are stored in `org-export-stack-contents'. They can
5870 ;; then be retrieved by calling `org-export-stack'.
5871 ;;
5872 ;; Export Stack is viewed through a dedicated major mode
5873 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5874 ;;`org-export-stack-delete', `org-export-stack-view' and
5875 ;;`org-export-stack-clear'.
5876 ;;
5877 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5878 ;; It should be used whenever `org-export-async-start' is called.
5881 "Call function FUN on the results returned by BODY evaluation.
5883 FUN is an anonymous function of one argument. BODY evaluation
5884 happens in an asynchronous process, from a buffer which is an
5885 exact copy of the current one.
5887 Use `org-export-add-to-stack' in FUN in order to register results
5888 in the stack.
5890 This is a low level function. See also `org-export-to-buffer'
5891 and `org-export-to-file' for more specialized functions."
5894 ;; Write the full sexp evaluating BODY in a copy of the current
5895 ;; buffer to a temporary file, as it may be too long for program
5896 ;; args in `start-process'.
5903 ;; Null characters (from variable values) are inserted
5904 ;; within the file. As a consequence, coding system for
5905 ;; buffer contents will not be recognized properly. So,
5906 ;; we make sure it is the same as the one used to display
5907 ;; the original buffer.
5909 ,coding
5912 ;; Ignore `kill-emacs-hook' and code evaluation
5913 ;; queries from Babel as we need a truly
5914 ;; non-interactive process.
5916 org-babel-confirm-evaluate-answer-no t)
5917 ;; Initialize export framework.
5919 ;; Re-create current buffer there.
5922 ;; Sexp to evaluate in the buffer.
5924 ;; Start external process.
5927 (,process
5929 #'start-process
5932 ,proc-buffer
5939 ;; Register running process in stack.
5941 ;; Set-up sentinel in order to catch results.
5944 ,process
5966 ;;;###autoload
5969 &optional async subtreep visible-only body-only ext-plist
5970 post-process)
5971 "Call `org-export-as' with output to a specified buffer.
5973 BACKEND is either an export back-end, as returned by, e.g.,
5974 `org-export-create-backend', or a symbol referring to
5975 a registered back-end.
5977 BUFFER is the name of the output buffer. If it already exists,
5978 it will be erased first, otherwise, it will be created.
5980 A non-nil optional argument ASYNC means the process should happen
5981 asynchronously. The resulting buffer should then be accessible
5982 through the `org-export-stack' interface. When ASYNC is nil, the
5983 buffer is displayed if `org-export-show-temporary-export-buffer'
5984 is non-nil.
5986 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5987 EXT-PLIST are similar to those used in `org-export-as', which
5988 see.
5990 Optional argument POST-PROCESS is a function which should accept
5991 no argument. It is always called within the current process,
5992 from BUFFER, with point at its beginning. Export back-ends can
5993 use it to set a major mode there, e.g,
5995 (defun org-latex-export-as-latex
5996 (&optional async subtreep visible-only body-only ext-plist)
5997 (interactive)
5999 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
6001 This function returns BUFFER."
6029 buffer)))
6031 ;;;###autoload
6034 post-process)
6035 "Call `org-export-as' with output to a specified file.
6037 BACKEND is either an export back-end, as returned by, e.g.,
6038 `org-export-create-backend', or a symbol referring to
6039 a registered back-end. FILE is the name of the output file, as
6040 a string.
6042 A non-nil optional argument ASYNC means the process should happen
6043 asynchronously. The resulting buffer will then be accessible
6044 through the `org-export-stack' interface.
6046 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6047 EXT-PLIST are similar to those used in `org-export-as', which
6048 see.
6050 Optional argument POST-PROCESS is called with FILE as its
6051 argument and happens asynchronously when ASYNC is non-nil. It
6052 has to return a file name, or nil. Export back-ends can use this
6053 to send the output file through additional processing, e.g,
6055 (defun org-latex-export-to-latex
6056 (&optional async subtreep visible-only body-only ext-plist)
6057 (interactive)
6060 async subtreep visible-only body-only ext-plist
6061 (lambda (file) (org-latex-compile file)))
6063 The function returns either a file name returned by POST-PROCESS,
6064 or FILE."
6083 backend subtreep visible-only body-only ext-plist)))
6090 ;; Get proper return value.
6092 file))))))
6095 "Return output file's name according to buffer specifications.
6097 EXTENSION is a string representing the output file extension,
6098 with the leading dot.
6100 With a non-nil optional argument SUBTREEP, try to determine
6102 of subtree at point.
6104 When optional argument PUB-DIR is set, use it as the publishing
6105 directory.
6107 Return file name as a string."
6110 ;; File name may come from EXPORT_FILE_NAME subtree
6111 ;; property.
6114 ;; File name may be extracted from buffer's associated
6115 ;; file, if any.
6117 ;; Can't determine file name on our own: Ask user.
6119 "Output file: " pub-dir nil nil nil
6123 ;; Build file name. Enforce EXTENSION over whatever user
6124 ;; may have come up with. PUB-DIR, if defined, always has
6125 ;; precedence over any provided path.
6130 extension))
6133 ;; If writing to OUTPUT-FILE would overwrite original file, append
6134 ;; EXTENSION another time to final name.
6137 output-file)))
6140 "Add a new result to export stack if not present already.
6142 SOURCE is a buffer or a file name containing export results.
6143 BACKEND is a symbol representing export back-end used to generate
6144 it.
6146 Entries already pointing to SOURCE and unavailable entries are
6147 removed beforehand. Return the new stack."
6153 "Menu for asynchronous export results and running processes."
6163 "Remove all entries from export stack."
6168 "Refresh the export stack."
6173 "Remove export results at point from stack.
6174 If optional argument SOURCE is non-nil, remove it instead."
6179 org-export-stack-contents))))
6182 "View export results at point in stack.
6183 With an optional prefix argument IN-EMACS, force viewing files
6184 within Emacs."
6198 (define-key km "\C-p" 'previous-line)
6199 (define-key km "\C-?" 'previous-line)
6200 (define-key km [up] 'previous-line)
6201 (define-key km "C" 'org-export-stack-clear)
6202 (define-key km "v" 'org-export-stack-view)
6203 (define-key km (kbd "RET") 'org-export-stack-view)
6204 (define-key km "d" 'org-export-stack-remove)
6205 km)
6206 "Keymap for Org Export Stack.")
6208 (define-derived-mode org-export-stack-mode tabulated-list-mode "Org-Stack"
6209 "Mode for displaying asynchronous export stack.
6212 stack.
6214 In an Org Export Stack buffer, use \
6218 stack completely.
6220 Removing entries in a stack buffer does not affect files
6221 or buffers, only display.
6224 (setq tabulated-list-format
6225 (vector (list "#" 4 #'org-export--stack-num-predicate)
6226 (list "Back-End" 12 t)
6227 (list "Age" 6 nil)
6228 (list "Source" 0 nil)))
6229 (setq tabulated-list-sort-key (cons "#" nil))
6230 (setq tabulated-list-entries #'org-export--stack-generate)
6231 (add-hook 'tabulated-list-revert-hook #'org-export--stack-generate nil t)
6232 (add-hook 'post-command-hook #'org-export-stack-refresh nil t)
6233 (tabulated-list-init-header))
6235 (defun org-export--stack-generate ()
6236 "Generate the asynchronous export stack for display.
6237 Unavailable sources are removed from the list. Return a list
6238 appropriate for `tabulated-list-print'."
6239 ;; Clear stack from exited processes, dead buffers or non-existent
6240 ;; files.
6241 (setq org-export-stack-contents
6242 (cl-remove-if-not
6243 (lambda (el)
6244 (if (processp (nth 2 el))
6245 (buffer-live-p (process-buffer (nth 2 el)))
6246 (let ((source (car el)))
6247 (if (bufferp source) (buffer-live-p source)
6248 (file-exists-p source)))))
6249 org-export-stack-contents))
6250 ;; Update `tabulated-list-entries'.
6251 (let ((counter 0))
6252 (mapcar
6253 (lambda (entry)
6254 (let ((source (car entry)))
6255 (list source
6256 (vector
6257 ;; Counter.
6258 (number-to-string (cl-incf counter))
6259 ;; Back-End.
6260 (if (nth 1 entry) (symbol-name (nth 1 entry)) "")
6261 ;; Age.
6262 (let ((info (nth 2 entry)))
6263 (if (processp info) (symbol-name (process-status info))
6264 (format-seconds "%h:%.2m" (float-time (time-since info)))))
6265 ;; Source.
6266 (if (stringp source) source (buffer-name source))))))
6267 org-export-stack-contents)))
6269 (defun org-export--stack-num-predicate (a b)
6270 (< (string-to-number (aref (nth 1 a) 0))
6271 (string-to-number (aref (nth 1 b) 0))))
6273 (defun org-export--stack-source-at-point ()
6274 "Return source from export results at point in stack."
6275 (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
6276 (if (not source) (error "Source unavailable, please refresh buffer")
6277 (let ((source-name (if (stringp source) source (buffer-name source))))
6278 (if (save-excursion
6279 (beginning-of-line)
6280 (looking-at-p (concat ".* +" (regexp-quote source-name) "$")))
6281 source
6282 ;; SOURCE is not consistent with current line. The stack
6283 ;; view is outdated.
6284 (error (substitute-command-keys
6286 to refresh buffer")))))))
6289 \f
6290 ;;; The Dispatcher
6291 ;;
6292 ;; `org-export-dispatch' is the standard interactive way to start an
6293 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6294 ;; for its interface, which, in turn, delegates response to key
6295 ;; pressed to `org-export--dispatch-action'.
6297 ;;;###autoload
6298 (defun org-export-dispatch (&optional arg)
6299 "Export dispatcher for Org mode.
6301 It provides an access to common export related tasks in a buffer.
6302 Its interface comes in two flavors: standard and expert.
6304 While both share the same set of bindings, only the former
6305 displays the valid keys associations in a dedicated buffer.
6306 Scrolling (resp. line-wise motion) in this buffer is done with
6307 SPC and DEL (resp. C-n and C-p) keys.
6309 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6310 flavor or the other.
6313 same
6314 set of options used back then, on the current buffer.
6317 asynchronous export stack."
6318 (interactive "P")
6319 (let* ((input
6320 (cond ((equal arg '(16)) '(stack))
6321 ((and arg org-export-dispatch-last-action))
6322 (t (save-window-excursion
6323 (unwind-protect
6324 (progn
6325 ;; Remember where we are
6326 (move-marker org-export-dispatch-last-position
6327 (point)
6328 (org-base-buffer (current-buffer)))
6329 ;; Get and store an export command
6330 (setq org-export-dispatch-last-action
6331 (org-export--dispatch-ui
6332 (list org-export-initial-scope
6333 (and org-export-in-background 'async))
6334 nil
6335 org-export-dispatch-use-expert-ui)))
6336 (and (get-buffer "*Org Export Dispatcher*")
6337 (kill-buffer "*Org Export Dispatcher*")))))))
6338 (action (car input))
6339 (optns (cdr input)))
6340 (unless (memq 'subtree optns)
6341 (move-marker org-export-dispatch-last-position nil))
6342 (cl-case action
6343 ;; First handle special hard-coded actions.
6344 (template (org-export-insert-default-template nil optns))
6345 (stack (org-export-stack))
6346 (publish-current-file
6347 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6348 (publish-current-project
6349 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6350 (publish-choose-project
6351 (org-publish (assoc (completing-read
6352 "Publish project: "
6353 org-publish-project-alist nil t)
6354 org-publish-project-alist)
6355 (memq 'force optns)
6356 (memq 'async optns)))
6357 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6358 (otherwise
6359 (save-excursion
6360 (when arg
6361 ;; Repeating command, maybe move cursor to restore subtree
6362 ;; context.
6363 (if (eq (marker-buffer org-export-dispatch-last-position)
6364 (org-base-buffer (current-buffer)))
6365 (goto-char org-export-dispatch-last-position)
6366 ;; We are in a different buffer, forget position.
6367 (move-marker org-export-dispatch-last-position nil)))
6368 (funcall action
6369 ;; Return a symbol instead of a list to ease
6370 ;; asynchronous export macro use.
6371 (and (memq 'async optns) t)
6372 (and (memq 'subtree optns) t)
6373 (and (memq 'visible optns) t)
6374 (and (memq 'body optns) t)))))))
6376 (defun org-export--dispatch-ui (options first-key expertp)
6377 "Handle interface for `org-export-dispatch'.
6379 OPTIONS is a list containing current interactive options set for
6380 export. It can contain any of the following symbols:
6381 `body' toggles a body-only export
6382 `subtree' restricts export to current subtree
6383 `visible' restricts export to visible part of buffer.
6384 `force' force publishing files.
6385 `async' use asynchronous export process
6387 FIRST-KEY is the key pressed to select the first level menu. It
6388 is nil when this menu hasn't been selected yet.
6390 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6391 buffer is provided, but indications about currently active
6392 options are given in the prompt. Moreover, [?] allows switching
6393 back to standard interface."
6394 (let* ((fontify-key
6395 (lambda (key &optional access-key)
6396 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6397 ;; non-nil is the required first-level key to activate
6398 ;; KEY. When its value is t, activate KEY independently
6399 ;; on the first key, if any. A nil value means KEY will
6400 ;; only be activated at first level.
6401 (if (or (eq access-key t) (eq access-key first-key))
6402 (propertize key 'face 'org-warning)
6403 key)))
6404 (fontify-value
6405 (lambda (value)
6406 ;; Fontify VALUE string.
6407 (propertize value 'face 'font-lock-variable-name-face)))
6408 ;; Prepare menu entries by extracting them from registered
6409 ;; back-ends and sorting them by access key and by ordinal,
6410 ;; if any.
6411 (entries
6412 (sort (sort (delq nil
6413 (mapcar #'org-export-backend-menu
6414 org-export-registered-backends))
6415 (lambda (a b)
6416 (let ((key-a (nth 1 a))
6417 (key-b (nth 1 b)))
6418 (cond ((and (numberp key-a) (numberp key-b))
6419 (< key-a key-b))
6420 ((numberp key-b) t)))))
6421 'car-less-than-car))
6422 ;; Compute a list of allowed keys based on the first key
6423 ;; pressed, if any. Some keys
6424 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6425 ;; available.
6426 (allowed-keys
6427 (nconc (list 2 22 19 6 1)
6428 (if (not first-key) (org-uniquify (mapcar 'car entries))
6429 (let (sub-menu)
6430 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6431 (when (eq (car entry) first-key)
6432 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6433 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6434 ((not first-key) (list ?P)))
6435 (list ?& ?#)
6436 (when expertp (list ??))
6437 (list ?q)))
6438 ;; Build the help menu for standard UI.
6439 (help
6440 (unless expertp
6441 (concat
6442 ;; Options are hard-coded.
6443 (format "[%s] Body only: %s [%s] Visible only: %s
6444 \[%s] Export scope: %s [%s] Force publishing: %s
6446 (funcall fontify-key "C-b" t)
6447 (funcall fontify-value
6448 (if (memq 'body options) "On " "Off"))
6449 (funcall fontify-key "C-v" t)
6450 (funcall fontify-value
6451 (if (memq 'visible options) "On " "Off"))
6452 (funcall fontify-key "C-s" t)
6453 (funcall fontify-value
6454 (if (memq 'subtree options) "Subtree" "Buffer "))
6455 (funcall fontify-key "C-f" t)
6456 (funcall fontify-value
6457 (if (memq 'force options) "On " "Off"))
6458 (funcall fontify-key "C-a" t)
6459 (funcall fontify-value
6460 (if (memq 'async options) "On " "Off")))
6461 ;; Display registered back-end entries. When a key
6462 ;; appears for the second time, do not create another
6463 ;; entry, but append its sub-menu to existing menu.
6464 (let (last-key)
6465 (mapconcat
6466 (lambda (entry)
6467 (let ((top-key (car entry)))
6468 (concat
6469 (unless (eq top-key last-key)
6470 (setq last-key top-key)
6472 (funcall fontify-key (char-to-string top-key))
6473 (nth 1 entry)))
6474 (let ((sub-menu (nth 2 entry)))
6475 (unless (functionp sub-menu)
6476 ;; Split sub-menu into two columns.
6477 (let ((index -1))
6478 (concat
6479 (mapconcat
6480 (lambda (sub-entry)
6481 (cl-incf index)
6482 (format
6483 (if (zerop (mod index 2)) " [%s] %-26s"
6485 (funcall fontify-key
6486 (char-to-string (car sub-entry))
6487 top-key)
6488 (nth 1 sub-entry)))
6489 sub-menu "")
6491 entries ""))
6492 ;; Publishing menu is hard-coded.
6494 [%s] Current file [%s] Current project
6496 (funcall fontify-key "P")
6497 (funcall fontify-key "f" ?P)
6498 (funcall fontify-key "p" ?P)
6499 (funcall fontify-key "x" ?P)
6500 (funcall fontify-key "a" ?P))
6502 (funcall fontify-key "&" t)
6503 (funcall fontify-key "#" t))
6504 (format "[%s] %s"
6505 (funcall fontify-key "q" t)
6506 (if first-key "Main menu" "Exit")))))
6507 ;; Build prompts for both standard and expert UI.
6508 (standard-prompt (unless expertp "Export command: "))
6509 (expert-prompt
6510 (when expertp
6511 (format
6512 "Export command (C-%s%s%s%s%s) [%s]: "
6513 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6514 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6515 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6516 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6517 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6518 (mapconcat (lambda (k)
6519 ;; Strip control characters.
6520 (unless (< k 27) (char-to-string k)))
6521 allowed-keys "")))))
6522 ;; With expert UI, just read key with a fancy prompt. In standard
6523 ;; UI, display an intrusive help buffer.
6524 (if expertp
6525 (org-export--dispatch-action
6526 expert-prompt allowed-keys entries options first-key expertp)
6527 ;; At first call, create frame layout in order to display menu.
6528 (unless (get-buffer "*Org Export Dispatcher*")
6529 (delete-other-windows)
6530 (org-switch-to-buffer-other-window
6531 (get-buffer-create "*Org Export Dispatcher*"))
6532 (setq cursor-type nil
6533 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6534 ;; Make sure that invisible cursor will not highlight square
6535 ;; brackets.
6536 (set-syntax-table (copy-syntax-table))
6537 (modify-syntax-entry ?\[ "w"))
6538 ;; At this point, the buffer containing the menu exists and is
6539 ;; visible in the current window. So, refresh it.
6540 (with-current-buffer "*Org Export Dispatcher*"
6541 ;; Refresh help. Maintain display continuity by re-visiting
6542 ;; previous window position.
6543 (let ((pos (window-start)))
6544 (erase-buffer)
6545 (insert help)
6546 (set-window-start nil pos)))
6547 (org-fit-window-to-buffer)
6548 (org-export--dispatch-action
6549 standard-prompt allowed-keys entries options first-key expertp))))
6551 (defun org-export--dispatch-action
6552 (prompt allowed-keys entries options first-key expertp)
6553 "Read a character from command input and act accordingly.
6555 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6556 a list of characters available at a given step in the process.
6557 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6558 EXPERTP are the same as defined in `org-export--dispatch-ui',
6559 which see.
6561 Toggle export options when required. Otherwise, return value is
6562 a list with action as CAR and a list of interactive export
6563 options as CDR."
6564 (let (key)
6565 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6566 ;; C-p, SPC, DEL).
6567 (while (and (setq key (read-char-exclusive prompt))
6568 (not expertp)
6569 (memq key '(14 16 ?\s ?\d)))
6570 (cl-case key
6571 (14 (if (not (pos-visible-in-window-p (point-max)))
6572 (ignore-errors (scroll-up 1))
6573 (message "End of buffer")
6574 (sit-for 1)))
6575 (16 (if (not (pos-visible-in-window-p (point-min)))
6576 (ignore-errors (scroll-down 1))
6577 (message "Beginning of buffer")
6578 (sit-for 1)))
6579 (?\s (if (not (pos-visible-in-window-p (point-max)))
6580 (scroll-up nil)
6581 (message "End of buffer")
6582 (sit-for 1)))
6583 (?\d (if (not (pos-visible-in-window-p (point-min)))
6584 (scroll-down nil)
6585 (message "Beginning of buffer")
6586 (sit-for 1)))))
6587 (cond
6588 ;; Ignore undefined associations.
6589 ((not (memq key allowed-keys))
6590 (ding)
6591 (unless expertp (message "Invalid key") (sit-for 1))
6592 (org-export--dispatch-ui options first-key expertp))
6593 ;; q key at first level aborts export. At second level, cancel
6594 ;; first key instead.
6595 ((eq key ?q) (if (not first-key) (error "Export aborted")
6596 (org-export--dispatch-ui options nil expertp)))
6597 ;; Help key: Switch back to standard interface if expert UI was
6598 ;; active.
6599 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6600 ;; Send request for template insertion along with export scope.
6601 ((eq key ?#) (cons 'template (memq 'subtree options)))
6602 ;; Switch to asynchronous export stack.
6603 ((eq key ?&) '(stack))
6604 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6605 ((memq key '(2 22 19 6 1))
6606 (org-export--dispatch-ui
6607 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6608 (6 'force) (1 'async))))
6609 (if (memq option options) (remq option options)
6610 (cons option options)))
6611 first-key expertp))
6612 ;; Action selected: Send key and options back to
6613 ;; `org-export-dispatch'.
6614 ((or first-key (functionp (nth 2 (assq key entries))))
6615 (cons (cond
6616 ((not first-key) (nth 2 (assq key entries)))
6617 ;; Publishing actions are hard-coded. Send a special
6618 ;; signal to `org-export-dispatch'.
6619 ((eq first-key ?P)
6620 (cl-case key
6621 (?f 'publish-current-file)
6622 (?p 'publish-current-project)
6623 (?x 'publish-choose-project)
6624 (?a 'publish-all)))
6625 ;; Return first action associated to FIRST-KEY + KEY
6626 ;; path. Indeed, derived backends can share the same
6627 ;; FIRST-KEY.
6628 (t (catch 'found
6629 (dolist (entry (member (assq first-key entries) entries))
6630 (let ((match (assq key (nth 2 entry))))
6631 (when match (throw 'found (nth 2 match))))))))
6632 options))
6633 ;; Otherwise, enter sub-menu.
6634 (t (org-export--dispatch-ui options key expertp)))))
6638 (provide 'ox)
6640 ;; Local variables:
6641 ;; generated-autoload-file: "org-loaddefs.el"
6642 ;; End:
6644 ;;; ox.el ends here