| blob | f4b046e9682d14aecd4bdd99e234cd5d4a2e47bb |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
91 \f
92 ;;; Internal Variables
93 ;;
94 ;; Among internal variables, the most important is
95 ;; `org-export-options-alist'. This variable define the global export
96 ;; options, shared between every exporter, and how they are acquired.
142 "Alist between export properties and ways to set them.
144 The key of the alist is the property name, and the value is a list
145 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
147 KEYWORD is a string representing a buffer keyword, or nil. Each
148 property defined this way can also be set, during subtree
149 export, through a headline property named after the keyword
151 property).
152 OPTION is a string that could be found in an #+OPTIONS: line.
153 DEFAULT is the default value for the property.
154 BEHAVIOR determines how Org should handle multiple keywords for
155 the same property. It is a symbol among:
156 nil Keep old value and discard the new one.
157 t Replace old value with the new one.
158 `space' Concatenate the values, separating them with a space.
159 `newline' Concatenate the values, separating them with
160 a newline.
161 `split' Split values at white spaces, and cons them to the
162 previous list.
163 `parse' Parse value as a list of strings and Org objects,
164 which can then be transcoded with, e.g.,
165 `org-export-data'. It implies `space' behavior.
167 Values set through KEYWORD and OPTION have precedence over
168 DEFAULT.
170 All these properties should be back-end agnostic. Back-end
171 specific properties are set through `org-export-define-backend'.
175 "List of in-buffer keywords that require special treatment.
176 These keywords are not directly associated to a property. The
177 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
263 org-element--cache org-element--cache-objects org-element--cache-sync-keys
264 org-element--cache-sync-requests org-element--cache-sync-timer)
265 "List of variables not copied through upon buffer duplication.
266 Export process takes place on a copy of the original buffer.
267 When this copy is created, all Org related local variables not in
268 this list are copied to the new buffer. Variables with an
272 "Non-nil means asynchronous export process should leave data behind.
276 located in `temporary-file-directory'.
278 When non-nil, it will also set `debug-on-error' to a non-nil
282 "Record asynchronously generated export results and processes.
283 This is an alist: its CAR is the source of the
284 result (destination file or buffer for a finished process,
285 original buffer for a running one) and its CDR is a list
286 containing the back-end used, as a symbol, and either a process
287 or the time at which it finished. It is used to build the menu
291 "List of backends currently available in the exporter.
292 This variable is set with `org-export-define-backend' and
296 "Last command called from the dispatcher.
297 The value should be a list. Its CAR is the action, as a symbol,
301 "The position where the last export command was created using the dispatcher.
302 This marker will be used with `C-u C-c C-e' to make sure export repetition
305 ;; For compatibility with Org < 8
307 "Name, if any, of the back-end used during an export process.
309 Its value is a symbol such as `html', `latex', `ascii', or nil if
310 the back-end is anonymous (see `org-export-create-backend') or if
311 there is no export process in progress.
313 It can be used to teach Babel blocks how to act differently
317 \f
318 ;;; User-configurable Variables
319 ;;
320 ;; Configuration for the masses.
321 ;;
322 ;; They should never be accessed directly, as their value is to be
323 ;; stored in a property list (cf. `org-export-options-alist').
324 ;; Back-ends will read their value from there instead.
327 "Options for exporting Org mode files."
332 "General options for export engine."
337 "Whether sub-trees with the ARCHIVE tag should be exported.
339 This can have three different values:
340 nil Do not export, pretend this tree is not present.
341 t Do export the entire tree.
342 `headline' Only export the headline, but skip the tree below it.
344 This option can also be set with the OPTIONS keyword,
354 "Non-nil means insert author name into the exported file.
355 This option can also be set with the OPTIONS keyword,
362 "Non-nil means export CLOCK keywords.
363 This option can also be set with the OPTIONS keyword,
370 "Non-nil means the postamble should contain a creator sentence.
372 The sentence can be set in `org-export-creator-string', which
373 see.
375 This option can also be set with the OPTIONS keyword, e.g.,
384 "Non-nil means insert date in the exported document.
385 This option can also be set with the OPTIONS keyword,
392 "Time-stamp format string to use for DATE keyword.
394 The format string, when specified, only applies if date consists
395 in a single time-stamp. Otherwise its value will be ignored.
397 See `format-time-string' for details on how to build this
398 string."
407 emacs-version
409 "Information about the creator of the document.
410 This option can also be set on with the CREATOR keyword."
416 "Non-nil means export contents of standard drawers.
418 When t, all drawers are exported. This may also be a list of
419 drawer names to export, as strings. If that list starts with
420 `not', only drawers with such names will be ignored.
422 This variable doesn't apply to properties drawers. See
423 `org-export-with-properties' instead.
425 This option can also be set with the OPTIONS keyword,
438 :inline t
447 "Non-nil means insert author email into the exported file.
448 This option can also be set with the OPTIONS keyword,
455 "Non-nil means interpret *word*, /word/, _word_ and +word+.
457 If the export target supports emphasizing text, the word will be
458 typeset in bold, italic, with an underline or strike-through,
459 respectively.
461 This option can also be set with the OPTIONS keyword,
468 "Tags that exclude a tree from export.
470 All trees carrying any of these tags will be excluded from
471 export. This is without condition, so even subtrees inside that
472 carry one of the `org-export-select-tags' will be removed.
474 This option can also be set with the EXCLUDE_TAGS keyword."
481 This option can also be set with the OPTIONS keyword,
490 "Non-nil means Org footnotes should be exported.
491 This option can also be set with the OPTIONS keyword,
498 "Non-nil means process LaTeX environments and fragments.
500 This option can also be set with the OPTIONS line,
503 nil Ignore math snippets.
504 `verbatim' Keep everything in verbatim.
505 t Allow export of math snippets."
516 "The last level which is still exported as a headline.
518 Inferior levels will usually produce itemize or enumerate lists
519 when exported, but back-end behavior may differ.
521 This option can also be set with the OPTIONS keyword,
528 "The default language for export and clocktable translations, as a string.
529 This may have an association in
530 `org-clock-clocktable-language-setup',
531 `org-export-smart-quotes-alist' and `org-export-dictionary'.
532 This option can also be set with the LANGUAGE keyword."
538 "Non-nil means preserve all line breaks when exporting.
539 This option can also be set with the OPTIONS keyword,
546 "Non-nil means interpret entities when exporting.
549 Å.
551 For a list of supported names, see the constant `org-entities'
552 and the user option `org-entities-user'.
554 This option can also be set with the OPTIONS keyword,
561 "Non-nil means inlinetasks should be exported.
562 This option can also be set with the OPTIONS keyword,
571 "Non-nil means include planning info in export.
573 Planning info is the line containing either SCHEDULED:,
574 DEADLINE:, CLOSED: time-stamps, or a combination of them.
576 This option can also be set with the OPTIONS keyword,
585 "Non-nil means include priority cookies in export.
586 This option can also be set with the OPTIONS keyword,
593 "Non-nil means export contents of properties drawers.
595 When t, all properties are exported. This may also be a list of
596 properties to export, as strings.
598 This option can also be set with the OPTIONS keyword,
612 "Non-nil means add section numbers to headlines when exporting.
614 When set to an integer n, numbering will only happen for
615 headlines whose relative level is higher or equal to n.
617 This option can also be set with the OPTIONS keyword,
624 "Tags that select a tree for export.
626 If any such tag is found in a buffer, all trees that do not carry
627 one of these tags will be ignored during export. Inside trees
628 that are selected like this, you can still deselect a subtree by
629 tagging it with one of the `org-export-exclude-tags'.
631 This option can also be set with the SELECT_TAGS keyword."
637 "Non-nil means activate smart quotes during export.
638 This option can also be set with the OPTIONS keyword,
641 When setting this to non-nil, you need to take care of
642 using the correct Babel package when exporting to LaTeX.
643 E.g., you can load Babel for french like this:
655 When this option is turned on, these strings will be exported as:
657 Org HTML LaTeX UTF-8
658 -----+----------+--------+-------
660 -- – -- –
661 --- — --- —
664 This option can also be set with the OPTIONS keyword,
671 "Non-nil means include statistics cookies in export.
672 This option can also be set with the OPTIONS keyword,
683 If you want to control how Org displays those characters, see
684 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
685 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
686 it is not anymore.
688 When this option is turned on, you can use TeX-like syntax for
689 sub- and superscripts and see them exported correctly.
691 You can also set the option with #+OPTIONS: ^:t
694 single item - so grouping with {} is normally not needed. For
695 example, the following things will be parsed as single sub- or
696 superscripts:
698 10^24 or 10^tau several digits will be considered 1 item.
699 10^-12 or 10^-tau a leading sign with digits or a word
700 x^2-y^3 will be read as x^2 - y^3, because items are
701 terminated by almost any nonword/nondigit char.
702 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
704 Still, ambiguity is possible. So when in doubt, use {} to enclose
705 the sub/superscript. If you set this variable to the symbol `{}',
706 the braces are *required* in order to trigger interpretations as
708 frequently in plain text."
719 "Non-nil means create a table of contents in exported files.
721 The TOC contains headlines with levels up
722 to`org-export-headline-levels'. When an integer, include levels
723 up to N in the toc, this may then be different from
724 `org-export-headline-levels', but it will not be allowed to be
725 larger than the number of headline levels. When nil, no table of
726 contents is made.
728 This option can also be set with the OPTIONS keyword,
739 "Non-nil means export tables.
740 This option can also be set with the OPTIONS keyword,
749 "If nil, do not export tags, just remove them from headlines.
751 If this is the symbol `not-in-toc', tags will be removed from
752 table of contents entries, but still be shown in the headlines of
753 the document.
755 This option can also be set with the OPTIONS keyword,
765 "Non-nil means include TODO items for export.
767 This may have the following values:
768 t include tasks independent of state.
769 `todo' include only tasks that are not yet done.
770 `done' include only tasks that are already done.
771 nil ignore all tasks.
772 list of keywords include tasks with these keywords.
774 This option can also be set with the OPTIONS keyword,
789 "Non-nil means print title into the exported file.
790 This option can also be set with the OPTIONS keyword,
799 "Non-nil means insert a time stamp into the exported file.
800 The time stamp shows when the file was created. This option can
807 "Non nil means allow timestamps in export.
809 It can be set to any of the following values:
810 t export all timestamps.
811 `active' export active timestamps only.
812 `inactive' export inactive timestamps only.
813 nil do not export timestamps
815 This only applies to timestamps isolated in a paragraph
816 containing only timestamps. Other timestamps are always
817 exported.
819 This option can also be set with the OPTIONS keyword, e.g.
830 "Non-nil means include TODO keywords in export.
831 When nil, remove all these keywords from the export. This option
837 "Non-nil means BIND keywords can define local variable values.
838 This is a potential security risk, which is why the default value
839 is nil. You can also allow them through local buffer variables."
846 "Non-nil means do not raise an error on broken links.
848 When this variable is non-nil, broken links are ignored, without
849 stopping the export process. If it is set to `mark', broken
850 links are marked as such in the output, with a string like
852 [BROKEN LINK: path]
854 where PATH is the un-resolvable reference.
856 This option can also be set with the OPTIONS keyword, e.g.,
867 "Alist between export snippets back-ends and exporter back-ends.
869 This variable allows providing shortcuts for export snippets.
873 HTML code while every other back-end will ignore it."
887 "Alist between macro names and expansion templates.
889 This variable defines macro expansion templates available
890 globally. Associations follow the pattern
892 (NAME . TEMPLATE)
894 where NAME is a string beginning with a letter and consisting of
895 alphanumeric characters only.
897 TEMPLATE is the string to which the macro is going to be
899 macro's arguments. Moreover, if the template starts with
901 accordingly."
910 "Coding system for the exported file."
917 "Non-nil means pushing export output to the kill ring.
918 This variable is ignored during asynchronous export."
928 "The initial scope when exporting with `org-export-dispatch'.
929 This variable can be either set to `buffer' or `subtree'."
936 "Non-nil means show buffer after exporting to temp buffer.
937 When Org exports to a file, the buffer visiting that file is never
938 shown, but remains buried. However, when exporting to
939 a temporary buffer, that buffer is popped up in a second window.
940 When this variable is nil, the buffer remains buried also in
941 these cases."
946 "Non-nil means export and publishing commands will run in background.
947 Results from an asynchronous export are never displayed
955 "File used to initialize external export process.
957 Value must be either nil or an absolute file name. When nil, the
958 external process is launched like a regular Emacs session,
959 loading user's initialization file and any site specific
960 configuration. If a file is provided, it, and only it, is loaded
961 at start-up.
963 Therefore, using a specific configuration makes the process to
964 load faster and the export more portable."
973 "Non-nil means using a non-intrusive `org-export-dispatch'.
974 In that case, no help buffer is displayed. Though, an indicator
980 asynchronous). Also, [?] allows switching back to standard
981 mode."
988 \f
989 ;;; Defining Back-ends
990 ;;
991 ;; An export back-end is a structure with `org-export-backend' type
992 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
993 ;; and `menu' slots.
994 ;;
995 ;; At the lowest level, a back-end is created with
996 ;; `org-export-create-backend' function.
997 ;;
998 ;; A named back-end can be registered with
999 ;; `org-export-register-backend' function. A registered back-end can
1000 ;; later be referred to by its name, with `org-export-get-backend'
1001 ;; function. Also, such a back-end can become the parent of a derived
1002 ;; back-end from which slot values will be inherited by default.
1003 ;; `org-export-derived-backend-p' can check if a given back-end is
1004 ;; derived from a list of back-end names.
1005 ;;
1006 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
1007 ;; `org-export-get-all-filters' return the full alist of transcoders,
1008 ;; options and filters, including those inherited from ancestors.
1009 ;;
1010 ;; At a higher level, `org-export-define-backend' is the standard way
1011 ;; to define an export back-end. If the new back-end is similar to
1012 ;; a registered back-end, `org-export-define-derived-backend' may be
1013 ;; used instead.
1014 ;;
1015 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
1016 ;; when a given back-end hasn't been registered yet.
1020 name parent transcoders options filters blocks menu)
1023 "Return export back-end named after NAME.
1024 NAME is a symbol. Return nil if no such back-end is found."
1031 "Register BACKEND as a known export back-end.
1032 BACKEND is a structure with `org-export-backend' type."
1033 ;; Refuse to register an unnamed back-end.
1036 ;; Refuse to register a back-end with an unknown parent.
1040 ;; If a back-end with the same name as BACKEND is already
1041 ;; registered, replace it with BACKEND. Otherwise, simply add
1042 ;; BACKEND to the list of registered back-ends.
1048 "Signal an error if BACKEND isn't defined."
1053 "Non-nil if BACKEND is derived from one of BACKENDS.
1054 BACKEND is an export back-end, as returned by, e.g.,
1055 `org-export-create-backend', or a symbol referring to
1056 a registered back-end. BACKENDS is constituted of symbols."
1068 "Return full translation table for BACKEND.
1070 BACKEND is an export back-end, as return by, e.g,,
1071 `org-export-create-backend'. Return value is an alist where
1072 keys are element or object types, as symbols, and values are
1073 transcoders.
1075 Unlike to `org-export-backend-transcoders', this function
1076 also returns transcoders inherited from parent back-ends,
1077 if any."
1081 parent)
1086 transcoders)))
1089 "Return export options for BACKEND.
1091 BACKEND is an export back-end, as return by, e.g,,
1092 `org-export-create-backend'. See `org-export-options-alist'
1093 for the shape of the return value.
1095 Unlike to `org-export-backend-options', this function also
1096 returns options inherited from parent back-ends, if any."
1100 parent)
1104 options)))
1107 "Return complete list of filters for BACKEND.
1109 BACKEND is an export back-end, as return by, e.g,,
1110 `org-export-create-backend'. Return value is an alist where
1111 keys are symbols and values lists of functions.
1113 Unlike to `org-export-backend-filters', this function also
1114 returns filters inherited from parent back-ends, if any."
1118 parent)
1122 filters)))
1125 "Define a new back-end BACKEND.
1127 TRANSCODERS is an alist between object or element types and
1128 functions handling them.
1130 These functions should return a string without any trailing
1131 space, or nil. They must accept three arguments: the object or
1132 element itself, its contents or nil when it isn't recursive and
1133 the property list used as a communication channel.
1135 Contents, when not nil, are stripped from any global indentation
1136 \(although the relative one is preserved). They also always end
1137 with a single newline character.
1139 If, for a given type, no function is found, that element or
1140 object type will simply be ignored, along with any blank line or
1141 white space at its end. The same will happen if the function
1142 returns the nil value. If that function returns the empty
1143 string, the type will be ignored, but the blank lines or white
1144 spaces will be kept.
1146 In addition to element and object types, one function can be
1147 associated to the `template' (or `inner-template') symbol and
1148 another one to the `plain-text' symbol.
1150 The former returns the final transcoded string, and can be used
1151 to add a preamble and a postamble to document's body. It must
1152 accept two arguments: the transcoded string and the property list
1153 containing export options. A function associated to `template'
1155 A function associated to `inner-template' is always applied.
1157 The latter, when defined, is to be called on every text not
1158 recognized as an element or an object. It must accept two
1159 arguments: the text string and the information channel. It is an
1160 appropriate place to protect special chars relative to the
1161 back-end.
1163 BODY can start with pre-defined keyword arguments. The following
1164 keywords are understood:
1166 :filters-alist
1168 Alist between filters and function, or list of functions,
1169 specific to the back-end. See `org-export-filters-alist' for
1170 a list of all allowed filters. Filters defined here
1171 shouldn't make a back-end test, as it may prevent back-ends
1172 derived from this one to behave properly.
1174 :menu-entry
1176 Menu entry for the export dispatcher. It should be a list
1177 like:
1181 where :
1183 KEY is a free character selecting the back-end.
1185 DESCRIPTION-OR-ORDINAL is either a string or a number.
1187 If it is a string, is will be used to name the back-end in
1188 its menu entry. If it is a number, the following menu will
1189 be displayed as a sub-menu of the back-end with the same
1190 KEY. Also, the number will be used to determine in which
1191 order such sub-menus will appear (lowest first).
1193 ACTION-OR-MENU is either a function or an alist.
1195 If it is an action, it will be called with four
1196 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1197 BODY-ONLY. See `org-export-as' for further explanations on
1198 some of them.
1200 If it is an alist, associations should follow the
1201 pattern:
1205 where KEY, DESCRIPTION and ACTION are described above.
1207 Valid values include:
1211 or
1216 (lambda (a s v b)
1217 (if a (org-latex-export-to-pdf t s v b)
1218 (org-open-file
1219 (org-latex-export-to-pdf nil s v b)))))))
1221 or the following, which will be added to the previous
1222 sub-menu,
1228 :options-alist
1230 Alist between back-end specific properties introduced in
1231 communication channel and how their value are acquired. See
1232 `org-export-options-alist' for more information about
1233 structure of the values."
1245 :transcoders transcoders
1246 :options options
1247 :filters filters
1251 "Create a new back-end as a variant of an existing one.
1253 CHILD is the name of the derived back-end. PARENT is the name of
1254 the parent back-end.
1256 BODY can start with pre-defined keyword arguments. The following
1257 keywords are understood:
1259 :filters-alist
1261 Alist of filters that will overwrite or complete filters
1262 defined in PARENT back-end. See `org-export-filters-alist'
1263 for a list of allowed filters.
1265 :menu-entry
1267 Menu entry for the export dispatcher. See
1268 `org-export-define-backend' for more information about the
1269 expected value.
1271 :options-alist
1273 Alist of back-end specific properties that will overwrite or
1274 complete those defined in PARENT back-end. Refer to
1275 `org-export-options-alist' for more information about
1276 structure of the values.
1278 :translate-alist
1280 Alist of element and object types and transcoders that will
1281 overwrite or complete transcode table from PARENT back-end.
1282 Refer to `org-export-define-backend' for detailed information
1283 about transcoders.
1286 as a variant of `latex' back-end with a custom template function:
1291 The back-end could then be called with, for example:
1306 :parent parent
1307 :transcoders transcoders
1308 :options options
1309 :filters filters
1313 \f
1314 ;;; The Communication Channel
1315 ;;
1316 ;; During export process, every function has access to a number of
1317 ;; properties. They are of two types:
1318 ;;
1319 ;; 1. Environment options are collected once at the very beginning of
1320 ;; the process, out of the original buffer and configuration.
1321 ;; Collecting them is handled by `org-export-get-environment'
1322 ;; function.
1323 ;;
1324 ;; Most environment options are defined through the
1325 ;; `org-export-options-alist' variable.
1326 ;;
1327 ;; 2. Tree properties are extracted directly from the parsed tree,
1328 ;; just before export, by `org-export--collect-tree-properties'.
1330 ;;;; Environment Options
1331 ;;
1332 ;; Environment options encompass all parameters defined outside the
1333 ;; scope of the parsed data. They come from five sources, in
1334 ;; increasing precedence order:
1335 ;;
1336 ;; - Global variables,
1337 ;; - Buffer's attributes,
1338 ;; - Options keyword symbols,
1339 ;; - Buffer keywords,
1340 ;; - Subtree properties.
1341 ;;
1342 ;; The central internal function with regards to environment options
1343 ;; is `org-export-get-environment'. It updates global variables with
1344 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1345 ;; the different sources.
1346 ;;
1347 ;; The internal functions doing the retrieval are:
1348 ;; `org-export--get-global-options',
1349 ;; `org-export--get-buffer-attributes',
1350 ;; `org-export--parse-option-keyword',
1351 ;; `org-export--get-subtree-options' and
1352 ;; `org-export--get-inbuffer-options'
1353 ;;
1354 ;; Also, `org-export--list-bound-variables' collects bound variables
1355 ;; along with their value in order to set them as buffer local
1356 ;; variables later in the process.
1359 "Collect export options from the current buffer.
1361 Optional argument BACKEND is an export back-end, as returned by
1362 `org-export-create-backend'.
1364 When optional argument SUBTREEP is non-nil, assume the export is
1365 done against the current sub-tree.
1367 Third optional argument EXT-PLIST is a property list with
1368 external parameters overriding Org default settings, but still
1369 inferior to file-local settings."
1370 ;; First install #+BIND variables since these must be set before
1371 ;; global options are read.
1374 ;; Get and prioritize export options...
1376 ;; ... from global variables...
1378 ;; ... from an external property list...
1379 ext-plist
1380 ;; ... from in-buffer settings...
1382 ;; ... and from subtree, when appropriate.
1386 "Parse an OPTIONS line and return values as a plist.
1387 Optional argument BACKEND is an export back-end, as returned by,
1388 e.g., `org-export-create-backend'. It specifies which back-end
1389 specific items to read, if any."
1396 alist))
1397 alist))
1398 ;; Priority is given to back-end specific options.
1400 org-export-options-alist))
1410 "Get export options in subtree at point.
1411 Optional argument BACKEND is an export back-end, as returned by,
1412 e.g., `org-export-create-backend'. It specifies back-end used
1413 for export. Return options as a plist."
1414 ;; For each buffer keyword, create a headline property setting the
1415 ;; same property in communication channel. The name for the
1416 ;; property is the keyword with "EXPORT_" appended to it.
1418 ;; Make sure point is at a heading.
1421 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1422 ;; care of them right from the start.
1425 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1426 ;; headline's title (with no todo keyword, priority cookie or
1427 ;; tag) as its fallback value.
1434 ;; Look for both general keywords and back-end specific
1435 ;; options, with priority given to the latter.
1437 org-export-options-alist)))
1438 ;; Handle other keywords. Then return PLIST.
1452 property
1461 "Return current buffer export options, as a plist.
1463 Optional argument BACKEND, when non-nil, is an export back-end,
1464 as returned by, e.g., `org-export-create-backend'. It specifies
1465 which back-end specific options should also be read in the
1466 process.
1468 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1471 ;; Priority is given to back-end specific options.
1473 org-export-options-alist))
1476 org-export-special-keywords))))
1477 plist to-parse)
1480 ;; Return all properties associated to KEYWORD.
1487 ;; Recursively read keywords in buffer. FILES is
1488 ;; a list of files read so far. PLIST is the current
1489 ;; property list obtained.
1498 ;; Options in `org-export-special-keywords'.
1503 ;; Avoid circular dependencies.
1514 plist
1516 val backend))))
1520 plist
1527 ;; Options in `org-export-options-alist'.
1530 plist
1532 plist property
1533 ;; Handle value depending on specified
1534 ;; BEHAVIOR.
1539 ;; Even if `parse' implies `space'
1540 ;; behavior, we separate line with
1541 ;; "\n" so as to preserve
1542 ;; line-breaks. However, empty
1543 ;; lines are forbidden since `parse'
1544 ;; doesn't allow more than one
1545 ;; paragraph.
1554 " "
1567 ;; Read options in the current buffer and return value.
1569 ;; Parse properties in TO-PARSE. Remove newline characters not
1570 ;; involved in line breaks to simulate `space' behavior.
1571 ;; Finally return options.
1584 "Return properties related to export process, as a plist.
1585 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1586 are like the arguments with the same names of function
1587 `org-export-as'."
1592 :back-end backend
1597 "Return properties related to buffer attributes, as a plist."
1602 "Return global export options as a plist.
1603 Optional argument BACKEND, if non-nil, is an export back-end, as
1604 returned by, e.g., `org-export-create-backend'. It specifies
1605 which back-end specific export options should also be read in the
1606 process."
1608 ;; Priority is given to back-end specific options.
1610 org-export-options-alist)))
1616 plist
1617 prop
1618 ;; Evaluate default value provided.
1623 value)))))))))
1626 "Return variables bound from BIND keywords in current buffer.
1627 Also look for BIND keywords in setup files. The return value is
1628 an alist where associations are (VARIABLE-NAME VALUE)."
1632 ;; Return an alist between variable names and their
1633 ;; value. FILES is a list of setup files names read
1634 ;; so far, used to avoid circular dependencies. ALIST
1635 ;; is the alist collected so far.
1647 ;; Enter setup file.
1659 alist))))))))))
1660 alist)))))
1661 ;; Return value in appropriate order of appearance.
1664 ;; defsubst org-export-get-parent must be defined before first use,
1665 ;; was originally defined in the topology section
1668 "Return BLOB parent or nil.
1669 BLOB is the element or object considered."
1672 ;;;; Tree Properties
1673 ;;
1674 ;; Tree properties are information extracted from parse tree. They
1675 ;; are initialized at the beginning of the transcoding process by
1676 ;; `org-export--collect-tree-properties'.
1677 ;;
1678 ;; Dedicated functions focus on computing the value of specific tree
1679 ;; properties during initialization. Thus,
1680 ;; `org-export--populate-ignore-list' lists elements and objects that
1681 ;; should be skipped during export, `org-export--get-min-level' gets
1682 ;; the minimal exportable level, used as a basis to compute relative
1683 ;; level for headlines. Eventually
1684 ;; `org-export--collect-headline-numbering' builds an alist between
1685 ;; headlines and their numbering.
1688 "Extract tree properties from parse tree.
1690 DATA is the parse tree from which information is retrieved. INFO
1691 is a list holding export options.
1693 Following tree properties are set or updated:
1695 `:headline-offset' Offset between true level of headlines and
1696 local level. An offset of -1 means a headline
1697 of level 2 should be considered as a level
1698 1 headline in the context.
1700 `:headline-numbering' Alist of all headlines as key and the
1701 associated numbering as value.
1703 `:id-alist' Alist of all ID references as key and associated file
1704 as value.
1706 Return updated plist."
1707 ;; Install the parse tree in the communication channel.
1709 ;; Compute `:headline-offset' in order to be able to use
1710 ;; `org-export-get-relative-level'.
1713 :headline-offset
1715 ;; From now on, properties order doesn't matter: get the rest of the
1716 ;; tree properties.
1718 info
1720 :id-alist
1729 "Return minimum exportable headline's level in DATA.
1730 DATA is parsed tree as returned by `org-element-parse-buffer'.
1731 OPTIONS is a plist holding export options."
1740 ;; If no headline was found, for the sake of consistency, set
1741 ;; minimum level to 1 nonetheless.
1745 "Return numbering of all exportable, numbered headlines in a parse tree.
1747 DATA is the parse tree. OPTIONS is the plist holding export
1748 options.
1750 Return an alist whose key is a headline and value is its
1751 associated numbering \(in the shape of a list of numbers) or nil
1752 for a footnotes section."
1761 headline
1763 for n across numbering
1764 for idx from 0 to org-export-max-depth
1768 options)))
1771 "List headlines and inlinetasks with a select tag in their tree.
1772 DATA is parsed data as returned by `org-element-parse-buffer'.
1773 INFO is a plist holding export options."
1776 ;; If FILETAGS contains a select tag, every headline or
1777 ;; inlinetask is returned.
1787 ;; When a select tag is found, mark full
1788 ;; genealogy and every headline within the
1789 ;; tree as acceptable.
1792 genealogy
1795 selected-trees))
1796 ;; If at a headline, continue searching in
1797 ;; tree, recursively.
1806 selected-trees))))
1809 "Non-nil when element or object BLOB should be skipped during export.
1810 OPTIONS is the plist holding export options. SELECTED, when
1811 non-nil, is a list of headlines or inlinetasks belonging to
1812 a tree with a select tag."
1819 ;; If `:with-drawers' value starts with `not', ignore
1820 ;; every drawer whose name belong to that list.
1821 ;; Otherwise, ignore drawers whose name isn't in that
1822 ;; list.
1839 ;; Ignore subtrees with an exclude tag.
1842 ;; When a select tag is present in the buffer, ignore any tree
1843 ;; without it.
1845 ;; Ignore commented sub-trees.
1847 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1849 ;; Ignore tasks, if specified by `:with-tasks' property.
1861 properties-set))))))
1872 ;; `:with-timestamps' only applies to isolated timestamps
1873 ;; objects, i.e. timestamp objects in a paragraph containing only
1874 ;; timestamps and whitespaces.
1882 options t))))
1891 \f
1892 ;;; The Transcoder
1893 ;;
1894 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1895 ;; `org-element-parse-buffer') and transcodes it into a specified
1896 ;; back-end output. It takes care of filtering out elements or
1897 ;; objects according to export options and organizing the output blank
1898 ;; lines and white space are preserved. The function memoizes its
1899 ;; results, so it is cheap to call it within transcoders.
1900 ;;
1901 ;; It is possible to modify locally the back-end used by
1902 ;; `org-export-data' or even use a temporary back-end by using
1903 ;; `org-export-data-with-backend'.
1904 ;;
1905 ;; `org-export-transcoder' is an accessor returning appropriate
1906 ;; translator function for a given element or object.
1909 "Return appropriate transcoder for BLOB.
1910 INFO is a plist containing export directives."
1912 ;; Return contents only for complete parse trees.
1918 "Convert DATA into current back-end format.
1920 DATA is a parse tree, an element or an object or a secondary
1921 string. INFO is a plist holding export options.
1923 Return a string."
1925 ;; Handle broken links according to
1926 ;; `org-export-with-broken-links'.
1942 ;; Ignored element/object.
1944 ;; Plain text.
1950 info))
1951 ;; Secondary string.
1954 ;; Element/Object without contents or, as a special
1955 ;; case, headline with archive tag and archived trees
1956 ;; restricted to title only.
1965 ;; Export snippets never return a nil value so
1966 ;; that white spaces following them are never
1967 ;; ignored.
1969 ;; Element/Object with contents.
1982 ;; Elements directly containing
1983 ;; objects must have their indentation
1984 ;; normalized first.
1986 data
1987 ;; When normalizing contents of the
1988 ;; first paragraph in an item or
1989 ;; a footnote definition, ignore
1990 ;; first line's indentation: there is
1991 ;; none and it might be misleading.
1995 data)
2003 info)))))))))
2004 ;; Final result will be memoized before being returned.
2006 data
2010 ;; Append the same white space between elements or objects
2011 ;; as in the original buffer, and call appropriate filters.
2020 info)))
2024 "Convert DATA into BACKEND format.
2026 DATA is an element, an object, a secondary string or a string.
2027 BACKEND is a symbol. INFO is a plist used as a communication
2028 channel.
2030 Unlike to `org-export-with-backend', this function will
2031 recursively convert DATA using BACKEND translation table."
2033 ;; Set-up a new communication channel with translations defined in
2034 ;; BACKEND as the translate table and a new hash table for
2035 ;; memoization.
2038 info
2041 ;; Size of the hash table is reduced since this
2042 ;; function will probably be used on small trees.
2045 ;; Preserve `:internal-references', as those do not depend on
2046 ;; the back-end used; we need to make sure that any new
2047 ;; reference when the temporary back-end was active gets through
2048 ;; the default one.
2053 "Expand a parsed element or object to its original state.
2055 BLOB is either an element or an object. CONTENTS is its
2056 contents, as a string or nil.
2058 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2059 keywords before output."
2065 blob contents))))
2068 \f
2069 ;;; The Filter System
2070 ;;
2071 ;; Filters allow end-users to tweak easily the transcoded output.
2072 ;; They are the functional counterpart of hooks, as every filter in
2073 ;; a set is applied to the return value of the previous one.
2074 ;;
2075 ;; Every set is back-end agnostic. Although, a filter is always
2076 ;; called, in addition to the string it applies to, with the back-end
2077 ;; used as argument, so it's easy for the end-user to add back-end
2078 ;; specific filters in the set. The communication channel, as
2079 ;; a plist, is required as the third argument.
2080 ;;
2081 ;; From the developer side, filters sets can be installed in the
2082 ;; process with the help of `org-export-define-backend', which
2083 ;; internally stores filters as an alist. Each association has a key
2084 ;; among the following symbols and a function or a list of functions
2085 ;; as value.
2086 ;;
2087 ;; - `:filter-options' applies to the property list containing export
2088 ;; options. Unlike to other filters, functions in this list accept
2089 ;; two arguments instead of three: the property list containing
2090 ;; export options and the back-end. Users can set its value through
2091 ;; `org-export-filter-options-functions' variable.
2092 ;;
2093 ;; - `:filter-parse-tree' applies directly to the complete parsed
2094 ;; tree. Users can set it through
2095 ;; `org-export-filter-parse-tree-functions' variable.
2096 ;;
2097 ;; - `:filter-body' applies to the body of the output, before template
2098 ;; translator chimes in. Users can set it through
2099 ;; `org-export-filter-body-functions' variable.
2100 ;;
2101 ;; - `:filter-final-output' applies to the final transcoded string.
2102 ;; Users can set it with `org-export-filter-final-output-functions'
2103 ;; variable.
2104 ;;
2105 ;; - `:filter-plain-text' applies to any string not recognized as Org
2106 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2107 ;; configure it.
2108 ;;
2109 ;; - `:filter-TYPE' applies on the string returned after an element or
2110 ;; object of type TYPE has been transcoded. A user can modify
2111 ;; `org-export-filter-TYPE-functions' to install these filters.
2112 ;;
2113 ;; All filters sets are applied with
2114 ;; `org-export-filter-apply-functions' function. Filters in a set are
2115 ;; applied in a LIFO fashion. It allows developers to be sure that
2116 ;; their filters will be applied first.
2117 ;;
2118 ;; Filters properties are installed in communication channel with
2119 ;; `org-export-install-filters' function.
2120 ;;
2121 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2122 ;; `org-export-before-parsing-hook') are run at the beginning of the
2123 ;; export process and just before parsing to allow for heavy structure
2124 ;; modifications.
2127 ;;;; Hooks
2130 "Hook run at the beginning of the export process.
2132 This is run before include keywords and macros are expanded and
2133 Babel code blocks executed, on a copy of the original buffer
2134 being exported. Visibility and narrowing are preserved. Point
2135 is at the beginning of the buffer.
2137 Every function in this hook will be called with one argument: the
2141 "Hook run before parsing an export buffer.
2143 This is run after include keywords and macros have been expanded
2144 and Babel code blocks executed, on a copy of the original buffer
2145 being exported. Visibility and narrowing are preserved. Point
2146 is at the beginning of the buffer.
2148 Every function in this hook will be called with one argument: the
2152 ;;;; Special Filters
2155 "List of functions applied to the export options.
2156 Each filter is called with two arguments: the export options, as
2157 a plist, and the back-end, as a symbol. It must return
2161 "List of functions applied to the parsed tree.
2162 Each filter is called with three arguments: the parse tree, as
2163 returned by `org-element-parse-buffer', the back-end, as
2164 a symbol, and the communication channel, as a plist. It must
2168 "List of functions applied to plain text.
2169 Each filter is called with three arguments: a string which
2170 contains no Org syntax, the back-end, as a symbol, and the
2171 communication channel, as a plist. It must return a string or
2175 "List of functions applied to transcoded body.
2176 Each filter is called with three arguments: a string which
2177 contains no Org syntax, the back-end, as a symbol, and the
2178 communication channel, as a plist. It must return a string or
2182 "List of functions applied to the transcoded string.
2183 Each filter is called with three arguments: the full transcoded
2184 string, the back-end, as a symbol, and the communication channel,
2185 as a plist. It must return a string that will be used as the
2189 ;;;; Elements Filters
2192 "List of functions applied to a transcoded babel-call.
2193 Each filter is called with three arguments: the transcoded data,
2194 as a string, the back-end, as a symbol, and the communication
2198 "List of functions applied to a transcoded center block.
2199 Each filter is called with three arguments: the transcoded data,
2200 as a string, the back-end, as a symbol, and the communication
2204 "List of functions applied to a transcoded clock.
2205 Each filter is called with three arguments: the transcoded data,
2206 as a string, the back-end, as a symbol, and the communication
2210 "List of functions applied to a transcoded diary-sexp.
2211 Each filter is called with three arguments: the transcoded data,
2212 as a string, the back-end, as a symbol, and the communication
2216 "List of functions applied to a transcoded drawer.
2217 Each filter is called with three arguments: the transcoded data,
2218 as a string, the back-end, as a symbol, and the communication
2222 "List of functions applied to a transcoded dynamic-block.
2223 Each filter is called with three arguments: the transcoded data,
2224 as a string, the back-end, as a symbol, and the communication
2228 "List of functions applied to a transcoded example-block.
2229 Each filter is called with three arguments: the transcoded data,
2230 as a string, the back-end, as a symbol, and the communication
2234 "List of functions applied to a transcoded export-block.
2235 Each filter is called with three arguments: the transcoded data,
2236 as a string, the back-end, as a symbol, and the communication
2240 "List of functions applied to a transcoded fixed-width.
2241 Each filter is called with three arguments: the transcoded data,
2242 as a string, the back-end, as a symbol, and the communication
2246 "List of functions applied to a transcoded footnote-definition.
2247 Each filter is called with three arguments: the transcoded data,
2248 as a string, the back-end, as a symbol, and the communication
2252 "List of functions applied to a transcoded headline.
2253 Each filter is called with three arguments: the transcoded data,
2254 as a string, the back-end, as a symbol, and the communication
2258 "List of functions applied to a transcoded horizontal-rule.
2259 Each filter is called with three arguments: the transcoded data,
2260 as a string, the back-end, as a symbol, and the communication
2264 "List of functions applied to a transcoded inlinetask.
2265 Each filter is called with three arguments: the transcoded data,
2266 as a string, the back-end, as a symbol, and the communication
2270 "List of functions applied to a transcoded item.
2271 Each filter is called with three arguments: the transcoded data,
2272 as a string, the back-end, as a symbol, and the communication
2276 "List of functions applied to a transcoded keyword.
2277 Each filter is called with three arguments: the transcoded data,
2278 as a string, the back-end, as a symbol, and the communication
2282 "List of functions applied to a transcoded latex-environment.
2283 Each filter is called with three arguments: the transcoded data,
2284 as a string, the back-end, as a symbol, and the communication
2288 "List of functions applied to a transcoded node-property.
2289 Each filter is called with three arguments: the transcoded data,
2290 as a string, the back-end, as a symbol, and the communication
2294 "List of functions applied to a transcoded paragraph.
2295 Each filter is called with three arguments: the transcoded data,
2296 as a string, the back-end, as a symbol, and the communication
2300 "List of functions applied to a transcoded plain-list.
2301 Each filter is called with three arguments: the transcoded data,
2302 as a string, the back-end, as a symbol, and the communication
2306 "List of functions applied to a transcoded planning.
2307 Each filter is called with three arguments: the transcoded data,
2308 as a string, the back-end, as a symbol, and the communication
2312 "List of functions applied to a transcoded property-drawer.
2313 Each filter is called with three arguments: the transcoded data,
2314 as a string, the back-end, as a symbol, and the communication
2318 "List of functions applied to a transcoded quote block.
2319 Each filter is called with three arguments: the transcoded quote
2320 data, as a string, the back-end, as a symbol, and the
2321 communication channel, as a plist. It must return a string or
2325 "List of functions applied to a transcoded section.
2326 Each filter is called with three arguments: the transcoded data,
2327 as a string, the back-end, as a symbol, and the communication
2331 "List of functions applied to a transcoded special block.
2332 Each filter is called with three arguments: the transcoded data,
2333 as a string, the back-end, as a symbol, and the communication
2337 "List of functions applied to a transcoded src-block.
2338 Each filter is called with three arguments: the transcoded data,
2339 as a string, the back-end, as a symbol, and the communication
2343 "List of functions applied to a transcoded table.
2344 Each filter is called with three arguments: the transcoded data,
2345 as a string, the back-end, as a symbol, and the communication
2349 "List of functions applied to a transcoded table-cell.
2350 Each filter is called with three arguments: the transcoded data,
2351 as a string, the back-end, as a symbol, and the communication
2355 "List of functions applied to a transcoded table-row.
2356 Each filter is called with three arguments: the transcoded data,
2357 as a string, the back-end, as a symbol, and the communication
2361 "List of functions applied to a transcoded verse block.
2362 Each filter is called with three arguments: the transcoded data,
2363 as a string, the back-end, as a symbol, and the communication
2367 ;;;; Objects Filters
2370 "List of functions applied to transcoded bold text.
2371 Each filter is called with three arguments: the transcoded data,
2372 as a string, the back-end, as a symbol, and the communication
2376 "List of functions applied to transcoded code text.
2377 Each filter is called with three arguments: the transcoded data,
2378 as a string, the back-end, as a symbol, and the communication
2382 "List of functions applied to a transcoded entity.
2383 Each filter is called with three arguments: the transcoded data,
2384 as a string, the back-end, as a symbol, and the communication
2388 "List of functions applied to a transcoded export-snippet.
2389 Each filter is called with three arguments: the transcoded data,
2390 as a string, the back-end, as a symbol, and the communication
2394 "List of functions applied to a transcoded footnote-reference.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2400 "List of functions applied to a transcoded inline-babel-call.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2406 "List of functions applied to a transcoded inline-src-block.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2412 "List of functions applied to transcoded italic text.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2418 "List of functions applied to a transcoded latex-fragment.
2419 Each filter is called with three arguments: the transcoded data,
2420 as a string, the back-end, as a symbol, and the communication
2424 "List of functions applied to a transcoded line-break.
2425 Each filter is called with three arguments: the transcoded data,
2426 as a string, the back-end, as a symbol, and the communication
2430 "List of functions applied to a transcoded link.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2436 "List of functions applied to a transcoded radio-target.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2442 "List of functions applied to a transcoded statistics-cookie.
2443 Each filter is called with three arguments: the transcoded data,
2444 as a string, the back-end, as a symbol, and the communication
2448 "List of functions applied to transcoded strike-through text.
2449 Each filter is called with three arguments: the transcoded data,
2450 as a string, the back-end, as a symbol, and the communication
2454 "List of functions applied to a transcoded subscript.
2455 Each filter is called with three arguments: the transcoded data,
2456 as a string, the back-end, as a symbol, and the communication
2460 "List of functions applied to a transcoded superscript.
2461 Each filter is called with three arguments: the transcoded data,
2462 as a string, the back-end, as a symbol, and the communication
2466 "List of functions applied to a transcoded target.
2467 Each filter is called with three arguments: the transcoded data,
2468 as a string, the back-end, as a symbol, and the communication
2472 "List of functions applied to a transcoded timestamp.
2473 Each filter is called with three arguments: the transcoded data,
2474 as a string, the back-end, as a symbol, and the communication
2478 "List of functions applied to transcoded underline text.
2479 Each filter is called with three arguments: the transcoded data,
2480 as a string, the back-end, as a symbol, and the communication
2484 "List of functions applied to transcoded verbatim text.
2485 Each filter is called with three arguments: the transcoded data,
2486 as a string, the back-end, as a symbol, and the communication
2490 ;;;; Filters Tools
2491 ;;
2492 ;; Internal function `org-export-install-filters' installs filters
2493 ;; hard-coded in back-ends (developer filters) and filters from global
2494 ;; variables (user filters) in the communication channel.
2495 ;;
2496 ;; Internal function `org-export-filter-apply-functions' takes care
2497 ;; about applying each filter in order to a given data. It ignores
2498 ;; filters returning a nil value but stops whenever a filter returns
2499 ;; an empty string.
2502 "Call every function in FILTERS.
2504 Functions are called with three arguments: a value, the export
2505 back-end name and the communication channel. First function in
2506 FILTERS is called with VALUE as its first argument. Second
2507 function in FILTERS is called with the previous result as its
2508 value, etc.
2510 Functions returning nil are skipped. Any function returning the
2511 empty string ends the process, which returns the empty string.
2513 Call is done in a LIFO fashion, to be sure that developer
2514 specified filters, if any, are called first."
2525 "Install filters properties in communication channel.
2526 INFO is a plist containing the current communication channel.
2527 Return the updated communication channel."
2529 ;; Install user-defined filters with `org-export-filters-alist'
2530 ;; and filters already in INFO (through ext-plist mechanism).
2537 ;; Filters in INFO will be called
2538 ;; before those user provided.
2541 default-value)))))
2542 ;; Prepend back-end specific filters to that list.
2544 ;; Single values get consed, lists are appended.
2549 plist key
2552 ;; Return new communication channel.
2556 \f
2557 ;;; Core functions
2558 ;;
2559 ;; This is the room for the main function, `org-export-as', along with
2560 ;; its derivative, `org-export-string-as'.
2561 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2562 ;; function should be added to kill ring.
2563 ;;
2564 ;; Note that `org-export-as' doesn't really parse the current buffer,
2565 ;; but a copy of it (with the same buffer-local variables and
2566 ;; visibility), where macros and include keywords are expanded and
2567 ;; Babel blocks are executed, if appropriate.
2568 ;; `org-export-with-buffer-copy' macro prepares that copy.
2569 ;;
2570 ;; File inclusion is taken care of by
2571 ;; `org-export-expand-include-keyword' and
2572 ;; `org-export--prepare-file-contents'. Structure wise, including
2573 ;; a whole Org file in a buffer often makes little sense. For
2574 ;; example, if the file contains a headline and the include keyword
2575 ;; was within an item, the item should contain the headline. That's
2576 ;; why file inclusion should be done before any structure can be
2577 ;; associated to the file, that is before parsing.
2578 ;;
2579 ;; `org-export-insert-default-template' is a command to insert
2580 ;; a default template (or a back-end specific template) at point or in
2581 ;; current subtree.
2584 "Return a copy of the current buffer.
2585 The copy preserves Org buffer-local variables, visibility and
2586 narrowing."
2592 new-buf))
2595 "Apply BODY in a copy of the current buffer.
2596 The copy preserves local variables, visibility and contents of
2597 the original buffer. Point is at the beginning of the buffer
2598 when BODY is applied."
2607 ;; Kill copy without confirmation.
2613 "Generate a function duplicating BUFFER.
2615 The copy will preserve local variables, visibility, contents and
2616 narrowing of the original buffer. If a region was active in
2617 BUFFER, contents will be narrowed to that region instead.
2619 The resulting function can be evaluated at a later time, from
2620 another buffer, effectively cloning the original buffer there.
2622 The function assumes BUFFER's major mode is `org-mode'."
2626 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2627 ;; already in BUFFER.
2629 ;; Copy specific buffer local variables and variables set
2630 ;; through BIND keywords.
2632 vars)
2640 buffer-file-name
2641 buffer-file-coding-system))
2645 ;; Skip unreadable values, as they cannot be
2646 ;; sent to external process.
2650 vars))))))
2651 ;; Whole buffer contents.
2656 ;; Narrowing.
2660 ;; Current position of point.
2662 ;; Overlays with invisible property.
2671 ov-set)))))))))
2674 "Delete commented areas in the buffer.
2675 Commented areas are comments, comment blocks, commented trees and
2676 inlinetasks. Trailing blank lines after a comment or a comment
2677 block are removed, as long as it doesn't alter the structure of
2678 the document. Narrowing, if any, is ignored."
2684 comment-re)))
2696 ;; We remove trailing blank lines. Doing so could
2697 ;; modify the structure of the document. Therefore
2698 ;; we ensure that any comment between elements is
2699 ;; replaced with one empty line, so as to keep them
2700 ;; separated.
2706 start)
2708 end)
2718 "Prune non exportable elements from DATA.
2719 DATA is the parse tree to traverse. INFO is the plist holding
2720 export info. Also set `:ignore-list' in INFO to a list of
2721 objects which should be ignored during export, but not removed
2722 from tree."
2724 ;; First find trees containing a select tag, if any.
2728 ;; Prune non-exportable elements and objects from tree.
2729 ;; As a special case, special rows and cells from tables
2730 ;; are stored in IGNORE, as they still need to be
2731 ;; accessed during export.
2741 ;; If headline is archived but tree below has
2742 ;; to be skipped, remove contents.
2744 ;; Move into recursive objects/elements.
2746 ;; Move into secondary string, if any.
2748 org-element-secondary-value-alist)))
2751 ;; Collect definitions before possibly pruning them so as
2752 ;; to avoid parsing them again if they are required.
2761 #'org-element-create
2764 ;; If a select tag is active, also ignore the section before the
2765 ;; first headline, if any.
2770 ;; Prune tree and communication channel.
2773 ;; Priority is given to back-end specific options.
2775 org-export-options-alist))
2781 ;; Eventually set `:ignore-list'.
2785 "List footnote definitions missing from TREE.
2786 Missing definitions are searched within DEFINITIONS, which is
2787 a list of footnote definitions or in the widened buffer."
2790 ;; List all footnote labels encountered in DATA. Inline
2791 ;; footnote references are ignored.
2796 defined undefined missing-definitions)
2797 ;; Partition DIRECT-REFERENCES between DEFINED and UNDEFINED
2798 ;; references.
2805 seen)
2810 ;; Complete MISSING-DEFINITIONS by finding the definition of every
2811 ;; undefined label, first by looking into DEFINITIONS, then by
2812 ;; searching the widened buffer. This is a recursive process
2813 ;; since definitions found can themselves contain an undefined
2814 ;; reference.
2821 d))
2822 definitions))
2829 datum
2830 ;; Parse definition with contents.
2841 ;; Look for footnote references within DEFINITION, since
2842 ;; we may need to also find their definition.
2847 ;; MISSING-DEFINITIONS may contain footnote references with inline
2848 ;; definitions. Make sure those are changed into real footnote
2849 ;; definitions.
2856 missing-definitions)))
2859 "Install footnote definitions in tree.
2861 DEFINITIONS is the list of footnote definitions to install. TREE
2862 is the parse tree.
2864 If there is a footnote section in TREE, definitions found are
2865 appended to it. If `org-footnote-section' is non-nil, a new
2866 footnote section containing all definitions is inserted in TREE.
2867 Otherwise, definitions are appended at the end of the section
2868 containing their first reference."
2871 ;; If there is a footnote section, insert definitions there.
2875 nil t)))
2878 footnote-section
2880 ;; If there should be a footnote section, create one containing all
2881 ;; the definitions at the end of the tree.
2884 tree
2890 'section
2891 nil
2893 ;; Otherwise add each definition at the end of the section where it
2894 ;; is first referenced.
2899 ;; Insert footnote definitions in the same section as
2900 ;; their first reference in DATA.
2911 label)
2912 d))
2913 definitions)))
2916 definition)
2917 ;; Also insert definitions for nested
2918 ;; references, if any.
2923 "Change uninterpreted elements back into Org syntax.
2924 DATA is the parse tree. INFO is a plist containing export
2925 options. Each uninterpreted element or object is changed back
2926 into a string. Contents, if any, are not modified. The parse
2927 tree is modified by side effect."
2933 p
2936 info))))))
2939 "Change uninterpreted elements back into Org syntax.
2940 DATA is a parse tree or a secondary string. INFO is a plist
2941 containing export options. It is modified by side effect and
2942 returned by the function."
2945 subscript superscript underline)
2949 ;; ... entities...
2956 ?\s)))))
2957 ;; ... emphasis...
2969 marker
2973 ?\s)))))))
2974 ;; ... LaTeX environments and fragments...
2978 ;; ... sub/superscripts...
2987 "_"
2996 ?\s)))))))))))
2998 ;; Splice NEW at BLOB location in parse tree.
3001 info nil nil t)
3002 ;; Return modified parse tree.
3003 data)
3005 ;;;###autoload
3008 "Transcode current Org buffer into BACKEND code.
3010 BACKEND is either an export back-end, as returned by, e.g.,
3011 `org-export-create-backend', or a symbol referring to
3012 a registered back-end.
3014 If narrowing is active in the current buffer, only transcode its
3015 narrowed part.
3017 If a region is active, transcode that region.
3019 When optional argument SUBTREEP is non-nil, transcode the
3020 sub-tree at point, extracting information from the headline
3021 properties first.
3023 When optional argument VISIBLE-ONLY is non-nil, don't export
3024 contents of hidden elements.
3026 When optional argument BODY-ONLY is non-nil, only return body
3027 code, without surrounding template.
3029 Optional argument EXT-PLIST, when provided, is a property list
3030 with external parameters overriding Org default settings, but
3031 still inferior to file-local settings.
3033 Return code as a string."
3038 ;; Narrow buffer to an appropriate region or subtree for
3039 ;; parsing. If parsing subtree, be sure to remove main
3040 ;; headline, planning data and property drawer.
3048 ;; Initialize communication channel with original buffer
3049 ;; attributes, unavailable in its copy.
3053 backend subtreep visible-only body-only)
3059 org-export-options-alist))))
3060 tree)
3061 ;; Update communication channel and get parse tree. Buffer
3062 ;; isn't parsed directly. Instead, all buffer modifications
3063 ;; and consequent parsing are undertaken in a temporary copy.
3065 ;; Run first hook with current back-end's name as argument.
3068 ;; Include files, delete comments and expand macros.
3074 nil parsed-keywords)
3075 ;; Refresh buffer properties and radio targets after
3076 ;; potentially invasive previous changes. Likewise, do it
3077 ;; again after executing Babel code.
3084 ;; Run last hook with current back-end's name as argument.
3085 ;; Update buffer properties and radio targets one last time
3086 ;; before parsing.
3093 ;; Update communication channel with environment. Also
3094 ;; install user's and developer's filters.
3099 ;; Call options filters and update export options. We do not
3100 ;; use `org-export-filter-apply-functions' here since the
3101 ;; arity of such filters is different.
3106 ;; Expand export-specific set of macros: {{{author}}},
3107 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
3108 ;; be done once regular macros have been expanded, since
3109 ;; parsed keywords may contain one of them.
3122 value)
3123 value)))
3127 'finalize
3128 parsed-keywords)
3129 ;; Parse buffer.
3131 ;; Prune tree from non-exported elements and transform
3132 ;; uninterpreted elements or objects in both parse tree and
3133 ;; communication channel.
3136 ;; Call parse tree filters.
3140 ;; Now tree is complete, compute its properties and add them
3141 ;; to communication channel.
3143 ;; Eventually transcode TREE. Wrap the resulting string into
3144 ;; a template.
3153 info))
3156 ;; Remove all text properties since they cannot be
3157 ;; retrieved from an external process. Finally call
3158 ;; final-output filter and return result.
3164 info))))))))
3166 ;;;###autoload
3168 "Transcode STRING into BACKEND code.
3170 BACKEND is either an export back-end, as returned by, e.g.,
3171 `org-export-create-backend', or a symbol referring to
3172 a registered back-end.
3174 When optional argument BODY-ONLY is non-nil, only return body
3175 code, without preamble nor postamble.
3177 Optional argument EXT-PLIST, when provided, is a property list
3178 with external parameters overriding Org default settings, but
3179 still inferior to file-local settings.
3181 Return code as a string."
3187 ;;;###autoload
3189 "Replace the active region by its export to BACKEND.
3190 BACKEND is either an export back-end, as returned by, e.g.,
3191 `org-export-create-backend', or a symbol referring to
3192 a registered back-end."
3198 ;;;###autoload
3200 "Insert all export keywords with default values at beginning of line.
3202 BACKEND is a symbol referring to the name of a registered export
3203 back-end, for which specific export options should be added to
3204 the template, or `default' for default template. When it is nil,
3205 the user will be prompted for a category.
3207 If SUBTREEP is non-nil, export configuration will be set up
3208 locally for the subtree through node properties."
3218 "Options category: "
3222 org-export-registered-backends))
3223 nil t))))
3224 options keywords)
3225 ;; Populate OPTIONS and KEYWORDS.
3242 ;; Move to an appropriate location in order to insert options.
3244 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3262 ;; Then the rest of keywords, in the order specified in either
3263 ;; `org-export-options-alist' or respective export back-ends.
3284 "Expand every include keyword in buffer.
3285 Optional argument INCLUDED is a list of included file names along
3286 with their line restriction, when appropriate. It is used to
3287 avoid infinite recursion. Optional argument DIR is the current
3288 working directory. It is used to properly resolve relative
3289 paths. Optional argument FOOTNOTES is a hash-table used for
3290 storing and resolving footnotes. It is created automatically."
3296 ;; If :minlevel is not set the text-property
3297 ;; `:org-include-induced-level' will be used to determine the
3298 ;; relative level when expanding INCLUDE.
3299 ;; Only affects included Org documents.
3303 :org-include-induced-level
3305 ;; Expand INCLUDE keywords.
3311 ;; Extract arguments from keyword's value.
3314 location
3322 matched)
3328 dir)))
3332 value)
3338 value)
3347 ;; Minimal level of included file defaults to the child
3348 ;; level of the current headline, if any, or one. It
3349 ;; only applies is the file is meant to be included as
3350 ;; an Org one.
3361 ;; Remove keyword.
3367 ;; Check if files has already been parsed. Look after
3368 ;; inclusion lines too, as different parts of the same file
3369 ;; can be included too.
3382 ind-str block arg-str contents ind-str block))))
3389 ind-str block contents ind-str block))))
3397 file location only-contents lines)
3398 lines)))
3402 file lines ind minlevel
3405 footnotes)))
3409 footnotes)
3411 ;; Expand footnotes after all files have been included.
3412 ;; Footnotes are stored at end of buffer.
3417 footnotes)))))))))))
3420 "Resolve absolute lines for an included file with file-link.
3422 FILE is string file-name of the file to include. LOCATION is a
3423 string name within FILE to be included (located via
3424 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3425 contents of the named element will be included, as determined
3426 Org-Element. If LINES is non-nil only those lines are included.
3428 Return a string of lines to be included in the format expected by
3429 `org-export--prepare-file-contents'."
3435 ;; Enforce consistent search.
3448 ;; Skip planning line and property-drawer.
3474 start-line
3476 (+ start-line
3479 counter))))))))
3483 "Prepare contents of FILE for inclusion and return it as a string.
3485 When optional argument LINES is a string specifying a range of
3486 lines, include only those lines.
3488 Optional argument IND, when non-nil, is an integer specifying the
3489 global indentation of returned contents. Since its purpose is to
3490 allow an included file to stay in the same environment it was
3491 created (e.g., a list item), it doesn't apply past the first
3492 headline encountered.
3494 Optional argument MINLEVEL, when non-nil, is an integer
3495 specifying the level that any top-level headline in the included
3496 file should have.
3498 Optional argument ID is an integer that will be inserted before
3499 each footnote definition and reference if FILE is an Org file.
3500 This is useful to avoid conflicts when more than one Org file
3501 with footnotes is included in a document.
3503 Optional argument FOOTNOTES is a hash-table to store footnotes in
3504 the included document."
3520 ;; Remove blank lines at beginning and end of contents. The logic
3521 ;; behind that removal is that blank lines around include keyword
3522 ;; override blank lines in included file.
3531 ;; If IND is set, preserve indentation of include keyword until
3532 ;; the first headline encountered.
3539 ;; Do not move footnote definitions out of column 0.
3545 ;; When MINLEVEL is specified, compute minimal level for headlines
3546 ;; in the file (CUR-MIN), and remove stars to each headline so
3547 ;; that headlines with minimal level have a level of MINLEVEL.
3558 ;; Only change stars, don't bother moving whole
3559 ;; sections.
3564 ;; Append ID to all footnote references and definitions, so they
3565 ;; become file specific and cannot collide with footnotes in other
3566 ;; included files. Further, collect relevant footnote definitions
3567 ;; outside of LINES, in order to reintroduce them later.
3573 ;; Generate new label from LABEL by prefixing it with
3574 ;; "-ID-".
3578 ;; Replace OLD label with NEW in footnote F.
3592 ;; Update the footnote-reference at point and collect
3593 ;; the new label, which is only used for footnotes
3594 ;; outsides LINES.
3606 ;; Store since footnote-definition is
3607 ;; outside of LINES.
3610 footnotes))))
3617 "Return a non-nil value when output should be added to the kill ring.
3618 See also `org-export-copy-to-kill-ring'."
3624 \f
3625 ;;; Tools For Back-Ends
3626 ;;
3627 ;; A whole set of tools is available to help build new exporters. Any
3628 ;; function general enough to have its use across many back-ends
3629 ;; should be added here.
3631 ;;;; For Affiliated Keywords
3632 ;;
3633 ;; `org-export-read-attribute' reads a property from a given element
3634 ;; as a plist. It can be used to normalize affiliated keywords'
3635 ;; syntax.
3636 ;;
3637 ;; Since captions can span over multiple lines and accept dual values,
3638 ;; their internal representation is a bit tricky. Therefore,
3639 ;; `org-export-get-caption' transparently returns a given element's
3640 ;; caption as a secondary string.
3643 "Turn ATTRIBUTE property from ELEMENT into a plist.
3645 When optional argument PROPERTY is non-nil, return the value of
3646 that property within attributes.
3650 properties.
3652 All values will become strings except the empty string and
3655 will become the empty string."
3669 s)
3674 ;; Ignore any string before first property with `cdr'.
3679 "Return caption from ELEMENT as a secondary string.
3681 When optional argument SHORTP is non-nil, return short caption,
3682 as a secondary string, instead.
3684 Caption lines are separated by a white space."
3692 ;;;; For Derived Back-ends
3693 ;;
3694 ;; `org-export-with-backend' is a function allowing to locally use
3695 ;; another back-end to transcode some object or element. In a derived
3696 ;; back-end, it may be used as a fall-back function once all specific
3697 ;; cases have been treated.
3700 "Call a transcoder from BACKEND on DATA.
3701 BACKEND is an export back-end, as returned by, e.g.,
3702 `org-export-create-backend', or a symbol referring to
3703 a registered back-end. DATA is an Org element, object, secondary
3704 string or string. CONTENTS, when non-nil, is the transcoded
3705 contents of DATA element, as a string. INFO, when non-nil, is
3706 the communication channel used for export, as a plist."
3717 :back-end backend
3718 :translate-alist all-transcoders
3720 ;; `:internal-references' are shared across back-ends.
3726 ;;;; For Export Snippets
3727 ;;
3728 ;; Every export snippet is transmitted to the back-end. Though, the
3729 ;; latter will only retain one type of export-snippet, ignoring
3730 ;; others, based on the former's target back-end. The function
3731 ;; `org-export-snippet-backend' returns that back-end for a given
3732 ;; export-snippet.
3735 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3736 Translation, with `org-export-snippet-translation-alist', is
3737 applied."
3741 back-end))))
3744 ;;;; For Footnotes
3745 ;;
3746 ;; `org-export-collect-footnote-definitions' is a tool to list
3747 ;; actually used footnotes definitions in the whole parse tree, or in
3748 ;; a headline, in order to add footnote listings throughout the
3749 ;; transcoded data.
3750 ;;
3751 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3752 ;; back-ends, when they need to attach the footnote definition only to
3753 ;; the first occurrence of the corresponding label.
3754 ;;
3755 ;; `org-export-get-footnote-definition' and
3756 ;; `org-export-get-footnote-number' provide easier access to
3757 ;; additional information relative to a footnote reference.
3760 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3761 INFO is the plist used as a communication channel. If no such
3762 definition can be found, raise an error."
3768 hash))))
3776 ;; Skip any footnote with a different label.
3777 ;; Also skip any standard footnote reference
3778 ;; with the same label since those cannot
3779 ;; contain a definition.
3783 ;; Even if the contents are empty, we can not
3784 ;; return nil since that would eventually raise
3785 ;; the error. Instead, return the equivalent
3786 ;; empty string.
3788 info t)
3789 cache)
3794 "Apply FUNCTION on every footnote reference in DATA.
3795 INFO is a plist containing export state. By default, as soon as
3796 a new footnote reference is encountered, FUNCTION is called onto
3797 its definition. However, if BODY-FIRST is non-nil, this step is
3798 delayed until the end of the process."
3803 ;; Search footnote references through DATA, filling
3804 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3805 ;; store footnote definitions so they can be entered
3806 ;; later.
3813 ;; Search for subsequent references in footnote
3814 ;; definition so numbering follows reading
3815 ;; logic, unless DELAYP in non-nil.
3819 definitions))
3820 ;; Do not force entering inline definitions,
3821 ;; since `org-element-map' already traverses
3822 ;; them at the right time.
3826 nil))))))
3827 info nil
3828 ;; Don't enter footnote definitions since it will
3829 ;; happen when their first reference is found.
3830 ;; Moreover, if DELAYP is non-nil, make sure we
3831 ;; postpone entering definitions of inline references.
3838 "Return an alist between footnote numbers, labels and definitions.
3840 INFO is the current export state, as a plist.
3842 Definitions are collected throughout the whole parse tree, or
3843 DATA when non-nil.
3845 Sorting is done by order of references. As soon as a new
3846 reference is encountered, other references are searched within
3847 its definition. However, if BODY-FIRST is non-nil, this step is
3848 delayed after the whole tree is checked. This alters results
3849 when references are found in footnote definitions.
3851 Definitions either appear as Org data or as a secondary string
3852 for inlined footnotes. Unreferenced definitions are ignored."
3856 ;; Collect footnote number, label and definition.
3867 "Non-nil when a footnote reference is the first one for its label.
3869 FOOTNOTE-REFERENCE is the footnote reference being considered.
3870 INFO is a plist containing current export state.
3872 Search is done throughout the whole parse tree, or DATA when
3873 non-nil.
3875 By default, as soon as a new footnote reference is encountered,
3876 other references are searched within its definition. However, if
3877 BODY-FIRST is non-nil, this step is delayed after the whole tree
3878 is checked. This alters results when references are found in
3879 footnote definitions."
3881 ;; Anonymous footnotes are always a first reference.
3892 "Return number associated to a footnote.
3894 FOOTNOTE is either a footnote reference or a footnote definition.
3895 INFO is the plist containing export state.
3897 Number is unique throughout the whole parse tree, or DATA, when
3898 non-nil.
3900 By default, as soon as a new footnote reference is encountered,
3901 counting process moves into its definition. However, if
3902 BODY-FIRST is non-nil, this step is delayed until the end of the
3903 process, leading to a different order when footnotes are nested."
3912 ;; Anonymous footnote match: return number.
3914 ;; Labels match: return number.
3916 ;; Otherwise store label and increase counter if label
3917 ;; wasn't encountered yet.
3923 ;;;; For Headlines
3924 ;;
3925 ;; `org-export-get-relative-level' is a shortcut to get headline
3926 ;; level, relatively to the lower headline level in the parsed tree.
3927 ;;
3928 ;; `org-export-get-headline-number' returns the section number of an
3929 ;; headline, while `org-export-number-to-roman' allows it to be
3930 ;; converted to roman numbers. With an optional argument,
3931 ;; `org-export-get-headline-number' returns a number to unnumbered
3932 ;; headlines (used for internal id).
3933 ;;
3934 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3935 ;; `org-export-last-sibling-p' are three useful predicates when it
3936 ;; comes to fulfill the `:headline-levels' property.
3937 ;;
3938 ;; `org-export-get-tags', `org-export-get-category' and
3939 ;; `org-export-get-node-property' extract useful information from an
3940 ;; headline or a parent headline. They all handle inheritance.
3941 ;;
3942 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3943 ;; as a secondary string, suitable for table of contents. It falls
3944 ;; back onto default title.
3947 "Return HEADLINE relative level within current parsed tree.
3948 INFO is a plist holding contextual information."
3953 "Non-nil when HEADLINE is considered as low level.
3955 INFO is a plist used as a communication channel.
3957 A low level headlines has a relative level greater than
3958 `:headline-levels' property value.
3960 Return value is the difference between HEADLINE relative level
3961 and the last level being considered as high enough, or nil."
3968 "Return numbered HEADLINE numbering as a list of numbers.
3969 INFO is a plist holding contextual information."
3974 "Return a non-nil value if HEADLINE element should be numbered.
3975 INFO is a plist used as a communication channel."
3984 "Convert integer N into a roman numeral."
3997 res)))
4000 "Return list of tags associated to ELEMENT.
4002 ELEMENT has either an `headline' or an `inlinetask' type. INFO
4003 is a plist used as a communication channel.
4005 When non-nil, optional argument TAGS should be a list of strings.
4006 Any tag belonging to this list will also be removed.
4008 When optional argument INHERITED is non-nil, tags can also be
4009 inherited from parent headlines and FILETAGS keywords."
4013 ;; Build complete list of inherited tags.
4020 ;; Add FILETAGS keywords and return results.
4024 "Return node PROPERTY value for BLOB.
4026 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
4027 element or object.
4029 If optional argument INHERITED is non-nil, the value can be
4030 inherited from a parent headline.
4032 Return value is a string or nil."
4044 "Return category for element or object BLOB.
4046 INFO is a plist used as a communication channel.
4048 CATEGORY is automatically inherited from a parent headline, from
4049 #+CATEGORY: keyword or created out of original file name. If all
4062 "Return alternative title for HEADLINE, as a secondary string.
4063 If no optional title is defined, fall-back to the regular title."
4070 "Non-nil when BLOB is the first sibling in its parent.
4071 BLOB is an element or an object. If BLOB is a headline, non-nil
4072 means it is the first sibling in the sub-tree. INFO is a plist
4073 used as a communication channel."
4078 "Non-nil when BLOB is the last sibling in its parent.
4079 BLOB is an element or an object. INFO is a plist used as
4080 a communication channel."
4084 ;;;; For Keywords
4085 ;;
4086 ;; `org-export-get-date' returns a date appropriate for the document
4087 ;; to about to be exported. In particular, it takes care of
4088 ;; `org-export-date-timestamp-format'.
4091 "Return date value for the current document.
4093 INFO is a plist used as a communication channel. FMT, when
4094 non-nil, is a time format string that will be applied on the date
4095 if it consists in a single timestamp object. It defaults to
4096 `org-export-date-timestamp-format' when nil.
4098 A proper date can be a secondary string, a string or nil. It is
4099 meant to be translated with `org-export-data' or alike."
4110 ;;;; For Links
4111 ;;
4112 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4113 ;; in `org-link-parameters'.
4114 ;;
4115 ;; `org-export-get-coderef-format' returns an appropriate format
4116 ;; string for coderefs.
4117 ;;
4118 ;; `org-export-inline-image-p' returns a non-nil value when the link
4119 ;; provided should be considered as an inline image.
4120 ;;
4121 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4122 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4123 ;; returns an appropriate unique identifier.
4124 ;;
4125 ;; `org-export-resolve-id-link' returns the first headline with
4126 ;; specified id or custom-id in parse tree, the path to the external
4127 ;; file with the id.
4128 ;;
4129 ;; `org-export-resolve-coderef' associates a reference to a line
4130 ;; number in the element it belongs, or returns the reference itself
4131 ;; when the element isn't numbered.
4132 ;;
4133 ;; `org-export-file-uri' expands a filename as stored in :path value
4134 ;; of a "file" link into a file URI.
4135 ;;
4136 ;; Broken links raise a `org-link-broken' error, which is caught by
4137 ;; `org-export-data' for further processing, depending on
4138 ;; `org-export-with-broken-links' value.
4143 "Try exporting LINK with a dedicated function.
4145 DESC is its description, as a string, or nil. BACKEND is the
4146 back-end used for export, as a symbol.
4148 Return output as a string, or nil if no protocol handles LINK.
4150 A custom protocol has precedence over regular back-end export.
4151 The function ignores links with an implicit type (e.g.,
4160 desc
4161 backend))))))
4164 "Return format string for code reference link.
4165 PATH is the link path. DESC is its description."
4173 "Non-nil if LINK object points to an inline image.
4175 Optional argument is a set of RULES defining inline images. It
4176 is an alist where associations have the following shape:
4178 (TYPE . REGEXP)
4180 Applying a rule means apply REGEXP against LINK's path when its
4181 type is TYPE. The function will return a non-nil value if any of
4182 the provided rules is non-nil. The default rule is
4183 `org-export-default-inline-image-rule'.
4185 This only applies to links without a description."
4195 "Insert image links in DATA.
4197 Org syntax do not support nested links. Nevertheless, some
4198 export back-ends support image as descriptions of links. Since
4199 images are really link to image files, we need to make an
4200 exception about link nesting.
4202 This function recognizes links whose contents are really images
4203 and turn them into proper nested links. It is meant to be used
4204 as a parse tree filter in back-ends supporting such constructs.
4206 DATA is a parse tree. INFO is the current state of the export
4207 process, as a plist.
4209 A description is a valid images if it matches any rule in RULES,
4210 if non-nil, or `org-export-default-inline-image-rule' otherwise.
4211 See `org-export-inline-image-p' for more information about the
4212 structure of RULES.
4214 Return modified DATA."
4216 org-plain-link-re
4217 org-angle-link-re))
4231 l
4235 info nil nil t))
4236 data)
4239 "Resolve a code reference REF.
4241 INFO is a plist used as a communication channel.
4243 Return associated line number in source code, or REF itself,
4244 depending on src-block or example element's switches. Throw an
4245 error if no block contains REF."
4251 org-coderef-label-format))
4253 ;; Element containing REF is found. Resolve it to
4254 ;; either a label or a line number, as needed.
4263 "List search cells for element or object DATUM.
4265 A search cell follows the pattern (TYPE . SEARCH) where
4267 TYPE is a symbol among `headline', `custom-id', `target' and
4268 `other'.
4270 SEARCH is the string a link is expected to match. More
4271 accurately, it is
4273 - headline's title, as a list of strings, if TYPE is
4274 `headline'.
4276 - CUSTOM_ID value, as a string, if TYPE is `custom-id'.
4278 - target's or radio-target's name as a list of strings if
4279 TYPE is `target'.
4281 - NAME affiliated keyword is TYPE is `other'.
4283 A search cell is the internal representation of a fuzzy link. It
4284 ignores white spaces and statistics cookies, if applicable."
4286 (`headline
4297 (`target
4305 "Return search cells associated to string S.
4306 S is either the path of a fuzzy link or a search option, i.e., it
4307 tries to match either a headline (through custom ID or title),
4308 a target or a named element."
4316 "Non-nil when DATUM matches search cells CELLS.
4317 DATUM is an element or object. CELLS is a list of search cells,
4318 as returned by `org-export-search-cells'."
4323 "Return LINK destination.
4325 INFO is a plist holding contextual information.
4327 Return value can be an object or an element:
4329 - If LINK path matches a target object (i.e. <<path>>) return it.
4331 - If LINK path exactly matches the name affiliated keyword
4332 (i.e. #+NAME: path) of an element, return that element.
4334 - If LINK path exactly matches any headline name, return that
4335 element.
4337 - Otherwise, throw an error.
4340 significant."
4346 table)))
4354 datum)))))
4359 search-cells
4360 ;; There can be multiple matches for un-typed searches, i.e.,
4361 ;; for searches not starting with # or *. In this case,
4362 ;; prioritize targets and names over headline titles.
4363 ;; Matching both a name and a target is not valid, and
4364 ;; therefore undefined.
4367 datum))
4368 matches)
4370 link-cache)))))
4373 "Return headline referenced as LINK destination.
4375 INFO is a plist used as a communication channel.
4377 Return value can be the headline element matched in current parse
4381 ;; First check if id is within the current parse tree.
4386 headline))
4388 ;; Otherwise, look for external files.
4393 "Return radio-target object referenced as LINK destination.
4395 INFO is a plist used as a communication channel.
4397 Return value can be a radio-target object or nil. Assume LINK
4406 nil nil path nil nil t)
4407 t)
4408 radio))
4412 "Return file URI associated to FILENAME."
4419 ;;;; For References
4420 ;;
4421 ;; `org-export-get-reference' associate a unique reference for any
4422 ;; object or element. It uses `org-export-new-reference' and
4423 ;; `org-export-format-reference' to, respectively, generate new
4424 ;; internal references and turn them into a string suitable for
4425 ;; output.
4426 ;;
4427 ;; `org-export-get-ordinal' associates a sequence number to any object
4428 ;; or element.
4431 "Return a unique reference, among REFERENCES.
4432 REFERENCES is an alist whose values are in-use references, as
4433 numbers. Returns a number, which is the internal representation
4434 of a reference. See also `org-export-format-reference'."
4435 ;; Generate random 7 digits hexadecimal numbers. Collisions
4436 ;; increase exponentially with the numbers of references. However,
4437 ;; the odds for encountering at least one collision with 1000 active
4438 ;; references in the same document are roughly 0.2%, so this
4439 ;; shouldn't be the bottleneck.
4442 new))
4445 "Format REFERENCE into a string.
4446 REFERENCE is a number representing a reference, as returned by
4447 `org-export-new-reference', which see."
4451 "Return a unique reference for DATUM, as a string.
4453 DATUM is either an element or an object. INFO is the current
4454 export state, as a plist.
4456 This function checks `:crossrefs' property in INFO for search
4457 cells matching DATUM before creating a new reference. Returned
4458 reference consists of alphanumeric characters only."
4463 ;; Preserve any pre-existing association between
4464 ;; a search cell and a reference, i.e., when some
4465 ;; previously published document referenced a location
4466 ;; within current file (see
4467 ;; `org-publish-resolve-external-link').
4468 ;;
4469 ;; However, there is no guarantee that search cells are
4470 ;; unique, e.g., there might be duplicate custom ID or
4471 ;; two headings with the same title in the file.
4472 ;;
4473 ;; As a consequence, before re-using any reference to
4474 ;; an element or object, we check that it doesn't refer
4475 ;; to a previous element or object.
4482 cells)
4485 ;; Cache contains both data already associated to
4486 ;; a reference and in-use internal references, so as to make
4487 ;; unique references.
4489 ;; Retain a direct association between reference string and
4490 ;; DATUM since (1) not every object or element can be given
4491 ;; a search cell (2) it permits quick lookup.
4494 reference-string))))
4497 "Return ordinal number of an element or object.
4499 ELEMENT is the element or object considered. INFO is the plist
4500 used as a communication channel.
4502 Optional argument TYPES, when non-nil, is a list of element or
4503 object types, as symbols, that should also be counted in.
4504 Otherwise, only provided element's type is considered.
4506 Optional argument PREDICATE is a function returning a non-nil
4507 value if the current element or object should be counted in. It
4508 accepts two arguments: the element or object being considered and
4509 the plist used as a communication channel. This allows counting
4510 only a certain type of object (i.e. inline images).
4512 Return value is a list of numbers if ELEMENT is a headline or an
4513 item. It is nil for keywords. It represents the footnote number
4514 for footnote definitions and footnote references. If ELEMENT is
4515 a target, return the same value as if ELEMENT was the closest
4516 table, item or headline containing the target. In any other
4517 case, return the sequence number of ELEMENT among elements or
4518 objects of the same type."
4519 ;; Ordinal of a target object refer to the ordinal of the closest
4520 ;; table, item, or headline containing the object.
4524 element
4527 ;; Special case 1: A headline returns its number as a list.
4529 ;; Special case 2: An item returns its number as a list.
4533 struct
4540 ;; Increment counter until ELEMENT is found again.
4551 ;;;; For Src-Blocks
4552 ;;
4553 ;; `org-export-get-loc' counts number of code lines accumulated in
4554 ;; src-block or example-block elements with a "+n" switch until
4555 ;; a given element, excluded. Note: "-n" switches reset that count.
4556 ;;
4557 ;; `org-export-unravel-code' extracts source code (along with a code
4558 ;; references alist) from an `element-block' or `src-block' type
4559 ;; element.
4560 ;;
4561 ;; `org-export-format-code' applies a formatting function to each line
4562 ;; of code, providing relative line number and code reference when
4563 ;; appropriate. Since it doesn't access the original element from
4564 ;; which the source code is coming, it expects from the code calling
4565 ;; it to know if lines should be numbered and if code references
4566 ;; should appear.
4567 ;;
4568 ;; Eventually, `org-export-format-code-default' is a higher-level
4569 ;; function (it makes use of the two previous functions) which handles
4570 ;; line numbering and code references inclusion, and returns source
4571 ;; code in a format suitable for plain text or verbatim output.
4574 "Return count of lines of code before ELEMENT.
4576 ELEMENT is an example-block or src-block element. INFO is the
4577 plist used as a communication channel.
4579 Count includes every line of code in example-block or src-block
4581 ELEMENT doesn't allow line numbering."
4588 ;; ELEMENT is reached: Quit loop and return locs.
4590 ;; Only count lines from src-block and example-block
4591 ;; elements with a "+n" or "-n" switch.
4596 ;; Accumulate locs or reset them.
4604 "Clean source code and extract references out of it.
4606 ELEMENT has either a `src-block' an `example-block' type.
4608 Return a cons cell whose CAR is the source code, cleaned from any
4609 reference, protective commas and spurious indentation, and CDR is
4610 an alist between relative line number (integer) and name of code
4611 reference on that line (string)."
4614 ;; Get code and clean it. Remove blank lines at its
4615 ;; beginning and end.
4622 value
4624 ;; Build a regexp matching a loc with a reference.
4626 ;; Return value.
4628 ;; Code with references removed.
4634 ;; Ref line: remove ref, and signal its position in REFS.
4638 ;; Reference alist.
4639 refs)))
4642 "Format CODE by applying FUN line-wise and return it.
4644 CODE is a string representing the code to format. FUN is
4645 a function. It must accept three arguments: a line of
4646 code (string), the current line number (integer) or nil and the
4647 reference associated to the current line (string) or nil.
4649 Optional argument NUM-LINES can be an integer representing the
4650 number of code lines accumulated until the current code. Line
4651 numbers passed to FUN will take it into account. If it is nil,
4652 FUN's second argument will always be nil. This number can be
4653 obtained with `org-export-get-loc' function.
4655 Optional argument REF-ALIST can be an alist between relative line
4656 number (i.e. ignoring NUM-LINES) and the name of the code
4657 reference on it. If it is nil, FUN's third argument will always
4658 be nil. It can be obtained through the use of
4659 `org-export-unravel-code' function."
4671 "Return source code from ELEMENT, formatted in a standard way.
4673 ELEMENT is either a `src-block' or `example-block' element. INFO
4674 is a plist used as a communication channel.
4676 This function takes care of line numbering and code references
4677 inclusion. Line numbers, when applicable, appear at the
4678 beginning of the line, separated from the code by two white
4679 spaces. Code references, on the other hand, appear flushed to
4680 the right, separated by six white spaces from the widest line of
4681 code."
4682 ;; Extract code and references.
4689 ;; Handle line numbering.
4696 ;; Prepare references display, if required. Any reference
4697 ;; should start six columns after the widest line of code,
4698 ;; wrapped with parenthesis.
4703 code
4707 number-str
4708 loc
4714 num-start refs)))))
4717 ;;;; For Tables
4718 ;;
4719 ;; `org-export-table-has-special-column-p' and and
4720 ;; `org-export-table-row-is-special-p' are predicates used to look for
4721 ;; meta-information about the table structure.
4722 ;;
4723 ;; `org-table-has-header-p' tells when the rows before the first rule
4724 ;; should be considered as table's header.
4725 ;;
4726 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4727 ;; and `org-export-table-cell-borders' extract information from
4728 ;; a table-cell element.
4729 ;;
4730 ;; `org-export-table-dimensions' gives the number on rows and columns
4731 ;; in the table, ignoring horizontal rules and special columns.
4732 ;; `org-export-table-cell-address', given a table-cell object, returns
4733 ;; the absolute address of a cell. On the other hand,
4734 ;; `org-export-get-table-cell-at' does the contrary.
4735 ;;
4736 ;; `org-export-table-cell-starts-colgroup-p',
4737 ;; `org-export-table-cell-ends-colgroup-p',
4738 ;; `org-export-table-row-starts-rowgroup-p',
4739 ;; `org-export-table-row-ends-rowgroup-p',
4740 ;; `org-export-table-row-starts-header-p',
4741 ;; `org-export-table-row-ends-header-p' and
4742 ;; `org-export-table-row-in-header-p' indicate position of current row
4743 ;; or cell within the table.
4746 "Non-nil when TABLE has a special column.
4747 All special columns will be ignored during export."
4748 ;; The table has a special column when every first cell of every row
4749 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4750 ;; "*" "_" and "^". Though, do not consider a first column
4751 ;; containing only empty cells as special.
4766 "Non-nil when TABLE has a header.
4768 INFO is a plist used as a communication channel.
4770 A table has a header when it contains at least two row groups."
4774 table)))
4790 nil)))
4792 cache)))))
4795 "Non-nil if TABLE-ROW is considered special.
4796 All special rows will be ignored during export."
4800 ;; A row is special either when...
4802 ;; ... it starts with a field only containing "/",
4804 ;; ... the table contains a special column and the row start
4805 ;; with a marking character among, "^", "_", "$" or "!",
4809 ;; ... it contains only alignment cookies and empty cells.
4814 ;; Since VALUE is a secondary string, the following
4815 ;; checks avoid expanding it with `org-export-data'.
4826 "Return TABLE-ROW's group number, as an integer.
4828 INFO is a plist used as the communication channel.
4830 Return value is the group number, as an integer, or nil for
4831 special rows and rows separators. First group is also table's
4832 header."
4837 table)))
4840 ;; First time a row is queried, populate cache with all the
4841 ;; rows from the table.
4849 info))
4853 "Return TABLE-CELL contents width.
4855 INFO is a plist used as the communication channel.
4857 Return value is the width given by the last width cookie in the
4858 same column as TABLE-CELL, or nil."
4867 table)))
4876 ;; In a special row, try to find a width cookie at COLUMN.
4880 ;; The following checks avoid expanding unnecessarily
4881 ;; the cell with `org-export-data'.
4891 "Return TABLE-CELL contents alignment.
4893 INFO is a plist used as the communication channel.
4895 Return alignment as specified by the last alignment cookie in the
4896 same column as TABLE-CELL. If no such cookie is found, a default
4897 alignment value will be deduced from fraction of numbers in the
4898 column (see `org-table-number-fraction' for more information).
4899 Possible values are `left', `right' and `center'."
4900 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4910 table)))
4916 cookie-align
4917 previous-cell-number-p)
4920 ;; In a special row, try to find an alignment cookie at
4921 ;; COLUMN.
4925 ;; Since VALUE is a secondary string, the following
4926 ;; checks avoid useless expansion through
4927 ;; `org-export-data'.
4935 ;; Ignore table rules.
4937 ;; In a standard row, check if cell's contents are
4938 ;; expressing some kind of number. Increase NUMBER-CELLS
4939 ;; accordingly. Though, don't bother if an alignment
4940 ;; cookie has already defined cell's alignment.
4945 info)))
4947 ;; Treat an empty cell as a number if it follows
4948 ;; a number.
4954 ;; Return value. Alignment specified by cookies has
4955 ;; precedence over alignment deduced from cell's contents.
4957 column
4962 org-table-number-fraction)
4967 "Return TABLE-CELL borders.
4969 INFO is a plist used as a communication channel.
4971 Return value is a list of symbols, or nil. Possible values are:
4972 `top', `bottom', `above', `below', `left' and `right'. Note:
4973 `top' (resp. `bottom') only happen for a cell in the first
4974 row (resp. last row) of the table, ignoring table rules, if any.
4976 Returned borders ignore special rows."
4979 borders)
4980 ;; Top/above border? TABLE-CELL has a border above when a rule
4981 ;; used to demarcate row groups can be found above. Hence,
4982 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4983 ;; another regular row has to be found above that rule.
4986 ;; Look at every row before the current one.
4993 ;; No rule above, or rule found starts the table (ignoring any
4994 ;; special row): TABLE-CELL is at the top of the table.
4997 ;; Bottom/below border? TABLE-CELL has a border below when next
4998 ;; non-regular row below is a rule.
5001 ;; Look at every row after the current one.
5008 ;; No rule below, or rule found ends the table (modulo some
5009 ;; special row): TABLE-CELL is at the bottom of the table.
5012 ;; Right/left borders? They can only be specified by column
5013 ;; groups. Column groups are defined in a row starting with "/".
5014 ;; Also a column groups row only contains "<", "<>", ">" or blank
5015 ;; cells.
5019 ;; Table rows are read in reverse order so last column groups
5020 ;; row has precedence over any previous one.
5033 ;; There's a left border when previous cell, if
5034 ;; any, ends a group, or current one starts one.
5040 ;; There's a right border when next cell, if any,
5041 ;; starts a group, or current one ends one.
5048 ;; Return value.
5049 borders))
5052 "Non-nil when TABLE-CELL is at the beginning of a column group.
5053 INFO is a plist used as a communication channel."
5054 ;; A cell starts a column group either when it is at the beginning
5055 ;; of a row (or after the special column, if any) or when it has
5056 ;; a left border.
5059 table-cell)
5063 "Non-nil when TABLE-CELL is at the end of a column group.
5064 INFO is a plist used as a communication channel."
5065 ;; A cell ends a column group either when it is at the end of a row
5066 ;; or when it has a right border.
5069 table-cell)
5073 "Non-nil when TABLE-ROW is at the beginning of a row group.
5074 INFO is a plist used as a communication channel."
5082 "Non-nil when TABLE-ROW is at the end of a row group.
5083 INFO is a plist used as a communication channel."
5091 "Non-nil when TABLE-ROW is located within table's header.
5092 INFO is a plist used as a communication channel. Always return
5093 nil for special rows and rows separators."
5099 "Non-nil when TABLE-ROW is the first table header's row.
5100 INFO is a plist used as a communication channel."
5105 "Non-nil when TABLE-ROW is the last table header's row.
5106 INFO is a plist used as a communication channel."
5111 "Return TABLE-ROW number.
5112 INFO is a plist used as a communication channel. Return value is
5113 zero-indexed and ignores separators. The function returns nil
5114 for special rows and separators."
5119 table)))
5122 ;; First time a row is queried, populate cache with all the
5123 ;; rows from the table.
5129 info))
5133 "Return TABLE dimensions.
5135 INFO is a plist used as a communication channel.
5137 Return value is a CONS like (ROWS . COLUMNS) where
5138 ROWS (resp. COLUMNS) is the number of exportable
5139 rows (resp. columns)."
5141 ;; Set number of rows, and extract first one.
5147 ;; Set number of columns.
5149 ;; Return value.
5153 "Return address of a regular TABLE-CELL object.
5155 TABLE-CELL is the cell considered. INFO is a plist used as
5156 a communication channel.
5158 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5159 zero-based index. Only exportable cells are considered. The
5160 function returns nil for other cells."
5172 "Return regular table-cell object at ADDRESS in TABLE.
5174 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5175 zero-based index. TABLE is a table type element. INFO is
5176 a plist used as a communication channel.
5178 If no table-cell, among exportable cells, is found at ADDRESS,
5179 return nil."
5182 ;; Row at (car address) or nil.
5190 'table-cell
5197 ;;;; For Tables Of Contents
5198 ;;
5199 ;; `org-export-collect-headlines' builds a list of all exportable
5200 ;; headline elements, maybe limited to a certain depth. One can then
5201 ;; easily parse it and transcode it.
5202 ;;
5203 ;; Building lists of tables, figures or listings is quite similar.
5204 ;; Once the generic function `org-export-collect-elements' is defined,
5205 ;; `org-export-collect-tables', `org-export-collect-figures' and
5206 ;; `org-export-collect-listings' can be derived from it.
5209 "Collect headlines in order to build a table of contents.
5211 INFO is a plist used as a communication channel.
5213 When optional argument N is an integer, it specifies the depth of
5214 the table of contents. Otherwise, it is set to the value of the
5215 last headline level. See `org-export-headline-levels' for more
5216 information.
5218 Optional argument SCOPE, when non-nil, is an element. If it is
5219 a headline, only children of SCOPE are collected. Otherwise,
5220 collect children of the headline containing provided element. If
5221 there is no such headline, collect all headlines. In any case,
5222 argument N becomes relative to the level of that headline.
5224 Return a list of all exportable headlines as parsed elements.
5225 Footnote sections are ignored."
5234 limit))))
5240 info)))
5243 "Collect referenceable elements of a determined type.
5245 TYPE can be a symbol or a list of symbols specifying element
5246 types to search. Only elements with a caption are collected.
5248 INFO is a plist used as a communication channel.
5250 When non-nil, optional argument PREDICATE is a function accepting
5251 one argument, an element of type TYPE. It returns a non-nil
5252 value when that element should be collected.
5254 Return a list of all elements found, in order of appearance."
5259 element))
5260 info))
5263 "Build a list of tables.
5264 INFO is a plist used as a communication channel.
5266 Return a list of table elements with a caption."
5270 "Build a list of figures.
5272 INFO is a plist used as a communication channel. PREDICATE is
5273 a function which accepts one argument: a paragraph element and
5274 whose return value is non-nil when that element should be
5275 collected.
5277 A figure is a paragraph type element, with a caption, verifying
5279 a vague concept that may depend on back-end.
5281 Return a list of elements recognized as figures."
5285 "Build a list of src blocks.
5287 INFO is a plist used as a communication channel.
5289 Return a list of src-block elements with a caption."
5293 ;;;; Smart Quotes
5294 ;;
5295 ;; The main function for the smart quotes sub-system is
5296 ;; `org-export-activate-smart-quotes', which replaces every quote in
5297 ;; a given string from the parse tree with its "smart" counterpart.
5298 ;;
5299 ;; Dictionary for smart quotes is stored in
5300 ;; `org-export-smart-quotes-alist'.
5316 ;; one may use: »...«, "...", ›...‹, or '...'.
5317 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5318 ;; LaTeX quotes require Babel!
5378 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5389 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5400 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5411 ;; 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
5412 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5423 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5429 "Smart quotes translations.
5431 Alist whose CAR is a language string and CDR is an alist with
5432 quote type as key and a plist associating various encodings to
5433 their translation as value.
5435 A quote type can be any symbol among `primary-opening',
5436 `primary-closing', `secondary-opening', `secondary-closing' and
5437 `apostrophe'.
5439 Valid encodings include `:utf-8', `:html', `:latex' and
5440 `:texinfo'.
5445 "Return smart quote status at the beginning of string S.
5446 INFO is the current export state, as a plist."
5451 table)))
5459 'plain-text
5468 ;; Not already in a level 1 quote: this is an
5469 ;; apostrophe.
5471 ;; Extract previous char and next char. As
5472 ;; a special case, they can also be set to `blank',
5473 ;; `no-blank' or nil. Then determine if current
5474 ;; match is allowed as an opening quote or a closing
5475 ;; quote.
5480 text info)))
5497 previous)
5508 next)
5515 current-status)
5519 info nil org-element-recursive-objects)
5526 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5527 `:utf-8'. INFO is a plist used as a communication channel.
5529 The function has to retrieve information about string
5530 surroundings in parse tree. It can only happen with an
5531 unmodified string. Thus, if S has already been through another
5532 process, a non-nil ORIGINAL optional argument will provide that
5533 original string.
5535 Return the new string."
5544 org-export-smart-quotes-alist))))
5545 encoding)
5546 match))
5547 s nil t)))
5549 ;;;; Topology
5550 ;;
5551 ;; Here are various functions to retrieve information about the
5552 ;; neighborhood of a given element or object. Neighbors of interest
5553 ;; are direct parent (`org-export-get-parent'), parent headline
5554 ;; (`org-export-get-parent-headline'), first element containing an
5555 ;; object, (`org-export-get-parent-element'), parent table
5556 ;; (`org-export-get-parent-table'), previous element or object
5557 ;; (`org-export-get-previous-element') and next element or object
5558 ;; (`org-export-get-next-element').
5560 ;; defsubst org-export-get-parent must be defined before first use
5563 "Return BLOB parent headline or nil.
5564 BLOB is the element or object being considered."
5568 "Return first element containing OBJECT or nil.
5569 OBJECT is the object to consider."
5573 "Return OBJECT parent table or nil.
5574 OBJECT is either a `table-cell' or `table-element' type object."
5578 "Return previous element or object.
5580 BLOB is an element or object. INFO is a plist used as
5581 a communication channel. Return previous exportable element or
5582 object, a string, or nil.
5584 When optional argument N is a positive integer, return a list
5585 containing up to N siblings before BLOB, from farthest to
5586 closest. With any other non-nil value, return a list containing
5587 all of them."
5593 prev)
5603 "Return next element or object.
5605 BLOB is an element or object. INFO is a plist used as
5606 a communication channel. Return next exportable element or
5607 object, a string, or nil.
5609 When optional argument N is a positive integer, return a list
5610 containing up to N siblings after BLOB, from closest to farthest.
5611 With any other non-nil value, return a list containing all of
5612 them."
5619 next)
5629 ;;;; Translation
5630 ;;
5631 ;; `org-export-translate' translates a string according to the language
5632 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5633 ;; the dictionary used for the translation.
5667 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5678 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5684 ("ru" :html "(Продолжение следует)"
5766 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5790 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5796 ("ru" :html "Список распечаток"
5812 ("ru" :html "Список таблиц"
5937 ("ru" :html "Неизвестная ссылка"
5940 "Dictionary for export engine.
5942 Alist whose car is the string to translate and cdr is an alist
5943 whose car is the language string and cdr is a plist whose
5944 properties are possible charsets and values translated terms.
5946 It is used as a database for `org-export-translate'. Since this
5947 function returns the string as-is if no translation was found,
5948 the variable only needs to record values different from the
5952 "Translate string S according to language specification.
5954 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5955 and `:utf-8'. INFO is a plist used as a communication channel.
5957 Translation depends on `:language' property. Return the
5958 translated string. If no translation is found, try to fall back
5959 to `:default' encoding. If it fails, return S."
5965 s)))
5968 \f
5969 ;;; Asynchronous Export
5970 ;;
5971 ;; `org-export-async-start' is the entry point for asynchronous
5972 ;; export. It recreates current buffer (including visibility,
5973 ;; narrowing and visited file) in an external Emacs process, and
5974 ;; evaluates a command there. It then applies a function on the
5975 ;; returned results in the current process.
5976 ;;
5977 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5978 ;; allow exporting to a buffer or a file, asynchronously or not.
5979 ;;
5980 ;; `org-export-output-file-name' is an auxiliary function meant to be
5981 ;; used with `org-export-to-file'. With a given extension, it tries
5982 ;; to provide a canonical file name to write export output to.
5983 ;;
5984 ;; Asynchronously generated results are never displayed directly.
5985 ;; Instead, they are stored in `org-export-stack-contents'. They can
5986 ;; then be retrieved by calling `org-export-stack'.
5987 ;;
5988 ;; Export Stack is viewed through a dedicated major mode
5989 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5990 ;;`org-export-stack-delete', `org-export-stack-view' and
5991 ;;`org-export-stack-clear'.
5992 ;;
5993 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5994 ;; It should be used whenever `org-export-async-start' is called.
5997 "Call function FUN on the results returned by BODY evaluation.
5999 FUN is an anonymous function of one argument. BODY evaluation
6000 happens in an asynchronous process, from a buffer which is an
6001 exact copy of the current one.
6003 Use `org-export-add-to-stack' in FUN in order to register results
6004 in the stack.
6006 This is a low level function. See also `org-export-to-buffer'
6007 and `org-export-to-file' for more specialized functions."
6010 ;; Write the full sexp evaluating BODY in a copy of the current
6011 ;; buffer to a temporary file, as it may be too long for program
6012 ;; args in `start-process'.
6019 ;; Null characters (from variable values) are inserted
6020 ;; within the file. As a consequence, coding system for
6021 ;; buffer contents will not be recognized properly. So,
6022 ;; we make sure it is the same as the one used to display
6023 ;; the original buffer.
6025 ,coding
6028 ;; Ignore `kill-emacs-hook' and code evaluation
6029 ;; queries from Babel as we need a truly
6030 ;; non-interactive process.
6032 org-babel-confirm-evaluate-answer-no t)
6033 ;; Initialize export framework.
6035 ;; Re-create current buffer there.
6038 ;; Sexp to evaluate in the buffer.
6040 ;; Start external process.
6043 (,process
6045 #'start-process
6048 ,proc-buffer
6055 ;; Register running process in stack.
6057 ;; Set-up sentinel in order to catch results.
6060 ,process
6082 ;;;###autoload
6085 &optional async subtreep visible-only body-only ext-plist
6086 post-process)
6087 "Call `org-export-as' with output to a specified buffer.
6089 BACKEND is either an export back-end, as returned by, e.g.,
6090 `org-export-create-backend', or a symbol referring to
6091 a registered back-end.
6093 BUFFER is the name of the output buffer. If it already exists,
6094 it will be erased first, otherwise, it will be created.
6096 A non-nil optional argument ASYNC means the process should happen
6097 asynchronously. The resulting buffer should then be accessible
6098 through the `org-export-stack' interface. When ASYNC is nil, the
6099 buffer is displayed if `org-export-show-temporary-export-buffer'
6100 is non-nil.
6102 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6103 EXT-PLIST are similar to those used in `org-export-as', which
6104 see.
6106 Optional argument POST-PROCESS is a function which should accept
6107 no argument. It is always called within the current process,
6108 from BUFFER, with point at its beginning. Export back-ends can
6109 use it to set a major mode there, e.g,
6111 (defun org-latex-export-as-latex
6112 (&optional async subtreep visible-only body-only ext-plist)
6113 (interactive)
6115 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
6117 This function returns BUFFER."
6145 buffer)))
6147 ;;;###autoload
6150 post-process)
6151 "Call `org-export-as' with output to a specified file.
6153 BACKEND is either an export back-end, as returned by, e.g.,
6154 `org-export-create-backend', or a symbol referring to
6155 a registered back-end. FILE is the name of the output file, as
6156 a string.
6158 A non-nil optional argument ASYNC means the process should happen
6159 asynchronously. The resulting buffer will then be accessible
6160 through the `org-export-stack' interface.
6162 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6163 EXT-PLIST are similar to those used in `org-export-as', which
6164 see.
6166 Optional argument POST-PROCESS is called with FILE as its
6167 argument and happens asynchronously when ASYNC is non-nil. It
6168 has to return a file name, or nil. Export back-ends can use this
6169 to send the output file through additional processing, e.g,
6171 (defun org-latex-export-to-latex
6172 (&optional async subtreep visible-only body-only ext-plist)
6173 (interactive)
6176 async subtreep visible-only body-only ext-plist
6177 (lambda (file) (org-latex-compile file)))
6179 The function returns either a file name returned by POST-PROCESS,
6180 or FILE."
6199 backend subtreep visible-only body-only ext-plist)))
6206 ;; Get proper return value.
6208 file))))))
6211 "Return output file's name according to buffer specifications.
6213 EXTENSION is a string representing the output file extension,
6214 with the leading dot.
6216 With a non-nil optional argument SUBTREEP, try to determine
6218 of subtree at point.
6220 When optional argument PUB-DIR is set, use it as the publishing
6221 directory.
6223 Return file name as a string."
6229 ;; Check EXPORT_FILE_NAME subtree property.
6231 ;; Check #+EXPORT_FILE_NAME keyword.
6241 ;; Extract from buffer's associated file, if any.
6243 ;; Can't determine file name on our own: ask user.
6245 "Output file: " pub-dir nil nil nil
6247 extension))
6249 ;; Build file name. Enforce EXTENSION over whatever user
6250 ;; may have come up with. PUB-DIR, if defined, always has
6251 ;; precedence over any provided path.
6257 ;; If writing to OUTPUT-FILE would overwrite original file, append
6258 ;; EXTENSION another time to final name.
6261 output-file)))
6264 "Add a new result to export stack if not present already.
6266 SOURCE is a buffer or a file name containing export results.
6267 BACKEND is a symbol representing export back-end used to generate
6268 it.
6270 Entries already pointing to SOURCE and unavailable entries are
6271 removed beforehand. Return the new stack."
6277 "Menu for asynchronous export results and running processes."
6287 "Remove all entries from export stack."
6292 "Refresh the export stack."
6297 "Remove export results at point from stack.
6298 If optional argument SOURCE is non-nil, remove it instead."
6303 org-export-stack-contents))))
6306 "View export results at point in stack.
6307 With an optional prefix argument IN-EMACS, force viewing files
6308 within Emacs."
6322 (define-key km "\C-p" 'previous-line)
6323 (define-key km "\C-?" 'previous-line)
6324 (define-key km [up] 'previous-line)
6325 (define-key km "C" 'org-export-stack-clear)
6326 (define-key km "v" 'org-export-stack-view)
6327 (define-key km (kbd "RET") 'org-export-stack-view)
6328 (define-key km "d" 'org-export-stack-remove)
6329 km)
6330 "Keymap for Org Export Stack.")
6332 (define-derived-mode org-export-stack-mode tabulated-list-mode "Org-Stack"
6333 "Mode for displaying asynchronous export stack.
6336 stack.
6338 In an Org Export Stack buffer, use \
6342 stack completely.
6344 Removing entries in a stack buffer does not affect files
6345 or buffers, only display.
6348 (setq tabulated-list-format
6349 (vector (list "#" 4 #'org-export--stack-num-predicate)
6350 (list "Back-End" 12 t)
6351 (list "Age" 6 nil)
6352 (list "Source" 0 nil)))
6353 (setq tabulated-list-sort-key (cons "#" nil))
6354 (setq tabulated-list-entries #'org-export--stack-generate)
6355 (add-hook 'tabulated-list-revert-hook #'org-export--stack-generate nil t)
6356 (add-hook 'post-command-hook #'org-export-stack-refresh nil t)
6357 (tabulated-list-init-header))
6359 (defun org-export--stack-generate ()
6360 "Generate the asynchronous export stack for display.
6361 Unavailable sources are removed from the list. Return a list
6362 appropriate for `tabulated-list-print'."
6363 ;; Clear stack from exited processes, dead buffers or non-existent
6364 ;; files.
6365 (setq org-export-stack-contents
6366 (cl-remove-if-not
6367 (lambda (el)
6368 (if (processp (nth 2 el))
6369 (buffer-live-p (process-buffer (nth 2 el)))
6370 (let ((source (car el)))
6371 (if (bufferp source) (buffer-live-p source)
6372 (file-exists-p source)))))
6373 org-export-stack-contents))
6374 ;; Update `tabulated-list-entries'.
6375 (let ((counter 0))
6376 (mapcar
6377 (lambda (entry)
6378 (let ((source (car entry)))
6379 (list source
6380 (vector
6381 ;; Counter.
6382 (number-to-string (cl-incf counter))
6383 ;; Back-End.
6384 (if (nth 1 entry) (symbol-name (nth 1 entry)) "")
6385 ;; Age.
6386 (let ((info (nth 2 entry)))
6387 (if (processp info) (symbol-name (process-status info))
6388 (format-seconds "%h:%.2m" (float-time (time-since info)))))
6389 ;; Source.
6390 (if (stringp source) source (buffer-name source))))))
6391 org-export-stack-contents)))
6393 (defun org-export--stack-num-predicate (a b)
6394 (< (string-to-number (aref (nth 1 a) 0))
6395 (string-to-number (aref (nth 1 b) 0))))
6397 (defun org-export--stack-source-at-point ()
6398 "Return source from export results at point in stack."
6399 (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
6400 (if (not source) (error "Source unavailable, please refresh buffer")
6401 (let ((source-name (if (stringp source) source (buffer-name source))))
6402 (if (save-excursion
6403 (beginning-of-line)
6404 (looking-at-p (concat ".* +" (regexp-quote source-name) "$")))
6405 source
6406 ;; SOURCE is not consistent with current line. The stack
6407 ;; view is outdated.
6408 (error (substitute-command-keys
6410 to refresh buffer")))))))
6413 \f
6414 ;;; The Dispatcher
6415 ;;
6416 ;; `org-export-dispatch' is the standard interactive way to start an
6417 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6418 ;; for its interface, which, in turn, delegates response to key
6419 ;; pressed to `org-export--dispatch-action'.
6421 ;;;###autoload
6422 (defun org-export-dispatch (&optional arg)
6423 "Export dispatcher for Org mode.
6425 It provides an access to common export related tasks in a buffer.
6426 Its interface comes in two flavors: standard and expert.
6428 While both share the same set of bindings, only the former
6429 displays the valid keys associations in a dedicated buffer.
6430 Scrolling (resp. line-wise motion) in this buffer is done with
6431 SPC and DEL (resp. C-n and C-p) keys.
6433 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6434 flavor or the other.
6437 same
6438 set of options used back then, on the current buffer.
6441 asynchronous export stack."
6442 (interactive "P")
6443 (let* ((input
6444 (cond ((equal arg '(16)) '(stack))
6445 ((and arg org-export-dispatch-last-action))
6446 (t (save-window-excursion
6447 (unwind-protect
6448 (progn
6449 ;; Remember where we are
6450 (move-marker org-export-dispatch-last-position
6451 (point)
6452 (org-base-buffer (current-buffer)))
6453 ;; Get and store an export command
6454 (setq org-export-dispatch-last-action
6455 (org-export--dispatch-ui
6456 (list org-export-initial-scope
6457 (and org-export-in-background 'async))
6458 nil
6459 org-export-dispatch-use-expert-ui)))
6460 (and (get-buffer "*Org Export Dispatcher*")
6461 (kill-buffer "*Org Export Dispatcher*")))))))
6462 (action (car input))
6463 (optns (cdr input)))
6464 (unless (memq 'subtree optns)
6465 (move-marker org-export-dispatch-last-position nil))
6466 (cl-case action
6467 ;; First handle special hard-coded actions.
6468 (template (org-export-insert-default-template nil optns))
6469 (stack (org-export-stack))
6470 (publish-current-file
6471 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6472 (publish-current-project
6473 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6474 (publish-choose-project
6475 (org-publish (assoc (completing-read
6476 "Publish project: "
6477 org-publish-project-alist nil t)
6478 org-publish-project-alist)
6479 (memq 'force optns)
6480 (memq 'async optns)))
6481 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6482 (otherwise
6483 (save-excursion
6484 (when arg
6485 ;; Repeating command, maybe move cursor to restore subtree
6486 ;; context.
6487 (if (eq (marker-buffer org-export-dispatch-last-position)
6488 (org-base-buffer (current-buffer)))
6489 (goto-char org-export-dispatch-last-position)
6490 ;; We are in a different buffer, forget position.
6491 (move-marker org-export-dispatch-last-position nil)))
6492 (funcall action
6493 ;; Return a symbol instead of a list to ease
6494 ;; asynchronous export macro use.
6495 (and (memq 'async optns) t)
6496 (and (memq 'subtree optns) t)
6497 (and (memq 'visible optns) t)
6498 (and (memq 'body optns) t)))))))
6500 (defun org-export--dispatch-ui (options first-key expertp)
6501 "Handle interface for `org-export-dispatch'.
6503 OPTIONS is a list containing current interactive options set for
6504 export. It can contain any of the following symbols:
6505 `body' toggles a body-only export
6506 `subtree' restricts export to current subtree
6507 `visible' restricts export to visible part of buffer.
6508 `force' force publishing files.
6509 `async' use asynchronous export process
6511 FIRST-KEY is the key pressed to select the first level menu. It
6512 is nil when this menu hasn't been selected yet.
6514 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6515 buffer is provided, but indications about currently active
6516 options are given in the prompt. Moreover, [?] allows switching
6517 back to standard interface."
6518 (let* ((fontify-key
6519 (lambda (key &optional access-key)
6520 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6521 ;; non-nil is the required first-level key to activate
6522 ;; KEY. When its value is t, activate KEY independently
6523 ;; on the first key, if any. A nil value means KEY will
6524 ;; only be activated at first level.
6525 (if (or (eq access-key t) (eq access-key first-key))
6526 (propertize key 'face 'org-warning)
6527 key)))
6528 (fontify-value
6529 (lambda (value)
6530 ;; Fontify VALUE string.
6531 (propertize value 'face 'font-lock-variable-name-face)))
6532 ;; Prepare menu entries by extracting them from registered
6533 ;; back-ends and sorting them by access key and by ordinal,
6534 ;; if any.
6535 (entries
6536 (sort (sort (delq nil
6537 (mapcar #'org-export-backend-menu
6538 org-export-registered-backends))
6539 (lambda (a b)
6540 (let ((key-a (nth 1 a))
6541 (key-b (nth 1 b)))
6542 (cond ((and (numberp key-a) (numberp key-b))
6543 (< key-a key-b))
6544 ((numberp key-b) t)))))
6545 'car-less-than-car))
6546 ;; Compute a list of allowed keys based on the first key
6547 ;; pressed, if any. Some keys
6548 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6549 ;; available.
6550 (allowed-keys
6551 (nconc (list 2 22 19 6 1)
6552 (if (not first-key) (org-uniquify (mapcar 'car entries))
6553 (let (sub-menu)
6554 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6555 (when (eq (car entry) first-key)
6556 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6557 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6558 ((not first-key) (list ?P)))
6559 (list ?& ?#)
6560 (when expertp (list ??))
6561 (list ?q)))
6562 ;; Build the help menu for standard UI.
6563 (help
6564 (unless expertp
6565 (concat
6566 ;; Options are hard-coded.
6567 (format "[%s] Body only: %s [%s] Visible only: %s
6568 \[%s] Export scope: %s [%s] Force publishing: %s
6570 (funcall fontify-key "C-b" t)
6571 (funcall fontify-value
6572 (if (memq 'body options) "On " "Off"))
6573 (funcall fontify-key "C-v" t)
6574 (funcall fontify-value
6575 (if (memq 'visible options) "On " "Off"))
6576 (funcall fontify-key "C-s" t)
6577 (funcall fontify-value
6578 (if (memq 'subtree options) "Subtree" "Buffer "))
6579 (funcall fontify-key "C-f" t)
6580 (funcall fontify-value
6581 (if (memq 'force options) "On " "Off"))
6582 (funcall fontify-key "C-a" t)
6583 (funcall fontify-value
6584 (if (memq 'async options) "On " "Off")))
6585 ;; Display registered back-end entries. When a key
6586 ;; appears for the second time, do not create another
6587 ;; entry, but append its sub-menu to existing menu.
6588 (let (last-key)
6589 (mapconcat
6590 (lambda (entry)
6591 (let ((top-key (car entry)))
6592 (concat
6593 (unless (eq top-key last-key)
6594 (setq last-key top-key)
6596 (funcall fontify-key (char-to-string top-key))
6597 (nth 1 entry)))
6598 (let ((sub-menu (nth 2 entry)))
6599 (unless (functionp sub-menu)
6600 ;; Split sub-menu into two columns.
6601 (let ((index -1))
6602 (concat
6603 (mapconcat
6604 (lambda (sub-entry)
6605 (cl-incf index)
6606 (format
6607 (if (zerop (mod index 2)) " [%s] %-26s"
6609 (funcall fontify-key
6610 (char-to-string (car sub-entry))
6611 top-key)
6612 (nth 1 sub-entry)))
6613 sub-menu "")
6615 entries ""))
6616 ;; Publishing menu is hard-coded.
6618 [%s] Current file [%s] Current project
6620 (funcall fontify-key "P")
6621 (funcall fontify-key "f" ?P)
6622 (funcall fontify-key "p" ?P)
6623 (funcall fontify-key "x" ?P)
6624 (funcall fontify-key "a" ?P))
6626 (funcall fontify-key "&" t)
6627 (funcall fontify-key "#" t))
6628 (format "[%s] %s"
6629 (funcall fontify-key "q" t)
6630 (if first-key "Main menu" "Exit")))))
6631 ;; Build prompts for both standard and expert UI.
6632 (standard-prompt (unless expertp "Export command: "))
6633 (expert-prompt
6634 (when expertp
6635 (format
6636 "Export command (C-%s%s%s%s%s) [%s]: "
6637 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6638 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6639 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6640 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6641 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6642 (mapconcat (lambda (k)
6643 ;; Strip control characters.
6644 (unless (< k 27) (char-to-string k)))
6645 allowed-keys "")))))
6646 ;; With expert UI, just read key with a fancy prompt. In standard
6647 ;; UI, display an intrusive help buffer.
6648 (if expertp
6649 (org-export--dispatch-action
6650 expert-prompt allowed-keys entries options first-key expertp)
6651 ;; At first call, create frame layout in order to display menu.
6652 (unless (get-buffer "*Org Export Dispatcher*")
6653 (delete-other-windows)
6654 (org-switch-to-buffer-other-window
6655 (get-buffer-create "*Org Export Dispatcher*"))
6656 (setq cursor-type nil
6657 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6658 ;; Make sure that invisible cursor will not highlight square
6659 ;; brackets.
6660 (set-syntax-table (copy-syntax-table))
6661 (modify-syntax-entry ?\[ "w"))
6662 ;; At this point, the buffer containing the menu exists and is
6663 ;; visible in the current window. So, refresh it.
6664 (with-current-buffer "*Org Export Dispatcher*"
6665 ;; Refresh help. Maintain display continuity by re-visiting
6666 ;; previous window position.
6667 (let ((pos (window-start)))
6668 (erase-buffer)
6669 (insert help)
6670 (set-window-start nil pos)))
6671 (org-fit-window-to-buffer)
6672 (org-export--dispatch-action
6673 standard-prompt allowed-keys entries options first-key expertp))))
6675 (defun org-export--dispatch-action
6676 (prompt allowed-keys entries options first-key expertp)
6677 "Read a character from command input and act accordingly.
6679 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6680 a list of characters available at a given step in the process.
6681 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6682 EXPERTP are the same as defined in `org-export--dispatch-ui',
6683 which see.
6685 Toggle export options when required. Otherwise, return value is
6686 a list with action as CAR and a list of interactive export
6687 options as CDR."
6688 (let (key)
6689 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6690 ;; C-p, SPC, DEL).
6691 (while (and (setq key (read-char-exclusive prompt))
6692 (not expertp)
6693 (memq key '(14 16 ?\s ?\d)))
6694 (cl-case key
6695 (14 (if (not (pos-visible-in-window-p (point-max)))
6696 (ignore-errors (scroll-up 1))
6697 (message "End of buffer")
6698 (sit-for 1)))
6699 (16 (if (not (pos-visible-in-window-p (point-min)))
6700 (ignore-errors (scroll-down 1))
6701 (message "Beginning of buffer")
6702 (sit-for 1)))
6703 (?\s (if (not (pos-visible-in-window-p (point-max)))
6704 (scroll-up nil)
6705 (message "End of buffer")
6706 (sit-for 1)))
6707 (?\d (if (not (pos-visible-in-window-p (point-min)))
6708 (scroll-down nil)
6709 (message "Beginning of buffer")
6710 (sit-for 1)))))
6711 (cond
6712 ;; Ignore undefined associations.
6713 ((not (memq key allowed-keys))
6714 (ding)
6715 (unless expertp (message "Invalid key") (sit-for 1))
6716 (org-export--dispatch-ui options first-key expertp))
6717 ;; q key at first level aborts export. At second level, cancel
6718 ;; first key instead.
6719 ((eq key ?q) (if (not first-key) (error "Export aborted")
6720 (org-export--dispatch-ui options nil expertp)))
6721 ;; Help key: Switch back to standard interface if expert UI was
6722 ;; active.
6723 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6724 ;; Send request for template insertion along with export scope.
6725 ((eq key ?#) (cons 'template (memq 'subtree options)))
6726 ;; Switch to asynchronous export stack.
6727 ((eq key ?&) '(stack))
6728 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6729 ((memq key '(2 22 19 6 1))
6730 (org-export--dispatch-ui
6731 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6732 (6 'force) (1 'async))))
6733 (if (memq option options) (remq option options)
6734 (cons option options)))
6735 first-key expertp))
6736 ;; Action selected: Send key and options back to
6737 ;; `org-export-dispatch'.
6738 ((or first-key (functionp (nth 2 (assq key entries))))
6739 (cons (cond
6740 ((not first-key) (nth 2 (assq key entries)))
6741 ;; Publishing actions are hard-coded. Send a special
6742 ;; signal to `org-export-dispatch'.
6743 ((eq first-key ?P)
6744 (cl-case key
6745 (?f 'publish-current-file)
6746 (?p 'publish-current-project)
6747 (?x 'publish-choose-project)
6748 (?a 'publish-all)))
6749 ;; Return first action associated to FIRST-KEY + KEY
6750 ;; path. Indeed, derived backends can share the same
6751 ;; FIRST-KEY.
6752 (t (catch 'found
6753 (dolist (entry (member (assq first-key entries) entries))
6754 (let ((match (assq key (nth 2 entry))))
6755 (when match (throw 'found (nth 2 match))))))))
6756 options))
6757 ;; Otherwise, enter sub-menu.
6758 (t (org-export--dispatch-ui options key expertp)))))
6762 (provide 'ox)
6764 ;; Local variables:
6765 ;; generated-autoload-file: "org-loaddefs.el"
6766 ;; End:
6768 ;;; ox.el ends here