| blob | f35963e095b993e253bc6a08131e71cfcbe0a8ba |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2017 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
91 \f
92 ;;; Internal Variables
93 ;;
94 ;; Among internal variables, the most important is
95 ;; `org-export-options-alist'. This variable define the global export
96 ;; options, shared between every exporter, and how they are acquired.
142 "Alist between export properties and ways to set them.
144 The key of the alist is the property name, and the value is a list
145 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
147 KEYWORD is a string representing a buffer keyword, or nil. Each
148 property defined this way can also be set, during subtree
149 export, through a headline property named after the keyword
151 property).
152 OPTION is a string that could be found in an #+OPTIONS: line.
153 DEFAULT is the default value for the property.
154 BEHAVIOR determines how Org should handle multiple keywords for
155 the same property. It is a symbol among:
156 nil Keep old value and discard the new one.
157 t Replace old value with the new one.
158 `space' Concatenate the values, separating them with a space.
159 `newline' Concatenate the values, separating them with
160 a newline.
161 `split' Split values at white spaces, and cons them to the
162 previous list.
163 `parse' Parse value as a list of strings and Org objects,
164 which can then be transcoded with, e.g.,
165 `org-export-data'. It implies `space' behavior.
167 Values set through KEYWORD and OPTION have precedence over
168 DEFAULT.
170 All these properties should be back-end agnostic. Back-end
171 specific properties are set through `org-export-define-backend'.
175 "List of in-buffer keywords that require special treatment.
176 These keywords are not directly associated to a property. The
177 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
263 org-element--cache org-element--cache-objects org-element--cache-sync-keys
264 org-element--cache-sync-requests org-element--cache-sync-timer)
265 "List of variables not copied through upon buffer duplication.
266 Export process takes place on a copy of the original buffer.
267 When this copy is created, all Org related local variables not in
268 this list are copied to the new buffer. Variables with an
272 "Non-nil means asynchronous export process should leave data behind.
276 located in `temporary-file-directory'.
278 When non-nil, it will also set `debug-on-error' to a non-nil
282 "Record asynchronously generated export results and processes.
283 This is an alist: its CAR is the source of the
284 result (destination file or buffer for a finished process,
285 original buffer for a running one) and its CDR is a list
286 containing the back-end used, as a symbol, and either a process
287 or the time at which it finished. It is used to build the menu
291 "List of backends currently available in the exporter.
292 This variable is set with `org-export-define-backend' and
296 "Last command called from the dispatcher.
297 The value should be a list. Its CAR is the action, as a symbol,
301 "The position where the last export command was created using the dispatcher.
302 This marker will be used with `C-u C-c C-e' to make sure export repetition
305 ;; For compatibility with Org < 8
307 "Name, if any, of the back-end used during an export process.
309 Its value is a symbol such as `html', `latex', `ascii', or nil if
310 the back-end is anonymous (see `org-export-create-backend') or if
311 there is no export process in progress.
313 It can be used to teach Babel blocks how to act differently
317 \f
318 ;;; User-configurable Variables
319 ;;
320 ;; Configuration for the masses.
321 ;;
322 ;; They should never be accessed directly, as their value is to be
323 ;; stored in a property list (cf. `org-export-options-alist').
324 ;; Back-ends will read their value from there instead.
327 "Options for exporting Org mode files."
332 "General options for export engine."
337 "Whether sub-trees with the ARCHIVE tag should be exported.
339 This can have three different values:
340 nil Do not export, pretend this tree is not present.
341 t Do export the entire tree.
342 `headline' Only export the headline, but skip the tree below it.
344 This option can also be set with the OPTIONS keyword,
354 "Non-nil means insert author name into the exported file.
355 This option can also be set with the OPTIONS keyword,
362 "Non-nil means export CLOCK keywords.
363 This option can also be set with the OPTIONS keyword,
370 "Non-nil means the postamble should contain a creator sentence.
372 The sentence can be set in `org-export-creator-string', which
373 see.
375 This option can also be set with the OPTIONS keyword, e.g.,
384 "Non-nil means insert date in the exported document.
385 This option can also be set with the OPTIONS keyword,
392 "Time-stamp format string to use for DATE keyword.
394 The format string, when specified, only applies if date consists
395 in a single time-stamp. Otherwise its value will be ignored.
397 See `format-time-string' for details on how to build this
398 string."
407 emacs-version
409 "Information about the creator of the document.
410 This option can also be set on with the CREATOR keyword."
416 "Non-nil means export contents of standard drawers.
418 When t, all drawers are exported. This may also be a list of
419 drawer names to export, as strings. If that list starts with
420 `not', only drawers with such names will be ignored.
422 This variable doesn't apply to properties drawers. See
423 `org-export-with-properties' instead.
425 This option can also be set with the OPTIONS keyword,
438 :inline t
447 "Non-nil means insert author email into the exported file.
448 This option can also be set with the OPTIONS keyword,
455 "Non-nil means interpret *word*, /word/, _word_ and +word+.
457 If the export target supports emphasizing text, the word will be
458 typeset in bold, italic, with an underline or strike-through,
459 respectively.
461 This option can also be set with the OPTIONS keyword,
468 "Tags that exclude a tree from export.
470 All trees carrying any of these tags will be excluded from
471 export. This is without condition, so even subtrees inside that
472 carry one of the `org-export-select-tags' will be removed.
474 This option can also be set with the EXCLUDE_TAGS keyword."
481 This option can also be set with the OPTIONS keyword,
490 "Non-nil means Org footnotes should be exported.
491 This option can also be set with the OPTIONS keyword,
498 "Non-nil means process LaTeX environments and fragments.
500 This option can also be set with the OPTIONS line,
503 nil Ignore math snippets.
504 `verbatim' Keep everything in verbatim.
505 t Allow export of math snippets."
516 "The last level which is still exported as a headline.
518 Inferior levels will usually produce itemize or enumerate lists
519 when exported, but back-end behavior may differ.
521 This option can also be set with the OPTIONS keyword,
528 "The default language for export and clocktable translations, as a string.
529 This may have an association in
530 `org-clock-clocktable-language-setup',
531 `org-export-smart-quotes-alist' and `org-export-dictionary'.
532 This option can also be set with the LANGUAGE keyword."
538 "Non-nil means preserve all line breaks when exporting.
539 This option can also be set with the OPTIONS keyword,
546 "Non-nil means interpret entities when exporting.
549 Å.
551 For a list of supported names, see the constant `org-entities'
552 and the user option `org-entities-user'.
554 This option can also be set with the OPTIONS keyword,
561 "Non-nil means inlinetasks should be exported.
562 This option can also be set with the OPTIONS keyword,
571 "Non-nil means include planning info in export.
573 Planning info is the line containing either SCHEDULED:,
574 DEADLINE:, CLOSED: time-stamps, or a combination of them.
576 This option can also be set with the OPTIONS keyword,
585 "Non-nil means include priority cookies in export.
586 This option can also be set with the OPTIONS keyword,
593 "Non-nil means export contents of properties drawers.
595 When t, all properties are exported. This may also be a list of
596 properties to export, as strings.
598 This option can also be set with the OPTIONS keyword,
612 "Non-nil means add section numbers to headlines when exporting.
614 When set to an integer n, numbering will only happen for
615 headlines whose relative level is higher or equal to n.
617 This option can also be set with the OPTIONS keyword,
624 "Tags that select a tree for export.
626 If any such tag is found in a buffer, all trees that do not carry
627 one of these tags will be ignored during export. Inside trees
628 that are selected like this, you can still deselect a subtree by
629 tagging it with one of the `org-export-exclude-tags'.
631 This option can also be set with the SELECT_TAGS keyword."
637 "Non-nil means activate smart quotes during export.
638 This option can also be set with the OPTIONS keyword,
641 When setting this to non-nil, you need to take care of
642 using the correct Babel package when exporting to LaTeX.
643 E.g., you can load Babel for french like this:
655 When this option is turned on, these strings will be exported as:
657 Org HTML LaTeX UTF-8
658 -----+----------+--------+-------
660 -- – -- –
661 --- — --- —
664 This option can also be set with the OPTIONS keyword,
671 "Non-nil means include statistics cookies in export.
672 This option can also be set with the OPTIONS keyword,
683 If you want to control how Org displays those characters, see
684 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
685 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
686 it is not anymore.
688 When this option is turned on, you can use TeX-like syntax for
689 sub- and superscripts and see them exported correctly.
691 You can also set the option with #+OPTIONS: ^:t
694 single item - so grouping with {} is normally not needed. For
695 example, the following things will be parsed as single sub- or
696 superscripts:
698 10^24 or 10^tau several digits will be considered 1 item.
699 10^-12 or 10^-tau a leading sign with digits or a word
700 x^2-y^3 will be read as x^2 - y^3, because items are
701 terminated by almost any nonword/nondigit char.
702 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
704 Still, ambiguity is possible. So when in doubt, use {} to enclose
705 the sub/superscript. If you set this variable to the symbol `{}',
706 the braces are *required* in order to trigger interpretations as
708 frequently in plain text."
719 "Non-nil means create a table of contents in exported files.
721 The TOC contains headlines with levels up
722 to`org-export-headline-levels'. When an integer, include levels
723 up to N in the toc, this may then be different from
724 `org-export-headline-levels', but it will not be allowed to be
725 larger than the number of headline levels. When nil, no table of
726 contents is made.
728 This option can also be set with the OPTIONS keyword,
739 "Non-nil means export tables.
740 This option can also be set with the OPTIONS keyword,
749 "If nil, do not export tags, just remove them from headlines.
751 If this is the symbol `not-in-toc', tags will be removed from
752 table of contents entries, but still be shown in the headlines of
753 the document.
755 This option can also be set with the OPTIONS keyword,
765 "Non-nil means include TODO items for export.
767 This may have the following values:
768 t include tasks independent of state.
769 `todo' include only tasks that are not yet done.
770 `done' include only tasks that are already done.
771 nil ignore all tasks.
772 list of keywords include tasks with these keywords.
774 This option can also be set with the OPTIONS keyword,
789 "Non-nil means print title into the exported file.
790 This option can also be set with the OPTIONS keyword,
799 "Non-nil means insert a time stamp into the exported file.
800 The time stamp shows when the file was created. This option can
807 "Non nil means allow timestamps in export.
809 It can be set to any of the following values:
810 t export all timestamps.
811 `active' export active timestamps only.
812 `inactive' export inactive timestamps only.
813 nil do not export timestamps
815 This only applies to timestamps isolated in a paragraph
816 containing only timestamps. Other timestamps are always
817 exported.
819 This option can also be set with the OPTIONS keyword, e.g.
830 "Non-nil means include TODO keywords in export.
831 When nil, remove all these keywords from the export. This option
837 "Non-nil means BIND keywords can define local variable values.
838 This is a potential security risk, which is why the default value
839 is nil. You can also allow them through local buffer variables."
846 "Non-nil means do not raise an error on broken links.
848 When this variable is non-nil, broken links are ignored, without
849 stopping the export process. If it is set to `mark', broken
850 links are marked as such in the output, with a string like
852 [BROKEN LINK: path]
854 where PATH is the un-resolvable reference.
856 This option can also be set with the OPTIONS keyword, e.g.,
867 "Alist between export snippets back-ends and exporter back-ends.
869 This variable allows providing shortcuts for export snippets.
873 HTML code while every other back-end will ignore it."
887 "Alist between macro names and expansion templates.
889 This variable defines macro expansion templates available
890 globally. Associations follow the pattern
892 (NAME . TEMPLATE)
894 where NAME is a string beginning with a letter and consisting of
895 alphanumeric characters only.
897 TEMPLATE is the string to which the macro is going to be
899 macro's arguments. Moreover, if the template starts with
901 accordingly."
910 "Coding system for the exported file."
917 "Non-nil means pushing export output to the kill ring.
918 This variable is ignored during asynchronous export."
928 "The initial scope when exporting with `org-export-dispatch'.
929 This variable can be either set to `buffer' or `subtree'."
936 "Non-nil means show buffer after exporting to temp buffer.
937 When Org exports to a file, the buffer visiting that file is never
938 shown, but remains buried. However, when exporting to
939 a temporary buffer, that buffer is popped up in a second window.
940 When this variable is nil, the buffer remains buried also in
941 these cases."
946 "Non-nil means export and publishing commands will run in background.
947 Results from an asynchronous export are never displayed
955 "File used to initialize external export process.
957 Value must be either nil or an absolute file name. When nil, the
958 external process is launched like a regular Emacs session,
959 loading user's initialization file and any site specific
960 configuration. If a file is provided, it, and only it, is loaded
961 at start-up.
963 Therefore, using a specific configuration makes the process to
964 load faster and the export more portable."
973 "Non-nil means using a non-intrusive `org-export-dispatch'.
974 In that case, no help buffer is displayed. Though, an indicator
980 asynchronous). Also, [?] allows switching back to standard
981 mode."
988 \f
989 ;;; Defining Back-ends
990 ;;
991 ;; An export back-end is a structure with `org-export-backend' type
992 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
993 ;; and `menu' slots.
994 ;;
995 ;; At the lowest level, a back-end is created with
996 ;; `org-export-create-backend' function.
997 ;;
998 ;; A named back-end can be registered with
999 ;; `org-export-register-backend' function. A registered back-end can
1000 ;; later be referred to by its name, with `org-export-get-backend'
1001 ;; function. Also, such a back-end can become the parent of a derived
1002 ;; back-end from which slot values will be inherited by default.
1003 ;; `org-export-derived-backend-p' can check if a given back-end is
1004 ;; derived from a list of back-end names.
1005 ;;
1006 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
1007 ;; `org-export-get-all-filters' return the full alist of transcoders,
1008 ;; options and filters, including those inherited from ancestors.
1009 ;;
1010 ;; At a higher level, `org-export-define-backend' is the standard way
1011 ;; to define an export back-end. If the new back-end is similar to
1012 ;; a registered back-end, `org-export-define-derived-backend' may be
1013 ;; used instead.
1014 ;;
1015 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
1016 ;; when a given back-end hasn't been registered yet.
1020 name parent transcoders options filters blocks menu)
1022 ;;;###autoload
1024 "Return export back-end named after NAME.
1025 NAME is a symbol. Return nil if no such back-end is found."
1027 org-export-registered-backends))
1030 "Register BACKEND as a known export back-end.
1031 BACKEND is a structure with `org-export-backend' type."
1032 ;; Refuse to register an unnamed back-end.
1035 ;; Refuse to register a back-end with an unknown parent.
1039 ;; If a back-end with the same name as BACKEND is already
1040 ;; registered, replace it with BACKEND. Otherwise, simply add
1041 ;; BACKEND to the list of registered back-ends.
1047 "Signal an error if BACKEND isn't defined."
1052 "Non-nil if BACKEND is derived from one of BACKENDS.
1053 BACKEND is an export back-end, as returned by, e.g.,
1054 `org-export-create-backend', or a symbol referring to
1055 a registered back-end. BACKENDS is constituted of symbols."
1067 "Return full translation table for BACKEND.
1069 BACKEND is an export back-end, as return by, e.g,,
1070 `org-export-create-backend'. Return value is an alist where
1071 keys are element or object types, as symbols, and values are
1072 transcoders.
1074 Unlike to `org-export-backend-transcoders', this function
1075 also returns transcoders inherited from parent back-ends,
1076 if any."
1080 parent)
1085 transcoders)))
1088 "Return export options for BACKEND.
1090 BACKEND is an export back-end, as return by, e.g,,
1091 `org-export-create-backend'. See `org-export-options-alist'
1092 for the shape of the return value.
1094 Unlike to `org-export-backend-options', this function also
1095 returns options inherited from parent back-ends, if any.
1097 Return nil if BACKEND is unknown."
1101 parent)
1105 options)))
1108 "Return complete list of filters for BACKEND.
1110 BACKEND is an export back-end, as return by, e.g,,
1111 `org-export-create-backend'. Return value is an alist where
1112 keys are symbols and values lists of functions.
1114 Unlike to `org-export-backend-filters', this function also
1115 returns filters inherited from parent back-ends, if any."
1119 parent)
1123 filters)))
1126 "Define a new back-end BACKEND.
1128 TRANSCODERS is an alist between object or element types and
1129 functions handling them.
1131 These functions should return a string without any trailing
1132 space, or nil. They must accept three arguments: the object or
1133 element itself, its contents or nil when it isn't recursive and
1134 the property list used as a communication channel.
1136 Contents, when not nil, are stripped from any global indentation
1137 \(although the relative one is preserved). They also always end
1138 with a single newline character.
1140 If, for a given type, no function is found, that element or
1141 object type will simply be ignored, along with any blank line or
1142 white space at its end. The same will happen if the function
1143 returns the nil value. If that function returns the empty
1144 string, the type will be ignored, but the blank lines or white
1145 spaces will be kept.
1147 In addition to element and object types, one function can be
1148 associated to the `template' (or `inner-template') symbol and
1149 another one to the `plain-text' symbol.
1151 The former returns the final transcoded string, and can be used
1152 to add a preamble and a postamble to document's body. It must
1153 accept two arguments: the transcoded string and the property list
1154 containing export options. A function associated to `template'
1156 A function associated to `inner-template' is always applied.
1158 The latter, when defined, is to be called on every text not
1159 recognized as an element or an object. It must accept two
1160 arguments: the text string and the information channel. It is an
1161 appropriate place to protect special chars relative to the
1162 back-end.
1164 BODY can start with pre-defined keyword arguments. The following
1165 keywords are understood:
1167 :filters-alist
1169 Alist between filters and function, or list of functions,
1170 specific to the back-end. See `org-export-filters-alist' for
1171 a list of all allowed filters. Filters defined here
1172 shouldn't make a back-end test, as it may prevent back-ends
1173 derived from this one to behave properly.
1175 :menu-entry
1177 Menu entry for the export dispatcher. It should be a list
1178 like:
1182 where :
1184 KEY is a free character selecting the back-end.
1186 DESCRIPTION-OR-ORDINAL is either a string or a number.
1188 If it is a string, is will be used to name the back-end in
1189 its menu entry. If it is a number, the following menu will
1190 be displayed as a sub-menu of the back-end with the same
1191 KEY. Also, the number will be used to determine in which
1192 order such sub-menus will appear (lowest first).
1194 ACTION-OR-MENU is either a function or an alist.
1196 If it is an action, it will be called with four
1197 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1198 BODY-ONLY. See `org-export-as' for further explanations on
1199 some of them.
1201 If it is an alist, associations should follow the
1202 pattern:
1206 where KEY, DESCRIPTION and ACTION are described above.
1208 Valid values include:
1212 or
1217 (lambda (a s v b)
1218 (if a (org-latex-export-to-pdf t s v b)
1219 (org-open-file
1220 (org-latex-export-to-pdf nil s v b)))))))
1222 or the following, which will be added to the previous
1223 sub-menu,
1229 :options-alist
1231 Alist between back-end specific properties introduced in
1232 communication channel and how their value are acquired. See
1233 `org-export-options-alist' for more information about
1234 structure of the values."
1246 :transcoders transcoders
1247 :options options
1248 :filters filters
1252 "Create a new back-end as a variant of an existing one.
1254 CHILD is the name of the derived back-end. PARENT is the name of
1255 the parent back-end.
1257 BODY can start with pre-defined keyword arguments. The following
1258 keywords are understood:
1260 :filters-alist
1262 Alist of filters that will overwrite or complete filters
1263 defined in PARENT back-end. See `org-export-filters-alist'
1264 for a list of allowed filters.
1266 :menu-entry
1268 Menu entry for the export dispatcher. See
1269 `org-export-define-backend' for more information about the
1270 expected value.
1272 :options-alist
1274 Alist of back-end specific properties that will overwrite or
1275 complete those defined in PARENT back-end. Refer to
1276 `org-export-options-alist' for more information about
1277 structure of the values.
1279 :translate-alist
1281 Alist of element and object types and transcoders that will
1282 overwrite or complete transcode table from PARENT back-end.
1283 Refer to `org-export-define-backend' for detailed information
1284 about transcoders.
1287 as a variant of `latex' back-end with a custom template function:
1292 The back-end could then be called with, for example:
1307 :parent parent
1308 :transcoders transcoders
1309 :options options
1310 :filters filters
1314 \f
1315 ;;; The Communication Channel
1316 ;;
1317 ;; During export process, every function has access to a number of
1318 ;; properties. They are of two types:
1319 ;;
1320 ;; 1. Environment options are collected once at the very beginning of
1321 ;; the process, out of the original buffer and configuration.
1322 ;; Collecting them is handled by `org-export-get-environment'
1323 ;; function.
1324 ;;
1325 ;; Most environment options are defined through the
1326 ;; `org-export-options-alist' variable.
1327 ;;
1328 ;; 2. Tree properties are extracted directly from the parsed tree,
1329 ;; just before export, by `org-export--collect-tree-properties'.
1331 ;;;; Environment Options
1332 ;;
1333 ;; Environment options encompass all parameters defined outside the
1334 ;; scope of the parsed data. They come from five sources, in
1335 ;; increasing precedence order:
1336 ;;
1337 ;; - Global variables,
1338 ;; - Buffer's attributes,
1339 ;; - Options keyword symbols,
1340 ;; - Buffer keywords,
1341 ;; - Subtree properties.
1342 ;;
1343 ;; The central internal function with regards to environment options
1344 ;; is `org-export-get-environment'. It updates global variables with
1345 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1346 ;; the different sources.
1347 ;;
1348 ;; The internal functions doing the retrieval are:
1349 ;; `org-export--get-global-options',
1350 ;; `org-export--get-buffer-attributes',
1351 ;; `org-export--parse-option-keyword',
1352 ;; `org-export--get-subtree-options' and
1353 ;; `org-export--get-inbuffer-options'
1354 ;;
1355 ;; Also, `org-export--list-bound-variables' collects bound variables
1356 ;; along with their value in order to set them as buffer local
1357 ;; variables later in the process.
1359 ;;;###autoload
1361 "Collect export options from the current buffer.
1363 Optional argument BACKEND is an export back-end, as returned by
1364 `org-export-create-backend'.
1366 When optional argument SUBTREEP is non-nil, assume the export is
1367 done against the current sub-tree.
1369 Third optional argument EXT-PLIST is a property list with
1370 external parameters overriding Org default settings, but still
1371 inferior to file-local settings."
1372 ;; First install #+BIND variables since these must be set before
1373 ;; global options are read.
1376 ;; Get and prioritize export options...
1378 ;; ... from global variables...
1380 ;; ... from an external property list...
1381 ext-plist
1382 ;; ... from in-buffer settings...
1384 ;; ... and from subtree, when appropriate.
1388 "Parse an OPTIONS line and return values as a plist.
1389 Optional argument BACKEND is an export back-end, as returned by,
1390 e.g., `org-export-create-backend'. It specifies which back-end
1391 specific items to read, if any."
1398 alist))
1399 alist))
1400 ;; Priority is given to back-end specific options.
1402 org-export-options-alist))
1412 "Get export options in subtree at point.
1413 Optional argument BACKEND is an export back-end, as returned by,
1414 e.g., `org-export-create-backend'. It specifies back-end used
1415 for export. Return options as a plist."
1416 ;; For each buffer keyword, create a headline property setting the
1417 ;; same property in communication channel. The name for the
1418 ;; property is the keyword with "EXPORT_" appended to it.
1420 ;; Make sure point is at a heading.
1423 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1424 ;; care of them right from the start.
1427 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1428 ;; headline's title (with no todo keyword, priority cookie or
1429 ;; tag) as its fallback value.
1436 ;; Look for both general keywords and back-end specific
1437 ;; options, with priority given to the latter.
1439 org-export-options-alist)))
1440 ;; Handle other keywords. Then return PLIST.
1454 property
1463 "Return current buffer export options, as a plist.
1465 Optional argument BACKEND, when non-nil, is an export back-end,
1466 as returned by, e.g., `org-export-create-backend'. It specifies
1467 which back-end specific options should also be read in the
1468 process.
1470 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1473 ;; Priority is given to back-end specific options.
1475 org-export-options-alist))
1478 org-export-special-keywords))))
1479 plist to-parse)
1482 ;; Return all properties associated to KEYWORD.
1489 ;; Recursively read keywords in buffer. FILES is
1490 ;; a list of files read so far. PLIST is the current
1491 ;; property list obtained.
1500 ;; Options in `org-export-special-keywords'.
1505 ;; Avoid circular dependencies.
1516 plist
1518 val backend))))
1522 plist
1529 ;; Options in `org-export-options-alist'.
1532 plist
1534 plist property
1535 ;; Handle value depending on specified
1536 ;; BEHAVIOR.
1541 ;; Even if `parse' implies `space'
1542 ;; behavior, we separate line with
1543 ;; "\n" so as to preserve
1544 ;; line-breaks. However, empty
1545 ;; lines are forbidden since `parse'
1546 ;; doesn't allow more than one
1547 ;; paragraph.
1556 " "
1569 ;; Read options in the current buffer and return value.
1571 ;; Parse properties in TO-PARSE. Remove newline characters not
1572 ;; involved in line breaks to simulate `space' behavior.
1573 ;; Finally return options.
1586 "Return properties related to export process, as a plist.
1587 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1588 are like the arguments with the same names of function
1589 `org-export-as'."
1594 :back-end backend
1599 "Return properties related to buffer attributes, as a plist."
1604 "Return global export options as a plist.
1605 Optional argument BACKEND, if non-nil, is an export back-end, as
1606 returned by, e.g., `org-export-create-backend'. It specifies
1607 which back-end specific export options should also be read in the
1608 process."
1610 ;; Priority is given to back-end specific options.
1612 org-export-options-alist)))
1618 plist
1619 prop
1620 ;; Evaluate default value provided.
1625 value)))))))))
1628 "Return variables bound from BIND keywords in current buffer.
1629 Also look for BIND keywords in setup files. The return value is
1630 an alist where associations are (VARIABLE-NAME VALUE)."
1634 ;; Return an alist between variable names and their
1635 ;; value. FILES is a list of setup files names read
1636 ;; so far, used to avoid circular dependencies. ALIST
1637 ;; is the alist collected so far.
1649 ;; Enter setup file.
1661 alist))))))))))
1662 alist)))))
1663 ;; Return value in appropriate order of appearance.
1666 ;; defsubst org-export-get-parent must be defined before first use,
1667 ;; was originally defined in the topology section
1670 "Return BLOB parent or nil.
1671 BLOB is the element or object considered."
1674 ;;;; Tree Properties
1675 ;;
1676 ;; Tree properties are information extracted from parse tree. They
1677 ;; are initialized at the beginning of the transcoding process by
1678 ;; `org-export--collect-tree-properties'.
1679 ;;
1680 ;; Dedicated functions focus on computing the value of specific tree
1681 ;; properties during initialization. Thus,
1682 ;; `org-export--populate-ignore-list' lists elements and objects that
1683 ;; should be skipped during export, `org-export--get-min-level' gets
1684 ;; the minimal exportable level, used as a basis to compute relative
1685 ;; level for headlines. Eventually
1686 ;; `org-export--collect-headline-numbering' builds an alist between
1687 ;; headlines and their numbering.
1690 "Extract tree properties from parse tree.
1692 DATA is the parse tree from which information is retrieved. INFO
1693 is a list holding export options.
1695 Following tree properties are set or updated:
1697 `:headline-offset' Offset between true level of headlines and
1698 local level. An offset of -1 means a headline
1699 of level 2 should be considered as a level
1700 1 headline in the context.
1702 `:headline-numbering' Alist of all headlines as key and the
1703 associated numbering as value.
1705 `:id-alist' Alist of all ID references as key and associated file
1706 as value.
1708 Return updated plist."
1709 ;; Install the parse tree in the communication channel.
1711 ;; Compute `:headline-offset' in order to be able to use
1712 ;; `org-export-get-relative-level'.
1715 :headline-offset
1717 ;; From now on, properties order doesn't matter: get the rest of the
1718 ;; tree properties.
1720 info
1722 :id-alist
1731 "Return minimum exportable headline's level in DATA.
1732 DATA is parsed tree as returned by `org-element-parse-buffer'.
1733 OPTIONS is a plist holding export options."
1742 ;; If no headline was found, for the sake of consistency, set
1743 ;; minimum level to 1 nonetheless.
1747 "Return numbering of all exportable, numbered headlines in a parse tree.
1749 DATA is the parse tree. OPTIONS is the plist holding export
1750 options.
1752 Return an alist whose key is a headline and value is its
1753 associated numbering \(in the shape of a list of numbers) or nil
1754 for a footnotes section."
1763 headline
1765 for n across numbering
1766 for idx from 0 to org-export-max-depth
1770 options)))
1773 "List headlines and inlinetasks with a select tag in their tree.
1774 DATA is parsed data as returned by `org-element-parse-buffer'.
1775 INFO is a plist holding export options."
1778 ;; If FILETAGS contains a select tag, every headline or
1779 ;; inlinetask is returned.
1789 ;; When a select tag is found, mark full
1790 ;; genealogy and every headline within the
1791 ;; tree as acceptable.
1794 genealogy
1797 selected-trees))
1798 ;; If at a headline, continue searching in
1799 ;; tree, recursively.
1808 selected-trees))))
1811 "Non-nil when element or object DATUM should be skipped during export.
1812 OPTIONS is the plist holding export options. SELECTED, when
1813 non-nil, is a list of headlines or inlinetasks belonging to
1814 a tree with a select tag."
1817 ;; Skip all comments and comment blocks. Make to keep maximum
1818 ;; number of blank lines around the comment so as to preserve
1819 ;; local structure of the document upon interpreting it back into
1820 ;; Org syntax.
1826 t)
1832 ;; If `:with-drawers' value starts with `not', ignore
1833 ;; every drawer whose name belong to that list.
1834 ;; Otherwise, ignore drawers whose name isn't in that
1835 ;; list.
1852 ;; Ignore subtrees with an exclude tag.
1855 ;; When a select tag is present in the buffer, ignore any tree
1856 ;; without it.
1858 ;; Ignore commented sub-trees.
1860 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1862 ;; Ignore tasks, if specified by `:with-tasks' property.
1874 properties-set))))))
1885 ;; `:with-timestamps' only applies to isolated timestamps
1886 ;; objects, i.e. timestamp objects in a paragraph containing only
1887 ;; timestamps and whitespaces.
1895 options t))))
1904 \f
1905 ;;; The Transcoder
1906 ;;
1907 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1908 ;; `org-element-parse-buffer') and transcodes it into a specified
1909 ;; back-end output. It takes care of filtering out elements or
1910 ;; objects according to export options and organizing the output blank
1911 ;; lines and white space are preserved. The function memoizes its
1912 ;; results, so it is cheap to call it within transcoders.
1913 ;;
1914 ;; It is possible to modify locally the back-end used by
1915 ;; `org-export-data' or even use a temporary back-end by using
1916 ;; `org-export-data-with-backend'.
1917 ;;
1918 ;; `org-export-transcoder' is an accessor returning appropriate
1919 ;; translator function for a given element or object.
1922 "Return appropriate transcoder for BLOB.
1923 INFO is a plist containing export directives."
1925 ;; Return contents only for complete parse trees.
1931 "Convert DATA into current back-end format.
1933 DATA is a parse tree, an element or an object or a secondary
1934 string. INFO is a plist holding export options.
1936 Return a string."
1938 ;; Handle broken links according to
1939 ;; `org-export-with-broken-links'.
1955 ;; Ignored element/object.
1957 ;; Plain text.
1963 info))
1964 ;; Secondary string.
1967 ;; Element/Object without contents or, as a special
1968 ;; case, headline with archive tag and archived trees
1969 ;; restricted to title only.
1978 ;; Export snippets never return a nil value so
1979 ;; that white spaces following them are never
1980 ;; ignored.
1982 ;; Element/Object with contents.
1995 ;; Elements directly containing
1996 ;; objects must have their indentation
1997 ;; normalized first.
1999 data
2000 ;; When normalizing contents of the
2001 ;; first paragraph in an item or
2002 ;; a footnote definition, ignore
2003 ;; first line's indentation: there is
2004 ;; none and it might be misleading.
2008 data)
2016 info)))))))))
2017 ;; Final result will be memoized before being returned.
2019 data
2023 ;; Append the same white space between elements or objects
2024 ;; as in the original buffer, and call appropriate filters.
2033 info)))
2037 "Convert DATA into BACKEND format.
2039 DATA is an element, an object, a secondary string or a string.
2040 BACKEND is a symbol. INFO is a plist used as a communication
2041 channel.
2043 Unlike to `org-export-with-backend', this function will
2044 recursively convert DATA using BACKEND translation table."
2046 ;; Set-up a new communication channel with translations defined in
2047 ;; BACKEND as the translate table and a new hash table for
2048 ;; memoization.
2051 info
2054 ;; Size of the hash table is reduced since this
2055 ;; function will probably be used on small trees.
2058 ;; Preserve `:internal-references', as those do not depend on
2059 ;; the back-end used; we need to make sure that any new
2060 ;; reference when the temporary back-end was active gets through
2061 ;; the default one.
2066 "Expand a parsed element or object to its original state.
2068 BLOB is either an element or an object. CONTENTS is its
2069 contents, as a string or nil.
2071 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2072 keywords before output."
2078 blob contents))))
2081 \f
2082 ;;; The Filter System
2083 ;;
2084 ;; Filters allow end-users to tweak easily the transcoded output.
2085 ;; They are the functional counterpart of hooks, as every filter in
2086 ;; a set is applied to the return value of the previous one.
2087 ;;
2088 ;; Every set is back-end agnostic. Although, a filter is always
2089 ;; called, in addition to the string it applies to, with the back-end
2090 ;; used as argument, so it's easy for the end-user to add back-end
2091 ;; specific filters in the set. The communication channel, as
2092 ;; a plist, is required as the third argument.
2093 ;;
2094 ;; From the developer side, filters sets can be installed in the
2095 ;; process with the help of `org-export-define-backend', which
2096 ;; internally stores filters as an alist. Each association has a key
2097 ;; among the following symbols and a function or a list of functions
2098 ;; as value.
2099 ;;
2100 ;; - `:filter-options' applies to the property list containing export
2101 ;; options. Unlike to other filters, functions in this list accept
2102 ;; two arguments instead of three: the property list containing
2103 ;; export options and the back-end. Users can set its value through
2104 ;; `org-export-filter-options-functions' variable.
2105 ;;
2106 ;; - `:filter-parse-tree' applies directly to the complete parsed
2107 ;; tree. Users can set it through
2108 ;; `org-export-filter-parse-tree-functions' variable.
2109 ;;
2110 ;; - `:filter-body' applies to the body of the output, before template
2111 ;; translator chimes in. Users can set it through
2112 ;; `org-export-filter-body-functions' variable.
2113 ;;
2114 ;; - `:filter-final-output' applies to the final transcoded string.
2115 ;; Users can set it with `org-export-filter-final-output-functions'
2116 ;; variable.
2117 ;;
2118 ;; - `:filter-plain-text' applies to any string not recognized as Org
2119 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2120 ;; configure it.
2121 ;;
2122 ;; - `:filter-TYPE' applies on the string returned after an element or
2123 ;; object of type TYPE has been transcoded. A user can modify
2124 ;; `org-export-filter-TYPE-functions' to install these filters.
2125 ;;
2126 ;; All filters sets are applied with
2127 ;; `org-export-filter-apply-functions' function. Filters in a set are
2128 ;; applied in a LIFO fashion. It allows developers to be sure that
2129 ;; their filters will be applied first.
2130 ;;
2131 ;; Filters properties are installed in communication channel with
2132 ;; `org-export-install-filters' function.
2133 ;;
2134 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2135 ;; `org-export-before-parsing-hook') are run at the beginning of the
2136 ;; export process and just before parsing to allow for heavy structure
2137 ;; modifications.
2140 ;;;; Hooks
2143 "Hook run at the beginning of the export process.
2145 This is run before include keywords and macros are expanded and
2146 Babel code blocks executed, on a copy of the original buffer
2147 being exported. Visibility and narrowing are preserved. Point
2148 is at the beginning of the buffer.
2150 Every function in this hook will be called with one argument: the
2154 "Hook run before parsing an export buffer.
2156 This is run after include keywords and macros have been expanded
2157 and Babel code blocks executed, on a copy of the original buffer
2158 being exported. Visibility and narrowing are preserved. Point
2159 is at the beginning of the buffer.
2161 Every function in this hook will be called with one argument: the
2165 ;;;; Special Filters
2168 "List of functions applied to the export options.
2169 Each filter is called with two arguments: the export options, as
2170 a plist, and the back-end, as a symbol. It must return
2174 "List of functions applied to the parsed tree.
2175 Each filter is called with three arguments: the parse tree, as
2176 returned by `org-element-parse-buffer', the back-end, as
2177 a symbol, and the communication channel, as a plist. It must
2181 "List of functions applied to plain text.
2182 Each filter is called with three arguments: a string which
2183 contains no Org syntax, the back-end, as a symbol, and the
2184 communication channel, as a plist. It must return a string or
2188 "List of functions applied to transcoded body.
2189 Each filter is called with three arguments: a string which
2190 contains no Org syntax, the back-end, as a symbol, and the
2191 communication channel, as a plist. It must return a string or
2195 "List of functions applied to the transcoded string.
2196 Each filter is called with three arguments: the full transcoded
2197 string, the back-end, as a symbol, and the communication channel,
2198 as a plist. It must return a string that will be used as the
2202 ;;;; Elements Filters
2205 "List of functions applied to a transcoded babel-call.
2206 Each filter is called with three arguments: the transcoded data,
2207 as a string, the back-end, as a symbol, and the communication
2211 "List of functions applied to a transcoded center block.
2212 Each filter is called with three arguments: the transcoded data,
2213 as a string, the back-end, as a symbol, and the communication
2217 "List of functions applied to a transcoded clock.
2218 Each filter is called with three arguments: the transcoded data,
2219 as a string, the back-end, as a symbol, and the communication
2223 "List of functions applied to a transcoded diary-sexp.
2224 Each filter is called with three arguments: the transcoded data,
2225 as a string, the back-end, as a symbol, and the communication
2229 "List of functions applied to a transcoded drawer.
2230 Each filter is called with three arguments: the transcoded data,
2231 as a string, the back-end, as a symbol, and the communication
2235 "List of functions applied to a transcoded dynamic-block.
2236 Each filter is called with three arguments: the transcoded data,
2237 as a string, the back-end, as a symbol, and the communication
2241 "List of functions applied to a transcoded example-block.
2242 Each filter is called with three arguments: the transcoded data,
2243 as a string, the back-end, as a symbol, and the communication
2247 "List of functions applied to a transcoded export-block.
2248 Each filter is called with three arguments: the transcoded data,
2249 as a string, the back-end, as a symbol, and the communication
2253 "List of functions applied to a transcoded fixed-width.
2254 Each filter is called with three arguments: the transcoded data,
2255 as a string, the back-end, as a symbol, and the communication
2259 "List of functions applied to a transcoded footnote-definition.
2260 Each filter is called with three arguments: the transcoded data,
2261 as a string, the back-end, as a symbol, and the communication
2265 "List of functions applied to a transcoded headline.
2266 Each filter is called with three arguments: the transcoded data,
2267 as a string, the back-end, as a symbol, and the communication
2271 "List of functions applied to a transcoded horizontal-rule.
2272 Each filter is called with three arguments: the transcoded data,
2273 as a string, the back-end, as a symbol, and the communication
2277 "List of functions applied to a transcoded inlinetask.
2278 Each filter is called with three arguments: the transcoded data,
2279 as a string, the back-end, as a symbol, and the communication
2283 "List of functions applied to a transcoded item.
2284 Each filter is called with three arguments: the transcoded data,
2285 as a string, the back-end, as a symbol, and the communication
2289 "List of functions applied to a transcoded keyword.
2290 Each filter is called with three arguments: the transcoded data,
2291 as a string, the back-end, as a symbol, and the communication
2295 "List of functions applied to a transcoded latex-environment.
2296 Each filter is called with three arguments: the transcoded data,
2297 as a string, the back-end, as a symbol, and the communication
2301 "List of functions applied to a transcoded node-property.
2302 Each filter is called with three arguments: the transcoded data,
2303 as a string, the back-end, as a symbol, and the communication
2307 "List of functions applied to a transcoded paragraph.
2308 Each filter is called with three arguments: the transcoded data,
2309 as a string, the back-end, as a symbol, and the communication
2313 "List of functions applied to a transcoded plain-list.
2314 Each filter is called with three arguments: the transcoded data,
2315 as a string, the back-end, as a symbol, and the communication
2319 "List of functions applied to a transcoded planning.
2320 Each filter is called with three arguments: the transcoded data,
2321 as a string, the back-end, as a symbol, and the communication
2325 "List of functions applied to a transcoded property-drawer.
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 quote block.
2332 Each filter is called with three arguments: the transcoded quote
2333 data, as a string, the back-end, as a symbol, and the
2334 communication channel, as a plist. It must return a string or
2338 "List of functions applied to a transcoded section.
2339 Each filter is called with three arguments: the transcoded data,
2340 as a string, the back-end, as a symbol, and the communication
2344 "List of functions applied to a transcoded special block.
2345 Each filter is called with three arguments: the transcoded data,
2346 as a string, the back-end, as a symbol, and the communication
2350 "List of functions applied to a transcoded src-block.
2351 Each filter is called with three arguments: the transcoded data,
2352 as a string, the back-end, as a symbol, and the communication
2356 "List of functions applied to a transcoded table.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 "List of functions applied to a transcoded table-cell.
2363 Each filter is called with three arguments: the transcoded data,
2364 as a string, the back-end, as a symbol, and the communication
2368 "List of functions applied to a transcoded table-row.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded verse block.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 ;;;; Objects Filters
2383 "List of functions applied to transcoded bold text.
2384 Each filter is called with three arguments: the transcoded data,
2385 as a string, the back-end, as a symbol, and the communication
2389 "List of functions applied to transcoded code text.
2390 Each filter is called with three arguments: the transcoded data,
2391 as a string, the back-end, as a symbol, and the communication
2395 "List of functions applied to a transcoded entity.
2396 Each filter is called with three arguments: the transcoded data,
2397 as a string, the back-end, as a symbol, and the communication
2401 "List of functions applied to a transcoded export-snippet.
2402 Each filter is called with three arguments: the transcoded data,
2403 as a string, the back-end, as a symbol, and the communication
2407 "List of functions applied to a transcoded footnote-reference.
2408 Each filter is called with three arguments: the transcoded data,
2409 as a string, the back-end, as a symbol, and the communication
2413 "List of functions applied to a transcoded inline-babel-call.
2414 Each filter is called with three arguments: the transcoded data,
2415 as a string, the back-end, as a symbol, and the communication
2419 "List of functions applied to a transcoded inline-src-block.
2420 Each filter is called with three arguments: the transcoded data,
2421 as a string, the back-end, as a symbol, and the communication
2425 "List of functions applied to transcoded italic text.
2426 Each filter is called with three arguments: the transcoded data,
2427 as a string, the back-end, as a symbol, and the communication
2431 "List of functions applied to a transcoded latex-fragment.
2432 Each filter is called with three arguments: the transcoded data,
2433 as a string, the back-end, as a symbol, and the communication
2437 "List of functions applied to a transcoded line-break.
2438 Each filter is called with three arguments: the transcoded data,
2439 as a string, the back-end, as a symbol, and the communication
2443 "List of functions applied to a transcoded link.
2444 Each filter is called with three arguments: the transcoded data,
2445 as a string, the back-end, as a symbol, and the communication
2449 "List of functions applied to a transcoded radio-target.
2450 Each filter is called with three arguments: the transcoded data,
2451 as a string, the back-end, as a symbol, and the communication
2455 "List of functions applied to a transcoded statistics-cookie.
2456 Each filter is called with three arguments: the transcoded data,
2457 as a string, the back-end, as a symbol, and the communication
2461 "List of functions applied to transcoded strike-through text.
2462 Each filter is called with three arguments: the transcoded data,
2463 as a string, the back-end, as a symbol, and the communication
2467 "List of functions applied to a transcoded subscript.
2468 Each filter is called with three arguments: the transcoded data,
2469 as a string, the back-end, as a symbol, and the communication
2473 "List of functions applied to a transcoded superscript.
2474 Each filter is called with three arguments: the transcoded data,
2475 as a string, the back-end, as a symbol, and the communication
2479 "List of functions applied to a transcoded target.
2480 Each filter is called with three arguments: the transcoded data,
2481 as a string, the back-end, as a symbol, and the communication
2485 "List of functions applied to a transcoded timestamp.
2486 Each filter is called with three arguments: the transcoded data,
2487 as a string, the back-end, as a symbol, and the communication
2491 "List of functions applied to transcoded underline text.
2492 Each filter is called with three arguments: the transcoded data,
2493 as a string, the back-end, as a symbol, and the communication
2497 "List of functions applied to transcoded verbatim text.
2498 Each filter is called with three arguments: the transcoded data,
2499 as a string, the back-end, as a symbol, and the communication
2503 ;;;; Filters Tools
2504 ;;
2505 ;; Internal function `org-export-install-filters' installs filters
2506 ;; hard-coded in back-ends (developer filters) and filters from global
2507 ;; variables (user filters) in the communication channel.
2508 ;;
2509 ;; Internal function `org-export-filter-apply-functions' takes care
2510 ;; about applying each filter in order to a given data. It ignores
2511 ;; filters returning a nil value but stops whenever a filter returns
2512 ;; an empty string.
2515 "Call every function in FILTERS.
2517 Functions are called with three arguments: a value, the export
2518 back-end name and the communication channel. First function in
2519 FILTERS is called with VALUE as its first argument. Second
2520 function in FILTERS is called with the previous result as its
2521 value, etc.
2523 Functions returning nil are skipped. Any function returning the
2524 empty string ends the process, which returns the empty string.
2526 Call is done in a LIFO fashion, to be sure that developer
2527 specified filters, if any, are called first."
2538 "Install filters properties in communication channel.
2539 INFO is a plist containing the current communication channel.
2540 Return the updated communication channel."
2542 ;; Install user-defined filters with `org-export-filters-alist'
2543 ;; and filters already in INFO (through ext-plist mechanism).
2550 ;; Filters in INFO will be called
2551 ;; before those user provided.
2554 default-value)))))
2555 ;; Prepend back-end specific filters to that list.
2557 ;; Single values get consed, lists are appended.
2562 plist key
2565 ;; Return new communication channel.
2569 \f
2570 ;;; Core functions
2571 ;;
2572 ;; This is the room for the main function, `org-export-as', along with
2573 ;; its derivative, `org-export-string-as'.
2574 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2575 ;; function should be added to kill ring.
2576 ;;
2577 ;; Note that `org-export-as' doesn't really parse the current buffer,
2578 ;; but a copy of it (with the same buffer-local variables and
2579 ;; visibility), where macros and include keywords are expanded and
2580 ;; Babel blocks are executed, if appropriate.
2581 ;; `org-export-with-buffer-copy' macro prepares that copy.
2582 ;;
2583 ;; File inclusion is taken care of by
2584 ;; `org-export-expand-include-keyword' and
2585 ;; `org-export--prepare-file-contents'. Structure wise, including
2586 ;; a whole Org file in a buffer often makes little sense. For
2587 ;; example, if the file contains a headline and the include keyword
2588 ;; was within an item, the item should contain the headline. That's
2589 ;; why file inclusion should be done before any structure can be
2590 ;; associated to the file, that is before parsing.
2591 ;;
2592 ;; `org-export-insert-default-template' is a command to insert
2593 ;; a default template (or a back-end specific template) at point or in
2594 ;; current subtree.
2597 "Return a copy of the current buffer.
2598 The copy preserves Org buffer-local variables, visibility and
2599 narrowing."
2605 new-buf))
2608 "Apply BODY in a copy of the current buffer.
2609 The copy preserves local variables, visibility and contents of
2610 the original buffer. Point is at the beginning of the buffer
2611 when BODY is applied."
2620 ;; Kill copy without confirmation.
2626 "Generate a function duplicating BUFFER.
2628 The copy will preserve local variables, visibility, contents and
2629 narrowing of the original buffer. If a region was active in
2630 BUFFER, contents will be narrowed to that region instead.
2632 The resulting function can be evaluated at a later time, from
2633 another buffer, effectively cloning the original buffer there.
2635 The function assumes BUFFER's major mode is `org-mode'."
2639 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2640 ;; already in BUFFER.
2642 ;; Copy specific buffer local variables and variables set
2643 ;; through BIND keywords.
2645 vars)
2653 buffer-file-name
2654 buffer-file-coding-system))
2658 ;; Skip unreadable values, as they cannot be
2659 ;; sent to external process.
2663 vars))))))
2664 ;; Whole buffer contents.
2669 ;; Narrowing.
2673 ;; Current position of point.
2675 ;; Overlays with invisible property.
2684 ov-set)))))))))
2687 "Delete commented trees and commented inlinetasks in the buffer.
2688 Narrowing, if any, is ignored."
2700 "Prune non exportable elements from DATA.
2701 DATA is the parse tree to traverse. INFO is the plist holding
2702 export info. Also set `:ignore-list' in INFO to a list of
2703 objects which should be ignored during export, but not removed
2704 from tree."
2706 ;; First find trees containing a select tag, if any.
2710 ;; Prune non-exportable elements and objects from tree.
2711 ;; As a special case, special rows and cells from tables
2712 ;; are stored in IGNORE, as they still need to be
2713 ;; accessed during export.
2723 ;; If headline is archived but tree below has
2724 ;; to be skipped, remove contents.
2726 ;; Move into recursive objects/elements.
2728 ;; Move into secondary string, if any.
2730 org-element-secondary-value-alist)))
2733 ;; Collect definitions before possibly pruning them so as
2734 ;; to avoid parsing them again if they are required.
2743 #'org-element-create
2746 ;; If a select tag is active, also ignore the section before the
2747 ;; first headline, if any.
2752 ;; Prune tree and communication channel.
2755 ;; Priority is given to back-end specific options.
2757 org-export-options-alist))
2763 ;; Eventually set `:ignore-list'.
2767 "List footnote definitions missing from TREE.
2768 Missing definitions are searched within DEFINITIONS, which is
2769 a list of footnote definitions or in the widened buffer."
2772 ;; List all footnote labels encountered in DATA. Inline
2773 ;; footnote references are ignored.
2778 defined undefined missing-definitions)
2779 ;; Partition DIRECT-REFERENCES between DEFINED and UNDEFINED
2780 ;; references.
2787 seen)
2792 ;; Complete MISSING-DEFINITIONS by finding the definition of every
2793 ;; undefined label, first by looking into DEFINITIONS, then by
2794 ;; searching the widened buffer. This is a recursive process
2795 ;; since definitions found can themselves contain an undefined
2796 ;; reference.
2803 d))
2804 definitions))
2811 datum
2812 ;; Parse definition with contents.
2823 ;; Look for footnote references within DEFINITION, since
2824 ;; we may need to also find their definition.
2829 ;; MISSING-DEFINITIONS may contain footnote references with inline
2830 ;; definitions. Make sure those are changed into real footnote
2831 ;; definitions.
2838 missing-definitions)))
2841 "Install footnote definitions in tree.
2843 DEFINITIONS is the list of footnote definitions to install. TREE
2844 is the parse tree.
2846 If there is a footnote section in TREE, definitions found are
2847 appended to it. If `org-footnote-section' is non-nil, a new
2848 footnote section containing all definitions is inserted in TREE.
2849 Otherwise, definitions are appended at the end of the section
2850 containing their first reference."
2853 ;; If there is a footnote section, insert definitions there.
2857 nil t)))
2860 footnote-section
2862 ;; If there should be a footnote section, create one containing all
2863 ;; the definitions at the end of the tree.
2866 tree
2872 'section
2873 nil
2875 ;; Otherwise add each definition at the end of the section where it
2876 ;; is first referenced.
2881 ;; Insert footnote definitions in the same section as
2882 ;; their first reference in DATA.
2893 label)
2894 d))
2895 definitions)))
2898 definition)
2899 ;; Also insert definitions for nested
2900 ;; references, if any.
2905 "Change uninterpreted elements back into Org syntax.
2906 DATA is a parse tree or a secondary string. INFO is a plist
2907 containing export options. It is modified by side effect and
2908 returned by the function."
2911 subscript superscript underline)
2915 ;; ... entities...
2922 ?\s)))))
2923 ;; ... emphasis...
2935 marker
2939 ?\s)))))))
2940 ;; ... LaTeX environments and fragments...
2944 ;; ... sub/superscripts...
2953 "_"
2962 ?\s)))))))))))
2964 ;; Splice NEW at DATUM location in parse tree.
2967 info nil nil t)
2968 ;; Return modified parse tree.
2969 data)
2971 ;;;###autoload
2974 "Transcode current Org buffer into BACKEND code.
2976 BACKEND is either an export back-end, as returned by, e.g.,
2977 `org-export-create-backend', or a symbol referring to
2978 a registered back-end.
2980 If narrowing is active in the current buffer, only transcode its
2981 narrowed part.
2983 If a region is active, transcode that region.
2985 When optional argument SUBTREEP is non-nil, transcode the
2986 sub-tree at point, extracting information from the headline
2987 properties first.
2989 When optional argument VISIBLE-ONLY is non-nil, don't export
2990 contents of hidden elements.
2992 When optional argument BODY-ONLY is non-nil, only return body
2993 code, without surrounding template.
2995 Optional argument EXT-PLIST, when provided, is a property list
2996 with external parameters overriding Org default settings, but
2997 still inferior to file-local settings.
2999 Return code as a string."
3004 ;; Narrow buffer to an appropriate region or subtree for
3005 ;; parsing. If parsing subtree, be sure to remove main
3006 ;; headline, planning data and property drawer.
3014 ;; Initialize communication channel with original buffer
3015 ;; attributes, unavailable in its copy.
3019 backend subtreep visible-only body-only)
3025 org-export-options-alist))))
3026 tree)
3027 ;; Update communication channel and get parse tree. Buffer
3028 ;; isn't parsed directly. Instead, all buffer modifications
3029 ;; and consequent parsing are undertaken in a temporary copy.
3031 ;; Run first hook with current back-end's name as argument.
3034 ;; Include files, delete comments and expand macros.
3040 nil parsed-keywords)
3041 ;; Refresh buffer properties and radio targets after
3042 ;; potentially invasive previous changes. Likewise, do it
3043 ;; again after executing Babel code.
3050 ;; Run last hook with current back-end's name as argument.
3051 ;; Update buffer properties and radio targets one last time
3052 ;; before parsing.
3059 ;; Update communication channel with environment.
3063 ;; De-activate uninterpreted data from parsed keywords.
3065 org-export-options-alist))
3070 p
3073 ;; Install user's and developer's filters.
3075 ;; Call options filters and update export options. We do not
3076 ;; use `org-export-filter-apply-functions' here since the
3077 ;; arity of such filters is different.
3082 ;; Expand export-specific set of macros: {{{author}}},
3083 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
3084 ;; be done once regular macros have been expanded, since
3085 ;; parsed keywords may contain one of them.
3098 value)
3099 value)))
3103 'finalize
3104 parsed-keywords)
3105 ;; Parse buffer.
3107 ;; Prune tree from non-exported elements and transform
3108 ;; uninterpreted elements or objects in both parse tree and
3109 ;; communication channel.
3112 ;; Call parse tree filters.
3116 ;; Now tree is complete, compute its properties and add them
3117 ;; to communication channel.
3119 ;; Eventually transcode TREE. Wrap the resulting string into
3120 ;; a template.
3129 info))
3132 ;; Remove all text properties since they cannot be
3133 ;; retrieved from an external process. Finally call
3134 ;; final-output filter and return result.
3140 info))))))))
3142 ;;;###autoload
3144 "Transcode STRING into BACKEND code.
3146 BACKEND is either an export back-end, as returned by, e.g.,
3147 `org-export-create-backend', or a symbol referring to
3148 a registered back-end.
3150 When optional argument BODY-ONLY is non-nil, only return body
3151 code, without preamble nor postamble.
3153 Optional argument EXT-PLIST, when provided, is a property list
3154 with external parameters overriding Org default settings, but
3155 still inferior to file-local settings.
3157 Return code as a string."
3163 ;;;###autoload
3165 "Replace the active region by its export to BACKEND.
3166 BACKEND is either an export back-end, as returned by, e.g.,
3167 `org-export-create-backend', or a symbol referring to
3168 a registered back-end."
3174 ;;;###autoload
3176 "Insert all export keywords with default values at beginning of line.
3178 BACKEND is a symbol referring to the name of a registered export
3179 back-end, for which specific export options should be added to
3180 the template, or `default' for default template. When it is nil,
3181 the user will be prompted for a category.
3183 If SUBTREEP is non-nil, export configuration will be set up
3184 locally for the subtree through node properties."
3194 "Options category: "
3198 org-export-registered-backends))
3199 nil t))))
3200 options keywords)
3201 ;; Populate OPTIONS and KEYWORDS.
3218 ;; Move to an appropriate location in order to insert options.
3220 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3238 ;; Then the rest of keywords, in the order specified in either
3239 ;; `org-export-options-alist' or respective export back-ends.
3260 "Expand every include keyword in buffer.
3261 Optional argument INCLUDED is a list of included file names along
3262 with their line restriction, when appropriate. It is used to
3263 avoid infinite recursion. Optional argument DIR is the current
3264 working directory. It is used to properly resolve relative
3265 paths. Optional argument FOOTNOTES is a hash-table used for
3266 storing and resolving footnotes. It is created automatically."
3272 ;; If :minlevel is not set the text-property
3273 ;; `:org-include-induced-level' will be used to determine the
3274 ;; relative level when expanding INCLUDE.
3275 ;; Only affects included Org documents.
3279 :org-include-induced-level
3281 ;; Expand INCLUDE keywords.
3287 ;; Extract arguments from keyword's value.
3290 location
3298 matched)
3304 dir)))
3308 value)
3314 value)
3323 ;; Minimal level of included file defaults to the child
3324 ;; level of the current headline, if any, or one. It
3325 ;; only applies is the file is meant to be included as
3326 ;; an Org one.
3337 ;; Remove keyword.
3343 ;; Check if files has already been parsed. Look after
3344 ;; inclusion lines too, as different parts of the same file
3345 ;; can be included too.
3358 ind-str block arg-str contents ind-str block))))
3365 ind-str block contents ind-str block))))
3373 file location only-contents lines)
3374 lines)))
3378 file lines ind minlevel
3381 footnotes)))
3385 footnotes)
3387 ;; Expand footnotes after all files have been included.
3388 ;; Footnotes are stored at end of buffer.
3393 footnotes)))))))))))
3396 "Resolve absolute lines for an included file with file-link.
3398 FILE is string file-name of the file to include. LOCATION is a
3399 string name within FILE to be included (located via
3400 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3401 contents of the named element will be included, as determined
3402 Org-Element. If LINES is non-nil only those lines are included.
3404 Return a string of lines to be included in the format expected by
3405 `org-export--prepare-file-contents'."
3411 ;; Enforce consistent search.
3424 ;; Skip planning line and property-drawer.
3450 start-line
3452 (+ start-line
3455 counter))))))))
3459 "Prepare contents of FILE for inclusion and return it as a string.
3461 When optional argument LINES is a string specifying a range of
3462 lines, include only those lines.
3464 Optional argument IND, when non-nil, is an integer specifying the
3465 global indentation of returned contents. Since its purpose is to
3466 allow an included file to stay in the same environment it was
3467 created (e.g., a list item), it doesn't apply past the first
3468 headline encountered.
3470 Optional argument MINLEVEL, when non-nil, is an integer
3471 specifying the level that any top-level headline in the included
3472 file should have.
3474 Optional argument ID is an integer that will be inserted before
3475 each footnote definition and reference if FILE is an Org file.
3476 This is useful to avoid conflicts when more than one Org file
3477 with footnotes is included in a document.
3479 Optional argument FOOTNOTES is a hash-table to store footnotes in
3480 the included document."
3496 ;; Remove blank lines at beginning and end of contents. The logic
3497 ;; behind that removal is that blank lines around include keyword
3498 ;; override blank lines in included file.
3507 ;; If IND is set, preserve indentation of include keyword until
3508 ;; the first headline encountered.
3515 ;; Do not move footnote definitions out of column 0.
3521 ;; When MINLEVEL is specified, compute minimal level for headlines
3522 ;; in the file (CUR-MIN), and remove stars to each headline so
3523 ;; that headlines with minimal level have a level of MINLEVEL.
3534 ;; Only change stars, don't bother moving whole
3535 ;; sections.
3540 ;; Append ID to all footnote references and definitions, so they
3541 ;; become file specific and cannot collide with footnotes in other
3542 ;; included files. Further, collect relevant footnote definitions
3543 ;; outside of LINES, in order to reintroduce them later.
3549 ;; Generate new label from LABEL by prefixing it with
3550 ;; "-ID-".
3554 ;; Replace OLD label with NEW in footnote F.
3568 ;; Update the footnote-reference at point and collect
3569 ;; the new label, which is only used for footnotes
3570 ;; outsides LINES.
3582 ;; Store since footnote-definition is
3583 ;; outside of LINES.
3586 footnotes))))
3593 "Return a non-nil value when output should be added to the kill ring.
3594 See also `org-export-copy-to-kill-ring'."
3600 \f
3601 ;;; Tools For Back-Ends
3602 ;;
3603 ;; A whole set of tools is available to help build new exporters. Any
3604 ;; function general enough to have its use across many back-ends
3605 ;; should be added here.
3607 ;;;; For Affiliated Keywords
3608 ;;
3609 ;; `org-export-read-attribute' reads a property from a given element
3610 ;; as a plist. It can be used to normalize affiliated keywords'
3611 ;; syntax.
3612 ;;
3613 ;; Since captions can span over multiple lines and accept dual values,
3614 ;; their internal representation is a bit tricky. Therefore,
3615 ;; `org-export-get-caption' transparently returns a given element's
3616 ;; caption as a secondary string.
3619 "Turn ATTRIBUTE property from ELEMENT into a plist.
3621 When optional argument PROPERTY is non-nil, return the value of
3622 that property within attributes.
3626 properties.
3628 All values will become strings except the empty string and
3631 will become the empty string."
3645 s)
3650 ;; Ignore any string before first property with `cdr'.
3655 "Return caption from ELEMENT as a secondary string.
3657 When optional argument SHORTP is non-nil, return short caption,
3658 as a secondary string, instead.
3660 Caption lines are separated by a white space."
3668 ;;;; For Derived Back-ends
3669 ;;
3670 ;; `org-export-with-backend' is a function allowing to locally use
3671 ;; another back-end to transcode some object or element. In a derived
3672 ;; back-end, it may be used as a fall-back function once all specific
3673 ;; cases have been treated.
3676 "Call a transcoder from BACKEND on DATA.
3677 BACKEND is an export back-end, as returned by, e.g.,
3678 `org-export-create-backend', or a symbol referring to
3679 a registered back-end. DATA is an Org element, object, secondary
3680 string or string. CONTENTS, when non-nil, is the transcoded
3681 contents of DATA element, as a string. INFO, when non-nil, is
3682 the communication channel used for export, as a plist."
3693 :back-end backend
3694 :translate-alist all-transcoders
3696 ;; `:internal-references' are shared across back-ends.
3702 ;;;; For Export Snippets
3703 ;;
3704 ;; Every export snippet is transmitted to the back-end. Though, the
3705 ;; latter will only retain one type of export-snippet, ignoring
3706 ;; others, based on the former's target back-end. The function
3707 ;; `org-export-snippet-backend' returns that back-end for a given
3708 ;; export-snippet.
3711 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3712 Translation, with `org-export-snippet-translation-alist', is
3713 applied."
3717 back-end))))
3720 ;;;; For Footnotes
3721 ;;
3722 ;; `org-export-collect-footnote-definitions' is a tool to list
3723 ;; actually used footnotes definitions in the whole parse tree, or in
3724 ;; a headline, in order to add footnote listings throughout the
3725 ;; transcoded data.
3726 ;;
3727 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3728 ;; back-ends, when they need to attach the footnote definition only to
3729 ;; the first occurrence of the corresponding label.
3730 ;;
3731 ;; `org-export-get-footnote-definition' and
3732 ;; `org-export-get-footnote-number' provide easier access to
3733 ;; additional information relative to a footnote reference.
3736 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3737 INFO is the plist used as a communication channel. If no such
3738 definition can be found, raise an error."
3744 hash))))
3752 ;; Skip any footnote with a different label.
3753 ;; Also skip any standard footnote reference
3754 ;; with the same label since those cannot
3755 ;; contain a definition.
3759 ;; Even if the contents are empty, we can not
3760 ;; return nil since that would eventually raise
3761 ;; the error. Instead, return the equivalent
3762 ;; empty string.
3764 info t)
3765 cache)
3770 "Apply FUNCTION on every footnote reference in DATA.
3771 INFO is a plist containing export state. By default, as soon as
3772 a new footnote reference is encountered, FUNCTION is called onto
3773 its definition. However, if BODY-FIRST is non-nil, this step is
3774 delayed until the end of the process."
3779 ;; Search footnote references through DATA, filling
3780 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3781 ;; store footnote definitions so they can be entered
3782 ;; later.
3789 ;; Search for subsequent references in footnote
3790 ;; definition so numbering follows reading
3791 ;; logic, unless DELAYP in non-nil.
3795 definitions))
3796 ;; Do not force entering inline definitions,
3797 ;; since `org-element-map' already traverses
3798 ;; them at the right time.
3802 nil))))))
3803 info nil
3804 ;; Don't enter footnote definitions since it will
3805 ;; happen when their first reference is found.
3806 ;; Moreover, if DELAYP is non-nil, make sure we
3807 ;; postpone entering definitions of inline references.
3814 "Return an alist between footnote numbers, labels and definitions.
3816 INFO is the current export state, as a plist.
3818 Definitions are collected throughout the whole parse tree, or
3819 DATA when non-nil.
3821 Sorting is done by order of references. As soon as a new
3822 reference is encountered, other references are searched within
3823 its definition. However, if BODY-FIRST is non-nil, this step is
3824 delayed after the whole tree is checked. This alters results
3825 when references are found in footnote definitions.
3827 Definitions either appear as Org data or as a secondary string
3828 for inlined footnotes. Unreferenced definitions are ignored."
3832 ;; Collect footnote number, label and definition.
3843 "Non-nil when a footnote reference is the first one for its label.
3845 FOOTNOTE-REFERENCE is the footnote reference being considered.
3846 INFO is a plist containing current export state.
3848 Search is done throughout the whole parse tree, or DATA when
3849 non-nil.
3851 By default, as soon as a new footnote reference is encountered,
3852 other references are searched within its definition. However, if
3853 BODY-FIRST is non-nil, this step is delayed after the whole tree
3854 is checked. This alters results when references are found in
3855 footnote definitions."
3857 ;; Anonymous footnotes are always a first reference.
3868 "Return number associated to a footnote.
3870 FOOTNOTE is either a footnote reference or a footnote definition.
3871 INFO is the plist containing export state.
3873 Number is unique throughout the whole parse tree, or DATA, when
3874 non-nil.
3876 By default, as soon as a new footnote reference is encountered,
3877 counting process moves into its definition. However, if
3878 BODY-FIRST is non-nil, this step is delayed until the end of the
3879 process, leading to a different order when footnotes are nested."
3888 ;; Anonymous footnote match: return number.
3890 ;; Labels match: return number.
3892 ;; Otherwise store label and increase counter if label
3893 ;; wasn't encountered yet.
3899 ;;;; For Headlines
3900 ;;
3901 ;; `org-export-get-relative-level' is a shortcut to get headline
3902 ;; level, relatively to the lower headline level in the parsed tree.
3903 ;;
3904 ;; `org-export-get-headline-number' returns the section number of an
3905 ;; headline, while `org-export-number-to-roman' allows it to be
3906 ;; converted to roman numbers. With an optional argument,
3907 ;; `org-export-get-headline-number' returns a number to unnumbered
3908 ;; headlines (used for internal id).
3909 ;;
3910 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3911 ;; `org-export-last-sibling-p' are three useful predicates when it
3912 ;; comes to fulfill the `:headline-levels' property.
3913 ;;
3914 ;; `org-export-get-tags', `org-export-get-category' and
3915 ;; `org-export-get-node-property' extract useful information from an
3916 ;; headline or a parent headline. They all handle inheritance.
3917 ;;
3918 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3919 ;; as a secondary string, suitable for table of contents. It falls
3920 ;; back onto default title.
3923 "Return HEADLINE relative level within current parsed tree.
3924 INFO is a plist holding contextual information."
3929 "Non-nil when HEADLINE is considered as low level.
3931 INFO is a plist used as a communication channel.
3933 A low level headlines has a relative level greater than
3934 `:headline-levels' property value.
3936 Return value is the difference between HEADLINE relative level
3937 and the last level being considered as high enough, or nil."
3944 "Return numbered HEADLINE numbering as a list of numbers.
3945 INFO is a plist holding contextual information."
3950 "Return a non-nil value if HEADLINE element should be numbered.
3951 INFO is a plist used as a communication channel."
3960 "Convert integer N into a roman numeral."
3973 res)))
3976 "Return list of tags associated to ELEMENT.
3978 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3979 is a plist used as a communication channel.
3981 When non-nil, optional argument TAGS should be a list of strings.
3982 Any tag belonging to this list will also be removed.
3984 When optional argument INHERITED is non-nil, tags can also be
3985 inherited from parent headlines and FILETAGS keywords."
3989 ;; Build complete list of inherited tags.
3996 ;; Add FILETAGS keywords and return results.
4000 "Return node PROPERTY value for BLOB.
4002 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
4003 element or object.
4005 If optional argument INHERITED is non-nil, the value can be
4006 inherited from a parent headline.
4008 Return value is a string or nil."
4020 "Return category for element or object BLOB.
4022 INFO is a plist used as a communication channel.
4024 CATEGORY is automatically inherited from a parent headline, from
4025 #+CATEGORY: keyword or created out of original file name. If all
4038 "Return alternative title for HEADLINE, as a secondary string.
4039 If no optional title is defined, fall-back to the regular title."
4046 "Non-nil when BLOB is the first sibling in its parent.
4047 BLOB is an element or an object. If BLOB is a headline, non-nil
4048 means it is the first sibling in the sub-tree. INFO is a plist
4049 used as a communication channel."
4054 "Non-nil when BLOB is the last sibling in its parent.
4055 BLOB is an element or an object. INFO is a plist used as
4056 a communication channel."
4060 ;;;; For Keywords
4061 ;;
4062 ;; `org-export-get-date' returns a date appropriate for the document
4063 ;; to about to be exported. In particular, it takes care of
4064 ;; `org-export-date-timestamp-format'.
4067 "Return date value for the current document.
4069 INFO is a plist used as a communication channel. FMT, when
4070 non-nil, is a time format string that will be applied on the date
4071 if it consists in a single timestamp object. It defaults to
4072 `org-export-date-timestamp-format' when nil.
4074 A proper date can be a secondary string, a string or nil. It is
4075 meant to be translated with `org-export-data' or alike."
4086 ;;;; For Links
4087 ;;
4088 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4089 ;; in `org-link-parameters'.
4090 ;;
4091 ;; `org-export-get-coderef-format' returns an appropriate format
4092 ;; string for coderefs.
4093 ;;
4094 ;; `org-export-inline-image-p' returns a non-nil value when the link
4095 ;; provided should be considered as an inline image.
4096 ;;
4097 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4098 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4099 ;; returns an appropriate unique identifier.
4100 ;;
4101 ;; `org-export-resolve-id-link' returns the first headline with
4102 ;; specified id or custom-id in parse tree, the path to the external
4103 ;; file with the id.
4104 ;;
4105 ;; `org-export-resolve-coderef' associates a reference to a line
4106 ;; number in the element it belongs, or returns the reference itself
4107 ;; when the element isn't numbered.
4108 ;;
4109 ;; `org-export-file-uri' expands a filename as stored in :path value
4110 ;; of a "file" link into a file URI.
4111 ;;
4112 ;; Broken links raise a `org-link-broken' error, which is caught by
4113 ;; `org-export-data' for further processing, depending on
4114 ;; `org-export-with-broken-links' value.
4119 "Try exporting LINK with a dedicated function.
4121 DESC is its description, as a string, or nil. BACKEND is the
4122 back-end used for export, as a symbol.
4124 Return output as a string, or nil if no protocol handles LINK.
4126 A custom protocol has precedence over regular back-end export.
4127 The function ignores links with an implicit type (e.g.,
4136 desc
4137 backend))))))
4140 "Return format string for code reference link.
4141 PATH is the link path. DESC is its description."
4149 "Non-nil if LINK object points to an inline image.
4151 Optional argument is a set of RULES defining inline images. It
4152 is an alist where associations have the following shape:
4154 (TYPE . REGEXP)
4156 Applying a rule means apply REGEXP against LINK's path when its
4157 type is TYPE. The function will return a non-nil value if any of
4158 the provided rules is non-nil. The default rule is
4159 `org-export-default-inline-image-rule'.
4161 This only applies to links without a description."
4171 "Insert image links in DATA.
4173 Org syntax does not support nested links. Nevertheless, some
4174 export back-ends support images as descriptions of links. Since
4175 images are really links to image files, we need to make an
4176 exception about links nesting.
4178 This function recognizes links whose contents are really images
4179 and turn them into proper nested links. It is meant to be used
4180 as a parse tree filter in back-ends supporting such constructs.
4182 DATA is a parse tree. INFO is the current state of the export
4183 process, as a plist.
4185 A description is a valid images if it matches any rule in RULES,
4186 if non-nil, or `org-export-default-inline-image-rule' otherwise.
4187 See `org-export-inline-image-p' for more information about the
4188 structure of RULES.
4190 Return modified DATA."
4192 org-plain-link-re
4193 org-angle-link-re))
4206 ;; Replace contents with image link.
4212 info nil nil t))
4213 data)
4216 "Resolve a code reference REF.
4218 INFO is a plist used as a communication channel.
4220 Return associated line number in source code, or REF itself,
4221 depending on src-block or example element's switches. Throw an
4222 error if no block contains REF."
4228 org-coderef-label-format))
4230 ;; Element containing REF is found. Resolve it to
4231 ;; either a label or a line number, as needed.
4240 "List search cells for element or object DATUM.
4242 A search cell follows the pattern (TYPE . SEARCH) where
4244 TYPE is a symbol among `headline', `custom-id', `target' and
4245 `other'.
4247 SEARCH is the string a link is expected to match. More
4248 accurately, it is
4250 - headline's title, as a list of strings, if TYPE is
4251 `headline'.
4253 - CUSTOM_ID value, as a string, if TYPE is `custom-id'.
4255 - target's or radio-target's name as a list of strings if
4256 TYPE is `target'.
4258 - NAME affiliated keyword is TYPE is `other'.
4260 A search cell is the internal representation of a fuzzy link. It
4261 ignores white spaces and statistics cookies, if applicable."
4263 (`headline
4274 (`target
4282 "Return search cells associated to string S.
4283 S is either the path of a fuzzy link or a search option, i.e., it
4284 tries to match either a headline (through custom ID or title),
4285 a target or a named element."
4293 "Non-nil when DATUM matches search cells CELLS.
4294 DATUM is an element or object. CELLS is a list of search cells,
4295 as returned by `org-export-search-cells'."
4300 "Return LINK destination.
4302 INFO is a plist holding contextual information.
4304 Return value can be an object or an element:
4306 - If LINK path matches a target object (i.e. <<path>>) return it.
4308 - If LINK path exactly matches the name affiliated keyword
4309 (i.e. #+NAME: path) of an element, return that element.
4311 - If LINK path exactly matches any headline name, return that
4312 element.
4314 - Otherwise, throw an error.
4317 significant."
4323 table)))
4331 datum)))))
4335 search-cells
4336 ;; There can be multiple matches for un-typed searches, i.e.,
4337 ;; for searches not starting with # or *. In this case,
4338 ;; prioritize targets and names over headline titles.
4339 ;; Matching both a name and a target is not valid, and
4340 ;; therefore undefined.
4343 datum))
4344 matches)
4346 link-cache)))))
4349 "Return headline referenced as LINK destination.
4351 INFO is a plist used as a communication channel.
4353 Return value can be the headline element matched in current parse
4357 ;; First check if id is within the current parse tree.
4362 headline))
4364 ;; Otherwise, look for external files.
4369 "Return radio-target object referenced as LINK destination.
4371 INFO is a plist used as a communication channel.
4373 Return value can be a radio-target object or nil. Assume LINK
4382 nil nil path nil nil t)
4383 t)
4384 radio))
4388 "Return file URI associated to FILENAME."
4395 fullname)))))
4397 ;;;; For References
4398 ;;
4399 ;; `org-export-get-reference' associate a unique reference for any
4400 ;; object or element. It uses `org-export-new-reference' and
4401 ;; `org-export-format-reference' to, respectively, generate new
4402 ;; internal references and turn them into a string suitable for
4403 ;; output.
4404 ;;
4405 ;; `org-export-get-ordinal' associates a sequence number to any object
4406 ;; or element.
4409 "Return a unique reference, among REFERENCES.
4410 REFERENCES is an alist whose values are in-use references, as
4411 numbers. Returns a number, which is the internal representation
4412 of a reference. See also `org-export-format-reference'."
4413 ;; Generate random 7 digits hexadecimal numbers. Collisions
4414 ;; increase exponentially with the numbers of references. However,
4415 ;; the odds for encountering at least one collision with 1000 active
4416 ;; references in the same document are roughly 0.2%, so this
4417 ;; shouldn't be the bottleneck.
4420 new))
4423 "Format REFERENCE into a string.
4424 REFERENCE is a number representing a reference, as returned by
4425 `org-export-new-reference', which see."
4429 "Return a unique reference for DATUM, as a string.
4431 DATUM is either an element or an object. INFO is the current
4432 export state, as a plist.
4434 This function checks `:crossrefs' property in INFO for search
4435 cells matching DATUM before creating a new reference. Returned
4436 reference consists of alphanumeric characters only."
4441 ;; Preserve any pre-existing association between
4442 ;; a search cell and a reference, i.e., when some
4443 ;; previously published document referenced a location
4444 ;; within current file (see
4445 ;; `org-publish-resolve-external-link').
4446 ;;
4447 ;; However, there is no guarantee that search cells are
4448 ;; unique, e.g., there might be duplicate custom ID or
4449 ;; two headings with the same title in the file.
4450 ;;
4451 ;; As a consequence, before re-using any reference to
4452 ;; an element or object, we check that it doesn't refer
4453 ;; to a previous element or object.
4460 cells)
4463 ;; Cache contains both data already associated to
4464 ;; a reference and in-use internal references, so as to make
4465 ;; unique references.
4467 ;; Retain a direct association between reference string and
4468 ;; DATUM since (1) not every object or element can be given
4469 ;; a search cell (2) it permits quick lookup.
4472 reference-string))))
4475 "Return ordinal number of an element or object.
4477 ELEMENT is the element or object considered. INFO is the plist
4478 used as a communication channel.
4480 Optional argument TYPES, when non-nil, is a list of element or
4481 object types, as symbols, that should also be counted in.
4482 Otherwise, only provided element's type is considered.
4484 Optional argument PREDICATE is a function returning a non-nil
4485 value if the current element or object should be counted in. It
4486 accepts two arguments: the element or object being considered and
4487 the plist used as a communication channel. This allows counting
4488 only a certain type of object (i.e. inline images).
4490 Return value is a list of numbers if ELEMENT is a headline or an
4491 item. It is nil for keywords. It represents the footnote number
4492 for footnote definitions and footnote references. If ELEMENT is
4493 a target, return the same value as if ELEMENT was the closest
4494 table, item or headline containing the target. In any other
4495 case, return the sequence number of ELEMENT among elements or
4496 objects of the same type."
4497 ;; Ordinal of a target object refer to the ordinal of the closest
4498 ;; table, item, or headline containing the object.
4502 element
4505 ;; Special case 1: A headline returns its number as a list.
4507 ;; Special case 2: An item returns its number as a list.
4511 struct
4518 ;; Increment counter until ELEMENT is found again.
4529 ;;;; For Src-Blocks
4530 ;;
4531 ;; `org-export-get-loc' counts number of code lines accumulated in
4532 ;; src-block or example-block elements with a "+n" switch until
4533 ;; a given element, excluded. Note: "-n" switches reset that count.
4534 ;;
4535 ;; `org-export-unravel-code' extracts source code (along with a code
4536 ;; references alist) from an `element-block' or `src-block' type
4537 ;; element.
4538 ;;
4539 ;; `org-export-format-code' applies a formatting function to each line
4540 ;; of code, providing relative line number and code reference when
4541 ;; appropriate. Since it doesn't access the original element from
4542 ;; which the source code is coming, it expects from the code calling
4543 ;; it to know if lines should be numbered and if code references
4544 ;; should appear.
4545 ;;
4546 ;; Eventually, `org-export-format-code-default' is a higher-level
4547 ;; function (it makes use of the two previous functions) which handles
4548 ;; line numbering and code references inclusion, and returns source
4549 ;; code in a format suitable for plain text or verbatim output.
4552 "Return count of lines of code before ELEMENT.
4554 ELEMENT is an example-block or src-block element. INFO is the
4555 plist used as a communication channel.
4557 Count includes every line of code in example-block or src-block
4559 ELEMENT doesn't allow line numbering."
4566 ;; ELEMENT is reached: Quit loop and return locs.
4568 ;; Only count lines from src-block and example-block
4569 ;; elements with a "+n" or "-n" switch.
4574 ;; Accumulate locs or reset them.
4582 "Clean source code and extract references out of it.
4584 ELEMENT has either a `src-block' an `example-block' type.
4586 Return a cons cell whose CAR is the source code, cleaned from any
4587 reference, protective commas and spurious indentation, and CDR is
4588 an alist between relative line number (integer) and name of code
4589 reference on that line (string)."
4592 ;; Get code and clean it. Remove blank lines at its
4593 ;; beginning and end.
4600 value
4602 ;; Build a regexp matching a loc with a reference.
4604 ;; Return value.
4606 ;; Code with references removed.
4612 ;; Ref line: remove ref, and signal its position in REFS.
4616 ;; Reference alist.
4617 refs)))
4620 "Format CODE by applying FUN line-wise and return it.
4622 CODE is a string representing the code to format. FUN is
4623 a function. It must accept three arguments: a line of
4624 code (string), the current line number (integer) or nil and the
4625 reference associated to the current line (string) or nil.
4627 Optional argument NUM-LINES can be an integer representing the
4628 number of code lines accumulated until the current code. Line
4629 numbers passed to FUN will take it into account. If it is nil,
4630 FUN's second argument will always be nil. This number can be
4631 obtained with `org-export-get-loc' function.
4633 Optional argument REF-ALIST can be an alist between relative line
4634 number (i.e. ignoring NUM-LINES) and the name of the code
4635 reference on it. If it is nil, FUN's third argument will always
4636 be nil. It can be obtained through the use of
4637 `org-export-unravel-code' function."
4649 "Return source code from ELEMENT, formatted in a standard way.
4651 ELEMENT is either a `src-block' or `example-block' element. INFO
4652 is a plist used as a communication channel.
4654 This function takes care of line numbering and code references
4655 inclusion. Line numbers, when applicable, appear at the
4656 beginning of the line, separated from the code by two white
4657 spaces. Code references, on the other hand, appear flushed to
4658 the right, separated by six white spaces from the widest line of
4659 code."
4660 ;; Extract code and references.
4667 ;; Handle line numbering.
4674 ;; Prepare references display, if required. Any reference
4675 ;; should start six columns after the widest line of code,
4676 ;; wrapped with parenthesis.
4681 code
4685 number-str
4686 loc
4692 num-start refs)))))
4695 ;;;; For Tables
4696 ;;
4697 ;; `org-export-table-has-special-column-p' and and
4698 ;; `org-export-table-row-is-special-p' are predicates used to look for
4699 ;; meta-information about the table structure.
4700 ;;
4701 ;; `org-table-has-header-p' tells when the rows before the first rule
4702 ;; should be considered as table's header.
4703 ;;
4704 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4705 ;; and `org-export-table-cell-borders' extract information from
4706 ;; a table-cell element.
4707 ;;
4708 ;; `org-export-table-dimensions' gives the number on rows and columns
4709 ;; in the table, ignoring horizontal rules and special columns.
4710 ;; `org-export-table-cell-address', given a table-cell object, returns
4711 ;; the absolute address of a cell. On the other hand,
4712 ;; `org-export-get-table-cell-at' does the contrary.
4713 ;;
4714 ;; `org-export-table-cell-starts-colgroup-p',
4715 ;; `org-export-table-cell-ends-colgroup-p',
4716 ;; `org-export-table-row-starts-rowgroup-p',
4717 ;; `org-export-table-row-ends-rowgroup-p',
4718 ;; `org-export-table-row-starts-header-p',
4719 ;; `org-export-table-row-ends-header-p' and
4720 ;; `org-export-table-row-in-header-p' indicate position of current row
4721 ;; or cell within the table.
4724 "Non-nil when TABLE has a special column.
4725 All special columns will be ignored during export."
4726 ;; The table has a special column when every first cell of every row
4727 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4728 ;; "*" "_" and "^". Though, do not consider a first column
4729 ;; containing only empty cells as special.
4744 "Non-nil when TABLE has a header.
4746 INFO is a plist used as a communication channel.
4748 A table has a header when it contains at least two row groups."
4752 table)))
4768 nil)))
4770 cache)))))
4773 "Non-nil if TABLE-ROW is considered special.
4774 All special rows will be ignored during export."
4778 ;; A row is special either when...
4780 ;; ... it starts with a field only containing "/",
4782 ;; ... the table contains a special column and the row start
4783 ;; with a marking character among, "^", "_", "$" or "!",
4787 ;; ... it contains only alignment cookies and empty cells.
4792 ;; Since VALUE is a secondary string, the following
4793 ;; checks avoid expanding it with `org-export-data'.
4804 "Return TABLE-ROW's group number, as an integer.
4806 INFO is a plist used as the communication channel.
4808 Return value is the group number, as an integer, or nil for
4809 special rows and rows separators. First group is also table's
4810 header."
4815 table)))
4818 ;; First time a row is queried, populate cache with all the
4819 ;; rows from the table.
4827 info))
4831 "Return TABLE-CELL contents width.
4833 INFO is a plist used as the communication channel.
4835 Return value is the width given by the last width cookie in the
4836 same column as TABLE-CELL, or nil."
4845 table)))
4854 ;; In a special row, try to find a width cookie at COLUMN.
4858 ;; The following checks avoid expanding unnecessarily
4859 ;; the cell with `org-export-data'.
4869 "Return TABLE-CELL contents alignment.
4871 INFO is a plist used as the communication channel.
4873 Return alignment as specified by the last alignment cookie in the
4874 same column as TABLE-CELL. If no such cookie is found, a default
4875 alignment value will be deduced from fraction of numbers in the
4876 column (see `org-table-number-fraction' for more information).
4877 Possible values are `left', `right' and `center'."
4878 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4888 table)))
4894 cookie-align
4895 previous-cell-number-p)
4898 ;; In a special row, try to find an alignment cookie at
4899 ;; COLUMN.
4903 ;; Since VALUE is a secondary string, the following
4904 ;; checks avoid useless expansion through
4905 ;; `org-export-data'.
4913 ;; Ignore table rules.
4915 ;; In a standard row, check if cell's contents are
4916 ;; expressing some kind of number. Increase NUMBER-CELLS
4917 ;; accordingly. Though, don't bother if an alignment
4918 ;; cookie has already defined cell's alignment.
4923 info)))
4925 ;; Treat an empty cell as a number if it follows
4926 ;; a number.
4932 ;; Return value. Alignment specified by cookies has
4933 ;; precedence over alignment deduced from cell's contents.
4935 column
4940 org-table-number-fraction)
4945 "Return TABLE-CELL borders.
4947 INFO is a plist used as a communication channel.
4949 Return value is a list of symbols, or nil. Possible values are:
4950 `top', `bottom', `above', `below', `left' and `right'. Note:
4951 `top' (resp. `bottom') only happen for a cell in the first
4952 row (resp. last row) of the table, ignoring table rules, if any.
4954 Returned borders ignore special rows."
4957 borders)
4958 ;; Top/above border? TABLE-CELL has a border above when a rule
4959 ;; used to demarcate row groups can be found above. Hence,
4960 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4961 ;; another regular row has to be found above that rule.
4964 ;; Look at every row before the current one.
4971 ;; No rule above, or rule found starts the table (ignoring any
4972 ;; special row): TABLE-CELL is at the top of the table.
4975 ;; Bottom/below border? TABLE-CELL has a border below when next
4976 ;; non-regular row below is a rule.
4979 ;; Look at every row after the current one.
4986 ;; No rule below, or rule found ends the table (modulo some
4987 ;; special row): TABLE-CELL is at the bottom of the table.
4990 ;; Right/left borders? They can only be specified by column
4991 ;; groups. Column groups are defined in a row starting with "/".
4992 ;; Also a column groups row only contains "<", "<>", ">" or blank
4993 ;; cells.
4997 ;; Table rows are read in reverse order so last column groups
4998 ;; row has precedence over any previous one.
5011 ;; There's a left border when previous cell, if
5012 ;; any, ends a group, or current one starts one.
5018 ;; There's a right border when next cell, if any,
5019 ;; starts a group, or current one ends one.
5026 ;; Return value.
5027 borders))
5030 "Non-nil when TABLE-CELL is at the beginning of a column group.
5031 INFO is a plist used as a communication channel."
5032 ;; A cell starts a column group either when it is at the beginning
5033 ;; of a row (or after the special column, if any) or when it has
5034 ;; a left border.
5037 table-cell)
5041 "Non-nil when TABLE-CELL is at the end of a column group.
5042 INFO is a plist used as a communication channel."
5043 ;; A cell ends a column group either when it is at the end of a row
5044 ;; or when it has a right border.
5047 table-cell)
5051 "Non-nil when TABLE-ROW is at the beginning of a row group.
5052 INFO is a plist used as a communication channel."
5060 "Non-nil when TABLE-ROW is at the end of a row group.
5061 INFO is a plist used as a communication channel."
5069 "Non-nil when TABLE-ROW is located within table's header.
5070 INFO is a plist used as a communication channel. Always return
5071 nil for special rows and rows separators."
5077 "Non-nil when TABLE-ROW is the first table header's row.
5078 INFO is a plist used as a communication channel."
5083 "Non-nil when TABLE-ROW is the last table header's row.
5084 INFO is a plist used as a communication channel."
5089 "Return TABLE-ROW number.
5090 INFO is a plist used as a communication channel. Return value is
5091 zero-indexed and ignores separators. The function returns nil
5092 for special rows and separators."
5097 table)))
5100 ;; First time a row is queried, populate cache with all the
5101 ;; rows from the table.
5107 info))
5111 "Return TABLE dimensions.
5113 INFO is a plist used as a communication channel.
5115 Return value is a CONS like (ROWS . COLUMNS) where
5116 ROWS (resp. COLUMNS) is the number of exportable
5117 rows (resp. columns)."
5119 ;; Set number of rows, and extract first one.
5125 ;; Set number of columns.
5127 ;; Return value.
5131 "Return address of a regular TABLE-CELL object.
5133 TABLE-CELL is the cell considered. INFO is a plist used as
5134 a communication channel.
5136 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5137 zero-based index. Only exportable cells are considered. The
5138 function returns nil for other cells."
5150 "Return regular table-cell object at ADDRESS in TABLE.
5152 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5153 zero-based index. TABLE is a table type element. INFO is
5154 a plist used as a communication channel.
5156 If no table-cell, among exportable cells, is found at ADDRESS,
5157 return nil."
5160 ;; Row at (car address) or nil.
5168 'table-cell
5175 ;;;; For Tables Of Contents
5176 ;;
5177 ;; `org-export-collect-headlines' builds a list of all exportable
5178 ;; headline elements, maybe limited to a certain depth. One can then
5179 ;; easily parse it and transcode it.
5180 ;;
5181 ;; Building lists of tables, figures or listings is quite similar.
5182 ;; Once the generic function `org-export-collect-elements' is defined,
5183 ;; `org-export-collect-tables', `org-export-collect-figures' and
5184 ;; `org-export-collect-listings' can be derived from it.
5187 "Collect headlines in order to build a table of contents.
5189 INFO is a plist used as a communication channel.
5191 When optional argument N is an integer, it specifies the depth of
5192 the table of contents. Otherwise, it is set to the value of the
5193 last headline level. See `org-export-headline-levels' for more
5194 information.
5196 Optional argument SCOPE, when non-nil, is an element. If it is
5197 a headline, only children of SCOPE are collected. Otherwise,
5198 collect children of the headline containing provided element. If
5199 there is no such headline, collect all headlines. In any case,
5200 argument N becomes relative to the level of that headline.
5202 Return a list of all exportable headlines as parsed elements.
5203 Footnote sections are ignored."
5212 limit))))
5218 info)))
5221 "Collect referenceable elements of a determined type.
5223 TYPE can be a symbol or a list of symbols specifying element
5224 types to search. Only elements with a caption are collected.
5226 INFO is a plist used as a communication channel.
5228 When non-nil, optional argument PREDICATE is a function accepting
5229 one argument, an element of type TYPE. It returns a non-nil
5230 value when that element should be collected.
5232 Return a list of all elements found, in order of appearance."
5237 element))
5238 info))
5241 "Build a list of tables.
5242 INFO is a plist used as a communication channel.
5244 Return a list of table elements with a caption."
5248 "Build a list of figures.
5250 INFO is a plist used as a communication channel. PREDICATE is
5251 a function which accepts one argument: a paragraph element and
5252 whose return value is non-nil when that element should be
5253 collected.
5255 A figure is a paragraph type element, with a caption, verifying
5257 a vague concept that may depend on back-end.
5259 Return a list of elements recognized as figures."
5263 "Build a list of src blocks.
5265 INFO is a plist used as a communication channel.
5267 Return a list of src-block elements with a caption."
5271 ;;;; Smart Quotes
5272 ;;
5273 ;; The main function for the smart quotes sub-system is
5274 ;; `org-export-activate-smart-quotes', which replaces every quote in
5275 ;; a given string from the parse tree with its "smart" counterpart.
5276 ;;
5277 ;; Dictionary for smart quotes is stored in
5278 ;; `org-export-smart-quotes-alist'.
5294 ;; one may use: »...«, "...", ›...‹, or '...'.
5295 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5296 ;; LaTeX quotes require Babel!
5356 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5367 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5378 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5389 ;; 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
5390 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5401 ;; Based on https://sl.wikipedia.org/wiki/Narekovaj
5412 ;; Based on https://sv.wikipedia.org/wiki/Citattecken
5418 "Smart quotes translations.
5420 Alist whose CAR is a language string and CDR is an alist with
5421 quote type as key and a plist associating various encodings to
5422 their translation as value.
5424 A quote type can be any symbol among `primary-opening',
5425 `primary-closing', `secondary-opening', `secondary-closing' and
5426 `apostrophe'.
5428 Valid encodings include `:utf-8', `:html', `:latex' and
5429 `:texinfo'.
5434 "Return smart quote status at the beginning of string S.
5435 INFO is the current export state, as a plist."
5440 table)))
5448 'plain-text
5457 ;; Not already in a level 1 quote: this is an
5458 ;; apostrophe.
5460 ;; Extract previous char and next char. As
5461 ;; a special case, they can also be set to `blank',
5462 ;; `no-blank' or nil. Then determine if current
5463 ;; match is allowed as an opening quote or a closing
5464 ;; quote.
5469 text info)))
5486 previous)
5497 next)
5504 current-status)
5508 info nil org-element-recursive-objects)
5515 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5516 `:utf-8'. INFO is a plist used as a communication channel.
5518 The function has to retrieve information about string
5519 surroundings in parse tree. It can only happen with an
5520 unmodified string. Thus, if S has already been through another
5521 process, a non-nil ORIGINAL optional argument will provide that
5522 original string.
5524 Return the new string."
5533 org-export-smart-quotes-alist))))
5534 encoding)
5535 match))
5536 s nil t)))
5538 ;;;; Topology
5539 ;;
5540 ;; Here are various functions to retrieve information about the
5541 ;; neighborhood of a given element or object. Neighbors of interest
5542 ;; are direct parent (`org-export-get-parent'), parent headline
5543 ;; (`org-export-get-parent-headline'), first element containing an
5544 ;; object, (`org-export-get-parent-element'), parent table
5545 ;; (`org-export-get-parent-table'), previous element or object
5546 ;; (`org-export-get-previous-element') and next element or object
5547 ;; (`org-export-get-next-element').
5549 ;; defsubst org-export-get-parent must be defined before first use
5552 "Return BLOB parent headline or nil.
5553 BLOB is the element or object being considered."
5557 "Return first element containing OBJECT or nil.
5558 OBJECT is the object to consider."
5562 "Return OBJECT parent table or nil.
5563 OBJECT is either a `table-cell' or `table-element' type object."
5567 "Return previous element or object.
5569 BLOB is an element or object. INFO is a plist used as
5570 a communication channel. Return previous exportable element or
5571 object, a string, or nil.
5573 When optional argument N is a positive integer, return a list
5574 containing up to N siblings before BLOB, from farthest to
5575 closest. With any other non-nil value, return a list containing
5576 all of them."
5582 prev)
5592 "Return next element or object.
5594 BLOB is an element or object. INFO is a plist used as
5595 a communication channel. Return next exportable element or
5596 object, a string, or nil.
5598 When optional argument N is a positive integer, return a list
5599 containing up to N siblings after BLOB, from closest to farthest.
5600 With any other non-nil value, return a list containing all of
5601 them."
5608 next)
5618 ;;;; Translation
5619 ;;
5620 ;; `org-export-translate' translates a string according to the language
5621 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5622 ;; the dictionary used for the translation.
5657 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5669 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5675 ("ru" :html "(Продолжение следует)"
5763 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5788 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5794 ("ru" :html "Список распечаток"
5811 ("ru" :html "Список таблиц"
5946 ("ru" :html "Неизвестная ссылка"
5950 "Dictionary for export engine.
5952 Alist whose car is the string to translate and cdr is an alist
5953 whose car is the language string and cdr is a plist whose
5954 properties are possible charsets and values translated terms.
5956 It is used as a database for `org-export-translate'. Since this
5957 function returns the string as-is if no translation was found,
5958 the variable only needs to record values different from the
5962 "Translate string S according to language specification.
5964 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5965 and `:utf-8'. INFO is a plist used as a communication channel.
5967 Translation depends on `:language' property. Return the
5968 translated string. If no translation is found, try to fall back
5969 to `:default' encoding. If it fails, return S."
5975 s)))
5978 \f
5979 ;;; Asynchronous Export
5980 ;;
5981 ;; `org-export-async-start' is the entry point for asynchronous
5982 ;; export. It recreates current buffer (including visibility,
5983 ;; narrowing and visited file) in an external Emacs process, and
5984 ;; evaluates a command there. It then applies a function on the
5985 ;; returned results in the current process.
5986 ;;
5987 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5988 ;; allow exporting to a buffer or a file, asynchronously or not.
5989 ;;
5990 ;; `org-export-output-file-name' is an auxiliary function meant to be
5991 ;; used with `org-export-to-file'. With a given extension, it tries
5992 ;; to provide a canonical file name to write export output to.
5993 ;;
5994 ;; Asynchronously generated results are never displayed directly.
5995 ;; Instead, they are stored in `org-export-stack-contents'. They can
5996 ;; then be retrieved by calling `org-export-stack'.
5997 ;;
5998 ;; Export Stack is viewed through a dedicated major mode
5999 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
6000 ;;`org-export-stack-delete', `org-export-stack-view' and
6001 ;;`org-export-stack-clear'.
6002 ;;
6003 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
6004 ;; It should be used whenever `org-export-async-start' is called.
6007 "Call function FUN on the results returned by BODY evaluation.
6009 FUN is an anonymous function of one argument. BODY evaluation
6010 happens in an asynchronous process, from a buffer which is an
6011 exact copy of the current one.
6013 Use `org-export-add-to-stack' in FUN in order to register results
6014 in the stack.
6016 This is a low level function. See also `org-export-to-buffer'
6017 and `org-export-to-file' for more specialized functions."
6020 ;; Write the full sexp evaluating BODY in a copy of the current
6021 ;; buffer to a temporary file, as it may be too long for program
6022 ;; args in `start-process'.
6029 ;; Null characters (from variable values) are inserted
6030 ;; within the file. As a consequence, coding system for
6031 ;; buffer contents will not be recognized properly. So,
6032 ;; we make sure it is the same as the one used to display
6033 ;; the original buffer.
6035 ,coding
6038 ;; Ignore `kill-emacs-hook' and code evaluation
6039 ;; queries from Babel as we need a truly
6040 ;; non-interactive process.
6042 org-babel-confirm-evaluate-answer-no t)
6043 ;; Initialize export framework.
6045 ;; Re-create current buffer there.
6048 ;; Sexp to evaluate in the buffer.
6050 ;; Start external process.
6053 (,process
6055 #'start-process
6058 ,proc-buffer
6065 ;; Register running process in stack.
6067 ;; Set-up sentinel in order to catch results.
6070 ,process
6092 ;;;###autoload
6095 &optional async subtreep visible-only body-only ext-plist
6096 post-process)
6097 "Call `org-export-as' with output to a specified buffer.
6099 BACKEND is either an export back-end, as returned by, e.g.,
6100 `org-export-create-backend', or a symbol referring to
6101 a registered back-end.
6103 BUFFER is the name of the output buffer. If it already exists,
6104 it will be erased first, otherwise, it will be created.
6106 A non-nil optional argument ASYNC means the process should happen
6107 asynchronously. The resulting buffer should then be accessible
6108 through the `org-export-stack' interface. When ASYNC is nil, the
6109 buffer is displayed if `org-export-show-temporary-export-buffer'
6110 is non-nil.
6112 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6113 EXT-PLIST are similar to those used in `org-export-as', which
6114 see.
6116 Optional argument POST-PROCESS is a function which should accept
6117 no argument. It is always called within the current process,
6118 from BUFFER, with point at its beginning. Export back-ends can
6119 use it to set a major mode there, e.g,
6121 (defun org-latex-export-as-latex
6122 (&optional async subtreep visible-only body-only ext-plist)
6123 (interactive)
6125 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
6127 This function returns BUFFER."
6155 buffer)))
6157 ;;;###autoload
6160 post-process)
6161 "Call `org-export-as' with output to a specified file.
6163 BACKEND is either an export back-end, as returned by, e.g.,
6164 `org-export-create-backend', or a symbol referring to
6165 a registered back-end. FILE is the name of the output file, as
6166 a string.
6168 A non-nil optional argument ASYNC means the process should happen
6169 asynchronously. The resulting buffer will then be accessible
6170 through the `org-export-stack' interface.
6172 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6173 EXT-PLIST are similar to those used in `org-export-as', which
6174 see.
6176 Optional argument POST-PROCESS is called with FILE as its
6177 argument and happens asynchronously when ASYNC is non-nil. It
6178 has to return a file name, or nil. Export back-ends can use this
6179 to send the output file through additional processing, e.g,
6181 (defun org-latex-export-to-latex
6182 (&optional async subtreep visible-only body-only ext-plist)
6183 (interactive)
6186 async subtreep visible-only body-only ext-plist
6187 (lambda (file) (org-latex-compile file)))
6189 The function returns either a file name returned by POST-PROCESS,
6190 or FILE."
6209 backend subtreep visible-only body-only ext-plist)))
6216 ;; Get proper return value.
6218 file))))))
6221 "Return output file's name according to buffer specifications.
6223 EXTENSION is a string representing the output file extension,
6224 with the leading dot.
6226 With a non-nil optional argument SUBTREEP, try to determine
6228 of subtree at point.
6230 When optional argument PUB-DIR is set, use it as the publishing
6231 directory.
6233 Return file name as a string."
6239 ;; Check EXPORT_FILE_NAME subtree property.
6241 ;; Check #+EXPORT_FILE_NAME keyword.
6251 ;; Extract from buffer's associated file, if any.
6253 ;; Can't determine file name on our own: ask user.
6255 "Output file: " pub-dir nil nil nil
6257 extension))
6259 ;; Build file name. Enforce EXTENSION over whatever user
6260 ;; may have come up with. PUB-DIR, if defined, always has
6261 ;; precedence over any provided path.
6267 ;; If writing to OUTPUT-FILE would overwrite original file, append
6268 ;; EXTENSION another time to final name.
6271 output-file)))
6274 "Add a new result to export stack if not present already.
6276 SOURCE is a buffer or a file name containing export results.
6277 BACKEND is a symbol representing export back-end used to generate
6278 it.
6280 Entries already pointing to SOURCE and unavailable entries are
6281 removed beforehand. Return the new stack."
6287 "Menu for asynchronous export results and running processes."
6297 "Remove all entries from export stack."
6302 "Refresh the export stack."
6307 "Remove export results at point from stack.
6308 If optional argument SOURCE is non-nil, remove it instead."
6313 org-export-stack-contents))))
6316 "View export results at point in stack.
6317 With an optional prefix argument IN-EMACS, force viewing files
6318 within Emacs."
6332 (define-key km "\C-p" 'previous-line)
6333 (define-key km "\C-?" 'previous-line)
6334 (define-key km [up] 'previous-line)
6335 (define-key km "C" 'org-export-stack-clear)
6336 (define-key km "v" 'org-export-stack-view)
6337 (define-key km (kbd "RET") 'org-export-stack-view)
6338 (define-key km "d" 'org-export-stack-remove)
6339 km)
6340 "Keymap for Org Export Stack.")
6342 (define-derived-mode org-export-stack-mode tabulated-list-mode "Org-Stack"
6343 "Mode for displaying asynchronous export stack.
6346 stack.
6348 In an Org Export Stack buffer, use \
6352 stack completely.
6354 Removing entries in a stack buffer does not affect files
6355 or buffers, only display.
6358 (setq tabulated-list-format
6359 (vector (list "#" 4 #'org-export--stack-num-predicate)
6360 (list "Back-End" 12 t)
6361 (list "Age" 6 nil)
6362 (list "Source" 0 nil)))
6363 (setq tabulated-list-sort-key (cons "#" nil))
6364 (setq tabulated-list-entries #'org-export--stack-generate)
6365 (add-hook 'tabulated-list-revert-hook #'org-export--stack-generate nil t)
6366 (add-hook 'post-command-hook #'org-export-stack-refresh nil t)
6367 (tabulated-list-init-header))
6369 (defun org-export--stack-generate ()
6370 "Generate the asynchronous export stack for display.
6371 Unavailable sources are removed from the list. Return a list
6372 appropriate for `tabulated-list-print'."
6373 ;; Clear stack from exited processes, dead buffers or non-existent
6374 ;; files.
6375 (setq org-export-stack-contents
6376 (cl-remove-if-not
6377 (lambda (el)
6378 (if (processp (nth 2 el))
6379 (buffer-live-p (process-buffer (nth 2 el)))
6380 (let ((source (car el)))
6381 (if (bufferp source) (buffer-live-p source)
6382 (file-exists-p source)))))
6383 org-export-stack-contents))
6384 ;; Update `tabulated-list-entries'.
6385 (let ((counter 0))
6386 (mapcar
6387 (lambda (entry)
6388 (let ((source (car entry)))
6389 (list source
6390 (vector
6391 ;; Counter.
6392 (number-to-string (cl-incf counter))
6393 ;; Back-End.
6394 (if (nth 1 entry) (symbol-name (nth 1 entry)) "")
6395 ;; Age.
6396 (let ((info (nth 2 entry)))
6397 (if (processp info) (symbol-name (process-status info))
6398 (format-seconds "%h:%.2m" (float-time (time-since info)))))
6399 ;; Source.
6400 (if (stringp source) source (buffer-name source))))))
6401 org-export-stack-contents)))
6403 (defun org-export--stack-num-predicate (a b)
6404 (< (string-to-number (aref (nth 1 a) 0))
6405 (string-to-number (aref (nth 1 b) 0))))
6407 (defun org-export--stack-source-at-point ()
6408 "Return source from export results at point in stack."
6409 (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
6410 (if (not source) (error "Source unavailable, please refresh buffer")
6411 (let ((source-name (if (stringp source) source (buffer-name source))))
6412 (if (save-excursion
6413 (beginning-of-line)
6414 (looking-at-p (concat ".* +" (regexp-quote source-name) "$")))
6415 source
6416 ;; SOURCE is not consistent with current line. The stack
6417 ;; view is outdated.
6418 (error (substitute-command-keys
6420 to refresh buffer")))))))
6423 \f
6424 ;;; The Dispatcher
6425 ;;
6426 ;; `org-export-dispatch' is the standard interactive way to start an
6427 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6428 ;; for its interface, which, in turn, delegates response to key
6429 ;; pressed to `org-export--dispatch-action'.
6431 ;;;###autoload
6432 (defun org-export-dispatch (&optional arg)
6433 "Export dispatcher for Org mode.
6435 It provides an access to common export related tasks in a buffer.
6436 Its interface comes in two flavors: standard and expert.
6438 While both share the same set of bindings, only the former
6439 displays the valid keys associations in a dedicated buffer.
6440 Scrolling (resp. line-wise motion) in this buffer is done with
6441 SPC and DEL (resp. C-n and C-p) keys.
6443 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6444 flavor or the other.
6447 same
6448 set of options used back then, on the current buffer.
6451 asynchronous export stack."
6452 (interactive "P")
6453 (let* ((input
6454 (cond ((equal arg '(16)) '(stack))
6455 ((and arg org-export-dispatch-last-action))
6456 (t (save-window-excursion
6457 (unwind-protect
6458 (progn
6459 ;; Remember where we are
6460 (move-marker org-export-dispatch-last-position
6461 (point)
6462 (org-base-buffer (current-buffer)))
6463 ;; Get and store an export command
6464 (setq org-export-dispatch-last-action
6465 (org-export--dispatch-ui
6466 (list org-export-initial-scope
6467 (and org-export-in-background 'async))
6468 nil
6469 org-export-dispatch-use-expert-ui)))
6470 (and (get-buffer "*Org Export Dispatcher*")
6471 (kill-buffer "*Org Export Dispatcher*")))))))
6472 (action (car input))
6473 (optns (cdr input)))
6474 (unless (memq 'subtree optns)
6475 (move-marker org-export-dispatch-last-position nil))
6476 (cl-case action
6477 ;; First handle special hard-coded actions.
6478 (template (org-export-insert-default-template nil optns))
6479 (stack (org-export-stack))
6480 (publish-current-file
6481 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6482 (publish-current-project
6483 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6484 (publish-choose-project
6485 (org-publish (assoc (completing-read
6486 "Publish project: "
6487 org-publish-project-alist nil t)
6488 org-publish-project-alist)
6489 (memq 'force optns)
6490 (memq 'async optns)))
6491 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6492 (otherwise
6493 (save-excursion
6494 (when arg
6495 ;; Repeating command, maybe move cursor to restore subtree
6496 ;; context.
6497 (if (eq (marker-buffer org-export-dispatch-last-position)
6498 (org-base-buffer (current-buffer)))
6499 (goto-char org-export-dispatch-last-position)
6500 ;; We are in a different buffer, forget position.
6501 (move-marker org-export-dispatch-last-position nil)))
6502 (funcall action
6503 ;; Return a symbol instead of a list to ease
6504 ;; asynchronous export macro use.
6505 (and (memq 'async optns) t)
6506 (and (memq 'subtree optns) t)
6507 (and (memq 'visible optns) t)
6508 (and (memq 'body optns) t)))))))
6510 (defun org-export--dispatch-ui (options first-key expertp)
6511 "Handle interface for `org-export-dispatch'.
6513 OPTIONS is a list containing current interactive options set for
6514 export. It can contain any of the following symbols:
6515 `body' toggles a body-only export
6516 `subtree' restricts export to current subtree
6517 `visible' restricts export to visible part of buffer.
6518 `force' force publishing files.
6519 `async' use asynchronous export process
6521 FIRST-KEY is the key pressed to select the first level menu. It
6522 is nil when this menu hasn't been selected yet.
6524 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6525 buffer is provided, but indications about currently active
6526 options are given in the prompt. Moreover, [?] allows switching
6527 back to standard interface."
6528 (let* ((fontify-key
6529 (lambda (key &optional access-key)
6530 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6531 ;; non-nil is the required first-level key to activate
6532 ;; KEY. When its value is t, activate KEY independently
6533 ;; on the first key, if any. A nil value means KEY will
6534 ;; only be activated at first level.
6535 (if (or (eq access-key t) (eq access-key first-key))
6536 (propertize key 'face 'org-warning)
6537 key)))
6538 (fontify-value
6539 (lambda (value)
6540 ;; Fontify VALUE string.
6541 (propertize value 'face 'font-lock-variable-name-face)))
6542 ;; Prepare menu entries by extracting them from registered
6543 ;; back-ends and sorting them by access key and by ordinal,
6544 ;; if any.
6545 (entries
6546 (sort (sort (delq nil
6547 (mapcar #'org-export-backend-menu
6548 org-export-registered-backends))
6549 (lambda (a b)
6550 (let ((key-a (nth 1 a))
6551 (key-b (nth 1 b)))
6552 (cond ((and (numberp key-a) (numberp key-b))
6553 (< key-a key-b))
6554 ((numberp key-b) t)))))
6555 'car-less-than-car))
6556 ;; Compute a list of allowed keys based on the first key
6557 ;; pressed, if any. Some keys
6558 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6559 ;; available.
6560 (allowed-keys
6561 (nconc (list 2 22 19 6 1)
6562 (if (not first-key) (org-uniquify (mapcar 'car entries))
6563 (let (sub-menu)
6564 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6565 (when (eq (car entry) first-key)
6566 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6567 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6568 ((not first-key) (list ?P)))
6569 (list ?& ?#)
6570 (when expertp (list ??))
6571 (list ?q)))
6572 ;; Build the help menu for standard UI.
6573 (help
6574 (unless expertp
6575 (concat
6576 ;; Options are hard-coded.
6577 (format "[%s] Body only: %s [%s] Visible only: %s
6578 \[%s] Export scope: %s [%s] Force publishing: %s
6580 (funcall fontify-key "C-b" t)
6581 (funcall fontify-value
6582 (if (memq 'body options) "On " "Off"))
6583 (funcall fontify-key "C-v" t)
6584 (funcall fontify-value
6585 (if (memq 'visible options) "On " "Off"))
6586 (funcall fontify-key "C-s" t)
6587 (funcall fontify-value
6588 (if (memq 'subtree options) "Subtree" "Buffer "))
6589 (funcall fontify-key "C-f" t)
6590 (funcall fontify-value
6591 (if (memq 'force options) "On " "Off"))
6592 (funcall fontify-key "C-a" t)
6593 (funcall fontify-value
6594 (if (memq 'async options) "On " "Off")))
6595 ;; Display registered back-end entries. When a key
6596 ;; appears for the second time, do not create another
6597 ;; entry, but append its sub-menu to existing menu.
6598 (let (last-key)
6599 (mapconcat
6600 (lambda (entry)
6601 (let ((top-key (car entry)))
6602 (concat
6603 (unless (eq top-key last-key)
6604 (setq last-key top-key)
6606 (funcall fontify-key (char-to-string top-key))
6607 (nth 1 entry)))
6608 (let ((sub-menu (nth 2 entry)))
6609 (unless (functionp sub-menu)
6610 ;; Split sub-menu into two columns.
6611 (let ((index -1))
6612 (concat
6613 (mapconcat
6614 (lambda (sub-entry)
6615 (cl-incf index)
6616 (format
6617 (if (zerop (mod index 2)) " [%s] %-26s"
6619 (funcall fontify-key
6620 (char-to-string (car sub-entry))
6621 top-key)
6622 (nth 1 sub-entry)))
6623 sub-menu "")
6625 entries ""))
6626 ;; Publishing menu is hard-coded.
6628 [%s] Current file [%s] Current project
6630 (funcall fontify-key "P")
6631 (funcall fontify-key "f" ?P)
6632 (funcall fontify-key "p" ?P)
6633 (funcall fontify-key "x" ?P)
6634 (funcall fontify-key "a" ?P))
6636 (funcall fontify-key "&" t)
6637 (funcall fontify-key "#" t))
6638 (format "[%s] %s"
6639 (funcall fontify-key "q" t)
6640 (if first-key "Main menu" "Exit")))))
6641 ;; Build prompts for both standard and expert UI.
6642 (standard-prompt (unless expertp "Export command: "))
6643 (expert-prompt
6644 (when expertp
6645 (format
6646 "Export command (C-%s%s%s%s%s) [%s]: "
6647 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6648 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6649 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6650 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6651 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6652 (mapconcat (lambda (k)
6653 ;; Strip control characters.
6654 (unless (< k 27) (char-to-string k)))
6655 allowed-keys "")))))
6656 ;; With expert UI, just read key with a fancy prompt. In standard
6657 ;; UI, display an intrusive help buffer.
6658 (if expertp
6659 (org-export--dispatch-action
6660 expert-prompt allowed-keys entries options first-key expertp)
6661 ;; At first call, create frame layout in order to display menu.
6662 (unless (get-buffer "*Org Export Dispatcher*")
6663 (delete-other-windows)
6664 (org-switch-to-buffer-other-window
6665 (get-buffer-create "*Org Export Dispatcher*"))
6666 (setq cursor-type nil
6667 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6668 ;; Make sure that invisible cursor will not highlight square
6669 ;; brackets.
6670 (set-syntax-table (copy-syntax-table))
6671 (modify-syntax-entry ?\[ "w"))
6672 ;; At this point, the buffer containing the menu exists and is
6673 ;; visible in the current window. So, refresh it.
6674 (with-current-buffer "*Org Export Dispatcher*"
6675 ;; Refresh help. Maintain display continuity by re-visiting
6676 ;; previous window position.
6677 (let ((pos (window-start)))
6678 (erase-buffer)
6679 (insert help)
6680 (set-window-start nil pos)))
6681 (org-fit-window-to-buffer)
6682 (org-export--dispatch-action
6683 standard-prompt allowed-keys entries options first-key expertp))))
6685 (defun org-export--dispatch-action
6686 (prompt allowed-keys entries options first-key expertp)
6687 "Read a character from command input and act accordingly.
6689 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6690 a list of characters available at a given step in the process.
6691 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6692 EXPERTP are the same as defined in `org-export--dispatch-ui',
6693 which see.
6695 Toggle export options when required. Otherwise, return value is
6696 a list with action as CAR and a list of interactive export
6697 options as CDR."
6698 (let (key)
6699 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6700 ;; C-p, SPC, DEL).
6701 (while (and (setq key (read-char-exclusive prompt))
6702 (not expertp)
6703 (memq key '(14 16 ?\s ?\d)))
6704 (cl-case key
6705 (14 (if (not (pos-visible-in-window-p (point-max)))
6706 (ignore-errors (scroll-up 1))
6707 (message "End of buffer")
6708 (sit-for 1)))
6709 (16 (if (not (pos-visible-in-window-p (point-min)))
6710 (ignore-errors (scroll-down 1))
6711 (message "Beginning of buffer")
6712 (sit-for 1)))
6713 (?\s (if (not (pos-visible-in-window-p (point-max)))
6714 (scroll-up nil)
6715 (message "End of buffer")
6716 (sit-for 1)))
6717 (?\d (if (not (pos-visible-in-window-p (point-min)))
6718 (scroll-down nil)
6719 (message "Beginning of buffer")
6720 (sit-for 1)))))
6721 (cond
6722 ;; Ignore undefined associations.
6723 ((not (memq key allowed-keys))
6724 (ding)
6725 (unless expertp (message "Invalid key") (sit-for 1))
6726 (org-export--dispatch-ui options first-key expertp))
6727 ;; q key at first level aborts export. At second level, cancel
6728 ;; first key instead.
6729 ((eq key ?q) (if (not first-key) (error "Export aborted")
6730 (org-export--dispatch-ui options nil expertp)))
6731 ;; Help key: Switch back to standard interface if expert UI was
6732 ;; active.
6733 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6734 ;; Send request for template insertion along with export scope.
6735 ((eq key ?#) (cons 'template (memq 'subtree options)))
6736 ;; Switch to asynchronous export stack.
6737 ((eq key ?&) '(stack))
6738 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6739 ((memq key '(2 22 19 6 1))
6740 (org-export--dispatch-ui
6741 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6742 (6 'force) (1 'async))))
6743 (if (memq option options) (remq option options)
6744 (cons option options)))
6745 first-key expertp))
6746 ;; Action selected: Send key and options back to
6747 ;; `org-export-dispatch'.
6748 ((or first-key (functionp (nth 2 (assq key entries))))
6749 (cons (cond
6750 ((not first-key) (nth 2 (assq key entries)))
6751 ;; Publishing actions are hard-coded. Send a special
6752 ;; signal to `org-export-dispatch'.
6753 ((eq first-key ?P)
6754 (cl-case key
6755 (?f 'publish-current-file)
6756 (?p 'publish-current-project)
6757 (?x 'publish-choose-project)
6758 (?a 'publish-all)))
6759 ;; Return first action associated to FIRST-KEY + KEY
6760 ;; path. Indeed, derived backends can share the same
6761 ;; FIRST-KEY.
6762 (t (catch 'found
6763 (dolist (entry (member (assq first-key entries) entries))
6764 (let ((match (assq key (nth 2 entry))))
6765 (when match (throw 'found (nth 2 match))))))))
6766 options))
6767 ;; Otherwise, enter sub-menu.
6768 (t (org-export--dispatch-ui options key expertp)))))
6772 (provide 'ox)
6774 ;; Local variables:
6775 ;; generated-autoload-file: "org-loaddefs.el"
6776 ;; End:
6778 ;;; ox.el ends here