| blob | 1a54effaaf0571c718c54709879cfc6e9f331a45 |
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
268 org-element--cache org-element--cache-objects org-element--cache-sync-keys
269 org-element--cache-sync-requests org-element--cache-sync-timer)
270 "List of variables not copied through upon buffer duplication.
271 Export process takes place on a copy of the original buffer.
272 When this copy is created, all Org related local variables not in
273 this list are copied to the new buffer. Variables with an
277 "Non-nil means asynchronous export process should leave data behind.
281 located in `temporary-file-directory'.
283 When non-nil, it will also set `debug-on-error' to a non-nil
287 "Record asynchronously generated export results and processes.
288 This is an alist: its CAR is the source of the
289 result (destination file or buffer for a finished process,
290 original buffer for a running one) and its CDR is a list
291 containing the back-end used, as a symbol, and either a process
292 or the time at which it finished. It is used to build the menu
296 "List of backends currently available in the exporter.
297 This variable is set with `org-export-define-backend' and
301 "Last command called from the dispatcher.
302 The value should be a list. Its CAR is the action, as a symbol,
306 "The position where the last export command was created using the dispatcher.
307 This marker will be used with `C-u C-c C-e' to make sure export repetition
310 ;; For compatibility with Org < 8
312 "Name, if any, of the back-end used during an export process.
314 Its value is a symbol such as `html', `latex', `ascii', or nil if
315 the back-end is anonymous (see `org-export-create-backend') or if
316 there is no export process in progress.
318 It can be used to teach Babel blocks how to act differently
322 \f
323 ;;; User-configurable Variables
324 ;;
325 ;; Configuration for the masses.
326 ;;
327 ;; They should never be accessed directly, as their value is to be
328 ;; stored in a property list (cf. `org-export-options-alist').
329 ;; Back-ends will read their value from there instead.
332 "Options for exporting Org mode files."
337 "General options for export engine."
342 "Whether sub-trees with the ARCHIVE tag should be exported.
344 This can have three different values:
345 nil Do not export, pretend this tree is not present.
346 t Do export the entire tree.
347 `headline' Only export the headline, but skip the tree below it.
349 This option can also be set with the OPTIONS keyword,
358 "Non-nil means insert author name into the exported file.
359 This option can also be set with the OPTIONS keyword,
365 "Non-nil means export CLOCK keywords.
366 This option can also be set with the OPTIONS keyword,
372 "Non-nil means the postamble should contain a creator sentence.
374 The sentence can be set in `org-export-creator-string' and
377 If the value is `comment' insert it as a comment."
385 "Non-nil means insert date in the exported document.
386 This option can also be set with the OPTIONS keyword,
392 "Time-stamp format string to use for DATE keyword.
394 The format string, when specified, only applies if date consists
395 in a single time-stamp. Otherwise its value will be ignored.
397 See `format-time-string' for details on how to build this
398 string."
406 emacs-version
408 "Information about the creator of the document.
409 This option can also be set on with the CREATOR keyword."
414 "Non-nil means export contents of standard drawers.
416 When t, all drawers are exported. This may also be a list of
417 drawer names to export, as strings. If that list starts with
418 `not', only drawers with such names will be ignored.
420 This variable doesn't apply to properties drawers. See
421 `org-export-with-properties' instead.
423 This option can also be set with the OPTIONS keyword,
436 :inline t
440 "Non-nil means insert author email into the exported file.
441 This option can also be set with the OPTIONS keyword,
447 "Non-nil means interpret *word*, /word/, _word_ and +word+.
449 If the export target supports emphasizing text, the word will be
450 typeset in bold, italic, with an underline or strike-through,
451 respectively.
453 This option can also be set with the OPTIONS keyword,
459 "Tags that exclude a tree from export.
461 All trees carrying any of these tags will be excluded from
462 export. This is without condition, so even subtrees inside that
463 carry one of the `org-export-select-tags' will be removed.
465 This option can also be set with the EXCLUDE_TAGS keyword."
471 This option can also be set with the OPTIONS keyword,
479 "Non-nil means Org footnotes should be exported.
480 This option can also be set with the OPTIONS keyword,
486 "Non-nil means process LaTeX environments and fragments.
488 This option can also be set with the OPTIONS line,
491 nil Ignore math snippets.
492 `verbatim' Keep everything in verbatim.
493 t Allow export of math snippets."
503 "The last level which is still exported as a headline.
505 Inferior levels will usually produce itemize or enumerate lists
506 when exported, but back-end behaviour may differ.
508 This option can also be set with the OPTIONS keyword,
514 "The default language for export and clocktable translations, as a string.
515 This may have an association in
516 `org-clock-clocktable-language-setup',
517 `org-export-smart-quotes-alist' and `org-export-dictionary'.
518 This option can also be set with the LANGUAGE keyword."
523 "Non-nil means preserve all line breaks when exporting.
524 This option can also be set with the OPTIONS keyword,
530 "Non-nil means interpret entities when exporting.
533 Å.
535 For a list of supported names, see the constant `org-entities'
536 and the user option `org-entities-user'.
538 This option can also be set with the OPTIONS keyword,
544 "Non-nil means inlinetasks should be exported.
545 This option can also be set with the OPTIONS keyword,
553 "Non-nil means include planning info in export.
555 Planning info is the line containing either SCHEDULED:,
556 DEADLINE:, CLOSED: time-stamps, or a combination of them.
558 This option can also be set with the OPTIONS keyword,
566 "Non-nil means include priority cookies in export.
567 This option can also be set with the OPTIONS keyword,
573 "Non-nil means export contents of properties drawers.
575 When t, all properties are exported. This may also be a list of
576 properties to export, as strings.
578 This option can also be set with the OPTIONS keyword,
590 "Non-nil means add section numbers to headlines when exporting.
592 When set to an integer n, numbering will only happen for
593 headlines whose relative level is higher or equal to n.
595 This option can also be set with the OPTIONS keyword,
601 "Tags that select a tree for export.
603 If any such tag is found in a buffer, all trees that do not carry
604 one of these tags will be ignored during export. Inside trees
605 that are selected like this, you can still deselect a subtree by
606 tagging it with one of the `org-export-exclude-tags'.
608 This option can also be set with the SELECT_TAGS keyword."
613 "Non-nil means activate smart quotes during export.
614 This option can also be set with the OPTIONS keyword,
617 When setting this to non-nil, you need to take care of
618 using the correct Babel package when exporting to LaTeX.
619 E.g., you can load Babel for french like this:
630 When this option is turned on, these strings will be exported as:
632 Org HTML LaTeX UTF-8
633 -----+----------+--------+-------
635 -- – -- –
636 --- — --- —
639 This option can also be set with the OPTIONS keyword,
645 "Non-nil means include statistics cookies in export.
646 This option can also be set with the OPTIONS keyword,
656 If you want to control how Org displays those characters, see
657 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
658 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
659 it is not anymore.
661 When this option is turned on, you can use TeX-like syntax for
662 sub- and superscripts and see them exported correctly.
664 You can also set the option with #+OPTIONS: ^:t
667 single item - so grouping with {} is normally not needed. For
668 example, the following things will be parsed as single sub- or
669 superscripts:
671 10^24 or 10^tau several digits will be considered 1 item.
672 10^-12 or 10^-tau a leading sign with digits or a word
673 x^2-y^3 will be read as x^2 - y^3, because items are
674 terminated by almost any nonword/nondigit char.
675 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
677 Still, ambiguity is possible. So when in doubt, use {} to enclose
678 the sub/superscript. If you set this variable to the symbol `{}',
679 the braces are *required* in order to trigger interpretations as
681 frequently in plain text."
691 "Non-nil means create a table of contents in exported files.
693 The TOC contains headlines with levels up
694 to`org-export-headline-levels'. When an integer, include levels
695 up to N in the toc, this may then be different from
696 `org-export-headline-levels', but it will not be allowed to be
697 larger than the number of headline levels. When nil, no table of
698 contents is made.
700 This option can also be set with the OPTIONS keyword,
709 "Non-nil means export tables.
710 This option can also be set with the OPTIONS keyword,
718 "If nil, do not export tags, just remove them from headlines.
720 If this is the symbol `not-in-toc', tags will be removed from
721 table of contents entries, but still be shown in the headlines of
722 the document.
724 This option can also be set with the OPTIONS keyword,
733 "Non-nil means include TODO items for export.
735 This may have the following values:
736 t include tasks independent of state.
737 `todo' include only tasks that are not yet done.
738 `done' include only tasks that are already done.
739 nil ignore all tasks.
740 list of keywords include tasks with these keywords.
742 This option can also be set with the OPTIONS keyword,
754 "Non-nil means insert a time stamp into the exported file.
755 The time stamp shows when the file was created. This option can
761 "Non nil means allow timestamps in export.
763 It can be set to any of the following values:
764 t export all timestamps.
765 `active' export active timestamps only.
766 `inactive' export inactive timestamps only.
767 nil do not export timestamps
769 This only applies to timestamps isolated in a paragraph
770 containing only timestamps. Other timestamps are always
771 exported.
773 This option can also be set with the OPTIONS keyword, e.g.
783 "Non-nil means include TODO keywords in export.
784 When nil, remove all these keywords from the export. This option
790 "Non-nil means BIND keywords can define local variable values.
791 This is a potential security risk, which is why the default value
792 is nil. You can also allow them through local buffer variables."
799 "Alist between export snippets back-ends and exporter back-ends.
801 This variable allows to provide shortcuts for export snippets.
805 HTML code while every other back-end will ignore it."
814 "Coding system for the exported file."
821 "Non-nil means pushing export output to the kill ring.
822 This variable is ignored during asynchronous export."
832 "The initial scope when exporting with `org-export-dispatch'.
833 This variable can be either set to `buffer' or `subtree'."
840 "Non-nil means show buffer after exporting to temp buffer.
841 When Org exports to a file, the buffer visiting that file is ever
842 shown, but remains buried. However, when exporting to
843 a temporary buffer, that buffer is popped up in a second window.
844 When this variable is nil, the buffer remains buried also in
845 these cases."
850 "Non-nil means export and publishing commands will run in background.
851 Results from an asynchronous export are never displayed
859 "File used to initialize external export process.
861 Value must be either nil or an absolute file name. When nil, the
862 external process is launched like a regular Emacs session,
863 loading user's initialization file and any site specific
864 configuration. If a file is provided, it, and only it, is loaded
865 at start-up.
867 Therefore, using a specific configuration makes the process to
868 load faster and the export more portable."
877 "Non-nil means using a non-intrusive `org-export-dispatch'.
878 In that case, no help buffer is displayed. Though, an indicator
884 asynchronous). Also, \[?] allows to switch back to standard
885 mode."
892 \f
893 ;;; Defining Back-ends
894 ;;
895 ;; An export back-end is a structure with `org-export-backend' type
896 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
897 ;; and `menu' slots.
898 ;;
899 ;; At the lowest level, a back-end is created with
900 ;; `org-export-create-backend' function.
901 ;;
902 ;; A named back-end can be registered with
903 ;; `org-export-register-backend' function. A registered back-end can
904 ;; later be referred to by its name, with `org-export-get-backend'
905 ;; function. Also, such a back-end can become the parent of a derived
906 ;; back-end from which slot values will be inherited by default.
907 ;; `org-export-derived-backend-p' can check if a given back-end is
908 ;; derived from a list of back-end names.
909 ;;
910 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
911 ;; `org-export-get-all-filters' return the full alist of transcoders,
912 ;; options and filters, including those inherited from ancestors.
913 ;;
914 ;; At a higher level, `org-export-define-backend' is the standard way
915 ;; to define an export back-end. If the new back-end is similar to
916 ;; a registered back-end, `org-export-define-derived-backend' may be
917 ;; used instead.
918 ;;
919 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
920 ;; when a given back-end hasn't been registered yet.
924 name parent transcoders options filters blocks menu)
927 "Return export back-end named after NAME.
928 NAME is a symbol. Return nil if no such back-end is found."
935 "Register BACKEND as a known export back-end.
936 BACKEND is a structure with `org-export-backend' type."
937 ;; Refuse to register an unnamed back-end.
940 ;; Refuse to register a back-end with an unknown parent.
944 ;; Register dedicated export blocks in the parser.
948 ;; If a back-end with the same name as BACKEND is already
949 ;; registered, replace it with BACKEND. Otherwise, simply add
950 ;; BACKEND to the list of registered back-ends.
956 "Signal an error if BACKEND isn't defined."
961 "Non-nil if BACKEND is derived from one of BACKENDS.
962 BACKEND is an export back-end, as returned by, e.g.,
963 `org-export-create-backend', or a symbol referring to
964 a registered back-end. BACKENDS is constituted of symbols."
976 "Return full translation table for BACKEND.
978 BACKEND is an export back-end, as return by, e.g,,
979 `org-export-create-backend'. Return value is an alist where
980 keys are element or object types, as symbols, and values are
981 transcoders.
983 Unlike to `org-export-backend-transcoders', this function
984 also returns transcoders inherited from parent back-ends,
985 if any."
989 parent)
994 transcoders)))
997 "Return export options for BACKEND.
999 BACKEND is an export back-end, as return by, e.g,,
1000 `org-export-create-backend'. See `org-export-options-alist'
1001 for the shape of the return value.
1003 Unlike to `org-export-backend-options', this function also
1004 returns options inherited from parent back-ends, if any."
1008 parent)
1012 options)))
1015 "Return complete list of filters for BACKEND.
1017 BACKEND is an export back-end, as return by, e.g,,
1018 `org-export-create-backend'. Return value is an alist where
1019 keys are symbols and values lists of functions.
1021 Unlike to `org-export-backend-filters', this function also
1022 returns filters inherited from parent back-ends, if any."
1026 parent)
1030 filters)))
1033 "Define a new back-end BACKEND.
1035 TRANSCODERS is an alist between object or element types and
1036 functions handling them.
1038 These functions should return a string without any trailing
1039 space, or nil. They must accept three arguments: the object or
1040 element itself, its contents or nil when it isn't recursive and
1041 the property list used as a communication channel.
1043 Contents, when not nil, are stripped from any global indentation
1044 \(although the relative one is preserved). They also always end
1045 with a single newline character.
1047 If, for a given type, no function is found, that element or
1048 object type will simply be ignored, along with any blank line or
1049 white space at its end. The same will happen if the function
1050 returns the nil value. If that function returns the empty
1051 string, the type will be ignored, but the blank lines or white
1052 spaces will be kept.
1054 In addition to element and object types, one function can be
1055 associated to the `template' (or `inner-template') symbol and
1056 another one to the `plain-text' symbol.
1058 The former returns the final transcoded string, and can be used
1059 to add a preamble and a postamble to document's body. It must
1060 accept two arguments: the transcoded string and the property list
1061 containing export options. A function associated to `template'
1063 A function associated to `inner-template' is always applied.
1065 The latter, when defined, is to be called on every text not
1066 recognized as an element or an object. It must accept two
1067 arguments: the text string and the information channel. It is an
1068 appropriate place to protect special chars relative to the
1069 back-end.
1071 BODY can start with pre-defined keyword arguments. The following
1072 keywords are understood:
1074 :export-block
1076 String, or list of strings, representing block names that
1077 will not be parsed. This is used to specify blocks that will
1078 contain raw code specific to the back-end. These blocks
1079 still have to be handled by the relative `export-block' type
1080 translator.
1082 :filters-alist
1084 Alist between filters and function, or list of functions,
1085 specific to the back-end. See `org-export-filters-alist' for
1086 a list of all allowed filters. Filters defined here
1087 shouldn't make a back-end test, as it may prevent back-ends
1088 derived from this one to behave properly.
1090 :menu-entry
1092 Menu entry for the export dispatcher. It should be a list
1093 like:
1095 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1097 where :
1099 KEY is a free character selecting the back-end.
1101 DESCRIPTION-OR-ORDINAL is either a string or a number.
1103 If it is a string, is will be used to name the back-end in
1104 its menu entry. If it is a number, the following menu will
1105 be displayed as a sub-menu of the back-end with the same
1106 KEY. Also, the number will be used to determine in which
1107 order such sub-menus will appear (lowest first).
1109 ACTION-OR-MENU is either a function or an alist.
1111 If it is an action, it will be called with four
1112 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1113 BODY-ONLY. See `org-export-as' for further explanations on
1114 some of them.
1116 If it is an alist, associations should follow the
1117 pattern:
1119 '(KEY DESCRIPTION ACTION)
1121 where KEY, DESCRIPTION and ACTION are described above.
1123 Valid values include:
1127 or
1132 \(lambda (a s v b)
1133 \(if a (org-latex-export-to-pdf t s v b)
1134 \(org-open-file
1135 \(org-latex-export-to-pdf nil s v b)))))))
1137 or the following, which will be added to the previous
1138 sub-menu,
1140 '(?l 1
1144 :options-alist
1146 Alist between back-end specific properties introduced in
1147 communication channel and how their value are acquired. See
1148 `org-export-options-alist' for more information about
1149 structure of the values."
1163 :transcoders transcoders
1164 :options options
1165 :filters filters
1166 :blocks blocks
1170 "Create a new back-end as a variant of an existing one.
1172 CHILD is the name of the derived back-end. PARENT is the name of
1173 the parent back-end.
1175 BODY can start with pre-defined keyword arguments. The following
1176 keywords are understood:
1178 :export-block
1180 String, or list of strings, representing block names that
1181 will not be parsed. This is used to specify blocks that will
1182 contain raw code specific to the back-end. These blocks
1183 still have to be handled by the relative `export-block' type
1184 translator.
1186 :filters-alist
1188 Alist of filters that will overwrite or complete filters
1189 defined in PARENT back-end. See `org-export-filters-alist'
1190 for a list of allowed filters.
1192 :menu-entry
1194 Menu entry for the export dispatcher. See
1195 `org-export-define-backend' for more information about the
1196 expected value.
1198 :options-alist
1200 Alist of back-end specific properties that will overwrite or
1201 complete those defined in PARENT back-end. Refer to
1202 `org-export-options-alist' for more information about
1203 structure of the values.
1205 :translate-alist
1207 Alist of element and object types and transcoders that will
1208 overwrite or complete transcode table from PARENT back-end.
1209 Refer to `org-export-define-backend' for detailed information
1210 about transcoders.
1213 as a variant of `latex' back-end with a custom template function:
1215 \(org-export-define-derived-backend 'my-latex 'latex
1216 :translate-alist '((template . my-latex-template-fun)))
1218 The back-end could then be called with, for example:
1235 :parent parent
1236 :transcoders transcoders
1237 :options options
1238 :filters filters
1239 :blocks blocks
1243 \f
1244 ;;; The Communication Channel
1245 ;;
1246 ;; During export process, every function has access to a number of
1247 ;; properties. They are of two types:
1248 ;;
1249 ;; 1. Environment options are collected once at the very beginning of
1250 ;; the process, out of the original buffer and configuration.
1251 ;; Collecting them is handled by `org-export-get-environment'
1252 ;; function.
1253 ;;
1254 ;; Most environment options are defined through the
1255 ;; `org-export-options-alist' variable.
1256 ;;
1257 ;; 2. Tree properties are extracted directly from the parsed tree,
1258 ;; just before export, by `org-export-collect-tree-properties'.
1259 ;;
1260 ;; Here is the full list of properties available during transcode
1261 ;; process, with their category and their value type.
1262 ;;
1263 ;; + `:author' :: Author's name.
1264 ;; - category :: option
1265 ;; - type :: string
1266 ;;
1267 ;; + `:back-end' :: Current back-end used for transcoding.
1268 ;; - category :: tree
1269 ;; - type :: structure
1270 ;;
1271 ;; + `:creator' :: String to write as creation information.
1272 ;; - category :: option
1273 ;; - type :: string
1274 ;;
1275 ;; + `:date' :: String to use as date.
1276 ;; - category :: option
1277 ;; - type :: string
1278 ;;
1279 ;; + `:description' :: Description text for the current data.
1280 ;; - category :: option
1281 ;; - type :: string
1282 ;;
1283 ;; + `:email' :: Author's email.
1284 ;; - category :: option
1285 ;; - type :: string
1286 ;;
1287 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1288 ;; process.
1289 ;; - category :: option
1290 ;; - type :: list of strings
1291 ;;
1292 ;; + `:export-options' :: List of export options available for current
1293 ;; process.
1294 ;; - category :: none
1295 ;; - type :: list of symbols, among `subtree', `body-only' and
1296 ;; `visible-only'.
1297 ;;
1298 ;; + `:exported-data' :: Hash table used for memoizing
1299 ;; `org-export-data'.
1300 ;; - category :: tree
1301 ;; - type :: hash table
1302 ;;
1303 ;; + `:filetags' :: List of global tags for buffer. Used by
1304 ;; `org-export-get-tags' to get tags with inheritance.
1305 ;; - category :: option
1306 ;; - type :: list of strings
1307 ;;
1308 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1309 ;; their definition, as parsed data. Only non-inlined footnotes
1310 ;; are represented in this alist. Also, every definition isn't
1311 ;; guaranteed to be referenced in the parse tree. The purpose of
1312 ;; this property is to preserve definitions from oblivion
1313 ;; (i.e. when the parse tree comes from a part of the original
1314 ;; buffer), it isn't meant for direct use in a back-end. To
1315 ;; retrieve a definition relative to a reference, use
1316 ;; `org-export-get-footnote-definition' instead.
1317 ;; - category :: option
1318 ;; - type :: alist (STRING . LIST)
1319 ;;
1320 ;; + `:headline-levels' :: Maximum level being exported as an
1321 ;; headline. Comparison is done with the relative level of
1322 ;; headlines in the parse tree, not necessarily with their
1323 ;; actual level.
1324 ;; - category :: option
1325 ;; - type :: integer
1326 ;;
1327 ;; + `:headline-offset' :: Difference between relative and real level
1328 ;; of headlines in the parse tree. For example, a value of -1
1329 ;; means a level 2 headline should be considered as level
1330 ;; 1 (cf. `org-export-get-relative-level').
1331 ;; - category :: tree
1332 ;; - type :: integer
1333 ;;
1334 ;; + `:headline-numbering' :: Alist between headlines and their
1335 ;; numbering, as a list of numbers
1336 ;; (cf. `org-export-get-headline-number').
1337 ;; - category :: tree
1338 ;; - type :: alist (INTEGER . LIST)
1339 ;;
1340 ;; + `:id-alist' :: Alist between ID strings and destination file's
1341 ;; path, relative to current directory. It is used by
1342 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1343 ;; external file.
1344 ;; - category :: option
1345 ;; - type :: alist (STRING . STRING)
1346 ;;
1347 ;; + `:ignore-list' :: List of elements and objects that should be
1348 ;; ignored during export.
1349 ;; - category :: tree
1350 ;; - type :: list of elements and objects
1351 ;;
1352 ;; + `:input-buffer' :: Original buffer name.
1353 ;; - category :: option
1354 ;; - type :: string
1355 ;;
1356 ;; + `:input-file' :: Full path to input file, if any.
1357 ;; - category :: option
1358 ;; - type :: string or nil
1359 ;;
1360 ;; + `:keywords' :: List of keywords attached to data.
1361 ;; - category :: option
1362 ;; - type :: string
1363 ;;
1364 ;; + `:language' :: Default language used for translations.
1365 ;; - category :: option
1366 ;; - type :: string
1367 ;;
1368 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1369 ;; transcoding.
1370 ;; - category :: option
1371 ;; - type :: list (as returned by `org-element-parse-buffer')
1372 ;;
1373 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1374 ;; all line breaks.
1375 ;; - category :: option
1376 ;; - type :: symbol (nil, t)
1377 ;;
1378 ;; + `:section-numbers' :: Non-nil means transcoding should add
1379 ;; section numbers to headlines.
1380 ;; - category :: option
1381 ;; - type :: symbol (nil, t)
1382 ;;
1383 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1384 ;; in transcoding. When such a tag is present, subtrees without
1385 ;; it are de facto excluded from the process. See
1386 ;; `use-select-tags'.
1387 ;; - category :: option
1388 ;; - type :: list of strings
1389 ;;
1390 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1391 ;; a time stamp in the output.
1392 ;; - category :: option
1393 ;; - type :: symbol (nil, t)
1394 ;;
1395 ;; + `:translate-alist' :: Alist between element and object types and
1396 ;; transcoding functions relative to the current back-end.
1397 ;; Special keys `inner-template', `template' and `plain-text' are
1398 ;; also possible.
1399 ;; - category :: option
1400 ;; - type :: alist (SYMBOL . FUNCTION)
1401 ;;
1402 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1403 ;; also be transcoded. If it is set to the `headline' symbol,
1404 ;; only the archived headline's name is retained.
1405 ;; - category :: option
1406 ;; - type :: symbol (nil, t, `headline')
1407 ;;
1408 ;; + `:with-author' :: Non-nil means author's name should be included
1409 ;; in the output.
1410 ;; - category :: option
1411 ;; - type :: symbol (nil, t)
1412 ;;
1413 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1414 ;; - category :: option
1415 ;; - type :: symbol (nil, t)
1416 ;;
1417 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1418 ;; inserted at the end of the transcoded string. If the value
1419 ;; is `comment', it should be commented.
1420 ;; - category :: option
1421 ;; - type :: symbol (`comment', nil, t)
1422 ;;
1423 ;; + `:with-date' :: Non-nil means output should contain a date.
1424 ;; - category :: option
1425 ;; - type :. symbol (nil, t)
1426 ;;
1427 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1428 ;; its value is a list of names, only drawers with such names
1429 ;; will be transcoded. If that list starts with `not', drawer
1430 ;; with these names will be skipped.
1431 ;; - category :: option
1432 ;; - type :: symbol (nil, t) or list of strings
1433 ;;
1434 ;; + `:with-email' :: Non-nil means output should contain author's
1435 ;; email.
1436 ;; - category :: option
1437 ;; - type :: symbol (nil, t)
1438 ;;
1439 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1440 ;; interpreted.
1441 ;; - category :: option
1442 ;; - type :: symbol (nil, t)
1443 ;;
1444 ;; + `:with-fixed-width' :: Non-nil if transcoder should export
1445 ;; strings starting with a colon as a fixed-with (verbatim) area.
1446 ;; - category :: option
1447 ;; - type :: symbol (nil, t)
1448 ;;
1449 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1450 ;; footnotes.
1451 ;; - category :: option
1452 ;; - type :: symbol (nil, t)
1453 ;;
1454 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1455 ;; `latex-fragment' objects should appear in export output. When
1456 ;; this property is set to `verbatim', they will be left as-is.
1457 ;; - category :: option
1458 ;; - type :: symbol (`verbatim', nil, t)
1459 ;;
1460 ;; + `:with-planning' :: Non-nil means transcoding should include
1461 ;; planning info.
1462 ;; - category :: option
1463 ;; - type :: symbol (nil, t)
1464 ;;
1465 ;; + `:with-priority' :: Non-nil means transcoding should include
1466 ;; priority cookies.
1467 ;; - category :: option
1468 ;; - type :: symbol (nil, t)
1469 ;;
1470 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1471 ;; plain text.
1472 ;; - category :: option
1473 ;; - type :: symbol (nil, t)
1474 ;;
1475 ;; + `:with-special-strings' :: Non-nil means transcoding should
1476 ;; interpret special strings in plain text.
1477 ;; - category :: option
1478 ;; - type :: symbol (nil, t)
1479 ;;
1480 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1481 ;; interpret subscript and superscript. With a value of "{}",
1482 ;; only interpret those using curly brackets.
1483 ;; - category :: option
1484 ;; - type :: symbol (nil, {}, t)
1485 ;;
1486 ;; + `:with-tables' :: Non-nil means transcoding should export tables.
1487 ;; - category :: option
1488 ;; - type :: symbol (nil, t)
1489 ;;
1490 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1491 ;; headlines. A `not-in-toc' value will remove them from the
1492 ;; table of contents, if any, nonetheless.
1493 ;; - category :: option
1494 ;; - type :: symbol (nil, t, `not-in-toc')
1495 ;;
1496 ;; + `:with-tasks' :: Non-nil means transcoding should include
1497 ;; headlines with a TODO keyword. A `todo' value will only
1498 ;; include headlines with a todo type keyword while a `done'
1499 ;; value will do the contrary. If a list of strings is provided,
1500 ;; only tasks with keywords belonging to that list will be kept.
1501 ;; - category :: option
1502 ;; - type :: symbol (t, todo, done, nil) or list of strings
1503 ;;
1504 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1505 ;; time stamps. Special value `active' (resp. `inactive') ask to
1506 ;; export only active (resp. inactive) timestamps. Otherwise,
1507 ;; completely remove them.
1508 ;; - category :: option
1509 ;; - type :: symbol: (`active', `inactive', t, nil)
1510 ;;
1511 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1512 ;; added to the output. An integer value limits its depth.
1513 ;; - category :: option
1514 ;; - type :: symbol (nil, t or integer)
1515 ;;
1516 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1517 ;; include TODO keywords.
1518 ;; - category :: option
1519 ;; - type :: symbol (nil, t)
1522 ;;;; Environment Options
1523 ;;
1524 ;; Environment options encompass all parameters defined outside the
1525 ;; scope of the parsed data. They come from five sources, in
1526 ;; increasing precedence order:
1527 ;;
1528 ;; - Global variables,
1529 ;; - Buffer's attributes,
1530 ;; - Options keyword symbols,
1531 ;; - Buffer keywords,
1532 ;; - Subtree properties.
1533 ;;
1534 ;; The central internal function with regards to environment options
1535 ;; is `org-export-get-environment'. It updates global variables with
1536 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1537 ;; the different sources.
1538 ;;
1539 ;; The internal functions doing the retrieval are:
1540 ;; `org-export--get-global-options',
1541 ;; `org-export--get-buffer-attributes',
1542 ;; `org-export--parse-option-keyword',
1543 ;; `org-export--get-subtree-options' and
1544 ;; `org-export--get-inbuffer-options'
1545 ;;
1546 ;; Also, `org-export--list-bound-variables' collects bound variables
1547 ;; along with their value in order to set them as buffer local
1548 ;; variables later in the process.
1551 "Collect export options from the current buffer.
1553 Optional argument BACKEND is an export back-end, as returned by
1554 `org-export-create-backend'.
1556 When optional argument SUBTREEP is non-nil, assume the export is
1557 done against the current sub-tree.
1559 Third optional argument EXT-PLIST is a property list with
1560 external parameters overriding Org default settings, but still
1561 inferior to file-local settings."
1562 ;; First install #+BIND variables since these must be set before
1563 ;; global options are read.
1566 ;; Get and prioritize export options...
1568 ;; ... from global variables...
1570 ;; ... from an external property list...
1571 ext-plist
1572 ;; ... from in-buffer settings...
1574 ;; ... and from subtree, when appropriate.
1576 ;; Eventually add misc. properties.
1578 :back-end
1579 backend
1581 :footnote-definition-alist
1582 ;; Footnotes definitions must be collected in the original
1583 ;; buffer, as there's no insurance that they will still be in
1584 ;; the parse tree, due to possible narrowing.
1598 alist))))
1599 alist))
1600 :id-alist
1601 ;; Collect id references.
1612 alist))))
1615 "Parse an OPTIONS line and return values as a plist.
1616 Optional argument BACKEND is an export back-end, as returned by,
1617 e.g., `org-export-create-backend'. It specifies which back-end
1618 specific items to read, if any."
1620 ;; Priority is given to back-end specific options.
1622 org-export-options-alist))
1623 plist)
1632 options))
1634 property
1637 plist))
1640 "Get export options in subtree at point.
1641 Optional argument BACKEND is an export back-end, as returned by,
1642 e.g., `org-export-create-backend'. It specifies back-end used
1643 for export. Return options as a plist."
1644 ;; For each buffer keyword, create a headline property setting the
1645 ;; same property in communication channel. The name for the property
1646 ;; is the keyword with "EXPORT_" appended to it.
1649 ;; Make sure point is at a heading.
1651 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1652 ;; title (with no todo keyword, priority cookie or tag) as its
1653 ;; fallback value.
1659 plist :title
1662 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1666 ;; Handle other keywords. TITLE keyword is excluded as it has
1667 ;; been handled already.
1675 ;; Export properties are not case-sensitive.
1682 plist
1683 property
1685 ;; Parse VALUE if required.
1689 ;; If BEHAVIOR is `split' expected value is
1690 ;; a list of strings, not a string.
1693 ;; Look for both general keywords and back-end specific
1694 ;; options, with priority given to the latter.
1696 org-export-options-alist)))
1697 ;; Return value.
1698 plist)))
1701 "Return current buffer export options, as a plist.
1703 Optional argument BACKEND, when non-nil, is an export back-end,
1704 as returned by, e.g., `org-export-create-backend'. It specifies
1705 which back-end specific options should also be read in the
1706 process.
1708 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1710 get-options ; For byte-compiler.
1713 ;; Priority is given to back-end specific options.
1715 org-export-options-alist))
1718 org-export-special-keywords))))
1721 ;; Return all properties associated to KEYWORD.
1728 ;; Recursively read keywords in buffer. FILES is a list
1729 ;; of files read so far. PLIST is the current property
1730 ;; list obtained.
1739 ;; Options in `org-export-special-keywords'.
1743 ;; Avoid circular dependencies.
1753 plist
1758 plist
1764 ;; Options in `org-export-options-alist'.
1769 plist property
1770 ;; Handle value depending on specified
1771 ;; BEHAVIOR.
1777 " "
1790 ;; Return final value.
1791 plist))))
1792 ;; Read options in the current buffer.
1795 ;; Parse keywords specified in `org-element-document-properties'
1796 ;; and return PLIST.
1807 "Return properties related to buffer attributes, as a plist."
1808 ;; Store full path of input file name, or nil. For internal use.
1811 :input-file visited-file
1817 "Return global export options as a plist.
1818 Optional argument BACKEND, if non-nil, is an export back-end, as
1819 returned by, e.g., `org-export-create-backend'. It specifies
1820 which back-end specific export options should also be read in the
1821 process."
1823 ;; Priority is given to back-end specific options.
1825 org-export-options-alist)))
1832 plist
1833 prop
1834 ;; Eval default value provided. If keyword is
1835 ;; a member of `org-element-document-properties',
1836 ;; parse it as a secondary string before storing it.
1843 value)))))))))))
1846 "Return variables bound from BIND keywords in current buffer.
1847 Also look for BIND keywords in setup files. The return value is
1848 an alist where associations are (VARIABLE-NAME VALUE)."
1853 ;; Return an alist between variable names and their
1854 ;; value. FILES is a list of setup files names read so
1855 ;; far, used to avoid circular dependencies. ALIST is
1856 ;; the alist collected so far.
1867 ;; Enter setup file.
1877 alist))))))))))
1878 alist)))))
1879 ;; Return value in appropriate order of appearance.
1883 ;;;; Tree Properties
1884 ;;
1885 ;; Tree properties are information extracted from parse tree. They
1886 ;; are initialized at the beginning of the transcoding process by
1887 ;; `org-export-collect-tree-properties'.
1888 ;;
1889 ;; Dedicated functions focus on computing the value of specific tree
1890 ;; properties during initialization. Thus,
1891 ;; `org-export--populate-ignore-list' lists elements and objects that
1892 ;; should be skipped during export, `org-export--get-min-level' gets
1893 ;; the minimal exportable level, used as a basis to compute relative
1894 ;; level for headlines. Eventually
1895 ;; `org-export--collect-headline-numbering' builds an alist between
1896 ;; headlines and their numbering.
1899 "Extract tree properties from parse tree.
1901 DATA is the parse tree from which information is retrieved. INFO
1902 is a list holding export options.
1904 Following tree properties are set or updated:
1906 `:exported-data' Hash table used to memoize results from
1907 `org-export-data'.
1909 `:footnote-definition-alist' List of footnotes definitions in
1910 original buffer and current parse tree.
1912 `:headline-offset' Offset between true level of headlines and
1913 local level. An offset of -1 means a headline
1914 of level 2 should be considered as a level
1915 1 headline in the context.
1917 `:headline-numbering' Alist of all headlines as key an the
1918 associated numbering as value.
1920 `:ignore-list' List of elements that should be ignored during
1921 export.
1923 Return updated plist."
1924 ;; Install the parse tree in the communication channel, in order to
1925 ;; use `org-export-get-genealogy' and al.
1927 ;; Get the list of elements and objects to ignore, and put it into
1928 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1929 ;; been done during parse tree filtering.
1932 :ignore-list
1935 ;; Compute `:headline-offset' in order to be able to use
1936 ;; `org-export-get-relative-level'.
1939 :headline-offset
1941 ;; Update footnotes definitions list with definitions in parse tree.
1942 ;; This is required since buffer expansion might have modified
1943 ;; boundaries of footnote definitions contained in the parse tree.
1944 ;; This way, definitions in `footnote-definition-alist' are bound to
1945 ;; match those in the parse tree.
1951 defs)))
1953 ;; Properties order doesn't matter: get the rest of the tree
1954 ;; properties.
1958 info))
1961 "Return minimum exportable headline's level in DATA.
1962 DATA is parsed tree as returned by `org-element-parse-buffer'.
1963 OPTIONS is a plist holding export options."
1974 ;; If no headline was found, for the sake of consistency, set
1975 ;; minimum level to 1 nonetheless.
1979 "Return numbering of all exportable headlines in a parse tree.
1981 DATA is the parse tree. OPTIONS is the plist holding export
1982 options.
1984 Return an alist whose key is a headline and value is its
1985 associated numbering \(in the shape of a list of numbers\) or nil
1986 for a footnotes section."
1994 headline
1996 for idx from 0 to org-export-max-depth
2000 options)))
2003 "Return list of elements and objects to ignore during export.
2004 DATA is the parse tree to traverse. OPTIONS is the plist holding
2005 export options."
2007 ;; First find trees containing a select tag, if any.
2009 ;; If a select tag is active, also ignore the section before
2010 ;; the first headline, if any.
2014 first-element))))
2017 ;; Collect ignored elements or objects into IGNORE-LIST.
2023 ;; If headline is archived but tree below has
2024 ;; to be skipped, add it to ignore list.
2027 ;; Move into secondary string, if any.
2032 ;; Move into recursive objects/elements.
2034 ;; Main call.
2036 ;; Return value.
2037 ignore))
2040 "Return list of headlines and inlinetasks with a select tag in their tree.
2041 DATA is parsed data as returned by `org-element-parse-buffer'.
2042 INFO is a plist holding export options."
2044 walk-data ; For byte-compiler.
2054 ;; When a select tag is found, mark full
2055 ;; genealogy and every headline within the tree
2056 ;; as acceptable.
2059 genealogy
2062 selected-trees))
2063 ;; If at a headline, continue searching in tree,
2064 ;; recursively.
2074 selected-trees))
2077 "Non-nil when element or object BLOB should be skipped during export.
2078 OPTIONS is the plist holding export options. SELECTED, when
2079 non-nil, is a list of headlines or inlinetasks belonging to
2080 a tree with a select tag."
2087 ;; If `:with-drawers' value starts with `not', ignore
2088 ;; every drawer whose name belong to that list.
2089 ;; Otherwise, ignore drawers whose name isn't in that
2090 ;; list.
2107 ;; Ignore subtrees with an exclude tag.
2110 ;; When a select tag is present in the buffer, ignore any tree
2111 ;; without it.
2113 ;; Ignore commented sub-trees.
2115 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2117 ;; Ignore tasks, if specified by `:with-tasks' property.
2129 properties-set))))))
2140 ;; `:with-timestamps' only applies to isolated timestamps
2141 ;; objects, i.e. timestamp objects in a paragraph containing only
2142 ;; timestamps and whitespaces.
2150 options t))))
2159 \f
2160 ;;; The Transcoder
2161 ;;
2162 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2163 ;; `org-element-parse-buffer') and transcodes it into a specified
2164 ;; back-end output. It takes care of filtering out elements or
2165 ;; objects according to export options and organizing the output blank
2166 ;; lines and white space are preserved. The function memoizes its
2167 ;; results, so it is cheap to call it within transcoders.
2168 ;;
2169 ;; It is possible to modify locally the back-end used by
2170 ;; `org-export-data' or even use a temporary back-end by using
2171 ;; `org-export-data-with-backend'.
2172 ;;
2173 ;; Internally, three functions handle the filtering of objects and
2174 ;; elements during the export. In particular,
2175 ;; `org-export-ignore-element' marks an element or object so future
2176 ;; parse tree traversals skip it and `org-export-expand' transforms
2177 ;; the others back into their original shape.
2178 ;;
2179 ;; `org-export-transcoder' is an accessor returning appropriate
2180 ;; translator function for a given element or object.
2183 "Return appropriate transcoder for BLOB.
2184 INFO is a plist containing export directives."
2186 ;; Return contents only for complete parse trees.
2192 "Convert DATA into current back-end format.
2194 DATA is a parse tree, an element or an object or a secondary
2195 string. INFO is a plist holding export options.
2197 Return a string."
2202 ;; Ignored element/object.
2204 ;; Plain text.
2210 info))
2211 ;; Secondary string.
2214 ;; Element/Object without contents or, as a special
2215 ;; case, headline with archive tag and archived trees
2216 ;; restricted to title only.
2224 ;; Export snippets never return a nil value so
2225 ;; that white spaces following them are never
2226 ;; ignored.
2228 ;; Element/Object with contents.
2241 ;; Elements directly containing
2242 ;; objects must have their indentation
2243 ;; normalized first.
2245 data
2246 ;; When normalizing contents of the
2247 ;; first paragraph in an item or
2248 ;; a footnote definition, ignore
2249 ;; first line's indentation: there is
2250 ;; none and it might be misleading.
2255 data)
2262 info))))))))
2263 ;; Final result will be memoized before being returned.
2265 data
2269 ;; Append the same white space between elements or objects
2270 ;; as in the original buffer, and call appropriate filters.
2281 info)))
2282 results)))
2286 "Convert DATA into BACKEND format.
2288 DATA is an element, an object, a secondary string or a string.
2289 BACKEND is a symbol. INFO is a plist used as a communication
2290 channel.
2292 Unlike to `org-export-with-backend', this function will
2293 recursively convert DATA using BACKEND translation table."
2296 data
2297 ;; Set-up a new communication channel with translations defined in
2298 ;; BACKEND as the translate table and a new hash table for
2299 ;; memoization.
2301 info
2304 ;; Size of the hash table is reduced since this function
2305 ;; will probably be used on small trees.
2309 "Change uninterpreted elements back into Org syntax.
2310 DATA is the parse tree. INFO is a plist containing export
2311 options. Each uninterpreted element or object is changed back
2312 into a string. Contents, if any, are not modified. The parse
2313 tree is modified by side effect and returned by the function."
2317 prop
2320 info))))
2323 "Change uninterpreted elements back into Org syntax.
2324 DATA is a parse tree or a secondary string. INFO is a plist
2325 containing export options. It is modified by side effect and
2326 returned by the function."
2329 subscript superscript underline)
2333 ;; ... entities...
2340 ?\s)))))
2341 ;; ... emphasis...
2353 marker
2357 ?\s)))))))
2358 ;; ... LaTeX environments and fragments...
2362 ;; ... sub/superscripts...
2371 "_"
2380 ?\s)))))))))))
2382 ;; Splice NEW at BLOB location in parse tree.
2385 info)
2386 ;; Return modified parse tree.
2387 data)
2390 "Expand a parsed element or object to its original state.
2392 BLOB is either an element or an object. CONTENTS is its
2393 contents, as a string or nil.
2395 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2396 keywords before output."
2401 blob contents))))
2404 "Add ELEMENT to `:ignore-list' in INFO.
2406 Any element in `:ignore-list' will be skipped when using
2407 `org-element-map'. INFO is modified by side effects."
2411 \f
2412 ;;; The Filter System
2413 ;;
2414 ;; Filters allow end-users to tweak easily the transcoded output.
2415 ;; They are the functional counterpart of hooks, as every filter in
2416 ;; a set is applied to the return value of the previous one.
2417 ;;
2418 ;; Every set is back-end agnostic. Although, a filter is always
2419 ;; called, in addition to the string it applies to, with the back-end
2420 ;; used as argument, so it's easy for the end-user to add back-end
2421 ;; specific filters in the set. The communication channel, as
2422 ;; a plist, is required as the third argument.
2423 ;;
2424 ;; From the developer side, filters sets can be installed in the
2425 ;; process with the help of `org-export-define-backend', which
2426 ;; internally stores filters as an alist. Each association has a key
2427 ;; among the following symbols and a function or a list of functions
2428 ;; as value.
2429 ;;
2430 ;; - `:filter-options' applies to the property list containing export
2431 ;; options. Unlike to other filters, functions in this list accept
2432 ;; two arguments instead of three: the property list containing
2433 ;; export options and the back-end. Users can set its value through
2434 ;; `org-export-filter-options-functions' variable.
2435 ;;
2436 ;; - `:filter-parse-tree' applies directly to the complete parsed
2437 ;; tree. Users can set it through
2438 ;; `org-export-filter-parse-tree-functions' variable.
2439 ;;
2440 ;; - `:filter-final-output' applies to the final transcoded string.
2441 ;; Users can set it with `org-export-filter-final-output-functions'
2442 ;; variable
2443 ;;
2444 ;; - `:filter-plain-text' applies to any string not recognized as Org
2445 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2446 ;; configure it.
2447 ;;
2448 ;; - `:filter-TYPE' applies on the string returned after an element or
2449 ;; object of type TYPE has been transcoded. A user can modify
2450 ;; `org-export-filter-TYPE-functions'
2451 ;;
2452 ;; All filters sets are applied with
2453 ;; `org-export-filter-apply-functions' function. Filters in a set are
2454 ;; applied in a LIFO fashion. It allows developers to be sure that
2455 ;; their filters will be applied first.
2456 ;;
2457 ;; Filters properties are installed in communication channel with
2458 ;; `org-export-install-filters' function.
2459 ;;
2460 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2461 ;; `org-export-before-parsing-hook') are run at the beginning of the
2462 ;; export process and just before parsing to allow for heavy structure
2463 ;; modifications.
2466 ;;;; Hooks
2469 "Hook run at the beginning of the export process.
2471 This is run before include keywords and macros are expanded and
2472 Babel code blocks executed, on a copy of the original buffer
2473 being exported. Visibility and narrowing are preserved. Point
2474 is at the beginning of the buffer.
2476 Every function in this hook will be called with one argument: the
2480 "Hook run before parsing an export buffer.
2482 This is run after include keywords and macros have been expanded
2483 and Babel code blocks executed, on a copy of the original buffer
2484 being exported. Visibility and narrowing are preserved. Point
2485 is at the beginning of the buffer.
2487 Every function in this hook will be called with one argument: the
2491 ;;;; Special Filters
2494 "List of functions applied to the export options.
2495 Each filter is called with two arguments: the export options, as
2496 a plist, and the back-end, as a symbol. It must return
2500 "List of functions applied to the parsed tree.
2501 Each filter is called with three arguments: the parse tree, as
2502 returned by `org-element-parse-buffer', the back-end, as
2503 a symbol, and the communication channel, as a plist. It must
2507 "List of functions applied to plain text.
2508 Each filter is called with three arguments: a string which
2509 contains no Org syntax, the back-end, as a symbol, and the
2510 communication channel, as a plist. It must return a string or
2514 "List of functions applied to the transcoded string.
2515 Each filter is called with three arguments: the full transcoded
2516 string, the back-end, as a symbol, and the communication channel,
2517 as a plist. It must return a string that will be used as the
2521 ;;;; Elements Filters
2524 "List of functions applied to a transcoded babel-call.
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 center block.
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 clock.
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 comment.
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 comment-block.
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 diary-sexp.
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 drawer.
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 dynamic-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 example-block.
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 export-block.
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 fixed-width.
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 footnote-definition.
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 headline.
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 horizontal-rule.
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 inlinetask.
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 item.
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 keyword.
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 latex-environment.
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 node-property.
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 paragraph.
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 plain-list.
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 planning.
2651 Each filter is called with three arguments: the transcoded data,
2652 as a string, the back-end, as a symbol, and the communication
2656 "List of functions applied to a transcoded property-drawer.
2657 Each filter is called with three arguments: the transcoded data,
2658 as a string, the back-end, as a symbol, and the communication
2662 "List of functions applied to a transcoded quote block.
2663 Each filter is called with three arguments: the transcoded quote
2664 data, as a string, the back-end, as a symbol, and the
2665 communication channel, as a plist. It must return a string or
2669 "List of functions applied to a transcoded section.
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 special block.
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 src-block.
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.
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 table-cell.
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 "List of functions applied to a transcoded table-row.
2700 Each filter is called with three arguments: the transcoded data,
2701 as a string, the back-end, as a symbol, and the communication
2705 "List of functions applied to a transcoded verse block.
2706 Each filter is called with three arguments: the transcoded data,
2707 as a string, the back-end, as a symbol, and the communication
2711 ;;;; Objects Filters
2714 "List of functions applied to transcoded bold text.
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 transcoded code text.
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 entity.
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 export-snippet.
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 footnote-reference.
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 a transcoded inline-babel-call.
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 inline-src-block.
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 transcoded italic text.
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 latex-fragment.
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 line-break.
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 link.
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 a transcoded radio-target.
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 statistics-cookie.
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 transcoded strike-through text.
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 subscript.
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 superscript.
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 a transcoded target.
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 a transcoded timestamp.
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 "List of functions applied to transcoded underline text.
2823 Each filter is called with three arguments: the transcoded data,
2824 as a string, the back-end, as a symbol, and the communication
2828 "List of functions applied to transcoded verbatim text.
2829 Each filter is called with three arguments: the transcoded data,
2830 as a string, the back-end, as a symbol, and the communication
2834 ;;;; Filters Tools
2835 ;;
2836 ;; Internal function `org-export-install-filters' installs filters
2837 ;; hard-coded in back-ends (developer filters) and filters from global
2838 ;; variables (user filters) in the communication channel.
2839 ;;
2840 ;; Internal function `org-export-filter-apply-functions' takes care
2841 ;; about applying each filter in order to a given data. It ignores
2842 ;; filters returning a nil value but stops whenever a filter returns
2843 ;; an empty string.
2846 "Call every function in FILTERS.
2848 Functions are called with arguments VALUE, current export
2849 back-end's name and INFO. A function returning a nil value will
2850 be skipped. If it returns the empty string, the process ends and
2851 VALUE is ignored.
2853 Call is done in a LIFO fashion, to be sure that developer
2854 specified filters, if any, are called first."
2865 "Install filters properties in communication channel.
2866 INFO is a plist containing the current communication channel.
2867 Return the updated communication channel."
2869 ;; Install user-defined filters with `org-export-filters-alist'
2870 ;; and filters already in INFO (through ext-plist mechanism).
2877 ;; Filters in INFO will be called
2878 ;; before those user provided.
2881 default-value)))))
2882 org-export-filters-alist)
2883 ;; Prepend back-end specific filters to that list.
2885 ;; Single values get consed, lists are appended.
2890 plist key
2894 ;; Return new communication channel.
2898 \f
2899 ;;; Core functions
2900 ;;
2901 ;; This is the room for the main function, `org-export-as', along with
2902 ;; its derivative, `org-export-string-as'.
2903 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2904 ;; function should be added to kill ring.
2905 ;;
2906 ;; Note that `org-export-as' doesn't really parse the current buffer,
2907 ;; but a copy of it (with the same buffer-local variables and
2908 ;; visibility), where macros and include keywords are expanded and
2909 ;; Babel blocks are executed, if appropriate.
2910 ;; `org-export-with-buffer-copy' macro prepares that copy.
2911 ;;
2912 ;; File inclusion is taken care of by
2913 ;; `org-export-expand-include-keyword' and
2914 ;; `org-export--prepare-file-contents'. Structure wise, including
2915 ;; a whole Org file in a buffer often makes little sense. For
2916 ;; example, if the file contains a headline and the include keyword
2917 ;; was within an item, the item should contain the headline. That's
2918 ;; why file inclusion should be done before any structure can be
2919 ;; associated to the file, that is before parsing.
2920 ;;
2921 ;; `org-export-insert-default-template' is a command to insert
2922 ;; a default template (or a back-end specific template) at point or in
2923 ;; current subtree.
2926 "Return a copy of the current buffer.
2927 The copy preserves Org buffer-local variables, visibility and
2928 narrowing."
2934 new-buf))
2937 "Apply BODY in a copy of the current buffer.
2938 The copy preserves local variables, visibility and contents of
2939 the original buffer. Point is at the beginning of the buffer
2940 when BODY is applied."
2949 ;; Kill copy without confirmation.
2955 "Generate a function duplicating BUFFER.
2957 The copy will preserve local variables, visibility, contents and
2958 narrowing of the original buffer. If a region was active in
2959 BUFFER, contents will be narrowed to that region instead.
2961 The resulting function can be evaluated at a later time, from
2962 another buffer, effectively cloning the original buffer there.
2964 The function assumes BUFFER's major mode is `org-mode'."
2968 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2969 ;; already in BUFFER.
2971 ;; Copy specific buffer local variables and variables set
2972 ;; through BIND keywords.
2974 vars)
2982 buffer-file-name
2983 buffer-file-coding-system))
2987 ;; Skip unreadable values, as they cannot be
2988 ;; sent to external process.
2992 vars))))))
2993 ;; Whole buffer contents.
2998 ;; Narrowing.
3002 ;; Current position of point.
3004 ;; Overlays with invisible property.
3014 ov-set))))
3016 ov-set)))))
3018 ;;;###autoload
3021 "Transcode current Org buffer into BACKEND code.
3023 BACKEND is either an export back-end, as returned by, e.g.,
3024 `org-export-create-backend', or a symbol referring to
3025 a registered back-end.
3027 If narrowing is active in the current buffer, only transcode its
3028 narrowed part.
3030 If a region is active, transcode that region.
3032 When optional argument SUBTREEP is non-nil, transcode the
3033 sub-tree at point, extracting information from the headline
3034 properties first.
3036 When optional argument VISIBLE-ONLY is non-nil, don't export
3037 contents of hidden elements.
3039 When optional argument BODY-ONLY is non-nil, only return body
3040 code, without surrounding template.
3042 Optional argument EXT-PLIST, when provided, is a property list
3043 with external parameters overriding Org default settings, but
3044 still inferior to file-local settings.
3046 Return code as a string."
3051 ;; Narrow buffer to an appropriate region or subtree for
3052 ;; parsing. If parsing subtree, be sure to remove main headline
3053 ;; too.
3061 ;; Initialize communication channel with original buffer
3062 ;; attributes, unavailable in its copy.
3071 tree)
3072 ;; Update communication channel and get parse tree. Buffer
3073 ;; isn't parsed directly. Instead, a temporary copy is
3074 ;; created, where include keywords, macros are expanded and
3075 ;; code blocks are evaluated.
3077 ;; Run first hook with current back-end's name as argument.
3081 ;; Update macro templates since #+INCLUDE keywords might have
3082 ;; added some new ones.
3086 ;; Update radio targets since keyword inclusion might have
3087 ;; added some more.
3089 ;; Run last hook with current back-end's name as argument.
3094 ;; Update communication channel with environment. Also
3095 ;; install user's and developer's filters.
3100 ;; Expand export-specific set of macros: {{{author}}},
3101 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3102 ;; once regular macros have been expanded, since document
3103 ;; keywords may contain one of them.
3109 ;; EMAIL is not a parsed keyword: store it as-is.
3113 ;; Parse buffer.
3115 ;; Handle left-over uninterpreted elements or objects in
3116 ;; parse tree and communication channel.
3118 ;; Call options filters and update export options. We do not
3119 ;; use `org-export-filter-apply-functions' here since the
3120 ;; arity of such filters is different.
3125 ;; Parse buffer, handle uninterpreted elements or objects,
3126 ;; then call parse-tree filters.
3130 ;; Now tree is complete, compute its properties and add them
3131 ;; to communication channel.
3135 ;; Eventually transcode TREE. Wrap the resulting string into
3136 ;; a template.
3145 ;; Remove all text properties since they cannot be
3146 ;; retrieved from an external process. Finally call
3147 ;; final-output filter and return result.
3153 info))))))))
3155 ;;;###autoload
3157 "Transcode STRING into BACKEND code.
3159 BACKEND is either an export back-end, as returned by, e.g.,
3160 `org-export-create-backend', or a symbol referring to
3161 a registered back-end.
3163 When optional argument BODY-ONLY is non-nil, only return body
3164 code, without preamble nor postamble.
3166 Optional argument EXT-PLIST, when provided, is a property list
3167 with external parameters overriding Org default settings, but
3168 still inferior to file-local settings.
3170 Return code as a string."
3176 ;;;###autoload
3178 "Replace the active region by its export to BACKEND.
3179 BACKEND is either an export back-end, as returned by, e.g.,
3180 `org-export-create-backend', or a symbol referring to
3181 a registered back-end."
3191 ;;;###autoload
3193 "Insert all export keywords with default values at beginning of line.
3195 BACKEND is a symbol referring to the name of a registered export
3196 back-end, for which specific export options should be added to
3197 the template, or `default' for default template. When it is nil,
3198 the user will be prompted for a category.
3200 If SUBTREEP is non-nil, export configuration will be set up
3201 locally for the subtree through node properties."
3211 "Options category: "
3215 org-export--registered-backends))
3216 nil t))))
3217 options keywords)
3218 ;; Populate OPTIONS and KEYWORDS.
3235 ;; Move to an appropriate location in order to insert options.
3237 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3255 ;; Then the rest of keywords, in the order specified in either
3256 ;; `org-export-options-alist' or respective export back-ends.
3277 "Expand every include keyword in buffer.
3278 Optional argument INCLUDED is a list of included file names along
3279 with their line restriction, when appropriate. It is used to
3280 avoid infinite recursion. Optional argument DIR is the current
3281 working directory. It is used to properly resolve relative
3282 paths."
3291 ;; Extract arguments from keyword's value.
3299 dir)
3304 value)
3310 ;; Minimal level of included file defaults to the child
3311 ;; level of the current headline, if any, or one. It
3312 ;; only applies is the file is meant to be included as
3313 ;; an Org one.
3321 ;; Remove keyword.
3327 ;; Check if files has already been parsed. Look after
3328 ;; inclusion lines too, as different parts of the same file
3329 ;; can be included too.
3341 ind-str contents ind-str))))
3349 ind-str env contents ind-str))))
3356 file lines ind minlevel
3365 "Prepare the contents of FILE for inclusion and return them as a string.
3367 When optional argument LINES is a string specifying a range of
3368 lines, include only those lines.
3370 Optional argument IND, when non-nil, is an integer specifying the
3371 global indentation of returned contents. Since its purpose is to
3372 allow an included file to stay in the same environment it was
3373 created \(i.e. a list item), it doesn't apply past the first
3374 headline encountered.
3376 Optional argument MINLEVEL, when non-nil, is an integer
3377 specifying the level that any top-level headline in the included
3378 file should have.
3380 Optional argument ID is an integer that will be inserted before
3381 each footnote definition and reference if FILE is an Org file.
3382 This is useful to avoid conflicts when more than one Org file
3383 with footnotes is included in a document."
3399 ;; Remove blank lines at beginning and end of contents. The logic
3400 ;; behind that removal is that blank lines around include keyword
3401 ;; override blank lines in included file.
3410 ;; If IND is set, preserve indentation of include keyword until
3411 ;; the first headline encountered.
3418 ;; Do not move footnote definitions out of column 0.
3424 ;; When MINLEVEL is specified, compute minimal level for headlines
3425 ;; in the file (CUR-MIN), and remove stars to each headline so
3426 ;; that headlines with minimal level have a level of MINLEVEL.
3437 ;; Only change stars, don't bother moving whole
3438 ;; sections.
3442 ;; Append ID to all footnote references and definitions, so they
3443 ;; become file specific and cannot collide with footnotes in other
3444 ;; included files.
3461 "Execute every Babel code in the visible part of current buffer."
3462 ;; Get a pristine copy of current buffer so Babel references can be
3463 ;; properly resolved.
3469 "Return a non-nil value when output should be added to the kill ring.
3470 See also `org-export-copy-to-kill-ring'."
3476 \f
3477 ;;; Tools For Back-Ends
3478 ;;
3479 ;; A whole set of tools is available to help build new exporters. Any
3480 ;; function general enough to have its use across many back-ends
3481 ;; should be added here.
3483 ;;;; For Affiliated Keywords
3484 ;;
3485 ;; `org-export-read-attribute' reads a property from a given element
3486 ;; as a plist. It can be used to normalize affiliated keywords'
3487 ;; syntax.
3488 ;;
3489 ;; Since captions can span over multiple lines and accept dual values,
3490 ;; their internal representation is a bit tricky. Therefore,
3491 ;; `org-export-get-caption' transparently returns a given element's
3492 ;; caption as a secondary string.
3495 "Turn ATTRIBUTE property from ELEMENT into a plist.
3497 When optional argument PROPERTY is non-nil, return the value of
3498 that property within attributes.
3502 properties.
3504 All values will become strings except the empty string and
3507 will become the empty string."
3521 s)
3526 ;; Ignore any string before first property with `cdr'.
3531 "Return caption from ELEMENT as a secondary string.
3533 When optional argument SHORTP is non-nil, return short caption,
3534 as a secondary string, instead.
3536 Caption lines are separated by a white space."
3544 ;;;; For Derived Back-ends
3545 ;;
3546 ;; `org-export-with-backend' is a function allowing to locally use
3547 ;; another back-end to transcode some object or element. In a derived
3548 ;; back-end, it may be used as a fall-back function once all specific
3549 ;; cases have been treated.
3552 "Call a transcoder from BACKEND on DATA.
3553 BACKEND is an export back-end, as returned by, e.g.,
3554 `org-export-create-backend', or a symbol referring to
3555 a registered back-end. DATA is an Org element, object, secondary
3556 string or string. CONTENTS, when non-nil, is the transcoded
3557 contents of DATA element, as a string. INFO, when non-nil, is
3558 the communication channel used for export, as a plist."
3568 transcoder data contents
3571 :translate-alist all-transcoders
3575 ;;;; For Export Snippets
3576 ;;
3577 ;; Every export snippet is transmitted to the back-end. Though, the
3578 ;; latter will only retain one type of export-snippet, ignoring
3579 ;; others, based on the former's target back-end. The function
3580 ;; `org-export-snippet-backend' returns that back-end for a given
3581 ;; export-snippet.
3584 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3585 Translation, with `org-export-snippet-translation-alist', is
3586 applied."
3590 back-end))))
3593 ;;;; For Footnotes
3594 ;;
3595 ;; `org-export-collect-footnote-definitions' is a tool to list
3596 ;; actually used footnotes definitions in the whole parse tree, or in
3597 ;; a headline, in order to add footnote listings throughout the
3598 ;; transcoded data.
3599 ;;
3600 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3601 ;; back-ends, when they need to attach the footnote definition only to
3602 ;; the first occurrence of the corresponding label.
3603 ;;
3604 ;; `org-export-get-footnote-definition' and
3605 ;; `org-export-get-footnote-number' provide easier access to
3606 ;; additional information relative to a footnote reference.
3609 "Return an alist between footnote numbers, labels and definitions.
3611 DATA is the parse tree from which definitions are collected.
3612 INFO is the plist used as a communication channel.
3614 Definitions are sorted by order of references. They either
3615 appear as Org data or as a secondary string for inlined
3616 footnotes. Unreferenced definitions are ignored."
3618 collect-fn ; for byte-compiler.
3622 ;; Collect footnote number, label and definition in DATA.
3630 def)
3631 num-alist)
3632 ;; Also search in definition for nested footnotes.
3635 ;; Don't enter footnote definitions since it will happen
3636 ;; when their first reference is found.
3642 "Non-nil when a footnote reference is the first one for its label.
3644 FOOTNOTE-REFERENCE is the footnote reference being considered.
3645 INFO is the plist used as a communication channel."
3647 ;; Anonymous footnotes are always a first reference.
3649 ;; Otherwise, return the first footnote with the same LABEL and
3650 ;; test if it is equal to FOOTNOTE-REFERENCE.
3660 ;; If FN isn't inlined, be sure to traverse its
3661 ;; definition before resuming search. See
3662 ;; comments in `org-export-get-footnote-number'
3663 ;; for more information.
3667 ;; Don't enter footnote definitions since it will
3668 ;; happen when their first reference is found.
3671 footnote-reference)))))
3674 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3675 INFO is the plist used as a communication channel. If no such
3677 string."
3684 "Return number associated to a footnote.
3686 FOOTNOTE is either a footnote reference or a footnote definition.
3687 INFO is the plist used as a communication channel."
3689 seen-refs
3690 search-ref ; For byte-compiler.
3694 ;; Search footnote references through DATA, filling
3695 ;; SEEN-REFS along the way.
3700 ;; Anonymous footnote match: return number.
3703 ;; Labels match: return number.
3706 ;; Anonymous footnote: it's always a new one.
3707 ;; Also, be sure to return nil from the `cond' so
3708 ;; `first-match' doesn't get us out of the loop.
3710 ;; Label not seen so far: add it so SEEN-REFS.
3711 ;;
3712 ;; Also search for subsequent references in
3713 ;; footnote definition so numbering follows
3714 ;; reading logic. Note that we don't have to care
3715 ;; about inline definitions, since
3716 ;; `org-element-map' already traverses them at the
3717 ;; right time.
3718 ;;
3719 ;; Once again, return nil to stay in the loop.
3724 nil))))
3725 ;; Don't enter footnote definitions since it will
3726 ;; happen when their first reference is found.
3731 ;;;; For Headlines
3732 ;;
3733 ;; `org-export-get-relative-level' is a shortcut to get headline
3734 ;; level, relatively to the lower headline level in the parsed tree.
3735 ;;
3736 ;; `org-export-get-headline-number' returns the section number of an
3737 ;; headline, while `org-export-number-to-roman' allows to convert it
3738 ;; to roman numbers.
3739 ;;
3740 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3741 ;; `org-export-last-sibling-p' are three useful predicates when it
3742 ;; comes to fulfill the `:headline-levels' property.
3743 ;;
3744 ;; `org-export-get-tags', `org-export-get-category' and
3745 ;; `org-export-get-node-property' extract useful information from an
3746 ;; headline or a parent headline. They all handle inheritance.
3747 ;;
3748 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3749 ;; as a secondary string, suitable for table of contents. It falls
3750 ;; back onto default title.
3753 "Return HEADLINE relative level within current parsed tree.
3754 INFO is a plist holding contextual information."
3759 "Non-nil when HEADLINE is considered as low level.
3761 INFO is a plist used as a communication channel.
3763 A low level headlines has a relative level greater than
3764 `:headline-levels' property value.
3766 Return value is the difference between HEADLINE relative level
3767 and the last level being considered as high enough, or nil."
3774 "Return HEADLINE numbering as a list of numbers.
3775 INFO is a plist holding contextual information."
3779 "Return a non-nil value if HEADLINE element should be numbered.
3780 INFO is a plist used as a communication channel."
3786 "Convert integer N into a roman numeral."
3799 res)))
3802 "Return list of tags associated to ELEMENT.
3804 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3805 is a plist used as a communication channel.
3807 Select tags (see `org-export-select-tags') and exclude tags (see
3808 `org-export-exclude-tags') are removed from the list.
3810 When non-nil, optional argument TAGS should be a list of strings.
3811 Any tag belonging to this list will also be removed.
3813 When optional argument INHERITED is non-nil, tags can also be
3814 inherited from parent headlines and FILETAGS keywords."
3820 ;; Build complete list of inherited tags.
3831 ;; Add FILETAGS keywords and return results.
3835 "Return node PROPERTY value for BLOB.
3837 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3838 element or object.
3840 If optional argument INHERITED is non-nil, the value can be
3841 inherited from a parent headline.
3843 Return value is a string or nil."
3855 "Return category for element or object BLOB.
3857 INFO is a plist used as a communication channel.
3859 CATEGORY is automatically inherited from a parent headline, from
3860 #+CATEGORY: keyword or created out of original file name. If all
3864 ;; Almost like `org-export-node-property', but we cannot trust
3865 ;; `plist-member' as every headline has a `:CATEGORY'
3866 ;; property, would it be nil or equal to "???" (which has the
3867 ;; same meaning).
3885 "Return alternative title for HEADLINE, as a secondary string.
3886 INFO is a plist used as a communication channel. If no optional
3887 title is defined, fall-back to the regular title."
3892 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3893 INFO is a plist used as a communication channel."
3898 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3899 INFO is a plist used as a communication channel."
3903 ;;;; For Keywords
3904 ;;
3905 ;; `org-export-get-date' returns a date appropriate for the document
3906 ;; to about to be exported. In particular, it takes care of
3907 ;; `org-export-date-timestamp-format'.
3910 "Return date value for the current document.
3912 INFO is a plist used as a communication channel. FMT, when
3913 non-nil, is a time format string that will be applied on the date
3914 if it consists in a single timestamp object. It defaults to
3915 `org-export-date-timestamp-format' when nil.
3917 A proper date can be a secondary string, a string or nil. It is
3918 meant to be translated with `org-export-data' or alike."
3929 ;;;; For Links
3930 ;;
3931 ;; `org-export-solidify-link-text' turns a string into a safer version
3932 ;; for links, replacing most non-standard characters with hyphens.
3933 ;;
3934 ;; `org-export-get-coderef-format' returns an appropriate format
3935 ;; string for coderefs.
3936 ;;
3937 ;; `org-export-inline-image-p' returns a non-nil value when the link
3938 ;; provided should be considered as an inline image.
3939 ;;
3940 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3941 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3942 ;; returns an appropriate unique identifier when found, or nil.
3943 ;;
3944 ;; `org-export-resolve-id-link' returns the first headline with
3945 ;; specified id or custom-id in parse tree, the path to the external
3946 ;; file with the id or nil when neither was found.
3947 ;;
3948 ;; `org-export-resolve-coderef' associates a reference to a line
3949 ;; number in the element it belongs, or returns the reference itself
3950 ;; when the element isn't numbered.
3953 "Take link text S and make a safe target out of it."
3958 "Return format string for code reference link.
3959 PATH is the link path. DESC is its description."
3967 "Non-nil if LINK object points to an inline image.
3969 Optional argument is a set of RULES defining inline images. It
3970 is an alist where associations have the following shape:
3972 \(TYPE . REGEXP)
3974 Applying a rule means apply REGEXP against LINK's path when its
3975 type is TYPE. The function will return a non-nil value if any of
3976 the provided rules is non-nil. The default rule is
3977 `org-export-default-inline-image-rule'.
3979 This only applies to links without a description."
3990 rules)
3991 ;; Return nil if no rule matched.
3992 nil))))
3995 "Resolve a code reference REF.
3997 INFO is a plist used as a communication channel.
3999 Return associated line number in source code, or REF itself,
4000 depending on src-block or example element's switches."
4007 org-coderef-label-format)))
4011 ;; Element containing REF is found. Resolve it to either
4012 ;; a label or a line number, as needed.
4022 "Return LINK destination.
4024 INFO is a plist holding contextual information.
4026 Return value can be an object, an element, or nil:
4028 - If LINK path matches a target object (i.e. <<path>>) return it.
4030 - If LINK path exactly matches the name affiliated keyword
4031 \(i.e. #+NAME: path) of an element, return that element.
4033 - If LINK path exactly matches any headline name, return that
4034 element. If more than one headline share that name, priority
4035 will be given to the one with the closest common ancestor, if
4036 any, or the first one in the parse tree otherwise.
4038 - Otherwise, return nil.
4041 significant."
4044 ;; Split PATH at white spaces so matches are space
4045 ;; insensitive.
4048 ;; Cache for destinations that are not position dependent.
4056 ;; Destination is not position dependent: use cached value.
4058 ;; First try to find a matching "<<path>>" unless user specified
4059 ;; he was looking for a headline (path starts with a "*"
4060 ;; character).
4066 path)
4067 blob))
4070 ;; Then try to find an element with a matching "#+NAME: path"
4071 ;; affiliated keyword.
4074 org-element-all-elements
4079 el)))
4082 ;; Last case: link either points to a headline or to nothingness.
4083 ;; Try to find the source, with priority given to headlines with
4084 ;; the closest common ancestor. If such candidate is found,
4085 ;; return it, otherwise return nil.
4089 ;; Return first headline whose `:raw-value' property is
4090 ;; NAME in parse tree DATA, or nil. Statistics cookies
4091 ;; are ignored.
4099 name)
4100 headline))
4102 ;; Search among headlines sharing an ancestor with link, from
4103 ;; closest to farthest.
4112 ;; No destination found: return nil.
4116 "Return headline referenced as LINK destination.
4118 INFO is a plist used as a communication channel.
4120 Return value can be the headline element matched in current parse
4124 ;; First check if id is within the current parse tree.
4129 headline))
4131 ;; Otherwise, look for external files.
4135 "Return radio-target object referenced as LINK destination.
4137 INFO is a plist used as a communication channel.
4139 Return value can be a radio-target object or nil. Assume LINK
4148 nil nil path nil nil t)
4149 t)
4150 radio))
4154 ;;;; For References
4155 ;;
4156 ;; `org-export-get-ordinal' associates a sequence number to any object
4157 ;; or element.
4160 "Return ordinal number of an element or object.
4162 ELEMENT is the element or object considered. INFO is the plist
4163 used as a communication channel.
4165 Optional argument TYPES, when non-nil, is a list of element or
4166 object types, as symbols, that should also be counted in.
4167 Otherwise, only provided element's type is considered.
4169 Optional argument PREDICATE is a function returning a non-nil
4170 value if the current element or object should be counted in. It
4171 accepts two arguments: the element or object being considered and
4172 the plist used as a communication channel. This allows to count
4173 only a certain type of objects (i.e. inline images).
4175 Return value is a list of numbers if ELEMENT is a headline or an
4176 item. It is nil for keywords. It represents the footnote number
4177 for footnote definitions and footnote references. If ELEMENT is
4178 a target, return the same value as if ELEMENT was the closest
4179 table, item or headline containing the target. In any other
4180 case, return the sequence number of ELEMENT among elements or
4181 objects of the same type."
4182 ;; Ordinal of a target object refer to the ordinal of the closest
4183 ;; table, item, or headline containing the object.
4187 when
4191 table))
4192 return parent)))
4194 ;; Special case 1: A headline returns its number as a list.
4196 ;; Special case 2: An item returns its number as a list.
4200 struct
4207 ;; Increment counter until ELEMENT is found again.
4218 ;;;; For Src-Blocks
4219 ;;
4220 ;; `org-export-get-loc' counts number of code lines accumulated in
4221 ;; src-block or example-block elements with a "+n" switch until
4222 ;; a given element, excluded. Note: "-n" switches reset that count.
4223 ;;
4224 ;; `org-export-unravel-code' extracts source code (along with a code
4225 ;; references alist) from an `element-block' or `src-block' type
4226 ;; element.
4227 ;;
4228 ;; `org-export-format-code' applies a formatting function to each line
4229 ;; of code, providing relative line number and code reference when
4230 ;; appropriate. Since it doesn't access the original element from
4231 ;; which the source code is coming, it expects from the code calling
4232 ;; it to know if lines should be numbered and if code references
4233 ;; should appear.
4234 ;;
4235 ;; Eventually, `org-export-format-code-default' is a higher-level
4236 ;; function (it makes use of the two previous functions) which handles
4237 ;; line numbering and code references inclusion, and returns source
4238 ;; code in a format suitable for plain text or verbatim output.
4241 "Return accumulated lines of code up to ELEMENT.
4243 INFO is the plist used as a communication channel.
4245 ELEMENT is excluded from count."
4251 ;; ELEMENT is reached: Quit the loop.
4253 ;; Only count lines from src-block and example-block elements
4254 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4258 ;; Accumulate locs or reset them.
4262 ;; Return nil to stay in the loop.
4263 nil)))
4265 ;; Return value.
4266 loc))
4269 "Clean source code and extract references out of it.
4271 ELEMENT has either a `src-block' an `example-block' type.
4273 Return a cons cell whose CAR is the source code, cleaned from any
4274 reference, protective commas and spurious indentation, and CDR is
4275 an alist between relative line number (integer) and name of code
4276 reference on that line (string)."
4279 ;; Get code and clean it. Remove blank lines at its
4280 ;; beginning and end.
4287 value
4289 ;; Get format used for references.
4292 org-coderef-label-format)))
4293 ;; Build a regexp matching a loc with a reference.
4298 ;; Return value.
4300 ;; Code with references removed.
4306 ;; Ref line: remove ref, and signal its position in REFS.
4310 ;; Reference alist.
4311 refs)))
4314 "Format CODE by applying FUN line-wise and return it.
4316 CODE is a string representing the code to format. FUN is
4317 a function. It must accept three arguments: a line of
4318 code (string), the current line number (integer) or nil and the
4319 reference associated to the current line (string) or nil.
4321 Optional argument NUM-LINES can be an integer representing the
4322 number of code lines accumulated until the current code. Line
4323 numbers passed to FUN will take it into account. If it is nil,
4324 FUN's second argument will always be nil. This number can be
4325 obtained with `org-export-get-loc' function.
4327 Optional argument REF-ALIST can be an alist between relative line
4328 number (i.e. ignoring NUM-LINES) and the name of the code
4329 reference on it. If it is nil, FUN's third argument will always
4330 be nil. It can be obtained through the use of
4331 `org-export-unravel-code' function."
4343 "Return source code from ELEMENT, formatted in a standard way.
4345 ELEMENT is either a `src-block' or `example-block' element. INFO
4346 is a plist used as a communication channel.
4348 This function takes care of line numbering and code references
4349 inclusion. Line numbers, when applicable, appear at the
4350 beginning of the line, separated from the code by two white
4351 spaces. Code references, on the other hand, appear flushed to
4352 the right, separated by six white spaces from the widest line of
4353 code."
4354 ;; Extract code and references.
4361 ;; Handle line numbering.
4370 ;; Prepare references display, if required. Any reference
4371 ;; should start six columns after the widest line of code,
4372 ;; wrapped with parenthesis.
4377 code
4381 number-str
4382 loc
4388 num-start refs)))))
4391 ;;;; For Tables
4392 ;;
4393 ;; `org-export-table-has-special-column-p' and and
4394 ;; `org-export-table-row-is-special-p' are predicates used to look for
4395 ;; meta-information about the table structure.
4396 ;;
4397 ;; `org-table-has-header-p' tells when the rows before the first rule
4398 ;; should be considered as table's header.
4399 ;;
4400 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4401 ;; and `org-export-table-cell-borders' extract information from
4402 ;; a table-cell element.
4403 ;;
4404 ;; `org-export-table-dimensions' gives the number on rows and columns
4405 ;; in the table, ignoring horizontal rules and special columns.
4406 ;; `org-export-table-cell-address', given a table-cell object, returns
4407 ;; the absolute address of a cell. On the other hand,
4408 ;; `org-export-get-table-cell-at' does the contrary.
4409 ;;
4410 ;; `org-export-table-cell-starts-colgroup-p',
4411 ;; `org-export-table-cell-ends-colgroup-p',
4412 ;; `org-export-table-row-starts-rowgroup-p',
4413 ;; `org-export-table-row-ends-rowgroup-p',
4414 ;; `org-export-table-row-starts-header-p' and
4415 ;; `org-export-table-row-ends-header-p' indicate position of current
4416 ;; row or cell within the table.
4419 "Non-nil when TABLE has a special column.
4420 All special columns will be ignored during export."
4421 ;; The table has a special column when every first cell of every row
4422 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4423 ;; "*" "_" and "^". Though, do not consider a first row containing
4424 ;; only empty cells as special.
4440 "Non-nil when TABLE has a header.
4442 INFO is a plist used as a communication channel.
4444 A table has a header when it contains at least two row groups."
4453 table
4464 cache)))))
4467 "Non-nil if TABLE-ROW is considered special.
4469 INFO is a plist used as the communication channel.
4471 All special rows will be ignored during export."
4475 ;; A row is special either when...
4477 ;; ... it starts with a field only containing "/",
4479 ;; ... the table contains a special column and the row start
4480 ;; with a marking character among, "^", "_", "$" or "!",
4484 ;; ... it contains only alignment cookies and empty cells.
4490 ;; Since VALUE is a secondary string, the following
4491 ;; checks avoid expanding it with `org-export-data'.
4503 "Return TABLE-ROW's group number, as an integer.
4505 INFO is a plist used as the communication channel.
4507 Return value is the group number, as an integer, or nil for
4508 special rows and rows separators. First group is also table's
4509 header."
4527 "Return TABLE-CELL contents width.
4529 INFO is a plist used as the communication channel.
4531 Return value is the width given by the last width cookie in the
4532 same column as TABLE-CELL, or nil."
4551 ;; In a special row, try to find a width cookie at COLUMN.
4555 ;; The following checks avoid expanding unnecessarily
4556 ;; the cell with `org-export-data'.
4566 "Return TABLE-CELL contents alignment.
4568 INFO is a plist used as the communication channel.
4570 Return alignment as specified by the last alignment cookie in the
4571 same column as TABLE-CELL. If no such cookie is found, a default
4572 alignment value will be deduced from fraction of numbers in the
4573 column (see `org-table-number-fraction' for more information).
4574 Possible values are `left', `right' and `center'."
4575 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4592 cookie-align
4593 previous-cell-number-p)
4596 ;; In a special row, try to find an alignment cookie at
4597 ;; COLUMN.
4601 ;; Since VALUE is a secondary string, the following
4602 ;; checks avoid useless expansion through
4603 ;; `org-export-data'.
4611 ;; Ignore table rules.
4613 ;; In a standard row, check if cell's contents are
4614 ;; expressing some kind of number. Increase NUMBER-CELLS
4615 ;; accordingly. Though, don't bother if an alignment
4616 ;; cookie has already defined cell's alignment.
4621 info)))
4623 ;; Treat an empty cell as a number if it follows
4624 ;; a number.
4630 ;; Return value. Alignment specified by cookies has
4631 ;; precedence over alignment deduced from cell's contents.
4633 column
4638 org-table-number-fraction)
4643 "Return TABLE-CELL borders.
4645 INFO is a plist used as a communication channel.
4647 Return value is a list of symbols, or nil. Possible values are:
4648 `top', `bottom', `above', `below', `left' and `right'. Note:
4649 `top' (resp. `bottom') only happen for a cell in the first
4650 row (resp. last row) of the table, ignoring table rules, if any.
4652 Returned borders ignore special rows."
4655 borders)
4656 ;; Top/above border? TABLE-CELL has a border above when a rule
4657 ;; used to demarcate row groups can be found above. Hence,
4658 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4659 ;; another regular row has to be found above that rule.
4668 ;; Look at every row before the current one.
4670 ;; No rule above, or rule found starts the table (ignoring any
4671 ;; special row): TABLE-CELL is at the top of the table.
4674 ;; Bottom/below border? TABLE-CELL has a border below when next
4675 ;; non-regular row below is a rule.
4684 ;; Look at every row after the current one.
4686 ;; No rule below, or rule found ends the table (modulo some
4687 ;; special row): TABLE-CELL is at the bottom of the table.
4690 ;; Right/left borders? They can only be specified by column
4691 ;; groups. Column groups are defined in a row starting with "/".
4692 ;; Also a column groups row only contains "<", "<>", ">" or blank
4693 ;; cells.
4710 ;; There's a left border when previous cell, if
4711 ;; any, ends a group, or current one starts one.
4717 ;; There's a right border when next cell, if any,
4718 ;; starts a group, or current one ends one.
4725 ;; Table rows are read in reverse order so last column groups
4726 ;; row has precedence over any previous one.
4728 ;; Return value.
4729 borders))
4732 "Non-nil when TABLE-CELL is at the beginning of a column group.
4733 INFO is a plist used as a communication channel."
4734 ;; A cell starts a column group either when it is at the beginning
4735 ;; of a row (or after the special column, if any) or when it has
4736 ;; a left border.
4739 table-cell)
4743 "Non-nil when TABLE-CELL is at the end of a column group.
4744 INFO is a plist used as a communication channel."
4745 ;; A cell ends a column group either when it is at the end of a row
4746 ;; or when it has a right border.
4749 table-cell)
4753 "Non-nil when TABLE-ROW is at the beginning of a row group.
4754 INFO is a plist used as a communication channel."
4762 "Non-nil when TABLE-ROW is at the end of a row group.
4763 INFO is a plist used as a communication channel."
4771 "Non-nil when TABLE-ROW is the first table header's row.
4772 INFO is a plist used as a communication channel."
4779 "Non-nil when TABLE-ROW is the last table header's row.
4780 INFO is a plist used as a communication channel."
4787 "Return TABLE-ROW number.
4788 INFO is a plist used as a communication channel. Return value is
4789 zero-based and ignores separators. The function returns nil for
4790 special columns and separators."
4802 "Return TABLE dimensions.
4804 INFO is a plist used as a communication channel.
4806 Return value is a CONS like (ROWS . COLUMNS) where
4807 ROWS (resp. COLUMNS) is the number of exportable
4808 rows (resp. columns)."
4810 ;; Set number of rows, and extract first one.
4816 ;; Set number of columns.
4818 ;; Return value.
4822 "Return address of a regular TABLE-CELL object.
4824 TABLE-CELL is the cell considered. INFO is a plist used as
4825 a communication channel.
4827 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4828 zero-based index. Only exportable cells are considered. The
4829 function returns nil for other cells."
4841 "Return regular table-cell object at ADDRESS in TABLE.
4843 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4844 zero-based index. TABLE is a table type element. INFO is
4845 a plist used as a communication channel.
4847 If no table-cell, among exportable cells, is found at ADDRESS,
4848 return nil."
4851 ;; Row at (car address) or nil.
4859 'table-cell
4866 ;;;; For Tables Of Contents
4867 ;;
4868 ;; `org-export-collect-headlines' builds a list of all exportable
4869 ;; headline elements, maybe limited to a certain depth. One can then
4870 ;; easily parse it and transcode it.
4871 ;;
4872 ;; Building lists of tables, figures or listings is quite similar.
4873 ;; Once the generic function `org-export-collect-elements' is defined,
4874 ;; `org-export-collect-tables', `org-export-collect-figures' and
4875 ;; `org-export-collect-listings' can be derived from it.
4878 "Collect headlines in order to build a table of contents.
4880 INFO is a plist used as a communication channel.
4882 When optional argument N is an integer, it specifies the depth of
4883 the table of contents. Otherwise, it is set to the value of the
4884 last headline level. See `org-export-headline-levels' for more
4885 information.
4887 Return a list of all exportable headlines as parsed elements.
4888 Footnote sections, if any, will be ignored."
4896 info)))
4899 "Collect referenceable elements of a determined type.
4901 TYPE can be a symbol or a list of symbols specifying element
4902 types to search. Only elements with a caption are collected.
4904 INFO is a plist used as a communication channel.
4906 When non-nil, optional argument PREDICATE is a function accepting
4907 one argument, an element of type TYPE. It returns a non-nil
4908 value when that element should be collected.
4910 Return a list of all elements found, in order of appearance."
4915 element))
4916 info))
4919 "Build a list of tables.
4920 INFO is a plist used as a communication channel.
4922 Return a list of table elements with a caption."
4926 "Build a list of figures.
4928 INFO is a plist used as a communication channel. PREDICATE is
4929 a function which accepts one argument: a paragraph element and
4930 whose return value is non-nil when that element should be
4931 collected.
4933 A figure is a paragraph type element, with a caption, verifying
4935 a vague concept that may depend on back-end.
4937 Return a list of elements recognized as figures."
4941 "Build a list of src blocks.
4943 INFO is a plist used as a communication channel.
4945 Return a list of src-block elements with a caption."
4949 ;;;; Smart Quotes
4950 ;;
4951 ;; The main function for the smart quotes sub-system is
4952 ;; `org-export-activate-smart-quotes', which replaces every quote in
4953 ;; a given string from the parse tree with its "smart" counterpart.
4954 ;;
4955 ;; Dictionary for smart quotes is stored in
4956 ;; `org-export-smart-quotes-alist'.
4957 ;;
4958 ;; Internally, regexps matching potential smart quotes (checks at
4959 ;; string boundaries are also necessary) are defined in
4960 ;; `org-export-smart-quotes-regexps'.
4964 ;; one may use: »...«, "...", ›...‹, or '...'.
4965 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4966 ;; LaTeX quotes require Babel!
5011 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5020 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5029 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5038 ;; 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
5039 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5050 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5056 )
5057 "Smart quotes translations.
5059 Alist whose CAR is a language string and CDR is an alist with
5060 quote type as key and a plist associating various encodings to
5061 their translation as value.
5063 A quote type can be any symbol among `opening-double-quote',
5064 `closing-double-quote', `opening-single-quote',
5065 `closing-single-quote' and `apostrophe'.
5067 Valid encodings include `:utf-8', `:html', `:latex' and
5068 `:texinfo'.
5074 ;; Possible opening quote at beginning of string.
5076 ;; Possible closing quote at beginning of string.
5078 ;; Possible apostrophe at beginning of string.
5080 ;; Opening single and double quotes.
5082 ;; Closing single and double quotes.
5084 ;; Apostrophe.
5086 ;; Possible opening quote at end of string.
5088 ;; Possible closing quote at end of string.
5090 ;; Possible apostrophe at end of string.
5092 "List of regexps matching a quote or an apostrophe.
5098 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5099 `:utf-8'. INFO is a plist used as a communication channel.
5101 The function has to retrieve information about string
5102 surroundings in parse tree. It can only happen with an
5103 unmodified string. Thus, if S has already been through another
5104 process, a non-nil ORIGINAL optional argument will provide that
5105 original string.
5107 Return the new string."
5110 ;; Try to be flexible when computing number of blanks
5111 ;; before object. The previous object may be a string
5112 ;; introduced by the back-end and not completely parsed.
5115 ;; A string with missing `:post-blank'
5116 ;; property.
5120 ;; Fallback value.
5125 ;; Return smart quote associated to a give quote Q, as
5126 ;; a string. TYPE is a symbol among `open', `close' and
5127 ;; `apostrophe'.
5137 org-export-smart-quotes-alist))))
5138 encoding)
5139 q)))))
5141 ;; Only a quote: no regexp can match. We have to check both
5142 ;; sides and decide what to do.
5150 ;; 1. Replace quote character at the beginning of S.
5152 ;; Apostrophe?
5158 ;; Closing quote?
5164 ;; Opening quote?
5170 ;; 2. Replace quotes in the middle of the string.
5172 ;; Opening quotes.
5178 ;; Closing quotes.
5184 ;; Apostrophes.
5189 ;; 3. Replace quote character at the end of S.
5191 ;; Apostrophe?
5196 ;; Closing quote?
5202 ;; Opening quote?
5207 ;; Return string with smart quotes.
5208 s))))
5210 ;;;; Topology
5211 ;;
5212 ;; Here are various functions to retrieve information about the
5213 ;; neighborhood of a given element or object. Neighbors of interest
5214 ;; are direct parent (`org-export-get-parent'), parent headline
5215 ;; (`org-export-get-parent-headline'), first element containing an
5216 ;; object, (`org-export-get-parent-element'), parent table
5217 ;; (`org-export-get-parent-table'), previous element or object
5218 ;; (`org-export-get-previous-element') and next element or object
5219 ;; (`org-export-get-next-element').
5220 ;;
5221 ;; `org-export-get-genealogy' returns the full genealogy of a given
5222 ;; element or object, from closest parent to full parse tree.
5225 "Return full genealogy relative to a given element or object.
5227 BLOB is the element or object being considered.
5229 Ancestors are returned from closest to farthest, the last one
5230 being the full parse tree."
5237 "Return BLOB parent headline or nil.
5238 BLOB is the element or object being considered."
5242 parent))
5245 "Return first element containing OBJECT or nil.
5246 OBJECT is the object to consider."
5250 parent))
5253 "Return OBJECT parent table or nil.
5254 OBJECT is either a `table-cell' or `table-element' type object."
5258 parent))
5261 "Return previous element or object.
5263 BLOB is an element or object. INFO is a plist used as
5264 a communication channel. Return previous exportable element or
5265 object, a string, or nil.
5267 When optional argument N is a positive integer, return a list
5268 containing up to N siblings before BLOB, from farthest to
5269 closest. With any other non-nil value, return a list containing
5270 all of them."
5276 prev)
5286 "Return next element or object.
5288 BLOB is an element or object. INFO is a plist used as
5289 a communication channel. Return next exportable element or
5290 object, a string, or nil.
5292 When optional argument N is a positive integer, return a list
5293 containing up to N siblings after BLOB, from closest to farthest.
5294 With any other non-nil value, return a list containing all of
5295 them."
5302 next)
5312 ;;;; Translation
5313 ;;
5314 ;; `org-export-translate' translates a string according to the language
5315 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5316 ;; the dictionary used for the translation.
5363 ("ru" :html "(Продолжение следует)"
5461 ("ru" :html "Список распечаток"
5474 ("ru" :html "Список таблиц"
5557 ("ru" :html "Неизвестная ссылка"
5560 "Dictionary for export engine.
5562 Alist whose CAR is the string to translate and CDR is an alist
5563 whose CAR is the language string and CDR is a plist whose
5564 properties are possible charsets and values translated terms.
5566 It is used as a database for `org-export-translate'. Since this
5567 function returns the string as-is if no translation was found,
5568 the variable only needs to record values different from the
5572 "Translate string S according to language specification.
5574 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5575 and `:utf-8'. INFO is a plist used as a communication channel.
5577 Translation depends on `:language' property. Return the
5578 translated string. If no translation is found, try to fall back
5579 to `:default' encoding. If it fails, return S."
5585 s)))
5588 \f
5589 ;;; Asynchronous Export
5590 ;;
5591 ;; `org-export-async-start' is the entry point for asynchronous
5592 ;; export. It recreates current buffer (including visibility,
5593 ;; narrowing and visited file) in an external Emacs process, and
5594 ;; evaluates a command there. It then applies a function on the
5595 ;; returned results in the current process.
5596 ;;
5597 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5598 ;; allow to export to a buffer or a file, asynchronously or not.
5599 ;;
5600 ;; `org-export-output-file-name' is an auxiliary function meant to be
5601 ;; used with `org-export-to-file'. With a given extension, it tries
5602 ;; to provide a canonical file name to write export output to.
5603 ;;
5604 ;; Asynchronously generated results are never displayed directly.
5605 ;; Instead, they are stored in `org-export-stack-contents'. They can
5606 ;; then be retrieved by calling `org-export-stack'.
5607 ;;
5608 ;; Export Stack is viewed through a dedicated major mode
5609 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5610 ;;`org-export-stack-delete', `org-export-stack-view' and
5611 ;;`org-export-stack-clear'.
5612 ;;
5613 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5614 ;; It should be used whenever `org-export-async-start' is called.
5617 "Call function FUN on the results returned by BODY evaluation.
5619 BODY evaluation happens in an asynchronous process, from a buffer
5620 which is an exact copy of the current one.
5622 Use `org-export-add-to-stack' in FUN in order to register results
5623 in the stack.
5625 This is a low level function. See also `org-export-to-buffer'
5626 and `org-export-to-file' for more specialized functions."
5629 ;; Write the full sexp evaluating BODY in a copy of the current
5630 ;; buffer to a temporary file, as it may be too long for program
5631 ;; args in `start-process'.
5638 ;; Null characters (from variable values) are inserted
5639 ;; within the file. As a consequence, coding system for
5640 ;; buffer contents will not be recognized properly. So,
5641 ;; we make sure it is the same as the one used to display
5642 ;; the original buffer.
5644 ,coding
5647 ;; Ignore `kill-emacs-hook' and code evaluation
5648 ;; queries from Babel as we need a truly
5649 ;; non-interactive process.
5651 org-babel-confirm-evaluate-answer-no t)
5652 ;; Initialize export framework.
5654 ;; Re-create current buffer there.
5657 ;; Sexp to evaluate in the buffer.
5659 ;; Start external process.
5662 (,process
5664 #'start-process
5667 ,proc-buffer
5674 ;; Register running process in stack.
5676 ;; Set-up sentinel in order to catch results.
5679 ,process
5701 ;;;###autoload
5704 &optional async subtreep visible-only body-only ext-plist
5705 post-process)
5706 "Call `org-export-as' with output to a specified buffer.
5708 BACKEND is either an export back-end, as returned by, e.g.,
5709 `org-export-create-backend', or a symbol referring to
5710 a registered back-end.
5712 BUFFER is the name of the output buffer. If it already exists,
5713 it will be erased first, otherwise, it will be created.
5715 A non-nil optional argument ASYNC means the process should happen
5716 asynchronously. The resulting buffer should then be accessible
5717 through the `org-export-stack' interface. When ASYNC is nil, the
5718 buffer is displayed if `org-export-show-temporary-export-buffer'
5719 is non-nil.
5721 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5722 EXT-PLIST are similar to those used in `org-export-as', which
5723 see.
5725 Optional argument POST-PROCESS is a function which should accept
5726 no argument. It is always called within the current process,
5727 from BUFFER, with point at its beginning. Export back-ends can
5728 use it to set a major mode there, e.g,
5730 \(defun org-latex-export-as-latex
5731 \(&optional async subtreep visible-only body-only ext-plist)
5732 \(interactive)
5734 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5736 This function returns BUFFER."
5764 buffer)))
5766 ;;;###autoload
5769 post-process)
5770 "Call `org-export-as' with output to a specified file.
5772 BACKEND is either an export back-end, as returned by, e.g.,
5773 `org-export-create-backend', or a symbol referring to
5774 a registered back-end. FILE is the name of the output file, as
5775 a string.
5777 A non-nil optional argument ASYNC means the process should happen
5778 asynchronously. The resulting buffer will then be accessible
5779 through the `org-export-stack' interface.
5781 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5782 EXT-PLIST are similar to those used in `org-export-as', which
5783 see.
5785 Optional argument POST-PROCESS is called with FILE as its
5786 argument and happens asynchronously when ASYNC is non-nil. It
5787 has to return a file name, or nil. Export back-ends can use this
5788 to send the output file through additional processing, e.g,
5790 \(defun org-latex-export-to-latex
5791 \(&optional async subtreep visible-only body-only ext-plist)
5792 \(interactive)
5794 \(org-export-to-file 'latex outfile
5795 async subtreep visible-only body-only ext-plist
5796 \(lambda (file) (org-latex-compile file)))
5798 The function returns either a file name returned by POST-PROCESS,
5799 or FILE."
5817 backend subtreep visible-only body-only ext-plist)))
5824 ;; Get proper return value.
5826 file))))))
5829 "Return output file's name according to buffer specifications.
5831 EXTENSION is a string representing the output file extension,
5832 with the leading dot.
5834 With a non-nil optional argument SUBTREEP, try to determine
5836 of subtree at point.
5838 When optional argument PUB-DIR is set, use it as the publishing
5839 directory.
5841 When optional argument VISIBLE-ONLY is non-nil, don't export
5842 contents of hidden elements.
5844 Return file name as a string."
5847 ;; File name may come from EXPORT_FILE_NAME subtree
5848 ;; property, assuming point is at beginning of said
5849 ;; sub-tree.
5856 ;; File name may be extracted from buffer's associated
5857 ;; file, if any.
5859 ;; Can't determine file name on our own: Ask user.
5863 "Output file: " pub-dir nil nil nil
5867 ;; Build file name. Enforce EXTENSION over whatever user
5868 ;; may have come up with. PUB-DIR, if defined, always has
5869 ;; precedence over any provided path.
5874 extension))
5877 ;; If writing to OUTPUT-FILE would overwrite original file, append
5878 ;; EXTENSION another time to final name.
5881 output-file)))
5884 "Add a new result to export stack if not present already.
5886 SOURCE is a buffer or a file name containing export results.
5887 BACKEND is a symbol representing export back-end used to generate
5888 it.
5890 Entries already pointing to SOURCE and unavailable entries are
5891 removed beforehand. Return the new stack."
5897 "Menu for asynchronous export results and running processes."
5907 "Return source from export results at point in stack."
5914 source
5915 ;; SOURCE is not consistent with current line. The stack
5916 ;; view is outdated.
5920 "Remove all entries from export stack."
5925 "Refresh the asynchronous export stack.
5926 DUMMY is ignored. Unavailable sources are removed from the list.
5927 Return the new stack."
5937 ;; Back-end.
5939 ;; Age.
5942 ;; Compute age of the results.
5944 "%4h:%.2m "
5946 ;; Source.
5951 ;; Clear stack from exited processes, dead buffers or
5952 ;; non-existent files.
5964 "Remove export results at point from stack.
5965 If optional argument SOURCE is non-nil, remove it instead."
5970 org-export-stack-contents))))
5973 "View export results at point in stack.
5974 With an optional prefix argument IN-EMACS, force viewing files
5975 within Emacs."
5989 (define-key km "p" 'previous-line)
5990 (define-key km "\C-p" 'previous-line)
5991 (define-key km "\C-?" 'previous-line)
5992 (define-key km [up] 'previous-line)
5993 (define-key km "C" 'org-export-stack-clear)
5994 (define-key km "v" 'org-export-stack-view)
5995 (define-key km (kbd "RET") 'org-export-stack-view)
5996 (define-key km "d" 'org-export-stack-remove)
5997 km)
5998 "Keymap for Org Export Stack.")
6000 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6001 "Mode for displaying asynchronous export stack.
6004 stack.
6006 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6007 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6008 stack completely.
6010 Removing entries in an Org Export Stack buffer doesn't affect
6011 files or buffers, only the display.
6014 (abbrev-mode 0)
6015 (auto-fill-mode 0)
6016 (setq buffer-read-only t
6017 buffer-undo-list t
6018 truncate-lines t
6019 header-line-format
6020 '(:eval
6021 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6022 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6023 (set (make-local-variable 'revert-buffer-function)
6024 'org-export-stack-refresh))
6027 \f
6028 ;;; The Dispatcher
6029 ;;
6030 ;; `org-export-dispatch' is the standard interactive way to start an
6031 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6032 ;; for its interface, which, in turn, delegates response to key
6033 ;; pressed to `org-export--dispatch-action'.
6035 ;;;###autoload
6036 (defun org-export-dispatch (&optional arg)
6037 "Export dispatcher for Org mode.
6039 It provides an access to common export related tasks in a buffer.
6040 Its interface comes in two flavors: standard and expert.
6042 While both share the same set of bindings, only the former
6043 displays the valid keys associations in a dedicated buffer.
6044 Scrolling (resp. line-wise motion) in this buffer is done with
6045 SPC and DEL (resp. C-n and C-p) keys.
6047 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6048 flavor or the other.
6051 of options used back then, on the current buffer.
6053 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6054 (interactive "P")
6055 (let* ((input
6056 (cond ((equal arg '(16)) '(stack))
6057 ((and arg org-export-dispatch-last-action))
6058 (t (save-window-excursion
6059 (unwind-protect
6060 (progn
6061 ;; Remember where we are
6062 (move-marker org-export-dispatch-last-position
6063 (point)
6064 (org-base-buffer (current-buffer)))
6065 ;; Get and store an export command
6066 (setq org-export-dispatch-last-action
6067 (org-export--dispatch-ui
6068 (list org-export-initial-scope
6069 (and org-export-in-background 'async))
6070 nil
6071 org-export-dispatch-use-expert-ui)))
6072 (and (get-buffer "*Org Export Dispatcher*")
6073 (kill-buffer "*Org Export Dispatcher*")))))))
6074 (action (car input))
6075 (optns (cdr input)))
6076 (unless (memq 'subtree optns)
6077 (move-marker org-export-dispatch-last-position nil))
6078 (case action
6079 ;; First handle special hard-coded actions.
6080 (template (org-export-insert-default-template nil optns))
6081 (stack (org-export-stack))
6082 (publish-current-file
6083 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6084 (publish-current-project
6085 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6086 (publish-choose-project
6087 (org-publish (assoc (org-icompleting-read
6088 "Publish project: "
6089 org-publish-project-alist nil t)
6090 org-publish-project-alist)
6091 (memq 'force optns)
6092 (memq 'async optns)))
6093 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6094 (otherwise
6095 (save-excursion
6096 (when arg
6097 ;; Repeating command, maybe move cursor to restore subtree
6098 ;; context.
6099 (if (eq (marker-buffer org-export-dispatch-last-position)
6100 (org-base-buffer (current-buffer)))
6101 (goto-char org-export-dispatch-last-position)
6102 ;; We are in a different buffer, forget position.
6103 (move-marker org-export-dispatch-last-position nil)))
6104 (funcall action
6105 ;; Return a symbol instead of a list to ease
6106 ;; asynchronous export macro use.
6107 (and (memq 'async optns) t)
6108 (and (memq 'subtree optns) t)
6109 (and (memq 'visible optns) t)
6110 (and (memq 'body optns) t)))))))
6112 (defun org-export--dispatch-ui (options first-key expertp)
6113 "Handle interface for `org-export-dispatch'.
6115 OPTIONS is a list containing current interactive options set for
6116 export. It can contain any of the following symbols:
6117 `body' toggles a body-only export
6118 `subtree' restricts export to current subtree
6119 `visible' restricts export to visible part of buffer.
6120 `force' force publishing files.
6121 `async' use asynchronous export process
6123 FIRST-KEY is the key pressed to select the first level menu. It
6124 is nil when this menu hasn't been selected yet.
6126 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6127 buffer is provided, but indications about currently active
6128 options are given in the prompt. Moreover, \[?] allows to switch
6129 back to standard interface."
6130 (let* ((fontify-key
6131 (lambda (key &optional access-key)
6132 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6133 ;; non-nil is the required first-level key to activate
6134 ;; KEY. When its value is t, activate KEY independently
6135 ;; on the first key, if any. A nil value means KEY will
6136 ;; only be activated at first level.
6137 (if (or (eq access-key t) (eq access-key first-key))
6138 (org-propertize key 'face 'org-warning)
6139 key)))
6140 (fontify-value
6141 (lambda (value)
6142 ;; Fontify VALUE string.
6143 (org-propertize value 'face 'font-lock-variable-name-face)))
6144 ;; Prepare menu entries by extracting them from registered
6145 ;; back-ends and sorting them by access key and by ordinal,
6146 ;; if any.
6147 (entries
6148 (sort (sort (delq nil
6149 (mapcar 'org-export-backend-menu
6150 org-export--registered-backends))
6151 (lambda (a b)
6152 (let ((key-a (nth 1 a))
6153 (key-b (nth 1 b)))
6154 (cond ((and (numberp key-a) (numberp key-b))
6155 (< key-a key-b))
6156 ((numberp key-b) t)))))
6157 'car-less-than-car))
6158 ;; Compute a list of allowed keys based on the first key
6159 ;; pressed, if any. Some keys
6160 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6161 ;; available.
6162 (allowed-keys
6163 (nconc (list 2 22 19 6 1)
6164 (if (not first-key) (org-uniquify (mapcar 'car entries))
6165 (let (sub-menu)
6166 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6167 (when (eq (car entry) first-key)
6168 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6169 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6170 ((not first-key) (list ?P)))
6171 (list ?& ?#)
6172 (when expertp (list ??))
6173 (list ?q)))
6174 ;; Build the help menu for standard UI.
6175 (help
6176 (unless expertp
6177 (concat
6178 ;; Options are hard-coded.
6179 (format "[%s] Body only: %s [%s] Visible only: %s
6180 \[%s] Export scope: %s [%s] Force publishing: %s
6182 (funcall fontify-key "C-b" t)
6183 (funcall fontify-value
6184 (if (memq 'body options) "On " "Off"))
6185 (funcall fontify-key "C-v" t)
6186 (funcall fontify-value
6187 (if (memq 'visible options) "On " "Off"))
6188 (funcall fontify-key "C-s" t)
6189 (funcall fontify-value
6190 (if (memq 'subtree options) "Subtree" "Buffer "))
6191 (funcall fontify-key "C-f" t)
6192 (funcall fontify-value
6193 (if (memq 'force options) "On " "Off"))
6194 (funcall fontify-key "C-a" t)
6195 (funcall fontify-value
6196 (if (memq 'async options) "On " "Off")))
6197 ;; Display registered back-end entries. When a key
6198 ;; appears for the second time, do not create another
6199 ;; entry, but append its sub-menu to existing menu.
6200 (let (last-key)
6201 (mapconcat
6202 (lambda (entry)
6203 (let ((top-key (car entry)))
6204 (concat
6205 (unless (eq top-key last-key)
6206 (setq last-key top-key)
6208 (funcall fontify-key (char-to-string top-key))
6209 (nth 1 entry)))
6210 (let ((sub-menu (nth 2 entry)))
6211 (unless (functionp sub-menu)
6212 ;; Split sub-menu into two columns.
6213 (let ((index -1))
6214 (concat
6215 (mapconcat
6216 (lambda (sub-entry)
6217 (incf index)
6218 (format
6219 (if (zerop (mod index 2)) " [%s] %-26s"
6221 (funcall fontify-key
6222 (char-to-string (car sub-entry))
6223 top-key)
6224 (nth 1 sub-entry)))
6225 sub-menu "")
6227 entries ""))
6228 ;; Publishing menu is hard-coded.
6230 [%s] Current file [%s] Current project
6232 (funcall fontify-key "P")
6233 (funcall fontify-key "f" ?P)
6234 (funcall fontify-key "p" ?P)
6235 (funcall fontify-key "x" ?P)
6236 (funcall fontify-key "a" ?P))
6238 (funcall fontify-key "&" t)
6239 (funcall fontify-key "#" t))
6240 (format "[%s] %s"
6241 (funcall fontify-key "q" t)
6242 (if first-key "Main menu" "Exit")))))
6243 ;; Build prompts for both standard and expert UI.
6244 (standard-prompt (unless expertp "Export command: "))
6245 (expert-prompt
6246 (when expertp
6247 (format
6248 "Export command (C-%s%s%s%s%s) [%s]: "
6249 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6250 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6251 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6252 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6253 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6254 (mapconcat (lambda (k)
6255 ;; Strip control characters.
6256 (unless (< k 27) (char-to-string k)))
6257 allowed-keys "")))))
6258 ;; With expert UI, just read key with a fancy prompt. In standard
6259 ;; UI, display an intrusive help buffer.
6260 (if expertp
6261 (org-export--dispatch-action
6262 expert-prompt allowed-keys entries options first-key expertp)
6263 ;; At first call, create frame layout in order to display menu.
6264 (unless (get-buffer "*Org Export Dispatcher*")
6265 (delete-other-windows)
6266 (org-switch-to-buffer-other-window
6267 (get-buffer-create "*Org Export Dispatcher*"))
6268 (setq cursor-type nil
6269 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6270 ;; Make sure that invisible cursor will not highlight square
6271 ;; brackets.
6272 (set-syntax-table (copy-syntax-table))
6273 (modify-syntax-entry ?\[ "w"))
6274 ;; At this point, the buffer containing the menu exists and is
6275 ;; visible in the current window. So, refresh it.
6276 (with-current-buffer "*Org Export Dispatcher*"
6277 ;; Refresh help. Maintain display continuity by re-visiting
6278 ;; previous window position.
6279 (let ((pos (window-start)))
6280 (erase-buffer)
6281 (insert help)
6282 (set-window-start nil pos)))
6283 (org-fit-window-to-buffer)
6284 (org-export--dispatch-action
6285 standard-prompt allowed-keys entries options first-key expertp))))
6287 (defun org-export--dispatch-action
6288 (prompt allowed-keys entries options first-key expertp)
6289 "Read a character from command input and act accordingly.
6291 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6292 a list of characters available at a given step in the process.
6293 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6294 EXPERTP are the same as defined in `org-export--dispatch-ui',
6295 which see.
6297 Toggle export options when required. Otherwise, return value is
6298 a list with action as CAR and a list of interactive export
6299 options as CDR."
6300 (let (key)
6301 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6302 ;; C-p, SPC, DEL).
6303 (while (and (setq key (read-char-exclusive prompt))
6304 (not expertp)
6305 (memq key '(14 16 ?\s ?\d)))
6306 (case key
6307 (14 (if (not (pos-visible-in-window-p (point-max)))
6308 (ignore-errors (scroll-up 1))
6309 (message "End of buffer")
6310 (sit-for 1)))
6311 (16 (if (not (pos-visible-in-window-p (point-min)))
6312 (ignore-errors (scroll-down 1))
6313 (message "Beginning of buffer")
6314 (sit-for 1)))
6315 (?\s (if (not (pos-visible-in-window-p (point-max)))
6316 (scroll-up nil)
6317 (message "End of buffer")
6318 (sit-for 1)))
6319 (?\d (if (not (pos-visible-in-window-p (point-min)))
6320 (scroll-down nil)
6321 (message "Beginning of buffer")
6322 (sit-for 1)))))
6323 (cond
6324 ;; Ignore undefined associations.
6325 ((not (memq key allowed-keys))
6326 (ding)
6327 (unless expertp (message "Invalid key") (sit-for 1))
6328 (org-export--dispatch-ui options first-key expertp))
6329 ;; q key at first level aborts export. At second level, cancel
6330 ;; first key instead.
6331 ((eq key ?q) (if (not first-key) (error "Export aborted")
6332 (org-export--dispatch-ui options nil expertp)))
6333 ;; Help key: Switch back to standard interface if expert UI was
6334 ;; active.
6335 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6336 ;; Send request for template insertion along with export scope.
6337 ((eq key ?#) (cons 'template (memq 'subtree options)))
6338 ;; Switch to asynchronous export stack.
6339 ((eq key ?&) '(stack))
6340 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6341 ((memq key '(2 22 19 6 1))
6342 (org-export--dispatch-ui
6343 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6344 (6 'force) (1 'async))))
6345 (if (memq option options) (remq option options)
6346 (cons option options)))
6347 first-key expertp))
6348 ;; Action selected: Send key and options back to
6349 ;; `org-export-dispatch'.
6350 ((or first-key (functionp (nth 2 (assq key entries))))
6351 (cons (cond
6352 ((not first-key) (nth 2 (assq key entries)))
6353 ;; Publishing actions are hard-coded. Send a special
6354 ;; signal to `org-export-dispatch'.
6355 ((eq first-key ?P)
6356 (case key
6357 (?f 'publish-current-file)
6358 (?p 'publish-current-project)
6359 (?x 'publish-choose-project)
6360 (?a 'publish-all)))
6361 ;; Return first action associated to FIRST-KEY + KEY
6362 ;; path. Indeed, derived backends can share the same
6363 ;; FIRST-KEY.
6364 (t (catch 'found
6365 (mapc (lambda (entry)
6366 (let ((match (assq key (nth 2 entry))))
6367 (when match (throw 'found (nth 2 match)))))
6368 (member (assq first-key entries) entries)))))
6369 options))
6370 ;; Otherwise, enter sub-menu.
6371 (t (org-export--dispatch-ui options key expertp)))))
6375 (provide 'ox)
6377 ;; Local variables:
6378 ;; generated-autoload-file: "org-loaddefs.el"
6379 ;; End:
6381 ;;; ox.el ends here