| blob | d47c2e69a021027401ae3317d70f14bc19407566 |
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 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1356 ;; transcoding.
1357 ;; - category :: option
1358 ;; - type :: list (as returned by `org-element-parse-buffer')
1359 ;;
1360 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1361 ;; all line breaks.
1362 ;; - category :: option
1363 ;; - type :: symbol (nil, t)
1364 ;;
1365 ;; + `:section-numbers' :: Non-nil means transcoding should add
1366 ;; section numbers to headlines.
1367 ;; - category :: option
1368 ;; - type :: symbol (nil, t)
1369 ;;
1370 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1371 ;; in transcoding. When such a tag is present, subtrees without
1372 ;; it are de facto excluded from the process. See
1373 ;; `use-select-tags'.
1374 ;; - category :: option
1375 ;; - type :: list of strings
1376 ;;
1377 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1378 ;; a time stamp in the output.
1379 ;; - category :: option
1380 ;; - type :: symbol (nil, t)
1381 ;;
1382 ;; + `:translate-alist' :: Alist between element and object types and
1383 ;; transcoding functions relative to the current back-end.
1384 ;; Special keys `inner-template', `template' and `plain-text' are
1385 ;; also possible.
1386 ;; - category :: option
1387 ;; - type :: alist (SYMBOL . FUNCTION)
1388 ;;
1389 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1390 ;; also be transcoded. If it is set to the `headline' symbol,
1391 ;; only the archived headline's name is retained.
1392 ;; - category :: option
1393 ;; - type :: symbol (nil, t, `headline')
1394 ;;
1395 ;; + `:with-author' :: Non-nil means author's name should be included
1396 ;; in the output.
1397 ;; - category :: option
1398 ;; - type :: symbol (nil, t)
1399 ;;
1400 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1401 ;; - category :: option
1402 ;; - type :: symbol (nil, t)
1403 ;;
1404 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1405 ;; inserted at the end of the transcoded string. If the value
1406 ;; is `comment', it should be commented.
1407 ;; - category :: option
1408 ;; - type :: symbol (`comment', nil, t)
1409 ;;
1410 ;; + `:with-date' :: Non-nil means output should contain a date.
1411 ;; - category :: option
1412 ;; - type :. symbol (nil, t)
1413 ;;
1414 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1415 ;; its value is a list of names, only drawers with such names
1416 ;; will be transcoded. If that list starts with `not', drawer
1417 ;; with these names will be skipped.
1418 ;; - category :: option
1419 ;; - type :: symbol (nil, t) or list of strings
1420 ;;
1421 ;; + `:with-email' :: Non-nil means output should contain author's
1422 ;; email.
1423 ;; - category :: option
1424 ;; - type :: symbol (nil, t)
1425 ;;
1426 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1427 ;; interpreted.
1428 ;; - category :: option
1429 ;; - type :: symbol (nil, t)
1430 ;;
1431 ;; + `:with-fixed-width' :: Non-nil if transcoder should export
1432 ;; strings starting with a colon as a fixed-with (verbatim) area.
1433 ;; - category :: option
1434 ;; - type :: symbol (nil, t)
1435 ;;
1436 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1437 ;; footnotes.
1438 ;; - category :: option
1439 ;; - type :: symbol (nil, t)
1440 ;;
1441 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1442 ;; `latex-fragment' objects should appear in export output. When
1443 ;; this property is set to `verbatim', they will be left as-is.
1444 ;; - category :: option
1445 ;; - type :: symbol (`verbatim', nil, t)
1446 ;;
1447 ;; + `:with-planning' :: Non-nil means transcoding should include
1448 ;; planning info.
1449 ;; - category :: option
1450 ;; - type :: symbol (nil, t)
1451 ;;
1452 ;; + `:with-priority' :: Non-nil means transcoding should include
1453 ;; priority cookies.
1454 ;; - category :: option
1455 ;; - type :: symbol (nil, t)
1456 ;;
1457 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1458 ;; plain text.
1459 ;; - category :: option
1460 ;; - type :: symbol (nil, t)
1461 ;;
1462 ;; + `:with-special-strings' :: Non-nil means transcoding should
1463 ;; interpret special strings in plain text.
1464 ;; - category :: option
1465 ;; - type :: symbol (nil, t)
1466 ;;
1467 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1468 ;; interpret subscript and superscript. With a value of "{}",
1469 ;; only interpret those using curly brackets.
1470 ;; - category :: option
1471 ;; - type :: symbol (nil, {}, t)
1472 ;;
1473 ;; + `:with-tables' :: Non-nil means transcoding should export tables.
1474 ;; - category :: option
1475 ;; - type :: symbol (nil, t)
1476 ;;
1477 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1478 ;; headlines. A `not-in-toc' value will remove them from the
1479 ;; table of contents, if any, nonetheless.
1480 ;; - category :: option
1481 ;; - type :: symbol (nil, t, `not-in-toc')
1482 ;;
1483 ;; + `:with-tasks' :: Non-nil means transcoding should include
1484 ;; headlines with a TODO keyword. A `todo' value will only
1485 ;; include headlines with a todo type keyword while a `done'
1486 ;; value will do the contrary. If a list of strings is provided,
1487 ;; only tasks with keywords belonging to that list will be kept.
1488 ;; - category :: option
1489 ;; - type :: symbol (t, todo, done, nil) or list of strings
1490 ;;
1491 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1492 ;; time stamps. Special value `active' (resp. `inactive') ask to
1493 ;; export only active (resp. inactive) timestamps. Otherwise,
1494 ;; completely remove them.
1495 ;; - category :: option
1496 ;; - type :: symbol: (`active', `inactive', t, nil)
1497 ;;
1498 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1499 ;; added to the output. An integer value limits its depth.
1500 ;; - category :: option
1501 ;; - type :: symbol (nil, t or integer)
1502 ;;
1503 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1504 ;; include TODO keywords.
1505 ;; - category :: option
1506 ;; - type :: symbol (nil, t)
1509 ;;;; Environment Options
1510 ;;
1511 ;; Environment options encompass all parameters defined outside the
1512 ;; scope of the parsed data. They come from five sources, in
1513 ;; increasing precedence order:
1514 ;;
1515 ;; - Global variables,
1516 ;; - Buffer's attributes,
1517 ;; - Options keyword symbols,
1518 ;; - Buffer keywords,
1519 ;; - Subtree properties.
1520 ;;
1521 ;; The central internal function with regards to environment options
1522 ;; is `org-export-get-environment'. It updates global variables with
1523 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1524 ;; the different sources.
1525 ;;
1526 ;; The internal functions doing the retrieval are:
1527 ;; `org-export--get-global-options',
1528 ;; `org-export--get-buffer-attributes',
1529 ;; `org-export--parse-option-keyword',
1530 ;; `org-export--get-subtree-options' and
1531 ;; `org-export--get-inbuffer-options'
1532 ;;
1533 ;; Also, `org-export--list-bound-variables' collects bound variables
1534 ;; along with their value in order to set them as buffer local
1535 ;; variables later in the process.
1538 "Collect export options from the current buffer.
1540 Optional argument BACKEND is an export back-end, as returned by
1541 `org-export-create-backend'.
1543 When optional argument SUBTREEP is non-nil, assume the export is
1544 done against the current sub-tree.
1546 Third optional argument EXT-PLIST is a property list with
1547 external parameters overriding Org default settings, but still
1548 inferior to file-local settings."
1549 ;; First install #+BIND variables since these must be set before
1550 ;; global options are read.
1553 ;; Get and prioritize export options...
1555 ;; ... from global variables...
1557 ;; ... from an external property list...
1558 ext-plist
1559 ;; ... from in-buffer settings...
1561 ;; ... and from subtree, when appropriate.
1563 ;; Eventually add misc. properties.
1565 :back-end
1566 backend
1568 :footnote-definition-alist
1569 ;; Footnotes definitions must be collected in the original
1570 ;; buffer, as there's no insurance that they will still be in
1571 ;; the parse tree, due to possible narrowing.
1587 alist))
1599 alist)))))))
1600 alist))
1601 :id-alist
1602 ;; Collect id references.
1613 alist))))
1616 "Parse an OPTIONS line and return values as a plist.
1617 Optional argument BACKEND is an export back-end, as returned by,
1618 e.g., `org-export-create-backend'. It specifies which back-end
1619 specific items to read, if any."
1621 ;; Priority is given to back-end specific options.
1623 org-export-options-alist))
1624 plist)
1633 options))
1635 property
1638 plist))
1641 "Get export options in subtree at point.
1642 Optional argument BACKEND is an export back-end, as returned by,
1643 e.g., `org-export-create-backend'. It specifies back-end used
1644 for export. Return options as a plist."
1645 ;; For each buffer keyword, create a headline property setting the
1646 ;; same property in communication channel. The name for the property
1647 ;; is the keyword with "EXPORT_" appended to it.
1650 ;; Make sure point is at a heading.
1652 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1653 ;; title (with no todo keyword, priority cookie or tag) as its
1654 ;; fallback value.
1660 plist :title
1663 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1667 ;; Handle other keywords. TITLE keyword is excluded as it has
1668 ;; been handled already.
1676 ;; Export properties are not case-sensitive.
1683 plist
1684 property
1686 ;; Parse VALUE if required.
1690 ;; If BEHAVIOR is `split' expected value is
1691 ;; a list of strings, not a string.
1694 ;; Look for both general keywords and back-end specific
1695 ;; options, with priority given to the latter.
1697 org-export-options-alist)))
1698 ;; Return value.
1699 plist)))
1702 "Return current buffer export options, as a plist.
1704 Optional argument BACKEND, when non-nil, is an export back-end,
1705 as returned by, e.g., `org-export-create-backend'. It specifies
1706 which back-end specific options should also be read in the
1707 process.
1709 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1711 get-options ; For byte-compiler.
1714 ;; Priority is given to back-end specific options.
1716 org-export-options-alist))
1719 org-export-special-keywords))))
1722 ;; Return all properties associated to KEYWORD.
1729 ;; Recursively read keywords in buffer. FILES is a list
1730 ;; of files read so far. PLIST is the current property
1731 ;; list obtained.
1740 ;; Options in `org-export-special-keywords'.
1744 ;; Avoid circular dependencies.
1754 plist
1759 plist
1765 ;; Options in `org-export-options-alist'.
1770 plist property
1771 ;; Handle value depending on specified
1772 ;; BEHAVIOR.
1778 " "
1791 ;; Return final value.
1792 plist))))
1793 ;; Read options in the current buffer.
1796 ;; Parse keywords specified in `org-element-document-properties'
1797 ;; and return PLIST.
1808 "Return properties related to buffer attributes, as a plist."
1809 ;; Store full path of input file name, or nil. For internal use.
1813 "Return global export options as a plist.
1814 Optional argument BACKEND, if non-nil, is an export back-end, as
1815 returned by, e.g., `org-export-create-backend'. It specifies
1816 which back-end specific export options should also be read in the
1817 process."
1819 ;; Priority is given to back-end specific options.
1821 org-export-options-alist)))
1827 plist
1828 prop
1829 ;; Evaluate default value provided. If keyword is
1830 ;; a member of `org-element-document-properties',
1831 ;; parse it as a secondary string before storing it.
1835 org-element-document-properties))
1838 value)))))))))
1841 "Return variables bound from BIND keywords in current buffer.
1842 Also look for BIND keywords in setup files. The return value is
1843 an alist where associations are (VARIABLE-NAME VALUE)."
1848 ;; Return an alist between variable names and their
1849 ;; value. FILES is a list of setup files names read so
1850 ;; far, used to avoid circular dependencies. ALIST is
1851 ;; the alist collected so far.
1862 ;; Enter setup file.
1872 alist))))))))))
1873 alist)))))
1874 ;; Return value in appropriate order of appearance.
1877 ;; defsubst org-export-get-parent must be defined before first use,
1878 ;; was originally defined in the topology section
1881 "Return BLOB parent or nil.
1882 BLOB is the element or object considered."
1885 ;;;; Tree Properties
1886 ;;
1887 ;; Tree properties are information extracted from parse tree. They
1888 ;; are initialized at the beginning of the transcoding process by
1889 ;; `org-export-collect-tree-properties'.
1890 ;;
1891 ;; Dedicated functions focus on computing the value of specific tree
1892 ;; properties during initialization. Thus,
1893 ;; `org-export--populate-ignore-list' lists elements and objects that
1894 ;; should be skipped during export, `org-export--get-min-level' gets
1895 ;; the minimal exportable level, used as a basis to compute relative
1896 ;; level for headlines. Eventually
1897 ;; `org-export--collect-headline-numbering' builds an alist between
1898 ;; headlines and their numbering.
1901 "Extract tree properties from parse tree.
1903 DATA is the parse tree from which information is retrieved. INFO
1904 is a list holding export options.
1906 Following tree properties are set or updated:
1908 `:exported-data' Hash table used to memoize results from
1909 `org-export-data'.
1911 `:footnote-definition-alist' List of footnotes definitions in
1912 original buffer and current parse tree.
1914 `:headline-offset' Offset between true level of headlines and
1915 local level. An offset of -1 means a headline
1916 of level 2 should be considered as a level
1917 1 headline in the context.
1919 `:headline-numbering' Alist of all headlines as key an the
1920 associated numbering as value.
1922 `:ignore-list' List of elements that should be ignored during
1923 export.
1925 Return updated plist."
1926 ;; Install the parse tree in the communication channel, in order to
1927 ;; use `org-export-get-genealogy' and al.
1929 ;; Get the list of elements and objects to ignore, and put it into
1930 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1931 ;; been done during parse tree filtering.
1934 :ignore-list
1937 ;; Compute `:headline-offset' in order to be able to use
1938 ;; `org-export-get-relative-level'.
1941 :headline-offset
1943 ;; Footnote definitions in parse tree override those stored in
1944 ;; `:footnote-definition-alist'. This way, any change to
1945 ;; a definition in the parse tree (e.g., through a parse tree
1946 ;; filter) propagates into the alist.
1953 defs))
1957 defs)))))
1959 ;; Properties order doesn't matter: get the rest of the tree
1960 ;; properties.
1964 info))
1967 "Return minimum exportable headline's level in DATA.
1968 DATA is parsed tree as returned by `org-element-parse-buffer'.
1969 OPTIONS is a plist holding export options."
1980 ;; If no headline was found, for the sake of consistency, set
1981 ;; minimum level to 1 nonetheless.
1985 "Return numbering of all exportable headlines in a parse tree.
1987 DATA is the parse tree. OPTIONS is the plist holding export
1988 options.
1990 Return an alist whose key is a headline and value is its
1991 associated numbering \(in the shape of a list of numbers\) or nil
1992 for a footnotes section."
2000 headline
2002 for idx from 0 to org-export-max-depth
2006 options)))
2009 "Return list of elements and objects to ignore during export.
2010 DATA is the parse tree to traverse. OPTIONS is the plist holding
2011 export options."
2013 ;; First find trees containing a select tag, if any.
2015 ;; If a select tag is active, also ignore the section before
2016 ;; the first headline, if any.
2020 first-element))))
2023 ;; Collect ignored elements or objects into IGNORE-LIST.
2029 ;; If headline is archived but tree below has
2030 ;; to be skipped, add it to ignore list.
2033 ;; Move into secondary string, if any.
2038 ;; Move into recursive objects/elements.
2040 ;; Main call.
2042 ;; Return value.
2043 ignore))
2046 "Return list of headlines and inlinetasks with a select tag in their tree.
2047 DATA is parsed data as returned by `org-element-parse-buffer'.
2048 INFO is a plist holding export options."
2050 walk-data ; For byte-compiler.
2060 ;; When a select tag is found, mark full
2061 ;; genealogy and every headline within the tree
2062 ;; as acceptable.
2065 genealogy
2068 selected-trees))
2069 ;; If at a headline, continue searching in tree,
2070 ;; recursively.
2080 selected-trees))
2083 "Non-nil when element or object BLOB should be skipped during export.
2084 OPTIONS is the plist holding export options. SELECTED, when
2085 non-nil, is a list of headlines or inlinetasks belonging to
2086 a tree with a select tag."
2093 ;; If `:with-drawers' value starts with `not', ignore
2094 ;; every drawer whose name belong to that list.
2095 ;; Otherwise, ignore drawers whose name isn't in that
2096 ;; list.
2113 ;; Ignore subtrees with an exclude tag.
2116 ;; When a select tag is present in the buffer, ignore any tree
2117 ;; without it.
2119 ;; Ignore commented sub-trees.
2121 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2123 ;; Ignore tasks, if specified by `:with-tasks' property.
2135 properties-set))))))
2146 ;; `:with-timestamps' only applies to isolated timestamps
2147 ;; objects, i.e. timestamp objects in a paragraph containing only
2148 ;; timestamps and whitespaces.
2156 options t))))
2165 \f
2166 ;;; The Transcoder
2167 ;;
2168 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2169 ;; `org-element-parse-buffer') and transcodes it into a specified
2170 ;; back-end output. It takes care of filtering out elements or
2171 ;; objects according to export options and organizing the output blank
2172 ;; lines and white space are preserved. The function memoizes its
2173 ;; results, so it is cheap to call it within transcoders.
2174 ;;
2175 ;; It is possible to modify locally the back-end used by
2176 ;; `org-export-data' or even use a temporary back-end by using
2177 ;; `org-export-data-with-backend'.
2178 ;;
2179 ;; Internally, three functions handle the filtering of objects and
2180 ;; elements during the export. In particular,
2181 ;; `org-export-ignore-element' marks an element or object so future
2182 ;; parse tree traversals skip it and `org-export-expand' transforms
2183 ;; the others back into their original shape.
2184 ;;
2185 ;; `org-export-transcoder' is an accessor returning appropriate
2186 ;; translator function for a given element or object.
2189 "Return appropriate transcoder for BLOB.
2190 INFO is a plist containing export directives."
2192 ;; Return contents only for complete parse trees.
2198 "Convert DATA into current back-end format.
2200 DATA is a parse tree, an element or an object or a secondary
2201 string. INFO is a plist holding export options.
2203 Return a string."
2208 ;; Ignored element/object.
2210 ;; Plain text.
2216 info))
2217 ;; Secondary string.
2220 ;; Element/Object without contents or, as a special
2221 ;; case, headline with archive tag and archived trees
2222 ;; restricted to title only.
2230 ;; Export snippets never return a nil value so
2231 ;; that white spaces following them are never
2232 ;; ignored.
2234 ;; Element/Object with contents.
2247 ;; Elements directly containing
2248 ;; objects must have their indentation
2249 ;; normalized first.
2251 data
2252 ;; When normalizing contents of the
2253 ;; first paragraph in an item or
2254 ;; a footnote definition, ignore
2255 ;; first line's indentation: there is
2256 ;; none and it might be misleading.
2261 data)
2268 info))))))))
2269 ;; Final result will be memoized before being returned.
2271 data
2275 ;; Append the same white space between elements or objects
2276 ;; as in the original buffer, and call appropriate filters.
2287 info)))
2288 results)))
2292 "Convert DATA into BACKEND format.
2294 DATA is an element, an object, a secondary string or a string.
2295 BACKEND is a symbol. INFO is a plist used as a communication
2296 channel.
2298 Unlike to `org-export-with-backend', this function will
2299 recursively convert DATA using BACKEND translation table."
2302 data
2303 ;; Set-up a new communication channel with translations defined in
2304 ;; BACKEND as the translate table and a new hash table for
2305 ;; memoization.
2307 info
2310 ;; Size of the hash table is reduced since this function
2311 ;; will probably be used on small trees.
2315 "Change uninterpreted elements back into Org syntax.
2316 DATA is the parse tree. INFO is a plist containing export
2317 options. Each uninterpreted element or object is changed back
2318 into a string. Contents, if any, are not modified. The parse
2319 tree is modified by side effect and returned by the function."
2323 prop
2326 info))))
2329 "Change uninterpreted elements back into Org syntax.
2330 DATA is a parse tree or a secondary string. INFO is a plist
2331 containing export options. It is modified by side effect and
2332 returned by the function."
2335 subscript superscript underline)
2339 ;; ... entities...
2346 ?\s)))))
2347 ;; ... emphasis...
2359 marker
2363 ?\s)))))))
2364 ;; ... LaTeX environments and fragments...
2368 ;; ... sub/superscripts...
2377 "_"
2386 ?\s)))))))))))
2388 ;; Splice NEW at BLOB location in parse tree.
2391 info)
2392 ;; Return modified parse tree.
2393 data)
2396 "Expand a parsed element or object to its original state.
2398 BLOB is either an element or an object. CONTENTS is its
2399 contents, as a string or nil.
2401 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2402 keywords before output."
2407 blob contents))))
2410 "Add ELEMENT to `:ignore-list' in INFO.
2412 Any element in `:ignore-list' will be skipped when using
2413 `org-element-map'. INFO is modified by side effects."
2417 \f
2418 ;;; The Filter System
2419 ;;
2420 ;; Filters allow end-users to tweak easily the transcoded output.
2421 ;; They are the functional counterpart of hooks, as every filter in
2422 ;; a set is applied to the return value of the previous one.
2423 ;;
2424 ;; Every set is back-end agnostic. Although, a filter is always
2425 ;; called, in addition to the string it applies to, with the back-end
2426 ;; used as argument, so it's easy for the end-user to add back-end
2427 ;; specific filters in the set. The communication channel, as
2428 ;; a plist, is required as the third argument.
2429 ;;
2430 ;; From the developer side, filters sets can be installed in the
2431 ;; process with the help of `org-export-define-backend', which
2432 ;; internally stores filters as an alist. Each association has a key
2433 ;; among the following symbols and a function or a list of functions
2434 ;; as value.
2435 ;;
2436 ;; - `:filter-options' applies to the property list containing export
2437 ;; options. Unlike to other filters, functions in this list accept
2438 ;; two arguments instead of three: the property list containing
2439 ;; export options and the back-end. Users can set its value through
2440 ;; `org-export-filter-options-functions' variable.
2441 ;;
2442 ;; - `:filter-parse-tree' applies directly to the complete parsed
2443 ;; tree. Users can set it through
2444 ;; `org-export-filter-parse-tree-functions' variable.
2445 ;;
2446 ;; - `:filter-final-output' applies to the final transcoded string.
2447 ;; Users can set it with `org-export-filter-final-output-functions'
2448 ;; variable
2449 ;;
2450 ;; - `:filter-plain-text' applies to any string not recognized as Org
2451 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2452 ;; configure it.
2453 ;;
2454 ;; - `:filter-TYPE' applies on the string returned after an element or
2455 ;; object of type TYPE has been transcoded. A user can modify
2456 ;; `org-export-filter-TYPE-functions'
2457 ;;
2458 ;; All filters sets are applied with
2459 ;; `org-export-filter-apply-functions' function. Filters in a set are
2460 ;; applied in a LIFO fashion. It allows developers to be sure that
2461 ;; their filters will be applied first.
2462 ;;
2463 ;; Filters properties are installed in communication channel with
2464 ;; `org-export-install-filters' function.
2465 ;;
2466 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2467 ;; `org-export-before-parsing-hook') are run at the beginning of the
2468 ;; export process and just before parsing to allow for heavy structure
2469 ;; modifications.
2472 ;;;; Hooks
2475 "Hook run at the beginning of the export process.
2477 This is run before include keywords and macros are expanded and
2478 Babel code blocks executed, on a copy of the original buffer
2479 being exported. Visibility and narrowing are preserved. Point
2480 is at the beginning of the buffer.
2482 Every function in this hook will be called with one argument: the
2486 "Hook run before parsing an export buffer.
2488 This is run after include keywords and macros have been expanded
2489 and Babel code blocks executed, on a copy of the original buffer
2490 being exported. Visibility and narrowing are preserved. Point
2491 is at the beginning of the buffer.
2493 Every function in this hook will be called with one argument: the
2497 ;;;; Special Filters
2500 "List of functions applied to the export options.
2501 Each filter is called with two arguments: the export options, as
2502 a plist, and the back-end, as a symbol. It must return
2506 "List of functions applied to the parsed tree.
2507 Each filter is called with three arguments: the parse tree, as
2508 returned by `org-element-parse-buffer', the back-end, as
2509 a symbol, and the communication channel, as a plist. It must
2513 "List of functions applied to plain text.
2514 Each filter is called with three arguments: a string which
2515 contains no Org syntax, the back-end, as a symbol, and the
2516 communication channel, as a plist. It must return a string or
2520 "List of functions applied to the transcoded string.
2521 Each filter is called with three arguments: the full transcoded
2522 string, the back-end, as a symbol, and the communication channel,
2523 as a plist. It must return a string that will be used as the
2527 ;;;; Elements Filters
2530 "List of functions applied to a transcoded babel-call.
2531 Each filter is called with three arguments: the transcoded data,
2532 as a string, the back-end, as a symbol, and the communication
2536 "List of functions applied to a transcoded center block.
2537 Each filter is called with three arguments: the transcoded data,
2538 as a string, the back-end, as a symbol, and the communication
2542 "List of functions applied to a transcoded clock.
2543 Each filter is called with three arguments: the transcoded data,
2544 as a string, the back-end, as a symbol, and the communication
2548 "List of functions applied to a transcoded comment.
2549 Each filter is called with three arguments: the transcoded data,
2550 as a string, the back-end, as a symbol, and the communication
2554 "List of functions applied to a transcoded comment-block.
2555 Each filter is called with three arguments: the transcoded data,
2556 as a string, the back-end, as a symbol, and the communication
2560 "List of functions applied to a transcoded diary-sexp.
2561 Each filter is called with three arguments: the transcoded data,
2562 as a string, the back-end, as a symbol, and the communication
2566 "List of functions applied to a transcoded drawer.
2567 Each filter is called with three arguments: the transcoded data,
2568 as a string, the back-end, as a symbol, and the communication
2572 "List of functions applied to a transcoded dynamic-block.
2573 Each filter is called with three arguments: the transcoded data,
2574 as a string, the back-end, as a symbol, and the communication
2578 "List of functions applied to a transcoded example-block.
2579 Each filter is called with three arguments: the transcoded data,
2580 as a string, the back-end, as a symbol, and the communication
2584 "List of functions applied to a transcoded fixed-width.
2585 Each filter is called with three arguments: the transcoded data,
2586 as a string, the back-end, as a symbol, and the communication
2590 "List of functions applied to a transcoded footnote-definition.
2591 Each filter is called with three arguments: the transcoded data,
2592 as a string, the back-end, as a symbol, and the communication
2596 "List of functions applied to a transcoded headline.
2597 Each filter is called with three arguments: the transcoded data,
2598 as a string, the back-end, as a symbol, and the communication
2602 "List of functions applied to a transcoded horizontal-rule.
2603 Each filter is called with three arguments: the transcoded data,
2604 as a string, the back-end, as a symbol, and the communication
2608 "List of functions applied to a transcoded inlinetask.
2609 Each filter is called with three arguments: the transcoded data,
2610 as a string, the back-end, as a symbol, and the communication
2614 "List of functions applied to a transcoded item.
2615 Each filter is called with three arguments: the transcoded data,
2616 as a string, the back-end, as a symbol, and the communication
2620 "List of functions applied to a transcoded keyword.
2621 Each filter is called with three arguments: the transcoded data,
2622 as a string, the back-end, as a symbol, and the communication
2626 "List of functions applied to a transcoded latex-environment.
2627 Each filter is called with three arguments: the transcoded data,
2628 as a string, the back-end, as a symbol, and the communication
2632 "List of functions applied to a transcoded node-property.
2633 Each filter is called with three arguments: the transcoded data,
2634 as a string, the back-end, as a symbol, and the communication
2638 "List of functions applied to a transcoded paragraph.
2639 Each filter is called with three arguments: the transcoded data,
2640 as a string, the back-end, as a symbol, and the communication
2644 "List of functions applied to a transcoded plain-list.
2645 Each filter is called with three arguments: the transcoded data,
2646 as a string, the back-end, as a symbol, and the communication
2650 "List of functions applied to a transcoded planning.
2651 Each filter is called with three arguments: the transcoded data,
2652 as a string, the back-end, as a symbol, and the communication
2656 "List of functions applied to a transcoded property-drawer.
2657 Each filter is called with three arguments: the transcoded data,
2658 as a string, the back-end, as a symbol, and the communication
2662 "List of functions applied to a transcoded quote block.
2663 Each filter is called with three arguments: the transcoded quote
2664 data, as a string, the back-end, as a symbol, and the
2665 communication channel, as a plist. It must return a string or
2669 "List of functions applied to a transcoded section.
2670 Each filter is called with three arguments: the transcoded data,
2671 as a string, the back-end, as a symbol, and the communication
2675 "List of functions applied to a transcoded special block.
2676 Each filter is called with three arguments: the transcoded data,
2677 as a string, the back-end, as a symbol, and the communication
2681 "List of functions applied to a transcoded src-block.
2682 Each filter is called with three arguments: the transcoded data,
2683 as a string, the back-end, as a symbol, and the communication
2687 "List of functions applied to a transcoded table.
2688 Each filter is called with three arguments: the transcoded data,
2689 as a string, the back-end, as a symbol, and the communication
2693 "List of functions applied to a transcoded table-cell.
2694 Each filter is called with three arguments: the transcoded data,
2695 as a string, the back-end, as a symbol, and the communication
2699 "List of functions applied to a transcoded table-row.
2700 Each filter is called with three arguments: the transcoded data,
2701 as a string, the back-end, as a symbol, and the communication
2705 "List of functions applied to a transcoded verse block.
2706 Each filter is called with three arguments: the transcoded data,
2707 as a string, the back-end, as a symbol, and the communication
2711 ;;;; Objects Filters
2714 "List of functions applied to transcoded bold text.
2715 Each filter is called with three arguments: the transcoded data,
2716 as a string, the back-end, as a symbol, and the communication
2720 "List of functions applied to transcoded code text.
2721 Each filter is called with three arguments: the transcoded data,
2722 as a string, the back-end, as a symbol, and the communication
2726 "List of functions applied to a transcoded entity.
2727 Each filter is called with three arguments: the transcoded data,
2728 as a string, the back-end, as a symbol, and the communication
2732 "List of functions applied to a transcoded export-snippet.
2733 Each filter is called with three arguments: the transcoded data,
2734 as a string, the back-end, as a symbol, and the communication
2738 "List of functions applied to a transcoded footnote-reference.
2739 Each filter is called with three arguments: the transcoded data,
2740 as a string, the back-end, as a symbol, and the communication
2744 "List of functions applied to a transcoded inline-babel-call.
2745 Each filter is called with three arguments: the transcoded data,
2746 as a string, the back-end, as a symbol, and the communication
2750 "List of functions applied to a transcoded inline-src-block.
2751 Each filter is called with three arguments: the transcoded data,
2752 as a string, the back-end, as a symbol, and the communication
2756 "List of functions applied to transcoded italic text.
2757 Each filter is called with three arguments: the transcoded data,
2758 as a string, the back-end, as a symbol, and the communication
2762 "List of functions applied to a transcoded latex-fragment.
2763 Each filter is called with three arguments: the transcoded data,
2764 as a string, the back-end, as a symbol, and the communication
2768 "List of functions applied to a transcoded line-break.
2769 Each filter is called with three arguments: the transcoded data,
2770 as a string, the back-end, as a symbol, and the communication
2774 "List of functions applied to a transcoded link.
2775 Each filter is called with three arguments: the transcoded data,
2776 as a string, the back-end, as a symbol, and the communication
2780 "List of functions applied to a transcoded radio-target.
2781 Each filter is called with three arguments: the transcoded data,
2782 as a string, the back-end, as a symbol, and the communication
2786 "List of functions applied to a transcoded statistics-cookie.
2787 Each filter is called with three arguments: the transcoded data,
2788 as a string, the back-end, as a symbol, and the communication
2792 "List of functions applied to transcoded strike-through text.
2793 Each filter is called with three arguments: the transcoded data,
2794 as a string, the back-end, as a symbol, and the communication
2798 "List of functions applied to a transcoded subscript.
2799 Each filter is called with three arguments: the transcoded data,
2800 as a string, the back-end, as a symbol, and the communication
2804 "List of functions applied to a transcoded superscript.
2805 Each filter is called with three arguments: the transcoded data,
2806 as a string, the back-end, as a symbol, and the communication
2810 "List of functions applied to a transcoded target.
2811 Each filter is called with three arguments: the transcoded data,
2812 as a string, the back-end, as a symbol, and the communication
2816 "List of functions applied to a transcoded timestamp.
2817 Each filter is called with three arguments: the transcoded data,
2818 as a string, the back-end, as a symbol, and the communication
2822 "List of functions applied to transcoded underline text.
2823 Each filter is called with three arguments: the transcoded data,
2824 as a string, the back-end, as a symbol, and the communication
2828 "List of functions applied to transcoded verbatim text.
2829 Each filter is called with three arguments: the transcoded data,
2830 as a string, the back-end, as a symbol, and the communication
2834 ;;;; Filters Tools
2835 ;;
2836 ;; Internal function `org-export-install-filters' installs filters
2837 ;; hard-coded in back-ends (developer filters) and filters from global
2838 ;; variables (user filters) in the communication channel.
2839 ;;
2840 ;; Internal function `org-export-filter-apply-functions' takes care
2841 ;; about applying each filter in order to a given data. It ignores
2842 ;; filters returning a nil value but stops whenever a filter returns
2843 ;; an empty string.
2846 "Call every function in FILTERS.
2848 Functions are called with arguments VALUE, current export
2849 back-end's name and INFO. A function returning a nil value will
2850 be skipped. If it returns the empty string, the process ends and
2851 VALUE is ignored.
2853 Call is done in a LIFO fashion, to be sure that developer
2854 specified filters, if any, are called first."
2865 "Install filters properties in communication channel.
2866 INFO is a plist containing the current communication channel.
2867 Return the updated communication channel."
2869 ;; Install user-defined filters with `org-export-filters-alist'
2870 ;; and filters already in INFO (through ext-plist mechanism).
2877 ;; Filters in INFO will be called
2878 ;; before those user provided.
2881 default-value)))))
2882 org-export-filters-alist)
2883 ;; Prepend back-end specific filters to that list.
2885 ;; Single values get consed, lists are appended.
2890 plist key
2894 ;; Return new communication channel.
2898 \f
2899 ;;; Core functions
2900 ;;
2901 ;; This is the room for the main function, `org-export-as', along with
2902 ;; its derivative, `org-export-string-as'.
2903 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2904 ;; function should be added to kill ring.
2905 ;;
2906 ;; Note that `org-export-as' doesn't really parse the current buffer,
2907 ;; but a copy of it (with the same buffer-local variables and
2908 ;; visibility), where macros and include keywords are expanded and
2909 ;; Babel blocks are executed, if appropriate.
2910 ;; `org-export-with-buffer-copy' macro prepares that copy.
2911 ;;
2912 ;; File inclusion is taken care of by
2913 ;; `org-export-expand-include-keyword' and
2914 ;; `org-export--prepare-file-contents'. Structure wise, including
2915 ;; a whole Org file in a buffer often makes little sense. For
2916 ;; example, if the file contains a headline and the include keyword
2917 ;; was within an item, the item should contain the headline. That's
2918 ;; why file inclusion should be done before any structure can be
2919 ;; associated to the file, that is before parsing.
2920 ;;
2921 ;; `org-export-insert-default-template' is a command to insert
2922 ;; a default template (or a back-end specific template) at point or in
2923 ;; current subtree.
2926 "Return a copy of the current buffer.
2927 The copy preserves Org buffer-local variables, visibility and
2928 narrowing."
2934 new-buf))
2937 "Apply BODY in a copy of the current buffer.
2938 The copy preserves local variables, visibility and contents of
2939 the original buffer. Point is at the beginning of the buffer
2940 when BODY is applied."
2949 ;; Kill copy without confirmation.
2955 "Generate a function duplicating BUFFER.
2957 The copy will preserve local variables, visibility, contents and
2958 narrowing of the original buffer. If a region was active in
2959 BUFFER, contents will be narrowed to that region instead.
2961 The resulting function can be evaluated at a later time, from
2962 another buffer, effectively cloning the original buffer there.
2964 The function assumes BUFFER's major mode is `org-mode'."
2968 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2969 ;; already in BUFFER.
2971 ;; Copy specific buffer local variables and variables set
2972 ;; through BIND keywords.
2974 vars)
2982 buffer-file-name
2983 buffer-file-coding-system))
2987 ;; Skip unreadable values, as they cannot be
2988 ;; sent to external process.
2992 vars))))))
2993 ;; Whole buffer contents.
2998 ;; Narrowing.
3002 ;; Current position of point.
3004 ;; Overlays with invisible property.
3014 ov-set))))
3016 ov-set)))))
3018 ;;;###autoload
3021 "Transcode current Org buffer into BACKEND code.
3023 BACKEND is either an export back-end, as returned by, e.g.,
3024 `org-export-create-backend', or a symbol referring to
3025 a registered back-end.
3027 If narrowing is active in the current buffer, only transcode its
3028 narrowed part.
3030 If a region is active, transcode that region.
3032 When optional argument SUBTREEP is non-nil, transcode the
3033 sub-tree at point, extracting information from the headline
3034 properties first.
3036 When optional argument VISIBLE-ONLY is non-nil, don't export
3037 contents of hidden elements.
3039 When optional argument BODY-ONLY is non-nil, only return body
3040 code, without surrounding template.
3042 Optional argument EXT-PLIST, when provided, is a property list
3043 with external parameters overriding Org default settings, but
3044 still inferior to file-local settings.
3046 Return code as a string."
3051 ;; Narrow buffer to an appropriate region or subtree for
3052 ;; parsing. If parsing subtree, be sure to remove main headline
3053 ;; too.
3061 ;; Initialize communication channel with original buffer
3062 ;; attributes, unavailable in its copy.
3071 tree)
3072 ;; Update communication channel and get parse tree. Buffer
3073 ;; isn't parsed directly. Instead, a temporary copy is
3074 ;; created, where include keywords, macros are expanded and
3075 ;; code blocks are evaluated.
3077 ;; Run first hook with current back-end's name as argument.
3081 ;; Update macro templates since #+INCLUDE keywords might have
3082 ;; added some new ones.
3086 ;; Update radio targets since keyword inclusion might have
3087 ;; added some more.
3089 ;; Run last hook with current back-end's name as argument.
3094 ;; Update communication channel with environment. Also
3095 ;; install user's and developer's filters.
3100 ;; Expand export-specific set of macros: {{{author}}},
3101 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3102 ;; once regular macros have been expanded, since document
3103 ;; keywords may contain one of them.
3109 ;; EMAIL is not a parsed keyword: store it as-is.
3113 ;; Parse buffer.
3115 ;; Handle left-over uninterpreted elements or objects in
3116 ;; parse tree and communication channel.
3118 ;; Call options filters and update export options. We do not
3119 ;; use `org-export-filter-apply-functions' here since the
3120 ;; arity of such filters is different.
3125 ;; Parse buffer, handle uninterpreted elements or objects,
3126 ;; then call parse-tree filters.
3130 ;; Now tree is complete, compute its properties and add them
3131 ;; to communication channel.
3135 ;; Eventually transcode TREE. Wrap the resulting string into
3136 ;; a template.
3145 ;; Remove all text properties since they cannot be
3146 ;; retrieved from an external process. Finally call
3147 ;; final-output filter and return result.
3153 info))))))))
3155 ;;;###autoload
3157 "Transcode STRING into BACKEND code.
3159 BACKEND is either an export back-end, as returned by, e.g.,
3160 `org-export-create-backend', or a symbol referring to
3161 a registered back-end.
3163 When optional argument BODY-ONLY is non-nil, only return body
3164 code, without preamble nor postamble.
3166 Optional argument EXT-PLIST, when provided, is a property list
3167 with external parameters overriding Org default settings, but
3168 still inferior to file-local settings.
3170 Return code as a string."
3176 ;;;###autoload
3178 "Replace the active region by its export to BACKEND.
3179 BACKEND is either an export back-end, as returned by, e.g.,
3180 `org-export-create-backend', or a symbol referring to
3181 a registered back-end."
3191 ;;;###autoload
3193 "Insert all export keywords with default values at beginning of line.
3195 BACKEND is a symbol referring to the name of a registered export
3196 back-end, for which specific export options should be added to
3197 the template, or `default' for default template. When it is nil,
3198 the user will be prompted for a category.
3200 If SUBTREEP is non-nil, export configuration will be set up
3201 locally for the subtree through node properties."
3211 "Options category: "
3215 org-export--registered-backends))
3216 nil t))))
3217 options keywords)
3218 ;; Populate OPTIONS and KEYWORDS.
3235 ;; Move to an appropriate location in order to insert options.
3237 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3255 ;; Then the rest of keywords, in the order specified in either
3256 ;; `org-export-options-alist' or respective export back-ends.
3277 "Expand every include keyword in buffer.
3278 Optional argument INCLUDED is a list of included file names along
3279 with their line restriction, when appropriate. It is used to
3280 avoid infinite recursion. Optional argument DIR is the current
3281 working directory. It is used to properly resolve relative
3282 paths."
3291 ;; Extract arguments from keyword's value.
3299 dir)
3304 value)
3311 ;; Minimal level of included file defaults to the child
3312 ;; level of the current headline, if any, or one. It
3313 ;; only applies is the file is meant to be included as
3314 ;; an Org one.
3326 ;; Remove keyword.
3332 ;; Check if files has already been parsed. Look after
3333 ;; inclusion lines too, as different parts of the same file
3334 ;; can be included too.
3349 ind-str block arg-str contents ind-str block))))
3356 ind-str block contents ind-str block))))
3363 file lines ind minlevel
3372 "Prepare the contents of FILE for inclusion and return them as a string.
3374 When optional argument LINES is a string specifying a range of
3375 lines, include only those lines.
3377 Optional argument IND, when non-nil, is an integer specifying the
3378 global indentation of returned contents. Since its purpose is to
3379 allow an included file to stay in the same environment it was
3380 created \(i.e. a list item), it doesn't apply past the first
3381 headline encountered.
3383 Optional argument MINLEVEL, when non-nil, is an integer
3384 specifying the level that any top-level headline in the included
3385 file should have.
3387 Optional argument ID is an integer that will be inserted before
3388 each footnote definition and reference if FILE is an Org file.
3389 This is useful to avoid conflicts when more than one Org file
3390 with footnotes is included in a document."
3406 ;; Remove blank lines at beginning and end of contents. The logic
3407 ;; behind that removal is that blank lines around include keyword
3408 ;; override blank lines in included file.
3417 ;; If IND is set, preserve indentation of include keyword until
3418 ;; the first headline encountered.
3425 ;; Do not move footnote definitions out of column 0.
3431 ;; When MINLEVEL is specified, compute minimal level for headlines
3432 ;; in the file (CUR-MIN), and remove stars to each headline so
3433 ;; that headlines with minimal level have a level of MINLEVEL.
3444 ;; Only change stars, don't bother moving whole
3445 ;; sections.
3449 ;; Append ID to all footnote references and definitions, so they
3450 ;; become file specific and cannot collide with footnotes in other
3451 ;; included files.
3468 "Execute every Babel code in the visible part of current buffer."
3469 ;; Get a pristine copy of current buffer so Babel references can be
3470 ;; properly resolved.
3476 "Return a non-nil value when output should be added to the kill ring.
3477 See also `org-export-copy-to-kill-ring'."
3483 \f
3484 ;;; Tools For Back-Ends
3485 ;;
3486 ;; A whole set of tools is available to help build new exporters. Any
3487 ;; function general enough to have its use across many back-ends
3488 ;; should be added here.
3490 ;;;; For Affiliated Keywords
3491 ;;
3492 ;; `org-export-read-attribute' reads a property from a given element
3493 ;; as a plist. It can be used to normalize affiliated keywords'
3494 ;; syntax.
3495 ;;
3496 ;; Since captions can span over multiple lines and accept dual values,
3497 ;; their internal representation is a bit tricky. Therefore,
3498 ;; `org-export-get-caption' transparently returns a given element's
3499 ;; caption as a secondary string.
3502 "Turn ATTRIBUTE property from ELEMENT into a plist.
3504 When optional argument PROPERTY is non-nil, return the value of
3505 that property within attributes.
3509 properties.
3511 All values will become strings except the empty string and
3514 will become the empty string."
3528 s)
3533 ;; Ignore any string before first property with `cdr'.
3538 "Return caption from ELEMENT as a secondary string.
3540 When optional argument SHORTP is non-nil, return short caption,
3541 as a secondary string, instead.
3543 Caption lines are separated by a white space."
3551 ;;;; For Derived Back-ends
3552 ;;
3553 ;; `org-export-with-backend' is a function allowing to locally use
3554 ;; another back-end to transcode some object or element. In a derived
3555 ;; back-end, it may be used as a fall-back function once all specific
3556 ;; cases have been treated.
3559 "Call a transcoder from BACKEND on DATA.
3560 BACKEND is an export back-end, as returned by, e.g.,
3561 `org-export-create-backend', or a symbol referring to
3562 a registered back-end. DATA is an Org element, object, secondary
3563 string or string. CONTENTS, when non-nil, is the transcoded
3564 contents of DATA element, as a string. INFO, when non-nil, is
3565 the communication channel used for export, as a plist."
3575 transcoder data contents
3578 :translate-alist all-transcoders
3582 ;;;; For Export Snippets
3583 ;;
3584 ;; Every export snippet is transmitted to the back-end. Though, the
3585 ;; latter will only retain one type of export-snippet, ignoring
3586 ;; others, based on the former's target back-end. The function
3587 ;; `org-export-snippet-backend' returns that back-end for a given
3588 ;; export-snippet.
3591 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3592 Translation, with `org-export-snippet-translation-alist', is
3593 applied."
3597 back-end))))
3600 ;;;; For Footnotes
3601 ;;
3602 ;; `org-export-collect-footnote-definitions' is a tool to list
3603 ;; actually used footnotes definitions in the whole parse tree, or in
3604 ;; a headline, in order to add footnote listings throughout the
3605 ;; transcoded data.
3606 ;;
3607 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3608 ;; back-ends, when they need to attach the footnote definition only to
3609 ;; the first occurrence of the corresponding label.
3610 ;;
3611 ;; `org-export-get-footnote-definition' and
3612 ;; `org-export-get-footnote-number' provide easier access to
3613 ;; additional information relative to a footnote reference.
3616 "Return an alist between footnote numbers, labels and definitions.
3618 DATA is the parse tree from which definitions are collected.
3619 INFO is the plist used as a communication channel.
3621 Definitions are sorted by order of references. They either
3622 appear as Org data or as a secondary string for inlined
3623 footnotes. Unreferenced definitions are ignored."
3625 collect-fn ; for byte-compiler.
3629 ;; Collect footnote number, label and definition in DATA.
3637 def)
3638 num-alist)
3639 ;; Also search in definition for nested footnotes.
3642 ;; Don't enter footnote definitions since it will happen
3643 ;; when their first reference is found.
3649 "Non-nil when a footnote reference is the first one for its label.
3651 FOOTNOTE-REFERENCE is the footnote reference being considered.
3652 INFO is the plist used as a communication channel."
3654 ;; Anonymous footnotes are always a first reference.
3656 ;; Otherwise, return the first footnote with the same LABEL and
3657 ;; test if it is equal to FOOTNOTE-REFERENCE.
3667 ;; If FN isn't inlined, be sure to traverse its
3668 ;; definition before resuming search. See
3669 ;; comments in `org-export-get-footnote-number'
3670 ;; for more information.
3674 ;; Don't enter footnote definitions since it will
3675 ;; happen when their first reference is found.
3678 footnote-reference)))))
3681 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3682 INFO is the plist used as a communication channel. If no such
3691 "Return number associated to a footnote.
3693 FOOTNOTE is either a footnote reference or a footnote definition.
3694 INFO is the plist used as a communication channel."
3696 seen-refs
3697 search-ref ; For byte-compiler.
3701 ;; Search footnote references through DATA, filling
3702 ;; SEEN-REFS along the way.
3707 ;; Anonymous footnote match: return number.
3710 ;; Labels match: return number.
3713 ;; Anonymous footnote: it's always a new one.
3714 ;; Also, be sure to return nil from the `cond' so
3715 ;; `first-match' doesn't get us out of the loop.
3717 ;; Label not seen so far: add it so SEEN-REFS.
3718 ;;
3719 ;; Also search for subsequent references in
3720 ;; footnote definition so numbering follows
3721 ;; reading logic. Note that we don't have to care
3722 ;; about inline definitions, since
3723 ;; `org-element-map' already traverses them at the
3724 ;; right time.
3725 ;;
3726 ;; Once again, return nil to stay in the loop.
3731 nil))))
3732 ;; Don't enter footnote definitions since it will
3733 ;; happen when their first reference is found.
3738 ;;;; For Headlines
3739 ;;
3740 ;; `org-export-get-relative-level' is a shortcut to get headline
3741 ;; level, relatively to the lower headline level in the parsed tree.
3742 ;;
3743 ;; `org-export-get-headline-number' returns the section number of an
3744 ;; headline, while `org-export-number-to-roman' allows to convert it
3745 ;; to roman numbers.
3746 ;;
3747 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3748 ;; `org-export-last-sibling-p' are three useful predicates when it
3749 ;; comes to fulfill the `:headline-levels' property.
3750 ;;
3751 ;; `org-export-get-tags', `org-export-get-category' and
3752 ;; `org-export-get-node-property' extract useful information from an
3753 ;; headline or a parent headline. They all handle inheritance.
3754 ;;
3755 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3756 ;; as a secondary string, suitable for table of contents. It falls
3757 ;; back onto default title.
3760 "Return HEADLINE relative level within current parsed tree.
3761 INFO is a plist holding contextual information."
3766 "Non-nil when HEADLINE is considered as low level.
3768 INFO is a plist used as a communication channel.
3770 A low level headlines has a relative level greater than
3771 `:headline-levels' property value.
3773 Return value is the difference between HEADLINE relative level
3774 and the last level being considered as high enough, or nil."
3781 "Return HEADLINE numbering as a list of numbers.
3782 INFO is a plist holding contextual information."
3786 "Return a non-nil value if HEADLINE element should be numbered.
3787 INFO is a plist used as a communication channel."
3793 "Convert integer N into a roman numeral."
3806 res)))
3809 "Return list of tags associated to ELEMENT.
3811 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3812 is a plist used as a communication channel.
3814 Select tags (see `org-export-select-tags') and exclude tags (see
3815 `org-export-exclude-tags') are removed from the list.
3817 When non-nil, optional argument TAGS should be a list of strings.
3818 Any tag belonging to this list will also be removed.
3820 When optional argument INHERITED is non-nil, tags can also be
3821 inherited from parent headlines and FILETAGS keywords."
3827 ;; Build complete list of inherited tags.
3838 ;; Add FILETAGS keywords and return results.
3842 "Return node PROPERTY value for BLOB.
3844 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3845 element or object.
3847 If optional argument INHERITED is non-nil, the value can be
3848 inherited from a parent headline.
3850 Return value is a string or nil."
3862 "Return category for element or object BLOB.
3864 INFO is a plist used as a communication channel.
3866 CATEGORY is automatically inherited from a parent headline, from
3867 #+CATEGORY: keyword or created out of original file name. If all
3880 "Return alternative title for HEADLINE, as a secondary string.
3881 INFO is a plist used as a communication channel. If no optional
3882 title is defined, fall-back to the regular title."
3887 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3888 INFO is a plist used as a communication channel."
3893 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3894 INFO is a plist used as a communication channel."
3898 ;;;; For Keywords
3899 ;;
3900 ;; `org-export-get-date' returns a date appropriate for the document
3901 ;; to about to be exported. In particular, it takes care of
3902 ;; `org-export-date-timestamp-format'.
3905 "Return date value for the current document.
3907 INFO is a plist used as a communication channel. FMT, when
3908 non-nil, is a time format string that will be applied on the date
3909 if it consists in a single timestamp object. It defaults to
3910 `org-export-date-timestamp-format' when nil.
3912 A proper date can be a secondary string, a string or nil. It is
3913 meant to be translated with `org-export-data' or alike."
3924 ;;;; For Links
3925 ;;
3926 ;; `org-export-solidify-link-text' turns a string into a safer version
3927 ;; for links, replacing most non-standard characters with hyphens.
3928 ;;
3929 ;; `org-export-get-coderef-format' returns an appropriate format
3930 ;; string for coderefs.
3931 ;;
3932 ;; `org-export-inline-image-p' returns a non-nil value when the link
3933 ;; provided should be considered as an inline image.
3934 ;;
3935 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3936 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3937 ;; returns an appropriate unique identifier when found, or nil.
3938 ;;
3939 ;; `org-export-resolve-id-link' returns the first headline with
3940 ;; specified id or custom-id in parse tree, the path to the external
3941 ;; file with the id or nil when neither was found.
3942 ;;
3943 ;; `org-export-resolve-coderef' associates a reference to a line
3944 ;; number in the element it belongs, or returns the reference itself
3945 ;; when the element isn't numbered.
3948 "Take link text S and make a safe target out of it."
3953 "Return format string for code reference link.
3954 PATH is the link path. DESC is its description."
3962 "Non-nil if LINK object points to an inline image.
3964 Optional argument is a set of RULES defining inline images. It
3965 is an alist where associations have the following shape:
3967 \(TYPE . REGEXP)
3969 Applying a rule means apply REGEXP against LINK's path when its
3970 type is TYPE. The function will return a non-nil value if any of
3971 the provided rules is non-nil. The default rule is
3972 `org-export-default-inline-image-rule'.
3974 This only applies to links without a description."
3985 rules)
3986 ;; Return nil if no rule matched.
3987 nil))))
3990 "Resolve a code reference REF.
3992 INFO is a plist used as a communication channel.
3994 Return associated line number in source code, or REF itself,
3995 depending on src-block or example element's switches."
4002 org-coderef-label-format)))
4006 ;; Element containing REF is found. Resolve it to either
4007 ;; a label or a line number, as needed.
4017 "Return LINK destination.
4019 INFO is a plist holding contextual information.
4021 Return value can be an object, an element, or nil:
4023 - If LINK path matches a target object (i.e. <<path>>) return it.
4025 - If LINK path exactly matches the name affiliated keyword
4026 \(i.e. #+NAME: path) of an element, return that element.
4028 - If LINK path exactly matches any headline name, return that
4029 element. If more than one headline share that name, priority
4030 will be given to the one with the closest common ancestor, if
4031 any, or the first one in the parse tree otherwise.
4033 - Otherwise, return nil.
4036 significant."
4039 ;; Split PATH at white spaces so matches are space
4040 ;; insensitive.
4043 ;; Cache for destinations that are not position dependent.
4051 ;; Destination is not position dependent: use cached value.
4053 ;; First try to find a matching "<<path>>" unless user specified
4054 ;; he was looking for a headline (path starts with a "*"
4055 ;; character).
4061 path)
4062 blob))
4065 ;; Then try to find an element with a matching "#+NAME: path"
4066 ;; affiliated keyword.
4069 org-element-all-elements
4074 el)))
4077 ;; Last case: link either points to a headline or to nothingness.
4078 ;; Try to find the source, with priority given to headlines with
4079 ;; the closest common ancestor. If such candidate is found,
4080 ;; return it, otherwise return nil.
4084 ;; Return first headline whose `:raw-value' property is
4085 ;; NAME in parse tree DATA, or nil. Statistics cookies
4086 ;; are ignored.
4094 name)
4095 headline))
4097 ;; Search among headlines sharing an ancestor with link, from
4098 ;; closest to farthest.
4107 ;; No destination found: return nil.
4111 "Return headline referenced as LINK destination.
4113 INFO is a plist used as a communication channel.
4115 Return value can be the headline element matched in current parse
4119 ;; First check if id is within the current parse tree.
4124 headline))
4126 ;; Otherwise, look for external files.
4130 "Return radio-target object referenced as LINK destination.
4132 INFO is a plist used as a communication channel.
4134 Return value can be a radio-target object or nil. Assume LINK
4143 nil nil path nil nil t)
4144 t)
4145 radio))
4149 ;;;; For References
4150 ;;
4151 ;; `org-export-get-ordinal' associates a sequence number to any object
4152 ;; or element.
4155 "Return ordinal number of an element or object.
4157 ELEMENT is the element or object considered. INFO is the plist
4158 used as a communication channel.
4160 Optional argument TYPES, when non-nil, is a list of element or
4161 object types, as symbols, that should also be counted in.
4162 Otherwise, only provided element's type is considered.
4164 Optional argument PREDICATE is a function returning a non-nil
4165 value if the current element or object should be counted in. It
4166 accepts two arguments: the element or object being considered and
4167 the plist used as a communication channel. This allows to count
4168 only a certain type of objects (i.e. inline images).
4170 Return value is a list of numbers if ELEMENT is a headline or an
4171 item. It is nil for keywords. It represents the footnote number
4172 for footnote definitions and footnote references. If ELEMENT is
4173 a target, return the same value as if ELEMENT was the closest
4174 table, item or headline containing the target. In any other
4175 case, return the sequence number of ELEMENT among elements or
4176 objects of the same type."
4177 ;; Ordinal of a target object refer to the ordinal of the closest
4178 ;; table, item, or headline containing the object.
4182 when
4186 table))
4187 return parent)))
4189 ;; Special case 1: A headline returns its number as a list.
4191 ;; Special case 2: An item returns its number as a list.
4195 struct
4202 ;; Increment counter until ELEMENT is found again.
4212 ;;;; For Special Blocks
4213 ;;
4214 ;; `org-export-raw-special-block-p' check if current special block is
4215 ;; an "export block", i.e., a block whose contents should be inserted
4216 ;; as-is in the output. This should generally be the first check to
4217 ;; do when handling special blocks in the export back-end.
4220 "Non-nil if ELEMENT is an export block relatively to current back-end.
4221 An export block is a special block whose contents should be
4222 included as-is in the final output. Such blocks are defined
4223 through :export-block property in `org-export-define-backend',
4224 which see."
4231 b))))
4234 ;;;; For Src Blocks
4235 ;;
4236 ;; `org-export-get-loc' counts number of code lines accumulated in
4237 ;; src-block or example-block elements with a "+n" switch until
4238 ;; a given element, excluded. Note: "-n" switches reset that count.
4239 ;;
4240 ;; `org-export-unravel-code' extracts source code (along with a code
4241 ;; references alist) from an `element-block' or `src-block' type
4242 ;; element.
4243 ;;
4244 ;; `org-export-format-code' applies a formatting function to each line
4245 ;; of code, providing relative line number and code reference when
4246 ;; appropriate. Since it doesn't access the original element from
4247 ;; which the source code is coming, it expects from the code calling
4248 ;; it to know if lines should be numbered and if code references
4249 ;; should appear.
4250 ;;
4251 ;; Eventually, `org-export-format-code-default' is a higher-level
4252 ;; function (it makes use of the two previous functions) which handles
4253 ;; line numbering and code references inclusion, and returns source
4254 ;; code in a format suitable for plain text or verbatim output.
4257 "Return accumulated lines of code up to ELEMENT.
4259 INFO is the plist used as a communication channel.
4261 ELEMENT is excluded from count."
4267 ;; ELEMENT is reached: Quit the loop.
4269 ;; Only count lines from src-block and example-block elements
4270 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4274 ;; Accumulate locs or reset them.
4278 ;; Return nil to stay in the loop.
4279 nil)))
4281 ;; Return value.
4282 loc))
4285 "Clean source code and extract references out of it.
4287 ELEMENT has either a `src-block' an `example-block' type.
4289 Return a cons cell whose CAR is the source code, cleaned from any
4290 reference, protective commas and spurious indentation, and CDR is
4291 an alist between relative line number (integer) and name of code
4292 reference on that line (string)."
4295 ;; Get code and clean it. Remove blank lines at its
4296 ;; beginning and end.
4303 value
4305 ;; Get format used for references.
4308 org-coderef-label-format)))
4309 ;; Build a regexp matching a loc with a reference.
4314 ;; Return value.
4316 ;; Code with references removed.
4322 ;; Ref line: remove ref, and signal its position in REFS.
4326 ;; Reference alist.
4327 refs)))
4330 "Format CODE by applying FUN line-wise and return it.
4332 CODE is a string representing the code to format. FUN is
4333 a function. It must accept three arguments: a line of
4334 code (string), the current line number (integer) or nil and the
4335 reference associated to the current line (string) or nil.
4337 Optional argument NUM-LINES can be an integer representing the
4338 number of code lines accumulated until the current code. Line
4339 numbers passed to FUN will take it into account. If it is nil,
4340 FUN's second argument will always be nil. This number can be
4341 obtained with `org-export-get-loc' function.
4343 Optional argument REF-ALIST can be an alist between relative line
4344 number (i.e. ignoring NUM-LINES) and the name of the code
4345 reference on it. If it is nil, FUN's third argument will always
4346 be nil. It can be obtained through the use of
4347 `org-export-unravel-code' function."
4359 "Return source code from ELEMENT, formatted in a standard way.
4361 ELEMENT is either a `src-block' or `example-block' element. INFO
4362 is a plist used as a communication channel.
4364 This function takes care of line numbering and code references
4365 inclusion. Line numbers, when applicable, appear at the
4366 beginning of the line, separated from the code by two white
4367 spaces. Code references, on the other hand, appear flushed to
4368 the right, separated by six white spaces from the widest line of
4369 code."
4370 ;; Extract code and references.
4377 ;; Handle line numbering.
4386 ;; Prepare references display, if required. Any reference
4387 ;; should start six columns after the widest line of code,
4388 ;; wrapped with parenthesis.
4393 code
4397 number-str
4398 loc
4404 num-start refs)))))
4407 ;;;; For Tables
4408 ;;
4409 ;; `org-export-table-has-special-column-p' and and
4410 ;; `org-export-table-row-is-special-p' are predicates used to look for
4411 ;; meta-information about the table structure.
4412 ;;
4413 ;; `org-table-has-header-p' tells when the rows before the first rule
4414 ;; should be considered as table's header.
4415 ;;
4416 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4417 ;; and `org-export-table-cell-borders' extract information from
4418 ;; a table-cell element.
4419 ;;
4420 ;; `org-export-table-dimensions' gives the number on rows and columns
4421 ;; in the table, ignoring horizontal rules and special columns.
4422 ;; `org-export-table-cell-address', given a table-cell object, returns
4423 ;; the absolute address of a cell. On the other hand,
4424 ;; `org-export-get-table-cell-at' does the contrary.
4425 ;;
4426 ;; `org-export-table-cell-starts-colgroup-p',
4427 ;; `org-export-table-cell-ends-colgroup-p',
4428 ;; `org-export-table-row-starts-rowgroup-p',
4429 ;; `org-export-table-row-ends-rowgroup-p',
4430 ;; `org-export-table-row-starts-header-p' and
4431 ;; `org-export-table-row-ends-header-p' indicate position of current
4432 ;; row or cell within the table.
4435 "Non-nil when TABLE has a special column.
4436 All special columns will be ignored during export."
4437 ;; The table has a special column when every first cell of every row
4438 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4439 ;; "*" "_" and "^". Though, do not consider a first row containing
4440 ;; only empty cells as special.
4456 "Non-nil when TABLE has a header.
4458 INFO is a plist used as a communication channel.
4460 A table has a header when it contains at least two row groups."
4469 table
4480 cache)))))
4483 "Non-nil if TABLE-ROW is considered special.
4485 INFO is a plist used as the communication channel.
4487 All special rows will be ignored during export."
4491 ;; A row is special either when...
4493 ;; ... it starts with a field only containing "/",
4495 ;; ... the table contains a special column and the row start
4496 ;; with a marking character among, "^", "_", "$" or "!",
4500 ;; ... it contains only alignment cookies and empty cells.
4506 ;; Since VALUE is a secondary string, the following
4507 ;; checks avoid expanding it with `org-export-data'.
4519 "Return TABLE-ROW's group number, as an integer.
4521 INFO is a plist used as the communication channel.
4523 Return value is the group number, as an integer, or nil for
4524 special rows and rows separators. First group is also table's
4525 header."
4543 "Return TABLE-CELL contents width.
4545 INFO is a plist used as the communication channel.
4547 Return value is the width given by the last width cookie in the
4548 same column as TABLE-CELL, or nil."
4567 ;; In a special row, try to find a width cookie at COLUMN.
4571 ;; The following checks avoid expanding unnecessarily
4572 ;; the cell with `org-export-data'.
4582 "Return TABLE-CELL contents alignment.
4584 INFO is a plist used as the communication channel.
4586 Return alignment as specified by the last alignment cookie in the
4587 same column as TABLE-CELL. If no such cookie is found, a default
4588 alignment value will be deduced from fraction of numbers in the
4589 column (see `org-table-number-fraction' for more information).
4590 Possible values are `left', `right' and `center'."
4591 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4608 cookie-align
4609 previous-cell-number-p)
4612 ;; In a special row, try to find an alignment cookie at
4613 ;; COLUMN.
4617 ;; Since VALUE is a secondary string, the following
4618 ;; checks avoid useless expansion through
4619 ;; `org-export-data'.
4627 ;; Ignore table rules.
4629 ;; In a standard row, check if cell's contents are
4630 ;; expressing some kind of number. Increase NUMBER-CELLS
4631 ;; accordingly. Though, don't bother if an alignment
4632 ;; cookie has already defined cell's alignment.
4637 info)))
4639 ;; Treat an empty cell as a number if it follows
4640 ;; a number.
4646 ;; Return value. Alignment specified by cookies has
4647 ;; precedence over alignment deduced from cell's contents.
4649 column
4654 org-table-number-fraction)
4659 "Return TABLE-CELL borders.
4661 INFO is a plist used as a communication channel.
4663 Return value is a list of symbols, or nil. Possible values are:
4664 `top', `bottom', `above', `below', `left' and `right'. Note:
4665 `top' (resp. `bottom') only happen for a cell in the first
4666 row (resp. last row) of the table, ignoring table rules, if any.
4668 Returned borders ignore special rows."
4671 borders)
4672 ;; Top/above border? TABLE-CELL has a border above when a rule
4673 ;; used to demarcate row groups can be found above. Hence,
4674 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4675 ;; another regular row has to be found above that rule.
4684 ;; Look at every row before the current one.
4686 ;; No rule above, or rule found starts the table (ignoring any
4687 ;; special row): TABLE-CELL is at the top of the table.
4690 ;; Bottom/below border? TABLE-CELL has a border below when next
4691 ;; non-regular row below is a rule.
4700 ;; Look at every row after the current one.
4702 ;; No rule below, or rule found ends the table (modulo some
4703 ;; special row): TABLE-CELL is at the bottom of the table.
4706 ;; Right/left borders? They can only be specified by column
4707 ;; groups. Column groups are defined in a row starting with "/".
4708 ;; Also a column groups row only contains "<", "<>", ">" or blank
4709 ;; cells.
4726 ;; There's a left border when previous cell, if
4727 ;; any, ends a group, or current one starts one.
4733 ;; There's a right border when next cell, if any,
4734 ;; starts a group, or current one ends one.
4741 ;; Table rows are read in reverse order so last column groups
4742 ;; row has precedence over any previous one.
4744 ;; Return value.
4745 borders))
4748 "Non-nil when TABLE-CELL is at the beginning of a column group.
4749 INFO is a plist used as a communication channel."
4750 ;; A cell starts a column group either when it is at the beginning
4751 ;; of a row (or after the special column, if any) or when it has
4752 ;; a left border.
4755 table-cell)
4759 "Non-nil when TABLE-CELL is at the end of a column group.
4760 INFO is a plist used as a communication channel."
4761 ;; A cell ends a column group either when it is at the end of a row
4762 ;; or when it has a right border.
4765 table-cell)
4769 "Non-nil when TABLE-ROW is at the beginning of a row group.
4770 INFO is a plist used as a communication channel."
4778 "Non-nil when TABLE-ROW is at the end of a row group.
4779 INFO is a plist used as a communication channel."
4787 "Non-nil when TABLE-ROW is the first table header's row.
4788 INFO is a plist used as a communication channel."
4795 "Non-nil when TABLE-ROW is the last table header's row.
4796 INFO is a plist used as a communication channel."
4803 "Return TABLE-ROW number.
4804 INFO is a plist used as a communication channel. Return value is
4805 zero-based and ignores separators. The function returns nil for
4806 special columns and separators."
4818 "Return TABLE dimensions.
4820 INFO is a plist used as a communication channel.
4822 Return value is a CONS like (ROWS . COLUMNS) where
4823 ROWS (resp. COLUMNS) is the number of exportable
4824 rows (resp. columns)."
4826 ;; Set number of rows, and extract first one.
4832 ;; Set number of columns.
4834 ;; Return value.
4838 "Return address of a regular TABLE-CELL object.
4840 TABLE-CELL is the cell considered. INFO is a plist used as
4841 a communication channel.
4843 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4844 zero-based index. Only exportable cells are considered. The
4845 function returns nil for other cells."
4857 "Return regular table-cell object at ADDRESS in TABLE.
4859 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4860 zero-based index. TABLE is a table type element. INFO is
4861 a plist used as a communication channel.
4863 If no table-cell, among exportable cells, is found at ADDRESS,
4864 return nil."
4867 ;; Row at (car address) or nil.
4875 'table-cell
4882 ;;;; For Tables Of Contents
4883 ;;
4884 ;; `org-export-collect-headlines' builds a list of all exportable
4885 ;; headline elements, maybe limited to a certain depth. One can then
4886 ;; easily parse it and transcode it.
4887 ;;
4888 ;; Building lists of tables, figures or listings is quite similar.
4889 ;; Once the generic function `org-export-collect-elements' is defined,
4890 ;; `org-export-collect-tables', `org-export-collect-figures' and
4891 ;; `org-export-collect-listings' can be derived from it.
4894 "Collect headlines in order to build a table of contents.
4896 INFO is a plist used as a communication channel.
4898 When optional argument N is an integer, it specifies the depth of
4899 the table of contents. Otherwise, it is set to the value of the
4900 last headline level. See `org-export-headline-levels' for more
4901 information.
4903 Return a list of all exportable headlines as parsed elements.
4904 Footnote sections, if any, will be ignored."
4912 info)))
4915 "Collect referenceable elements of a determined type.
4917 TYPE can be a symbol or a list of symbols specifying element
4918 types to search. Only elements with a caption are collected.
4920 INFO is a plist used as a communication channel.
4922 When non-nil, optional argument PREDICATE is a function accepting
4923 one argument, an element of type TYPE. It returns a non-nil
4924 value when that element should be collected.
4926 Return a list of all elements found, in order of appearance."
4931 element))
4932 info))
4935 "Build a list of tables.
4936 INFO is a plist used as a communication channel.
4938 Return a list of table elements with a caption."
4942 "Build a list of figures.
4944 INFO is a plist used as a communication channel. PREDICATE is
4945 a function which accepts one argument: a paragraph element and
4946 whose return value is non-nil when that element should be
4947 collected.
4949 A figure is a paragraph type element, with a caption, verifying
4951 a vague concept that may depend on back-end.
4953 Return a list of elements recognized as figures."
4957 "Build a list of src blocks.
4959 INFO is a plist used as a communication channel.
4961 Return a list of src-block elements with a caption."
4965 ;;;; Smart Quotes
4966 ;;
4967 ;; The main function for the smart quotes sub-system is
4968 ;; `org-export-activate-smart-quotes', which replaces every quote in
4969 ;; a given string from the parse tree with its "smart" counterpart.
4970 ;;
4971 ;; Dictionary for smart quotes is stored in
4972 ;; `org-export-smart-quotes-alist'.
4973 ;;
4974 ;; Internally, regexps matching potential smart quotes (checks at
4975 ;; string boundaries are also necessary) are defined in
4976 ;; `org-export-smart-quotes-regexps'.
4980 ;; one may use: »...«, "...", ›...‹, or '...'.
4981 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4982 ;; LaTeX quotes require Babel!
5027 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5036 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5045 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5054 ;; 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
5055 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5066 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5072 )
5073 "Smart quotes translations.
5075 Alist whose CAR is a language string and CDR is an alist with
5076 quote type as key and a plist associating various encodings to
5077 their translation as value.
5079 A quote type can be any symbol among `opening-double-quote',
5080 `closing-double-quote', `opening-single-quote',
5081 `closing-single-quote' and `apostrophe'.
5083 Valid encodings include `:utf-8', `:html', `:latex' and
5084 `:texinfo'.
5090 ;; Possible opening quote at beginning of string.
5092 ;; Possible closing quote at beginning of string.
5094 ;; Possible apostrophe at beginning of string.
5096 ;; Opening single and double quotes.
5098 ;; Closing single and double quotes.
5100 ;; Apostrophe.
5102 ;; Possible opening quote at end of string.
5104 ;; Possible closing quote at end of string.
5106 ;; Possible apostrophe at end of string.
5108 "List of regexps matching a quote or an apostrophe.
5114 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5115 `:utf-8'. INFO is a plist used as a communication channel.
5117 The function has to retrieve information about string
5118 surroundings in parse tree. It can only happen with an
5119 unmodified string. Thus, if S has already been through another
5120 process, a non-nil ORIGINAL optional argument will provide that
5121 original string.
5123 Return the new string."
5126 ;; Try to be flexible when computing number of blanks
5127 ;; before object. The previous object may be a string
5128 ;; introduced by the back-end and not completely parsed.
5131 ;; A string with missing `:post-blank'
5132 ;; property.
5136 ;; Fallback value.
5141 ;; Return smart quote associated to a give quote Q, as
5142 ;; a string. TYPE is a symbol among `open', `close' and
5143 ;; `apostrophe'.
5153 org-export-smart-quotes-alist))))
5154 encoding)
5155 q)))))
5157 ;; Only a quote: no regexp can match. We have to check both
5158 ;; sides and decide what to do.
5166 ;; 1. Replace quote character at the beginning of S.
5168 ;; Apostrophe?
5174 ;; Closing quote?
5180 ;; Opening quote?
5186 ;; 2. Replace quotes in the middle of the string.
5188 ;; Opening quotes.
5194 ;; Closing quotes.
5200 ;; Apostrophes.
5205 ;; 3. Replace quote character at the end of S.
5207 ;; Apostrophe?
5212 ;; Closing quote?
5218 ;; Opening quote?
5223 ;; Return string with smart quotes.
5224 s))))
5226 ;;;; Topology
5227 ;;
5228 ;; Here are various functions to retrieve information about the
5229 ;; neighborhood of a given element or object. Neighbors of interest
5230 ;; are direct parent (`org-export-get-parent'), parent headline
5231 ;; (`org-export-get-parent-headline'), first element containing an
5232 ;; object, (`org-export-get-parent-element'), parent table
5233 ;; (`org-export-get-parent-table'), previous element or object
5234 ;; (`org-export-get-previous-element') and next element or object
5235 ;; (`org-export-get-next-element').
5236 ;;
5237 ;; `org-export-get-genealogy' returns the full genealogy of a given
5238 ;; element or object, from closest parent to full parse tree.
5240 ;; defsubst org-export-get-parent must be defined before first use
5243 "Return full genealogy relative to a given element or object.
5245 BLOB is the element or object being considered.
5247 Ancestors are returned from closest to farthest, the last one
5248 being the full parse tree."
5255 "Return BLOB parent headline or nil.
5256 BLOB is the element or object being considered."
5260 parent))
5263 "Return first element containing OBJECT or nil.
5264 OBJECT is the object to consider."
5268 parent))
5271 "Return OBJECT parent table or nil.
5272 OBJECT is either a `table-cell' or `table-element' type object."
5276 parent))
5279 "Return previous element or object.
5281 BLOB is an element or object. INFO is a plist used as
5282 a communication channel. Return previous exportable element or
5283 object, a string, or nil.
5285 When optional argument N is a positive integer, return a list
5286 containing up to N siblings before BLOB, from farthest to
5287 closest. With any other non-nil value, return a list containing
5288 all of them."
5294 prev)
5304 "Return next element or object.
5306 BLOB is an element or object. INFO is a plist used as
5307 a communication channel. Return next exportable element or
5308 object, a string, or nil.
5310 When optional argument N is a positive integer, return a list
5311 containing up to N siblings after BLOB, from closest to farthest.
5312 With any other non-nil value, return a list containing all of
5313 them."
5320 next)
5330 ;;;; Translation
5331 ;;
5332 ;; `org-export-translate' translates a string according to the language
5333 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5334 ;; the dictionary used for the translation.
5381 ("ru" :html "(Продолжение следует)"
5479 ("ru" :html "Список распечаток"
5492 ("ru" :html "Список таблиц"
5575 ("ru" :html "Неизвестная ссылка"
5578 "Dictionary for export engine.
5580 Alist whose CAR is the string to translate and CDR is an alist
5581 whose CAR is the language string and CDR is a plist whose
5582 properties are possible charsets and values translated terms.
5584 It is used as a database for `org-export-translate'. Since this
5585 function returns the string as-is if no translation was found,
5586 the variable only needs to record values different from the
5590 "Translate string S according to language specification.
5592 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5593 and `:utf-8'. INFO is a plist used as a communication channel.
5595 Translation depends on `:language' property. Return the
5596 translated string. If no translation is found, try to fall back
5597 to `:default' encoding. If it fails, return S."
5603 s)))
5606 \f
5607 ;;; Asynchronous Export
5608 ;;
5609 ;; `org-export-async-start' is the entry point for asynchronous
5610 ;; export. It recreates current buffer (including visibility,
5611 ;; narrowing and visited file) in an external Emacs process, and
5612 ;; evaluates a command there. It then applies a function on the
5613 ;; returned results in the current process.
5614 ;;
5615 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5616 ;; allow to export to a buffer or a file, asynchronously or not.
5617 ;;
5618 ;; `org-export-output-file-name' is an auxiliary function meant to be
5619 ;; used with `org-export-to-file'. With a given extension, it tries
5620 ;; to provide a canonical file name to write export output to.
5621 ;;
5622 ;; Asynchronously generated results are never displayed directly.
5623 ;; Instead, they are stored in `org-export-stack-contents'. They can
5624 ;; then be retrieved by calling `org-export-stack'.
5625 ;;
5626 ;; Export Stack is viewed through a dedicated major mode
5627 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5628 ;;`org-export-stack-delete', `org-export-stack-view' and
5629 ;;`org-export-stack-clear'.
5630 ;;
5631 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5632 ;; It should be used whenever `org-export-async-start' is called.
5635 "Call function FUN on the results returned by BODY evaluation.
5637 BODY evaluation happens in an asynchronous process, from a buffer
5638 which is an exact copy of the current one.
5640 Use `org-export-add-to-stack' in FUN in order to register results
5641 in the stack.
5643 This is a low level function. See also `org-export-to-buffer'
5644 and `org-export-to-file' for more specialized functions."
5647 ;; Write the full sexp evaluating BODY in a copy of the current
5648 ;; buffer to a temporary file, as it may be too long for program
5649 ;; args in `start-process'.
5656 ;; Null characters (from variable values) are inserted
5657 ;; within the file. As a consequence, coding system for
5658 ;; buffer contents will not be recognized properly. So,
5659 ;; we make sure it is the same as the one used to display
5660 ;; the original buffer.
5662 ,coding
5665 ;; Ignore `kill-emacs-hook' and code evaluation
5666 ;; queries from Babel as we need a truly
5667 ;; non-interactive process.
5669 org-babel-confirm-evaluate-answer-no t)
5670 ;; Initialize export framework.
5672 ;; Re-create current buffer there.
5675 ;; Sexp to evaluate in the buffer.
5677 ;; Start external process.
5680 (,process
5682 #'start-process
5685 ,proc-buffer
5692 ;; Register running process in stack.
5694 ;; Set-up sentinel in order to catch results.
5697 ,process
5719 ;;;###autoload
5722 &optional async subtreep visible-only body-only ext-plist
5723 post-process)
5724 "Call `org-export-as' with output to a specified buffer.
5726 BACKEND is either an export back-end, as returned by, e.g.,
5727 `org-export-create-backend', or a symbol referring to
5728 a registered back-end.
5730 BUFFER is the name of the output buffer. If it already exists,
5731 it will be erased first, otherwise, it will be created.
5733 A non-nil optional argument ASYNC means the process should happen
5734 asynchronously. The resulting buffer should then be accessible
5735 through the `org-export-stack' interface. When ASYNC is nil, the
5736 buffer is displayed if `org-export-show-temporary-export-buffer'
5737 is non-nil.
5739 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5740 EXT-PLIST are similar to those used in `org-export-as', which
5741 see.
5743 Optional argument POST-PROCESS is a function which should accept
5744 no argument. It is always called within the current process,
5745 from BUFFER, with point at its beginning. Export back-ends can
5746 use it to set a major mode there, e.g,
5748 \(defun org-latex-export-as-latex
5749 \(&optional async subtreep visible-only body-only ext-plist)
5750 \(interactive)
5752 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5754 This function returns BUFFER."
5782 buffer)))
5784 ;;;###autoload
5787 post-process)
5788 "Call `org-export-as' with output to a specified file.
5790 BACKEND is either an export back-end, as returned by, e.g.,
5791 `org-export-create-backend', or a symbol referring to
5792 a registered back-end. FILE is the name of the output file, as
5793 a string.
5795 A non-nil optional argument ASYNC means the process should happen
5796 asynchronously. The resulting buffer will then be accessible
5797 through the `org-export-stack' interface.
5799 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5800 EXT-PLIST are similar to those used in `org-export-as', which
5801 see.
5803 Optional argument POST-PROCESS is called with FILE as its
5804 argument and happens asynchronously when ASYNC is non-nil. It
5805 has to return a file name, or nil. Export back-ends can use this
5806 to send the output file through additional processing, e.g,
5808 \(defun org-latex-export-to-latex
5809 \(&optional async subtreep visible-only body-only ext-plist)
5810 \(interactive)
5812 \(org-export-to-file 'latex outfile
5813 async subtreep visible-only body-only ext-plist
5814 \(lambda (file) (org-latex-compile file)))
5816 The function returns either a file name returned by POST-PROCESS,
5817 or FILE."
5835 backend subtreep visible-only body-only ext-plist)))
5842 ;; Get proper return value.
5844 file))))))
5847 "Return output file's name according to buffer specifications.
5849 EXTENSION is a string representing the output file extension,
5850 with the leading dot.
5852 With a non-nil optional argument SUBTREEP, try to determine
5854 of subtree at point.
5856 When optional argument PUB-DIR is set, use it as the publishing
5857 directory.
5859 When optional argument VISIBLE-ONLY is non-nil, don't export
5860 contents of hidden elements.
5862 Return file name as a string."
5865 ;; File name may come from EXPORT_FILE_NAME subtree
5866 ;; property, assuming point is at beginning of said
5867 ;; sub-tree.
5874 ;; File name may be extracted from buffer's associated
5875 ;; file, if any.
5877 ;; Can't determine file name on our own: Ask user.
5881 "Output file: " pub-dir nil nil nil
5885 ;; Build file name. Enforce EXTENSION over whatever user
5886 ;; may have come up with. PUB-DIR, if defined, always has
5887 ;; precedence over any provided path.
5892 extension))
5895 ;; If writing to OUTPUT-FILE would overwrite original file, append
5896 ;; EXTENSION another time to final name.
5899 output-file)))
5902 "Add a new result to export stack if not present already.
5904 SOURCE is a buffer or a file name containing export results.
5905 BACKEND is a symbol representing export back-end used to generate
5906 it.
5908 Entries already pointing to SOURCE and unavailable entries are
5909 removed beforehand. Return the new stack."
5915 "Menu for asynchronous export results and running processes."
5925 "Return source from export results at point in stack."
5932 source
5933 ;; SOURCE is not consistent with current line. The stack
5934 ;; view is outdated.
5938 "Remove all entries from export stack."
5943 "Refresh the asynchronous export stack.
5944 DUMMY is ignored. Unavailable sources are removed from the list.
5945 Return the new stack."
5955 ;; Back-end.
5957 ;; Age.
5960 ;; Compute age of the results.
5962 "%4h:%.2m "
5964 ;; Source.
5969 ;; Clear stack from exited processes, dead buffers or
5970 ;; non-existent files.
5982 "Remove export results at point from stack.
5983 If optional argument SOURCE is non-nil, remove it instead."
5988 org-export-stack-contents))))
5991 "View export results at point in stack.
5992 With an optional prefix argument IN-EMACS, force viewing files
5993 within Emacs."
6007 (define-key km "p" 'previous-line)
6008 (define-key km "\C-p" 'previous-line)
6009 (define-key km "\C-?" 'previous-line)
6010 (define-key km [up] 'previous-line)
6011 (define-key km "C" 'org-export-stack-clear)
6012 (define-key km "v" 'org-export-stack-view)
6013 (define-key km (kbd "RET") 'org-export-stack-view)
6014 (define-key km "d" 'org-export-stack-remove)
6015 km)
6016 "Keymap for Org Export Stack.")
6018 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6019 "Mode for displaying asynchronous export stack.
6022 stack.
6024 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6025 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6026 stack completely.
6028 Removing entries in an Org Export Stack buffer doesn't affect
6029 files or buffers, only the display.
6032 (abbrev-mode 0)
6033 (auto-fill-mode 0)
6034 (setq buffer-read-only t
6035 buffer-undo-list t
6036 truncate-lines t
6037 header-line-format
6038 '(:eval
6039 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6040 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6041 (set (make-local-variable 'revert-buffer-function)
6042 'org-export-stack-refresh))
6045 \f
6046 ;;; The Dispatcher
6047 ;;
6048 ;; `org-export-dispatch' is the standard interactive way to start an
6049 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6050 ;; for its interface, which, in turn, delegates response to key
6051 ;; pressed to `org-export--dispatch-action'.
6053 ;;;###autoload
6054 (defun org-export-dispatch (&optional arg)
6055 "Export dispatcher for Org mode.
6057 It provides an access to common export related tasks in a buffer.
6058 Its interface comes in two flavors: standard and expert.
6060 While both share the same set of bindings, only the former
6061 displays the valid keys associations in a dedicated buffer.
6062 Scrolling (resp. line-wise motion) in this buffer is done with
6063 SPC and DEL (resp. C-n and C-p) keys.
6065 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6066 flavor or the other.
6069 of options used back then, on the current buffer.
6071 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6072 (interactive "P")
6073 (let* ((input
6074 (cond ((equal arg '(16)) '(stack))
6075 ((and arg org-export-dispatch-last-action))
6076 (t (save-window-excursion
6077 (unwind-protect
6078 (progn
6079 ;; Remember where we are
6080 (move-marker org-export-dispatch-last-position
6081 (point)
6082 (org-base-buffer (current-buffer)))
6083 ;; Get and store an export command
6084 (setq org-export-dispatch-last-action
6085 (org-export--dispatch-ui
6086 (list org-export-initial-scope
6087 (and org-export-in-background 'async))
6088 nil
6089 org-export-dispatch-use-expert-ui)))
6090 (and (get-buffer "*Org Export Dispatcher*")
6091 (kill-buffer "*Org Export Dispatcher*")))))))
6092 (action (car input))
6093 (optns (cdr input)))
6094 (unless (memq 'subtree optns)
6095 (move-marker org-export-dispatch-last-position nil))
6096 (case action
6097 ;; First handle special hard-coded actions.
6098 (template (org-export-insert-default-template nil optns))
6099 (stack (org-export-stack))
6100 (publish-current-file
6101 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6102 (publish-current-project
6103 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6104 (publish-choose-project
6105 (org-publish (assoc (org-icompleting-read
6106 "Publish project: "
6107 org-publish-project-alist nil t)
6108 org-publish-project-alist)
6109 (memq 'force optns)
6110 (memq 'async optns)))
6111 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6112 (otherwise
6113 (save-excursion
6114 (when arg
6115 ;; Repeating command, maybe move cursor to restore subtree
6116 ;; context.
6117 (if (eq (marker-buffer org-export-dispatch-last-position)
6118 (org-base-buffer (current-buffer)))
6119 (goto-char org-export-dispatch-last-position)
6120 ;; We are in a different buffer, forget position.
6121 (move-marker org-export-dispatch-last-position nil)))
6122 (funcall action
6123 ;; Return a symbol instead of a list to ease
6124 ;; asynchronous export macro use.
6125 (and (memq 'async optns) t)
6126 (and (memq 'subtree optns) t)
6127 (and (memq 'visible optns) t)
6128 (and (memq 'body optns) t)))))))
6130 (defun org-export--dispatch-ui (options first-key expertp)
6131 "Handle interface for `org-export-dispatch'.
6133 OPTIONS is a list containing current interactive options set for
6134 export. It can contain any of the following symbols:
6135 `body' toggles a body-only export
6136 `subtree' restricts export to current subtree
6137 `visible' restricts export to visible part of buffer.
6138 `force' force publishing files.
6139 `async' use asynchronous export process
6141 FIRST-KEY is the key pressed to select the first level menu. It
6142 is nil when this menu hasn't been selected yet.
6144 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6145 buffer is provided, but indications about currently active
6146 options are given in the prompt. Moreover, \[?] allows to switch
6147 back to standard interface."
6148 (let* ((fontify-key
6149 (lambda (key &optional access-key)
6150 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6151 ;; non-nil is the required first-level key to activate
6152 ;; KEY. When its value is t, activate KEY independently
6153 ;; on the first key, if any. A nil value means KEY will
6154 ;; only be activated at first level.
6155 (if (or (eq access-key t) (eq access-key first-key))
6156 (org-propertize key 'face 'org-warning)
6157 key)))
6158 (fontify-value
6159 (lambda (value)
6160 ;; Fontify VALUE string.
6161 (org-propertize value 'face 'font-lock-variable-name-face)))
6162 ;; Prepare menu entries by extracting them from registered
6163 ;; back-ends and sorting them by access key and by ordinal,
6164 ;; if any.
6165 (entries
6166 (sort (sort (delq nil
6167 (mapcar 'org-export-backend-menu
6168 org-export--registered-backends))
6169 (lambda (a b)
6170 (let ((key-a (nth 1 a))
6171 (key-b (nth 1 b)))
6172 (cond ((and (numberp key-a) (numberp key-b))
6173 (< key-a key-b))
6174 ((numberp key-b) t)))))
6175 'car-less-than-car))
6176 ;; Compute a list of allowed keys based on the first key
6177 ;; pressed, if any. Some keys
6178 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6179 ;; available.
6180 (allowed-keys
6181 (nconc (list 2 22 19 6 1)
6182 (if (not first-key) (org-uniquify (mapcar 'car entries))
6183 (let (sub-menu)
6184 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6185 (when (eq (car entry) first-key)
6186 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6187 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6188 ((not first-key) (list ?P)))
6189 (list ?& ?#)
6190 (when expertp (list ??))
6191 (list ?q)))
6192 ;; Build the help menu for standard UI.
6193 (help
6194 (unless expertp
6195 (concat
6196 ;; Options are hard-coded.
6197 (format "[%s] Body only: %s [%s] Visible only: %s
6198 \[%s] Export scope: %s [%s] Force publishing: %s
6200 (funcall fontify-key "C-b" t)
6201 (funcall fontify-value
6202 (if (memq 'body options) "On " "Off"))
6203 (funcall fontify-key "C-v" t)
6204 (funcall fontify-value
6205 (if (memq 'visible options) "On " "Off"))
6206 (funcall fontify-key "C-s" t)
6207 (funcall fontify-value
6208 (if (memq 'subtree options) "Subtree" "Buffer "))
6209 (funcall fontify-key "C-f" t)
6210 (funcall fontify-value
6211 (if (memq 'force options) "On " "Off"))
6212 (funcall fontify-key "C-a" t)
6213 (funcall fontify-value
6214 (if (memq 'async options) "On " "Off")))
6215 ;; Display registered back-end entries. When a key
6216 ;; appears for the second time, do not create another
6217 ;; entry, but append its sub-menu to existing menu.
6218 (let (last-key)
6219 (mapconcat
6220 (lambda (entry)
6221 (let ((top-key (car entry)))
6222 (concat
6223 (unless (eq top-key last-key)
6224 (setq last-key top-key)
6226 (funcall fontify-key (char-to-string top-key))
6227 (nth 1 entry)))
6228 (let ((sub-menu (nth 2 entry)))
6229 (unless (functionp sub-menu)
6230 ;; Split sub-menu into two columns.
6231 (let ((index -1))
6232 (concat
6233 (mapconcat
6234 (lambda (sub-entry)
6235 (incf index)
6236 (format
6237 (if (zerop (mod index 2)) " [%s] %-26s"
6239 (funcall fontify-key
6240 (char-to-string (car sub-entry))
6241 top-key)
6242 (nth 1 sub-entry)))
6243 sub-menu "")
6245 entries ""))
6246 ;; Publishing menu is hard-coded.
6248 [%s] Current file [%s] Current project
6250 (funcall fontify-key "P")
6251 (funcall fontify-key "f" ?P)
6252 (funcall fontify-key "p" ?P)
6253 (funcall fontify-key "x" ?P)
6254 (funcall fontify-key "a" ?P))
6256 (funcall fontify-key "&" t)
6257 (funcall fontify-key "#" t))
6258 (format "[%s] %s"
6259 (funcall fontify-key "q" t)
6260 (if first-key "Main menu" "Exit")))))
6261 ;; Build prompts for both standard and expert UI.
6262 (standard-prompt (unless expertp "Export command: "))
6263 (expert-prompt
6264 (when expertp
6265 (format
6266 "Export command (C-%s%s%s%s%s) [%s]: "
6267 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6268 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6269 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6270 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6271 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6272 (mapconcat (lambda (k)
6273 ;; Strip control characters.
6274 (unless (< k 27) (char-to-string k)))
6275 allowed-keys "")))))
6276 ;; With expert UI, just read key with a fancy prompt. In standard
6277 ;; UI, display an intrusive help buffer.
6278 (if expertp
6279 (org-export--dispatch-action
6280 expert-prompt allowed-keys entries options first-key expertp)
6281 ;; At first call, create frame layout in order to display menu.
6282 (unless (get-buffer "*Org Export Dispatcher*")
6283 (delete-other-windows)
6284 (org-switch-to-buffer-other-window
6285 (get-buffer-create "*Org Export Dispatcher*"))
6286 (setq cursor-type nil
6287 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6288 ;; Make sure that invisible cursor will not highlight square
6289 ;; brackets.
6290 (set-syntax-table (copy-syntax-table))
6291 (modify-syntax-entry ?\[ "w"))
6292 ;; At this point, the buffer containing the menu exists and is
6293 ;; visible in the current window. So, refresh it.
6294 (with-current-buffer "*Org Export Dispatcher*"
6295 ;; Refresh help. Maintain display continuity by re-visiting
6296 ;; previous window position.
6297 (let ((pos (window-start)))
6298 (erase-buffer)
6299 (insert help)
6300 (set-window-start nil pos)))
6301 (org-fit-window-to-buffer)
6302 (org-export--dispatch-action
6303 standard-prompt allowed-keys entries options first-key expertp))))
6305 (defun org-export--dispatch-action
6306 (prompt allowed-keys entries options first-key expertp)
6307 "Read a character from command input and act accordingly.
6309 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6310 a list of characters available at a given step in the process.
6311 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6312 EXPERTP are the same as defined in `org-export--dispatch-ui',
6313 which see.
6315 Toggle export options when required. Otherwise, return value is
6316 a list with action as CAR and a list of interactive export
6317 options as CDR."
6318 (let (key)
6319 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6320 ;; C-p, SPC, DEL).
6321 (while (and (setq key (read-char-exclusive prompt))
6322 (not expertp)
6323 (memq key '(14 16 ?\s ?\d)))
6324 (case key
6325 (14 (if (not (pos-visible-in-window-p (point-max)))
6326 (ignore-errors (scroll-up 1))
6327 (message "End of buffer")
6328 (sit-for 1)))
6329 (16 (if (not (pos-visible-in-window-p (point-min)))
6330 (ignore-errors (scroll-down 1))
6331 (message "Beginning of buffer")
6332 (sit-for 1)))
6333 (?\s (if (not (pos-visible-in-window-p (point-max)))
6334 (scroll-up nil)
6335 (message "End of buffer")
6336 (sit-for 1)))
6337 (?\d (if (not (pos-visible-in-window-p (point-min)))
6338 (scroll-down nil)
6339 (message "Beginning of buffer")
6340 (sit-for 1)))))
6341 (cond
6342 ;; Ignore undefined associations.
6343 ((not (memq key allowed-keys))
6344 (ding)
6345 (unless expertp (message "Invalid key") (sit-for 1))
6346 (org-export--dispatch-ui options first-key expertp))
6347 ;; q key at first level aborts export. At second level, cancel
6348 ;; first key instead.
6349 ((eq key ?q) (if (not first-key) (error "Export aborted")
6350 (org-export--dispatch-ui options nil expertp)))
6351 ;; Help key: Switch back to standard interface if expert UI was
6352 ;; active.
6353 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6354 ;; Send request for template insertion along with export scope.
6355 ((eq key ?#) (cons 'template (memq 'subtree options)))
6356 ;; Switch to asynchronous export stack.
6357 ((eq key ?&) '(stack))
6358 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6359 ((memq key '(2 22 19 6 1))
6360 (org-export--dispatch-ui
6361 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6362 (6 'force) (1 'async))))
6363 (if (memq option options) (remq option options)
6364 (cons option options)))
6365 first-key expertp))
6366 ;; Action selected: Send key and options back to
6367 ;; `org-export-dispatch'.
6368 ((or first-key (functionp (nth 2 (assq key entries))))
6369 (cons (cond
6370 ((not first-key) (nth 2 (assq key entries)))
6371 ;; Publishing actions are hard-coded. Send a special
6372 ;; signal to `org-export-dispatch'.
6373 ((eq first-key ?P)
6374 (case key
6375 (?f 'publish-current-file)
6376 (?p 'publish-current-project)
6377 (?x 'publish-choose-project)
6378 (?a 'publish-all)))
6379 ;; Return first action associated to FIRST-KEY + KEY
6380 ;; path. Indeed, derived backends can share the same
6381 ;; FIRST-KEY.
6382 (t (catch 'found
6383 (mapc (lambda (entry)
6384 (let ((match (assq key (nth 2 entry))))
6385 (when match (throw 'found (nth 2 match)))))
6386 (member (assq first-key entries) entries)))))
6387 options))
6388 ;; Otherwise, enter sub-menu.
6389 (t (org-export--dispatch-ui options key expertp)))))
6393 (provide 'ox)
6395 ;; Local variables:
6396 ;; generated-autoload-file: "org-loaddefs.el"
6397 ;; End:
6399 ;;; ox.el ends here