| blob | cf569b5a5d70506c7ec43bc67decc26514ea3be3 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012, 2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; GNU Emacs is free software: you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
22 ;;
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
25 ;;
26 ;; Besides that parser, the generic exporter is made of three distinct
27 ;; parts:
28 ;;
29 ;; - The communication channel consists in a property list, which is
30 ;; created and updated during the process. Its use is to offer
31 ;; every piece of information, would it be about initial environment
32 ;; or contextual data, all in a single place. The exhaustive list
33 ;; of properties is given in "The Communication Channel" section of
34 ;; this file.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core function is `org-export-as'. It returns the transcoded
48 ;; buffer as a string.
49 ;;
50 ;; An export back-end is defined with `org-export-define-backend',
51 ;; which defines one mandatory information: his translation table.
52 ;; Its value is an alist whose keys are elements and objects types and
53 ;; values translator functions. See function's docstring for more
54 ;; information about translators.
55 ;;
56 ;; Optionally, `org-export-define-backend' can also support specific
57 ;; buffer keywords, OPTION keyword's items and filters. Also refer to
58 ;; function documentation for more information.
59 ;;
60 ;; If the new back-end shares most properties with another one,
61 ;; `org-export-define-derived-backend' can be used to simplify the
62 ;; process.
63 ;;
64 ;; Any back-end can define its own variables. Among them, those
65 ;; customizable should belong to the `org-export-BACKEND' group.
66 ;;
67 ;; Tools for common tasks across back-ends are implemented in the
68 ;; following part of the file.
69 ;;
70 ;; Then, a wrapper macro for asynchronous export,
71 ;; `org-export-async-start', along with tools to display results. are
72 ;; given in the penultimate part.
73 ;;
74 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
75 ;; back-ends is provided in the last one.
77 ;;; Code:
96 \f
97 ;;; Internal Variables
98 ;;
99 ;; Among internal variables, the most important is
100 ;; `org-export-options-alist'. This variable define the global export
101 ;; options, shared between every exporter, and how they are acquired.
146 "Alist between export properties and ways to set them.
148 The CAR of the alist is the property name, and the CDR is a list
149 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
151 KEYWORD is a string representing a buffer keyword, or nil. Each
152 property defined this way can also be set, during subtree
153 export, through a headline property named after the keyword
155 property).
156 OPTION is a string that could be found in an #+OPTIONS: line.
157 DEFAULT is the default value for the property.
158 BEHAVIOUR determines how Org should handle multiple keywords for
159 the same property. It is a symbol among:
160 nil Keep old value and discard the new one.
161 t Replace old value with the new one.
162 `space' Concatenate the values, separating them with a space.
163 `newline' Concatenate the values, separating them with
164 a newline.
165 `split' Split values at white spaces, and cons them to the
166 previous list.
168 Values set through KEYWORD and OPTION have precedence over
169 DEFAULT.
171 All these properties should be back-end agnostic. Back-end
172 specific properties are set through `org-export-define-backend'.
176 "List of in-buffer keywords that require special treatment.
177 These keywords are not directly associated to a property. The
178 way they are handled must be hard-coded into
239 "Alist between filters properties and initial values.
241 The key of each association is a property name accessible through
242 the communication channel. Its value is a configurable global
243 variable defining initial filters.
245 This list is meant to install user specified filters. Back-end
246 developers may install their own filters using
247 `org-export-define-backend'. Filters defined there will always
248 be prepended to the current list, so they always get applied
257 "Default rule for link matching an inline image.
258 This rule applies to links with no description. By default, it
259 will be considered as an inline image if it targets a local file
262 See `org-export-inline-image-p' for more information about
266 "Non-nil means asynchronous export process should leave data behind.
270 located in `temporary-file-directory'.
272 When non-nil, it will also set `debug-on-error' to a non-nil
276 "Record asynchronously generated export results and processes.
277 This is an alist: its CAR is the source of the
278 result (destination file or buffer for a finished process,
279 original buffer for a running one) and its CDR is a list
280 containing the back-end used, as a symbol, and either a process
281 or the time at which it finished. It is used to build the menu
285 "List of backends currently available in the exporter.
287 A backend is stored as a list where CAR is its name, as a symbol,
288 and CDR is a plist with the following properties:
289 `:filters-alist', `:menu-entry', `:options-alist' and
290 `:translate-alist'.
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 \f
306 ;;; User-configurable Variables
307 ;;
308 ;; Configuration for the masses.
309 ;;
310 ;; They should never be accessed directly, as their value is to be
311 ;; stored in a property list (cf. `org-export-options-alist').
312 ;; Back-ends will read their value from there instead.
315 "Options for exporting Org mode files."
320 "General options for export engine."
325 "Whether sub-trees with the ARCHIVE tag should be exported.
327 This can have three different values:
328 nil Do not export, pretend this tree is not present.
329 t Do export the entire tree.
330 `headline' Only export the headline, but skip the tree below it.
332 This option can also be set with the #+OPTIONS line,
341 "Non-nil means insert author name into the exported file.
342 This option can also be set with the #+OPTIONS line,
348 "Non-nil means export CLOCK keywords.
349 This option can also be set with the #+OPTIONS line,
355 "Non-nil means the postamble should contain a creator sentence.
357 The sentence can be set in `org-export-creator-string' and
360 If the value is `comment' insert it as a comment."
368 "Non-nil means insert date in the exported document.
369 This options can also be set with the OPTIONS keyword,
373 "Time-stamp format string to use for DATE keyword.
375 The format string, when specified, only applies if date consists
376 in a single time-stamp. Otherwise its value will be ignored.
378 See `format-time-string' for details on how to build this
379 string."
388 emacs-version)
389 "String to insert at the end of the generated document."
394 "Non-nil means export contents of standard drawers.
396 When t, all drawers are exported. This may also be a list of
397 drawer names to export. If that list starts with `not', only
398 drawers with such names will be ignored.
400 This variable doesn't apply to properties drawers.
402 This option can also be set with the #+OPTIONS line,
415 :inline t
419 "Non-nil means insert author email into the exported file.
420 This option can also be set with the #+OPTIONS line,
426 "Non-nil means interpret *word*, /word/, _word_ and +word+.
428 If the export target supports emphasizing text, the word will be
429 typeset in bold, italic, with an underline or strike-through,
430 respectively.
437 "Tags that exclude a tree from export.
439 All trees carrying any of these tags will be excluded from
440 export. This is without condition, so even subtrees inside that
441 carry one of the `org-export-select-tags' will be removed.
443 This option can also be set with the #+EXCLUDE_TAGS: keyword."
450 This can be used to have pre-formatted text, fragments of code
451 etc. For example:
452 : ;; Some Lisp examples
453 : (while (defc cnt)
454 : (ding))
455 will be looking just like this in also HTML. See also the QUOTE
456 keyword. Not all export backends support this.
463 "Non-nil means Org footnotes should be exported.
464 This option can also be set with the #+OPTIONS line,
470 "Non-nil means process LaTeX environments and fragments.
472 This option can also be set with the +OPTIONS line,
475 nil Ignore math snippets.
476 `verbatim' Keep everything in verbatim.
477 t Allow export of math snippets."
487 "The last level which is still exported as a headline.
489 Inferior levels will produce itemize or enumerate lists when
490 exported.
497 "The default language for export and clocktable translations, as a string.
498 This may have an association in
499 `org-clock-clocktable-language-setup'."
504 "Non-nil means preserve all line breaks when exporting.
505 This option can also be set with the #+OPTIONS line,
511 "Non-nil means interpret entities when exporting.
514 Å.
516 For a list of supported names, see the constant `org-entities'
517 and the user option `org-entities-user'.
519 This option can also be set with the #+OPTIONS line,
525 "Non-nil means inlinetasks should be exported.
526 This option can also be set with the #+OPTIONS line,
534 "Non-nil means include planning info in export.
535 This option can also be set with the #+OPTIONS: line,
543 "Non-nil means include priority cookies in export.
544 This option can also be set with the #+OPTIONS line,
550 "Non-nil means add section numbers to headlines when exporting.
552 When set to an integer n, numbering will only happen for
553 headlines whose relative level is higher or equal to n.
555 This option can also be set with the #+OPTIONS line,
561 "Tags that select a tree for export.
563 If any such tag is found in a buffer, all trees that do not carry
564 one of these tags will be ignored during export. Inside trees
565 that are selected like this, you can still deselect a subtree by
566 tagging it with one of the `org-export-exclude-tags'.
568 This option can also be set with the #+SELECT_TAGS: keyword."
573 "Non-nil means activate smart quotes during export.
574 This option can also be set with the #+OPTIONS: line,
584 When this option is turned on, these strings will be exported as:
586 Org HTML LaTeX UTF-8
587 -----+----------+--------+-------
589 -- – -- –
590 --- — --- —
593 This option can also be set with the #+OPTIONS line,
599 "Non-nil means include statistics cookies in export.
600 This option can also be set with the #+OPTIONS: line,
610 When this option is turned on, you can use TeX-like syntax for
612 will be considered as a single item - so grouping with {} is
613 normally not needed. For example, the following things will be
614 parsed as single sub- or superscripts.
616 10^24 or 10^tau several digits will be considered 1 item.
617 10^-12 or 10^-tau a leading sign with digits or a word
618 x^2-y^3 will be read as x^2 - y^3, because items are
619 terminated by almost any nonword/nondigit char.
620 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
622 Still, ambiguity is possible - so when in doubt use {} to enclose
623 the sub/superscript. If you set this variable to the symbol
624 `{}', the braces are *required* in order to trigger
625 interpretations as sub/superscript. This can be helpful in
628 This option can also be set with the #+OPTIONS line,
637 "Non-nil means create a table of contents in exported files.
639 The TOC contains headlines with levels up
640 to`org-export-headline-levels'. When an integer, include levels
641 up to N in the toc, this may then be different from
642 `org-export-headline-levels', but it will not be allowed to be
643 larger than the number of headline levels. When nil, no table of
644 contents is made.
646 This option can also be set with the #+OPTIONS line,
656 For example:
658 | Name | Address | Birthday |
659 |-------------+----------+-----------|
660 | Arthur Dent | England | 29.2.2100 |
667 "If nil, do not export tags, just remove them from headlines.
669 If this is the symbol `not-in-toc', tags will be removed from
670 table of contents entries, but still be shown in the headlines of
671 the document.
673 This option can also be set with the #+OPTIONS line,
682 "Non-nil means include TODO items for export.
684 This may have the following values:
685 t include tasks independent of state.
686 `todo' include only tasks that are not yet done.
687 `done' include only tasks that are already done.
688 nil ignore all tasks.
689 list of keywords include tasks with these keywords.
691 This option can also be set with the #+OPTIONS line,
703 "Non-nil means insert a time stamp into the exported file.
704 The time stamp shows when the file was created.
706 This option can also be set with the #+OPTIONS line,
712 "Non nil means allow timestamps in export.
714 It can be set to `active', `inactive', t or nil, in order to
715 export, respectively, only active timestamps, only inactive ones,
716 all of them or none.
718 This option can also be set with the #+OPTIONS line, e.g.
728 "Non-nil means include TODO keywords in export.
729 When nil, remove all these keywords from the export."
734 "Non-nil means BIND keywords can define local variable values.
735 This is a potential security risk, which is why the default value
736 is nil. You can also allow them through local buffer variables."
743 "Alist between export snippets back-ends and exporter back-ends.
745 This variable allows to provide shortcuts for export snippets.
749 HTML code while every other back-end will ignore it."
758 "Coding system for the exported file."
765 "Should we push exported content to the kill ring?"
774 "The initial scope when exporting with `org-export-dispatch'.
775 This variable can be either set to `buffer' or `subtree'."
782 "Non-nil means show buffer after exporting to temp buffer.
783 When Org exports to a file, the buffer visiting that file is ever
784 shown, but remains buried. However, when exporting to
785 a temporary buffer, that buffer is popped up in a second window.
786 When this variable is nil, the buffer remains buried also in
787 these cases."
792 "Non-nil means export and publishing commands will run in background.
793 Results from an asynchronous export are never displayed
801 "File used to initialize external export process.
802 Value must be an absolute file name. It defaults to user's
803 initialization file. Though, a specific configuration makes the
804 process faster and the export more portable."
811 "List of back-ends that shouldn't appear in the dispatcher.
813 Any back-end belonging to this list or derived from a back-end
814 belonging to it will not appear in the dispatcher menu.
816 Indeed, Org may require some export back-ends without notice. If
817 these modules are never to be used interactively, adding them
818 here will avoid cluttering the dispatcher menu."
825 "Non-nil means using a non-intrusive `org-export-dispatch'.
826 In that case, no help buffer is displayed. Though, an indicator
832 asynchronous). Also, \[?] allows to switch back to standard
833 mode."
840 \f
841 ;;; Defining Back-ends
842 ;;
843 ;; `org-export-define-backend' is the standard way to define an export
844 ;; back-end. It allows to specify translators, filters, buffer
845 ;; options and a menu entry. If the new back-end shares translators
846 ;; with another back-end, `org-export-define-derived-backend' may be
847 ;; used instead.
848 ;;
849 ;; Internally, a back-end is stored as a list, of which CAR is the
850 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
851 ;; properties of a given back-end are: `org-export-backend-filters',
852 ;; `org-export-backend-menu', `org-export-backend-options' and
853 ;; `org-export-backend-translate-table'.
854 ;;
855 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
856 ;; when a given back-end hasn't been registered yet.
859 "Define a new back-end BACKEND.
861 TRANSLATORS is an alist between object or element types and
862 functions handling them.
864 These functions should return a string without any trailing
865 space, or nil. They must accept three arguments: the object or
866 element itself, its contents or nil when it isn't recursive and
867 the property list used as a communication channel.
869 Contents, when not nil, are stripped from any global indentation
870 \(although the relative one is preserved). They also always end
871 with a single newline character.
873 If, for a given type, no function is found, that element or
874 object type will simply be ignored, along with any blank line or
875 white space at its end. The same will happen if the function
876 returns the nil value. If that function returns the empty
877 string, the type will be ignored, but the blank lines or white
878 spaces will be kept.
880 In addition to element and object types, one function can be
881 associated to the `template' (or `inner-template') symbol and
882 another one to the `plain-text' symbol.
884 The former returns the final transcoded string, and can be used
885 to add a preamble and a postamble to document's body. It must
886 accept two arguments: the transcoded string and the property list
887 containing export options. A function associated to `template'
889 A function associated to `inner-template' is always applied.
891 The latter, when defined, is to be called on every text not
892 recognized as an element or an object. It must accept two
893 arguments: the text string and the information channel. It is an
894 appropriate place to protect special chars relative to the
895 back-end.
897 BODY can start with pre-defined keyword arguments. The following
898 keywords are understood:
900 :export-block
902 String, or list of strings, representing block names that
903 will not be parsed. This is used to specify blocks that will
904 contain raw code specific to the back-end. These blocks
905 still have to be handled by the relative `export-block' type
906 translator.
908 :filters-alist
910 Alist between filters and function, or list of functions,
911 specific to the back-end. See `org-export-filters-alist' for
912 a list of all allowed filters. Filters defined here
913 shouldn't make a back-end test, as it may prevent back-ends
914 derived from this one to behave properly.
916 :menu-entry
918 Menu entry for the export dispatcher. It should be a list
919 like:
921 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
923 where :
925 KEY is a free character selecting the back-end.
927 DESCRIPTION-OR-ORDINAL is either a string or a number.
929 If it is a string, is will be used to name the back-end in
930 its menu entry. If it is a number, the following menu will
931 be displayed as a sub-menu of the back-end with the same
932 KEY. Also, the number will be used to determine in which
933 order such sub-menus will appear (lowest first).
935 ACTION-OR-MENU is either a function or an alist.
937 If it is an action, it will be called with four
938 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
939 BODY-ONLY. See `org-export-as' for further explanations on
940 some of them.
942 If it is an alist, associations should follow the
943 pattern:
945 '(KEY DESCRIPTION ACTION)
947 where KEY, DESCRIPTION and ACTION are described above.
949 Valid values include:
953 or
958 \(lambda (a s v b)
959 \(if a (org-latex-export-to-pdf t s v b)
960 \(org-open-file
961 \(org-latex-export-to-pdf nil s v b)))))))
963 or the following, which will be added to the previous
964 sub-menu,
966 '(?l 1
970 :options-alist
972 Alist between back-end specific properties introduced in
973 communication channel and how their value are acquired. See
974 `org-export-options-alist' for more information about
975 structure of the values."
992 ;; Register back-end.
996 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1002 export-block))))
1005 "Create a new back-end as a variant of an existing one.
1007 CHILD is the name of the derived back-end. PARENT is the name of
1008 the parent back-end.
1010 BODY can start with pre-defined keyword arguments. The following
1011 keywords are understood:
1013 :export-block
1015 String, or list of strings, representing block names that
1016 will not be parsed. This is used to specify blocks that will
1017 contain raw code specific to the back-end. These blocks
1018 still have to be handled by the relative `export-block' type
1019 translator.
1021 :filters-alist
1023 Alist of filters that will overwrite or complete filters
1024 defined in PARENT back-end. See `org-export-filters-alist'
1025 for a list of allowed filters.
1027 :menu-entry
1029 Menu entry for the export dispatcher. See
1030 `org-export-define-backend' for more information about the
1031 expected value.
1033 :options-alist
1035 Alist of back-end specific properties that will overwrite or
1036 complete those defined in PARENT back-end. Refer to
1037 `org-export-options-alist' for more information about
1038 structure of the values.
1040 :translate-alist
1042 Alist of element and object types and transcoders that will
1043 overwrite or complete transcode table from PARENT back-end.
1044 Refer to `org-export-define-backend' for detailed information
1045 about transcoders.
1048 as a variant of `latex' back-end with a custom template function:
1050 \(org-export-define-derived-backend 'my-latex 'latex
1051 :translate-alist '((template . my-latex-template-fun)))
1053 The back-end could then be called with, for example:
1079 ;; Register back-end.
1083 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1089 export-block))))
1092 "Return back-end from which BACKEND is derived, or nil."
1096 "Return filters for BACKEND."
1101 "Return menu entry for BACKEND."
1106 "Return export options for BACKEND."
1111 "Return translate table for BACKEND."
1116 "Signal an error if BACKEND isn't defined."
1121 "Non-nil if BACKEND is derived from one of BACKENDS."
1125 parent))
1128 \f
1129 ;;; The Communication Channel
1130 ;;
1131 ;; During export process, every function has access to a number of
1132 ;; properties. They are of two types:
1133 ;;
1134 ;; 1. Environment options are collected once at the very beginning of
1135 ;; the process, out of the original buffer and configuration.
1136 ;; Collecting them is handled by `org-export-get-environment'
1137 ;; function.
1138 ;;
1139 ;; Most environment options are defined through the
1140 ;; `org-export-options-alist' variable.
1141 ;;
1142 ;; 2. Tree properties are extracted directly from the parsed tree,
1143 ;; just before export, by `org-export-collect-tree-properties'.
1144 ;;
1145 ;; Here is the full list of properties available during transcode
1146 ;; process, with their category and their value type.
1147 ;;
1148 ;; + `:author' :: Author's name.
1149 ;; - category :: option
1150 ;; - type :: string
1151 ;;
1152 ;; + `:back-end' :: Current back-end used for transcoding.
1153 ;; - category :: tree
1154 ;; - type :: symbol
1155 ;;
1156 ;; + `:creator' :: String to write as creation information.
1157 ;; - category :: option
1158 ;; - type :: string
1159 ;;
1160 ;; + `:date' :: String to use as date.
1161 ;; - category :: option
1162 ;; - type :: string
1163 ;;
1164 ;; + `:description' :: Description text for the current data.
1165 ;; - category :: option
1166 ;; - type :: string
1167 ;;
1168 ;; + `:email' :: Author's email.
1169 ;; - category :: option
1170 ;; - type :: string
1171 ;;
1172 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1173 ;; process.
1174 ;; - category :: option
1175 ;; - type :: list of strings
1176 ;;
1177 ;; + `:export-options' :: List of export options available for current
1178 ;; process.
1179 ;; - category :: none
1180 ;; - type :: list of symbols, among `subtree', `body-only' and
1181 ;; `visible-only'.
1182 ;;
1183 ;; + `:exported-data' :: Hash table used for memoizing
1184 ;; `org-export-data'.
1185 ;; - category :: tree
1186 ;; - type :: hash table
1187 ;;
1188 ;; + `:filetags' :: List of global tags for buffer. Used by
1189 ;; `org-export-get-tags' to get tags with inheritance.
1190 ;; - category :: option
1191 ;; - type :: list of strings
1192 ;;
1193 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1194 ;; their definition, as parsed data. Only non-inlined footnotes
1195 ;; are represented in this alist. Also, every definition isn't
1196 ;; guaranteed to be referenced in the parse tree. The purpose of
1197 ;; this property is to preserve definitions from oblivion
1198 ;; (i.e. when the parse tree comes from a part of the original
1199 ;; buffer), it isn't meant for direct use in a back-end. To
1200 ;; retrieve a definition relative to a reference, use
1201 ;; `org-export-get-footnote-definition' instead.
1202 ;; - category :: option
1203 ;; - type :: alist (STRING . LIST)
1204 ;;
1205 ;; + `:headline-levels' :: Maximum level being exported as an
1206 ;; headline. Comparison is done with the relative level of
1207 ;; headlines in the parse tree, not necessarily with their
1208 ;; actual level.
1209 ;; - category :: option
1210 ;; - type :: integer
1211 ;;
1212 ;; + `:headline-offset' :: Difference between relative and real level
1213 ;; of headlines in the parse tree. For example, a value of -1
1214 ;; means a level 2 headline should be considered as level
1215 ;; 1 (cf. `org-export-get-relative-level').
1216 ;; - category :: tree
1217 ;; - type :: integer
1218 ;;
1219 ;; + `:headline-numbering' :: Alist between headlines and their
1220 ;; numbering, as a list of numbers
1221 ;; (cf. `org-export-get-headline-number').
1222 ;; - category :: tree
1223 ;; - type :: alist (INTEGER . LIST)
1224 ;;
1225 ;; + `:id-alist' :: Alist between ID strings and destination file's
1226 ;; path, relative to current directory. It is used by
1227 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1228 ;; external file.
1229 ;; - category :: option
1230 ;; - type :: alist (STRING . STRING)
1231 ;;
1232 ;; + `:ignore-list' :: List of elements and objects that should be
1233 ;; ignored during export.
1234 ;; - category :: tree
1235 ;; - type :: list of elements and objects
1236 ;;
1237 ;; + `:input-file' :: Full path to input file, if any.
1238 ;; - category :: option
1239 ;; - type :: string or nil
1240 ;;
1241 ;; + `:keywords' :: List of keywords attached to data.
1242 ;; - category :: option
1243 ;; - type :: string
1244 ;;
1245 ;; + `:language' :: Default language used for translations.
1246 ;; - category :: option
1247 ;; - type :: string
1248 ;;
1249 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1250 ;; transcoding.
1251 ;; - category :: option
1252 ;; - type :: list (as returned by `org-element-parse-buffer')
1253 ;;
1254 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1255 ;; all line breaks.
1256 ;; - category :: option
1257 ;; - type :: symbol (nil, t)
1258 ;;
1259 ;; + `:section-numbers' :: Non-nil means transcoding should add
1260 ;; section numbers to headlines.
1261 ;; - category :: option
1262 ;; - type :: symbol (nil, t)
1263 ;;
1264 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1265 ;; in transcoding. When such a tag is present, subtrees without
1266 ;; it are de facto excluded from the process. See
1267 ;; `use-select-tags'.
1268 ;; - category :: option
1269 ;; - type :: list of strings
1270 ;;
1271 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1272 ;; a time stamp in the output.
1273 ;; - category :: option
1274 ;; - type :: symbol (nil, t)
1275 ;;
1276 ;; + `:translate-alist' :: Alist between element and object types and
1277 ;; transcoding functions relative to the current back-end.
1278 ;; Special keys `inner-template', `template' and `plain-text' are
1279 ;; also possible.
1280 ;; - category :: option
1281 ;; - type :: alist (SYMBOL . FUNCTION)
1282 ;;
1283 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1284 ;; also be transcoded. If it is set to the `headline' symbol,
1285 ;; only the archived headline's name is retained.
1286 ;; - category :: option
1287 ;; - type :: symbol (nil, t, `headline')
1288 ;;
1289 ;; + `:with-author' :: Non-nil means author's name should be included
1290 ;; in the output.
1291 ;; - category :: option
1292 ;; - type :: symbol (nil, t)
1293 ;;
1294 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1295 ;; - category :: option
1296 ;; - type :: symbol (nil, t)
1297 ;;
1298 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1299 ;; inserted at the end of the transcoded string. If the value
1300 ;; is `comment', it should be commented.
1301 ;; - category :: option
1302 ;; - type :: symbol (`comment', nil, t)
1303 ;;
1304 ;; + `:with-date' :: Non-nil means output should contain a date.
1305 ;; - category :: option
1306 ;; - type :. symbol (nil, t)
1307 ;;
1308 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1309 ;; its value is a list of names, only drawers with such names
1310 ;; will be transcoded. If that list starts with `not', drawer
1311 ;; with these names will be skipped.
1312 ;; - category :: option
1313 ;; - type :: symbol (nil, t) or list of strings
1314 ;;
1315 ;; + `:with-email' :: Non-nil means output should contain author's
1316 ;; email.
1317 ;; - category :: option
1318 ;; - type :: symbol (nil, t)
1319 ;;
1320 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1321 ;; interpreted.
1322 ;; - category :: option
1323 ;; - type :: symbol (nil, t)
1324 ;;
1325 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1326 ;; strings starting with a colon as a fixed-with (verbatim) area.
1327 ;; - category :: option
1328 ;; - type :: symbol (nil, t)
1329 ;;
1330 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1331 ;; footnotes.
1332 ;; - category :: option
1333 ;; - type :: symbol (nil, t)
1334 ;;
1335 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1336 ;; `latex-fragment' objects should appear in export output. When
1337 ;; this property is set to `verbatim', they will be left as-is.
1338 ;; - category :: option
1339 ;; - type :: symbol (`verbatim', nil, t)
1340 ;;
1341 ;; + `:with-plannings' :: Non-nil means transcoding should include
1342 ;; planning info.
1343 ;; - category :: option
1344 ;; - type :: symbol (nil, t)
1345 ;;
1346 ;; + `:with-priority' :: Non-nil means transcoding should include
1347 ;; priority cookies.
1348 ;; - category :: option
1349 ;; - type :: symbol (nil, t)
1350 ;;
1351 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1352 ;; plain text.
1353 ;; - category :: option
1354 ;; - type :: symbol (nil, t)
1355 ;;
1356 ;; + `:with-special-strings' :: Non-nil means transcoding should
1357 ;; interpret special strings in plain text.
1358 ;; - category :: option
1359 ;; - type :: symbol (nil, t)
1360 ;;
1361 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1362 ;; interpret subscript and superscript. With a value of "{}",
1363 ;; only interpret those using curly brackets.
1364 ;; - category :: option
1365 ;; - type :: symbol (nil, {}, t)
1366 ;;
1367 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1368 ;; tables.
1369 ;; - category :: option
1370 ;; - type :: symbol (nil, t)
1371 ;;
1372 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1373 ;; headlines. A `not-in-toc' value will remove them from the
1374 ;; table of contents, if any, nonetheless.
1375 ;; - category :: option
1376 ;; - type :: symbol (nil, t, `not-in-toc')
1377 ;;
1378 ;; + `:with-tasks' :: Non-nil means transcoding should include
1379 ;; headlines with a TODO keyword. A `todo' value will only
1380 ;; include headlines with a todo type keyword while a `done'
1381 ;; value will do the contrary. If a list of strings is provided,
1382 ;; only tasks with keywords belonging to that list will be kept.
1383 ;; - category :: option
1384 ;; - type :: symbol (t, todo, done, nil) or list of strings
1385 ;;
1386 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1387 ;; time stamps. Special value `active' (resp. `inactive') ask to
1388 ;; export only active (resp. inactive) timestamps. Otherwise,
1389 ;; completely remove them.
1390 ;; - category :: option
1391 ;; - type :: symbol: (`active', `inactive', t, nil)
1392 ;;
1393 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1394 ;; added to the output. An integer value limits its depth.
1395 ;; - category :: option
1396 ;; - type :: symbol (nil, t or integer)
1397 ;;
1398 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1399 ;; include TODO keywords.
1400 ;; - category :: option
1401 ;; - type :: symbol (nil, t)
1404 ;;;; Environment Options
1405 ;;
1406 ;; Environment options encompass all parameters defined outside the
1407 ;; scope of the parsed data. They come from five sources, in
1408 ;; increasing precedence order:
1409 ;;
1410 ;; - Global variables,
1411 ;; - Buffer's attributes,
1412 ;; - Options keyword symbols,
1413 ;; - Buffer keywords,
1414 ;; - Subtree properties.
1415 ;;
1416 ;; The central internal function with regards to environment options
1417 ;; is `org-export-get-environment'. It updates global variables with
1418 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1419 ;; the different sources.
1420 ;;
1421 ;; The internal functions doing the retrieval are:
1422 ;; `org-export--get-global-options',
1423 ;; `org-export--get-buffer-attributes',
1424 ;; `org-export--parse-option-keyword',
1425 ;; `org-export--get-subtree-options' and
1426 ;; `org-export--get-inbuffer-options'
1427 ;;
1428 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1429 ;; relative to "#+BIND:" keywords.
1432 "Collect export options from the current buffer.
1434 Optional argument BACKEND is a symbol specifying which back-end
1435 specific options to read, if any.
1437 When optional argument SUBTREEP is non-nil, assume the export is
1438 done against the current sub-tree.
1440 Third optional argument EXT-PLIST is a property list with
1441 external parameters overriding Org default settings, but still
1442 inferior to file-local settings."
1443 ;; First install #+BIND variables since these must be set before
1444 ;; global options are read.
1447 ;; Get and prioritize export options...
1449 ;; ... from global variables...
1451 ;; ... from an external property list...
1452 ext-plist
1453 ;; ... from in-buffer settings...
1455 ;; ... and from subtree, when appropriate.
1457 ;; Eventually add misc. properties.
1459 :back-end
1460 backend
1461 :translate-alist
1463 :footnote-definition-alist
1464 ;; Footnotes definitions must be collected in the original
1465 ;; buffer, as there's no insurance that they will still be in
1466 ;; the parse tree, due to possible narrowing.
1480 alist))))
1481 alist))
1482 :id-alist
1483 ;; Collect id references.
1494 alist))))
1497 "Parse an OPTIONS line and return values as a plist.
1498 Optional argument BACKEND is a symbol specifying which back-end
1499 specific items to read, if any."
1501 ;; Priority is given to back-end specific options.
1503 org-export-options-alist))
1504 plist)
1513 options))
1515 property
1518 plist))
1521 "Get export options in subtree at point.
1522 Optional argument BACKEND is a symbol specifying back-end used
1523 for export. Return options as a plist."
1524 ;; For each buffer keyword, create a headline property setting the
1525 ;; same property in communication channel. The name for the property
1526 ;; is the keyword with "EXPORT_" appended to it.
1529 ;; Make sure point is at an heading.
1531 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1532 ;; title as its fallback value.
1538 plist :title
1541 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1545 ;; Handle other keywords. TITLE keyword is excluded as it has
1546 ;; been handled already.
1554 ;; Export properties are not case-sensitive.
1561 plist
1562 property
1564 ;; Parse VALUE if required.
1568 ;; If BEHAVIOUR is `split' expected value is
1569 ;; a list of strings, not a string.
1572 ;; Look for both general keywords and back-end specific
1573 ;; options, with priority given to the latter.
1575 org-export-options-alist)))
1576 ;; Return value.
1577 plist)))
1580 "Return current buffer export options, as a plist.
1582 Optional argument BACKEND, when non-nil, is a symbol specifying
1583 which back-end specific options should also be read in the
1584 process.
1586 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1588 get-options ; For byte-compiler.
1591 ;; Priority is given to back-end specific options.
1593 org-export-options-alist))
1596 org-export-special-keywords))))
1599 ;; Return property name associated to KEYWORD.
1604 options))))
1607 ;; Recursively read keywords in buffer. FILES is a list
1608 ;; of files read so far. PLIST is the current property
1609 ;; list obtained.
1618 ;; Options in `org-export-special-keywords'.
1622 ;; Avoid circular dependencies.
1632 plist
1637 plist
1643 ;; Options in `org-export-options-alist'.
1648 plist prop
1649 ;; Handle value depending on specified
1650 ;; BEHAVIOUR.
1656 " "
1668 ;; Return final value.
1669 plist))))
1670 ;; Read options in the current buffer.
1672 ;; Parse keywords specified in `org-element-document-properties'.
1674 ;; Find the property associated to the keyword.
1682 org-element-document-properties)
1683 ;; Return value.
1684 plist))
1687 "Return properties related to buffer attributes, as a plist."
1690 ;; Store full path of input file name, or nil. For internal use.
1691 :input-file visited-file
1698 "Return global export options as a plist.
1700 Optional argument BACKEND, if non-nil, is a symbol specifying
1701 which back-end specific export options should also be read in the
1702 process."
1704 ;; Priority is given to back-end specific options.
1706 org-export-options-alist))
1707 plist)
1714 plist
1715 prop
1716 ;; Eval default value provided. If keyword is a member
1717 ;; of `org-element-document-properties', parse it as
1718 ;; a secondary string before storing it.
1723 value
1726 all)
1727 ;; Return value.
1728 plist))
1731 "Return variables bound from BIND keywords in current buffer.
1732 Also look for BIND keywords in setup files. The return value is
1733 an alist where associations are (VARIABLE-NAME VALUE)."
1738 ;; Return an alist between variable names and their
1739 ;; value. FILES is a list of setup files names read so
1740 ;; far, used to avoid circular dependencies. ALIST is
1741 ;; the alist collected so far.
1752 ;; Enter setup file.
1762 alist))))))))))
1763 alist)))))
1764 ;; Return value in appropriate order of appearance.
1768 ;;;; Tree Properties
1769 ;;
1770 ;; Tree properties are information extracted from parse tree. They
1771 ;; are initialized at the beginning of the transcoding process by
1772 ;; `org-export-collect-tree-properties'.
1773 ;;
1774 ;; Dedicated functions focus on computing the value of specific tree
1775 ;; properties during initialization. Thus,
1776 ;; `org-export--populate-ignore-list' lists elements and objects that
1777 ;; should be skipped during export, `org-export--get-min-level' gets
1778 ;; the minimal exportable level, used as a basis to compute relative
1779 ;; level for headlines. Eventually
1780 ;; `org-export--collect-headline-numbering' builds an alist between
1781 ;; headlines and their numbering.
1784 "Extract tree properties from parse tree.
1786 DATA is the parse tree from which information is retrieved. INFO
1787 is a list holding export options.
1789 Following tree properties are set or updated:
1791 `:exported-data' Hash table used to memoize results from
1792 `org-export-data'.
1794 `:footnote-definition-alist' List of footnotes definitions in
1795 original buffer and current parse tree.
1797 `:headline-offset' Offset between true level of headlines and
1798 local level. An offset of -1 means a headline
1799 of level 2 should be considered as a level
1800 1 headline in the context.
1802 `:headline-numbering' Alist of all headlines as key an the
1803 associated numbering as value.
1805 `:ignore-list' List of elements that should be ignored during
1806 export.
1808 Return updated plist."
1809 ;; Install the parse tree in the communication channel, in order to
1810 ;; use `org-export-get-genealogy' and al.
1812 ;; Get the list of elements and objects to ignore, and put it into
1813 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1814 ;; been done during parse tree filtering.
1817 :ignore-list
1820 ;; Compute `:headline-offset' in order to be able to use
1821 ;; `org-export-get-relative-level'.
1824 :headline-offset
1826 ;; Update footnotes definitions list with definitions in parse tree.
1827 ;; This is required since buffer expansion might have modified
1828 ;; boundaries of footnote definitions contained in the parse tree.
1829 ;; This way, definitions in `footnote-definition-alist' are bound to
1830 ;; match those in the parse tree.
1836 defs)))
1838 ;; Properties order doesn't matter: get the rest of the tree
1839 ;; properties.
1843 info))
1846 "Return minimum exportable headline's level in DATA.
1847 DATA is parsed tree as returned by `org-element-parse-buffer'.
1848 OPTIONS is a plist holding export options."
1859 ;; If no headline was found, for the sake of consistency, set
1860 ;; minimum level to 1 nonetheless.
1864 "Return numbering of all exportable headlines in a parse tree.
1866 DATA is the parse tree. OPTIONS is the plist holding export
1867 options.
1869 Return an alist whose key is a headline and value is its
1870 associated numbering \(in the shape of a list of numbers\) or nil
1871 for a footnotes section."
1879 headline
1881 for idx from 0 to org-export-max-depth
1885 options)))
1888 "Return list of elements and objects to ignore during export.
1889 DATA is the parse tree to traverse. OPTIONS is the plist holding
1890 export options."
1892 walk-data
1893 ;; First find trees containing a select tag, if any.
1897 ;; Collect ignored elements or objects into IGNORE-LIST.
1903 ;; If headline is archived but tree below has
1904 ;; to be skipped, add it to ignore list.
1907 ;; Move into secondary string, if any.
1912 ;; Move into recursive objects/elements.
1914 ;; Main call.
1916 ;; Return value.
1917 ignore))
1920 "Return list of headlines and inlinetasks with a select tag in their tree.
1921 DATA is parsed data as returned by `org-element-parse-buffer'.
1922 INFO is a plist holding export options."
1924 walk-data ; For byte-compiler.
1934 ;; When a select tag is found, mark full
1935 ;; genealogy and every headline within the tree
1936 ;; as acceptable.
1939 genealogy
1942 selected-trees))
1943 ;; If at a headline, continue searching in tree,
1944 ;; recursively.
1954 selected-trees))
1957 "Non-nil when element or object BLOB should be skipped during export.
1958 OPTIONS is the plist holding export options. SELECTED, when
1959 non-nil, is a list of headlines or inlinetasks belonging to
1960 a tree with a select tag."
1967 ;; If `:with-drawers' value starts with `not', ignore
1968 ;; every drawer whose name belong to that list.
1969 ;; Otherwise, ignore drawers whose name isn't in that
1970 ;; list.
1984 ;; Ignore subtrees with an exclude tag.
1987 ;; When a select tag is present in the buffer, ignore any tree
1988 ;; without it.
1990 ;; Ignore commented sub-trees.
1992 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1994 ;; Ignore tasks, if specified by `:with-tasks' property.
2010 ;; No timestamp allowed.
2012 ;; Only active timestamps allowed and the current one isn't
2013 ;; active.
2017 ;; Only inactive timestamps allowed and the current one isn't
2018 ;; inactive.
2023 \f
2024 ;;; The Transcoder
2025 ;;
2026 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2027 ;; `org-element-parse-buffer') and transcodes it into a specified
2028 ;; back-end output. It takes care of filtering out elements or
2029 ;; objects according to export options and organizing the output blank
2030 ;; lines and white space are preserved. The function memoizes its
2031 ;; results, so it is cheap to call it within translators.
2032 ;;
2033 ;; It is possible to modify locally the back-end used by
2034 ;; `org-export-data' or even use a temporary back-end by using
2035 ;; `org-export-data-with-translations' and
2036 ;; `org-export-data-with-backend'.
2037 ;;
2038 ;; Internally, three functions handle the filtering of objects and
2039 ;; elements during the export. In particular,
2040 ;; `org-export-ignore-element' marks an element or object so future
2041 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2042 ;; elements or objects should be seen as real Org syntax and
2043 ;; `org-export-expand' transforms the others back into their original
2044 ;; shape
2045 ;;
2046 ;; `org-export-transcoder' is an accessor returning appropriate
2047 ;; translator function for a given element or object.
2050 "Return appropriate transcoder for BLOB.
2051 INFO is a plist containing export directives."
2053 ;; Return contents only for complete parse trees.
2059 "Convert DATA into current back-end format.
2061 DATA is a parse tree, an element or an object or a secondary
2062 string. INFO is a plist holding export options.
2064 Return transcoded string."
2070 ;; Ignored element/object.
2072 ;; Plain text.
2078 info))
2079 ;; Uninterpreted element/object: change it back to Org
2080 ;; syntax and export again resulting raw string.
2084 data
2088 info))
2089 ;; Secondary string.
2092 ;; Element/Object without contents or, as a special case,
2093 ;; headline with archive tag and archived trees restricted
2094 ;; to title only.
2102 ;; Export snippets never return a nil value so
2103 ;; that white spaces following them are never
2104 ;; ignored.
2106 ;; Element/Object with contents.
2119 ;; Elements directly containing objects
2120 ;; must have their indentation normalized
2121 ;; first.
2123 data
2124 ;; When normalizing contents of the first
2125 ;; paragraph in an item or a footnote
2126 ;; definition, ignore first line's
2127 ;; indentation: there is none and it
2128 ;; might be misleading.
2133 data)
2140 info))))))))
2141 ;; Final result will be memoized before being returned.
2143 data
2147 ;; Append the same white space between elements or objects as in
2148 ;; the original buffer, and call appropriate filters.
2159 info)))
2160 results)))
2164 "Convert DATA into another format using a given translation table.
2165 DATA is an element, an object, a secondary string or a string.
2166 TRANSLATIONS is an alist between element or object types and
2167 a functions handling them. See `org-export-define-backend' for
2168 more information. INFO is a plist used as a communication
2169 channel."
2171 data
2172 ;; Set-up a new communication channel with TRANSLATIONS as the
2173 ;; translate table and a new hash table for memoization.
2175 info
2177 ;; Size of the hash table is reduced since this function
2178 ;; will probably be used on short trees.
2182 "Convert DATA into BACKEND format.
2184 DATA is an element, an object, a secondary string or a string.
2185 BACKEND is a symbol. INFO is a plist used as a communication
2186 channel.
2188 Unlike to `org-export-with-backend', this function will
2189 recursively convert DATA using BACKEND translation table."
2195 "Non-nil if element or object BLOB should be interpreted during export.
2196 If nil, BLOB will appear as raw Org syntax. Check is done
2197 according to export options INFO, stored as a plist."
2199 ;; ... entities...
2201 ;; ... emphasis...
2204 ;; ... fixed-width areas.
2206 ;; ... footnotes...
2209 ;; ... LaTeX environments and fragments...
2213 ;; ... sub/superscripts...
2219 ;; ... tables...
2224 "Expand a parsed element or object to its original state.
2225 BLOB is either an element or an object. CONTENTS is its
2226 contents, as a string or nil."
2229 blob contents))
2232 "Add ELEMENT to `:ignore-list' in INFO.
2234 Any element in `:ignore-list' will be skipped when using
2235 `org-element-map'. INFO is modified by side effects."
2239 \f
2240 ;;; The Filter System
2241 ;;
2242 ;; Filters allow end-users to tweak easily the transcoded output.
2243 ;; They are the functional counterpart of hooks, as every filter in
2244 ;; a set is applied to the return value of the previous one.
2245 ;;
2246 ;; Every set is back-end agnostic. Although, a filter is always
2247 ;; called, in addition to the string it applies to, with the back-end
2248 ;; used as argument, so it's easy for the end-user to add back-end
2249 ;; specific filters in the set. The communication channel, as
2250 ;; a plist, is required as the third argument.
2251 ;;
2252 ;; From the developer side, filters sets can be installed in the
2253 ;; process with the help of `org-export-define-backend', which
2254 ;; internally stores filters as an alist. Each association has a key
2255 ;; among the following symbols and a function or a list of functions
2256 ;; as value.
2257 ;;
2258 ;; - `:filter-options' applies to the property list containing export
2259 ;; options. Unlike to other filters, functions in this list accept
2260 ;; two arguments instead of three: the property list containing
2261 ;; export options and the back-end. Users can set its value through
2262 ;; `org-export-filter-options-functions' variable.
2263 ;;
2264 ;; - `:filter-parse-tree' applies directly to the complete parsed
2265 ;; tree. Users can set it through
2266 ;; `org-export-filter-parse-tree-functions' variable.
2267 ;;
2268 ;; - `:filter-final-output' applies to the final transcoded string.
2269 ;; Users can set it with `org-export-filter-final-output-functions'
2270 ;; variable
2271 ;;
2272 ;; - `:filter-plain-text' applies to any string not recognized as Org
2273 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2274 ;; configure it.
2275 ;;
2276 ;; - `:filter-TYPE' applies on the string returned after an element or
2277 ;; object of type TYPE has been transcoded. An user can modify
2278 ;; `org-export-filter-TYPE-functions'
2279 ;;
2280 ;; All filters sets are applied with
2281 ;; `org-export-filter-apply-functions' function. Filters in a set are
2282 ;; applied in a LIFO fashion. It allows developers to be sure that
2283 ;; their filters will be applied first.
2284 ;;
2285 ;; Filters properties are installed in communication channel with
2286 ;; `org-export-install-filters' function.
2287 ;;
2288 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2289 ;; `org-export-before-parsing-hook') are run at the beginning of the
2290 ;; export process and just before parsing to allow for heavy structure
2291 ;; modifications.
2294 ;;;; Hooks
2297 "Hook run at the beginning of the export process.
2299 This is run before include keywords and macros are expanded and
2300 Babel code blocks executed, on a copy of the original buffer
2301 being exported. Visibility and narrowing are preserved. Point
2302 is at the beginning of the buffer.
2304 Every function in this hook will be called with one argument: the
2308 "Hook run before parsing an export buffer.
2310 This is run after include keywords and macros have been expanded
2311 and Babel code blocks executed, on a copy of the original buffer
2312 being exported. Visibility and narrowing are preserved. Point
2313 is at the beginning of the buffer.
2315 Every function in this hook will be called with one argument: the
2319 ;;;; Special Filters
2322 "List of functions applied to the export options.
2323 Each filter is called with two arguments: the export options, as
2324 a plist, and the back-end, as a symbol. It must return
2328 "List of functions applied to the parsed tree.
2329 Each filter is called with three arguments: the parse tree, as
2330 returned by `org-element-parse-buffer', the back-end, as
2331 a symbol, and the communication channel, as a plist. It must
2335 "List of functions applied to plain text.
2336 Each filter is called with three arguments: a string which
2337 contains no Org syntax, the back-end, as a symbol, and the
2338 communication channel, as a plist. It must return a string or
2342 "List of functions applied to the transcoded string.
2343 Each filter is called with three arguments: the full transcoded
2344 string, the back-end, as a symbol, and the communication channel,
2345 as a plist. It must return a string that will be used as the
2349 ;;;; Elements Filters
2352 "List of functions applied to a transcoded babel-call.
2353 Each filter is called with three arguments: the transcoded data,
2354 as a string, the back-end, as a symbol, and the communication
2358 "List of functions applied to a transcoded center block.
2359 Each filter is called with three arguments: the transcoded data,
2360 as a string, the back-end, as a symbol, and the communication
2364 "List of functions applied to a transcoded clock.
2365 Each filter is called with three arguments: the transcoded data,
2366 as a string, the back-end, as a symbol, and the communication
2370 "List of functions applied to a transcoded comment.
2371 Each filter is called with three arguments: the transcoded data,
2372 as a string, the back-end, as a symbol, and the communication
2376 "List of functions applied to a transcoded comment-block.
2377 Each filter is called with three arguments: the transcoded data,
2378 as a string, the back-end, as a symbol, and the communication
2382 "List of functions applied to a transcoded diary-sexp.
2383 Each filter is called with three arguments: the transcoded data,
2384 as a string, the back-end, as a symbol, and the communication
2388 "List of functions applied to a transcoded drawer.
2389 Each filter is called with three arguments: the transcoded data,
2390 as a string, the back-end, as a symbol, and the communication
2394 "List of functions applied to a transcoded dynamic-block.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2400 "List of functions applied to a transcoded example-block.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2406 "List of functions applied to a transcoded export-block.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2412 "List of functions applied to a transcoded fixed-width.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2418 "List of functions applied to a transcoded footnote-definition.
2419 Each filter is called with three arguments: the transcoded data,
2420 as a string, the back-end, as a symbol, and the communication
2424 "List of functions applied to a transcoded headline.
2425 Each filter is called with three arguments: the transcoded data,
2426 as a string, the back-end, as a symbol, and the communication
2430 "List of functions applied to a transcoded horizontal-rule.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2436 "List of functions applied to a transcoded inlinetask.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2442 "List of functions applied to a transcoded item.
2443 Each filter is called with three arguments: the transcoded data,
2444 as a string, the back-end, as a symbol, and the communication
2448 "List of functions applied to a transcoded keyword.
2449 Each filter is called with three arguments: the transcoded data,
2450 as a string, the back-end, as a symbol, and the communication
2454 "List of functions applied to a transcoded latex-environment.
2455 Each filter is called with three arguments: the transcoded data,
2456 as a string, the back-end, as a symbol, and the communication
2460 "List of functions applied to a transcoded node-property.
2461 Each filter is called with three arguments: the transcoded data,
2462 as a string, the back-end, as a symbol, and the communication
2466 "List of functions applied to a transcoded paragraph.
2467 Each filter is called with three arguments: the transcoded data,
2468 as a string, the back-end, as a symbol, and the communication
2472 "List of functions applied to a transcoded plain-list.
2473 Each filter is called with three arguments: the transcoded data,
2474 as a string, the back-end, as a symbol, and the communication
2478 "List of functions applied to a transcoded planning.
2479 Each filter is called with three arguments: the transcoded data,
2480 as a string, the back-end, as a symbol, and the communication
2484 "List of functions applied to a transcoded property-drawer.
2485 Each filter is called with three arguments: the transcoded data,
2486 as a string, the back-end, as a symbol, and the communication
2490 "List of functions applied to a transcoded quote block.
2491 Each filter is called with three arguments: the transcoded quote
2492 data, as a string, the back-end, as a symbol, and the
2493 communication channel, as a plist. It must return a string or
2497 "List of functions applied to a transcoded quote-section.
2498 Each filter is called with three arguments: the transcoded data,
2499 as a string, the back-end, as a symbol, and the communication
2503 "List of functions applied to a transcoded section.
2504 Each filter is called with three arguments: the transcoded data,
2505 as a string, the back-end, as a symbol, and the communication
2509 "List of functions applied to a transcoded special block.
2510 Each filter is called with three arguments: the transcoded data,
2511 as a string, the back-end, as a symbol, and the communication
2515 "List of functions applied to a transcoded src-block.
2516 Each filter is called with three arguments: the transcoded data,
2517 as a string, the back-end, as a symbol, and the communication
2521 "List of functions applied to a transcoded table.
2522 Each filter is called with three arguments: the transcoded data,
2523 as a string, the back-end, as a symbol, and the communication
2527 "List of functions applied to a transcoded table-cell.
2528 Each filter is called with three arguments: the transcoded data,
2529 as a string, the back-end, as a symbol, and the communication
2533 "List of functions applied to a transcoded table-row.
2534 Each filter is called with three arguments: the transcoded data,
2535 as a string, the back-end, as a symbol, and the communication
2539 "List of functions applied to a transcoded verse block.
2540 Each filter is called with three arguments: the transcoded data,
2541 as a string, the back-end, as a symbol, and the communication
2545 ;;;; Objects Filters
2548 "List of functions applied to transcoded bold text.
2549 Each filter is called with three arguments: the transcoded data,
2550 as a string, the back-end, as a symbol, and the communication
2554 "List of functions applied to transcoded code text.
2555 Each filter is called with three arguments: the transcoded data,
2556 as a string, the back-end, as a symbol, and the communication
2560 "List of functions applied to a transcoded entity.
2561 Each filter is called with three arguments: the transcoded data,
2562 as a string, the back-end, as a symbol, and the communication
2566 "List of functions applied to a transcoded export-snippet.
2567 Each filter is called with three arguments: the transcoded data,
2568 as a string, the back-end, as a symbol, and the communication
2572 "List of functions applied to a transcoded footnote-reference.
2573 Each filter is called with three arguments: the transcoded data,
2574 as a string, the back-end, as a symbol, and the communication
2578 "List of functions applied to a transcoded inline-babel-call.
2579 Each filter is called with three arguments: the transcoded data,
2580 as a string, the back-end, as a symbol, and the communication
2584 "List of functions applied to a transcoded inline-src-block.
2585 Each filter is called with three arguments: the transcoded data,
2586 as a string, the back-end, as a symbol, and the communication
2590 "List of functions applied to transcoded italic text.
2591 Each filter is called with three arguments: the transcoded data,
2592 as a string, the back-end, as a symbol, and the communication
2596 "List of functions applied to a transcoded latex-fragment.
2597 Each filter is called with three arguments: the transcoded data,
2598 as a string, the back-end, as a symbol, and the communication
2602 "List of functions applied to a transcoded line-break.
2603 Each filter is called with three arguments: the transcoded data,
2604 as a string, the back-end, as a symbol, and the communication
2608 "List of functions applied to a transcoded link.
2609 Each filter is called with three arguments: the transcoded data,
2610 as a string, the back-end, as a symbol, and the communication
2614 "List of functions applied to a transcoded macro.
2615 Each filter is called with three arguments: the transcoded data,
2616 as a string, the back-end, as a symbol, and the communication
2620 "List of functions applied to a transcoded radio-target.
2621 Each filter is called with three arguments: the transcoded data,
2622 as a string, the back-end, as a symbol, and the communication
2626 "List of functions applied to a transcoded statistics-cookie.
2627 Each filter is called with three arguments: the transcoded data,
2628 as a string, the back-end, as a symbol, and the communication
2632 "List of functions applied to transcoded strike-through text.
2633 Each filter is called with three arguments: the transcoded data,
2634 as a string, the back-end, as a symbol, and the communication
2638 "List of functions applied to a transcoded subscript.
2639 Each filter is called with three arguments: the transcoded data,
2640 as a string, the back-end, as a symbol, and the communication
2644 "List of functions applied to a transcoded superscript.
2645 Each filter is called with three arguments: the transcoded data,
2646 as a string, the back-end, as a symbol, and the communication
2650 "List of functions applied to a transcoded target.
2651 Each filter is called with three arguments: the transcoded data,
2652 as a string, the back-end, as a symbol, and the communication
2656 "List of functions applied to a transcoded timestamp.
2657 Each filter is called with three arguments: the transcoded data,
2658 as a string, the back-end, as a symbol, and the communication
2662 "List of functions applied to transcoded underline text.
2663 Each filter is called with three arguments: the transcoded data,
2664 as a string, the back-end, as a symbol, and the communication
2668 "List of functions applied to transcoded verbatim text.
2669 Each filter is called with three arguments: the transcoded data,
2670 as a string, the back-end, as a symbol, and the communication
2674 ;;;; Filters Tools
2675 ;;
2676 ;; Internal function `org-export-install-filters' installs filters
2677 ;; hard-coded in back-ends (developer filters) and filters from global
2678 ;; variables (user filters) in the communication channel.
2679 ;;
2680 ;; Internal function `org-export-filter-apply-functions' takes care
2681 ;; about applying each filter in order to a given data. It ignores
2682 ;; filters returning a nil value but stops whenever a filter returns
2683 ;; an empty string.
2686 "Call every function in FILTERS.
2688 Functions are called with arguments VALUE, current export
2689 back-end and INFO. A function returning a nil value will be
2690 skipped. If it returns the empty string, the process ends and
2691 VALUE is ignored.
2693 Call is done in a LIFO fashion, to be sure that developer
2694 specified filters, if any, are called first."
2703 "Install filters properties in communication channel.
2704 INFO is a plist containing the current communication channel.
2705 Return the updated communication channel."
2707 ;; Install user-defined filters with `org-export-filters-alist'
2708 ;; and filters already in INFO (through ext-plist mechanism).
2715 ;; Filters in INFO will be called
2716 ;; before those user provided.
2719 default-value)))))
2720 org-export-filters-alist)
2721 ;; Prepend back-end specific filters to that list.
2723 ;; Single values get consed, lists are appended.
2728 plist key
2732 ;; Return new communication channel.
2736 \f
2737 ;;; Core functions
2738 ;;
2739 ;; This is the room for the main function, `org-export-as', along with
2740 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2741 ;; `org-export-string-as'. They differ either by the way they output
2742 ;; the resulting code (for the first two) or by the input type (for
2743 ;; the latter). `org-export--copy-to-kill-ring-p' determines if
2744 ;; output of these function should be added to kill ring.
2745 ;;
2746 ;; `org-export-output-file-name' is an auxiliary function meant to be
2747 ;; used with `org-export-to-file'. With a given extension, it tries
2748 ;; to provide a canonical file name to write export output to.
2749 ;;
2750 ;; Note that `org-export-as' doesn't really parse the current buffer,
2751 ;; but a copy of it (with the same buffer-local variables and
2752 ;; visibility), where macros and include keywords are expanded and
2753 ;; Babel blocks are executed, if appropriate.
2754 ;; `org-export-with-buffer-copy' macro prepares that copy.
2755 ;;
2756 ;; File inclusion is taken care of by
2757 ;; `org-export-expand-include-keyword' and
2758 ;; `org-export--prepare-file-contents'. Structure wise, including
2759 ;; a whole Org file in a buffer often makes little sense. For
2760 ;; example, if the file contains a headline and the include keyword
2761 ;; was within an item, the item should contain the headline. That's
2762 ;; why file inclusion should be done before any structure can be
2763 ;; associated to the file, that is before parsing.
2764 ;;
2765 ;; `org-export-insert-default-template' is a command to insert
2766 ;; a default template (or a back-end specific template) at point or in
2767 ;; current subtree.
2770 "Return a copy of the current buffer.
2771 The copy preserves Org buffer-local variables, visibility and
2772 narrowing."
2778 new-buf))
2781 "Apply BODY in a copy of the current buffer.
2782 The copy preserves local variables, visibility and contents of
2783 the original buffer. Point is at the beginning of the buffer
2784 when BODY is applied."
2793 ;; Kill copy without confirmation.
2799 "Generate a function duplicating BUFFER.
2801 The copy will preserve local variables, visibility, contents and
2802 narrowing of the original buffer. If a region was active in
2803 BUFFER, contents will be narrowed to that region instead.
2805 The resulting function can be evaled at a later time, from
2806 another buffer, effectively cloning the original buffer there.
2808 The function assumes BUFFER's major mode is `org-mode'."
2812 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2813 ;; already in BUFFER.
2815 ;; Copy specific buffer local variables and variables set
2816 ;; through BIND keywords.
2818 vars)
2826 buffer-file-name
2827 buffer-file-coding-system))
2831 ;; Skip unreadable values, as they cannot be
2832 ;; sent to external process.
2836 vars))))))
2837 ;; Whole buffer contents.
2842 ;; Narrowing.
2846 ;; Current position of point.
2848 ;; Overlays with invisible property.
2858 ov-set))))
2860 ov-set)))))
2862 ;;;###autoload
2865 "Transcode current Org buffer into BACKEND code.
2867 If narrowing is active in the current buffer, only transcode its
2868 narrowed part.
2870 If a region is active, transcode that region.
2872 When optional argument SUBTREEP is non-nil, transcode the
2873 sub-tree at point, extracting information from the headline
2874 properties first.
2876 When optional argument VISIBLE-ONLY is non-nil, don't export
2877 contents of hidden elements.
2879 When optional argument BODY-ONLY is non-nil, only return body
2880 code, without surrounding template.
2882 Optional argument EXT-PLIST, when provided, is a property list
2883 with external parameters overriding Org default settings, but
2884 still inferior to file-local settings.
2886 Return code as a string."
2890 ;; Narrow buffer to an appropriate region or subtree for
2891 ;; parsing. If parsing subtree, be sure to remove main headline
2892 ;; too.
2900 ;; Initialize communication channel with original buffer
2901 ;; attributes, unavailable in its copy.
2909 tree)
2910 ;; Update communication channel and get parse tree. Buffer
2911 ;; isn't parsed directly. Instead, a temporary copy is
2912 ;; created, where include keywords, macros are expanded and
2913 ;; code blocks are evaluated.
2915 ;; Run first hook with current back-end as argument.
2918 ;; Update macro templates since #+INCLUDE keywords might have
2919 ;; added some new ones.
2923 ;; Update radio targets since keyword inclusion might have
2924 ;; added some more.
2926 ;; Run last hook with current back-end as argument.
2930 ;; Update communication channel with environment. Also
2931 ;; install user's and developer's filters.
2936 ;; Expand export-specific set of macros: {{{author}}},
2937 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2938 ;; once regular macros have been expanded, since document
2939 ;; keywords may contain one of them.
2945 ;; EMAIL is not a parsed keyword: store it as-is.
2949 ;; Call options filters and update export options. We do not
2950 ;; use `org-export-filter-apply-functions' here since the
2951 ;; arity of such filters is different.
2955 ;; Parse buffer and call parse-tree filter on it.
2960 ;; Now tree is complete, compute its properties and add them
2961 ;; to communication channel.
2965 ;; Eventually transcode TREE. Wrap the resulting string into
2966 ;; a template.
2975 ;; Remove all text properties since they cannot be
2976 ;; retrieved from an external process. Finally call
2977 ;; final-output filter and return result.
2983 info))))))))
2985 ;;;###autoload
2988 "Call `org-export-as' with output to a specified buffer.
2990 BACKEND is the back-end used for transcoding, as a symbol.
2992 BUFFER is the output buffer. If it already exists, it will be
2993 erased first, otherwise, it will be created.
2995 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2996 EXT-PLIST are similar to those used in `org-export-as', which
2997 see.
2999 Depending on `org-export-copy-to-kill-ring', add buffer contents
3000 to kill ring. Return buffer."
3007 ;; Maybe add buffer contents to kill ring.
3010 ;; Return buffer.
3011 buffer))
3013 ;;;###autoload
3016 "Call `org-export-as' with output to a specified file.
3018 BACKEND is the back-end used for transcoding, as a symbol. FILE
3019 is the name of the output file, as a string.
3021 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3022 EXT-PLIST are similar to those used in `org-export-as', which
3023 see.
3025 Depending on `org-export-copy-to-kill-ring', add file contents
3026 to kill ring. Return output file's name."
3027 ;; Checks for FILE permissions. `write-file' would do the same, but
3028 ;; we'd rather avoid needless transcoding of parse tree.
3030 ;; Insert contents to a temporary buffer and write it to FILE.
3036 ;; Maybe add file contents to kill ring.
3039 ;; Return full path.
3040 file)
3042 ;;;###autoload
3044 "Transcode STRING into BACKEND code.
3046 When optional argument BODY-ONLY is non-nil, only return body
3047 code, without preamble nor postamble.
3049 Optional argument EXT-PLIST, when provided, is a property list
3050 with external parameters overriding Org default settings, but
3051 still inferior to file-local settings.
3053 Return code as a string."
3059 ;;;###autoload
3061 "Insert all export keywords with default values at beginning of line.
3063 BACKEND is a symbol representing the export back-end for which
3064 specific export options should be added to the template, or
3065 `default' for default template. When it is nil, the user will be
3066 prompted for a category.
3068 If SUBTREEP is non-nil, export configuration will be set up
3069 locally for the subtree through node properties."
3078 "Options category: "
3081 org-export-registered-backends))))))
3082 options keywords)
3083 ;; Populate OPTIONS and KEYWORDS.
3097 ;; Move to an appropriate location in order to insert options.
3099 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3100 ;; list of available keywords.
3128 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3147 ;; And the rest of keywords.
3158 "Return output file's name according to buffer specifications.
3160 EXTENSION is a string representing the output file extension,
3161 with the leading dot.
3163 With a non-nil optional argument SUBTREEP, try to determine
3165 of subtree at point.
3167 When optional argument PUB-DIR is set, use it as the publishing
3168 directory.
3170 When optional argument VISIBLE-ONLY is non-nil, don't export
3171 contents of hidden elements.
3173 Return file name as a string."
3176 ;; File name may come from EXPORT_FILE_NAME subtree
3177 ;; property, assuming point is at beginning of said
3178 ;; sub-tree.
3185 ;; File name may be extracted from buffer's associated
3186 ;; file, if any.
3188 ;; Can't determine file name on our own: Ask user.
3192 "Output file: " pub-dir nil nil nil
3196 ;; Build file name. Enforce EXTENSION over whatever user
3197 ;; may have come up with. PUB-DIR, if defined, always has
3198 ;; precedence over any provided path.
3203 extension))
3206 ;; If writing to OUTPUT-FILE would overwrite original file, append
3207 ;; EXTENSION another time to final name.
3210 output-file)))
3213 "Expand every include keyword in buffer.
3214 Optional argument INCLUDED is a list of included file names along
3215 with their line restriction, when appropriate. It is used to
3216 avoid infinite recursion. Optional argument DIR is the current
3217 working directory. It is used to properly resolve relative
3218 paths."
3225 ;; Extract arguments from keyword's value.
3239 ;; Minimal level of included file defaults to the child
3240 ;; level of the current headline, if any, or one. It
3241 ;; only applies is the file is meant to be included as
3242 ;; an Org one.
3250 ;; Remove keyword.
3255 ;; Check if files has already been parsed. Look after
3256 ;; inclusion lines too, as different parts of the same file
3257 ;; can be included too.
3269 ind-str contents ind-str))))
3277 ind-str env contents ind-str))))
3290 "Prepare the contents of FILE for inclusion and return them as a string.
3292 When optional argument LINES is a string specifying a range of
3293 lines, include only those lines.
3295 Optional argument IND, when non-nil, is an integer specifying the
3296 global indentation of returned contents. Since its purpose is to
3297 allow an included file to stay in the same environment it was
3298 created \(i.e. a list item), it doesn't apply past the first
3299 headline encountered.
3301 Optional argument MINLEVEL, when non-nil, is an integer
3302 specifying the level that any top-level headline in the included
3303 file should have."
3319 ;; Remove blank lines at beginning and end of contents. The logic
3320 ;; behind that removal is that blank lines around include keyword
3321 ;; override blank lines in included file.
3330 ;; If IND is set, preserve indentation of include keyword until
3331 ;; the first headline encountered.
3338 ;; Do not move footnote definitions out of column 0.
3344 ;; When MINLEVEL is specified, compute minimal level for headlines
3345 ;; in the file (CUR-MIN), and remove stars to each headline so
3346 ;; that headlines with minimal level have a level of MINLEVEL.
3357 ;; Only change stars, don't bother moving whole
3358 ;; sections.
3365 "Execute every Babel code in the visible part of current buffer."
3366 ;; Get a pristine copy of current buffer so Babel references can be
3367 ;; properly resolved.
3374 "Return a non-nil value when output should be added to the kill ring.
3375 See also `org-export-copy-to-kill-ring'."
3381 \f
3382 ;;; Tools For Back-Ends
3383 ;;
3384 ;; A whole set of tools is available to help build new exporters. Any
3385 ;; function general enough to have its use across many back-ends
3386 ;; should be added here.
3388 ;;;; For Affiliated Keywords
3389 ;;
3390 ;; `org-export-read-attribute' reads a property from a given element
3391 ;; as a plist. It can be used to normalize affiliated keywords'
3392 ;; syntax.
3393 ;;
3394 ;; Since captions can span over multiple lines and accept dual values,
3395 ;; their internal representation is a bit tricky. Therefore,
3396 ;; `org-export-get-caption' transparently returns a given element's
3397 ;; caption as a secondary string.
3400 "Turn ATTRIBUTE property from ELEMENT into a plist.
3402 When optional argument PROPERTY is non-nil, return the value of
3403 that property within attributes.
3407 properties. All values will become strings except the empty
3415 s)
3420 ;; Ignore any string before the first property with `cdr'.
3423 s)
3424 result))))))))
3428 "Return caption from ELEMENT as a secondary string.
3430 When optional argument SHORTP is non-nil, return short caption,
3431 as a secondary string, instead.
3433 Caption lines are separated by a white space."
3441 ;;;; For Derived Back-ends
3442 ;;
3443 ;; `org-export-with-backend' is a function allowing to locally use
3444 ;; another back-end to transcode some object or element. In a derived
3445 ;; back-end, it may be used as a fall-back function once all specific
3446 ;; cases have been treated.
3449 "Call a transcoder from BACK-END on DATA.
3450 CONTENTS, when non-nil, is the transcoded contents of DATA
3451 element, as a string. INFO, when non-nil, is the communication
3452 channel used for export, as a plist.."
3462 ;;;; For Export Snippets
3463 ;;
3464 ;; Every export snippet is transmitted to the back-end. Though, the
3465 ;; latter will only retain one type of export-snippet, ignoring
3466 ;; others, based on the former's target back-end. The function
3467 ;; `org-export-snippet-backend' returns that back-end for a given
3468 ;; export-snippet.
3471 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3472 Translation, with `org-export-snippet-translation-alist', is
3473 applied."
3477 back-end))))
3480 ;;;; For Footnotes
3481 ;;
3482 ;; `org-export-collect-footnote-definitions' is a tool to list
3483 ;; actually used footnotes definitions in the whole parse tree, or in
3484 ;; a headline, in order to add footnote listings throughout the
3485 ;; transcoded data.
3486 ;;
3487 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3488 ;; back-ends, when they need to attach the footnote definition only to
3489 ;; the first occurrence of the corresponding label.
3490 ;;
3491 ;; `org-export-get-footnote-definition' and
3492 ;; `org-export-get-footnote-number' provide easier access to
3493 ;; additional information relative to a footnote reference.
3496 "Return an alist between footnote numbers, labels and definitions.
3498 DATA is the parse tree from which definitions are collected.
3499 INFO is the plist used as a communication channel.
3501 Definitions are sorted by order of references. They either
3502 appear as Org data or as a secondary string for inlined
3503 footnotes. Unreferenced definitions are ignored."
3505 collect-fn ; for byte-compiler.
3509 ;; Collect footnote number, label and definition in DATA.
3517 def)
3518 num-alist)
3519 ;; Also search in definition for nested footnotes.
3522 ;; Don't enter footnote definitions since it will happen
3523 ;; when their first reference is found.
3529 "Non-nil when a footnote reference is the first one for its label.
3531 FOOTNOTE-REFERENCE is the footnote reference being considered.
3532 INFO is the plist used as a communication channel."
3534 ;; Anonymous footnotes are always a first reference.
3536 ;; Otherwise, return the first footnote with the same LABEL and
3537 ;; test if it is equal to FOOTNOTE-REFERENCE.
3547 ;; If FN isn't inlined, be sure to traverse its
3548 ;; definition before resuming search. See
3549 ;; comments in `org-export-get-footnote-number'
3550 ;; for more information.
3554 ;; Don't enter footnote definitions since it will
3555 ;; happen when their first reference is found.
3558 footnote-reference)))))
3561 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3562 INFO is the plist used as a communication channel. If no such
3564 string."
3571 "Return number associated to a footnote.
3573 FOOTNOTE is either a footnote reference or a footnote definition.
3574 INFO is the plist used as a communication channel."
3576 seen-refs
3577 search-ref ; For byte-compiler.
3581 ;; Search footnote references through DATA, filling
3582 ;; SEEN-REFS along the way.
3587 ;; Anonymous footnote match: return number.
3590 ;; Labels match: return number.
3593 ;; Anonymous footnote: it's always a new one.
3594 ;; Also, be sure to return nil from the `cond' so
3595 ;; `first-match' doesn't get us out of the loop.
3597 ;; Label not seen so far: add it so SEEN-REFS.
3598 ;;
3599 ;; Also search for subsequent references in
3600 ;; footnote definition so numbering follows
3601 ;; reading logic. Note that we don't have to care
3602 ;; about inline definitions, since
3603 ;; `org-element-map' already traverses them at the
3604 ;; right time.
3605 ;;
3606 ;; Once again, return nil to stay in the loop.
3611 nil))))
3612 ;; Don't enter footnote definitions since it will
3613 ;; happen when their first reference is found.
3618 ;;;; For Headlines
3619 ;;
3620 ;; `org-export-get-relative-level' is a shortcut to get headline
3621 ;; level, relatively to the lower headline level in the parsed tree.
3622 ;;
3623 ;; `org-export-get-headline-number' returns the section number of an
3624 ;; headline, while `org-export-number-to-roman' allows to convert it
3625 ;; to roman numbers.
3626 ;;
3627 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3628 ;; `org-export-last-sibling-p' are three useful predicates when it
3629 ;; comes to fulfill the `:headline-levels' property.
3630 ;;
3631 ;; `org-export-get-tags', `org-export-get-category' and
3632 ;; `org-export-get-node-property' extract useful information from an
3633 ;; headline or a parent headline. They all handle inheritance.
3634 ;;
3635 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3636 ;; as a secondary string, suitable for table of contents. It falls
3637 ;; back onto default title.
3640 "Return HEADLINE relative level within current parsed tree.
3641 INFO is a plist holding contextual information."
3646 "Non-nil when HEADLINE is considered as low level.
3648 INFO is a plist used as a communication channel.
3650 A low level headlines has a relative level greater than
3651 `:headline-levels' property value.
3653 Return value is the difference between HEADLINE relative level
3654 and the last level being considered as high enough, or nil."
3661 "Return HEADLINE numbering as a list of numbers.
3662 INFO is a plist holding contextual information."
3666 "Return a non-nil value if HEADLINE element should be numbered.
3667 INFO is a plist used as a communication channel."
3673 "Convert integer N into a roman numeral."
3686 res)))
3689 "Return list of tags associated to ELEMENT.
3691 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3692 is a plist used as a communication channel.
3694 Select tags (see `org-export-select-tags') and exclude tags (see
3695 `org-export-exclude-tags') are removed from the list.
3697 When non-nil, optional argument TAGS should be a list of strings.
3698 Any tag belonging to this list will also be removed.
3700 When optional argument INHERITED is non-nil, tags can also be
3701 inherited from parent headlines and FILETAGS keywords."
3707 ;; Build complete list of inherited tags.
3718 ;; Add FILETAGS keywords and return results.
3722 "Return node PROPERTY value for BLOB.
3724 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3725 element or object.
3727 If optional argument INHERITED is non-nil, the value can be
3728 inherited from a parent headline.
3730 Return value is a string or nil."
3742 "Return category for element or object BLOB.
3744 INFO is a plist used as a communication channel.
3746 CATEGORY is automatically inherited from a parent headline, from
3747 #+CATEGORY: keyword or created out of original file name. If all
3751 ;; Almost like `org-export-node-property', but we cannot trust
3752 ;; `plist-member' as every headline has a `:CATEGORY'
3753 ;; property, would it be nil or equal to "???" (which has the
3754 ;; same meaning).
3772 "Return alternative title for HEADLINE, as a secondary string.
3773 INFO is a plist used as a communication channel. If no optional
3774 title is defined, fall-back to the regular title."
3779 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3780 INFO is a plist used as a communication channel."
3785 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3786 INFO is a plist used as a communication channel."
3790 ;;;; For Keywords
3791 ;;
3792 ;; `org-export-get-date' returns a date appropriate for the document
3793 ;; to about to be exported. In particular, it takes care of
3794 ;; `org-export-date-timestamp-format'.
3797 "Return date value for the current document.
3799 INFO is a plist used as a communication channel. FMT, when
3800 non-nil, is a time format string that will be applied on the date
3801 if it consists in a single timestamp object. It defaults to
3802 `org-export-date-timestamp-format' when nil.
3804 A proper date can be a secondary string, a string or nil. It is
3805 meant to be translated with `org-export-data' or alike."
3816 ;;;; For Links
3817 ;;
3818 ;; `org-export-solidify-link-text' turns a string into a safer version
3819 ;; for links, replacing most non-standard characters with hyphens.
3820 ;;
3821 ;; `org-export-get-coderef-format' returns an appropriate format
3822 ;; string for coderefs.
3823 ;;
3824 ;; `org-export-inline-image-p' returns a non-nil value when the link
3825 ;; provided should be considered as an inline image.
3826 ;;
3827 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3828 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3829 ;; returns an appropriate unique identifier when found, or nil.
3830 ;;
3831 ;; `org-export-resolve-id-link' returns the first headline with
3832 ;; specified id or custom-id in parse tree, the path to the external
3833 ;; file with the id or nil when neither was found.
3834 ;;
3835 ;; `org-export-resolve-coderef' associates a reference to a line
3836 ;; number in the element it belongs, or returns the reference itself
3837 ;; when the element isn't numbered.
3840 "Take link text S and make a safe target out of it."
3845 "Return format string for code reference link.
3846 PATH is the link path. DESC is its description."
3854 "Non-nil if LINK object points to an inline image.
3856 Optional argument is a set of RULES defining inline images. It
3857 is an alist where associations have the following shape:
3859 \(TYPE . REGEXP)
3861 Applying a rule means apply REGEXP against LINK's path when its
3862 type is TYPE. The function will return a non-nil value if any of
3863 the provided rules is non-nil. The default rule is
3864 `org-export-default-inline-image-rule'.
3866 This only applies to links without a description."
3877 rules)
3878 ;; Return nil if no rule matched.
3879 nil))))
3882 "Resolve a code reference REF.
3884 INFO is a plist used as a communication channel.
3886 Return associated line number in source code, or REF itself,
3887 depending on src-block or example element's switches."
3894 org-coderef-label-format)))
3898 ;; Element containing REF is found. Resolve it to either
3899 ;; a label or a line number, as needed.
3909 "Return LINK destination.
3911 INFO is a plist holding contextual information.
3913 Return value can be an object, an element, or nil:
3915 - If LINK path matches a target object (i.e. <<path>>) return it.
3917 - If LINK path exactly matches the name affiliated keyword
3918 \(i.e. #+NAME: path) of an element, return that element.
3920 - If LINK path exactly matches any headline name, return that
3921 element. If more than one headline share that name, priority
3922 will be given to the one with the closest common ancestor, if
3923 any, or the first one in the parse tree otherwise.
3925 - Otherwise, return nil.
3928 significant."
3931 ;; Split PATH at white spaces so matches are space
3932 ;; insensitive.
3936 ;; First try to find a matching "<<path>>" unless user specified
3937 ;; he was looking for a headline (path starts with a "*"
3938 ;; character).
3943 path)
3944 blob))
3945 info t)))
3946 ;; Then try to find an element with a matching "#+NAME: path"
3947 ;; affiliated keyword.
3950 org-element-all-elements
3955 ;; Last case: link either points to a headline or to nothingness.
3956 ;; Try to find the source, with priority given to headlines with
3957 ;; the closest common ancestor. If such candidate is found,
3958 ;; return it, otherwise return nil.
3962 ;; Return first headline whose `:raw-value' property is
3963 ;; NAME in parse tree DATA, or nil. Statistics cookies
3964 ;; are ignored.
3972 name)
3973 headline))
3975 ;; Search among headlines sharing an ancestor with link, from
3976 ;; closest to farthest.
3984 ;; No match with a common ancestor: try full parse-tree.
3988 "Return headline referenced as LINK destination.
3990 INFO is a plist used as a communication channel.
3992 Return value can be the headline element matched in current parse
3996 ;; First check if id is within the current parse tree.
4001 headline))
4003 ;; Otherwise, look for external files.
4007 "Return radio-target object referenced as LINK destination.
4009 INFO is a plist used as a communication channel.
4011 Return value can be a radio-target object or nil. Assume LINK
4018 radio))
4022 ;;;; For References
4023 ;;
4024 ;; `org-export-get-ordinal' associates a sequence number to any object
4025 ;; or element.
4028 "Return ordinal number of an element or object.
4030 ELEMENT is the element or object considered. INFO is the plist
4031 used as a communication channel.
4033 Optional argument TYPES, when non-nil, is a list of element or
4034 object types, as symbols, that should also be counted in.
4035 Otherwise, only provided element's type is considered.
4037 Optional argument PREDICATE is a function returning a non-nil
4038 value if the current element or object should be counted in. It
4039 accepts two arguments: the element or object being considered and
4040 the plist used as a communication channel. This allows to count
4041 only a certain type of objects (i.e. inline images).
4043 Return value is a list of numbers if ELEMENT is a headline or an
4044 item. It is nil for keywords. It represents the footnote number
4045 for footnote definitions and footnote references. If ELEMENT is
4046 a target, return the same value as if ELEMENT was the closest
4047 table, item or headline containing the target. In any other
4048 case, return the sequence number of ELEMENT among elements or
4049 objects of the same type."
4050 ;; Ordinal of a target object refer to the ordinal of the closest
4051 ;; table, item, or headline containing the object.
4055 when
4059 table))
4060 return parent)))
4062 ;; Special case 1: A headline returns its number as a list.
4064 ;; Special case 2: An item returns its number as a list.
4068 struct
4075 ;; Increment counter until ELEMENT is found again.
4086 ;;;; For Src-Blocks
4087 ;;
4088 ;; `org-export-get-loc' counts number of code lines accumulated in
4089 ;; src-block or example-block elements with a "+n" switch until
4090 ;; a given element, excluded. Note: "-n" switches reset that count.
4091 ;;
4092 ;; `org-export-unravel-code' extracts source code (along with a code
4093 ;; references alist) from an `element-block' or `src-block' type
4094 ;; element.
4095 ;;
4096 ;; `org-export-format-code' applies a formatting function to each line
4097 ;; of code, providing relative line number and code reference when
4098 ;; appropriate. Since it doesn't access the original element from
4099 ;; which the source code is coming, it expects from the code calling
4100 ;; it to know if lines should be numbered and if code references
4101 ;; should appear.
4102 ;;
4103 ;; Eventually, `org-export-format-code-default' is a higher-level
4104 ;; function (it makes use of the two previous functions) which handles
4105 ;; line numbering and code references inclusion, and returns source
4106 ;; code in a format suitable for plain text or verbatim output.
4109 "Return accumulated lines of code up to ELEMENT.
4111 INFO is the plist used as a communication channel.
4113 ELEMENT is excluded from count."
4119 ;; ELEMENT is reached: Quit the loop.
4121 ;; Only count lines from src-block and example-block elements
4122 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4126 ;; Accumulate locs or reset them.
4130 ;; Return nil to stay in the loop.
4131 nil)))
4133 ;; Return value.
4134 loc))
4137 "Clean source code and extract references out of it.
4139 ELEMENT has either a `src-block' an `example-block' type.
4141 Return a cons cell whose CAR is the source code, cleaned from any
4142 reference and protective comma and CDR is an alist between
4143 relative line number (integer) and name of code reference on that
4144 line (string)."
4146 ;; Get code and clean it. Remove blank lines at its
4147 ;; beginning and end.
4153 ;; If appropriate, remove global indentation.
4156 c
4158 ;; Get format used for references.
4161 org-coderef-label-format)))
4162 ;; Build a regexp matching a loc with a reference.
4167 ;; Return value.
4169 ;; Code with references removed.
4175 ;; Ref line: remove ref, and signal its position in REFS.
4179 ;; Reference alist.
4180 refs)))
4183 "Format CODE by applying FUN line-wise and return it.
4185 CODE is a string representing the code to format. FUN is
4186 a function. It must accept three arguments: a line of
4187 code (string), the current line number (integer) or nil and the
4188 reference associated to the current line (string) or nil.
4190 Optional argument NUM-LINES can be an integer representing the
4191 number of code lines accumulated until the current code. Line
4192 numbers passed to FUN will take it into account. If it is nil,
4193 FUN's second argument will always be nil. This number can be
4194 obtained with `org-export-get-loc' function.
4196 Optional argument REF-ALIST can be an alist between relative line
4197 number (i.e. ignoring NUM-LINES) and the name of the code
4198 reference on it. If it is nil, FUN's third argument will always
4199 be nil. It can be obtained through the use of
4200 `org-export-unravel-code' function."
4212 "Return source code from ELEMENT, formatted in a standard way.
4214 ELEMENT is either a `src-block' or `example-block' element. INFO
4215 is a plist used as a communication channel.
4217 This function takes care of line numbering and code references
4218 inclusion. Line numbers, when applicable, appear at the
4219 beginning of the line, separated from the code by two white
4220 spaces. Code references, on the other hand, appear flushed to
4221 the right, separated by six white spaces from the widest line of
4222 code."
4223 ;; Extract code and references.
4230 ;; Handle line numbering.
4239 ;; Prepare references display, if required. Any reference
4240 ;; should start six columns after the widest line of code,
4241 ;; wrapped with parenthesis.
4246 code
4250 number-str
4251 loc
4257 num-start refs)))))
4260 ;;;; For Tables
4261 ;;
4262 ;; `org-export-table-has-special-column-p' and and
4263 ;; `org-export-table-row-is-special-p' are predicates used to look for
4264 ;; meta-information about the table structure.
4265 ;;
4266 ;; `org-table-has-header-p' tells when the rows before the first rule
4267 ;; should be considered as table's header.
4268 ;;
4269 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4270 ;; and `org-export-table-cell-borders' extract information from
4271 ;; a table-cell element.
4272 ;;
4273 ;; `org-export-table-dimensions' gives the number on rows and columns
4274 ;; in the table, ignoring horizontal rules and special columns.
4275 ;; `org-export-table-cell-address', given a table-cell object, returns
4276 ;; the absolute address of a cell. On the other hand,
4277 ;; `org-export-get-table-cell-at' does the contrary.
4278 ;;
4279 ;; `org-export-table-cell-starts-colgroup-p',
4280 ;; `org-export-table-cell-ends-colgroup-p',
4281 ;; `org-export-table-row-starts-rowgroup-p',
4282 ;; `org-export-table-row-ends-rowgroup-p',
4283 ;; `org-export-table-row-starts-header-p' and
4284 ;; `org-export-table-row-ends-header-p' indicate position of current
4285 ;; row or cell within the table.
4288 "Non-nil when TABLE has a special column.
4289 All special columns will be ignored during export."
4290 ;; The table has a special column when every first cell of every row
4291 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4292 ;; "*" "_" and "^". Though, do not consider a first row containing
4293 ;; only empty cells as special.
4309 "Non-nil when TABLE has an header.
4311 INFO is a plist used as a communication channel.
4313 A table has an header when it contains at least two row groups."
4323 info)))
4326 "Non-nil if TABLE-ROW is considered special.
4328 INFO is a plist used as the communication channel.
4330 All special rows will be ignored during export."
4334 ;; A row is special either when...
4336 ;; ... it starts with a field only containing "/",
4338 ;; ... the table contains a special column and the row start
4339 ;; with a marking character among, "^", "_", "$" or "!",
4343 ;; ... it contains only alignment cookies and empty cells.
4349 ;; Since VALUE is a secondary string, the following
4350 ;; checks avoid expanding it with `org-export-data'.
4362 "Return TABLE-ROW's group.
4364 INFO is a plist used as the communication channel.
4366 Return value is the group number, as an integer, or nil special
4367 rows and table rules. Group 1 is also table's header."
4384 "Return TABLE-CELL contents width.
4386 INFO is a plist used as the communication channel.
4388 Return value is the width given by the last width cookie in the
4389 same column as TABLE-CELL, or nil."
4394 cookie-width)
4398 ;; In a special row, try to find a width cookie at COLUMN.
4402 ;; The following checks avoid expanding unnecessarily the
4403 ;; cell with `org-export-data'
4411 ;; Ignore table rules.
4414 ;; Return value.
4415 cookie-width))
4418 "Return TABLE-CELL contents alignment.
4420 INFO is a plist used as the communication channel.
4422 Return alignment as specified by the last alignment cookie in the
4423 same column as TABLE-CELL. If no such cookie is found, a default
4424 alignment value will be deduced from fraction of numbers in the
4425 column (see `org-table-number-fraction' for more information).
4426 Possible values are `left', `right' and `center'."
4433 cookie-align
4434 previous-cell-number-p)
4438 ;; In a special row, try to find an alignment cookie at
4439 ;; COLUMN.
4443 ;; Since VALUE is a secondary string, the following checks
4444 ;; avoid useless expansion through `org-export-data'.
4452 ;; Ignore table rules.
4454 ;; In a standard row, check if cell's contents are expressing
4455 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4456 ;; Though, don't bother if an alignment cookie has already
4457 ;; defined cell's alignment.
4462 info)))
4464 ;; Treat an empty cell as a number if it follows a number
4471 ;; Return value. Alignment specified by cookies has precedence
4472 ;; over alignment deduced from cells contents.
4481 "Return TABLE-CELL borders.
4483 INFO is a plist used as a communication channel.
4485 Return value is a list of symbols, or nil. Possible values are:
4486 `top', `bottom', `above', `below', `left' and `right'. Note:
4487 `top' (resp. `bottom') only happen for a cell in the first
4488 row (resp. last row) of the table, ignoring table rules, if any.
4490 Returned borders ignore special rows."
4493 borders)
4494 ;; Top/above border? TABLE-CELL has a border above when a rule
4495 ;; used to demarcate row groups can be found above. Hence,
4496 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4497 ;; another regular row has to be found above that rule.
4506 ;; Look at every row before the current one.
4508 ;; No rule above, or rule found starts the table (ignoring any
4509 ;; special row): TABLE-CELL is at the top of the table.
4512 ;; Bottom/below border? TABLE-CELL has a border below when next
4513 ;; non-regular row below is a rule.
4522 ;; Look at every row after the current one.
4524 ;; No rule below, or rule found ends the table (modulo some
4525 ;; special row): TABLE-CELL is at the bottom of the table.
4528 ;; Right/left borders? They can only be specified by column
4529 ;; groups. Column groups are defined in a row starting with "/".
4530 ;; Also a column groups row only contains "<", "<>", ">" or blank
4531 ;; cells.
4548 ;; There's a left border when previous cell, if
4549 ;; any, ends a group, or current one starts one.
4555 ;; There's a right border when next cell, if any,
4556 ;; starts a group, or current one ends one.
4563 ;; Table rows are read in reverse order so last column groups
4564 ;; row has precedence over any previous one.
4566 ;; Return value.
4567 borders))
4570 "Non-nil when TABLE-CELL is at the beginning of a row group.
4571 INFO is a plist used as a communication channel."
4572 ;; A cell starts a column group either when it is at the beginning
4573 ;; of a row (or after the special column, if any) or when it has
4574 ;; a left border.
4577 table-cell)
4581 "Non-nil when TABLE-CELL is at the end of a row group.
4582 INFO is a plist used as a communication channel."
4583 ;; A cell ends a column group either when it is at the end of a row
4584 ;; or when it has a right border.
4587 table-cell)
4591 "Non-nil when TABLE-ROW is at the beginning of a column group.
4592 INFO is a plist used as a communication channel."
4600 "Non-nil when TABLE-ROW is at the end of a column group.
4601 INFO is a plist used as a communication channel."
4609 "Non-nil when TABLE-ROW is the first table header's row.
4610 INFO is a plist used as a communication channel."
4617 "Non-nil when TABLE-ROW is the last table header's row.
4618 INFO is a plist used as a communication channel."
4625 "Return TABLE dimensions.
4627 INFO is a plist used as a communication channel.
4629 Return value is a CONS like (ROWS . COLUMNS) where
4630 ROWS (resp. COLUMNS) is the number of exportable
4631 rows (resp. columns)."
4633 ;; Set number of rows, and extract first one.
4639 ;; Set number of columns.
4641 ;; Return value.
4645 "Return address of a regular TABLE-CELL object.
4647 TABLE-CELL is the cell considered. INFO is a plist used as
4648 a communication channel.
4650 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4651 zero-based index. Only exportable cells are considered. The
4652 function returns nil for other cells."
4655 ;; Ignore cells in special rows or in special column.
4660 ;; Row number.
4668 ;; Column number.
4676 "Return regular table-cell object at ADDRESS in TABLE.
4678 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4679 zero-based index. TABLE is a table type element. INFO is
4680 a plist used as a communication channel.
4682 If no table-cell, among exportable cells, is found at ADDRESS,
4683 return nil."
4686 ;; Row at (car address) or nil.
4694 'table-cell
4701 ;;;; For Tables Of Contents
4702 ;;
4703 ;; `org-export-collect-headlines' builds a list of all exportable
4704 ;; headline elements, maybe limited to a certain depth. One can then
4705 ;; easily parse it and transcode it.
4706 ;;
4707 ;; Building lists of tables, figures or listings is quite similar.
4708 ;; Once the generic function `org-export-collect-elements' is defined,
4709 ;; `org-export-collect-tables', `org-export-collect-figures' and
4710 ;; `org-export-collect-listings' can be derived from it.
4713 "Collect headlines in order to build a table of contents.
4715 INFO is a plist used as a communication channel.
4717 When optional argument N is an integer, it specifies the depth of
4718 the table of contents. Otherwise, it is set to the value of the
4719 last headline level. See `org-export-headline-levels' for more
4720 information.
4722 Return a list of all exportable headlines as parsed elements.
4723 Footnote sections, if any, will be ignored."
4728 ;; Strip contents from HEADLINE.
4731 info))
4734 "Collect referenceable elements of a determined type.
4736 TYPE can be a symbol or a list of symbols specifying element
4737 types to search. Only elements with a caption are collected.
4739 INFO is a plist used as a communication channel.
4741 When non-nil, optional argument PREDICATE is a function accepting
4742 one argument, an element of type TYPE. It returns a non-nil
4743 value when that element should be collected.
4745 Return a list of all elements found, in order of appearance."
4750 element))
4751 info))
4754 "Build a list of tables.
4755 INFO is a plist used as a communication channel.
4757 Return a list of table elements with a caption."
4761 "Build a list of figures.
4763 INFO is a plist used as a communication channel. PREDICATE is
4764 a function which accepts one argument: a paragraph element and
4765 whose return value is non-nil when that element should be
4766 collected.
4768 A figure is a paragraph type element, with a caption, verifying
4770 a vague concept that may depend on back-end.
4772 Return a list of elements recognized as figures."
4776 "Build a list of src blocks.
4778 INFO is a plist used as a communication channel.
4780 Return a list of src-block elements with a caption."
4784 ;;;; Smart Quotes
4785 ;;
4786 ;; The main function for the smart quotes sub-system is
4787 ;; `org-export-activate-smart-quotes', which replaces every quote in
4788 ;; a given string from the parse tree with its "smart" counterpart.
4789 ;;
4790 ;; Dictionary for smart quotes is stored in
4791 ;; `org-export-smart-quotes-alist'.
4792 ;;
4793 ;; Internally, regexps matching potential smart quotes (checks at
4794 ;; string boundaries are also necessary) are defined in
4795 ;; `org-export-smart-quotes-regexps'.
4832 "Smart quotes translations.
4834 Alist whose CAR is a language string and CDR is an alist with
4835 quote type as key and a plist associating various encodings to
4836 their translation as value.
4838 A quote type can be any symbol among `opening-double-quote',
4839 `closing-double-quote', `opening-single-quote',
4840 `closing-single-quote' and `apostrophe'.
4842 Valid encodings include `:utf-8', `:html', `:latex' and
4843 `:texinfo'.
4849 ;; Possible opening quote at beginning of string.
4851 ;; Possible closing quote at beginning of string.
4853 ;; Possible apostrophe at beginning of string.
4855 ;; Opening single and double quotes.
4857 ;; Closing single and double quotes.
4859 ;; Apostrophe.
4861 ;; Possible opening quote at end of string.
4863 ;; Possible closing quote at end of string.
4865 ;; Possible apostrophe at end of string.
4867 "List of regexps matching a quote or an apostrophe.
4873 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4874 `:utf-8'. INFO is a plist used as a communication channel.
4876 The function has to retrieve information about string
4877 surroundings in parse tree. It can only happen with an
4878 unmodified string. Thus, if S has already been through another
4879 process, a non-nil ORIGINAL optional argument will provide that
4880 original string.
4882 Return the new string."
4885 ;; Try to be flexible when computing number of blanks
4886 ;; before object. The previous object may be a string
4887 ;; introduced by the back-end and not completely parsed.
4890 ;; A string with missing `:post-blank'
4891 ;; property.
4895 ;; Fallback value.
4900 ;; Return smart quote associated to a give quote Q, as
4901 ;; a string. TYPE is a symbol among `open', `close' and
4902 ;; `apostrophe'.
4912 org-export-smart-quotes-alist))))
4913 encoding)
4914 q)))))
4916 ;; Only a quote: no regexp can match. We have to check both
4917 ;; sides and decide what to do.
4925 ;; 1. Replace quote character at the beginning of S.
4927 ;; Apostrophe?
4933 ;; Closing quote?
4939 ;; Opening quote?
4945 ;; 2. Replace quotes in the middle of the string.
4947 ;; Opening quotes.
4953 ;; Closing quotes.
4959 ;; Apostrophes.
4964 ;; 3. Replace quote character at the end of S.
4966 ;; Apostrophe?
4971 ;; Closing quote?
4977 ;; Opening quote?
4982 ;; Return string with smart quotes.
4983 s))))
4985 ;;;; Topology
4986 ;;
4987 ;; Here are various functions to retrieve information about the
4988 ;; neighbourhood of a given element or object. Neighbours of interest
4989 ;; are direct parent (`org-export-get-parent'), parent headline
4990 ;; (`org-export-get-parent-headline'), first element containing an
4991 ;; object, (`org-export-get-parent-element'), parent table
4992 ;; (`org-export-get-parent-table'), previous element or object
4993 ;; (`org-export-get-previous-element') and next element or object
4994 ;; (`org-export-get-next-element').
4995 ;;
4996 ;; `org-export-get-genealogy' returns the full genealogy of a given
4997 ;; element or object, from closest parent to full parse tree.
5000 "Return BLOB parent or nil.
5001 BLOB is the element or object considered."
5005 "Return full genealogy relative to a given element or object.
5007 BLOB is the element or object being considered.
5009 Ancestors are returned from closest to farthest, the last one
5010 being the full parse tree."
5017 "Return BLOB parent headline or nil.
5018 BLOB is the element or object being considered."
5022 parent))
5025 "Return first element containing OBJECT or nil.
5026 OBJECT is the object to consider."
5030 parent))
5033 "Return OBJECT parent table or nil.
5034 OBJECT is either a `table-cell' or `table-element' type object."
5038 parent))
5041 "Return previous element or object.
5043 BLOB is an element or object. INFO is a plist used as
5044 a communication channel. Return previous exportable element or
5045 object, a string, or nil.
5047 When optional argument N is a positive integer, return a list
5048 containing up to N siblings before BLOB, from farthest to
5049 closest. With any other non-nil value, return a list containing
5050 all of them."
5052 ;; An object can belong to the contents of its parent or
5053 ;; to a secondary string. We check the latter option
5054 ;; first.
5057 org-element-all-elements))
5061 org-element-secondary-value-alist))
5062 parent)))
5065 prev)
5074 prev)))
5077 "Return next element or object.
5079 BLOB is an element or object. INFO is a plist used as
5080 a communication channel. Return next exportable element or
5081 object, a string, or nil.
5083 When optional argument N is a positive integer, return a list
5084 containing up to N siblings after BLOB, from closest to farthest.
5085 With any other non-nil value, return a list containing all of
5086 them."
5088 ;; An object can belong to the contents of its parent or to
5089 ;; a secondary string. We check the latter option first.
5092 org-element-all-objects))
5096 org-element-secondary-value-alist))
5097 parent)))
5100 next)
5108 siblings)
5112 ;;;; Translation
5113 ;;
5114 ;; `org-export-translate' translates a string according to language
5115 ;; specified by LANGUAGE keyword or `org-export-language-setup'
5116 ;; variable and a specified charset. `org-export-dictionary' contains
5117 ;; the dictionary used for the translation.
5239 "Dictionary for export engine.
5241 Alist whose CAR is the string to translate and CDR is an alist
5242 whose CAR is the language string and CDR is a plist whose
5243 properties are possible charsets and values translated terms.
5245 It is used as a database for `org-export-translate'. Since this
5246 function returns the string as-is if no translation was found,
5247 the variable only needs to record values different from the
5251 "Translate string S according to language specification.
5253 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5254 and `:utf-8'. INFO is a plist used as a communication channel.
5256 Translation depends on `:language' property. Return the
5257 translated string. If no translation is found, try to fall back
5258 to `:default' encoding. If it fails, return S."
5264 s)))
5267 \f
5268 ;;; Asynchronous Export
5269 ;;
5270 ;; `org-export-async-start' is the entry point for asynchronous
5271 ;; export. It recreates current buffer (including visibility,
5272 ;; narrowing and visited file) in an external Emacs process, and
5273 ;; evaluates a command there. It then applies a function on the
5274 ;; returned results in the current process.
5275 ;;
5276 ;; Asynchronously generated results are never displayed directly.
5277 ;; Instead, they are stored in `org-export-stack-contents'. They can
5278 ;; then be retrieved by calling `org-export-stack'.
5279 ;;
5280 ;; Export Stack is viewed through a dedicated major mode
5281 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5282 ;;`org-export-stack-delete', `org-export-stack-view' and
5283 ;;`org-export-stack-clear'.
5284 ;;
5285 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5286 ;; It should used whenever `org-export-async-start' is called.
5289 "Call function FUN on the results returned by BODY evaluation.
5291 BODY evaluation happens in an asynchronous process, from a buffer
5292 which is an exact copy of the current one.
5294 Use `org-export-add-to-stack' in FUN in order to register results
5295 in the stack. Examples for, respectively a temporary buffer and
5296 a file are:
5298 \(org-export-async-start
5299 \(lambda (output)
5301 \(erase-buffer)
5302 \(insert output)
5303 \(goto-char (point-min))
5304 \(org-export-add-to-stack (current-buffer) 'backend)))
5305 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5307 and
5309 \(org-export-async-start
5310 \(lambda (f) (org-export-add-to-stack f 'backend))
5311 `(expand-file-name
5312 \(org-export-to-file
5313 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5316 ;; Write the full sexp evaluating BODY in a copy of the current
5317 ;; buffer to a temporary file, as it may be too long for program
5318 ;; args in `start-process'.
5325 ;; Null characters (from variable values) are inserted
5326 ;; within the file. As a consequence, coding system for
5327 ;; buffer contents will not be recognized properly. So,
5328 ;; we make sure it is the same as the one used to display
5329 ;; the original buffer.
5331 ,coding
5334 ;; Ignore `kill-emacs-hook' and code evaluation
5335 ;; queries from Babel as we need a truly
5336 ;; non-interactive process.
5338 org-babel-confirm-evaluate-answer-no t)
5339 ;; Initialize export framework.
5341 ;; Re-create current buffer there.
5344 ;; Sexp to evaluate in the buffer.
5346 ;; Start external process.
5349 (,process
5354 "-l" org-export-async-init-file
5356 ;; Register running process in stack.
5358 ;; Set-up sentinel in order to catch results.
5360 ,process
5384 "Add a new result to export stack if not present already.
5386 SOURCE is a buffer or a file name containing export results.
5387 BACKEND is a symbol representing export back-end used to generate
5388 it.
5390 Entries already pointing to SOURCE and unavailable entries are
5391 removed beforehand. Return the new stack."
5397 "Menu for asynchronous export results and running processes."
5407 "Return source from export results at point in stack."
5414 source
5415 ;; SOURCE is not consistent with current line. The stack
5416 ;; view is outdated.
5420 "Remove all entries from export stack."
5425 "Refresh the asynchronous export stack.
5426 DUMMY is ignored. Unavailable sources are removed from the list.
5427 Return the new stack."
5437 ;; Back-end.
5439 ;; Age.
5442 ;; Compute age of the results.
5444 "%4h:%.2m "
5446 ;; Source.
5451 ;; Clear stack from exited processes, dead buffers or
5452 ;; non-existent files.
5464 "Remove export results at point from stack.
5465 If optional argument SOURCE is non-nil, remove it instead."
5470 org-export-stack-contents))))
5473 "View export results at point in stack.
5474 With an optional prefix argument IN-EMACS, force viewing files
5475 within Emacs."
5489 (define-key km "p" 'previous-line)
5490 (define-key km "\C-p" 'previous-line)
5491 (define-key km "\C-?" 'previous-line)
5492 (define-key km [up] 'previous-line)
5493 (define-key km "C" 'org-export-stack-clear)
5494 (define-key km "v" 'org-export-stack-view)
5495 (define-key km (kbd "RET") 'org-export-stack-view)
5496 (define-key km "d" 'org-export-stack-remove)
5497 km)
5498 "Keymap for Org Export Stack.")
5500 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5501 "Mode for displaying asynchronous export stack.
5504 stack.
5506 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5507 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5508 stack completely.
5510 Removing entries in an Org Export Stack buffer doesn't affect
5511 files or buffers, only the display.
5514 (abbrev-mode 0)
5515 (auto-fill-mode 0)
5516 (setq buffer-read-only t
5517 buffer-undo-list t
5518 truncate-lines t
5519 header-line-format
5520 '(:eval
5521 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5522 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5523 (set (make-local-variable 'revert-buffer-function)
5524 'org-export-stack-refresh))
5527 \f
5528 ;;; The Dispatcher
5529 ;;
5530 ;; `org-export-dispatch' is the standard interactive way to start an
5531 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5532 ;; for its interface, which, in turn, delegates response to key
5533 ;; pressed to `org-export--dispatch-action'.
5535 ;;;###autoload
5536 (defun org-export-dispatch (&optional arg)
5537 "Export dispatcher for Org mode.
5539 It provides an access to common export related tasks in a buffer.
5540 Its interface comes in two flavours: standard and expert.
5542 While both share the same set of bindings, only the former
5543 displays the valid keys associations in a dedicated buffer.
5544 Scrolling (resp. line-wise motion) in this buffer is done with
5545 SPC and DEL (resp. C-n and C-p) keys.
5547 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5548 flavour or the other.
5551 of options used back then, on the current buffer.
5553 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5554 (interactive "P")
5555 (let* ((input
5556 (cond ((equal arg '(16)) '(stack))
5557 ((and arg org-export-dispatch-last-action))
5558 (t (save-window-excursion
5559 (unwind-protect
5560 (progn
5561 ;; Remember where we are
5562 (move-marker org-export-dispatch-last-position
5563 (point)
5564 (org-base-buffer (current-buffer)))
5565 ;; Get and store an export command
5566 (setq org-export-dispatch-last-action
5567 (org-export--dispatch-ui
5568 (list org-export-initial-scope
5569 (and org-export-in-background 'async))
5570 nil
5571 org-export-dispatch-use-expert-ui)))
5572 (and (get-buffer "*Org Export Dispatcher*")
5573 (kill-buffer "*Org Export Dispatcher*")))))))
5574 (action (car input))
5575 (optns (cdr input)))
5576 (unless (memq 'subtree optns)
5577 (move-marker org-export-dispatch-last-position nil))
5578 (case action
5579 ;; First handle special hard-coded actions.
5580 (template (org-export-insert-default-template nil optns))
5581 (stack (org-export-stack))
5582 (publish-current-file
5583 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5584 (publish-current-project
5585 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5586 (publish-choose-project
5587 (org-publish (assoc (org-icompleting-read
5588 "Publish project: "
5589 org-publish-project-alist nil t)
5590 org-publish-project-alist)
5591 (memq 'force optns)
5592 (memq 'async optns)))
5593 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5594 (otherwise
5595 (save-excursion
5596 (when arg
5597 ;; Repeating command, maybe move cursor to restore subtree
5598 ;; context.
5599 (if (eq (marker-buffer org-export-dispatch-last-position)
5600 (org-base-buffer (current-buffer)))
5601 (goto-char org-export-dispatch-last-position)
5602 ;; We are in a different buffer, forget position.
5603 (move-marker org-export-dispatch-last-position nil)))
5604 (funcall action
5605 ;; Return a symbol instead of a list to ease
5606 ;; asynchronous export macro use.
5607 (and (memq 'async optns) t)
5608 (and (memq 'subtree optns) t)
5609 (and (memq 'visible optns) t)
5610 (and (memq 'body optns) t)))))))
5612 (defun org-export--dispatch-ui (options first-key expertp)
5613 "Handle interface for `org-export-dispatch'.
5615 OPTIONS is a list containing current interactive options set for
5616 export. It can contain any of the following symbols:
5617 `body' toggles a body-only export
5618 `subtree' restricts export to current subtree
5619 `visible' restricts export to visible part of buffer.
5620 `force' force publishing files.
5621 `async' use asynchronous export process
5623 FIRST-KEY is the key pressed to select the first level menu. It
5624 is nil when this menu hasn't been selected yet.
5626 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5627 buffer is provided, but indications about currently active
5628 options are given in the prompt. Moreover, \[?] allows to switch
5629 back to standard interface."
5630 (let* ((fontify-key
5631 (lambda (key &optional access-key)
5632 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5633 ;; non-nil is the required first-level key to activate
5634 ;; KEY. When its value is t, activate KEY independently
5635 ;; on the first key, if any. A nil value means KEY will
5636 ;; only be activated at first level.
5637 (if (or (eq access-key t) (eq access-key first-key))
5638 (org-propertize key 'face 'org-warning)
5639 key)))
5640 (fontify-value
5641 (lambda (value)
5642 ;; Fontify VALUE string.
5643 (org-propertize value 'face 'font-lock-variable-name-face)))
5644 ;; Prepare menu entries by extracting them from
5645 ;; `org-export-registered-backends', and sorting them by
5646 ;; access key and by ordinal, if any.
5647 (backends
5648 (sort
5649 (sort
5650 (delq nil
5651 (mapcar
5652 (lambda (b)
5653 (let ((name (car b)))
5654 (catch 'ignored
5655 ;; Ignore any back-end belonging to
5656 ;; `org-export-invisible-backends' or derived
5657 ;; from one of them.
5658 (dolist (ignored org-export-invisible-backends)
5659 (when (org-export-derived-backend-p name ignored)
5660 (throw 'ignored nil)))
5661 (org-export-backend-menu name))))
5662 org-export-registered-backends))
5663 (lambda (a b)
5664 (let ((key-a (nth 1 a))
5665 (key-b (nth 1 b)))
5666 (cond ((and (numberp key-a) (numberp key-b))
5667 (< key-a key-b))
5668 ((numberp key-b) t)))))
5669 (lambda (a b) (< (car a) (car b)))))
5670 ;; Compute a list of allowed keys based on the first key
5671 ;; pressed, if any. Some keys
5672 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
5673 ;; available.
5674 (allowed-keys
5675 (nconc (list 2 22 19 6 1)
5676 (if (not first-key) (org-uniquify (mapcar 'car backends))
5677 (let (sub-menu)
5678 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5679 (when (eq (car backend) first-key)
5680 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5681 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5682 ((not first-key) (list ?P)))
5683 (list ?& ?#)
5684 (when expertp (list ??))
5685 (list ?q)))
5686 ;; Build the help menu for standard UI.
5687 (help
5688 (unless expertp
5689 (concat
5690 ;; Options are hard-coded.
5691 (format "[%s] Body only: %s [%s] Visible only: %s
5692 \[%s] Export scope: %s [%s] Force publishing: %s
5694 (funcall fontify-key "C-b" t)
5695 (funcall fontify-value
5696 (if (memq 'body options) "On " "Off"))
5697 (funcall fontify-key "C-v" t)
5698 (funcall fontify-value
5699 (if (memq 'visible options) "On " "Off"))
5700 (funcall fontify-key "C-s" t)
5701 (funcall fontify-value
5702 (if (memq 'subtree options) "Subtree" "Buffer "))
5703 (funcall fontify-key "C-f" t)
5704 (funcall fontify-value
5705 (if (memq 'force options) "On " "Off"))
5706 (funcall fontify-key "C-a" t)
5707 (funcall fontify-value
5708 (if (memq 'async options) "On " "Off")))
5709 ;; Display registered back-end entries. When a key
5710 ;; appears for the second time, do not create another
5711 ;; entry, but append its sub-menu to existing menu.
5712 (let (last-key)
5713 (mapconcat
5714 (lambda (entry)
5715 (let ((top-key (car entry)))
5716 (concat
5717 (unless (eq top-key last-key)
5718 (setq last-key top-key)
5720 (funcall fontify-key (char-to-string top-key))
5721 (nth 1 entry)))
5722 (let ((sub-menu (nth 2 entry)))
5723 (unless (functionp sub-menu)
5724 ;; Split sub-menu into two columns.
5725 (let ((index -1))
5726 (concat
5727 (mapconcat
5728 (lambda (sub-entry)
5729 (incf index)
5730 (format
5731 (if (zerop (mod index 2)) " [%s] %-26s"
5733 (funcall fontify-key
5734 (char-to-string (car sub-entry))
5735 top-key)
5736 (nth 1 sub-entry)))
5737 sub-menu "")
5739 backends ""))
5740 ;; Publishing menu is hard-coded.
5742 [%s] Current file [%s] Current project
5744 (funcall fontify-key "P")
5745 (funcall fontify-key "f" ?P)
5746 (funcall fontify-key "p" ?P)
5747 (funcall fontify-key "x" ?P)
5748 (funcall fontify-key "a" ?P))
5750 (funcall fontify-key "&" t)
5751 (funcall fontify-key "#" t))
5752 (format "[%s] %s"
5753 (funcall fontify-key "q" t)
5754 (if first-key "Main menu" "Exit")))))
5755 ;; Build prompts for both standard and expert UI.
5756 (standard-prompt (unless expertp "Export command: "))
5757 (expert-prompt
5758 (when expertp
5759 (format
5760 "Export command (C-%s%s%s%s%s) [%s]: "
5761 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5762 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5763 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5764 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5765 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5766 (mapconcat (lambda (k)
5767 ;; Strip control characters.
5768 (unless (< k 27) (char-to-string k)))
5769 allowed-keys "")))))
5770 ;; With expert UI, just read key with a fancy prompt. In standard
5771 ;; UI, display an intrusive help buffer.
5772 (if expertp
5773 (org-export--dispatch-action
5774 expert-prompt allowed-keys backends options first-key expertp)
5775 ;; At first call, create frame layout in order to display menu.
5776 (unless (get-buffer "*Org Export Dispatcher*")
5777 (delete-other-windows)
5778 (org-switch-to-buffer-other-window
5779 (get-buffer-create "*Org Export Dispatcher*"))
5780 (setq cursor-type nil
5781 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
5782 ;; Make sure that invisible cursor will not highlight square
5783 ;; brackets.
5784 (set-syntax-table (copy-syntax-table))
5785 (modify-syntax-entry ?\[ "w"))
5786 ;; At this point, the buffer containing the menu exists and is
5787 ;; visible in the current window. So, refresh it.
5788 (with-current-buffer "*Org Export Dispatcher*"
5789 ;; Refresh help. Maintain display continuity by re-visiting
5790 ;; previous window position.
5791 (let ((pos (window-start)))
5792 (erase-buffer)
5793 (insert help)
5794 (set-window-start nil pos)))
5795 (org-fit-window-to-buffer)
5796 (org-export--dispatch-action
5797 standard-prompt allowed-keys backends options first-key expertp))))
5799 (defun org-export--dispatch-action
5800 (prompt allowed-keys backends options first-key expertp)
5801 "Read a character from command input and act accordingly.
5803 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5804 a list of characters available at a given step in the process.
5805 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5806 EXPERTP are the same as defined in `org-export--dispatch-ui',
5807 which see.
5809 Toggle export options when required. Otherwise, return value is
5810 a list with action as CAR and a list of interactive export
5811 options as CDR."
5812 (let (key)
5813 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
5814 ;; C-p, SPC, DEL).
5815 (while (and (setq key (read-char-exclusive prompt))
5816 (not expertp)
5817 (memq key '(14 16 ?\s ?\d)))
5818 (case key
5819 (14 (if (not (pos-visible-in-window-p (point-max)))
5820 (ignore-errors (scroll-up-line))
5821 (message "End of buffer")
5822 (sit-for 1)))
5823 (16 (if (not (pos-visible-in-window-p (point-min)))
5824 (ignore-errors (scroll-down-line))
5825 (message "Beginning of buffer")
5826 (sit-for 1)))
5827 (?\s (if (not (pos-visible-in-window-p (point-max)))
5828 (scroll-up nil)
5829 (message "End of buffer")
5830 (sit-for 1)))
5831 (?\d (if (not (pos-visible-in-window-p (point-min)))
5832 (scroll-down nil)
5833 (message "Beginning of buffer")
5834 (sit-for 1)))))
5835 (cond
5836 ;; Ignore undefined associations.
5837 ((not (memq key allowed-keys))
5838 (ding)
5839 (unless expertp (message "Invalid key") (sit-for 1))
5840 (org-export--dispatch-ui options first-key expertp))
5841 ;; q key at first level aborts export. At second level, cancel
5842 ;; first key instead.
5843 ((eq key ?q) (if (not first-key) (error "Export aborted")
5844 (org-export--dispatch-ui options nil expertp)))
5845 ;; Help key: Switch back to standard interface if expert UI was
5846 ;; active.
5847 ((eq key ??) (org-export--dispatch-ui options first-key nil))
5848 ;; Send request for template insertion along with export scope.
5849 ((eq key ?#) (cons 'template (memq 'subtree options)))
5850 ;; Switch to asynchronous export stack.
5851 ((eq key ?&) '(stack))
5852 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
5853 ((memq key '(2 22 19 6 1))
5854 (org-export--dispatch-ui
5855 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
5856 (6 'force) (1 'async))))
5857 (if (memq option options) (remq option options)
5858 (cons option options)))
5859 first-key expertp))
5860 ;; Action selected: Send key and options back to
5861 ;; `org-export-dispatch'.
5862 ((or first-key (functionp (nth 2 (assq key backends))))
5863 (cons (cond
5864 ((not first-key) (nth 2 (assq key backends)))
5865 ;; Publishing actions are hard-coded. Send a special
5866 ;; signal to `org-export-dispatch'.
5867 ((eq first-key ?P)
5868 (case key
5869 (?f 'publish-current-file)
5870 (?p 'publish-current-project)
5871 (?x 'publish-choose-project)
5872 (?a 'publish-all)))
5873 ;; Return first action associated to FIRST-KEY + KEY
5874 ;; path. Indeed, derived backends can share the same
5875 ;; FIRST-KEY.
5876 (t (catch 'found
5877 (mapc (lambda (backend)
5878 (let ((match (assq key (nth 2 backend))))
5879 (when match (throw 'found (nth 2 match)))))
5880 (member (assq first-key backends) backends)))))
5881 options))
5882 ;; Otherwise, enter sub-menu.
5883 (t (org-export--dispatch-ui options key expertp)))))
5887 (provide 'ox)
5889 ;; Local variables:
5890 ;; generated-autoload-file: "org-loaddefs.el"
5891 ;; End:
5893 ;;; ox.el ends here