| blob | f81b7694586bee63a228d4377d8c3934c3a2e273 |
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."
1153 :transcoders transcoders
1154 :options options
1155 :filters filters
1156 :blocks blocks
1160 "Create a new back-end as a variant of an existing one.
1162 CHILD is the name of the derived back-end. PARENT is the name of
1163 the parent back-end.
1165 BODY can start with pre-defined keyword arguments. The following
1166 keywords are understood:
1168 :export-block
1170 String, or list of strings, representing block names that
1171 will not be parsed. This is used to specify blocks that will
1172 contain raw code specific to the back-end. These blocks
1173 still have to be handled by the `special-block' type
1174 translator.
1176 :filters-alist
1178 Alist of filters that will overwrite or complete filters
1179 defined in PARENT back-end. See `org-export-filters-alist'
1180 for a list of allowed filters.
1182 :menu-entry
1184 Menu entry for the export dispatcher. See
1185 `org-export-define-backend' for more information about the
1186 expected value.
1188 :options-alist
1190 Alist of back-end specific properties that will overwrite or
1191 complete those defined in PARENT back-end. Refer to
1192 `org-export-options-alist' for more information about
1193 structure of the values.
1195 :translate-alist
1197 Alist of element and object types and transcoders that will
1198 overwrite or complete transcode table from PARENT back-end.
1199 Refer to `org-export-define-backend' for detailed information
1200 about transcoders.
1203 as a variant of `latex' back-end with a custom template function:
1205 \(org-export-define-derived-backend 'my-latex 'latex
1206 :translate-alist '((template . my-latex-template-fun)))
1208 The back-end could then be called with, for example:
1226 :parent parent
1227 :transcoders transcoders
1228 :options options
1229 :filters filters
1230 :blocks blocks
1234 \f
1235 ;;; The Communication Channel
1236 ;;
1237 ;; During export process, every function has access to a number of
1238 ;; properties. They are of two types:
1239 ;;
1240 ;; 1. Environment options are collected once at the very beginning of
1241 ;; the process, out of the original buffer and configuration.
1242 ;; Collecting them is handled by `org-export-get-environment'
1243 ;; function.
1244 ;;
1245 ;; Most environment options are defined through the
1246 ;; `org-export-options-alist' variable.
1247 ;;
1248 ;; 2. Tree properties are extracted directly from the parsed tree,
1249 ;; just before export, by `org-export-collect-tree-properties'.
1250 ;;
1251 ;; Here is the full list of properties available during transcode
1252 ;; process, with their category and their value type.
1253 ;;
1254 ;; + `:author' :: Author's name.
1255 ;; - category :: option
1256 ;; - type :: string
1257 ;;
1258 ;; + `:back-end' :: Current back-end used for transcoding.
1259 ;; - category :: tree
1260 ;; - type :: structure
1261 ;;
1262 ;; + `:creator' :: String to write as creation information.
1263 ;; - category :: option
1264 ;; - type :: string
1265 ;;
1266 ;; + `:date' :: String to use as date.
1267 ;; - category :: option
1268 ;; - type :: string
1269 ;;
1270 ;; + `:description' :: Description text for the current data.
1271 ;; - category :: option
1272 ;; - type :: string
1273 ;;
1274 ;; + `:email' :: Author's email.
1275 ;; - category :: option
1276 ;; - type :: string
1277 ;;
1278 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1279 ;; process.
1280 ;; - category :: option
1281 ;; - type :: list of strings
1282 ;;
1283 ;; + `:export-options' :: List of export options available for current
1284 ;; process.
1285 ;; - category :: none
1286 ;; - type :: list of symbols, among `subtree', `body-only' and
1287 ;; `visible-only'.
1288 ;;
1289 ;; + `:exported-data' :: Hash table used for memoizing
1290 ;; `org-export-data'.
1291 ;; - category :: tree
1292 ;; - type :: hash table
1293 ;;
1294 ;; + `:filetags' :: List of global tags for buffer. Used by
1295 ;; `org-export-get-tags' to get tags with inheritance.
1296 ;; - category :: option
1297 ;; - type :: list of strings
1298 ;;
1299 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1300 ;; their definition, as parsed data. Only non-inlined footnotes
1301 ;; are represented in this alist. Also, every definition isn't
1302 ;; guaranteed to be referenced in the parse tree. The purpose of
1303 ;; this property is to preserve definitions from oblivion
1304 ;; (i.e. when the parse tree comes from a part of the original
1305 ;; buffer), it isn't meant for direct use in a back-end. To
1306 ;; retrieve a definition relative to a reference, use
1307 ;; `org-export-get-footnote-definition' instead.
1308 ;; - category :: option
1309 ;; - type :: alist (STRING . LIST)
1310 ;;
1311 ;; + `:headline-levels' :: Maximum level being exported as an
1312 ;; headline. Comparison is done with the relative level of
1313 ;; headlines in the parse tree, not necessarily with their
1314 ;; actual level.
1315 ;; - category :: option
1316 ;; - type :: integer
1317 ;;
1318 ;; + `:headline-offset' :: Difference between relative and real level
1319 ;; of headlines in the parse tree. For example, a value of -1
1320 ;; means a level 2 headline should be considered as level
1321 ;; 1 (cf. `org-export-get-relative-level').
1322 ;; - category :: tree
1323 ;; - type :: integer
1324 ;;
1325 ;; + `:headline-numbering' :: Alist between headlines and their
1326 ;; numbering, as a list of numbers
1327 ;; (cf. `org-export-get-headline-number').
1328 ;; - category :: tree
1329 ;; - type :: alist (INTEGER . LIST)
1330 ;;
1331 ;; + `:id-alist' :: Alist between ID strings and destination file's
1332 ;; path, relative to current directory. It is used by
1333 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1334 ;; external file.
1335 ;; - category :: option
1336 ;; - type :: alist (STRING . STRING)
1337 ;;
1338 ;; + `:ignore-list' :: List of elements and objects that should be
1339 ;; ignored during export.
1340 ;; - category :: tree
1341 ;; - type :: list of elements and objects
1342 ;;
1343 ;; + `:input-file' :: Full path to input file, if any.
1344 ;; - category :: option
1345 ;; - type :: string or nil
1346 ;;
1347 ;; + `:keywords' :: List of keywords attached to data.
1348 ;; - category :: option
1349 ;; - type :: string
1350 ;;
1351 ;; + `:language' :: Default language used for translations.
1352 ;; - category :: option
1353 ;; - type :: string
1354 ;;
1355 ;; + `:output-file' :: Full path to output file, if any.
1356 ;; - category :: option
1357 ;; - type :: string or nil
1358 ;;
1359 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1360 ;; transcoding.
1361 ;; - category :: option
1362 ;; - type :: list (as returned by `org-element-parse-buffer')
1363 ;;
1364 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1365 ;; all line breaks.
1366 ;; - category :: option
1367 ;; - type :: symbol (nil, t)
1368 ;;
1369 ;; + `:section-numbers' :: Non-nil means transcoding should add
1370 ;; section numbers to headlines.
1371 ;; - category :: option
1372 ;; - type :: symbol (nil, t)
1373 ;;
1374 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1375 ;; in transcoding. When such a tag is present, subtrees without
1376 ;; it are de facto excluded from the process. See
1377 ;; `use-select-tags'.
1378 ;; - category :: option
1379 ;; - type :: list of strings
1380 ;;
1381 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1382 ;; a time stamp in the output.
1383 ;; - category :: option
1384 ;; - type :: symbol (nil, t)
1385 ;;
1386 ;; + `:translate-alist' :: Alist between element and object types and
1387 ;; transcoding functions relative to the current back-end.
1388 ;; Special keys `inner-template', `template' and `plain-text' are
1389 ;; also possible.
1390 ;; - category :: option
1391 ;; - type :: alist (SYMBOL . FUNCTION)
1392 ;;
1393 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1394 ;; also be transcoded. If it is set to the `headline' symbol,
1395 ;; only the archived headline's name is retained.
1396 ;; - category :: option
1397 ;; - type :: symbol (nil, t, `headline')
1398 ;;
1399 ;; + `:with-author' :: Non-nil means author's name should be included
1400 ;; in the output.
1401 ;; - category :: option
1402 ;; - type :: symbol (nil, t)
1403 ;;
1404 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1405 ;; - category :: option
1406 ;; - type :: symbol (nil, t)
1407 ;;
1408 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1409 ;; inserted at the end of the transcoded string. If the value
1410 ;; is `comment', it should be commented.
1411 ;; - category :: option
1412 ;; - type :: symbol (`comment', nil, t)
1413 ;;
1414 ;; + `:with-date' :: Non-nil means output should contain a date.
1415 ;; - category :: option
1416 ;; - type :. symbol (nil, t)
1417 ;;
1418 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1419 ;; its value is a list of names, only drawers with such names
1420 ;; will be transcoded. If that list starts with `not', drawer
1421 ;; with these names will be skipped.
1422 ;; - category :: option
1423 ;; - type :: symbol (nil, t) or list of strings
1424 ;;
1425 ;; + `:with-email' :: Non-nil means output should contain author's
1426 ;; email.
1427 ;; - category :: option
1428 ;; - type :: symbol (nil, t)
1429 ;;
1430 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1431 ;; interpreted.
1432 ;; - category :: option
1433 ;; - type :: symbol (nil, t)
1434 ;;
1435 ;; + `:with-fixed-width' :: Non-nil if transcoder should export
1436 ;; strings starting with a colon as a fixed-with (verbatim) area.
1437 ;; - category :: option
1438 ;; - type :: symbol (nil, t)
1439 ;;
1440 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1441 ;; footnotes.
1442 ;; - category :: option
1443 ;; - type :: symbol (nil, t)
1444 ;;
1445 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1446 ;; `latex-fragment' objects should appear in export output. When
1447 ;; this property is set to `verbatim', they will be left as-is.
1448 ;; - category :: option
1449 ;; - type :: symbol (`verbatim', nil, t)
1450 ;;
1451 ;; + `:with-planning' :: Non-nil means transcoding should include
1452 ;; planning info.
1453 ;; - category :: option
1454 ;; - type :: symbol (nil, t)
1455 ;;
1456 ;; + `:with-priority' :: Non-nil means transcoding should include
1457 ;; priority cookies.
1458 ;; - category :: option
1459 ;; - type :: symbol (nil, t)
1460 ;;
1461 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1462 ;; plain text.
1463 ;; - category :: option
1464 ;; - type :: symbol (nil, t)
1465 ;;
1466 ;; + `:with-special-strings' :: Non-nil means transcoding should
1467 ;; interpret special strings in plain text.
1468 ;; - category :: option
1469 ;; - type :: symbol (nil, t)
1470 ;;
1471 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1472 ;; interpret subscript and superscript. With a value of "{}",
1473 ;; only interpret those using curly brackets.
1474 ;; - category :: option
1475 ;; - type :: symbol (nil, {}, t)
1476 ;;
1477 ;; + `:with-tables' :: Non-nil means transcoding should export tables.
1478 ;; - category :: option
1479 ;; - type :: symbol (nil, t)
1480 ;;
1481 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1482 ;; headlines. A `not-in-toc' value will remove them from the
1483 ;; table of contents, if any, nonetheless.
1484 ;; - category :: option
1485 ;; - type :: symbol (nil, t, `not-in-toc')
1486 ;;
1487 ;; + `:with-tasks' :: Non-nil means transcoding should include
1488 ;; headlines with a TODO keyword. A `todo' value will only
1489 ;; include headlines with a todo type keyword while a `done'
1490 ;; value will do the contrary. If a list of strings is provided,
1491 ;; only tasks with keywords belonging to that list will be kept.
1492 ;; - category :: option
1493 ;; - type :: symbol (t, todo, done, nil) or list of strings
1494 ;;
1495 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1496 ;; time stamps. Special value `active' (resp. `inactive') ask to
1497 ;; export only active (resp. inactive) timestamps. Otherwise,
1498 ;; completely remove them.
1499 ;; - category :: option
1500 ;; - type :: symbol: (`active', `inactive', t, nil)
1501 ;;
1502 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1503 ;; added to the output. An integer value limits its depth.
1504 ;; - category :: option
1505 ;; - type :: symbol (nil, t or integer)
1506 ;;
1507 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1508 ;; include TODO keywords.
1509 ;; - category :: option
1510 ;; - type :: symbol (nil, t)
1513 ;;;; Environment Options
1514 ;;
1515 ;; Environment options encompass all parameters defined outside the
1516 ;; scope of the parsed data. They come from five sources, in
1517 ;; increasing precedence order:
1518 ;;
1519 ;; - Global variables,
1520 ;; - Buffer's attributes,
1521 ;; - Options keyword symbols,
1522 ;; - Buffer keywords,
1523 ;; - Subtree properties.
1524 ;;
1525 ;; The central internal function with regards to environment options
1526 ;; is `org-export-get-environment'. It updates global variables with
1527 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1528 ;; the different sources.
1529 ;;
1530 ;; The internal functions doing the retrieval are:
1531 ;; `org-export--get-global-options',
1532 ;; `org-export--get-buffer-attributes',
1533 ;; `org-export--parse-option-keyword',
1534 ;; `org-export--get-subtree-options' and
1535 ;; `org-export--get-inbuffer-options'
1536 ;;
1537 ;; Also, `org-export--list-bound-variables' collects bound variables
1538 ;; along with their value in order to set them as buffer local
1539 ;; variables later in the process.
1542 "Collect export options from the current buffer.
1544 Optional argument BACKEND is an export back-end, as returned by
1545 `org-export-create-backend'.
1547 When optional argument SUBTREEP is non-nil, assume the export is
1548 done against the current sub-tree.
1550 Third optional argument EXT-PLIST is a property list with
1551 external parameters overriding Org default settings, but still
1552 inferior to file-local settings."
1553 ;; First install #+BIND variables since these must be set before
1554 ;; global options are read.
1557 ;; Get and prioritize export options...
1559 ;; ... from global variables...
1561 ;; ... from an external property list...
1562 ext-plist
1563 ;; ... from in-buffer settings...
1565 ;; ... and from subtree, when appropriate.
1567 ;; Eventually add misc. properties.
1569 :back-end
1570 backend
1572 :footnote-definition-alist
1573 ;; Footnotes definitions must be collected in the original
1574 ;; buffer, as there's no insurance that they will still be in
1575 ;; the parse tree, due to possible narrowing.
1591 alist))
1603 alist)))))))
1604 alist))
1605 :id-alist
1606 ;; Collect id references.
1617 alist))))
1620 "Parse an OPTIONS line and return values as a plist.
1621 Optional argument BACKEND is an export back-end, as returned by,
1622 e.g., `org-export-create-backend'. It specifies which back-end
1623 specific items to read, if any."
1625 ;; Priority is given to back-end specific options.
1627 org-export-options-alist))
1628 plist)
1637 options))
1639 property
1642 plist))
1645 "Get export options in subtree at point.
1646 Optional argument BACKEND is an export back-end, as returned by,
1647 e.g., `org-export-create-backend'. It specifies back-end used
1648 for export. Return options as a plist."
1649 ;; For each buffer keyword, create a headline property setting the
1650 ;; same property in communication channel. The name for the property
1651 ;; is the keyword with "EXPORT_" appended to it.
1654 ;; Make sure point is at a heading.
1656 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1657 ;; title (with no todo keyword, priority cookie or tag) as its
1658 ;; fallback value.
1664 plist :title
1667 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1671 ;; Handle other keywords. TITLE keyword is excluded as it has
1672 ;; been handled already.
1680 ;; Export properties are not case-sensitive.
1687 plist
1688 property
1690 ;; Parse VALUE if required.
1694 ;; If BEHAVIOR is `split' expected value is
1695 ;; a list of strings, not a string.
1698 ;; Look for both general keywords and back-end specific
1699 ;; options, with priority given to the latter.
1701 org-export-options-alist)))
1702 ;; Return value.
1703 plist)))
1706 "Return current buffer export options, as a plist.
1708 Optional argument BACKEND, when non-nil, is an export back-end,
1709 as returned by, e.g., `org-export-create-backend'. It specifies
1710 which back-end specific options should also be read in the
1711 process.
1713 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1715 get-options ; For byte-compiler.
1718 ;; Priority is given to back-end specific options.
1720 org-export-options-alist))
1723 org-export-special-keywords))))
1726 ;; Return all properties associated to KEYWORD.
1733 ;; Recursively read keywords in buffer. FILES is a list
1734 ;; of files read so far. PLIST is the current property
1735 ;; list obtained.
1744 ;; Options in `org-export-special-keywords'.
1748 ;; Avoid circular dependencies.
1758 plist
1763 plist
1769 ;; Options in `org-export-options-alist'.
1774 plist property
1775 ;; Handle value depending on specified
1776 ;; BEHAVIOR.
1782 " "
1795 ;; Return final value.
1796 plist))))
1797 ;; Read options in the current buffer.
1800 ;; Parse keywords specified in `org-element-document-properties'
1801 ;; and return PLIST.
1812 "Return properties related to buffer attributes, as a plist."
1813 ;; Store full path of input file name, or nil. For internal use.
1817 "Return global export options as a plist.
1818 Optional argument BACKEND, if non-nil, is an export back-end, as
1819 returned by, e.g., `org-export-create-backend'. It specifies
1820 which back-end specific export options should also be read in the
1821 process."
1823 ;; Priority is given to back-end specific options.
1825 org-export-options-alist)))
1831 plist
1832 prop
1833 ;; Evaluate default value provided. If keyword is
1834 ;; a member of `org-element-document-properties',
1835 ;; parse it as a secondary string before storing it.
1839 org-element-document-properties))
1842 value)))))))))
1845 "Return variables bound from BIND keywords in current buffer.
1846 Also look for BIND keywords in setup files. The return value is
1847 an alist where associations are (VARIABLE-NAME VALUE)."
1852 ;; Return an alist between variable names and their
1853 ;; value. FILES is a list of setup files names read so
1854 ;; far, used to avoid circular dependencies. ALIST is
1855 ;; the alist collected so far.
1866 ;; Enter setup file.
1876 alist))))))))))
1877 alist)))))
1878 ;; Return value in appropriate order of appearance.
1881 ;; defsubst org-export-get-parent must be defined before first use,
1882 ;; was originally defined in the topology section
1885 "Return BLOB parent or nil.
1886 BLOB is the element or object considered."
1889 ;;;; Tree Properties
1890 ;;
1891 ;; Tree properties are information extracted from parse tree. They
1892 ;; are initialized at the beginning of the transcoding process by
1893 ;; `org-export-collect-tree-properties'.
1894 ;;
1895 ;; Dedicated functions focus on computing the value of specific tree
1896 ;; properties during initialization. Thus,
1897 ;; `org-export--populate-ignore-list' lists elements and objects that
1898 ;; should be skipped during export, `org-export--get-min-level' gets
1899 ;; the minimal exportable level, used as a basis to compute relative
1900 ;; level for headlines. Eventually
1901 ;; `org-export--collect-headline-numbering' builds an alist between
1902 ;; headlines and their numbering.
1905 "Extract tree properties from parse tree.
1907 DATA is the parse tree from which information is retrieved. INFO
1908 is a list holding export options.
1910 Following tree properties are set or updated:
1912 `:exported-data' Hash table used to memoize results from
1913 `org-export-data'.
1915 `:footnote-definition-alist' List of footnotes definitions in
1916 original buffer and current parse tree.
1918 `:headline-offset' Offset between true level of headlines and
1919 local level. An offset of -1 means a headline
1920 of level 2 should be considered as a level
1921 1 headline in the context.
1923 `:headline-numbering' Alist of all headlines as key an the
1924 associated numbering as value.
1926 `:ignore-list' List of elements that should be ignored during
1927 export.
1929 Return updated plist."
1930 ;; Install the parse tree in the communication channel, in order to
1931 ;; use `org-export-get-genealogy' and al.
1933 ;; Get the list of elements and objects to ignore, and put it into
1934 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1935 ;; been done during parse tree filtering.
1938 :ignore-list
1941 ;; Compute `:headline-offset' in order to be able to use
1942 ;; `org-export-get-relative-level'.
1945 :headline-offset
1947 ;; Footnote definitions in parse tree override those stored in
1948 ;; `:footnote-definition-alist'. This way, any change to
1949 ;; a definition in the parse tree (e.g., through a parse tree
1950 ;; filter) propagates into the alist.
1957 defs))
1961 defs)))))
1963 ;; Properties order doesn't matter: get the rest of the tree
1964 ;; properties.
1968 info))
1971 "Return minimum exportable headline's level in DATA.
1972 DATA is parsed tree as returned by `org-element-parse-buffer'.
1973 OPTIONS is a plist holding export options."
1984 ;; If no headline was found, for the sake of consistency, set
1985 ;; minimum level to 1 nonetheless.
1989 "Return numbering of all exportable headlines in a parse tree.
1991 DATA is the parse tree. OPTIONS is the plist holding export
1992 options.
1994 Return an alist whose key is a headline and value is its
1995 associated numbering \(in the shape of a list of numbers\) or nil
1996 for a footnotes section."
2004 headline
2006 for idx from 0 to org-export-max-depth
2010 options)))
2013 "Return list of elements and objects to ignore during export.
2014 DATA is the parse tree to traverse. OPTIONS is the plist holding
2015 export options."
2017 ;; First find trees containing a select tag, if any.
2019 ;; If a select tag is active, also ignore the section before
2020 ;; the first headline, if any.
2024 first-element))))
2027 ;; Collect ignored elements or objects into IGNORE-LIST.
2033 ;; If headline is archived but tree below has
2034 ;; to be skipped, add it to ignore list.
2037 ;; Move into secondary string, if any.
2042 ;; Move into recursive objects/elements.
2044 ;; Main call.
2046 ;; Return value.
2047 ignore))
2050 "Return list of headlines and inlinetasks with a select tag in their tree.
2051 DATA is parsed data as returned by `org-element-parse-buffer'.
2052 INFO is a plist holding export options."
2054 walk-data ; For byte-compiler.
2064 ;; When a select tag is found, mark full
2065 ;; genealogy and every headline within the tree
2066 ;; as acceptable.
2069 genealogy
2072 selected-trees))
2073 ;; If at a headline, continue searching in tree,
2074 ;; recursively.
2084 selected-trees))
2087 "Non-nil when element or object BLOB should be skipped during export.
2088 OPTIONS is the plist holding export options. SELECTED, when
2089 non-nil, is a list of headlines or inlinetasks belonging to
2090 a tree with a select tag."
2097 ;; If `:with-drawers' value starts with `not', ignore
2098 ;; every drawer whose name belong to that list.
2099 ;; Otherwise, ignore drawers whose name isn't in that
2100 ;; list.
2117 ;; Ignore subtrees with an exclude tag.
2120 ;; When a select tag is present in the buffer, ignore any tree
2121 ;; without it.
2123 ;; Ignore commented sub-trees.
2125 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2127 ;; Ignore tasks, if specified by `:with-tasks' property.
2139 properties-set))))))
2150 ;; `:with-timestamps' only applies to isolated timestamps
2151 ;; objects, i.e. timestamp objects in a paragraph containing only
2152 ;; timestamps and whitespaces.
2160 options t))))
2169 \f
2170 ;;; The Transcoder
2171 ;;
2172 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2173 ;; `org-element-parse-buffer') and transcodes it into a specified
2174 ;; back-end output. It takes care of filtering out elements or
2175 ;; objects according to export options and organizing the output blank
2176 ;; lines and white space are preserved. The function memoizes its
2177 ;; results, so it is cheap to call it within transcoders.
2178 ;;
2179 ;; It is possible to modify locally the back-end used by
2180 ;; `org-export-data' or even use a temporary back-end by using
2181 ;; `org-export-data-with-backend'.
2182 ;;
2183 ;; Internally, three functions handle the filtering of objects and
2184 ;; elements during the export. In particular,
2185 ;; `org-export-ignore-element' marks an element or object so future
2186 ;; parse tree traversals skip it and `org-export-expand' transforms
2187 ;; the others back into their original shape.
2188 ;;
2189 ;; `org-export-transcoder' is an accessor returning appropriate
2190 ;; translator function for a given element or object.
2193 "Return appropriate transcoder for BLOB.
2194 INFO is a plist containing export directives."
2196 ;; Return contents only for complete parse trees.
2202 "Convert DATA into current back-end format.
2204 DATA is a parse tree, an element or an object or a secondary
2205 string. INFO is a plist holding export options.
2207 Return a string."
2212 ;; Ignored element/object.
2214 ;; Plain text.
2220 info))
2221 ;; Secondary string.
2224 ;; Element/Object without contents or, as a special
2225 ;; case, headline with archive tag and archived trees
2226 ;; restricted to title only.
2234 ;; Export snippets never return a nil value so
2235 ;; that white spaces following them are never
2236 ;; ignored.
2238 ;; Element/Object with contents.
2251 ;; Elements directly containing
2252 ;; objects must have their indentation
2253 ;; normalized first.
2255 data
2256 ;; When normalizing contents of the
2257 ;; first paragraph in an item or
2258 ;; a footnote definition, ignore
2259 ;; first line's indentation: there is
2260 ;; none and it might be misleading.
2265 data)
2272 info))))))))
2273 ;; Final result will be memoized before being returned.
2275 data
2279 ;; Append the same white space between elements or objects
2280 ;; as in the original buffer, and call appropriate filters.
2291 info)))
2292 results)))
2296 "Convert DATA into BACKEND format.
2298 DATA is an element, an object, a secondary string or a string.
2299 BACKEND is a symbol. INFO is a plist used as a communication
2300 channel.
2302 Unlike to `org-export-with-backend', this function will
2303 recursively convert DATA using BACKEND translation table."
2306 data
2307 ;; Set-up a new communication channel with translations defined in
2308 ;; BACKEND as the translate table and a new hash table for
2309 ;; memoization.
2311 info
2314 ;; Size of the hash table is reduced since this function
2315 ;; will probably be used on small trees.
2319 "Change uninterpreted elements back into Org syntax.
2320 DATA is the parse tree. INFO is a plist containing export
2321 options. Each uninterpreted element or object is changed back
2322 into a string. Contents, if any, are not modified. The parse
2323 tree is modified by side effect and returned by the function."
2327 prop
2330 info))))
2333 "Change uninterpreted elements back into Org syntax.
2334 DATA is a parse tree or a secondary string. INFO is a plist
2335 containing export options. It is modified by side effect and
2336 returned by the function."
2339 subscript superscript underline)
2343 ;; ... entities...
2350 ?\s)))))
2351 ;; ... emphasis...
2363 marker
2367 ?\s)))))))
2368 ;; ... LaTeX environments and fragments...
2372 ;; ... sub/superscripts...
2381 "_"
2390 ?\s)))))))))))
2392 ;; Splice NEW at BLOB location in parse tree.
2395 info)
2396 ;; Return modified parse tree.
2397 data)
2400 "Expand a parsed element or object to its original state.
2402 BLOB is either an element or an object. CONTENTS is its
2403 contents, as a string or nil.
2405 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2406 keywords before output."
2411 blob contents))))
2414 "Add ELEMENT to `:ignore-list' in INFO.
2416 Any element in `:ignore-list' will be skipped when using
2417 `org-element-map'. INFO is modified by side effects."
2421 \f
2422 ;;; The Filter System
2423 ;;
2424 ;; Filters allow end-users to tweak easily the transcoded output.
2425 ;; They are the functional counterpart of hooks, as every filter in
2426 ;; a set is applied to the return value of the previous one.
2427 ;;
2428 ;; Every set is back-end agnostic. Although, a filter is always
2429 ;; called, in addition to the string it applies to, with the back-end
2430 ;; used as argument, so it's easy for the end-user to add back-end
2431 ;; specific filters in the set. The communication channel, as
2432 ;; a plist, is required as the third argument.
2433 ;;
2434 ;; From the developer side, filters sets can be installed in the
2435 ;; process with the help of `org-export-define-backend', which
2436 ;; internally stores filters as an alist. Each association has a key
2437 ;; among the following symbols and a function or a list of functions
2438 ;; as value.
2439 ;;
2440 ;; - `:filter-options' applies to the property list containing export
2441 ;; options. Unlike to other filters, functions in this list accept
2442 ;; two arguments instead of three: the property list containing
2443 ;; export options and the back-end. Users can set its value through
2444 ;; `org-export-filter-options-functions' variable.
2445 ;;
2446 ;; - `:filter-parse-tree' applies directly to the complete parsed
2447 ;; tree. Users can set it through
2448 ;; `org-export-filter-parse-tree-functions' variable.
2449 ;;
2450 ;; - `:filter-final-output' applies to the final transcoded string.
2451 ;; Users can set it with `org-export-filter-final-output-functions'
2452 ;; variable
2453 ;;
2454 ;; - `:filter-plain-text' applies to any string not recognized as Org
2455 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2456 ;; configure it.
2457 ;;
2458 ;; - `:filter-TYPE' applies on the string returned after an element or
2459 ;; object of type TYPE has been transcoded. A user can modify
2460 ;; `org-export-filter-TYPE-functions'
2461 ;;
2462 ;; All filters sets are applied with
2463 ;; `org-export-filter-apply-functions' function. Filters in a set are
2464 ;; applied in a LIFO fashion. It allows developers to be sure that
2465 ;; their filters will be applied first.
2466 ;;
2467 ;; Filters properties are installed in communication channel with
2468 ;; `org-export-install-filters' function.
2469 ;;
2470 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2471 ;; `org-export-before-parsing-hook') are run at the beginning of the
2472 ;; export process and just before parsing to allow for heavy structure
2473 ;; modifications.
2476 ;;;; Hooks
2479 "Hook run at the beginning of the export process.
2481 This is run before include keywords and macros are expanded and
2482 Babel code blocks executed, on a copy of the original buffer
2483 being exported. Visibility and narrowing are preserved. Point
2484 is at the beginning of the buffer.
2486 Every function in this hook will be called with one argument: the
2490 "Hook run before parsing an export buffer.
2492 This is run after include keywords and macros have been expanded
2493 and Babel code blocks executed, on a copy of the original buffer
2494 being exported. Visibility and narrowing are preserved. Point
2495 is at the beginning of the buffer.
2497 Every function in this hook will be called with one argument: the
2501 ;;;; Special Filters
2504 "List of functions applied to the export options.
2505 Each filter is called with two arguments: the export options, as
2506 a plist, and the back-end, as a symbol. It must return
2510 "List of functions applied to the parsed tree.
2511 Each filter is called with three arguments: the parse tree, as
2512 returned by `org-element-parse-buffer', the back-end, as
2513 a symbol, and the communication channel, as a plist. It must
2517 "List of functions applied to plain text.
2518 Each filter is called with three arguments: a string which
2519 contains no Org syntax, the back-end, as a symbol, and the
2520 communication channel, as a plist. It must return a string or
2524 "List of functions applied to the transcoded string.
2525 Each filter is called with three arguments: the full transcoded
2526 string, the back-end, as a symbol, and the communication channel,
2527 as a plist. It must return a string that will be used as the
2531 ;;;; Elements Filters
2534 "List of functions applied to a transcoded babel-call.
2535 Each filter is called with three arguments: the transcoded data,
2536 as a string, the back-end, as a symbol, and the communication
2540 "List of functions applied to a transcoded center block.
2541 Each filter is called with three arguments: the transcoded data,
2542 as a string, the back-end, as a symbol, and the communication
2546 "List of functions applied to a transcoded clock.
2547 Each filter is called with three arguments: the transcoded data,
2548 as a string, the back-end, as a symbol, and the communication
2552 "List of functions applied to a transcoded comment.
2553 Each filter is called with three arguments: the transcoded data,
2554 as a string, the back-end, as a symbol, and the communication
2558 "List of functions applied to a transcoded comment-block.
2559 Each filter is called with three arguments: the transcoded data,
2560 as a string, the back-end, as a symbol, and the communication
2564 "List of functions applied to a transcoded diary-sexp.
2565 Each filter is called with three arguments: the transcoded data,
2566 as a string, the back-end, as a symbol, and the communication
2570 "List of functions applied to a transcoded drawer.
2571 Each filter is called with three arguments: the transcoded data,
2572 as a string, the back-end, as a symbol, and the communication
2576 "List of functions applied to a transcoded dynamic-block.
2577 Each filter is called with three arguments: the transcoded data,
2578 as a string, the back-end, as a symbol, and the communication
2582 "List of functions applied to a transcoded example-block.
2583 Each filter is called with three arguments: the transcoded data,
2584 as a string, the back-end, as a symbol, and the communication
2588 "List of functions applied to a transcoded fixed-width.
2589 Each filter is called with three arguments: the transcoded data,
2590 as a string, the back-end, as a symbol, and the communication
2594 "List of functions applied to a transcoded footnote-definition.
2595 Each filter is called with three arguments: the transcoded data,
2596 as a string, the back-end, as a symbol, and the communication
2600 "List of functions applied to a transcoded headline.
2601 Each filter is called with three arguments: the transcoded data,
2602 as a string, the back-end, as a symbol, and the communication
2606 "List of functions applied to a transcoded horizontal-rule.
2607 Each filter is called with three arguments: the transcoded data,
2608 as a string, the back-end, as a symbol, and the communication
2612 "List of functions applied to a transcoded inlinetask.
2613 Each filter is called with three arguments: the transcoded data,
2614 as a string, the back-end, as a symbol, and the communication
2618 "List of functions applied to a transcoded item.
2619 Each filter is called with three arguments: the transcoded data,
2620 as a string, the back-end, as a symbol, and the communication
2624 "List of functions applied to a transcoded keyword.
2625 Each filter is called with three arguments: the transcoded data,
2626 as a string, the back-end, as a symbol, and the communication
2630 "List of functions applied to a transcoded latex-environment.
2631 Each filter is called with three arguments: the transcoded data,
2632 as a string, the back-end, as a symbol, and the communication
2636 "List of functions applied to a transcoded node-property.
2637 Each filter is called with three arguments: the transcoded data,
2638 as a string, the back-end, as a symbol, and the communication
2642 "List of functions applied to a transcoded paragraph.
2643 Each filter is called with three arguments: the transcoded data,
2644 as a string, the back-end, as a symbol, and the communication
2648 "List of functions applied to a transcoded plain-list.
2649 Each filter is called with three arguments: the transcoded data,
2650 as a string, the back-end, as a symbol, and the communication
2654 "List of functions applied to a transcoded planning.
2655 Each filter is called with three arguments: the transcoded data,
2656 as a string, the back-end, as a symbol, and the communication
2660 "List of functions applied to a transcoded property-drawer.
2661 Each filter is called with three arguments: the transcoded data,
2662 as a string, the back-end, as a symbol, and the communication
2666 "List of functions applied to a transcoded quote block.
2667 Each filter is called with three arguments: the transcoded quote
2668 data, as a string, the back-end, as a symbol, and the
2669 communication channel, as a plist. It must return a string or
2673 "List of functions applied to a transcoded section.
2674 Each filter is called with three arguments: the transcoded data,
2675 as a string, the back-end, as a symbol, and the communication
2679 "List of functions applied to a transcoded special block.
2680 Each filter is called with three arguments: the transcoded data,
2681 as a string, the back-end, as a symbol, and the communication
2685 "List of functions applied to a transcoded src-block.
2686 Each filter is called with three arguments: the transcoded data,
2687 as a string, the back-end, as a symbol, and the communication
2691 "List of functions applied to a transcoded table.
2692 Each filter is called with three arguments: the transcoded data,
2693 as a string, the back-end, as a symbol, and the communication
2697 "List of functions applied to a transcoded table-cell.
2698 Each filter is called with three arguments: the transcoded data,
2699 as a string, the back-end, as a symbol, and the communication
2703 "List of functions applied to a transcoded table-row.
2704 Each filter is called with three arguments: the transcoded data,
2705 as a string, the back-end, as a symbol, and the communication
2709 "List of functions applied to a transcoded verse block.
2710 Each filter is called with three arguments: the transcoded data,
2711 as a string, the back-end, as a symbol, and the communication
2715 ;;;; Objects Filters
2718 "List of functions applied to transcoded bold text.
2719 Each filter is called with three arguments: the transcoded data,
2720 as a string, the back-end, as a symbol, and the communication
2724 "List of functions applied to transcoded code text.
2725 Each filter is called with three arguments: the transcoded data,
2726 as a string, the back-end, as a symbol, and the communication
2730 "List of functions applied to a transcoded entity.
2731 Each filter is called with three arguments: the transcoded data,
2732 as a string, the back-end, as a symbol, and the communication
2736 "List of functions applied to a transcoded export-snippet.
2737 Each filter is called with three arguments: the transcoded data,
2738 as a string, the back-end, as a symbol, and the communication
2742 "List of functions applied to a transcoded footnote-reference.
2743 Each filter is called with three arguments: the transcoded data,
2744 as a string, the back-end, as a symbol, and the communication
2748 "List of functions applied to a transcoded inline-babel-call.
2749 Each filter is called with three arguments: the transcoded data,
2750 as a string, the back-end, as a symbol, and the communication
2754 "List of functions applied to a transcoded inline-src-block.
2755 Each filter is called with three arguments: the transcoded data,
2756 as a string, the back-end, as a symbol, and the communication
2760 "List of functions applied to transcoded italic text.
2761 Each filter is called with three arguments: the transcoded data,
2762 as a string, the back-end, as a symbol, and the communication
2766 "List of functions applied to a transcoded latex-fragment.
2767 Each filter is called with three arguments: the transcoded data,
2768 as a string, the back-end, as a symbol, and the communication
2772 "List of functions applied to a transcoded line-break.
2773 Each filter is called with three arguments: the transcoded data,
2774 as a string, the back-end, as a symbol, and the communication
2778 "List of functions applied to a transcoded link.
2779 Each filter is called with three arguments: the transcoded data,
2780 as a string, the back-end, as a symbol, and the communication
2784 "List of functions applied to a transcoded radio-target.
2785 Each filter is called with three arguments: the transcoded data,
2786 as a string, the back-end, as a symbol, and the communication
2790 "List of functions applied to a transcoded statistics-cookie.
2791 Each filter is called with three arguments: the transcoded data,
2792 as a string, the back-end, as a symbol, and the communication
2796 "List of functions applied to transcoded strike-through text.
2797 Each filter is called with three arguments: the transcoded data,
2798 as a string, the back-end, as a symbol, and the communication
2802 "List of functions applied to a transcoded subscript.
2803 Each filter is called with three arguments: the transcoded data,
2804 as a string, the back-end, as a symbol, and the communication
2808 "List of functions applied to a transcoded superscript.
2809 Each filter is called with three arguments: the transcoded data,
2810 as a string, the back-end, as a symbol, and the communication
2814 "List of functions applied to a transcoded target.
2815 Each filter is called with three arguments: the transcoded data,
2816 as a string, the back-end, as a symbol, and the communication
2820 "List of functions applied to a transcoded timestamp.
2821 Each filter is called with three arguments: the transcoded data,
2822 as a string, the back-end, as a symbol, and the communication
2826 "List of functions applied to transcoded underline text.
2827 Each filter is called with three arguments: the transcoded data,
2828 as a string, the back-end, as a symbol, and the communication
2832 "List of functions applied to transcoded verbatim text.
2833 Each filter is called with three arguments: the transcoded data,
2834 as a string, the back-end, as a symbol, and the communication
2838 ;;;; Filters Tools
2839 ;;
2840 ;; Internal function `org-export-install-filters' installs filters
2841 ;; hard-coded in back-ends (developer filters) and filters from global
2842 ;; variables (user filters) in the communication channel.
2843 ;;
2844 ;; Internal function `org-export-filter-apply-functions' takes care
2845 ;; about applying each filter in order to a given data. It ignores
2846 ;; filters returning a nil value but stops whenever a filter returns
2847 ;; an empty string.
2850 "Call every function in FILTERS.
2852 Functions are called with arguments VALUE, current export
2853 back-end's name and INFO. A function returning a nil value will
2854 be skipped. If it returns the empty string, the process ends and
2855 VALUE is ignored.
2857 Call is done in a LIFO fashion, to be sure that developer
2858 specified filters, if any, are called first."
2869 "Install filters properties in communication channel.
2870 INFO is a plist containing the current communication channel.
2871 Return the updated communication channel."
2873 ;; Install user-defined filters with `org-export-filters-alist'
2874 ;; and filters already in INFO (through ext-plist mechanism).
2881 ;; Filters in INFO will be called
2882 ;; before those user provided.
2885 default-value)))))
2886 org-export-filters-alist)
2887 ;; Prepend back-end specific filters to that list.
2889 ;; Single values get consed, lists are appended.
2894 plist key
2898 ;; Return new communication channel.
2902 \f
2903 ;;; Core functions
2904 ;;
2905 ;; This is the room for the main function, `org-export-as', along with
2906 ;; its derivative, `org-export-string-as'.
2907 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2908 ;; function should be added to kill ring.
2909 ;;
2910 ;; Note that `org-export-as' doesn't really parse the current buffer,
2911 ;; but a copy of it (with the same buffer-local variables and
2912 ;; visibility), where macros and include keywords are expanded and
2913 ;; Babel blocks are executed, if appropriate.
2914 ;; `org-export-with-buffer-copy' macro prepares that copy.
2915 ;;
2916 ;; File inclusion is taken care of by
2917 ;; `org-export-expand-include-keyword' and
2918 ;; `org-export--prepare-file-contents'. Structure wise, including
2919 ;; a whole Org file in a buffer often makes little sense. For
2920 ;; example, if the file contains a headline and the include keyword
2921 ;; was within an item, the item should contain the headline. That's
2922 ;; why file inclusion should be done before any structure can be
2923 ;; associated to the file, that is before parsing.
2924 ;;
2925 ;; `org-export-insert-default-template' is a command to insert
2926 ;; a default template (or a back-end specific template) at point or in
2927 ;; current subtree.
2930 "Return a copy of the current buffer.
2931 The copy preserves Org buffer-local variables, visibility and
2932 narrowing."
2938 new-buf))
2941 "Apply BODY in a copy of the current buffer.
2942 The copy preserves local variables, visibility and contents of
2943 the original buffer. Point is at the beginning of the buffer
2944 when BODY is applied."
2953 ;; Kill copy without confirmation.
2959 "Generate a function duplicating BUFFER.
2961 The copy will preserve local variables, visibility, contents and
2962 narrowing of the original buffer. If a region was active in
2963 BUFFER, contents will be narrowed to that region instead.
2965 The resulting function can be evaluated at a later time, from
2966 another buffer, effectively cloning the original buffer there.
2968 The function assumes BUFFER's major mode is `org-mode'."
2972 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2973 ;; already in BUFFER.
2975 ;; Copy specific buffer local variables and variables set
2976 ;; through BIND keywords.
2978 vars)
2986 buffer-file-name
2987 buffer-file-coding-system))
2991 ;; Skip unreadable values, as they cannot be
2992 ;; sent to external process.
2996 vars))))))
2997 ;; Whole buffer contents.
3002 ;; Narrowing.
3006 ;; Current position of point.
3008 ;; Overlays with invisible property.
3018 ov-set))))
3020 ov-set)))))
3022 ;;;###autoload
3025 "Transcode current Org buffer into BACKEND code.
3027 BACKEND is either an export back-end, as returned by, e.g.,
3028 `org-export-create-backend', or a symbol referring to
3029 a registered back-end.
3031 If narrowing is active in the current buffer, only transcode its
3032 narrowed part.
3034 If a region is active, transcode that region.
3036 When optional argument SUBTREEP is non-nil, transcode the
3037 sub-tree at point, extracting information from the headline
3038 properties first.
3040 When optional argument VISIBLE-ONLY is non-nil, don't export
3041 contents of hidden elements.
3043 When optional argument BODY-ONLY is non-nil, only return body
3044 code, without surrounding template.
3046 Optional argument EXT-PLIST, when provided, is a property list
3047 with external parameters overriding Org default settings, but
3048 still inferior to file-local settings.
3050 Return code as a string."
3055 ;; Narrow buffer to an appropriate region or subtree for
3056 ;; parsing. If parsing subtree, be sure to remove main headline
3057 ;; too.
3065 ;; Initialize communication channel with original buffer
3066 ;; attributes, unavailable in its copy.
3075 tree)
3076 ;; Update communication channel and get parse tree. Buffer
3077 ;; isn't parsed directly. Instead, a temporary copy is
3078 ;; created, where include keywords, macros are expanded and
3079 ;; code blocks are evaluated.
3081 ;; Run first hook with current back-end's name as argument.
3085 ;; Update macro templates since #+INCLUDE keywords might have
3086 ;; added some new ones.
3090 ;; Update radio targets since keyword inclusion might have
3091 ;; added some more.
3093 ;; Run last hook with current back-end's name as argument.
3098 ;; Update communication channel with environment. Also
3099 ;; install user's and developer's filters.
3104 ;; Expand export-specific set of macros: {{{author}}},
3105 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3106 ;; once regular macros have been expanded, since document
3107 ;; keywords may contain one of them.
3113 ;; EMAIL is not a parsed keyword: store it as-is.
3117 ;; Parse buffer.
3119 ;; Handle left-over uninterpreted elements or objects in
3120 ;; parse tree and communication channel.
3122 ;; Call options filters and update export options. We do not
3123 ;; use `org-export-filter-apply-functions' here since the
3124 ;; arity of such filters is different.
3129 ;; Parse buffer, handle uninterpreted elements or objects,
3130 ;; then call parse-tree filters.
3134 ;; Now tree is complete, compute its properties and add them
3135 ;; to communication channel.
3139 ;; Eventually transcode TREE. Wrap the resulting string into
3140 ;; a template.
3149 ;; Remove all text properties since they cannot be
3150 ;; retrieved from an external process. Finally call
3151 ;; final-output filter and return result.
3157 info))))))))
3159 ;;;###autoload
3161 "Transcode STRING into BACKEND code.
3163 BACKEND is either an export back-end, as returned by, e.g.,
3164 `org-export-create-backend', or a symbol referring to
3165 a registered back-end.
3167 When optional argument BODY-ONLY is non-nil, only return body
3168 code, without preamble nor postamble.
3170 Optional argument EXT-PLIST, when provided, is a property list
3171 with external parameters overriding Org default settings, but
3172 still inferior to file-local settings.
3174 Return code as a string."
3180 ;;;###autoload
3182 "Replace the active region by its export to BACKEND.
3183 BACKEND is either an export back-end, as returned by, e.g.,
3184 `org-export-create-backend', or a symbol referring to
3185 a registered back-end."
3195 ;;;###autoload
3197 "Insert all export keywords with default values at beginning of line.
3199 BACKEND is a symbol referring to the name of a registered export
3200 back-end, for which specific export options should be added to
3201 the template, or `default' for default template. When it is nil,
3202 the user will be prompted for a category.
3204 If SUBTREEP is non-nil, export configuration will be set up
3205 locally for the subtree through node properties."
3215 "Options category: "
3219 org-export--registered-backends))
3220 nil t))))
3221 options keywords)
3222 ;; Populate OPTIONS and KEYWORDS.
3239 ;; Move to an appropriate location in order to insert options.
3241 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3259 ;; Then the rest of keywords, in the order specified in either
3260 ;; `org-export-options-alist' or respective export back-ends.
3281 "Expand every include keyword in buffer.
3282 Optional argument INCLUDED is a list of included file names along
3283 with their line restriction, when appropriate. It is used to
3284 avoid infinite recursion. Optional argument DIR is the current
3285 working directory. It is used to properly resolve relative
3286 paths."
3295 ;; Extract arguments from keyword's value.
3303 dir)
3308 value)
3315 ;; Minimal level of included file defaults to the child
3316 ;; level of the current headline, if any, or one. It
3317 ;; only applies is the file is meant to be included as
3318 ;; an Org one.
3330 ;; Remove keyword.
3336 ;; Check if files has already been parsed. Look after
3337 ;; inclusion lines too, as different parts of the same file
3338 ;; can be included too.
3353 ind-str block arg-str contents ind-str block))))
3360 ind-str block contents ind-str block))))
3367 file lines ind minlevel
3376 "Prepare the contents of FILE for inclusion and return them as a string.
3378 When optional argument LINES is a string specifying a range of
3379 lines, include only those lines.
3381 Optional argument IND, when non-nil, is an integer specifying the
3382 global indentation of returned contents. Since its purpose is to
3383 allow an included file to stay in the same environment it was
3384 created \(i.e. a list item), it doesn't apply past the first
3385 headline encountered.
3387 Optional argument MINLEVEL, when non-nil, is an integer
3388 specifying the level that any top-level headline in the included
3389 file should have.
3391 Optional argument ID is an integer that will be inserted before
3392 each footnote definition and reference if FILE is an Org file.
3393 This is useful to avoid conflicts when more than one Org file
3394 with footnotes is included in a document."
3410 ;; Remove blank lines at beginning and end of contents. The logic
3411 ;; behind that removal is that blank lines around include keyword
3412 ;; override blank lines in included file.
3421 ;; If IND is set, preserve indentation of include keyword until
3422 ;; the first headline encountered.
3429 ;; Do not move footnote definitions out of column 0.
3435 ;; When MINLEVEL is specified, compute minimal level for headlines
3436 ;; in the file (CUR-MIN), and remove stars to each headline so
3437 ;; that headlines with minimal level have a level of MINLEVEL.
3448 ;; Only change stars, don't bother moving whole
3449 ;; sections.
3453 ;; Append ID to all footnote references and definitions, so they
3454 ;; become file specific and cannot collide with footnotes in other
3455 ;; included files.
3472 "Execute every Babel code in the visible part of current buffer."
3473 ;; Get a pristine copy of current buffer so Babel references can be
3474 ;; properly resolved.
3480 "Return a non-nil value when output should be added to the kill ring.
3481 See also `org-export-copy-to-kill-ring'."
3487 \f
3488 ;;; Tools For Back-Ends
3489 ;;
3490 ;; A whole set of tools is available to help build new exporters. Any
3491 ;; function general enough to have its use across many back-ends
3492 ;; should be added here.
3494 ;;;; For Affiliated Keywords
3495 ;;
3496 ;; `org-export-read-attribute' reads a property from a given element
3497 ;; as a plist. It can be used to normalize affiliated keywords'
3498 ;; syntax.
3499 ;;
3500 ;; Since captions can span over multiple lines and accept dual values,
3501 ;; their internal representation is a bit tricky. Therefore,
3502 ;; `org-export-get-caption' transparently returns a given element's
3503 ;; caption as a secondary string.
3506 "Turn ATTRIBUTE property from ELEMENT into a plist.
3508 When optional argument PROPERTY is non-nil, return the value of
3509 that property within attributes.
3513 properties.
3515 All values will become strings except the empty string and
3518 will become the empty string."
3532 s)
3537 ;; Ignore any string before first property with `cdr'.
3542 "Return caption from ELEMENT as a secondary string.
3544 When optional argument SHORTP is non-nil, return short caption,
3545 as a secondary string, instead.
3547 Caption lines are separated by a white space."
3555 ;;;; For Derived Back-ends
3556 ;;
3557 ;; `org-export-with-backend' is a function allowing to locally use
3558 ;; another back-end to transcode some object or element. In a derived
3559 ;; back-end, it may be used as a fall-back function once all specific
3560 ;; cases have been treated.
3563 "Call a transcoder from BACKEND on DATA.
3564 BACKEND is an export back-end, as returned by, e.g.,
3565 `org-export-create-backend', or a symbol referring to
3566 a registered back-end. DATA is an Org element, object, secondary
3567 string or string. CONTENTS, when non-nil, is the transcoded
3568 contents of DATA element, as a string. INFO, when non-nil, is
3569 the communication channel used for export, as a plist."
3579 transcoder data contents
3582 :translate-alist all-transcoders
3586 ;;;; For Export Snippets
3587 ;;
3588 ;; Every export snippet is transmitted to the back-end. Though, the
3589 ;; latter will only retain one type of export-snippet, ignoring
3590 ;; others, based on the former's target back-end. The function
3591 ;; `org-export-snippet-backend' returns that back-end for a given
3592 ;; export-snippet.
3595 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3596 Translation, with `org-export-snippet-translation-alist', is
3597 applied."
3601 back-end))))
3604 ;;;; For Footnotes
3605 ;;
3606 ;; `org-export-collect-footnote-definitions' is a tool to list
3607 ;; actually used footnotes definitions in the whole parse tree, or in
3608 ;; a headline, in order to add footnote listings throughout the
3609 ;; transcoded data.
3610 ;;
3611 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3612 ;; back-ends, when they need to attach the footnote definition only to
3613 ;; the first occurrence of the corresponding label.
3614 ;;
3615 ;; `org-export-get-footnote-definition' and
3616 ;; `org-export-get-footnote-number' provide easier access to
3617 ;; additional information relative to a footnote reference.
3620 "Return an alist between footnote numbers, labels and definitions.
3622 DATA is the parse tree from which definitions are collected.
3623 INFO is the plist used as a communication channel.
3625 Definitions are sorted by order of references. They either
3626 appear as Org data or as a secondary string for inlined
3627 footnotes. Unreferenced definitions are ignored."
3629 collect-fn ; for byte-compiler.
3633 ;; Collect footnote number, label and definition in DATA.
3641 def)
3642 num-alist)
3643 ;; Also search in definition for nested footnotes.
3646 ;; Don't enter footnote definitions since it will happen
3647 ;; when their first reference is found.
3653 "Non-nil when a footnote reference is the first one for its label.
3655 FOOTNOTE-REFERENCE is the footnote reference being considered.
3656 INFO is the plist used as a communication channel."
3658 ;; Anonymous footnotes are always a first reference.
3660 ;; Otherwise, return the first footnote with the same LABEL and
3661 ;; test if it is equal to FOOTNOTE-REFERENCE.
3671 ;; If FN isn't inlined, be sure to traverse its
3672 ;; definition before resuming search. See
3673 ;; comments in `org-export-get-footnote-number'
3674 ;; for more information.
3678 ;; Don't enter footnote definitions since it will
3679 ;; happen when their first reference is found.
3682 footnote-reference)))))
3685 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3686 INFO is the plist used as a communication channel. If no such
3695 "Return number associated to a footnote.
3697 FOOTNOTE is either a footnote reference or a footnote definition.
3698 INFO is the plist used as a communication channel."
3700 seen-refs
3701 search-ref ; For byte-compiler.
3705 ;; Search footnote references through DATA, filling
3706 ;; SEEN-REFS along the way.
3711 ;; Anonymous footnote match: return number.
3714 ;; Labels match: return number.
3717 ;; Anonymous footnote: it's always a new one.
3718 ;; Also, be sure to return nil from the `cond' so
3719 ;; `first-match' doesn't get us out of the loop.
3721 ;; Label not seen so far: add it so SEEN-REFS.
3722 ;;
3723 ;; Also search for subsequent references in
3724 ;; footnote definition so numbering follows
3725 ;; reading logic. Note that we don't have to care
3726 ;; about inline definitions, since
3727 ;; `org-element-map' already traverses them at the
3728 ;; right time.
3729 ;;
3730 ;; Once again, return nil to stay in the loop.
3735 nil))))
3736 ;; Don't enter footnote definitions since it will
3737 ;; happen when their first reference is found.
3742 ;;;; For Headlines
3743 ;;
3744 ;; `org-export-get-relative-level' is a shortcut to get headline
3745 ;; level, relatively to the lower headline level in the parsed tree.
3746 ;;
3747 ;; `org-export-get-headline-number' returns the section number of an
3748 ;; headline, while `org-export-number-to-roman' allows to convert it
3749 ;; to roman numbers.
3750 ;;
3751 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3752 ;; `org-export-last-sibling-p' are three useful predicates when it
3753 ;; comes to fulfill the `:headline-levels' property.
3754 ;;
3755 ;; `org-export-get-tags', `org-export-get-category' and
3756 ;; `org-export-get-node-property' extract useful information from an
3757 ;; headline or a parent headline. They all handle inheritance.
3758 ;;
3759 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3760 ;; as a secondary string, suitable for table of contents. It falls
3761 ;; back onto default title.
3764 "Return HEADLINE relative level within current parsed tree.
3765 INFO is a plist holding contextual information."
3770 "Non-nil when HEADLINE is considered as low level.
3772 INFO is a plist used as a communication channel.
3774 A low level headlines has a relative level greater than
3775 `:headline-levels' property value.
3777 Return value is the difference between HEADLINE relative level
3778 and the last level being considered as high enough, or nil."
3785 "Return HEADLINE numbering as a list of numbers.
3786 INFO is a plist holding contextual information."
3790 "Return a non-nil value if HEADLINE element should be numbered.
3791 INFO is a plist used as a communication channel."
3797 "Convert integer N into a roman numeral."
3810 res)))
3813 "Return list of tags associated to ELEMENT.
3815 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3816 is a plist used as a communication channel.
3818 Select tags (see `org-export-select-tags') and exclude tags (see
3819 `org-export-exclude-tags') are removed from the list.
3821 When non-nil, optional argument TAGS should be a list of strings.
3822 Any tag belonging to this list will also be removed.
3824 When optional argument INHERITED is non-nil, tags can also be
3825 inherited from parent headlines and FILETAGS keywords."
3831 ;; Build complete list of inherited tags.
3842 ;; Add FILETAGS keywords and return results.
3846 "Return node PROPERTY value for BLOB.
3848 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3849 element or object.
3851 If optional argument INHERITED is non-nil, the value can be
3852 inherited from a parent headline.
3854 Return value is a string or nil."
3866 "Return category for element or object BLOB.
3868 INFO is a plist used as a communication channel.
3870 CATEGORY is automatically inherited from a parent headline, from
3871 #+CATEGORY: keyword or created out of original file name. If all
3884 "Return alternative title for HEADLINE, as a secondary string.
3885 INFO is a plist used as a communication channel. If no optional
3886 title is defined, fall-back to the regular title."
3891 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3892 INFO is a plist used as a communication channel."
3897 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3898 INFO is a plist used as a communication channel."
3902 ;;;; For Keywords
3903 ;;
3904 ;; `org-export-get-date' returns a date appropriate for the document
3905 ;; to about to be exported. In particular, it takes care of
3906 ;; `org-export-date-timestamp-format'.
3909 "Return date value for the current document.
3911 INFO is a plist used as a communication channel. FMT, when
3912 non-nil, is a time format string that will be applied on the date
3913 if it consists in a single timestamp object. It defaults to
3914 `org-export-date-timestamp-format' when nil.
3916 A proper date can be a secondary string, a string or nil. It is
3917 meant to be translated with `org-export-data' or alike."
3928 ;;;; For Links
3929 ;;
3930 ;; `org-export-solidify-link-text' turns a string into a safer version
3931 ;; for links, replacing most non-standard characters with hyphens.
3932 ;;
3933 ;; `org-export-get-coderef-format' returns an appropriate format
3934 ;; string for coderefs.
3935 ;;
3936 ;; `org-export-inline-image-p' returns a non-nil value when the link
3937 ;; provided should be considered as an inline image.
3938 ;;
3939 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3940 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3941 ;; returns an appropriate unique identifier when found, or nil.
3942 ;;
3943 ;; `org-export-resolve-id-link' returns the first headline with
3944 ;; specified id or custom-id in parse tree, the path to the external
3945 ;; file with the id or nil when neither was found.
3946 ;;
3947 ;; `org-export-resolve-coderef' associates a reference to a line
3948 ;; number in the element it belongs, or returns the reference itself
3949 ;; when the element isn't numbered.
3952 "Take link text S and make a safe target out of it."
3957 "Return format string for code reference link.
3958 PATH is the link path. DESC is its description."
3966 "Non-nil if LINK object points to an inline image.
3968 Optional argument is a set of RULES defining inline images. It
3969 is an alist where associations have the following shape:
3971 \(TYPE . REGEXP)
3973 Applying a rule means apply REGEXP against LINK's path when its
3974 type is TYPE. The function will return a non-nil value if any of
3975 the provided rules is non-nil. The default rule is
3976 `org-export-default-inline-image-rule'.
3978 This only applies to links without a description."
3989 rules)
3990 ;; Return nil if no rule matched.
3991 nil))))
3994 "Resolve a code reference REF.
3996 INFO is a plist used as a communication channel.
3998 Return associated line number in source code, or REF itself,
3999 depending on src-block or example element's switches."
4006 org-coderef-label-format)))
4010 ;; Element containing REF is found. Resolve it to either
4011 ;; a label or a line number, as needed.
4021 "Return LINK destination.
4023 INFO is a plist holding contextual information.
4025 Return value can be an object, an element, or nil:
4027 - If LINK path matches a target object (i.e. <<path>>) return it.
4029 - If LINK path exactly matches the name affiliated keyword
4030 \(i.e. #+NAME: path) of an element, return that element.
4032 - If LINK path exactly matches any headline name, return that
4033 element. If more than one headline share that name, priority
4034 will be given to the one with the closest common ancestor, if
4035 any, or the first one in the parse tree otherwise.
4037 - Otherwise, return nil.
4040 significant."
4043 ;; Split PATH at white spaces so matches are space
4044 ;; insensitive.
4047 ;; Cache for destinations that are not position dependent.
4055 ;; Destination is not position dependent: use cached value.
4057 ;; First try to find a matching "<<path>>" unless user specified
4058 ;; he was looking for a headline (path starts with a "*"
4059 ;; character).
4065 path)
4066 blob))
4069 ;; Then try to find an element with a matching "#+NAME: path"
4070 ;; affiliated keyword.
4073 org-element-all-elements
4078 el)))
4081 ;; Last case: link either points to a headline or to nothingness.
4082 ;; Try to find the source, with priority given to headlines with
4083 ;; the closest common ancestor. If such candidate is found,
4084 ;; return it, otherwise return nil.
4088 ;; Return first headline whose `:raw-value' property is
4089 ;; NAME in parse tree DATA, or nil. Statistics cookies
4090 ;; are ignored.
4098 name)
4099 headline))
4101 ;; Search among headlines sharing an ancestor with link, from
4102 ;; closest to farthest.
4111 ;; No destination found: return nil.
4115 "Return headline referenced as LINK destination.
4117 INFO is a plist used as a communication channel.
4119 Return value can be the headline element matched in current parse
4123 ;; First check if id is within the current parse tree.
4128 headline))
4130 ;; Otherwise, look for external files.
4134 "Return radio-target object referenced as LINK destination.
4136 INFO is a plist used as a communication channel.
4138 Return value can be a radio-target object or nil. Assume LINK
4147 nil nil path nil nil t)
4148 t)
4149 radio))
4153 ;;;; For References
4154 ;;
4155 ;; `org-export-get-ordinal' associates a sequence number to any object
4156 ;; or element.
4159 "Return ordinal number of an element or object.
4161 ELEMENT is the element or object considered. INFO is the plist
4162 used as a communication channel.
4164 Optional argument TYPES, when non-nil, is a list of element or
4165 object types, as symbols, that should also be counted in.
4166 Otherwise, only provided element's type is considered.
4168 Optional argument PREDICATE is a function returning a non-nil
4169 value if the current element or object should be counted in. It
4170 accepts two arguments: the element or object being considered and
4171 the plist used as a communication channel. This allows to count
4172 only a certain type of objects (i.e. inline images).
4174 Return value is a list of numbers if ELEMENT is a headline or an
4175 item. It is nil for keywords. It represents the footnote number
4176 for footnote definitions and footnote references. If ELEMENT is
4177 a target, return the same value as if ELEMENT was the closest
4178 table, item or headline containing the target. In any other
4179 case, return the sequence number of ELEMENT among elements or
4180 objects of the same type."
4181 ;; Ordinal of a target object refer to the ordinal of the closest
4182 ;; table, item, or headline containing the object.
4186 when
4190 table))
4191 return parent)))
4193 ;; Special case 1: A headline returns its number as a list.
4195 ;; Special case 2: An item returns its number as a list.
4199 struct
4206 ;; Increment counter until ELEMENT is found again.
4216 ;;;; For Special Blocks
4217 ;;
4218 ;; `org-export-raw-special-block-p' check if current special block is
4219 ;; an "export block", i.e., a block whose contents should be inserted
4220 ;; as-is in the output. This should generally be the first check to
4221 ;; do when handling special blocks in the export back-end.
4224 "Non-nil if ELEMENT is an export block relatively to current back-end.
4225 An export block is a special block whose contents should be
4226 included as-is in the final output. Such blocks are defined
4227 through :export-block property in `org-export-define-backend',
4228 which see."
4235 b))))
4238 ;;;; For Src Blocks
4239 ;;
4240 ;; `org-export-get-loc' counts number of code lines accumulated in
4241 ;; src-block or example-block elements with a "+n" switch until
4242 ;; a given element, excluded. Note: "-n" switches reset that count.
4243 ;;
4244 ;; `org-export-unravel-code' extracts source code (along with a code
4245 ;; references alist) from an `element-block' or `src-block' type
4246 ;; element.
4247 ;;
4248 ;; `org-export-format-code' applies a formatting function to each line
4249 ;; of code, providing relative line number and code reference when
4250 ;; appropriate. Since it doesn't access the original element from
4251 ;; which the source code is coming, it expects from the code calling
4252 ;; it to know if lines should be numbered and if code references
4253 ;; should appear.
4254 ;;
4255 ;; Eventually, `org-export-format-code-default' is a higher-level
4256 ;; function (it makes use of the two previous functions) which handles
4257 ;; line numbering and code references inclusion, and returns source
4258 ;; code in a format suitable for plain text or verbatim output.
4261 "Return accumulated lines of code up to ELEMENT.
4263 INFO is the plist used as a communication channel.
4265 ELEMENT is excluded from count."
4271 ;; ELEMENT is reached: Quit the loop.
4273 ;; Only count lines from src-block and example-block elements
4274 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4278 ;; Accumulate locs or reset them.
4282 ;; Return nil to stay in the loop.
4283 nil)))
4285 ;; Return value.
4286 loc))
4289 "Clean source code and extract references out of it.
4291 ELEMENT has either a `src-block' an `example-block' type.
4293 Return a cons cell whose CAR is the source code, cleaned from any
4294 reference, protective commas and spurious indentation, and CDR is
4295 an alist between relative line number (integer) and name of code
4296 reference on that line (string)."
4299 ;; Get code and clean it. Remove blank lines at its
4300 ;; beginning and end.
4307 value
4309 ;; Get format used for references.
4312 org-coderef-label-format)))
4313 ;; Build a regexp matching a loc with a reference.
4318 ;; Return value.
4320 ;; Code with references removed.
4326 ;; Ref line: remove ref, and signal its position in REFS.
4330 ;; Reference alist.
4331 refs)))
4334 "Format CODE by applying FUN line-wise and return it.
4336 CODE is a string representing the code to format. FUN is
4337 a function. It must accept three arguments: a line of
4338 code (string), the current line number (integer) or nil and the
4339 reference associated to the current line (string) or nil.
4341 Optional argument NUM-LINES can be an integer representing the
4342 number of code lines accumulated until the current code. Line
4343 numbers passed to FUN will take it into account. If it is nil,
4344 FUN's second argument will always be nil. This number can be
4345 obtained with `org-export-get-loc' function.
4347 Optional argument REF-ALIST can be an alist between relative line
4348 number (i.e. ignoring NUM-LINES) and the name of the code
4349 reference on it. If it is nil, FUN's third argument will always
4350 be nil. It can be obtained through the use of
4351 `org-export-unravel-code' function."
4363 "Return source code from ELEMENT, formatted in a standard way.
4365 ELEMENT is either a `src-block' or `example-block' element. INFO
4366 is a plist used as a communication channel.
4368 This function takes care of line numbering and code references
4369 inclusion. Line numbers, when applicable, appear at the
4370 beginning of the line, separated from the code by two white
4371 spaces. Code references, on the other hand, appear flushed to
4372 the right, separated by six white spaces from the widest line of
4373 code."
4374 ;; Extract code and references.
4381 ;; Handle line numbering.
4390 ;; Prepare references display, if required. Any reference
4391 ;; should start six columns after the widest line of code,
4392 ;; wrapped with parenthesis.
4397 code
4401 number-str
4402 loc
4408 num-start refs)))))
4411 ;;;; For Tables
4412 ;;
4413 ;; `org-export-table-has-special-column-p' and and
4414 ;; `org-export-table-row-is-special-p' are predicates used to look for
4415 ;; meta-information about the table structure.
4416 ;;
4417 ;; `org-table-has-header-p' tells when the rows before the first rule
4418 ;; should be considered as table's header.
4419 ;;
4420 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4421 ;; and `org-export-table-cell-borders' extract information from
4422 ;; a table-cell element.
4423 ;;
4424 ;; `org-export-table-dimensions' gives the number on rows and columns
4425 ;; in the table, ignoring horizontal rules and special columns.
4426 ;; `org-export-table-cell-address', given a table-cell object, returns
4427 ;; the absolute address of a cell. On the other hand,
4428 ;; `org-export-get-table-cell-at' does the contrary.
4429 ;;
4430 ;; `org-export-table-cell-starts-colgroup-p',
4431 ;; `org-export-table-cell-ends-colgroup-p',
4432 ;; `org-export-table-row-starts-rowgroup-p',
4433 ;; `org-export-table-row-ends-rowgroup-p',
4434 ;; `org-export-table-row-starts-header-p' and
4435 ;; `org-export-table-row-ends-header-p' indicate position of current
4436 ;; row or cell within the table.
4439 "Non-nil when TABLE has a special column.
4440 All special columns will be ignored during export."
4441 ;; The table has a special column when every first cell of every row
4442 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4443 ;; "*" "_" and "^". Though, do not consider a first row containing
4444 ;; only empty cells as special.
4460 "Non-nil when TABLE has a header.
4462 INFO is a plist used as a communication channel.
4464 A table has a header when it contains at least two row groups."
4473 table
4484 cache)))))
4487 "Non-nil if TABLE-ROW is considered special.
4489 INFO is a plist used as the communication channel.
4491 All special rows will be ignored during export."
4495 ;; A row is special either when...
4497 ;; ... it starts with a field only containing "/",
4499 ;; ... the table contains a special column and the row start
4500 ;; with a marking character among, "^", "_", "$" or "!",
4504 ;; ... it contains only alignment cookies and empty cells.
4510 ;; Since VALUE is a secondary string, the following
4511 ;; checks avoid expanding it with `org-export-data'.
4523 "Return TABLE-ROW's group number, as an integer.
4525 INFO is a plist used as the communication channel.
4527 Return value is the group number, as an integer, or nil for
4528 special rows and rows separators. First group is also table's
4529 header."
4547 "Return TABLE-CELL contents width.
4549 INFO is a plist used as the communication channel.
4551 Return value is the width given by the last width cookie in the
4552 same column as TABLE-CELL, or nil."
4571 ;; In a special row, try to find a width cookie at COLUMN.
4575 ;; The following checks avoid expanding unnecessarily
4576 ;; the cell with `org-export-data'.
4586 "Return TABLE-CELL contents alignment.
4588 INFO is a plist used as the communication channel.
4590 Return alignment as specified by the last alignment cookie in the
4591 same column as TABLE-CELL. If no such cookie is found, a default
4592 alignment value will be deduced from fraction of numbers in the
4593 column (see `org-table-number-fraction' for more information).
4594 Possible values are `left', `right' and `center'."
4595 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4612 cookie-align
4613 previous-cell-number-p)
4616 ;; In a special row, try to find an alignment cookie at
4617 ;; COLUMN.
4621 ;; Since VALUE is a secondary string, the following
4622 ;; checks avoid useless expansion through
4623 ;; `org-export-data'.
4631 ;; Ignore table rules.
4633 ;; In a standard row, check if cell's contents are
4634 ;; expressing some kind of number. Increase NUMBER-CELLS
4635 ;; accordingly. Though, don't bother if an alignment
4636 ;; cookie has already defined cell's alignment.
4641 info)))
4643 ;; Treat an empty cell as a number if it follows
4644 ;; a number.
4650 ;; Return value. Alignment specified by cookies has
4651 ;; precedence over alignment deduced from cell's contents.
4653 column
4658 org-table-number-fraction)
4663 "Return TABLE-CELL borders.
4665 INFO is a plist used as a communication channel.
4667 Return value is a list of symbols, or nil. Possible values are:
4668 `top', `bottom', `above', `below', `left' and `right'. Note:
4669 `top' (resp. `bottom') only happen for a cell in the first
4670 row (resp. last row) of the table, ignoring table rules, if any.
4672 Returned borders ignore special rows."
4675 borders)
4676 ;; Top/above border? TABLE-CELL has a border above when a rule
4677 ;; used to demarcate row groups can be found above. Hence,
4678 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4679 ;; another regular row has to be found above that rule.
4688 ;; Look at every row before the current one.
4690 ;; No rule above, or rule found starts the table (ignoring any
4691 ;; special row): TABLE-CELL is at the top of the table.
4694 ;; Bottom/below border? TABLE-CELL has a border below when next
4695 ;; non-regular row below is a rule.
4704 ;; Look at every row after the current one.
4706 ;; No rule below, or rule found ends the table (modulo some
4707 ;; special row): TABLE-CELL is at the bottom of the table.
4710 ;; Right/left borders? They can only be specified by column
4711 ;; groups. Column groups are defined in a row starting with "/".
4712 ;; Also a column groups row only contains "<", "<>", ">" or blank
4713 ;; cells.
4730 ;; There's a left border when previous cell, if
4731 ;; any, ends a group, or current one starts one.
4737 ;; There's a right border when next cell, if any,
4738 ;; starts a group, or current one ends one.
4745 ;; Table rows are read in reverse order so last column groups
4746 ;; row has precedence over any previous one.
4748 ;; Return value.
4749 borders))
4752 "Non-nil when TABLE-CELL is at the beginning of a column group.
4753 INFO is a plist used as a communication channel."
4754 ;; A cell starts a column group either when it is at the beginning
4755 ;; of a row (or after the special column, if any) or when it has
4756 ;; a left border.
4759 table-cell)
4763 "Non-nil when TABLE-CELL is at the end of a column group.
4764 INFO is a plist used as a communication channel."
4765 ;; A cell ends a column group either when it is at the end of a row
4766 ;; or when it has a right border.
4769 table-cell)
4773 "Non-nil when TABLE-ROW is at the beginning of a row group.
4774 INFO is a plist used as a communication channel."
4782 "Non-nil when TABLE-ROW is at the end of a row group.
4783 INFO is a plist used as a communication channel."
4791 "Non-nil when TABLE-ROW is the first table header's row.
4792 INFO is a plist used as a communication channel."
4799 "Non-nil when TABLE-ROW is the last table header's row.
4800 INFO is a plist used as a communication channel."
4807 "Return TABLE-ROW number.
4808 INFO is a plist used as a communication channel. Return value is
4809 zero-based and ignores separators. The function returns nil for
4810 special columns and separators."
4822 "Return TABLE dimensions.
4824 INFO is a plist used as a communication channel.
4826 Return value is a CONS like (ROWS . COLUMNS) where
4827 ROWS (resp. COLUMNS) is the number of exportable
4828 rows (resp. columns)."
4830 ;; Set number of rows, and extract first one.
4836 ;; Set number of columns.
4838 ;; Return value.
4842 "Return address of a regular TABLE-CELL object.
4844 TABLE-CELL is the cell considered. INFO is a plist used as
4845 a communication channel.
4847 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4848 zero-based index. Only exportable cells are considered. The
4849 function returns nil for other cells."
4861 "Return regular table-cell object at ADDRESS in TABLE.
4863 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4864 zero-based index. TABLE is a table type element. INFO is
4865 a plist used as a communication channel.
4867 If no table-cell, among exportable cells, is found at ADDRESS,
4868 return nil."
4871 ;; Row at (car address) or nil.
4879 'table-cell
4886 ;;;; For Tables Of Contents
4887 ;;
4888 ;; `org-export-collect-headlines' builds a list of all exportable
4889 ;; headline elements, maybe limited to a certain depth. One can then
4890 ;; easily parse it and transcode it.
4891 ;;
4892 ;; Building lists of tables, figures or listings is quite similar.
4893 ;; Once the generic function `org-export-collect-elements' is defined,
4894 ;; `org-export-collect-tables', `org-export-collect-figures' and
4895 ;; `org-export-collect-listings' can be derived from it.
4898 "Collect headlines in order to build a table of contents.
4900 INFO is a plist used as a communication channel.
4902 When optional argument N is an integer, it specifies the depth of
4903 the table of contents. Otherwise, it is set to the value of the
4904 last headline level. See `org-export-headline-levels' for more
4905 information.
4907 Return a list of all exportable headlines as parsed elements.
4908 Footnote sections, if any, will be ignored."
4916 info)))
4919 "Collect referenceable elements of a determined type.
4921 TYPE can be a symbol or a list of symbols specifying element
4922 types to search. Only elements with a caption are collected.
4924 INFO is a plist used as a communication channel.
4926 When non-nil, optional argument PREDICATE is a function accepting
4927 one argument, an element of type TYPE. It returns a non-nil
4928 value when that element should be collected.
4930 Return a list of all elements found, in order of appearance."
4935 element))
4936 info))
4939 "Build a list of tables.
4940 INFO is a plist used as a communication channel.
4942 Return a list of table elements with a caption."
4946 "Build a list of figures.
4948 INFO is a plist used as a communication channel. PREDICATE is
4949 a function which accepts one argument: a paragraph element and
4950 whose return value is non-nil when that element should be
4951 collected.
4953 A figure is a paragraph type element, with a caption, verifying
4955 a vague concept that may depend on back-end.
4957 Return a list of elements recognized as figures."
4961 "Build a list of src blocks.
4963 INFO is a plist used as a communication channel.
4965 Return a list of src-block elements with a caption."
4969 ;;;; Smart Quotes
4970 ;;
4971 ;; The main function for the smart quotes sub-system is
4972 ;; `org-export-activate-smart-quotes', which replaces every quote in
4973 ;; a given string from the parse tree with its "smart" counterpart.
4974 ;;
4975 ;; Dictionary for smart quotes is stored in
4976 ;; `org-export-smart-quotes-alist'.
4977 ;;
4978 ;; Internally, regexps matching potential smart quotes (checks at
4979 ;; string boundaries are also necessary) are defined in
4980 ;; `org-export-smart-quotes-regexps'.
4984 ;; one may use: »...«, "...", ›...‹, or '...'.
4985 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4986 ;; LaTeX quotes require Babel!
5031 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5040 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5049 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5058 ;; 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
5059 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5070 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5076 )
5077 "Smart quotes translations.
5079 Alist whose CAR is a language string and CDR is an alist with
5080 quote type as key and a plist associating various encodings to
5081 their translation as value.
5083 A quote type can be any symbol among `opening-double-quote',
5084 `closing-double-quote', `opening-single-quote',
5085 `closing-single-quote' and `apostrophe'.
5087 Valid encodings include `:utf-8', `:html', `:latex' and
5088 `:texinfo'.
5094 ;; Possible opening quote at beginning of string.
5096 ;; Possible closing quote at beginning of string.
5098 ;; Possible apostrophe at beginning of string.
5100 ;; Opening single and double quotes.
5102 ;; Closing single and double quotes.
5104 ;; Apostrophe.
5106 ;; Possible opening quote at end of string.
5108 ;; Possible closing quote at end of string.
5110 ;; Possible apostrophe at end of string.
5112 "List of regexps matching a quote or an apostrophe.
5118 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5119 `:utf-8'. INFO is a plist used as a communication channel.
5121 The function has to retrieve information about string
5122 surroundings in parse tree. It can only happen with an
5123 unmodified string. Thus, if S has already been through another
5124 process, a non-nil ORIGINAL optional argument will provide that
5125 original string.
5127 Return the new string."
5130 ;; Try to be flexible when computing number of blanks
5131 ;; before object. The previous object may be a string
5132 ;; introduced by the back-end and not completely parsed.
5135 ;; A string with missing `:post-blank'
5136 ;; property.
5140 ;; Fallback value.
5145 ;; Return smart quote associated to a give quote Q, as
5146 ;; a string. TYPE is a symbol among `open', `close' and
5147 ;; `apostrophe'.
5157 org-export-smart-quotes-alist))))
5158 encoding)
5159 q)))))
5161 ;; Only a quote: no regexp can match. We have to check both
5162 ;; sides and decide what to do.
5170 ;; 1. Replace quote character at the beginning of S.
5172 ;; Apostrophe?
5178 ;; Closing quote?
5184 ;; Opening quote?
5190 ;; 2. Replace quotes in the middle of the string.
5192 ;; Opening quotes.
5198 ;; Closing quotes.
5204 ;; Apostrophes.
5209 ;; 3. Replace quote character at the end of S.
5211 ;; Apostrophe?
5216 ;; Closing quote?
5222 ;; Opening quote?
5227 ;; Return string with smart quotes.
5228 s))))
5230 ;;;; Topology
5231 ;;
5232 ;; Here are various functions to retrieve information about the
5233 ;; neighborhood of a given element or object. Neighbors of interest
5234 ;; are direct parent (`org-export-get-parent'), parent headline
5235 ;; (`org-export-get-parent-headline'), first element containing an
5236 ;; object, (`org-export-get-parent-element'), parent table
5237 ;; (`org-export-get-parent-table'), previous element or object
5238 ;; (`org-export-get-previous-element') and next element or object
5239 ;; (`org-export-get-next-element').
5240 ;;
5241 ;; `org-export-get-genealogy' returns the full genealogy of a given
5242 ;; element or object, from closest parent to full parse tree.
5244 ;; defsubst org-export-get-parent must be defined before first use
5247 "Return full genealogy relative to a given element or object.
5249 BLOB is the element or object being considered.
5251 Ancestors are returned from closest to farthest, the last one
5252 being the full parse tree."
5259 "Return BLOB parent headline or nil.
5260 BLOB is the element or object being considered."
5264 parent))
5267 "Return first element containing OBJECT or nil.
5268 OBJECT is the object to consider."
5272 parent))
5275 "Return OBJECT parent table or nil.
5276 OBJECT is either a `table-cell' or `table-element' type object."
5280 parent))
5283 "Return previous element or object.
5285 BLOB is an element or object. INFO is a plist used as
5286 a communication channel. Return previous exportable element or
5287 object, a string, or nil.
5289 When optional argument N is a positive integer, return a list
5290 containing up to N siblings before BLOB, from farthest to
5291 closest. With any other non-nil value, return a list containing
5292 all of them."
5298 prev)
5308 "Return next element or object.
5310 BLOB is an element or object. INFO is a plist used as
5311 a communication channel. Return next exportable element or
5312 object, a string, or nil.
5314 When optional argument N is a positive integer, return a list
5315 containing up to N siblings after BLOB, from closest to farthest.
5316 With any other non-nil value, return a list containing all of
5317 them."
5324 next)
5334 ;;;; Translation
5335 ;;
5336 ;; `org-export-translate' translates a string according to the language
5337 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5338 ;; the dictionary used for the translation.
5385 ("ru" :html "(Продолжение следует)"
5483 ("ru" :html "Список распечаток"
5496 ("ru" :html "Список таблиц"
5579 ("ru" :html "Неизвестная ссылка"
5582 "Dictionary for export engine.
5584 Alist whose CAR is the string to translate and CDR is an alist
5585 whose CAR is the language string and CDR is a plist whose
5586 properties are possible charsets and values translated terms.
5588 It is used as a database for `org-export-translate'. Since this
5589 function returns the string as-is if no translation was found,
5590 the variable only needs to record values different from the
5594 "Translate string S according to language specification.
5596 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5597 and `:utf-8'. INFO is a plist used as a communication channel.
5599 Translation depends on `:language' property. Return the
5600 translated string. If no translation is found, try to fall back
5601 to `:default' encoding. If it fails, return S."
5607 s)))
5610 \f
5611 ;;; Asynchronous Export
5612 ;;
5613 ;; `org-export-async-start' is the entry point for asynchronous
5614 ;; export. It recreates current buffer (including visibility,
5615 ;; narrowing and visited file) in an external Emacs process, and
5616 ;; evaluates a command there. It then applies a function on the
5617 ;; returned results in the current process.
5618 ;;
5619 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5620 ;; allow to export to a buffer or a file, asynchronously or not.
5621 ;;
5622 ;; `org-export-output-file-name' is an auxiliary function meant to be
5623 ;; used with `org-export-to-file'. With a given extension, it tries
5624 ;; to provide a canonical file name to write export output to.
5625 ;;
5626 ;; Asynchronously generated results are never displayed directly.
5627 ;; Instead, they are stored in `org-export-stack-contents'. They can
5628 ;; then be retrieved by calling `org-export-stack'.
5629 ;;
5630 ;; Export Stack is viewed through a dedicated major mode
5631 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5632 ;;`org-export-stack-delete', `org-export-stack-view' and
5633 ;;`org-export-stack-clear'.
5634 ;;
5635 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5636 ;; It should be used whenever `org-export-async-start' is called.
5639 "Call function FUN on the results returned by BODY evaluation.
5641 BODY evaluation happens in an asynchronous process, from a buffer
5642 which is an exact copy of the current one.
5644 Use `org-export-add-to-stack' in FUN in order to register results
5645 in the stack.
5647 This is a low level function. See also `org-export-to-buffer'
5648 and `org-export-to-file' for more specialized functions."
5651 ;; Write the full sexp evaluating BODY in a copy of the current
5652 ;; buffer to a temporary file, as it may be too long for program
5653 ;; args in `start-process'.
5660 ;; Null characters (from variable values) are inserted
5661 ;; within the file. As a consequence, coding system for
5662 ;; buffer contents will not be recognized properly. So,
5663 ;; we make sure it is the same as the one used to display
5664 ;; the original buffer.
5666 ,coding
5669 ;; Ignore `kill-emacs-hook' and code evaluation
5670 ;; queries from Babel as we need a truly
5671 ;; non-interactive process.
5673 org-babel-confirm-evaluate-answer-no t)
5674 ;; Initialize export framework.
5676 ;; Re-create current buffer there.
5679 ;; Sexp to evaluate in the buffer.
5681 ;; Start external process.
5684 (,process
5686 #'start-process
5689 ,proc-buffer
5696 ;; Register running process in stack.
5698 ;; Set-up sentinel in order to catch results.
5701 ,process
5723 ;;;###autoload
5726 &optional async subtreep visible-only body-only ext-plist
5727 post-process)
5728 "Call `org-export-as' with output to a specified buffer.
5730 BACKEND is either an export back-end, as returned by, e.g.,
5731 `org-export-create-backend', or a symbol referring to
5732 a registered back-end.
5734 BUFFER is the name of the output buffer. If it already exists,
5735 it will be erased first, otherwise, it will be created.
5737 A non-nil optional argument ASYNC means the process should happen
5738 asynchronously. The resulting buffer should then be accessible
5739 through the `org-export-stack' interface. When ASYNC is nil, the
5740 buffer is displayed if `org-export-show-temporary-export-buffer'
5741 is non-nil.
5743 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5744 EXT-PLIST are similar to those used in `org-export-as', which
5745 see.
5747 Optional argument POST-PROCESS is a function which should accept
5748 no argument. It is always called within the current process,
5749 from BUFFER, with point at its beginning. Export back-ends can
5750 use it to set a major mode there, e.g,
5752 \(defun org-latex-export-as-latex
5753 \(&optional async subtreep visible-only body-only ext-plist)
5754 \(interactive)
5756 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5758 This function returns BUFFER."
5786 buffer)))
5788 ;;;###autoload
5791 post-process)
5792 "Call `org-export-as' with output to a specified file.
5794 BACKEND is either an export back-end, as returned by, e.g.,
5795 `org-export-create-backend', or a symbol referring to
5796 a registered back-end. FILE is the name of the output file, as
5797 a string.
5799 A non-nil optional argument ASYNC means the process should happen
5800 asynchronously. The resulting buffer will then be accessible
5801 through the `org-export-stack' interface.
5803 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5804 EXT-PLIST are similar to those used in `org-export-as', which
5805 see.
5807 Optional argument POST-PROCESS is called with FILE as its
5808 argument and happens asynchronously when ASYNC is non-nil. It
5809 has to return a file name, or nil. Export back-ends can use this
5810 to send the output file through additional processing, e.g,
5812 \(defun org-latex-export-to-latex
5813 \(&optional async subtreep visible-only body-only ext-plist)
5814 \(interactive)
5816 \(org-export-to-file 'latex outfile
5817 async subtreep visible-only body-only ext-plist
5818 \(lambda (file) (org-latex-compile file)))
5820 The function returns either a file name returned by POST-PROCESS,
5821 or FILE."
5840 backend subtreep visible-only body-only ext-plist)))
5847 ;; Get proper return value.
5849 file))))))
5852 "Return output file's name according to buffer specifications.
5854 EXTENSION is a string representing the output file extension,
5855 with the leading dot.
5857 With a non-nil optional argument SUBTREEP, try to determine
5859 of subtree at point.
5861 When optional argument PUB-DIR is set, use it as the publishing
5862 directory.
5864 When optional argument VISIBLE-ONLY is non-nil, don't export
5865 contents of hidden elements.
5867 Return file name as a string."
5870 ;; File name may come from EXPORT_FILE_NAME subtree
5871 ;; property, assuming point is at beginning of said
5872 ;; sub-tree.
5879 ;; File name may be extracted from buffer's associated
5880 ;; file, if any.
5882 ;; Can't determine file name on our own: Ask user.
5886 "Output file: " pub-dir nil nil nil
5890 ;; Build file name. Enforce EXTENSION over whatever user
5891 ;; may have come up with. PUB-DIR, if defined, always has
5892 ;; precedence over any provided path.
5897 extension))
5900 ;; If writing to OUTPUT-FILE would overwrite original file, append
5901 ;; EXTENSION another time to final name.
5904 output-file)))
5907 "Add a new result to export stack if not present already.
5909 SOURCE is a buffer or a file name containing export results.
5910 BACKEND is a symbol representing export back-end used to generate
5911 it.
5913 Entries already pointing to SOURCE and unavailable entries are
5914 removed beforehand. Return the new stack."
5920 "Menu for asynchronous export results and running processes."
5930 "Return source from export results at point in stack."
5937 source
5938 ;; SOURCE is not consistent with current line. The stack
5939 ;; view is outdated.
5943 "Remove all entries from export stack."
5948 "Refresh the asynchronous export stack.
5949 DUMMY is ignored. Unavailable sources are removed from the list.
5950 Return the new stack."
5960 ;; Back-end.
5962 ;; Age.
5965 ;; Compute age of the results.
5967 "%4h:%.2m "
5969 ;; Source.
5974 ;; Clear stack from exited processes, dead buffers or
5975 ;; non-existent files.
5987 "Remove export results at point from stack.
5988 If optional argument SOURCE is non-nil, remove it instead."
5993 org-export-stack-contents))))
5996 "View export results at point in stack.
5997 With an optional prefix argument IN-EMACS, force viewing files
5998 within Emacs."
6012 (define-key km "p" 'previous-line)
6013 (define-key km "\C-p" 'previous-line)
6014 (define-key km "\C-?" 'previous-line)
6015 (define-key km [up] 'previous-line)
6016 (define-key km "C" 'org-export-stack-clear)
6017 (define-key km "v" 'org-export-stack-view)
6018 (define-key km (kbd "RET") 'org-export-stack-view)
6019 (define-key km "d" 'org-export-stack-remove)
6020 km)
6021 "Keymap for Org Export Stack.")
6023 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6024 "Mode for displaying asynchronous export stack.
6027 stack.
6029 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6030 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6031 stack completely.
6033 Removing entries in an Org Export Stack buffer doesn't affect
6034 files or buffers, only the display.
6037 (abbrev-mode 0)
6038 (auto-fill-mode 0)
6039 (setq buffer-read-only t
6040 buffer-undo-list t
6041 truncate-lines t
6042 header-line-format
6043 '(:eval
6044 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6045 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6046 (set (make-local-variable 'revert-buffer-function)
6047 'org-export-stack-refresh))
6050 \f
6051 ;;; The Dispatcher
6052 ;;
6053 ;; `org-export-dispatch' is the standard interactive way to start an
6054 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6055 ;; for its interface, which, in turn, delegates response to key
6056 ;; pressed to `org-export--dispatch-action'.
6058 ;;;###autoload
6059 (defun org-export-dispatch (&optional arg)
6060 "Export dispatcher for Org mode.
6062 It provides an access to common export related tasks in a buffer.
6063 Its interface comes in two flavors: standard and expert.
6065 While both share the same set of bindings, only the former
6066 displays the valid keys associations in a dedicated buffer.
6067 Scrolling (resp. line-wise motion) in this buffer is done with
6068 SPC and DEL (resp. C-n and C-p) keys.
6070 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6071 flavor or the other.
6074 of options used back then, on the current buffer.
6076 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6077 (interactive "P")
6078 (let* ((input
6079 (cond ((equal arg '(16)) '(stack))
6080 ((and arg org-export-dispatch-last-action))
6081 (t (save-window-excursion
6082 (unwind-protect
6083 (progn
6084 ;; Remember where we are
6085 (move-marker org-export-dispatch-last-position
6086 (point)
6087 (org-base-buffer (current-buffer)))
6088 ;; Get and store an export command
6089 (setq org-export-dispatch-last-action
6090 (org-export--dispatch-ui
6091 (list org-export-initial-scope
6092 (and org-export-in-background 'async))
6093 nil
6094 org-export-dispatch-use-expert-ui)))
6095 (and (get-buffer "*Org Export Dispatcher*")
6096 (kill-buffer "*Org Export Dispatcher*")))))))
6097 (action (car input))
6098 (optns (cdr input)))
6099 (unless (memq 'subtree optns)
6100 (move-marker org-export-dispatch-last-position nil))
6101 (case action
6102 ;; First handle special hard-coded actions.
6103 (template (org-export-insert-default-template nil optns))
6104 (stack (org-export-stack))
6105 (publish-current-file
6106 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6107 (publish-current-project
6108 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6109 (publish-choose-project
6110 (org-publish (assoc (org-icompleting-read
6111 "Publish project: "
6112 org-publish-project-alist nil t)
6113 org-publish-project-alist)
6114 (memq 'force optns)
6115 (memq 'async optns)))
6116 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6117 (otherwise
6118 (save-excursion
6119 (when arg
6120 ;; Repeating command, maybe move cursor to restore subtree
6121 ;; context.
6122 (if (eq (marker-buffer org-export-dispatch-last-position)
6123 (org-base-buffer (current-buffer)))
6124 (goto-char org-export-dispatch-last-position)
6125 ;; We are in a different buffer, forget position.
6126 (move-marker org-export-dispatch-last-position nil)))
6127 (funcall action
6128 ;; Return a symbol instead of a list to ease
6129 ;; asynchronous export macro use.
6130 (and (memq 'async optns) t)
6131 (and (memq 'subtree optns) t)
6132 (and (memq 'visible optns) t)
6133 (and (memq 'body optns) t)))))))
6135 (defun org-export--dispatch-ui (options first-key expertp)
6136 "Handle interface for `org-export-dispatch'.
6138 OPTIONS is a list containing current interactive options set for
6139 export. It can contain any of the following symbols:
6140 `body' toggles a body-only export
6141 `subtree' restricts export to current subtree
6142 `visible' restricts export to visible part of buffer.
6143 `force' force publishing files.
6144 `async' use asynchronous export process
6146 FIRST-KEY is the key pressed to select the first level menu. It
6147 is nil when this menu hasn't been selected yet.
6149 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6150 buffer is provided, but indications about currently active
6151 options are given in the prompt. Moreover, \[?] allows to switch
6152 back to standard interface."
6153 (let* ((fontify-key
6154 (lambda (key &optional access-key)
6155 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6156 ;; non-nil is the required first-level key to activate
6157 ;; KEY. When its value is t, activate KEY independently
6158 ;; on the first key, if any. A nil value means KEY will
6159 ;; only be activated at first level.
6160 (if (or (eq access-key t) (eq access-key first-key))
6161 (org-propertize key 'face 'org-warning)
6162 key)))
6163 (fontify-value
6164 (lambda (value)
6165 ;; Fontify VALUE string.
6166 (org-propertize value 'face 'font-lock-variable-name-face)))
6167 ;; Prepare menu entries by extracting them from registered
6168 ;; back-ends and sorting them by access key and by ordinal,
6169 ;; if any.
6170 (entries
6171 (sort (sort (delq nil
6172 (mapcar 'org-export-backend-menu
6173 org-export--registered-backends))
6174 (lambda (a b)
6175 (let ((key-a (nth 1 a))
6176 (key-b (nth 1 b)))
6177 (cond ((and (numberp key-a) (numberp key-b))
6178 (< key-a key-b))
6179 ((numberp key-b) t)))))
6180 'car-less-than-car))
6181 ;; Compute a list of allowed keys based on the first key
6182 ;; pressed, if any. Some keys
6183 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6184 ;; available.
6185 (allowed-keys
6186 (nconc (list 2 22 19 6 1)
6187 (if (not first-key) (org-uniquify (mapcar 'car entries))
6188 (let (sub-menu)
6189 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6190 (when (eq (car entry) first-key)
6191 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6192 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6193 ((not first-key) (list ?P)))
6194 (list ?& ?#)
6195 (when expertp (list ??))
6196 (list ?q)))
6197 ;; Build the help menu for standard UI.
6198 (help
6199 (unless expertp
6200 (concat
6201 ;; Options are hard-coded.
6202 (format "[%s] Body only: %s [%s] Visible only: %s
6203 \[%s] Export scope: %s [%s] Force publishing: %s
6205 (funcall fontify-key "C-b" t)
6206 (funcall fontify-value
6207 (if (memq 'body options) "On " "Off"))
6208 (funcall fontify-key "C-v" t)
6209 (funcall fontify-value
6210 (if (memq 'visible options) "On " "Off"))
6211 (funcall fontify-key "C-s" t)
6212 (funcall fontify-value
6213 (if (memq 'subtree options) "Subtree" "Buffer "))
6214 (funcall fontify-key "C-f" t)
6215 (funcall fontify-value
6216 (if (memq 'force options) "On " "Off"))
6217 (funcall fontify-key "C-a" t)
6218 (funcall fontify-value
6219 (if (memq 'async options) "On " "Off")))
6220 ;; Display registered back-end entries. When a key
6221 ;; appears for the second time, do not create another
6222 ;; entry, but append its sub-menu to existing menu.
6223 (let (last-key)
6224 (mapconcat
6225 (lambda (entry)
6226 (let ((top-key (car entry)))
6227 (concat
6228 (unless (eq top-key last-key)
6229 (setq last-key top-key)
6231 (funcall fontify-key (char-to-string top-key))
6232 (nth 1 entry)))
6233 (let ((sub-menu (nth 2 entry)))
6234 (unless (functionp sub-menu)
6235 ;; Split sub-menu into two columns.
6236 (let ((index -1))
6237 (concat
6238 (mapconcat
6239 (lambda (sub-entry)
6240 (incf index)
6241 (format
6242 (if (zerop (mod index 2)) " [%s] %-26s"
6244 (funcall fontify-key
6245 (char-to-string (car sub-entry))
6246 top-key)
6247 (nth 1 sub-entry)))
6248 sub-menu "")
6250 entries ""))
6251 ;; Publishing menu is hard-coded.
6253 [%s] Current file [%s] Current project
6255 (funcall fontify-key "P")
6256 (funcall fontify-key "f" ?P)
6257 (funcall fontify-key "p" ?P)
6258 (funcall fontify-key "x" ?P)
6259 (funcall fontify-key "a" ?P))
6261 (funcall fontify-key "&" t)
6262 (funcall fontify-key "#" t))
6263 (format "[%s] %s"
6264 (funcall fontify-key "q" t)
6265 (if first-key "Main menu" "Exit")))))
6266 ;; Build prompts for both standard and expert UI.
6267 (standard-prompt (unless expertp "Export command: "))
6268 (expert-prompt
6269 (when expertp
6270 (format
6271 "Export command (C-%s%s%s%s%s) [%s]: "
6272 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6273 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6274 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6275 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6276 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6277 (mapconcat (lambda (k)
6278 ;; Strip control characters.
6279 (unless (< k 27) (char-to-string k)))
6280 allowed-keys "")))))
6281 ;; With expert UI, just read key with a fancy prompt. In standard
6282 ;; UI, display an intrusive help buffer.
6283 (if expertp
6284 (org-export--dispatch-action
6285 expert-prompt allowed-keys entries options first-key expertp)
6286 ;; At first call, create frame layout in order to display menu.
6287 (unless (get-buffer "*Org Export Dispatcher*")
6288 (delete-other-windows)
6289 (org-switch-to-buffer-other-window
6290 (get-buffer-create "*Org Export Dispatcher*"))
6291 (setq cursor-type nil
6292 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6293 ;; Make sure that invisible cursor will not highlight square
6294 ;; brackets.
6295 (set-syntax-table (copy-syntax-table))
6296 (modify-syntax-entry ?\[ "w"))
6297 ;; At this point, the buffer containing the menu exists and is
6298 ;; visible in the current window. So, refresh it.
6299 (with-current-buffer "*Org Export Dispatcher*"
6300 ;; Refresh help. Maintain display continuity by re-visiting
6301 ;; previous window position.
6302 (let ((pos (window-start)))
6303 (erase-buffer)
6304 (insert help)
6305 (set-window-start nil pos)))
6306 (org-fit-window-to-buffer)
6307 (org-export--dispatch-action
6308 standard-prompt allowed-keys entries options first-key expertp))))
6310 (defun org-export--dispatch-action
6311 (prompt allowed-keys entries options first-key expertp)
6312 "Read a character from command input and act accordingly.
6314 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6315 a list of characters available at a given step in the process.
6316 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6317 EXPERTP are the same as defined in `org-export--dispatch-ui',
6318 which see.
6320 Toggle export options when required. Otherwise, return value is
6321 a list with action as CAR and a list of interactive export
6322 options as CDR."
6323 (let (key)
6324 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6325 ;; C-p, SPC, DEL).
6326 (while (and (setq key (read-char-exclusive prompt))
6327 (not expertp)
6328 (memq key '(14 16 ?\s ?\d)))
6329 (case key
6330 (14 (if (not (pos-visible-in-window-p (point-max)))
6331 (ignore-errors (scroll-up 1))
6332 (message "End of buffer")
6333 (sit-for 1)))
6334 (16 (if (not (pos-visible-in-window-p (point-min)))
6335 (ignore-errors (scroll-down 1))
6336 (message "Beginning of buffer")
6337 (sit-for 1)))
6338 (?\s (if (not (pos-visible-in-window-p (point-max)))
6339 (scroll-up nil)
6340 (message "End of buffer")
6341 (sit-for 1)))
6342 (?\d (if (not (pos-visible-in-window-p (point-min)))
6343 (scroll-down nil)
6344 (message "Beginning of buffer")
6345 (sit-for 1)))))
6346 (cond
6347 ;; Ignore undefined associations.
6348 ((not (memq key allowed-keys))
6349 (ding)
6350 (unless expertp (message "Invalid key") (sit-for 1))
6351 (org-export--dispatch-ui options first-key expertp))
6352 ;; q key at first level aborts export. At second level, cancel
6353 ;; first key instead.
6354 ((eq key ?q) (if (not first-key) (error "Export aborted")
6355 (org-export--dispatch-ui options nil expertp)))
6356 ;; Help key: Switch back to standard interface if expert UI was
6357 ;; active.
6358 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6359 ;; Send request for template insertion along with export scope.
6360 ((eq key ?#) (cons 'template (memq 'subtree options)))
6361 ;; Switch to asynchronous export stack.
6362 ((eq key ?&) '(stack))
6363 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6364 ((memq key '(2 22 19 6 1))
6365 (org-export--dispatch-ui
6366 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6367 (6 'force) (1 'async))))
6368 (if (memq option options) (remq option options)
6369 (cons option options)))
6370 first-key expertp))
6371 ;; Action selected: Send key and options back to
6372 ;; `org-export-dispatch'.
6373 ((or first-key (functionp (nth 2 (assq key entries))))
6374 (cons (cond
6375 ((not first-key) (nth 2 (assq key entries)))
6376 ;; Publishing actions are hard-coded. Send a special
6377 ;; signal to `org-export-dispatch'.
6378 ((eq first-key ?P)
6379 (case key
6380 (?f 'publish-current-file)
6381 (?p 'publish-current-project)
6382 (?x 'publish-choose-project)
6383 (?a 'publish-all)))
6384 ;; Return first action associated to FIRST-KEY + KEY
6385 ;; path. Indeed, derived backends can share the same
6386 ;; FIRST-KEY.
6387 (t (catch 'found
6388 (mapc (lambda (entry)
6389 (let ((match (assq key (nth 2 entry))))
6390 (when match (throw 'found (nth 2 match)))))
6391 (member (assq first-key entries) entries)))))
6392 options))
6393 ;; Otherwise, enter sub-menu.
6394 (t (org-export--dispatch-ui options key expertp)))))
6398 (provide 'ox)
6400 ;; Local variables:
6401 ;; generated-autoload-file: "org-loaddefs.el"
6402 ;; End:
6404 ;;; ox.el ends here