| blob | ec52203c45b17bb4c9270a7326e022bfe3f0d791 |
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.
1979 info))
1982 "Return minimum exportable headline's level in DATA.
1983 DATA is parsed tree as returned by `org-element-parse-buffer'.
1984 OPTIONS is a plist holding export options."
1995 ;; If no headline was found, for the sake of consistency, set
1996 ;; minimum level to 1 nonetheless.
2000 "Return numbering of all exportable, numbered headlines in a parse tree.
2002 DATA is the parse tree. OPTIONS is the plist holding export
2003 options.
2005 Return an alist whose key is a headline and value is its
2006 associated numbering \(in the shape of a list of numbers\) or nil
2007 for a footnotes section."
2016 headline
2018 for idx from 0 to org-export-max-depth
2022 options)))
2025 "Return numbering of all exportable, unnumbered headlines.
2026 DATA is the parse tree. OPTIONS is the plist holding export
2027 options. Unnumbered headlines are numbered as a function of
2028 occurrence."
2036 "Return list of elements and objects to ignore during export.
2037 DATA is the parse tree to traverse. OPTIONS is the plist holding
2038 export options."
2040 ;; First find trees containing a select tag, if any.
2042 ;; If a select tag is active, also ignore the section before
2043 ;; the first headline, if any.
2047 first-element))))
2050 ;; Collect ignored elements or objects into IGNORE-LIST.
2056 ;; If headline is archived but tree below has
2057 ;; to be skipped, add it to ignore list.
2060 ;; Move into secondary string, if any.
2065 ;; Move into recursive objects/elements.
2067 ;; Main call.
2069 ;; Return value.
2070 ignore))
2073 "Return list of headlines and inlinetasks with a select tag in their tree.
2074 DATA is parsed data as returned by `org-element-parse-buffer'.
2075 INFO is a plist holding export options."
2077 walk-data ; For byte-compiler.
2087 ;; When a select tag is found, mark full
2088 ;; genealogy and every headline within the tree
2089 ;; as acceptable.
2092 genealogy
2095 selected-trees))
2096 ;; If at a headline, continue searching in tree,
2097 ;; recursively.
2107 selected-trees))
2110 "Non-nil when element or object BLOB should be skipped during export.
2111 OPTIONS is the plist holding export options. SELECTED, when
2112 non-nil, is a list of headlines or inlinetasks belonging to
2113 a tree with a select tag."
2120 ;; If `:with-drawers' value starts with `not', ignore
2121 ;; every drawer whose name belong to that list.
2122 ;; Otherwise, ignore drawers whose name isn't in that
2123 ;; list.
2140 ;; Ignore subtrees with an exclude tag.
2143 ;; When a select tag is present in the buffer, ignore any tree
2144 ;; without it.
2146 ;; Ignore commented sub-trees.
2148 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2150 ;; Ignore tasks, if specified by `:with-tasks' property.
2162 properties-set))))))
2173 ;; `:with-timestamps' only applies to isolated timestamps
2174 ;; objects, i.e. timestamp objects in a paragraph containing only
2175 ;; timestamps and whitespaces.
2183 options t))))
2192 \f
2193 ;;; The Transcoder
2194 ;;
2195 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2196 ;; `org-element-parse-buffer') and transcodes it into a specified
2197 ;; back-end output. It takes care of filtering out elements or
2198 ;; objects according to export options and organizing the output blank
2199 ;; lines and white space are preserved. The function memoizes its
2200 ;; results, so it is cheap to call it within transcoders.
2201 ;;
2202 ;; It is possible to modify locally the back-end used by
2203 ;; `org-export-data' or even use a temporary back-end by using
2204 ;; `org-export-data-with-backend'.
2205 ;;
2206 ;; Internally, three functions handle the filtering of objects and
2207 ;; elements during the export. In particular,
2208 ;; `org-export-ignore-element' marks an element or object so future
2209 ;; parse tree traversals skip it and `org-export-expand' transforms
2210 ;; the others back into their original shape.
2211 ;;
2212 ;; `org-export-transcoder' is an accessor returning appropriate
2213 ;; translator function for a given element or object.
2216 "Return appropriate transcoder for BLOB.
2217 INFO is a plist containing export directives."
2219 ;; Return contents only for complete parse trees.
2225 "Convert DATA into current back-end format.
2227 DATA is a parse tree, an element or an object or a secondary
2228 string. INFO is a plist holding export options.
2230 Return a string."
2235 ;; Ignored element/object.
2237 ;; Plain text.
2243 info))
2244 ;; Secondary string.
2247 ;; Element/Object without contents or, as a special
2248 ;; case, headline with archive tag and archived trees
2249 ;; restricted to title only.
2257 ;; Export snippets never return a nil value so
2258 ;; that white spaces following them are never
2259 ;; ignored.
2261 ;; Element/Object with contents.
2274 ;; Elements directly containing
2275 ;; objects must have their indentation
2276 ;; normalized first.
2278 data
2279 ;; When normalizing contents of the
2280 ;; first paragraph in an item or
2281 ;; a footnote definition, ignore
2282 ;; first line's indentation: there is
2283 ;; none and it might be misleading.
2288 data)
2295 info))))))))
2296 ;; Final result will be memoized before being returned.
2298 data
2302 ;; Append the same white space between elements or objects
2303 ;; as in the original buffer, and call appropriate filters.
2314 info)))
2315 results)))
2319 "Convert DATA into BACKEND format.
2321 DATA is an element, an object, a secondary string or a string.
2322 BACKEND is a symbol. INFO is a plist used as a communication
2323 channel.
2325 Unlike to `org-export-with-backend', this function will
2326 recursively convert DATA using BACKEND translation table."
2329 data
2330 ;; Set-up a new communication channel with translations defined in
2331 ;; BACKEND as the translate table and a new hash table for
2332 ;; memoization.
2334 info
2337 ;; Size of the hash table is reduced since this function
2338 ;; will probably be used on small trees.
2342 "Change uninterpreted elements back into Org syntax.
2343 DATA is the parse tree. INFO is a plist containing export
2344 options. Each uninterpreted element or object is changed back
2345 into a string. Contents, if any, are not modified. The parse
2346 tree is modified by side effect and returned by the function."
2350 prop
2353 info))))
2356 "Change uninterpreted elements back into Org syntax.
2357 DATA is a parse tree or a secondary string. INFO is a plist
2358 containing export options. It is modified by side effect and
2359 returned by the function."
2362 subscript superscript underline)
2366 ;; ... entities...
2373 ?\s)))))
2374 ;; ... emphasis...
2386 marker
2390 ?\s)))))))
2391 ;; ... LaTeX environments and fragments...
2395 ;; ... sub/superscripts...
2404 "_"
2413 ?\s)))))))))))
2415 ;; Splice NEW at BLOB location in parse tree.
2418 info)
2419 ;; Return modified parse tree.
2420 data)
2423 "Expand a parsed element or object to its original state.
2425 BLOB is either an element or an object. CONTENTS is its
2426 contents, as a string or nil.
2428 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2429 keywords before output."
2434 blob contents))))
2437 "Add ELEMENT to `:ignore-list' in INFO.
2439 Any element in `:ignore-list' will be skipped when using
2440 `org-element-map'. INFO is modified by side effects."
2444 \f
2445 ;;; The Filter System
2446 ;;
2447 ;; Filters allow end-users to tweak easily the transcoded output.
2448 ;; They are the functional counterpart of hooks, as every filter in
2449 ;; a set is applied to the return value of the previous one.
2450 ;;
2451 ;; Every set is back-end agnostic. Although, a filter is always
2452 ;; called, in addition to the string it applies to, with the back-end
2453 ;; used as argument, so it's easy for the end-user to add back-end
2454 ;; specific filters in the set. The communication channel, as
2455 ;; a plist, is required as the third argument.
2456 ;;
2457 ;; From the developer side, filters sets can be installed in the
2458 ;; process with the help of `org-export-define-backend', which
2459 ;; internally stores filters as an alist. Each association has a key
2460 ;; among the following symbols and a function or a list of functions
2461 ;; as value.
2462 ;;
2463 ;; - `:filter-options' applies to the property list containing export
2464 ;; options. Unlike to other filters, functions in this list accept
2465 ;; two arguments instead of three: the property list containing
2466 ;; export options and the back-end. Users can set its value through
2467 ;; `org-export-filter-options-functions' variable.
2468 ;;
2469 ;; - `:filter-parse-tree' applies directly to the complete parsed
2470 ;; tree. Users can set it through
2471 ;; `org-export-filter-parse-tree-functions' variable.
2472 ;;
2473 ;; - `:filter-body' applies to the body of the output, before template
2474 ;; translator chimes in. Users can set it through
2475 ;; `org-export-filter-body-functions' variable.
2476 ;;
2477 ;; - `:filter-final-output' applies to the final transcoded string.
2478 ;; Users can set it with `org-export-filter-final-output-functions'
2479 ;; variable.
2480 ;;
2481 ;; - `:filter-plain-text' applies to any string not recognized as Org
2482 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2483 ;; configure it.
2484 ;;
2485 ;; - `:filter-TYPE' applies on the string returned after an element or
2486 ;; object of type TYPE has been transcoded. A user can modify
2487 ;; `org-export-filter-TYPE-functions' to install these filters.
2488 ;;
2489 ;; All filters sets are applied with
2490 ;; `org-export-filter-apply-functions' function. Filters in a set are
2491 ;; applied in a LIFO fashion. It allows developers to be sure that
2492 ;; their filters will be applied first.
2493 ;;
2494 ;; Filters properties are installed in communication channel with
2495 ;; `org-export-install-filters' function.
2496 ;;
2497 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2498 ;; `org-export-before-parsing-hook') are run at the beginning of the
2499 ;; export process and just before parsing to allow for heavy structure
2500 ;; modifications.
2503 ;;;; Hooks
2506 "Hook run at the beginning of the export process.
2508 This is run before include keywords and macros are expanded and
2509 Babel code blocks executed, on a copy of the original buffer
2510 being exported. Visibility and narrowing are preserved. Point
2511 is at the beginning of the buffer.
2513 Every function in this hook will be called with one argument: the
2517 "Hook run before parsing an export buffer.
2519 This is run after include keywords and macros have been expanded
2520 and Babel code blocks executed, on a copy of the original buffer
2521 being exported. Visibility and narrowing are preserved. Point
2522 is at the beginning of the buffer.
2524 Every function in this hook will be called with one argument: the
2528 ;;;; Special Filters
2531 "List of functions applied to the export options.
2532 Each filter is called with two arguments: the export options, as
2533 a plist, and the back-end, as a symbol. It must return
2537 "List of functions applied to the parsed tree.
2538 Each filter is called with three arguments: the parse tree, as
2539 returned by `org-element-parse-buffer', the back-end, as
2540 a symbol, and the communication channel, as a plist. It must
2544 "List of functions applied to plain text.
2545 Each filter is called with three arguments: a string which
2546 contains no Org syntax, the back-end, as a symbol, and the
2547 communication channel, as a plist. It must return a string or
2551 "List of functions applied to transcoded body.
2552 Each filter is called with three arguments: a string which
2553 contains no Org syntax, the back-end, as a symbol, and the
2554 communication channel, as a plist. It must return a string or
2558 "List of functions applied to the transcoded string.
2559 Each filter is called with three arguments: the full transcoded
2560 string, the back-end, as a symbol, and the communication channel,
2561 as a plist. It must return a string that will be used as the
2565 ;;;; Elements Filters
2568 "List of functions applied to a transcoded babel-call.
2569 Each filter is called with three arguments: the transcoded data,
2570 as a string, the back-end, as a symbol, and the communication
2574 "List of functions applied to a transcoded center block.
2575 Each filter is called with three arguments: the transcoded data,
2576 as a string, the back-end, as a symbol, and the communication
2580 "List of functions applied to a transcoded clock.
2581 Each filter is called with three arguments: the transcoded data,
2582 as a string, the back-end, as a symbol, and the communication
2586 "List of functions applied to a transcoded comment.
2587 Each filter is called with three arguments: the transcoded data,
2588 as a string, the back-end, as a symbol, and the communication
2592 "List of functions applied to a transcoded comment-block.
2593 Each filter is called with three arguments: the transcoded data,
2594 as a string, the back-end, as a symbol, and the communication
2598 "List of functions applied to a transcoded diary-sexp.
2599 Each filter is called with three arguments: the transcoded data,
2600 as a string, the back-end, as a symbol, and the communication
2604 "List of functions applied to a transcoded drawer.
2605 Each filter is called with three arguments: the transcoded data,
2606 as a string, the back-end, as a symbol, and the communication
2610 "List of functions applied to a transcoded dynamic-block.
2611 Each filter is called with three arguments: the transcoded data,
2612 as a string, the back-end, as a symbol, and the communication
2616 "List of functions applied to a transcoded example-block.
2617 Each filter is called with three arguments: the transcoded data,
2618 as a string, the back-end, as a symbol, and the communication
2622 "List of functions applied to a transcoded export-block.
2623 Each filter is called with three arguments: the transcoded data,
2624 as a string, the back-end, as a symbol, and the communication
2628 "List of functions applied to a transcoded fixed-width.
2629 Each filter is called with three arguments: the transcoded data,
2630 as a string, the back-end, as a symbol, and the communication
2634 "List of functions applied to a transcoded footnote-definition.
2635 Each filter is called with three arguments: the transcoded data,
2636 as a string, the back-end, as a symbol, and the communication
2640 "List of functions applied to a transcoded headline.
2641 Each filter is called with three arguments: the transcoded data,
2642 as a string, the back-end, as a symbol, and the communication
2646 "List of functions applied to a transcoded horizontal-rule.
2647 Each filter is called with three arguments: the transcoded data,
2648 as a string, the back-end, as a symbol, and the communication
2652 "List of functions applied to a transcoded inlinetask.
2653 Each filter is called with three arguments: the transcoded data,
2654 as a string, the back-end, as a symbol, and the communication
2658 "List of functions applied to a transcoded item.
2659 Each filter is called with three arguments: the transcoded data,
2660 as a string, the back-end, as a symbol, and the communication
2664 "List of functions applied to a transcoded keyword.
2665 Each filter is called with three arguments: the transcoded data,
2666 as a string, the back-end, as a symbol, and the communication
2670 "List of functions applied to a transcoded latex-environment.
2671 Each filter is called with three arguments: the transcoded data,
2672 as a string, the back-end, as a symbol, and the communication
2676 "List of functions applied to a transcoded node-property.
2677 Each filter is called with three arguments: the transcoded data,
2678 as a string, the back-end, as a symbol, and the communication
2682 "List of functions applied to a transcoded paragraph.
2683 Each filter is called with three arguments: the transcoded data,
2684 as a string, the back-end, as a symbol, and the communication
2688 "List of functions applied to a transcoded plain-list.
2689 Each filter is called with three arguments: the transcoded data,
2690 as a string, the back-end, as a symbol, and the communication
2694 "List of functions applied to a transcoded planning.
2695 Each filter is called with three arguments: the transcoded data,
2696 as a string, the back-end, as a symbol, and the communication
2700 "List of functions applied to a transcoded property-drawer.
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 quote block.
2707 Each filter is called with three arguments: the transcoded quote
2708 data, as a string, the back-end, as a symbol, and the
2709 communication channel, as a plist. It must return a string or
2713 "List of functions applied to a transcoded section.
2714 Each filter is called with three arguments: the transcoded data,
2715 as a string, the back-end, as a symbol, and the communication
2719 "List of functions applied to a transcoded special block.
2720 Each filter is called with three arguments: the transcoded data,
2721 as a string, the back-end, as a symbol, and the communication
2725 "List of functions applied to a transcoded src-block.
2726 Each filter is called with three arguments: the transcoded data,
2727 as a string, the back-end, as a symbol, and the communication
2731 "List of functions applied to a transcoded table.
2732 Each filter is called with three arguments: the transcoded data,
2733 as a string, the back-end, as a symbol, and the communication
2737 "List of functions applied to a transcoded table-cell.
2738 Each filter is called with three arguments: the transcoded data,
2739 as a string, the back-end, as a symbol, and the communication
2743 "List of functions applied to a transcoded table-row.
2744 Each filter is called with three arguments: the transcoded data,
2745 as a string, the back-end, as a symbol, and the communication
2749 "List of functions applied to a transcoded verse block.
2750 Each filter is called with three arguments: the transcoded data,
2751 as a string, the back-end, as a symbol, and the communication
2755 ;;;; Objects Filters
2758 "List of functions applied to transcoded bold text.
2759 Each filter is called with three arguments: the transcoded data,
2760 as a string, the back-end, as a symbol, and the communication
2764 "List of functions applied to transcoded code text.
2765 Each filter is called with three arguments: the transcoded data,
2766 as a string, the back-end, as a symbol, and the communication
2770 "List of functions applied to a transcoded entity.
2771 Each filter is called with three arguments: the transcoded data,
2772 as a string, the back-end, as a symbol, and the communication
2776 "List of functions applied to a transcoded export-snippet.
2777 Each filter is called with three arguments: the transcoded data,
2778 as a string, the back-end, as a symbol, and the communication
2782 "List of functions applied to a transcoded footnote-reference.
2783 Each filter is called with three arguments: the transcoded data,
2784 as a string, the back-end, as a symbol, and the communication
2788 "List of functions applied to a transcoded inline-babel-call.
2789 Each filter is called with three arguments: the transcoded data,
2790 as a string, the back-end, as a symbol, and the communication
2794 "List of functions applied to a transcoded inline-src-block.
2795 Each filter is called with three arguments: the transcoded data,
2796 as a string, the back-end, as a symbol, and the communication
2800 "List of functions applied to transcoded italic text.
2801 Each filter is called with three arguments: the transcoded data,
2802 as a string, the back-end, as a symbol, and the communication
2806 "List of functions applied to a transcoded latex-fragment.
2807 Each filter is called with three arguments: the transcoded data,
2808 as a string, the back-end, as a symbol, and the communication
2812 "List of functions applied to a transcoded line-break.
2813 Each filter is called with three arguments: the transcoded data,
2814 as a string, the back-end, as a symbol, and the communication
2818 "List of functions applied to a transcoded link.
2819 Each filter is called with three arguments: the transcoded data,
2820 as a string, the back-end, as a symbol, and the communication
2824 "List of functions applied to a transcoded radio-target.
2825 Each filter is called with three arguments: the transcoded data,
2826 as a string, the back-end, as a symbol, and the communication
2830 "List of functions applied to a transcoded statistics-cookie.
2831 Each filter is called with three arguments: the transcoded data,
2832 as a string, the back-end, as a symbol, and the communication
2836 "List of functions applied to transcoded strike-through text.
2837 Each filter is called with three arguments: the transcoded data,
2838 as a string, the back-end, as a symbol, and the communication
2842 "List of functions applied to a transcoded subscript.
2843 Each filter is called with three arguments: the transcoded data,
2844 as a string, the back-end, as a symbol, and the communication
2848 "List of functions applied to a transcoded superscript.
2849 Each filter is called with three arguments: the transcoded data,
2850 as a string, the back-end, as a symbol, and the communication
2854 "List of functions applied to a transcoded target.
2855 Each filter is called with three arguments: the transcoded data,
2856 as a string, the back-end, as a symbol, and the communication
2860 "List of functions applied to a transcoded timestamp.
2861 Each filter is called with three arguments: the transcoded data,
2862 as a string, the back-end, as a symbol, and the communication
2866 "List of functions applied to transcoded underline text.
2867 Each filter is called with three arguments: the transcoded data,
2868 as a string, the back-end, as a symbol, and the communication
2872 "List of functions applied to transcoded verbatim text.
2873 Each filter is called with three arguments: the transcoded data,
2874 as a string, the back-end, as a symbol, and the communication
2878 ;;;; Filters Tools
2879 ;;
2880 ;; Internal function `org-export-install-filters' installs filters
2881 ;; hard-coded in back-ends (developer filters) and filters from global
2882 ;; variables (user filters) in the communication channel.
2883 ;;
2884 ;; Internal function `org-export-filter-apply-functions' takes care
2885 ;; about applying each filter in order to a given data. It ignores
2886 ;; filters returning a nil value but stops whenever a filter returns
2887 ;; an empty string.
2890 "Call every function in FILTERS.
2892 Functions are called with arguments VALUE, current export
2893 back-end's name and INFO. A function returning a nil value will
2894 be skipped. If it returns the empty string, the process ends and
2895 VALUE is ignored.
2897 Call is done in a LIFO fashion, to be sure that developer
2898 specified filters, if any, are called first."
2909 "Install filters properties in communication channel.
2910 INFO is a plist containing the current communication channel.
2911 Return the updated communication channel."
2913 ;; Install user-defined filters with `org-export-filters-alist'
2914 ;; and filters already in INFO (through ext-plist mechanism).
2921 ;; Filters in INFO will be called
2922 ;; before those user provided.
2925 default-value)))))
2926 org-export-filters-alist)
2927 ;; Prepend back-end specific filters to that list.
2929 ;; Single values get consed, lists are appended.
2934 plist key
2938 ;; Return new communication channel.
2942 \f
2943 ;;; Core functions
2944 ;;
2945 ;; This is the room for the main function, `org-export-as', along with
2946 ;; its derivative, `org-export-string-as'.
2947 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2948 ;; function should be added to kill ring.
2949 ;;
2950 ;; Note that `org-export-as' doesn't really parse the current buffer,
2951 ;; but a copy of it (with the same buffer-local variables and
2952 ;; visibility), where macros and include keywords are expanded and
2953 ;; Babel blocks are executed, if appropriate.
2954 ;; `org-export-with-buffer-copy' macro prepares that copy.
2955 ;;
2956 ;; File inclusion is taken care of by
2957 ;; `org-export-expand-include-keyword' and
2958 ;; `org-export--prepare-file-contents'. Structure wise, including
2959 ;; a whole Org file in a buffer often makes little sense. For
2960 ;; example, if the file contains a headline and the include keyword
2961 ;; was within an item, the item should contain the headline. That's
2962 ;; why file inclusion should be done before any structure can be
2963 ;; associated to the file, that is before parsing.
2964 ;;
2965 ;; `org-export-insert-default-template' is a command to insert
2966 ;; a default template (or a back-end specific template) at point or in
2967 ;; current subtree.
2970 "Return a copy of the current buffer.
2971 The copy preserves Org buffer-local variables, visibility and
2972 narrowing."
2978 new-buf))
2981 "Apply BODY in a copy of the current buffer.
2982 The copy preserves local variables, visibility and contents of
2983 the original buffer. Point is at the beginning of the buffer
2984 when BODY is applied."
2993 ;; Kill copy without confirmation.
2999 "Generate a function duplicating BUFFER.
3001 The copy will preserve local variables, visibility, contents and
3002 narrowing of the original buffer. If a region was active in
3003 BUFFER, contents will be narrowed to that region instead.
3005 The resulting function can be evaluated at a later time, from
3006 another buffer, effectively cloning the original buffer there.
3008 The function assumes BUFFER's major mode is `org-mode'."
3012 ;; Set major mode. Ignore `org-mode-hook' as it has been run
3013 ;; already in BUFFER.
3015 ;; Copy specific buffer local variables and variables set
3016 ;; through BIND keywords.
3018 vars)
3026 buffer-file-name
3027 buffer-file-coding-system))
3031 ;; Skip unreadable values, as they cannot be
3032 ;; sent to external process.
3036 vars))))))
3037 ;; Whole buffer contents.
3042 ;; Narrowing.
3046 ;; Current position of point.
3048 ;; Overlays with invisible property.
3058 ov-set))))
3060 ov-set)))))
3062 ;;;###autoload
3065 "Transcode current Org buffer into BACKEND code.
3067 BACKEND is either an export back-end, as returned by, e.g.,
3068 `org-export-create-backend', or a symbol referring to
3069 a registered back-end.
3071 If narrowing is active in the current buffer, only transcode its
3072 narrowed part.
3074 If a region is active, transcode that region.
3076 When optional argument SUBTREEP is non-nil, transcode the
3077 sub-tree at point, extracting information from the headline
3078 properties first.
3080 When optional argument VISIBLE-ONLY is non-nil, don't export
3081 contents of hidden elements.
3083 When optional argument BODY-ONLY is non-nil, only return body
3084 code, without surrounding template.
3086 Optional argument EXT-PLIST, when provided, is a property list
3087 with external parameters overriding Org default settings, but
3088 still inferior to file-local settings.
3090 Return code as a string."
3095 ;; Narrow buffer to an appropriate region or subtree for
3096 ;; parsing. If parsing subtree, be sure to remove main headline
3097 ;; too.
3105 ;; Initialize communication channel with original buffer
3106 ;; attributes, unavailable in its copy.
3115 tree)
3116 ;; Update communication channel and get parse tree. Buffer
3117 ;; isn't parsed directly. Instead, a temporary copy is
3118 ;; created, where include keywords, macros are expanded and
3119 ;; code blocks are evaluated.
3121 ;; Run first hook with current back-end's name as argument.
3125 ;; Update macro templates since #+INCLUDE keywords might have
3126 ;; added some new ones.
3130 ;; Update radio targets since keyword inclusion might have
3131 ;; added some more.
3133 ;; Run last hook with current back-end's name as argument.
3138 ;; Update communication channel with environment. Also
3139 ;; install user's and developer's filters.
3144 ;; Expand export-specific set of macros: {{{author}}},
3145 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3146 ;; once regular macros have been expanded, since document
3147 ;; keywords may contain one of them.
3153 ;; EMAIL is not a parsed keyword: store it as-is.
3157 ;; Parse buffer.
3159 ;; Handle left-over uninterpreted elements or objects in
3160 ;; parse tree and communication channel.
3162 ;; Call options filters and update export options. We do not
3163 ;; use `org-export-filter-apply-functions' here since the
3164 ;; arity of such filters is different.
3169 ;; Parse buffer, handle uninterpreted elements or objects,
3170 ;; then call parse-tree filters.
3174 ;; Now tree is complete, compute its properties and add them
3175 ;; to communication channel.
3179 ;; Eventually transcode TREE. Wrap the resulting string into
3180 ;; a template.
3189 info))
3192 ;; Remove all text properties since they cannot be
3193 ;; retrieved from an external process. Finally call
3194 ;; final-output filter and return result.
3200 info))))))))
3202 ;;;###autoload
3204 "Transcode STRING into BACKEND code.
3206 BACKEND is either an export back-end, as returned by, e.g.,
3207 `org-export-create-backend', or a symbol referring to
3208 a registered back-end.
3210 When optional argument BODY-ONLY is non-nil, only return body
3211 code, without preamble nor postamble.
3213 Optional argument EXT-PLIST, when provided, is a property list
3214 with external parameters overriding Org default settings, but
3215 still inferior to file-local settings.
3217 Return code as a string."
3223 ;;;###autoload
3225 "Replace the active region by its export to BACKEND.
3226 BACKEND is either an export back-end, as returned by, e.g.,
3227 `org-export-create-backend', or a symbol referring to
3228 a registered back-end."
3238 ;;;###autoload
3240 "Insert all export keywords with default values at beginning of line.
3242 BACKEND is a symbol referring to the name of a registered export
3243 back-end, for which specific export options should be added to
3244 the template, or `default' for default template. When it is nil,
3245 the user will be prompted for a category.
3247 If SUBTREEP is non-nil, export configuration will be set up
3248 locally for the subtree through node properties."
3258 "Options category: "
3262 org-export--registered-backends))
3263 nil t))))
3264 options keywords)
3265 ;; Populate OPTIONS and KEYWORDS.
3282 ;; Move to an appropriate location in order to insert options.
3284 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3302 ;; Then the rest of keywords, in the order specified in either
3303 ;; `org-export-options-alist' or respective export back-ends.
3324 "Expand every include keyword in buffer.
3325 Optional argument INCLUDED is a list of included file names along
3326 with their line restriction, when appropriate. It is used to
3327 avoid infinite recursion. Optional argument DIR is the current
3328 working directory. It is used to properly resolve relative
3329 paths."
3338 ;; Extract arguments from keyword's value.
3341 location
3353 matched)
3354 dir)))
3363 value)
3370 ;; Minimal level of included file defaults to the child
3371 ;; level of the current headline, if any, or one. It
3372 ;; only applies is the file is meant to be included as
3373 ;; an Org one.
3385 ;; Remove keyword.
3391 ;; Check if files has already been parsed. Look after
3392 ;; inclusion lines too, as different parts of the same file
3393 ;; can be included too.
3408 ind-str block arg-str contents ind-str block))))
3415 ind-str block contents ind-str block))))
3423 file location only-contents lines)
3424 lines)))
3428 file lines ind minlevel
3437 "Resolve absolute lines for an included file with file-link.
3439 FILE is string file-name of the file to include. LOCATION is a
3440 string name within FILE to be included (located via
3441 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3442 contents of the named element will be included, as determined
3443 Org-Element. If LINES is non-nil only those lines are included.
3445 Return a string of lines to be included in the format expected by
3446 `org-export--prepare-file-contents'."
3452 ;; Enforce consistent search.
3465 ;; Skip planning line and property-drawer. If a normal drawer
3466 ;; precedes a property-drawer both will be included.
3467 ;; Remaining property-drawers are removed as needed in
3468 ;; `org-export--prepare-file-contents'.
3494 start-line
3496 (+ start-line
3499 counter))))))))
3502 "Prepare the contents of FILE for inclusion and return them as a string.
3504 When optional argument LINES is a string specifying a range of
3505 lines, include only those lines.
3507 Optional argument IND, when non-nil, is an integer specifying the
3508 global indentation of returned contents. Since its purpose is to
3509 allow an included file to stay in the same environment it was
3510 created \(i.e. a list item), it doesn't apply past the first
3511 headline encountered.
3513 Optional argument MINLEVEL, when non-nil, is an integer
3514 specifying the level that any top-level headline in the included
3515 file should have.
3517 Optional argument ID is an integer that will be inserted before
3518 each footnote definition and reference if FILE is an Org file.
3519 This is useful to avoid conflicts when more than one Org file
3520 with footnotes is included in a document."
3536 ;; Remove blank lines at beginning and end of contents. The logic
3537 ;; behind that removal is that blank lines around include keyword
3538 ;; override blank lines in included file.
3547 ;; Remove property-drawers after drawers.
3561 ;; If IND is set, preserve indentation of include keyword until
3562 ;; the first headline encountered.
3569 ;; Do not move footnote definitions out of column 0.
3575 ;; When MINLEVEL is specified, compute minimal level for headlines
3576 ;; in the file (CUR-MIN), and remove stars to each headline so
3577 ;; that headlines with minimal level have a level of MINLEVEL.
3588 ;; Only change stars, don't bother moving whole
3589 ;; sections.
3593 ;; Append ID to all footnote references and definitions, so they
3594 ;; become file specific and cannot collide with footnotes in other
3595 ;; included files.
3612 "Execute every Babel code in the visible part of current buffer."
3613 ;; Get a pristine copy of current buffer so Babel references can be
3614 ;; properly resolved.
3620 "Return a non-nil value when output should be added to the kill ring.
3621 See also `org-export-copy-to-kill-ring'."
3627 \f
3628 ;;; Tools For Back-Ends
3629 ;;
3630 ;; A whole set of tools is available to help build new exporters. Any
3631 ;; function general enough to have its use across many back-ends
3632 ;; should be added here.
3634 ;;;; For Affiliated Keywords
3635 ;;
3636 ;; `org-export-read-attribute' reads a property from a given element
3637 ;; as a plist. It can be used to normalize affiliated keywords'
3638 ;; syntax.
3639 ;;
3640 ;; Since captions can span over multiple lines and accept dual values,
3641 ;; their internal representation is a bit tricky. Therefore,
3642 ;; `org-export-get-caption' transparently returns a given element's
3643 ;; caption as a secondary string.
3646 "Turn ATTRIBUTE property from ELEMENT into a plist.
3648 When optional argument PROPERTY is non-nil, return the value of
3649 that property within attributes.
3653 properties.
3655 All values will become strings except the empty string and
3658 will become the empty string."
3672 s)
3677 ;; Ignore any string before first property with `cdr'.
3682 "Return caption from ELEMENT as a secondary string.
3684 When optional argument SHORTP is non-nil, return short caption,
3685 as a secondary string, instead.
3687 Caption lines are separated by a white space."
3695 ;;;; For Derived Back-ends
3696 ;;
3697 ;; `org-export-with-backend' is a function allowing to locally use
3698 ;; another back-end to transcode some object or element. In a derived
3699 ;; back-end, it may be used as a fall-back function once all specific
3700 ;; cases have been treated.
3703 "Call a transcoder from BACKEND on DATA.
3704 BACKEND is an export back-end, as returned by, e.g.,
3705 `org-export-create-backend', or a symbol referring to
3706 a registered back-end. DATA is an Org element, object, secondary
3707 string or string. CONTENTS, when non-nil, is the transcoded
3708 contents of DATA element, as a string. INFO, when non-nil, is
3709 the communication channel used for export, as a plist."
3719 transcoder data contents
3722 :translate-alist all-transcoders
3726 ;;;; For Export Snippets
3727 ;;
3728 ;; Every export snippet is transmitted to the back-end. Though, the
3729 ;; latter will only retain one type of export-snippet, ignoring
3730 ;; others, based on the former's target back-end. The function
3731 ;; `org-export-snippet-backend' returns that back-end for a given
3732 ;; export-snippet.
3735 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3736 Translation, with `org-export-snippet-translation-alist', is
3737 applied."
3741 back-end))))
3744 ;;;; For Footnotes
3745 ;;
3746 ;; `org-export-collect-footnote-definitions' is a tool to list
3747 ;; actually used footnotes definitions in the whole parse tree, or in
3748 ;; a headline, in order to add footnote listings throughout the
3749 ;; transcoded data.
3750 ;;
3751 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3752 ;; back-ends, when they need to attach the footnote definition only to
3753 ;; the first occurrence of the corresponding label.
3754 ;;
3755 ;; `org-export-get-footnote-definition' and
3756 ;; `org-export-get-footnote-number' provide easier access to
3757 ;; additional information relative to a footnote reference.
3760 "Return an alist between footnote numbers, labels and definitions.
3762 DATA is the parse tree from which definitions are collected.
3763 INFO is the plist used as a communication channel.
3765 Definitions are sorted by order of references. They either
3766 appear as Org data or as a secondary string for inlined
3767 footnotes. Unreferenced definitions are ignored."
3769 collect-fn ; for byte-compiler.
3773 ;; Collect footnote number, label and definition in DATA.
3781 def)
3782 num-alist)
3783 ;; Also search in definition for nested footnotes.
3786 ;; Don't enter footnote definitions since it will happen
3787 ;; when their first reference is found.
3793 "Non-nil when a footnote reference is the first one for its label.
3795 FOOTNOTE-REFERENCE is the footnote reference being considered.
3796 INFO is the plist used as a communication channel."
3798 ;; Anonymous footnotes are always a first reference.
3800 ;; Otherwise, return the first footnote with the same LABEL and
3801 ;; test if it is equal to FOOTNOTE-REFERENCE.
3811 ;; If FN isn't inlined, be sure to traverse its
3812 ;; definition before resuming search. See
3813 ;; comments in `org-export-get-footnote-number'
3814 ;; for more information.
3818 ;; Don't enter footnote definitions since it will
3819 ;; happen when their first reference is found.
3822 footnote-reference)))))
3825 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3826 INFO is the plist used as a communication channel. If no such
3835 "Return number associated to a footnote.
3837 FOOTNOTE is either a footnote reference or a footnote definition.
3838 INFO is the plist used as a communication channel."
3840 seen-refs
3841 search-ref ; For byte-compiler.
3845 ;; Search footnote references through DATA, filling
3846 ;; SEEN-REFS along the way.
3851 ;; Anonymous footnote match: return number.
3854 ;; Labels match: return number.
3857 ;; Anonymous footnote: it's always a new one.
3858 ;; Also, be sure to return nil from the `cond' so
3859 ;; `first-match' doesn't get us out of the loop.
3861 ;; Label not seen so far: add it so SEEN-REFS.
3862 ;;
3863 ;; Also search for subsequent references in
3864 ;; footnote definition so numbering follows
3865 ;; reading logic. Note that we don't have to care
3866 ;; about inline definitions, since
3867 ;; `org-element-map' already traverses them at the
3868 ;; right time.
3869 ;;
3870 ;; Once again, return nil to stay in the loop.
3875 nil))))
3876 ;; Don't enter footnote definitions since it will
3877 ;; happen when their first reference is found.
3882 ;;;; For Headlines
3883 ;;
3884 ;; `org-export-get-relative-level' is a shortcut to get headline
3885 ;; level, relatively to the lower headline level in the parsed tree.
3886 ;;
3887 ;; `org-export-get-headline-number' returns the section number of an
3888 ;; headline, while `org-export-number-to-roman' allows to convert it
3889 ;; to roman numbers. With an optional argument,
3890 ;; `org-export-get-headline-number' returns a number to unnumbered
3891 ;; headlines (used for internal id).
3892 ;;
3893 ;; `org-export-get-headline-id' returns the unique internal id of a
3894 ;; headline.
3895 ;;
3896 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3897 ;; `org-export-last-sibling-p' are three useful predicates when it
3898 ;; comes to fulfill the `:headline-levels' property.
3899 ;;
3900 ;; `org-export-get-tags', `org-export-get-category' and
3901 ;; `org-export-get-node-property' extract useful information from an
3902 ;; headline or a parent headline. They all handle inheritance.
3903 ;;
3904 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3905 ;; as a secondary string, suitable for table of contents. It falls
3906 ;; back onto default title.
3909 "Return HEADLINE relative level within current parsed tree.
3910 INFO is a plist holding contextual information."
3915 "Non-nil when HEADLINE is considered as low level.
3917 INFO is a plist used as a communication channel.
3919 A low level headlines has a relative level greater than
3920 `:headline-levels' property value.
3922 Return value is the difference between HEADLINE relative level
3923 and the last level being considered as high enough, or nil."
3930 "Return a unique ID for HEADLINE.
3931 INFO is a plist holding contextual information."
3941 "Return numbered HEADLINE numbering as a list of numbers.
3942 INFO is a plist holding contextual information."
3947 "Return a non-nil value if HEADLINE element should be numbered.
3948 INFO is a plist used as a communication channel."
3957 "Convert integer N into a roman numeral."
3970 res)))
3973 "Return list of tags associated to ELEMENT.
3975 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3976 is a plist used as a communication channel.
3978 Select tags (see `org-export-select-tags') and exclude tags (see
3979 `org-export-exclude-tags') are removed from the list.
3981 When non-nil, optional argument TAGS should be a list of strings.
3982 Any tag belonging to this list will also be removed.
3984 When optional argument INHERITED is non-nil, tags can also be
3985 inherited from parent headlines and FILETAGS keywords."
3991 ;; Build complete list of inherited tags.
4002 ;; Add FILETAGS keywords and return results.
4006 "Return node PROPERTY value for BLOB.
4008 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
4009 element or object.
4011 If optional argument INHERITED is non-nil, the value can be
4012 inherited from a parent headline.
4014 Return value is a string or nil."
4026 "Return category for element or object BLOB.
4028 INFO is a plist used as a communication channel.
4030 CATEGORY is automatically inherited from a parent headline, from
4031 #+CATEGORY: keyword or created out of original file name. If all
4044 "Return alternative title for HEADLINE, as a secondary string.
4045 INFO is a plist used as a communication channel. If no optional
4046 title is defined, fall-back to the regular title."
4051 "Non-nil when BLOB is the first sibling in its parent.
4052 BLOB is an element or an object. If BLOB is a headline, non-nil
4053 means it is the first sibling in the sub-tree. INFO is a plist
4054 used as a communication channel."
4059 "Non-nil when BLOB is the last sibling in its parent.
4060 BLOB is an element or an object. INFO is a plist used as
4061 a communication channel."
4065 ;;;; For Keywords
4066 ;;
4067 ;; `org-export-get-date' returns a date appropriate for the document
4068 ;; to about to be exported. In particular, it takes care of
4069 ;; `org-export-date-timestamp-format'.
4072 "Return date value for the current document.
4074 INFO is a plist used as a communication channel. FMT, when
4075 non-nil, is a time format string that will be applied on the date
4076 if it consists in a single timestamp object. It defaults to
4077 `org-export-date-timestamp-format' when nil.
4079 A proper date can be a secondary string, a string or nil. It is
4080 meant to be translated with `org-export-data' or alike."
4091 ;;;; For Links
4092 ;;
4093 ;; `org-export-solidify-link-text' turns a string into a safer version
4094 ;; for links, replacing most non-standard characters with hyphens.
4095 ;;
4096 ;; `org-export-get-coderef-format' returns an appropriate format
4097 ;; string for coderefs.
4098 ;;
4099 ;; `org-export-inline-image-p' returns a non-nil value when the link
4100 ;; provided should be considered as an inline image.
4101 ;;
4102 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4103 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4104 ;; returns an appropriate unique identifier when found, or nil.
4105 ;;
4106 ;; `org-export-resolve-id-link' returns the first headline with
4107 ;; specified id or custom-id in parse tree, the path to the external
4108 ;; file with the id or nil when neither was found.
4109 ;;
4110 ;; `org-export-resolve-coderef' associates a reference to a line
4111 ;; number in the element it belongs, or returns the reference itself
4112 ;; when the element isn't numbered.
4115 "Take link text S and make a safe target out of it."
4120 "Return format string for code reference link.
4121 PATH is the link path. DESC is its description."
4129 "Non-nil if LINK object points to an inline image.
4131 Optional argument is a set of RULES defining inline images. It
4132 is an alist where associations have the following shape:
4134 \(TYPE . REGEXP)
4136 Applying a rule means apply REGEXP against LINK's path when its
4137 type is TYPE. The function will return a non-nil value if any of
4138 the provided rules is non-nil. The default rule is
4139 `org-export-default-inline-image-rule'.
4141 This only applies to links without a description."
4152 rules)
4153 ;; Return nil if no rule matched.
4154 nil))))
4157 "Resolve a code reference REF.
4159 INFO is a plist used as a communication channel.
4161 Return associated line number in source code, or REF itself,
4162 depending on src-block or example element's switches."
4169 org-coderef-label-format)))
4173 ;; Element containing REF is found. Resolve it to either
4174 ;; a label or a line number, as needed.
4184 "Return LINK destination.
4186 INFO is a plist holding contextual information.
4188 Return value can be an object, an element, or nil:
4190 - If LINK path matches a target object (i.e. <<path>>) return it.
4192 - If LINK path exactly matches the name affiliated keyword
4193 \(i.e. #+NAME: path) of an element, return that element.
4195 - If LINK path exactly matches any headline name, return that
4196 element. If more than one headline share that name, priority
4197 will be given to the one with the closest common ancestor, if
4198 any, or the first one in the parse tree otherwise.
4200 - Otherwise, return nil.
4203 significant."
4206 ;; Split PATH at white spaces so matches are space
4207 ;; insensitive.
4210 ;; Cache for destinations that are not position dependent.
4218 ;; Destination is not position dependent: use cached value.
4220 ;; First try to find a matching "<<path>>" unless user specified
4221 ;; he was looking for a headline (path starts with a "*"
4222 ;; character).
4228 path)
4229 blob))
4232 ;; Then try to find an element with a matching "#+NAME: path"
4233 ;; affiliated keyword.
4236 org-element-all-elements
4241 el)))
4244 ;; Last case: link either points to a headline or to nothingness.
4245 ;; Try to find the source, with priority given to headlines with
4246 ;; the closest common ancestor. If such candidate is found,
4247 ;; return it, otherwise return nil.
4251 ;; Return first headline whose `:raw-value' property is
4252 ;; NAME in parse tree DATA, or nil. Statistics cookies
4253 ;; are ignored.
4261 name)
4262 headline))
4264 ;; Search among headlines sharing an ancestor with link, from
4265 ;; closest to farthest.
4274 ;; No destination found: return nil.
4278 "Return headline referenced as LINK destination.
4280 INFO is a plist used as a communication channel.
4282 Return value can be the headline element matched in current parse
4286 ;; First check if id is within the current parse tree.
4291 headline))
4293 ;; Otherwise, look for external files.
4297 "Return radio-target object referenced as LINK destination.
4299 INFO is a plist used as a communication channel.
4301 Return value can be a radio-target object or nil. Assume LINK
4310 nil nil path nil nil t)
4311 t)
4312 radio))
4316 ;;;; For References
4317 ;;
4318 ;; `org-export-get-ordinal' associates a sequence number to any object
4319 ;; or element.
4322 "Return ordinal number of an element or object.
4324 ELEMENT is the element or object considered. INFO is the plist
4325 used as a communication channel.
4327 Optional argument TYPES, when non-nil, is a list of element or
4328 object types, as symbols, that should also be counted in.
4329 Otherwise, only provided element's type is considered.
4331 Optional argument PREDICATE is a function returning a non-nil
4332 value if the current element or object should be counted in. It
4333 accepts two arguments: the element or object being considered and
4334 the plist used as a communication channel. This allows to count
4335 only a certain type of objects (i.e. inline images).
4337 Return value is a list of numbers if ELEMENT is a headline or an
4338 item. It is nil for keywords. It represents the footnote number
4339 for footnote definitions and footnote references. If ELEMENT is
4340 a target, return the same value as if ELEMENT was the closest
4341 table, item or headline containing the target. In any other
4342 case, return the sequence number of ELEMENT among elements or
4343 objects of the same type."
4344 ;; Ordinal of a target object refer to the ordinal of the closest
4345 ;; table, item, or headline containing the object.
4349 when
4353 table))
4354 return parent)))
4356 ;; Special case 1: A headline returns its number as a list.
4358 ;; Special case 2: An item returns its number as a list.
4362 struct
4369 ;; Increment counter until ELEMENT is found again.
4380 ;;;; For Src-Blocks
4381 ;;
4382 ;; `org-export-get-loc' counts number of code lines accumulated in
4383 ;; src-block or example-block elements with a "+n" switch until
4384 ;; a given element, excluded. Note: "-n" switches reset that count.
4385 ;;
4386 ;; `org-export-unravel-code' extracts source code (along with a code
4387 ;; references alist) from an `element-block' or `src-block' type
4388 ;; element.
4389 ;;
4390 ;; `org-export-format-code' applies a formatting function to each line
4391 ;; of code, providing relative line number and code reference when
4392 ;; appropriate. Since it doesn't access the original element from
4393 ;; which the source code is coming, it expects from the code calling
4394 ;; it to know if lines should be numbered and if code references
4395 ;; should appear.
4396 ;;
4397 ;; Eventually, `org-export-format-code-default' is a higher-level
4398 ;; function (it makes use of the two previous functions) which handles
4399 ;; line numbering and code references inclusion, and returns source
4400 ;; code in a format suitable for plain text or verbatim output.
4403 "Return accumulated lines of code up to ELEMENT.
4405 INFO is the plist used as a communication channel.
4407 ELEMENT is excluded from count."
4413 ;; ELEMENT is reached: Quit the loop.
4415 ;; Only count lines from src-block and example-block elements
4416 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4420 ;; Accumulate locs or reset them.
4424 ;; Return nil to stay in the loop.
4425 nil)))
4427 ;; Return value.
4428 loc))
4431 "Clean source code and extract references out of it.
4433 ELEMENT has either a `src-block' an `example-block' type.
4435 Return a cons cell whose CAR is the source code, cleaned from any
4436 reference, protective commas and spurious indentation, and CDR is
4437 an alist between relative line number (integer) and name of code
4438 reference on that line (string)."
4441 ;; Get code and clean it. Remove blank lines at its
4442 ;; beginning and end.
4449 value
4451 ;; Get format used for references.
4454 org-coderef-label-format)))
4455 ;; Build a regexp matching a loc with a reference.
4460 ;; Return value.
4462 ;; Code with references removed.
4468 ;; Ref line: remove ref, and signal its position in REFS.
4472 ;; Reference alist.
4473 refs)))
4476 "Format CODE by applying FUN line-wise and return it.
4478 CODE is a string representing the code to format. FUN is
4479 a function. It must accept three arguments: a line of
4480 code (string), the current line number (integer) or nil and the
4481 reference associated to the current line (string) or nil.
4483 Optional argument NUM-LINES can be an integer representing the
4484 number of code lines accumulated until the current code. Line
4485 numbers passed to FUN will take it into account. If it is nil,
4486 FUN's second argument will always be nil. This number can be
4487 obtained with `org-export-get-loc' function.
4489 Optional argument REF-ALIST can be an alist between relative line
4490 number (i.e. ignoring NUM-LINES) and the name of the code
4491 reference on it. If it is nil, FUN's third argument will always
4492 be nil. It can be obtained through the use of
4493 `org-export-unravel-code' function."
4505 "Return source code from ELEMENT, formatted in a standard way.
4507 ELEMENT is either a `src-block' or `example-block' element. INFO
4508 is a plist used as a communication channel.
4510 This function takes care of line numbering and code references
4511 inclusion. Line numbers, when applicable, appear at the
4512 beginning of the line, separated from the code by two white
4513 spaces. Code references, on the other hand, appear flushed to
4514 the right, separated by six white spaces from the widest line of
4515 code."
4516 ;; Extract code and references.
4523 ;; Handle line numbering.
4532 ;; Prepare references display, if required. Any reference
4533 ;; should start six columns after the widest line of code,
4534 ;; wrapped with parenthesis.
4539 code
4543 number-str
4544 loc
4550 num-start refs)))))
4553 ;;;; For Tables
4554 ;;
4555 ;; `org-export-table-has-special-column-p' and and
4556 ;; `org-export-table-row-is-special-p' are predicates used to look for
4557 ;; meta-information about the table structure.
4558 ;;
4559 ;; `org-table-has-header-p' tells when the rows before the first rule
4560 ;; should be considered as table's header.
4561 ;;
4562 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4563 ;; and `org-export-table-cell-borders' extract information from
4564 ;; a table-cell element.
4565 ;;
4566 ;; `org-export-table-dimensions' gives the number on rows and columns
4567 ;; in the table, ignoring horizontal rules and special columns.
4568 ;; `org-export-table-cell-address', given a table-cell object, returns
4569 ;; the absolute address of a cell. On the other hand,
4570 ;; `org-export-get-table-cell-at' does the contrary.
4571 ;;
4572 ;; `org-export-table-cell-starts-colgroup-p',
4573 ;; `org-export-table-cell-ends-colgroup-p',
4574 ;; `org-export-table-row-starts-rowgroup-p',
4575 ;; `org-export-table-row-ends-rowgroup-p',
4576 ;; `org-export-table-row-starts-header-p',
4577 ;; `org-export-table-row-ends-header-p' and
4578 ;; `org-export-table-row-in-header-p' indicate position of current row
4579 ;; or cell within the table.
4582 "Non-nil when TABLE has a special column.
4583 All special columns will be ignored during export."
4584 ;; The table has a special column when every first cell of every row
4585 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4586 ;; "*" "_" and "^". Though, do not consider a first row containing
4587 ;; only empty cells as special.
4603 "Non-nil when TABLE has a header.
4605 INFO is a plist used as a communication channel.
4607 A table has a header when it contains at least two row groups."
4616 table
4627 cache)))))
4630 "Non-nil if TABLE-ROW is considered special.
4632 INFO is a plist used as the communication channel.
4634 All special rows will be ignored during export."
4638 ;; A row is special either when...
4640 ;; ... it starts with a field only containing "/",
4642 ;; ... the table contains a special column and the row start
4643 ;; with a marking character among, "^", "_", "$" or "!",
4647 ;; ... it contains only alignment cookies and empty cells.
4653 ;; Since VALUE is a secondary string, the following
4654 ;; checks avoid expanding it with `org-export-data'.
4666 "Return TABLE-ROW's group number, as an integer.
4668 INFO is a plist used as the communication channel.
4670 Return value is the group number, as an integer, or nil for
4671 special rows and rows separators. First group is also table's
4672 header."
4690 "Return TABLE-CELL contents width.
4692 INFO is a plist used as the communication channel.
4694 Return value is the width given by the last width cookie in the
4695 same column as TABLE-CELL, or nil."
4714 ;; In a special row, try to find a width cookie at COLUMN.
4718 ;; The following checks avoid expanding unnecessarily
4719 ;; the cell with `org-export-data'.
4729 "Return TABLE-CELL contents alignment.
4731 INFO is a plist used as the communication channel.
4733 Return alignment as specified by the last alignment cookie in the
4734 same column as TABLE-CELL. If no such cookie is found, a default
4735 alignment value will be deduced from fraction of numbers in the
4736 column (see `org-table-number-fraction' for more information).
4737 Possible values are `left', `right' and `center'."
4738 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4755 cookie-align
4756 previous-cell-number-p)
4759 ;; In a special row, try to find an alignment cookie at
4760 ;; COLUMN.
4764 ;; Since VALUE is a secondary string, the following
4765 ;; checks avoid useless expansion through
4766 ;; `org-export-data'.
4774 ;; Ignore table rules.
4776 ;; In a standard row, check if cell's contents are
4777 ;; expressing some kind of number. Increase NUMBER-CELLS
4778 ;; accordingly. Though, don't bother if an alignment
4779 ;; cookie has already defined cell's alignment.
4784 info)))
4786 ;; Treat an empty cell as a number if it follows
4787 ;; a number.
4793 ;; Return value. Alignment specified by cookies has
4794 ;; precedence over alignment deduced from cell's contents.
4796 column
4801 org-table-number-fraction)
4806 "Return TABLE-CELL borders.
4808 INFO is a plist used as a communication channel.
4810 Return value is a list of symbols, or nil. Possible values are:
4811 `top', `bottom', `above', `below', `left' and `right'. Note:
4812 `top' (resp. `bottom') only happen for a cell in the first
4813 row (resp. last row) of the table, ignoring table rules, if any.
4815 Returned borders ignore special rows."
4818 borders)
4819 ;; Top/above border? TABLE-CELL has a border above when a rule
4820 ;; used to demarcate row groups can be found above. Hence,
4821 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4822 ;; another regular row has to be found above that rule.
4831 ;; Look at every row before the current one.
4833 ;; No rule above, or rule found starts the table (ignoring any
4834 ;; special row): TABLE-CELL is at the top of the table.
4837 ;; Bottom/below border? TABLE-CELL has a border below when next
4838 ;; non-regular row below is a rule.
4847 ;; Look at every row after the current one.
4849 ;; No rule below, or rule found ends the table (modulo some
4850 ;; special row): TABLE-CELL is at the bottom of the table.
4853 ;; Right/left borders? They can only be specified by column
4854 ;; groups. Column groups are defined in a row starting with "/".
4855 ;; Also a column groups row only contains "<", "<>", ">" or blank
4856 ;; cells.
4873 ;; There's a left border when previous cell, if
4874 ;; any, ends a group, or current one starts one.
4880 ;; There's a right border when next cell, if any,
4881 ;; starts a group, or current one ends one.
4888 ;; Table rows are read in reverse order so last column groups
4889 ;; row has precedence over any previous one.
4891 ;; Return value.
4892 borders))
4895 "Non-nil when TABLE-CELL is at the beginning of a column group.
4896 INFO is a plist used as a communication channel."
4897 ;; A cell starts a column group either when it is at the beginning
4898 ;; of a row (or after the special column, if any) or when it has
4899 ;; a left border.
4902 table-cell)
4906 "Non-nil when TABLE-CELL is at the end of a column group.
4907 INFO is a plist used as a communication channel."
4908 ;; A cell ends a column group either when it is at the end of a row
4909 ;; or when it has a right border.
4912 table-cell)
4916 "Non-nil when TABLE-ROW is at the beginning of a row group.
4917 INFO is a plist used as a communication channel."
4925 "Non-nil when TABLE-ROW is at the end of a row group.
4926 INFO is a plist used as a communication channel."
4934 "Non-nil when TABLE-ROW is located within table's header.
4935 INFO is a plist used as a communication channel. Always return
4936 nil for special rows and rows separators."
4942 "Non-nil when TABLE-ROW is the first table header's row.
4943 INFO is a plist used as a communication channel."
4948 "Non-nil when TABLE-ROW is the last table header's row.
4949 INFO is a plist used as a communication channel."
4954 "Return TABLE-ROW number.
4955 INFO is a plist used as a communication channel. Return value is
4956 zero-based and ignores separators. The function returns nil for
4957 special columns and separators."
4969 "Return TABLE dimensions.
4971 INFO is a plist used as a communication channel.
4973 Return value is a CONS like (ROWS . COLUMNS) where
4974 ROWS (resp. COLUMNS) is the number of exportable
4975 rows (resp. columns)."
4977 ;; Set number of rows, and extract first one.
4983 ;; Set number of columns.
4985 ;; Return value.
4989 "Return address of a regular TABLE-CELL object.
4991 TABLE-CELL is the cell considered. INFO is a plist used as
4992 a communication channel.
4994 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4995 zero-based index. Only exportable cells are considered. The
4996 function returns nil for other cells."
5008 "Return regular table-cell object at ADDRESS in TABLE.
5010 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5011 zero-based index. TABLE is a table type element. INFO is
5012 a plist used as a communication channel.
5014 If no table-cell, among exportable cells, is found at ADDRESS,
5015 return nil."
5018 ;; Row at (car address) or nil.
5026 'table-cell
5033 ;;;; For Tables Of Contents
5034 ;;
5035 ;; `org-export-collect-headlines' builds a list of all exportable
5036 ;; headline elements, maybe limited to a certain depth. One can then
5037 ;; easily parse it and transcode it.
5038 ;;
5039 ;; Building lists of tables, figures or listings is quite similar.
5040 ;; Once the generic function `org-export-collect-elements' is defined,
5041 ;; `org-export-collect-tables', `org-export-collect-figures' and
5042 ;; `org-export-collect-listings' can be derived from it.
5045 "Collect headlines in order to build a table of contents.
5047 INFO is a plist used as a communication channel.
5049 When optional argument N is an integer, it specifies the depth of
5050 the table of contents. Otherwise, it is set to the value of the
5051 last headline level. See `org-export-headline-levels' for more
5052 information.
5054 Return a list of all exportable headlines as parsed elements.
5055 Footnote sections, if any, will be ignored."
5063 info)))
5066 "Collect referenceable elements of a determined type.
5068 TYPE can be a symbol or a list of symbols specifying element
5069 types to search. Only elements with a caption are collected.
5071 INFO is a plist used as a communication channel.
5073 When non-nil, optional argument PREDICATE is a function accepting
5074 one argument, an element of type TYPE. It returns a non-nil
5075 value when that element should be collected.
5077 Return a list of all elements found, in order of appearance."
5082 element))
5083 info))
5086 "Build a list of tables.
5087 INFO is a plist used as a communication channel.
5089 Return a list of table elements with a caption."
5093 "Build a list of figures.
5095 INFO is a plist used as a communication channel. PREDICATE is
5096 a function which accepts one argument: a paragraph element and
5097 whose return value is non-nil when that element should be
5098 collected.
5100 A figure is a paragraph type element, with a caption, verifying
5102 a vague concept that may depend on back-end.
5104 Return a list of elements recognized as figures."
5108 "Build a list of src blocks.
5110 INFO is a plist used as a communication channel.
5112 Return a list of src-block elements with a caption."
5116 ;;;; Smart Quotes
5117 ;;
5118 ;; The main function for the smart quotes sub-system is
5119 ;; `org-export-activate-smart-quotes', which replaces every quote in
5120 ;; a given string from the parse tree with its "smart" counterpart.
5121 ;;
5122 ;; Dictionary for smart quotes is stored in
5123 ;; `org-export-smart-quotes-alist'.
5124 ;;
5125 ;; Internally, regexps matching potential smart quotes (checks at
5126 ;; string boundaries are also necessary) are defined in
5127 ;; `org-export-smart-quotes-regexps'.
5131 ;; one may use: »...«, "...", ›...‹, or '...'.
5132 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5133 ;; LaTeX quotes require Babel!
5178 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5187 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5196 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5205 ;; 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
5206 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5217 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5223 )
5224 "Smart quotes translations.
5226 Alist whose CAR is a language string and CDR is an alist with
5227 quote type as key and a plist associating various encodings to
5228 their translation as value.
5230 A quote type can be any symbol among `opening-double-quote',
5231 `closing-double-quote', `opening-single-quote',
5232 `closing-single-quote' and `apostrophe'.
5234 Valid encodings include `:utf-8', `:html', `:latex' and
5235 `:texinfo'.
5241 ;; Possible opening quote at beginning of string.
5243 ;; Possible closing quote at beginning of string.
5245 ;; Possible apostrophe at beginning of string.
5247 ;; Opening single and double quotes.
5249 ;; Closing single and double quotes.
5251 ;; Apostrophe.
5253 ;; Possible opening quote at end of string.
5255 ;; Possible closing quote at end of string.
5257 ;; Possible apostrophe at end of string.
5259 "List of regexps matching a quote or an apostrophe.
5265 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5266 `:utf-8'. INFO is a plist used as a communication channel.
5268 The function has to retrieve information about string
5269 surroundings in parse tree. It can only happen with an
5270 unmodified string. Thus, if S has already been through another
5271 process, a non-nil ORIGINAL optional argument will provide that
5272 original string.
5274 Return the new string."
5277 ;; Try to be flexible when computing number of blanks
5278 ;; before object. The previous object may be a string
5279 ;; introduced by the back-end and not completely parsed.
5282 ;; A string with missing `:post-blank'
5283 ;; property.
5287 ;; Fallback value.
5292 ;; Return smart quote associated to a give quote Q, as
5293 ;; a string. TYPE is a symbol among `open', `close' and
5294 ;; `apostrophe'.
5304 org-export-smart-quotes-alist))))
5305 encoding)
5306 q)))))
5308 ;; Only a quote: no regexp can match. We have to check both
5309 ;; sides and decide what to do.
5317 ;; 1. Replace quote character at the beginning of S.
5319 ;; Apostrophe?
5325 ;; Closing quote?
5331 ;; Opening quote?
5337 ;; 2. Replace quotes in the middle of the string.
5339 ;; Opening quotes.
5345 ;; Closing quotes.
5351 ;; Apostrophes.
5356 ;; 3. Replace quote character at the end of S.
5358 ;; Apostrophe?
5363 ;; Closing quote?
5369 ;; Opening quote?
5374 ;; Return string with smart quotes.
5375 s))))
5377 ;;;; Topology
5378 ;;
5379 ;; Here are various functions to retrieve information about the
5380 ;; neighborhood of a given element or object. Neighbors of interest
5381 ;; are direct parent (`org-export-get-parent'), parent headline
5382 ;; (`org-export-get-parent-headline'), first element containing an
5383 ;; object, (`org-export-get-parent-element'), parent table
5384 ;; (`org-export-get-parent-table'), previous element or object
5385 ;; (`org-export-get-previous-element') and next element or object
5386 ;; (`org-export-get-next-element').
5387 ;;
5388 ;; `org-export-get-genealogy' returns the full genealogy of a given
5389 ;; element or object, from closest parent to full parse tree.
5391 ;; defsubst org-export-get-parent must be defined before first use
5394 "Return full genealogy relative to a given element or object.
5396 BLOB is the element or object being considered.
5398 Ancestors are returned from closest to farthest, the last one
5399 being the full parse tree."
5406 "Return BLOB parent headline or nil.
5407 BLOB is the element or object being considered."
5411 parent))
5414 "Return first element containing OBJECT or nil.
5415 OBJECT is the object to consider."
5419 parent))
5422 "Return OBJECT parent table or nil.
5423 OBJECT is either a `table-cell' or `table-element' type object."
5427 parent))
5430 "Return previous element or object.
5432 BLOB is an element or object. INFO is a plist used as
5433 a communication channel. Return previous exportable element or
5434 object, a string, or nil.
5436 When optional argument N is a positive integer, return a list
5437 containing up to N siblings before BLOB, from farthest to
5438 closest. With any other non-nil value, return a list containing
5439 all of them."
5445 prev)
5455 "Return next element or object.
5457 BLOB is an element or object. INFO is a plist used as
5458 a communication channel. Return next exportable element or
5459 object, a string, or nil.
5461 When optional argument N is a positive integer, return a list
5462 containing up to N siblings after BLOB, from closest to farthest.
5463 With any other non-nil value, return a list containing all of
5464 them."
5471 next)
5481 ;;;; Translation
5482 ;;
5483 ;; `org-export-translate' translates a string according to the language
5484 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5485 ;; the dictionary used for the translation.
5532 ("ru" :html "(Продолжение следует)"
5630 ("ru" :html "Список распечаток"
5643 ("ru" :html "Список таблиц"
5726 ("ru" :html "Неизвестная ссылка"
5729 "Dictionary for export engine.
5731 Alist whose CAR is the string to translate and CDR is an alist
5732 whose CAR is the language string and CDR is a plist whose
5733 properties are possible charsets and values translated terms.
5735 It is used as a database for `org-export-translate'. Since this
5736 function returns the string as-is if no translation was found,
5737 the variable only needs to record values different from the
5741 "Translate string S according to language specification.
5743 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5744 and `:utf-8'. INFO is a plist used as a communication channel.
5746 Translation depends on `:language' property. Return the
5747 translated string. If no translation is found, try to fall back
5748 to `:default' encoding. If it fails, return S."
5754 s)))
5757 \f
5758 ;;; Asynchronous Export
5759 ;;
5760 ;; `org-export-async-start' is the entry point for asynchronous
5761 ;; export. It recreates current buffer (including visibility,
5762 ;; narrowing and visited file) in an external Emacs process, and
5763 ;; evaluates a command there. It then applies a function on the
5764 ;; returned results in the current process.
5765 ;;
5766 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5767 ;; allow to export to a buffer or a file, asynchronously or not.
5768 ;;
5769 ;; `org-export-output-file-name' is an auxiliary function meant to be
5770 ;; used with `org-export-to-file'. With a given extension, it tries
5771 ;; to provide a canonical file name to write export output to.
5772 ;;
5773 ;; Asynchronously generated results are never displayed directly.
5774 ;; Instead, they are stored in `org-export-stack-contents'. They can
5775 ;; then be retrieved by calling `org-export-stack'.
5776 ;;
5777 ;; Export Stack is viewed through a dedicated major mode
5778 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5779 ;;`org-export-stack-delete', `org-export-stack-view' and
5780 ;;`org-export-stack-clear'.
5781 ;;
5782 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5783 ;; It should be used whenever `org-export-async-start' is called.
5786 "Call function FUN on the results returned by BODY evaluation.
5788 BODY evaluation happens in an asynchronous process, from a buffer
5789 which is an exact copy of the current one.
5791 Use `org-export-add-to-stack' in FUN in order to register results
5792 in the stack.
5794 This is a low level function. See also `org-export-to-buffer'
5795 and `org-export-to-file' for more specialized functions."
5798 ;; Write the full sexp evaluating BODY in a copy of the current
5799 ;; buffer to a temporary file, as it may be too long for program
5800 ;; args in `start-process'.
5807 ;; Null characters (from variable values) are inserted
5808 ;; within the file. As a consequence, coding system for
5809 ;; buffer contents will not be recognized properly. So,
5810 ;; we make sure it is the same as the one used to display
5811 ;; the original buffer.
5813 ,coding
5816 ;; Ignore `kill-emacs-hook' and code evaluation
5817 ;; queries from Babel as we need a truly
5818 ;; non-interactive process.
5820 org-babel-confirm-evaluate-answer-no t)
5821 ;; Initialize export framework.
5823 ;; Re-create current buffer there.
5826 ;; Sexp to evaluate in the buffer.
5828 ;; Start external process.
5831 (,process
5833 #'start-process
5836 ,proc-buffer
5843 ;; Register running process in stack.
5845 ;; Set-up sentinel in order to catch results.
5848 ,process
5870 ;;;###autoload
5873 &optional async subtreep visible-only body-only ext-plist
5874 post-process)
5875 "Call `org-export-as' with output to a specified buffer.
5877 BACKEND is either an export back-end, as returned by, e.g.,
5878 `org-export-create-backend', or a symbol referring to
5879 a registered back-end.
5881 BUFFER is the name of the output buffer. If it already exists,
5882 it will be erased first, otherwise, it will be created.
5884 A non-nil optional argument ASYNC means the process should happen
5885 asynchronously. The resulting buffer should then be accessible
5886 through the `org-export-stack' interface. When ASYNC is nil, the
5887 buffer is displayed if `org-export-show-temporary-export-buffer'
5888 is non-nil.
5890 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5891 EXT-PLIST are similar to those used in `org-export-as', which
5892 see.
5894 Optional argument POST-PROCESS is a function which should accept
5895 no argument. It is always called within the current process,
5896 from BUFFER, with point at its beginning. Export back-ends can
5897 use it to set a major mode there, e.g,
5899 \(defun org-latex-export-as-latex
5900 \(&optional async subtreep visible-only body-only ext-plist)
5901 \(interactive)
5903 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5905 This function returns BUFFER."
5933 buffer)))
5935 ;;;###autoload
5938 post-process)
5939 "Call `org-export-as' with output to a specified file.
5941 BACKEND is either an export back-end, as returned by, e.g.,
5942 `org-export-create-backend', or a symbol referring to
5943 a registered back-end. FILE is the name of the output file, as
5944 a string.
5946 A non-nil optional argument ASYNC means the process should happen
5947 asynchronously. The resulting buffer will then be accessible
5948 through the `org-export-stack' interface.
5950 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5951 EXT-PLIST are similar to those used in `org-export-as', which
5952 see.
5954 Optional argument POST-PROCESS is called with FILE as its
5955 argument and happens asynchronously when ASYNC is non-nil. It
5956 has to return a file name, or nil. Export back-ends can use this
5957 to send the output file through additional processing, e.g,
5959 \(defun org-latex-export-to-latex
5960 \(&optional async subtreep visible-only body-only ext-plist)
5961 \(interactive)
5963 \(org-export-to-file 'latex outfile
5964 async subtreep visible-only body-only ext-plist
5965 \(lambda (file) (org-latex-compile file)))
5967 The function returns either a file name returned by POST-PROCESS,
5968 or FILE."
5987 backend subtreep visible-only body-only ext-plist)))
5994 ;; Get proper return value.
5996 file))))))
5999 "Return output file's name according to buffer specifications.
6001 EXTENSION is a string representing the output file extension,
6002 with the leading dot.
6004 With a non-nil optional argument SUBTREEP, try to determine
6006 of subtree at point.
6008 When optional argument PUB-DIR is set, use it as the publishing
6009 directory.
6011 When optional argument VISIBLE-ONLY is non-nil, don't export
6012 contents of hidden elements.
6014 Return file name as a string."
6017 ;; File name may come from EXPORT_FILE_NAME subtree
6018 ;; property, assuming point is at beginning of said
6019 ;; sub-tree.
6026 ;; File name may be extracted from buffer's associated
6027 ;; file, if any.
6029 ;; Can't determine file name on our own: Ask user.
6033 "Output file: " pub-dir nil nil nil
6037 ;; Build file name. Enforce EXTENSION over whatever user
6038 ;; may have come up with. PUB-DIR, if defined, always has
6039 ;; precedence over any provided path.
6044 extension))
6047 ;; If writing to OUTPUT-FILE would overwrite original file, append
6048 ;; EXTENSION another time to final name.
6051 output-file)))
6054 "Add a new result to export stack if not present already.
6056 SOURCE is a buffer or a file name containing export results.
6057 BACKEND is a symbol representing export back-end used to generate
6058 it.
6060 Entries already pointing to SOURCE and unavailable entries are
6061 removed beforehand. Return the new stack."
6067 "Menu for asynchronous export results and running processes."
6077 "Return source from export results at point in stack."
6084 source
6085 ;; SOURCE is not consistent with current line. The stack
6086 ;; view is outdated.
6090 "Remove all entries from export stack."
6095 "Refresh the asynchronous export stack.
6096 DUMMY is ignored. Unavailable sources are removed from the list.
6097 Return the new stack."
6107 ;; Back-end.
6109 ;; Age.
6112 ;; Compute age of the results.
6114 "%4h:%.2m "
6116 ;; Source.
6121 ;; Clear stack from exited processes, dead buffers or
6122 ;; non-existent files.
6134 "Remove export results at point from stack.
6135 If optional argument SOURCE is non-nil, remove it instead."
6140 org-export-stack-contents))))
6143 "View export results at point in stack.
6144 With an optional prefix argument IN-EMACS, force viewing files
6145 within Emacs."
6159 (define-key km "p" 'previous-line)
6160 (define-key km "\C-p" 'previous-line)
6161 (define-key km "\C-?" 'previous-line)
6162 (define-key km [up] 'previous-line)
6163 (define-key km "C" 'org-export-stack-clear)
6164 (define-key km "v" 'org-export-stack-view)
6165 (define-key km (kbd "RET") 'org-export-stack-view)
6166 (define-key km "d" 'org-export-stack-remove)
6167 km)
6168 "Keymap for Org Export Stack.")
6170 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6171 "Mode for displaying asynchronous export stack.
6174 stack.
6176 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6177 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6178 stack completely.
6180 Removing entries in an Org Export Stack buffer doesn't affect
6181 files or buffers, only the display.
6184 (abbrev-mode 0)
6185 (auto-fill-mode 0)
6186 (setq buffer-read-only t
6187 buffer-undo-list t
6188 truncate-lines t
6189 header-line-format
6190 '(:eval
6191 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6192 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6193 (set (make-local-variable 'revert-buffer-function)
6194 'org-export-stack-refresh))
6197 \f
6198 ;;; The Dispatcher
6199 ;;
6200 ;; `org-export-dispatch' is the standard interactive way to start an
6201 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6202 ;; for its interface, which, in turn, delegates response to key
6203 ;; pressed to `org-export--dispatch-action'.
6205 ;;;###autoload
6206 (defun org-export-dispatch (&optional arg)
6207 "Export dispatcher for Org mode.
6209 It provides an access to common export related tasks in a buffer.
6210 Its interface comes in two flavors: standard and expert.
6212 While both share the same set of bindings, only the former
6213 displays the valid keys associations in a dedicated buffer.
6214 Scrolling (resp. line-wise motion) in this buffer is done with
6215 SPC and DEL (resp. C-n and C-p) keys.
6217 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6218 flavor or the other.
6221 of options used back then, on the current buffer.
6223 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6224 (interactive "P")
6225 (let* ((input
6226 (cond ((equal arg '(16)) '(stack))
6227 ((and arg org-export-dispatch-last-action))
6228 (t (save-window-excursion
6229 (unwind-protect
6230 (progn
6231 ;; Remember where we are
6232 (move-marker org-export-dispatch-last-position
6233 (point)
6234 (org-base-buffer (current-buffer)))
6235 ;; Get and store an export command
6236 (setq org-export-dispatch-last-action
6237 (org-export--dispatch-ui
6238 (list org-export-initial-scope
6239 (and org-export-in-background 'async))
6240 nil
6241 org-export-dispatch-use-expert-ui)))
6242 (and (get-buffer "*Org Export Dispatcher*")
6243 (kill-buffer "*Org Export Dispatcher*")))))))
6244 (action (car input))
6245 (optns (cdr input)))
6246 (unless (memq 'subtree optns)
6247 (move-marker org-export-dispatch-last-position nil))
6248 (case action
6249 ;; First handle special hard-coded actions.
6250 (template (org-export-insert-default-template nil optns))
6251 (stack (org-export-stack))
6252 (publish-current-file
6253 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6254 (publish-current-project
6255 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6256 (publish-choose-project
6257 (org-publish (assoc (org-icompleting-read
6258 "Publish project: "
6259 org-publish-project-alist nil t)
6260 org-publish-project-alist)
6261 (memq 'force optns)
6262 (memq 'async optns)))
6263 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6264 (otherwise
6265 (save-excursion
6266 (when arg
6267 ;; Repeating command, maybe move cursor to restore subtree
6268 ;; context.
6269 (if (eq (marker-buffer org-export-dispatch-last-position)
6270 (org-base-buffer (current-buffer)))
6271 (goto-char org-export-dispatch-last-position)
6272 ;; We are in a different buffer, forget position.
6273 (move-marker org-export-dispatch-last-position nil)))
6274 (funcall action
6275 ;; Return a symbol instead of a list to ease
6276 ;; asynchronous export macro use.
6277 (and (memq 'async optns) t)
6278 (and (memq 'subtree optns) t)
6279 (and (memq 'visible optns) t)
6280 (and (memq 'body optns) t)))))))
6282 (defun org-export--dispatch-ui (options first-key expertp)
6283 "Handle interface for `org-export-dispatch'.
6285 OPTIONS is a list containing current interactive options set for
6286 export. It can contain any of the following symbols:
6287 `body' toggles a body-only export
6288 `subtree' restricts export to current subtree
6289 `visible' restricts export to visible part of buffer.
6290 `force' force publishing files.
6291 `async' use asynchronous export process
6293 FIRST-KEY is the key pressed to select the first level menu. It
6294 is nil when this menu hasn't been selected yet.
6296 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6297 buffer is provided, but indications about currently active
6298 options are given in the prompt. Moreover, \[?] allows to switch
6299 back to standard interface."
6300 (let* ((fontify-key
6301 (lambda (key &optional access-key)
6302 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6303 ;; non-nil is the required first-level key to activate
6304 ;; KEY. When its value is t, activate KEY independently
6305 ;; on the first key, if any. A nil value means KEY will
6306 ;; only be activated at first level.
6307 (if (or (eq access-key t) (eq access-key first-key))
6308 (org-propertize key 'face 'org-warning)
6309 key)))
6310 (fontify-value
6311 (lambda (value)
6312 ;; Fontify VALUE string.
6313 (org-propertize value 'face 'font-lock-variable-name-face)))
6314 ;; Prepare menu entries by extracting them from registered
6315 ;; back-ends and sorting them by access key and by ordinal,
6316 ;; if any.
6317 (entries
6318 (sort (sort (delq nil
6319 (mapcar 'org-export-backend-menu
6320 org-export--registered-backends))
6321 (lambda (a b)
6322 (let ((key-a (nth 1 a))
6323 (key-b (nth 1 b)))
6324 (cond ((and (numberp key-a) (numberp key-b))
6325 (< key-a key-b))
6326 ((numberp key-b) t)))))
6327 'car-less-than-car))
6328 ;; Compute a list of allowed keys based on the first key
6329 ;; pressed, if any. Some keys
6330 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6331 ;; available.
6332 (allowed-keys
6333 (nconc (list 2 22 19 6 1)
6334 (if (not first-key) (org-uniquify (mapcar 'car entries))
6335 (let (sub-menu)
6336 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6337 (when (eq (car entry) first-key)
6338 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6339 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6340 ((not first-key) (list ?P)))
6341 (list ?& ?#)
6342 (when expertp (list ??))
6343 (list ?q)))
6344 ;; Build the help menu for standard UI.
6345 (help
6346 (unless expertp
6347 (concat
6348 ;; Options are hard-coded.
6349 (format "[%s] Body only: %s [%s] Visible only: %s
6350 \[%s] Export scope: %s [%s] Force publishing: %s
6352 (funcall fontify-key "C-b" t)
6353 (funcall fontify-value
6354 (if (memq 'body options) "On " "Off"))
6355 (funcall fontify-key "C-v" t)
6356 (funcall fontify-value
6357 (if (memq 'visible options) "On " "Off"))
6358 (funcall fontify-key "C-s" t)
6359 (funcall fontify-value
6360 (if (memq 'subtree options) "Subtree" "Buffer "))
6361 (funcall fontify-key "C-f" t)
6362 (funcall fontify-value
6363 (if (memq 'force options) "On " "Off"))
6364 (funcall fontify-key "C-a" t)
6365 (funcall fontify-value
6366 (if (memq 'async options) "On " "Off")))
6367 ;; Display registered back-end entries. When a key
6368 ;; appears for the second time, do not create another
6369 ;; entry, but append its sub-menu to existing menu.
6370 (let (last-key)
6371 (mapconcat
6372 (lambda (entry)
6373 (let ((top-key (car entry)))
6374 (concat
6375 (unless (eq top-key last-key)
6376 (setq last-key top-key)
6378 (funcall fontify-key (char-to-string top-key))
6379 (nth 1 entry)))
6380 (let ((sub-menu (nth 2 entry)))
6381 (unless (functionp sub-menu)
6382 ;; Split sub-menu into two columns.
6383 (let ((index -1))
6384 (concat
6385 (mapconcat
6386 (lambda (sub-entry)
6387 (incf index)
6388 (format
6389 (if (zerop (mod index 2)) " [%s] %-26s"
6391 (funcall fontify-key
6392 (char-to-string (car sub-entry))
6393 top-key)
6394 (nth 1 sub-entry)))
6395 sub-menu "")
6397 entries ""))
6398 ;; Publishing menu is hard-coded.
6400 [%s] Current file [%s] Current project
6402 (funcall fontify-key "P")
6403 (funcall fontify-key "f" ?P)
6404 (funcall fontify-key "p" ?P)
6405 (funcall fontify-key "x" ?P)
6406 (funcall fontify-key "a" ?P))
6408 (funcall fontify-key "&" t)
6409 (funcall fontify-key "#" t))
6410 (format "[%s] %s"
6411 (funcall fontify-key "q" t)
6412 (if first-key "Main menu" "Exit")))))
6413 ;; Build prompts for both standard and expert UI.
6414 (standard-prompt (unless expertp "Export command: "))
6415 (expert-prompt
6416 (when expertp
6417 (format
6418 "Export command (C-%s%s%s%s%s) [%s]: "
6419 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6420 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6421 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6422 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6423 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6424 (mapconcat (lambda (k)
6425 ;; Strip control characters.
6426 (unless (< k 27) (char-to-string k)))
6427 allowed-keys "")))))
6428 ;; With expert UI, just read key with a fancy prompt. In standard
6429 ;; UI, display an intrusive help buffer.
6430 (if expertp
6431 (org-export--dispatch-action
6432 expert-prompt allowed-keys entries options first-key expertp)
6433 ;; At first call, create frame layout in order to display menu.
6434 (unless (get-buffer "*Org Export Dispatcher*")
6435 (delete-other-windows)
6436 (org-switch-to-buffer-other-window
6437 (get-buffer-create "*Org Export Dispatcher*"))
6438 (setq cursor-type nil
6439 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6440 ;; Make sure that invisible cursor will not highlight square
6441 ;; brackets.
6442 (set-syntax-table (copy-syntax-table))
6443 (modify-syntax-entry ?\[ "w"))
6444 ;; At this point, the buffer containing the menu exists and is
6445 ;; visible in the current window. So, refresh it.
6446 (with-current-buffer "*Org Export Dispatcher*"
6447 ;; Refresh help. Maintain display continuity by re-visiting
6448 ;; previous window position.
6449 (let ((pos (window-start)))
6450 (erase-buffer)
6451 (insert help)
6452 (set-window-start nil pos)))
6453 (org-fit-window-to-buffer)
6454 (org-export--dispatch-action
6455 standard-prompt allowed-keys entries options first-key expertp))))
6457 (defun org-export--dispatch-action
6458 (prompt allowed-keys entries options first-key expertp)
6459 "Read a character from command input and act accordingly.
6461 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6462 a list of characters available at a given step in the process.
6463 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6464 EXPERTP are the same as defined in `org-export--dispatch-ui',
6465 which see.
6467 Toggle export options when required. Otherwise, return value is
6468 a list with action as CAR and a list of interactive export
6469 options as CDR."
6470 (let (key)
6471 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6472 ;; C-p, SPC, DEL).
6473 (while (and (setq key (read-char-exclusive prompt))
6474 (not expertp)
6475 (memq key '(14 16 ?\s ?\d)))
6476 (case key
6477 (14 (if (not (pos-visible-in-window-p (point-max)))
6478 (ignore-errors (scroll-up 1))
6479 (message "End of buffer")
6480 (sit-for 1)))
6481 (16 (if (not (pos-visible-in-window-p (point-min)))
6482 (ignore-errors (scroll-down 1))
6483 (message "Beginning of buffer")
6484 (sit-for 1)))
6485 (?\s (if (not (pos-visible-in-window-p (point-max)))
6486 (scroll-up nil)
6487 (message "End of buffer")
6488 (sit-for 1)))
6489 (?\d (if (not (pos-visible-in-window-p (point-min)))
6490 (scroll-down nil)
6491 (message "Beginning of buffer")
6492 (sit-for 1)))))
6493 (cond
6494 ;; Ignore undefined associations.
6495 ((not (memq key allowed-keys))
6496 (ding)
6497 (unless expertp (message "Invalid key") (sit-for 1))
6498 (org-export--dispatch-ui options first-key expertp))
6499 ;; q key at first level aborts export. At second level, cancel
6500 ;; first key instead.
6501 ((eq key ?q) (if (not first-key) (error "Export aborted")
6502 (org-export--dispatch-ui options nil expertp)))
6503 ;; Help key: Switch back to standard interface if expert UI was
6504 ;; active.
6505 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6506 ;; Send request for template insertion along with export scope.
6507 ((eq key ?#) (cons 'template (memq 'subtree options)))
6508 ;; Switch to asynchronous export stack.
6509 ((eq key ?&) '(stack))
6510 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6511 ((memq key '(2 22 19 6 1))
6512 (org-export--dispatch-ui
6513 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6514 (6 'force) (1 'async))))
6515 (if (memq option options) (remq option options)
6516 (cons option options)))
6517 first-key expertp))
6518 ;; Action selected: Send key and options back to
6519 ;; `org-export-dispatch'.
6520 ((or first-key (functionp (nth 2 (assq key entries))))
6521 (cons (cond
6522 ((not first-key) (nth 2 (assq key entries)))
6523 ;; Publishing actions are hard-coded. Send a special
6524 ;; signal to `org-export-dispatch'.
6525 ((eq first-key ?P)
6526 (case key
6527 (?f 'publish-current-file)
6528 (?p 'publish-current-project)
6529 (?x 'publish-choose-project)
6530 (?a 'publish-all)))
6531 ;; Return first action associated to FIRST-KEY + KEY
6532 ;; path. Indeed, derived backends can share the same
6533 ;; FIRST-KEY.
6534 (t (catch 'found
6535 (mapc (lambda (entry)
6536 (let ((match (assq key (nth 2 entry))))
6537 (when match (throw 'found (nth 2 match)))))
6538 (member (assq first-key entries) entries)))))
6539 options))
6540 ;; Otherwise, enter sub-menu.
6541 (t (org-export--dispatch-ui options key expertp)))))
6545 (provide 'ox)
6547 ;; Local variables:
6548 ;; generated-autoload-file: "org-loaddefs.el"
6549 ;; End:
6551 ;;; ox.el ends here