| blob | 90c623e21532758cf50be8557f5cdc9d31d92e48 |
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 never
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-buffer' :: Original buffer name.
1350 ;; - category :: option
1351 ;; - type :: string
1352 ;;
1353 ;; + `:input-file' :: Full path to input file, if any.
1354 ;; - category :: option
1355 ;; - type :: string or nil
1356 ;;
1357 ;; + `:keywords' :: List of keywords attached to data.
1358 ;; - category :: option
1359 ;; - type :: string
1360 ;;
1361 ;; + `:language' :: Default language used for translations.
1362 ;; - category :: option
1363 ;; - type :: string
1364 ;;
1365 ;; + `:output-file' :: Full path to output file, if any.
1366 ;; - category :: option
1367 ;; - type :: string or nil
1368 ;;
1369 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1370 ;; transcoding.
1371 ;; - category :: option
1372 ;; - type :: list (as returned by `org-element-parse-buffer')
1373 ;;
1374 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1375 ;; all line breaks.
1376 ;; - category :: option
1377 ;; - type :: symbol (nil, t)
1378 ;;
1379 ;; + `:section-numbers' :: Non-nil means transcoding should add
1380 ;; section numbers to headlines.
1381 ;; - category :: option
1382 ;; - type :: symbol (nil, t)
1383 ;;
1384 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1385 ;; in transcoding. When such a tag is present, subtrees without
1386 ;; it are de facto excluded from the process. See
1387 ;; `use-select-tags'.
1388 ;; - category :: option
1389 ;; - type :: list of strings
1390 ;;
1391 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1392 ;; a time stamp in the output.
1393 ;; - category :: option
1394 ;; - type :: symbol (nil, t)
1395 ;;
1396 ;; + `:translate-alist' :: Alist between element and object types and
1397 ;; transcoding functions relative to the current back-end.
1398 ;; Special keys `inner-template', `template' and `plain-text' are
1399 ;; also possible.
1400 ;; - category :: option
1401 ;; - type :: alist (SYMBOL . FUNCTION)
1402 ;;
1403 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1404 ;; also be transcoded. If it is set to the `headline' symbol,
1405 ;; only the archived headline's name is retained.
1406 ;; - category :: option
1407 ;; - type :: symbol (nil, t, `headline')
1408 ;;
1409 ;; + `:with-author' :: Non-nil means author's name should be included
1410 ;; in the output.
1411 ;; - category :: option
1412 ;; - type :: symbol (nil, t)
1413 ;;
1414 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1415 ;; - category :: option
1416 ;; - type :: symbol (nil, t)
1417 ;;
1418 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1419 ;; inserted at the end of the transcoded string. If the value
1420 ;; is `comment', it should be commented.
1421 ;; - category :: option
1422 ;; - type :: symbol (`comment', nil, t)
1423 ;;
1424 ;; + `:with-date' :: Non-nil means output should contain a date.
1425 ;; - category :: option
1426 ;; - type :. symbol (nil, t)
1427 ;;
1428 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1429 ;; its value is a list of names, only drawers with such names
1430 ;; will be transcoded. If that list starts with `not', drawer
1431 ;; with these names will be skipped.
1432 ;; - category :: option
1433 ;; - type :: symbol (nil, t) or list of strings
1434 ;;
1435 ;; + `:with-email' :: Non-nil means output should contain author's
1436 ;; email.
1437 ;; - category :: option
1438 ;; - type :: symbol (nil, t)
1439 ;;
1440 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1441 ;; interpreted.
1442 ;; - category :: option
1443 ;; - type :: symbol (nil, t)
1444 ;;
1445 ;; + `:with-fixed-width' :: Non-nil if transcoder should export
1446 ;; strings starting with a colon as a fixed-with (verbatim) area.
1447 ;; - category :: option
1448 ;; - type :: symbol (nil, t)
1449 ;;
1450 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1451 ;; footnotes.
1452 ;; - category :: option
1453 ;; - type :: symbol (nil, t)
1454 ;;
1455 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1456 ;; `latex-fragment' objects should appear in export output. When
1457 ;; this property is set to `verbatim', they will be left as-is.
1458 ;; - category :: option
1459 ;; - type :: symbol (`verbatim', nil, t)
1460 ;;
1461 ;; + `:with-planning' :: Non-nil means transcoding should include
1462 ;; planning info.
1463 ;; - category :: option
1464 ;; - type :: symbol (nil, t)
1465 ;;
1466 ;; + `:with-priority' :: Non-nil means transcoding should include
1467 ;; priority cookies.
1468 ;; - category :: option
1469 ;; - type :: symbol (nil, t)
1470 ;;
1471 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1472 ;; plain text.
1473 ;; - category :: option
1474 ;; - type :: symbol (nil, t)
1475 ;;
1476 ;; + `:with-special-strings' :: Non-nil means transcoding should
1477 ;; interpret special strings in plain text.
1478 ;; - category :: option
1479 ;; - type :: symbol (nil, t)
1480 ;;
1481 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1482 ;; interpret subscript and superscript. With a value of "{}",
1483 ;; only interpret those using curly brackets.
1484 ;; - category :: option
1485 ;; - type :: symbol (nil, {}, t)
1486 ;;
1487 ;; + `:with-tables' :: Non-nil means transcoding should export tables.
1488 ;; - category :: option
1489 ;; - type :: symbol (nil, t)
1490 ;;
1491 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1492 ;; headlines. A `not-in-toc' value will remove them from the
1493 ;; table of contents, if any, nonetheless.
1494 ;; - category :: option
1495 ;; - type :: symbol (nil, t, `not-in-toc')
1496 ;;
1497 ;; + `:with-tasks' :: Non-nil means transcoding should include
1498 ;; headlines with a TODO keyword. A `todo' value will only
1499 ;; include headlines with a todo type keyword while a `done'
1500 ;; value will do the contrary. If a list of strings is provided,
1501 ;; only tasks with keywords belonging to that list will be kept.
1502 ;; - category :: option
1503 ;; - type :: symbol (t, todo, done, nil) or list of strings
1504 ;;
1505 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1506 ;; time stamps. Special value `active' (resp. `inactive') ask to
1507 ;; export only active (resp. inactive) timestamps. Otherwise,
1508 ;; completely remove them.
1509 ;; - category :: option
1510 ;; - type :: symbol: (`active', `inactive', t, nil)
1511 ;;
1512 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1513 ;; added to the output. An integer value limits its depth.
1514 ;; - category :: option
1515 ;; - type :: symbol (nil, t or integer)
1516 ;;
1517 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1518 ;; include TODO keywords.
1519 ;; - category :: option
1520 ;; - type :: symbol (nil, t)
1523 ;;;; Environment Options
1524 ;;
1525 ;; Environment options encompass all parameters defined outside the
1526 ;; scope of the parsed data. They come from five sources, in
1527 ;; increasing precedence order:
1528 ;;
1529 ;; - Global variables,
1530 ;; - Buffer's attributes,
1531 ;; - Options keyword symbols,
1532 ;; - Buffer keywords,
1533 ;; - Subtree properties.
1534 ;;
1535 ;; The central internal function with regards to environment options
1536 ;; is `org-export-get-environment'. It updates global variables with
1537 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1538 ;; the different sources.
1539 ;;
1540 ;; The internal functions doing the retrieval are:
1541 ;; `org-export--get-global-options',
1542 ;; `org-export--get-buffer-attributes',
1543 ;; `org-export--parse-option-keyword',
1544 ;; `org-export--get-subtree-options' and
1545 ;; `org-export--get-inbuffer-options'
1546 ;;
1547 ;; Also, `org-export--list-bound-variables' collects bound variables
1548 ;; along with their value in order to set them as buffer local
1549 ;; variables later in the process.
1552 "Collect export options from the current buffer.
1554 Optional argument BACKEND is an export back-end, as returned by
1555 `org-export-create-backend'.
1557 When optional argument SUBTREEP is non-nil, assume the export is
1558 done against the current sub-tree.
1560 Third optional argument EXT-PLIST is a property list with
1561 external parameters overriding Org default settings, but still
1562 inferior to file-local settings."
1563 ;; First install #+BIND variables since these must be set before
1564 ;; global options are read.
1567 ;; Get and prioritize export options...
1569 ;; ... from global variables...
1571 ;; ... from an external property list...
1572 ext-plist
1573 ;; ... from in-buffer settings...
1575 ;; ... and from subtree, when appropriate.
1577 ;; Eventually add misc. properties.
1579 :back-end
1580 backend
1582 :footnote-definition-alist
1583 ;; Footnotes definitions must be collected in the original
1584 ;; buffer, as there's no insurance that they will still be in
1585 ;; the parse tree, due to possible narrowing.
1601 alist))
1613 alist)))))))
1614 alist))
1615 :id-alist
1616 ;; Collect id references.
1627 alist))))
1630 "Parse an OPTIONS line and return values as a plist.
1631 Optional argument BACKEND is an export back-end, as returned by,
1632 e.g., `org-export-create-backend'. It specifies which back-end
1633 specific items to read, if any."
1635 ;; Priority is given to back-end specific options.
1637 org-export-options-alist))
1638 plist)
1647 options))
1649 property
1652 plist))
1655 "Get export options in subtree at point.
1656 Optional argument BACKEND is an export back-end, as returned by,
1657 e.g., `org-export-create-backend'. It specifies back-end used
1658 for export. Return options as a plist."
1659 ;; For each buffer keyword, create a headline property setting the
1660 ;; same property in communication channel. The name for the property
1661 ;; is the keyword with "EXPORT_" appended to it.
1664 ;; Make sure point is at a heading.
1666 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1667 ;; title (with no todo keyword, priority cookie or tag) as its
1668 ;; fallback value.
1674 plist :title
1677 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1681 ;; Handle other keywords. TITLE keyword is excluded as it has
1682 ;; been handled already.
1690 ;; Export properties are not case-sensitive.
1697 plist
1698 property
1700 ;; Parse VALUE if required.
1704 ;; If BEHAVIOR is `split' expected value is
1705 ;; a list of strings, not a string.
1708 ;; Look for both general keywords and back-end specific
1709 ;; options, with priority given to the latter.
1711 org-export-options-alist)))
1712 ;; Return value.
1713 plist)))
1716 "Return current buffer export options, as a plist.
1718 Optional argument BACKEND, when non-nil, is an export back-end,
1719 as returned by, e.g., `org-export-create-backend'. It specifies
1720 which back-end specific options should also be read in the
1721 process.
1723 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1725 get-options ; For byte-compiler.
1728 ;; Priority is given to back-end specific options.
1730 org-export-options-alist))
1733 org-export-special-keywords))))
1736 ;; Return all properties associated to KEYWORD.
1743 ;; Recursively read keywords in buffer. FILES is a list
1744 ;; of files read so far. PLIST is the current property
1745 ;; list obtained.
1754 ;; Options in `org-export-special-keywords'.
1758 ;; Avoid circular dependencies.
1768 plist
1773 plist
1779 ;; Options in `org-export-options-alist'.
1784 plist property
1785 ;; Handle value depending on specified
1786 ;; BEHAVIOR.
1792 " "
1805 ;; Return final value.
1806 plist))))
1807 ;; Read options in the current buffer.
1810 ;; Parse keywords specified in `org-element-document-properties'
1811 ;; and return PLIST.
1822 "Return properties related to buffer attributes, as a plist."
1827 "Return global export options as a plist.
1828 Optional argument BACKEND, if non-nil, is an export back-end, as
1829 returned by, e.g., `org-export-create-backend'. It specifies
1830 which back-end specific export options should also be read in the
1831 process."
1833 ;; Priority is given to back-end specific options.
1835 org-export-options-alist)))
1841 plist
1842 prop
1843 ;; Evaluate default value provided. If keyword is
1844 ;; a member of `org-element-document-properties',
1845 ;; parse it as a secondary string before storing it.
1849 org-element-document-properties))
1852 value)))))))))
1855 "Return variables bound from BIND keywords in current buffer.
1856 Also look for BIND keywords in setup files. The return value is
1857 an alist where associations are (VARIABLE-NAME VALUE)."
1862 ;; Return an alist between variable names and their
1863 ;; value. FILES is a list of setup files names read so
1864 ;; far, used to avoid circular dependencies. ALIST is
1865 ;; the alist collected so far.
1876 ;; Enter setup file.
1886 alist))))))))))
1887 alist)))))
1888 ;; Return value in appropriate order of appearance.
1891 ;; defsubst org-export-get-parent must be defined before first use,
1892 ;; was originally defined in the topology section
1895 "Return BLOB parent or nil.
1896 BLOB is the element or object considered."
1899 ;;;; Tree Properties
1900 ;;
1901 ;; Tree properties are information extracted from parse tree. They
1902 ;; are initialized at the beginning of the transcoding process by
1903 ;; `org-export-collect-tree-properties'.
1904 ;;
1905 ;; Dedicated functions focus on computing the value of specific tree
1906 ;; properties during initialization. Thus,
1907 ;; `org-export--populate-ignore-list' lists elements and objects that
1908 ;; should be skipped during export, `org-export--get-min-level' gets
1909 ;; the minimal exportable level, used as a basis to compute relative
1910 ;; level for headlines. Eventually
1911 ;; `org-export--collect-headline-numbering' builds an alist between
1912 ;; headlines and their numbering.
1915 "Extract tree properties from parse tree.
1917 DATA is the parse tree from which information is retrieved. INFO
1918 is a list holding export options.
1920 Following tree properties are set or updated:
1922 `:exported-data' Hash table used to memoize results from
1923 `org-export-data'.
1925 `:footnote-definition-alist' List of footnotes definitions in
1926 original buffer and current parse tree.
1928 `:headline-offset' Offset between true level of headlines and
1929 local level. An offset of -1 means a headline
1930 of level 2 should be considered as a level
1931 1 headline in the context.
1933 `:headline-numbering' Alist of all headlines as key an the
1934 associated numbering as value.
1936 `:ignore-list' List of elements that should be ignored during
1937 export.
1939 Return updated plist."
1940 ;; Install the parse tree in the communication channel, in order to
1941 ;; use `org-export-get-genealogy' and al.
1943 ;; Get the list of elements and objects to ignore, and put it into
1944 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1945 ;; been done during parse tree filtering.
1948 :ignore-list
1951 ;; Compute `:headline-offset' in order to be able to use
1952 ;; `org-export-get-relative-level'.
1955 :headline-offset
1957 ;; Footnote definitions in parse tree override those stored in
1958 ;; `:footnote-definition-alist'. This way, any change to
1959 ;; a definition in the parse tree (e.g., through a parse tree
1960 ;; filter) propagates into the alist.
1967 defs))
1971 defs)))))
1973 ;; Properties order doesn't matter: get the rest of the tree
1974 ;; properties.
1978 info))
1981 "Return minimum exportable headline's level in DATA.
1982 DATA is parsed tree as returned by `org-element-parse-buffer'.
1983 OPTIONS is a plist holding export options."
1994 ;; If no headline was found, for the sake of consistency, set
1995 ;; minimum level to 1 nonetheless.
1999 "Return numbering of all exportable headlines in a parse tree.
2001 DATA is the parse tree. OPTIONS is the plist holding export
2002 options.
2004 Return an alist whose key is a headline and value is its
2005 associated numbering \(in the shape of a list of numbers\) or nil
2006 for a footnotes section."
2014 headline
2016 for idx from 0 to org-export-max-depth
2020 options)))
2023 "Return list of elements and objects to ignore during export.
2024 DATA is the parse tree to traverse. OPTIONS is the plist holding
2025 export options."
2027 ;; First find trees containing a select tag, if any.
2029 ;; If a select tag is active, also ignore the section before
2030 ;; the first headline, if any.
2034 first-element))))
2037 ;; Collect ignored elements or objects into IGNORE-LIST.
2043 ;; If headline is archived but tree below has
2044 ;; to be skipped, add it to ignore list.
2047 ;; Move into secondary string, if any.
2052 ;; Move into recursive objects/elements.
2054 ;; Main call.
2056 ;; Return value.
2057 ignore))
2060 "Return list of headlines and inlinetasks with a select tag in their tree.
2061 DATA is parsed data as returned by `org-element-parse-buffer'.
2062 INFO is a plist holding export options."
2064 walk-data ; For byte-compiler.
2074 ;; When a select tag is found, mark full
2075 ;; genealogy and every headline within the tree
2076 ;; as acceptable.
2079 genealogy
2082 selected-trees))
2083 ;; If at a headline, continue searching in tree,
2084 ;; recursively.
2094 selected-trees))
2097 "Non-nil when element or object BLOB should be skipped during export.
2098 OPTIONS is the plist holding export options. SELECTED, when
2099 non-nil, is a list of headlines or inlinetasks belonging to
2100 a tree with a select tag."
2107 ;; If `:with-drawers' value starts with `not', ignore
2108 ;; every drawer whose name belong to that list.
2109 ;; Otherwise, ignore drawers whose name isn't in that
2110 ;; list.
2127 ;; Ignore subtrees with an exclude tag.
2130 ;; When a select tag is present in the buffer, ignore any tree
2131 ;; without it.
2133 ;; Ignore commented sub-trees.
2135 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2137 ;; Ignore tasks, if specified by `:with-tasks' property.
2149 properties-set))))))
2160 ;; `:with-timestamps' only applies to isolated timestamps
2161 ;; objects, i.e. timestamp objects in a paragraph containing only
2162 ;; timestamps and whitespaces.
2170 options t))))
2179 \f
2180 ;;; The Transcoder
2181 ;;
2182 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2183 ;; `org-element-parse-buffer') and transcodes it into a specified
2184 ;; back-end output. It takes care of filtering out elements or
2185 ;; objects according to export options and organizing the output blank
2186 ;; lines and white space are preserved. The function memoizes its
2187 ;; results, so it is cheap to call it within transcoders.
2188 ;;
2189 ;; It is possible to modify locally the back-end used by
2190 ;; `org-export-data' or even use a temporary back-end by using
2191 ;; `org-export-data-with-backend'.
2192 ;;
2193 ;; Internally, three functions handle the filtering of objects and
2194 ;; elements during the export. In particular,
2195 ;; `org-export-ignore-element' marks an element or object so future
2196 ;; parse tree traversals skip it and `org-export-expand' transforms
2197 ;; the others back into their original shape.
2198 ;;
2199 ;; `org-export-transcoder' is an accessor returning appropriate
2200 ;; translator function for a given element or object.
2203 "Return appropriate transcoder for BLOB.
2204 INFO is a plist containing export directives."
2206 ;; Return contents only for complete parse trees.
2212 "Convert DATA into current back-end format.
2214 DATA is a parse tree, an element or an object or a secondary
2215 string. INFO is a plist holding export options.
2217 Return a string."
2222 ;; Ignored element/object.
2224 ;; Plain text.
2230 info))
2231 ;; Secondary string.
2234 ;; Element/Object without contents or, as a special
2235 ;; case, headline with archive tag and archived trees
2236 ;; restricted to title only.
2244 ;; Export snippets never return a nil value so
2245 ;; that white spaces following them are never
2246 ;; ignored.
2248 ;; Element/Object with contents.
2261 ;; Elements directly containing
2262 ;; objects must have their indentation
2263 ;; normalized first.
2265 data
2266 ;; When normalizing contents of the
2267 ;; first paragraph in an item or
2268 ;; a footnote definition, ignore
2269 ;; first line's indentation: there is
2270 ;; none and it might be misleading.
2275 data)
2282 info))))))))
2283 ;; Final result will be memoized before being returned.
2285 data
2289 ;; Append the same white space between elements or objects
2290 ;; as in the original buffer, and call appropriate filters.
2301 info)))
2302 results)))
2306 "Convert DATA into BACKEND format.
2308 DATA is an element, an object, a secondary string or a string.
2309 BACKEND is a symbol. INFO is a plist used as a communication
2310 channel.
2312 Unlike to `org-export-with-backend', this function will
2313 recursively convert DATA using BACKEND translation table."
2316 data
2317 ;; Set-up a new communication channel with translations defined in
2318 ;; BACKEND as the translate table and a new hash table for
2319 ;; memoization.
2321 info
2324 ;; Size of the hash table is reduced since this function
2325 ;; will probably be used on small trees.
2329 "Change uninterpreted elements back into Org syntax.
2330 DATA is the parse tree. INFO is a plist containing export
2331 options. Each uninterpreted element or object is changed back
2332 into a string. Contents, if any, are not modified. The parse
2333 tree is modified by side effect and returned by the function."
2337 prop
2340 info))))
2343 "Change uninterpreted elements back into Org syntax.
2344 DATA is a parse tree or a secondary string. INFO is a plist
2345 containing export options. It is modified by side effect and
2346 returned by the function."
2349 subscript superscript underline)
2353 ;; ... entities...
2360 ?\s)))))
2361 ;; ... emphasis...
2373 marker
2377 ?\s)))))))
2378 ;; ... LaTeX environments and fragments...
2382 ;; ... sub/superscripts...
2391 "_"
2400 ?\s)))))))))))
2402 ;; Splice NEW at BLOB location in parse tree.
2405 info)
2406 ;; Return modified parse tree.
2407 data)
2410 "Expand a parsed element or object to its original state.
2412 BLOB is either an element or an object. CONTENTS is its
2413 contents, as a string or nil.
2415 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2416 keywords before output."
2421 blob contents))))
2424 "Add ELEMENT to `:ignore-list' in INFO.
2426 Any element in `:ignore-list' will be skipped when using
2427 `org-element-map'. INFO is modified by side effects."
2431 \f
2432 ;;; The Filter System
2433 ;;
2434 ;; Filters allow end-users to tweak easily the transcoded output.
2435 ;; They are the functional counterpart of hooks, as every filter in
2436 ;; a set is applied to the return value of the previous one.
2437 ;;
2438 ;; Every set is back-end agnostic. Although, a filter is always
2439 ;; called, in addition to the string it applies to, with the back-end
2440 ;; used as argument, so it's easy for the end-user to add back-end
2441 ;; specific filters in the set. The communication channel, as
2442 ;; a plist, is required as the third argument.
2443 ;;
2444 ;; From the developer side, filters sets can be installed in the
2445 ;; process with the help of `org-export-define-backend', which
2446 ;; internally stores filters as an alist. Each association has a key
2447 ;; among the following symbols and a function or a list of functions
2448 ;; as value.
2449 ;;
2450 ;; - `:filter-options' applies to the property list containing export
2451 ;; options. Unlike to other filters, functions in this list accept
2452 ;; two arguments instead of three: the property list containing
2453 ;; export options and the back-end. Users can set its value through
2454 ;; `org-export-filter-options-functions' variable.
2455 ;;
2456 ;; - `:filter-parse-tree' applies directly to the complete parsed
2457 ;; tree. Users can set it through
2458 ;; `org-export-filter-parse-tree-functions' variable.
2459 ;;
2460 ;; - `:filter-body' applies to the body of the output, before template
2461 ;; translator chimes in. Users can set it through
2462 ;; `org-export-filter-body-functions' variable.
2463 ;;
2464 ;; - `:filter-final-output' applies to the final transcoded string.
2465 ;; Users can set it with `org-export-filter-final-output-functions'
2466 ;; variable.
2467 ;;
2468 ;; - `:filter-plain-text' applies to any string not recognized as Org
2469 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2470 ;; configure it.
2471 ;;
2472 ;; - `:filter-TYPE' applies on the string returned after an element or
2473 ;; object of type TYPE has been transcoded. A user can modify
2474 ;; `org-export-filter-TYPE-functions' to install these filters.
2475 ;;
2476 ;; All filters sets are applied with
2477 ;; `org-export-filter-apply-functions' function. Filters in a set are
2478 ;; applied in a LIFO fashion. It allows developers to be sure that
2479 ;; their filters will be applied first.
2480 ;;
2481 ;; Filters properties are installed in communication channel with
2482 ;; `org-export-install-filters' function.
2483 ;;
2484 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2485 ;; `org-export-before-parsing-hook') are run at the beginning of the
2486 ;; export process and just before parsing to allow for heavy structure
2487 ;; modifications.
2490 ;;;; Hooks
2493 "Hook run at the beginning of the export process.
2495 This is run before include keywords and macros are expanded and
2496 Babel code blocks executed, on a copy of the original buffer
2497 being exported. Visibility and narrowing are preserved. Point
2498 is at the beginning of the buffer.
2500 Every function in this hook will be called with one argument: the
2504 "Hook run before parsing an export buffer.
2506 This is run after include keywords and macros have been expanded
2507 and Babel code blocks executed, on a copy of the original buffer
2508 being exported. Visibility and narrowing are preserved. Point
2509 is at the beginning of the buffer.
2511 Every function in this hook will be called with one argument: the
2515 ;;;; Special Filters
2518 "List of functions applied to the export options.
2519 Each filter is called with two arguments: the export options, as
2520 a plist, and the back-end, as a symbol. It must return
2524 "List of functions applied to the parsed tree.
2525 Each filter is called with three arguments: the parse tree, as
2526 returned by `org-element-parse-buffer', the back-end, as
2527 a symbol, and the communication channel, as a plist. It must
2531 "List of functions applied to plain text.
2532 Each filter is called with three arguments: a string which
2533 contains no Org syntax, the back-end, as a symbol, and the
2534 communication channel, as a plist. It must return a string or
2538 "List of functions applied to transcoded body.
2539 Each filter is called with three arguments: a string which
2540 contains no Org syntax, the back-end, as a symbol, and the
2541 communication channel, as a plist. It must return a string or
2545 "List of functions applied to the transcoded string.
2546 Each filter is called with three arguments: the full transcoded
2547 string, the back-end, as a symbol, and the communication channel,
2548 as a plist. It must return a string that will be used as the
2552 ;;;; Elements Filters
2555 "List of functions applied to a transcoded babel-call.
2556 Each filter is called with three arguments: the transcoded data,
2557 as a string, the back-end, as a symbol, and the communication
2561 "List of functions applied to a transcoded center block.
2562 Each filter is called with three arguments: the transcoded data,
2563 as a string, the back-end, as a symbol, and the communication
2567 "List of functions applied to a transcoded clock.
2568 Each filter is called with three arguments: the transcoded data,
2569 as a string, the back-end, as a symbol, and the communication
2573 "List of functions applied to a transcoded comment.
2574 Each filter is called with three arguments: the transcoded data,
2575 as a string, the back-end, as a symbol, and the communication
2579 "List of functions applied to a transcoded comment-block.
2580 Each filter is called with three arguments: the transcoded data,
2581 as a string, the back-end, as a symbol, and the communication
2585 "List of functions applied to a transcoded diary-sexp.
2586 Each filter is called with three arguments: the transcoded data,
2587 as a string, the back-end, as a symbol, and the communication
2591 "List of functions applied to a transcoded drawer.
2592 Each filter is called with three arguments: the transcoded data,
2593 as a string, the back-end, as a symbol, and the communication
2597 "List of functions applied to a transcoded dynamic-block.
2598 Each filter is called with three arguments: the transcoded data,
2599 as a string, the back-end, as a symbol, and the communication
2603 "List of functions applied to a transcoded example-block.
2604 Each filter is called with three arguments: the transcoded data,
2605 as a string, the back-end, as a symbol, and the communication
2609 "List of functions applied to a transcoded export-block.
2610 Each filter is called with three arguments: the transcoded data,
2611 as a string, the back-end, as a symbol, and the communication
2615 "List of functions applied to a transcoded fixed-width.
2616 Each filter is called with three arguments: the transcoded data,
2617 as a string, the back-end, as a symbol, and the communication
2621 "List of functions applied to a transcoded footnote-definition.
2622 Each filter is called with three arguments: the transcoded data,
2623 as a string, the back-end, as a symbol, and the communication
2627 "List of functions applied to a transcoded headline.
2628 Each filter is called with three arguments: the transcoded data,
2629 as a string, the back-end, as a symbol, and the communication
2633 "List of functions applied to a transcoded horizontal-rule.
2634 Each filter is called with three arguments: the transcoded data,
2635 as a string, the back-end, as a symbol, and the communication
2639 "List of functions applied to a transcoded inlinetask.
2640 Each filter is called with three arguments: the transcoded data,
2641 as a string, the back-end, as a symbol, and the communication
2645 "List of functions applied to a transcoded item.
2646 Each filter is called with three arguments: the transcoded data,
2647 as a string, the back-end, as a symbol, and the communication
2651 "List of functions applied to a transcoded keyword.
2652 Each filter is called with three arguments: the transcoded data,
2653 as a string, the back-end, as a symbol, and the communication
2657 "List of functions applied to a transcoded latex-environment.
2658 Each filter is called with three arguments: the transcoded data,
2659 as a string, the back-end, as a symbol, and the communication
2663 "List of functions applied to a transcoded node-property.
2664 Each filter is called with three arguments: the transcoded data,
2665 as a string, the back-end, as a symbol, and the communication
2669 "List of functions applied to a transcoded paragraph.
2670 Each filter is called with three arguments: the transcoded data,
2671 as a string, the back-end, as a symbol, and the communication
2675 "List of functions applied to a transcoded plain-list.
2676 Each filter is called with three arguments: the transcoded data,
2677 as a string, the back-end, as a symbol, and the communication
2681 "List of functions applied to a transcoded planning.
2682 Each filter is called with three arguments: the transcoded data,
2683 as a string, the back-end, as a symbol, and the communication
2687 "List of functions applied to a transcoded property-drawer.
2688 Each filter is called with three arguments: the transcoded data,
2689 as a string, the back-end, as a symbol, and the communication
2693 "List of functions applied to a transcoded quote block.
2694 Each filter is called with three arguments: the transcoded quote
2695 data, as a string, the back-end, as a symbol, and the
2696 communication channel, as a plist. It must return a string or
2700 "List of functions applied to a transcoded section.
2701 Each filter is called with three arguments: the transcoded data,
2702 as a string, the back-end, as a symbol, and the communication
2706 "List of functions applied to a transcoded special block.
2707 Each filter is called with three arguments: the transcoded data,
2708 as a string, the back-end, as a symbol, and the communication
2712 "List of functions applied to a transcoded src-block.
2713 Each filter is called with three arguments: the transcoded data,
2714 as a string, the back-end, as a symbol, and the communication
2718 "List of functions applied to a transcoded table.
2719 Each filter is called with three arguments: the transcoded data,
2720 as a string, the back-end, as a symbol, and the communication
2724 "List of functions applied to a transcoded table-cell.
2725 Each filter is called with three arguments: the transcoded data,
2726 as a string, the back-end, as a symbol, and the communication
2730 "List of functions applied to a transcoded table-row.
2731 Each filter is called with three arguments: the transcoded data,
2732 as a string, the back-end, as a symbol, and the communication
2736 "List of functions applied to a transcoded verse block.
2737 Each filter is called with three arguments: the transcoded data,
2738 as a string, the back-end, as a symbol, and the communication
2742 ;;;; Objects Filters
2745 "List of functions applied to transcoded bold text.
2746 Each filter is called with three arguments: the transcoded data,
2747 as a string, the back-end, as a symbol, and the communication
2751 "List of functions applied to transcoded code text.
2752 Each filter is called with three arguments: the transcoded data,
2753 as a string, the back-end, as a symbol, and the communication
2757 "List of functions applied to a transcoded entity.
2758 Each filter is called with three arguments: the transcoded data,
2759 as a string, the back-end, as a symbol, and the communication
2763 "List of functions applied to a transcoded export-snippet.
2764 Each filter is called with three arguments: the transcoded data,
2765 as a string, the back-end, as a symbol, and the communication
2769 "List of functions applied to a transcoded footnote-reference.
2770 Each filter is called with three arguments: the transcoded data,
2771 as a string, the back-end, as a symbol, and the communication
2775 "List of functions applied to a transcoded inline-babel-call.
2776 Each filter is called with three arguments: the transcoded data,
2777 as a string, the back-end, as a symbol, and the communication
2781 "List of functions applied to a transcoded inline-src-block.
2782 Each filter is called with three arguments: the transcoded data,
2783 as a string, the back-end, as a symbol, and the communication
2787 "List of functions applied to transcoded italic text.
2788 Each filter is called with three arguments: the transcoded data,
2789 as a string, the back-end, as a symbol, and the communication
2793 "List of functions applied to a transcoded latex-fragment.
2794 Each filter is called with three arguments: the transcoded data,
2795 as a string, the back-end, as a symbol, and the communication
2799 "List of functions applied to a transcoded line-break.
2800 Each filter is called with three arguments: the transcoded data,
2801 as a string, the back-end, as a symbol, and the communication
2805 "List of functions applied to a transcoded link.
2806 Each filter is called with three arguments: the transcoded data,
2807 as a string, the back-end, as a symbol, and the communication
2811 "List of functions applied to a transcoded radio-target.
2812 Each filter is called with three arguments: the transcoded data,
2813 as a string, the back-end, as a symbol, and the communication
2817 "List of functions applied to a transcoded statistics-cookie.
2818 Each filter is called with three arguments: the transcoded data,
2819 as a string, the back-end, as a symbol, and the communication
2823 "List of functions applied to transcoded strike-through text.
2824 Each filter is called with three arguments: the transcoded data,
2825 as a string, the back-end, as a symbol, and the communication
2829 "List of functions applied to a transcoded subscript.
2830 Each filter is called with three arguments: the transcoded data,
2831 as a string, the back-end, as a symbol, and the communication
2835 "List of functions applied to a transcoded superscript.
2836 Each filter is called with three arguments: the transcoded data,
2837 as a string, the back-end, as a symbol, and the communication
2841 "List of functions applied to a transcoded target.
2842 Each filter is called with three arguments: the transcoded data,
2843 as a string, the back-end, as a symbol, and the communication
2847 "List of functions applied to a transcoded timestamp.
2848 Each filter is called with three arguments: the transcoded data,
2849 as a string, the back-end, as a symbol, and the communication
2853 "List of functions applied to transcoded underline text.
2854 Each filter is called with three arguments: the transcoded data,
2855 as a string, the back-end, as a symbol, and the communication
2859 "List of functions applied to transcoded verbatim text.
2860 Each filter is called with three arguments: the transcoded data,
2861 as a string, the back-end, as a symbol, and the communication
2865 ;;;; Filters Tools
2866 ;;
2867 ;; Internal function `org-export-install-filters' installs filters
2868 ;; hard-coded in back-ends (developer filters) and filters from global
2869 ;; variables (user filters) in the communication channel.
2870 ;;
2871 ;; Internal function `org-export-filter-apply-functions' takes care
2872 ;; about applying each filter in order to a given data. It ignores
2873 ;; filters returning a nil value but stops whenever a filter returns
2874 ;; an empty string.
2877 "Call every function in FILTERS.
2879 Functions are called with arguments VALUE, current export
2880 back-end's name and INFO. A function returning a nil value will
2881 be skipped. If it returns the empty string, the process ends and
2882 VALUE is ignored.
2884 Call is done in a LIFO fashion, to be sure that developer
2885 specified filters, if any, are called first."
2896 "Install filters properties in communication channel.
2897 INFO is a plist containing the current communication channel.
2898 Return the updated communication channel."
2900 ;; Install user-defined filters with `org-export-filters-alist'
2901 ;; and filters already in INFO (through ext-plist mechanism).
2908 ;; Filters in INFO will be called
2909 ;; before those user provided.
2912 default-value)))))
2913 org-export-filters-alist)
2914 ;; Prepend back-end specific filters to that list.
2916 ;; Single values get consed, lists are appended.
2921 plist key
2925 ;; Return new communication channel.
2929 \f
2930 ;;; Core functions
2931 ;;
2932 ;; This is the room for the main function, `org-export-as', along with
2933 ;; its derivative, `org-export-string-as'.
2934 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2935 ;; function should be added to kill ring.
2936 ;;
2937 ;; Note that `org-export-as' doesn't really parse the current buffer,
2938 ;; but a copy of it (with the same buffer-local variables and
2939 ;; visibility), where macros and include keywords are expanded and
2940 ;; Babel blocks are executed, if appropriate.
2941 ;; `org-export-with-buffer-copy' macro prepares that copy.
2942 ;;
2943 ;; File inclusion is taken care of by
2944 ;; `org-export-expand-include-keyword' and
2945 ;; `org-export--prepare-file-contents'. Structure wise, including
2946 ;; a whole Org file in a buffer often makes little sense. For
2947 ;; example, if the file contains a headline and the include keyword
2948 ;; was within an item, the item should contain the headline. That's
2949 ;; why file inclusion should be done before any structure can be
2950 ;; associated to the file, that is before parsing.
2951 ;;
2952 ;; `org-export-insert-default-template' is a command to insert
2953 ;; a default template (or a back-end specific template) at point or in
2954 ;; current subtree.
2957 "Return a copy of the current buffer.
2958 The copy preserves Org buffer-local variables, visibility and
2959 narrowing."
2965 new-buf))
2968 "Apply BODY in a copy of the current buffer.
2969 The copy preserves local variables, visibility and contents of
2970 the original buffer. Point is at the beginning of the buffer
2971 when BODY is applied."
2980 ;; Kill copy without confirmation.
2986 "Generate a function duplicating BUFFER.
2988 The copy will preserve local variables, visibility, contents and
2989 narrowing of the original buffer. If a region was active in
2990 BUFFER, contents will be narrowed to that region instead.
2992 The resulting function can be evaluated at a later time, from
2993 another buffer, effectively cloning the original buffer there.
2995 The function assumes BUFFER's major mode is `org-mode'."
2999 ;; Set major mode. Ignore `org-mode-hook' as it has been run
3000 ;; already in BUFFER.
3002 ;; Copy specific buffer local variables and variables set
3003 ;; through BIND keywords.
3005 vars)
3013 buffer-file-name
3014 buffer-file-coding-system))
3018 ;; Skip unreadable values, as they cannot be
3019 ;; sent to external process.
3023 vars))))))
3024 ;; Whole buffer contents.
3029 ;; Narrowing.
3033 ;; Current position of point.
3035 ;; Overlays with invisible property.
3045 ov-set))))
3047 ov-set)))))
3049 ;;;###autoload
3052 "Transcode current Org buffer into BACKEND code.
3054 BACKEND is either an export back-end, as returned by, e.g.,
3055 `org-export-create-backend', or a symbol referring to
3056 a registered back-end.
3058 If narrowing is active in the current buffer, only transcode its
3059 narrowed part.
3061 If a region is active, transcode that region.
3063 When optional argument SUBTREEP is non-nil, transcode the
3064 sub-tree at point, extracting information from the headline
3065 properties first.
3067 When optional argument VISIBLE-ONLY is non-nil, don't export
3068 contents of hidden elements.
3070 When optional argument BODY-ONLY is non-nil, only return body
3071 code, without surrounding template.
3073 Optional argument EXT-PLIST, when provided, is a property list
3074 with external parameters overriding Org default settings, but
3075 still inferior to file-local settings.
3077 Return code as a string."
3082 ;; Narrow buffer to an appropriate region or subtree for
3083 ;; parsing. If parsing subtree, be sure to remove main headline
3084 ;; too.
3092 ;; Initialize communication channel with original buffer
3093 ;; attributes, unavailable in its copy.
3102 tree)
3103 ;; Update communication channel and get parse tree. Buffer
3104 ;; isn't parsed directly. Instead, a temporary copy is
3105 ;; created, where include keywords, macros are expanded and
3106 ;; code blocks are evaluated.
3108 ;; Run first hook with current back-end's name as argument.
3112 ;; Update macro templates since #+INCLUDE keywords might have
3113 ;; added some new ones.
3117 ;; Update radio targets since keyword inclusion might have
3118 ;; added some more.
3120 ;; Run last hook with current back-end's name as argument.
3125 ;; Update communication channel with environment. Also
3126 ;; install user's and developer's filters.
3131 ;; Expand export-specific set of macros: {{{author}}},
3132 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3133 ;; once regular macros have been expanded, since document
3134 ;; keywords may contain one of them.
3140 ;; EMAIL is not a parsed keyword: store it as-is.
3144 ;; Parse buffer.
3146 ;; Handle left-over uninterpreted elements or objects in
3147 ;; parse tree and communication channel.
3149 ;; Call options filters and update export options. We do not
3150 ;; use `org-export-filter-apply-functions' here since the
3151 ;; arity of such filters is different.
3156 ;; Parse buffer, handle uninterpreted elements or objects,
3157 ;; then call parse-tree filters.
3161 ;; Now tree is complete, compute its properties and add them
3162 ;; to communication channel.
3166 ;; Eventually transcode TREE. Wrap the resulting string into
3167 ;; a template.
3176 info))
3179 ;; Remove all text properties since they cannot be
3180 ;; retrieved from an external process. Finally call
3181 ;; final-output filter and return result.
3187 info))))))))
3189 ;;;###autoload
3191 "Transcode STRING into BACKEND code.
3193 BACKEND is either an export back-end, as returned by, e.g.,
3194 `org-export-create-backend', or a symbol referring to
3195 a registered back-end.
3197 When optional argument BODY-ONLY is non-nil, only return body
3198 code, without preamble nor postamble.
3200 Optional argument EXT-PLIST, when provided, is a property list
3201 with external parameters overriding Org default settings, but
3202 still inferior to file-local settings.
3204 Return code as a string."
3210 ;;;###autoload
3212 "Replace the active region by its export to BACKEND.
3213 BACKEND is either an export back-end, as returned by, e.g.,
3214 `org-export-create-backend', or a symbol referring to
3215 a registered back-end."
3225 ;;;###autoload
3227 "Insert all export keywords with default values at beginning of line.
3229 BACKEND is a symbol referring to the name of a registered export
3230 back-end, for which specific export options should be added to
3231 the template, or `default' for default template. When it is nil,
3232 the user will be prompted for a category.
3234 If SUBTREEP is non-nil, export configuration will be set up
3235 locally for the subtree through node properties."
3245 "Options category: "
3249 org-export--registered-backends))
3250 nil t))))
3251 options keywords)
3252 ;; Populate OPTIONS and KEYWORDS.
3269 ;; Move to an appropriate location in order to insert options.
3271 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3289 ;; Then the rest of keywords, in the order specified in either
3290 ;; `org-export-options-alist' or respective export back-ends.
3311 "Expand every include keyword in buffer.
3312 Optional argument INCLUDED is a list of included file names along
3313 with their line restriction, when appropriate. It is used to
3314 avoid infinite recursion. Optional argument DIR is the current
3315 working directory. It is used to properly resolve relative
3316 paths."
3325 ;; Extract arguments from keyword's value.
3333 dir)
3338 value)
3345 ;; Minimal level of included file defaults to the child
3346 ;; level of the current headline, if any, or one. It
3347 ;; only applies is the file is meant to be included as
3348 ;; an Org one.
3360 ;; Remove keyword.
3366 ;; Check if files has already been parsed. Look after
3367 ;; inclusion lines too, as different parts of the same file
3368 ;; can be included too.
3383 ind-str block arg-str contents ind-str block))))
3390 ind-str block contents ind-str block))))
3397 file lines ind minlevel
3406 "Prepare the contents of FILE for inclusion and return them as a string.
3408 When optional argument LINES is a string specifying a range of
3409 lines, include only those lines.
3411 Optional argument IND, when non-nil, is an integer specifying the
3412 global indentation of returned contents. Since its purpose is to
3413 allow an included file to stay in the same environment it was
3414 created \(i.e. a list item), it doesn't apply past the first
3415 headline encountered.
3417 Optional argument MINLEVEL, when non-nil, is an integer
3418 specifying the level that any top-level headline in the included
3419 file should have.
3421 Optional argument ID is an integer that will be inserted before
3422 each footnote definition and reference if FILE is an Org file.
3423 This is useful to avoid conflicts when more than one Org file
3424 with footnotes is included in a document."
3440 ;; Remove blank lines at beginning and end of contents. The logic
3441 ;; behind that removal is that blank lines around include keyword
3442 ;; override blank lines in included file.
3451 ;; If IND is set, preserve indentation of include keyword until
3452 ;; the first headline encountered.
3459 ;; Do not move footnote definitions out of column 0.
3465 ;; When MINLEVEL is specified, compute minimal level for headlines
3466 ;; in the file (CUR-MIN), and remove stars to each headline so
3467 ;; that headlines with minimal level have a level of MINLEVEL.
3478 ;; Only change stars, don't bother moving whole
3479 ;; sections.
3483 ;; Append ID to all footnote references and definitions, so they
3484 ;; become file specific and cannot collide with footnotes in other
3485 ;; included files.
3502 "Execute every Babel code in the visible part of current buffer."
3503 ;; Get a pristine copy of current buffer so Babel references can be
3504 ;; properly resolved.
3510 "Return a non-nil value when output should be added to the kill ring.
3511 See also `org-export-copy-to-kill-ring'."
3517 \f
3518 ;;; Tools For Back-Ends
3519 ;;
3520 ;; A whole set of tools is available to help build new exporters. Any
3521 ;; function general enough to have its use across many back-ends
3522 ;; should be added here.
3524 ;;;; For Affiliated Keywords
3525 ;;
3526 ;; `org-export-read-attribute' reads a property from a given element
3527 ;; as a plist. It can be used to normalize affiliated keywords'
3528 ;; syntax.
3529 ;;
3530 ;; Since captions can span over multiple lines and accept dual values,
3531 ;; their internal representation is a bit tricky. Therefore,
3532 ;; `org-export-get-caption' transparently returns a given element's
3533 ;; caption as a secondary string.
3536 "Turn ATTRIBUTE property from ELEMENT into a plist.
3538 When optional argument PROPERTY is non-nil, return the value of
3539 that property within attributes.
3543 properties.
3545 All values will become strings except the empty string and
3548 will become the empty string."
3562 s)
3567 ;; Ignore any string before first property with `cdr'.
3572 "Return caption from ELEMENT as a secondary string.
3574 When optional argument SHORTP is non-nil, return short caption,
3575 as a secondary string, instead.
3577 Caption lines are separated by a white space."
3585 ;;;; For Derived Back-ends
3586 ;;
3587 ;; `org-export-with-backend' is a function allowing to locally use
3588 ;; another back-end to transcode some object or element. In a derived
3589 ;; back-end, it may be used as a fall-back function once all specific
3590 ;; cases have been treated.
3593 "Call a transcoder from BACKEND on DATA.
3594 BACKEND is an export back-end, as returned by, e.g.,
3595 `org-export-create-backend', or a symbol referring to
3596 a registered back-end. DATA is an Org element, object, secondary
3597 string or string. CONTENTS, when non-nil, is the transcoded
3598 contents of DATA element, as a string. INFO, when non-nil, is
3599 the communication channel used for export, as a plist."
3609 transcoder data contents
3612 :translate-alist all-transcoders
3616 ;;;; For Export Snippets
3617 ;;
3618 ;; Every export snippet is transmitted to the back-end. Though, the
3619 ;; latter will only retain one type of export-snippet, ignoring
3620 ;; others, based on the former's target back-end. The function
3621 ;; `org-export-snippet-backend' returns that back-end for a given
3622 ;; export-snippet.
3625 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3626 Translation, with `org-export-snippet-translation-alist', is
3627 applied."
3631 back-end))))
3634 ;;;; For Footnotes
3635 ;;
3636 ;; `org-export-collect-footnote-definitions' is a tool to list
3637 ;; actually used footnotes definitions in the whole parse tree, or in
3638 ;; a headline, in order to add footnote listings throughout the
3639 ;; transcoded data.
3640 ;;
3641 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3642 ;; back-ends, when they need to attach the footnote definition only to
3643 ;; the first occurrence of the corresponding label.
3644 ;;
3645 ;; `org-export-get-footnote-definition' and
3646 ;; `org-export-get-footnote-number' provide easier access to
3647 ;; additional information relative to a footnote reference.
3650 "Return an alist between footnote numbers, labels and definitions.
3652 DATA is the parse tree from which definitions are collected.
3653 INFO is the plist used as a communication channel.
3655 Definitions are sorted by order of references. They either
3656 appear as Org data or as a secondary string for inlined
3657 footnotes. Unreferenced definitions are ignored."
3659 collect-fn ; for byte-compiler.
3663 ;; Collect footnote number, label and definition in DATA.
3671 def)
3672 num-alist)
3673 ;; Also search in definition for nested footnotes.
3676 ;; Don't enter footnote definitions since it will happen
3677 ;; when their first reference is found.
3683 "Non-nil when a footnote reference is the first one for its label.
3685 FOOTNOTE-REFERENCE is the footnote reference being considered.
3686 INFO is the plist used as a communication channel."
3688 ;; Anonymous footnotes are always a first reference.
3690 ;; Otherwise, return the first footnote with the same LABEL and
3691 ;; test if it is equal to FOOTNOTE-REFERENCE.
3701 ;; If FN isn't inlined, be sure to traverse its
3702 ;; definition before resuming search. See
3703 ;; comments in `org-export-get-footnote-number'
3704 ;; for more information.
3708 ;; Don't enter footnote definitions since it will
3709 ;; happen when their first reference is found.
3712 footnote-reference)))))
3715 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3716 INFO is the plist used as a communication channel. If no such
3725 "Return number associated to a footnote.
3727 FOOTNOTE is either a footnote reference or a footnote definition.
3728 INFO is the plist used as a communication channel."
3730 seen-refs
3731 search-ref ; For byte-compiler.
3735 ;; Search footnote references through DATA, filling
3736 ;; SEEN-REFS along the way.
3741 ;; Anonymous footnote match: return number.
3744 ;; Labels match: return number.
3747 ;; Anonymous footnote: it's always a new one.
3748 ;; Also, be sure to return nil from the `cond' so
3749 ;; `first-match' doesn't get us out of the loop.
3751 ;; Label not seen so far: add it so SEEN-REFS.
3752 ;;
3753 ;; Also search for subsequent references in
3754 ;; footnote definition so numbering follows
3755 ;; reading logic. Note that we don't have to care
3756 ;; about inline definitions, since
3757 ;; `org-element-map' already traverses them at the
3758 ;; right time.
3759 ;;
3760 ;; Once again, return nil to stay in the loop.
3765 nil))))
3766 ;; Don't enter footnote definitions since it will
3767 ;; happen when their first reference is found.
3772 ;;;; For Headlines
3773 ;;
3774 ;; `org-export-get-relative-level' is a shortcut to get headline
3775 ;; level, relatively to the lower headline level in the parsed tree.
3776 ;;
3777 ;; `org-export-get-headline-number' returns the section number of an
3778 ;; headline, while `org-export-number-to-roman' allows to convert it
3779 ;; to roman numbers.
3780 ;;
3781 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3782 ;; `org-export-last-sibling-p' are three useful predicates when it
3783 ;; comes to fulfill the `:headline-levels' property.
3784 ;;
3785 ;; `org-export-get-tags', `org-export-get-category' and
3786 ;; `org-export-get-node-property' extract useful information from an
3787 ;; headline or a parent headline. They all handle inheritance.
3788 ;;
3789 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3790 ;; as a secondary string, suitable for table of contents. It falls
3791 ;; back onto default title.
3794 "Return HEADLINE relative level within current parsed tree.
3795 INFO is a plist holding contextual information."
3800 "Non-nil when HEADLINE is considered as low level.
3802 INFO is a plist used as a communication channel.
3804 A low level headlines has a relative level greater than
3805 `:headline-levels' property value.
3807 Return value is the difference between HEADLINE relative level
3808 and the last level being considered as high enough, or nil."
3815 "Return HEADLINE numbering as a list of numbers.
3816 INFO is a plist holding contextual information."
3820 "Return a non-nil value if HEADLINE element should be numbered.
3821 INFO is a plist used as a communication channel."
3827 "Convert integer N into a roman numeral."
3840 res)))
3843 "Return list of tags associated to ELEMENT.
3845 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3846 is a plist used as a communication channel.
3848 Select tags (see `org-export-select-tags') and exclude tags (see
3849 `org-export-exclude-tags') are removed from the list.
3851 When non-nil, optional argument TAGS should be a list of strings.
3852 Any tag belonging to this list will also be removed.
3854 When optional argument INHERITED is non-nil, tags can also be
3855 inherited from parent headlines and FILETAGS keywords."
3861 ;; Build complete list of inherited tags.
3872 ;; Add FILETAGS keywords and return results.
3876 "Return node PROPERTY value for BLOB.
3878 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3879 element or object.
3881 If optional argument INHERITED is non-nil, the value can be
3882 inherited from a parent headline.
3884 Return value is a string or nil."
3896 "Return category for element or object BLOB.
3898 INFO is a plist used as a communication channel.
3900 CATEGORY is automatically inherited from a parent headline, from
3901 #+CATEGORY: keyword or created out of original file name. If all
3914 "Return alternative title for HEADLINE, as a secondary string.
3915 INFO is a plist used as a communication channel. If no optional
3916 title is defined, fall-back to the regular title."
3921 "Non-nil when BLOB is the first sibling in its parent.
3922 BLOB is an element or an object. If BLOB is a headline, non-nil
3923 means it is the first sibling in the sub-tree. INFO is a plist
3924 used as a communication channel."
3929 "Non-nil when BLOB is the last sibling in its parent.
3930 BLOB is an element or an object. INFO is a plist used as
3931 a communication channel."
3935 ;;;; For Keywords
3936 ;;
3937 ;; `org-export-get-date' returns a date appropriate for the document
3938 ;; to about to be exported. In particular, it takes care of
3939 ;; `org-export-date-timestamp-format'.
3942 "Return date value for the current document.
3944 INFO is a plist used as a communication channel. FMT, when
3945 non-nil, is a time format string that will be applied on the date
3946 if it consists in a single timestamp object. It defaults to
3947 `org-export-date-timestamp-format' when nil.
3949 A proper date can be a secondary string, a string or nil. It is
3950 meant to be translated with `org-export-data' or alike."
3961 ;;;; For Links
3962 ;;
3963 ;; `org-export-solidify-link-text' turns a string into a safer version
3964 ;; for links, replacing most non-standard characters with hyphens.
3965 ;;
3966 ;; `org-export-get-coderef-format' returns an appropriate format
3967 ;; string for coderefs.
3968 ;;
3969 ;; `org-export-inline-image-p' returns a non-nil value when the link
3970 ;; provided should be considered as an inline image.
3971 ;;
3972 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3973 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3974 ;; returns an appropriate unique identifier when found, or nil.
3975 ;;
3976 ;; `org-export-resolve-id-link' returns the first headline with
3977 ;; specified id or custom-id in parse tree, the path to the external
3978 ;; file with the id or nil when neither was found.
3979 ;;
3980 ;; `org-export-resolve-coderef' associates a reference to a line
3981 ;; number in the element it belongs, or returns the reference itself
3982 ;; when the element isn't numbered.
3985 "Take link text S and make a safe target out of it."
3990 "Return format string for code reference link.
3991 PATH is the link path. DESC is its description."
3999 "Non-nil if LINK object points to an inline image.
4001 Optional argument is a set of RULES defining inline images. It
4002 is an alist where associations have the following shape:
4004 \(TYPE . REGEXP)
4006 Applying a rule means apply REGEXP against LINK's path when its
4007 type is TYPE. The function will return a non-nil value if any of
4008 the provided rules is non-nil. The default rule is
4009 `org-export-default-inline-image-rule'.
4011 This only applies to links without a description."
4022 rules)
4023 ;; Return nil if no rule matched.
4024 nil))))
4027 "Resolve a code reference REF.
4029 INFO is a plist used as a communication channel.
4031 Return associated line number in source code, or REF itself,
4032 depending on src-block or example element's switches."
4039 org-coderef-label-format)))
4043 ;; Element containing REF is found. Resolve it to either
4044 ;; a label or a line number, as needed.
4054 "Return LINK destination.
4056 INFO is a plist holding contextual information.
4058 Return value can be an object, an element, or nil:
4060 - If LINK path matches a target object (i.e. <<path>>) return it.
4062 - If LINK path exactly matches the name affiliated keyword
4063 \(i.e. #+NAME: path) of an element, return that element.
4065 - If LINK path exactly matches any headline name, return that
4066 element. If more than one headline share that name, priority
4067 will be given to the one with the closest common ancestor, if
4068 any, or the first one in the parse tree otherwise.
4070 - Otherwise, return nil.
4073 significant."
4076 ;; Split PATH at white spaces so matches are space
4077 ;; insensitive.
4080 ;; Cache for destinations that are not position dependent.
4088 ;; Destination is not position dependent: use cached value.
4090 ;; First try to find a matching "<<path>>" unless user specified
4091 ;; he was looking for a headline (path starts with a "*"
4092 ;; character).
4098 path)
4099 blob))
4102 ;; Then try to find an element with a matching "#+NAME: path"
4103 ;; affiliated keyword.
4106 org-element-all-elements
4111 el)))
4114 ;; Last case: link either points to a headline or to nothingness.
4115 ;; Try to find the source, with priority given to headlines with
4116 ;; the closest common ancestor. If such candidate is found,
4117 ;; return it, otherwise return nil.
4121 ;; Return first headline whose `:raw-value' property is
4122 ;; NAME in parse tree DATA, or nil. Statistics cookies
4123 ;; are ignored.
4131 name)
4132 headline))
4134 ;; Search among headlines sharing an ancestor with link, from
4135 ;; closest to farthest.
4144 ;; No destination found: return nil.
4148 "Return headline referenced as LINK destination.
4150 INFO is a plist used as a communication channel.
4152 Return value can be the headline element matched in current parse
4156 ;; First check if id is within the current parse tree.
4161 headline))
4163 ;; Otherwise, look for external files.
4167 "Return radio-target object referenced as LINK destination.
4169 INFO is a plist used as a communication channel.
4171 Return value can be a radio-target object or nil. Assume LINK
4180 nil nil path nil nil t)
4181 t)
4182 radio))
4186 ;;;; For References
4187 ;;
4188 ;; `org-export-get-ordinal' associates a sequence number to any object
4189 ;; or element.
4192 "Return ordinal number of an element or object.
4194 ELEMENT is the element or object considered. INFO is the plist
4195 used as a communication channel.
4197 Optional argument TYPES, when non-nil, is a list of element or
4198 object types, as symbols, that should also be counted in.
4199 Otherwise, only provided element's type is considered.
4201 Optional argument PREDICATE is a function returning a non-nil
4202 value if the current element or object should be counted in. It
4203 accepts two arguments: the element or object being considered and
4204 the plist used as a communication channel. This allows to count
4205 only a certain type of objects (i.e. inline images).
4207 Return value is a list of numbers if ELEMENT is a headline or an
4208 item. It is nil for keywords. It represents the footnote number
4209 for footnote definitions and footnote references. If ELEMENT is
4210 a target, return the same value as if ELEMENT was the closest
4211 table, item or headline containing the target. In any other
4212 case, return the sequence number of ELEMENT among elements or
4213 objects of the same type."
4214 ;; Ordinal of a target object refer to the ordinal of the closest
4215 ;; table, item, or headline containing the object.
4219 when
4223 table))
4224 return parent)))
4226 ;; Special case 1: A headline returns its number as a list.
4228 ;; Special case 2: An item returns its number as a list.
4232 struct
4239 ;; Increment counter until ELEMENT is found again.
4250 ;;;; For Src-Blocks
4251 ;;
4252 ;; `org-export-get-loc' counts number of code lines accumulated in
4253 ;; src-block or example-block elements with a "+n" switch until
4254 ;; a given element, excluded. Note: "-n" switches reset that count.
4255 ;;
4256 ;; `org-export-unravel-code' extracts source code (along with a code
4257 ;; references alist) from an `element-block' or `src-block' type
4258 ;; element.
4259 ;;
4260 ;; `org-export-format-code' applies a formatting function to each line
4261 ;; of code, providing relative line number and code reference when
4262 ;; appropriate. Since it doesn't access the original element from
4263 ;; which the source code is coming, it expects from the code calling
4264 ;; it to know if lines should be numbered and if code references
4265 ;; should appear.
4266 ;;
4267 ;; Eventually, `org-export-format-code-default' is a higher-level
4268 ;; function (it makes use of the two previous functions) which handles
4269 ;; line numbering and code references inclusion, and returns source
4270 ;; code in a format suitable for plain text or verbatim output.
4273 "Return accumulated lines of code up to ELEMENT.
4275 INFO is the plist used as a communication channel.
4277 ELEMENT is excluded from count."
4283 ;; ELEMENT is reached: Quit the loop.
4285 ;; Only count lines from src-block and example-block elements
4286 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4290 ;; Accumulate locs or reset them.
4294 ;; Return nil to stay in the loop.
4295 nil)))
4297 ;; Return value.
4298 loc))
4301 "Clean source code and extract references out of it.
4303 ELEMENT has either a `src-block' an `example-block' type.
4305 Return a cons cell whose CAR is the source code, cleaned from any
4306 reference, protective commas and spurious indentation, and CDR is
4307 an alist between relative line number (integer) and name of code
4308 reference on that line (string)."
4311 ;; Get code and clean it. Remove blank lines at its
4312 ;; beginning and end.
4319 value
4321 ;; Get format used for references.
4324 org-coderef-label-format)))
4325 ;; Build a regexp matching a loc with a reference.
4330 ;; Return value.
4332 ;; Code with references removed.
4338 ;; Ref line: remove ref, and signal its position in REFS.
4342 ;; Reference alist.
4343 refs)))
4346 "Format CODE by applying FUN line-wise and return it.
4348 CODE is a string representing the code to format. FUN is
4349 a function. It must accept three arguments: a line of
4350 code (string), the current line number (integer) or nil and the
4351 reference associated to the current line (string) or nil.
4353 Optional argument NUM-LINES can be an integer representing the
4354 number of code lines accumulated until the current code. Line
4355 numbers passed to FUN will take it into account. If it is nil,
4356 FUN's second argument will always be nil. This number can be
4357 obtained with `org-export-get-loc' function.
4359 Optional argument REF-ALIST can be an alist between relative line
4360 number (i.e. ignoring NUM-LINES) and the name of the code
4361 reference on it. If it is nil, FUN's third argument will always
4362 be nil. It can be obtained through the use of
4363 `org-export-unravel-code' function."
4375 "Return source code from ELEMENT, formatted in a standard way.
4377 ELEMENT is either a `src-block' or `example-block' element. INFO
4378 is a plist used as a communication channel.
4380 This function takes care of line numbering and code references
4381 inclusion. Line numbers, when applicable, appear at the
4382 beginning of the line, separated from the code by two white
4383 spaces. Code references, on the other hand, appear flushed to
4384 the right, separated by six white spaces from the widest line of
4385 code."
4386 ;; Extract code and references.
4393 ;; Handle line numbering.
4402 ;; Prepare references display, if required. Any reference
4403 ;; should start six columns after the widest line of code,
4404 ;; wrapped with parenthesis.
4409 code
4413 number-str
4414 loc
4420 num-start refs)))))
4423 ;;;; For Tables
4424 ;;
4425 ;; `org-export-table-has-special-column-p' and and
4426 ;; `org-export-table-row-is-special-p' are predicates used to look for
4427 ;; meta-information about the table structure.
4428 ;;
4429 ;; `org-table-has-header-p' tells when the rows before the first rule
4430 ;; should be considered as table's header.
4431 ;;
4432 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4433 ;; and `org-export-table-cell-borders' extract information from
4434 ;; a table-cell element.
4435 ;;
4436 ;; `org-export-table-dimensions' gives the number on rows and columns
4437 ;; in the table, ignoring horizontal rules and special columns.
4438 ;; `org-export-table-cell-address', given a table-cell object, returns
4439 ;; the absolute address of a cell. On the other hand,
4440 ;; `org-export-get-table-cell-at' does the contrary.
4441 ;;
4442 ;; `org-export-table-cell-starts-colgroup-p',
4443 ;; `org-export-table-cell-ends-colgroup-p',
4444 ;; `org-export-table-row-starts-rowgroup-p',
4445 ;; `org-export-table-row-ends-rowgroup-p',
4446 ;; `org-export-table-row-starts-header-p',
4447 ;; `org-export-table-row-ends-header-p' and
4448 ;; `org-export-table-row-in-header-p' indicate position of current row
4449 ;; or cell within the table.
4452 "Non-nil when TABLE has a special column.
4453 All special columns will be ignored during export."
4454 ;; The table has a special column when every first cell of every row
4455 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4456 ;; "*" "_" and "^". Though, do not consider a first row containing
4457 ;; only empty cells as special.
4473 "Non-nil when TABLE has a header.
4475 INFO is a plist used as a communication channel.
4477 A table has a header when it contains at least two row groups."
4486 table
4497 cache)))))
4500 "Non-nil if TABLE-ROW is considered special.
4502 INFO is a plist used as the communication channel.
4504 All special rows will be ignored during export."
4508 ;; A row is special either when...
4510 ;; ... it starts with a field only containing "/",
4512 ;; ... the table contains a special column and the row start
4513 ;; with a marking character among, "^", "_", "$" or "!",
4517 ;; ... it contains only alignment cookies and empty cells.
4523 ;; Since VALUE is a secondary string, the following
4524 ;; checks avoid expanding it with `org-export-data'.
4536 "Return TABLE-ROW's group number, as an integer.
4538 INFO is a plist used as the communication channel.
4540 Return value is the group number, as an integer, or nil for
4541 special rows and rows separators. First group is also table's
4542 header."
4560 "Return TABLE-CELL contents width.
4562 INFO is a plist used as the communication channel.
4564 Return value is the width given by the last width cookie in the
4565 same column as TABLE-CELL, or nil."
4584 ;; In a special row, try to find a width cookie at COLUMN.
4588 ;; The following checks avoid expanding unnecessarily
4589 ;; the cell with `org-export-data'.
4599 "Return TABLE-CELL contents alignment.
4601 INFO is a plist used as the communication channel.
4603 Return alignment as specified by the last alignment cookie in the
4604 same column as TABLE-CELL. If no such cookie is found, a default
4605 alignment value will be deduced from fraction of numbers in the
4606 column (see `org-table-number-fraction' for more information).
4607 Possible values are `left', `right' and `center'."
4608 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4625 cookie-align
4626 previous-cell-number-p)
4629 ;; In a special row, try to find an alignment cookie at
4630 ;; COLUMN.
4634 ;; Since VALUE is a secondary string, the following
4635 ;; checks avoid useless expansion through
4636 ;; `org-export-data'.
4644 ;; Ignore table rules.
4646 ;; In a standard row, check if cell's contents are
4647 ;; expressing some kind of number. Increase NUMBER-CELLS
4648 ;; accordingly. Though, don't bother if an alignment
4649 ;; cookie has already defined cell's alignment.
4654 info)))
4656 ;; Treat an empty cell as a number if it follows
4657 ;; a number.
4663 ;; Return value. Alignment specified by cookies has
4664 ;; precedence over alignment deduced from cell's contents.
4666 column
4671 org-table-number-fraction)
4676 "Return TABLE-CELL borders.
4678 INFO is a plist used as a communication channel.
4680 Return value is a list of symbols, or nil. Possible values are:
4681 `top', `bottom', `above', `below', `left' and `right'. Note:
4682 `top' (resp. `bottom') only happen for a cell in the first
4683 row (resp. last row) of the table, ignoring table rules, if any.
4685 Returned borders ignore special rows."
4688 borders)
4689 ;; Top/above border? TABLE-CELL has a border above when a rule
4690 ;; used to demarcate row groups can be found above. Hence,
4691 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4692 ;; another regular row has to be found above that rule.
4701 ;; Look at every row before the current one.
4703 ;; No rule above, or rule found starts the table (ignoring any
4704 ;; special row): TABLE-CELL is at the top of the table.
4707 ;; Bottom/below border? TABLE-CELL has a border below when next
4708 ;; non-regular row below is a rule.
4717 ;; Look at every row after the current one.
4719 ;; No rule below, or rule found ends the table (modulo some
4720 ;; special row): TABLE-CELL is at the bottom of the table.
4723 ;; Right/left borders? They can only be specified by column
4724 ;; groups. Column groups are defined in a row starting with "/".
4725 ;; Also a column groups row only contains "<", "<>", ">" or blank
4726 ;; cells.
4743 ;; There's a left border when previous cell, if
4744 ;; any, ends a group, or current one starts one.
4750 ;; There's a right border when next cell, if any,
4751 ;; starts a group, or current one ends one.
4758 ;; Table rows are read in reverse order so last column groups
4759 ;; row has precedence over any previous one.
4761 ;; Return value.
4762 borders))
4765 "Non-nil when TABLE-CELL is at the beginning of a column group.
4766 INFO is a plist used as a communication channel."
4767 ;; A cell starts a column group either when it is at the beginning
4768 ;; of a row (or after the special column, if any) or when it has
4769 ;; a left border.
4772 table-cell)
4776 "Non-nil when TABLE-CELL is at the end of a column group.
4777 INFO is a plist used as a communication channel."
4778 ;; A cell ends a column group either when it is at the end of a row
4779 ;; or when it has a right border.
4782 table-cell)
4786 "Non-nil when TABLE-ROW is at the beginning of a row group.
4787 INFO is a plist used as a communication channel."
4795 "Non-nil when TABLE-ROW is at the end of a row group.
4796 INFO is a plist used as a communication channel."
4804 "Non-nil when TABLE-ROW is located within table's header.
4805 INFO is a plist used as a communication channel. Always return
4806 nil for special rows and rows separators."
4812 "Non-nil when TABLE-ROW is the first table header's row.
4813 INFO is a plist used as a communication channel."
4818 "Non-nil when TABLE-ROW is the last table header's row.
4819 INFO is a plist used as a communication channel."
4824 "Return TABLE-ROW number.
4825 INFO is a plist used as a communication channel. Return value is
4826 zero-based and ignores separators. The function returns nil for
4827 special columns and separators."
4839 "Return TABLE dimensions.
4841 INFO is a plist used as a communication channel.
4843 Return value is a CONS like (ROWS . COLUMNS) where
4844 ROWS (resp. COLUMNS) is the number of exportable
4845 rows (resp. columns)."
4847 ;; Set number of rows, and extract first one.
4853 ;; Set number of columns.
4855 ;; Return value.
4859 "Return address of a regular TABLE-CELL object.
4861 TABLE-CELL is the cell considered. INFO is a plist used as
4862 a communication channel.
4864 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4865 zero-based index. Only exportable cells are considered. The
4866 function returns nil for other cells."
4878 "Return regular table-cell object at ADDRESS in TABLE.
4880 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4881 zero-based index. TABLE is a table type element. INFO is
4882 a plist used as a communication channel.
4884 If no table-cell, among exportable cells, is found at ADDRESS,
4885 return nil."
4888 ;; Row at (car address) or nil.
4896 'table-cell
4903 ;;;; For Tables Of Contents
4904 ;;
4905 ;; `org-export-collect-headlines' builds a list of all exportable
4906 ;; headline elements, maybe limited to a certain depth. One can then
4907 ;; easily parse it and transcode it.
4908 ;;
4909 ;; Building lists of tables, figures or listings is quite similar.
4910 ;; Once the generic function `org-export-collect-elements' is defined,
4911 ;; `org-export-collect-tables', `org-export-collect-figures' and
4912 ;; `org-export-collect-listings' can be derived from it.
4915 "Collect headlines in order to build a table of contents.
4917 INFO is a plist used as a communication channel.
4919 When optional argument N is an integer, it specifies the depth of
4920 the table of contents. Otherwise, it is set to the value of the
4921 last headline level. See `org-export-headline-levels' for more
4922 information.
4924 Return a list of all exportable headlines as parsed elements.
4925 Footnote sections, if any, will be ignored."
4933 info)))
4936 "Collect referenceable elements of a determined type.
4938 TYPE can be a symbol or a list of symbols specifying element
4939 types to search. Only elements with a caption are collected.
4941 INFO is a plist used as a communication channel.
4943 When non-nil, optional argument PREDICATE is a function accepting
4944 one argument, an element of type TYPE. It returns a non-nil
4945 value when that element should be collected.
4947 Return a list of all elements found, in order of appearance."
4952 element))
4953 info))
4956 "Build a list of tables.
4957 INFO is a plist used as a communication channel.
4959 Return a list of table elements with a caption."
4963 "Build a list of figures.
4965 INFO is a plist used as a communication channel. PREDICATE is
4966 a function which accepts one argument: a paragraph element and
4967 whose return value is non-nil when that element should be
4968 collected.
4970 A figure is a paragraph type element, with a caption, verifying
4972 a vague concept that may depend on back-end.
4974 Return a list of elements recognized as figures."
4978 "Build a list of src blocks.
4980 INFO is a plist used as a communication channel.
4982 Return a list of src-block elements with a caption."
4986 ;;;; Smart Quotes
4987 ;;
4988 ;; The main function for the smart quotes sub-system is
4989 ;; `org-export-activate-smart-quotes', which replaces every quote in
4990 ;; a given string from the parse tree with its "smart" counterpart.
4991 ;;
4992 ;; Dictionary for smart quotes is stored in
4993 ;; `org-export-smart-quotes-alist'.
4994 ;;
4995 ;; Internally, regexps matching potential smart quotes (checks at
4996 ;; string boundaries are also necessary) are defined in
4997 ;; `org-export-smart-quotes-regexps'.
5001 ;; one may use: »...«, "...", ›...‹, or '...'.
5002 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5003 ;; LaTeX quotes require Babel!
5048 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5057 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5066 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5075 ;; 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
5076 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5087 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5093 )
5094 "Smart quotes translations.
5096 Alist whose CAR is a language string and CDR is an alist with
5097 quote type as key and a plist associating various encodings to
5098 their translation as value.
5100 A quote type can be any symbol among `opening-double-quote',
5101 `closing-double-quote', `opening-single-quote',
5102 `closing-single-quote' and `apostrophe'.
5104 Valid encodings include `:utf-8', `:html', `:latex' and
5105 `:texinfo'.
5111 ;; Possible opening quote at beginning of string.
5113 ;; Possible closing quote at beginning of string.
5115 ;; Possible apostrophe at beginning of string.
5117 ;; Opening single and double quotes.
5119 ;; Closing single and double quotes.
5121 ;; Apostrophe.
5123 ;; Possible opening quote at end of string.
5125 ;; Possible closing quote at end of string.
5127 ;; Possible apostrophe at end of string.
5129 "List of regexps matching a quote or an apostrophe.
5135 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5136 `:utf-8'. INFO is a plist used as a communication channel.
5138 The function has to retrieve information about string
5139 surroundings in parse tree. It can only happen with an
5140 unmodified string. Thus, if S has already been through another
5141 process, a non-nil ORIGINAL optional argument will provide that
5142 original string.
5144 Return the new string."
5147 ;; Try to be flexible when computing number of blanks
5148 ;; before object. The previous object may be a string
5149 ;; introduced by the back-end and not completely parsed.
5152 ;; A string with missing `:post-blank'
5153 ;; property.
5157 ;; Fallback value.
5162 ;; Return smart quote associated to a give quote Q, as
5163 ;; a string. TYPE is a symbol among `open', `close' and
5164 ;; `apostrophe'.
5174 org-export-smart-quotes-alist))))
5175 encoding)
5176 q)))))
5178 ;; Only a quote: no regexp can match. We have to check both
5179 ;; sides and decide what to do.
5187 ;; 1. Replace quote character at the beginning of S.
5189 ;; Apostrophe?
5195 ;; Closing quote?
5201 ;; Opening quote?
5207 ;; 2. Replace quotes in the middle of the string.
5209 ;; Opening quotes.
5215 ;; Closing quotes.
5221 ;; Apostrophes.
5226 ;; 3. Replace quote character at the end of S.
5228 ;; Apostrophe?
5233 ;; Closing quote?
5239 ;; Opening quote?
5244 ;; Return string with smart quotes.
5245 s))))
5247 ;;;; Topology
5248 ;;
5249 ;; Here are various functions to retrieve information about the
5250 ;; neighborhood of a given element or object. Neighbors of interest
5251 ;; are direct parent (`org-export-get-parent'), parent headline
5252 ;; (`org-export-get-parent-headline'), first element containing an
5253 ;; object, (`org-export-get-parent-element'), parent table
5254 ;; (`org-export-get-parent-table'), previous element or object
5255 ;; (`org-export-get-previous-element') and next element or object
5256 ;; (`org-export-get-next-element').
5257 ;;
5258 ;; `org-export-get-genealogy' returns the full genealogy of a given
5259 ;; element or object, from closest parent to full parse tree.
5261 ;; defsubst org-export-get-parent must be defined before first use
5264 "Return full genealogy relative to a given element or object.
5266 BLOB is the element or object being considered.
5268 Ancestors are returned from closest to farthest, the last one
5269 being the full parse tree."
5276 "Return BLOB parent headline or nil.
5277 BLOB is the element or object being considered."
5281 parent))
5284 "Return first element containing OBJECT or nil.
5285 OBJECT is the object to consider."
5289 parent))
5292 "Return OBJECT parent table or nil.
5293 OBJECT is either a `table-cell' or `table-element' type object."
5297 parent))
5300 "Return previous element or object.
5302 BLOB is an element or object. INFO is a plist used as
5303 a communication channel. Return previous exportable element or
5304 object, a string, or nil.
5306 When optional argument N is a positive integer, return a list
5307 containing up to N siblings before BLOB, from farthest to
5308 closest. With any other non-nil value, return a list containing
5309 all of them."
5315 prev)
5325 "Return next element or object.
5327 BLOB is an element or object. INFO is a plist used as
5328 a communication channel. Return next exportable element or
5329 object, a string, or nil.
5331 When optional argument N is a positive integer, return a list
5332 containing up to N siblings after BLOB, from closest to farthest.
5333 With any other non-nil value, return a list containing all of
5334 them."
5341 next)
5351 ;;;; Translation
5352 ;;
5353 ;; `org-export-translate' translates a string according to the language
5354 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5355 ;; the dictionary used for the translation.
5402 ("ru" :html "(Продолжение следует)"
5500 ("ru" :html "Список распечаток"
5513 ("ru" :html "Список таблиц"
5596 ("ru" :html "Неизвестная ссылка"
5599 "Dictionary for export engine.
5601 Alist whose CAR is the string to translate and CDR is an alist
5602 whose CAR is the language string and CDR is a plist whose
5603 properties are possible charsets and values translated terms.
5605 It is used as a database for `org-export-translate'. Since this
5606 function returns the string as-is if no translation was found,
5607 the variable only needs to record values different from the
5611 "Translate string S according to language specification.
5613 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5614 and `:utf-8'. INFO is a plist used as a communication channel.
5616 Translation depends on `:language' property. Return the
5617 translated string. If no translation is found, try to fall back
5618 to `:default' encoding. If it fails, return S."
5624 s)))
5627 \f
5628 ;;; Asynchronous Export
5629 ;;
5630 ;; `org-export-async-start' is the entry point for asynchronous
5631 ;; export. It recreates current buffer (including visibility,
5632 ;; narrowing and visited file) in an external Emacs process, and
5633 ;; evaluates a command there. It then applies a function on the
5634 ;; returned results in the current process.
5635 ;;
5636 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5637 ;; allow to export to a buffer or a file, asynchronously or not.
5638 ;;
5639 ;; `org-export-output-file-name' is an auxiliary function meant to be
5640 ;; used with `org-export-to-file'. With a given extension, it tries
5641 ;; to provide a canonical file name to write export output to.
5642 ;;
5643 ;; Asynchronously generated results are never displayed directly.
5644 ;; Instead, they are stored in `org-export-stack-contents'. They can
5645 ;; then be retrieved by calling `org-export-stack'.
5646 ;;
5647 ;; Export Stack is viewed through a dedicated major mode
5648 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5649 ;;`org-export-stack-delete', `org-export-stack-view' and
5650 ;;`org-export-stack-clear'.
5651 ;;
5652 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5653 ;; It should be used whenever `org-export-async-start' is called.
5656 "Call function FUN on the results returned by BODY evaluation.
5658 BODY evaluation happens in an asynchronous process, from a buffer
5659 which is an exact copy of the current one.
5661 Use `org-export-add-to-stack' in FUN in order to register results
5662 in the stack.
5664 This is a low level function. See also `org-export-to-buffer'
5665 and `org-export-to-file' for more specialized functions."
5668 ;; Write the full sexp evaluating BODY in a copy of the current
5669 ;; buffer to a temporary file, as it may be too long for program
5670 ;; args in `start-process'.
5677 ;; Null characters (from variable values) are inserted
5678 ;; within the file. As a consequence, coding system for
5679 ;; buffer contents will not be recognized properly. So,
5680 ;; we make sure it is the same as the one used to display
5681 ;; the original buffer.
5683 ,coding
5686 ;; Ignore `kill-emacs-hook' and code evaluation
5687 ;; queries from Babel as we need a truly
5688 ;; non-interactive process.
5690 org-babel-confirm-evaluate-answer-no t)
5691 ;; Initialize export framework.
5693 ;; Re-create current buffer there.
5696 ;; Sexp to evaluate in the buffer.
5698 ;; Start external process.
5701 (,process
5703 #'start-process
5706 ,proc-buffer
5713 ;; Register running process in stack.
5715 ;; Set-up sentinel in order to catch results.
5718 ,process
5740 ;;;###autoload
5743 &optional async subtreep visible-only body-only ext-plist
5744 post-process)
5745 "Call `org-export-as' with output to a specified buffer.
5747 BACKEND is either an export back-end, as returned by, e.g.,
5748 `org-export-create-backend', or a symbol referring to
5749 a registered back-end.
5751 BUFFER is the name of the output buffer. If it already exists,
5752 it will be erased first, otherwise, it will be created.
5754 A non-nil optional argument ASYNC means the process should happen
5755 asynchronously. The resulting buffer should then be accessible
5756 through the `org-export-stack' interface. When ASYNC is nil, the
5757 buffer is displayed if `org-export-show-temporary-export-buffer'
5758 is non-nil.
5760 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5761 EXT-PLIST are similar to those used in `org-export-as', which
5762 see.
5764 Optional argument POST-PROCESS is a function which should accept
5765 no argument. It is always called within the current process,
5766 from BUFFER, with point at its beginning. Export back-ends can
5767 use it to set a major mode there, e.g,
5769 \(defun org-latex-export-as-latex
5770 \(&optional async subtreep visible-only body-only ext-plist)
5771 \(interactive)
5773 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5775 This function returns BUFFER."
5803 buffer)))
5805 ;;;###autoload
5808 post-process)
5809 "Call `org-export-as' with output to a specified file.
5811 BACKEND is either an export back-end, as returned by, e.g.,
5812 `org-export-create-backend', or a symbol referring to
5813 a registered back-end. FILE is the name of the output file, as
5814 a string.
5816 A non-nil optional argument ASYNC means the process should happen
5817 asynchronously. The resulting buffer will then be accessible
5818 through the `org-export-stack' interface.
5820 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5821 EXT-PLIST are similar to those used in `org-export-as', which
5822 see.
5824 Optional argument POST-PROCESS is called with FILE as its
5825 argument and happens asynchronously when ASYNC is non-nil. It
5826 has to return a file name, or nil. Export back-ends can use this
5827 to send the output file through additional processing, e.g,
5829 \(defun org-latex-export-to-latex
5830 \(&optional async subtreep visible-only body-only ext-plist)
5831 \(interactive)
5833 \(org-export-to-file 'latex outfile
5834 async subtreep visible-only body-only ext-plist
5835 \(lambda (file) (org-latex-compile file)))
5837 The function returns either a file name returned by POST-PROCESS,
5838 or FILE."
5857 backend subtreep visible-only body-only ext-plist)))
5864 ;; Get proper return value.
5866 file))))))
5869 "Return output file's name according to buffer specifications.
5871 EXTENSION is a string representing the output file extension,
5872 with the leading dot.
5874 With a non-nil optional argument SUBTREEP, try to determine
5876 of subtree at point.
5878 When optional argument PUB-DIR is set, use it as the publishing
5879 directory.
5881 When optional argument VISIBLE-ONLY is non-nil, don't export
5882 contents of hidden elements.
5884 Return file name as a string."
5887 ;; File name may come from EXPORT_FILE_NAME subtree
5888 ;; property, assuming point is at beginning of said
5889 ;; sub-tree.
5896 ;; File name may be extracted from buffer's associated
5897 ;; file, if any.
5899 ;; Can't determine file name on our own: Ask user.
5903 "Output file: " pub-dir nil nil nil
5907 ;; Build file name. Enforce EXTENSION over whatever user
5908 ;; may have come up with. PUB-DIR, if defined, always has
5909 ;; precedence over any provided path.
5914 extension))
5917 ;; If writing to OUTPUT-FILE would overwrite original file, append
5918 ;; EXTENSION another time to final name.
5921 output-file)))
5924 "Add a new result to export stack if not present already.
5926 SOURCE is a buffer or a file name containing export results.
5927 BACKEND is a symbol representing export back-end used to generate
5928 it.
5930 Entries already pointing to SOURCE and unavailable entries are
5931 removed beforehand. Return the new stack."
5937 "Menu for asynchronous export results and running processes."
5947 "Return source from export results at point in stack."
5954 source
5955 ;; SOURCE is not consistent with current line. The stack
5956 ;; view is outdated.
5960 "Remove all entries from export stack."
5965 "Refresh the asynchronous export stack.
5966 DUMMY is ignored. Unavailable sources are removed from the list.
5967 Return the new stack."
5977 ;; Back-end.
5979 ;; Age.
5982 ;; Compute age of the results.
5984 "%4h:%.2m "
5986 ;; Source.
5991 ;; Clear stack from exited processes, dead buffers or
5992 ;; non-existent files.
6004 "Remove export results at point from stack.
6005 If optional argument SOURCE is non-nil, remove it instead."
6010 org-export-stack-contents))))
6013 "View export results at point in stack.
6014 With an optional prefix argument IN-EMACS, force viewing files
6015 within Emacs."
6029 (define-key km "p" 'previous-line)
6030 (define-key km "\C-p" 'previous-line)
6031 (define-key km "\C-?" 'previous-line)
6032 (define-key km [up] 'previous-line)
6033 (define-key km "C" 'org-export-stack-clear)
6034 (define-key km "v" 'org-export-stack-view)
6035 (define-key km (kbd "RET") 'org-export-stack-view)
6036 (define-key km "d" 'org-export-stack-remove)
6037 km)
6038 "Keymap for Org Export Stack.")
6040 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6041 "Mode for displaying asynchronous export stack.
6044 stack.
6046 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6047 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6048 stack completely.
6050 Removing entries in an Org Export Stack buffer doesn't affect
6051 files or buffers, only the display.
6054 (abbrev-mode 0)
6055 (auto-fill-mode 0)
6056 (setq buffer-read-only t
6057 buffer-undo-list t
6058 truncate-lines t
6059 header-line-format
6060 '(:eval
6061 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6062 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6063 (set (make-local-variable 'revert-buffer-function)
6064 'org-export-stack-refresh))
6067 \f
6068 ;;; The Dispatcher
6069 ;;
6070 ;; `org-export-dispatch' is the standard interactive way to start an
6071 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6072 ;; for its interface, which, in turn, delegates response to key
6073 ;; pressed to `org-export--dispatch-action'.
6075 ;;;###autoload
6076 (defun org-export-dispatch (&optional arg)
6077 "Export dispatcher for Org mode.
6079 It provides an access to common export related tasks in a buffer.
6080 Its interface comes in two flavors: standard and expert.
6082 While both share the same set of bindings, only the former
6083 displays the valid keys associations in a dedicated buffer.
6084 Scrolling (resp. line-wise motion) in this buffer is done with
6085 SPC and DEL (resp. C-n and C-p) keys.
6087 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6088 flavor or the other.
6091 of options used back then, on the current buffer.
6093 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6094 (interactive "P")
6095 (let* ((input
6096 (cond ((equal arg '(16)) '(stack))
6097 ((and arg org-export-dispatch-last-action))
6098 (t (save-window-excursion
6099 (unwind-protect
6100 (progn
6101 ;; Remember where we are
6102 (move-marker org-export-dispatch-last-position
6103 (point)
6104 (org-base-buffer (current-buffer)))
6105 ;; Get and store an export command
6106 (setq org-export-dispatch-last-action
6107 (org-export--dispatch-ui
6108 (list org-export-initial-scope
6109 (and org-export-in-background 'async))
6110 nil
6111 org-export-dispatch-use-expert-ui)))
6112 (and (get-buffer "*Org Export Dispatcher*")
6113 (kill-buffer "*Org Export Dispatcher*")))))))
6114 (action (car input))
6115 (optns (cdr input)))
6116 (unless (memq 'subtree optns)
6117 (move-marker org-export-dispatch-last-position nil))
6118 (case action
6119 ;; First handle special hard-coded actions.
6120 (template (org-export-insert-default-template nil optns))
6121 (stack (org-export-stack))
6122 (publish-current-file
6123 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6124 (publish-current-project
6125 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6126 (publish-choose-project
6127 (org-publish (assoc (org-icompleting-read
6128 "Publish project: "
6129 org-publish-project-alist nil t)
6130 org-publish-project-alist)
6131 (memq 'force optns)
6132 (memq 'async optns)))
6133 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6134 (otherwise
6135 (save-excursion
6136 (when arg
6137 ;; Repeating command, maybe move cursor to restore subtree
6138 ;; context.
6139 (if (eq (marker-buffer org-export-dispatch-last-position)
6140 (org-base-buffer (current-buffer)))
6141 (goto-char org-export-dispatch-last-position)
6142 ;; We are in a different buffer, forget position.
6143 (move-marker org-export-dispatch-last-position nil)))
6144 (funcall action
6145 ;; Return a symbol instead of a list to ease
6146 ;; asynchronous export macro use.
6147 (and (memq 'async optns) t)
6148 (and (memq 'subtree optns) t)
6149 (and (memq 'visible optns) t)
6150 (and (memq 'body optns) t)))))))
6152 (defun org-export--dispatch-ui (options first-key expertp)
6153 "Handle interface for `org-export-dispatch'.
6155 OPTIONS is a list containing current interactive options set for
6156 export. It can contain any of the following symbols:
6157 `body' toggles a body-only export
6158 `subtree' restricts export to current subtree
6159 `visible' restricts export to visible part of buffer.
6160 `force' force publishing files.
6161 `async' use asynchronous export process
6163 FIRST-KEY is the key pressed to select the first level menu. It
6164 is nil when this menu hasn't been selected yet.
6166 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6167 buffer is provided, but indications about currently active
6168 options are given in the prompt. Moreover, \[?] allows to switch
6169 back to standard interface."
6170 (let* ((fontify-key
6171 (lambda (key &optional access-key)
6172 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6173 ;; non-nil is the required first-level key to activate
6174 ;; KEY. When its value is t, activate KEY independently
6175 ;; on the first key, if any. A nil value means KEY will
6176 ;; only be activated at first level.
6177 (if (or (eq access-key t) (eq access-key first-key))
6178 (org-propertize key 'face 'org-warning)
6179 key)))
6180 (fontify-value
6181 (lambda (value)
6182 ;; Fontify VALUE string.
6183 (org-propertize value 'face 'font-lock-variable-name-face)))
6184 ;; Prepare menu entries by extracting them from registered
6185 ;; back-ends and sorting them by access key and by ordinal,
6186 ;; if any.
6187 (entries
6188 (sort (sort (delq nil
6189 (mapcar 'org-export-backend-menu
6190 org-export--registered-backends))
6191 (lambda (a b)
6192 (let ((key-a (nth 1 a))
6193 (key-b (nth 1 b)))
6194 (cond ((and (numberp key-a) (numberp key-b))
6195 (< key-a key-b))
6196 ((numberp key-b) t)))))
6197 'car-less-than-car))
6198 ;; Compute a list of allowed keys based on the first key
6199 ;; pressed, if any. Some keys
6200 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6201 ;; available.
6202 (allowed-keys
6203 (nconc (list 2 22 19 6 1)
6204 (if (not first-key) (org-uniquify (mapcar 'car entries))
6205 (let (sub-menu)
6206 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6207 (when (eq (car entry) first-key)
6208 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6209 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6210 ((not first-key) (list ?P)))
6211 (list ?& ?#)
6212 (when expertp (list ??))
6213 (list ?q)))
6214 ;; Build the help menu for standard UI.
6215 (help
6216 (unless expertp
6217 (concat
6218 ;; Options are hard-coded.
6219 (format "[%s] Body only: %s [%s] Visible only: %s
6220 \[%s] Export scope: %s [%s] Force publishing: %s
6222 (funcall fontify-key "C-b" t)
6223 (funcall fontify-value
6224 (if (memq 'body options) "On " "Off"))
6225 (funcall fontify-key "C-v" t)
6226 (funcall fontify-value
6227 (if (memq 'visible options) "On " "Off"))
6228 (funcall fontify-key "C-s" t)
6229 (funcall fontify-value
6230 (if (memq 'subtree options) "Subtree" "Buffer "))
6231 (funcall fontify-key "C-f" t)
6232 (funcall fontify-value
6233 (if (memq 'force options) "On " "Off"))
6234 (funcall fontify-key "C-a" t)
6235 (funcall fontify-value
6236 (if (memq 'async options) "On " "Off")))
6237 ;; Display registered back-end entries. When a key
6238 ;; appears for the second time, do not create another
6239 ;; entry, but append its sub-menu to existing menu.
6240 (let (last-key)
6241 (mapconcat
6242 (lambda (entry)
6243 (let ((top-key (car entry)))
6244 (concat
6245 (unless (eq top-key last-key)
6246 (setq last-key top-key)
6248 (funcall fontify-key (char-to-string top-key))
6249 (nth 1 entry)))
6250 (let ((sub-menu (nth 2 entry)))
6251 (unless (functionp sub-menu)
6252 ;; Split sub-menu into two columns.
6253 (let ((index -1))
6254 (concat
6255 (mapconcat
6256 (lambda (sub-entry)
6257 (incf index)
6258 (format
6259 (if (zerop (mod index 2)) " [%s] %-26s"
6261 (funcall fontify-key
6262 (char-to-string (car sub-entry))
6263 top-key)
6264 (nth 1 sub-entry)))
6265 sub-menu "")
6267 entries ""))
6268 ;; Publishing menu is hard-coded.
6270 [%s] Current file [%s] Current project
6272 (funcall fontify-key "P")
6273 (funcall fontify-key "f" ?P)
6274 (funcall fontify-key "p" ?P)
6275 (funcall fontify-key "x" ?P)
6276 (funcall fontify-key "a" ?P))
6278 (funcall fontify-key "&" t)
6279 (funcall fontify-key "#" t))
6280 (format "[%s] %s"
6281 (funcall fontify-key "q" t)
6282 (if first-key "Main menu" "Exit")))))
6283 ;; Build prompts for both standard and expert UI.
6284 (standard-prompt (unless expertp "Export command: "))
6285 (expert-prompt
6286 (when expertp
6287 (format
6288 "Export command (C-%s%s%s%s%s) [%s]: "
6289 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6290 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6291 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6292 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6293 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6294 (mapconcat (lambda (k)
6295 ;; Strip control characters.
6296 (unless (< k 27) (char-to-string k)))
6297 allowed-keys "")))))
6298 ;; With expert UI, just read key with a fancy prompt. In standard
6299 ;; UI, display an intrusive help buffer.
6300 (if expertp
6301 (org-export--dispatch-action
6302 expert-prompt allowed-keys entries options first-key expertp)
6303 ;; At first call, create frame layout in order to display menu.
6304 (unless (get-buffer "*Org Export Dispatcher*")
6305 (delete-other-windows)
6306 (org-switch-to-buffer-other-window
6307 (get-buffer-create "*Org Export Dispatcher*"))
6308 (setq cursor-type nil
6309 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6310 ;; Make sure that invisible cursor will not highlight square
6311 ;; brackets.
6312 (set-syntax-table (copy-syntax-table))
6313 (modify-syntax-entry ?\[ "w"))
6314 ;; At this point, the buffer containing the menu exists and is
6315 ;; visible in the current window. So, refresh it.
6316 (with-current-buffer "*Org Export Dispatcher*"
6317 ;; Refresh help. Maintain display continuity by re-visiting
6318 ;; previous window position.
6319 (let ((pos (window-start)))
6320 (erase-buffer)
6321 (insert help)
6322 (set-window-start nil pos)))
6323 (org-fit-window-to-buffer)
6324 (org-export--dispatch-action
6325 standard-prompt allowed-keys entries options first-key expertp))))
6327 (defun org-export--dispatch-action
6328 (prompt allowed-keys entries options first-key expertp)
6329 "Read a character from command input and act accordingly.
6331 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6332 a list of characters available at a given step in the process.
6333 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6334 EXPERTP are the same as defined in `org-export--dispatch-ui',
6335 which see.
6337 Toggle export options when required. Otherwise, return value is
6338 a list with action as CAR and a list of interactive export
6339 options as CDR."
6340 (let (key)
6341 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6342 ;; C-p, SPC, DEL).
6343 (while (and (setq key (read-char-exclusive prompt))
6344 (not expertp)
6345 (memq key '(14 16 ?\s ?\d)))
6346 (case key
6347 (14 (if (not (pos-visible-in-window-p (point-max)))
6348 (ignore-errors (scroll-up 1))
6349 (message "End of buffer")
6350 (sit-for 1)))
6351 (16 (if (not (pos-visible-in-window-p (point-min)))
6352 (ignore-errors (scroll-down 1))
6353 (message "Beginning of buffer")
6354 (sit-for 1)))
6355 (?\s (if (not (pos-visible-in-window-p (point-max)))
6356 (scroll-up nil)
6357 (message "End of buffer")
6358 (sit-for 1)))
6359 (?\d (if (not (pos-visible-in-window-p (point-min)))
6360 (scroll-down nil)
6361 (message "Beginning of buffer")
6362 (sit-for 1)))))
6363 (cond
6364 ;; Ignore undefined associations.
6365 ((not (memq key allowed-keys))
6366 (ding)
6367 (unless expertp (message "Invalid key") (sit-for 1))
6368 (org-export--dispatch-ui options first-key expertp))
6369 ;; q key at first level aborts export. At second level, cancel
6370 ;; first key instead.
6371 ((eq key ?q) (if (not first-key) (error "Export aborted")
6372 (org-export--dispatch-ui options nil expertp)))
6373 ;; Help key: Switch back to standard interface if expert UI was
6374 ;; active.
6375 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6376 ;; Send request for template insertion along with export scope.
6377 ((eq key ?#) (cons 'template (memq 'subtree options)))
6378 ;; Switch to asynchronous export stack.
6379 ((eq key ?&) '(stack))
6380 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6381 ((memq key '(2 22 19 6 1))
6382 (org-export--dispatch-ui
6383 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6384 (6 'force) (1 'async))))
6385 (if (memq option options) (remq option options)
6386 (cons option options)))
6387 first-key expertp))
6388 ;; Action selected: Send key and options back to
6389 ;; `org-export-dispatch'.
6390 ((or first-key (functionp (nth 2 (assq key entries))))
6391 (cons (cond
6392 ((not first-key) (nth 2 (assq key entries)))
6393 ;; Publishing actions are hard-coded. Send a special
6394 ;; signal to `org-export-dispatch'.
6395 ((eq first-key ?P)
6396 (case key
6397 (?f 'publish-current-file)
6398 (?p 'publish-current-project)
6399 (?x 'publish-choose-project)
6400 (?a 'publish-all)))
6401 ;; Return first action associated to FIRST-KEY + KEY
6402 ;; path. Indeed, derived backends can share the same
6403 ;; FIRST-KEY.
6404 (t (catch 'found
6405 (mapc (lambda (entry)
6406 (let ((match (assq key (nth 2 entry))))
6407 (when match (throw 'found (nth 2 match)))))
6408 (member (assq first-key entries) entries)))))
6409 options))
6410 ;; Otherwise, enter sub-menu.
6411 (t (org-export--dispatch-ui options key expertp)))))
6415 (provide 'ox)
6417 ;; Local variables:
6418 ;; generated-autoload-file: "org-loaddefs.el"
6419 ;; End:
6421 ;;; ox.el ends here