| blob | 7d2f3d1714a09d814eeccf224544869ef6643f7c |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2017 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
91 \f
92 ;;; Internal Variables
93 ;;
94 ;; Among internal variables, the most important is
95 ;; `org-export-options-alist'. This variable define the global export
96 ;; options, shared between every exporter, and how they are acquired.
142 "Alist between export properties and ways to set them.
144 The key of the alist is the property name, and the value is a list
145 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
147 KEYWORD is a string representing a buffer keyword, or nil. Each
148 property defined this way can also be set, during subtree
149 export, through a headline property named after the keyword
151 property).
152 OPTION is a string that could be found in an #+OPTIONS: line.
153 DEFAULT is the default value for the property.
154 BEHAVIOR determines how Org should handle multiple keywords for
155 the same property. It is a symbol among:
156 nil Keep old value and discard the new one.
157 t Replace old value with the new one.
158 `space' Concatenate the values, separating them with a space.
159 `newline' Concatenate the values, separating them with
160 a newline.
161 `split' Split values at white spaces, and cons them to the
162 previous list.
163 `parse' Parse value as a list of strings and Org objects,
164 which can then be transcoded with, e.g.,
165 `org-export-data'. It implies `space' behavior.
167 Values set through KEYWORD and OPTION have precedence over
168 DEFAULT.
170 All these properties should be back-end agnostic. Back-end
171 specific properties are set through `org-export-define-backend'.
175 "List of in-buffer keywords that require special treatment.
176 These keywords are not directly associated to a property. The
177 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
263 org-element--cache org-element--cache-objects org-element--cache-sync-keys
264 org-element--cache-sync-requests org-element--cache-sync-timer)
265 "List of variables not copied through upon buffer duplication.
266 Export process takes place on a copy of the original buffer.
267 When this copy is created, all Org related local variables not in
268 this list are copied to the new buffer. Variables with an
272 "Non-nil means asynchronous export process should leave data behind.
276 located in `temporary-file-directory'.
278 When non-nil, it will also set `debug-on-error' to a non-nil
282 "Record asynchronously generated export results and processes.
283 This is an alist: its CAR is the source of the
284 result (destination file or buffer for a finished process,
285 original buffer for a running one) and its CDR is a list
286 containing the back-end used, as a symbol, and either a process
287 or the time at which it finished. It is used to build the menu
291 "List of backends currently available in the exporter.
292 This variable is set with `org-export-define-backend' and
296 "Last command called from the dispatcher.
297 The value should be a list. Its CAR is the action, as a symbol,
301 "The position where the last export command was created using the dispatcher.
302 This marker will be used with `C-u C-c C-e' to make sure export repetition
305 ;; For compatibility with Org < 8
307 "Name, if any, of the back-end used during an export process.
309 Its value is a symbol such as `html', `latex', `ascii', or nil if
310 the back-end is anonymous (see `org-export-create-backend') or if
311 there is no export process in progress.
313 It can be used to teach Babel blocks how to act differently
317 \f
318 ;;; User-configurable Variables
319 ;;
320 ;; Configuration for the masses.
321 ;;
322 ;; They should never be accessed directly, as their value is to be
323 ;; stored in a property list (cf. `org-export-options-alist').
324 ;; Back-ends will read their value from there instead.
327 "Options for exporting Org mode files."
332 "General options for export engine."
337 "Whether sub-trees with the ARCHIVE tag should be exported.
339 This can have three different values:
340 nil Do not export, pretend this tree is not present.
341 t Do export the entire tree.
342 `headline' Only export the headline, but skip the tree below it.
344 This option can also be set with the OPTIONS keyword,
354 "Non-nil means insert author name into the exported file.
355 This option can also be set with the OPTIONS keyword,
362 "Non-nil means export CLOCK keywords.
363 This option can also be set with the OPTIONS keyword,
370 "Non-nil means the postamble should contain a creator sentence.
372 The sentence can be set in `org-export-creator-string', which
373 see.
375 This option can also be set with the OPTIONS keyword, e.g.,
384 "Non-nil means insert date in the exported document.
385 This option can also be set with the OPTIONS keyword,
392 "Time-stamp format string to use for DATE keyword.
394 The format string, when specified, only applies if date consists
395 in a single time-stamp. Otherwise its value will be ignored.
397 See `format-time-string' for details on how to build this
398 string."
407 emacs-version
409 "Information about the creator of the document.
410 This option can also be set on with the CREATOR keyword."
416 "Non-nil means export contents of standard drawers.
418 When t, all drawers are exported. This may also be a list of
419 drawer names to export, as strings. If that list starts with
420 `not', only drawers with such names will be ignored.
422 This variable doesn't apply to properties drawers. See
423 `org-export-with-properties' instead.
425 This option can also be set with the OPTIONS keyword,
438 :inline t
447 "Non-nil means insert author email into the exported file.
448 This option can also be set with the OPTIONS keyword,
455 "Non-nil means interpret *word*, /word/, _word_ and +word+.
457 If the export target supports emphasizing text, the word will be
458 typeset in bold, italic, with an underline or strike-through,
459 respectively.
461 This option can also be set with the OPTIONS keyword,
468 "Tags that exclude a tree from export.
470 All trees carrying any of these tags will be excluded from
471 export. This is without condition, so even subtrees inside that
472 carry one of the `org-export-select-tags' will be removed.
474 This option can also be set with the EXCLUDE_TAGS keyword."
481 This option can also be set with the OPTIONS keyword,
490 "Non-nil means Org footnotes should be exported.
491 This option can also be set with the OPTIONS keyword,
498 "Non-nil means process LaTeX environments and fragments.
500 This option can also be set with the OPTIONS line,
503 nil Ignore math snippets.
504 `verbatim' Keep everything in verbatim.
505 t Allow export of math snippets."
516 "The last level which is still exported as a headline.
518 Inferior levels will usually produce itemize or enumerate lists
519 when exported, but back-end behavior may differ.
521 This option can also be set with the OPTIONS keyword,
528 "The default language for export and clocktable translations, as a string.
529 This may have an association in
530 `org-clock-clocktable-language-setup',
531 `org-export-smart-quotes-alist' and `org-export-dictionary'.
532 This option can also be set with the LANGUAGE keyword."
538 "Non-nil means preserve all line breaks when exporting.
539 This option can also be set with the OPTIONS keyword,
546 "Non-nil means interpret entities when exporting.
549 Å.
551 For a list of supported names, see the constant `org-entities'
552 and the user option `org-entities-user'.
554 This option can also be set with the OPTIONS keyword,
561 "Non-nil means inlinetasks should be exported.
562 This option can also be set with the OPTIONS keyword,
571 "Non-nil means include planning info in export.
573 Planning info is the line containing either SCHEDULED:,
574 DEADLINE:, CLOSED: time-stamps, or a combination of them.
576 This option can also be set with the OPTIONS keyword,
585 "Non-nil means include priority cookies in export.
586 This option can also be set with the OPTIONS keyword,
593 "Non-nil means export contents of properties drawers.
595 When t, all properties are exported. This may also be a list of
596 properties to export, as strings.
598 This option can also be set with the OPTIONS keyword,
612 "Non-nil means add section numbers to headlines when exporting.
614 When set to an integer n, numbering will only happen for
615 headlines whose relative level is higher or equal to n.
617 This option can also be set with the OPTIONS keyword,
624 "Tags that select a tree for export.
626 If any such tag is found in a buffer, all trees that do not carry
627 one of these tags will be ignored during export. Inside trees
628 that are selected like this, you can still deselect a subtree by
629 tagging it with one of the `org-export-exclude-tags'.
631 This option can also be set with the SELECT_TAGS keyword."
637 "Non-nil means activate smart quotes during export.
638 This option can also be set with the OPTIONS keyword,
641 When setting this to non-nil, you need to take care of
642 using the correct Babel package when exporting to LaTeX.
643 E.g., you can load Babel for french like this:
655 When this option is turned on, these strings will be exported as:
657 Org HTML LaTeX UTF-8
658 -----+----------+--------+-------
660 -- – -- –
661 --- — --- —
664 This option can also be set with the OPTIONS keyword,
671 "Non-nil means include statistics cookies in export.
672 This option can also be set with the OPTIONS keyword,
683 If you want to control how Org displays those characters, see
684 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
685 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
686 it is not anymore.
688 When this option is turned on, you can use TeX-like syntax for
689 sub- and superscripts and see them exported correctly.
691 You can also set the option with #+OPTIONS: ^:t
694 single item - so grouping with {} is normally not needed. For
695 example, the following things will be parsed as single sub- or
696 superscripts:
698 10^24 or 10^tau several digits will be considered 1 item.
699 10^-12 or 10^-tau a leading sign with digits or a word
700 x^2-y^3 will be read as x^2 - y^3, because items are
701 terminated by almost any nonword/nondigit char.
702 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
704 Still, ambiguity is possible. So when in doubt, use {} to enclose
705 the sub/superscript. If you set this variable to the symbol `{}',
706 the braces are *required* in order to trigger interpretations as
708 frequently in plain text."
719 "Non-nil means create a table of contents in exported files.
721 The TOC contains headlines with levels up
722 to`org-export-headline-levels'. When an integer, include levels
723 up to N in the toc, this may then be different from
724 `org-export-headline-levels', but it will not be allowed to be
725 larger than the number of headline levels. When nil, no table of
726 contents is made.
728 This option can also be set with the OPTIONS keyword,
739 "Non-nil means export tables.
740 This option can also be set with the OPTIONS keyword,
749 "If nil, do not export tags, just remove them from headlines.
751 If this is the symbol `not-in-toc', tags will be removed from
752 table of contents entries, but still be shown in the headlines of
753 the document.
755 This option can also be set with the OPTIONS keyword,
765 "Non-nil means include TODO items for export.
767 This may have the following values:
768 t include tasks independent of state.
769 `todo' include only tasks that are not yet done.
770 `done' include only tasks that are already done.
771 nil ignore all tasks.
772 list of keywords include tasks with these keywords.
774 This option can also be set with the OPTIONS keyword,
789 "Non-nil means print title into the exported file.
790 This option can also be set with the OPTIONS keyword,
799 "Non-nil means insert a time stamp into the exported file.
800 The time stamp shows when the file was created. This option can
807 "Non nil means allow timestamps in export.
809 It can be set to any of the following values:
810 t export all timestamps.
811 `active' export active timestamps only.
812 `inactive' export inactive timestamps only.
813 nil do not export timestamps
815 This only applies to timestamps isolated in a paragraph
816 containing only timestamps. Other timestamps are always
817 exported.
819 This option can also be set with the OPTIONS keyword, e.g.
830 "Non-nil means include TODO keywords in export.
831 When nil, remove all these keywords from the export. This option
837 "Non-nil means BIND keywords can define local variable values.
838 This is a potential security risk, which is why the default value
839 is nil. You can also allow them through local buffer variables."
846 "Non-nil means do not raise an error on broken links.
848 When this variable is non-nil, broken links are ignored, without
849 stopping the export process. If it is set to `mark', broken
850 links are marked as such in the output, with a string like
852 [BROKEN LINK: path]
854 where PATH is the un-resolvable reference.
856 This option can also be set with the OPTIONS keyword, e.g.,
867 "Alist between export snippets back-ends and exporter back-ends.
869 This variable allows providing shortcuts for export snippets.
873 HTML code while every other back-end will ignore it."
887 "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)
999 ;;;###autoload
1001 "Return export back-end named after NAME.
1002 NAME is a symbol. Return nil if no such back-end is found."
1004 org-export-registered-backends))
1007 "Register BACKEND as a known export back-end.
1008 BACKEND is a structure with `org-export-backend' type."
1009 ;; Refuse to register an unnamed back-end.
1012 ;; Refuse to register a back-end with an unknown parent.
1016 ;; If a back-end with the same name as BACKEND is already
1017 ;; registered, replace it with BACKEND. Otherwise, simply add
1018 ;; BACKEND to the list of registered back-ends.
1024 "Signal an error if BACKEND isn't defined."
1029 "Non-nil if BACKEND is derived from one of BACKENDS.
1030 BACKEND is an export back-end, as returned by, e.g.,
1031 `org-export-create-backend', or a symbol referring to
1032 a registered back-end. BACKENDS is constituted of symbols."
1044 "Return full translation table for BACKEND.
1046 BACKEND is an export back-end, as return by, e.g,,
1047 `org-export-create-backend'. Return value is an alist where
1048 keys are element or object types, as symbols, and values are
1049 transcoders.
1051 Unlike to `org-export-backend-transcoders', this function
1052 also returns transcoders inherited from parent back-ends,
1053 if any."
1057 parent)
1062 transcoders)))
1065 "Return export options for BACKEND.
1067 BACKEND is an export back-end, as return by, e.g,,
1068 `org-export-create-backend'. See `org-export-options-alist'
1069 for the shape of the return value.
1071 Unlike to `org-export-backend-options', this function also
1072 returns options inherited from parent back-ends, if any.
1074 Return nil if BACKEND is unknown."
1078 parent)
1082 options)))
1085 "Return complete list of filters for BACKEND.
1087 BACKEND is an export back-end, as return by, e.g,,
1088 `org-export-create-backend'. Return value is an alist where
1089 keys are symbols and values lists of functions.
1091 Unlike to `org-export-backend-filters', this function also
1092 returns filters inherited from parent back-ends, if any."
1096 parent)
1100 filters)))
1103 "Define a new back-end BACKEND.
1105 TRANSCODERS is an alist between object or element types and
1106 functions handling them.
1108 These functions should return a string without any trailing
1109 space, or nil. They must accept three arguments: the object or
1110 element itself, its contents or nil when it isn't recursive and
1111 the property list used as a communication channel.
1113 Contents, when not nil, are stripped from any global indentation
1114 \(although the relative one is preserved). They also always end
1115 with a single newline character.
1117 If, for a given type, no function is found, that element or
1118 object type will simply be ignored, along with any blank line or
1119 white space at its end. The same will happen if the function
1120 returns the nil value. If that function returns the empty
1121 string, the type will be ignored, but the blank lines or white
1122 spaces will be kept.
1124 In addition to element and object types, one function can be
1125 associated to the `template' (or `inner-template') symbol and
1126 another one to the `plain-text' symbol.
1128 The former returns the final transcoded string, and can be used
1129 to add a preamble and a postamble to document's body. It must
1130 accept two arguments: the transcoded string and the property list
1131 containing export options. A function associated to `template'
1133 A function associated to `inner-template' is always applied.
1135 The latter, when defined, is to be called on every text not
1136 recognized as an element or an object. It must accept two
1137 arguments: the text string and the information channel. It is an
1138 appropriate place to protect special chars relative to the
1139 back-end.
1141 BODY can start with pre-defined keyword arguments. The following
1142 keywords are understood:
1144 :filters-alist
1146 Alist between filters and function, or list of functions,
1147 specific to the back-end. See `org-export-filters-alist' for
1148 a list of all allowed filters. Filters defined here
1149 shouldn't make a back-end test, as it may prevent back-ends
1150 derived from this one to behave properly.
1152 :menu-entry
1154 Menu entry for the export dispatcher. It should be a list
1155 like:
1159 where :
1161 KEY is a free character selecting the back-end.
1163 DESCRIPTION-OR-ORDINAL is either a string or a number.
1165 If it is a string, is will be used to name the back-end in
1166 its menu entry. If it is a number, the following menu will
1167 be displayed as a sub-menu of the back-end with the same
1168 KEY. Also, the number will be used to determine in which
1169 order such sub-menus will appear (lowest first).
1171 ACTION-OR-MENU is either a function or an alist.
1173 If it is an action, it will be called with four
1174 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1175 BODY-ONLY. See `org-export-as' for further explanations on
1176 some of them.
1178 If it is an alist, associations should follow the
1179 pattern:
1183 where KEY, DESCRIPTION and ACTION are described above.
1185 Valid values include:
1189 or
1194 (lambda (a s v b)
1195 (if a (org-latex-export-to-pdf t s v b)
1196 (org-open-file
1197 (org-latex-export-to-pdf nil s v b)))))))
1199 or the following, which will be added to the previous
1200 sub-menu,
1206 :options-alist
1208 Alist between back-end specific properties introduced in
1209 communication channel and how their value are acquired. See
1210 `org-export-options-alist' for more information about
1211 structure of the values."
1223 :transcoders transcoders
1224 :options options
1225 :filters filters
1229 "Create a new back-end as a variant of an existing one.
1231 CHILD is the name of the derived back-end. PARENT is the name of
1232 the parent back-end.
1234 BODY can start with pre-defined keyword arguments. The following
1235 keywords are understood:
1237 :filters-alist
1239 Alist of filters that will overwrite or complete filters
1240 defined in PARENT back-end. See `org-export-filters-alist'
1241 for a list of allowed filters.
1243 :menu-entry
1245 Menu entry for the export dispatcher. See
1246 `org-export-define-backend' for more information about the
1247 expected value.
1249 :options-alist
1251 Alist of back-end specific properties that will overwrite or
1252 complete those defined in PARENT back-end. Refer to
1253 `org-export-options-alist' for more information about
1254 structure of the values.
1256 :translate-alist
1258 Alist of element and object types and transcoders that will
1259 overwrite or complete transcode table from PARENT back-end.
1260 Refer to `org-export-define-backend' for detailed information
1261 about transcoders.
1264 as a variant of `latex' back-end with a custom template function:
1269 The back-end could then be called with, for example:
1284 :parent parent
1285 :transcoders transcoders
1286 :options options
1287 :filters filters
1291 \f
1292 ;;; The Communication Channel
1293 ;;
1294 ;; During export process, every function has access to a number of
1295 ;; properties. They are of two types:
1296 ;;
1297 ;; 1. Environment options are collected once at the very beginning of
1298 ;; the process, out of the original buffer and configuration.
1299 ;; Collecting them is handled by `org-export-get-environment'
1300 ;; function.
1301 ;;
1302 ;; Most environment options are defined through the
1303 ;; `org-export-options-alist' variable.
1304 ;;
1305 ;; 2. Tree properties are extracted directly from the parsed tree,
1306 ;; just before export, by `org-export--collect-tree-properties'.
1308 ;;;; Environment Options
1309 ;;
1310 ;; Environment options encompass all parameters defined outside the
1311 ;; scope of the parsed data. They come from five sources, in
1312 ;; increasing precedence order:
1313 ;;
1314 ;; - Global variables,
1315 ;; - Buffer's attributes,
1316 ;; - Options keyword symbols,
1317 ;; - Buffer keywords,
1318 ;; - Subtree properties.
1319 ;;
1320 ;; The central internal function with regards to environment options
1321 ;; is `org-export-get-environment'. It updates global variables with
1322 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1323 ;; the different sources.
1324 ;;
1325 ;; The internal functions doing the retrieval are:
1326 ;; `org-export--get-global-options',
1327 ;; `org-export--get-buffer-attributes',
1328 ;; `org-export--parse-option-keyword',
1329 ;; `org-export--get-subtree-options' and
1330 ;; `org-export--get-inbuffer-options'
1331 ;;
1332 ;; Also, `org-export--list-bound-variables' collects bound variables
1333 ;; along with their value in order to set them as buffer local
1334 ;; variables later in the process.
1336 ;;;###autoload
1338 "Collect export options from the current buffer.
1340 Optional argument BACKEND is an export back-end, as returned by
1341 `org-export-create-backend'.
1343 When optional argument SUBTREEP is non-nil, assume the export is
1344 done against the current sub-tree.
1346 Third optional argument EXT-PLIST is a property list with
1347 external parameters overriding Org default settings, but still
1348 inferior to file-local settings."
1349 ;; First install #+BIND variables since these must be set before
1350 ;; global options are read.
1353 ;; Get and prioritize export options...
1355 ;; ... from global variables...
1357 ;; ... from an external property list...
1358 ext-plist
1359 ;; ... from in-buffer settings...
1361 ;; ... and from subtree, when appropriate.
1365 "Parse an OPTIONS line and return values as a plist.
1366 Optional argument BACKEND is an export back-end, as returned by,
1367 e.g., `org-export-create-backend'. It specifies which back-end
1368 specific items to read, if any."
1375 alist))
1376 alist))
1377 ;; Priority is given to back-end specific options.
1379 org-export-options-alist))
1389 "Get export options in subtree at point.
1390 Optional argument BACKEND is an export back-end, as returned by,
1391 e.g., `org-export-create-backend'. It specifies back-end used
1392 for export. Return options as a plist."
1393 ;; For each buffer keyword, create a headline property setting the
1394 ;; same property in communication channel. The name for the
1395 ;; property is the keyword with "EXPORT_" appended to it.
1397 ;; Make sure point is at a heading.
1400 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1401 ;; care of them right from the start.
1404 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1405 ;; headline's title (with no todo keyword, priority cookie or
1406 ;; tag) as its fallback value.
1413 ;; Look for both general keywords and back-end specific
1414 ;; options, with priority given to the latter.
1416 org-export-options-alist)))
1417 ;; Handle other keywords. Then return PLIST.
1431 property
1440 "Return current buffer export options, as a plist.
1442 Optional argument BACKEND, when non-nil, is an export back-end,
1443 as returned by, e.g., `org-export-create-backend'. It specifies
1444 which back-end specific options should also be read in the
1445 process.
1447 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1450 ;; Priority is given to back-end specific options.
1452 org-export-options-alist))
1455 org-export-special-keywords))))
1456 plist to-parse)
1459 ;; Return all properties associated to KEYWORD.
1466 ;; Recursively read keywords in buffer. FILES is
1467 ;; a list of files read so far. PLIST is the current
1468 ;; property list obtained.
1477 ;; Options in `org-export-special-keywords'.
1482 ;; Avoid circular dependencies.
1493 plist
1495 val backend))))
1499 plist
1506 ;; Options in `org-export-options-alist'.
1509 plist
1511 plist property
1512 ;; Handle value depending on specified
1513 ;; BEHAVIOR.
1518 ;; Even if `parse' implies `space'
1519 ;; behavior, we separate line with
1520 ;; "\n" so as to preserve
1521 ;; line-breaks. However, empty
1522 ;; lines are forbidden since `parse'
1523 ;; doesn't allow more than one
1524 ;; paragraph.
1533 " "
1546 ;; Read options in the current buffer and return value.
1548 ;; Parse properties in TO-PARSE. Remove newline characters not
1549 ;; involved in line breaks to simulate `space' behavior.
1550 ;; Finally return options.
1563 "Return properties related to export process, as a plist.
1564 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1565 are like the arguments with the same names of function
1566 `org-export-as'."
1571 :back-end backend
1576 "Return properties related to buffer attributes, as a plist."
1581 "Return global export options as a plist.
1582 Optional argument BACKEND, if non-nil, is an export back-end, as
1583 returned by, e.g., `org-export-create-backend'. It specifies
1584 which back-end specific export options should also be read in the
1585 process."
1587 ;; Priority is given to back-end specific options.
1589 org-export-options-alist)))
1595 plist
1596 prop
1597 ;; Evaluate default value provided.
1602 value)))))))))
1605 "Return variables bound from BIND keywords in current buffer.
1606 Also look for BIND keywords in setup files. The return value is
1607 an alist where associations are (VARIABLE-NAME VALUE)."
1611 ;; Return an alist between variable names and their
1612 ;; value. FILES is a list of setup files names read
1613 ;; so far, used to avoid circular dependencies. ALIST
1614 ;; is the alist collected so far.
1626 ;; Enter setup file.
1638 alist))))))))))
1639 alist)))))
1640 ;; Return value in appropriate order of appearance.
1643 ;; defsubst org-export-get-parent must be defined before first use,
1644 ;; was originally defined in the topology section
1647 "Return BLOB parent or nil.
1648 BLOB is the element or object considered."
1651 ;;;; Tree Properties
1652 ;;
1653 ;; Tree properties are information extracted from parse tree. They
1654 ;; are initialized at the beginning of the transcoding process by
1655 ;; `org-export--collect-tree-properties'.
1656 ;;
1657 ;; Dedicated functions focus on computing the value of specific tree
1658 ;; properties during initialization. Thus,
1659 ;; `org-export--populate-ignore-list' lists elements and objects that
1660 ;; should be skipped during export, `org-export--get-min-level' gets
1661 ;; the minimal exportable level, used as a basis to compute relative
1662 ;; level for headlines. Eventually
1663 ;; `org-export--collect-headline-numbering' builds an alist between
1664 ;; headlines and their numbering.
1667 "Extract tree properties from parse tree.
1669 DATA is the parse tree from which information is retrieved. INFO
1670 is a list holding export options.
1672 Following tree properties are set or updated:
1674 `:headline-offset' Offset between true level of headlines and
1675 local level. An offset of -1 means a headline
1676 of level 2 should be considered as a level
1677 1 headline in the context.
1679 `:headline-numbering' Alist of all headlines as key and the
1680 associated numbering as value.
1682 `:id-alist' Alist of all ID references as key and associated file
1683 as value.
1685 Return updated plist."
1686 ;; Install the parse tree in the communication channel.
1688 ;; Compute `:headline-offset' in order to be able to use
1689 ;; `org-export-get-relative-level'.
1692 :headline-offset
1694 ;; From now on, properties order doesn't matter: get the rest of the
1695 ;; tree properties.
1697 info
1699 :id-alist
1708 "Return minimum exportable headline's level in DATA.
1709 DATA is parsed tree as returned by `org-element-parse-buffer'.
1710 OPTIONS is a plist holding export options."
1719 ;; If no headline was found, for the sake of consistency, set
1720 ;; minimum level to 1 nonetheless.
1724 "Return numbering of all exportable, numbered headlines in a parse tree.
1726 DATA is the parse tree. OPTIONS is the plist holding export
1727 options.
1729 Return an alist whose key is a headline and value is its
1730 associated numbering \(in the shape of a list of numbers) or nil
1731 for a footnotes section."
1740 headline
1742 for n across numbering
1743 for idx from 0 to org-export-max-depth
1747 options)))
1750 "List headlines and inlinetasks with a select tag in their tree.
1751 DATA is parsed data as returned by `org-element-parse-buffer'.
1752 INFO is a plist holding export options."
1755 ;; If FILETAGS contains a select tag, every headline or
1756 ;; inlinetask is returned.
1766 ;; When a select tag is found, mark full
1767 ;; genealogy and every headline within the
1768 ;; tree as acceptable.
1771 genealogy
1774 selected-trees))
1775 ;; If at a headline, continue searching in
1776 ;; tree, recursively.
1785 selected-trees))))
1788 "Non-nil when element or object DATUM should be skipped during export.
1789 OPTIONS is the plist holding export options. SELECTED, when
1790 non-nil, is a list of headlines or inlinetasks belonging to
1791 a tree with a select tag."
1794 ;; Skip all comments and comment blocks. Make to keep maximum
1795 ;; number of blank lines around the comment so as to preserve
1796 ;; local structure of the document upon interpreting it back into
1797 ;; Org syntax.
1803 t)
1809 ;; If `:with-drawers' value starts with `not', ignore
1810 ;; every drawer whose name belong to that list.
1811 ;; Otherwise, ignore drawers whose name isn't in that
1812 ;; list.
1829 ;; Ignore subtrees with an exclude tag.
1832 ;; When a select tag is present in the buffer, ignore any tree
1833 ;; without it.
1835 ;; Ignore commented sub-trees.
1837 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1839 ;; Ignore tasks, if specified by `:with-tasks' property.
1851 properties-set))))))
1862 ;; `:with-timestamps' only applies to isolated timestamps
1863 ;; objects, i.e. timestamp objects in a paragraph containing only
1864 ;; timestamps and whitespaces.
1872 options t))))
1881 \f
1882 ;;; The Transcoder
1883 ;;
1884 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1885 ;; `org-element-parse-buffer') and transcodes it into a specified
1886 ;; back-end output. It takes care of filtering out elements or
1887 ;; objects according to export options and organizing the output blank
1888 ;; lines and white space are preserved. The function memoizes its
1889 ;; results, so it is cheap to call it within transcoders.
1890 ;;
1891 ;; It is possible to modify locally the back-end used by
1892 ;; `org-export-data' or even use a temporary back-end by using
1893 ;; `org-export-data-with-backend'.
1894 ;;
1895 ;; `org-export-transcoder' is an accessor returning appropriate
1896 ;; translator function for a given element or object.
1899 "Return appropriate transcoder for BLOB.
1900 INFO is a plist containing export directives."
1902 ;; Return contents only for complete parse trees.
1908 "Convert DATA into current back-end format.
1910 DATA is a parse tree, an element or an object or a secondary
1911 string. INFO is a plist holding export options.
1913 Return a string."
1915 ;; Handle broken links according to
1916 ;; `org-export-with-broken-links'.
1932 ;; Ignored element/object.
1934 ;; Plain text.
1940 info))
1941 ;; Secondary string.
1944 ;; Element/Object without contents or, as a special
1945 ;; case, headline with archive tag and archived trees
1946 ;; restricted to title only.
1955 ;; Export snippets never return a nil value so
1956 ;; that white spaces following them are never
1957 ;; ignored.
1959 ;; Element/Object with contents.
1972 ;; Elements directly containing
1973 ;; objects must have their indentation
1974 ;; normalized first.
1976 data
1977 ;; When normalizing contents of the
1978 ;; first paragraph in an item or
1979 ;; a footnote definition, ignore
1980 ;; first line's indentation: there is
1981 ;; none and it might be misleading.
1985 data)
1993 info)))))))))
1994 ;; Final result will be memoized before being returned.
1996 data
2000 ;; Append the same white space between elements or objects
2001 ;; as in the original buffer, and call appropriate filters.
2010 info)))
2014 "Convert DATA into BACKEND format.
2016 DATA is an element, an object, a secondary string or a string.
2017 BACKEND is a symbol. INFO is a plist used as a communication
2018 channel.
2020 Unlike to `org-export-with-backend', this function will
2021 recursively convert DATA using BACKEND translation table."
2023 ;; Set-up a new communication channel with translations defined in
2024 ;; BACKEND as the translate table and a new hash table for
2025 ;; memoization.
2028 info
2031 ;; Size of the hash table is reduced since this
2032 ;; function will probably be used on small trees.
2035 ;; Preserve `:internal-references', as those do not depend on
2036 ;; the back-end used; we need to make sure that any new
2037 ;; reference when the temporary back-end was active gets through
2038 ;; the default one.
2043 "Expand a parsed element or object to its original state.
2045 BLOB is either an element or an object. CONTENTS is its
2046 contents, as a string or nil.
2048 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2049 keywords before output."
2055 blob contents))))
2058 \f
2059 ;;; The Filter System
2060 ;;
2061 ;; Filters allow end-users to tweak easily the transcoded output.
2062 ;; They are the functional counterpart of hooks, as every filter in
2063 ;; a set is applied to the return value of the previous one.
2064 ;;
2065 ;; Every set is back-end agnostic. Although, a filter is always
2066 ;; called, in addition to the string it applies to, with the back-end
2067 ;; used as argument, so it's easy for the end-user to add back-end
2068 ;; specific filters in the set. The communication channel, as
2069 ;; a plist, is required as the third argument.
2070 ;;
2071 ;; From the developer side, filters sets can be installed in the
2072 ;; process with the help of `org-export-define-backend', which
2073 ;; internally stores filters as an alist. Each association has a key
2074 ;; among the following symbols and a function or a list of functions
2075 ;; as value.
2076 ;;
2077 ;; - `:filter-options' applies to the property list containing export
2078 ;; options. Unlike to other filters, functions in this list accept
2079 ;; two arguments instead of three: the property list containing
2080 ;; export options and the back-end. Users can set its value through
2081 ;; `org-export-filter-options-functions' variable.
2082 ;;
2083 ;; - `:filter-parse-tree' applies directly to the complete parsed
2084 ;; tree. Users can set it through
2085 ;; `org-export-filter-parse-tree-functions' variable.
2086 ;;
2087 ;; - `:filter-body' applies to the body of the output, before template
2088 ;; translator chimes in. Users can set it through
2089 ;; `org-export-filter-body-functions' variable.
2090 ;;
2091 ;; - `:filter-final-output' applies to the final transcoded string.
2092 ;; Users can set it with `org-export-filter-final-output-functions'
2093 ;; variable.
2094 ;;
2095 ;; - `:filter-plain-text' applies to any string not recognized as Org
2096 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2097 ;; configure it.
2098 ;;
2099 ;; - `:filter-TYPE' applies on the string returned after an element or
2100 ;; object of type TYPE has been transcoded. A user can modify
2101 ;; `org-export-filter-TYPE-functions' to install these filters.
2102 ;;
2103 ;; All filters sets are applied with
2104 ;; `org-export-filter-apply-functions' function. Filters in a set are
2105 ;; applied in a LIFO fashion. It allows developers to be sure that
2106 ;; their filters will be applied first.
2107 ;;
2108 ;; Filters properties are installed in communication channel with
2109 ;; `org-export-install-filters' function.
2110 ;;
2111 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2112 ;; `org-export-before-parsing-hook') are run at the beginning of the
2113 ;; export process and just before parsing to allow for heavy structure
2114 ;; modifications.
2117 ;;;; Hooks
2120 "Hook run at the beginning of the export process.
2122 This is run before include keywords and macros are expanded and
2123 Babel code blocks executed, on a copy of the original buffer
2124 being exported. Visibility and narrowing are preserved. Point
2125 is at the beginning of the buffer.
2127 Every function in this hook will be called with one argument: the
2131 "Hook run before parsing an export buffer.
2133 This is run after include keywords and macros have been expanded
2134 and Babel code blocks executed, on a copy of the original buffer
2135 being exported. Visibility and narrowing are preserved. Point
2136 is at the beginning of the buffer.
2138 Every function in this hook will be called with one argument: the
2142 ;;;; Special Filters
2145 "List of functions applied to the export options.
2146 Each filter is called with two arguments: the export options, as
2147 a plist, and the back-end, as a symbol. It must return
2151 "List of functions applied to the parsed tree.
2152 Each filter is called with three arguments: the parse tree, as
2153 returned by `org-element-parse-buffer', the back-end, as
2154 a symbol, and the communication channel, as a plist. It must
2158 "List of functions applied to plain text.
2159 Each filter is called with three arguments: a string which
2160 contains no Org syntax, the back-end, as a symbol, and the
2161 communication channel, as a plist. It must return a string or
2165 "List of functions applied to transcoded body.
2166 Each filter is called with three arguments: a string which
2167 contains no Org syntax, the back-end, as a symbol, and the
2168 communication channel, as a plist. It must return a string or
2172 "List of functions applied to the transcoded string.
2173 Each filter is called with three arguments: the full transcoded
2174 string, the back-end, as a symbol, and the communication channel,
2175 as a plist. It must return a string that will be used as the
2179 ;;;; Elements Filters
2182 "List of functions applied to a transcoded babel-call.
2183 Each filter is called with three arguments: the transcoded data,
2184 as a string, the back-end, as a symbol, and the communication
2188 "List of functions applied to a transcoded center block.
2189 Each filter is called with three arguments: the transcoded data,
2190 as a string, the back-end, as a symbol, and the communication
2194 "List of functions applied to a transcoded clock.
2195 Each filter is called with three arguments: the transcoded data,
2196 as a string, the back-end, as a symbol, and the communication
2200 "List of functions applied to a transcoded diary-sexp.
2201 Each filter is called with three arguments: the transcoded data,
2202 as a string, the back-end, as a symbol, and the communication
2206 "List of functions applied to a transcoded drawer.
2207 Each filter is called with three arguments: the transcoded data,
2208 as a string, the back-end, as a symbol, and the communication
2212 "List of functions applied to a transcoded dynamic-block.
2213 Each filter is called with three arguments: the transcoded data,
2214 as a string, the back-end, as a symbol, and the communication
2218 "List of functions applied to a transcoded example-block.
2219 Each filter is called with three arguments: the transcoded data,
2220 as a string, the back-end, as a symbol, and the communication
2224 "List of functions applied to a transcoded export-block.
2225 Each filter is called with three arguments: the transcoded data,
2226 as a string, the back-end, as a symbol, and the communication
2230 "List of functions applied to a transcoded fixed-width.
2231 Each filter is called with three arguments: the transcoded data,
2232 as a string, the back-end, as a symbol, and the communication
2236 "List of functions applied to a transcoded footnote-definition.
2237 Each filter is called with three arguments: the transcoded data,
2238 as a string, the back-end, as a symbol, and the communication
2242 "List of functions applied to a transcoded headline.
2243 Each filter is called with three arguments: the transcoded data,
2244 as a string, the back-end, as a symbol, and the communication
2248 "List of functions applied to a transcoded horizontal-rule.
2249 Each filter is called with three arguments: the transcoded data,
2250 as a string, the back-end, as a symbol, and the communication
2254 "List of functions applied to a transcoded inlinetask.
2255 Each filter is called with three arguments: the transcoded data,
2256 as a string, the back-end, as a symbol, and the communication
2260 "List of functions applied to a transcoded item.
2261 Each filter is called with three arguments: the transcoded data,
2262 as a string, the back-end, as a symbol, and the communication
2266 "List of functions applied to a transcoded keyword.
2267 Each filter is called with three arguments: the transcoded data,
2268 as a string, the back-end, as a symbol, and the communication
2272 "List of functions applied to a transcoded latex-environment.
2273 Each filter is called with three arguments: the transcoded data,
2274 as a string, the back-end, as a symbol, and the communication
2278 "List of functions applied to a transcoded node-property.
2279 Each filter is called with three arguments: the transcoded data,
2280 as a string, the back-end, as a symbol, and the communication
2284 "List of functions applied to a transcoded paragraph.
2285 Each filter is called with three arguments: the transcoded data,
2286 as a string, the back-end, as a symbol, and the communication
2290 "List of functions applied to a transcoded plain-list.
2291 Each filter is called with three arguments: the transcoded data,
2292 as a string, the back-end, as a symbol, and the communication
2296 "List of functions applied to a transcoded planning.
2297 Each filter is called with three arguments: the transcoded data,
2298 as a string, the back-end, as a symbol, and the communication
2302 "List of functions applied to a transcoded property-drawer.
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 quote block.
2309 Each filter is called with three arguments: the transcoded quote
2310 data, as a string, the back-end, as a symbol, and the
2311 communication channel, as a plist. It must return a string or
2315 "List of functions applied to a transcoded section.
2316 Each filter is called with three arguments: the transcoded data,
2317 as a string, the back-end, as a symbol, and the communication
2321 "List of functions applied to a transcoded special block.
2322 Each filter is called with three arguments: the transcoded data,
2323 as a string, the back-end, as a symbol, and the communication
2327 "List of functions applied to a transcoded src-block.
2328 Each filter is called with three arguments: the transcoded data,
2329 as a string, the back-end, as a symbol, and the communication
2333 "List of functions applied to a transcoded table.
2334 Each filter is called with three arguments: the transcoded data,
2335 as a string, the back-end, as a symbol, and the communication
2339 "List of functions applied to a transcoded table-cell.
2340 Each filter is called with three arguments: the transcoded data,
2341 as a string, the back-end, as a symbol, and the communication
2345 "List of functions applied to a transcoded table-row.
2346 Each filter is called with three arguments: the transcoded data,
2347 as a string, the back-end, as a symbol, and the communication
2351 "List of functions applied to a transcoded verse block.
2352 Each filter is called with three arguments: the transcoded data,
2353 as a string, the back-end, as a symbol, and the communication
2357 ;;;; Objects Filters
2360 "List of functions applied to transcoded bold text.
2361 Each filter is called with three arguments: the transcoded data,
2362 as a string, the back-end, as a symbol, and the communication
2366 "List of functions applied to transcoded code text.
2367 Each filter is called with three arguments: the transcoded data,
2368 as a string, the back-end, as a symbol, and the communication
2372 "List of functions applied to a transcoded entity.
2373 Each filter is called with three arguments: the transcoded data,
2374 as a string, the back-end, as a symbol, and the communication
2378 "List of functions applied to a transcoded export-snippet.
2379 Each filter is called with three arguments: the transcoded data,
2380 as a string, the back-end, as a symbol, and the communication
2384 "List of functions applied to a transcoded footnote-reference.
2385 Each filter is called with three arguments: the transcoded data,
2386 as a string, the back-end, as a symbol, and the communication
2390 "List of functions applied to a transcoded inline-babel-call.
2391 Each filter is called with three arguments: the transcoded data,
2392 as a string, the back-end, as a symbol, and the communication
2396 "List of functions applied to a transcoded inline-src-block.
2397 Each filter is called with three arguments: the transcoded data,
2398 as a string, the back-end, as a symbol, and the communication
2402 "List of functions applied to transcoded italic text.
2403 Each filter is called with three arguments: the transcoded data,
2404 as a string, the back-end, as a symbol, and the communication
2408 "List of functions applied to a transcoded latex-fragment.
2409 Each filter is called with three arguments: the transcoded data,
2410 as a string, the back-end, as a symbol, and the communication
2414 "List of functions applied to a transcoded line-break.
2415 Each filter is called with three arguments: the transcoded data,
2416 as a string, the back-end, as a symbol, and the communication
2420 "List of functions applied to a transcoded link.
2421 Each filter is called with three arguments: the transcoded data,
2422 as a string, the back-end, as a symbol, and the communication
2426 "List of functions applied to a transcoded radio-target.
2427 Each filter is called with three arguments: the transcoded data,
2428 as a string, the back-end, as a symbol, and the communication
2432 "List of functions applied to a transcoded statistics-cookie.
2433 Each filter is called with three arguments: the transcoded data,
2434 as a string, the back-end, as a symbol, and the communication
2438 "List of functions applied to transcoded strike-through text.
2439 Each filter is called with three arguments: the transcoded data,
2440 as a string, the back-end, as a symbol, and the communication
2444 "List of functions applied to a transcoded subscript.
2445 Each filter is called with three arguments: the transcoded data,
2446 as a string, the back-end, as a symbol, and the communication
2450 "List of functions applied to a transcoded superscript.
2451 Each filter is called with three arguments: the transcoded data,
2452 as a string, the back-end, as a symbol, and the communication
2456 "List of functions applied to a transcoded target.
2457 Each filter is called with three arguments: the transcoded data,
2458 as a string, the back-end, as a symbol, and the communication
2462 "List of functions applied to a transcoded timestamp.
2463 Each filter is called with three arguments: the transcoded data,
2464 as a string, the back-end, as a symbol, and the communication
2468 "List of functions applied to transcoded underline text.
2469 Each filter is called with three arguments: the transcoded data,
2470 as a string, the back-end, as a symbol, and the communication
2474 "List of functions applied to transcoded verbatim text.
2475 Each filter is called with three arguments: the transcoded data,
2476 as a string, the back-end, as a symbol, and the communication
2480 ;;;; Filters Tools
2481 ;;
2482 ;; Internal function `org-export-install-filters' installs filters
2483 ;; hard-coded in back-ends (developer filters) and filters from global
2484 ;; variables (user filters) in the communication channel.
2485 ;;
2486 ;; Internal function `org-export-filter-apply-functions' takes care
2487 ;; about applying each filter in order to a given data. It ignores
2488 ;; filters returning a nil value but stops whenever a filter returns
2489 ;; an empty string.
2492 "Call every function in FILTERS.
2494 Functions are called with three arguments: a value, the export
2495 back-end name and the communication channel. First function in
2496 FILTERS is called with VALUE as its first argument. Second
2497 function in FILTERS is called with the previous result as its
2498 value, etc.
2500 Functions returning nil are skipped. Any function returning the
2501 empty string ends the process, which returns the empty string.
2503 Call is done in a LIFO fashion, to be sure that developer
2504 specified filters, if any, are called first."
2515 "Install filters properties in communication channel.
2516 INFO is a plist containing the current communication channel.
2517 Return the updated communication channel."
2519 ;; Install user-defined filters with `org-export-filters-alist'
2520 ;; and filters already in INFO (through ext-plist mechanism).
2527 ;; Filters in INFO will be called
2528 ;; before those user provided.
2531 default-value)))))
2532 ;; Prepend back-end specific filters to that list.
2534 ;; Single values get consed, lists are appended.
2539 plist key
2542 ;; Return new communication channel.
2546 \f
2547 ;;; Core functions
2548 ;;
2549 ;; This is the room for the main function, `org-export-as', along with
2550 ;; its derivative, `org-export-string-as'.
2551 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2552 ;; function should be added to kill ring.
2553 ;;
2554 ;; Note that `org-export-as' doesn't really parse the current buffer,
2555 ;; but a copy of it (with the same buffer-local variables and
2556 ;; visibility), where macros and include keywords are expanded and
2557 ;; Babel blocks are executed, if appropriate.
2558 ;; `org-export-with-buffer-copy' macro prepares that copy.
2559 ;;
2560 ;; File inclusion is taken care of by
2561 ;; `org-export-expand-include-keyword' and
2562 ;; `org-export--prepare-file-contents'. Structure wise, including
2563 ;; a whole Org file in a buffer often makes little sense. For
2564 ;; example, if the file contains a headline and the include keyword
2565 ;; was within an item, the item should contain the headline. That's
2566 ;; why file inclusion should be done before any structure can be
2567 ;; associated to the file, that is before parsing.
2568 ;;
2569 ;; `org-export-insert-default-template' is a command to insert
2570 ;; a default template (or a back-end specific template) at point or in
2571 ;; current subtree.
2574 "Return a copy of the current buffer.
2575 The copy preserves Org buffer-local variables, visibility and
2576 narrowing."
2582 new-buf))
2585 "Apply BODY in a copy of the current buffer.
2586 The copy preserves local variables, visibility and contents of
2587 the original buffer. Point is at the beginning of the buffer
2588 when BODY is applied."
2597 ;; Kill copy without confirmation.
2603 "Generate a function duplicating BUFFER.
2605 The copy will preserve local variables, visibility, contents and
2606 narrowing of the original buffer. If a region was active in
2607 BUFFER, contents will be narrowed to that region instead.
2609 The resulting function can be evaluated at a later time, from
2610 another buffer, effectively cloning the original buffer there.
2612 The function assumes BUFFER's major mode is `org-mode'."
2616 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2617 ;; already in BUFFER.
2619 ;; Copy specific buffer local variables and variables set
2620 ;; through BIND keywords.
2622 vars)
2630 buffer-file-name
2631 buffer-file-coding-system))
2635 ;; Skip unreadable values, as they cannot be
2636 ;; sent to external process.
2640 vars))))))
2641 ;; Whole buffer contents.
2646 ;; Narrowing.
2650 ;; Current position of point.
2652 ;; Overlays with invisible property.
2661 ov-set)))))))))
2664 "Delete commented trees and commented inlinetasks in the buffer.
2665 Narrowing, if any, is ignored."
2677 "Prune non exportable elements from DATA.
2678 DATA is the parse tree to traverse. INFO is the plist holding
2679 export info. Also set `:ignore-list' in INFO to a list of
2680 objects which should be ignored during export, but not removed
2681 from tree."
2683 ;; First find trees containing a select tag, if any.
2687 ;; Prune non-exportable elements and objects from tree.
2688 ;; As a special case, special rows and cells from tables
2689 ;; are stored in IGNORE, as they still need to be
2690 ;; accessed during export.
2700 ;; If headline is archived but tree below has
2701 ;; to be skipped, remove contents.
2703 ;; Move into recursive objects/elements.
2705 ;; Move into secondary string, if any.
2707 org-element-secondary-value-alist)))
2710 ;; Collect definitions before possibly pruning them so as
2711 ;; to avoid parsing them again if they are required.
2718 f)
2720 ;; If a select tag is active, also ignore the section before the
2721 ;; first headline, if any.
2726 ;; Prune tree and communication channel.
2729 ;; Priority is given to back-end specific options.
2731 org-export-options-alist))
2737 ;; Eventually set `:ignore-list'.
2741 "List footnote definitions missing from TREE.
2742 Missing definitions are searched within DEFINITIONS, which is
2743 a list of footnote definitions or in the widened buffer."
2746 ;; List all footnote labels encountered in DATA. Inline
2747 ;; footnote references are ignored.
2752 defined undefined missing-definitions)
2753 ;; Partition DIRECT-REFERENCES between DEFINED and UNDEFINED
2754 ;; references.
2761 seen)
2766 ;; Complete MISSING-DEFINITIONS by finding the definition of every
2767 ;; undefined label, first by looking into DEFINITIONS, then by
2768 ;; searching the widened buffer. This is a recursive process
2769 ;; since definitions found can themselves contain an undefined
2770 ;; reference.
2777 d))
2778 definitions))
2785 datum
2786 ;; Parse definition with contents.
2797 ;; Look for footnote references within DEFINITION, since
2798 ;; we may need to also find their definition.
2803 ;; MISSING-DEFINITIONS may contain footnote references with inline
2804 ;; definitions. Make sure those are changed into real footnote
2805 ;; definitions.
2812 missing-definitions)))
2815 "Install footnote definitions in tree.
2817 DEFINITIONS is the list of footnote definitions to install. TREE
2818 is the parse tree.
2820 If there is a footnote section in TREE, definitions found are
2821 appended to it. If `org-footnote-section' is non-nil, a new
2822 footnote section containing all definitions is inserted in TREE.
2823 Otherwise, definitions are appended at the end of the section
2824 containing their first reference."
2827 ;; If there is a footnote section, insert definitions there.
2831 nil t)))
2834 footnote-section
2836 ;; If there should be a footnote section, create one containing all
2837 ;; the definitions at the end of the tree.
2840 tree
2844 :title org-footnote-section
2847 'section
2848 nil
2850 ;; Otherwise add each definition at the end of the section where it
2851 ;; is first referenced.
2856 ;; Insert footnote definitions in the same section as
2857 ;; their first reference in DATA.
2868 label)
2869 d))
2870 definitions)))
2873 definition)
2874 ;; Also insert definitions for nested
2875 ;; references, if any.
2880 "Change uninterpreted elements back into Org syntax.
2881 DATA is a parse tree or a secondary string. INFO is a plist
2882 containing export options. It is modified by side effect and
2883 returned by the function."
2886 subscript superscript underline)
2890 ;; ... entities...
2897 ?\s)))))
2898 ;; ... emphasis...
2910 marker
2914 ?\s)))))))
2915 ;; ... LaTeX environments and fragments...
2919 ;; ... sub/superscripts...
2928 "_"
2937 ?\s)))))))))))
2939 ;; Splice NEW at DATUM location in parse tree.
2942 info nil nil t)
2943 ;; Return modified parse tree.
2944 data)
2946 ;;;###autoload
2949 "Transcode current Org buffer into BACKEND code.
2951 BACKEND is either an export back-end, as returned by, e.g.,
2952 `org-export-create-backend', or a symbol referring to
2953 a registered back-end.
2955 If narrowing is active in the current buffer, only transcode its
2956 narrowed part.
2958 If a region is active, transcode that region.
2960 When optional argument SUBTREEP is non-nil, transcode the
2961 sub-tree at point, extracting information from the headline
2962 properties first.
2964 When optional argument VISIBLE-ONLY is non-nil, don't export
2965 contents of hidden elements.
2967 When optional argument BODY-ONLY is non-nil, only return body
2968 code, without surrounding template.
2970 Optional argument EXT-PLIST, when provided, is a property list
2971 with external parameters overriding Org default settings, but
2972 still inferior to file-local settings.
2974 Return code as a string."
2979 ;; Narrow buffer to an appropriate region or subtree for
2980 ;; parsing. If parsing subtree, be sure to remove main
2981 ;; headline, planning data and property drawer.
2989 ;; Initialize communication channel with original buffer
2990 ;; attributes, unavailable in its copy.
2994 backend subtreep visible-only body-only)
3000 org-export-options-alist))))
3001 tree)
3002 ;; Update communication channel and get parse tree. Buffer
3003 ;; isn't parsed directly. Instead, all buffer modifications
3004 ;; and consequent parsing are undertaken in a temporary copy.
3006 ;; Run first hook with current back-end's name as argument.
3009 ;; Include files, delete comments and expand macros.
3014 ;; Refresh buffer properties and radio targets after
3015 ;; potentially invasive previous changes. Likewise, do it
3016 ;; again after executing Babel code.
3023 ;; Run last hook with current back-end's name as argument.
3024 ;; Update buffer properties and radio targets one last time
3025 ;; before parsing.
3032 ;; Update communication channel with environment.
3036 ;; De-activate uninterpreted data from parsed keywords.
3038 org-export-options-alist))
3043 p
3046 ;; Install user's and developer's filters.
3048 ;; Call options filters and update export options. We do not
3049 ;; use `org-export-filter-apply-functions' here since the
3050 ;; arity of such filters is different.
3055 ;; Expand export-specific set of macros: {{{author}}},
3056 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
3057 ;; be done once regular macros have been expanded, since
3058 ;; parsed keywords may contain one of them.
3071 value)
3072 value)))
3076 'finalize
3077 parsed-keywords)
3078 ;; Parse buffer.
3080 ;; Prune tree from non-exported elements and transform
3081 ;; uninterpreted elements or objects in both parse tree and
3082 ;; communication channel.
3085 ;; Call parse tree filters.
3089 ;; Now tree is complete, compute its properties and add them
3090 ;; to communication channel.
3092 ;; Eventually transcode TREE. Wrap the resulting string into
3093 ;; a template.
3102 info))
3105 ;; Remove all text properties since they cannot be
3106 ;; retrieved from an external process. Finally call
3107 ;; final-output filter and return result.
3113 info))))))))
3115 ;;;###autoload
3117 "Transcode STRING into BACKEND code.
3119 BACKEND is either an export back-end, as returned by, e.g.,
3120 `org-export-create-backend', or a symbol referring to
3121 a registered back-end.
3123 When optional argument BODY-ONLY is non-nil, only return body
3124 code, without preamble nor postamble.
3126 Optional argument EXT-PLIST, when provided, is a property list
3127 with external parameters overriding Org default settings, but
3128 still inferior to file-local settings.
3130 Return code as a string."
3136 ;;;###autoload
3138 "Replace the active region by its export to BACKEND.
3139 BACKEND is either an export back-end, as returned by, e.g.,
3140 `org-export-create-backend', or a symbol referring to
3141 a registered back-end."
3147 ;;;###autoload
3149 "Insert all export keywords with default values at beginning of line.
3151 BACKEND is a symbol referring to the name of a registered export
3152 back-end, for which specific export options should be added to
3153 the template, or `default' for default template. When it is nil,
3154 the user will be prompted for a category.
3156 If SUBTREEP is non-nil, export configuration will be set up
3157 locally for the subtree through node properties."
3167 "Options category: "
3171 org-export-registered-backends))
3172 nil t))))
3173 options keywords)
3174 ;; Populate OPTIONS and KEYWORDS.
3191 ;; Move to an appropriate location in order to insert options.
3193 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3211 ;; Then the rest of keywords, in the order specified in either
3212 ;; `org-export-options-alist' or respective export back-ends.
3233 "Expand every include keyword in buffer.
3234 Optional argument INCLUDED is a list of included file names along
3235 with their line restriction, when appropriate. It is used to
3236 avoid infinite recursion. Optional argument DIR is the current
3237 working directory. It is used to properly resolve relative
3238 paths. Optional argument FOOTNOTES is a hash-table used for
3239 storing and resolving footnotes. It is created automatically."
3245 ;; If :minlevel is not set the text-property
3246 ;; `:org-include-induced-level' will be used to determine the
3247 ;; relative level when expanding INCLUDE.
3248 ;; Only affects included Org documents.
3252 :org-include-induced-level
3254 ;; Expand INCLUDE keywords.
3260 ;; Extract arguments from keyword's value.
3263 location
3271 matched)
3277 dir)))
3281 value)
3287 value)
3296 ;; Minimal level of included file defaults to the child
3297 ;; level of the current headline, if any, or one. It
3298 ;; only applies is the file is meant to be included as
3299 ;; an Org one.
3310 ;; Remove keyword.
3316 ;; Check if files has already been parsed. Look after
3317 ;; inclusion lines too, as different parts of the same file
3318 ;; can be included too.
3331 ind-str block arg-str contents ind-str block))))
3338 ind-str block contents ind-str block))))
3346 file location only-contents lines)
3347 lines)))
3351 file lines ind minlevel
3354 footnotes)))
3358 footnotes)
3360 ;; Expand footnotes after all files have been included.
3361 ;; Footnotes are stored at end of buffer.
3366 footnotes)))))))))))
3369 "Resolve absolute lines for an included file with file-link.
3371 FILE is string file-name of the file to include. LOCATION is a
3372 string name within FILE to be included (located via
3373 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3374 contents of the named element will be included, as determined
3375 Org-Element. If LINES is non-nil only those lines are included.
3377 Return a string of lines to be included in the format expected by
3378 `org-export--prepare-file-contents'."
3384 ;; Enforce consistent search.
3397 ;; Skip planning line and property-drawer.
3423 start-line
3425 (+ start-line
3428 counter))))))))
3432 "Prepare contents of FILE for inclusion and return it as a string.
3434 When optional argument LINES is a string specifying a range of
3435 lines, include only those lines.
3437 Optional argument IND, when non-nil, is an integer specifying the
3438 global indentation of returned contents. Since its purpose is to
3439 allow an included file to stay in the same environment it was
3440 created (e.g., a list item), it doesn't apply past the first
3441 headline encountered.
3443 Optional argument MINLEVEL, when non-nil, is an integer
3444 specifying the level that any top-level headline in the included
3445 file should have.
3447 Optional argument ID is an integer that will be inserted before
3448 each footnote definition and reference if FILE is an Org file.
3449 This is useful to avoid conflicts when more than one Org file
3450 with footnotes is included in a document.
3452 Optional argument FOOTNOTES is a hash-table to store footnotes in
3453 the included document."
3469 ;; Remove blank lines at beginning and end of contents. The logic
3470 ;; behind that removal is that blank lines around include keyword
3471 ;; override blank lines in included file.
3480 ;; If IND is set, preserve indentation of include keyword until
3481 ;; the first headline encountered.
3488 ;; Do not move footnote definitions out of column 0.
3494 ;; When MINLEVEL is specified, compute minimal level for headlines
3495 ;; in the file (CUR-MIN), and remove stars to each headline so
3496 ;; that headlines with minimal level have a level of MINLEVEL.
3507 ;; Only change stars, don't bother moving whole
3508 ;; sections.
3513 ;; Append ID to all footnote references and definitions, so they
3514 ;; become file specific and cannot collide with footnotes in other
3515 ;; included files. Further, collect relevant footnote definitions
3516 ;; outside of LINES, in order to reintroduce them later.
3522 ;; Generate new label from LABEL by prefixing it with
3523 ;; "-ID-".
3527 ;; Replace OLD label with NEW in footnote F.
3541 ;; Update the footnote-reference at point and collect
3542 ;; the new label, which is only used for footnotes
3543 ;; outsides LINES.
3555 ;; Store since footnote-definition is
3556 ;; outside of LINES.
3559 footnotes))))
3566 "Return a non-nil value when output should be added to the kill ring.
3567 See also `org-export-copy-to-kill-ring'."
3573 \f
3574 ;;; Tools For Back-Ends
3575 ;;
3576 ;; A whole set of tools is available to help build new exporters. Any
3577 ;; function general enough to have its use across many back-ends
3578 ;; should be added here.
3580 ;;;; For Affiliated Keywords
3581 ;;
3582 ;; `org-export-read-attribute' reads a property from a given element
3583 ;; as a plist. It can be used to normalize affiliated keywords'
3584 ;; syntax.
3585 ;;
3586 ;; Since captions can span over multiple lines and accept dual values,
3587 ;; their internal representation is a bit tricky. Therefore,
3588 ;; `org-export-get-caption' transparently returns a given element's
3589 ;; caption as a secondary string.
3592 "Turn ATTRIBUTE property from ELEMENT into a plist.
3594 When optional argument PROPERTY is non-nil, return the value of
3595 that property within attributes.
3599 properties.
3601 All values will become strings except the empty string and
3604 will become the empty string."
3618 s)
3623 ;; Ignore any string before first property with `cdr'.
3628 "Return caption from ELEMENT as a secondary string.
3630 When optional argument SHORTP is non-nil, return short caption,
3631 as a secondary string, instead.
3633 Caption lines are separated by a white space."
3641 ;;;; For Derived Back-ends
3642 ;;
3643 ;; `org-export-with-backend' is a function allowing to locally use
3644 ;; another back-end to transcode some object or element. In a derived
3645 ;; back-end, it may be used as a fall-back function once all specific
3646 ;; cases have been treated.
3649 "Call a transcoder from BACKEND on DATA.
3650 BACKEND is an export back-end, as returned by, e.g.,
3651 `org-export-create-backend', or a symbol referring to
3652 a registered back-end. DATA is an Org element, object, secondary
3653 string or string. CONTENTS, when non-nil, is the transcoded
3654 contents of DATA element, as a string. INFO, when non-nil, is
3655 the communication channel used for export, as a plist."
3666 :back-end backend
3667 :translate-alist all-transcoders
3669 ;; `:internal-references' are shared across back-ends.
3675 ;;;; For Export Snippets
3676 ;;
3677 ;; Every export snippet is transmitted to the back-end. Though, the
3678 ;; latter will only retain one type of export-snippet, ignoring
3679 ;; others, based on the former's target back-end. The function
3680 ;; `org-export-snippet-backend' returns that back-end for a given
3681 ;; export-snippet.
3684 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3685 Translation, with `org-export-snippet-translation-alist', is
3686 applied."
3690 back-end))))
3693 ;;;; For Footnotes
3694 ;;
3695 ;; `org-export-collect-footnote-definitions' is a tool to list
3696 ;; actually used footnotes definitions in the whole parse tree, or in
3697 ;; a headline, in order to add footnote listings throughout the
3698 ;; transcoded data.
3699 ;;
3700 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3701 ;; back-ends, when they need to attach the footnote definition only to
3702 ;; the first occurrence of the corresponding label.
3703 ;;
3704 ;; `org-export-get-footnote-definition' and
3705 ;; `org-export-get-footnote-number' provide easier access to
3706 ;; additional information relative to a footnote reference.
3709 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3710 INFO is the plist used as a communication channel. If no such
3711 definition can be found, raise an error."
3717 hash))))
3725 ;; Skip any footnote with a different label.
3726 ;; Also skip any standard footnote reference
3727 ;; with the same label since those cannot
3728 ;; contain a definition.
3732 ;; Even if the contents are empty, we can not
3733 ;; return nil since that would eventually raise
3734 ;; the error. Instead, return the equivalent
3735 ;; empty string.
3737 info t)
3738 cache)
3743 "Apply FUNCTION on every footnote reference in DATA.
3744 INFO is a plist containing export state. By default, as soon as
3745 a new footnote reference is encountered, FUNCTION is called onto
3746 its definition. However, if BODY-FIRST is non-nil, this step is
3747 delayed until the end of the process."
3752 ;; Search footnote references through DATA, filling
3753 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3754 ;; store footnote definitions so they can be entered
3755 ;; later.
3762 ;; Search for subsequent references in footnote
3763 ;; definition so numbering follows reading
3764 ;; logic, unless DELAYP in non-nil.
3768 definitions))
3769 ;; Do not force entering inline definitions,
3770 ;; since `org-element-map' already traverses
3771 ;; them at the right time.
3775 nil))))))
3776 info nil
3777 ;; Don't enter footnote definitions since it will
3778 ;; happen when their first reference is found.
3779 ;; Moreover, if DELAYP is non-nil, make sure we
3780 ;; postpone entering definitions of inline references.
3787 "Return an alist between footnote numbers, labels and definitions.
3789 INFO is the current export state, as a plist.
3791 Definitions are collected throughout the whole parse tree, or
3792 DATA when non-nil.
3794 Sorting is done by order of references. As soon as a new
3795 reference is encountered, other references are searched within
3796 its definition. However, if BODY-FIRST is non-nil, this step is
3797 delayed after the whole tree is checked. This alters results
3798 when references are found in footnote definitions.
3800 Definitions either appear as Org data or as a secondary string
3801 for inlined footnotes. Unreferenced definitions are ignored."
3805 ;; Collect footnote number, label and definition.
3816 "Non-nil when a footnote reference is the first one for its label.
3818 FOOTNOTE-REFERENCE is the footnote reference being considered.
3819 INFO is a plist containing current export state.
3821 Search is done throughout the whole parse tree, or DATA when
3822 non-nil.
3824 By default, as soon as a new footnote reference is encountered,
3825 other references are searched within its definition. However, if
3826 BODY-FIRST is non-nil, this step is delayed after the whole tree
3827 is checked. This alters results when references are found in
3828 footnote definitions."
3830 ;; Anonymous footnotes are always a first reference.
3841 "Return number associated to a footnote.
3843 FOOTNOTE is either a footnote reference or a footnote definition.
3844 INFO is the plist containing export state.
3846 Number is unique throughout the whole parse tree, or DATA, when
3847 non-nil.
3849 By default, as soon as a new footnote reference is encountered,
3850 counting process moves into its definition. However, if
3851 BODY-FIRST is non-nil, this step is delayed until the end of the
3852 process, leading to a different order when footnotes are nested."
3861 ;; Anonymous footnote match: return number.
3863 ;; Labels match: return number.
3865 ;; Otherwise store label and increase counter if label
3866 ;; wasn't encountered yet.
3872 ;;;; For Headlines
3873 ;;
3874 ;; `org-export-get-relative-level' is a shortcut to get headline
3875 ;; level, relatively to the lower headline level in the parsed tree.
3876 ;;
3877 ;; `org-export-get-headline-number' returns the section number of an
3878 ;; headline, while `org-export-number-to-roman' allows it to be
3879 ;; converted to roman numbers. With an optional argument,
3880 ;; `org-export-get-headline-number' returns a number to unnumbered
3881 ;; headlines (used for internal id).
3882 ;;
3883 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3884 ;; `org-export-last-sibling-p' are three useful predicates when it
3885 ;; comes to fulfill the `:headline-levels' property.
3886 ;;
3887 ;; `org-export-get-tags', `org-export-get-category' and
3888 ;; `org-export-get-node-property' extract useful information from an
3889 ;; headline or a parent headline. They all handle inheritance.
3890 ;;
3891 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3892 ;; as a secondary string, suitable for table of contents. It falls
3893 ;; back onto default title.
3896 "Return HEADLINE relative level within current parsed tree.
3897 INFO is a plist holding contextual information."
3902 "Non-nil when HEADLINE is considered as low level.
3904 INFO is a plist used as a communication channel.
3906 A low level headlines has a relative level greater than
3907 `:headline-levels' property value.
3909 Return value is the difference between HEADLINE relative level
3910 and the last level being considered as high enough, or nil."
3917 "Return numbered HEADLINE numbering as a list of numbers.
3918 INFO is a plist holding contextual information."
3923 "Return a non-nil value if HEADLINE element should be numbered.
3924 INFO is a plist used as a communication channel."
3933 "Convert integer N into a roman numeral."
3946 res)))
3949 "Return list of tags associated to ELEMENT.
3951 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3952 is a plist used as a communication channel.
3954 When non-nil, optional argument TAGS should be a list of strings.
3955 Any tag belonging to this list will also be removed.
3957 When optional argument INHERITED is non-nil, tags can also be
3958 inherited from parent headlines and FILETAGS keywords."
3962 ;; Build complete list of inherited tags.
3969 ;; Add FILETAGS keywords and return results.
3973 "Return node PROPERTY value for BLOB.
3975 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3976 element or object.
3978 If optional argument INHERITED is non-nil, the value can be
3979 inherited from a parent headline.
3981 Return value is a string or nil."
3993 "Return category for element or object BLOB.
3995 INFO is a plist used as a communication channel.
3997 CATEGORY is automatically inherited from a parent headline, from
3998 #+CATEGORY: keyword or created out of original file name. If all
4011 "Return alternative title for HEADLINE, as a secondary string.
4012 If no optional title is defined, fall-back to the regular title."
4019 "Non-nil when BLOB is the first sibling in its parent.
4020 BLOB is an element or an object. If BLOB is a headline, non-nil
4021 means it is the first sibling in the sub-tree. INFO is a plist
4022 used as a communication channel."
4027 "Non-nil when BLOB is the last sibling in its parent.
4028 BLOB is an element or an object. INFO is a plist used as
4029 a communication channel."
4033 ;;;; For Keywords
4034 ;;
4035 ;; `org-export-get-date' returns a date appropriate for the document
4036 ;; to about to be exported. In particular, it takes care of
4037 ;; `org-export-date-timestamp-format'.
4040 "Return date value for the current document.
4042 INFO is a plist used as a communication channel. FMT, when
4043 non-nil, is a time format string that will be applied on the date
4044 if it consists in a single timestamp object. It defaults to
4045 `org-export-date-timestamp-format' when nil.
4047 A proper date can be a secondary string, a string or nil. It is
4048 meant to be translated with `org-export-data' or alike."
4059 ;;;; For Links
4060 ;;
4061 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4062 ;; in `org-link-parameters'.
4063 ;;
4064 ;; `org-export-get-coderef-format' returns an appropriate format
4065 ;; string for coderefs.
4066 ;;
4067 ;; `org-export-inline-image-p' returns a non-nil value when the link
4068 ;; provided should be considered as an inline image.
4069 ;;
4070 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4071 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4072 ;; returns an appropriate unique identifier.
4073 ;;
4074 ;; `org-export-resolve-id-link' returns the first headline with
4075 ;; specified id or custom-id in parse tree, the path to the external
4076 ;; file with the id.
4077 ;;
4078 ;; `org-export-resolve-coderef' associates a reference to a line
4079 ;; number in the element it belongs, or returns the reference itself
4080 ;; when the element isn't numbered.
4081 ;;
4082 ;; `org-export-file-uri' expands a filename as stored in :path value
4083 ;; of a "file" link into a file URI.
4084 ;;
4085 ;; Broken links raise a `org-link-broken' error, which is caught by
4086 ;; `org-export-data' for further processing, depending on
4087 ;; `org-export-with-broken-links' value.
4092 "Try exporting LINK with a dedicated function.
4094 DESC is its description, as a string, or nil. BACKEND is the
4095 back-end used for export, as a symbol.
4097 Return output as a string, or nil if no protocol handles LINK.
4099 A custom protocol has precedence over regular back-end export.
4100 The function ignores links with an implicit type (e.g.,
4109 desc
4110 backend))))))
4113 "Return format string for code reference link.
4114 PATH is the link path. DESC is its description."
4122 "Non-nil if LINK object points to an inline image.
4124 Optional argument is a set of RULES defining inline images. It
4125 is an alist where associations have the following shape:
4127 (TYPE . REGEXP)
4129 Applying a rule means apply REGEXP against LINK's path when its
4130 type is TYPE. The function will return a non-nil value if any of
4131 the provided rules is non-nil. The default rule is
4132 `org-export-default-inline-image-rule'.
4134 This only applies to links without a description."
4145 "Resolve a code reference REF.
4147 INFO is a plist used as a communication channel.
4149 Return associated line number in source code, or REF itself,
4150 depending on src-block or example element's switches. Throw an
4151 error if no block contains REF."
4157 org-coderef-label-format))
4159 ;; Element containing REF is found. Resolve it to
4160 ;; either a label or a line number, as needed.
4169 "List search cells for element or object DATUM.
4171 A search cell follows the pattern (TYPE . SEARCH) where
4173 TYPE is a symbol among `headline', `custom-id', `target' and
4174 `other'.
4176 SEARCH is the string a link is expected to match. More
4177 accurately, it is
4179 - headline's title, as a list of strings, if TYPE is
4180 `headline'.
4182 - CUSTOM_ID value, as a string, if TYPE is `custom-id'.
4184 - target's or radio-target's name as a list of strings if
4185 TYPE is `target'.
4187 - NAME affiliated keyword is TYPE is `other'.
4189 A search cell is the internal representation of a fuzzy link. It
4190 ignores white spaces and statistics cookies, if applicable."
4192 (`headline
4203 (`target
4211 "Return search cells associated to string S.
4212 S is either the path of a fuzzy link or a search option, i.e., it
4213 tries to match either a headline (through custom ID or title),
4214 a target or a named element."
4222 "Non-nil when DATUM matches search cells CELLS.
4223 DATUM is an element or object. CELLS is a list of search cells,
4224 as returned by `org-export-search-cells'."
4229 "Return LINK destination.
4231 INFO is a plist holding contextual information.
4233 Return value can be an object or an element:
4235 - If LINK path matches a target object (i.e. <<path>>) return it.
4237 - If LINK path exactly matches the name affiliated keyword
4238 (i.e. #+NAME: path) of an element, return that element.
4240 - If LINK path exactly matches any headline name, return that
4241 element.
4243 - Otherwise, throw an error.
4246 significant."
4252 :resolve-fuzzy-link-cache
4262 datum)))))
4266 search-cells
4267 ;; There can be multiple matches for un-typed searches, i.e.,
4268 ;; for searches not starting with # or *. In this case,
4269 ;; prioritize targets and names over headline titles.
4270 ;; Matching both a name and a target is not valid, and
4271 ;; therefore undefined.
4274 datum))
4275 matches)
4277 link-cache)))))
4280 "Return headline referenced as LINK destination.
4282 INFO is a plist used as a communication channel.
4284 Return value can be the headline element matched in current parse
4288 ;; First check if id is within the current parse tree.
4293 headline))
4295 ;; Otherwise, look for external files.
4300 "Return radio-target object referenced as LINK destination.
4302 INFO is a plist used as a communication channel.
4304 Return value can be a radio-target object or nil. Assume LINK
4313 nil nil path nil nil t)
4314 t)
4315 radio))
4319 "Return file URI associated to FILENAME."
4326 fullname)))))
4328 ;;;; For References
4329 ;;
4330 ;; `org-export-get-reference' associate a unique reference for any
4331 ;; object or element. It uses `org-export-new-reference' and
4332 ;; `org-export-format-reference' to, respectively, generate new
4333 ;; internal references and turn them into a string suitable for
4334 ;; output.
4335 ;;
4336 ;; `org-export-get-ordinal' associates a sequence number to any object
4337 ;; or element.
4340 "Return a unique reference, among REFERENCES.
4341 REFERENCES is an alist whose values are in-use references, as
4342 numbers. Returns a number, which is the internal representation
4343 of a reference. See also `org-export-format-reference'."
4344 ;; Generate random 7 digits hexadecimal numbers. Collisions
4345 ;; increase exponentially with the numbers of references. However,
4346 ;; the odds for encountering at least one collision with 1000 active
4347 ;; references in the same document are roughly 0.2%, so this
4348 ;; shouldn't be the bottleneck.
4351 new))
4354 "Format REFERENCE into a string.
4355 REFERENCE is a number representing a reference, as returned by
4356 `org-export-new-reference', which see."
4360 "Return a unique reference for DATUM, as a string.
4362 DATUM is either an element or an object. INFO is the current
4363 export state, as a plist.
4365 This function checks `:crossrefs' property in INFO for search
4366 cells matching DATUM before creating a new reference. Returned
4367 reference consists of alphanumeric characters only."
4372 ;; Preserve any pre-existing association between
4373 ;; a search cell and a reference, i.e., when some
4374 ;; previously published document referenced a location
4375 ;; within current file (see
4376 ;; `org-publish-resolve-external-link').
4377 ;;
4378 ;; However, there is no guarantee that search cells are
4379 ;; unique, e.g., there might be duplicate custom ID or
4380 ;; two headings with the same title in the file.
4381 ;;
4382 ;; As a consequence, before re-using any reference to
4383 ;; an element or object, we check that it doesn't refer
4384 ;; to a previous element or object.
4391 cells)
4394 ;; Cache contains both data already associated to
4395 ;; a reference and in-use internal references, so as to make
4396 ;; unique references.
4398 ;; Retain a direct association between reference string and
4399 ;; DATUM since (1) not every object or element can be given
4400 ;; a search cell (2) it permits quick lookup.
4403 reference-string))))
4406 "Return ordinal number of an element or object.
4408 ELEMENT is the element or object considered. INFO is the plist
4409 used as a communication channel.
4411 Optional argument TYPES, when non-nil, is a list of element or
4412 object types, as symbols, that should also be counted in.
4413 Otherwise, only provided element's type is considered.
4415 Optional argument PREDICATE is a function returning a non-nil
4416 value if the current element or object should be counted in. It
4417 accepts two arguments: the element or object being considered and
4418 the plist used as a communication channel. This allows counting
4419 only a certain type of object (i.e. inline images).
4421 Return value is a list of numbers if ELEMENT is a headline or an
4422 item. It is nil for keywords. It represents the footnote number
4423 for footnote definitions and footnote references. If ELEMENT is
4424 a target, return the same value as if ELEMENT was the closest
4425 table, item or headline containing the target. In any other
4426 case, return the sequence number of ELEMENT among elements or
4427 objects of the same type."
4428 ;; Ordinal of a target object refer to the ordinal of the closest
4429 ;; table, item, or headline containing the object.
4433 element
4436 ;; Special case 1: A headline returns its number as a list.
4438 ;; Special case 2: An item returns its number as a list.
4442 struct
4449 ;; Increment counter until ELEMENT is found again.
4460 ;;;; For Src-Blocks
4461 ;;
4462 ;; `org-export-get-loc' counts number of code lines accumulated in
4463 ;; src-block or example-block elements with a "+n" switch until
4464 ;; a given element, excluded. Note: "-n" switches reset that count.
4465 ;;
4466 ;; `org-export-unravel-code' extracts source code (along with a code
4467 ;; references alist) from an `element-block' or `src-block' type
4468 ;; element.
4469 ;;
4470 ;; `org-export-format-code' applies a formatting function to each line
4471 ;; of code, providing relative line number and code reference when
4472 ;; appropriate. Since it doesn't access the original element from
4473 ;; which the source code is coming, it expects from the code calling
4474 ;; it to know if lines should be numbered and if code references
4475 ;; should appear.
4476 ;;
4477 ;; Eventually, `org-export-format-code-default' is a higher-level
4478 ;; function (it makes use of the two previous functions) which handles
4479 ;; line numbering and code references inclusion, and returns source
4480 ;; code in a format suitable for plain text or verbatim output.
4483 "Return count of lines of code before ELEMENT.
4485 ELEMENT is an example-block or src-block element. INFO is the
4486 plist used as a communication channel.
4488 Count includes every line of code in example-block or src-block
4490 ELEMENT doesn't allow line numbering."
4497 ;; ELEMENT is reached: Quit loop and return locs.
4499 ;; Only count lines from src-block and example-block
4500 ;; elements with a "+n" or "-n" switch.
4505 ;; Accumulate locs or reset them.
4513 "Clean source code and extract references out of it.
4515 ELEMENT has either a `src-block' an `example-block' type.
4517 Return a cons cell whose CAR is the source code, cleaned from any
4518 reference, protective commas and spurious indentation, and CDR is
4519 an alist between relative line number (integer) and name of code
4520 reference on that line (string)."
4523 ;; Remove global indentation from code, if necessary. Also
4524 ;; remove final newline character, since it doesn't belongs
4525 ;; to the code proper.
4530 value
4532 ;; Build a regexp matching a loc with a reference.
4534 ;; Return value.
4536 ;; Code with references removed.
4541 ;; Ref line: remove ref, and add its position in REFS.
4545 ;; Reference alist.
4546 refs)))
4549 "Format CODE by applying FUN line-wise and return it.
4551 CODE is a string representing the code to format. FUN is
4552 a function. It must accept three arguments: a line of
4553 code (string), the current line number (integer) or nil and the
4554 reference associated to the current line (string) or nil.
4556 Optional argument NUM-LINES can be an integer representing the
4557 number of code lines accumulated until the current code. Line
4558 numbers passed to FUN will take it into account. If it is nil,
4559 FUN's second argument will always be nil. This number can be
4560 obtained with `org-export-get-loc' function.
4562 Optional argument REF-ALIST can be an alist between relative line
4563 number (i.e. ignoring NUM-LINES) and the name of the code
4564 reference on it. If it is nil, FUN's third argument will always
4565 be nil. It can be obtained through the use of
4566 `org-export-unravel-code' function."
4579 "Return source code from ELEMENT, formatted in a standard way.
4581 ELEMENT is either a `src-block' or `example-block' element. INFO
4582 is a plist used as a communication channel.
4584 This function takes care of line numbering and code references
4585 inclusion. Line numbers, when applicable, appear at the
4586 beginning of the line, separated from the code by two white
4587 spaces. Code references, on the other hand, appear flushed to
4588 the right, separated by six white spaces from the widest line of
4589 code."
4590 ;; Extract code and references.
4597 ;; Handle line numbering.
4604 ;; Prepare references display, if required. Any reference
4605 ;; should start six columns after the widest line of code,
4606 ;; wrapped with parenthesis.
4611 code
4615 number-str
4616 loc
4620 ?\s)
4622 num-start refs)))))
4625 ;;;; For Tables
4626 ;;
4627 ;; `org-export-table-has-special-column-p' and and
4628 ;; `org-export-table-row-is-special-p' are predicates used to look for
4629 ;; meta-information about the table structure.
4630 ;;
4631 ;; `org-table-has-header-p' tells when the rows before the first rule
4632 ;; should be considered as table's header.
4633 ;;
4634 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4635 ;; and `org-export-table-cell-borders' extract information from
4636 ;; a table-cell element.
4637 ;;
4638 ;; `org-export-table-dimensions' gives the number on rows and columns
4639 ;; in the table, ignoring horizontal rules and special columns.
4640 ;; `org-export-table-cell-address', given a table-cell object, returns
4641 ;; the absolute address of a cell. On the other hand,
4642 ;; `org-export-get-table-cell-at' does the contrary.
4643 ;;
4644 ;; `org-export-table-cell-starts-colgroup-p',
4645 ;; `org-export-table-cell-ends-colgroup-p',
4646 ;; `org-export-table-row-starts-rowgroup-p',
4647 ;; `org-export-table-row-ends-rowgroup-p',
4648 ;; `org-export-table-row-starts-header-p',
4649 ;; `org-export-table-row-ends-header-p' and
4650 ;; `org-export-table-row-in-header-p' indicate position of current row
4651 ;; or cell within the table.
4654 "Non-nil when TABLE has a special column.
4655 All special columns will be ignored during export."
4656 ;; The table has a special column when every first cell of every row
4657 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4658 ;; "*" "_" and "^". Though, do not consider a first row containing
4659 ;; only empty cells as special.
4673 "Non-nil when TABLE has a header.
4675 INFO is a plist used as a communication channel.
4677 A table has a header when it contains at least two row groups."
4686 table
4697 cache)))))
4700 "Non-nil if TABLE-ROW is considered special.
4701 All special rows will be ignored during export."
4705 ;; A row is special either when...
4707 ;; ... it starts with a field only containing "/",
4709 ;; ... the table contains a special column and the row start
4710 ;; with a marking character among, "^", "_", "$" or "!",
4714 ;; ... it contains only alignment cookies and empty cells.
4719 ;; Since VALUE is a secondary string, the following
4720 ;; checks avoid expanding it with `org-export-data'.
4731 "Return TABLE-ROW's group number, as an integer.
4733 INFO is a plist used as the communication channel.
4735 Return value is the group number, as an integer, or nil for
4736 special rows and rows separators. First group is also table's
4737 header."
4755 "Return TABLE-CELL contents width.
4757 INFO is a plist used as the communication channel.
4759 Return value is the width given by the last width cookie in the
4760 same column as TABLE-CELL, or nil."
4779 ;; In a special row, try to find a width cookie at COLUMN.
4783 ;; The following checks avoid expanding unnecessarily
4784 ;; the cell with `org-export-data'.
4794 "Return TABLE-CELL contents alignment.
4796 INFO is a plist used as the communication channel.
4798 Return alignment as specified by the last alignment cookie in the
4799 same column as TABLE-CELL. If no such cookie is found, a default
4800 alignment value will be deduced from fraction of numbers in the
4801 column (see `org-table-number-fraction' for more information).
4802 Possible values are `left', `right' and `center'."
4803 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4820 cookie-align
4821 previous-cell-number-p)
4824 ;; In a special row, try to find an alignment cookie at
4825 ;; COLUMN.
4829 ;; Since VALUE is a secondary string, the following
4830 ;; checks avoid useless expansion through
4831 ;; `org-export-data'.
4839 ;; Ignore table rules.
4841 ;; In a standard row, check if cell's contents are
4842 ;; expressing some kind of number. Increase NUMBER-CELLS
4843 ;; accordingly. Though, don't bother if an alignment
4844 ;; cookie has already defined cell's alignment.
4849 info)))
4851 ;; Treat an empty cell as a number if it follows
4852 ;; a number.
4858 ;; Return value. Alignment specified by cookies has
4859 ;; precedence over alignment deduced from cell's contents.
4861 column
4866 org-table-number-fraction)
4871 "Return TABLE-CELL borders.
4873 INFO is a plist used as a communication channel.
4875 Return value is a list of symbols, or nil. Possible values are:
4876 `top', `bottom', `above', `below', `left' and `right'. Note:
4877 `top' (resp. `bottom') only happen for a cell in the first
4878 row (resp. last row) of the table, ignoring table rules, if any.
4880 Returned borders ignore special rows."
4883 borders)
4884 ;; Top/above border? TABLE-CELL has a border above when a rule
4885 ;; used to demarcate row groups can be found above. Hence,
4886 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4887 ;; another regular row has to be found above that rule.
4890 ;; Look at every row before the current one.
4897 ;; No rule above, or rule found starts the table (ignoring any
4898 ;; special row): TABLE-CELL is at the top of the table.
4901 ;; Bottom/below border? TABLE-CELL has a border below when next
4902 ;; non-regular row below is a rule.
4905 ;; Look at every row after the current one.
4912 ;; No rule below, or rule found ends the table (modulo some
4913 ;; special row): TABLE-CELL is at the bottom of the table.
4916 ;; Right/left borders? They can only be specified by column
4917 ;; groups. Column groups are defined in a row starting with "/".
4918 ;; Also a column groups row only contains "<", "<>", ">" or blank
4919 ;; cells.
4923 ;; Table rows are read in reverse order so last column groups
4924 ;; row has precedence over any previous one.
4937 ;; There's a left border when previous cell, if
4938 ;; any, ends a group, or current one starts one.
4944 ;; There's a right border when next cell, if any,
4945 ;; starts a group, or current one ends one.
4952 ;; Return value.
4953 borders))
4956 "Non-nil when TABLE-CELL is at the beginning of a column group.
4957 INFO is a plist used as a communication channel."
4958 ;; A cell starts a column group either when it is at the beginning
4959 ;; of a row (or after the special column, if any) or when it has
4960 ;; a left border.
4963 table-cell)
4967 "Non-nil when TABLE-CELL is at the end of a column group.
4968 INFO is a plist used as a communication channel."
4969 ;; A cell ends a column group either when it is at the end of a row
4970 ;; or when it has a right border.
4973 table-cell)
4977 "Non-nil when TABLE-ROW is at the beginning of a row group.
4978 INFO is a plist used as a communication channel."
4986 "Non-nil when TABLE-ROW is at the end of a row group.
4987 INFO is a plist used as a communication channel."
4995 "Non-nil when TABLE-ROW is located within table's header.
4996 INFO is a plist used as a communication channel. Always return
4997 nil for special rows and rows separators."
5003 "Non-nil when TABLE-ROW is the first table header's row.
5004 INFO is a plist used as a communication channel."
5009 "Non-nil when TABLE-ROW is the last table header's row.
5010 INFO is a plist used as a communication channel."
5015 "Return TABLE-ROW number.
5016 INFO is a plist used as a communication channel. Return value is
5017 zero-based and ignores separators. The function returns nil for
5018 special columns and separators."
5030 "Return TABLE dimensions.
5032 INFO is a plist used as a communication channel.
5034 Return value is a CONS like (ROWS . COLUMNS) where
5035 ROWS (resp. COLUMNS) is the number of exportable
5036 rows (resp. columns)."
5038 ;; Set number of rows, and extract first one.
5044 ;; Set number of columns.
5046 ;; Return value.
5050 "Return address of a regular TABLE-CELL object.
5052 TABLE-CELL is the cell considered. INFO is a plist used as
5053 a communication channel.
5055 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5056 zero-based index. Only exportable cells are considered. The
5057 function returns nil for other cells."
5069 "Return regular table-cell object at ADDRESS in TABLE.
5071 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5072 zero-based index. TABLE is a table type element. INFO is
5073 a plist used as a communication channel.
5075 If no table-cell, among exportable cells, is found at ADDRESS,
5076 return nil."
5079 ;; Row at (car address) or nil.
5087 'table-cell
5094 ;;;; For Tables Of Contents
5095 ;;
5096 ;; `org-export-collect-headlines' builds a list of all exportable
5097 ;; headline elements, maybe limited to a certain depth. One can then
5098 ;; easily parse it and transcode it.
5099 ;;
5100 ;; Building lists of tables, figures or listings is quite similar.
5101 ;; Once the generic function `org-export-collect-elements' is defined,
5102 ;; `org-export-collect-tables', `org-export-collect-figures' and
5103 ;; `org-export-collect-listings' can be derived from it.
5106 "Collect headlines in order to build a table of contents.
5108 INFO is a plist used as a communication channel.
5110 When optional argument N is an integer, it specifies the depth of
5111 the table of contents. Otherwise, it is set to the value of the
5112 last headline level. See `org-export-headline-levels' for more
5113 information.
5115 Optional argument SCOPE, when non-nil, is an element. If it is
5116 a headline, only children of SCOPE are collected. Otherwise,
5117 collect children of the headline containing provided element. If
5118 there is no such headline, collect all headlines. In any case,
5119 argument N becomes relative to the level of that headline.
5121 Return a list of all exportable headlines as parsed elements.
5122 Footnote sections are ignored."
5131 limit))))
5137 info)))
5140 "Collect referenceable elements of a determined type.
5142 TYPE can be a symbol or a list of symbols specifying element
5143 types to search. Only elements with a caption are collected.
5145 INFO is a plist used as a communication channel.
5147 When non-nil, optional argument PREDICATE is a function accepting
5148 one argument, an element of type TYPE. It returns a non-nil
5149 value when that element should be collected.
5151 Return a list of all elements found, in order of appearance."
5156 element))
5157 info))
5160 "Build a list of tables.
5161 INFO is a plist used as a communication channel.
5163 Return a list of table elements with a caption."
5167 "Build a list of figures.
5169 INFO is a plist used as a communication channel. PREDICATE is
5170 a function which accepts one argument: a paragraph element and
5171 whose return value is non-nil when that element should be
5172 collected.
5174 A figure is a paragraph type element, with a caption, verifying
5176 a vague concept that may depend on back-end.
5178 Return a list of elements recognized as figures."
5182 "Build a list of src blocks.
5184 INFO is a plist used as a communication channel.
5186 Return a list of src-block elements with a caption."
5190 ;;;; Smart Quotes
5191 ;;
5192 ;; The main function for the smart quotes sub-system is
5193 ;; `org-export-activate-smart-quotes', which replaces every quote in
5194 ;; a given string from the parse tree with its "smart" counterpart.
5195 ;;
5196 ;; Dictionary for smart quotes is stored in
5197 ;; `org-export-smart-quotes-alist'.
5201 ;; one may use: »...«, "...", ›...‹, or '...'.
5202 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5203 ;; LaTeX quotes require Babel!
5263 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5274 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5285 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5296 ;; 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
5297 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5308 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5314 "Smart quotes translations.
5316 Alist whose CAR is a language string and CDR is an alist with
5317 quote type as key and a plist associating various encodings to
5318 their translation as value.
5320 A quote type can be any symbol among `primary-opening',
5321 `primary-closing', `secondary-opening', `secondary-closing' and
5322 `apostrophe'.
5324 Valid encodings include `:utf-8', `:html', `:latex' and
5325 `:texinfo'.
5330 "Return smart quote status at the beginning of string S.
5331 INFO is the current export state, as a plist."
5336 table)))
5344 'plain-text
5353 ;; Not already in a level 1 quote: this is an
5354 ;; apostrophe.
5356 ;; Extract previous char and next char. As
5357 ;; a special case, they can also be set to `blank',
5358 ;; `no-blank' or nil. Then determine if current
5359 ;; match is allowed as an opening quote or a closing
5360 ;; quote.
5365 text info)))
5382 previous)
5393 next)
5400 current-status)
5404 info nil org-element-recursive-objects)
5411 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5412 `:utf-8'. INFO is a plist used as a communication channel.
5414 The function has to retrieve information about string
5415 surroundings in parse tree. It can only happen with an
5416 unmodified string. Thus, if S has already been through another
5417 process, a non-nil ORIGINAL optional argument will provide that
5418 original string.
5420 Return the new string."
5429 org-export-smart-quotes-alist))))
5430 encoding)
5431 match))
5432 s nil t)))
5434 ;;;; Topology
5435 ;;
5436 ;; Here are various functions to retrieve information about the
5437 ;; neighborhood of a given element or object. Neighbors of interest
5438 ;; are direct parent (`org-export-get-parent'), parent headline
5439 ;; (`org-export-get-parent-headline'), first element containing an
5440 ;; object, (`org-export-get-parent-element'), parent table
5441 ;; (`org-export-get-parent-table'), previous element or object
5442 ;; (`org-export-get-previous-element') and next element or object
5443 ;; (`org-export-get-next-element').
5445 ;; defsubst org-export-get-parent must be defined before first use
5448 "Return BLOB parent headline or nil.
5449 BLOB is the element or object being considered."
5453 "Return first element containing OBJECT or nil.
5454 OBJECT is the object to consider."
5458 "Return OBJECT parent table or nil.
5459 OBJECT is either a `table-cell' or `table-element' type object."
5463 "Return previous element or object.
5465 BLOB is an element or object. INFO is a plist used as
5466 a communication channel. Return previous exportable element or
5467 object, a string, or nil.
5469 When optional argument N is a positive integer, return a list
5470 containing up to N siblings before BLOB, from farthest to
5471 closest. With any other non-nil value, return a list containing
5472 all of them."
5478 prev)
5488 "Return next element or object.
5490 BLOB is an element or object. INFO is a plist used as
5491 a communication channel. Return next exportable element or
5492 object, a string, or nil.
5494 When optional argument N is a positive integer, return a list
5495 containing up to N siblings after BLOB, from closest to farthest.
5496 With any other non-nil value, return a list containing all of
5497 them."
5504 next)
5514 ;;;; Translation
5515 ;;
5516 ;; `org-export-translate' translates a string according to the language
5517 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5518 ;; the dictionary used for the translation.
5550 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5560 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5566 ("ru" :html "(Продолжение следует)"
5643 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5666 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5672 ("ru" :html "Список распечаток"
5687 ("ru" :html "Список таблиц"
5804 ("ru" :html "Неизвестная ссылка"
5807 "Dictionary for export engine.
5809 Alist whose car is the string to translate and cdr is an alist
5810 whose car is the language string and cdr is a plist whose
5811 properties are possible charsets and values translated terms.
5813 It is used as a database for `org-export-translate'. Since this
5814 function returns the string as-is if no translation was found,
5815 the variable only needs to record values different from the
5819 "Translate string S according to language specification.
5821 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5822 and `:utf-8'. INFO is a plist used as a communication channel.
5824 Translation depends on `:language' property. Return the
5825 translated string. If no translation is found, try to fall back
5826 to `:default' encoding. If it fails, return S."
5832 s)))
5835 \f
5836 ;;; Asynchronous Export
5837 ;;
5838 ;; `org-export-async-start' is the entry point for asynchronous
5839 ;; export. It recreates current buffer (including visibility,
5840 ;; narrowing and visited file) in an external Emacs process, and
5841 ;; evaluates a command there. It then applies a function on the
5842 ;; returned results in the current process.
5843 ;;
5844 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5845 ;; allow exporting to a buffer or a file, asynchronously or not.
5846 ;;
5847 ;; `org-export-output-file-name' is an auxiliary function meant to be
5848 ;; used with `org-export-to-file'. With a given extension, it tries
5849 ;; to provide a canonical file name to write export output to.
5850 ;;
5851 ;; Asynchronously generated results are never displayed directly.
5852 ;; Instead, they are stored in `org-export-stack-contents'. They can
5853 ;; then be retrieved by calling `org-export-stack'.
5854 ;;
5855 ;; Export Stack is viewed through a dedicated major mode
5856 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5857 ;;`org-export-stack-delete', `org-export-stack-view' and
5858 ;;`org-export-stack-clear'.
5859 ;;
5860 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5861 ;; It should be used whenever `org-export-async-start' is called.
5864 "Call function FUN on the results returned by BODY evaluation.
5866 FUN is an anonymous function of one argument. BODY evaluation
5867 happens in an asynchronous process, from a buffer which is an
5868 exact copy of the current one.
5870 Use `org-export-add-to-stack' in FUN in order to register results
5871 in the stack.
5873 This is a low level function. See also `org-export-to-buffer'
5874 and `org-export-to-file' for more specialized functions."
5877 ;; Write the full sexp evaluating BODY in a copy of the current
5878 ;; buffer to a temporary file, as it may be too long for program
5879 ;; args in `start-process'.
5886 ;; Null characters (from variable values) are inserted
5887 ;; within the file. As a consequence, coding system for
5888 ;; buffer contents will not be recognized properly. So,
5889 ;; we make sure it is the same as the one used to display
5890 ;; the original buffer.
5892 ,coding
5895 ;; Ignore `kill-emacs-hook' and code evaluation
5896 ;; queries from Babel as we need a truly
5897 ;; non-interactive process.
5899 org-babel-confirm-evaluate-answer-no t)
5900 ;; Initialize export framework.
5902 ;; Re-create current buffer there.
5905 ;; Sexp to evaluate in the buffer.
5907 ;; Start external process.
5910 (,process
5912 #'start-process
5915 ,proc-buffer
5922 ;; Register running process in stack.
5924 ;; Set-up sentinel in order to catch results.
5927 ,process
5949 ;;;###autoload
5952 &optional async subtreep visible-only body-only ext-plist
5953 post-process)
5954 "Call `org-export-as' with output to a specified buffer.
5956 BACKEND is either an export back-end, as returned by, e.g.,
5957 `org-export-create-backend', or a symbol referring to
5958 a registered back-end.
5960 BUFFER is the name of the output buffer. If it already exists,
5961 it will be erased first, otherwise, it will be created.
5963 A non-nil optional argument ASYNC means the process should happen
5964 asynchronously. The resulting buffer should then be accessible
5965 through the `org-export-stack' interface. When ASYNC is nil, the
5966 buffer is displayed if `org-export-show-temporary-export-buffer'
5967 is non-nil.
5969 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5970 EXT-PLIST are similar to those used in `org-export-as', which
5971 see.
5973 Optional argument POST-PROCESS is a function which should accept
5974 no argument. It is always called within the current process,
5975 from BUFFER, with point at its beginning. Export back-ends can
5976 use it to set a major mode there, e.g,
5978 (defun org-latex-export-as-latex
5979 (&optional async subtreep visible-only body-only ext-plist)
5980 (interactive)
5982 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5984 This function returns BUFFER."
6012 buffer)))
6014 ;;;###autoload
6017 post-process)
6018 "Call `org-export-as' with output to a specified file.
6020 BACKEND is either an export back-end, as returned by, e.g.,
6021 `org-export-create-backend', or a symbol referring to
6022 a registered back-end. FILE is the name of the output file, as
6023 a string.
6025 A non-nil optional argument ASYNC means the process should happen
6026 asynchronously. The resulting buffer will then be accessible
6027 through the `org-export-stack' interface.
6029 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6030 EXT-PLIST are similar to those used in `org-export-as', which
6031 see.
6033 Optional argument POST-PROCESS is called with FILE as its
6034 argument and happens asynchronously when ASYNC is non-nil. It
6035 has to return a file name, or nil. Export back-ends can use this
6036 to send the output file through additional processing, e.g,
6038 (defun org-latex-export-to-latex
6039 (&optional async subtreep visible-only body-only ext-plist)
6040 (interactive)
6043 async subtreep visible-only body-only ext-plist
6044 (lambda (file) (org-latex-compile file)))
6046 The function returns either a file name returned by POST-PROCESS,
6047 or FILE."
6066 backend subtreep visible-only body-only ext-plist)))
6073 ;; Get proper return value.
6075 file))))))
6078 "Return output file's name according to buffer specifications.
6080 EXTENSION is a string representing the output file extension,
6081 with the leading dot.
6083 With a non-nil optional argument SUBTREEP, try to determine
6085 of subtree at point.
6087 When optional argument PUB-DIR is set, use it as the publishing
6088 directory.
6090 Return file name as a string."
6093 ;; File name may come from EXPORT_FILE_NAME subtree
6094 ;; property.
6097 ;; File name may be extracted from buffer's associated
6098 ;; file, if any.
6100 ;; Can't determine file name on our own: Ask user.
6102 "Output file: " pub-dir nil nil nil
6106 ;; Build file name. Enforce EXTENSION over whatever user
6107 ;; may have come up with. PUB-DIR, if defined, always has
6108 ;; precedence over any provided path.
6113 extension))
6116 ;; If writing to OUTPUT-FILE would overwrite original file, append
6117 ;; EXTENSION another time to final name.
6120 output-file)))
6123 "Add a new result to export stack if not present already.
6125 SOURCE is a buffer or a file name containing export results.
6126 BACKEND is a symbol representing export back-end used to generate
6127 it.
6129 Entries already pointing to SOURCE and unavailable entries are
6130 removed beforehand. Return the new stack."
6136 "Menu for asynchronous export results and running processes."
6146 "Remove all entries from export stack."
6151 "Refresh the export stack."
6156 "Remove export results at point from stack.
6157 If optional argument SOURCE is non-nil, remove it instead."
6162 org-export-stack-contents))))
6165 "View export results at point in stack.
6166 With an optional prefix argument IN-EMACS, force viewing files
6167 within Emacs."
6181 (define-key km "\C-p" 'previous-line)
6182 (define-key km "\C-?" 'previous-line)
6183 (define-key km [up] 'previous-line)
6184 (define-key km "C" 'org-export-stack-clear)
6185 (define-key km "v" 'org-export-stack-view)
6186 (define-key km (kbd "RET") 'org-export-stack-view)
6187 (define-key km "d" 'org-export-stack-remove)
6188 km)
6189 "Keymap for Org Export Stack.")
6191 (define-derived-mode org-export-stack-mode tabulated-list-mode "Org-Stack"
6192 "Mode for displaying asynchronous export stack.
6195 stack.
6197 In an Org Export Stack buffer, use \
6201 stack completely.
6203 Removing entries in a stack buffer does not affect files
6204 or buffers, only display.
6207 (setq tabulated-list-format
6208 (vector (list "#" 4 #'org-export--stack-num-predicate)
6209 (list "Back-End" 12 t)
6210 (list "Age" 6 nil)
6211 (list "Source" 0 nil)))
6212 (setq tabulated-list-sort-key (cons "#" nil))
6213 (setq tabulated-list-entries #'org-export--stack-generate)
6214 (add-hook 'tabulated-list-revert-hook #'org-export--stack-generate nil t)
6215 (add-hook 'post-command-hook #'org-export-stack-refresh nil t)
6216 (tabulated-list-init-header))
6218 (defun org-export--stack-generate ()
6219 "Generate the asynchronous export stack for display.
6220 Unavailable sources are removed from the list. Return a list
6221 appropriate for `tabulated-list-print'."
6222 ;; Clear stack from exited processes, dead buffers or non-existent
6223 ;; files.
6224 (setq org-export-stack-contents
6225 (cl-remove-if-not
6226 (lambda (el)
6227 (if (processp (nth 2 el))
6228 (buffer-live-p (process-buffer (nth 2 el)))
6229 (let ((source (car el)))
6230 (if (bufferp source) (buffer-live-p source)
6231 (file-exists-p source)))))
6232 org-export-stack-contents))
6233 ;; Update `tabulated-list-entries'.
6234 (let ((counter 0))
6235 (mapcar
6236 (lambda (entry)
6237 (let ((source (car entry)))
6238 (list source
6239 (vector
6240 ;; Counter.
6241 (number-to-string (cl-incf counter))
6242 ;; Back-End.
6243 (if (nth 1 entry) (symbol-name (nth 1 entry)) "")
6244 ;; Age.
6245 (let ((info (nth 2 entry)))
6246 (if (processp info) (symbol-name (process-status info))
6247 (format-seconds "%h:%.2m" (float-time (time-since info)))))
6248 ;; Source.
6249 (if (stringp source) source (buffer-name source))))))
6250 org-export-stack-contents)))
6252 (defun org-export--stack-num-predicate (a b)
6253 (< (string-to-number (aref (nth 1 a) 0))
6254 (string-to-number (aref (nth 1 b) 0))))
6256 (defun org-export--stack-source-at-point ()
6257 "Return source from export results at point in stack."
6258 (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
6259 (if (not source) (error "Source unavailable, please refresh buffer")
6260 (let ((source-name (if (stringp source) source (buffer-name source))))
6261 (if (save-excursion
6262 (beginning-of-line)
6263 (looking-at-p (concat ".* +" (regexp-quote source-name) "$")))
6264 source
6265 ;; SOURCE is not consistent with current line. The stack
6266 ;; view is outdated.
6267 (error (substitute-command-keys
6269 to refresh buffer")))))))
6272 \f
6273 ;;; The Dispatcher
6274 ;;
6275 ;; `org-export-dispatch' is the standard interactive way to start an
6276 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6277 ;; for its interface, which, in turn, delegates response to key
6278 ;; pressed to `org-export--dispatch-action'.
6280 ;;;###autoload
6281 (defun org-export-dispatch (&optional arg)
6282 "Export dispatcher for Org mode.
6284 It provides an access to common export related tasks in a buffer.
6285 Its interface comes in two flavors: standard and expert.
6287 While both share the same set of bindings, only the former
6288 displays the valid keys associations in a dedicated buffer.
6289 Scrolling (resp. line-wise motion) in this buffer is done with
6290 SPC and DEL (resp. C-n and C-p) keys.
6292 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6293 flavor or the other.
6296 same
6297 set of options used back then, on the current buffer.
6300 asynchronous export stack."
6301 (interactive "P")
6302 (let* ((input
6303 (cond ((equal arg '(16)) '(stack))
6304 ((and arg org-export-dispatch-last-action))
6305 (t (save-window-excursion
6306 (unwind-protect
6307 (progn
6308 ;; Remember where we are
6309 (move-marker org-export-dispatch-last-position
6310 (point)
6311 (org-base-buffer (current-buffer)))
6312 ;; Get and store an export command
6313 (setq org-export-dispatch-last-action
6314 (org-export--dispatch-ui
6315 (list org-export-initial-scope
6316 (and org-export-in-background 'async))
6317 nil
6318 org-export-dispatch-use-expert-ui)))
6319 (and (get-buffer "*Org Export Dispatcher*")
6320 (kill-buffer "*Org Export Dispatcher*")))))))
6321 (action (car input))
6322 (optns (cdr input)))
6323 (unless (memq 'subtree optns)
6324 (move-marker org-export-dispatch-last-position nil))
6325 (cl-case action
6326 ;; First handle special hard-coded actions.
6327 (template (org-export-insert-default-template nil optns))
6328 (stack (org-export-stack))
6329 (publish-current-file
6330 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6331 (publish-current-project
6332 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6333 (publish-choose-project
6334 (org-publish (assoc (completing-read
6335 "Publish project: "
6336 org-publish-project-alist nil t)
6337 org-publish-project-alist)
6338 (memq 'force optns)
6339 (memq 'async optns)))
6340 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6341 (otherwise
6342 (save-excursion
6343 (when arg
6344 ;; Repeating command, maybe move cursor to restore subtree
6345 ;; context.
6346 (if (eq (marker-buffer org-export-dispatch-last-position)
6347 (org-base-buffer (current-buffer)))
6348 (goto-char org-export-dispatch-last-position)
6349 ;; We are in a different buffer, forget position.
6350 (move-marker org-export-dispatch-last-position nil)))
6351 (funcall action
6352 ;; Return a symbol instead of a list to ease
6353 ;; asynchronous export macro use.
6354 (and (memq 'async optns) t)
6355 (and (memq 'subtree optns) t)
6356 (and (memq 'visible optns) t)
6357 (and (memq 'body optns) t)))))))
6359 (defun org-export--dispatch-ui (options first-key expertp)
6360 "Handle interface for `org-export-dispatch'.
6362 OPTIONS is a list containing current interactive options set for
6363 export. It can contain any of the following symbols:
6364 `body' toggles a body-only export
6365 `subtree' restricts export to current subtree
6366 `visible' restricts export to visible part of buffer.
6367 `force' force publishing files.
6368 `async' use asynchronous export process
6370 FIRST-KEY is the key pressed to select the first level menu. It
6371 is nil when this menu hasn't been selected yet.
6373 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6374 buffer is provided, but indications about currently active
6375 options are given in the prompt. Moreover, [?] allows switching
6376 back to standard interface."
6377 (let* ((fontify-key
6378 (lambda (key &optional access-key)
6379 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6380 ;; non-nil is the required first-level key to activate
6381 ;; KEY. When its value is t, activate KEY independently
6382 ;; on the first key, if any. A nil value means KEY will
6383 ;; only be activated at first level.
6384 (if (or (eq access-key t) (eq access-key first-key))
6385 (propertize key 'face 'org-warning)
6386 key)))
6387 (fontify-value
6388 (lambda (value)
6389 ;; Fontify VALUE string.
6390 (propertize value 'face 'font-lock-variable-name-face)))
6391 ;; Prepare menu entries by extracting them from registered
6392 ;; back-ends and sorting them by access key and by ordinal,
6393 ;; if any.
6394 (entries
6395 (sort (sort (delq nil
6396 (mapcar #'org-export-backend-menu
6397 org-export-registered-backends))
6398 (lambda (a b)
6399 (let ((key-a (nth 1 a))
6400 (key-b (nth 1 b)))
6401 (cond ((and (numberp key-a) (numberp key-b))
6402 (< key-a key-b))
6403 ((numberp key-b) t)))))
6404 'car-less-than-car))
6405 ;; Compute a list of allowed keys based on the first key
6406 ;; pressed, if any. Some keys
6407 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6408 ;; available.
6409 (allowed-keys
6410 (nconc (list 2 22 19 6 1)
6411 (if (not first-key) (org-uniquify (mapcar 'car entries))
6412 (let (sub-menu)
6413 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6414 (when (eq (car entry) first-key)
6415 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6416 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6417 ((not first-key) (list ?P)))
6418 (list ?& ?#)
6419 (when expertp (list ??))
6420 (list ?q)))
6421 ;; Build the help menu for standard UI.
6422 (help
6423 (unless expertp
6424 (concat
6425 ;; Options are hard-coded.
6426 (format "[%s] Body only: %s [%s] Visible only: %s
6427 \[%s] Export scope: %s [%s] Force publishing: %s
6429 (funcall fontify-key "C-b" t)
6430 (funcall fontify-value
6431 (if (memq 'body options) "On " "Off"))
6432 (funcall fontify-key "C-v" t)
6433 (funcall fontify-value
6434 (if (memq 'visible options) "On " "Off"))
6435 (funcall fontify-key "C-s" t)
6436 (funcall fontify-value
6437 (if (memq 'subtree options) "Subtree" "Buffer "))
6438 (funcall fontify-key "C-f" t)
6439 (funcall fontify-value
6440 (if (memq 'force options) "On " "Off"))
6441 (funcall fontify-key "C-a" t)
6442 (funcall fontify-value
6443 (if (memq 'async options) "On " "Off")))
6444 ;; Display registered back-end entries. When a key
6445 ;; appears for the second time, do not create another
6446 ;; entry, but append its sub-menu to existing menu.
6447 (let (last-key)
6448 (mapconcat
6449 (lambda (entry)
6450 (let ((top-key (car entry)))
6451 (concat
6452 (unless (eq top-key last-key)
6453 (setq last-key top-key)
6455 (funcall fontify-key (char-to-string top-key))
6456 (nth 1 entry)))
6457 (let ((sub-menu (nth 2 entry)))
6458 (unless (functionp sub-menu)
6459 ;; Split sub-menu into two columns.
6460 (let ((index -1))
6461 (concat
6462 (mapconcat
6463 (lambda (sub-entry)
6464 (cl-incf index)
6465 (format
6466 (if (zerop (mod index 2)) " [%s] %-26s"
6468 (funcall fontify-key
6469 (char-to-string (car sub-entry))
6470 top-key)
6471 (nth 1 sub-entry)))
6472 sub-menu "")
6474 entries ""))
6475 ;; Publishing menu is hard-coded.
6477 [%s] Current file [%s] Current project
6479 (funcall fontify-key "P")
6480 (funcall fontify-key "f" ?P)
6481 (funcall fontify-key "p" ?P)
6482 (funcall fontify-key "x" ?P)
6483 (funcall fontify-key "a" ?P))
6485 (funcall fontify-key "&" t)
6486 (funcall fontify-key "#" t))
6487 (format "[%s] %s"
6488 (funcall fontify-key "q" t)
6489 (if first-key "Main menu" "Exit")))))
6490 ;; Build prompts for both standard and expert UI.
6491 (standard-prompt (unless expertp "Export command: "))
6492 (expert-prompt
6493 (when expertp
6494 (format
6495 "Export command (C-%s%s%s%s%s) [%s]: "
6496 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6497 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6498 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6499 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6500 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6501 (mapconcat (lambda (k)
6502 ;; Strip control characters.
6503 (unless (< k 27) (char-to-string k)))
6504 allowed-keys "")))))
6505 ;; With expert UI, just read key with a fancy prompt. In standard
6506 ;; UI, display an intrusive help buffer.
6507 (if expertp
6508 (org-export--dispatch-action
6509 expert-prompt allowed-keys entries options first-key expertp)
6510 ;; At first call, create frame layout in order to display menu.
6511 (unless (get-buffer "*Org Export Dispatcher*")
6512 (delete-other-windows)
6513 (org-switch-to-buffer-other-window
6514 (get-buffer-create "*Org Export Dispatcher*"))
6515 (setq cursor-type nil
6516 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6517 ;; Make sure that invisible cursor will not highlight square
6518 ;; brackets.
6519 (set-syntax-table (copy-syntax-table))
6520 (modify-syntax-entry ?\[ "w"))
6521 ;; At this point, the buffer containing the menu exists and is
6522 ;; visible in the current window. So, refresh it.
6523 (with-current-buffer "*Org Export Dispatcher*"
6524 ;; Refresh help. Maintain display continuity by re-visiting
6525 ;; previous window position.
6526 (let ((pos (window-start)))
6527 (erase-buffer)
6528 (insert help)
6529 (set-window-start nil pos)))
6530 (org-fit-window-to-buffer)
6531 (org-export--dispatch-action
6532 standard-prompt allowed-keys entries options first-key expertp))))
6534 (defun org-export--dispatch-action
6535 (prompt allowed-keys entries options first-key expertp)
6536 "Read a character from command input and act accordingly.
6538 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6539 a list of characters available at a given step in the process.
6540 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6541 EXPERTP are the same as defined in `org-export--dispatch-ui',
6542 which see.
6544 Toggle export options when required. Otherwise, return value is
6545 a list with action as CAR and a list of interactive export
6546 options as CDR."
6547 (let (key)
6548 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6549 ;; C-p, SPC, DEL).
6550 (while (and (setq key (read-char-exclusive prompt))
6551 (not expertp)
6552 (memq key '(14 16 ?\s ?\d)))
6553 (cl-case key
6554 (14 (if (not (pos-visible-in-window-p (point-max)))
6555 (ignore-errors (scroll-up 1))
6556 (message "End of buffer")
6557 (sit-for 1)))
6558 (16 (if (not (pos-visible-in-window-p (point-min)))
6559 (ignore-errors (scroll-down 1))
6560 (message "Beginning of buffer")
6561 (sit-for 1)))
6562 (?\s (if (not (pos-visible-in-window-p (point-max)))
6563 (scroll-up nil)
6564 (message "End of buffer")
6565 (sit-for 1)))
6566 (?\d (if (not (pos-visible-in-window-p (point-min)))
6567 (scroll-down nil)
6568 (message "Beginning of buffer")
6569 (sit-for 1)))))
6570 (cond
6571 ;; Ignore undefined associations.
6572 ((not (memq key allowed-keys))
6573 (ding)
6574 (unless expertp (message "Invalid key") (sit-for 1))
6575 (org-export--dispatch-ui options first-key expertp))
6576 ;; q key at first level aborts export. At second level, cancel
6577 ;; first key instead.
6578 ((eq key ?q) (if (not first-key) (error "Export aborted")
6579 (org-export--dispatch-ui options nil expertp)))
6580 ;; Help key: Switch back to standard interface if expert UI was
6581 ;; active.
6582 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6583 ;; Send request for template insertion along with export scope.
6584 ((eq key ?#) (cons 'template (memq 'subtree options)))
6585 ;; Switch to asynchronous export stack.
6586 ((eq key ?&) '(stack))
6587 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6588 ((memq key '(2 22 19 6 1))
6589 (org-export--dispatch-ui
6590 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6591 (6 'force) (1 'async))))
6592 (if (memq option options) (remq option options)
6593 (cons option options)))
6594 first-key expertp))
6595 ;; Action selected: Send key and options back to
6596 ;; `org-export-dispatch'.
6597 ((or first-key (functionp (nth 2 (assq key entries))))
6598 (cons (cond
6599 ((not first-key) (nth 2 (assq key entries)))
6600 ;; Publishing actions are hard-coded. Send a special
6601 ;; signal to `org-export-dispatch'.
6602 ((eq first-key ?P)
6603 (cl-case key
6604 (?f 'publish-current-file)
6605 (?p 'publish-current-project)
6606 (?x 'publish-choose-project)
6607 (?a 'publish-all)))
6608 ;; Return first action associated to FIRST-KEY + KEY
6609 ;; path. Indeed, derived backends can share the same
6610 ;; FIRST-KEY.
6611 (t (catch 'found
6612 (dolist (entry (member (assq first-key entries) entries))
6613 (let ((match (assq key (nth 2 entry))))
6614 (when match (throw 'found (nth 2 match))))))))
6615 options))
6616 ;; Otherwise, enter sub-menu.
6617 (t (org-export--dispatch-ui options key expertp)))))
6621 (provide 'ox)
6623 ;; Local variables:
6624 ;; generated-autoload-file: "org-loaddefs.el"
6625 ;; End:
6627 ;;; ox.el ends here