| blob | 050b054373355c969f17828ccdbbffba45e2a529 |
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
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
263 org-element--cache org-element--cache-objects org-element--cache-sync-keys
264 org-element--cache-sync-requests org-element--cache-sync-timer)
265 "List of variables not copied through upon buffer duplication.
266 Export process takes place on a copy of the original buffer.
267 When this copy is created, all Org related local variables not in
268 this list are copied to the new buffer. Variables with an
272 "Non-nil means asynchronous export process should leave data behind.
276 located in `temporary-file-directory'.
278 When non-nil, it will also set `debug-on-error' to a non-nil
282 "Record asynchronously generated export results and processes.
283 This is an alist: its CAR is the source of the
284 result (destination file or buffer for a finished process,
285 original buffer for a running one) and its CDR is a list
286 containing the back-end used, as a symbol, and either a process
287 or the time at which it finished. It is used to build the menu
291 "List of backends currently available in the exporter.
292 This variable is set with `org-export-define-backend' and
296 "Last command called from the dispatcher.
297 The value should be a list. Its CAR is the action, as a symbol,
301 "The position where the last export command was created using the dispatcher.
302 This marker will be used with `C-u C-c C-e' to make sure export repetition
305 ;; For compatibility with Org < 8
307 "Name, if any, of the back-end used during an export process.
309 Its value is a symbol such as `html', `latex', `ascii', or nil if
310 the back-end is anonymous (see `org-export-create-backend') or if
311 there is no export process in progress.
313 It can be used to teach Babel blocks how to act differently
317 \f
318 ;;; User-configurable Variables
319 ;;
320 ;; Configuration for the masses.
321 ;;
322 ;; They should never be accessed directly, as their value is to be
323 ;; stored in a property list (cf. `org-export-options-alist').
324 ;; Back-ends will read their value from there instead.
327 "Options for exporting Org mode files."
332 "General options for export engine."
337 "Whether sub-trees with the ARCHIVE tag should be exported.
339 This can have three different values:
340 nil Do not export, pretend this tree is not present.
341 t Do export the entire tree.
342 `headline' Only export the headline, but skip the tree below it.
344 This option can also be set with the OPTIONS keyword,
353 "Non-nil means insert author name into the exported file.
354 This option can also be set with the OPTIONS keyword,
360 "Non-nil means export CLOCK keywords.
361 This option can also be set with the OPTIONS keyword,
367 "Non-nil means the postamble should contain a creator sentence.
369 The sentence can be set in `org-export-creator-string' and
372 If the value is `comment' insert it as a comment."
380 "Non-nil means insert date in the exported document.
381 This option can also be set with the OPTIONS keyword,
387 "Time-stamp format string to use for DATE keyword.
389 The format string, when specified, only applies if date consists
390 in a single time-stamp. Otherwise its value will be ignored.
392 See `format-time-string' for details on how to build this
393 string."
401 emacs-version
403 "Information about the creator of the document.
404 This option can also be set on with the CREATOR keyword."
409 "Non-nil means export contents of standard drawers.
411 When t, all drawers are exported. This may also be a list of
412 drawer names to export, as strings. If that list starts with
413 `not', only drawers with such names will be ignored.
415 This variable doesn't apply to properties drawers. See
416 `org-export-with-properties' instead.
418 This option can also be set with the OPTIONS keyword,
431 :inline t
435 "Non-nil means insert author email into the exported file.
436 This option can also be set with the OPTIONS keyword,
442 "Non-nil means interpret *word*, /word/, _word_ and +word+.
444 If the export target supports emphasizing text, the word will be
445 typeset in bold, italic, with an underline or strike-through,
446 respectively.
448 This option can also be set with the OPTIONS keyword,
454 "Tags that exclude a tree from export.
456 All trees carrying any of these tags will be excluded from
457 export. This is without condition, so even subtrees inside that
458 carry one of the `org-export-select-tags' will be removed.
460 This option can also be set with the EXCLUDE_TAGS keyword."
466 This option can also be set with the OPTIONS keyword,
474 "Non-nil means Org footnotes should be exported.
475 This option can also be set with the OPTIONS keyword,
481 "Non-nil means process LaTeX environments and fragments.
483 This option can also be set with the OPTIONS line,
486 nil Ignore math snippets.
487 `verbatim' Keep everything in verbatim.
488 t Allow export of math snippets."
498 "The last level which is still exported as a headline.
500 Inferior levels will usually produce itemize or enumerate lists
501 when exported, but back-end behaviour may differ.
503 This option can also be set with the OPTIONS keyword,
509 "The default language for export and clocktable translations, as a string.
510 This may have an association in
511 `org-clock-clocktable-language-setup',
512 `org-export-smart-quotes-alist' and `org-export-dictionary'.
513 This option can also be set with the LANGUAGE keyword."
518 "Non-nil means preserve all line breaks when exporting.
519 This option can also be set with the OPTIONS keyword,
525 "Non-nil means interpret entities when exporting.
528 Å.
530 For a list of supported names, see the constant `org-entities'
531 and the user option `org-entities-user'.
533 This option can also be set with the OPTIONS keyword,
539 "Non-nil means inlinetasks should be exported.
540 This option can also be set with the OPTIONS keyword,
548 "Non-nil means include planning info in export.
550 Planning info is the line containing either SCHEDULED:,
551 DEADLINE:, CLOSED: time-stamps, or a combination of them.
553 This option can also be set with the OPTIONS keyword,
561 "Non-nil means include priority cookies in export.
562 This option can also be set with the OPTIONS keyword,
568 "Non-nil means export contents of properties drawers.
570 When t, all properties are exported. This may also be a list of
571 properties to export, as strings.
573 This option can also be set with the OPTIONS keyword,
585 "Non-nil means add section numbers to headlines when exporting.
587 When set to an integer n, numbering will only happen for
588 headlines whose relative level is higher or equal to n.
590 This option can also be set with the OPTIONS keyword,
596 "Tags that select a tree for export.
598 If any such tag is found in a buffer, all trees that do not carry
599 one of these tags will be ignored during export. Inside trees
600 that are selected like this, you can still deselect a subtree by
601 tagging it with one of the `org-export-exclude-tags'.
603 This option can also be set with the SELECT_TAGS keyword."
608 "Non-nil means activate smart quotes during export.
609 This option can also be set with the OPTIONS keyword,
612 When setting this to non-nil, you need to take care of
613 using the correct Babel package when exporting to LaTeX.
614 E.g., you can load Babel for french like this:
625 When this option is turned on, these strings will be exported as:
627 Org HTML LaTeX UTF-8
628 -----+----------+--------+-------
630 -- – -- –
631 --- — --- —
634 This option can also be set with the OPTIONS keyword,
640 "Non-nil means include statistics cookies in export.
641 This option can also be set with the OPTIONS keyword,
651 If you want to control how Org displays those characters, see
652 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
653 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
654 it is not anymore.
656 When this option is turned on, you can use TeX-like syntax for
657 sub- and superscripts and see them exported correctly.
659 You can also set the option with #+OPTIONS: ^:t
662 single item - so grouping with {} is normally not needed. For
663 example, the following things will be parsed as single sub- or
664 superscripts:
666 10^24 or 10^tau several digits will be considered 1 item.
667 10^-12 or 10^-tau a leading sign with digits or a word
668 x^2-y^3 will be read as x^2 - y^3, because items are
669 terminated by almost any nonword/nondigit char.
670 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
672 Still, ambiguity is possible. So when in doubt, use {} to enclose
673 the sub/superscript. If you set this variable to the symbol `{}',
674 the braces are *required* in order to trigger interpretations as
676 frequently in plain text."
686 "Non-nil means create a table of contents in exported files.
688 The TOC contains headlines with levels up
689 to`org-export-headline-levels'. When an integer, include levels
690 up to N in the toc, this may then be different from
691 `org-export-headline-levels', but it will not be allowed to be
692 larger than the number of headline levels. When nil, no table of
693 contents is made.
695 This option can also be set with the OPTIONS keyword,
704 "Non-nil means export tables.
705 This option can also be set with the OPTIONS keyword,
713 "If nil, do not export tags, just remove them from headlines.
715 If this is the symbol `not-in-toc', tags will be removed from
716 table of contents entries, but still be shown in the headlines of
717 the document.
719 This option can also be set with the OPTIONS keyword,
728 "Non-nil means include TODO items for export.
730 This may have the following values:
731 t include tasks independent of state.
732 `todo' include only tasks that are not yet done.
733 `done' include only tasks that are already done.
734 nil ignore all tasks.
735 list of keywords include tasks with these keywords.
737 This option can also be set with the OPTIONS keyword,
749 "Non-nil means insert a time stamp into the exported file.
750 The time stamp shows when the file was created. This option can
756 "Non nil means allow timestamps in export.
758 It can be set to any of the following values:
759 t export all timestamps.
760 `active' export active timestamps only.
761 `inactive' export inactive timestamps only.
762 nil do not export timestamps
764 This only applies to timestamps isolated in a paragraph
765 containing only timestamps. Other timestamps are always
766 exported.
768 This option can also be set with the OPTIONS keyword, e.g.
778 "Non-nil means include TODO keywords in export.
779 When nil, remove all these keywords from the export. This option
785 "Non-nil means BIND keywords can define local variable values.
786 This is a potential security risk, which is why the default value
787 is nil. You can also allow them through local buffer variables."
794 "Alist between export snippets back-ends and exporter back-ends.
796 This variable allows to provide shortcuts for export snippets.
800 HTML code while every other back-end will ignore it."
809 "Coding system for the exported file."
816 "Non-nil means pushing export output to the kill ring.
817 This variable is ignored during asynchronous export."
827 "The initial scope when exporting with `org-export-dispatch'.
828 This variable can be either set to `buffer' or `subtree'."
835 "Non-nil means show buffer after exporting to temp buffer.
836 When Org exports to a file, the buffer visiting that file is ever
837 shown, but remains buried. However, when exporting to
838 a temporary buffer, that buffer is popped up in a second window.
839 When this variable is nil, the buffer remains buried also in
840 these cases."
845 "Non-nil means export and publishing commands will run in background.
846 Results from an asynchronous export are never displayed
854 "File used to initialize external export process.
856 Value must be either nil or an absolute file name. When nil, the
857 external process is launched like a regular Emacs session,
858 loading user's initialization file and any site specific
859 configuration. If a file is provided, it, and only it, is loaded
860 at start-up.
862 Therefore, using a specific configuration makes the process to
863 load faster and the export more portable."
872 "Non-nil means using a non-intrusive `org-export-dispatch'.
873 In that case, no help buffer is displayed. Though, an indicator
879 asynchronous). Also, \[?] allows to switch back to standard
880 mode."
887 \f
888 ;;; Defining Back-ends
889 ;;
890 ;; An export back-end is a structure with `org-export-backend' type
891 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
892 ;; and `menu' slots.
893 ;;
894 ;; At the lowest level, a back-end is created with
895 ;; `org-export-create-backend' function.
896 ;;
897 ;; A named back-end can be registered with
898 ;; `org-export-register-backend' function. A registered back-end can
899 ;; later be referred to by its name, with `org-export-get-backend'
900 ;; function. Also, such a back-end can become the parent of a derived
901 ;; back-end from which slot values will be inherited by default.
902 ;; `org-export-derived-backend-p' can check if a given back-end is
903 ;; derived from a list of back-end names.
904 ;;
905 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
906 ;; `org-export-get-all-filters' return the full alist of transcoders,
907 ;; options and filters, including those inherited from ancestors.
908 ;;
909 ;; At a higher level, `org-export-define-backend' is the standard way
910 ;; to define an export back-end. If the new back-end is similar to
911 ;; a registered back-end, `org-export-define-derived-backend' may be
912 ;; used instead.
913 ;;
914 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
915 ;; when a given back-end hasn't been registered yet.
919 name parent transcoders options filters blocks menu)
922 "Return export back-end named after NAME.
923 NAME is a symbol. Return nil if no such back-end is found."
930 "Register BACKEND as a known export back-end.
931 BACKEND is a structure with `org-export-backend' type."
932 ;; Refuse to register an unnamed back-end.
935 ;; Refuse to register a back-end with an unknown parent.
939 ;; Register dedicated export blocks in the parser.
943 ;; If a back-end with the same name as BACKEND is already
944 ;; registered, replace it with BACKEND. Otherwise, simply add
945 ;; BACKEND to the list of registered back-ends.
951 "Signal an error if BACKEND isn't defined."
956 "Non-nil if BACKEND is derived from one of BACKENDS.
957 BACKEND is an export back-end, as returned by, e.g.,
958 `org-export-create-backend', or a symbol referring to
959 a registered back-end. BACKENDS is constituted of symbols."
971 "Return full translation table for BACKEND.
973 BACKEND is an export back-end, as return by, e.g,,
974 `org-export-create-backend'. Return value is an alist where
975 keys are element or object types, as symbols, and values are
976 transcoders.
978 Unlike to `org-export-backend-transcoders', this function
979 also returns transcoders inherited from parent back-ends,
980 if any."
984 parent)
989 transcoders)))
992 "Return export options for BACKEND.
994 BACKEND is an export back-end, as return by, e.g,,
995 `org-export-create-backend'. See `org-export-options-alist'
996 for the shape of the return value.
998 Unlike to `org-export-backend-options', this function also
999 returns options inherited from parent back-ends, if any."
1003 parent)
1007 options)))
1010 "Return complete list of filters for BACKEND.
1012 BACKEND is an export back-end, as return by, e.g,,
1013 `org-export-create-backend'. Return value is an alist where
1014 keys are symbols and values lists of functions.
1016 Unlike to `org-export-backend-filters', this function also
1017 returns filters inherited from parent back-ends, if any."
1021 parent)
1025 filters)))
1028 "Define a new back-end BACKEND.
1030 TRANSCODERS is an alist between object or element types and
1031 functions handling them.
1033 These functions should return a string without any trailing
1034 space, or nil. They must accept three arguments: the object or
1035 element itself, its contents or nil when it isn't recursive and
1036 the property list used as a communication channel.
1038 Contents, when not nil, are stripped from any global indentation
1039 \(although the relative one is preserved). They also always end
1040 with a single newline character.
1042 If, for a given type, no function is found, that element or
1043 object type will simply be ignored, along with any blank line or
1044 white space at its end. The same will happen if the function
1045 returns the nil value. If that function returns the empty
1046 string, the type will be ignored, but the blank lines or white
1047 spaces will be kept.
1049 In addition to element and object types, one function can be
1050 associated to the `template' (or `inner-template') symbol and
1051 another one to the `plain-text' symbol.
1053 The former returns the final transcoded string, and can be used
1054 to add a preamble and a postamble to document's body. It must
1055 accept two arguments: the transcoded string and the property list
1056 containing export options. A function associated to `template'
1058 A function associated to `inner-template' is always applied.
1060 The latter, when defined, is to be called on every text not
1061 recognized as an element or an object. It must accept two
1062 arguments: the text string and the information channel. It is an
1063 appropriate place to protect special chars relative to the
1064 back-end.
1066 BODY can start with pre-defined keyword arguments. The following
1067 keywords are understood:
1069 :export-block
1071 String, or list of strings, representing block names that
1072 will not be parsed. This is used to specify blocks that will
1073 contain raw code specific to the back-end. These blocks
1074 still have to be handled by the relative `export-block' type
1075 translator.
1077 :filters-alist
1079 Alist between filters and function, or list of functions,
1080 specific to the back-end. See `org-export-filters-alist' for
1081 a list of all allowed filters. Filters defined here
1082 shouldn't make a back-end test, as it may prevent back-ends
1083 derived from this one to behave properly.
1085 :menu-entry
1087 Menu entry for the export dispatcher. It should be a list
1088 like:
1090 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1092 where :
1094 KEY is a free character selecting the back-end.
1096 DESCRIPTION-OR-ORDINAL is either a string or a number.
1098 If it is a string, is will be used to name the back-end in
1099 its menu entry. If it is a number, the following menu will
1100 be displayed as a sub-menu of the back-end with the same
1101 KEY. Also, the number will be used to determine in which
1102 order such sub-menus will appear (lowest first).
1104 ACTION-OR-MENU is either a function or an alist.
1106 If it is an action, it will be called with four
1107 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1108 BODY-ONLY. See `org-export-as' for further explanations on
1109 some of them.
1111 If it is an alist, associations should follow the
1112 pattern:
1114 '(KEY DESCRIPTION ACTION)
1116 where KEY, DESCRIPTION and ACTION are described above.
1118 Valid values include:
1122 or
1127 \(lambda (a s v b)
1128 \(if a (org-latex-export-to-pdf t s v b)
1129 \(org-open-file
1130 \(org-latex-export-to-pdf nil s v b)))))))
1132 or the following, which will be added to the previous
1133 sub-menu,
1135 '(?l 1
1139 :options-alist
1141 Alist between back-end specific properties introduced in
1142 communication channel and how their value are acquired. See
1143 `org-export-options-alist' for more information about
1144 structure of the values."
1159 :transcoders transcoders
1160 :options options
1161 :filters filters
1162 :blocks blocks
1166 "Create a new back-end as a variant of an existing one.
1168 CHILD is the name of the derived back-end. PARENT is the name of
1169 the parent back-end.
1171 BODY can start with pre-defined keyword arguments. The following
1172 keywords are understood:
1174 :export-block
1176 String, or list of strings, representing block names that
1177 will not be parsed. This is used to specify blocks that will
1178 contain raw code specific to the back-end. These blocks
1179 still have to be handled by the relative `export-block' type
1180 translator.
1182 :filters-alist
1184 Alist of filters that will overwrite or complete filters
1185 defined in PARENT back-end. See `org-export-filters-alist'
1186 for a list of allowed filters.
1188 :menu-entry
1190 Menu entry for the export dispatcher. See
1191 `org-export-define-backend' for more information about the
1192 expected value.
1194 :options-alist
1196 Alist of back-end specific properties that will overwrite or
1197 complete those defined in PARENT back-end. Refer to
1198 `org-export-options-alist' for more information about
1199 structure of the values.
1201 :translate-alist
1203 Alist of element and object types and transcoders that will
1204 overwrite or complete transcode table from PARENT back-end.
1205 Refer to `org-export-define-backend' for detailed information
1206 about transcoders.
1209 as a variant of `latex' back-end with a custom template function:
1211 \(org-export-define-derived-backend 'my-latex 'latex
1212 :translate-alist '((template . my-latex-template-fun)))
1214 The back-end could then be called with, for example:
1232 :parent parent
1233 :transcoders transcoders
1234 :options options
1235 :filters filters
1236 :blocks blocks
1240 \f
1241 ;;; The Communication Channel
1242 ;;
1243 ;; During export process, every function has access to a number of
1244 ;; properties. They are of two types:
1245 ;;
1246 ;; 1. Environment options are collected once at the very beginning of
1247 ;; the process, out of the original buffer and configuration.
1248 ;; Collecting them is handled by `org-export-get-environment'
1249 ;; function.
1250 ;;
1251 ;; Most environment options are defined through the
1252 ;; `org-export-options-alist' variable.
1253 ;;
1254 ;; 2. Tree properties are extracted directly from the parsed tree,
1255 ;; just before export, by `org-export-collect-tree-properties'.
1256 ;;
1257 ;; Here is the full list of properties available during transcode
1258 ;; process, with their category and their value type.
1259 ;;
1260 ;; + `:author' :: Author's name.
1261 ;; - category :: option
1262 ;; - type :: string
1263 ;;
1264 ;; + `:back-end' :: Current back-end used for transcoding.
1265 ;; - category :: tree
1266 ;; - type :: structure
1267 ;;
1268 ;; + `:creator' :: String to write as creation information.
1269 ;; - category :: option
1270 ;; - type :: string
1271 ;;
1272 ;; + `:date' :: String to use as date.
1273 ;; - category :: option
1274 ;; - type :: string
1275 ;;
1276 ;; + `:description' :: Description text for the current data.
1277 ;; - category :: option
1278 ;; - type :: string
1279 ;;
1280 ;; + `:email' :: Author's email.
1281 ;; - category :: option
1282 ;; - type :: string
1283 ;;
1284 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1285 ;; process.
1286 ;; - category :: option
1287 ;; - type :: list of strings
1288 ;;
1289 ;; + `:export-options' :: List of export options available for current
1290 ;; process.
1291 ;; - category :: none
1292 ;; - type :: list of symbols, among `subtree', `body-only' and
1293 ;; `visible-only'.
1294 ;;
1295 ;; + `:exported-data' :: Hash table used for memoizing
1296 ;; `org-export-data'.
1297 ;; - category :: tree
1298 ;; - type :: hash table
1299 ;;
1300 ;; + `:filetags' :: List of global tags for buffer. Used by
1301 ;; `org-export-get-tags' to get tags with inheritance.
1302 ;; - category :: option
1303 ;; - type :: list of strings
1304 ;;
1305 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1306 ;; their definition, as parsed data. Only non-inlined footnotes
1307 ;; are represented in this alist. Also, every definition isn't
1308 ;; guaranteed to be referenced in the parse tree. The purpose of
1309 ;; this property is to preserve definitions from oblivion
1310 ;; (i.e. when the parse tree comes from a part of the original
1311 ;; buffer), it isn't meant for direct use in a back-end. To
1312 ;; retrieve a definition relative to a reference, use
1313 ;; `org-export-get-footnote-definition' instead.
1314 ;; - category :: option
1315 ;; - type :: alist (STRING . LIST)
1316 ;;
1317 ;; + `:headline-levels' :: Maximum level being exported as an
1318 ;; headline. Comparison is done with the relative level of
1319 ;; headlines in the parse tree, not necessarily with their
1320 ;; actual level.
1321 ;; - category :: option
1322 ;; - type :: integer
1323 ;;
1324 ;; + `:headline-offset' :: Difference between relative and real level
1325 ;; of headlines in the parse tree. For example, a value of -1
1326 ;; means a level 2 headline should be considered as level
1327 ;; 1 (cf. `org-export-get-relative-level').
1328 ;; - category :: tree
1329 ;; - type :: integer
1330 ;;
1331 ;; + `:headline-numbering' :: Alist between headlines and their
1332 ;; numbering, as a list of numbers
1333 ;; (cf. `org-export-get-headline-number').
1334 ;; - category :: tree
1335 ;; - type :: alist (INTEGER . LIST)
1336 ;;
1337 ;; + `:id-alist' :: Alist between ID strings and destination file's
1338 ;; path, relative to current directory. It is used by
1339 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1340 ;; external file.
1341 ;; - category :: option
1342 ;; - type :: alist (STRING . STRING)
1343 ;;
1344 ;; + `:ignore-list' :: List of elements and objects that should be
1345 ;; ignored during export.
1346 ;; - category :: tree
1347 ;; - type :: list of elements and objects
1348 ;;
1349 ;; + `:input-file' :: Full path to input file, if any.
1350 ;; - category :: option
1351 ;; - type :: string or nil
1352 ;;
1353 ;; + `:keywords' :: List of keywords attached to data.
1354 ;; - category :: option
1355 ;; - type :: string
1356 ;;
1357 ;; + `:language' :: Default language used for translations.
1358 ;; - category :: option
1359 ;; - type :: string
1360 ;;
1361 ;; + `:output-file' :: Full path to output file, if any.
1362 ;; - category :: option
1363 ;; - type :: string or nil
1364 ;;
1365 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1366 ;; transcoding.
1367 ;; - category :: option
1368 ;; - type :: list (as returned by `org-element-parse-buffer')
1369 ;;
1370 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1371 ;; all line breaks.
1372 ;; - category :: option
1373 ;; - type :: symbol (nil, t)
1374 ;;
1375 ;; + `:section-numbers' :: Non-nil means transcoding should add
1376 ;; section numbers to headlines.
1377 ;; - category :: option
1378 ;; - type :: symbol (nil, t)
1379 ;;
1380 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1381 ;; in transcoding. When such a tag is present, subtrees without
1382 ;; it are de facto excluded from the process. See
1383 ;; `use-select-tags'.
1384 ;; - category :: option
1385 ;; - type :: list of strings
1386 ;;
1387 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1388 ;; a time stamp in the output.
1389 ;; - category :: option
1390 ;; - type :: symbol (nil, t)
1391 ;;
1392 ;; + `:translate-alist' :: Alist between element and object types and
1393 ;; transcoding functions relative to the current back-end.
1394 ;; Special keys `inner-template', `template' and `plain-text' are
1395 ;; also possible.
1396 ;; - category :: option
1397 ;; - type :: alist (SYMBOL . FUNCTION)
1398 ;;
1399 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1400 ;; also be transcoded. If it is set to the `headline' symbol,
1401 ;; only the archived headline's name is retained.
1402 ;; - category :: option
1403 ;; - type :: symbol (nil, t, `headline')
1404 ;;
1405 ;; + `:with-author' :: Non-nil means author's name should be included
1406 ;; in the output.
1407 ;; - category :: option
1408 ;; - type :: symbol (nil, t)
1409 ;;
1410 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1411 ;; - category :: option
1412 ;; - type :: symbol (nil, t)
1413 ;;
1414 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1415 ;; inserted at the end of the transcoded string. If the value
1416 ;; is `comment', it should be commented.
1417 ;; - category :: option
1418 ;; - type :: symbol (`comment', nil, t)
1419 ;;
1420 ;; + `:with-date' :: Non-nil means output should contain a date.
1421 ;; - category :: option
1422 ;; - type :. symbol (nil, t)
1423 ;;
1424 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1425 ;; its value is a list of names, only drawers with such names
1426 ;; will be transcoded. If that list starts with `not', drawer
1427 ;; with these names will be skipped.
1428 ;; - category :: option
1429 ;; - type :: symbol (nil, t) or list of strings
1430 ;;
1431 ;; + `:with-email' :: Non-nil means output should contain author's
1432 ;; email.
1433 ;; - category :: option
1434 ;; - type :: symbol (nil, t)
1435 ;;
1436 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1437 ;; interpreted.
1438 ;; - category :: option
1439 ;; - type :: symbol (nil, t)
1440 ;;
1441 ;; + `:with-fixed-width' :: Non-nil if transcoder should export
1442 ;; strings starting with a colon as a fixed-with (verbatim) area.
1443 ;; - category :: option
1444 ;; - type :: symbol (nil, t)
1445 ;;
1446 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1447 ;; footnotes.
1448 ;; - category :: option
1449 ;; - type :: symbol (nil, t)
1450 ;;
1451 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1452 ;; `latex-fragment' objects should appear in export output. When
1453 ;; this property is set to `verbatim', they will be left as-is.
1454 ;; - category :: option
1455 ;; - type :: symbol (`verbatim', nil, t)
1456 ;;
1457 ;; + `:with-planning' :: Non-nil means transcoding should include
1458 ;; planning info.
1459 ;; - category :: option
1460 ;; - type :: symbol (nil, t)
1461 ;;
1462 ;; + `:with-priority' :: Non-nil means transcoding should include
1463 ;; priority cookies.
1464 ;; - category :: option
1465 ;; - type :: symbol (nil, t)
1466 ;;
1467 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1468 ;; plain text.
1469 ;; - category :: option
1470 ;; - type :: symbol (nil, t)
1471 ;;
1472 ;; + `:with-special-strings' :: Non-nil means transcoding should
1473 ;; interpret special strings in plain text.
1474 ;; - category :: option
1475 ;; - type :: symbol (nil, t)
1476 ;;
1477 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1478 ;; interpret subscript and superscript. With a value of "{}",
1479 ;; only interpret those using curly brackets.
1480 ;; - category :: option
1481 ;; - type :: symbol (nil, {}, t)
1482 ;;
1483 ;; + `:with-tables' :: Non-nil means transcoding should export tables.
1484 ;; - category :: option
1485 ;; - type :: symbol (nil, t)
1486 ;;
1487 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1488 ;; headlines. A `not-in-toc' value will remove them from the
1489 ;; table of contents, if any, nonetheless.
1490 ;; - category :: option
1491 ;; - type :: symbol (nil, t, `not-in-toc')
1492 ;;
1493 ;; + `:with-tasks' :: Non-nil means transcoding should include
1494 ;; headlines with a TODO keyword. A `todo' value will only
1495 ;; include headlines with a todo type keyword while a `done'
1496 ;; value will do the contrary. If a list of strings is provided,
1497 ;; only tasks with keywords belonging to that list will be kept.
1498 ;; - category :: option
1499 ;; - type :: symbol (t, todo, done, nil) or list of strings
1500 ;;
1501 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1502 ;; time stamps. Special value `active' (resp. `inactive') ask to
1503 ;; export only active (resp. inactive) timestamps. Otherwise,
1504 ;; completely remove them.
1505 ;; - category :: option
1506 ;; - type :: symbol: (`active', `inactive', t, nil)
1507 ;;
1508 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1509 ;; added to the output. An integer value limits its depth.
1510 ;; - category :: option
1511 ;; - type :: symbol (nil, t or integer)
1512 ;;
1513 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1514 ;; include TODO keywords.
1515 ;; - category :: option
1516 ;; - type :: symbol (nil, t)
1519 ;;;; Environment Options
1520 ;;
1521 ;; Environment options encompass all parameters defined outside the
1522 ;; scope of the parsed data. They come from five sources, in
1523 ;; increasing precedence order:
1524 ;;
1525 ;; - Global variables,
1526 ;; - Buffer's attributes,
1527 ;; - Options keyword symbols,
1528 ;; - Buffer keywords,
1529 ;; - Subtree properties.
1530 ;;
1531 ;; The central internal function with regards to environment options
1532 ;; is `org-export-get-environment'. It updates global variables with
1533 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1534 ;; the different sources.
1535 ;;
1536 ;; The internal functions doing the retrieval are:
1537 ;; `org-export--get-global-options',
1538 ;; `org-export--get-buffer-attributes',
1539 ;; `org-export--parse-option-keyword',
1540 ;; `org-export--get-subtree-options' and
1541 ;; `org-export--get-inbuffer-options'
1542 ;;
1543 ;; Also, `org-export--list-bound-variables' collects bound variables
1544 ;; along with their value in order to set them as buffer local
1545 ;; variables later in the process.
1548 "Collect export options from the current buffer.
1550 Optional argument BACKEND is an export back-end, as returned by
1551 `org-export-create-backend'.
1553 When optional argument SUBTREEP is non-nil, assume the export is
1554 done against the current sub-tree.
1556 Third optional argument EXT-PLIST is a property list with
1557 external parameters overriding Org default settings, but still
1558 inferior to file-local settings."
1559 ;; First install #+BIND variables since these must be set before
1560 ;; global options are read.
1563 ;; Get and prioritize export options...
1565 ;; ... from global variables...
1567 ;; ... from an external property list...
1568 ext-plist
1569 ;; ... from in-buffer settings...
1571 ;; ... and from subtree, when appropriate.
1573 ;; Eventually add misc. properties.
1575 :back-end
1576 backend
1578 :footnote-definition-alist
1579 ;; Footnotes definitions must be collected in the original
1580 ;; buffer, as there's no insurance that they will still be in
1581 ;; the parse tree, due to possible narrowing.
1597 alist))
1609 alist)))))))
1610 alist))
1611 :id-alist
1612 ;; Collect id references.
1623 alist))))
1626 "Parse an OPTIONS line and return values as a plist.
1627 Optional argument BACKEND is an export back-end, as returned by,
1628 e.g., `org-export-create-backend'. It specifies which back-end
1629 specific items to read, if any."
1631 ;; Priority is given to back-end specific options.
1633 org-export-options-alist))
1634 plist)
1643 options))
1645 property
1648 plist))
1651 "Get export options in subtree at point.
1652 Optional argument BACKEND is an export back-end, as returned by,
1653 e.g., `org-export-create-backend'. It specifies back-end used
1654 for export. Return options as a plist."
1655 ;; For each buffer keyword, create a headline property setting the
1656 ;; same property in communication channel. The name for the property
1657 ;; is the keyword with "EXPORT_" appended to it.
1660 ;; Make sure point is at a heading.
1662 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1663 ;; title (with no todo keyword, priority cookie or tag) as its
1664 ;; fallback value.
1670 plist :title
1673 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1677 ;; Handle other keywords. TITLE keyword is excluded as it has
1678 ;; been handled already.
1686 ;; Export properties are not case-sensitive.
1693 plist
1694 property
1696 ;; Parse VALUE if required.
1700 ;; If BEHAVIOR is `split' expected value is
1701 ;; a list of strings, not a string.
1704 ;; Look for both general keywords and back-end specific
1705 ;; options, with priority given to the latter.
1707 org-export-options-alist)))
1708 ;; Return value.
1709 plist)))
1712 "Return current buffer export options, as a plist.
1714 Optional argument BACKEND, when non-nil, is an export back-end,
1715 as returned by, e.g., `org-export-create-backend'. It specifies
1716 which back-end specific options should also be read in the
1717 process.
1719 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1721 get-options ; For byte-compiler.
1724 ;; Priority is given to back-end specific options.
1726 org-export-options-alist))
1729 org-export-special-keywords))))
1732 ;; Return all properties associated to KEYWORD.
1739 ;; Recursively read keywords in buffer. FILES is a list
1740 ;; of files read so far. PLIST is the current property
1741 ;; list obtained.
1750 ;; Options in `org-export-special-keywords'.
1754 ;; Avoid circular dependencies.
1764 plist
1769 plist
1775 ;; Options in `org-export-options-alist'.
1780 plist property
1781 ;; Handle value depending on specified
1782 ;; BEHAVIOR.
1788 " "
1801 ;; Return final value.
1802 plist))))
1803 ;; Read options in the current buffer.
1806 ;; Parse keywords specified in `org-element-document-properties'
1807 ;; and return PLIST.
1818 "Return properties related to buffer attributes, as a plist."
1819 ;; Store full path of input file name, or nil. For internal use.
1823 "Return global export options as a plist.
1824 Optional argument BACKEND, if non-nil, is an export back-end, as
1825 returned by, e.g., `org-export-create-backend'. It specifies
1826 which back-end specific export options should also be read in the
1827 process."
1829 ;; Priority is given to back-end specific options.
1831 org-export-options-alist)))
1837 plist
1838 prop
1839 ;; Evaluate default value provided. If keyword is
1840 ;; a member of `org-element-document-properties',
1841 ;; parse it as a secondary string before storing it.
1845 org-element-document-properties))
1848 value)))))))))
1851 "Return variables bound from BIND keywords in current buffer.
1852 Also look for BIND keywords in setup files. The return value is
1853 an alist where associations are (VARIABLE-NAME VALUE)."
1858 ;; Return an alist between variable names and their
1859 ;; value. FILES is a list of setup files names read so
1860 ;; far, used to avoid circular dependencies. ALIST is
1861 ;; the alist collected so far.
1872 ;; Enter setup file.
1882 alist))))))))))
1883 alist)))))
1884 ;; Return value in appropriate order of appearance.
1887 ;; defsubst org-export-get-parent must be defined before first use,
1888 ;; was originally defined in the topology section
1891 "Return BLOB parent or nil.
1892 BLOB is the element or object considered."
1895 ;;;; Tree Properties
1896 ;;
1897 ;; Tree properties are information extracted from parse tree. They
1898 ;; are initialized at the beginning of the transcoding process by
1899 ;; `org-export-collect-tree-properties'.
1900 ;;
1901 ;; Dedicated functions focus on computing the value of specific tree
1902 ;; properties during initialization. Thus,
1903 ;; `org-export--populate-ignore-list' lists elements and objects that
1904 ;; should be skipped during export, `org-export--get-min-level' gets
1905 ;; the minimal exportable level, used as a basis to compute relative
1906 ;; level for headlines. Eventually
1907 ;; `org-export--collect-headline-numbering' builds an alist between
1908 ;; headlines and their numbering.
1911 "Extract tree properties from parse tree.
1913 DATA is the parse tree from which information is retrieved. INFO
1914 is a list holding export options.
1916 Following tree properties are set or updated:
1918 `:exported-data' Hash table used to memoize results from
1919 `org-export-data'.
1921 `:footnote-definition-alist' List of footnotes definitions in
1922 original buffer and current parse tree.
1924 `:headline-offset' Offset between true level of headlines and
1925 local level. An offset of -1 means a headline
1926 of level 2 should be considered as a level
1927 1 headline in the context.
1929 `:headline-numbering' Alist of all headlines as key an the
1930 associated numbering as value.
1932 `:ignore-list' List of elements that should be ignored during
1933 export.
1935 Return updated plist."
1936 ;; Install the parse tree in the communication channel, in order to
1937 ;; use `org-export-get-genealogy' and al.
1939 ;; Get the list of elements and objects to ignore, and put it into
1940 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1941 ;; been done during parse tree filtering.
1944 :ignore-list
1947 ;; Compute `:headline-offset' in order to be able to use
1948 ;; `org-export-get-relative-level'.
1951 :headline-offset
1953 ;; Footnote definitions in parse tree override those stored in
1954 ;; `:footnote-definition-alist'. This way, any change to
1955 ;; a definition in the parse tree (e.g., through a parse tree
1956 ;; filter) propagates into the alist.
1963 defs))
1967 defs)))))
1969 ;; Properties order doesn't matter: get the rest of the tree
1970 ;; properties.
1974 info))
1977 "Return minimum exportable headline's level in DATA.
1978 DATA is parsed tree as returned by `org-element-parse-buffer'.
1979 OPTIONS is a plist holding export options."
1990 ;; If no headline was found, for the sake of consistency, set
1991 ;; minimum level to 1 nonetheless.
1995 "Return numbering of all exportable headlines in a parse tree.
1997 DATA is the parse tree. OPTIONS is the plist holding export
1998 options.
2000 Return an alist whose key is a headline and value is its
2001 associated numbering \(in the shape of a list of numbers\) or nil
2002 for a footnotes section."
2010 headline
2012 for idx from 0 to org-export-max-depth
2016 options)))
2019 "Return list of elements and objects to ignore during export.
2020 DATA is the parse tree to traverse. OPTIONS is the plist holding
2021 export options."
2023 ;; First find trees containing a select tag, if any.
2025 ;; If a select tag is active, also ignore the section before
2026 ;; the first headline, if any.
2030 first-element))))
2033 ;; Collect ignored elements or objects into IGNORE-LIST.
2039 ;; If headline is archived but tree below has
2040 ;; to be skipped, add it to ignore list.
2043 ;; Move into secondary string, if any.
2048 ;; Move into recursive objects/elements.
2050 ;; Main call.
2052 ;; Return value.
2053 ignore))
2056 "Return list of headlines and inlinetasks with a select tag in their tree.
2057 DATA is parsed data as returned by `org-element-parse-buffer'.
2058 INFO is a plist holding export options."
2060 walk-data ; For byte-compiler.
2070 ;; When a select tag is found, mark full
2071 ;; genealogy and every headline within the tree
2072 ;; as acceptable.
2075 genealogy
2078 selected-trees))
2079 ;; If at a headline, continue searching in tree,
2080 ;; recursively.
2090 selected-trees))
2093 "Non-nil when element or object BLOB should be skipped during export.
2094 OPTIONS is the plist holding export options. SELECTED, when
2095 non-nil, is a list of headlines or inlinetasks belonging to
2096 a tree with a select tag."
2103 ;; If `:with-drawers' value starts with `not', ignore
2104 ;; every drawer whose name belong to that list.
2105 ;; Otherwise, ignore drawers whose name isn't in that
2106 ;; list.
2123 ;; Ignore subtrees with an exclude tag.
2126 ;; When a select tag is present in the buffer, ignore any tree
2127 ;; without it.
2129 ;; Ignore commented sub-trees.
2131 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2133 ;; Ignore tasks, if specified by `:with-tasks' property.
2145 properties-set))))))
2156 ;; `:with-timestamps' only applies to isolated timestamps
2157 ;; objects, i.e. timestamp objects in a paragraph containing only
2158 ;; timestamps and whitespaces.
2166 options t))))
2175 \f
2176 ;;; The Transcoder
2177 ;;
2178 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2179 ;; `org-element-parse-buffer') and transcodes it into a specified
2180 ;; back-end output. It takes care of filtering out elements or
2181 ;; objects according to export options and organizing the output blank
2182 ;; lines and white space are preserved. The function memoizes its
2183 ;; results, so it is cheap to call it within transcoders.
2184 ;;
2185 ;; It is possible to modify locally the back-end used by
2186 ;; `org-export-data' or even use a temporary back-end by using
2187 ;; `org-export-data-with-backend'.
2188 ;;
2189 ;; Internally, three functions handle the filtering of objects and
2190 ;; elements during the export. In particular,
2191 ;; `org-export-ignore-element' marks an element or object so future
2192 ;; parse tree traversals skip it and `org-export-expand' transforms
2193 ;; the others back into their original shape.
2194 ;;
2195 ;; `org-export-transcoder' is an accessor returning appropriate
2196 ;; translator function for a given element or object.
2199 "Return appropriate transcoder for BLOB.
2200 INFO is a plist containing export directives."
2202 ;; Return contents only for complete parse trees.
2208 "Convert DATA into current back-end format.
2210 DATA is a parse tree, an element or an object or a secondary
2211 string. INFO is a plist holding export options.
2213 Return a string."
2218 ;; Ignored element/object.
2220 ;; Plain text.
2226 info))
2227 ;; Secondary string.
2230 ;; Element/Object without contents or, as a special
2231 ;; case, headline with archive tag and archived trees
2232 ;; restricted to title only.
2240 ;; Export snippets never return a nil value so
2241 ;; that white spaces following them are never
2242 ;; ignored.
2244 ;; Element/Object with contents.
2257 ;; Elements directly containing
2258 ;; objects must have their indentation
2259 ;; normalized first.
2261 data
2262 ;; When normalizing contents of the
2263 ;; first paragraph in an item or
2264 ;; a footnote definition, ignore
2265 ;; first line's indentation: there is
2266 ;; none and it might be misleading.
2271 data)
2278 info))))))))
2279 ;; Final result will be memoized before being returned.
2281 data
2285 ;; Append the same white space between elements or objects
2286 ;; as in the original buffer, and call appropriate filters.
2297 info)))
2298 results)))
2302 "Convert DATA into BACKEND format.
2304 DATA is an element, an object, a secondary string or a string.
2305 BACKEND is a symbol. INFO is a plist used as a communication
2306 channel.
2308 Unlike to `org-export-with-backend', this function will
2309 recursively convert DATA using BACKEND translation table."
2312 data
2313 ;; Set-up a new communication channel with translations defined in
2314 ;; BACKEND as the translate table and a new hash table for
2315 ;; memoization.
2317 info
2320 ;; Size of the hash table is reduced since this function
2321 ;; will probably be used on small trees.
2325 "Change uninterpreted elements back into Org syntax.
2326 DATA is the parse tree. INFO is a plist containing export
2327 options. Each uninterpreted element or object is changed back
2328 into a string. Contents, if any, are not modified. The parse
2329 tree is modified by side effect and returned by the function."
2333 prop
2336 info))))
2339 "Change uninterpreted elements back into Org syntax.
2340 DATA is a parse tree or a secondary string. INFO is a plist
2341 containing export options. It is modified by side effect and
2342 returned by the function."
2345 subscript superscript underline)
2349 ;; ... entities...
2356 ?\s)))))
2357 ;; ... emphasis...
2369 marker
2373 ?\s)))))))
2374 ;; ... LaTeX environments and fragments...
2378 ;; ... sub/superscripts...
2387 "_"
2396 ?\s)))))))))))
2398 ;; Splice NEW at BLOB location in parse tree.
2401 info)
2402 ;; Return modified parse tree.
2403 data)
2406 "Expand a parsed element or object to its original state.
2408 BLOB is either an element or an object. CONTENTS is its
2409 contents, as a string or nil.
2411 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2412 keywords before output."
2417 blob contents))))
2420 "Add ELEMENT to `:ignore-list' in INFO.
2422 Any element in `:ignore-list' will be skipped when using
2423 `org-element-map'. INFO is modified by side effects."
2427 \f
2428 ;;; The Filter System
2429 ;;
2430 ;; Filters allow end-users to tweak easily the transcoded output.
2431 ;; They are the functional counterpart of hooks, as every filter in
2432 ;; a set is applied to the return value of the previous one.
2433 ;;
2434 ;; Every set is back-end agnostic. Although, a filter is always
2435 ;; called, in addition to the string it applies to, with the back-end
2436 ;; used as argument, so it's easy for the end-user to add back-end
2437 ;; specific filters in the set. The communication channel, as
2438 ;; a plist, is required as the third argument.
2439 ;;
2440 ;; From the developer side, filters sets can be installed in the
2441 ;; process with the help of `org-export-define-backend', which
2442 ;; internally stores filters as an alist. Each association has a key
2443 ;; among the following symbols and a function or a list of functions
2444 ;; as value.
2445 ;;
2446 ;; - `:filter-options' applies to the property list containing export
2447 ;; options. Unlike to other filters, functions in this list accept
2448 ;; two arguments instead of three: the property list containing
2449 ;; export options and the back-end. Users can set its value through
2450 ;; `org-export-filter-options-functions' variable.
2451 ;;
2452 ;; - `:filter-parse-tree' applies directly to the complete parsed
2453 ;; tree. Users can set it through
2454 ;; `org-export-filter-parse-tree-functions' variable.
2455 ;;
2456 ;; - `:filter-body' applies to the body of the output, before template
2457 ;; translator chimes in. Users can set it through
2458 ;; `org-export-filter-body-functions' variable.
2459 ;;
2460 ;; - `:filter-final-output' applies to the final transcoded string.
2461 ;; Users can set it with `org-export-filter-final-output-functions'
2462 ;; variable.
2463 ;;
2464 ;; - `:filter-plain-text' applies to any string not recognized as Org
2465 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2466 ;; configure it.
2467 ;;
2468 ;; - `:filter-TYPE' applies on the string returned after an element or
2469 ;; object of type TYPE has been transcoded. A user can modify
2470 ;; `org-export-filter-TYPE-functions' to install these filters.
2471 ;;
2472 ;; All filters sets are applied with
2473 ;; `org-export-filter-apply-functions' function. Filters in a set are
2474 ;; applied in a LIFO fashion. It allows developers to be sure that
2475 ;; their filters will be applied first.
2476 ;;
2477 ;; Filters properties are installed in communication channel with
2478 ;; `org-export-install-filters' function.
2479 ;;
2480 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2481 ;; `org-export-before-parsing-hook') are run at the beginning of the
2482 ;; export process and just before parsing to allow for heavy structure
2483 ;; modifications.
2486 ;;;; Hooks
2489 "Hook run at the beginning of the export process.
2491 This is run before include keywords and macros are expanded and
2492 Babel code blocks executed, on a copy of the original buffer
2493 being exported. Visibility and narrowing are preserved. Point
2494 is at the beginning of the buffer.
2496 Every function in this hook will be called with one argument: the
2500 "Hook run before parsing an export buffer.
2502 This is run after include keywords and macros have been expanded
2503 and Babel code blocks executed, on a copy of the original buffer
2504 being exported. Visibility and narrowing are preserved. Point
2505 is at the beginning of the buffer.
2507 Every function in this hook will be called with one argument: the
2511 ;;;; Special Filters
2514 "List of functions applied to the export options.
2515 Each filter is called with two arguments: the export options, as
2516 a plist, and the back-end, as a symbol. It must return
2520 "List of functions applied to the parsed tree.
2521 Each filter is called with three arguments: the parse tree, as
2522 returned by `org-element-parse-buffer', the back-end, as
2523 a symbol, and the communication channel, as a plist. It must
2527 "List of functions applied to plain text.
2528 Each filter is called with three arguments: a string which
2529 contains no Org syntax, the back-end, as a symbol, and the
2530 communication channel, as a plist. It must return a string or
2534 "List of functions applied to transcoded body.
2535 Each filter is called with three arguments: a string which
2536 contains no Org syntax, the back-end, as a symbol, and the
2537 communication channel, as a plist. It must return a string or
2541 "List of functions applied to the transcoded string.
2542 Each filter is called with three arguments: the full transcoded
2543 string, the back-end, as a symbol, and the communication channel,
2544 as a plist. It must return a string that will be used as the
2548 ;;;; Elements Filters
2551 "List of functions applied to a transcoded babel-call.
2552 Each filter is called with three arguments: the transcoded data,
2553 as a string, the back-end, as a symbol, and the communication
2557 "List of functions applied to a transcoded center block.
2558 Each filter is called with three arguments: the transcoded data,
2559 as a string, the back-end, as a symbol, and the communication
2563 "List of functions applied to a transcoded clock.
2564 Each filter is called with three arguments: the transcoded data,
2565 as a string, the back-end, as a symbol, and the communication
2569 "List of functions applied to a transcoded comment.
2570 Each filter is called with three arguments: the transcoded data,
2571 as a string, the back-end, as a symbol, and the communication
2575 "List of functions applied to a transcoded comment-block.
2576 Each filter is called with three arguments: the transcoded data,
2577 as a string, the back-end, as a symbol, and the communication
2581 "List of functions applied to a transcoded diary-sexp.
2582 Each filter is called with three arguments: the transcoded data,
2583 as a string, the back-end, as a symbol, and the communication
2587 "List of functions applied to a transcoded drawer.
2588 Each filter is called with three arguments: the transcoded data,
2589 as a string, the back-end, as a symbol, and the communication
2593 "List of functions applied to a transcoded dynamic-block.
2594 Each filter is called with three arguments: the transcoded data,
2595 as a string, the back-end, as a symbol, and the communication
2599 "List of functions applied to a transcoded example-block.
2600 Each filter is called with three arguments: the transcoded data,
2601 as a string, the back-end, as a symbol, and the communication
2605 "List of functions applied to a transcoded export-block.
2606 Each filter is called with three arguments: the transcoded data,
2607 as a string, the back-end, as a symbol, and the communication
2611 "List of functions applied to a transcoded fixed-width.
2612 Each filter is called with three arguments: the transcoded data,
2613 as a string, the back-end, as a symbol, and the communication
2617 "List of functions applied to a transcoded footnote-definition.
2618 Each filter is called with three arguments: the transcoded data,
2619 as a string, the back-end, as a symbol, and the communication
2623 "List of functions applied to a transcoded headline.
2624 Each filter is called with three arguments: the transcoded data,
2625 as a string, the back-end, as a symbol, and the communication
2629 "List of functions applied to a transcoded horizontal-rule.
2630 Each filter is called with three arguments: the transcoded data,
2631 as a string, the back-end, as a symbol, and the communication
2635 "List of functions applied to a transcoded inlinetask.
2636 Each filter is called with three arguments: the transcoded data,
2637 as a string, the back-end, as a symbol, and the communication
2641 "List of functions applied to a transcoded item.
2642 Each filter is called with three arguments: the transcoded data,
2643 as a string, the back-end, as a symbol, and the communication
2647 "List of functions applied to a transcoded keyword.
2648 Each filter is called with three arguments: the transcoded data,
2649 as a string, the back-end, as a symbol, and the communication
2653 "List of functions applied to a transcoded latex-environment.
2654 Each filter is called with three arguments: the transcoded data,
2655 as a string, the back-end, as a symbol, and the communication
2659 "List of functions applied to a transcoded node-property.
2660 Each filter is called with three arguments: the transcoded data,
2661 as a string, the back-end, as a symbol, and the communication
2665 "List of functions applied to a transcoded paragraph.
2666 Each filter is called with three arguments: the transcoded data,
2667 as a string, the back-end, as a symbol, and the communication
2671 "List of functions applied to a transcoded plain-list.
2672 Each filter is called with three arguments: the transcoded data,
2673 as a string, the back-end, as a symbol, and the communication
2677 "List of functions applied to a transcoded planning.
2678 Each filter is called with three arguments: the transcoded data,
2679 as a string, the back-end, as a symbol, and the communication
2683 "List of functions applied to a transcoded property-drawer.
2684 Each filter is called with three arguments: the transcoded data,
2685 as a string, the back-end, as a symbol, and the communication
2689 "List of functions applied to a transcoded quote block.
2690 Each filter is called with three arguments: the transcoded quote
2691 data, as a string, the back-end, as a symbol, and the
2692 communication channel, as a plist. It must return a string or
2696 "List of functions applied to a transcoded section.
2697 Each filter is called with three arguments: the transcoded data,
2698 as a string, the back-end, as a symbol, and the communication
2702 "List of functions applied to a transcoded special block.
2703 Each filter is called with three arguments: the transcoded data,
2704 as a string, the back-end, as a symbol, and the communication
2708 "List of functions applied to a transcoded src-block.
2709 Each filter is called with three arguments: the transcoded data,
2710 as a string, the back-end, as a symbol, and the communication
2714 "List of functions applied to a transcoded table.
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 a transcoded table-cell.
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 table-row.
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 verse block.
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 ;;;; Objects Filters
2741 "List of functions applied to transcoded bold text.
2742 Each filter is called with three arguments: the transcoded data,
2743 as a string, the back-end, as a symbol, and the communication
2747 "List of functions applied to transcoded code text.
2748 Each filter is called with three arguments: the transcoded data,
2749 as a string, the back-end, as a symbol, and the communication
2753 "List of functions applied to a transcoded entity.
2754 Each filter is called with three arguments: the transcoded data,
2755 as a string, the back-end, as a symbol, and the communication
2759 "List of functions applied to a transcoded export-snippet.
2760 Each filter is called with three arguments: the transcoded data,
2761 as a string, the back-end, as a symbol, and the communication
2765 "List of functions applied to a transcoded footnote-reference.
2766 Each filter is called with three arguments: the transcoded data,
2767 as a string, the back-end, as a symbol, and the communication
2771 "List of functions applied to a transcoded inline-babel-call.
2772 Each filter is called with three arguments: the transcoded data,
2773 as a string, the back-end, as a symbol, and the communication
2777 "List of functions applied to a transcoded inline-src-block.
2778 Each filter is called with three arguments: the transcoded data,
2779 as a string, the back-end, as a symbol, and the communication
2783 "List of functions applied to transcoded italic text.
2784 Each filter is called with three arguments: the transcoded data,
2785 as a string, the back-end, as a symbol, and the communication
2789 "List of functions applied to a transcoded latex-fragment.
2790 Each filter is called with three arguments: the transcoded data,
2791 as a string, the back-end, as a symbol, and the communication
2795 "List of functions applied to a transcoded line-break.
2796 Each filter is called with three arguments: the transcoded data,
2797 as a string, the back-end, as a symbol, and the communication
2801 "List of functions applied to a transcoded link.
2802 Each filter is called with three arguments: the transcoded data,
2803 as a string, the back-end, as a symbol, and the communication
2807 "List of functions applied to a transcoded radio-target.
2808 Each filter is called with three arguments: the transcoded data,
2809 as a string, the back-end, as a symbol, and the communication
2813 "List of functions applied to a transcoded statistics-cookie.
2814 Each filter is called with three arguments: the transcoded data,
2815 as a string, the back-end, as a symbol, and the communication
2819 "List of functions applied to transcoded strike-through text.
2820 Each filter is called with three arguments: the transcoded data,
2821 as a string, the back-end, as a symbol, and the communication
2825 "List of functions applied to a transcoded subscript.
2826 Each filter is called with three arguments: the transcoded data,
2827 as a string, the back-end, as a symbol, and the communication
2831 "List of functions applied to a transcoded superscript.
2832 Each filter is called with three arguments: the transcoded data,
2833 as a string, the back-end, as a symbol, and the communication
2837 "List of functions applied to a transcoded target.
2838 Each filter is called with three arguments: the transcoded data,
2839 as a string, the back-end, as a symbol, and the communication
2843 "List of functions applied to a transcoded timestamp.
2844 Each filter is called with three arguments: the transcoded data,
2845 as a string, the back-end, as a symbol, and the communication
2849 "List of functions applied to transcoded underline text.
2850 Each filter is called with three arguments: the transcoded data,
2851 as a string, the back-end, as a symbol, and the communication
2855 "List of functions applied to transcoded verbatim text.
2856 Each filter is called with three arguments: the transcoded data,
2857 as a string, the back-end, as a symbol, and the communication
2861 ;;;; Filters Tools
2862 ;;
2863 ;; Internal function `org-export-install-filters' installs filters
2864 ;; hard-coded in back-ends (developer filters) and filters from global
2865 ;; variables (user filters) in the communication channel.
2866 ;;
2867 ;; Internal function `org-export-filter-apply-functions' takes care
2868 ;; about applying each filter in order to a given data. It ignores
2869 ;; filters returning a nil value but stops whenever a filter returns
2870 ;; an empty string.
2873 "Call every function in FILTERS.
2875 Functions are called with arguments VALUE, current export
2876 back-end's name and INFO. A function returning a nil value will
2877 be skipped. If it returns the empty string, the process ends and
2878 VALUE is ignored.
2880 Call is done in a LIFO fashion, to be sure that developer
2881 specified filters, if any, are called first."
2892 "Install filters properties in communication channel.
2893 INFO is a plist containing the current communication channel.
2894 Return the updated communication channel."
2896 ;; Install user-defined filters with `org-export-filters-alist'
2897 ;; and filters already in INFO (through ext-plist mechanism).
2904 ;; Filters in INFO will be called
2905 ;; before those user provided.
2908 default-value)))))
2909 org-export-filters-alist)
2910 ;; Prepend back-end specific filters to that list.
2912 ;; Single values get consed, lists are appended.
2917 plist key
2921 ;; Return new communication channel.
2925 \f
2926 ;;; Core functions
2927 ;;
2928 ;; This is the room for the main function, `org-export-as', along with
2929 ;; its derivative, `org-export-string-as'.
2930 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2931 ;; function should be added to kill ring.
2932 ;;
2933 ;; Note that `org-export-as' doesn't really parse the current buffer,
2934 ;; but a copy of it (with the same buffer-local variables and
2935 ;; visibility), where macros and include keywords are expanded and
2936 ;; Babel blocks are executed, if appropriate.
2937 ;; `org-export-with-buffer-copy' macro prepares that copy.
2938 ;;
2939 ;; File inclusion is taken care of by
2940 ;; `org-export-expand-include-keyword' and
2941 ;; `org-export--prepare-file-contents'. Structure wise, including
2942 ;; a whole Org file in a buffer often makes little sense. For
2943 ;; example, if the file contains a headline and the include keyword
2944 ;; was within an item, the item should contain the headline. That's
2945 ;; why file inclusion should be done before any structure can be
2946 ;; associated to the file, that is before parsing.
2947 ;;
2948 ;; `org-export-insert-default-template' is a command to insert
2949 ;; a default template (or a back-end specific template) at point or in
2950 ;; current subtree.
2953 "Return a copy of the current buffer.
2954 The copy preserves Org buffer-local variables, visibility and
2955 narrowing."
2961 new-buf))
2964 "Apply BODY in a copy of the current buffer.
2965 The copy preserves local variables, visibility and contents of
2966 the original buffer. Point is at the beginning of the buffer
2967 when BODY is applied."
2976 ;; Kill copy without confirmation.
2982 "Generate a function duplicating BUFFER.
2984 The copy will preserve local variables, visibility, contents and
2985 narrowing of the original buffer. If a region was active in
2986 BUFFER, contents will be narrowed to that region instead.
2988 The resulting function can be evaluated at a later time, from
2989 another buffer, effectively cloning the original buffer there.
2991 The function assumes BUFFER's major mode is `org-mode'."
2995 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2996 ;; already in BUFFER.
2998 ;; Copy specific buffer local variables and variables set
2999 ;; through BIND keywords.
3001 vars)
3009 buffer-file-name
3010 buffer-file-coding-system))
3014 ;; Skip unreadable values, as they cannot be
3015 ;; sent to external process.
3019 vars))))))
3020 ;; Whole buffer contents.
3025 ;; Narrowing.
3029 ;; Current position of point.
3031 ;; Overlays with invisible property.
3041 ov-set))))
3043 ov-set)))))
3045 ;;;###autoload
3048 "Transcode current Org buffer into BACKEND code.
3050 BACKEND is either an export back-end, as returned by, e.g.,
3051 `org-export-create-backend', or a symbol referring to
3052 a registered back-end.
3054 If narrowing is active in the current buffer, only transcode its
3055 narrowed part.
3057 If a region is active, transcode that region.
3059 When optional argument SUBTREEP is non-nil, transcode the
3060 sub-tree at point, extracting information from the headline
3061 properties first.
3063 When optional argument VISIBLE-ONLY is non-nil, don't export
3064 contents of hidden elements.
3066 When optional argument BODY-ONLY is non-nil, only return body
3067 code, without surrounding template.
3069 Optional argument EXT-PLIST, when provided, is a property list
3070 with external parameters overriding Org default settings, but
3071 still inferior to file-local settings.
3073 Return code as a string."
3078 ;; Narrow buffer to an appropriate region or subtree for
3079 ;; parsing. If parsing subtree, be sure to remove main headline
3080 ;; too.
3088 ;; Initialize communication channel with original buffer
3089 ;; attributes, unavailable in its copy.
3098 tree)
3099 ;; Update communication channel and get parse tree. Buffer
3100 ;; isn't parsed directly. Instead, a temporary copy is
3101 ;; created, where include keywords, macros are expanded and
3102 ;; code blocks are evaluated.
3104 ;; Run first hook with current back-end's name as argument.
3108 ;; Update macro templates since #+INCLUDE keywords might have
3109 ;; added some new ones.
3113 ;; Update radio targets since keyword inclusion might have
3114 ;; added some more.
3116 ;; Run last hook with current back-end's name as argument.
3121 ;; Update communication channel with environment. Also
3122 ;; install user's and developer's filters.
3127 ;; Expand export-specific set of macros: {{{author}}},
3128 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3129 ;; once regular macros have been expanded, since document
3130 ;; keywords may contain one of them.
3136 ;; EMAIL is not a parsed keyword: store it as-is.
3140 ;; Parse buffer.
3142 ;; Handle left-over uninterpreted elements or objects in
3143 ;; parse tree and communication channel.
3145 ;; Call options filters and update export options. We do not
3146 ;; use `org-export-filter-apply-functions' here since the
3147 ;; arity of such filters is different.
3152 ;; Parse buffer, handle uninterpreted elements or objects,
3153 ;; then call parse-tree filters.
3157 ;; Now tree is complete, compute its properties and add them
3158 ;; to communication channel.
3162 ;; Eventually transcode TREE. Wrap the resulting string into
3163 ;; a template.
3172 info))
3175 ;; Remove all text properties since they cannot be
3176 ;; retrieved from an external process. Finally call
3177 ;; final-output filter and return result.
3183 info))))))))
3185 ;;;###autoload
3187 "Transcode STRING into BACKEND code.
3189 BACKEND is either an export back-end, as returned by, e.g.,
3190 `org-export-create-backend', or a symbol referring to
3191 a registered back-end.
3193 When optional argument BODY-ONLY is non-nil, only return body
3194 code, without preamble nor postamble.
3196 Optional argument EXT-PLIST, when provided, is a property list
3197 with external parameters overriding Org default settings, but
3198 still inferior to file-local settings.
3200 Return code as a string."
3206 ;;;###autoload
3208 "Replace the active region by its export to BACKEND.
3209 BACKEND is either an export back-end, as returned by, e.g.,
3210 `org-export-create-backend', or a symbol referring to
3211 a registered back-end."
3221 ;;;###autoload
3223 "Insert all export keywords with default values at beginning of line.
3225 BACKEND is a symbol referring to the name of a registered export
3226 back-end, for which specific export options should be added to
3227 the template, or `default' for default template. When it is nil,
3228 the user will be prompted for a category.
3230 If SUBTREEP is non-nil, export configuration will be set up
3231 locally for the subtree through node properties."
3241 "Options category: "
3245 org-export--registered-backends))
3246 nil t))))
3247 options keywords)
3248 ;; Populate OPTIONS and KEYWORDS.
3265 ;; Move to an appropriate location in order to insert options.
3267 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3285 ;; Then the rest of keywords, in the order specified in either
3286 ;; `org-export-options-alist' or respective export back-ends.
3307 "Expand every include keyword in buffer.
3308 Optional argument INCLUDED is a list of included file names along
3309 with their line restriction, when appropriate. It is used to
3310 avoid infinite recursion. Optional argument DIR is the current
3311 working directory. It is used to properly resolve relative
3312 paths."
3321 ;; Extract arguments from keyword's value.
3329 dir)
3334 value)
3341 ;; Minimal level of included file defaults to the child
3342 ;; level of the current headline, if any, or one. It
3343 ;; only applies is the file is meant to be included as
3344 ;; an Org one.
3356 ;; Remove keyword.
3362 ;; Check if files has already been parsed. Look after
3363 ;; inclusion lines too, as different parts of the same file
3364 ;; can be included too.
3379 ind-str block arg-str contents ind-str block))))
3386 ind-str block contents ind-str block))))
3393 file lines ind minlevel
3402 "Prepare the contents of FILE for inclusion and return them as a string.
3404 When optional argument LINES is a string specifying a range of
3405 lines, include only those lines.
3407 Optional argument IND, when non-nil, is an integer specifying the
3408 global indentation of returned contents. Since its purpose is to
3409 allow an included file to stay in the same environment it was
3410 created \(i.e. a list item), it doesn't apply past the first
3411 headline encountered.
3413 Optional argument MINLEVEL, when non-nil, is an integer
3414 specifying the level that any top-level headline in the included
3415 file should have.
3417 Optional argument ID is an integer that will be inserted before
3418 each footnote definition and reference if FILE is an Org file.
3419 This is useful to avoid conflicts when more than one Org file
3420 with footnotes is included in a document."
3436 ;; Remove blank lines at beginning and end of contents. The logic
3437 ;; behind that removal is that blank lines around include keyword
3438 ;; override blank lines in included file.
3447 ;; If IND is set, preserve indentation of include keyword until
3448 ;; the first headline encountered.
3455 ;; Do not move footnote definitions out of column 0.
3461 ;; When MINLEVEL is specified, compute minimal level for headlines
3462 ;; in the file (CUR-MIN), and remove stars to each headline so
3463 ;; that headlines with minimal level have a level of MINLEVEL.
3474 ;; Only change stars, don't bother moving whole
3475 ;; sections.
3479 ;; Append ID to all footnote references and definitions, so they
3480 ;; become file specific and cannot collide with footnotes in other
3481 ;; included files.
3498 "Execute every Babel code in the visible part of current buffer."
3499 ;; Get a pristine copy of current buffer so Babel references can be
3500 ;; properly resolved.
3506 "Return a non-nil value when output should be added to the kill ring.
3507 See also `org-export-copy-to-kill-ring'."
3513 \f
3514 ;;; Tools For Back-Ends
3515 ;;
3516 ;; A whole set of tools is available to help build new exporters. Any
3517 ;; function general enough to have its use across many back-ends
3518 ;; should be added here.
3520 ;;;; For Affiliated Keywords
3521 ;;
3522 ;; `org-export-read-attribute' reads a property from a given element
3523 ;; as a plist. It can be used to normalize affiliated keywords'
3524 ;; syntax.
3525 ;;
3526 ;; Since captions can span over multiple lines and accept dual values,
3527 ;; their internal representation is a bit tricky. Therefore,
3528 ;; `org-export-get-caption' transparently returns a given element's
3529 ;; caption as a secondary string.
3532 "Turn ATTRIBUTE property from ELEMENT into a plist.
3534 When optional argument PROPERTY is non-nil, return the value of
3535 that property within attributes.
3539 properties.
3541 All values will become strings except the empty string and
3544 will become the empty string."
3558 s)
3563 ;; Ignore any string before first property with `cdr'.
3568 "Return caption from ELEMENT as a secondary string.
3570 When optional argument SHORTP is non-nil, return short caption,
3571 as a secondary string, instead.
3573 Caption lines are separated by a white space."
3581 ;;;; For Derived Back-ends
3582 ;;
3583 ;; `org-export-with-backend' is a function allowing to locally use
3584 ;; another back-end to transcode some object or element. In a derived
3585 ;; back-end, it may be used as a fall-back function once all specific
3586 ;; cases have been treated.
3589 "Call a transcoder from BACKEND on DATA.
3590 BACKEND is an export back-end, as returned by, e.g.,
3591 `org-export-create-backend', or a symbol referring to
3592 a registered back-end. DATA is an Org element, object, secondary
3593 string or string. CONTENTS, when non-nil, is the transcoded
3594 contents of DATA element, as a string. INFO, when non-nil, is
3595 the communication channel used for export, as a plist."
3605 transcoder data contents
3608 :translate-alist all-transcoders
3612 ;;;; For Export Snippets
3613 ;;
3614 ;; Every export snippet is transmitted to the back-end. Though, the
3615 ;; latter will only retain one type of export-snippet, ignoring
3616 ;; others, based on the former's target back-end. The function
3617 ;; `org-export-snippet-backend' returns that back-end for a given
3618 ;; export-snippet.
3621 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3622 Translation, with `org-export-snippet-translation-alist', is
3623 applied."
3627 back-end))))
3630 ;;;; For Footnotes
3631 ;;
3632 ;; `org-export-collect-footnote-definitions' is a tool to list
3633 ;; actually used footnotes definitions in the whole parse tree, or in
3634 ;; a headline, in order to add footnote listings throughout the
3635 ;; transcoded data.
3636 ;;
3637 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3638 ;; back-ends, when they need to attach the footnote definition only to
3639 ;; the first occurrence of the corresponding label.
3640 ;;
3641 ;; `org-export-get-footnote-definition' and
3642 ;; `org-export-get-footnote-number' provide easier access to
3643 ;; additional information relative to a footnote reference.
3646 "Return an alist between footnote numbers, labels and definitions.
3648 DATA is the parse tree from which definitions are collected.
3649 INFO is the plist used as a communication channel.
3651 Definitions are sorted by order of references. They either
3652 appear as Org data or as a secondary string for inlined
3653 footnotes. Unreferenced definitions are ignored."
3655 collect-fn ; for byte-compiler.
3659 ;; Collect footnote number, label and definition in DATA.
3667 def)
3668 num-alist)
3669 ;; Also search in definition for nested footnotes.
3672 ;; Don't enter footnote definitions since it will happen
3673 ;; when their first reference is found.
3679 "Non-nil when a footnote reference is the first one for its label.
3681 FOOTNOTE-REFERENCE is the footnote reference being considered.
3682 INFO is the plist used as a communication channel."
3684 ;; Anonymous footnotes are always a first reference.
3686 ;; Otherwise, return the first footnote with the same LABEL and
3687 ;; test if it is equal to FOOTNOTE-REFERENCE.
3697 ;; If FN isn't inlined, be sure to traverse its
3698 ;; definition before resuming search. See
3699 ;; comments in `org-export-get-footnote-number'
3700 ;; for more information.
3704 ;; Don't enter footnote definitions since it will
3705 ;; happen when their first reference is found.
3708 footnote-reference)))))
3711 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3712 INFO is the plist used as a communication channel. If no such
3721 "Return number associated to a footnote.
3723 FOOTNOTE is either a footnote reference or a footnote definition.
3724 INFO is the plist used as a communication channel."
3726 seen-refs
3727 search-ref ; For byte-compiler.
3731 ;; Search footnote references through DATA, filling
3732 ;; SEEN-REFS along the way.
3737 ;; Anonymous footnote match: return number.
3740 ;; Labels match: return number.
3743 ;; Anonymous footnote: it's always a new one.
3744 ;; Also, be sure to return nil from the `cond' so
3745 ;; `first-match' doesn't get us out of the loop.
3747 ;; Label not seen so far: add it so SEEN-REFS.
3748 ;;
3749 ;; Also search for subsequent references in
3750 ;; footnote definition so numbering follows
3751 ;; reading logic. Note that we don't have to care
3752 ;; about inline definitions, since
3753 ;; `org-element-map' already traverses them at the
3754 ;; right time.
3755 ;;
3756 ;; Once again, return nil to stay in the loop.
3761 nil))))
3762 ;; Don't enter footnote definitions since it will
3763 ;; happen when their first reference is found.
3768 ;;;; For Headlines
3769 ;;
3770 ;; `org-export-get-relative-level' is a shortcut to get headline
3771 ;; level, relatively to the lower headline level in the parsed tree.
3772 ;;
3773 ;; `org-export-get-headline-number' returns the section number of an
3774 ;; headline, while `org-export-number-to-roman' allows to convert it
3775 ;; to roman numbers.
3776 ;;
3777 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3778 ;; `org-export-last-sibling-p' are three useful predicates when it
3779 ;; comes to fulfill the `:headline-levels' property.
3780 ;;
3781 ;; `org-export-get-tags', `org-export-get-category' and
3782 ;; `org-export-get-node-property' extract useful information from an
3783 ;; headline or a parent headline. They all handle inheritance.
3784 ;;
3785 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3786 ;; as a secondary string, suitable for table of contents. It falls
3787 ;; back onto default title.
3790 "Return HEADLINE relative level within current parsed tree.
3791 INFO is a plist holding contextual information."
3796 "Non-nil when HEADLINE is considered as low level.
3798 INFO is a plist used as a communication channel.
3800 A low level headlines has a relative level greater than
3801 `:headline-levels' property value.
3803 Return value is the difference between HEADLINE relative level
3804 and the last level being considered as high enough, or nil."
3811 "Return HEADLINE numbering as a list of numbers.
3812 INFO is a plist holding contextual information."
3816 "Return a non-nil value if HEADLINE element should be numbered.
3817 INFO is a plist used as a communication channel."
3823 "Convert integer N into a roman numeral."
3836 res)))
3839 "Return list of tags associated to ELEMENT.
3841 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3842 is a plist used as a communication channel.
3844 Select tags (see `org-export-select-tags') and exclude tags (see
3845 `org-export-exclude-tags') are removed from the list.
3847 When non-nil, optional argument TAGS should be a list of strings.
3848 Any tag belonging to this list will also be removed.
3850 When optional argument INHERITED is non-nil, tags can also be
3851 inherited from parent headlines and FILETAGS keywords."
3857 ;; Build complete list of inherited tags.
3868 ;; Add FILETAGS keywords and return results.
3872 "Return node PROPERTY value for BLOB.
3874 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3875 element or object.
3877 If optional argument INHERITED is non-nil, the value can be
3878 inherited from a parent headline.
3880 Return value is a string or nil."
3892 "Return category for element or object BLOB.
3894 INFO is a plist used as a communication channel.
3896 CATEGORY is automatically inherited from a parent headline, from
3897 #+CATEGORY: keyword or created out of original file name. If all
3910 "Return alternative title for HEADLINE, as a secondary string.
3911 INFO is a plist used as a communication channel. If no optional
3912 title is defined, fall-back to the regular title."
3917 "Non-nil when BLOB is the first sibling in its parent.
3918 BLOB is an element or an object. If BLOB is a headline, non-nil
3919 means it is the first sibling in the sub-tree. INFO is a plist
3920 used as a communication channel."
3925 "Non-nil when BLOB is the last sibling in its parent.
3926 BLOB is an element or an object. INFO is a plist used as
3927 a communication channel."
3931 ;;;; For Keywords
3932 ;;
3933 ;; `org-export-get-date' returns a date appropriate for the document
3934 ;; to about to be exported. In particular, it takes care of
3935 ;; `org-export-date-timestamp-format'.
3938 "Return date value for the current document.
3940 INFO is a plist used as a communication channel. FMT, when
3941 non-nil, is a time format string that will be applied on the date
3942 if it consists in a single timestamp object. It defaults to
3943 `org-export-date-timestamp-format' when nil.
3945 A proper date can be a secondary string, a string or nil. It is
3946 meant to be translated with `org-export-data' or alike."
3957 ;;;; For Links
3958 ;;
3959 ;; `org-export-solidify-link-text' turns a string into a safer version
3960 ;; for links, replacing most non-standard characters with hyphens.
3961 ;;
3962 ;; `org-export-get-coderef-format' returns an appropriate format
3963 ;; string for coderefs.
3964 ;;
3965 ;; `org-export-inline-image-p' returns a non-nil value when the link
3966 ;; provided should be considered as an inline image.
3967 ;;
3968 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3969 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3970 ;; returns an appropriate unique identifier when found, or nil.
3971 ;;
3972 ;; `org-export-resolve-id-link' returns the first headline with
3973 ;; specified id or custom-id in parse tree, the path to the external
3974 ;; file with the id or nil when neither was found.
3975 ;;
3976 ;; `org-export-resolve-coderef' associates a reference to a line
3977 ;; number in the element it belongs, or returns the reference itself
3978 ;; when the element isn't numbered.
3981 "Take link text S and make a safe target out of it."
3986 "Return format string for code reference link.
3987 PATH is the link path. DESC is its description."
3995 "Non-nil if LINK object points to an inline image.
3997 Optional argument is a set of RULES defining inline images. It
3998 is an alist where associations have the following shape:
4000 \(TYPE . REGEXP)
4002 Applying a rule means apply REGEXP against LINK's path when its
4003 type is TYPE. The function will return a non-nil value if any of
4004 the provided rules is non-nil. The default rule is
4005 `org-export-default-inline-image-rule'.
4007 This only applies to links without a description."
4018 rules)
4019 ;; Return nil if no rule matched.
4020 nil))))
4023 "Resolve a code reference REF.
4025 INFO is a plist used as a communication channel.
4027 Return associated line number in source code, or REF itself,
4028 depending on src-block or example element's switches."
4035 org-coderef-label-format)))
4039 ;; Element containing REF is found. Resolve it to either
4040 ;; a label or a line number, as needed.
4050 "Return LINK destination.
4052 INFO is a plist holding contextual information.
4054 Return value can be an object, an element, or nil:
4056 - If LINK path matches a target object (i.e. <<path>>) return it.
4058 - If LINK path exactly matches the name affiliated keyword
4059 \(i.e. #+NAME: path) of an element, return that element.
4061 - If LINK path exactly matches any headline name, return that
4062 element. If more than one headline share that name, priority
4063 will be given to the one with the closest common ancestor, if
4064 any, or the first one in the parse tree otherwise.
4066 - Otherwise, return nil.
4069 significant."
4072 ;; Split PATH at white spaces so matches are space
4073 ;; insensitive.
4076 ;; Cache for destinations that are not position dependent.
4084 ;; Destination is not position dependent: use cached value.
4086 ;; First try to find a matching "<<path>>" unless user specified
4087 ;; he was looking for a headline (path starts with a "*"
4088 ;; character).
4094 path)
4095 blob))
4098 ;; Then try to find an element with a matching "#+NAME: path"
4099 ;; affiliated keyword.
4102 org-element-all-elements
4107 el)))
4110 ;; Last case: link either points to a headline or to nothingness.
4111 ;; Try to find the source, with priority given to headlines with
4112 ;; the closest common ancestor. If such candidate is found,
4113 ;; return it, otherwise return nil.
4117 ;; Return first headline whose `:raw-value' property is
4118 ;; NAME in parse tree DATA, or nil. Statistics cookies
4119 ;; are ignored.
4127 name)
4128 headline))
4130 ;; Search among headlines sharing an ancestor with link, from
4131 ;; closest to farthest.
4140 ;; No destination found: return nil.
4144 "Return headline referenced as LINK destination.
4146 INFO is a plist used as a communication channel.
4148 Return value can be the headline element matched in current parse
4152 ;; First check if id is within the current parse tree.
4157 headline))
4159 ;; Otherwise, look for external files.
4163 "Return radio-target object referenced as LINK destination.
4165 INFO is a plist used as a communication channel.
4167 Return value can be a radio-target object or nil. Assume LINK
4176 nil nil path nil nil t)
4177 t)
4178 radio))
4182 ;;;; For References
4183 ;;
4184 ;; `org-export-get-ordinal' associates a sequence number to any object
4185 ;; or element.
4188 "Return ordinal number of an element or object.
4190 ELEMENT is the element or object considered. INFO is the plist
4191 used as a communication channel.
4193 Optional argument TYPES, when non-nil, is a list of element or
4194 object types, as symbols, that should also be counted in.
4195 Otherwise, only provided element's type is considered.
4197 Optional argument PREDICATE is a function returning a non-nil
4198 value if the current element or object should be counted in. It
4199 accepts two arguments: the element or object being considered and
4200 the plist used as a communication channel. This allows to count
4201 only a certain type of objects (i.e. inline images).
4203 Return value is a list of numbers if ELEMENT is a headline or an
4204 item. It is nil for keywords. It represents the footnote number
4205 for footnote definitions and footnote references. If ELEMENT is
4206 a target, return the same value as if ELEMENT was the closest
4207 table, item or headline containing the target. In any other
4208 case, return the sequence number of ELEMENT among elements or
4209 objects of the same type."
4210 ;; Ordinal of a target object refer to the ordinal of the closest
4211 ;; table, item, or headline containing the object.
4215 when
4219 table))
4220 return parent)))
4222 ;; Special case 1: A headline returns its number as a list.
4224 ;; Special case 2: An item returns its number as a list.
4228 struct
4235 ;; Increment counter until ELEMENT is found again.
4245 ;;;; For Special Blocks
4246 ;;
4247 ;; `org-export-raw-special-block-p' check if current special block is
4248 ;; an "export block", i.e., a block whose contents should be inserted
4249 ;; as-is in the output. This should generally be the first check to
4250 ;; do when handling special blocks in the export back-end.
4253 "Non-nil if ELEMENT is an export block relatively to current back-end.
4254 An export block is a special block whose contents should be
4255 included as-is in the final output. Such blocks are defined
4256 through :export-block property in `org-export-define-backend',
4257 which see."
4264 b))))
4267 ;;;; For Src Blocks
4268 ;;
4269 ;; `org-export-get-loc' counts number of code lines accumulated in
4270 ;; src-block or example-block elements with a "+n" switch until
4271 ;; a given element, excluded. Note: "-n" switches reset that count.
4272 ;;
4273 ;; `org-export-unravel-code' extracts source code (along with a code
4274 ;; references alist) from an `element-block' or `src-block' type
4275 ;; element.
4276 ;;
4277 ;; `org-export-format-code' applies a formatting function to each line
4278 ;; of code, providing relative line number and code reference when
4279 ;; appropriate. Since it doesn't access the original element from
4280 ;; which the source code is coming, it expects from the code calling
4281 ;; it to know if lines should be numbered and if code references
4282 ;; should appear.
4283 ;;
4284 ;; Eventually, `org-export-format-code-default' is a higher-level
4285 ;; function (it makes use of the two previous functions) which handles
4286 ;; line numbering and code references inclusion, and returns source
4287 ;; code in a format suitable for plain text or verbatim output.
4290 "Return accumulated lines of code up to ELEMENT.
4292 INFO is the plist used as a communication channel.
4294 ELEMENT is excluded from count."
4300 ;; ELEMENT is reached: Quit the loop.
4302 ;; Only count lines from src-block and example-block elements
4303 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4307 ;; Accumulate locs or reset them.
4311 ;; Return nil to stay in the loop.
4312 nil)))
4314 ;; Return value.
4315 loc))
4318 "Clean source code and extract references out of it.
4320 ELEMENT has either a `src-block' an `example-block' type.
4322 Return a cons cell whose CAR is the source code, cleaned from any
4323 reference, protective commas and spurious indentation, and CDR is
4324 an alist between relative line number (integer) and name of code
4325 reference on that line (string)."
4328 ;; Get code and clean it. Remove blank lines at its
4329 ;; beginning and end.
4336 value
4338 ;; Get format used for references.
4341 org-coderef-label-format)))
4342 ;; Build a regexp matching a loc with a reference.
4347 ;; Return value.
4349 ;; Code with references removed.
4355 ;; Ref line: remove ref, and signal its position in REFS.
4359 ;; Reference alist.
4360 refs)))
4363 "Format CODE by applying FUN line-wise and return it.
4365 CODE is a string representing the code to format. FUN is
4366 a function. It must accept three arguments: a line of
4367 code (string), the current line number (integer) or nil and the
4368 reference associated to the current line (string) or nil.
4370 Optional argument NUM-LINES can be an integer representing the
4371 number of code lines accumulated until the current code. Line
4372 numbers passed to FUN will take it into account. If it is nil,
4373 FUN's second argument will always be nil. This number can be
4374 obtained with `org-export-get-loc' function.
4376 Optional argument REF-ALIST can be an alist between relative line
4377 number (i.e. ignoring NUM-LINES) and the name of the code
4378 reference on it. If it is nil, FUN's third argument will always
4379 be nil. It can be obtained through the use of
4380 `org-export-unravel-code' function."
4392 "Return source code from ELEMENT, formatted in a standard way.
4394 ELEMENT is either a `src-block' or `example-block' element. INFO
4395 is a plist used as a communication channel.
4397 This function takes care of line numbering and code references
4398 inclusion. Line numbers, when applicable, appear at the
4399 beginning of the line, separated from the code by two white
4400 spaces. Code references, on the other hand, appear flushed to
4401 the right, separated by six white spaces from the widest line of
4402 code."
4403 ;; Extract code and references.
4410 ;; Handle line numbering.
4419 ;; Prepare references display, if required. Any reference
4420 ;; should start six columns after the widest line of code,
4421 ;; wrapped with parenthesis.
4426 code
4430 number-str
4431 loc
4437 num-start refs)))))
4440 ;;;; For Tables
4441 ;;
4442 ;; `org-export-table-has-special-column-p' and and
4443 ;; `org-export-table-row-is-special-p' are predicates used to look for
4444 ;; meta-information about the table structure.
4445 ;;
4446 ;; `org-table-has-header-p' tells when the rows before the first rule
4447 ;; should be considered as table's header.
4448 ;;
4449 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4450 ;; and `org-export-table-cell-borders' extract information from
4451 ;; a table-cell element.
4452 ;;
4453 ;; `org-export-table-dimensions' gives the number on rows and columns
4454 ;; in the table, ignoring horizontal rules and special columns.
4455 ;; `org-export-table-cell-address', given a table-cell object, returns
4456 ;; the absolute address of a cell. On the other hand,
4457 ;; `org-export-get-table-cell-at' does the contrary.
4458 ;;
4459 ;; `org-export-table-cell-starts-colgroup-p',
4460 ;; `org-export-table-cell-ends-colgroup-p',
4461 ;; `org-export-table-row-starts-rowgroup-p',
4462 ;; `org-export-table-row-ends-rowgroup-p',
4463 ;; `org-export-table-row-starts-header-p',
4464 ;; `org-export-table-row-ends-header-p' and
4465 ;; `org-export-table-row-in-header-p' indicate position of current row
4466 ;; or cell within the table.
4469 "Non-nil when TABLE has a special column.
4470 All special columns will be ignored during export."
4471 ;; The table has a special column when every first cell of every row
4472 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4473 ;; "*" "_" and "^". Though, do not consider a first row containing
4474 ;; only empty cells as special.
4490 "Non-nil when TABLE has a header.
4492 INFO is a plist used as a communication channel.
4494 A table has a header when it contains at least two row groups."
4503 table
4514 cache)))))
4517 "Non-nil if TABLE-ROW is considered special.
4519 INFO is a plist used as the communication channel.
4521 All special rows will be ignored during export."
4525 ;; A row is special either when...
4527 ;; ... it starts with a field only containing "/",
4529 ;; ... the table contains a special column and the row start
4530 ;; with a marking character among, "^", "_", "$" or "!",
4534 ;; ... it contains only alignment cookies and empty cells.
4540 ;; Since VALUE is a secondary string, the following
4541 ;; checks avoid expanding it with `org-export-data'.
4553 "Return TABLE-ROW's group number, as an integer.
4555 INFO is a plist used as the communication channel.
4557 Return value is the group number, as an integer, or nil for
4558 special rows and rows separators. First group is also table's
4559 header."
4577 "Return TABLE-CELL contents width.
4579 INFO is a plist used as the communication channel.
4581 Return value is the width given by the last width cookie in the
4582 same column as TABLE-CELL, or nil."
4601 ;; In a special row, try to find a width cookie at COLUMN.
4605 ;; The following checks avoid expanding unnecessarily
4606 ;; the cell with `org-export-data'.
4616 "Return TABLE-CELL contents alignment.
4618 INFO is a plist used as the communication channel.
4620 Return alignment as specified by the last alignment cookie in the
4621 same column as TABLE-CELL. If no such cookie is found, a default
4622 alignment value will be deduced from fraction of numbers in the
4623 column (see `org-table-number-fraction' for more information).
4624 Possible values are `left', `right' and `center'."
4625 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4642 cookie-align
4643 previous-cell-number-p)
4646 ;; In a special row, try to find an alignment cookie at
4647 ;; COLUMN.
4651 ;; Since VALUE is a secondary string, the following
4652 ;; checks avoid useless expansion through
4653 ;; `org-export-data'.
4661 ;; Ignore table rules.
4663 ;; In a standard row, check if cell's contents are
4664 ;; expressing some kind of number. Increase NUMBER-CELLS
4665 ;; accordingly. Though, don't bother if an alignment
4666 ;; cookie has already defined cell's alignment.
4671 info)))
4673 ;; Treat an empty cell as a number if it follows
4674 ;; a number.
4680 ;; Return value. Alignment specified by cookies has
4681 ;; precedence over alignment deduced from cell's contents.
4683 column
4688 org-table-number-fraction)
4693 "Return TABLE-CELL borders.
4695 INFO is a plist used as a communication channel.
4697 Return value is a list of symbols, or nil. Possible values are:
4698 `top', `bottom', `above', `below', `left' and `right'. Note:
4699 `top' (resp. `bottom') only happen for a cell in the first
4700 row (resp. last row) of the table, ignoring table rules, if any.
4702 Returned borders ignore special rows."
4705 borders)
4706 ;; Top/above border? TABLE-CELL has a border above when a rule
4707 ;; used to demarcate row groups can be found above. Hence,
4708 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4709 ;; another regular row has to be found above that rule.
4718 ;; Look at every row before the current one.
4720 ;; No rule above, or rule found starts the table (ignoring any
4721 ;; special row): TABLE-CELL is at the top of the table.
4724 ;; Bottom/below border? TABLE-CELL has a border below when next
4725 ;; non-regular row below is a rule.
4734 ;; Look at every row after the current one.
4736 ;; No rule below, or rule found ends the table (modulo some
4737 ;; special row): TABLE-CELL is at the bottom of the table.
4740 ;; Right/left borders? They can only be specified by column
4741 ;; groups. Column groups are defined in a row starting with "/".
4742 ;; Also a column groups row only contains "<", "<>", ">" or blank
4743 ;; cells.
4760 ;; There's a left border when previous cell, if
4761 ;; any, ends a group, or current one starts one.
4767 ;; There's a right border when next cell, if any,
4768 ;; starts a group, or current one ends one.
4775 ;; Table rows are read in reverse order so last column groups
4776 ;; row has precedence over any previous one.
4778 ;; Return value.
4779 borders))
4782 "Non-nil when TABLE-CELL is at the beginning of a column group.
4783 INFO is a plist used as a communication channel."
4784 ;; A cell starts a column group either when it is at the beginning
4785 ;; of a row (or after the special column, if any) or when it has
4786 ;; a left border.
4789 table-cell)
4793 "Non-nil when TABLE-CELL is at the end of a column group.
4794 INFO is a plist used as a communication channel."
4795 ;; A cell ends a column group either when it is at the end of a row
4796 ;; or when it has a right border.
4799 table-cell)
4803 "Non-nil when TABLE-ROW is at the beginning of a row group.
4804 INFO is a plist used as a communication channel."
4812 "Non-nil when TABLE-ROW is at the end of a row group.
4813 INFO is a plist used as a communication channel."
4821 "Non-nil when TABLE-ROW is located within table's header.
4822 INFO is a plist used as a communication channel. Always return
4823 nil for special rows and rows separators."
4829 "Non-nil when TABLE-ROW is the first table header's row.
4830 INFO is a plist used as a communication channel."
4835 "Non-nil when TABLE-ROW is the last table header's row.
4836 INFO is a plist used as a communication channel."
4841 "Return TABLE-ROW number.
4842 INFO is a plist used as a communication channel. Return value is
4843 zero-based and ignores separators. The function returns nil for
4844 special columns and separators."
4856 "Return TABLE dimensions.
4858 INFO is a plist used as a communication channel.
4860 Return value is a CONS like (ROWS . COLUMNS) where
4861 ROWS (resp. COLUMNS) is the number of exportable
4862 rows (resp. columns)."
4864 ;; Set number of rows, and extract first one.
4870 ;; Set number of columns.
4872 ;; Return value.
4876 "Return address of a regular TABLE-CELL object.
4878 TABLE-CELL is the cell considered. INFO is a plist used as
4879 a communication channel.
4881 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4882 zero-based index. Only exportable cells are considered. The
4883 function returns nil for other cells."
4895 "Return regular table-cell object at ADDRESS in TABLE.
4897 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4898 zero-based index. TABLE is a table type element. INFO is
4899 a plist used as a communication channel.
4901 If no table-cell, among exportable cells, is found at ADDRESS,
4902 return nil."
4905 ;; Row at (car address) or nil.
4913 'table-cell
4920 ;;;; For Tables Of Contents
4921 ;;
4922 ;; `org-export-collect-headlines' builds a list of all exportable
4923 ;; headline elements, maybe limited to a certain depth. One can then
4924 ;; easily parse it and transcode it.
4925 ;;
4926 ;; Building lists of tables, figures or listings is quite similar.
4927 ;; Once the generic function `org-export-collect-elements' is defined,
4928 ;; `org-export-collect-tables', `org-export-collect-figures' and
4929 ;; `org-export-collect-listings' can be derived from it.
4932 "Collect headlines in order to build a table of contents.
4934 INFO is a plist used as a communication channel.
4936 When optional argument N is an integer, it specifies the depth of
4937 the table of contents. Otherwise, it is set to the value of the
4938 last headline level. See `org-export-headline-levels' for more
4939 information.
4941 Return a list of all exportable headlines as parsed elements.
4942 Footnote sections, if any, will be ignored."
4950 info)))
4953 "Collect referenceable elements of a determined type.
4955 TYPE can be a symbol or a list of symbols specifying element
4956 types to search. Only elements with a caption are collected.
4958 INFO is a plist used as a communication channel.
4960 When non-nil, optional argument PREDICATE is a function accepting
4961 one argument, an element of type TYPE. It returns a non-nil
4962 value when that element should be collected.
4964 Return a list of all elements found, in order of appearance."
4969 element))
4970 info))
4973 "Build a list of tables.
4974 INFO is a plist used as a communication channel.
4976 Return a list of table elements with a caption."
4980 "Build a list of figures.
4982 INFO is a plist used as a communication channel. PREDICATE is
4983 a function which accepts one argument: a paragraph element and
4984 whose return value is non-nil when that element should be
4985 collected.
4987 A figure is a paragraph type element, with a caption, verifying
4989 a vague concept that may depend on back-end.
4991 Return a list of elements recognized as figures."
4995 "Build a list of src blocks.
4997 INFO is a plist used as a communication channel.
4999 Return a list of src-block elements with a caption."
5003 ;;;; Smart Quotes
5004 ;;
5005 ;; The main function for the smart quotes sub-system is
5006 ;; `org-export-activate-smart-quotes', which replaces every quote in
5007 ;; a given string from the parse tree with its "smart" counterpart.
5008 ;;
5009 ;; Dictionary for smart quotes is stored in
5010 ;; `org-export-smart-quotes-alist'.
5011 ;;
5012 ;; Internally, regexps matching potential smart quotes (checks at
5013 ;; string boundaries are also necessary) are defined in
5014 ;; `org-export-smart-quotes-regexps'.
5018 ;; one may use: »...«, "...", ›...‹, or '...'.
5019 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5020 ;; LaTeX quotes require Babel!
5065 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5074 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5083 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5092 ;; 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
5093 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5104 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5110 )
5111 "Smart quotes translations.
5113 Alist whose CAR is a language string and CDR is an alist with
5114 quote type as key and a plist associating various encodings to
5115 their translation as value.
5117 A quote type can be any symbol among `opening-double-quote',
5118 `closing-double-quote', `opening-single-quote',
5119 `closing-single-quote' and `apostrophe'.
5121 Valid encodings include `:utf-8', `:html', `:latex' and
5122 `:texinfo'.
5128 ;; Possible opening quote at beginning of string.
5130 ;; Possible closing quote at beginning of string.
5132 ;; Possible apostrophe at beginning of string.
5134 ;; Opening single and double quotes.
5136 ;; Closing single and double quotes.
5138 ;; Apostrophe.
5140 ;; Possible opening quote at end of string.
5142 ;; Possible closing quote at end of string.
5144 ;; Possible apostrophe at end of string.
5146 "List of regexps matching a quote or an apostrophe.
5152 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5153 `:utf-8'. INFO is a plist used as a communication channel.
5155 The function has to retrieve information about string
5156 surroundings in parse tree. It can only happen with an
5157 unmodified string. Thus, if S has already been through another
5158 process, a non-nil ORIGINAL optional argument will provide that
5159 original string.
5161 Return the new string."
5164 ;; Try to be flexible when computing number of blanks
5165 ;; before object. The previous object may be a string
5166 ;; introduced by the back-end and not completely parsed.
5169 ;; A string with missing `:post-blank'
5170 ;; property.
5174 ;; Fallback value.
5179 ;; Return smart quote associated to a give quote Q, as
5180 ;; a string. TYPE is a symbol among `open', `close' and
5181 ;; `apostrophe'.
5191 org-export-smart-quotes-alist))))
5192 encoding)
5193 q)))))
5195 ;; Only a quote: no regexp can match. We have to check both
5196 ;; sides and decide what to do.
5204 ;; 1. Replace quote character at the beginning of S.
5206 ;; Apostrophe?
5212 ;; Closing quote?
5218 ;; Opening quote?
5224 ;; 2. Replace quotes in the middle of the string.
5226 ;; Opening quotes.
5232 ;; Closing quotes.
5238 ;; Apostrophes.
5243 ;; 3. Replace quote character at the end of S.
5245 ;; Apostrophe?
5250 ;; Closing quote?
5256 ;; Opening quote?
5261 ;; Return string with smart quotes.
5262 s))))
5264 ;;;; Topology
5265 ;;
5266 ;; Here are various functions to retrieve information about the
5267 ;; neighborhood of a given element or object. Neighbors of interest
5268 ;; are direct parent (`org-export-get-parent'), parent headline
5269 ;; (`org-export-get-parent-headline'), first element containing an
5270 ;; object, (`org-export-get-parent-element'), parent table
5271 ;; (`org-export-get-parent-table'), previous element or object
5272 ;; (`org-export-get-previous-element') and next element or object
5273 ;; (`org-export-get-next-element').
5274 ;;
5275 ;; `org-export-get-genealogy' returns the full genealogy of a given
5276 ;; element or object, from closest parent to full parse tree.
5278 ;; defsubst org-export-get-parent must be defined before first use
5281 "Return full genealogy relative to a given element or object.
5283 BLOB is the element or object being considered.
5285 Ancestors are returned from closest to farthest, the last one
5286 being the full parse tree."
5293 "Return BLOB parent headline or nil.
5294 BLOB is the element or object being considered."
5298 parent))
5301 "Return first element containing OBJECT or nil.
5302 OBJECT is the object to consider."
5306 parent))
5309 "Return OBJECT parent table or nil.
5310 OBJECT is either a `table-cell' or `table-element' type object."
5314 parent))
5317 "Return previous element or object.
5319 BLOB is an element or object. INFO is a plist used as
5320 a communication channel. Return previous exportable element or
5321 object, a string, or nil.
5323 When optional argument N is a positive integer, return a list
5324 containing up to N siblings before BLOB, from farthest to
5325 closest. With any other non-nil value, return a list containing
5326 all of them."
5332 prev)
5342 "Return next element or object.
5344 BLOB is an element or object. INFO is a plist used as
5345 a communication channel. Return next exportable element or
5346 object, a string, or nil.
5348 When optional argument N is a positive integer, return a list
5349 containing up to N siblings after BLOB, from closest to farthest.
5350 With any other non-nil value, return a list containing all of
5351 them."
5358 next)
5368 ;;;; Translation
5369 ;;
5370 ;; `org-export-translate' translates a string according to the language
5371 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5372 ;; the dictionary used for the translation.
5419 ("ru" :html "(Продолжение следует)"
5517 ("ru" :html "Список распечаток"
5530 ("ru" :html "Список таблиц"
5613 ("ru" :html "Неизвестная ссылка"
5616 "Dictionary for export engine.
5618 Alist whose CAR is the string to translate and CDR is an alist
5619 whose CAR is the language string and CDR is a plist whose
5620 properties are possible charsets and values translated terms.
5622 It is used as a database for `org-export-translate'. Since this
5623 function returns the string as-is if no translation was found,
5624 the variable only needs to record values different from the
5628 "Translate string S according to language specification.
5630 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5631 and `:utf-8'. INFO is a plist used as a communication channel.
5633 Translation depends on `:language' property. Return the
5634 translated string. If no translation is found, try to fall back
5635 to `:default' encoding. If it fails, return S."
5641 s)))
5644 \f
5645 ;;; Asynchronous Export
5646 ;;
5647 ;; `org-export-async-start' is the entry point for asynchronous
5648 ;; export. It recreates current buffer (including visibility,
5649 ;; narrowing and visited file) in an external Emacs process, and
5650 ;; evaluates a command there. It then applies a function on the
5651 ;; returned results in the current process.
5652 ;;
5653 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5654 ;; allow to export to a buffer or a file, asynchronously or not.
5655 ;;
5656 ;; `org-export-output-file-name' is an auxiliary function meant to be
5657 ;; used with `org-export-to-file'. With a given extension, it tries
5658 ;; to provide a canonical file name to write export output to.
5659 ;;
5660 ;; Asynchronously generated results are never displayed directly.
5661 ;; Instead, they are stored in `org-export-stack-contents'. They can
5662 ;; then be retrieved by calling `org-export-stack'.
5663 ;;
5664 ;; Export Stack is viewed through a dedicated major mode
5665 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5666 ;;`org-export-stack-delete', `org-export-stack-view' and
5667 ;;`org-export-stack-clear'.
5668 ;;
5669 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5670 ;; It should be used whenever `org-export-async-start' is called.
5673 "Call function FUN on the results returned by BODY evaluation.
5675 BODY evaluation happens in an asynchronous process, from a buffer
5676 which is an exact copy of the current one.
5678 Use `org-export-add-to-stack' in FUN in order to register results
5679 in the stack.
5681 This is a low level function. See also `org-export-to-buffer'
5682 and `org-export-to-file' for more specialized functions."
5685 ;; Write the full sexp evaluating BODY in a copy of the current
5686 ;; buffer to a temporary file, as it may be too long for program
5687 ;; args in `start-process'.
5694 ;; Null characters (from variable values) are inserted
5695 ;; within the file. As a consequence, coding system for
5696 ;; buffer contents will not be recognized properly. So,
5697 ;; we make sure it is the same as the one used to display
5698 ;; the original buffer.
5700 ,coding
5703 ;; Ignore `kill-emacs-hook' and code evaluation
5704 ;; queries from Babel as we need a truly
5705 ;; non-interactive process.
5707 org-babel-confirm-evaluate-answer-no t)
5708 ;; Initialize export framework.
5710 ;; Re-create current buffer there.
5713 ;; Sexp to evaluate in the buffer.
5715 ;; Start external process.
5718 (,process
5720 #'start-process
5723 ,proc-buffer
5730 ;; Register running process in stack.
5732 ;; Set-up sentinel in order to catch results.
5735 ,process
5757 ;;;###autoload
5760 &optional async subtreep visible-only body-only ext-plist
5761 post-process)
5762 "Call `org-export-as' with output to a specified buffer.
5764 BACKEND is either an export back-end, as returned by, e.g.,
5765 `org-export-create-backend', or a symbol referring to
5766 a registered back-end.
5768 BUFFER is the name of the output buffer. If it already exists,
5769 it will be erased first, otherwise, it will be created.
5771 A non-nil optional argument ASYNC means the process should happen
5772 asynchronously. The resulting buffer should then be accessible
5773 through the `org-export-stack' interface. When ASYNC is nil, the
5774 buffer is displayed if `org-export-show-temporary-export-buffer'
5775 is non-nil.
5777 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5778 EXT-PLIST are similar to those used in `org-export-as', which
5779 see.
5781 Optional argument POST-PROCESS is a function which should accept
5782 no argument. It is always called within the current process,
5783 from BUFFER, with point at its beginning. Export back-ends can
5784 use it to set a major mode there, e.g,
5786 \(defun org-latex-export-as-latex
5787 \(&optional async subtreep visible-only body-only ext-plist)
5788 \(interactive)
5790 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5792 This function returns BUFFER."
5820 buffer)))
5822 ;;;###autoload
5825 post-process)
5826 "Call `org-export-as' with output to a specified file.
5828 BACKEND is either an export back-end, as returned by, e.g.,
5829 `org-export-create-backend', or a symbol referring to
5830 a registered back-end. FILE is the name of the output file, as
5831 a string.
5833 A non-nil optional argument ASYNC means the process should happen
5834 asynchronously. The resulting buffer will then be accessible
5835 through the `org-export-stack' interface.
5837 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5838 EXT-PLIST are similar to those used in `org-export-as', which
5839 see.
5841 Optional argument POST-PROCESS is called with FILE as its
5842 argument and happens asynchronously when ASYNC is non-nil. It
5843 has to return a file name, or nil. Export back-ends can use this
5844 to send the output file through additional processing, e.g,
5846 \(defun org-latex-export-to-latex
5847 \(&optional async subtreep visible-only body-only ext-plist)
5848 \(interactive)
5850 \(org-export-to-file 'latex outfile
5851 async subtreep visible-only body-only ext-plist
5852 \(lambda (file) (org-latex-compile file)))
5854 The function returns either a file name returned by POST-PROCESS,
5855 or FILE."
5874 backend subtreep visible-only body-only ext-plist)))
5881 ;; Get proper return value.
5883 file))))))
5886 "Return output file's name according to buffer specifications.
5888 EXTENSION is a string representing the output file extension,
5889 with the leading dot.
5891 With a non-nil optional argument SUBTREEP, try to determine
5893 of subtree at point.
5895 When optional argument PUB-DIR is set, use it as the publishing
5896 directory.
5898 When optional argument VISIBLE-ONLY is non-nil, don't export
5899 contents of hidden elements.
5901 Return file name as a string."
5904 ;; File name may come from EXPORT_FILE_NAME subtree
5905 ;; property, assuming point is at beginning of said
5906 ;; sub-tree.
5913 ;; File name may be extracted from buffer's associated
5914 ;; file, if any.
5916 ;; Can't determine file name on our own: Ask user.
5920 "Output file: " pub-dir nil nil nil
5924 ;; Build file name. Enforce EXTENSION over whatever user
5925 ;; may have come up with. PUB-DIR, if defined, always has
5926 ;; precedence over any provided path.
5931 extension))
5934 ;; If writing to OUTPUT-FILE would overwrite original file, append
5935 ;; EXTENSION another time to final name.
5938 output-file)))
5941 "Add a new result to export stack if not present already.
5943 SOURCE is a buffer or a file name containing export results.
5944 BACKEND is a symbol representing export back-end used to generate
5945 it.
5947 Entries already pointing to SOURCE and unavailable entries are
5948 removed beforehand. Return the new stack."
5954 "Menu for asynchronous export results and running processes."
5964 "Return source from export results at point in stack."
5971 source
5972 ;; SOURCE is not consistent with current line. The stack
5973 ;; view is outdated.
5977 "Remove all entries from export stack."
5982 "Refresh the asynchronous export stack.
5983 DUMMY is ignored. Unavailable sources are removed from the list.
5984 Return the new stack."
5994 ;; Back-end.
5996 ;; Age.
5999 ;; Compute age of the results.
6001 "%4h:%.2m "
6003 ;; Source.
6008 ;; Clear stack from exited processes, dead buffers or
6009 ;; non-existent files.
6021 "Remove export results at point from stack.
6022 If optional argument SOURCE is non-nil, remove it instead."
6027 org-export-stack-contents))))
6030 "View export results at point in stack.
6031 With an optional prefix argument IN-EMACS, force viewing files
6032 within Emacs."
6046 (define-key km "p" 'previous-line)
6047 (define-key km "\C-p" 'previous-line)
6048 (define-key km "\C-?" 'previous-line)
6049 (define-key km [up] 'previous-line)
6050 (define-key km "C" 'org-export-stack-clear)
6051 (define-key km "v" 'org-export-stack-view)
6052 (define-key km (kbd "RET") 'org-export-stack-view)
6053 (define-key km "d" 'org-export-stack-remove)
6054 km)
6055 "Keymap for Org Export Stack.")
6057 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6058 "Mode for displaying asynchronous export stack.
6061 stack.
6063 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6064 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6065 stack completely.
6067 Removing entries in an Org Export Stack buffer doesn't affect
6068 files or buffers, only the display.
6071 (abbrev-mode 0)
6072 (auto-fill-mode 0)
6073 (setq buffer-read-only t
6074 buffer-undo-list t
6075 truncate-lines t
6076 header-line-format
6077 '(:eval
6078 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6079 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6080 (set (make-local-variable 'revert-buffer-function)
6081 'org-export-stack-refresh))
6084 \f
6085 ;;; The Dispatcher
6086 ;;
6087 ;; `org-export-dispatch' is the standard interactive way to start an
6088 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6089 ;; for its interface, which, in turn, delegates response to key
6090 ;; pressed to `org-export--dispatch-action'.
6092 ;;;###autoload
6093 (defun org-export-dispatch (&optional arg)
6094 "Export dispatcher for Org mode.
6096 It provides an access to common export related tasks in a buffer.
6097 Its interface comes in two flavors: standard and expert.
6099 While both share the same set of bindings, only the former
6100 displays the valid keys associations in a dedicated buffer.
6101 Scrolling (resp. line-wise motion) in this buffer is done with
6102 SPC and DEL (resp. C-n and C-p) keys.
6104 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6105 flavor or the other.
6108 of options used back then, on the current buffer.
6110 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6111 (interactive "P")
6112 (let* ((input
6113 (cond ((equal arg '(16)) '(stack))
6114 ((and arg org-export-dispatch-last-action))
6115 (t (save-window-excursion
6116 (unwind-protect
6117 (progn
6118 ;; Remember where we are
6119 (move-marker org-export-dispatch-last-position
6120 (point)
6121 (org-base-buffer (current-buffer)))
6122 ;; Get and store an export command
6123 (setq org-export-dispatch-last-action
6124 (org-export--dispatch-ui
6125 (list org-export-initial-scope
6126 (and org-export-in-background 'async))
6127 nil
6128 org-export-dispatch-use-expert-ui)))
6129 (and (get-buffer "*Org Export Dispatcher*")
6130 (kill-buffer "*Org Export Dispatcher*")))))))
6131 (action (car input))
6132 (optns (cdr input)))
6133 (unless (memq 'subtree optns)
6134 (move-marker org-export-dispatch-last-position nil))
6135 (case action
6136 ;; First handle special hard-coded actions.
6137 (template (org-export-insert-default-template nil optns))
6138 (stack (org-export-stack))
6139 (publish-current-file
6140 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6141 (publish-current-project
6142 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6143 (publish-choose-project
6144 (org-publish (assoc (org-icompleting-read
6145 "Publish project: "
6146 org-publish-project-alist nil t)
6147 org-publish-project-alist)
6148 (memq 'force optns)
6149 (memq 'async optns)))
6150 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6151 (otherwise
6152 (save-excursion
6153 (when arg
6154 ;; Repeating command, maybe move cursor to restore subtree
6155 ;; context.
6156 (if (eq (marker-buffer org-export-dispatch-last-position)
6157 (org-base-buffer (current-buffer)))
6158 (goto-char org-export-dispatch-last-position)
6159 ;; We are in a different buffer, forget position.
6160 (move-marker org-export-dispatch-last-position nil)))
6161 (funcall action
6162 ;; Return a symbol instead of a list to ease
6163 ;; asynchronous export macro use.
6164 (and (memq 'async optns) t)
6165 (and (memq 'subtree optns) t)
6166 (and (memq 'visible optns) t)
6167 (and (memq 'body optns) t)))))))
6169 (defun org-export--dispatch-ui (options first-key expertp)
6170 "Handle interface for `org-export-dispatch'.
6172 OPTIONS is a list containing current interactive options set for
6173 export. It can contain any of the following symbols:
6174 `body' toggles a body-only export
6175 `subtree' restricts export to current subtree
6176 `visible' restricts export to visible part of buffer.
6177 `force' force publishing files.
6178 `async' use asynchronous export process
6180 FIRST-KEY is the key pressed to select the first level menu. It
6181 is nil when this menu hasn't been selected yet.
6183 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6184 buffer is provided, but indications about currently active
6185 options are given in the prompt. Moreover, \[?] allows to switch
6186 back to standard interface."
6187 (let* ((fontify-key
6188 (lambda (key &optional access-key)
6189 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6190 ;; non-nil is the required first-level key to activate
6191 ;; KEY. When its value is t, activate KEY independently
6192 ;; on the first key, if any. A nil value means KEY will
6193 ;; only be activated at first level.
6194 (if (or (eq access-key t) (eq access-key first-key))
6195 (org-propertize key 'face 'org-warning)
6196 key)))
6197 (fontify-value
6198 (lambda (value)
6199 ;; Fontify VALUE string.
6200 (org-propertize value 'face 'font-lock-variable-name-face)))
6201 ;; Prepare menu entries by extracting them from registered
6202 ;; back-ends and sorting them by access key and by ordinal,
6203 ;; if any.
6204 (entries
6205 (sort (sort (delq nil
6206 (mapcar 'org-export-backend-menu
6207 org-export--registered-backends))
6208 (lambda (a b)
6209 (let ((key-a (nth 1 a))
6210 (key-b (nth 1 b)))
6211 (cond ((and (numberp key-a) (numberp key-b))
6212 (< key-a key-b))
6213 ((numberp key-b) t)))))
6214 'car-less-than-car))
6215 ;; Compute a list of allowed keys based on the first key
6216 ;; pressed, if any. Some keys
6217 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6218 ;; available.
6219 (allowed-keys
6220 (nconc (list 2 22 19 6 1)
6221 (if (not first-key) (org-uniquify (mapcar 'car entries))
6222 (let (sub-menu)
6223 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6224 (when (eq (car entry) first-key)
6225 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6226 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6227 ((not first-key) (list ?P)))
6228 (list ?& ?#)
6229 (when expertp (list ??))
6230 (list ?q)))
6231 ;; Build the help menu for standard UI.
6232 (help
6233 (unless expertp
6234 (concat
6235 ;; Options are hard-coded.
6236 (format "[%s] Body only: %s [%s] Visible only: %s
6237 \[%s] Export scope: %s [%s] Force publishing: %s
6239 (funcall fontify-key "C-b" t)
6240 (funcall fontify-value
6241 (if (memq 'body options) "On " "Off"))
6242 (funcall fontify-key "C-v" t)
6243 (funcall fontify-value
6244 (if (memq 'visible options) "On " "Off"))
6245 (funcall fontify-key "C-s" t)
6246 (funcall fontify-value
6247 (if (memq 'subtree options) "Subtree" "Buffer "))
6248 (funcall fontify-key "C-f" t)
6249 (funcall fontify-value
6250 (if (memq 'force options) "On " "Off"))
6251 (funcall fontify-key "C-a" t)
6252 (funcall fontify-value
6253 (if (memq 'async options) "On " "Off")))
6254 ;; Display registered back-end entries. When a key
6255 ;; appears for the second time, do not create another
6256 ;; entry, but append its sub-menu to existing menu.
6257 (let (last-key)
6258 (mapconcat
6259 (lambda (entry)
6260 (let ((top-key (car entry)))
6261 (concat
6262 (unless (eq top-key last-key)
6263 (setq last-key top-key)
6265 (funcall fontify-key (char-to-string top-key))
6266 (nth 1 entry)))
6267 (let ((sub-menu (nth 2 entry)))
6268 (unless (functionp sub-menu)
6269 ;; Split sub-menu into two columns.
6270 (let ((index -1))
6271 (concat
6272 (mapconcat
6273 (lambda (sub-entry)
6274 (incf index)
6275 (format
6276 (if (zerop (mod index 2)) " [%s] %-26s"
6278 (funcall fontify-key
6279 (char-to-string (car sub-entry))
6280 top-key)
6281 (nth 1 sub-entry)))
6282 sub-menu "")
6284 entries ""))
6285 ;; Publishing menu is hard-coded.
6287 [%s] Current file [%s] Current project
6289 (funcall fontify-key "P")
6290 (funcall fontify-key "f" ?P)
6291 (funcall fontify-key "p" ?P)
6292 (funcall fontify-key "x" ?P)
6293 (funcall fontify-key "a" ?P))
6295 (funcall fontify-key "&" t)
6296 (funcall fontify-key "#" t))
6297 (format "[%s] %s"
6298 (funcall fontify-key "q" t)
6299 (if first-key "Main menu" "Exit")))))
6300 ;; Build prompts for both standard and expert UI.
6301 (standard-prompt (unless expertp "Export command: "))
6302 (expert-prompt
6303 (when expertp
6304 (format
6305 "Export command (C-%s%s%s%s%s) [%s]: "
6306 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6307 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6308 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6309 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6310 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6311 (mapconcat (lambda (k)
6312 ;; Strip control characters.
6313 (unless (< k 27) (char-to-string k)))
6314 allowed-keys "")))))
6315 ;; With expert UI, just read key with a fancy prompt. In standard
6316 ;; UI, display an intrusive help buffer.
6317 (if expertp
6318 (org-export--dispatch-action
6319 expert-prompt allowed-keys entries options first-key expertp)
6320 ;; At first call, create frame layout in order to display menu.
6321 (unless (get-buffer "*Org Export Dispatcher*")
6322 (delete-other-windows)
6323 (org-switch-to-buffer-other-window
6324 (get-buffer-create "*Org Export Dispatcher*"))
6325 (setq cursor-type nil
6326 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6327 ;; Make sure that invisible cursor will not highlight square
6328 ;; brackets.
6329 (set-syntax-table (copy-syntax-table))
6330 (modify-syntax-entry ?\[ "w"))
6331 ;; At this point, the buffer containing the menu exists and is
6332 ;; visible in the current window. So, refresh it.
6333 (with-current-buffer "*Org Export Dispatcher*"
6334 ;; Refresh help. Maintain display continuity by re-visiting
6335 ;; previous window position.
6336 (let ((pos (window-start)))
6337 (erase-buffer)
6338 (insert help)
6339 (set-window-start nil pos)))
6340 (org-fit-window-to-buffer)
6341 (org-export--dispatch-action
6342 standard-prompt allowed-keys entries options first-key expertp))))
6344 (defun org-export--dispatch-action
6345 (prompt allowed-keys entries options first-key expertp)
6346 "Read a character from command input and act accordingly.
6348 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6349 a list of characters available at a given step in the process.
6350 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6351 EXPERTP are the same as defined in `org-export--dispatch-ui',
6352 which see.
6354 Toggle export options when required. Otherwise, return value is
6355 a list with action as CAR and a list of interactive export
6356 options as CDR."
6357 (let (key)
6358 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6359 ;; C-p, SPC, DEL).
6360 (while (and (setq key (read-char-exclusive prompt))
6361 (not expertp)
6362 (memq key '(14 16 ?\s ?\d)))
6363 (case key
6364 (14 (if (not (pos-visible-in-window-p (point-max)))
6365 (ignore-errors (scroll-up 1))
6366 (message "End of buffer")
6367 (sit-for 1)))
6368 (16 (if (not (pos-visible-in-window-p (point-min)))
6369 (ignore-errors (scroll-down 1))
6370 (message "Beginning of buffer")
6371 (sit-for 1)))
6372 (?\s (if (not (pos-visible-in-window-p (point-max)))
6373 (scroll-up nil)
6374 (message "End of buffer")
6375 (sit-for 1)))
6376 (?\d (if (not (pos-visible-in-window-p (point-min)))
6377 (scroll-down nil)
6378 (message "Beginning of buffer")
6379 (sit-for 1)))))
6380 (cond
6381 ;; Ignore undefined associations.
6382 ((not (memq key allowed-keys))
6383 (ding)
6384 (unless expertp (message "Invalid key") (sit-for 1))
6385 (org-export--dispatch-ui options first-key expertp))
6386 ;; q key at first level aborts export. At second level, cancel
6387 ;; first key instead.
6388 ((eq key ?q) (if (not first-key) (error "Export aborted")
6389 (org-export--dispatch-ui options nil expertp)))
6390 ;; Help key: Switch back to standard interface if expert UI was
6391 ;; active.
6392 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6393 ;; Send request for template insertion along with export scope.
6394 ((eq key ?#) (cons 'template (memq 'subtree options)))
6395 ;; Switch to asynchronous export stack.
6396 ((eq key ?&) '(stack))
6397 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6398 ((memq key '(2 22 19 6 1))
6399 (org-export--dispatch-ui
6400 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6401 (6 'force) (1 'async))))
6402 (if (memq option options) (remq option options)
6403 (cons option options)))
6404 first-key expertp))
6405 ;; Action selected: Send key and options back to
6406 ;; `org-export-dispatch'.
6407 ((or first-key (functionp (nth 2 (assq key entries))))
6408 (cons (cond
6409 ((not first-key) (nth 2 (assq key entries)))
6410 ;; Publishing actions are hard-coded. Send a special
6411 ;; signal to `org-export-dispatch'.
6412 ((eq first-key ?P)
6413 (case key
6414 (?f 'publish-current-file)
6415 (?p 'publish-current-project)
6416 (?x 'publish-choose-project)
6417 (?a 'publish-all)))
6418 ;; Return first action associated to FIRST-KEY + KEY
6419 ;; path. Indeed, derived backends can share the same
6420 ;; FIRST-KEY.
6421 (t (catch 'found
6422 (mapc (lambda (entry)
6423 (let ((match (assq key (nth 2 entry))))
6424 (when match (throw 'found (nth 2 match)))))
6425 (member (assq first-key entries) entries)))))
6426 options))
6427 ;; Otherwise, enter sub-menu.
6428 (t (org-export--dispatch-ui options key expertp)))))
6432 (provide 'ox)
6434 ;; Local variables:
6435 ;; generated-autoload-file: "org-loaddefs.el"
6436 ;; End:
6438 ;;; ox.el ends here