| blob | 7d09db80b85657991ae51fd00f5577386450cdfb |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists in a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place. The exhaustive list
35 ;; of properties is given in "The Communication Channel" section of
36 ;; this file.
37 ;;
38 ;; - The transcoder walks the parse tree, ignores or treat as plain
39 ;; text elements and objects according to export options, and
40 ;; eventually calls back-end specific functions to do the real
41 ;; transcoding, concatenating their return value along the way.
42 ;;
43 ;; - The filter system is activated at the very beginning and the very
44 ;; end of the export process, and each time an element or an object
45 ;; has been converted. It is the entry point to fine-tune standard
46 ;; output from back-end transcoders. See "The Filter System"
47 ;; section for more information.
48 ;;
49 ;; The core function is `org-export-as'. It returns the transcoded
50 ;; buffer as a string.
51 ;;
52 ;; An export back-end is defined with `org-export-define-backend'.
53 ;; This function can also support specific buffer keywords, OPTION
54 ;; keyword's items and filters. Refer to function's documentation for
55 ;; more information.
56 ;;
57 ;; If the new back-end shares most properties with another one,
58 ;; `org-export-define-derived-backend' can be used to simplify the
59 ;; process.
60 ;;
61 ;; Any back-end can define its own variables. Among them, those
62 ;; customizable should belong to the `org-export-BACKEND' group.
63 ;;
64 ;; Tools for common tasks across back-ends are implemented in the
65 ;; following part of the file.
66 ;;
67 ;; Then, a wrapper macro for asynchronous export,
68 ;; `org-export-async-start', along with tools to display results. are
69 ;; given in the penultimate part.
70 ;;
71 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
72 ;; back-ends is provided in the last one.
74 ;;; Code:
94 "Return BLOB parent or nil.
95 BLOB is the element or object considered."
98 \f
99 ;;; Internal Variables
100 ;;
101 ;; Among internal variables, the most important is
102 ;; `org-export-options-alist'. This variable define the global export
103 ;; options, shared between every exporter, and how they are acquired.
149 "Alist between export properties and ways to set them.
151 The CAR of the alist is the property name, and the CDR is a list
152 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
154 KEYWORD is a string representing a buffer keyword, or nil. Each
155 property defined this way can also be set, during subtree
156 export, through a headline property named after the keyword
158 property).
159 OPTION is a string that could be found in an #+OPTIONS: line.
160 DEFAULT is the default value for the property.
161 BEHAVIOR determines how Org should handle multiple keywords for
162 the same property. It is a symbol among:
163 nil Keep old value and discard the new one.
164 t Replace old value with the new one.
165 `space' Concatenate the values, separating them with a space.
166 `newline' Concatenate the values, separating them with
167 a newline.
168 `split' Split values at white spaces, and cons them to the
169 previous list.
171 Values set through KEYWORD and OPTION have precedence over
172 DEFAULT.
174 All these properties should be back-end agnostic. Back-end
175 specific properties are set through `org-export-define-backend'.
179 "List of in-buffer keywords that require special treatment.
180 These keywords are not directly associated to a property. The
181 way they are handled must be hard-coded into
240 "Alist between filters properties and initial values.
242 The key of each association is a property name accessible through
243 the communication channel. Its value is a configurable global
244 variable defining initial filters.
246 This list is meant to install user specified filters. Back-end
247 developers may install their own filters using
248 `org-export-define-backend'. Filters defined there will always
249 be prepended to the current list, so they always get applied
258 "Default rule for link matching an inline image.
259 This rule applies to links with no description. By default, it
260 will be considered as an inline image if it targets a local file
263 See `org-export-inline-image-p' for more information about
267 "Non-nil means asynchronous export process should leave data behind.
271 located in `temporary-file-directory'.
273 When non-nil, it will also set `debug-on-error' to a non-nil
277 "Record asynchronously generated export results and processes.
278 This is an alist: its CAR is the source of the
279 result (destination file or buffer for a finished process,
280 original buffer for a running one) and its CDR is a list
281 containing the back-end used, as a symbol, and either a process
282 or the time at which it finished. It is used to build the menu
286 "List of backends currently available in the exporter.
287 This variable is set with `org-export-define-backend' and
291 "Last command called from the dispatcher.
292 The value should be a list. Its CAR is the action, as a symbol,
296 "The position where the last export command was created using the dispatcher.
297 This marker will be used with `C-u C-c C-e' to make sure export repetition
300 ;; For compatibility with Org < 8
302 "Name, if any, of the back-end used during an export process.
304 Its value is a symbol such as `html', `latex', `ascii', or nil if
305 the back-end is anonymous (see `org-export-create-backend') or if
306 there is no export process in progress.
308 It can be used to teach Babel blocks how to act differently
311 \f
312 ;;; User-configurable Variables
313 ;;
314 ;; Configuration for the masses.
315 ;;
316 ;; They should never be accessed directly, as their value is to be
317 ;; stored in a property list (cf. `org-export-options-alist').
318 ;; Back-ends will read their value from there instead.
321 "Options for exporting Org mode files."
326 "General options for export engine."
331 "Whether sub-trees with the ARCHIVE tag should be exported.
333 This can have three different values:
334 nil Do not export, pretend this tree is not present.
335 t Do export the entire tree.
336 `headline' Only export the headline, but skip the tree below it.
338 This option can also be set with the OPTIONS keyword,
347 "Non-nil means insert author name into the exported file.
348 This option can also be set with the OPTIONS keyword,
354 "Non-nil means export CLOCK keywords.
355 This option can also be set with the OPTIONS keyword,
361 "Non-nil means the postamble should contain a creator sentence.
363 The sentence can be set in `org-export-creator-string' and
366 If the value is `comment' insert it as a comment."
374 "Non-nil means insert date in the exported document.
375 This option can also be set with the OPTIONS keyword,
381 "Time-stamp format string to use for DATE keyword.
383 The format string, when specified, only applies if date consists
384 in a single time-stamp. Otherwise its value will be ignored.
386 See `format-time-string' for details on how to build this
387 string."
395 emacs-version
397 "Information about the creator of the document.
398 This option can also be set on with the CREATOR keyword."
403 "Non-nil means export contents of standard drawers.
405 When t, all drawers are exported. This may also be a list of
406 drawer names to export, as strings. If that list starts with
407 `not', only drawers with such names will be ignored.
409 This variable doesn't apply to properties drawers. See
410 `org-export-with-properties' instead.
412 This option can also be set with the OPTIONS keyword,
425 :inline t
429 "Non-nil means insert author email into the exported file.
430 This option can also be set with the OPTIONS keyword,
436 "Non-nil means interpret *word*, /word/, _word_ and +word+.
438 If the export target supports emphasizing text, the word will be
439 typeset in bold, italic, with an underline or strike-through,
440 respectively.
442 This option can also be set with the OPTIONS keyword,
448 "Tags that exclude a tree from export.
450 All trees carrying any of these tags will be excluded from
451 export. This is without condition, so even subtrees inside that
452 carry one of the `org-export-select-tags' will be removed.
454 This option can also be set with the EXCLUDE_TAGS keyword."
460 This option can also be set with the OPTIONS keyword,
468 "Non-nil means Org footnotes should be exported.
469 This option can also be set with the OPTIONS keyword,
475 "Non-nil means process LaTeX environments and fragments.
477 This option can also be set with the OPTIONS line,
480 nil Ignore math snippets.
481 `verbatim' Keep everything in verbatim.
482 t Allow export of math snippets."
492 "The last level which is still exported as a headline.
494 Inferior levels will usually produce itemize or enumerate lists
495 when exported, but back-end behaviour may differ.
497 This option can also be set with the OPTIONS keyword,
503 "The default language for export and clocktable translations, as a string.
504 This may have an association in
505 `org-clock-clocktable-language-setup',
506 `org-export-smart-quotes-alist' and `org-export-dictionary'.
507 This option can also be set with the LANGUAGE keyword."
512 "Non-nil means preserve all line breaks when exporting.
513 This option can also be set with the OPTIONS keyword,
519 "Non-nil means interpret entities when exporting.
522 Å.
524 For a list of supported names, see the constant `org-entities'
525 and the user option `org-entities-user'.
527 This option can also be set with the OPTIONS keyword,
533 "Non-nil means inlinetasks should be exported.
534 This option can also be set with the OPTIONS keyword,
542 "Non-nil means include planning info in export.
544 Planning info is the line containing either SCHEDULED:,
545 DEADLINE:, CLOSED: time-stamps, or a combination of them.
547 This option can also be set with the OPTIONS keyword,
555 "Non-nil means include priority cookies in export.
556 This option can also be set with the OPTIONS keyword,
562 "Non-nil means export contents of properties drawers.
564 When t, all properties are exported. This may also be a list of
565 properties to export, as strings.
567 This option can also be set with the OPTIONS keyword,
579 "Non-nil means add section numbers to headlines when exporting.
581 When set to an integer n, numbering will only happen for
582 headlines whose relative level is higher or equal to n.
584 This option can also be set with the OPTIONS keyword,
590 "Tags that select a tree for export.
592 If any such tag is found in a buffer, all trees that do not carry
593 one of these tags will be ignored during export. Inside trees
594 that are selected like this, you can still deselect a subtree by
595 tagging it with one of the `org-export-exclude-tags'.
597 This option can also be set with the SELECT_TAGS keyword."
602 "Non-nil means activate smart quotes during export.
603 This option can also be set with the OPTIONS keyword,
606 When setting this to non-nil, you need to take care of
607 using the correct Babel package when exporting to LaTeX.
608 E.g., you can load Babel for french like this:
619 When this option is turned on, these strings will be exported as:
621 Org HTML LaTeX UTF-8
622 -----+----------+--------+-------
624 -- – -- –
625 --- — --- —
628 This option can also be set with the OPTIONS keyword,
634 "Non-nil means include statistics cookies in export.
635 This option can also be set with the OPTIONS keyword,
645 If you want to control how Org displays those characters, see
646 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
647 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
648 it is not anymore.
650 When this option is turned on, you can use TeX-like syntax for
651 sub- and superscripts and see them exported correctly.
653 You can also set the option with #+OPTIONS: ^:t
656 single item - so grouping with {} is normally not needed. For
657 example, the following things will be parsed as single sub- or
658 superscripts:
660 10^24 or 10^tau several digits will be considered 1 item.
661 10^-12 or 10^-tau a leading sign with digits or a word
662 x^2-y^3 will be read as x^2 - y^3, because items are
663 terminated by almost any nonword/nondigit char.
664 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
666 Still, ambiguity is possible. So when in doubt, use {} to enclose
667 the sub/superscript. If you set this variable to the symbol `{}',
668 the braces are *required* in order to trigger interpretations as
670 frequently in plain text."
680 "Non-nil means create a table of contents in exported files.
682 The TOC contains headlines with levels up
683 to`org-export-headline-levels'. When an integer, include levels
684 up to N in the toc, this may then be different from
685 `org-export-headline-levels', but it will not be allowed to be
686 larger than the number of headline levels. When nil, no table of
687 contents is made.
689 This option can also be set with the OPTIONS keyword,
698 "Non-nil means export tables.
699 This option can also be set with the OPTIONS keyword,
707 "If nil, do not export tags, just remove them from headlines.
709 If this is the symbol `not-in-toc', tags will be removed from
710 table of contents entries, but still be shown in the headlines of
711 the document.
713 This option can also be set with the OPTIONS keyword,
722 "Non-nil means include TODO items for export.
724 This may have the following values:
725 t include tasks independent of state.
726 `todo' include only tasks that are not yet done.
727 `done' include only tasks that are already done.
728 nil ignore all tasks.
729 list of keywords include tasks with these keywords.
731 This option can also be set with the OPTIONS keyword,
743 "Non-nil means insert a time stamp into the exported file.
744 The time stamp shows when the file was created. This option can
750 "Non nil means allow timestamps in export.
752 It can be set to any of the following values:
753 t export all timestamps.
754 `active' export active timestamps only.
755 `inactive' export inactive timestamps only.
756 nil do not export timestamps
758 This only applies to timestamps isolated in a paragraph
759 containing only timestamps. Other timestamps are always
760 exported.
762 This option can also be set with the OPTIONS keyword, e.g.
772 "Non-nil means include TODO keywords in export.
773 When nil, remove all these keywords from the export. This option
779 "Non-nil means BIND keywords can define local variable values.
780 This is a potential security risk, which is why the default value
781 is nil. You can also allow them through local buffer variables."
788 "Alist between export snippets back-ends and exporter back-ends.
790 This variable allows to provide shortcuts for export snippets.
794 HTML code while every other back-end will ignore it."
803 "Coding system for the exported file."
810 "Should we push exported content to the kill ring?"
819 "The initial scope when exporting with `org-export-dispatch'.
820 This variable can be either set to `buffer' or `subtree'."
827 "Non-nil means show buffer after exporting to temp buffer.
828 When Org exports to a file, the buffer visiting that file is ever
829 shown, but remains buried. However, when exporting to
830 a temporary buffer, that buffer is popped up in a second window.
831 When this variable is nil, the buffer remains buried also in
832 these cases."
837 "Non-nil means export and publishing commands will run in background.
838 Results from an asynchronous export are never displayed
846 "File used to initialize external export process.
848 Value must be either nil or an absolute file name. When nil, the
849 external process is launched like a regular Emacs session,
850 loading user's initialization file and any site specific
851 configuration. If a file is provided, it, and only it, is loaded
852 at start-up.
854 Therefore, using a specific configuration makes the process to
855 load faster and the export more portable."
864 "Non-nil means using a non-intrusive `org-export-dispatch'.
865 In that case, no help buffer is displayed. Though, an indicator
871 asynchronous). Also, \[?] allows to switch back to standard
872 mode."
879 \f
880 ;;; Defining Back-ends
881 ;;
882 ;; An export back-end is a structure with `org-export-backend' type
883 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
884 ;; and `menu' slots.
885 ;;
886 ;; At the lowest level, a back-end is created with
887 ;; `org-export-create-backend' function.
888 ;;
889 ;; A named back-end can be registered with
890 ;; `org-export-register-backend' function. A registered back-end can
891 ;; later be referred to by its name, with `org-export-get-backend'
892 ;; function. Also, such a back-end can become the parent of a derived
893 ;; back-end from which slot values will be inherited by default.
894 ;; `org-export-derived-backend-p' can check if a given back-end is
895 ;; derived from a list of back-end names.
896 ;;
897 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
898 ;; `org-export-get-all-filters' return the full alist of transcoders,
899 ;; options and filters, including those inherited from ancestors.
900 ;;
901 ;; At a higher level, `org-export-define-backend' is the standard way
902 ;; to define an export back-end. If the new back-end is similar to
903 ;; a registered back-end, `org-export-define-derived-backend' may be
904 ;; used instead.
905 ;;
906 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
907 ;; when a given back-end hasn't been registered yet.
911 name parent transcoders options filters blocks menu)
914 "Return export back-end named after NAME.
915 NAME is a symbol. Return nil if no such back-end is found."
922 "Register BACKEND as a known export back-end.
923 BACKEND is a structure with `org-export-backend' type."
924 ;; Refuse to register an unnamed back-end.
927 ;; Refuse to register a back-end with an unknown parent.
931 ;; Register dedicated export blocks in the parser.
935 ;; If a back-end with the same name as BACKEND is already
936 ;; registered, replace it with BACKEND. Otherwise, simply add
937 ;; BACKEND to the list of registered back-ends.
943 "Signal an error if BACKEND isn't defined."
948 "Non-nil if BACKEND is derived from one of BACKENDS.
949 BACKEND is an export back-end, as returned by, e.g.,
950 `org-export-create-backend', or a symbol referring to
951 a registered back-end. BACKENDS is constituted of symbols."
963 "Return full translation table for BACKEND.
965 BACKEND is an export back-end, as return by, e.g,,
966 `org-export-create-backend'. Return value is an alist where
967 keys are element or object types, as symbols, and values are
968 transcoders.
970 Unlike to `org-export-backend-transcoders', this function
971 also returns transcoders inherited from parent back-ends,
972 if any."
976 parent)
981 transcoders)))
984 "Return export options for BACKEND.
986 BACKEND is an export back-end, as return by, e.g,,
987 `org-export-create-backend'. See `org-export-options-alist'
988 for the shape of the return value.
990 Unlike to `org-export-backend-options', this function also
991 returns options inherited from parent back-ends, if any."
995 parent)
999 options)))
1002 "Return complete list of filters for BACKEND.
1004 BACKEND is an export back-end, as return by, e.g,,
1005 `org-export-create-backend'. Return value is an alist where
1006 keys are symbols and values lists of functions.
1008 Unlike to `org-export-backend-filters', this function also
1009 returns filters inherited from parent back-ends, if any."
1013 parent)
1017 filters)))
1020 "Define a new back-end BACKEND.
1022 TRANSCODERS is an alist between object or element types and
1023 functions handling them.
1025 These functions should return a string without any trailing
1026 space, or nil. They must accept three arguments: the object or
1027 element itself, its contents or nil when it isn't recursive and
1028 the property list used as a communication channel.
1030 Contents, when not nil, are stripped from any global indentation
1031 \(although the relative one is preserved). They also always end
1032 with a single newline character.
1034 If, for a given type, no function is found, that element or
1035 object type will simply be ignored, along with any blank line or
1036 white space at its end. The same will happen if the function
1037 returns the nil value. If that function returns the empty
1038 string, the type will be ignored, but the blank lines or white
1039 spaces will be kept.
1041 In addition to element and object types, one function can be
1042 associated to the `template' (or `inner-template') symbol and
1043 another one to the `plain-text' symbol.
1045 The former returns the final transcoded string, and can be used
1046 to add a preamble and a postamble to document's body. It must
1047 accept two arguments: the transcoded string and the property list
1048 containing export options. A function associated to `template'
1050 A function associated to `inner-template' is always applied.
1052 The latter, when defined, is to be called on every text not
1053 recognized as an element or an object. It must accept two
1054 arguments: the text string and the information channel. It is an
1055 appropriate place to protect special chars relative to the
1056 back-end.
1058 BODY can start with pre-defined keyword arguments. The following
1059 keywords are understood:
1061 :export-block
1063 String, or list of strings, representing block names that
1064 will not be parsed. This is used to specify blocks that will
1065 contain raw code specific to the back-end. These blocks
1066 still have to be handled by the relative `export-block' type
1067 translator.
1069 :filters-alist
1071 Alist between filters and function, or list of functions,
1072 specific to the back-end. See `org-export-filters-alist' for
1073 a list of all allowed filters. Filters defined here
1074 shouldn't make a back-end test, as it may prevent back-ends
1075 derived from this one to behave properly.
1077 :menu-entry
1079 Menu entry for the export dispatcher. It should be a list
1080 like:
1082 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1084 where :
1086 KEY is a free character selecting the back-end.
1088 DESCRIPTION-OR-ORDINAL is either a string or a number.
1090 If it is a string, is will be used to name the back-end in
1091 its menu entry. If it is a number, the following menu will
1092 be displayed as a sub-menu of the back-end with the same
1093 KEY. Also, the number will be used to determine in which
1094 order such sub-menus will appear (lowest first).
1096 ACTION-OR-MENU is either a function or an alist.
1098 If it is an action, it will be called with four
1099 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1100 BODY-ONLY. See `org-export-as' for further explanations on
1101 some of them.
1103 If it is an alist, associations should follow the
1104 pattern:
1106 '(KEY DESCRIPTION ACTION)
1108 where KEY, DESCRIPTION and ACTION are described above.
1110 Valid values include:
1114 or
1119 \(lambda (a s v b)
1120 \(if a (org-latex-export-to-pdf t s v b)
1121 \(org-open-file
1122 \(org-latex-export-to-pdf nil s v b)))))))
1124 or the following, which will be added to the previous
1125 sub-menu,
1127 '(?l 1
1131 :options-alist
1133 Alist between back-end specific properties introduced in
1134 communication channel and how their value are acquired. See
1135 `org-export-options-alist' for more information about
1136 structure of the values."
1150 :transcoders transcoders
1151 :options options
1152 :filters filters
1153 :blocks blocks
1157 "Create a new back-end as a variant of an existing one.
1159 CHILD is the name of the derived back-end. PARENT is the name of
1160 the parent back-end.
1162 BODY can start with pre-defined keyword arguments. The following
1163 keywords are understood:
1165 :export-block
1167 String, or list of strings, representing block names that
1168 will not be parsed. This is used to specify blocks that will
1169 contain raw code specific to the back-end. These blocks
1170 still have to be handled by the relative `export-block' type
1171 translator.
1173 :filters-alist
1175 Alist of filters that will overwrite or complete filters
1176 defined in PARENT back-end. See `org-export-filters-alist'
1177 for a list of allowed filters.
1179 :menu-entry
1181 Menu entry for the export dispatcher. See
1182 `org-export-define-backend' for more information about the
1183 expected value.
1185 :options-alist
1187 Alist of back-end specific properties that will overwrite or
1188 complete those defined in PARENT back-end. Refer to
1189 `org-export-options-alist' for more information about
1190 structure of the values.
1192 :translate-alist
1194 Alist of element and object types and transcoders that will
1195 overwrite or complete transcode table from PARENT back-end.
1196 Refer to `org-export-define-backend' for detailed information
1197 about transcoders.
1200 as a variant of `latex' back-end with a custom template function:
1202 \(org-export-define-derived-backend 'my-latex 'latex
1203 :translate-alist '((template . my-latex-template-fun)))
1205 The back-end could then be called with, for example:
1222 :parent parent
1223 :transcoders transcoders
1224 :options options
1225 :filters filters
1226 :blocks blocks
1230 \f
1231 ;;; The Communication Channel
1232 ;;
1233 ;; During export process, every function has access to a number of
1234 ;; properties. They are of two types:
1235 ;;
1236 ;; 1. Environment options are collected once at the very beginning of
1237 ;; the process, out of the original buffer and configuration.
1238 ;; Collecting them is handled by `org-export-get-environment'
1239 ;; function.
1240 ;;
1241 ;; Most environment options are defined through the
1242 ;; `org-export-options-alist' variable.
1243 ;;
1244 ;; 2. Tree properties are extracted directly from the parsed tree,
1245 ;; just before export, by `org-export-collect-tree-properties'.
1246 ;;
1247 ;; Here is the full list of properties available during transcode
1248 ;; process, with their category and their value type.
1249 ;;
1250 ;; + `:author' :: Author's name.
1251 ;; - category :: option
1252 ;; - type :: string
1253 ;;
1254 ;; + `:back-end' :: Current back-end used for transcoding.
1255 ;; - category :: tree
1256 ;; - type :: structure
1257 ;;
1258 ;; + `:creator' :: String to write as creation information.
1259 ;; - category :: option
1260 ;; - type :: string
1261 ;;
1262 ;; + `:date' :: String to use as date.
1263 ;; - category :: option
1264 ;; - type :: string
1265 ;;
1266 ;; + `:description' :: Description text for the current data.
1267 ;; - category :: option
1268 ;; - type :: string
1269 ;;
1270 ;; + `:email' :: Author's email.
1271 ;; - category :: option
1272 ;; - type :: string
1273 ;;
1274 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1275 ;; process.
1276 ;; - category :: option
1277 ;; - type :: list of strings
1278 ;;
1279 ;; + `:export-options' :: List of export options available for current
1280 ;; process.
1281 ;; - category :: none
1282 ;; - type :: list of symbols, among `subtree', `body-only' and
1283 ;; `visible-only'.
1284 ;;
1285 ;; + `:exported-data' :: Hash table used for memoizing
1286 ;; `org-export-data'.
1287 ;; - category :: tree
1288 ;; - type :: hash table
1289 ;;
1290 ;; + `:filetags' :: List of global tags for buffer. Used by
1291 ;; `org-export-get-tags' to get tags with inheritance.
1292 ;; - category :: option
1293 ;; - type :: list of strings
1294 ;;
1295 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1296 ;; their definition, as parsed data. Only non-inlined footnotes
1297 ;; are represented in this alist. Also, every definition isn't
1298 ;; guaranteed to be referenced in the parse tree. The purpose of
1299 ;; this property is to preserve definitions from oblivion
1300 ;; (i.e. when the parse tree comes from a part of the original
1301 ;; buffer), it isn't meant for direct use in a back-end. To
1302 ;; retrieve a definition relative to a reference, use
1303 ;; `org-export-get-footnote-definition' instead.
1304 ;; - category :: option
1305 ;; - type :: alist (STRING . LIST)
1306 ;;
1307 ;; + `:headline-levels' :: Maximum level being exported as an
1308 ;; headline. Comparison is done with the relative level of
1309 ;; headlines in the parse tree, not necessarily with their
1310 ;; actual level.
1311 ;; - category :: option
1312 ;; - type :: integer
1313 ;;
1314 ;; + `:headline-offset' :: Difference between relative and real level
1315 ;; of headlines in the parse tree. For example, a value of -1
1316 ;; means a level 2 headline should be considered as level
1317 ;; 1 (cf. `org-export-get-relative-level').
1318 ;; - category :: tree
1319 ;; - type :: integer
1320 ;;
1321 ;; + `:headline-numbering' :: Alist between headlines and their
1322 ;; numbering, as a list of numbers
1323 ;; (cf. `org-export-get-headline-number').
1324 ;; - category :: tree
1325 ;; - type :: alist (INTEGER . LIST)
1326 ;;
1327 ;; + `:id-alist' :: Alist between ID strings and destination file's
1328 ;; path, relative to current directory. It is used by
1329 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1330 ;; external file.
1331 ;; - category :: option
1332 ;; - type :: alist (STRING . STRING)
1333 ;;
1334 ;; + `:ignore-list' :: List of elements and objects that should be
1335 ;; ignored during export.
1336 ;; - category :: tree
1337 ;; - type :: list of elements and objects
1338 ;;
1339 ;; + `:input-buffer' :: Original buffer name.
1340 ;; - category :: option
1341 ;; - type :: string
1342 ;;
1343 ;; + `:input-file' :: Full path to input file, if any.
1344 ;; - category :: option
1345 ;; - type :: string or nil
1346 ;;
1347 ;; + `:keywords' :: List of keywords attached to data.
1348 ;; - category :: option
1349 ;; - type :: string
1350 ;;
1351 ;; + `:language' :: Default language used for translations.
1352 ;; - category :: option
1353 ;; - type :: string
1354 ;;
1355 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1356 ;; transcoding.
1357 ;; - category :: option
1358 ;; - type :: list (as returned by `org-element-parse-buffer')
1359 ;;
1360 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1361 ;; all line breaks.
1362 ;; - category :: option
1363 ;; - type :: symbol (nil, t)
1364 ;;
1365 ;; + `:section-numbers' :: Non-nil means transcoding should add
1366 ;; section numbers to headlines.
1367 ;; - category :: option
1368 ;; - type :: symbol (nil, t)
1369 ;;
1370 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1371 ;; in transcoding. When such a tag is present, subtrees without
1372 ;; it are de facto excluded from the process. See
1373 ;; `use-select-tags'.
1374 ;; - category :: option
1375 ;; - type :: list of strings
1376 ;;
1377 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1378 ;; a time stamp in the output.
1379 ;; - category :: option
1380 ;; - type :: symbol (nil, t)
1381 ;;
1382 ;; + `:translate-alist' :: Alist between element and object types and
1383 ;; transcoding functions relative to the current back-end.
1384 ;; Special keys `inner-template', `template' and `plain-text' are
1385 ;; also possible.
1386 ;; - category :: option
1387 ;; - type :: alist (SYMBOL . FUNCTION)
1388 ;;
1389 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1390 ;; also be transcoded. If it is set to the `headline' symbol,
1391 ;; only the archived headline's name is retained.
1392 ;; - category :: option
1393 ;; - type :: symbol (nil, t, `headline')
1394 ;;
1395 ;; + `:with-author' :: Non-nil means author's name should be included
1396 ;; in the output.
1397 ;; - category :: option
1398 ;; - type :: symbol (nil, t)
1399 ;;
1400 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1401 ;; - category :: option
1402 ;; - type :: symbol (nil, t)
1403 ;;
1404 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1405 ;; inserted at the end of the transcoded string. If the value
1406 ;; is `comment', it should be commented.
1407 ;; - category :: option
1408 ;; - type :: symbol (`comment', nil, t)
1409 ;;
1410 ;; + `:with-date' :: Non-nil means output should contain a date.
1411 ;; - category :: option
1412 ;; - type :. symbol (nil, t)
1413 ;;
1414 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1415 ;; its value is a list of names, only drawers with such names
1416 ;; will be transcoded. If that list starts with `not', drawer
1417 ;; with these names will be skipped.
1418 ;; - category :: option
1419 ;; - type :: symbol (nil, t) or list of strings
1420 ;;
1421 ;; + `:with-email' :: Non-nil means output should contain author's
1422 ;; email.
1423 ;; - category :: option
1424 ;; - type :: symbol (nil, t)
1425 ;;
1426 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1427 ;; interpreted.
1428 ;; - category :: option
1429 ;; - type :: symbol (nil, t)
1430 ;;
1431 ;; + `:with-fixed-width' :: Non-nil if transcoder should export
1432 ;; strings starting with a colon as a fixed-with (verbatim) area.
1433 ;; - category :: option
1434 ;; - type :: symbol (nil, t)
1435 ;;
1436 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1437 ;; footnotes.
1438 ;; - category :: option
1439 ;; - type :: symbol (nil, t)
1440 ;;
1441 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1442 ;; `latex-fragment' objects should appear in export output. When
1443 ;; this property is set to `verbatim', they will be left as-is.
1444 ;; - category :: option
1445 ;; - type :: symbol (`verbatim', nil, t)
1446 ;;
1447 ;; + `:with-planning' :: Non-nil means transcoding should include
1448 ;; planning info.
1449 ;; - category :: option
1450 ;; - type :: symbol (nil, t)
1451 ;;
1452 ;; + `:with-priority' :: Non-nil means transcoding should include
1453 ;; priority cookies.
1454 ;; - category :: option
1455 ;; - type :: symbol (nil, t)
1456 ;;
1457 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1458 ;; plain text.
1459 ;; - category :: option
1460 ;; - type :: symbol (nil, t)
1461 ;;
1462 ;; + `:with-special-strings' :: Non-nil means transcoding should
1463 ;; interpret special strings in plain text.
1464 ;; - category :: option
1465 ;; - type :: symbol (nil, t)
1466 ;;
1467 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1468 ;; interpret subscript and superscript. With a value of "{}",
1469 ;; only interpret those using curly brackets.
1470 ;; - category :: option
1471 ;; - type :: symbol (nil, {}, t)
1472 ;;
1473 ;; + `:with-tables' :: Non-nil means transcoding should export tables.
1474 ;; - category :: option
1475 ;; - type :: symbol (nil, t)
1476 ;;
1477 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1478 ;; headlines. A `not-in-toc' value will remove them from the
1479 ;; table of contents, if any, nonetheless.
1480 ;; - category :: option
1481 ;; - type :: symbol (nil, t, `not-in-toc')
1482 ;;
1483 ;; + `:with-tasks' :: Non-nil means transcoding should include
1484 ;; headlines with a TODO keyword. A `todo' value will only
1485 ;; include headlines with a todo type keyword while a `done'
1486 ;; value will do the contrary. If a list of strings is provided,
1487 ;; only tasks with keywords belonging to that list will be kept.
1488 ;; - category :: option
1489 ;; - type :: symbol (t, todo, done, nil) or list of strings
1490 ;;
1491 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1492 ;; time stamps. Special value `active' (resp. `inactive') ask to
1493 ;; export only active (resp. inactive) timestamps. Otherwise,
1494 ;; completely remove them.
1495 ;; - category :: option
1496 ;; - type :: symbol: (`active', `inactive', t, nil)
1497 ;;
1498 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1499 ;; added to the output. An integer value limits its depth.
1500 ;; - category :: option
1501 ;; - type :: symbol (nil, t or integer)
1502 ;;
1503 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1504 ;; include TODO keywords.
1505 ;; - category :: option
1506 ;; - type :: symbol (nil, t)
1509 ;;;; Environment Options
1510 ;;
1511 ;; Environment options encompass all parameters defined outside the
1512 ;; scope of the parsed data. They come from five sources, in
1513 ;; increasing precedence order:
1514 ;;
1515 ;; - Global variables,
1516 ;; - Buffer's attributes,
1517 ;; - Options keyword symbols,
1518 ;; - Buffer keywords,
1519 ;; - Subtree properties.
1520 ;;
1521 ;; The central internal function with regards to environment options
1522 ;; is `org-export-get-environment'. It updates global variables with
1523 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1524 ;; the different sources.
1525 ;;
1526 ;; The internal functions doing the retrieval are:
1527 ;; `org-export--get-global-options',
1528 ;; `org-export--get-buffer-attributes',
1529 ;; `org-export--parse-option-keyword',
1530 ;; `org-export--get-subtree-options' and
1531 ;; `org-export--get-inbuffer-options'
1532 ;;
1533 ;; Also, `org-export--list-bound-variables' collects bound variables
1534 ;; along with their value in order to set them as buffer local
1535 ;; variables later in the process.
1538 "Collect export options from the current buffer.
1540 Optional argument BACKEND is an export back-end, as returned by
1541 `org-export-create-backend'.
1543 When optional argument SUBTREEP is non-nil, assume the export is
1544 done against the current sub-tree.
1546 Third optional argument EXT-PLIST is a property list with
1547 external parameters overriding Org default settings, but still
1548 inferior to file-local settings."
1549 ;; First install #+BIND variables since these must be set before
1550 ;; global options are read.
1553 ;; Get and prioritize export options...
1555 ;; ... from global variables...
1557 ;; ... from an external property list...
1558 ext-plist
1559 ;; ... from in-buffer settings...
1561 ;; ... and from subtree, when appropriate.
1563 ;; Eventually add misc. properties.
1565 :back-end
1566 backend
1568 :footnote-definition-alist
1569 ;; Footnotes definitions must be collected in the original
1570 ;; buffer, as there's no insurance that they will still be in
1571 ;; the parse tree, due to possible narrowing.
1585 alist))))
1586 alist))
1587 :id-alist
1588 ;; Collect id references.
1599 alist))))
1602 "Parse an OPTIONS line and return values as a plist.
1603 Optional argument BACKEND is an export back-end, as returned by,
1604 e.g., `org-export-create-backend'. It specifies which back-end
1605 specific items to read, if any."
1607 ;; Priority is given to back-end specific options.
1609 org-export-options-alist))
1610 plist)
1619 options))
1621 property
1624 plist))
1627 "Get export options in subtree at point.
1628 Optional argument BACKEND is an export back-end, as returned by,
1629 e.g., `org-export-create-backend'. It specifies back-end used
1630 for export. Return options as a plist."
1631 ;; For each buffer keyword, create a headline property setting the
1632 ;; same property in communication channel. The name for the property
1633 ;; is the keyword with "EXPORT_" appended to it.
1636 ;; Make sure point is at a heading.
1638 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1639 ;; title (with no todo keyword, priority cookie or tag) as its
1640 ;; fallback value.
1646 plist :title
1649 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1653 ;; Handle other keywords. TITLE keyword is excluded as it has
1654 ;; been handled already.
1662 ;; Export properties are not case-sensitive.
1669 plist
1670 property
1672 ;; Parse VALUE if required.
1676 ;; If BEHAVIOR is `split' expected value is
1677 ;; a list of strings, not a string.
1680 ;; Look for both general keywords and back-end specific
1681 ;; options, with priority given to the latter.
1683 org-export-options-alist)))
1684 ;; Return value.
1685 plist)))
1688 "Return current buffer export options, as a plist.
1690 Optional argument BACKEND, when non-nil, is an export back-end,
1691 as returned by, e.g., `org-export-create-backend'. It specifies
1692 which back-end specific options should also be read in the
1693 process.
1695 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1697 get-options ; For byte-compiler.
1700 ;; Priority is given to back-end specific options.
1702 org-export-options-alist))
1705 org-export-special-keywords))))
1708 ;; Return all properties associated to KEYWORD.
1715 ;; Recursively read keywords in buffer. FILES is a list
1716 ;; of files read so far. PLIST is the current property
1717 ;; list obtained.
1726 ;; Options in `org-export-special-keywords'.
1730 ;; Avoid circular dependencies.
1740 plist
1745 plist
1751 ;; Options in `org-export-options-alist'.
1756 plist property
1757 ;; Handle value depending on specified
1758 ;; BEHAVIOR.
1764 " "
1777 ;; Return final value.
1778 plist))))
1779 ;; Read options in the current buffer.
1782 ;; Parse keywords specified in `org-element-document-properties'
1783 ;; and return PLIST.
1794 "Return properties related to buffer attributes, as a plist."
1795 ;; Store full path of input file name, or nil. For internal use.
1798 :input-file visited-file
1804 "Return global export options as a plist.
1805 Optional argument BACKEND, if non-nil, is an export back-end, as
1806 returned by, e.g., `org-export-create-backend'. It specifies
1807 which back-end specific export options should also be read in the
1808 process."
1810 ;; Priority is given to back-end specific options.
1812 org-export-options-alist)))
1819 plist
1820 prop
1821 ;; Eval default value provided. If keyword is
1822 ;; a member of `org-element-document-properties',
1823 ;; parse it as a secondary string before storing it.
1830 value)))))))))))
1833 "Return variables bound from BIND keywords in current buffer.
1834 Also look for BIND keywords in setup files. The return value is
1835 an alist where associations are (VARIABLE-NAME VALUE)."
1840 ;; Return an alist between variable names and their
1841 ;; value. FILES is a list of setup files names read so
1842 ;; far, used to avoid circular dependencies. ALIST is
1843 ;; the alist collected so far.
1854 ;; Enter setup file.
1864 alist))))))))))
1865 alist)))))
1866 ;; Return value in appropriate order of appearance.
1870 ;;;; Tree Properties
1871 ;;
1872 ;; Tree properties are information extracted from parse tree. They
1873 ;; are initialized at the beginning of the transcoding process by
1874 ;; `org-export-collect-tree-properties'.
1875 ;;
1876 ;; Dedicated functions focus on computing the value of specific tree
1877 ;; properties during initialization. Thus,
1878 ;; `org-export--populate-ignore-list' lists elements and objects that
1879 ;; should be skipped during export, `org-export--get-min-level' gets
1880 ;; the minimal exportable level, used as a basis to compute relative
1881 ;; level for headlines. Eventually
1882 ;; `org-export--collect-headline-numbering' builds an alist between
1883 ;; headlines and their numbering.
1886 "Extract tree properties from parse tree.
1888 DATA is the parse tree from which information is retrieved. INFO
1889 is a list holding export options.
1891 Following tree properties are set or updated:
1893 `:exported-data' Hash table used to memoize results from
1894 `org-export-data'.
1896 `:footnote-definition-alist' List of footnotes definitions in
1897 original buffer and current parse tree.
1899 `:headline-offset' Offset between true level of headlines and
1900 local level. An offset of -1 means a headline
1901 of level 2 should be considered as a level
1902 1 headline in the context.
1904 `:headline-numbering' Alist of all headlines as key an the
1905 associated numbering as value.
1907 `:ignore-list' List of elements that should be ignored during
1908 export.
1910 Return updated plist."
1911 ;; Install the parse tree in the communication channel, in order to
1912 ;; use `org-export-get-genealogy' and al.
1914 ;; Get the list of elements and objects to ignore, and put it into
1915 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1916 ;; been done during parse tree filtering.
1919 :ignore-list
1922 ;; Compute `:headline-offset' in order to be able to use
1923 ;; `org-export-get-relative-level'.
1926 :headline-offset
1928 ;; Update footnotes definitions list with definitions in parse tree.
1929 ;; This is required since buffer expansion might have modified
1930 ;; boundaries of footnote definitions contained in the parse tree.
1931 ;; This way, definitions in `footnote-definition-alist' are bound to
1932 ;; match those in the parse tree.
1938 defs)))
1940 ;; Properties order doesn't matter: get the rest of the tree
1941 ;; properties.
1945 info))
1948 "Return minimum exportable headline's level in DATA.
1949 DATA is parsed tree as returned by `org-element-parse-buffer'.
1950 OPTIONS is a plist holding export options."
1961 ;; If no headline was found, for the sake of consistency, set
1962 ;; minimum level to 1 nonetheless.
1966 "Return numbering of all exportable headlines in a parse tree.
1968 DATA is the parse tree. OPTIONS is the plist holding export
1969 options.
1971 Return an alist whose key is a headline and value is its
1972 associated numbering \(in the shape of a list of numbers\) or nil
1973 for a footnotes section."
1981 headline
1983 for idx from 0 to org-export-max-depth
1987 options)))
1990 "Return list of elements and objects to ignore during export.
1991 DATA is the parse tree to traverse. OPTIONS is the plist holding
1992 export options."
1994 ;; First find trees containing a select tag, if any.
1996 ;; If a select tag is active, also ignore the section before
1997 ;; the first headline, if any.
2001 first-element))))
2004 ;; Collect ignored elements or objects into IGNORE-LIST.
2010 ;; If headline is archived but tree below has
2011 ;; to be skipped, add it to ignore list.
2014 ;; Move into secondary string, if any.
2019 ;; Move into recursive objects/elements.
2021 ;; Main call.
2023 ;; Return value.
2024 ignore))
2027 "Return list of headlines and inlinetasks with a select tag in their tree.
2028 DATA is parsed data as returned by `org-element-parse-buffer'.
2029 INFO is a plist holding export options."
2031 walk-data ; For byte-compiler.
2041 ;; When a select tag is found, mark full
2042 ;; genealogy and every headline within the tree
2043 ;; as acceptable.
2046 genealogy
2049 selected-trees))
2050 ;; If at a headline, continue searching in tree,
2051 ;; recursively.
2061 selected-trees))
2064 "Non-nil when element or object BLOB should be skipped during export.
2065 OPTIONS is the plist holding export options. SELECTED, when
2066 non-nil, is a list of headlines or inlinetasks belonging to
2067 a tree with a select tag."
2074 ;; If `:with-drawers' value starts with `not', ignore
2075 ;; every drawer whose name belong to that list.
2076 ;; Otherwise, ignore drawers whose name isn't in that
2077 ;; list.
2094 ;; Ignore subtrees with an exclude tag.
2097 ;; When a select tag is present in the buffer, ignore any tree
2098 ;; without it.
2100 ;; Ignore commented sub-trees.
2102 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2104 ;; Ignore tasks, if specified by `:with-tasks' property.
2116 properties-set))))))
2127 ;; `:with-timestamps' only applies to isolated timestamps
2128 ;; objects, i.e. timestamp objects in a paragraph containing only
2129 ;; timestamps and whitespaces.
2137 options t))))
2146 \f
2147 ;;; The Transcoder
2148 ;;
2149 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2150 ;; `org-element-parse-buffer') and transcodes it into a specified
2151 ;; back-end output. It takes care of filtering out elements or
2152 ;; objects according to export options and organizing the output blank
2153 ;; lines and white space are preserved. The function memoizes its
2154 ;; results, so it is cheap to call it within transcoders.
2155 ;;
2156 ;; It is possible to modify locally the back-end used by
2157 ;; `org-export-data' or even use a temporary back-end by using
2158 ;; `org-export-data-with-backend'.
2159 ;;
2160 ;; Internally, three functions handle the filtering of objects and
2161 ;; elements during the export. In particular,
2162 ;; `org-export-ignore-element' marks an element or object so future
2163 ;; parse tree traversals skip it and `org-export-expand' transforms
2164 ;; the others back into their original shape.
2165 ;;
2166 ;; `org-export-transcoder' is an accessor returning appropriate
2167 ;; translator function for a given element or object.
2170 "Return appropriate transcoder for BLOB.
2171 INFO is a plist containing export directives."
2173 ;; Return contents only for complete parse trees.
2179 "Convert DATA into current back-end format.
2181 DATA is a parse tree, an element or an object or a secondary
2182 string. INFO is a plist holding export options.
2184 Return transcoded string."
2190 ;; Ignored element/object.
2192 ;; Plain text.
2198 info))
2199 ;; Secondary string.
2202 ;; Element/Object without contents or, as a special case,
2203 ;; headline with archive tag and archived trees restricted
2204 ;; to title only.
2212 ;; Export snippets never return a nil value so
2213 ;; that white spaces following them are never
2214 ;; ignored.
2216 ;; Element/Object with contents.
2229 ;; Elements directly containing objects
2230 ;; must have their indentation normalized
2231 ;; first.
2233 data
2234 ;; When normalizing contents of the first
2235 ;; paragraph in an item or a footnote
2236 ;; definition, ignore first line's
2237 ;; indentation: there is none and it
2238 ;; might be misleading.
2243 data)
2250 info))))))))
2251 ;; Final result will be memoized before being returned.
2253 data
2257 ;; Append the same white space between elements or objects as in
2258 ;; the original buffer, and call appropriate filters.
2269 info)))
2270 results)))
2274 "Convert DATA into BACKEND format.
2276 DATA is an element, an object, a secondary string or a string.
2277 BACKEND is a symbol. INFO is a plist used as a communication
2278 channel.
2280 Unlike to `org-export-with-backend', this function will
2281 recursively convert DATA using BACKEND translation table."
2284 data
2285 ;; Set-up a new communication channel with translations defined in
2286 ;; BACKEND as the translate table and a new hash table for
2287 ;; memoization.
2289 info
2292 ;; Size of the hash table is reduced since this function
2293 ;; will probably be used on small trees.
2297 "Change uninterpreted elements back into Org syntax.
2298 DATA is the parse tree. INFO is a plist containing export
2299 options. Each uninterpreted element or object is changed back
2300 into a string. Contents, if any, are not modified. The parse
2301 tree is modified by side effect and returned by the function."
2305 prop
2308 info))))
2311 "Change uninterpreted elements back into Org syntax.
2312 DATA is a parse tree or a secondary string. INFO is a plist
2313 containing export options. It is modified by side effect and
2314 returned by the function."
2317 subscript superscript underline)
2321 ;; ... entities...
2328 ?\s)))))
2329 ;; ... emphasis...
2341 marker
2345 ?\s)))))))
2346 ;; ... LaTeX environments and fragments...
2350 ;; ... sub/superscripts...
2359 "_"
2368 ?\s)))))))))))
2370 ;; Splice NEW at BLOB location in parse tree.
2373 info)
2374 ;; Return modified parse tree.
2375 data)
2378 "Expand a parsed element or object to its original state.
2380 BLOB is either an element or an object. CONTENTS is its
2381 contents, as a string or nil.
2383 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2384 keywords before output."
2389 blob contents))))
2392 "Add ELEMENT to `:ignore-list' in INFO.
2394 Any element in `:ignore-list' will be skipped when using
2395 `org-element-map'. INFO is modified by side effects."
2399 \f
2400 ;;; The Filter System
2401 ;;
2402 ;; Filters allow end-users to tweak easily the transcoded output.
2403 ;; They are the functional counterpart of hooks, as every filter in
2404 ;; a set is applied to the return value of the previous one.
2405 ;;
2406 ;; Every set is back-end agnostic. Although, a filter is always
2407 ;; called, in addition to the string it applies to, with the back-end
2408 ;; used as argument, so it's easy for the end-user to add back-end
2409 ;; specific filters in the set. The communication channel, as
2410 ;; a plist, is required as the third argument.
2411 ;;
2412 ;; From the developer side, filters sets can be installed in the
2413 ;; process with the help of `org-export-define-backend', which
2414 ;; internally stores filters as an alist. Each association has a key
2415 ;; among the following symbols and a function or a list of functions
2416 ;; as value.
2417 ;;
2418 ;; - `:filter-options' applies to the property list containing export
2419 ;; options. Unlike to other filters, functions in this list accept
2420 ;; two arguments instead of three: the property list containing
2421 ;; export options and the back-end. Users can set its value through
2422 ;; `org-export-filter-options-functions' variable.
2423 ;;
2424 ;; - `:filter-parse-tree' applies directly to the complete parsed
2425 ;; tree. Users can set it through
2426 ;; `org-export-filter-parse-tree-functions' variable.
2427 ;;
2428 ;; - `:filter-final-output' applies to the final transcoded string.
2429 ;; Users can set it with `org-export-filter-final-output-functions'
2430 ;; variable
2431 ;;
2432 ;; - `:filter-plain-text' applies to any string not recognized as Org
2433 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2434 ;; configure it.
2435 ;;
2436 ;; - `:filter-TYPE' applies on the string returned after an element or
2437 ;; object of type TYPE has been transcoded. A user can modify
2438 ;; `org-export-filter-TYPE-functions'
2439 ;;
2440 ;; All filters sets are applied with
2441 ;; `org-export-filter-apply-functions' function. Filters in a set are
2442 ;; applied in a LIFO fashion. It allows developers to be sure that
2443 ;; their filters will be applied first.
2444 ;;
2445 ;; Filters properties are installed in communication channel with
2446 ;; `org-export-install-filters' function.
2447 ;;
2448 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2449 ;; `org-export-before-parsing-hook') are run at the beginning of the
2450 ;; export process and just before parsing to allow for heavy structure
2451 ;; modifications.
2454 ;;;; Hooks
2457 "Hook run at the beginning of the export process.
2459 This is run before include keywords and macros are expanded and
2460 Babel code blocks executed, on a copy of the original buffer
2461 being exported. Visibility and narrowing are preserved. Point
2462 is at the beginning of the buffer.
2464 Every function in this hook will be called with one argument: the
2468 "Hook run before parsing an export buffer.
2470 This is run after include keywords and macros have been expanded
2471 and Babel code blocks executed, on a copy of the original buffer
2472 being exported. Visibility and narrowing are preserved. Point
2473 is at the beginning of the buffer.
2475 Every function in this hook will be called with one argument: the
2479 ;;;; Special Filters
2482 "List of functions applied to the export options.
2483 Each filter is called with two arguments: the export options, as
2484 a plist, and the back-end, as a symbol. It must return
2488 "List of functions applied to the parsed tree.
2489 Each filter is called with three arguments: the parse tree, as
2490 returned by `org-element-parse-buffer', the back-end, as
2491 a symbol, and the communication channel, as a plist. It must
2495 "List of functions applied to plain text.
2496 Each filter is called with three arguments: a string which
2497 contains no Org syntax, the back-end, as a symbol, and the
2498 communication channel, as a plist. It must return a string or
2502 "List of functions applied to the transcoded string.
2503 Each filter is called with three arguments: the full transcoded
2504 string, the back-end, as a symbol, and the communication channel,
2505 as a plist. It must return a string that will be used as the
2509 ;;;; Elements Filters
2512 "List of functions applied to a transcoded babel-call.
2513 Each filter is called with three arguments: the transcoded data,
2514 as a string, the back-end, as a symbol, and the communication
2518 "List of functions applied to a transcoded center block.
2519 Each filter is called with three arguments: the transcoded data,
2520 as a string, the back-end, as a symbol, and the communication
2524 "List of functions applied to a transcoded clock.
2525 Each filter is called with three arguments: the transcoded data,
2526 as a string, the back-end, as a symbol, and the communication
2530 "List of functions applied to a transcoded comment.
2531 Each filter is called with three arguments: the transcoded data,
2532 as a string, the back-end, as a symbol, and the communication
2536 "List of functions applied to a transcoded comment-block.
2537 Each filter is called with three arguments: the transcoded data,
2538 as a string, the back-end, as a symbol, and the communication
2542 "List of functions applied to a transcoded diary-sexp.
2543 Each filter is called with three arguments: the transcoded data,
2544 as a string, the back-end, as a symbol, and the communication
2548 "List of functions applied to a transcoded drawer.
2549 Each filter is called with three arguments: the transcoded data,
2550 as a string, the back-end, as a symbol, and the communication
2554 "List of functions applied to a transcoded dynamic-block.
2555 Each filter is called with three arguments: the transcoded data,
2556 as a string, the back-end, as a symbol, and the communication
2560 "List of functions applied to a transcoded example-block.
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-block.
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 fixed-width.
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 footnote-definition.
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 headline.
2585 Each filter is called with three arguments: the transcoded data,
2586 as a string, the back-end, as a symbol, and the communication
2590 "List of functions applied to a transcoded horizontal-rule.
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 inlinetask.
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 item.
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 keyword.
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 latex-environment.
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 node-property.
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 paragraph.
2627 Each filter is called with three arguments: the transcoded data,
2628 as a string, the back-end, as a symbol, and the communication
2632 "List of functions applied to a transcoded plain-list.
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 planning.
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 property-drawer.
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 quote block.
2651 Each filter is called with three arguments: the transcoded quote
2652 data, as a string, the back-end, as a symbol, and the
2653 communication channel, as a plist. It must return a string or
2657 "List of functions applied to a transcoded section.
2658 Each filter is called with three arguments: the transcoded data,
2659 as a string, the back-end, as a symbol, and the communication
2663 "List of functions applied to a transcoded special block.
2664 Each filter is called with three arguments: the transcoded data,
2665 as a string, the back-end, as a symbol, and the communication
2669 "List of functions applied to a transcoded src-block.
2670 Each filter is called with three arguments: the transcoded data,
2671 as a string, the back-end, as a symbol, and the communication
2675 "List of functions applied to a transcoded table.
2676 Each filter is called with three arguments: the transcoded data,
2677 as a string, the back-end, as a symbol, and the communication
2681 "List of functions applied to a transcoded table-cell.
2682 Each filter is called with three arguments: the transcoded data,
2683 as a string, the back-end, as a symbol, and the communication
2687 "List of functions applied to a transcoded table-row.
2688 Each filter is called with three arguments: the transcoded data,
2689 as a string, the back-end, as a symbol, and the communication
2693 "List of functions applied to a transcoded verse block.
2694 Each filter is called with three arguments: the transcoded data,
2695 as a string, the back-end, as a symbol, and the communication
2699 ;;;; Objects Filters
2702 "List of functions applied to transcoded bold text.
2703 Each filter is called with three arguments: the transcoded data,
2704 as a string, the back-end, as a symbol, and the communication
2708 "List of functions applied to transcoded code text.
2709 Each filter is called with three arguments: the transcoded data,
2710 as a string, the back-end, as a symbol, and the communication
2714 "List of functions applied to a transcoded entity.
2715 Each filter is called with three arguments: the transcoded data,
2716 as a string, the back-end, as a symbol, and the communication
2720 "List of functions applied to a transcoded export-snippet.
2721 Each filter is called with three arguments: the transcoded data,
2722 as a string, the back-end, as a symbol, and the communication
2726 "List of functions applied to a transcoded footnote-reference.
2727 Each filter is called with three arguments: the transcoded data,
2728 as a string, the back-end, as a symbol, and the communication
2732 "List of functions applied to a transcoded inline-babel-call.
2733 Each filter is called with three arguments: the transcoded data,
2734 as a string, the back-end, as a symbol, and the communication
2738 "List of functions applied to a transcoded inline-src-block.
2739 Each filter is called with three arguments: the transcoded data,
2740 as a string, the back-end, as a symbol, and the communication
2744 "List of functions applied to transcoded italic text.
2745 Each filter is called with three arguments: the transcoded data,
2746 as a string, the back-end, as a symbol, and the communication
2750 "List of functions applied to a transcoded latex-fragment.
2751 Each filter is called with three arguments: the transcoded data,
2752 as a string, the back-end, as a symbol, and the communication
2756 "List of functions applied to a transcoded line-break.
2757 Each filter is called with three arguments: the transcoded data,
2758 as a string, the back-end, as a symbol, and the communication
2762 "List of functions applied to a transcoded link.
2763 Each filter is called with three arguments: the transcoded data,
2764 as a string, the back-end, as a symbol, and the communication
2768 "List of functions applied to a transcoded radio-target.
2769 Each filter is called with three arguments: the transcoded data,
2770 as a string, the back-end, as a symbol, and the communication
2774 "List of functions applied to a transcoded statistics-cookie.
2775 Each filter is called with three arguments: the transcoded data,
2776 as a string, the back-end, as a symbol, and the communication
2780 "List of functions applied to transcoded strike-through text.
2781 Each filter is called with three arguments: the transcoded data,
2782 as a string, the back-end, as a symbol, and the communication
2786 "List of functions applied to a transcoded subscript.
2787 Each filter is called with three arguments: the transcoded data,
2788 as a string, the back-end, as a symbol, and the communication
2792 "List of functions applied to a transcoded superscript.
2793 Each filter is called with three arguments: the transcoded data,
2794 as a string, the back-end, as a symbol, and the communication
2798 "List of functions applied to a transcoded target.
2799 Each filter is called with three arguments: the transcoded data,
2800 as a string, the back-end, as a symbol, and the communication
2804 "List of functions applied to a transcoded timestamp.
2805 Each filter is called with three arguments: the transcoded data,
2806 as a string, the back-end, as a symbol, and the communication
2810 "List of functions applied to transcoded underline text.
2811 Each filter is called with three arguments: the transcoded data,
2812 as a string, the back-end, as a symbol, and the communication
2816 "List of functions applied to transcoded verbatim text.
2817 Each filter is called with three arguments: the transcoded data,
2818 as a string, the back-end, as a symbol, and the communication
2822 ;;;; Filters Tools
2823 ;;
2824 ;; Internal function `org-export-install-filters' installs filters
2825 ;; hard-coded in back-ends (developer filters) and filters from global
2826 ;; variables (user filters) in the communication channel.
2827 ;;
2828 ;; Internal function `org-export-filter-apply-functions' takes care
2829 ;; about applying each filter in order to a given data. It ignores
2830 ;; filters returning a nil value but stops whenever a filter returns
2831 ;; an empty string.
2834 "Call every function in FILTERS.
2836 Functions are called with arguments VALUE, current export
2837 back-end's name and INFO. A function returning a nil value will
2838 be skipped. If it returns the empty string, the process ends and
2839 VALUE is ignored.
2841 Call is done in a LIFO fashion, to be sure that developer
2842 specified filters, if any, are called first."
2853 "Install filters properties in communication channel.
2854 INFO is a plist containing the current communication channel.
2855 Return the updated communication channel."
2857 ;; Install user-defined filters with `org-export-filters-alist'
2858 ;; and filters already in INFO (through ext-plist mechanism).
2865 ;; Filters in INFO will be called
2866 ;; before those user provided.
2869 default-value)))))
2870 org-export-filters-alist)
2871 ;; Prepend back-end specific filters to that list.
2873 ;; Single values get consed, lists are appended.
2878 plist key
2882 ;; Return new communication channel.
2886 \f
2887 ;;; Core functions
2888 ;;
2889 ;; This is the room for the main function, `org-export-as', along with
2890 ;; its derivative, `org-export-string-as'.
2891 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2892 ;; function should be added to kill ring.
2893 ;;
2894 ;; Note that `org-export-as' doesn't really parse the current buffer,
2895 ;; but a copy of it (with the same buffer-local variables and
2896 ;; visibility), where macros and include keywords are expanded and
2897 ;; Babel blocks are executed, if appropriate.
2898 ;; `org-export-with-buffer-copy' macro prepares that copy.
2899 ;;
2900 ;; File inclusion is taken care of by
2901 ;; `org-export-expand-include-keyword' and
2902 ;; `org-export--prepare-file-contents'. Structure wise, including
2903 ;; a whole Org file in a buffer often makes little sense. For
2904 ;; example, if the file contains a headline and the include keyword
2905 ;; was within an item, the item should contain the headline. That's
2906 ;; why file inclusion should be done before any structure can be
2907 ;; associated to the file, that is before parsing.
2908 ;;
2909 ;; `org-export-insert-default-template' is a command to insert
2910 ;; a default template (or a back-end specific template) at point or in
2911 ;; current subtree.
2914 "Return a copy of the current buffer.
2915 The copy preserves Org buffer-local variables, visibility and
2916 narrowing."
2922 new-buf))
2925 "Apply BODY in a copy of the current buffer.
2926 The copy preserves local variables, visibility and contents of
2927 the original buffer. Point is at the beginning of the buffer
2928 when BODY is applied."
2937 ;; Kill copy without confirmation.
2943 "Generate a function duplicating BUFFER.
2945 The copy will preserve local variables, visibility, contents and
2946 narrowing of the original buffer. If a region was active in
2947 BUFFER, contents will be narrowed to that region instead.
2949 The resulting function can be evaluated at a later time, from
2950 another buffer, effectively cloning the original buffer there.
2952 The function assumes BUFFER's major mode is `org-mode'."
2956 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2957 ;; already in BUFFER.
2959 ;; Copy specific buffer local variables and variables set
2960 ;; through BIND keywords.
2962 vars)
2968 ;; Do not share cache across
2969 ;; buffers as values are
2970 ;; modified by side effect.
2971 org-element--cache)))
2974 buffer-file-name
2975 buffer-file-coding-system))
2979 ;; Skip unreadable values, as they cannot be
2980 ;; sent to external process.
2984 vars))))))
2985 ;; Whole buffer contents.
2990 ;; Narrowing.
2994 ;; Current position of point.
2996 ;; Overlays with invisible property.
3006 ov-set))))
3008 ov-set)))))
3010 ;;;###autoload
3013 "Transcode current Org buffer into BACKEND code.
3015 BACKEND is either an export back-end, as returned by, e.g.,
3016 `org-export-create-backend', or a symbol referring to
3017 a registered back-end.
3019 If narrowing is active in the current buffer, only transcode its
3020 narrowed part.
3022 If a region is active, transcode that region.
3024 When optional argument SUBTREEP is non-nil, transcode the
3025 sub-tree at point, extracting information from the headline
3026 properties first.
3028 When optional argument VISIBLE-ONLY is non-nil, don't export
3029 contents of hidden elements.
3031 When optional argument BODY-ONLY is non-nil, only return body
3032 code, without surrounding template.
3034 Optional argument EXT-PLIST, when provided, is a property list
3035 with external parameters overriding Org default settings, but
3036 still inferior to file-local settings.
3038 Return code as a string."
3043 ;; Narrow buffer to an appropriate region or subtree for
3044 ;; parsing. If parsing subtree, be sure to remove main headline
3045 ;; too.
3053 ;; Initialize communication channel with original buffer
3054 ;; attributes, unavailable in its copy.
3063 tree)
3064 ;; Update communication channel and get parse tree. Buffer
3065 ;; isn't parsed directly. Instead, a temporary copy is
3066 ;; created, where include keywords, macros are expanded and
3067 ;; code blocks are evaluated.
3069 ;; Run first hook with current back-end's name as argument.
3073 ;; Update macro templates since #+INCLUDE keywords might have
3074 ;; added some new ones.
3078 ;; Update radio targets since keyword inclusion might have
3079 ;; added some more.
3081 ;; Run last hook with current back-end's name as argument.
3086 ;; Update communication channel with environment. Also
3087 ;; install user's and developer's filters.
3092 ;; Expand export-specific set of macros: {{{author}}},
3093 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3094 ;; once regular macros have been expanded, since document
3095 ;; keywords may contain one of them.
3101 ;; EMAIL is not a parsed keyword: store it as-is.
3105 ;; Parse buffer.
3107 ;; Handle left-over uninterpreted elements or objects in
3108 ;; parse tree and communication channel.
3110 ;; Call options filters and update export options. We do not
3111 ;; use `org-export-filter-apply-functions' here since the
3112 ;; arity of such filters is different.
3117 ;; Parse buffer, handle uninterpreted elements or objects,
3118 ;; then call parse-tree filters.
3122 ;; Now tree is complete, compute its properties and add them
3123 ;; to communication channel.
3127 ;; Eventually transcode TREE. Wrap the resulting string into
3128 ;; a template.
3137 ;; Remove all text properties since they cannot be
3138 ;; retrieved from an external process. Finally call
3139 ;; final-output filter and return result.
3145 info))))))))
3147 ;;;###autoload
3149 "Transcode STRING into BACKEND code.
3151 BACKEND is either an export back-end, as returned by, e.g.,
3152 `org-export-create-backend', or a symbol referring to
3153 a registered back-end.
3155 When optional argument BODY-ONLY is non-nil, only return body
3156 code, without preamble nor postamble.
3158 Optional argument EXT-PLIST, when provided, is a property list
3159 with external parameters overriding Org default settings, but
3160 still inferior to file-local settings.
3162 Return code as a string."
3168 ;;;###autoload
3170 "Replace the active region by its export to BACKEND.
3171 BACKEND is either an export back-end, as returned by, e.g.,
3172 `org-export-create-backend', or a symbol referring to
3173 a registered back-end."
3183 ;;;###autoload
3185 "Insert all export keywords with default values at beginning of line.
3187 BACKEND is a symbol referring to the name of a registered export
3188 back-end, for which specific export options should be added to
3189 the template, or `default' for default template. When it is nil,
3190 the user will be prompted for a category.
3192 If SUBTREEP is non-nil, export configuration will be set up
3193 locally for the subtree through node properties."
3203 "Options category: "
3207 org-export--registered-backends))))))
3208 options keywords)
3209 ;; Populate OPTIONS and KEYWORDS.
3226 ;; Move to an appropriate location in order to insert options.
3228 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3246 ;; Then the rest of keywords, in the order specified in either
3247 ;; `org-export-options-alist' or respective export back-ends.
3268 "Expand every include keyword in buffer.
3269 Optional argument INCLUDED is a list of included file names along
3270 with their line restriction, when appropriate. It is used to
3271 avoid infinite recursion. Optional argument DIR is the current
3272 working directory. It is used to properly resolve relative
3273 paths."
3280 ;; Extract arguments from keyword's value.
3288 dir)
3293 value)
3299 ;; Minimal level of included file defaults to the child
3300 ;; level of the current headline, if any, or one. It
3301 ;; only applies is the file is meant to be included as
3302 ;; an Org one.
3310 ;; Remove keyword.
3316 ;; Check if files has already been parsed. Look after
3317 ;; inclusion lines too, as different parts of the same file
3318 ;; can be included too.
3330 ind-str contents ind-str))))
3338 ind-str env contents ind-str))))
3351 "Prepare the contents of FILE for inclusion and return them as a string.
3353 When optional argument LINES is a string specifying a range of
3354 lines, include only those lines.
3356 Optional argument IND, when non-nil, is an integer specifying the
3357 global indentation of returned contents. Since its purpose is to
3358 allow an included file to stay in the same environment it was
3359 created \(i.e. a list item), it doesn't apply past the first
3360 headline encountered.
3362 Optional argument MINLEVEL, when non-nil, is an integer
3363 specifying the level that any top-level headline in the included
3364 file should have."
3380 ;; Remove blank lines at beginning and end of contents. The logic
3381 ;; behind that removal is that blank lines around include keyword
3382 ;; override blank lines in included file.
3391 ;; If IND is set, preserve indentation of include keyword until
3392 ;; the first headline encountered.
3399 ;; Do not move footnote definitions out of column 0.
3405 ;; When MINLEVEL is specified, compute minimal level for headlines
3406 ;; in the file (CUR-MIN), and remove stars to each headline so
3407 ;; that headlines with minimal level have a level of MINLEVEL.
3418 ;; Only change stars, don't bother moving whole
3419 ;; sections.
3426 "Execute every Babel code in the visible part of current buffer."
3427 ;; Get a pristine copy of current buffer so Babel references can be
3428 ;; properly resolved.
3435 "Return a non-nil value when output should be added to the kill ring.
3436 See also `org-export-copy-to-kill-ring'."
3442 \f
3443 ;;; Tools For Back-Ends
3444 ;;
3445 ;; A whole set of tools is available to help build new exporters. Any
3446 ;; function general enough to have its use across many back-ends
3447 ;; should be added here.
3449 ;;;; For Affiliated Keywords
3450 ;;
3451 ;; `org-export-read-attribute' reads a property from a given element
3452 ;; as a plist. It can be used to normalize affiliated keywords'
3453 ;; syntax.
3454 ;;
3455 ;; Since captions can span over multiple lines and accept dual values,
3456 ;; their internal representation is a bit tricky. Therefore,
3457 ;; `org-export-get-caption' transparently returns a given element's
3458 ;; caption as a secondary string.
3461 "Turn ATTRIBUTE property from ELEMENT into a plist.
3463 When optional argument PROPERTY is non-nil, return the value of
3464 that property within attributes.
3468 properties.
3470 All values will become strings except the empty string and
3473 will become the empty string."
3487 s)
3492 ;; Ignore any string before first property with `cdr'.
3497 "Return caption from ELEMENT as a secondary string.
3499 When optional argument SHORTP is non-nil, return short caption,
3500 as a secondary string, instead.
3502 Caption lines are separated by a white space."
3510 ;;;; For Derived Back-ends
3511 ;;
3512 ;; `org-export-with-backend' is a function allowing to locally use
3513 ;; another back-end to transcode some object or element. In a derived
3514 ;; back-end, it may be used as a fall-back function once all specific
3515 ;; cases have been treated.
3518 "Call a transcoder from BACKEND on DATA.
3519 BACKEND is an export back-end, as returned by, e.g.,
3520 `org-export-create-backend', or a symbol referring to
3521 a registered back-end. DATA is an Org element, object, secondary
3522 string or string. CONTENTS, when non-nil, is the transcoded
3523 contents of DATA element, as a string. INFO, when non-nil, is
3524 the communication channel used for export, as a plist."
3534 transcoder data contents
3537 :translate-alist all-transcoders
3541 ;;;; For Export Snippets
3542 ;;
3543 ;; Every export snippet is transmitted to the back-end. Though, the
3544 ;; latter will only retain one type of export-snippet, ignoring
3545 ;; others, based on the former's target back-end. The function
3546 ;; `org-export-snippet-backend' returns that back-end for a given
3547 ;; export-snippet.
3550 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3551 Translation, with `org-export-snippet-translation-alist', is
3552 applied."
3556 back-end))))
3559 ;;;; For Footnotes
3560 ;;
3561 ;; `org-export-collect-footnote-definitions' is a tool to list
3562 ;; actually used footnotes definitions in the whole parse tree, or in
3563 ;; a headline, in order to add footnote listings throughout the
3564 ;; transcoded data.
3565 ;;
3566 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3567 ;; back-ends, when they need to attach the footnote definition only to
3568 ;; the first occurrence of the corresponding label.
3569 ;;
3570 ;; `org-export-get-footnote-definition' and
3571 ;; `org-export-get-footnote-number' provide easier access to
3572 ;; additional information relative to a footnote reference.
3575 "Return an alist between footnote numbers, labels and definitions.
3577 DATA is the parse tree from which definitions are collected.
3578 INFO is the plist used as a communication channel.
3580 Definitions are sorted by order of references. They either
3581 appear as Org data or as a secondary string for inlined
3582 footnotes. Unreferenced definitions are ignored."
3584 collect-fn ; for byte-compiler.
3588 ;; Collect footnote number, label and definition in DATA.
3596 def)
3597 num-alist)
3598 ;; Also search in definition for nested footnotes.
3601 ;; Don't enter footnote definitions since it will happen
3602 ;; when their first reference is found.
3608 "Non-nil when a footnote reference is the first one for its label.
3610 FOOTNOTE-REFERENCE is the footnote reference being considered.
3611 INFO is the plist used as a communication channel."
3613 ;; Anonymous footnotes are always a first reference.
3615 ;; Otherwise, return the first footnote with the same LABEL and
3616 ;; test if it is equal to FOOTNOTE-REFERENCE.
3626 ;; If FN isn't inlined, be sure to traverse its
3627 ;; definition before resuming search. See
3628 ;; comments in `org-export-get-footnote-number'
3629 ;; for more information.
3633 ;; Don't enter footnote definitions since it will
3634 ;; happen when their first reference is found.
3637 footnote-reference)))))
3640 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3641 INFO is the plist used as a communication channel. If no such
3643 string."
3650 "Return number associated to a footnote.
3652 FOOTNOTE is either a footnote reference or a footnote definition.
3653 INFO is the plist used as a communication channel."
3655 seen-refs
3656 search-ref ; For byte-compiler.
3660 ;; Search footnote references through DATA, filling
3661 ;; SEEN-REFS along the way.
3666 ;; Anonymous footnote match: return number.
3669 ;; Labels match: return number.
3672 ;; Anonymous footnote: it's always a new one.
3673 ;; Also, be sure to return nil from the `cond' so
3674 ;; `first-match' doesn't get us out of the loop.
3676 ;; Label not seen so far: add it so SEEN-REFS.
3677 ;;
3678 ;; Also search for subsequent references in
3679 ;; footnote definition so numbering follows
3680 ;; reading logic. Note that we don't have to care
3681 ;; about inline definitions, since
3682 ;; `org-element-map' already traverses them at the
3683 ;; right time.
3684 ;;
3685 ;; Once again, return nil to stay in the loop.
3690 nil))))
3691 ;; Don't enter footnote definitions since it will
3692 ;; happen when their first reference is found.
3697 ;;;; For Headlines
3698 ;;
3699 ;; `org-export-get-relative-level' is a shortcut to get headline
3700 ;; level, relatively to the lower headline level in the parsed tree.
3701 ;;
3702 ;; `org-export-get-headline-number' returns the section number of an
3703 ;; headline, while `org-export-number-to-roman' allows to convert it
3704 ;; to roman numbers.
3705 ;;
3706 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3707 ;; `org-export-last-sibling-p' are three useful predicates when it
3708 ;; comes to fulfill the `:headline-levels' property.
3709 ;;
3710 ;; `org-export-get-tags', `org-export-get-category' and
3711 ;; `org-export-get-node-property' extract useful information from an
3712 ;; headline or a parent headline. They all handle inheritance.
3713 ;;
3714 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3715 ;; as a secondary string, suitable for table of contents. It falls
3716 ;; back onto default title.
3719 "Return HEADLINE relative level within current parsed tree.
3720 INFO is a plist holding contextual information."
3725 "Non-nil when HEADLINE is considered as low level.
3727 INFO is a plist used as a communication channel.
3729 A low level headlines has a relative level greater than
3730 `:headline-levels' property value.
3732 Return value is the difference between HEADLINE relative level
3733 and the last level being considered as high enough, or nil."
3740 "Return HEADLINE numbering as a list of numbers.
3741 INFO is a plist holding contextual information."
3745 "Return a non-nil value if HEADLINE element should be numbered.
3746 INFO is a plist used as a communication channel."
3752 "Convert integer N into a roman numeral."
3765 res)))
3768 "Return list of tags associated to ELEMENT.
3770 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3771 is a plist used as a communication channel.
3773 Select tags (see `org-export-select-tags') and exclude tags (see
3774 `org-export-exclude-tags') are removed from the list.
3776 When non-nil, optional argument TAGS should be a list of strings.
3777 Any tag belonging to this list will also be removed.
3779 When optional argument INHERITED is non-nil, tags can also be
3780 inherited from parent headlines and FILETAGS keywords."
3786 ;; Build complete list of inherited tags.
3797 ;; Add FILETAGS keywords and return results.
3801 "Return node PROPERTY value for BLOB.
3803 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3804 element or object.
3806 If optional argument INHERITED is non-nil, the value can be
3807 inherited from a parent headline.
3809 Return value is a string or nil."
3821 "Return category for element or object BLOB.
3823 INFO is a plist used as a communication channel.
3825 CATEGORY is automatically inherited from a parent headline, from
3826 #+CATEGORY: keyword or created out of original file name. If all
3830 ;; Almost like `org-export-node-property', but we cannot trust
3831 ;; `plist-member' as every headline has a `:CATEGORY'
3832 ;; property, would it be nil or equal to "???" (which has the
3833 ;; same meaning).
3851 "Return alternative title for HEADLINE, as a secondary string.
3852 INFO is a plist used as a communication channel. If no optional
3853 title is defined, fall-back to the regular title."
3858 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3859 INFO is a plist used as a communication channel."
3864 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3865 INFO is a plist used as a communication channel."
3869 ;;;; For Keywords
3870 ;;
3871 ;; `org-export-get-date' returns a date appropriate for the document
3872 ;; to about to be exported. In particular, it takes care of
3873 ;; `org-export-date-timestamp-format'.
3876 "Return date value for the current document.
3878 INFO is a plist used as a communication channel. FMT, when
3879 non-nil, is a time format string that will be applied on the date
3880 if it consists in a single timestamp object. It defaults to
3881 `org-export-date-timestamp-format' when nil.
3883 A proper date can be a secondary string, a string or nil. It is
3884 meant to be translated with `org-export-data' or alike."
3895 ;;;; For Links
3896 ;;
3897 ;; `org-export-solidify-link-text' turns a string into a safer version
3898 ;; for links, replacing most non-standard characters with hyphens.
3899 ;;
3900 ;; `org-export-get-coderef-format' returns an appropriate format
3901 ;; string for coderefs.
3902 ;;
3903 ;; `org-export-inline-image-p' returns a non-nil value when the link
3904 ;; provided should be considered as an inline image.
3905 ;;
3906 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3907 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3908 ;; returns an appropriate unique identifier when found, or nil.
3909 ;;
3910 ;; `org-export-resolve-id-link' returns the first headline with
3911 ;; specified id or custom-id in parse tree, the path to the external
3912 ;; file with the id or nil when neither was found.
3913 ;;
3914 ;; `org-export-resolve-coderef' associates a reference to a line
3915 ;; number in the element it belongs, or returns the reference itself
3916 ;; when the element isn't numbered.
3919 "Take link text S and make a safe target out of it."
3924 "Return format string for code reference link.
3925 PATH is the link path. DESC is its description."
3933 "Non-nil if LINK object points to an inline image.
3935 Optional argument is a set of RULES defining inline images. It
3936 is an alist where associations have the following shape:
3938 \(TYPE . REGEXP)
3940 Applying a rule means apply REGEXP against LINK's path when its
3941 type is TYPE. The function will return a non-nil value if any of
3942 the provided rules is non-nil. The default rule is
3943 `org-export-default-inline-image-rule'.
3945 This only applies to links without a description."
3956 rules)
3957 ;; Return nil if no rule matched.
3958 nil))))
3961 "Resolve a code reference REF.
3963 INFO is a plist used as a communication channel.
3965 Return associated line number in source code, or REF itself,
3966 depending on src-block or example element's switches."
3973 org-coderef-label-format)))
3977 ;; Element containing REF is found. Resolve it to either
3978 ;; a label or a line number, as needed.
3988 "Return LINK destination.
3990 INFO is a plist holding contextual information.
3992 Return value can be an object, an element, or nil:
3994 - If LINK path matches a target object (i.e. <<path>>) return it.
3996 - If LINK path exactly matches the name affiliated keyword
3997 \(i.e. #+NAME: path) of an element, return that element.
3999 - If LINK path exactly matches any headline name, return that
4000 element. If more than one headline share that name, priority
4001 will be given to the one with the closest common ancestor, if
4002 any, or the first one in the parse tree otherwise.
4004 - Otherwise, return nil.
4007 significant."
4010 ;; Split PATH at white spaces so matches are space
4011 ;; insensitive.
4014 ;; Cache for destinations that are not position dependent.
4022 ;; Destination is not position dependent: use cached value.
4024 ;; First try to find a matching "<<path>>" unless user specified
4025 ;; he was looking for a headline (path starts with a "*"
4026 ;; character).
4032 path)
4033 blob))
4036 ;; Then try to find an element with a matching "#+NAME: path"
4037 ;; affiliated keyword.
4040 org-element-all-elements
4045 el)))
4048 ;; Last case: link either points to a headline or to nothingness.
4049 ;; Try to find the source, with priority given to headlines with
4050 ;; the closest common ancestor. If such candidate is found,
4051 ;; return it, otherwise return nil.
4055 ;; Return first headline whose `:raw-value' property is
4056 ;; NAME in parse tree DATA, or nil. Statistics cookies
4057 ;; are ignored.
4065 name)
4066 headline))
4068 ;; Search among headlines sharing an ancestor with link, from
4069 ;; closest to farthest.
4078 ;; No destination found: return nil.
4082 "Return headline referenced as LINK destination.
4084 INFO is a plist used as a communication channel.
4086 Return value can be the headline element matched in current parse
4090 ;; First check if id is within the current parse tree.
4095 headline))
4097 ;; Otherwise, look for external files.
4101 "Return radio-target object referenced as LINK destination.
4103 INFO is a plist used as a communication channel.
4105 Return value can be a radio-target object or nil. Assume LINK
4114 nil nil path nil nil t)
4115 t)
4116 radio))
4120 ;;;; For References
4121 ;;
4122 ;; `org-export-get-ordinal' associates a sequence number to any object
4123 ;; or element.
4126 "Return ordinal number of an element or object.
4128 ELEMENT is the element or object considered. INFO is the plist
4129 used as a communication channel.
4131 Optional argument TYPES, when non-nil, is a list of element or
4132 object types, as symbols, that should also be counted in.
4133 Otherwise, only provided element's type is considered.
4135 Optional argument PREDICATE is a function returning a non-nil
4136 value if the current element or object should be counted in. It
4137 accepts two arguments: the element or object being considered and
4138 the plist used as a communication channel. This allows to count
4139 only a certain type of objects (i.e. inline images).
4141 Return value is a list of numbers if ELEMENT is a headline or an
4142 item. It is nil for keywords. It represents the footnote number
4143 for footnote definitions and footnote references. If ELEMENT is
4144 a target, return the same value as if ELEMENT was the closest
4145 table, item or headline containing the target. In any other
4146 case, return the sequence number of ELEMENT among elements or
4147 objects of the same type."
4148 ;; Ordinal of a target object refer to the ordinal of the closest
4149 ;; table, item, or headline containing the object.
4153 when
4157 table))
4158 return parent)))
4160 ;; Special case 1: A headline returns its number as a list.
4162 ;; Special case 2: An item returns its number as a list.
4166 struct
4173 ;; Increment counter until ELEMENT is found again.
4184 ;;;; For Src-Blocks
4185 ;;
4186 ;; `org-export-get-loc' counts number of code lines accumulated in
4187 ;; src-block or example-block elements with a "+n" switch until
4188 ;; a given element, excluded. Note: "-n" switches reset that count.
4189 ;;
4190 ;; `org-export-unravel-code' extracts source code (along with a code
4191 ;; references alist) from an `element-block' or `src-block' type
4192 ;; element.
4193 ;;
4194 ;; `org-export-format-code' applies a formatting function to each line
4195 ;; of code, providing relative line number and code reference when
4196 ;; appropriate. Since it doesn't access the original element from
4197 ;; which the source code is coming, it expects from the code calling
4198 ;; it to know if lines should be numbered and if code references
4199 ;; should appear.
4200 ;;
4201 ;; Eventually, `org-export-format-code-default' is a higher-level
4202 ;; function (it makes use of the two previous functions) which handles
4203 ;; line numbering and code references inclusion, and returns source
4204 ;; code in a format suitable for plain text or verbatim output.
4207 "Return accumulated lines of code up to ELEMENT.
4209 INFO is the plist used as a communication channel.
4211 ELEMENT is excluded from count."
4217 ;; ELEMENT is reached: Quit the loop.
4219 ;; Only count lines from src-block and example-block elements
4220 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4224 ;; Accumulate locs or reset them.
4228 ;; Return nil to stay in the loop.
4229 nil)))
4231 ;; Return value.
4232 loc))
4235 "Clean source code and extract references out of it.
4237 ELEMENT has either a `src-block' an `example-block' type.
4239 Return a cons cell whose CAR is the source code, cleaned from any
4240 reference, protective commas and spurious indentation, and CDR is
4241 an alist between relative line number (integer) and name of code
4242 reference on that line (string)."
4245 ;; Get code and clean it. Remove blank lines at its
4246 ;; beginning and end.
4253 value
4255 ;; Get format used for references.
4258 org-coderef-label-format)))
4259 ;; Build a regexp matching a loc with a reference.
4264 ;; Return value.
4266 ;; Code with references removed.
4272 ;; Ref line: remove ref, and signal its position in REFS.
4276 ;; Reference alist.
4277 refs)))
4280 "Format CODE by applying FUN line-wise and return it.
4282 CODE is a string representing the code to format. FUN is
4283 a function. It must accept three arguments: a line of
4284 code (string), the current line number (integer) or nil and the
4285 reference associated to the current line (string) or nil.
4287 Optional argument NUM-LINES can be an integer representing the
4288 number of code lines accumulated until the current code. Line
4289 numbers passed to FUN will take it into account. If it is nil,
4290 FUN's second argument will always be nil. This number can be
4291 obtained with `org-export-get-loc' function.
4293 Optional argument REF-ALIST can be an alist between relative line
4294 number (i.e. ignoring NUM-LINES) and the name of the code
4295 reference on it. If it is nil, FUN's third argument will always
4296 be nil. It can be obtained through the use of
4297 `org-export-unravel-code' function."
4309 "Return source code from ELEMENT, formatted in a standard way.
4311 ELEMENT is either a `src-block' or `example-block' element. INFO
4312 is a plist used as a communication channel.
4314 This function takes care of line numbering and code references
4315 inclusion. Line numbers, when applicable, appear at the
4316 beginning of the line, separated from the code by two white
4317 spaces. Code references, on the other hand, appear flushed to
4318 the right, separated by six white spaces from the widest line of
4319 code."
4320 ;; Extract code and references.
4327 ;; Handle line numbering.
4336 ;; Prepare references display, if required. Any reference
4337 ;; should start six columns after the widest line of code,
4338 ;; wrapped with parenthesis.
4343 code
4347 number-str
4348 loc
4354 num-start refs)))))
4357 ;;;; For Tables
4358 ;;
4359 ;; `org-export-table-has-special-column-p' and and
4360 ;; `org-export-table-row-is-special-p' are predicates used to look for
4361 ;; meta-information about the table structure.
4362 ;;
4363 ;; `org-table-has-header-p' tells when the rows before the first rule
4364 ;; should be considered as table's header.
4365 ;;
4366 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4367 ;; and `org-export-table-cell-borders' extract information from
4368 ;; a table-cell element.
4369 ;;
4370 ;; `org-export-table-dimensions' gives the number on rows and columns
4371 ;; in the table, ignoring horizontal rules and special columns.
4372 ;; `org-export-table-cell-address', given a table-cell object, returns
4373 ;; the absolute address of a cell. On the other hand,
4374 ;; `org-export-get-table-cell-at' does the contrary.
4375 ;;
4376 ;; `org-export-table-cell-starts-colgroup-p',
4377 ;; `org-export-table-cell-ends-colgroup-p',
4378 ;; `org-export-table-row-starts-rowgroup-p',
4379 ;; `org-export-table-row-ends-rowgroup-p',
4380 ;; `org-export-table-row-starts-header-p' and
4381 ;; `org-export-table-row-ends-header-p' indicate position of current
4382 ;; row or cell within the table.
4385 "Non-nil when TABLE has a special column.
4386 All special columns will be ignored during export."
4387 ;; The table has a special column when every first cell of every row
4388 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4389 ;; "*" "_" and "^". Though, do not consider a first row containing
4390 ;; only empty cells as special.
4406 "Non-nil when TABLE has a header.
4408 INFO is a plist used as a communication channel.
4410 A table has a header when it contains at least two row groups."
4419 table
4430 cache)))))
4433 "Non-nil if TABLE-ROW is considered special.
4435 INFO is a plist used as the communication channel.
4437 All special rows will be ignored during export."
4441 ;; A row is special either when...
4443 ;; ... it starts with a field only containing "/",
4445 ;; ... the table contains a special column and the row start
4446 ;; with a marking character among, "^", "_", "$" or "!",
4450 ;; ... it contains only alignment cookies and empty cells.
4456 ;; Since VALUE is a secondary string, the following
4457 ;; checks avoid expanding it with `org-export-data'.
4469 "Return TABLE-ROW's group number, as an integer.
4471 INFO is a plist used as the communication channel.
4473 Return value is the group number, as an integer, or nil for
4474 special rows and rows separators. First group is also table's
4475 header."
4493 "Return TABLE-CELL contents width.
4495 INFO is a plist used as the communication channel.
4497 Return value is the width given by the last width cookie in the
4498 same column as TABLE-CELL, or nil."
4517 ;; In a special row, try to find a width cookie at COLUMN.
4521 ;; The following checks avoid expanding unnecessarily
4522 ;; the cell with `org-export-data'.
4532 "Return TABLE-CELL contents alignment.
4534 INFO is a plist used as the communication channel.
4536 Return alignment as specified by the last alignment cookie in the
4537 same column as TABLE-CELL. If no such cookie is found, a default
4538 alignment value will be deduced from fraction of numbers in the
4539 column (see `org-table-number-fraction' for more information).
4540 Possible values are `left', `right' and `center'."
4541 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4558 cookie-align
4559 previous-cell-number-p)
4562 ;; In a special row, try to find an alignment cookie at
4563 ;; COLUMN.
4567 ;; Since VALUE is a secondary string, the following
4568 ;; checks avoid useless expansion through
4569 ;; `org-export-data'.
4577 ;; Ignore table rules.
4579 ;; In a standard row, check if cell's contents are
4580 ;; expressing some kind of number. Increase NUMBER-CELLS
4581 ;; accordingly. Though, don't bother if an alignment
4582 ;; cookie has already defined cell's alignment.
4587 info)))
4589 ;; Treat an empty cell as a number if it follows
4590 ;; a number.
4596 ;; Return value. Alignment specified by cookies has
4597 ;; precedence over alignment deduced from cell's contents.
4599 column
4604 org-table-number-fraction)
4609 "Return TABLE-CELL borders.
4611 INFO is a plist used as a communication channel.
4613 Return value is a list of symbols, or nil. Possible values are:
4614 `top', `bottom', `above', `below', `left' and `right'. Note:
4615 `top' (resp. `bottom') only happen for a cell in the first
4616 row (resp. last row) of the table, ignoring table rules, if any.
4618 Returned borders ignore special rows."
4621 borders)
4622 ;; Top/above border? TABLE-CELL has a border above when a rule
4623 ;; used to demarcate row groups can be found above. Hence,
4624 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4625 ;; another regular row has to be found above that rule.
4634 ;; Look at every row before the current one.
4636 ;; No rule above, or rule found starts the table (ignoring any
4637 ;; special row): TABLE-CELL is at the top of the table.
4640 ;; Bottom/below border? TABLE-CELL has a border below when next
4641 ;; non-regular row below is a rule.
4650 ;; Look at every row after the current one.
4652 ;; No rule below, or rule found ends the table (modulo some
4653 ;; special row): TABLE-CELL is at the bottom of the table.
4656 ;; Right/left borders? They can only be specified by column
4657 ;; groups. Column groups are defined in a row starting with "/".
4658 ;; Also a column groups row only contains "<", "<>", ">" or blank
4659 ;; cells.
4676 ;; There's a left border when previous cell, if
4677 ;; any, ends a group, or current one starts one.
4683 ;; There's a right border when next cell, if any,
4684 ;; starts a group, or current one ends one.
4691 ;; Table rows are read in reverse order so last column groups
4692 ;; row has precedence over any previous one.
4694 ;; Return value.
4695 borders))
4698 "Non-nil when TABLE-CELL is at the beginning of a column group.
4699 INFO is a plist used as a communication channel."
4700 ;; A cell starts a column group either when it is at the beginning
4701 ;; of a row (or after the special column, if any) or when it has
4702 ;; a left border.
4705 table-cell)
4709 "Non-nil when TABLE-CELL is at the end of a column group.
4710 INFO is a plist used as a communication channel."
4711 ;; A cell ends a column group either when it is at the end of a row
4712 ;; or when it has a right border.
4715 table-cell)
4719 "Non-nil when TABLE-ROW is at the beginning of a row group.
4720 INFO is a plist used as a communication channel."
4728 "Non-nil when TABLE-ROW is at the end of a row group.
4729 INFO is a plist used as a communication channel."
4737 "Non-nil when TABLE-ROW is the first table header's row.
4738 INFO is a plist used as a communication channel."
4745 "Non-nil when TABLE-ROW is the last table header's row.
4746 INFO is a plist used as a communication channel."
4753 "Return TABLE-ROW number.
4754 INFO is a plist used as a communication channel. Return value is
4755 zero-based and ignores separators. The function returns nil for
4756 special columns and separators."
4768 "Return TABLE dimensions.
4770 INFO is a plist used as a communication channel.
4772 Return value is a CONS like (ROWS . COLUMNS) where
4773 ROWS (resp. COLUMNS) is the number of exportable
4774 rows (resp. columns)."
4776 ;; Set number of rows, and extract first one.
4782 ;; Set number of columns.
4784 ;; Return value.
4788 "Return address of a regular TABLE-CELL object.
4790 TABLE-CELL is the cell considered. INFO is a plist used as
4791 a communication channel.
4793 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4794 zero-based index. Only exportable cells are considered. The
4795 function returns nil for other cells."
4807 "Return regular table-cell object at ADDRESS in TABLE.
4809 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4810 zero-based index. TABLE is a table type element. INFO is
4811 a plist used as a communication channel.
4813 If no table-cell, among exportable cells, is found at ADDRESS,
4814 return nil."
4817 ;; Row at (car address) or nil.
4825 'table-cell
4832 ;;;; For Tables Of Contents
4833 ;;
4834 ;; `org-export-collect-headlines' builds a list of all exportable
4835 ;; headline elements, maybe limited to a certain depth. One can then
4836 ;; easily parse it and transcode it.
4837 ;;
4838 ;; Building lists of tables, figures or listings is quite similar.
4839 ;; Once the generic function `org-export-collect-elements' is defined,
4840 ;; `org-export-collect-tables', `org-export-collect-figures' and
4841 ;; `org-export-collect-listings' can be derived from it.
4844 "Collect headlines in order to build a table of contents.
4846 INFO is a plist used as a communication channel.
4848 When optional argument N is an integer, it specifies the depth of
4849 the table of contents. Otherwise, it is set to the value of the
4850 last headline level. See `org-export-headline-levels' for more
4851 information.
4853 Return a list of all exportable headlines as parsed elements.
4854 Footnote sections, if any, will be ignored."
4862 info)))
4865 "Collect referenceable elements of a determined type.
4867 TYPE can be a symbol or a list of symbols specifying element
4868 types to search. Only elements with a caption are collected.
4870 INFO is a plist used as a communication channel.
4872 When non-nil, optional argument PREDICATE is a function accepting
4873 one argument, an element of type TYPE. It returns a non-nil
4874 value when that element should be collected.
4876 Return a list of all elements found, in order of appearance."
4881 element))
4882 info))
4885 "Build a list of tables.
4886 INFO is a plist used as a communication channel.
4888 Return a list of table elements with a caption."
4892 "Build a list of figures.
4894 INFO is a plist used as a communication channel. PREDICATE is
4895 a function which accepts one argument: a paragraph element and
4896 whose return value is non-nil when that element should be
4897 collected.
4899 A figure is a paragraph type element, with a caption, verifying
4901 a vague concept that may depend on back-end.
4903 Return a list of elements recognized as figures."
4907 "Build a list of src blocks.
4909 INFO is a plist used as a communication channel.
4911 Return a list of src-block elements with a caption."
4915 ;;;; Smart Quotes
4916 ;;
4917 ;; The main function for the smart quotes sub-system is
4918 ;; `org-export-activate-smart-quotes', which replaces every quote in
4919 ;; a given string from the parse tree with its "smart" counterpart.
4920 ;;
4921 ;; Dictionary for smart quotes is stored in
4922 ;; `org-export-smart-quotes-alist'.
4923 ;;
4924 ;; Internally, regexps matching potential smart quotes (checks at
4925 ;; string boundaries are also necessary) are defined in
4926 ;; `org-export-smart-quotes-regexps'.
4930 ;; one may use: »...«, "...", ›...‹, or '...'.
4931 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4932 ;; LaTeX quotes require Babel!
4977 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4986 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4995 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5004 ;; http://ru.wikipedia.org/wiki/%D0%9A%D0%B0%D0%B2%D1%8B%D1%87%D0%BA%D0%B8#.D0.9A.D0.B0.D0.B2.D1.8B.D1.87.D0.BA.D0.B8.2C_.D0.B8.D1.81.D0.BF.D0.BE.D0.BB.D1.8C.D0.B7.D1.83.D0.B5.D0.BC.D1.8B.D0.B5_.D0.B2_.D1.80.D1.83.D1.81.D1.81.D0.BA.D0.BE.D0.BC_.D1.8F.D0.B7.D1.8B.D0.BA.D0.B5
5005 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5016 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5022 )
5023 "Smart quotes translations.
5025 Alist whose CAR is a language string and CDR is an alist with
5026 quote type as key and a plist associating various encodings to
5027 their translation as value.
5029 A quote type can be any symbol among `opening-double-quote',
5030 `closing-double-quote', `opening-single-quote',
5031 `closing-single-quote' and `apostrophe'.
5033 Valid encodings include `:utf-8', `:html', `:latex' and
5034 `:texinfo'.
5040 ;; Possible opening quote at beginning of string.
5042 ;; Possible closing quote at beginning of string.
5044 ;; Possible apostrophe at beginning of string.
5046 ;; Opening single and double quotes.
5048 ;; Closing single and double quotes.
5050 ;; Apostrophe.
5052 ;; Possible opening quote at end of string.
5054 ;; Possible closing quote at end of string.
5056 ;; Possible apostrophe at end of string.
5058 "List of regexps matching a quote or an apostrophe.
5064 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5065 `:utf-8'. INFO is a plist used as a communication channel.
5067 The function has to retrieve information about string
5068 surroundings in parse tree. It can only happen with an
5069 unmodified string. Thus, if S has already been through another
5070 process, a non-nil ORIGINAL optional argument will provide that
5071 original string.
5073 Return the new string."
5076 ;; Try to be flexible when computing number of blanks
5077 ;; before object. The previous object may be a string
5078 ;; introduced by the back-end and not completely parsed.
5081 ;; A string with missing `:post-blank'
5082 ;; property.
5086 ;; Fallback value.
5091 ;; Return smart quote associated to a give quote Q, as
5092 ;; a string. TYPE is a symbol among `open', `close' and
5093 ;; `apostrophe'.
5103 org-export-smart-quotes-alist))))
5104 encoding)
5105 q)))))
5107 ;; Only a quote: no regexp can match. We have to check both
5108 ;; sides and decide what to do.
5116 ;; 1. Replace quote character at the beginning of S.
5118 ;; Apostrophe?
5124 ;; Closing quote?
5130 ;; Opening quote?
5136 ;; 2. Replace quotes in the middle of the string.
5138 ;; Opening quotes.
5144 ;; Closing quotes.
5150 ;; Apostrophes.
5155 ;; 3. Replace quote character at the end of S.
5157 ;; Apostrophe?
5162 ;; Closing quote?
5168 ;; Opening quote?
5173 ;; Return string with smart quotes.
5174 s))))
5176 ;;;; Topology
5177 ;;
5178 ;; Here are various functions to retrieve information about the
5179 ;; neighborhood of a given element or object. Neighbors of interest
5180 ;; are direct parent (`org-export-get-parent'), parent headline
5181 ;; (`org-export-get-parent-headline'), first element containing an
5182 ;; object, (`org-export-get-parent-element'), parent table
5183 ;; (`org-export-get-parent-table'), previous element or object
5184 ;; (`org-export-get-previous-element') and next element or object
5185 ;; (`org-export-get-next-element').
5186 ;;
5187 ;; `org-export-get-genealogy' returns the full genealogy of a given
5188 ;; element or object, from closest parent to full parse tree.
5191 "Return full genealogy relative to a given element or object.
5193 BLOB is the element or object being considered.
5195 Ancestors are returned from closest to farthest, the last one
5196 being the full parse tree."
5203 "Return BLOB parent headline or nil.
5204 BLOB is the element or object being considered."
5208 parent))
5211 "Return first element containing OBJECT or nil.
5212 OBJECT is the object to consider."
5216 parent))
5219 "Return OBJECT parent table or nil.
5220 OBJECT is either a `table-cell' or `table-element' type object."
5224 parent))
5227 "Return previous element or object.
5229 BLOB is an element or object. INFO is a plist used as
5230 a communication channel. Return previous exportable element or
5231 object, a string, or nil.
5233 When optional argument N is a positive integer, return a list
5234 containing up to N siblings before BLOB, from farthest to
5235 closest. With any other non-nil value, return a list containing
5236 all of them."
5242 prev)
5252 "Return next element or object.
5254 BLOB is an element or object. INFO is a plist used as
5255 a communication channel. Return next exportable element or
5256 object, a string, or nil.
5258 When optional argument N is a positive integer, return a list
5259 containing up to N siblings after BLOB, from closest to farthest.
5260 With any other non-nil value, return a list containing all of
5261 them."
5268 next)
5278 ;;;; Translation
5279 ;;
5280 ;; `org-export-translate' translates a string according to the language
5281 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5282 ;; the dictionary used for the translation.
5329 ("ru" :html "(Продолжение следует)"
5427 ("ru" :html "Список распечаток"
5440 ("ru" :html "Список таблиц"
5520 ("ru" :html "Неизвестная ссылка"
5523 "Dictionary for export engine.
5525 Alist whose CAR is the string to translate and CDR is an alist
5526 whose CAR is the language string and CDR is a plist whose
5527 properties are possible charsets and values translated terms.
5529 It is used as a database for `org-export-translate'. Since this
5530 function returns the string as-is if no translation was found,
5531 the variable only needs to record values different from the
5535 "Translate string S according to language specification.
5537 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5538 and `:utf-8'. INFO is a plist used as a communication channel.
5540 Translation depends on `:language' property. Return the
5541 translated string. If no translation is found, try to fall back
5542 to `:default' encoding. If it fails, return S."
5548 s)))
5551 \f
5552 ;;; Asynchronous Export
5553 ;;
5554 ;; `org-export-async-start' is the entry point for asynchronous
5555 ;; export. It recreates current buffer (including visibility,
5556 ;; narrowing and visited file) in an external Emacs process, and
5557 ;; evaluates a command there. It then applies a function on the
5558 ;; returned results in the current process.
5559 ;;
5560 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5561 ;; allow to export to a buffer or a file, asynchronously or not.
5562 ;;
5563 ;; `org-export-output-file-name' is an auxiliary function meant to be
5564 ;; used with `org-export-to-file'. With a given extension, it tries
5565 ;; to provide a canonical file name to write export output to.
5566 ;;
5567 ;; Asynchronously generated results are never displayed directly.
5568 ;; Instead, they are stored in `org-export-stack-contents'. They can
5569 ;; then be retrieved by calling `org-export-stack'.
5570 ;;
5571 ;; Export Stack is viewed through a dedicated major mode
5572 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5573 ;;`org-export-stack-delete', `org-export-stack-view' and
5574 ;;`org-export-stack-clear'.
5575 ;;
5576 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5577 ;; It should be used whenever `org-export-async-start' is called.
5580 "Call function FUN on the results returned by BODY evaluation.
5582 BODY evaluation happens in an asynchronous process, from a buffer
5583 which is an exact copy of the current one.
5585 Use `org-export-add-to-stack' in FUN in order to register results
5586 in the stack.
5588 This is a low level function. See also `org-export-to-buffer'
5589 and `org-export-to-file' for more specialized functions."
5592 ;; Write the full sexp evaluating BODY in a copy of the current
5593 ;; buffer to a temporary file, as it may be too long for program
5594 ;; args in `start-process'.
5601 ;; Null characters (from variable values) are inserted
5602 ;; within the file. As a consequence, coding system for
5603 ;; buffer contents will not be recognized properly. So,
5604 ;; we make sure it is the same as the one used to display
5605 ;; the original buffer.
5607 ,coding
5610 ;; Ignore `kill-emacs-hook' and code evaluation
5611 ;; queries from Babel as we need a truly
5612 ;; non-interactive process.
5614 org-babel-confirm-evaluate-answer-no t)
5615 ;; Initialize export framework.
5617 ;; Re-create current buffer there.
5620 ;; Sexp to evaluate in the buffer.
5622 ;; Start external process.
5625 (,process
5627 #'start-process
5630 ,proc-buffer
5637 ;; Register running process in stack.
5639 ;; Set-up sentinel in order to catch results.
5642 ,process
5664 ;;;###autoload
5667 &optional async subtreep visible-only body-only ext-plist
5668 post-process)
5669 "Call `org-export-as' with output to a specified buffer.
5671 BACKEND is either an export back-end, as returned by, e.g.,
5672 `org-export-create-backend', or a symbol referring to
5673 a registered back-end.
5675 BUFFER is the name of the output buffer. If it already exists,
5676 it will be erased first, otherwise, it will be created.
5678 A non-nil optional argument ASYNC means the process should happen
5679 asynchronously. The resulting buffer should then be accessible
5680 through the `org-export-stack' interface. When ASYNC is nil, the
5681 buffer is displayed if `org-export-show-temporary-export-buffer'
5682 is non-nil.
5684 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5685 EXT-PLIST are similar to those used in `org-export-as', which
5686 see.
5688 Optional argument POST-PROCESS is a function which should accept
5689 no argument. It is always called within the current process,
5690 from BUFFER, with point at its beginning. Export back-ends can
5691 use it to set a major mode there, e.g,
5693 \(defun org-latex-export-as-latex
5694 \(&optional async subtreep visible-only body-only ext-plist)
5695 \(interactive)
5697 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5699 This function returns BUFFER."
5727 buffer)))
5729 ;;;###autoload
5732 post-process)
5733 "Call `org-export-as' with output to a specified file.
5735 BACKEND is either an export back-end, as returned by, e.g.,
5736 `org-export-create-backend', or a symbol referring to
5737 a registered back-end. FILE is the name of the output file, as
5738 a string.
5740 A non-nil optional argument ASYNC means the process should happen
5741 asynchronously. The resulting buffer will then be accessible
5742 through the `org-export-stack' interface.
5744 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5745 EXT-PLIST are similar to those used in `org-export-as', which
5746 see.
5748 Optional argument POST-PROCESS is called with FILE as its
5749 argument and happens asynchronously when ASYNC is non-nil. It
5750 has to return a file name, or nil. Export back-ends can use this
5751 to send the output file through additional processing, e.g,
5753 \(defun org-latex-export-to-latex
5754 \(&optional async subtreep visible-only body-only ext-plist)
5755 \(interactive)
5757 \(org-export-to-file 'latex outfile
5758 async subtreep visible-only body-only ext-plist
5759 \(lambda (file) (org-latex-compile file)))
5761 The function returns either a file name returned by POST-PROCESS,
5762 or FILE."
5780 backend subtreep visible-only body-only ext-plist)))
5787 ;; Get proper return value.
5789 file))))))
5792 "Return output file's name according to buffer specifications.
5794 EXTENSION is a string representing the output file extension,
5795 with the leading dot.
5797 With a non-nil optional argument SUBTREEP, try to determine
5799 of subtree at point.
5801 When optional argument PUB-DIR is set, use it as the publishing
5802 directory.
5804 When optional argument VISIBLE-ONLY is non-nil, don't export
5805 contents of hidden elements.
5807 Return file name as a string."
5810 ;; File name may come from EXPORT_FILE_NAME subtree
5811 ;; property, assuming point is at beginning of said
5812 ;; sub-tree.
5819 ;; File name may be extracted from buffer's associated
5820 ;; file, if any.
5822 ;; Can't determine file name on our own: Ask user.
5826 "Output file: " pub-dir nil nil nil
5830 ;; Build file name. Enforce EXTENSION over whatever user
5831 ;; may have come up with. PUB-DIR, if defined, always has
5832 ;; precedence over any provided path.
5837 extension))
5840 ;; If writing to OUTPUT-FILE would overwrite original file, append
5841 ;; EXTENSION another time to final name.
5844 output-file)))
5847 "Add a new result to export stack if not present already.
5849 SOURCE is a buffer or a file name containing export results.
5850 BACKEND is a symbol representing export back-end used to generate
5851 it.
5853 Entries already pointing to SOURCE and unavailable entries are
5854 removed beforehand. Return the new stack."
5860 "Menu for asynchronous export results and running processes."
5870 "Return source from export results at point in stack."
5877 source
5878 ;; SOURCE is not consistent with current line. The stack
5879 ;; view is outdated.
5883 "Remove all entries from export stack."
5888 "Refresh the asynchronous export stack.
5889 DUMMY is ignored. Unavailable sources are removed from the list.
5890 Return the new stack."
5900 ;; Back-end.
5902 ;; Age.
5905 ;; Compute age of the results.
5907 "%4h:%.2m "
5909 ;; Source.
5914 ;; Clear stack from exited processes, dead buffers or
5915 ;; non-existent files.
5927 "Remove export results at point from stack.
5928 If optional argument SOURCE is non-nil, remove it instead."
5933 org-export-stack-contents))))
5936 "View export results at point in stack.
5937 With an optional prefix argument IN-EMACS, force viewing files
5938 within Emacs."
5952 (define-key km "p" 'previous-line)
5953 (define-key km "\C-p" 'previous-line)
5954 (define-key km "\C-?" 'previous-line)
5955 (define-key km [up] 'previous-line)
5956 (define-key km "C" 'org-export-stack-clear)
5957 (define-key km "v" 'org-export-stack-view)
5958 (define-key km (kbd "RET") 'org-export-stack-view)
5959 (define-key km "d" 'org-export-stack-remove)
5960 km)
5961 "Keymap for Org Export Stack.")
5963 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5964 "Mode for displaying asynchronous export stack.
5967 stack.
5969 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5970 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5971 stack completely.
5973 Removing entries in an Org Export Stack buffer doesn't affect
5974 files or buffers, only the display.
5977 (abbrev-mode 0)
5978 (auto-fill-mode 0)
5979 (setq buffer-read-only t
5980 buffer-undo-list t
5981 truncate-lines t
5982 header-line-format
5983 '(:eval
5984 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5985 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5986 (set (make-local-variable 'revert-buffer-function)
5987 'org-export-stack-refresh))
5990 \f
5991 ;;; The Dispatcher
5992 ;;
5993 ;; `org-export-dispatch' is the standard interactive way to start an
5994 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5995 ;; for its interface, which, in turn, delegates response to key
5996 ;; pressed to `org-export--dispatch-action'.
5998 ;;;###autoload
5999 (defun org-export-dispatch (&optional arg)
6000 "Export dispatcher for Org mode.
6002 It provides an access to common export related tasks in a buffer.
6003 Its interface comes in two flavors: standard and expert.
6005 While both share the same set of bindings, only the former
6006 displays the valid keys associations in a dedicated buffer.
6007 Scrolling (resp. line-wise motion) in this buffer is done with
6008 SPC and DEL (resp. C-n and C-p) keys.
6010 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6011 flavor or the other.
6014 of options used back then, on the current buffer.
6016 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6017 (interactive "P")
6018 (let* ((input
6019 (cond ((equal arg '(16)) '(stack))
6020 ((and arg org-export-dispatch-last-action))
6021 (t (save-window-excursion
6022 (unwind-protect
6023 (progn
6024 ;; Remember where we are
6025 (move-marker org-export-dispatch-last-position
6026 (point)
6027 (org-base-buffer (current-buffer)))
6028 ;; Get and store an export command
6029 (setq org-export-dispatch-last-action
6030 (org-export--dispatch-ui
6031 (list org-export-initial-scope
6032 (and org-export-in-background 'async))
6033 nil
6034 org-export-dispatch-use-expert-ui)))
6035 (and (get-buffer "*Org Export Dispatcher*")
6036 (kill-buffer "*Org Export Dispatcher*")))))))
6037 (action (car input))
6038 (optns (cdr input)))
6039 (unless (memq 'subtree optns)
6040 (move-marker org-export-dispatch-last-position nil))
6041 (case action
6042 ;; First handle special hard-coded actions.
6043 (template (org-export-insert-default-template nil optns))
6044 (stack (org-export-stack))
6045 (publish-current-file
6046 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6047 (publish-current-project
6048 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6049 (publish-choose-project
6050 (org-publish (assoc (org-icompleting-read
6051 "Publish project: "
6052 org-publish-project-alist nil t)
6053 org-publish-project-alist)
6054 (memq 'force optns)
6055 (memq 'async optns)))
6056 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6057 (otherwise
6058 (save-excursion
6059 (when arg
6060 ;; Repeating command, maybe move cursor to restore subtree
6061 ;; context.
6062 (if (eq (marker-buffer org-export-dispatch-last-position)
6063 (org-base-buffer (current-buffer)))
6064 (goto-char org-export-dispatch-last-position)
6065 ;; We are in a different buffer, forget position.
6066 (move-marker org-export-dispatch-last-position nil)))
6067 (funcall action
6068 ;; Return a symbol instead of a list to ease
6069 ;; asynchronous export macro use.
6070 (and (memq 'async optns) t)
6071 (and (memq 'subtree optns) t)
6072 (and (memq 'visible optns) t)
6073 (and (memq 'body optns) t)))))))
6075 (defun org-export--dispatch-ui (options first-key expertp)
6076 "Handle interface for `org-export-dispatch'.
6078 OPTIONS is a list containing current interactive options set for
6079 export. It can contain any of the following symbols:
6080 `body' toggles a body-only export
6081 `subtree' restricts export to current subtree
6082 `visible' restricts export to visible part of buffer.
6083 `force' force publishing files.
6084 `async' use asynchronous export process
6086 FIRST-KEY is the key pressed to select the first level menu. It
6087 is nil when this menu hasn't been selected yet.
6089 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6090 buffer is provided, but indications about currently active
6091 options are given in the prompt. Moreover, \[?] allows to switch
6092 back to standard interface."
6093 (let* ((fontify-key
6094 (lambda (key &optional access-key)
6095 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6096 ;; non-nil is the required first-level key to activate
6097 ;; KEY. When its value is t, activate KEY independently
6098 ;; on the first key, if any. A nil value means KEY will
6099 ;; only be activated at first level.
6100 (if (or (eq access-key t) (eq access-key first-key))
6101 (org-propertize key 'face 'org-warning)
6102 key)))
6103 (fontify-value
6104 (lambda (value)
6105 ;; Fontify VALUE string.
6106 (org-propertize value 'face 'font-lock-variable-name-face)))
6107 ;; Prepare menu entries by extracting them from registered
6108 ;; back-ends and sorting them by access key and by ordinal,
6109 ;; if any.
6110 (entries
6111 (sort (sort (delq nil
6112 (mapcar 'org-export-backend-menu
6113 org-export--registered-backends))
6114 (lambda (a b)
6115 (let ((key-a (nth 1 a))
6116 (key-b (nth 1 b)))
6117 (cond ((and (numberp key-a) (numberp key-b))
6118 (< key-a key-b))
6119 ((numberp key-b) t)))))
6120 'car-less-than-car))
6121 ;; Compute a list of allowed keys based on the first key
6122 ;; pressed, if any. Some keys
6123 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6124 ;; available.
6125 (allowed-keys
6126 (nconc (list 2 22 19 6 1)
6127 (if (not first-key) (org-uniquify (mapcar 'car entries))
6128 (let (sub-menu)
6129 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6130 (when (eq (car entry) first-key)
6131 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6132 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6133 ((not first-key) (list ?P)))
6134 (list ?& ?#)
6135 (when expertp (list ??))
6136 (list ?q)))
6137 ;; Build the help menu for standard UI.
6138 (help
6139 (unless expertp
6140 (concat
6141 ;; Options are hard-coded.
6142 (format "[%s] Body only: %s [%s] Visible only: %s
6143 \[%s] Export scope: %s [%s] Force publishing: %s
6145 (funcall fontify-key "C-b" t)
6146 (funcall fontify-value
6147 (if (memq 'body options) "On " "Off"))
6148 (funcall fontify-key "C-v" t)
6149 (funcall fontify-value
6150 (if (memq 'visible options) "On " "Off"))
6151 (funcall fontify-key "C-s" t)
6152 (funcall fontify-value
6153 (if (memq 'subtree options) "Subtree" "Buffer "))
6154 (funcall fontify-key "C-f" t)
6155 (funcall fontify-value
6156 (if (memq 'force options) "On " "Off"))
6157 (funcall fontify-key "C-a" t)
6158 (funcall fontify-value
6159 (if (memq 'async options) "On " "Off")))
6160 ;; Display registered back-end entries. When a key
6161 ;; appears for the second time, do not create another
6162 ;; entry, but append its sub-menu to existing menu.
6163 (let (last-key)
6164 (mapconcat
6165 (lambda (entry)
6166 (let ((top-key (car entry)))
6167 (concat
6168 (unless (eq top-key last-key)
6169 (setq last-key top-key)
6171 (funcall fontify-key (char-to-string top-key))
6172 (nth 1 entry)))
6173 (let ((sub-menu (nth 2 entry)))
6174 (unless (functionp sub-menu)
6175 ;; Split sub-menu into two columns.
6176 (let ((index -1))
6177 (concat
6178 (mapconcat
6179 (lambda (sub-entry)
6180 (incf index)
6181 (format
6182 (if (zerop (mod index 2)) " [%s] %-26s"
6184 (funcall fontify-key
6185 (char-to-string (car sub-entry))
6186 top-key)
6187 (nth 1 sub-entry)))
6188 sub-menu "")
6190 entries ""))
6191 ;; Publishing menu is hard-coded.
6193 [%s] Current file [%s] Current project
6195 (funcall fontify-key "P")
6196 (funcall fontify-key "f" ?P)
6197 (funcall fontify-key "p" ?P)
6198 (funcall fontify-key "x" ?P)
6199 (funcall fontify-key "a" ?P))
6201 (funcall fontify-key "&" t)
6202 (funcall fontify-key "#" t))
6203 (format "[%s] %s"
6204 (funcall fontify-key "q" t)
6205 (if first-key "Main menu" "Exit")))))
6206 ;; Build prompts for both standard and expert UI.
6207 (standard-prompt (unless expertp "Export command: "))
6208 (expert-prompt
6209 (when expertp
6210 (format
6211 "Export command (C-%s%s%s%s%s) [%s]: "
6212 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6213 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6214 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6215 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6216 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6217 (mapconcat (lambda (k)
6218 ;; Strip control characters.
6219 (unless (< k 27) (char-to-string k)))
6220 allowed-keys "")))))
6221 ;; With expert UI, just read key with a fancy prompt. In standard
6222 ;; UI, display an intrusive help buffer.
6223 (if expertp
6224 (org-export--dispatch-action
6225 expert-prompt allowed-keys entries options first-key expertp)
6226 ;; At first call, create frame layout in order to display menu.
6227 (unless (get-buffer "*Org Export Dispatcher*")
6228 (delete-other-windows)
6229 (org-switch-to-buffer-other-window
6230 (get-buffer-create "*Org Export Dispatcher*"))
6231 (setq cursor-type nil
6232 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6233 ;; Make sure that invisible cursor will not highlight square
6234 ;; brackets.
6235 (set-syntax-table (copy-syntax-table))
6236 (modify-syntax-entry ?\[ "w"))
6237 ;; At this point, the buffer containing the menu exists and is
6238 ;; visible in the current window. So, refresh it.
6239 (with-current-buffer "*Org Export Dispatcher*"
6240 ;; Refresh help. Maintain display continuity by re-visiting
6241 ;; previous window position.
6242 (let ((pos (window-start)))
6243 (erase-buffer)
6244 (insert help)
6245 (set-window-start nil pos)))
6246 (org-fit-window-to-buffer)
6247 (org-export--dispatch-action
6248 standard-prompt allowed-keys entries options first-key expertp))))
6250 (defun org-export--dispatch-action
6251 (prompt allowed-keys entries options first-key expertp)
6252 "Read a character from command input and act accordingly.
6254 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6255 a list of characters available at a given step in the process.
6256 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6257 EXPERTP are the same as defined in `org-export--dispatch-ui',
6258 which see.
6260 Toggle export options when required. Otherwise, return value is
6261 a list with action as CAR and a list of interactive export
6262 options as CDR."
6263 (let (key)
6264 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6265 ;; C-p, SPC, DEL).
6266 (while (and (setq key (read-char-exclusive prompt))
6267 (not expertp)
6268 (memq key '(14 16 ?\s ?\d)))
6269 (case key
6270 (14 (if (not (pos-visible-in-window-p (point-max)))
6271 (ignore-errors (scroll-up 1))
6272 (message "End of buffer")
6273 (sit-for 1)))
6274 (16 (if (not (pos-visible-in-window-p (point-min)))
6275 (ignore-errors (scroll-down 1))
6276 (message "Beginning of buffer")
6277 (sit-for 1)))
6278 (?\s (if (not (pos-visible-in-window-p (point-max)))
6279 (scroll-up nil)
6280 (message "End of buffer")
6281 (sit-for 1)))
6282 (?\d (if (not (pos-visible-in-window-p (point-min)))
6283 (scroll-down nil)
6284 (message "Beginning of buffer")
6285 (sit-for 1)))))
6286 (cond
6287 ;; Ignore undefined associations.
6288 ((not (memq key allowed-keys))
6289 (ding)
6290 (unless expertp (message "Invalid key") (sit-for 1))
6291 (org-export--dispatch-ui options first-key expertp))
6292 ;; q key at first level aborts export. At second level, cancel
6293 ;; first key instead.
6294 ((eq key ?q) (if (not first-key) (error "Export aborted")
6295 (org-export--dispatch-ui options nil expertp)))
6296 ;; Help key: Switch back to standard interface if expert UI was
6297 ;; active.
6298 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6299 ;; Send request for template insertion along with export scope.
6300 ((eq key ?#) (cons 'template (memq 'subtree options)))
6301 ;; Switch to asynchronous export stack.
6302 ((eq key ?&) '(stack))
6303 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6304 ((memq key '(2 22 19 6 1))
6305 (org-export--dispatch-ui
6306 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6307 (6 'force) (1 'async))))
6308 (if (memq option options) (remq option options)
6309 (cons option options)))
6310 first-key expertp))
6311 ;; Action selected: Send key and options back to
6312 ;; `org-export-dispatch'.
6313 ((or first-key (functionp (nth 2 (assq key entries))))
6314 (cons (cond
6315 ((not first-key) (nth 2 (assq key entries)))
6316 ;; Publishing actions are hard-coded. Send a special
6317 ;; signal to `org-export-dispatch'.
6318 ((eq first-key ?P)
6319 (case key
6320 (?f 'publish-current-file)
6321 (?p 'publish-current-project)
6322 (?x 'publish-choose-project)
6323 (?a 'publish-all)))
6324 ;; Return first action associated to FIRST-KEY + KEY
6325 ;; path. Indeed, derived backends can share the same
6326 ;; FIRST-KEY.
6327 (t (catch 'found
6328 (mapc (lambda (entry)
6329 (let ((match (assq key (nth 2 entry))))
6330 (when match (throw 'found (nth 2 match)))))
6331 (member (assq first-key entries) entries)))))
6332 options))
6333 ;; Otherwise, enter sub-menu.
6334 (t (org-export--dispatch-ui options key expertp)))))
6338 (provide 'ox)
6340 ;; Local variables:
6341 ;; generated-autoload-file: "org-loaddefs.el"
6342 ;; End:
6344 ;;; ox.el ends here