| blob | 9b508dfd5b2f057668330553de23f8cf7422c9c8 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 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 in 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. The exhaustive list
35 ;; of properties is given in "The Communication Channel" section of
36 ;; this file.
37 ;;
38 ;; - The transcoder walks the parse tree, ignores or treat as plain
39 ;; text elements and objects according to export options, and
40 ;; eventually calls back-end specific functions to do the real
41 ;; transcoding, concatenating their return value along the way.
42 ;;
43 ;; - The filter system is activated at the very beginning and the very
44 ;; end of the export process, and each time an element or an object
45 ;; has been converted. It is the entry point to fine-tune standard
46 ;; output from back-end transcoders. See "The Filter System"
47 ;; section for more information.
48 ;;
49 ;; The core function is `org-export-as'. It returns the transcoded
50 ;; buffer as a string.
51 ;;
52 ;; An export back-end is defined with `org-export-define-backend'.
53 ;; This function can also support specific buffer keywords, OPTION
54 ;; keyword's items and filters. Refer to function's documentation for
55 ;; more information.
56 ;;
57 ;; If the new back-end shares most properties with another one,
58 ;; `org-export-define-derived-backend' can be used to simplify the
59 ;; process.
60 ;;
61 ;; Any back-end can define its own variables. Among them, those
62 ;; customizable should belong to the `org-export-BACKEND' group.
63 ;;
64 ;; Tools for common tasks across back-ends are implemented in the
65 ;; following part of the file.
66 ;;
67 ;; Then, a wrapper macro for asynchronous export,
68 ;; `org-export-async-start', along with tools to display results. are
69 ;; given in the penultimate part.
70 ;;
71 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
72 ;; back-ends is provided in the last one.
74 ;;; Code:
92 \f
93 ;;; Internal Variables
94 ;;
95 ;; Among internal variables, the most important is
96 ;; `org-export-options-alist'. This variable define the global export
97 ;; options, shared between every exporter, and how they are acquired.
143 "Alist between export properties and ways to set them.
145 The CAR of the alist is the property name, and the CDR is a list
146 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
148 KEYWORD is a string representing a buffer keyword, or nil. Each
149 property defined this way can also be set, during subtree
150 export, through a headline property named after the keyword
152 property).
153 OPTION is a string that could be found in an #+OPTIONS: line.
154 DEFAULT is the default value for the property.
155 BEHAVIOR determines how Org should handle multiple keywords for
156 the same property. It is a symbol among:
157 nil Keep old value and discard the new one.
158 t Replace old value with the new one.
159 `space' Concatenate the values, separating them with a space.
160 `newline' Concatenate the values, separating them with
161 a newline.
162 `split' Split values at white spaces, and cons them to the
163 previous list.
165 Values set through KEYWORD and OPTION have precedence over
166 DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
233 "Alist between filters properties and initial values.
235 The key of each association is a property name accessible through
236 the communication channel. Its value is a configurable global
237 variable defining initial filters.
239 This list is meant to install user specified filters. Back-end
240 developers may install their own filters using
241 `org-export-define-backend'. Filters defined there will always
242 be prepended to the current list, so they always get applied
251 "Default rule for link matching an inline image.
252 This rule applies to links with no description. By default, it
253 will be considered as an inline image if it targets a local file
256 See `org-export-inline-image-p' for more information about
261 org-element--cache org-element--cache-objects org-element--cache-sync-keys
262 org-element--cache-sync-requests org-element--cache-sync-timer)
263 "List of variables not copied through upon buffer duplication.
264 Export process takes place on a copy of the original buffer.
265 When this copy is created, all Org related local variables not in
266 this list are copied to the new buffer. Variables with an
270 "Non-nil means asynchronous export process should leave data behind.
274 located in `temporary-file-directory'.
276 When non-nil, it will also set `debug-on-error' to a non-nil
280 "Record asynchronously generated export results and processes.
281 This is an alist: its CAR is the source of the
282 result (destination file or buffer for a finished process,
283 original buffer for a running one) and its CDR is a list
284 containing the back-end used, as a symbol, and either a process
285 or the time at which it finished. It is used to build the menu
289 "List of backends currently available in the exporter.
290 This variable is set with `org-export-define-backend' and
294 "Last command called from the dispatcher.
295 The value should be a list. Its CAR is the action, as a symbol,
299 "The position where the last export command was created using the dispatcher.
300 This marker will be used with `C-u C-c C-e' to make sure export repetition
303 ;; For compatibility with Org < 8
305 "Name, if any, of the back-end used during an export process.
307 Its value is a symbol such as `html', `latex', `ascii', or nil if
308 the back-end is anonymous (see `org-export-create-backend') or if
309 there is no export process in progress.
311 It can be used to teach Babel blocks how to act differently
315 \f
316 ;;; User-configurable Variables
317 ;;
318 ;; Configuration for the masses.
319 ;;
320 ;; They should never be accessed directly, as their value is to be
321 ;; stored in a property list (cf. `org-export-options-alist').
322 ;; Back-ends will read their value from there instead.
325 "Options for exporting Org mode files."
330 "General options for export engine."
335 "Whether sub-trees with the ARCHIVE tag should be exported.
337 This can have three different values:
338 nil Do not export, pretend this tree is not present.
339 t Do export the entire tree.
340 `headline' Only export the headline, but skip the tree below it.
342 This option can also be set with the OPTIONS keyword,
351 "Non-nil means insert author name into the exported file.
352 This option can also be set with the OPTIONS keyword,
358 "Non-nil means export CLOCK keywords.
359 This option can also be set with the OPTIONS keyword,
365 "Non-nil means the postamble should contain a creator sentence.
367 The sentence can be set in `org-export-creator-string' and
370 If the value is `comment' insert it as a comment."
378 "Non-nil means insert date in the exported document.
379 This option can also be set with the OPTIONS keyword,
385 "Time-stamp format string to use for DATE keyword.
387 The format string, when specified, only applies if date consists
388 in a single time-stamp. Otherwise its value will be ignored.
390 See `format-time-string' for details on how to build this
391 string."
399 emacs-version
401 "Information about the creator of the document.
402 This option can also be set on with the CREATOR keyword."
407 "Non-nil means export contents of standard drawers.
409 When t, all drawers are exported. This may also be a list of
410 drawer names to export, as strings. If that list starts with
411 `not', only drawers with such names will be ignored.
413 This variable doesn't apply to properties drawers. See
414 `org-export-with-properties' instead.
416 This option can also be set with the OPTIONS keyword,
429 :inline t
433 "Non-nil means insert author email into the exported file.
434 This option can also be set with the OPTIONS keyword,
440 "Non-nil means interpret *word*, /word/, _word_ and +word+.
442 If the export target supports emphasizing text, the word will be
443 typeset in bold, italic, with an underline or strike-through,
444 respectively.
446 This option can also be set with the OPTIONS keyword,
452 "Tags that exclude a tree from export.
454 All trees carrying any of these tags will be excluded from
455 export. This is without condition, so even subtrees inside that
456 carry one of the `org-export-select-tags' will be removed.
458 This option can also be set with the EXCLUDE_TAGS keyword."
464 This option can also be set with the OPTIONS keyword,
472 "Non-nil means Org footnotes should be exported.
473 This option can also be set with the OPTIONS keyword,
479 "Non-nil means process LaTeX environments and fragments.
481 This option can also be set with the OPTIONS line,
484 nil Ignore math snippets.
485 `verbatim' Keep everything in verbatim.
486 t Allow export of math snippets."
496 "The last level which is still exported as a headline.
498 Inferior levels will usually produce itemize or enumerate lists
499 when exported, but back-end behaviour may differ.
501 This option can also be set with the OPTIONS keyword,
507 "The default language for export and clocktable translations, as a string.
508 This may have an association in
509 `org-clock-clocktable-language-setup',
510 `org-export-smart-quotes-alist' and `org-export-dictionary'.
511 This option can also be set with the LANGUAGE keyword."
516 "Non-nil means preserve all line breaks when exporting.
517 This option can also be set with the OPTIONS keyword,
523 "Non-nil means interpret entities when exporting.
526 Å.
528 For a list of supported names, see the constant `org-entities'
529 and the user option `org-entities-user'.
531 This option can also be set with the OPTIONS keyword,
537 "Non-nil means inlinetasks should be exported.
538 This option can also be set with the OPTIONS keyword,
546 "Non-nil means include planning info in export.
548 Planning info is the line containing either SCHEDULED:,
549 DEADLINE:, CLOSED: time-stamps, or a combination of them.
551 This option can also be set with the OPTIONS keyword,
559 "Non-nil means include priority cookies in export.
560 This option can also be set with the OPTIONS keyword,
566 "Non-nil means export contents of properties drawers.
568 When t, all properties are exported. This may also be a list of
569 properties to export, as strings.
571 This option can also be set with the OPTIONS keyword,
583 "Non-nil means add section numbers to headlines when exporting.
585 When set to an integer n, numbering will only happen for
586 headlines whose relative level is higher or equal to n.
588 This option can also be set with the OPTIONS keyword,
594 "Tags that select a tree for export.
596 If any such tag is found in a buffer, all trees that do not carry
597 one of these tags will be ignored during export. Inside trees
598 that are selected like this, you can still deselect a subtree by
599 tagging it with one of the `org-export-exclude-tags'.
601 This option can also be set with the SELECT_TAGS keyword."
606 "Non-nil means activate smart quotes during export.
607 This option can also be set with the OPTIONS keyword,
610 When setting this to non-nil, you need to take care of
611 using the correct Babel package when exporting to LaTeX.
612 E.g., you can load Babel for french like this:
623 When this option is turned on, these strings will be exported as:
625 Org HTML LaTeX UTF-8
626 -----+----------+--------+-------
628 -- – -- –
629 --- — --- —
632 This option can also be set with the OPTIONS keyword,
638 "Non-nil means include statistics cookies in export.
639 This option can also be set with the OPTIONS keyword,
649 If you want to control how Org displays those characters, see
650 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
651 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
652 it is not anymore.
654 When this option is turned on, you can use TeX-like syntax for
655 sub- and superscripts and see them exported correctly.
657 You can also set the option with #+OPTIONS: ^:t
660 single item - so grouping with {} is normally not needed. For
661 example, the following things will be parsed as single sub- or
662 superscripts:
664 10^24 or 10^tau several digits will be considered 1 item.
665 10^-12 or 10^-tau a leading sign with digits or a word
666 x^2-y^3 will be read as x^2 - y^3, because items are
667 terminated by almost any nonword/nondigit char.
668 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
670 Still, ambiguity is possible. So when in doubt, use {} to enclose
671 the sub/superscript. If you set this variable to the symbol `{}',
672 the braces are *required* in order to trigger interpretations as
674 frequently in plain text."
684 "Non-nil means create a table of contents in exported files.
686 The TOC contains headlines with levels up
687 to`org-export-headline-levels'. When an integer, include levels
688 up to N in the toc, this may then be different from
689 `org-export-headline-levels', but it will not be allowed to be
690 larger than the number of headline levels. When nil, no table of
691 contents is made.
693 This option can also be set with the OPTIONS keyword,
702 "Non-nil means export tables.
703 This option can also be set with the OPTIONS keyword,
711 "If nil, do not export tags, just remove them from headlines.
713 If this is the symbol `not-in-toc', tags will be removed from
714 table of contents entries, but still be shown in the headlines of
715 the document.
717 This option can also be set with the OPTIONS keyword,
726 "Non-nil means include TODO items for export.
728 This may have the following values:
729 t include tasks independent of state.
730 `todo' include only tasks that are not yet done.
731 `done' include only tasks that are already done.
732 nil ignore all tasks.
733 list of keywords include tasks with these keywords.
735 This option can also be set with the OPTIONS keyword,
747 "Non-nil means insert a time stamp into the exported file.
748 The time stamp shows when the file was created. This option can
754 "Non nil means allow timestamps in export.
756 It can be set to any of the following values:
757 t export all timestamps.
758 `active' export active timestamps only.
759 `inactive' export inactive timestamps only.
760 nil do not export timestamps
762 This only applies to timestamps isolated in a paragraph
763 containing only timestamps. Other timestamps are always
764 exported.
766 This option can also be set with the OPTIONS keyword, e.g.
776 "Non-nil means include TODO keywords in export.
777 When nil, remove all these keywords from the export. This option
783 "Non-nil means BIND keywords can define local variable values.
784 This is a potential security risk, which is why the default value
785 is nil. You can also allow them through local buffer variables."
792 "Alist between export snippets back-ends and exporter back-ends.
794 This variable allows to provide shortcuts for export snippets.
798 HTML code while every other back-end will ignore it."
807 "Coding system for the exported file."
814 "Non-nil means pushing export output to the kill ring.
815 This variable is ignored during asynchronous export."
825 "The initial scope when exporting with `org-export-dispatch'.
826 This variable can be either set to `buffer' or `subtree'."
833 "Non-nil means show buffer after exporting to temp buffer.
834 When Org exports to a file, the buffer visiting that file is ever
835 shown, but remains buried. However, when exporting to
836 a temporary buffer, that buffer is popped up in a second window.
837 When this variable is nil, the buffer remains buried also in
838 these cases."
843 "Non-nil means export and publishing commands will run in background.
844 Results from an asynchronous export are never displayed
852 "File used to initialize external export process.
854 Value must be either nil or an absolute file name. When nil, the
855 external process is launched like a regular Emacs session,
856 loading user's initialization file and any site specific
857 configuration. If a file is provided, it, and only it, is loaded
858 at start-up.
860 Therefore, using a specific configuration makes the process to
861 load faster and the export more portable."
870 "Non-nil means using a non-intrusive `org-export-dispatch'.
871 In that case, no help buffer is displayed. Though, an indicator
877 asynchronous). Also, \[?] allows to switch back to standard
878 mode."
885 \f
886 ;;; Defining Back-ends
887 ;;
888 ;; An export back-end is a structure with `org-export-backend' type
889 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
890 ;; and `menu' slots.
891 ;;
892 ;; At the lowest level, a back-end is created with
893 ;; `org-export-create-backend' function.
894 ;;
895 ;; A named back-end can be registered with
896 ;; `org-export-register-backend' function. A registered back-end can
897 ;; later be referred to by its name, with `org-export-get-backend'
898 ;; function. Also, such a back-end can become the parent of a derived
899 ;; back-end from which slot values will be inherited by default.
900 ;; `org-export-derived-backend-p' can check if a given back-end is
901 ;; derived from a list of back-end names.
902 ;;
903 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
904 ;; `org-export-get-all-filters' return the full alist of transcoders,
905 ;; options and filters, including those inherited from ancestors.
906 ;;
907 ;; At a higher level, `org-export-define-backend' is the standard way
908 ;; to define an export back-end. If the new back-end is similar to
909 ;; a registered back-end, `org-export-define-derived-backend' may be
910 ;; used instead.
911 ;;
912 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
913 ;; when a given back-end hasn't been registered yet.
917 name parent transcoders options filters blocks menu)
920 "Return export back-end named after NAME.
921 NAME is a symbol. Return nil if no such back-end is found."
928 "Register BACKEND as a known export back-end.
929 BACKEND is a structure with `org-export-backend' type."
930 ;; Refuse to register an unnamed back-end.
933 ;; Refuse to register a back-end with an unknown parent.
937 ;; If a back-end with the same name as BACKEND is already
938 ;; registered, replace it with BACKEND. Otherwise, simply add
939 ;; BACKEND to the list of registered back-ends.
945 "Signal an error if BACKEND isn't defined."
950 "Non-nil if BACKEND is derived from one of BACKENDS.
951 BACKEND is an export back-end, as returned by, e.g.,
952 `org-export-create-backend', or a symbol referring to
953 a registered back-end. BACKENDS is constituted of symbols."
965 "Return full translation table for BACKEND.
967 BACKEND is an export back-end, as return by, e.g,,
968 `org-export-create-backend'. Return value is an alist where
969 keys are element or object types, as symbols, and values are
970 transcoders.
972 Unlike to `org-export-backend-transcoders', this function
973 also returns transcoders inherited from parent back-ends,
974 if any."
978 parent)
983 transcoders)))
986 "Return export options for BACKEND.
988 BACKEND is an export back-end, as return by, e.g,,
989 `org-export-create-backend'. See `org-export-options-alist'
990 for the shape of the return value.
992 Unlike to `org-export-backend-options', this function also
993 returns options inherited from parent back-ends, if any."
997 parent)
1001 options)))
1004 "Return complete list of filters for BACKEND.
1006 BACKEND is an export back-end, as return by, e.g,,
1007 `org-export-create-backend'. Return value is an alist where
1008 keys are symbols and values lists of functions.
1010 Unlike to `org-export-backend-filters', this function also
1011 returns filters inherited from parent back-ends, if any."
1015 parent)
1019 filters)))
1022 "Define a new back-end BACKEND.
1024 TRANSCODERS is an alist between object or element types and
1025 functions handling them.
1027 These functions should return a string without any trailing
1028 space, or nil. They must accept three arguments: the object or
1029 element itself, its contents or nil when it isn't recursive and
1030 the property list used as a communication channel.
1032 Contents, when not nil, are stripped from any global indentation
1033 \(although the relative one is preserved). They also always end
1034 with a single newline character.
1036 If, for a given type, no function is found, that element or
1037 object type will simply be ignored, along with any blank line or
1038 white space at its end. The same will happen if the function
1039 returns the nil value. If that function returns the empty
1040 string, the type will be ignored, but the blank lines or white
1041 spaces will be kept.
1043 In addition to element and object types, one function can be
1044 associated to the `template' (or `inner-template') symbol and
1045 another one to the `plain-text' symbol.
1047 The former returns the final transcoded string, and can be used
1048 to add a preamble and a postamble to document's body. It must
1049 accept two arguments: the transcoded string and the property list
1050 containing export options. A function associated to `template'
1052 A function associated to `inner-template' is always applied.
1054 The latter, when defined, is to be called on every text not
1055 recognized as an element or an object. It must accept two
1056 arguments: the text string and the information channel. It is an
1057 appropriate place to protect special chars relative to the
1058 back-end.
1060 BODY can start with pre-defined keyword arguments. The following
1061 keywords are understood:
1063 :export-block
1065 String, or list of strings, representing block names that
1066 will not be parsed. This is used to specify blocks that will
1067 contain raw code specific to the back-end. These blocks
1068 still have to be handled by the `special-block' type
1069 translator.
1071 :filters-alist
1073 Alist between filters and function, or list of functions,
1074 specific to the back-end. See `org-export-filters-alist' for
1075 a list of all allowed filters. Filters defined here
1076 shouldn't make a back-end test, as it may prevent back-ends
1077 derived from this one to behave properly.
1079 :menu-entry
1081 Menu entry for the export dispatcher. It should be a list
1082 like:
1084 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1086 where :
1088 KEY is a free character selecting the back-end.
1090 DESCRIPTION-OR-ORDINAL is either a string or a number.
1092 If it is a string, is will be used to name the back-end in
1093 its menu entry. If it is a number, the following menu will
1094 be displayed as a sub-menu of the back-end with the same
1095 KEY. Also, the number will be used to determine in which
1096 order such sub-menus will appear (lowest first).
1098 ACTION-OR-MENU is either a function or an alist.
1100 If it is an action, it will be called with four
1101 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1102 BODY-ONLY. See `org-export-as' for further explanations on
1103 some of them.
1105 If it is an alist, associations should follow the
1106 pattern:
1108 '(KEY DESCRIPTION ACTION)
1110 where KEY, DESCRIPTION and ACTION are described above.
1112 Valid values include:
1116 or
1121 \(lambda (a s v b)
1122 \(if a (org-latex-export-to-pdf t s v b)
1123 \(org-open-file
1124 \(org-latex-export-to-pdf nil s v b)))))))
1126 or the following, which will be added to the previous
1127 sub-menu,
1129 '(?l 1
1133 :options-alist
1135 Alist between back-end specific properties introduced in
1136 communication channel and how their value are acquired. See
1137 `org-export-options-alist' for more information about
1138 structure of the values."
1152 :transcoders transcoders
1153 :options options
1154 :filters filters
1155 :blocks blocks
1159 "Create a new back-end as a variant of an existing one.
1161 CHILD is the name of the derived back-end. PARENT is the name of
1162 the parent back-end.
1164 BODY can start with pre-defined keyword arguments. The following
1165 keywords are understood:
1167 :export-block
1169 String, or list of strings, representing block names that
1170 will not be parsed. This is used to specify blocks that will
1171 contain raw code specific to the back-end. These blocks
1172 still have to be handled by the `special-block' type
1173 translator.
1175 :filters-alist
1177 Alist of filters that will overwrite or complete filters
1178 defined in PARENT back-end. See `org-export-filters-alist'
1179 for a list of allowed filters.
1181 :menu-entry
1183 Menu entry for the export dispatcher. See
1184 `org-export-define-backend' for more information about the
1185 expected value.
1187 :options-alist
1189 Alist of back-end specific properties that will overwrite or
1190 complete those defined in PARENT back-end. Refer to
1191 `org-export-options-alist' for more information about
1192 structure of the values.
1194 :translate-alist
1196 Alist of element and object types and transcoders that will
1197 overwrite or complete transcode table from PARENT back-end.
1198 Refer to `org-export-define-backend' for detailed information
1199 about transcoders.
1202 as a variant of `latex' back-end with a custom template function:
1204 \(org-export-define-derived-backend 'my-latex 'latex
1205 :translate-alist '((template . my-latex-template-fun)))
1207 The back-end could then be called with, for example:
1224 :parent parent
1225 :transcoders transcoders
1226 :options options
1227 :filters filters
1228 :blocks blocks
1232 \f
1233 ;;; The Communication Channel
1234 ;;
1235 ;; During export process, every function has access to a number of
1236 ;; properties. They are of two types:
1237 ;;
1238 ;; 1. Environment options are collected once at the very beginning of
1239 ;; the process, out of the original buffer and configuration.
1240 ;; Collecting them is handled by `org-export-get-environment'
1241 ;; function.
1242 ;;
1243 ;; Most environment options are defined through the
1244 ;; `org-export-options-alist' variable.
1245 ;;
1246 ;; 2. Tree properties are extracted directly from the parsed tree,
1247 ;; just before export, by `org-export-collect-tree-properties'.
1248 ;;
1249 ;; Here is the full list of properties available during transcode
1250 ;; process, with their category and their value type.
1251 ;;
1252 ;; + `:author' :: Author's name.
1253 ;; - category :: option
1254 ;; - type :: string
1255 ;;
1256 ;; + `:back-end' :: Current back-end used for transcoding.
1257 ;; - category :: tree
1258 ;; - type :: structure
1259 ;;
1260 ;; + `:creator' :: String to write as creation information.
1261 ;; - category :: option
1262 ;; - type :: string
1263 ;;
1264 ;; + `:date' :: String to use as date.
1265 ;; - category :: option
1266 ;; - type :: string
1267 ;;
1268 ;; + `:description' :: Description text for the current data.
1269 ;; - category :: option
1270 ;; - type :: string
1271 ;;
1272 ;; + `:email' :: Author's email.
1273 ;; - category :: option
1274 ;; - type :: string
1275 ;;
1276 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1277 ;; process.
1278 ;; - category :: option
1279 ;; - type :: list of strings
1280 ;;
1281 ;; + `:export-options' :: List of export options available for current
1282 ;; process.
1283 ;; - category :: none
1284 ;; - type :: list of symbols, among `subtree', `body-only' and
1285 ;; `visible-only'.
1286 ;;
1287 ;; + `:exported-data' :: Hash table used for memoizing
1288 ;; `org-export-data'.
1289 ;; - category :: tree
1290 ;; - type :: hash table
1291 ;;
1292 ;; + `:filetags' :: List of global tags for buffer. Used by
1293 ;; `org-export-get-tags' to get tags with inheritance.
1294 ;; - category :: option
1295 ;; - type :: list of strings
1296 ;;
1297 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1298 ;; their definition, as parsed data. Only non-inlined footnotes
1299 ;; are represented in this alist. Also, every definition isn't
1300 ;; guaranteed to be referenced in the parse tree. The purpose of
1301 ;; this property is to preserve definitions from oblivion
1302 ;; (i.e. when the parse tree comes from a part of the original
1303 ;; buffer), it isn't meant for direct use in a back-end. To
1304 ;; retrieve a definition relative to a reference, use
1305 ;; `org-export-get-footnote-definition' instead.
1306 ;; - category :: option
1307 ;; - type :: alist (STRING . LIST)
1308 ;;
1309 ;; + `:headline-levels' :: Maximum level being exported as an
1310 ;; headline. Comparison is done with the relative level of
1311 ;; headlines in the parse tree, not necessarily with their
1312 ;; actual level.
1313 ;; - category :: option
1314 ;; - type :: integer
1315 ;;
1316 ;; + `:headline-offset' :: Difference between relative and real level
1317 ;; of headlines in the parse tree. For example, a value of -1
1318 ;; means a level 2 headline should be considered as level
1319 ;; 1 (cf. `org-export-get-relative-level').
1320 ;; - category :: tree
1321 ;; - type :: integer
1322 ;;
1323 ;; + `:headline-numbering' :: Alist between headlines and their
1324 ;; numbering, as a list of numbers
1325 ;; (cf. `org-export-get-headline-number').
1326 ;; - category :: tree
1327 ;; - type :: alist (INTEGER . LIST)
1328 ;;
1329 ;; + `:id-alist' :: Alist between ID strings and destination file's
1330 ;; path, relative to current directory. It is used by
1331 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1332 ;; external file.
1333 ;; - category :: option
1334 ;; - type :: alist (STRING . STRING)
1335 ;;
1336 ;; + `:ignore-list' :: List of elements and objects that should be
1337 ;; ignored during export.
1338 ;; - category :: tree
1339 ;; - type :: list of elements and objects
1340 ;;
1341 ;; + `:input-buffer' :: Original buffer name.
1342 ;; - category :: option
1343 ;; - type :: string
1344 ;;
1345 ;; + `:input-file' :: Full path to input file, if any.
1346 ;; - category :: option
1347 ;; - type :: string or nil
1348 ;;
1349 ;; + `:keywords' :: List of keywords attached to data.
1350 ;; - category :: option
1351 ;; - type :: string
1352 ;;
1353 ;; + `:language' :: Default language used for translations.
1354 ;; - category :: option
1355 ;; - type :: string
1356 ;;
1357 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1358 ;; transcoding.
1359 ;; - category :: option
1360 ;; - type :: list (as returned by `org-element-parse-buffer')
1361 ;;
1362 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1363 ;; all line breaks.
1364 ;; - category :: option
1365 ;; - type :: symbol (nil, t)
1366 ;;
1367 ;; + `:section-numbers' :: Non-nil means transcoding should add
1368 ;; section numbers to headlines.
1369 ;; - category :: option
1370 ;; - type :: symbol (nil, t)
1371 ;;
1372 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1373 ;; in transcoding. When such a tag is present, subtrees without
1374 ;; it are de facto excluded from the process. See
1375 ;; `use-select-tags'.
1376 ;; - category :: option
1377 ;; - type :: list of strings
1378 ;;
1379 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1380 ;; a time stamp in the output.
1381 ;; - category :: option
1382 ;; - type :: symbol (nil, t)
1383 ;;
1384 ;; + `:translate-alist' :: Alist between element and object types and
1385 ;; transcoding functions relative to the current back-end.
1386 ;; Special keys `inner-template', `template' and `plain-text' are
1387 ;; also possible.
1388 ;; - category :: option
1389 ;; - type :: alist (SYMBOL . FUNCTION)
1390 ;;
1391 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1392 ;; also be transcoded. If it is set to the `headline' symbol,
1393 ;; only the archived headline's name is retained.
1394 ;; - category :: option
1395 ;; - type :: symbol (nil, t, `headline')
1396 ;;
1397 ;; + `:with-author' :: Non-nil means author's name should be included
1398 ;; in the output.
1399 ;; - category :: option
1400 ;; - type :: symbol (nil, t)
1401 ;;
1402 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1403 ;; - category :: option
1404 ;; - type :: symbol (nil, t)
1405 ;;
1406 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1407 ;; inserted at the end of the transcoded string. If the value
1408 ;; is `comment', it should be commented.
1409 ;; - category :: option
1410 ;; - type :: symbol (`comment', nil, t)
1411 ;;
1412 ;; + `:with-date' :: Non-nil means output should contain a date.
1413 ;; - category :: option
1414 ;; - type :. symbol (nil, t)
1415 ;;
1416 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1417 ;; its value is a list of names, only drawers with such names
1418 ;; will be transcoded. If that list starts with `not', drawer
1419 ;; with these names will be skipped.
1420 ;; - category :: option
1421 ;; - type :: symbol (nil, t) or list of strings
1422 ;;
1423 ;; + `:with-email' :: Non-nil means output should contain author's
1424 ;; email.
1425 ;; - category :: option
1426 ;; - type :: symbol (nil, t)
1427 ;;
1428 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1429 ;; interpreted.
1430 ;; - category :: option
1431 ;; - type :: symbol (nil, t)
1432 ;;
1433 ;; + `:with-fixed-width' :: Non-nil if transcoder should export
1434 ;; strings starting with a colon as a fixed-with (verbatim) area.
1435 ;; - category :: option
1436 ;; - type :: symbol (nil, t)
1437 ;;
1438 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1439 ;; footnotes.
1440 ;; - category :: option
1441 ;; - type :: symbol (nil, t)
1442 ;;
1443 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1444 ;; `latex-fragment' objects should appear in export output. When
1445 ;; this property is set to `verbatim', they will be left as-is.
1446 ;; - category :: option
1447 ;; - type :: symbol (`verbatim', nil, t)
1448 ;;
1449 ;; + `:with-planning' :: Non-nil means transcoding should include
1450 ;; planning info.
1451 ;; - category :: option
1452 ;; - type :: symbol (nil, t)
1453 ;;
1454 ;; + `:with-priority' :: Non-nil means transcoding should include
1455 ;; priority cookies.
1456 ;; - category :: option
1457 ;; - type :: symbol (nil, t)
1458 ;;
1459 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1460 ;; plain text.
1461 ;; - category :: option
1462 ;; - type :: symbol (nil, t)
1463 ;;
1464 ;; + `:with-special-strings' :: Non-nil means transcoding should
1465 ;; interpret special strings in plain text.
1466 ;; - category :: option
1467 ;; - type :: symbol (nil, t)
1468 ;;
1469 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1470 ;; interpret subscript and superscript. With a value of "{}",
1471 ;; only interpret those using curly brackets.
1472 ;; - category :: option
1473 ;; - type :: symbol (nil, {}, t)
1474 ;;
1475 ;; + `:with-tables' :: Non-nil means transcoding should export tables.
1476 ;; - category :: option
1477 ;; - type :: symbol (nil, t)
1478 ;;
1479 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1480 ;; headlines. A `not-in-toc' value will remove them from the
1481 ;; table of contents, if any, nonetheless.
1482 ;; - category :: option
1483 ;; - type :: symbol (nil, t, `not-in-toc')
1484 ;;
1485 ;; + `:with-tasks' :: Non-nil means transcoding should include
1486 ;; headlines with a TODO keyword. A `todo' value will only
1487 ;; include headlines with a todo type keyword while a `done'
1488 ;; value will do the contrary. If a list of strings is provided,
1489 ;; only tasks with keywords belonging to that list will be kept.
1490 ;; - category :: option
1491 ;; - type :: symbol (t, todo, done, nil) or list of strings
1492 ;;
1493 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1494 ;; time stamps. Special value `active' (resp. `inactive') ask to
1495 ;; export only active (resp. inactive) timestamps. Otherwise,
1496 ;; completely remove them.
1497 ;; - category :: option
1498 ;; - type :: symbol: (`active', `inactive', t, nil)
1499 ;;
1500 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1501 ;; added to the output. An integer value limits its depth.
1502 ;; - category :: option
1503 ;; - type :: symbol (nil, t or integer)
1504 ;;
1505 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1506 ;; include TODO keywords.
1507 ;; - category :: option
1508 ;; - type :: symbol (nil, t)
1511 ;;;; Environment Options
1512 ;;
1513 ;; Environment options encompass all parameters defined outside the
1514 ;; scope of the parsed data. They come from five sources, in
1515 ;; increasing precedence order:
1516 ;;
1517 ;; - Global variables,
1518 ;; - Buffer's attributes,
1519 ;; - Options keyword symbols,
1520 ;; - Buffer keywords,
1521 ;; - Subtree properties.
1522 ;;
1523 ;; The central internal function with regards to environment options
1524 ;; is `org-export-get-environment'. It updates global variables with
1525 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1526 ;; the different sources.
1527 ;;
1528 ;; The internal functions doing the retrieval are:
1529 ;; `org-export--get-global-options',
1530 ;; `org-export--get-buffer-attributes',
1531 ;; `org-export--parse-option-keyword',
1532 ;; `org-export--get-subtree-options' and
1533 ;; `org-export--get-inbuffer-options'
1534 ;;
1535 ;; Also, `org-export--list-bound-variables' collects bound variables
1536 ;; along with their value in order to set them as buffer local
1537 ;; variables later in the process.
1540 "Collect export options from the current buffer.
1542 Optional argument BACKEND is an export back-end, as returned by
1543 `org-export-create-backend'.
1545 When optional argument SUBTREEP is non-nil, assume the export is
1546 done against the current sub-tree.
1548 Third optional argument EXT-PLIST is a property list with
1549 external parameters overriding Org default settings, but still
1550 inferior to file-local settings."
1551 ;; First install #+BIND variables since these must be set before
1552 ;; global options are read.
1555 ;; Get and prioritize export options...
1557 ;; ... from global variables...
1559 ;; ... from an external property list...
1560 ext-plist
1561 ;; ... from in-buffer settings...
1563 ;; ... and from subtree, when appropriate.
1565 ;; Eventually add misc. properties.
1567 :back-end
1568 backend
1570 :footnote-definition-alist
1571 ;; Footnotes definitions must be collected in the original
1572 ;; buffer, as there's no insurance that they will still be in
1573 ;; the parse tree, due to possible narrowing.
1589 alist))
1601 alist)))))))
1602 alist))
1603 :id-alist
1604 ;; Collect id references.
1615 alist))))
1618 "Parse an OPTIONS line and return values as a plist.
1619 Optional argument BACKEND is an export back-end, as returned by,
1620 e.g., `org-export-create-backend'. It specifies which back-end
1621 specific items to read, if any."
1623 ;; Priority is given to back-end specific options.
1625 org-export-options-alist))
1626 plist)
1635 options))
1637 property
1640 plist))
1643 "Get export options in subtree at point.
1644 Optional argument BACKEND is an export back-end, as returned by,
1645 e.g., `org-export-create-backend'. It specifies back-end used
1646 for export. Return options as a plist."
1647 ;; For each buffer keyword, create a headline property setting the
1648 ;; same property in communication channel. The name for the property
1649 ;; is the keyword with "EXPORT_" appended to it.
1652 ;; Make sure point is at a heading.
1654 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1655 ;; title (with no todo keyword, priority cookie or tag) as its
1656 ;; fallback value.
1662 plist :title
1665 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1669 ;; Handle other keywords. TITLE keyword is excluded as it has
1670 ;; been handled already.
1678 ;; Export properties are not case-sensitive.
1685 plist
1686 property
1688 ;; Parse VALUE if required.
1692 ;; If BEHAVIOR is `split' expected value is
1693 ;; a list of strings, not a string.
1696 ;; Look for both general keywords and back-end specific
1697 ;; options, with priority given to the latter.
1699 org-export-options-alist)))
1700 ;; Return value.
1701 plist)))
1704 "Return current buffer export options, as a plist.
1706 Optional argument BACKEND, when non-nil, is an export back-end,
1707 as returned by, e.g., `org-export-create-backend'. It specifies
1708 which back-end specific options should also be read in the
1709 process.
1711 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1713 get-options ; For byte-compiler.
1716 ;; Priority is given to back-end specific options.
1718 org-export-options-alist))
1721 org-export-special-keywords))))
1724 ;; Return all properties associated to KEYWORD.
1731 ;; Recursively read keywords in buffer. FILES is a list
1732 ;; of files read so far. PLIST is the current property
1733 ;; list obtained.
1742 ;; Options in `org-export-special-keywords'.
1746 ;; Avoid circular dependencies.
1756 plist
1761 plist
1767 ;; Options in `org-export-options-alist'.
1772 plist property
1773 ;; Handle value depending on specified
1774 ;; BEHAVIOR.
1780 " "
1793 ;; Return final value.
1794 plist))))
1795 ;; Read options in the current buffer.
1798 ;; Parse keywords specified in `org-element-document-properties'
1799 ;; and return PLIST.
1808 ;; When TITLE keyword sets an empty
1809 ;; string, make sure it doesn't
1810 ;; appear as nil in the plist.
1814 "Return properties related to buffer attributes, as a plist."
1815 ;; Store full path of input file name, or nil. For internal use.
1821 "Return global export options as a plist.
1822 Optional argument BACKEND, if non-nil, is an export back-end, as
1823 returned by, e.g., `org-export-create-backend'. It specifies
1824 which back-end specific export options should also be read in the
1825 process."
1827 ;; Priority is given to back-end specific options.
1829 org-export-options-alist)))
1835 plist
1836 prop
1837 ;; Evaluate default value provided. If keyword is
1838 ;; a member of `org-element-document-properties',
1839 ;; parse it as a secondary string before storing it.
1843 org-element-document-properties))
1846 value)))))))))
1849 "Return variables bound from BIND keywords in current buffer.
1850 Also look for BIND keywords in setup files. The return value is
1851 an alist where associations are (VARIABLE-NAME VALUE)."
1856 ;; Return an alist between variable names and their
1857 ;; value. FILES is a list of setup files names read so
1858 ;; far, used to avoid circular dependencies. ALIST is
1859 ;; the alist collected so far.
1870 ;; Enter setup file.
1880 alist))))))))))
1881 alist)))))
1882 ;; Return value in appropriate order of appearance.
1885 ;; defsubst org-export-get-parent must be defined before first use,
1886 ;; was originally defined in the topology section
1889 "Return BLOB parent or nil.
1890 BLOB is the element or object considered."
1893 ;;;; Tree Properties
1894 ;;
1895 ;; Tree properties are information extracted from parse tree. They
1896 ;; are initialized at the beginning of the transcoding process by
1897 ;; `org-export-collect-tree-properties'.
1898 ;;
1899 ;; Dedicated functions focus on computing the value of specific tree
1900 ;; properties during initialization. Thus,
1901 ;; `org-export--populate-ignore-list' lists elements and objects that
1902 ;; should be skipped during export, `org-export--get-min-level' gets
1903 ;; the minimal exportable level, used as a basis to compute relative
1904 ;; level for headlines. Eventually
1905 ;; `org-export--collect-headline-numbering' builds an alist between
1906 ;; headlines and their numbering.
1909 "Extract tree properties from parse tree.
1911 DATA is the parse tree from which information is retrieved. INFO
1912 is a list holding export options.
1914 Following tree properties are set or updated:
1916 `:exported-data' Hash table used to memoize results from
1917 `org-export-data'.
1919 `:footnote-definition-alist' List of footnotes definitions in
1920 original buffer and current parse tree.
1922 `:headline-offset' Offset between true level of headlines and
1923 local level. An offset of -1 means a headline
1924 of level 2 should be considered as a level
1925 1 headline in the context.
1927 `:headline-numbering' Alist of all headlines as key an the
1928 associated numbering as value.
1930 `:ignore-list' List of elements that should be ignored during
1931 export.
1933 Return updated plist."
1934 ;; Install the parse tree in the communication channel, in order to
1935 ;; use `org-export-get-genealogy' and al.
1937 ;; Get the list of elements and objects to ignore, and put it into
1938 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1939 ;; been done during parse tree filtering.
1942 :ignore-list
1945 ;; Compute `:headline-offset' in order to be able to use
1946 ;; `org-export-get-relative-level'.
1949 :headline-offset
1951 ;; Footnote definitions in parse tree override those stored in
1952 ;; `:footnote-definition-alist'. This way, any change to
1953 ;; a definition in the parse tree (e.g., through a parse tree
1954 ;; filter) propagates into the alist.
1961 defs))
1965 defs)))))
1967 ;; Properties order doesn't matter: get the rest of the tree
1968 ;; properties.
1972 info))
1975 "Return minimum exportable headline's level in DATA.
1976 DATA is parsed tree as returned by `org-element-parse-buffer'.
1977 OPTIONS is a plist holding export options."
1988 ;; If no headline was found, for the sake of consistency, set
1989 ;; minimum level to 1 nonetheless.
1993 "Return numbering of all exportable headlines in a parse tree.
1995 DATA is the parse tree. OPTIONS is the plist holding export
1996 options.
1998 Return an alist whose key is a headline and value is its
1999 associated numbering \(in the shape of a list of numbers\) or nil
2000 for a footnotes section."
2008 headline
2010 for idx from 0 to org-export-max-depth
2014 options)))
2017 "Return list of elements and objects to ignore during export.
2018 DATA is the parse tree to traverse. OPTIONS is the plist holding
2019 export options."
2021 ;; First find trees containing a select tag, if any.
2023 ;; If a select tag is active, also ignore the section before
2024 ;; the first headline, if any.
2028 first-element))))
2031 ;; Collect ignored elements or objects into IGNORE-LIST.
2037 ;; If headline is archived but tree below has
2038 ;; to be skipped, add it to ignore list.
2041 ;; Move into secondary string, if any.
2046 ;; Move into recursive objects/elements.
2048 ;; Main call.
2050 ;; Return value.
2051 ignore))
2054 "Return list of headlines and inlinetasks with a select tag in their tree.
2055 DATA is parsed data as returned by `org-element-parse-buffer'.
2056 INFO is a plist holding export options."
2058 walk-data ; For byte-compiler.
2068 ;; When a select tag is found, mark full
2069 ;; genealogy and every headline within the tree
2070 ;; as acceptable.
2073 genealogy
2076 selected-trees))
2077 ;; If at a headline, continue searching in tree,
2078 ;; recursively.
2088 selected-trees))
2091 "Non-nil when element or object BLOB should be skipped during export.
2092 OPTIONS is the plist holding export options. SELECTED, when
2093 non-nil, is a list of headlines or inlinetasks belonging to
2094 a tree with a select tag."
2101 ;; If `:with-drawers' value starts with `not', ignore
2102 ;; every drawer whose name belong to that list.
2103 ;; Otherwise, ignore drawers whose name isn't in that
2104 ;; list.
2121 ;; Ignore subtrees with an exclude tag.
2124 ;; When a select tag is present in the buffer, ignore any tree
2125 ;; without it.
2127 ;; Ignore commented sub-trees.
2129 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2131 ;; Ignore tasks, if specified by `:with-tasks' property.
2143 properties-set))))))
2154 ;; `:with-timestamps' only applies to isolated timestamps
2155 ;; objects, i.e. timestamp objects in a paragraph containing only
2156 ;; timestamps and whitespaces.
2164 options t))))
2173 \f
2174 ;;; The Transcoder
2175 ;;
2176 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2177 ;; `org-element-parse-buffer') and transcodes it into a specified
2178 ;; back-end output. It takes care of filtering out elements or
2179 ;; objects according to export options and organizing the output blank
2180 ;; lines and white space are preserved. The function memoizes its
2181 ;; results, so it is cheap to call it within transcoders.
2182 ;;
2183 ;; It is possible to modify locally the back-end used by
2184 ;; `org-export-data' or even use a temporary back-end by using
2185 ;; `org-export-data-with-backend'.
2186 ;;
2187 ;; Internally, three functions handle the filtering of objects and
2188 ;; elements during the export. In particular,
2189 ;; `org-export-ignore-element' marks an element or object so future
2190 ;; parse tree traversals skip it and `org-export-expand' transforms
2191 ;; the others back into their original shape.
2192 ;;
2193 ;; `org-export-transcoder' is an accessor returning appropriate
2194 ;; translator function for a given element or object.
2197 "Return appropriate transcoder for BLOB.
2198 INFO is a plist containing export directives."
2200 ;; Return contents only for complete parse trees.
2206 "Convert DATA into current back-end format.
2208 DATA is a parse tree, an element or an object or a secondary
2209 string. INFO is a plist holding export options.
2211 Return a string."
2216 ;; Ignored element/object.
2218 ;; Plain text.
2224 info))
2225 ;; Secondary string.
2228 ;; Element/Object without contents or, as a special
2229 ;; case, headline with archive tag and archived trees
2230 ;; restricted to title only.
2238 ;; Export snippets never return a nil value so
2239 ;; that white spaces following them are never
2240 ;; ignored.
2242 ;; Element/Object with contents.
2255 ;; Elements directly containing
2256 ;; objects must have their indentation
2257 ;; normalized first.
2259 data
2260 ;; When normalizing contents of the
2261 ;; first paragraph in an item or
2262 ;; a footnote definition, ignore
2263 ;; first line's indentation: there is
2264 ;; none and it might be misleading.
2269 data)
2276 info))))))))
2277 ;; Final result will be memoized before being returned.
2279 data
2283 ;; Append the same white space between elements or objects
2284 ;; as in the original buffer, and call appropriate filters.
2295 info)))
2296 results)))
2300 "Convert DATA into BACKEND format.
2302 DATA is an element, an object, a secondary string or a string.
2303 BACKEND is a symbol. INFO is a plist used as a communication
2304 channel.
2306 Unlike to `org-export-with-backend', this function will
2307 recursively convert DATA using BACKEND translation table."
2310 data
2311 ;; Set-up a new communication channel with translations defined in
2312 ;; BACKEND as the translate table and a new hash table for
2313 ;; memoization.
2315 info
2318 ;; Size of the hash table is reduced since this function
2319 ;; will probably be used on small trees.
2323 "Change uninterpreted elements back into Org syntax.
2324 DATA is the parse tree. INFO is a plist containing export
2325 options. Each uninterpreted element or object is changed back
2326 into a string. Contents, if any, are not modified. The parse
2327 tree is modified by side effect and returned by the function."
2331 prop
2334 info))))
2337 "Change uninterpreted elements back into Org syntax.
2338 DATA is a parse tree or a secondary string. INFO is a plist
2339 containing export options. It is modified by side effect and
2340 returned by the function."
2343 subscript superscript underline)
2347 ;; ... entities...
2354 ?\s)))))
2355 ;; ... emphasis...
2367 marker
2371 ?\s)))))))
2372 ;; ... LaTeX environments and fragments...
2376 ;; ... sub/superscripts...
2385 "_"
2394 ?\s)))))))))))
2396 ;; Splice NEW at BLOB location in parse tree.
2399 info)
2400 ;; Return modified parse tree.
2401 data)
2404 "Expand a parsed element or object to its original state.
2406 BLOB is either an element or an object. CONTENTS is its
2407 contents, as a string or nil.
2409 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2410 keywords before output."
2415 blob contents))))
2418 "Add ELEMENT to `:ignore-list' in INFO.
2420 Any element in `:ignore-list' will be skipped when using
2421 `org-element-map'. INFO is modified by side effects."
2425 \f
2426 ;;; The Filter System
2427 ;;
2428 ;; Filters allow end-users to tweak easily the transcoded output.
2429 ;; They are the functional counterpart of hooks, as every filter in
2430 ;; a set is applied to the return value of the previous one.
2431 ;;
2432 ;; Every set is back-end agnostic. Although, a filter is always
2433 ;; called, in addition to the string it applies to, with the back-end
2434 ;; used as argument, so it's easy for the end-user to add back-end
2435 ;; specific filters in the set. The communication channel, as
2436 ;; a plist, is required as the third argument.
2437 ;;
2438 ;; From the developer side, filters sets can be installed in the
2439 ;; process with the help of `org-export-define-backend', which
2440 ;; internally stores filters as an alist. Each association has a key
2441 ;; among the following symbols and a function or a list of functions
2442 ;; as value.
2443 ;;
2444 ;; - `:filter-options' applies to the property list containing export
2445 ;; options. Unlike to other filters, functions in this list accept
2446 ;; two arguments instead of three: the property list containing
2447 ;; export options and the back-end. Users can set its value through
2448 ;; `org-export-filter-options-functions' variable.
2449 ;;
2450 ;; - `:filter-parse-tree' applies directly to the complete parsed
2451 ;; tree. Users can set it through
2452 ;; `org-export-filter-parse-tree-functions' variable.
2453 ;;
2454 ;; - `:filter-final-output' applies to the final transcoded string.
2455 ;; Users can set it with `org-export-filter-final-output-functions'
2456 ;; variable
2457 ;;
2458 ;; - `:filter-plain-text' applies to any string not recognized as Org
2459 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2460 ;; configure it.
2461 ;;
2462 ;; - `:filter-TYPE' applies on the string returned after an element or
2463 ;; object of type TYPE has been transcoded. A user can modify
2464 ;; `org-export-filter-TYPE-functions'
2465 ;;
2466 ;; All filters sets are applied with
2467 ;; `org-export-filter-apply-functions' function. Filters in a set are
2468 ;; applied in a LIFO fashion. It allows developers to be sure that
2469 ;; their filters will be applied first.
2470 ;;
2471 ;; Filters properties are installed in communication channel with
2472 ;; `org-export-install-filters' function.
2473 ;;
2474 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2475 ;; `org-export-before-parsing-hook') are run at the beginning of the
2476 ;; export process and just before parsing to allow for heavy structure
2477 ;; modifications.
2480 ;;;; Hooks
2483 "Hook run at the beginning of the export process.
2485 This is run before include keywords and macros are expanded and
2486 Babel code blocks executed, on a copy of the original buffer
2487 being exported. Visibility and narrowing are preserved. Point
2488 is at the beginning of the buffer.
2490 Every function in this hook will be called with one argument: the
2494 "Hook run before parsing an export buffer.
2496 This is run after include keywords and macros have been expanded
2497 and Babel code blocks executed, on a copy of the original buffer
2498 being exported. Visibility and narrowing are preserved. Point
2499 is at the beginning of the buffer.
2501 Every function in this hook will be called with one argument: the
2505 ;;;; Special Filters
2508 "List of functions applied to the export options.
2509 Each filter is called with two arguments: the export options, as
2510 a plist, and the back-end, as a symbol. It must return
2514 "List of functions applied to the parsed tree.
2515 Each filter is called with three arguments: the parse tree, as
2516 returned by `org-element-parse-buffer', the back-end, as
2517 a symbol, and the communication channel, as a plist. It must
2521 "List of functions applied to plain text.
2522 Each filter is called with three arguments: a string which
2523 contains no Org syntax, the back-end, as a symbol, and the
2524 communication channel, as a plist. It must return a string or
2528 "List of functions applied to the transcoded string.
2529 Each filter is called with three arguments: the full transcoded
2530 string, the back-end, as a symbol, and the communication channel,
2531 as a plist. It must return a string that will be used as the
2535 ;;;; Elements Filters
2538 "List of functions applied to a transcoded babel-call.
2539 Each filter is called with three arguments: the transcoded data,
2540 as a string, the back-end, as a symbol, and the communication
2544 "List of functions applied to a transcoded center block.
2545 Each filter is called with three arguments: the transcoded data,
2546 as a string, the back-end, as a symbol, and the communication
2550 "List of functions applied to a transcoded clock.
2551 Each filter is called with three arguments: the transcoded data,
2552 as a string, the back-end, as a symbol, and the communication
2556 "List of functions applied to a transcoded comment.
2557 Each filter is called with three arguments: the transcoded data,
2558 as a string, the back-end, as a symbol, and the communication
2562 "List of functions applied to a transcoded comment-block.
2563 Each filter is called with three arguments: the transcoded data,
2564 as a string, the back-end, as a symbol, and the communication
2568 "List of functions applied to a transcoded diary-sexp.
2569 Each filter is called with three arguments: the transcoded data,
2570 as a string, the back-end, as a symbol, and the communication
2574 "List of functions applied to a transcoded drawer.
2575 Each filter is called with three arguments: the transcoded data,
2576 as a string, the back-end, as a symbol, and the communication
2580 "List of functions applied to a transcoded dynamic-block.
2581 Each filter is called with three arguments: the transcoded data,
2582 as a string, the back-end, as a symbol, and the communication
2586 "List of functions applied to a transcoded example-block.
2587 Each filter is called with three arguments: the transcoded data,
2588 as a string, the back-end, as a symbol, and the communication
2592 "List of functions applied to a transcoded fixed-width.
2593 Each filter is called with three arguments: the transcoded data,
2594 as a string, the back-end, as a symbol, and the communication
2598 "List of functions applied to a transcoded footnote-definition.
2599 Each filter is called with three arguments: the transcoded data,
2600 as a string, the back-end, as a symbol, and the communication
2604 "List of functions applied to a transcoded headline.
2605 Each filter is called with three arguments: the transcoded data,
2606 as a string, the back-end, as a symbol, and the communication
2610 "List of functions applied to a transcoded horizontal-rule.
2611 Each filter is called with three arguments: the transcoded data,
2612 as a string, the back-end, as a symbol, and the communication
2616 "List of functions applied to a transcoded inlinetask.
2617 Each filter is called with three arguments: the transcoded data,
2618 as a string, the back-end, as a symbol, and the communication
2622 "List of functions applied to a transcoded item.
2623 Each filter is called with three arguments: the transcoded data,
2624 as a string, the back-end, as a symbol, and the communication
2628 "List of functions applied to a transcoded keyword.
2629 Each filter is called with three arguments: the transcoded data,
2630 as a string, the back-end, as a symbol, and the communication
2634 "List of functions applied to a transcoded latex-environment.
2635 Each filter is called with three arguments: the transcoded data,
2636 as a string, the back-end, as a symbol, and the communication
2640 "List of functions applied to a transcoded node-property.
2641 Each filter is called with three arguments: the transcoded data,
2642 as a string, the back-end, as a symbol, and the communication
2646 "List of functions applied to a transcoded paragraph.
2647 Each filter is called with three arguments: the transcoded data,
2648 as a string, the back-end, as a symbol, and the communication
2652 "List of functions applied to a transcoded plain-list.
2653 Each filter is called with three arguments: the transcoded data,
2654 as a string, the back-end, as a symbol, and the communication
2658 "List of functions applied to a transcoded planning.
2659 Each filter is called with three arguments: the transcoded data,
2660 as a string, the back-end, as a symbol, and the communication
2664 "List of functions applied to a transcoded property-drawer.
2665 Each filter is called with three arguments: the transcoded data,
2666 as a string, the back-end, as a symbol, and the communication
2670 "List of functions applied to a transcoded quote block.
2671 Each filter is called with three arguments: the transcoded quote
2672 data, as a string, the back-end, as a symbol, and the
2673 communication channel, as a plist. It must return a string or
2677 "List of functions applied to a transcoded section.
2678 Each filter is called with three arguments: the transcoded data,
2679 as a string, the back-end, as a symbol, and the communication
2683 "List of functions applied to a transcoded special block.
2684 Each filter is called with three arguments: the transcoded data,
2685 as a string, the back-end, as a symbol, and the communication
2689 "List of functions applied to a transcoded src-block.
2690 Each filter is called with three arguments: the transcoded data,
2691 as a string, the back-end, as a symbol, and the communication
2695 "List of functions applied to a transcoded table.
2696 Each filter is called with three arguments: the transcoded data,
2697 as a string, the back-end, as a symbol, and the communication
2701 "List of functions applied to a transcoded table-cell.
2702 Each filter is called with three arguments: the transcoded data,
2703 as a string, the back-end, as a symbol, and the communication
2707 "List of functions applied to a transcoded table-row.
2708 Each filter is called with three arguments: the transcoded data,
2709 as a string, the back-end, as a symbol, and the communication
2713 "List of functions applied to a transcoded verse block.
2714 Each filter is called with three arguments: the transcoded data,
2715 as a string, the back-end, as a symbol, and the communication
2719 ;;;; Objects Filters
2722 "List of functions applied to transcoded bold text.
2723 Each filter is called with three arguments: the transcoded data,
2724 as a string, the back-end, as a symbol, and the communication
2728 "List of functions applied to transcoded code text.
2729 Each filter is called with three arguments: the transcoded data,
2730 as a string, the back-end, as a symbol, and the communication
2734 "List of functions applied to a transcoded entity.
2735 Each filter is called with three arguments: the transcoded data,
2736 as a string, the back-end, as a symbol, and the communication
2740 "List of functions applied to a transcoded export-snippet.
2741 Each filter is called with three arguments: the transcoded data,
2742 as a string, the back-end, as a symbol, and the communication
2746 "List of functions applied to a transcoded footnote-reference.
2747 Each filter is called with three arguments: the transcoded data,
2748 as a string, the back-end, as a symbol, and the communication
2752 "List of functions applied to a transcoded inline-babel-call.
2753 Each filter is called with three arguments: the transcoded data,
2754 as a string, the back-end, as a symbol, and the communication
2758 "List of functions applied to a transcoded inline-src-block.
2759 Each filter is called with three arguments: the transcoded data,
2760 as a string, the back-end, as a symbol, and the communication
2764 "List of functions applied to transcoded italic text.
2765 Each filter is called with three arguments: the transcoded data,
2766 as a string, the back-end, as a symbol, and the communication
2770 "List of functions applied to a transcoded latex-fragment.
2771 Each filter is called with three arguments: the transcoded data,
2772 as a string, the back-end, as a symbol, and the communication
2776 "List of functions applied to a transcoded line-break.
2777 Each filter is called with three arguments: the transcoded data,
2778 as a string, the back-end, as a symbol, and the communication
2782 "List of functions applied to a transcoded link.
2783 Each filter is called with three arguments: the transcoded data,
2784 as a string, the back-end, as a symbol, and the communication
2788 "List of functions applied to a transcoded radio-target.
2789 Each filter is called with three arguments: the transcoded data,
2790 as a string, the back-end, as a symbol, and the communication
2794 "List of functions applied to a transcoded statistics-cookie.
2795 Each filter is called with three arguments: the transcoded data,
2796 as a string, the back-end, as a symbol, and the communication
2800 "List of functions applied to transcoded strike-through text.
2801 Each filter is called with three arguments: the transcoded data,
2802 as a string, the back-end, as a symbol, and the communication
2806 "List of functions applied to a transcoded subscript.
2807 Each filter is called with three arguments: the transcoded data,
2808 as a string, the back-end, as a symbol, and the communication
2812 "List of functions applied to a transcoded superscript.
2813 Each filter is called with three arguments: the transcoded data,
2814 as a string, the back-end, as a symbol, and the communication
2818 "List of functions applied to a transcoded target.
2819 Each filter is called with three arguments: the transcoded data,
2820 as a string, the back-end, as a symbol, and the communication
2824 "List of functions applied to a transcoded timestamp.
2825 Each filter is called with three arguments: the transcoded data,
2826 as a string, the back-end, as a symbol, and the communication
2830 "List of functions applied to transcoded underline text.
2831 Each filter is called with three arguments: the transcoded data,
2832 as a string, the back-end, as a symbol, and the communication
2836 "List of functions applied to transcoded verbatim text.
2837 Each filter is called with three arguments: the transcoded data,
2838 as a string, the back-end, as a symbol, and the communication
2842 ;;;; Filters Tools
2843 ;;
2844 ;; Internal function `org-export-install-filters' installs filters
2845 ;; hard-coded in back-ends (developer filters) and filters from global
2846 ;; variables (user filters) in the communication channel.
2847 ;;
2848 ;; Internal function `org-export-filter-apply-functions' takes care
2849 ;; about applying each filter in order to a given data. It ignores
2850 ;; filters returning a nil value but stops whenever a filter returns
2851 ;; an empty string.
2854 "Call every function in FILTERS.
2856 Functions are called with arguments VALUE, current export
2857 back-end's name and INFO. A function returning a nil value will
2858 be skipped. If it returns the empty string, the process ends and
2859 VALUE is ignored.
2861 Call is done in a LIFO fashion, to be sure that developer
2862 specified filters, if any, are called first."
2873 "Install filters properties in communication channel.
2874 INFO is a plist containing the current communication channel.
2875 Return the updated communication channel."
2877 ;; Install user-defined filters with `org-export-filters-alist'
2878 ;; and filters already in INFO (through ext-plist mechanism).
2885 ;; Filters in INFO will be called
2886 ;; before those user provided.
2889 default-value)))))
2890 org-export-filters-alist)
2891 ;; Prepend back-end specific filters to that list.
2893 ;; Single values get consed, lists are appended.
2898 plist key
2902 ;; Return new communication channel.
2906 \f
2907 ;;; Core functions
2908 ;;
2909 ;; This is the room for the main function, `org-export-as', along with
2910 ;; its derivative, `org-export-string-as'.
2911 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2912 ;; function should be added to kill ring.
2913 ;;
2914 ;; Note that `org-export-as' doesn't really parse the current buffer,
2915 ;; but a copy of it (with the same buffer-local variables and
2916 ;; visibility), where macros and include keywords are expanded and
2917 ;; Babel blocks are executed, if appropriate.
2918 ;; `org-export-with-buffer-copy' macro prepares that copy.
2919 ;;
2920 ;; File inclusion is taken care of by
2921 ;; `org-export-expand-include-keyword' and
2922 ;; `org-export--prepare-file-contents'. Structure wise, including
2923 ;; a whole Org file in a buffer often makes little sense. For
2924 ;; example, if the file contains a headline and the include keyword
2925 ;; was within an item, the item should contain the headline. That's
2926 ;; why file inclusion should be done before any structure can be
2927 ;; associated to the file, that is before parsing.
2928 ;;
2929 ;; `org-export-insert-default-template' is a command to insert
2930 ;; a default template (or a back-end specific template) at point or in
2931 ;; current subtree.
2934 "Return a copy of the current buffer.
2935 The copy preserves Org buffer-local variables, visibility and
2936 narrowing."
2942 new-buf))
2945 "Apply BODY in a copy of the current buffer.
2946 The copy preserves local variables, visibility and contents of
2947 the original buffer. Point is at the beginning of the buffer
2948 when BODY is applied."
2957 ;; Kill copy without confirmation.
2963 "Generate a function duplicating BUFFER.
2965 The copy will preserve local variables, visibility, contents and
2966 narrowing of the original buffer. If a region was active in
2967 BUFFER, contents will be narrowed to that region instead.
2969 The resulting function can be evaluated at a later time, from
2970 another buffer, effectively cloning the original buffer there.
2972 The function assumes BUFFER's major mode is `org-mode'."
2976 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2977 ;; already in BUFFER.
2979 ;; Copy specific buffer local variables and variables set
2980 ;; through BIND keywords.
2982 vars)
2990 buffer-file-name
2991 buffer-file-coding-system))
2995 ;; Skip unreadable values, as they cannot be
2996 ;; sent to external process.
3000 vars))))))
3001 ;; Whole buffer contents.
3006 ;; Narrowing.
3010 ;; Current position of point.
3012 ;; Overlays with invisible property.
3022 ov-set))))
3024 ov-set)))))
3026 ;;;###autoload
3029 "Transcode current Org buffer into BACKEND code.
3031 BACKEND is either an export back-end, as returned by, e.g.,
3032 `org-export-create-backend', or a symbol referring to
3033 a registered back-end.
3035 If narrowing is active in the current buffer, only transcode its
3036 narrowed part.
3038 If a region is active, transcode that region.
3040 When optional argument SUBTREEP is non-nil, transcode the
3041 sub-tree at point, extracting information from the headline
3042 properties first.
3044 When optional argument VISIBLE-ONLY is non-nil, don't export
3045 contents of hidden elements.
3047 When optional argument BODY-ONLY is non-nil, only return body
3048 code, without surrounding template.
3050 Optional argument EXT-PLIST, when provided, is a property list
3051 with external parameters overriding Org default settings, but
3052 still inferior to file-local settings.
3054 Return code as a string."
3059 ;; Narrow buffer to an appropriate region or subtree for
3060 ;; parsing. If parsing subtree, be sure to remove main headline
3061 ;; too.
3069 ;; Initialize communication channel with original buffer
3070 ;; attributes, unavailable in its copy.
3079 tree)
3080 ;; Update communication channel and get parse tree. Buffer
3081 ;; isn't parsed directly. Instead, a temporary copy is
3082 ;; created, where include keywords, macros are expanded and
3083 ;; code blocks are evaluated.
3085 ;; Run first hook with current back-end's name as argument.
3089 ;; Update macro templates since #+INCLUDE keywords might have
3090 ;; added some new ones.
3094 ;; Update radio targets since keyword inclusion might have
3095 ;; added some more.
3097 ;; Run last hook with current back-end's name as argument.
3102 ;; Update communication channel with environment. Also
3103 ;; install user's and developer's filters.
3108 ;; Special case: provide original file name or buffer name as
3109 ;; default value for :title property.
3112 info :title
3116 ;; Expand export-specific set of macros: {{{author}}},
3117 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3118 ;; once regular macros have been expanded, since document
3119 ;; keywords may contain one of them.
3125 ;; EMAIL is not a parsed keyword: store it as-is.
3129 ;; Parse buffer.
3131 ;; Handle left-over uninterpreted elements or objects in
3132 ;; parse tree and communication channel.
3134 ;; Call options filters and update export options. We do not
3135 ;; use `org-export-filter-apply-functions' here since the
3136 ;; arity of such filters is different.
3141 ;; Parse buffer, handle uninterpreted elements or objects,
3142 ;; then call parse-tree filters.
3146 ;; Now tree is complete, compute its properties and add them
3147 ;; to communication channel.
3151 ;; Eventually transcode TREE. Wrap the resulting string into
3152 ;; a template.
3161 ;; Remove all text properties since they cannot be
3162 ;; retrieved from an external process. Finally call
3163 ;; final-output filter and return result.
3169 info))))))))
3171 ;;;###autoload
3173 "Transcode STRING into BACKEND code.
3175 BACKEND is either an export back-end, as returned by, e.g.,
3176 `org-export-create-backend', or a symbol referring to
3177 a registered back-end.
3179 When optional argument BODY-ONLY is non-nil, only return body
3180 code, without preamble nor postamble.
3182 Optional argument EXT-PLIST, when provided, is a property list
3183 with external parameters overriding Org default settings, but
3184 still inferior to file-local settings.
3186 Return code as a string."
3192 ;;;###autoload
3194 "Replace the active region by its export to BACKEND.
3195 BACKEND is either an export back-end, as returned by, e.g.,
3196 `org-export-create-backend', or a symbol referring to
3197 a registered back-end."
3207 ;;;###autoload
3209 "Insert all export keywords with default values at beginning of line.
3211 BACKEND is a symbol referring to the name of a registered export
3212 back-end, for which specific export options should be added to
3213 the template, or `default' for default template. When it is nil,
3214 the user will be prompted for a category.
3216 If SUBTREEP is non-nil, export configuration will be set up
3217 locally for the subtree through node properties."
3227 "Options category: "
3231 org-export--registered-backends))
3232 nil t))))
3233 options keywords)
3234 ;; Populate OPTIONS and KEYWORDS.
3251 ;; Move to an appropriate location in order to insert options.
3253 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3271 ;; Then the rest of keywords, in the order specified in either
3272 ;; `org-export-options-alist' or respective export back-ends.
3293 "Expand every include keyword in buffer.
3294 Optional argument INCLUDED is a list of included file names along
3295 with their line restriction, when appropriate. It is used to
3296 avoid infinite recursion. Optional argument DIR is the current
3297 working directory. It is used to properly resolve relative
3298 paths."
3307 ;; Extract arguments from keyword's value.
3315 dir)
3320 value)
3327 ;; Minimal level of included file defaults to the child
3328 ;; level of the current headline, if any, or one. It
3329 ;; only applies is the file is meant to be included as
3330 ;; an Org one.
3342 ;; Remove keyword.
3348 ;; Check if files has already been parsed. Look after
3349 ;; inclusion lines too, as different parts of the same file
3350 ;; can be included too.
3365 ind-str block arg-str contents ind-str block))))
3372 ind-str block contents ind-str block))))
3379 file lines ind minlevel
3388 "Prepare the contents of FILE for inclusion and return them as a string.
3390 When optional argument LINES is a string specifying a range of
3391 lines, include only those lines.
3393 Optional argument IND, when non-nil, is an integer specifying the
3394 global indentation of returned contents. Since its purpose is to
3395 allow an included file to stay in the same environment it was
3396 created \(i.e. a list item), it doesn't apply past the first
3397 headline encountered.
3399 Optional argument MINLEVEL, when non-nil, is an integer
3400 specifying the level that any top-level headline in the included
3401 file should have.
3403 Optional argument ID is an integer that will be inserted before
3404 each footnote definition and reference if FILE is an Org file.
3405 This is useful to avoid conflicts when more than one Org file
3406 with footnotes is included in a document."
3422 ;; Remove blank lines at beginning and end of contents. The logic
3423 ;; behind that removal is that blank lines around include keyword
3424 ;; override blank lines in included file.
3433 ;; If IND is set, preserve indentation of include keyword until
3434 ;; the first headline encountered.
3441 ;; Do not move footnote definitions out of column 0.
3447 ;; When MINLEVEL is specified, compute minimal level for headlines
3448 ;; in the file (CUR-MIN), and remove stars to each headline so
3449 ;; that headlines with minimal level have a level of MINLEVEL.
3460 ;; Only change stars, don't bother moving whole
3461 ;; sections.
3465 ;; Append ID to all footnote references and definitions, so they
3466 ;; become file specific and cannot collide with footnotes in other
3467 ;; included files.
3484 "Execute every Babel code in the visible part of current buffer."
3485 ;; Get a pristine copy of current buffer so Babel references can be
3486 ;; properly resolved.
3492 "Return a non-nil value when output should be added to the kill ring.
3493 See also `org-export-copy-to-kill-ring'."
3499 \f
3500 ;;; Tools For Back-Ends
3501 ;;
3502 ;; A whole set of tools is available to help build new exporters. Any
3503 ;; function general enough to have its use across many back-ends
3504 ;; should be added here.
3506 ;;;; For Affiliated Keywords
3507 ;;
3508 ;; `org-export-read-attribute' reads a property from a given element
3509 ;; as a plist. It can be used to normalize affiliated keywords'
3510 ;; syntax.
3511 ;;
3512 ;; Since captions can span over multiple lines and accept dual values,
3513 ;; their internal representation is a bit tricky. Therefore,
3514 ;; `org-export-get-caption' transparently returns a given element's
3515 ;; caption as a secondary string.
3518 "Turn ATTRIBUTE property from ELEMENT into a plist.
3520 When optional argument PROPERTY is non-nil, return the value of
3521 that property within attributes.
3525 properties.
3527 All values will become strings except the empty string and
3530 will become the empty string."
3544 s)
3549 ;; Ignore any string before first property with `cdr'.
3554 "Return caption from ELEMENT as a secondary string.
3556 When optional argument SHORTP is non-nil, return short caption,
3557 as a secondary string, instead.
3559 Caption lines are separated by a white space."
3567 ;;;; For Derived Back-ends
3568 ;;
3569 ;; `org-export-with-backend' is a function allowing to locally use
3570 ;; another back-end to transcode some object or element. In a derived
3571 ;; back-end, it may be used as a fall-back function once all specific
3572 ;; cases have been treated.
3575 "Call a transcoder from BACKEND on DATA.
3576 BACKEND is an export back-end, as returned by, e.g.,
3577 `org-export-create-backend', or a symbol referring to
3578 a registered back-end. DATA is an Org element, object, secondary
3579 string or string. CONTENTS, when non-nil, is the transcoded
3580 contents of DATA element, as a string. INFO, when non-nil, is
3581 the communication channel used for export, as a plist."
3591 transcoder data contents
3594 :translate-alist all-transcoders
3598 ;;;; For Export Snippets
3599 ;;
3600 ;; Every export snippet is transmitted to the back-end. Though, the
3601 ;; latter will only retain one type of export-snippet, ignoring
3602 ;; others, based on the former's target back-end. The function
3603 ;; `org-export-snippet-backend' returns that back-end for a given
3604 ;; export-snippet.
3607 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3608 Translation, with `org-export-snippet-translation-alist', is
3609 applied."
3613 back-end))))
3616 ;;;; For Footnotes
3617 ;;
3618 ;; `org-export-collect-footnote-definitions' is a tool to list
3619 ;; actually used footnotes definitions in the whole parse tree, or in
3620 ;; a headline, in order to add footnote listings throughout the
3621 ;; transcoded data.
3622 ;;
3623 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3624 ;; back-ends, when they need to attach the footnote definition only to
3625 ;; the first occurrence of the corresponding label.
3626 ;;
3627 ;; `org-export-get-footnote-definition' and
3628 ;; `org-export-get-footnote-number' provide easier access to
3629 ;; additional information relative to a footnote reference.
3632 "Return an alist between footnote numbers, labels and definitions.
3634 DATA is the parse tree from which definitions are collected.
3635 INFO is the plist used as a communication channel.
3637 Definitions are sorted by order of references. They either
3638 appear as Org data or as a secondary string for inlined
3639 footnotes. Unreferenced definitions are ignored."
3641 collect-fn ; for byte-compiler.
3645 ;; Collect footnote number, label and definition in DATA.
3653 def)
3654 num-alist)
3655 ;; Also search in definition for nested footnotes.
3658 ;; Don't enter footnote definitions since it will happen
3659 ;; when their first reference is found.
3665 "Non-nil when a footnote reference is the first one for its label.
3667 FOOTNOTE-REFERENCE is the footnote reference being considered.
3668 INFO is the plist used as a communication channel."
3670 ;; Anonymous footnotes are always a first reference.
3672 ;; Otherwise, return the first footnote with the same LABEL and
3673 ;; test if it is equal to FOOTNOTE-REFERENCE.
3683 ;; If FN isn't inlined, be sure to traverse its
3684 ;; definition before resuming search. See
3685 ;; comments in `org-export-get-footnote-number'
3686 ;; for more information.
3690 ;; Don't enter footnote definitions since it will
3691 ;; happen when their first reference is found.
3694 footnote-reference)))))
3697 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3698 INFO is the plist used as a communication channel. If no such
3707 "Return number associated to a footnote.
3709 FOOTNOTE is either a footnote reference or a footnote definition.
3710 INFO is the plist used as a communication channel."
3712 seen-refs
3713 search-ref ; For byte-compiler.
3717 ;; Search footnote references through DATA, filling
3718 ;; SEEN-REFS along the way.
3723 ;; Anonymous footnote match: return number.
3726 ;; Labels match: return number.
3729 ;; Anonymous footnote: it's always a new one.
3730 ;; Also, be sure to return nil from the `cond' so
3731 ;; `first-match' doesn't get us out of the loop.
3733 ;; Label not seen so far: add it so SEEN-REFS.
3734 ;;
3735 ;; Also search for subsequent references in
3736 ;; footnote definition so numbering follows
3737 ;; reading logic. Note that we don't have to care
3738 ;; about inline definitions, since
3739 ;; `org-element-map' already traverses them at the
3740 ;; right time.
3741 ;;
3742 ;; Once again, return nil to stay in the loop.
3747 nil))))
3748 ;; Don't enter footnote definitions since it will
3749 ;; happen when their first reference is found.
3754 ;;;; For Headlines
3755 ;;
3756 ;; `org-export-get-relative-level' is a shortcut to get headline
3757 ;; level, relatively to the lower headline level in the parsed tree.
3758 ;;
3759 ;; `org-export-get-headline-number' returns the section number of an
3760 ;; headline, while `org-export-number-to-roman' allows to convert it
3761 ;; to roman numbers.
3762 ;;
3763 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3764 ;; `org-export-last-sibling-p' are three useful predicates when it
3765 ;; comes to fulfill the `:headline-levels' property.
3766 ;;
3767 ;; `org-export-get-tags', `org-export-get-category' and
3768 ;; `org-export-get-node-property' extract useful information from an
3769 ;; headline or a parent headline. They all handle inheritance.
3770 ;;
3771 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3772 ;; as a secondary string, suitable for table of contents. It falls
3773 ;; back onto default title.
3776 "Return HEADLINE relative level within current parsed tree.
3777 INFO is a plist holding contextual information."
3782 "Non-nil when HEADLINE is considered as low level.
3784 INFO is a plist used as a communication channel.
3786 A low level headlines has a relative level greater than
3787 `:headline-levels' property value.
3789 Return value is the difference between HEADLINE relative level
3790 and the last level being considered as high enough, or nil."
3797 "Return HEADLINE numbering as a list of numbers.
3798 INFO is a plist holding contextual information."
3802 "Return a non-nil value if HEADLINE element should be numbered.
3803 INFO is a plist used as a communication channel."
3809 "Convert integer N into a roman numeral."
3822 res)))
3825 "Return list of tags associated to ELEMENT.
3827 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3828 is a plist used as a communication channel.
3830 Select tags (see `org-export-select-tags') and exclude tags (see
3831 `org-export-exclude-tags') are removed from the list.
3833 When non-nil, optional argument TAGS should be a list of strings.
3834 Any tag belonging to this list will also be removed.
3836 When optional argument INHERITED is non-nil, tags can also be
3837 inherited from parent headlines and FILETAGS keywords."
3843 ;; Build complete list of inherited tags.
3854 ;; Add FILETAGS keywords and return results.
3858 "Return node PROPERTY value for BLOB.
3860 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3861 element or object.
3863 If optional argument INHERITED is non-nil, the value can be
3864 inherited from a parent headline.
3866 Return value is a string or nil."
3878 "Return category for element or object BLOB.
3880 INFO is a plist used as a communication channel.
3882 CATEGORY is automatically inherited from a parent headline, from
3883 #+CATEGORY: keyword or created out of original file name. If all
3896 "Return alternative title for HEADLINE, as a secondary string.
3897 INFO is a plist used as a communication channel. If no optional
3898 title is defined, fall-back to the regular title."
3903 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3904 INFO is a plist used as a communication channel."
3909 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3910 INFO is a plist used as a communication channel."
3914 ;;;; For Keywords
3915 ;;
3916 ;; `org-export-get-date' returns a date appropriate for the document
3917 ;; to about to be exported. In particular, it takes care of
3918 ;; `org-export-date-timestamp-format'.
3921 "Return date value for the current document.
3923 INFO is a plist used as a communication channel. FMT, when
3924 non-nil, is a time format string that will be applied on the date
3925 if it consists in a single timestamp object. It defaults to
3926 `org-export-date-timestamp-format' when nil.
3928 A proper date can be a secondary string, a string or nil. It is
3929 meant to be translated with `org-export-data' or alike."
3940 ;;;; For Links
3941 ;;
3942 ;; `org-export-solidify-link-text' turns a string into a safer version
3943 ;; for links, replacing most non-standard characters with hyphens.
3944 ;;
3945 ;; `org-export-get-coderef-format' returns an appropriate format
3946 ;; string for coderefs.
3947 ;;
3948 ;; `org-export-inline-image-p' returns a non-nil value when the link
3949 ;; provided should be considered as an inline image.
3950 ;;
3951 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3952 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3953 ;; returns an appropriate unique identifier when found, or nil.
3954 ;;
3955 ;; `org-export-resolve-id-link' returns the first headline with
3956 ;; specified id or custom-id in parse tree, the path to the external
3957 ;; file with the id or nil when neither was found.
3958 ;;
3959 ;; `org-export-resolve-coderef' associates a reference to a line
3960 ;; number in the element it belongs, or returns the reference itself
3961 ;; when the element isn't numbered.
3964 "Take link text S and make a safe target out of it."
3969 "Return format string for code reference link.
3970 PATH is the link path. DESC is its description."
3978 "Non-nil if LINK object points to an inline image.
3980 Optional argument is a set of RULES defining inline images. It
3981 is an alist where associations have the following shape:
3983 \(TYPE . REGEXP)
3985 Applying a rule means apply REGEXP against LINK's path when its
3986 type is TYPE. The function will return a non-nil value if any of
3987 the provided rules is non-nil. The default rule is
3988 `org-export-default-inline-image-rule'.
3990 This only applies to links without a description."
4001 rules)
4002 ;; Return nil if no rule matched.
4003 nil))))
4006 "Resolve a code reference REF.
4008 INFO is a plist used as a communication channel.
4010 Return associated line number in source code, or REF itself,
4011 depending on src-block or example element's switches."
4018 org-coderef-label-format)))
4022 ;; Element containing REF is found. Resolve it to either
4023 ;; a label or a line number, as needed.
4033 "Return LINK destination.
4035 INFO is a plist holding contextual information.
4037 Return value can be an object, an element, or nil:
4039 - If LINK path matches a target object (i.e. <<path>>) return it.
4041 - If LINK path exactly matches the name affiliated keyword
4042 \(i.e. #+NAME: path) of an element, return that element.
4044 - If LINK path exactly matches any headline name, return that
4045 element. If more than one headline share that name, priority
4046 will be given to the one with the closest common ancestor, if
4047 any, or the first one in the parse tree otherwise.
4049 - Otherwise, return nil.
4052 significant."
4055 ;; Split PATH at white spaces so matches are space
4056 ;; insensitive.
4059 ;; Cache for destinations that are not position dependent.
4067 ;; Destination is not position dependent: use cached value.
4069 ;; First try to find a matching "<<path>>" unless user specified
4070 ;; he was looking for a headline (path starts with a "*"
4071 ;; character).
4077 path)
4078 blob))
4081 ;; Then try to find an element with a matching "#+NAME: path"
4082 ;; affiliated keyword.
4085 org-element-all-elements
4090 el)))
4093 ;; Last case: link either points to a headline or to nothingness.
4094 ;; Try to find the source, with priority given to headlines with
4095 ;; the closest common ancestor. If such candidate is found,
4096 ;; return it, otherwise return nil.
4100 ;; Return first headline whose `:raw-value' property is
4101 ;; NAME in parse tree DATA, or nil. Statistics cookies
4102 ;; are ignored.
4110 name)
4111 headline))
4113 ;; Search among headlines sharing an ancestor with link, from
4114 ;; closest to farthest.
4123 ;; No destination found: return nil.
4127 "Return headline referenced as LINK destination.
4129 INFO is a plist used as a communication channel.
4131 Return value can be the headline element matched in current parse
4135 ;; First check if id is within the current parse tree.
4140 headline))
4142 ;; Otherwise, look for external files.
4146 "Return radio-target object referenced as LINK destination.
4148 INFO is a plist used as a communication channel.
4150 Return value can be a radio-target object or nil. Assume LINK
4159 nil nil path nil nil t)
4160 t)
4161 radio))
4165 ;;;; For References
4166 ;;
4167 ;; `org-export-get-ordinal' associates a sequence number to any object
4168 ;; or element.
4171 "Return ordinal number of an element or object.
4173 ELEMENT is the element or object considered. INFO is the plist
4174 used as a communication channel.
4176 Optional argument TYPES, when non-nil, is a list of element or
4177 object types, as symbols, that should also be counted in.
4178 Otherwise, only provided element's type is considered.
4180 Optional argument PREDICATE is a function returning a non-nil
4181 value if the current element or object should be counted in. It
4182 accepts two arguments: the element or object being considered and
4183 the plist used as a communication channel. This allows to count
4184 only a certain type of objects (i.e. inline images).
4186 Return value is a list of numbers if ELEMENT is a headline or an
4187 item. It is nil for keywords. It represents the footnote number
4188 for footnote definitions and footnote references. If ELEMENT is
4189 a target, return the same value as if ELEMENT was the closest
4190 table, item or headline containing the target. In any other
4191 case, return the sequence number of ELEMENT among elements or
4192 objects of the same type."
4193 ;; Ordinal of a target object refer to the ordinal of the closest
4194 ;; table, item, or headline containing the object.
4198 when
4202 table))
4203 return parent)))
4205 ;; Special case 1: A headline returns its number as a list.
4207 ;; Special case 2: An item returns its number as a list.
4211 struct
4218 ;; Increment counter until ELEMENT is found again.
4228 ;;;; For Special Blocks
4229 ;;
4230 ;; `org-export-raw-special-block-p' check if current special block is
4231 ;; an "export block", i.e., a block whose contents should be inserted
4232 ;; as-is in the output. This should generally be the first check to
4233 ;; do when handling special blocks in the export back-end.
4236 "Non-nil if ELEMENT is an export block relatively to current back-end.
4237 An export block is a special block whose contents should be
4238 included as-is in the final output. Such blocks are defined
4239 through :export-block property in `org-export-define-backend',
4240 which see."
4247 b))))
4250 ;;;; For Src Blocks
4251 ;;
4252 ;; `org-export-get-loc' counts number of code lines accumulated in
4253 ;; src-block or example-block elements with a "+n" switch until
4254 ;; a given element, excluded. Note: "-n" switches reset that count.
4255 ;;
4256 ;; `org-export-unravel-code' extracts source code (along with a code
4257 ;; references alist) from an `element-block' or `src-block' type
4258 ;; element.
4259 ;;
4260 ;; `org-export-format-code' applies a formatting function to each line
4261 ;; of code, providing relative line number and code reference when
4262 ;; appropriate. Since it doesn't access the original element from
4263 ;; which the source code is coming, it expects from the code calling
4264 ;; it to know if lines should be numbered and if code references
4265 ;; should appear.
4266 ;;
4267 ;; Eventually, `org-export-format-code-default' is a higher-level
4268 ;; function (it makes use of the two previous functions) which handles
4269 ;; line numbering and code references inclusion, and returns source
4270 ;; code in a format suitable for plain text or verbatim output.
4273 "Return accumulated lines of code up to ELEMENT.
4275 INFO is the plist used as a communication channel.
4277 ELEMENT is excluded from count."
4283 ;; ELEMENT is reached: Quit the loop.
4285 ;; Only count lines from src-block and example-block elements
4286 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4290 ;; Accumulate locs or reset them.
4294 ;; Return nil to stay in the loop.
4295 nil)))
4297 ;; Return value.
4298 loc))
4301 "Clean source code and extract references out of it.
4303 ELEMENT has either a `src-block' an `example-block' type.
4305 Return a cons cell whose CAR is the source code, cleaned from any
4306 reference, protective commas and spurious indentation, and CDR is
4307 an alist between relative line number (integer) and name of code
4308 reference on that line (string)."
4311 ;; Get code and clean it. Remove blank lines at its
4312 ;; beginning and end.
4319 value
4321 ;; Get format used for references.
4324 org-coderef-label-format)))
4325 ;; Build a regexp matching a loc with a reference.
4330 ;; Return value.
4332 ;; Code with references removed.
4338 ;; Ref line: remove ref, and signal its position in REFS.
4342 ;; Reference alist.
4343 refs)))
4346 "Format CODE by applying FUN line-wise and return it.
4348 CODE is a string representing the code to format. FUN is
4349 a function. It must accept three arguments: a line of
4350 code (string), the current line number (integer) or nil and the
4351 reference associated to the current line (string) or nil.
4353 Optional argument NUM-LINES can be an integer representing the
4354 number of code lines accumulated until the current code. Line
4355 numbers passed to FUN will take it into account. If it is nil,
4356 FUN's second argument will always be nil. This number can be
4357 obtained with `org-export-get-loc' function.
4359 Optional argument REF-ALIST can be an alist between relative line
4360 number (i.e. ignoring NUM-LINES) and the name of the code
4361 reference on it. If it is nil, FUN's third argument will always
4362 be nil. It can be obtained through the use of
4363 `org-export-unravel-code' function."
4375 "Return source code from ELEMENT, formatted in a standard way.
4377 ELEMENT is either a `src-block' or `example-block' element. INFO
4378 is a plist used as a communication channel.
4380 This function takes care of line numbering and code references
4381 inclusion. Line numbers, when applicable, appear at the
4382 beginning of the line, separated from the code by two white
4383 spaces. Code references, on the other hand, appear flushed to
4384 the right, separated by six white spaces from the widest line of
4385 code."
4386 ;; Extract code and references.
4393 ;; Handle line numbering.
4402 ;; Prepare references display, if required. Any reference
4403 ;; should start six columns after the widest line of code,
4404 ;; wrapped with parenthesis.
4409 code
4413 number-str
4414 loc
4420 num-start refs)))))
4423 ;;;; For Tables
4424 ;;
4425 ;; `org-export-table-has-special-column-p' and and
4426 ;; `org-export-table-row-is-special-p' are predicates used to look for
4427 ;; meta-information about the table structure.
4428 ;;
4429 ;; `org-table-has-header-p' tells when the rows before the first rule
4430 ;; should be considered as table's header.
4431 ;;
4432 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4433 ;; and `org-export-table-cell-borders' extract information from
4434 ;; a table-cell element.
4435 ;;
4436 ;; `org-export-table-dimensions' gives the number on rows and columns
4437 ;; in the table, ignoring horizontal rules and special columns.
4438 ;; `org-export-table-cell-address', given a table-cell object, returns
4439 ;; the absolute address of a cell. On the other hand,
4440 ;; `org-export-get-table-cell-at' does the contrary.
4441 ;;
4442 ;; `org-export-table-cell-starts-colgroup-p',
4443 ;; `org-export-table-cell-ends-colgroup-p',
4444 ;; `org-export-table-row-starts-rowgroup-p',
4445 ;; `org-export-table-row-ends-rowgroup-p',
4446 ;; `org-export-table-row-starts-header-p' and
4447 ;; `org-export-table-row-ends-header-p' indicate position of current
4448 ;; row or cell within the table.
4451 "Non-nil when TABLE has a special column.
4452 All special columns will be ignored during export."
4453 ;; The table has a special column when every first cell of every row
4454 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4455 ;; "*" "_" and "^". Though, do not consider a first row containing
4456 ;; only empty cells as special.
4472 "Non-nil when TABLE has a header.
4474 INFO is a plist used as a communication channel.
4476 A table has a header when it contains at least two row groups."
4485 table
4496 cache)))))
4499 "Non-nil if TABLE-ROW is considered special.
4501 INFO is a plist used as the communication channel.
4503 All special rows will be ignored during export."
4507 ;; A row is special either when...
4509 ;; ... it starts with a field only containing "/",
4511 ;; ... the table contains a special column and the row start
4512 ;; with a marking character among, "^", "_", "$" or "!",
4516 ;; ... it contains only alignment cookies and empty cells.
4522 ;; Since VALUE is a secondary string, the following
4523 ;; checks avoid expanding it with `org-export-data'.
4535 "Return TABLE-ROW's group number, as an integer.
4537 INFO is a plist used as the communication channel.
4539 Return value is the group number, as an integer, or nil for
4540 special rows and rows separators. First group is also table's
4541 header."
4559 "Return TABLE-CELL contents width.
4561 INFO is a plist used as the communication channel.
4563 Return value is the width given by the last width cookie in the
4564 same column as TABLE-CELL, or nil."
4583 ;; In a special row, try to find a width cookie at COLUMN.
4587 ;; The following checks avoid expanding unnecessarily
4588 ;; the cell with `org-export-data'.
4598 "Return TABLE-CELL contents alignment.
4600 INFO is a plist used as the communication channel.
4602 Return alignment as specified by the last alignment cookie in the
4603 same column as TABLE-CELL. If no such cookie is found, a default
4604 alignment value will be deduced from fraction of numbers in the
4605 column (see `org-table-number-fraction' for more information).
4606 Possible values are `left', `right' and `center'."
4607 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4624 cookie-align
4625 previous-cell-number-p)
4628 ;; In a special row, try to find an alignment cookie at
4629 ;; COLUMN.
4633 ;; Since VALUE is a secondary string, the following
4634 ;; checks avoid useless expansion through
4635 ;; `org-export-data'.
4643 ;; Ignore table rules.
4645 ;; In a standard row, check if cell's contents are
4646 ;; expressing some kind of number. Increase NUMBER-CELLS
4647 ;; accordingly. Though, don't bother if an alignment
4648 ;; cookie has already defined cell's alignment.
4653 info)))
4655 ;; Treat an empty cell as a number if it follows
4656 ;; a number.
4662 ;; Return value. Alignment specified by cookies has
4663 ;; precedence over alignment deduced from cell's contents.
4665 column
4670 org-table-number-fraction)
4675 "Return TABLE-CELL borders.
4677 INFO is a plist used as a communication channel.
4679 Return value is a list of symbols, or nil. Possible values are:
4680 `top', `bottom', `above', `below', `left' and `right'. Note:
4681 `top' (resp. `bottom') only happen for a cell in the first
4682 row (resp. last row) of the table, ignoring table rules, if any.
4684 Returned borders ignore special rows."
4687 borders)
4688 ;; Top/above border? TABLE-CELL has a border above when a rule
4689 ;; used to demarcate row groups can be found above. Hence,
4690 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4691 ;; another regular row has to be found above that rule.
4700 ;; Look at every row before the current one.
4702 ;; No rule above, or rule found starts the table (ignoring any
4703 ;; special row): TABLE-CELL is at the top of the table.
4706 ;; Bottom/below border? TABLE-CELL has a border below when next
4707 ;; non-regular row below is a rule.
4716 ;; Look at every row after the current one.
4718 ;; No rule below, or rule found ends the table (modulo some
4719 ;; special row): TABLE-CELL is at the bottom of the table.
4722 ;; Right/left borders? They can only be specified by column
4723 ;; groups. Column groups are defined in a row starting with "/".
4724 ;; Also a column groups row only contains "<", "<>", ">" or blank
4725 ;; cells.
4742 ;; There's a left border when previous cell, if
4743 ;; any, ends a group, or current one starts one.
4749 ;; There's a right border when next cell, if any,
4750 ;; starts a group, or current one ends one.
4757 ;; Table rows are read in reverse order so last column groups
4758 ;; row has precedence over any previous one.
4760 ;; Return value.
4761 borders))
4764 "Non-nil when TABLE-CELL is at the beginning of a column group.
4765 INFO is a plist used as a communication channel."
4766 ;; A cell starts a column group either when it is at the beginning
4767 ;; of a row (or after the special column, if any) or when it has
4768 ;; a left border.
4771 table-cell)
4775 "Non-nil when TABLE-CELL is at the end of a column group.
4776 INFO is a plist used as a communication channel."
4777 ;; A cell ends a column group either when it is at the end of a row
4778 ;; or when it has a right border.
4781 table-cell)
4785 "Non-nil when TABLE-ROW is at the beginning of a row group.
4786 INFO is a plist used as a communication channel."
4794 "Non-nil when TABLE-ROW is at the end of a row group.
4795 INFO is a plist used as a communication channel."
4803 "Non-nil when TABLE-ROW is the first table header's row.
4804 INFO is a plist used as a communication channel."
4811 "Non-nil when TABLE-ROW is the last table header's row.
4812 INFO is a plist used as a communication channel."
4819 "Return TABLE-ROW number.
4820 INFO is a plist used as a communication channel. Return value is
4821 zero-based and ignores separators. The function returns nil for
4822 special columns and separators."
4834 "Return TABLE dimensions.
4836 INFO is a plist used as a communication channel.
4838 Return value is a CONS like (ROWS . COLUMNS) where
4839 ROWS (resp. COLUMNS) is the number of exportable
4840 rows (resp. columns)."
4842 ;; Set number of rows, and extract first one.
4848 ;; Set number of columns.
4850 ;; Return value.
4854 "Return address of a regular TABLE-CELL object.
4856 TABLE-CELL is the cell considered. INFO is a plist used as
4857 a communication channel.
4859 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4860 zero-based index. Only exportable cells are considered. The
4861 function returns nil for other cells."
4873 "Return regular table-cell object at ADDRESS in TABLE.
4875 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4876 zero-based index. TABLE is a table type element. INFO is
4877 a plist used as a communication channel.
4879 If no table-cell, among exportable cells, is found at ADDRESS,
4880 return nil."
4883 ;; Row at (car address) or nil.
4891 'table-cell
4898 ;;;; For Tables Of Contents
4899 ;;
4900 ;; `org-export-collect-headlines' builds a list of all exportable
4901 ;; headline elements, maybe limited to a certain depth. One can then
4902 ;; easily parse it and transcode it.
4903 ;;
4904 ;; Building lists of tables, figures or listings is quite similar.
4905 ;; Once the generic function `org-export-collect-elements' is defined,
4906 ;; `org-export-collect-tables', `org-export-collect-figures' and
4907 ;; `org-export-collect-listings' can be derived from it.
4910 "Collect headlines in order to build a table of contents.
4912 INFO is a plist used as a communication channel.
4914 When optional argument N is an integer, it specifies the depth of
4915 the table of contents. Otherwise, it is set to the value of the
4916 last headline level. See `org-export-headline-levels' for more
4917 information.
4919 Return a list of all exportable headlines as parsed elements.
4920 Footnote sections, if any, will be ignored."
4928 info)))
4931 "Collect referenceable elements of a determined type.
4933 TYPE can be a symbol or a list of symbols specifying element
4934 types to search. Only elements with a caption are collected.
4936 INFO is a plist used as a communication channel.
4938 When non-nil, optional argument PREDICATE is a function accepting
4939 one argument, an element of type TYPE. It returns a non-nil
4940 value when that element should be collected.
4942 Return a list of all elements found, in order of appearance."
4947 element))
4948 info))
4951 "Build a list of tables.
4952 INFO is a plist used as a communication channel.
4954 Return a list of table elements with a caption."
4958 "Build a list of figures.
4960 INFO is a plist used as a communication channel. PREDICATE is
4961 a function which accepts one argument: a paragraph element and
4962 whose return value is non-nil when that element should be
4963 collected.
4965 A figure is a paragraph type element, with a caption, verifying
4967 a vague concept that may depend on back-end.
4969 Return a list of elements recognized as figures."
4973 "Build a list of src blocks.
4975 INFO is a plist used as a communication channel.
4977 Return a list of src-block elements with a caption."
4981 ;;;; Smart Quotes
4982 ;;
4983 ;; The main function for the smart quotes sub-system is
4984 ;; `org-export-activate-smart-quotes', which replaces every quote in
4985 ;; a given string from the parse tree with its "smart" counterpart.
4986 ;;
4987 ;; Dictionary for smart quotes is stored in
4988 ;; `org-export-smart-quotes-alist'.
4989 ;;
4990 ;; Internally, regexps matching potential smart quotes (checks at
4991 ;; string boundaries are also necessary) are defined in
4992 ;; `org-export-smart-quotes-regexps'.
4996 ;; one may use: »...«, "...", ›...‹, or '...'.
4997 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4998 ;; LaTeX quotes require Babel!
5043 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5052 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5061 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5070 ;; 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
5071 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5082 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5088 )
5089 "Smart quotes translations.
5091 Alist whose CAR is a language string and CDR is an alist with
5092 quote type as key and a plist associating various encodings to
5093 their translation as value.
5095 A quote type can be any symbol among `opening-double-quote',
5096 `closing-double-quote', `opening-single-quote',
5097 `closing-single-quote' and `apostrophe'.
5099 Valid encodings include `:utf-8', `:html', `:latex' and
5100 `:texinfo'.
5106 ;; Possible opening quote at beginning of string.
5108 ;; Possible closing quote at beginning of string.
5110 ;; Possible apostrophe at beginning of string.
5112 ;; Opening single and double quotes.
5114 ;; Closing single and double quotes.
5116 ;; Apostrophe.
5118 ;; Possible opening quote at end of string.
5120 ;; Possible closing quote at end of string.
5122 ;; Possible apostrophe at end of string.
5124 "List of regexps matching a quote or an apostrophe.
5130 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5131 `:utf-8'. INFO is a plist used as a communication channel.
5133 The function has to retrieve information about string
5134 surroundings in parse tree. It can only happen with an
5135 unmodified string. Thus, if S has already been through another
5136 process, a non-nil ORIGINAL optional argument will provide that
5137 original string.
5139 Return the new string."
5142 ;; Try to be flexible when computing number of blanks
5143 ;; before object. The previous object may be a string
5144 ;; introduced by the back-end and not completely parsed.
5147 ;; A string with missing `:post-blank'
5148 ;; property.
5152 ;; Fallback value.
5157 ;; Return smart quote associated to a give quote Q, as
5158 ;; a string. TYPE is a symbol among `open', `close' and
5159 ;; `apostrophe'.
5169 org-export-smart-quotes-alist))))
5170 encoding)
5171 q)))))
5173 ;; Only a quote: no regexp can match. We have to check both
5174 ;; sides and decide what to do.
5182 ;; 1. Replace quote character at the beginning of S.
5184 ;; Apostrophe?
5190 ;; Closing quote?
5196 ;; Opening quote?
5202 ;; 2. Replace quotes in the middle of the string.
5204 ;; Opening quotes.
5210 ;; Closing quotes.
5216 ;; Apostrophes.
5221 ;; 3. Replace quote character at the end of S.
5223 ;; Apostrophe?
5228 ;; Closing quote?
5234 ;; Opening quote?
5239 ;; Return string with smart quotes.
5240 s))))
5242 ;;;; Topology
5243 ;;
5244 ;; Here are various functions to retrieve information about the
5245 ;; neighborhood of a given element or object. Neighbors of interest
5246 ;; are direct parent (`org-export-get-parent'), parent headline
5247 ;; (`org-export-get-parent-headline'), first element containing an
5248 ;; object, (`org-export-get-parent-element'), parent table
5249 ;; (`org-export-get-parent-table'), previous element or object
5250 ;; (`org-export-get-previous-element') and next element or object
5251 ;; (`org-export-get-next-element').
5252 ;;
5253 ;; `org-export-get-genealogy' returns the full genealogy of a given
5254 ;; element or object, from closest parent to full parse tree.
5256 ;; defsubst org-export-get-parent must be defined before first use
5259 "Return full genealogy relative to a given element or object.
5261 BLOB is the element or object being considered.
5263 Ancestors are returned from closest to farthest, the last one
5264 being the full parse tree."
5271 "Return BLOB parent headline or nil.
5272 BLOB is the element or object being considered."
5276 parent))
5279 "Return first element containing OBJECT or nil.
5280 OBJECT is the object to consider."
5284 parent))
5287 "Return OBJECT parent table or nil.
5288 OBJECT is either a `table-cell' or `table-element' type object."
5292 parent))
5295 "Return previous element or object.
5297 BLOB is an element or object. INFO is a plist used as
5298 a communication channel. Return previous exportable element or
5299 object, a string, or nil.
5301 When optional argument N is a positive integer, return a list
5302 containing up to N siblings before BLOB, from farthest to
5303 closest. With any other non-nil value, return a list containing
5304 all of them."
5310 prev)
5320 "Return next element or object.
5322 BLOB is an element or object. INFO is a plist used as
5323 a communication channel. Return next exportable element or
5324 object, a string, or nil.
5326 When optional argument N is a positive integer, return a list
5327 containing up to N siblings after BLOB, from closest to farthest.
5328 With any other non-nil value, return a list containing all of
5329 them."
5336 next)
5346 ;;;; Translation
5347 ;;
5348 ;; `org-export-translate' translates a string according to the language
5349 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5350 ;; the dictionary used for the translation.
5397 ("ru" :html "(Продолжение следует)"
5495 ("ru" :html "Список распечаток"
5508 ("ru" :html "Список таблиц"
5591 ("ru" :html "Неизвестная ссылка"
5594 "Dictionary for export engine.
5596 Alist whose CAR is the string to translate and CDR is an alist
5597 whose CAR is the language string and CDR is a plist whose
5598 properties are possible charsets and values translated terms.
5600 It is used as a database for `org-export-translate'. Since this
5601 function returns the string as-is if no translation was found,
5602 the variable only needs to record values different from the
5606 "Translate string S according to language specification.
5608 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5609 and `:utf-8'. INFO is a plist used as a communication channel.
5611 Translation depends on `:language' property. Return the
5612 translated string. If no translation is found, try to fall back
5613 to `:default' encoding. If it fails, return S."
5619 s)))
5622 \f
5623 ;;; Asynchronous Export
5624 ;;
5625 ;; `org-export-async-start' is the entry point for asynchronous
5626 ;; export. It recreates current buffer (including visibility,
5627 ;; narrowing and visited file) in an external Emacs process, and
5628 ;; evaluates a command there. It then applies a function on the
5629 ;; returned results in the current process.
5630 ;;
5631 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5632 ;; allow to export to a buffer or a file, asynchronously or not.
5633 ;;
5634 ;; `org-export-output-file-name' is an auxiliary function meant to be
5635 ;; used with `org-export-to-file'. With a given extension, it tries
5636 ;; to provide a canonical file name to write export output to.
5637 ;;
5638 ;; Asynchronously generated results are never displayed directly.
5639 ;; Instead, they are stored in `org-export-stack-contents'. They can
5640 ;; then be retrieved by calling `org-export-stack'.
5641 ;;
5642 ;; Export Stack is viewed through a dedicated major mode
5643 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5644 ;;`org-export-stack-delete', `org-export-stack-view' and
5645 ;;`org-export-stack-clear'.
5646 ;;
5647 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5648 ;; It should be used whenever `org-export-async-start' is called.
5651 "Call function FUN on the results returned by BODY evaluation.
5653 BODY evaluation happens in an asynchronous process, from a buffer
5654 which is an exact copy of the current one.
5656 Use `org-export-add-to-stack' in FUN in order to register results
5657 in the stack.
5659 This is a low level function. See also `org-export-to-buffer'
5660 and `org-export-to-file' for more specialized functions."
5663 ;; Write the full sexp evaluating BODY in a copy of the current
5664 ;; buffer to a temporary file, as it may be too long for program
5665 ;; args in `start-process'.
5672 ;; Null characters (from variable values) are inserted
5673 ;; within the file. As a consequence, coding system for
5674 ;; buffer contents will not be recognized properly. So,
5675 ;; we make sure it is the same as the one used to display
5676 ;; the original buffer.
5678 ,coding
5681 ;; Ignore `kill-emacs-hook' and code evaluation
5682 ;; queries from Babel as we need a truly
5683 ;; non-interactive process.
5685 org-babel-confirm-evaluate-answer-no t)
5686 ;; Initialize export framework.
5688 ;; Re-create current buffer there.
5691 ;; Sexp to evaluate in the buffer.
5693 ;; Start external process.
5696 (,process
5698 #'start-process
5701 ,proc-buffer
5708 ;; Register running process in stack.
5710 ;; Set-up sentinel in order to catch results.
5713 ,process
5735 ;;;###autoload
5738 &optional async subtreep visible-only body-only ext-plist
5739 post-process)
5740 "Call `org-export-as' with output to a specified buffer.
5742 BACKEND is either an export back-end, as returned by, e.g.,
5743 `org-export-create-backend', or a symbol referring to
5744 a registered back-end.
5746 BUFFER is the name of the output buffer. If it already exists,
5747 it will be erased first, otherwise, it will be created.
5749 A non-nil optional argument ASYNC means the process should happen
5750 asynchronously. The resulting buffer should then be accessible
5751 through the `org-export-stack' interface. When ASYNC is nil, the
5752 buffer is displayed if `org-export-show-temporary-export-buffer'
5753 is non-nil.
5755 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5756 EXT-PLIST are similar to those used in `org-export-as', which
5757 see.
5759 Optional argument POST-PROCESS is a function which should accept
5760 no argument. It is always called within the current process,
5761 from BUFFER, with point at its beginning. Export back-ends can
5762 use it to set a major mode there, e.g,
5764 \(defun org-latex-export-as-latex
5765 \(&optional async subtreep visible-only body-only ext-plist)
5766 \(interactive)
5768 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5770 This function returns BUFFER."
5798 buffer)))
5800 ;;;###autoload
5803 post-process)
5804 "Call `org-export-as' with output to a specified file.
5806 BACKEND is either an export back-end, as returned by, e.g.,
5807 `org-export-create-backend', or a symbol referring to
5808 a registered back-end. FILE is the name of the output file, as
5809 a string.
5811 A non-nil optional argument ASYNC means the process should happen
5812 asynchronously. The resulting buffer will then be accessible
5813 through the `org-export-stack' interface.
5815 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5816 EXT-PLIST are similar to those used in `org-export-as', which
5817 see.
5819 Optional argument POST-PROCESS is called with FILE as its
5820 argument and happens asynchronously when ASYNC is non-nil. It
5821 has to return a file name, or nil. Export back-ends can use this
5822 to send the output file through additional processing, e.g,
5824 \(defun org-latex-export-to-latex
5825 \(&optional async subtreep visible-only body-only ext-plist)
5826 \(interactive)
5828 \(org-export-to-file 'latex outfile
5829 async subtreep visible-only body-only ext-plist
5830 \(lambda (file) (org-latex-compile file)))
5832 The function returns either a file name returned by POST-PROCESS,
5833 or FILE."
5851 backend subtreep visible-only body-only ext-plist)))
5858 ;; Get proper return value.
5860 file))))))
5863 "Return output file's name according to buffer specifications.
5865 EXTENSION is a string representing the output file extension,
5866 with the leading dot.
5868 With a non-nil optional argument SUBTREEP, try to determine
5870 of subtree at point.
5872 When optional argument PUB-DIR is set, use it as the publishing
5873 directory.
5875 When optional argument VISIBLE-ONLY is non-nil, don't export
5876 contents of hidden elements.
5878 Return file name as a string."
5881 ;; File name may come from EXPORT_FILE_NAME subtree
5882 ;; property, assuming point is at beginning of said
5883 ;; sub-tree.
5890 ;; File name may be extracted from buffer's associated
5891 ;; file, if any.
5893 ;; Can't determine file name on our own: Ask user.
5897 "Output file: " pub-dir nil nil nil
5901 ;; Build file name. Enforce EXTENSION over whatever user
5902 ;; may have come up with. PUB-DIR, if defined, always has
5903 ;; precedence over any provided path.
5908 extension))
5911 ;; If writing to OUTPUT-FILE would overwrite original file, append
5912 ;; EXTENSION another time to final name.
5915 output-file)))
5918 "Add a new result to export stack if not present already.
5920 SOURCE is a buffer or a file name containing export results.
5921 BACKEND is a symbol representing export back-end used to generate
5922 it.
5924 Entries already pointing to SOURCE and unavailable entries are
5925 removed beforehand. Return the new stack."
5931 "Menu for asynchronous export results and running processes."
5941 "Return source from export results at point in stack."
5948 source
5949 ;; SOURCE is not consistent with current line. The stack
5950 ;; view is outdated.
5954 "Remove all entries from export stack."
5959 "Refresh the asynchronous export stack.
5960 DUMMY is ignored. Unavailable sources are removed from the list.
5961 Return the new stack."
5971 ;; Back-end.
5973 ;; Age.
5976 ;; Compute age of the results.
5978 "%4h:%.2m "
5980 ;; Source.
5985 ;; Clear stack from exited processes, dead buffers or
5986 ;; non-existent files.
5998 "Remove export results at point from stack.
5999 If optional argument SOURCE is non-nil, remove it instead."
6004 org-export-stack-contents))))
6007 "View export results at point in stack.
6008 With an optional prefix argument IN-EMACS, force viewing files
6009 within Emacs."
6023 (define-key km "p" 'previous-line)
6024 (define-key km "\C-p" 'previous-line)
6025 (define-key km "\C-?" 'previous-line)
6026 (define-key km [up] 'previous-line)
6027 (define-key km "C" 'org-export-stack-clear)
6028 (define-key km "v" 'org-export-stack-view)
6029 (define-key km (kbd "RET") 'org-export-stack-view)
6030 (define-key km "d" 'org-export-stack-remove)
6031 km)
6032 "Keymap for Org Export Stack.")
6034 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6035 "Mode for displaying asynchronous export stack.
6038 stack.
6040 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6041 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6042 stack completely.
6044 Removing entries in an Org Export Stack buffer doesn't affect
6045 files or buffers, only the display.
6048 (abbrev-mode 0)
6049 (auto-fill-mode 0)
6050 (setq buffer-read-only t
6051 buffer-undo-list t
6052 truncate-lines t
6053 header-line-format
6054 '(:eval
6055 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6056 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6057 (set (make-local-variable 'revert-buffer-function)
6058 'org-export-stack-refresh))
6061 \f
6062 ;;; The Dispatcher
6063 ;;
6064 ;; `org-export-dispatch' is the standard interactive way to start an
6065 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6066 ;; for its interface, which, in turn, delegates response to key
6067 ;; pressed to `org-export--dispatch-action'.
6069 ;;;###autoload
6070 (defun org-export-dispatch (&optional arg)
6071 "Export dispatcher for Org mode.
6073 It provides an access to common export related tasks in a buffer.
6074 Its interface comes in two flavors: standard and expert.
6076 While both share the same set of bindings, only the former
6077 displays the valid keys associations in a dedicated buffer.
6078 Scrolling (resp. line-wise motion) in this buffer is done with
6079 SPC and DEL (resp. C-n and C-p) keys.
6081 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6082 flavor or the other.
6085 of options used back then, on the current buffer.
6087 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6088 (interactive "P")
6089 (let* ((input
6090 (cond ((equal arg '(16)) '(stack))
6091 ((and arg org-export-dispatch-last-action))
6092 (t (save-window-excursion
6093 (unwind-protect
6094 (progn
6095 ;; Remember where we are
6096 (move-marker org-export-dispatch-last-position
6097 (point)
6098 (org-base-buffer (current-buffer)))
6099 ;; Get and store an export command
6100 (setq org-export-dispatch-last-action
6101 (org-export--dispatch-ui
6102 (list org-export-initial-scope
6103 (and org-export-in-background 'async))
6104 nil
6105 org-export-dispatch-use-expert-ui)))
6106 (and (get-buffer "*Org Export Dispatcher*")
6107 (kill-buffer "*Org Export Dispatcher*")))))))
6108 (action (car input))
6109 (optns (cdr input)))
6110 (unless (memq 'subtree optns)
6111 (move-marker org-export-dispatch-last-position nil))
6112 (case action
6113 ;; First handle special hard-coded actions.
6114 (template (org-export-insert-default-template nil optns))
6115 (stack (org-export-stack))
6116 (publish-current-file
6117 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6118 (publish-current-project
6119 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6120 (publish-choose-project
6121 (org-publish (assoc (org-icompleting-read
6122 "Publish project: "
6123 org-publish-project-alist nil t)
6124 org-publish-project-alist)
6125 (memq 'force optns)
6126 (memq 'async optns)))
6127 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6128 (otherwise
6129 (save-excursion
6130 (when arg
6131 ;; Repeating command, maybe move cursor to restore subtree
6132 ;; context.
6133 (if (eq (marker-buffer org-export-dispatch-last-position)
6134 (org-base-buffer (current-buffer)))
6135 (goto-char org-export-dispatch-last-position)
6136 ;; We are in a different buffer, forget position.
6137 (move-marker org-export-dispatch-last-position nil)))
6138 (funcall action
6139 ;; Return a symbol instead of a list to ease
6140 ;; asynchronous export macro use.
6141 (and (memq 'async optns) t)
6142 (and (memq 'subtree optns) t)
6143 (and (memq 'visible optns) t)
6144 (and (memq 'body optns) t)))))))
6146 (defun org-export--dispatch-ui (options first-key expertp)
6147 "Handle interface for `org-export-dispatch'.
6149 OPTIONS is a list containing current interactive options set for
6150 export. It can contain any of the following symbols:
6151 `body' toggles a body-only export
6152 `subtree' restricts export to current subtree
6153 `visible' restricts export to visible part of buffer.
6154 `force' force publishing files.
6155 `async' use asynchronous export process
6157 FIRST-KEY is the key pressed to select the first level menu. It
6158 is nil when this menu hasn't been selected yet.
6160 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6161 buffer is provided, but indications about currently active
6162 options are given in the prompt. Moreover, \[?] allows to switch
6163 back to standard interface."
6164 (let* ((fontify-key
6165 (lambda (key &optional access-key)
6166 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6167 ;; non-nil is the required first-level key to activate
6168 ;; KEY. When its value is t, activate KEY independently
6169 ;; on the first key, if any. A nil value means KEY will
6170 ;; only be activated at first level.
6171 (if (or (eq access-key t) (eq access-key first-key))
6172 (org-propertize key 'face 'org-warning)
6173 key)))
6174 (fontify-value
6175 (lambda (value)
6176 ;; Fontify VALUE string.
6177 (org-propertize value 'face 'font-lock-variable-name-face)))
6178 ;; Prepare menu entries by extracting them from registered
6179 ;; back-ends and sorting them by access key and by ordinal,
6180 ;; if any.
6181 (entries
6182 (sort (sort (delq nil
6183 (mapcar 'org-export-backend-menu
6184 org-export--registered-backends))
6185 (lambda (a b)
6186 (let ((key-a (nth 1 a))
6187 (key-b (nth 1 b)))
6188 (cond ((and (numberp key-a) (numberp key-b))
6189 (< key-a key-b))
6190 ((numberp key-b) t)))))
6191 'car-less-than-car))
6192 ;; Compute a list of allowed keys based on the first key
6193 ;; pressed, if any. Some keys
6194 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6195 ;; available.
6196 (allowed-keys
6197 (nconc (list 2 22 19 6 1)
6198 (if (not first-key) (org-uniquify (mapcar 'car entries))
6199 (let (sub-menu)
6200 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6201 (when (eq (car entry) first-key)
6202 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6203 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6204 ((not first-key) (list ?P)))
6205 (list ?& ?#)
6206 (when expertp (list ??))
6207 (list ?q)))
6208 ;; Build the help menu for standard UI.
6209 (help
6210 (unless expertp
6211 (concat
6212 ;; Options are hard-coded.
6213 (format "[%s] Body only: %s [%s] Visible only: %s
6214 \[%s] Export scope: %s [%s] Force publishing: %s
6216 (funcall fontify-key "C-b" t)
6217 (funcall fontify-value
6218 (if (memq 'body options) "On " "Off"))
6219 (funcall fontify-key "C-v" t)
6220 (funcall fontify-value
6221 (if (memq 'visible options) "On " "Off"))
6222 (funcall fontify-key "C-s" t)
6223 (funcall fontify-value
6224 (if (memq 'subtree options) "Subtree" "Buffer "))
6225 (funcall fontify-key "C-f" t)
6226 (funcall fontify-value
6227 (if (memq 'force options) "On " "Off"))
6228 (funcall fontify-key "C-a" t)
6229 (funcall fontify-value
6230 (if (memq 'async options) "On " "Off")))
6231 ;; Display registered back-end entries. When a key
6232 ;; appears for the second time, do not create another
6233 ;; entry, but append its sub-menu to existing menu.
6234 (let (last-key)
6235 (mapconcat
6236 (lambda (entry)
6237 (let ((top-key (car entry)))
6238 (concat
6239 (unless (eq top-key last-key)
6240 (setq last-key top-key)
6242 (funcall fontify-key (char-to-string top-key))
6243 (nth 1 entry)))
6244 (let ((sub-menu (nth 2 entry)))
6245 (unless (functionp sub-menu)
6246 ;; Split sub-menu into two columns.
6247 (let ((index -1))
6248 (concat
6249 (mapconcat
6250 (lambda (sub-entry)
6251 (incf index)
6252 (format
6253 (if (zerop (mod index 2)) " [%s] %-26s"
6255 (funcall fontify-key
6256 (char-to-string (car sub-entry))
6257 top-key)
6258 (nth 1 sub-entry)))
6259 sub-menu "")
6261 entries ""))
6262 ;; Publishing menu is hard-coded.
6264 [%s] Current file [%s] Current project
6266 (funcall fontify-key "P")
6267 (funcall fontify-key "f" ?P)
6268 (funcall fontify-key "p" ?P)
6269 (funcall fontify-key "x" ?P)
6270 (funcall fontify-key "a" ?P))
6272 (funcall fontify-key "&" t)
6273 (funcall fontify-key "#" t))
6274 (format "[%s] %s"
6275 (funcall fontify-key "q" t)
6276 (if first-key "Main menu" "Exit")))))
6277 ;; Build prompts for both standard and expert UI.
6278 (standard-prompt (unless expertp "Export command: "))
6279 (expert-prompt
6280 (when expertp
6281 (format
6282 "Export command (C-%s%s%s%s%s) [%s]: "
6283 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6284 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6285 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6286 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6287 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6288 (mapconcat (lambda (k)
6289 ;; Strip control characters.
6290 (unless (< k 27) (char-to-string k)))
6291 allowed-keys "")))))
6292 ;; With expert UI, just read key with a fancy prompt. In standard
6293 ;; UI, display an intrusive help buffer.
6294 (if expertp
6295 (org-export--dispatch-action
6296 expert-prompt allowed-keys entries options first-key expertp)
6297 ;; At first call, create frame layout in order to display menu.
6298 (unless (get-buffer "*Org Export Dispatcher*")
6299 (delete-other-windows)
6300 (org-switch-to-buffer-other-window
6301 (get-buffer-create "*Org Export Dispatcher*"))
6302 (setq cursor-type nil
6303 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6304 ;; Make sure that invisible cursor will not highlight square
6305 ;; brackets.
6306 (set-syntax-table (copy-syntax-table))
6307 (modify-syntax-entry ?\[ "w"))
6308 ;; At this point, the buffer containing the menu exists and is
6309 ;; visible in the current window. So, refresh it.
6310 (with-current-buffer "*Org Export Dispatcher*"
6311 ;; Refresh help. Maintain display continuity by re-visiting
6312 ;; previous window position.
6313 (let ((pos (window-start)))
6314 (erase-buffer)
6315 (insert help)
6316 (set-window-start nil pos)))
6317 (org-fit-window-to-buffer)
6318 (org-export--dispatch-action
6319 standard-prompt allowed-keys entries options first-key expertp))))
6321 (defun org-export--dispatch-action
6322 (prompt allowed-keys entries options first-key expertp)
6323 "Read a character from command input and act accordingly.
6325 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6326 a list of characters available at a given step in the process.
6327 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6328 EXPERTP are the same as defined in `org-export--dispatch-ui',
6329 which see.
6331 Toggle export options when required. Otherwise, return value is
6332 a list with action as CAR and a list of interactive export
6333 options as CDR."
6334 (let (key)
6335 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6336 ;; C-p, SPC, DEL).
6337 (while (and (setq key (read-char-exclusive prompt))
6338 (not expertp)
6339 (memq key '(14 16 ?\s ?\d)))
6340 (case key
6341 (14 (if (not (pos-visible-in-window-p (point-max)))
6342 (ignore-errors (scroll-up 1))
6343 (message "End of buffer")
6344 (sit-for 1)))
6345 (16 (if (not (pos-visible-in-window-p (point-min)))
6346 (ignore-errors (scroll-down 1))
6347 (message "Beginning of buffer")
6348 (sit-for 1)))
6349 (?\s (if (not (pos-visible-in-window-p (point-max)))
6350 (scroll-up nil)
6351 (message "End of buffer")
6352 (sit-for 1)))
6353 (?\d (if (not (pos-visible-in-window-p (point-min)))
6354 (scroll-down nil)
6355 (message "Beginning of buffer")
6356 (sit-for 1)))))
6357 (cond
6358 ;; Ignore undefined associations.
6359 ((not (memq key allowed-keys))
6360 (ding)
6361 (unless expertp (message "Invalid key") (sit-for 1))
6362 (org-export--dispatch-ui options first-key expertp))
6363 ;; q key at first level aborts export. At second level, cancel
6364 ;; first key instead.
6365 ((eq key ?q) (if (not first-key) (error "Export aborted")
6366 (org-export--dispatch-ui options nil expertp)))
6367 ;; Help key: Switch back to standard interface if expert UI was
6368 ;; active.
6369 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6370 ;; Send request for template insertion along with export scope.
6371 ((eq key ?#) (cons 'template (memq 'subtree options)))
6372 ;; Switch to asynchronous export stack.
6373 ((eq key ?&) '(stack))
6374 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6375 ((memq key '(2 22 19 6 1))
6376 (org-export--dispatch-ui
6377 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6378 (6 'force) (1 'async))))
6379 (if (memq option options) (remq option options)
6380 (cons option options)))
6381 first-key expertp))
6382 ;; Action selected: Send key and options back to
6383 ;; `org-export-dispatch'.
6384 ((or first-key (functionp (nth 2 (assq key entries))))
6385 (cons (cond
6386 ((not first-key) (nth 2 (assq key entries)))
6387 ;; Publishing actions are hard-coded. Send a special
6388 ;; signal to `org-export-dispatch'.
6389 ((eq first-key ?P)
6390 (case key
6391 (?f 'publish-current-file)
6392 (?p 'publish-current-project)
6393 (?x 'publish-choose-project)
6394 (?a 'publish-all)))
6395 ;; Return first action associated to FIRST-KEY + KEY
6396 ;; path. Indeed, derived backends can share the same
6397 ;; FIRST-KEY.
6398 (t (catch 'found
6399 (mapc (lambda (entry)
6400 (let ((match (assq key (nth 2 entry))))
6401 (when match (throw 'found (nth 2 match)))))
6402 (member (assq first-key entries) entries)))))
6403 options))
6404 ;; Otherwise, enter sub-menu.
6405 (t (org-export--dispatch-ui options key expertp)))))
6409 (provide 'ox)
6411 ;; Local variables:
6412 ;; generated-autoload-file: "org-loaddefs.el"
6413 ;; End:
6415 ;;; ox.el ends here