| blob | c437038641ed9f7737a14fe82928d4c466dcf8cd |
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
321 \f
322 ;;; User-configurable Variables
323 ;;
324 ;; Configuration for the masses.
325 ;;
326 ;; They should never be accessed directly, as their value is to be
327 ;; stored in a property list (cf. `org-export-options-alist').
328 ;; Back-ends will read their value from there instead.
331 "Options for exporting Org mode files."
336 "General options for export engine."
341 "Whether sub-trees with the ARCHIVE tag should be exported.
343 This can have three different values:
344 nil Do not export, pretend this tree is not present.
345 t Do export the entire tree.
346 `headline' Only export the headline, but skip the tree below it.
348 This option can also be set with the OPTIONS keyword,
357 "Non-nil means insert author name into the exported file.
358 This option can also be set with the OPTIONS keyword,
364 "Non-nil means export CLOCK keywords.
365 This option can also be set with the OPTIONS keyword,
371 "Non-nil means the postamble should contain a creator sentence.
373 The sentence can be set in `org-export-creator-string' and
376 If the value is `comment' insert it as a comment."
384 "Non-nil means insert date in the exported document.
385 This option can also be set with the OPTIONS keyword,
391 "Time-stamp format string to use for DATE keyword.
393 The format string, when specified, only applies if date consists
394 in a single time-stamp. Otherwise its value will be ignored.
396 See `format-time-string' for details on how to build this
397 string."
405 emacs-version
407 "Information about the creator of the document.
408 This option can also be set on with the CREATOR keyword."
413 "Non-nil means export contents of standard drawers.
415 When t, all drawers are exported. This may also be a list of
416 drawer names to export, as strings. If that list starts with
417 `not', only drawers with such names will be ignored.
419 This variable doesn't apply to properties drawers. See
420 `org-export-with-properties' instead.
422 This option can also be set with the OPTIONS keyword,
435 :inline t
439 "Non-nil means insert author email into the exported file.
440 This option can also be set with the OPTIONS keyword,
446 "Non-nil means interpret *word*, /word/, _word_ and +word+.
448 If the export target supports emphasizing text, the word will be
449 typeset in bold, italic, with an underline or strike-through,
450 respectively.
452 This option can also be set with the OPTIONS keyword,
458 "Tags that exclude a tree from export.
460 All trees carrying any of these tags will be excluded from
461 export. This is without condition, so even subtrees inside that
462 carry one of the `org-export-select-tags' will be removed.
464 This option can also be set with the EXCLUDE_TAGS keyword."
470 This option can also be set with the OPTIONS keyword,
478 "Non-nil means Org footnotes should be exported.
479 This option can also be set with the OPTIONS keyword,
485 "Non-nil means process LaTeX environments and fragments.
487 This option can also be set with the OPTIONS line,
490 nil Ignore math snippets.
491 `verbatim' Keep everything in verbatim.
492 t Allow export of math snippets."
502 "The last level which is still exported as a headline.
504 Inferior levels will usually produce itemize or enumerate lists
505 when exported, but back-end behaviour may differ.
507 This option can also be set with the OPTIONS keyword,
513 "The default language for export and clocktable translations, as a string.
514 This may have an association in
515 `org-clock-clocktable-language-setup',
516 `org-export-smart-quotes-alist' and `org-export-dictionary'.
517 This option can also be set with the LANGUAGE keyword."
522 "Non-nil means preserve all line breaks when exporting.
523 This option can also be set with the OPTIONS keyword,
529 "Non-nil means interpret entities when exporting.
532 Å.
534 For a list of supported names, see the constant `org-entities'
535 and the user option `org-entities-user'.
537 This option can also be set with the OPTIONS keyword,
543 "Non-nil means inlinetasks should be exported.
544 This option can also be set with the OPTIONS keyword,
552 "Non-nil means include planning info in export.
554 Planning info is the line containing either SCHEDULED:,
555 DEADLINE:, CLOSED: time-stamps, or a combination of them.
557 This option can also be set with the OPTIONS keyword,
565 "Non-nil means include priority cookies in export.
566 This option can also be set with the OPTIONS keyword,
572 "Non-nil means export contents of properties drawers.
574 When t, all properties are exported. This may also be a list of
575 properties to export, as strings.
577 This option can also be set with the OPTIONS keyword,
589 "Non-nil means add section numbers to headlines when exporting.
591 When set to an integer n, numbering will only happen for
592 headlines whose relative level is higher or equal to n.
594 This option can also be set with the OPTIONS keyword,
600 "Tags that select a tree for export.
602 If any such tag is found in a buffer, all trees that do not carry
603 one of these tags will be ignored during export. Inside trees
604 that are selected like this, you can still deselect a subtree by
605 tagging it with one of the `org-export-exclude-tags'.
607 This option can also be set with the SELECT_TAGS keyword."
612 "Non-nil means activate smart quotes during export.
613 This option can also be set with the OPTIONS keyword,
616 When setting this to non-nil, you need to take care of
617 using the correct Babel package when exporting to LaTeX.
618 E.g., you can load Babel for french like this:
629 When this option is turned on, these strings will be exported as:
631 Org HTML LaTeX UTF-8
632 -----+----------+--------+-------
634 -- – -- –
635 --- — --- —
638 This option can also be set with the OPTIONS keyword,
644 "Non-nil means include statistics cookies in export.
645 This option can also be set with the OPTIONS keyword,
655 If you want to control how Org displays those characters, see
656 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
657 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
658 it is not anymore.
660 When this option is turned on, you can use TeX-like syntax for
661 sub- and superscripts and see them exported correctly.
663 You can also set the option with #+OPTIONS: ^:t
666 single item - so grouping with {} is normally not needed. For
667 example, the following things will be parsed as single sub- or
668 superscripts:
670 10^24 or 10^tau several digits will be considered 1 item.
671 10^-12 or 10^-tau a leading sign with digits or a word
672 x^2-y^3 will be read as x^2 - y^3, because items are
673 terminated by almost any nonword/nondigit char.
674 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
676 Still, ambiguity is possible. So when in doubt, use {} to enclose
677 the sub/superscript. If you set this variable to the symbol `{}',
678 the braces are *required* in order to trigger interpretations as
680 frequently in plain text."
690 "Non-nil means create a table of contents in exported files.
692 The TOC contains headlines with levels up
693 to`org-export-headline-levels'. When an integer, include levels
694 up to N in the toc, this may then be different from
695 `org-export-headline-levels', but it will not be allowed to be
696 larger than the number of headline levels. When nil, no table of
697 contents is made.
699 This option can also be set with the OPTIONS keyword,
708 "Non-nil means export tables.
709 This option can also be set with the OPTIONS keyword,
717 "If nil, do not export tags, just remove them from headlines.
719 If this is the symbol `not-in-toc', tags will be removed from
720 table of contents entries, but still be shown in the headlines of
721 the document.
723 This option can also be set with the OPTIONS keyword,
732 "Non-nil means include TODO items for export.
734 This may have the following values:
735 t include tasks independent of state.
736 `todo' include only tasks that are not yet done.
737 `done' include only tasks that are already done.
738 nil ignore all tasks.
739 list of keywords include tasks with these keywords.
741 This option can also be set with the OPTIONS keyword,
753 "Non-nil means insert a time stamp into the exported file.
754 The time stamp shows when the file was created. This option can
760 "Non nil means allow timestamps in export.
762 It can be set to any of the following values:
763 t export all timestamps.
764 `active' export active timestamps only.
765 `inactive' export inactive timestamps only.
766 nil do not export timestamps
768 This only applies to timestamps isolated in a paragraph
769 containing only timestamps. Other timestamps are always
770 exported.
772 This option can also be set with the OPTIONS keyword, e.g.
782 "Non-nil means include TODO keywords in export.
783 When nil, remove all these keywords from the export. This option
789 "Non-nil means BIND keywords can define local variable values.
790 This is a potential security risk, which is why the default value
791 is nil. You can also allow them through local buffer variables."
798 "Alist between export snippets back-ends and exporter back-ends.
800 This variable allows to provide shortcuts for export snippets.
804 HTML code while every other back-end will ignore it."
813 "Coding system for the exported file."
820 "Should we push exported content to the kill ring?"
829 "The initial scope when exporting with `org-export-dispatch'.
830 This variable can be either set to `buffer' or `subtree'."
837 "Non-nil means show buffer after exporting to temp buffer.
838 When Org exports to a file, the buffer visiting that file is ever
839 shown, but remains buried. However, when exporting to
840 a temporary buffer, that buffer is popped up in a second window.
841 When this variable is nil, the buffer remains buried also in
842 these cases."
847 "Non-nil means export and publishing commands will run in background.
848 Results from an asynchronous export are never displayed
856 "File used to initialize external export process.
858 Value must be either nil or an absolute file name. When nil, the
859 external process is launched like a regular Emacs session,
860 loading user's initialization file and any site specific
861 configuration. If a file is provided, it, and only it, is loaded
862 at start-up.
864 Therefore, using a specific configuration makes the process to
865 load faster and the export more portable."
874 "Non-nil means using a non-intrusive `org-export-dispatch'.
875 In that case, no help buffer is displayed. Though, an indicator
881 asynchronous). Also, \[?] allows to switch back to standard
882 mode."
889 \f
890 ;;; Defining Back-ends
891 ;;
892 ;; An export back-end is a structure with `org-export-backend' type
893 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
894 ;; and `menu' slots.
895 ;;
896 ;; At the lowest level, a back-end is created with
897 ;; `org-export-create-backend' function.
898 ;;
899 ;; A named back-end can be registered with
900 ;; `org-export-register-backend' function. A registered back-end can
901 ;; later be referred to by its name, with `org-export-get-backend'
902 ;; function. Also, such a back-end can become the parent of a derived
903 ;; back-end from which slot values will be inherited by default.
904 ;; `org-export-derived-backend-p' can check if a given back-end is
905 ;; derived from a list of back-end names.
906 ;;
907 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
908 ;; `org-export-get-all-filters' return the full alist of transcoders,
909 ;; options and filters, including those inherited from ancestors.
910 ;;
911 ;; At a higher level, `org-export-define-backend' is the standard way
912 ;; to define an export back-end. If the new back-end is similar to
913 ;; a registered back-end, `org-export-define-derived-backend' may be
914 ;; used instead.
915 ;;
916 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
917 ;; when a given back-end hasn't been registered yet.
921 name parent transcoders options filters blocks menu)
924 "Return export back-end named after NAME.
925 NAME is a symbol. Return nil if no such back-end is found."
932 "Register BACKEND as a known export back-end.
933 BACKEND is a structure with `org-export-backend' type."
934 ;; Refuse to register an unnamed back-end.
937 ;; Refuse to register a back-end with an unknown parent.
941 ;; Register dedicated export blocks in the parser.
945 ;; If a back-end with the same name as BACKEND is already
946 ;; registered, replace it with BACKEND. Otherwise, simply add
947 ;; BACKEND to the list of registered back-ends.
953 "Signal an error if BACKEND isn't defined."
958 "Non-nil if BACKEND is derived from one of BACKENDS.
959 BACKEND is an export back-end, as returned by, e.g.,
960 `org-export-create-backend', or a symbol referring to
961 a registered back-end. BACKENDS is constituted of symbols."
973 "Return full translation table for BACKEND.
975 BACKEND is an export back-end, as return by, e.g,,
976 `org-export-create-backend'. Return value is an alist where
977 keys are element or object types, as symbols, and values are
978 transcoders.
980 Unlike to `org-export-backend-transcoders', this function
981 also returns transcoders inherited from parent back-ends,
982 if any."
986 parent)
991 transcoders)))
994 "Return export options for BACKEND.
996 BACKEND is an export back-end, as return by, e.g,,
997 `org-export-create-backend'. See `org-export-options-alist'
998 for the shape of the return value.
1000 Unlike to `org-export-backend-options', this function also
1001 returns options inherited from parent back-ends, if any."
1005 parent)
1009 options)))
1012 "Return complete list of filters for BACKEND.
1014 BACKEND is an export back-end, as return by, e.g,,
1015 `org-export-create-backend'. Return value is an alist where
1016 keys are symbols and values lists of functions.
1018 Unlike to `org-export-backend-filters', this function also
1019 returns filters inherited from parent back-ends, if any."
1023 parent)
1027 filters)))
1030 "Define a new back-end BACKEND.
1032 TRANSCODERS is an alist between object or element types and
1033 functions handling them.
1035 These functions should return a string without any trailing
1036 space, or nil. They must accept three arguments: the object or
1037 element itself, its contents or nil when it isn't recursive and
1038 the property list used as a communication channel.
1040 Contents, when not nil, are stripped from any global indentation
1041 \(although the relative one is preserved). They also always end
1042 with a single newline character.
1044 If, for a given type, no function is found, that element or
1045 object type will simply be ignored, along with any blank line or
1046 white space at its end. The same will happen if the function
1047 returns the nil value. If that function returns the empty
1048 string, the type will be ignored, but the blank lines or white
1049 spaces will be kept.
1051 In addition to element and object types, one function can be
1052 associated to the `template' (or `inner-template') symbol and
1053 another one to the `plain-text' symbol.
1055 The former returns the final transcoded string, and can be used
1056 to add a preamble and a postamble to document's body. It must
1057 accept two arguments: the transcoded string and the property list
1058 containing export options. A function associated to `template'
1060 A function associated to `inner-template' is always applied.
1062 The latter, when defined, is to be called on every text not
1063 recognized as an element or an object. It must accept two
1064 arguments: the text string and the information channel. It is an
1065 appropriate place to protect special chars relative to the
1066 back-end.
1068 BODY can start with pre-defined keyword arguments. The following
1069 keywords are understood:
1071 :export-block
1073 String, or list of strings, representing block names that
1074 will not be parsed. This is used to specify blocks that will
1075 contain raw code specific to the back-end. These blocks
1076 still have to be handled by the relative `export-block' type
1077 translator.
1079 :filters-alist
1081 Alist between filters and function, or list of functions,
1082 specific to the back-end. See `org-export-filters-alist' for
1083 a list of all allowed filters. Filters defined here
1084 shouldn't make a back-end test, as it may prevent back-ends
1085 derived from this one to behave properly.
1087 :menu-entry
1089 Menu entry for the export dispatcher. It should be a list
1090 like:
1092 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1094 where :
1096 KEY is a free character selecting the back-end.
1098 DESCRIPTION-OR-ORDINAL is either a string or a number.
1100 If it is a string, is will be used to name the back-end in
1101 its menu entry. If it is a number, the following menu will
1102 be displayed as a sub-menu of the back-end with the same
1103 KEY. Also, the number will be used to determine in which
1104 order such sub-menus will appear (lowest first).
1106 ACTION-OR-MENU is either a function or an alist.
1108 If it is an action, it will be called with four
1109 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1110 BODY-ONLY. See `org-export-as' for further explanations on
1111 some of them.
1113 If it is an alist, associations should follow the
1114 pattern:
1116 '(KEY DESCRIPTION ACTION)
1118 where KEY, DESCRIPTION and ACTION are described above.
1120 Valid values include:
1124 or
1129 \(lambda (a s v b)
1130 \(if a (org-latex-export-to-pdf t s v b)
1131 \(org-open-file
1132 \(org-latex-export-to-pdf nil s v b)))))))
1134 or the following, which will be added to the previous
1135 sub-menu,
1137 '(?l 1
1141 :options-alist
1143 Alist between back-end specific properties introduced in
1144 communication channel and how their value are acquired. See
1145 `org-export-options-alist' for more information about
1146 structure of the values."
1160 :transcoders transcoders
1161 :options options
1162 :filters filters
1163 :blocks blocks
1167 "Create a new back-end as a variant of an existing one.
1169 CHILD is the name of the derived back-end. PARENT is the name of
1170 the parent back-end.
1172 BODY can start with pre-defined keyword arguments. The following
1173 keywords are understood:
1175 :export-block
1177 String, or list of strings, representing block names that
1178 will not be parsed. This is used to specify blocks that will
1179 contain raw code specific to the back-end. These blocks
1180 still have to be handled by the relative `export-block' type
1181 translator.
1183 :filters-alist
1185 Alist of filters that will overwrite or complete filters
1186 defined in PARENT back-end. See `org-export-filters-alist'
1187 for a list of allowed filters.
1189 :menu-entry
1191 Menu entry for the export dispatcher. See
1192 `org-export-define-backend' for more information about the
1193 expected value.
1195 :options-alist
1197 Alist of back-end specific properties that will overwrite or
1198 complete those defined in PARENT back-end. Refer to
1199 `org-export-options-alist' for more information about
1200 structure of the values.
1202 :translate-alist
1204 Alist of element and object types and transcoders that will
1205 overwrite or complete transcode table from PARENT back-end.
1206 Refer to `org-export-define-backend' for detailed information
1207 about transcoders.
1210 as a variant of `latex' back-end with a custom template function:
1212 \(org-export-define-derived-backend 'my-latex 'latex
1213 :translate-alist '((template . my-latex-template-fun)))
1215 The back-end could then be called with, for example:
1232 :parent parent
1233 :transcoders transcoders
1234 :options options
1235 :filters filters
1236 :blocks blocks
1240 \f
1241 ;;; The Communication Channel
1242 ;;
1243 ;; During export process, every function has access to a number of
1244 ;; properties. They are of two types:
1245 ;;
1246 ;; 1. Environment options are collected once at the very beginning of
1247 ;; the process, out of the original buffer and configuration.
1248 ;; Collecting them is handled by `org-export-get-environment'
1249 ;; function.
1250 ;;
1251 ;; Most environment options are defined through the
1252 ;; `org-export-options-alist' variable.
1253 ;;
1254 ;; 2. Tree properties are extracted directly from the parsed tree,
1255 ;; just before export, by `org-export-collect-tree-properties'.
1256 ;;
1257 ;; Here is the full list of properties available during transcode
1258 ;; process, with their category and their value type.
1259 ;;
1260 ;; + `:author' :: Author's name.
1261 ;; - category :: option
1262 ;; - type :: string
1263 ;;
1264 ;; + `:back-end' :: Current back-end used for transcoding.
1265 ;; - category :: tree
1266 ;; - type :: structure
1267 ;;
1268 ;; + `:creator' :: String to write as creation information.
1269 ;; - category :: option
1270 ;; - type :: string
1271 ;;
1272 ;; + `:date' :: String to use as date.
1273 ;; - category :: option
1274 ;; - type :: string
1275 ;;
1276 ;; + `:description' :: Description text for the current data.
1277 ;; - category :: option
1278 ;; - type :: string
1279 ;;
1280 ;; + `:email' :: Author's email.
1281 ;; - category :: option
1282 ;; - type :: string
1283 ;;
1284 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1285 ;; process.
1286 ;; - category :: option
1287 ;; - type :: list of strings
1288 ;;
1289 ;; + `:export-options' :: List of export options available for current
1290 ;; process.
1291 ;; - category :: none
1292 ;; - type :: list of symbols, among `subtree', `body-only' and
1293 ;; `visible-only'.
1294 ;;
1295 ;; + `:exported-data' :: Hash table used for memoizing
1296 ;; `org-export-data'.
1297 ;; - category :: tree
1298 ;; - type :: hash table
1299 ;;
1300 ;; + `:filetags' :: List of global tags for buffer. Used by
1301 ;; `org-export-get-tags' to get tags with inheritance.
1302 ;; - category :: option
1303 ;; - type :: list of strings
1304 ;;
1305 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1306 ;; their definition, as parsed data. Only non-inlined footnotes
1307 ;; are represented in this alist. Also, every definition isn't
1308 ;; guaranteed to be referenced in the parse tree. The purpose of
1309 ;; this property is to preserve definitions from oblivion
1310 ;; (i.e. when the parse tree comes from a part of the original
1311 ;; buffer), it isn't meant for direct use in a back-end. To
1312 ;; retrieve a definition relative to a reference, use
1313 ;; `org-export-get-footnote-definition' instead.
1314 ;; - category :: option
1315 ;; - type :: alist (STRING . LIST)
1316 ;;
1317 ;; + `:headline-levels' :: Maximum level being exported as an
1318 ;; headline. Comparison is done with the relative level of
1319 ;; headlines in the parse tree, not necessarily with their
1320 ;; actual level.
1321 ;; - category :: option
1322 ;; - type :: integer
1323 ;;
1324 ;; + `:headline-offset' :: Difference between relative and real level
1325 ;; of headlines in the parse tree. For example, a value of -1
1326 ;; means a level 2 headline should be considered as level
1327 ;; 1 (cf. `org-export-get-relative-level').
1328 ;; - category :: tree
1329 ;; - type :: integer
1330 ;;
1331 ;; + `:headline-numbering' :: Alist between headlines and their
1332 ;; numbering, as a list of numbers
1333 ;; (cf. `org-export-get-headline-number').
1334 ;; - category :: tree
1335 ;; - type :: alist (INTEGER . LIST)
1336 ;;
1337 ;; + `:id-alist' :: Alist between ID strings and destination file's
1338 ;; path, relative to current directory. It is used by
1339 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1340 ;; external file.
1341 ;; - category :: option
1342 ;; - type :: alist (STRING . STRING)
1343 ;;
1344 ;; + `:ignore-list' :: List of elements and objects that should be
1345 ;; ignored during export.
1346 ;; - category :: tree
1347 ;; - type :: list of elements and objects
1348 ;;
1349 ;; + `:input-buffer' :: Original buffer name.
1350 ;; - category :: option
1351 ;; - type :: string
1352 ;;
1353 ;; + `:input-file' :: Full path to input file, if any.
1354 ;; - category :: option
1355 ;; - type :: string or nil
1356 ;;
1357 ;; + `:keywords' :: List of keywords attached to data.
1358 ;; - category :: option
1359 ;; - type :: string
1360 ;;
1361 ;; + `:language' :: Default language used for translations.
1362 ;; - category :: option
1363 ;; - type :: string
1364 ;;
1365 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1366 ;; transcoding.
1367 ;; - category :: option
1368 ;; - type :: list (as returned by `org-element-parse-buffer')
1369 ;;
1370 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1371 ;; all line breaks.
1372 ;; - category :: option
1373 ;; - type :: symbol (nil, t)
1374 ;;
1375 ;; + `:section-numbers' :: Non-nil means transcoding should add
1376 ;; section numbers to headlines.
1377 ;; - category :: option
1378 ;; - type :: symbol (nil, t)
1379 ;;
1380 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1381 ;; in transcoding. When such a tag is present, subtrees without
1382 ;; it are de facto excluded from the process. See
1383 ;; `use-select-tags'.
1384 ;; - category :: option
1385 ;; - type :: list of strings
1386 ;;
1387 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1388 ;; a time stamp in the output.
1389 ;; - category :: option
1390 ;; - type :: symbol (nil, t)
1391 ;;
1392 ;; + `:translate-alist' :: Alist between element and object types and
1393 ;; transcoding functions relative to the current back-end.
1394 ;; Special keys `inner-template', `template' and `plain-text' are
1395 ;; also possible.
1396 ;; - category :: option
1397 ;; - type :: alist (SYMBOL . FUNCTION)
1398 ;;
1399 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1400 ;; also be transcoded. If it is set to the `headline' symbol,
1401 ;; only the archived headline's name is retained.
1402 ;; - category :: option
1403 ;; - type :: symbol (nil, t, `headline')
1404 ;;
1405 ;; + `:with-author' :: Non-nil means author's name should be included
1406 ;; in the output.
1407 ;; - category :: option
1408 ;; - type :: symbol (nil, t)
1409 ;;
1410 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1411 ;; - category :: option
1412 ;; - type :: symbol (nil, t)
1413 ;;
1414 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1415 ;; inserted at the end of the transcoded string. If the value
1416 ;; is `comment', it should be commented.
1417 ;; - category :: option
1418 ;; - type :: symbol (`comment', nil, t)
1419 ;;
1420 ;; + `:with-date' :: Non-nil means output should contain a date.
1421 ;; - category :: option
1422 ;; - type :. symbol (nil, t)
1423 ;;
1424 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1425 ;; its value is a list of names, only drawers with such names
1426 ;; will be transcoded. If that list starts with `not', drawer
1427 ;; with these names will be skipped.
1428 ;; - category :: option
1429 ;; - type :: symbol (nil, t) or list of strings
1430 ;;
1431 ;; + `:with-email' :: Non-nil means output should contain author's
1432 ;; email.
1433 ;; - category :: option
1434 ;; - type :: symbol (nil, t)
1435 ;;
1436 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1437 ;; interpreted.
1438 ;; - category :: option
1439 ;; - type :: symbol (nil, t)
1440 ;;
1441 ;; + `:with-fixed-width' :: Non-nil if transcoder should export
1442 ;; strings starting with a colon as a fixed-with (verbatim) area.
1443 ;; - category :: option
1444 ;; - type :: symbol (nil, t)
1445 ;;
1446 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1447 ;; footnotes.
1448 ;; - category :: option
1449 ;; - type :: symbol (nil, t)
1450 ;;
1451 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1452 ;; `latex-fragment' objects should appear in export output. When
1453 ;; this property is set to `verbatim', they will be left as-is.
1454 ;; - category :: option
1455 ;; - type :: symbol (`verbatim', nil, t)
1456 ;;
1457 ;; + `:with-planning' :: Non-nil means transcoding should include
1458 ;; planning info.
1459 ;; - category :: option
1460 ;; - type :: symbol (nil, t)
1461 ;;
1462 ;; + `:with-priority' :: Non-nil means transcoding should include
1463 ;; priority cookies.
1464 ;; - category :: option
1465 ;; - type :: symbol (nil, t)
1466 ;;
1467 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1468 ;; plain text.
1469 ;; - category :: option
1470 ;; - type :: symbol (nil, t)
1471 ;;
1472 ;; + `:with-special-strings' :: Non-nil means transcoding should
1473 ;; interpret special strings in plain text.
1474 ;; - category :: option
1475 ;; - type :: symbol (nil, t)
1476 ;;
1477 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1478 ;; interpret subscript and superscript. With a value of "{}",
1479 ;; only interpret those using curly brackets.
1480 ;; - category :: option
1481 ;; - type :: symbol (nil, {}, t)
1482 ;;
1483 ;; + `:with-tables' :: Non-nil means transcoding should export tables.
1484 ;; - category :: option
1485 ;; - type :: symbol (nil, t)
1486 ;;
1487 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1488 ;; headlines. A `not-in-toc' value will remove them from the
1489 ;; table of contents, if any, nonetheless.
1490 ;; - category :: option
1491 ;; - type :: symbol (nil, t, `not-in-toc')
1492 ;;
1493 ;; + `:with-tasks' :: Non-nil means transcoding should include
1494 ;; headlines with a TODO keyword. A `todo' value will only
1495 ;; include headlines with a todo type keyword while a `done'
1496 ;; value will do the contrary. If a list of strings is provided,
1497 ;; only tasks with keywords belonging to that list will be kept.
1498 ;; - category :: option
1499 ;; - type :: symbol (t, todo, done, nil) or list of strings
1500 ;;
1501 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1502 ;; time stamps. Special value `active' (resp. `inactive') ask to
1503 ;; export only active (resp. inactive) timestamps. Otherwise,
1504 ;; completely remove them.
1505 ;; - category :: option
1506 ;; - type :: symbol: (`active', `inactive', t, nil)
1507 ;;
1508 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1509 ;; added to the output. An integer value limits its depth.
1510 ;; - category :: option
1511 ;; - type :: symbol (nil, t or integer)
1512 ;;
1513 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1514 ;; include TODO keywords.
1515 ;; - category :: option
1516 ;; - type :: symbol (nil, t)
1519 ;;;; Environment Options
1520 ;;
1521 ;; Environment options encompass all parameters defined outside the
1522 ;; scope of the parsed data. They come from five sources, in
1523 ;; increasing precedence order:
1524 ;;
1525 ;; - Global variables,
1526 ;; - Buffer's attributes,
1527 ;; - Options keyword symbols,
1528 ;; - Buffer keywords,
1529 ;; - Subtree properties.
1530 ;;
1531 ;; The central internal function with regards to environment options
1532 ;; is `org-export-get-environment'. It updates global variables with
1533 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1534 ;; the different sources.
1535 ;;
1536 ;; The internal functions doing the retrieval are:
1537 ;; `org-export--get-global-options',
1538 ;; `org-export--get-buffer-attributes',
1539 ;; `org-export--parse-option-keyword',
1540 ;; `org-export--get-subtree-options' and
1541 ;; `org-export--get-inbuffer-options'
1542 ;;
1543 ;; Also, `org-export--list-bound-variables' collects bound variables
1544 ;; along with their value in order to set them as buffer local
1545 ;; variables later in the process.
1548 "Collect export options from the current buffer.
1550 Optional argument BACKEND is an export back-end, as returned by
1551 `org-export-create-backend'.
1553 When optional argument SUBTREEP is non-nil, assume the export is
1554 done against the current sub-tree.
1556 Third optional argument EXT-PLIST is a property list with
1557 external parameters overriding Org default settings, but still
1558 inferior to file-local settings."
1559 ;; First install #+BIND variables since these must be set before
1560 ;; global options are read.
1563 ;; Get and prioritize export options...
1565 ;; ... from global variables...
1567 ;; ... from an external property list...
1568 ext-plist
1569 ;; ... from in-buffer settings...
1571 ;; ... and from subtree, when appropriate.
1573 ;; Eventually add misc. properties.
1575 :back-end
1576 backend
1578 :footnote-definition-alist
1579 ;; Footnotes definitions must be collected in the original
1580 ;; buffer, as there's no insurance that they will still be in
1581 ;; the parse tree, due to possible narrowing.
1595 alist))))
1596 alist))
1597 :id-alist
1598 ;; Collect id references.
1609 alist))))
1612 "Parse an OPTIONS line and return values as a plist.
1613 Optional argument BACKEND is an export back-end, as returned by,
1614 e.g., `org-export-create-backend'. It specifies which back-end
1615 specific items to read, if any."
1617 ;; Priority is given to back-end specific options.
1619 org-export-options-alist))
1620 plist)
1629 options))
1631 property
1634 plist))
1637 "Get export options in subtree at point.
1638 Optional argument BACKEND is an export back-end, as returned by,
1639 e.g., `org-export-create-backend'. It specifies back-end used
1640 for export. Return options as a plist."
1641 ;; For each buffer keyword, create a headline property setting the
1642 ;; same property in communication channel. The name for the property
1643 ;; is the keyword with "EXPORT_" appended to it.
1646 ;; Make sure point is at a heading.
1648 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1649 ;; title (with no todo keyword, priority cookie or tag) as its
1650 ;; fallback value.
1656 plist :title
1659 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1663 ;; Handle other keywords. TITLE keyword is excluded as it has
1664 ;; been handled already.
1672 ;; Export properties are not case-sensitive.
1679 plist
1680 property
1682 ;; Parse VALUE if required.
1686 ;; If BEHAVIOR is `split' expected value is
1687 ;; a list of strings, not a string.
1690 ;; Look for both general keywords and back-end specific
1691 ;; options, with priority given to the latter.
1693 org-export-options-alist)))
1694 ;; Return value.
1695 plist)))
1698 "Return current buffer export options, as a plist.
1700 Optional argument BACKEND, when non-nil, is an export back-end,
1701 as returned by, e.g., `org-export-create-backend'. It specifies
1702 which back-end specific options should also be read in the
1703 process.
1705 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1707 get-options ; For byte-compiler.
1710 ;; Priority is given to back-end specific options.
1712 org-export-options-alist))
1715 org-export-special-keywords))))
1718 ;; Return all properties associated to KEYWORD.
1725 ;; Recursively read keywords in buffer. FILES is a list
1726 ;; of files read so far. PLIST is the current property
1727 ;; list obtained.
1736 ;; Options in `org-export-special-keywords'.
1740 ;; Avoid circular dependencies.
1750 plist
1755 plist
1761 ;; Options in `org-export-options-alist'.
1766 plist property
1767 ;; Handle value depending on specified
1768 ;; BEHAVIOR.
1774 " "
1787 ;; Return final value.
1788 plist))))
1789 ;; Read options in the current buffer.
1792 ;; Parse keywords specified in `org-element-document-properties'
1793 ;; and return PLIST.
1804 "Return properties related to buffer attributes, as a plist."
1805 ;; Store full path of input file name, or nil. For internal use.
1808 :input-file visited-file
1814 "Return global export options as a plist.
1815 Optional argument BACKEND, if non-nil, is an export back-end, as
1816 returned by, e.g., `org-export-create-backend'. It specifies
1817 which back-end specific export options should also be read in the
1818 process."
1820 ;; Priority is given to back-end specific options.
1822 org-export-options-alist)))
1829 plist
1830 prop
1831 ;; Eval default value provided. If keyword is
1832 ;; a member of `org-element-document-properties',
1833 ;; parse it as a secondary string before storing it.
1840 value)))))))))))
1843 "Return variables bound from BIND keywords in current buffer.
1844 Also look for BIND keywords in setup files. The return value is
1845 an alist where associations are (VARIABLE-NAME VALUE)."
1850 ;; Return an alist between variable names and their
1851 ;; value. FILES is a list of setup files names read so
1852 ;; far, used to avoid circular dependencies. ALIST is
1853 ;; the alist collected so far.
1864 ;; Enter setup file.
1874 alist))))))))))
1875 alist)))))
1876 ;; Return value in appropriate order of appearance.
1880 ;;;; Tree Properties
1881 ;;
1882 ;; Tree properties are information extracted from parse tree. They
1883 ;; are initialized at the beginning of the transcoding process by
1884 ;; `org-export-collect-tree-properties'.
1885 ;;
1886 ;; Dedicated functions focus on computing the value of specific tree
1887 ;; properties during initialization. Thus,
1888 ;; `org-export--populate-ignore-list' lists elements and objects that
1889 ;; should be skipped during export, `org-export--get-min-level' gets
1890 ;; the minimal exportable level, used as a basis to compute relative
1891 ;; level for headlines. Eventually
1892 ;; `org-export--collect-headline-numbering' builds an alist between
1893 ;; headlines and their numbering.
1896 "Extract tree properties from parse tree.
1898 DATA is the parse tree from which information is retrieved. INFO
1899 is a list holding export options.
1901 Following tree properties are set or updated:
1903 `:exported-data' Hash table used to memoize results from
1904 `org-export-data'.
1906 `:footnote-definition-alist' List of footnotes definitions in
1907 original buffer and current parse tree.
1909 `:headline-offset' Offset between true level of headlines and
1910 local level. An offset of -1 means a headline
1911 of level 2 should be considered as a level
1912 1 headline in the context.
1914 `:headline-numbering' Alist of all headlines as key an the
1915 associated numbering as value.
1917 `:ignore-list' List of elements that should be ignored during
1918 export.
1920 Return updated plist."
1921 ;; Install the parse tree in the communication channel, in order to
1922 ;; use `org-export-get-genealogy' and al.
1924 ;; Get the list of elements and objects to ignore, and put it into
1925 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1926 ;; been done during parse tree filtering.
1929 :ignore-list
1932 ;; Compute `:headline-offset' in order to be able to use
1933 ;; `org-export-get-relative-level'.
1936 :headline-offset
1938 ;; Update footnotes definitions list with definitions in parse tree.
1939 ;; This is required since buffer expansion might have modified
1940 ;; boundaries of footnote definitions contained in the parse tree.
1941 ;; This way, definitions in `footnote-definition-alist' are bound to
1942 ;; match those in the parse tree.
1948 defs)))
1950 ;; Properties order doesn't matter: get the rest of the tree
1951 ;; properties.
1955 info))
1958 "Return minimum exportable headline's level in DATA.
1959 DATA is parsed tree as returned by `org-element-parse-buffer'.
1960 OPTIONS is a plist holding export options."
1971 ;; If no headline was found, for the sake of consistency, set
1972 ;; minimum level to 1 nonetheless.
1976 "Return numbering of all exportable headlines in a parse tree.
1978 DATA is the parse tree. OPTIONS is the plist holding export
1979 options.
1981 Return an alist whose key is a headline and value is its
1982 associated numbering \(in the shape of a list of numbers\) or nil
1983 for a footnotes section."
1991 headline
1993 for idx from 0 to org-export-max-depth
1997 options)))
2000 "Return list of elements and objects to ignore during export.
2001 DATA is the parse tree to traverse. OPTIONS is the plist holding
2002 export options."
2004 ;; First find trees containing a select tag, if any.
2006 ;; If a select tag is active, also ignore the section before
2007 ;; the first headline, if any.
2011 first-element))))
2014 ;; Collect ignored elements or objects into IGNORE-LIST.
2020 ;; If headline is archived but tree below has
2021 ;; to be skipped, add it to ignore list.
2024 ;; Move into secondary string, if any.
2029 ;; Move into recursive objects/elements.
2031 ;; Main call.
2033 ;; Return value.
2034 ignore))
2037 "Return list of headlines and inlinetasks with a select tag in their tree.
2038 DATA is parsed data as returned by `org-element-parse-buffer'.
2039 INFO is a plist holding export options."
2041 walk-data ; For byte-compiler.
2051 ;; When a select tag is found, mark full
2052 ;; genealogy and every headline within the tree
2053 ;; as acceptable.
2056 genealogy
2059 selected-trees))
2060 ;; If at a headline, continue searching in tree,
2061 ;; recursively.
2071 selected-trees))
2074 "Non-nil when element or object BLOB should be skipped during export.
2075 OPTIONS is the plist holding export options. SELECTED, when
2076 non-nil, is a list of headlines or inlinetasks belonging to
2077 a tree with a select tag."
2084 ;; If `:with-drawers' value starts with `not', ignore
2085 ;; every drawer whose name belong to that list.
2086 ;; Otherwise, ignore drawers whose name isn't in that
2087 ;; list.
2104 ;; Ignore subtrees with an exclude tag.
2107 ;; When a select tag is present in the buffer, ignore any tree
2108 ;; without it.
2110 ;; Ignore commented sub-trees.
2112 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2114 ;; Ignore tasks, if specified by `:with-tasks' property.
2126 properties-set))))))
2137 ;; `:with-timestamps' only applies to isolated timestamps
2138 ;; objects, i.e. timestamp objects in a paragraph containing only
2139 ;; timestamps and whitespaces.
2147 options t))))
2156 \f
2157 ;;; The Transcoder
2158 ;;
2159 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2160 ;; `org-element-parse-buffer') and transcodes it into a specified
2161 ;; back-end output. It takes care of filtering out elements or
2162 ;; objects according to export options and organizing the output blank
2163 ;; lines and white space are preserved. The function memoizes its
2164 ;; results, so it is cheap to call it within transcoders.
2165 ;;
2166 ;; It is possible to modify locally the back-end used by
2167 ;; `org-export-data' or even use a temporary back-end by using
2168 ;; `org-export-data-with-backend'.
2169 ;;
2170 ;; Internally, three functions handle the filtering of objects and
2171 ;; elements during the export. In particular,
2172 ;; `org-export-ignore-element' marks an element or object so future
2173 ;; parse tree traversals skip it and `org-export-expand' transforms
2174 ;; the others back into their original shape.
2175 ;;
2176 ;; `org-export-transcoder' is an accessor returning appropriate
2177 ;; translator function for a given element or object.
2180 "Return appropriate transcoder for BLOB.
2181 INFO is a plist containing export directives."
2183 ;; Return contents only for complete parse trees.
2189 "Convert DATA into current back-end format.
2191 DATA is a parse tree, an element or an object or a secondary
2192 string. INFO is a plist holding export options.
2194 Return transcoded string."
2200 ;; Ignored element/object.
2202 ;; Plain text.
2208 info))
2209 ;; Secondary string.
2212 ;; Element/Object without contents or, as a special case,
2213 ;; headline with archive tag and archived trees restricted
2214 ;; to title only.
2222 ;; Export snippets never return a nil value so
2223 ;; that white spaces following them are never
2224 ;; ignored.
2226 ;; Element/Object with contents.
2239 ;; Elements directly containing objects
2240 ;; must have their indentation normalized
2241 ;; first.
2243 data
2244 ;; When normalizing contents of the first
2245 ;; paragraph in an item or a footnote
2246 ;; definition, ignore first line's
2247 ;; indentation: there is none and it
2248 ;; might be misleading.
2253 data)
2260 info))))))))
2261 ;; Final result will be memoized before being returned.
2263 data
2267 ;; Append the same white space between elements or objects as in
2268 ;; the original buffer, and call appropriate filters.
2279 info)))
2280 results)))
2284 "Convert DATA into BACKEND format.
2286 DATA is an element, an object, a secondary string or a string.
2287 BACKEND is a symbol. INFO is a plist used as a communication
2288 channel.
2290 Unlike to `org-export-with-backend', this function will
2291 recursively convert DATA using BACKEND translation table."
2294 data
2295 ;; Set-up a new communication channel with translations defined in
2296 ;; BACKEND as the translate table and a new hash table for
2297 ;; memoization.
2299 info
2302 ;; Size of the hash table is reduced since this function
2303 ;; will probably be used on small trees.
2307 "Change uninterpreted elements back into Org syntax.
2308 DATA is the parse tree. INFO is a plist containing export
2309 options. Each uninterpreted element or object is changed back
2310 into a string. Contents, if any, are not modified. The parse
2311 tree is modified by side effect and returned by the function."
2315 prop
2318 info))))
2321 "Change uninterpreted elements back into Org syntax.
2322 DATA is a parse tree or a secondary string. INFO is a plist
2323 containing export options. It is modified by side effect and
2324 returned by the function."
2327 subscript superscript underline)
2331 ;; ... entities...
2338 ?\s)))))
2339 ;; ... emphasis...
2351 marker
2355 ?\s)))))))
2356 ;; ... LaTeX environments and fragments...
2360 ;; ... sub/superscripts...
2369 "_"
2378 ?\s)))))))))))
2380 ;; Splice NEW at BLOB location in parse tree.
2383 info)
2384 ;; Return modified parse tree.
2385 data)
2388 "Expand a parsed element or object to its original state.
2390 BLOB is either an element or an object. CONTENTS is its
2391 contents, as a string or nil.
2393 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2394 keywords before output."
2399 blob contents))))
2402 "Add ELEMENT to `:ignore-list' in INFO.
2404 Any element in `:ignore-list' will be skipped when using
2405 `org-element-map'. INFO is modified by side effects."
2409 \f
2410 ;;; The Filter System
2411 ;;
2412 ;; Filters allow end-users to tweak easily the transcoded output.
2413 ;; They are the functional counterpart of hooks, as every filter in
2414 ;; a set is applied to the return value of the previous one.
2415 ;;
2416 ;; Every set is back-end agnostic. Although, a filter is always
2417 ;; called, in addition to the string it applies to, with the back-end
2418 ;; used as argument, so it's easy for the end-user to add back-end
2419 ;; specific filters in the set. The communication channel, as
2420 ;; a plist, is required as the third argument.
2421 ;;
2422 ;; From the developer side, filters sets can be installed in the
2423 ;; process with the help of `org-export-define-backend', which
2424 ;; internally stores filters as an alist. Each association has a key
2425 ;; among the following symbols and a function or a list of functions
2426 ;; as value.
2427 ;;
2428 ;; - `:filter-options' applies to the property list containing export
2429 ;; options. Unlike to other filters, functions in this list accept
2430 ;; two arguments instead of three: the property list containing
2431 ;; export options and the back-end. Users can set its value through
2432 ;; `org-export-filter-options-functions' variable.
2433 ;;
2434 ;; - `:filter-parse-tree' applies directly to the complete parsed
2435 ;; tree. Users can set it through
2436 ;; `org-export-filter-parse-tree-functions' variable.
2437 ;;
2438 ;; - `:filter-final-output' applies to the final transcoded string.
2439 ;; Users can set it with `org-export-filter-final-output-functions'
2440 ;; variable
2441 ;;
2442 ;; - `:filter-plain-text' applies to any string not recognized as Org
2443 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2444 ;; configure it.
2445 ;;
2446 ;; - `:filter-TYPE' applies on the string returned after an element or
2447 ;; object of type TYPE has been transcoded. A user can modify
2448 ;; `org-export-filter-TYPE-functions'
2449 ;;
2450 ;; All filters sets are applied with
2451 ;; `org-export-filter-apply-functions' function. Filters in a set are
2452 ;; applied in a LIFO fashion. It allows developers to be sure that
2453 ;; their filters will be applied first.
2454 ;;
2455 ;; Filters properties are installed in communication channel with
2456 ;; `org-export-install-filters' function.
2457 ;;
2458 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2459 ;; `org-export-before-parsing-hook') are run at the beginning of the
2460 ;; export process and just before parsing to allow for heavy structure
2461 ;; modifications.
2464 ;;;; Hooks
2467 "Hook run at the beginning of the export process.
2469 This is run before include keywords and macros are expanded and
2470 Babel code blocks executed, on a copy of the original buffer
2471 being exported. Visibility and narrowing are preserved. Point
2472 is at the beginning of the buffer.
2474 Every function in this hook will be called with one argument: the
2478 "Hook run before parsing an export buffer.
2480 This is run after include keywords and macros have been expanded
2481 and Babel code blocks executed, on a copy of the original buffer
2482 being exported. Visibility and narrowing are preserved. Point
2483 is at the beginning of the buffer.
2485 Every function in this hook will be called with one argument: the
2489 ;;;; Special Filters
2492 "List of functions applied to the export options.
2493 Each filter is called with two arguments: the export options, as
2494 a plist, and the back-end, as a symbol. It must return
2498 "List of functions applied to the parsed tree.
2499 Each filter is called with three arguments: the parse tree, as
2500 returned by `org-element-parse-buffer', the back-end, as
2501 a symbol, and the communication channel, as a plist. It must
2505 "List of functions applied to plain text.
2506 Each filter is called with three arguments: a string which
2507 contains no Org syntax, the back-end, as a symbol, and the
2508 communication channel, as a plist. It must return a string or
2512 "List of functions applied to the transcoded string.
2513 Each filter is called with three arguments: the full transcoded
2514 string, the back-end, as a symbol, and the communication channel,
2515 as a plist. It must return a string that will be used as the
2519 ;;;; Elements Filters
2522 "List of functions applied to a transcoded babel-call.
2523 Each filter is called with three arguments: the transcoded data,
2524 as a string, the back-end, as a symbol, and the communication
2528 "List of functions applied to a transcoded center block.
2529 Each filter is called with three arguments: the transcoded data,
2530 as a string, the back-end, as a symbol, and the communication
2534 "List of functions applied to a transcoded clock.
2535 Each filter is called with three arguments: the transcoded data,
2536 as a string, the back-end, as a symbol, and the communication
2540 "List of functions applied to a transcoded comment.
2541 Each filter is called with three arguments: the transcoded data,
2542 as a string, the back-end, as a symbol, and the communication
2546 "List of functions applied to a transcoded comment-block.
2547 Each filter is called with three arguments: the transcoded data,
2548 as a string, the back-end, as a symbol, and the communication
2552 "List of functions applied to a transcoded diary-sexp.
2553 Each filter is called with three arguments: the transcoded data,
2554 as a string, the back-end, as a symbol, and the communication
2558 "List of functions applied to a transcoded drawer.
2559 Each filter is called with three arguments: the transcoded data,
2560 as a string, the back-end, as a symbol, and the communication
2564 "List of functions applied to a transcoded dynamic-block.
2565 Each filter is called with three arguments: the transcoded data,
2566 as a string, the back-end, as a symbol, and the communication
2570 "List of functions applied to a transcoded example-block.
2571 Each filter is called with three arguments: the transcoded data,
2572 as a string, the back-end, as a symbol, and the communication
2576 "List of functions applied to a transcoded export-block.
2577 Each filter is called with three arguments: the transcoded data,
2578 as a string, the back-end, as a symbol, and the communication
2582 "List of functions applied to a transcoded fixed-width.
2583 Each filter is called with three arguments: the transcoded data,
2584 as a string, the back-end, as a symbol, and the communication
2588 "List of functions applied to a transcoded footnote-definition.
2589 Each filter is called with three arguments: the transcoded data,
2590 as a string, the back-end, as a symbol, and the communication
2594 "List of functions applied to a transcoded headline.
2595 Each filter is called with three arguments: the transcoded data,
2596 as a string, the back-end, as a symbol, and the communication
2600 "List of functions applied to a transcoded horizontal-rule.
2601 Each filter is called with three arguments: the transcoded data,
2602 as a string, the back-end, as a symbol, and the communication
2606 "List of functions applied to a transcoded inlinetask.
2607 Each filter is called with three arguments: the transcoded data,
2608 as a string, the back-end, as a symbol, and the communication
2612 "List of functions applied to a transcoded item.
2613 Each filter is called with three arguments: the transcoded data,
2614 as a string, the back-end, as a symbol, and the communication
2618 "List of functions applied to a transcoded keyword.
2619 Each filter is called with three arguments: the transcoded data,
2620 as a string, the back-end, as a symbol, and the communication
2624 "List of functions applied to a transcoded latex-environment.
2625 Each filter is called with three arguments: the transcoded data,
2626 as a string, the back-end, as a symbol, and the communication
2630 "List of functions applied to a transcoded node-property.
2631 Each filter is called with three arguments: the transcoded data,
2632 as a string, the back-end, as a symbol, and the communication
2636 "List of functions applied to a transcoded paragraph.
2637 Each filter is called with three arguments: the transcoded data,
2638 as a string, the back-end, as a symbol, and the communication
2642 "List of functions applied to a transcoded plain-list.
2643 Each filter is called with three arguments: the transcoded data,
2644 as a string, the back-end, as a symbol, and the communication
2648 "List of functions applied to a transcoded planning.
2649 Each filter is called with three arguments: the transcoded data,
2650 as a string, the back-end, as a symbol, and the communication
2654 "List of functions applied to a transcoded property-drawer.
2655 Each filter is called with three arguments: the transcoded data,
2656 as a string, the back-end, as a symbol, and the communication
2660 "List of functions applied to a transcoded quote block.
2661 Each filter is called with three arguments: the transcoded quote
2662 data, as a string, the back-end, as a symbol, and the
2663 communication channel, as a plist. It must return a string or
2667 "List of functions applied to a transcoded section.
2668 Each filter is called with three arguments: the transcoded data,
2669 as a string, the back-end, as a symbol, and the communication
2673 "List of functions applied to a transcoded special block.
2674 Each filter is called with three arguments: the transcoded data,
2675 as a string, the back-end, as a symbol, and the communication
2679 "List of functions applied to a transcoded src-block.
2680 Each filter is called with three arguments: the transcoded data,
2681 as a string, the back-end, as a symbol, and the communication
2685 "List of functions applied to a transcoded table.
2686 Each filter is called with three arguments: the transcoded data,
2687 as a string, the back-end, as a symbol, and the communication
2691 "List of functions applied to a transcoded table-cell.
2692 Each filter is called with three arguments: the transcoded data,
2693 as a string, the back-end, as a symbol, and the communication
2697 "List of functions applied to a transcoded table-row.
2698 Each filter is called with three arguments: the transcoded data,
2699 as a string, the back-end, as a symbol, and the communication
2703 "List of functions applied to a transcoded verse block.
2704 Each filter is called with three arguments: the transcoded data,
2705 as a string, the back-end, as a symbol, and the communication
2709 ;;;; Objects Filters
2712 "List of functions applied to transcoded bold text.
2713 Each filter is called with three arguments: the transcoded data,
2714 as a string, the back-end, as a symbol, and the communication
2718 "List of functions applied to transcoded code text.
2719 Each filter is called with three arguments: the transcoded data,
2720 as a string, the back-end, as a symbol, and the communication
2724 "List of functions applied to a transcoded entity.
2725 Each filter is called with three arguments: the transcoded data,
2726 as a string, the back-end, as a symbol, and the communication
2730 "List of functions applied to a transcoded export-snippet.
2731 Each filter is called with three arguments: the transcoded data,
2732 as a string, the back-end, as a symbol, and the communication
2736 "List of functions applied to a transcoded footnote-reference.
2737 Each filter is called with three arguments: the transcoded data,
2738 as a string, the back-end, as a symbol, and the communication
2742 "List of functions applied to a transcoded inline-babel-call.
2743 Each filter is called with three arguments: the transcoded data,
2744 as a string, the back-end, as a symbol, and the communication
2748 "List of functions applied to a transcoded inline-src-block.
2749 Each filter is called with three arguments: the transcoded data,
2750 as a string, the back-end, as a symbol, and the communication
2754 "List of functions applied to transcoded italic text.
2755 Each filter is called with three arguments: the transcoded data,
2756 as a string, the back-end, as a symbol, and the communication
2760 "List of functions applied to a transcoded latex-fragment.
2761 Each filter is called with three arguments: the transcoded data,
2762 as a string, the back-end, as a symbol, and the communication
2766 "List of functions applied to a transcoded line-break.
2767 Each filter is called with three arguments: the transcoded data,
2768 as a string, the back-end, as a symbol, and the communication
2772 "List of functions applied to a transcoded link.
2773 Each filter is called with three arguments: the transcoded data,
2774 as a string, the back-end, as a symbol, and the communication
2778 "List of functions applied to a transcoded radio-target.
2779 Each filter is called with three arguments: the transcoded data,
2780 as a string, the back-end, as a symbol, and the communication
2784 "List of functions applied to a transcoded statistics-cookie.
2785 Each filter is called with three arguments: the transcoded data,
2786 as a string, the back-end, as a symbol, and the communication
2790 "List of functions applied to transcoded strike-through text.
2791 Each filter is called with three arguments: the transcoded data,
2792 as a string, the back-end, as a symbol, and the communication
2796 "List of functions applied to a transcoded subscript.
2797 Each filter is called with three arguments: the transcoded data,
2798 as a string, the back-end, as a symbol, and the communication
2802 "List of functions applied to a transcoded superscript.
2803 Each filter is called with three arguments: the transcoded data,
2804 as a string, the back-end, as a symbol, and the communication
2808 "List of functions applied to a transcoded target.
2809 Each filter is called with three arguments: the transcoded data,
2810 as a string, the back-end, as a symbol, and the communication
2814 "List of functions applied to a transcoded timestamp.
2815 Each filter is called with three arguments: the transcoded data,
2816 as a string, the back-end, as a symbol, and the communication
2820 "List of functions applied to transcoded underline text.
2821 Each filter is called with three arguments: the transcoded data,
2822 as a string, the back-end, as a symbol, and the communication
2826 "List of functions applied to transcoded verbatim text.
2827 Each filter is called with three arguments: the transcoded data,
2828 as a string, the back-end, as a symbol, and the communication
2832 ;;;; Filters Tools
2833 ;;
2834 ;; Internal function `org-export-install-filters' installs filters
2835 ;; hard-coded in back-ends (developer filters) and filters from global
2836 ;; variables (user filters) in the communication channel.
2837 ;;
2838 ;; Internal function `org-export-filter-apply-functions' takes care
2839 ;; about applying each filter in order to a given data. It ignores
2840 ;; filters returning a nil value but stops whenever a filter returns
2841 ;; an empty string.
2844 "Call every function in FILTERS.
2846 Functions are called with arguments VALUE, current export
2847 back-end's name and INFO. A function returning a nil value will
2848 be skipped. If it returns the empty string, the process ends and
2849 VALUE is ignored.
2851 Call is done in a LIFO fashion, to be sure that developer
2852 specified filters, if any, are called first."
2863 "Install filters properties in communication channel.
2864 INFO is a plist containing the current communication channel.
2865 Return the updated communication channel."
2867 ;; Install user-defined filters with `org-export-filters-alist'
2868 ;; and filters already in INFO (through ext-plist mechanism).
2875 ;; Filters in INFO will be called
2876 ;; before those user provided.
2879 default-value)))))
2880 org-export-filters-alist)
2881 ;; Prepend back-end specific filters to that list.
2883 ;; Single values get consed, lists are appended.
2888 plist key
2892 ;; Return new communication channel.
2896 \f
2897 ;;; Core functions
2898 ;;
2899 ;; This is the room for the main function, `org-export-as', along with
2900 ;; its derivative, `org-export-string-as'.
2901 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2902 ;; function should be added to kill ring.
2903 ;;
2904 ;; Note that `org-export-as' doesn't really parse the current buffer,
2905 ;; but a copy of it (with the same buffer-local variables and
2906 ;; visibility), where macros and include keywords are expanded and
2907 ;; Babel blocks are executed, if appropriate.
2908 ;; `org-export-with-buffer-copy' macro prepares that copy.
2909 ;;
2910 ;; File inclusion is taken care of by
2911 ;; `org-export-expand-include-keyword' and
2912 ;; `org-export--prepare-file-contents'. Structure wise, including
2913 ;; a whole Org file in a buffer often makes little sense. For
2914 ;; example, if the file contains a headline and the include keyword
2915 ;; was within an item, the item should contain the headline. That's
2916 ;; why file inclusion should be done before any structure can be
2917 ;; associated to the file, that is before parsing.
2918 ;;
2919 ;; `org-export-insert-default-template' is a command to insert
2920 ;; a default template (or a back-end specific template) at point or in
2921 ;; current subtree.
2924 "Return a copy of the current buffer.
2925 The copy preserves Org buffer-local variables, visibility and
2926 narrowing."
2932 new-buf))
2935 "Apply BODY in a copy of the current buffer.
2936 The copy preserves local variables, visibility and contents of
2937 the original buffer. Point is at the beginning of the buffer
2938 when BODY is applied."
2947 ;; Kill copy without confirmation.
2953 "Generate a function duplicating BUFFER.
2955 The copy will preserve local variables, visibility, contents and
2956 narrowing of the original buffer. If a region was active in
2957 BUFFER, contents will be narrowed to that region instead.
2959 The resulting function can be evaluated at a later time, from
2960 another buffer, effectively cloning the original buffer there.
2962 The function assumes BUFFER's major mode is `org-mode'."
2966 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2967 ;; already in BUFFER.
2969 ;; Copy specific buffer local variables and variables set
2970 ;; through BIND keywords.
2972 vars)
2980 buffer-file-name
2981 buffer-file-coding-system))
2985 ;; Skip unreadable values, as they cannot be
2986 ;; sent to external process.
2990 vars))))))
2991 ;; Whole buffer contents.
2996 ;; Narrowing.
3000 ;; Current position of point.
3002 ;; Overlays with invisible property.
3012 ov-set))))
3014 ov-set)))))
3016 ;;;###autoload
3019 "Transcode current Org buffer into BACKEND code.
3021 BACKEND is either an export back-end, as returned by, e.g.,
3022 `org-export-create-backend', or a symbol referring to
3023 a registered back-end.
3025 If narrowing is active in the current buffer, only transcode its
3026 narrowed part.
3028 If a region is active, transcode that region.
3030 When optional argument SUBTREEP is non-nil, transcode the
3031 sub-tree at point, extracting information from the headline
3032 properties first.
3034 When optional argument VISIBLE-ONLY is non-nil, don't export
3035 contents of hidden elements.
3037 When optional argument BODY-ONLY is non-nil, only return body
3038 code, without surrounding template.
3040 Optional argument EXT-PLIST, when provided, is a property list
3041 with external parameters overriding Org default settings, but
3042 still inferior to file-local settings.
3044 Return code as a string."
3049 ;; Narrow buffer to an appropriate region or subtree for
3050 ;; parsing. If parsing subtree, be sure to remove main headline
3051 ;; too.
3059 ;; Initialize communication channel with original buffer
3060 ;; attributes, unavailable in its copy.
3069 tree)
3070 ;; Update communication channel and get parse tree. Buffer
3071 ;; isn't parsed directly. Instead, a temporary copy is
3072 ;; created, where include keywords, macros are expanded and
3073 ;; code blocks are evaluated.
3075 ;; Run first hook with current back-end's name as argument.
3079 ;; Update macro templates since #+INCLUDE keywords might have
3080 ;; added some new ones.
3084 ;; Update radio targets since keyword inclusion might have
3085 ;; added some more.
3087 ;; Run last hook with current back-end's name as argument.
3092 ;; Update communication channel with environment. Also
3093 ;; install user's and developer's filters.
3098 ;; Expand export-specific set of macros: {{{author}}},
3099 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3100 ;; once regular macros have been expanded, since document
3101 ;; keywords may contain one of them.
3107 ;; EMAIL is not a parsed keyword: store it as-is.
3111 ;; Parse buffer.
3113 ;; Handle left-over uninterpreted elements or objects in
3114 ;; parse tree and communication channel.
3116 ;; Call options filters and update export options. We do not
3117 ;; use `org-export-filter-apply-functions' here since the
3118 ;; arity of such filters is different.
3123 ;; Parse buffer, handle uninterpreted elements or objects,
3124 ;; then call parse-tree filters.
3128 ;; Now tree is complete, compute its properties and add them
3129 ;; to communication channel.
3133 ;; Eventually transcode TREE. Wrap the resulting string into
3134 ;; a template.
3143 ;; Remove all text properties since they cannot be
3144 ;; retrieved from an external process. Finally call
3145 ;; final-output filter and return result.
3151 info))))))))
3153 ;;;###autoload
3155 "Transcode STRING into BACKEND code.
3157 BACKEND is either an export back-end, as returned by, e.g.,
3158 `org-export-create-backend', or a symbol referring to
3159 a registered back-end.
3161 When optional argument BODY-ONLY is non-nil, only return body
3162 code, without preamble nor postamble.
3164 Optional argument EXT-PLIST, when provided, is a property list
3165 with external parameters overriding Org default settings, but
3166 still inferior to file-local settings.
3168 Return code as a string."
3174 ;;;###autoload
3176 "Replace the active region by its export to BACKEND.
3177 BACKEND is either an export back-end, as returned by, e.g.,
3178 `org-export-create-backend', or a symbol referring to
3179 a registered back-end."
3189 ;;;###autoload
3191 "Insert all export keywords with default values at beginning of line.
3193 BACKEND is a symbol referring to the name of a registered export
3194 back-end, for which specific export options should be added to
3195 the template, or `default' for default template. When it is nil,
3196 the user will be prompted for a category.
3198 If SUBTREEP is non-nil, export configuration will be set up
3199 locally for the subtree through node properties."
3209 "Options category: "
3213 org-export--registered-backends))
3214 nil t))))
3215 options keywords)
3216 ;; Populate OPTIONS and KEYWORDS.
3233 ;; Move to an appropriate location in order to insert options.
3235 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3253 ;; Then the rest of keywords, in the order specified in either
3254 ;; `org-export-options-alist' or respective export back-ends.
3275 "Expand every include keyword in buffer.
3276 Optional argument INCLUDED is a list of included file names along
3277 with their line restriction, when appropriate. It is used to
3278 avoid infinite recursion. Optional argument DIR is the current
3279 working directory. It is used to properly resolve relative
3280 paths."
3287 ;; Extract arguments from keyword's value.
3295 dir)
3300 value)
3306 ;; Minimal level of included file defaults to the child
3307 ;; level of the current headline, if any, or one. It
3308 ;; only applies is the file is meant to be included as
3309 ;; an Org one.
3317 ;; Remove keyword.
3323 ;; Check if files has already been parsed. Look after
3324 ;; inclusion lines too, as different parts of the same file
3325 ;; can be included too.
3337 ind-str contents ind-str))))
3345 ind-str env contents ind-str))))
3358 "Prepare the contents of FILE for inclusion and return them as a string.
3360 When optional argument LINES is a string specifying a range of
3361 lines, include only those lines.
3363 Optional argument IND, when non-nil, is an integer specifying the
3364 global indentation of returned contents. Since its purpose is to
3365 allow an included file to stay in the same environment it was
3366 created \(i.e. a list item), it doesn't apply past the first
3367 headline encountered.
3369 Optional argument MINLEVEL, when non-nil, is an integer
3370 specifying the level that any top-level headline in the included
3371 file should have."
3387 ;; Remove blank lines at beginning and end of contents. The logic
3388 ;; behind that removal is that blank lines around include keyword
3389 ;; override blank lines in included file.
3398 ;; If IND is set, preserve indentation of include keyword until
3399 ;; the first headline encountered.
3406 ;; Do not move footnote definitions out of column 0.
3412 ;; When MINLEVEL is specified, compute minimal level for headlines
3413 ;; in the file (CUR-MIN), and remove stars to each headline so
3414 ;; that headlines with minimal level have a level of MINLEVEL.
3425 ;; Only change stars, don't bother moving whole
3426 ;; sections.
3433 "Execute every Babel code in the visible part of current buffer."
3434 ;; Get a pristine copy of current buffer so Babel references can be
3435 ;; properly resolved.
3442 "Return a non-nil value when output should be added to the kill ring.
3443 See also `org-export-copy-to-kill-ring'."
3449 \f
3450 ;;; Tools For Back-Ends
3451 ;;
3452 ;; A whole set of tools is available to help build new exporters. Any
3453 ;; function general enough to have its use across many back-ends
3454 ;; should be added here.
3456 ;;;; For Affiliated Keywords
3457 ;;
3458 ;; `org-export-read-attribute' reads a property from a given element
3459 ;; as a plist. It can be used to normalize affiliated keywords'
3460 ;; syntax.
3461 ;;
3462 ;; Since captions can span over multiple lines and accept dual values,
3463 ;; their internal representation is a bit tricky. Therefore,
3464 ;; `org-export-get-caption' transparently returns a given element's
3465 ;; caption as a secondary string.
3468 "Turn ATTRIBUTE property from ELEMENT into a plist.
3470 When optional argument PROPERTY is non-nil, return the value of
3471 that property within attributes.
3475 properties.
3477 All values will become strings except the empty string and
3480 will become the empty string."
3494 s)
3499 ;; Ignore any string before first property with `cdr'.
3504 "Return caption from ELEMENT as a secondary string.
3506 When optional argument SHORTP is non-nil, return short caption,
3507 as a secondary string, instead.
3509 Caption lines are separated by a white space."
3517 ;;;; For Derived Back-ends
3518 ;;
3519 ;; `org-export-with-backend' is a function allowing to locally use
3520 ;; another back-end to transcode some object or element. In a derived
3521 ;; back-end, it may be used as a fall-back function once all specific
3522 ;; cases have been treated.
3525 "Call a transcoder from BACKEND on DATA.
3526 BACKEND is an export back-end, as returned by, e.g.,
3527 `org-export-create-backend', or a symbol referring to
3528 a registered back-end. DATA is an Org element, object, secondary
3529 string or string. CONTENTS, when non-nil, is the transcoded
3530 contents of DATA element, as a string. INFO, when non-nil, is
3531 the communication channel used for export, as a plist."
3541 transcoder data contents
3544 :translate-alist all-transcoders
3548 ;;;; For Export Snippets
3549 ;;
3550 ;; Every export snippet is transmitted to the back-end. Though, the
3551 ;; latter will only retain one type of export-snippet, ignoring
3552 ;; others, based on the former's target back-end. The function
3553 ;; `org-export-snippet-backend' returns that back-end for a given
3554 ;; export-snippet.
3557 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3558 Translation, with `org-export-snippet-translation-alist', is
3559 applied."
3563 back-end))))
3566 ;;;; For Footnotes
3567 ;;
3568 ;; `org-export-collect-footnote-definitions' is a tool to list
3569 ;; actually used footnotes definitions in the whole parse tree, or in
3570 ;; a headline, in order to add footnote listings throughout the
3571 ;; transcoded data.
3572 ;;
3573 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3574 ;; back-ends, when they need to attach the footnote definition only to
3575 ;; the first occurrence of the corresponding label.
3576 ;;
3577 ;; `org-export-get-footnote-definition' and
3578 ;; `org-export-get-footnote-number' provide easier access to
3579 ;; additional information relative to a footnote reference.
3582 "Return an alist between footnote numbers, labels and definitions.
3584 DATA is the parse tree from which definitions are collected.
3585 INFO is the plist used as a communication channel.
3587 Definitions are sorted by order of references. They either
3588 appear as Org data or as a secondary string for inlined
3589 footnotes. Unreferenced definitions are ignored."
3591 collect-fn ; for byte-compiler.
3595 ;; Collect footnote number, label and definition in DATA.
3603 def)
3604 num-alist)
3605 ;; Also search in definition for nested footnotes.
3608 ;; Don't enter footnote definitions since it will happen
3609 ;; when their first reference is found.
3615 "Non-nil when a footnote reference is the first one for its label.
3617 FOOTNOTE-REFERENCE is the footnote reference being considered.
3618 INFO is the plist used as a communication channel."
3620 ;; Anonymous footnotes are always a first reference.
3622 ;; Otherwise, return the first footnote with the same LABEL and
3623 ;; test if it is equal to FOOTNOTE-REFERENCE.
3633 ;; If FN isn't inlined, be sure to traverse its
3634 ;; definition before resuming search. See
3635 ;; comments in `org-export-get-footnote-number'
3636 ;; for more information.
3640 ;; Don't enter footnote definitions since it will
3641 ;; happen when their first reference is found.
3644 footnote-reference)))))
3647 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3648 INFO is the plist used as a communication channel. If no such
3650 string."
3657 "Return number associated to a footnote.
3659 FOOTNOTE is either a footnote reference or a footnote definition.
3660 INFO is the plist used as a communication channel."
3662 seen-refs
3663 search-ref ; For byte-compiler.
3667 ;; Search footnote references through DATA, filling
3668 ;; SEEN-REFS along the way.
3673 ;; Anonymous footnote match: return number.
3676 ;; Labels match: return number.
3679 ;; Anonymous footnote: it's always a new one.
3680 ;; Also, be sure to return nil from the `cond' so
3681 ;; `first-match' doesn't get us out of the loop.
3683 ;; Label not seen so far: add it so SEEN-REFS.
3684 ;;
3685 ;; Also search for subsequent references in
3686 ;; footnote definition so numbering follows
3687 ;; reading logic. Note that we don't have to care
3688 ;; about inline definitions, since
3689 ;; `org-element-map' already traverses them at the
3690 ;; right time.
3691 ;;
3692 ;; Once again, return nil to stay in the loop.
3697 nil))))
3698 ;; Don't enter footnote definitions since it will
3699 ;; happen when their first reference is found.
3704 ;;;; For Headlines
3705 ;;
3706 ;; `org-export-get-relative-level' is a shortcut to get headline
3707 ;; level, relatively to the lower headline level in the parsed tree.
3708 ;;
3709 ;; `org-export-get-headline-number' returns the section number of an
3710 ;; headline, while `org-export-number-to-roman' allows to convert it
3711 ;; to roman numbers.
3712 ;;
3713 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3714 ;; `org-export-last-sibling-p' are three useful predicates when it
3715 ;; comes to fulfill the `:headline-levels' property.
3716 ;;
3717 ;; `org-export-get-tags', `org-export-get-category' and
3718 ;; `org-export-get-node-property' extract useful information from an
3719 ;; headline or a parent headline. They all handle inheritance.
3720 ;;
3721 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3722 ;; as a secondary string, suitable for table of contents. It falls
3723 ;; back onto default title.
3726 "Return HEADLINE relative level within current parsed tree.
3727 INFO is a plist holding contextual information."
3732 "Non-nil when HEADLINE is considered as low level.
3734 INFO is a plist used as a communication channel.
3736 A low level headlines has a relative level greater than
3737 `:headline-levels' property value.
3739 Return value is the difference between HEADLINE relative level
3740 and the last level being considered as high enough, or nil."
3747 "Return HEADLINE numbering as a list of numbers.
3748 INFO is a plist holding contextual information."
3752 "Return a non-nil value if HEADLINE element should be numbered.
3753 INFO is a plist used as a communication channel."
3759 "Convert integer N into a roman numeral."
3772 res)))
3775 "Return list of tags associated to ELEMENT.
3777 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3778 is a plist used as a communication channel.
3780 Select tags (see `org-export-select-tags') and exclude tags (see
3781 `org-export-exclude-tags') are removed from the list.
3783 When non-nil, optional argument TAGS should be a list of strings.
3784 Any tag belonging to this list will also be removed.
3786 When optional argument INHERITED is non-nil, tags can also be
3787 inherited from parent headlines and FILETAGS keywords."
3793 ;; Build complete list of inherited tags.
3804 ;; Add FILETAGS keywords and return results.
3808 "Return node PROPERTY value for BLOB.
3810 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3811 element or object.
3813 If optional argument INHERITED is non-nil, the value can be
3814 inherited from a parent headline.
3816 Return value is a string or nil."
3828 "Return category for element or object BLOB.
3830 INFO is a plist used as a communication channel.
3832 CATEGORY is automatically inherited from a parent headline, from
3833 #+CATEGORY: keyword or created out of original file name. If all
3837 ;; Almost like `org-export-node-property', but we cannot trust
3838 ;; `plist-member' as every headline has a `:CATEGORY'
3839 ;; property, would it be nil or equal to "???" (which has the
3840 ;; same meaning).
3858 "Return alternative title for HEADLINE, as a secondary string.
3859 INFO is a plist used as a communication channel. If no optional
3860 title is defined, fall-back to the regular title."
3865 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3866 INFO is a plist used as a communication channel."
3871 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3872 INFO is a plist used as a communication channel."
3876 ;;;; For Keywords
3877 ;;
3878 ;; `org-export-get-date' returns a date appropriate for the document
3879 ;; to about to be exported. In particular, it takes care of
3880 ;; `org-export-date-timestamp-format'.
3883 "Return date value for the current document.
3885 INFO is a plist used as a communication channel. FMT, when
3886 non-nil, is a time format string that will be applied on the date
3887 if it consists in a single timestamp object. It defaults to
3888 `org-export-date-timestamp-format' when nil.
3890 A proper date can be a secondary string, a string or nil. It is
3891 meant to be translated with `org-export-data' or alike."
3902 ;;;; For Links
3903 ;;
3904 ;; `org-export-solidify-link-text' turns a string into a safer version
3905 ;; for links, replacing most non-standard characters with hyphens.
3906 ;;
3907 ;; `org-export-get-coderef-format' returns an appropriate format
3908 ;; string for coderefs.
3909 ;;
3910 ;; `org-export-inline-image-p' returns a non-nil value when the link
3911 ;; provided should be considered as an inline image.
3912 ;;
3913 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3914 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3915 ;; returns an appropriate unique identifier when found, or nil.
3916 ;;
3917 ;; `org-export-resolve-id-link' returns the first headline with
3918 ;; specified id or custom-id in parse tree, the path to the external
3919 ;; file with the id or nil when neither was found.
3920 ;;
3921 ;; `org-export-resolve-coderef' associates a reference to a line
3922 ;; number in the element it belongs, or returns the reference itself
3923 ;; when the element isn't numbered.
3926 "Take link text S and make a safe target out of it."
3931 "Return format string for code reference link.
3932 PATH is the link path. DESC is its description."
3940 "Non-nil if LINK object points to an inline image.
3942 Optional argument is a set of RULES defining inline images. It
3943 is an alist where associations have the following shape:
3945 \(TYPE . REGEXP)
3947 Applying a rule means apply REGEXP against LINK's path when its
3948 type is TYPE. The function will return a non-nil value if any of
3949 the provided rules is non-nil. The default rule is
3950 `org-export-default-inline-image-rule'.
3952 This only applies to links without a description."
3963 rules)
3964 ;; Return nil if no rule matched.
3965 nil))))
3968 "Resolve a code reference REF.
3970 INFO is a plist used as a communication channel.
3972 Return associated line number in source code, or REF itself,
3973 depending on src-block or example element's switches."
3980 org-coderef-label-format)))
3984 ;; Element containing REF is found. Resolve it to either
3985 ;; a label or a line number, as needed.
3995 "Return LINK destination.
3997 INFO is a plist holding contextual information.
3999 Return value can be an object, an element, or nil:
4001 - If LINK path matches a target object (i.e. <<path>>) return it.
4003 - If LINK path exactly matches the name affiliated keyword
4004 \(i.e. #+NAME: path) of an element, return that element.
4006 - If LINK path exactly matches any headline name, return that
4007 element. If more than one headline share that name, priority
4008 will be given to the one with the closest common ancestor, if
4009 any, or the first one in the parse tree otherwise.
4011 - Otherwise, return nil.
4014 significant."
4017 ;; Split PATH at white spaces so matches are space
4018 ;; insensitive.
4021 ;; Cache for destinations that are not position dependent.
4029 ;; Destination is not position dependent: use cached value.
4031 ;; First try to find a matching "<<path>>" unless user specified
4032 ;; he was looking for a headline (path starts with a "*"
4033 ;; character).
4039 path)
4040 blob))
4043 ;; Then try to find an element with a matching "#+NAME: path"
4044 ;; affiliated keyword.
4047 org-element-all-elements
4052 el)))
4055 ;; Last case: link either points to a headline or to nothingness.
4056 ;; Try to find the source, with priority given to headlines with
4057 ;; the closest common ancestor. If such candidate is found,
4058 ;; return it, otherwise return nil.
4062 ;; Return first headline whose `:raw-value' property is
4063 ;; NAME in parse tree DATA, or nil. Statistics cookies
4064 ;; are ignored.
4072 name)
4073 headline))
4075 ;; Search among headlines sharing an ancestor with link, from
4076 ;; closest to farthest.
4085 ;; No destination found: return nil.
4089 "Return headline referenced as LINK destination.
4091 INFO is a plist used as a communication channel.
4093 Return value can be the headline element matched in current parse
4097 ;; First check if id is within the current parse tree.
4102 headline))
4104 ;; Otherwise, look for external files.
4108 "Return radio-target object referenced as LINK destination.
4110 INFO is a plist used as a communication channel.
4112 Return value can be a radio-target object or nil. Assume LINK
4121 nil nil path nil nil t)
4122 t)
4123 radio))
4127 ;;;; For References
4128 ;;
4129 ;; `org-export-get-ordinal' associates a sequence number to any object
4130 ;; or element.
4133 "Return ordinal number of an element or object.
4135 ELEMENT is the element or object considered. INFO is the plist
4136 used as a communication channel.
4138 Optional argument TYPES, when non-nil, is a list of element or
4139 object types, as symbols, that should also be counted in.
4140 Otherwise, only provided element's type is considered.
4142 Optional argument PREDICATE is a function returning a non-nil
4143 value if the current element or object should be counted in. It
4144 accepts two arguments: the element or object being considered and
4145 the plist used as a communication channel. This allows to count
4146 only a certain type of objects (i.e. inline images).
4148 Return value is a list of numbers if ELEMENT is a headline or an
4149 item. It is nil for keywords. It represents the footnote number
4150 for footnote definitions and footnote references. If ELEMENT is
4151 a target, return the same value as if ELEMENT was the closest
4152 table, item or headline containing the target. In any other
4153 case, return the sequence number of ELEMENT among elements or
4154 objects of the same type."
4155 ;; Ordinal of a target object refer to the ordinal of the closest
4156 ;; table, item, or headline containing the object.
4160 when
4164 table))
4165 return parent)))
4167 ;; Special case 1: A headline returns its number as a list.
4169 ;; Special case 2: An item returns its number as a list.
4173 struct
4180 ;; Increment counter until ELEMENT is found again.
4191 ;;;; For Src-Blocks
4192 ;;
4193 ;; `org-export-get-loc' counts number of code lines accumulated in
4194 ;; src-block or example-block elements with a "+n" switch until
4195 ;; a given element, excluded. Note: "-n" switches reset that count.
4196 ;;
4197 ;; `org-export-unravel-code' extracts source code (along with a code
4198 ;; references alist) from an `element-block' or `src-block' type
4199 ;; element.
4200 ;;
4201 ;; `org-export-format-code' applies a formatting function to each line
4202 ;; of code, providing relative line number and code reference when
4203 ;; appropriate. Since it doesn't access the original element from
4204 ;; which the source code is coming, it expects from the code calling
4205 ;; it to know if lines should be numbered and if code references
4206 ;; should appear.
4207 ;;
4208 ;; Eventually, `org-export-format-code-default' is a higher-level
4209 ;; function (it makes use of the two previous functions) which handles
4210 ;; line numbering and code references inclusion, and returns source
4211 ;; code in a format suitable for plain text or verbatim output.
4214 "Return accumulated lines of code up to ELEMENT.
4216 INFO is the plist used as a communication channel.
4218 ELEMENT is excluded from count."
4224 ;; ELEMENT is reached: Quit the loop.
4226 ;; Only count lines from src-block and example-block elements
4227 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4231 ;; Accumulate locs or reset them.
4235 ;; Return nil to stay in the loop.
4236 nil)))
4238 ;; Return value.
4239 loc))
4242 "Clean source code and extract references out of it.
4244 ELEMENT has either a `src-block' an `example-block' type.
4246 Return a cons cell whose CAR is the source code, cleaned from any
4247 reference, protective commas and spurious indentation, and CDR is
4248 an alist between relative line number (integer) and name of code
4249 reference on that line (string)."
4252 ;; Get code and clean it. Remove blank lines at its
4253 ;; beginning and end.
4260 value
4262 ;; Get format used for references.
4265 org-coderef-label-format)))
4266 ;; Build a regexp matching a loc with a reference.
4271 ;; Return value.
4273 ;; Code with references removed.
4279 ;; Ref line: remove ref, and signal its position in REFS.
4283 ;; Reference alist.
4284 refs)))
4287 "Format CODE by applying FUN line-wise and return it.
4289 CODE is a string representing the code to format. FUN is
4290 a function. It must accept three arguments: a line of
4291 code (string), the current line number (integer) or nil and the
4292 reference associated to the current line (string) or nil.
4294 Optional argument NUM-LINES can be an integer representing the
4295 number of code lines accumulated until the current code. Line
4296 numbers passed to FUN will take it into account. If it is nil,
4297 FUN's second argument will always be nil. This number can be
4298 obtained with `org-export-get-loc' function.
4300 Optional argument REF-ALIST can be an alist between relative line
4301 number (i.e. ignoring NUM-LINES) and the name of the code
4302 reference on it. If it is nil, FUN's third argument will always
4303 be nil. It can be obtained through the use of
4304 `org-export-unravel-code' function."
4316 "Return source code from ELEMENT, formatted in a standard way.
4318 ELEMENT is either a `src-block' or `example-block' element. INFO
4319 is a plist used as a communication channel.
4321 This function takes care of line numbering and code references
4322 inclusion. Line numbers, when applicable, appear at the
4323 beginning of the line, separated from the code by two white
4324 spaces. Code references, on the other hand, appear flushed to
4325 the right, separated by six white spaces from the widest line of
4326 code."
4327 ;; Extract code and references.
4334 ;; Handle line numbering.
4343 ;; Prepare references display, if required. Any reference
4344 ;; should start six columns after the widest line of code,
4345 ;; wrapped with parenthesis.
4350 code
4354 number-str
4355 loc
4361 num-start refs)))))
4364 ;;;; For Tables
4365 ;;
4366 ;; `org-export-table-has-special-column-p' and and
4367 ;; `org-export-table-row-is-special-p' are predicates used to look for
4368 ;; meta-information about the table structure.
4369 ;;
4370 ;; `org-table-has-header-p' tells when the rows before the first rule
4371 ;; should be considered as table's header.
4372 ;;
4373 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4374 ;; and `org-export-table-cell-borders' extract information from
4375 ;; a table-cell element.
4376 ;;
4377 ;; `org-export-table-dimensions' gives the number on rows and columns
4378 ;; in the table, ignoring horizontal rules and special columns.
4379 ;; `org-export-table-cell-address', given a table-cell object, returns
4380 ;; the absolute address of a cell. On the other hand,
4381 ;; `org-export-get-table-cell-at' does the contrary.
4382 ;;
4383 ;; `org-export-table-cell-starts-colgroup-p',
4384 ;; `org-export-table-cell-ends-colgroup-p',
4385 ;; `org-export-table-row-starts-rowgroup-p',
4386 ;; `org-export-table-row-ends-rowgroup-p',
4387 ;; `org-export-table-row-starts-header-p' and
4388 ;; `org-export-table-row-ends-header-p' indicate position of current
4389 ;; row or cell within the table.
4392 "Non-nil when TABLE has a special column.
4393 All special columns will be ignored during export."
4394 ;; The table has a special column when every first cell of every row
4395 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4396 ;; "*" "_" and "^". Though, do not consider a first row containing
4397 ;; only empty cells as special.
4413 "Non-nil when TABLE has a header.
4415 INFO is a plist used as a communication channel.
4417 A table has a header when it contains at least two row groups."
4426 table
4437 cache)))))
4440 "Non-nil if TABLE-ROW is considered special.
4442 INFO is a plist used as the communication channel.
4444 All special rows will be ignored during export."
4448 ;; A row is special either when...
4450 ;; ... it starts with a field only containing "/",
4452 ;; ... the table contains a special column and the row start
4453 ;; with a marking character among, "^", "_", "$" or "!",
4457 ;; ... it contains only alignment cookies and empty cells.
4463 ;; Since VALUE is a secondary string, the following
4464 ;; checks avoid expanding it with `org-export-data'.
4476 "Return TABLE-ROW's group number, as an integer.
4478 INFO is a plist used as the communication channel.
4480 Return value is the group number, as an integer, or nil for
4481 special rows and rows separators. First group is also table's
4482 header."
4500 "Return TABLE-CELL contents width.
4502 INFO is a plist used as the communication channel.
4504 Return value is the width given by the last width cookie in the
4505 same column as TABLE-CELL, or nil."
4524 ;; In a special row, try to find a width cookie at COLUMN.
4528 ;; The following checks avoid expanding unnecessarily
4529 ;; the cell with `org-export-data'.
4539 "Return TABLE-CELL contents alignment.
4541 INFO is a plist used as the communication channel.
4543 Return alignment as specified by the last alignment cookie in the
4544 same column as TABLE-CELL. If no such cookie is found, a default
4545 alignment value will be deduced from fraction of numbers in the
4546 column (see `org-table-number-fraction' for more information).
4547 Possible values are `left', `right' and `center'."
4548 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4565 cookie-align
4566 previous-cell-number-p)
4569 ;; In a special row, try to find an alignment cookie at
4570 ;; COLUMN.
4574 ;; Since VALUE is a secondary string, the following
4575 ;; checks avoid useless expansion through
4576 ;; `org-export-data'.
4584 ;; Ignore table rules.
4586 ;; In a standard row, check if cell's contents are
4587 ;; expressing some kind of number. Increase NUMBER-CELLS
4588 ;; accordingly. Though, don't bother if an alignment
4589 ;; cookie has already defined cell's alignment.
4594 info)))
4596 ;; Treat an empty cell as a number if it follows
4597 ;; a number.
4603 ;; Return value. Alignment specified by cookies has
4604 ;; precedence over alignment deduced from cell's contents.
4606 column
4611 org-table-number-fraction)
4616 "Return TABLE-CELL borders.
4618 INFO is a plist used as a communication channel.
4620 Return value is a list of symbols, or nil. Possible values are:
4621 `top', `bottom', `above', `below', `left' and `right'. Note:
4622 `top' (resp. `bottom') only happen for a cell in the first
4623 row (resp. last row) of the table, ignoring table rules, if any.
4625 Returned borders ignore special rows."
4628 borders)
4629 ;; Top/above border? TABLE-CELL has a border above when a rule
4630 ;; used to demarcate row groups can be found above. Hence,
4631 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4632 ;; another regular row has to be found above that rule.
4641 ;; Look at every row before the current one.
4643 ;; No rule above, or rule found starts the table (ignoring any
4644 ;; special row): TABLE-CELL is at the top of the table.
4647 ;; Bottom/below border? TABLE-CELL has a border below when next
4648 ;; non-regular row below is a rule.
4657 ;; Look at every row after the current one.
4659 ;; No rule below, or rule found ends the table (modulo some
4660 ;; special row): TABLE-CELL is at the bottom of the table.
4663 ;; Right/left borders? They can only be specified by column
4664 ;; groups. Column groups are defined in a row starting with "/".
4665 ;; Also a column groups row only contains "<", "<>", ">" or blank
4666 ;; cells.
4683 ;; There's a left border when previous cell, if
4684 ;; any, ends a group, or current one starts one.
4690 ;; There's a right border when next cell, if any,
4691 ;; starts a group, or current one ends one.
4698 ;; Table rows are read in reverse order so last column groups
4699 ;; row has precedence over any previous one.
4701 ;; Return value.
4702 borders))
4705 "Non-nil when TABLE-CELL is at the beginning of a column group.
4706 INFO is a plist used as a communication channel."
4707 ;; A cell starts a column group either when it is at the beginning
4708 ;; of a row (or after the special column, if any) or when it has
4709 ;; a left border.
4712 table-cell)
4716 "Non-nil when TABLE-CELL is at the end of a column group.
4717 INFO is a plist used as a communication channel."
4718 ;; A cell ends a column group either when it is at the end of a row
4719 ;; or when it has a right border.
4722 table-cell)
4726 "Non-nil when TABLE-ROW is at the beginning of a row group.
4727 INFO is a plist used as a communication channel."
4735 "Non-nil when TABLE-ROW is at the end of a row group.
4736 INFO is a plist used as a communication channel."
4744 "Non-nil when TABLE-ROW is the first table header's row.
4745 INFO is a plist used as a communication channel."
4752 "Non-nil when TABLE-ROW is the last table header's row.
4753 INFO is a plist used as a communication channel."
4760 "Return TABLE-ROW number.
4761 INFO is a plist used as a communication channel. Return value is
4762 zero-based and ignores separators. The function returns nil for
4763 special columns and separators."
4775 "Return TABLE dimensions.
4777 INFO is a plist used as a communication channel.
4779 Return value is a CONS like (ROWS . COLUMNS) where
4780 ROWS (resp. COLUMNS) is the number of exportable
4781 rows (resp. columns)."
4783 ;; Set number of rows, and extract first one.
4789 ;; Set number of columns.
4791 ;; Return value.
4795 "Return address of a regular TABLE-CELL object.
4797 TABLE-CELL is the cell considered. INFO is a plist used as
4798 a communication channel.
4800 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4801 zero-based index. Only exportable cells are considered. The
4802 function returns nil for other cells."
4814 "Return regular table-cell object at ADDRESS in TABLE.
4816 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4817 zero-based index. TABLE is a table type element. INFO is
4818 a plist used as a communication channel.
4820 If no table-cell, among exportable cells, is found at ADDRESS,
4821 return nil."
4824 ;; Row at (car address) or nil.
4832 'table-cell
4839 ;;;; For Tables Of Contents
4840 ;;
4841 ;; `org-export-collect-headlines' builds a list of all exportable
4842 ;; headline elements, maybe limited to a certain depth. One can then
4843 ;; easily parse it and transcode it.
4844 ;;
4845 ;; Building lists of tables, figures or listings is quite similar.
4846 ;; Once the generic function `org-export-collect-elements' is defined,
4847 ;; `org-export-collect-tables', `org-export-collect-figures' and
4848 ;; `org-export-collect-listings' can be derived from it.
4851 "Collect headlines in order to build a table of contents.
4853 INFO is a plist used as a communication channel.
4855 When optional argument N is an integer, it specifies the depth of
4856 the table of contents. Otherwise, it is set to the value of the
4857 last headline level. See `org-export-headline-levels' for more
4858 information.
4860 Return a list of all exportable headlines as parsed elements.
4861 Footnote sections, if any, will be ignored."
4869 info)))
4872 "Collect referenceable elements of a determined type.
4874 TYPE can be a symbol or a list of symbols specifying element
4875 types to search. Only elements with a caption are collected.
4877 INFO is a plist used as a communication channel.
4879 When non-nil, optional argument PREDICATE is a function accepting
4880 one argument, an element of type TYPE. It returns a non-nil
4881 value when that element should be collected.
4883 Return a list of all elements found, in order of appearance."
4888 element))
4889 info))
4892 "Build a list of tables.
4893 INFO is a plist used as a communication channel.
4895 Return a list of table elements with a caption."
4899 "Build a list of figures.
4901 INFO is a plist used as a communication channel. PREDICATE is
4902 a function which accepts one argument: a paragraph element and
4903 whose return value is non-nil when that element should be
4904 collected.
4906 A figure is a paragraph type element, with a caption, verifying
4908 a vague concept that may depend on back-end.
4910 Return a list of elements recognized as figures."
4914 "Build a list of src blocks.
4916 INFO is a plist used as a communication channel.
4918 Return a list of src-block elements with a caption."
4922 ;;;; Smart Quotes
4923 ;;
4924 ;; The main function for the smart quotes sub-system is
4925 ;; `org-export-activate-smart-quotes', which replaces every quote in
4926 ;; a given string from the parse tree with its "smart" counterpart.
4927 ;;
4928 ;; Dictionary for smart quotes is stored in
4929 ;; `org-export-smart-quotes-alist'.
4930 ;;
4931 ;; Internally, regexps matching potential smart quotes (checks at
4932 ;; string boundaries are also necessary) are defined in
4933 ;; `org-export-smart-quotes-regexps'.
4937 ;; one may use: »...«, "...", ›...‹, or '...'.
4938 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4939 ;; LaTeX quotes require Babel!
4984 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4993 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5002 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5011 ;; 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
5012 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5023 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5029 )
5030 "Smart quotes translations.
5032 Alist whose CAR is a language string and CDR is an alist with
5033 quote type as key and a plist associating various encodings to
5034 their translation as value.
5036 A quote type can be any symbol among `opening-double-quote',
5037 `closing-double-quote', `opening-single-quote',
5038 `closing-single-quote' and `apostrophe'.
5040 Valid encodings include `:utf-8', `:html', `:latex' and
5041 `:texinfo'.
5047 ;; Possible opening quote at beginning of string.
5049 ;; Possible closing quote at beginning of string.
5051 ;; Possible apostrophe at beginning of string.
5053 ;; Opening single and double quotes.
5055 ;; Closing single and double quotes.
5057 ;; Apostrophe.
5059 ;; Possible opening quote at end of string.
5061 ;; Possible closing quote at end of string.
5063 ;; Possible apostrophe at end of string.
5065 "List of regexps matching a quote or an apostrophe.
5071 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5072 `:utf-8'. INFO is a plist used as a communication channel.
5074 The function has to retrieve information about string
5075 surroundings in parse tree. It can only happen with an
5076 unmodified string. Thus, if S has already been through another
5077 process, a non-nil ORIGINAL optional argument will provide that
5078 original string.
5080 Return the new string."
5083 ;; Try to be flexible when computing number of blanks
5084 ;; before object. The previous object may be a string
5085 ;; introduced by the back-end and not completely parsed.
5088 ;; A string with missing `:post-blank'
5089 ;; property.
5093 ;; Fallback value.
5098 ;; Return smart quote associated to a give quote Q, as
5099 ;; a string. TYPE is a symbol among `open', `close' and
5100 ;; `apostrophe'.
5110 org-export-smart-quotes-alist))))
5111 encoding)
5112 q)))))
5114 ;; Only a quote: no regexp can match. We have to check both
5115 ;; sides and decide what to do.
5123 ;; 1. Replace quote character at the beginning of S.
5125 ;; Apostrophe?
5131 ;; Closing quote?
5137 ;; Opening quote?
5143 ;; 2. Replace quotes in the middle of the string.
5145 ;; Opening quotes.
5151 ;; Closing quotes.
5157 ;; Apostrophes.
5162 ;; 3. Replace quote character at the end of S.
5164 ;; Apostrophe?
5169 ;; Closing quote?
5175 ;; Opening quote?
5180 ;; Return string with smart quotes.
5181 s))))
5183 ;;;; Topology
5184 ;;
5185 ;; Here are various functions to retrieve information about the
5186 ;; neighborhood of a given element or object. Neighbors of interest
5187 ;; are direct parent (`org-export-get-parent'), parent headline
5188 ;; (`org-export-get-parent-headline'), first element containing an
5189 ;; object, (`org-export-get-parent-element'), parent table
5190 ;; (`org-export-get-parent-table'), previous element or object
5191 ;; (`org-export-get-previous-element') and next element or object
5192 ;; (`org-export-get-next-element').
5193 ;;
5194 ;; `org-export-get-genealogy' returns the full genealogy of a given
5195 ;; element or object, from closest parent to full parse tree.
5198 "Return full genealogy relative to a given element or object.
5200 BLOB is the element or object being considered.
5202 Ancestors are returned from closest to farthest, the last one
5203 being the full parse tree."
5210 "Return BLOB parent headline or nil.
5211 BLOB is the element or object being considered."
5215 parent))
5218 "Return first element containing OBJECT or nil.
5219 OBJECT is the object to consider."
5223 parent))
5226 "Return OBJECT parent table or nil.
5227 OBJECT is either a `table-cell' or `table-element' type object."
5231 parent))
5234 "Return previous element or object.
5236 BLOB is an element or object. INFO is a plist used as
5237 a communication channel. Return previous exportable element or
5238 object, a string, or nil.
5240 When optional argument N is a positive integer, return a list
5241 containing up to N siblings before BLOB, from farthest to
5242 closest. With any other non-nil value, return a list containing
5243 all of them."
5249 prev)
5259 "Return next element or object.
5261 BLOB is an element or object. INFO is a plist used as
5262 a communication channel. Return next exportable element or
5263 object, a string, or nil.
5265 When optional argument N is a positive integer, return a list
5266 containing up to N siblings after BLOB, from closest to farthest.
5267 With any other non-nil value, return a list containing all of
5268 them."
5275 next)
5285 ;;;; Translation
5286 ;;
5287 ;; `org-export-translate' translates a string according to the language
5288 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5289 ;; the dictionary used for the translation.
5336 ("ru" :html "(Продолжение следует)"
5434 ("ru" :html "Список распечаток"
5447 ("ru" :html "Список таблиц"
5527 ("ru" :html "Неизвестная ссылка"
5530 "Dictionary for export engine.
5532 Alist whose CAR is the string to translate and CDR is an alist
5533 whose CAR is the language string and CDR is a plist whose
5534 properties are possible charsets and values translated terms.
5536 It is used as a database for `org-export-translate'. Since this
5537 function returns the string as-is if no translation was found,
5538 the variable only needs to record values different from the
5542 "Translate string S according to language specification.
5544 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5545 and `:utf-8'. INFO is a plist used as a communication channel.
5547 Translation depends on `:language' property. Return the
5548 translated string. If no translation is found, try to fall back
5549 to `:default' encoding. If it fails, return S."
5555 s)))
5558 \f
5559 ;;; Asynchronous Export
5560 ;;
5561 ;; `org-export-async-start' is the entry point for asynchronous
5562 ;; export. It recreates current buffer (including visibility,
5563 ;; narrowing and visited file) in an external Emacs process, and
5564 ;; evaluates a command there. It then applies a function on the
5565 ;; returned results in the current process.
5566 ;;
5567 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5568 ;; allow to export to a buffer or a file, asynchronously or not.
5569 ;;
5570 ;; `org-export-output-file-name' is an auxiliary function meant to be
5571 ;; used with `org-export-to-file'. With a given extension, it tries
5572 ;; to provide a canonical file name to write export output to.
5573 ;;
5574 ;; Asynchronously generated results are never displayed directly.
5575 ;; Instead, they are stored in `org-export-stack-contents'. They can
5576 ;; then be retrieved by calling `org-export-stack'.
5577 ;;
5578 ;; Export Stack is viewed through a dedicated major mode
5579 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5580 ;;`org-export-stack-delete', `org-export-stack-view' and
5581 ;;`org-export-stack-clear'.
5582 ;;
5583 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5584 ;; It should be used whenever `org-export-async-start' is called.
5587 "Call function FUN on the results returned by BODY evaluation.
5589 BODY evaluation happens in an asynchronous process, from a buffer
5590 which is an exact copy of the current one.
5592 Use `org-export-add-to-stack' in FUN in order to register results
5593 in the stack.
5595 This is a low level function. See also `org-export-to-buffer'
5596 and `org-export-to-file' for more specialized functions."
5599 ;; Write the full sexp evaluating BODY in a copy of the current
5600 ;; buffer to a temporary file, as it may be too long for program
5601 ;; args in `start-process'.
5608 ;; Null characters (from variable values) are inserted
5609 ;; within the file. As a consequence, coding system for
5610 ;; buffer contents will not be recognized properly. So,
5611 ;; we make sure it is the same as the one used to display
5612 ;; the original buffer.
5614 ,coding
5617 ;; Ignore `kill-emacs-hook' and code evaluation
5618 ;; queries from Babel as we need a truly
5619 ;; non-interactive process.
5621 org-babel-confirm-evaluate-answer-no t)
5622 ;; Initialize export framework.
5624 ;; Re-create current buffer there.
5627 ;; Sexp to evaluate in the buffer.
5629 ;; Start external process.
5632 (,process
5634 #'start-process
5637 ,proc-buffer
5644 ;; Register running process in stack.
5646 ;; Set-up sentinel in order to catch results.
5649 ,process
5671 ;;;###autoload
5674 &optional async subtreep visible-only body-only ext-plist
5675 post-process)
5676 "Call `org-export-as' with output to a specified buffer.
5678 BACKEND is either an export back-end, as returned by, e.g.,
5679 `org-export-create-backend', or a symbol referring to
5680 a registered back-end.
5682 BUFFER is the name of the output buffer. If it already exists,
5683 it will be erased first, otherwise, it will be created.
5685 A non-nil optional argument ASYNC means the process should happen
5686 asynchronously. The resulting buffer should then be accessible
5687 through the `org-export-stack' interface. When ASYNC is nil, the
5688 buffer is displayed if `org-export-show-temporary-export-buffer'
5689 is non-nil.
5691 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5692 EXT-PLIST are similar to those used in `org-export-as', which
5693 see.
5695 Optional argument POST-PROCESS is a function which should accept
5696 no argument. It is always called within the current process,
5697 from BUFFER, with point at its beginning. Export back-ends can
5698 use it to set a major mode there, e.g,
5700 \(defun org-latex-export-as-latex
5701 \(&optional async subtreep visible-only body-only ext-plist)
5702 \(interactive)
5704 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5706 This function returns BUFFER."
5734 buffer)))
5736 ;;;###autoload
5739 post-process)
5740 "Call `org-export-as' with output to a specified file.
5742 BACKEND is either an export back-end, as returned by, e.g.,
5743 `org-export-create-backend', or a symbol referring to
5744 a registered back-end. FILE is the name of the output file, as
5745 a string.
5747 A non-nil optional argument ASYNC means the process should happen
5748 asynchronously. The resulting buffer will then be accessible
5749 through the `org-export-stack' interface.
5751 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5752 EXT-PLIST are similar to those used in `org-export-as', which
5753 see.
5755 Optional argument POST-PROCESS is called with FILE as its
5756 argument and happens asynchronously when ASYNC is non-nil. It
5757 has to return a file name, or nil. Export back-ends can use this
5758 to send the output file through additional processing, e.g,
5760 \(defun org-latex-export-to-latex
5761 \(&optional async subtreep visible-only body-only ext-plist)
5762 \(interactive)
5764 \(org-export-to-file 'latex outfile
5765 async subtreep visible-only body-only ext-plist
5766 \(lambda (file) (org-latex-compile file)))
5768 The function returns either a file name returned by POST-PROCESS,
5769 or FILE."
5787 backend subtreep visible-only body-only ext-plist)))
5794 ;; Get proper return value.
5796 file))))))
5799 "Return output file's name according to buffer specifications.
5801 EXTENSION is a string representing the output file extension,
5802 with the leading dot.
5804 With a non-nil optional argument SUBTREEP, try to determine
5806 of subtree at point.
5808 When optional argument PUB-DIR is set, use it as the publishing
5809 directory.
5811 When optional argument VISIBLE-ONLY is non-nil, don't export
5812 contents of hidden elements.
5814 Return file name as a string."
5817 ;; File name may come from EXPORT_FILE_NAME subtree
5818 ;; property, assuming point is at beginning of said
5819 ;; sub-tree.
5826 ;; File name may be extracted from buffer's associated
5827 ;; file, if any.
5829 ;; Can't determine file name on our own: Ask user.
5833 "Output file: " pub-dir nil nil nil
5837 ;; Build file name. Enforce EXTENSION over whatever user
5838 ;; may have come up with. PUB-DIR, if defined, always has
5839 ;; precedence over any provided path.
5844 extension))
5847 ;; If writing to OUTPUT-FILE would overwrite original file, append
5848 ;; EXTENSION another time to final name.
5851 output-file)))
5854 "Add a new result to export stack if not present already.
5856 SOURCE is a buffer or a file name containing export results.
5857 BACKEND is a symbol representing export back-end used to generate
5858 it.
5860 Entries already pointing to SOURCE and unavailable entries are
5861 removed beforehand. Return the new stack."
5867 "Menu for asynchronous export results and running processes."
5877 "Return source from export results at point in stack."
5884 source
5885 ;; SOURCE is not consistent with current line. The stack
5886 ;; view is outdated.
5890 "Remove all entries from export stack."
5895 "Refresh the asynchronous export stack.
5896 DUMMY is ignored. Unavailable sources are removed from the list.
5897 Return the new stack."
5907 ;; Back-end.
5909 ;; Age.
5912 ;; Compute age of the results.
5914 "%4h:%.2m "
5916 ;; Source.
5921 ;; Clear stack from exited processes, dead buffers or
5922 ;; non-existent files.
5934 "Remove export results at point from stack.
5935 If optional argument SOURCE is non-nil, remove it instead."
5940 org-export-stack-contents))))
5943 "View export results at point in stack.
5944 With an optional prefix argument IN-EMACS, force viewing files
5945 within Emacs."
5959 (define-key km "p" 'previous-line)
5960 (define-key km "\C-p" 'previous-line)
5961 (define-key km "\C-?" 'previous-line)
5962 (define-key km [up] 'previous-line)
5963 (define-key km "C" 'org-export-stack-clear)
5964 (define-key km "v" 'org-export-stack-view)
5965 (define-key km (kbd "RET") 'org-export-stack-view)
5966 (define-key km "d" 'org-export-stack-remove)
5967 km)
5968 "Keymap for Org Export Stack.")
5970 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5971 "Mode for displaying asynchronous export stack.
5974 stack.
5976 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5977 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5978 stack completely.
5980 Removing entries in an Org Export Stack buffer doesn't affect
5981 files or buffers, only the display.
5984 (abbrev-mode 0)
5985 (auto-fill-mode 0)
5986 (setq buffer-read-only t
5987 buffer-undo-list t
5988 truncate-lines t
5989 header-line-format
5990 '(:eval
5991 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5992 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5993 (set (make-local-variable 'revert-buffer-function)
5994 'org-export-stack-refresh))
5997 \f
5998 ;;; The Dispatcher
5999 ;;
6000 ;; `org-export-dispatch' is the standard interactive way to start an
6001 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6002 ;; for its interface, which, in turn, delegates response to key
6003 ;; pressed to `org-export--dispatch-action'.
6005 ;;;###autoload
6006 (defun org-export-dispatch (&optional arg)
6007 "Export dispatcher for Org mode.
6009 It provides an access to common export related tasks in a buffer.
6010 Its interface comes in two flavors: standard and expert.
6012 While both share the same set of bindings, only the former
6013 displays the valid keys associations in a dedicated buffer.
6014 Scrolling (resp. line-wise motion) in this buffer is done with
6015 SPC and DEL (resp. C-n and C-p) keys.
6017 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6018 flavor or the other.
6021 of options used back then, on the current buffer.
6023 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6024 (interactive "P")
6025 (let* ((input
6026 (cond ((equal arg '(16)) '(stack))
6027 ((and arg org-export-dispatch-last-action))
6028 (t (save-window-excursion
6029 (unwind-protect
6030 (progn
6031 ;; Remember where we are
6032 (move-marker org-export-dispatch-last-position
6033 (point)
6034 (org-base-buffer (current-buffer)))
6035 ;; Get and store an export command
6036 (setq org-export-dispatch-last-action
6037 (org-export--dispatch-ui
6038 (list org-export-initial-scope
6039 (and org-export-in-background 'async))
6040 nil
6041 org-export-dispatch-use-expert-ui)))
6042 (and (get-buffer "*Org Export Dispatcher*")
6043 (kill-buffer "*Org Export Dispatcher*")))))))
6044 (action (car input))
6045 (optns (cdr input)))
6046 (unless (memq 'subtree optns)
6047 (move-marker org-export-dispatch-last-position nil))
6048 (case action
6049 ;; First handle special hard-coded actions.
6050 (template (org-export-insert-default-template nil optns))
6051 (stack (org-export-stack))
6052 (publish-current-file
6053 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6054 (publish-current-project
6055 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6056 (publish-choose-project
6057 (org-publish (assoc (org-icompleting-read
6058 "Publish project: "
6059 org-publish-project-alist nil t)
6060 org-publish-project-alist)
6061 (memq 'force optns)
6062 (memq 'async optns)))
6063 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6064 (otherwise
6065 (save-excursion
6066 (when arg
6067 ;; Repeating command, maybe move cursor to restore subtree
6068 ;; context.
6069 (if (eq (marker-buffer org-export-dispatch-last-position)
6070 (org-base-buffer (current-buffer)))
6071 (goto-char org-export-dispatch-last-position)
6072 ;; We are in a different buffer, forget position.
6073 (move-marker org-export-dispatch-last-position nil)))
6074 (funcall action
6075 ;; Return a symbol instead of a list to ease
6076 ;; asynchronous export macro use.
6077 (and (memq 'async optns) t)
6078 (and (memq 'subtree optns) t)
6079 (and (memq 'visible optns) t)
6080 (and (memq 'body optns) t)))))))
6082 (defun org-export--dispatch-ui (options first-key expertp)
6083 "Handle interface for `org-export-dispatch'.
6085 OPTIONS is a list containing current interactive options set for
6086 export. It can contain any of the following symbols:
6087 `body' toggles a body-only export
6088 `subtree' restricts export to current subtree
6089 `visible' restricts export to visible part of buffer.
6090 `force' force publishing files.
6091 `async' use asynchronous export process
6093 FIRST-KEY is the key pressed to select the first level menu. It
6094 is nil when this menu hasn't been selected yet.
6096 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6097 buffer is provided, but indications about currently active
6098 options are given in the prompt. Moreover, \[?] allows to switch
6099 back to standard interface."
6100 (let* ((fontify-key
6101 (lambda (key &optional access-key)
6102 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6103 ;; non-nil is the required first-level key to activate
6104 ;; KEY. When its value is t, activate KEY independently
6105 ;; on the first key, if any. A nil value means KEY will
6106 ;; only be activated at first level.
6107 (if (or (eq access-key t) (eq access-key first-key))
6108 (org-propertize key 'face 'org-warning)
6109 key)))
6110 (fontify-value
6111 (lambda (value)
6112 ;; Fontify VALUE string.
6113 (org-propertize value 'face 'font-lock-variable-name-face)))
6114 ;; Prepare menu entries by extracting them from registered
6115 ;; back-ends and sorting them by access key and by ordinal,
6116 ;; if any.
6117 (entries
6118 (sort (sort (delq nil
6119 (mapcar 'org-export-backend-menu
6120 org-export--registered-backends))
6121 (lambda (a b)
6122 (let ((key-a (nth 1 a))
6123 (key-b (nth 1 b)))
6124 (cond ((and (numberp key-a) (numberp key-b))
6125 (< key-a key-b))
6126 ((numberp key-b) t)))))
6127 'car-less-than-car))
6128 ;; Compute a list of allowed keys based on the first key
6129 ;; pressed, if any. Some keys
6130 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6131 ;; available.
6132 (allowed-keys
6133 (nconc (list 2 22 19 6 1)
6134 (if (not first-key) (org-uniquify (mapcar 'car entries))
6135 (let (sub-menu)
6136 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6137 (when (eq (car entry) first-key)
6138 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6139 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6140 ((not first-key) (list ?P)))
6141 (list ?& ?#)
6142 (when expertp (list ??))
6143 (list ?q)))
6144 ;; Build the help menu for standard UI.
6145 (help
6146 (unless expertp
6147 (concat
6148 ;; Options are hard-coded.
6149 (format "[%s] Body only: %s [%s] Visible only: %s
6150 \[%s] Export scope: %s [%s] Force publishing: %s
6152 (funcall fontify-key "C-b" t)
6153 (funcall fontify-value
6154 (if (memq 'body options) "On " "Off"))
6155 (funcall fontify-key "C-v" t)
6156 (funcall fontify-value
6157 (if (memq 'visible options) "On " "Off"))
6158 (funcall fontify-key "C-s" t)
6159 (funcall fontify-value
6160 (if (memq 'subtree options) "Subtree" "Buffer "))
6161 (funcall fontify-key "C-f" t)
6162 (funcall fontify-value
6163 (if (memq 'force options) "On " "Off"))
6164 (funcall fontify-key "C-a" t)
6165 (funcall fontify-value
6166 (if (memq 'async options) "On " "Off")))
6167 ;; Display registered back-end entries. When a key
6168 ;; appears for the second time, do not create another
6169 ;; entry, but append its sub-menu to existing menu.
6170 (let (last-key)
6171 (mapconcat
6172 (lambda (entry)
6173 (let ((top-key (car entry)))
6174 (concat
6175 (unless (eq top-key last-key)
6176 (setq last-key top-key)
6178 (funcall fontify-key (char-to-string top-key))
6179 (nth 1 entry)))
6180 (let ((sub-menu (nth 2 entry)))
6181 (unless (functionp sub-menu)
6182 ;; Split sub-menu into two columns.
6183 (let ((index -1))
6184 (concat
6185 (mapconcat
6186 (lambda (sub-entry)
6187 (incf index)
6188 (format
6189 (if (zerop (mod index 2)) " [%s] %-26s"
6191 (funcall fontify-key
6192 (char-to-string (car sub-entry))
6193 top-key)
6194 (nth 1 sub-entry)))
6195 sub-menu "")
6197 entries ""))
6198 ;; Publishing menu is hard-coded.
6200 [%s] Current file [%s] Current project
6202 (funcall fontify-key "P")
6203 (funcall fontify-key "f" ?P)
6204 (funcall fontify-key "p" ?P)
6205 (funcall fontify-key "x" ?P)
6206 (funcall fontify-key "a" ?P))
6208 (funcall fontify-key "&" t)
6209 (funcall fontify-key "#" t))
6210 (format "[%s] %s"
6211 (funcall fontify-key "q" t)
6212 (if first-key "Main menu" "Exit")))))
6213 ;; Build prompts for both standard and expert UI.
6214 (standard-prompt (unless expertp "Export command: "))
6215 (expert-prompt
6216 (when expertp
6217 (format
6218 "Export command (C-%s%s%s%s%s) [%s]: "
6219 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6220 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6221 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6222 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6223 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6224 (mapconcat (lambda (k)
6225 ;; Strip control characters.
6226 (unless (< k 27) (char-to-string k)))
6227 allowed-keys "")))))
6228 ;; With expert UI, just read key with a fancy prompt. In standard
6229 ;; UI, display an intrusive help buffer.
6230 (if expertp
6231 (org-export--dispatch-action
6232 expert-prompt allowed-keys entries options first-key expertp)
6233 ;; At first call, create frame layout in order to display menu.
6234 (unless (get-buffer "*Org Export Dispatcher*")
6235 (delete-other-windows)
6236 (org-switch-to-buffer-other-window
6237 (get-buffer-create "*Org Export Dispatcher*"))
6238 (setq cursor-type nil
6239 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6240 ;; Make sure that invisible cursor will not highlight square
6241 ;; brackets.
6242 (set-syntax-table (copy-syntax-table))
6243 (modify-syntax-entry ?\[ "w"))
6244 ;; At this point, the buffer containing the menu exists and is
6245 ;; visible in the current window. So, refresh it.
6246 (with-current-buffer "*Org Export Dispatcher*"
6247 ;; Refresh help. Maintain display continuity by re-visiting
6248 ;; previous window position.
6249 (let ((pos (window-start)))
6250 (erase-buffer)
6251 (insert help)
6252 (set-window-start nil pos)))
6253 (org-fit-window-to-buffer)
6254 (org-export--dispatch-action
6255 standard-prompt allowed-keys entries options first-key expertp))))
6257 (defun org-export--dispatch-action
6258 (prompt allowed-keys entries options first-key expertp)
6259 "Read a character from command input and act accordingly.
6261 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6262 a list of characters available at a given step in the process.
6263 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6264 EXPERTP are the same as defined in `org-export--dispatch-ui',
6265 which see.
6267 Toggle export options when required. Otherwise, return value is
6268 a list with action as CAR and a list of interactive export
6269 options as CDR."
6270 (let (key)
6271 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6272 ;; C-p, SPC, DEL).
6273 (while (and (setq key (read-char-exclusive prompt))
6274 (not expertp)
6275 (memq key '(14 16 ?\s ?\d)))
6276 (case key
6277 (14 (if (not (pos-visible-in-window-p (point-max)))
6278 (ignore-errors (scroll-up 1))
6279 (message "End of buffer")
6280 (sit-for 1)))
6281 (16 (if (not (pos-visible-in-window-p (point-min)))
6282 (ignore-errors (scroll-down 1))
6283 (message "Beginning of buffer")
6284 (sit-for 1)))
6285 (?\s (if (not (pos-visible-in-window-p (point-max)))
6286 (scroll-up nil)
6287 (message "End of buffer")
6288 (sit-for 1)))
6289 (?\d (if (not (pos-visible-in-window-p (point-min)))
6290 (scroll-down nil)
6291 (message "Beginning of buffer")
6292 (sit-for 1)))))
6293 (cond
6294 ;; Ignore undefined associations.
6295 ((not (memq key allowed-keys))
6296 (ding)
6297 (unless expertp (message "Invalid key") (sit-for 1))
6298 (org-export--dispatch-ui options first-key expertp))
6299 ;; q key at first level aborts export. At second level, cancel
6300 ;; first key instead.
6301 ((eq key ?q) (if (not first-key) (error "Export aborted")
6302 (org-export--dispatch-ui options nil expertp)))
6303 ;; Help key: Switch back to standard interface if expert UI was
6304 ;; active.
6305 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6306 ;; Send request for template insertion along with export scope.
6307 ((eq key ?#) (cons 'template (memq 'subtree options)))
6308 ;; Switch to asynchronous export stack.
6309 ((eq key ?&) '(stack))
6310 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6311 ((memq key '(2 22 19 6 1))
6312 (org-export--dispatch-ui
6313 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6314 (6 'force) (1 'async))))
6315 (if (memq option options) (remq option options)
6316 (cons option options)))
6317 first-key expertp))
6318 ;; Action selected: Send key and options back to
6319 ;; `org-export-dispatch'.
6320 ((or first-key (functionp (nth 2 (assq key entries))))
6321 (cons (cond
6322 ((not first-key) (nth 2 (assq key entries)))
6323 ;; Publishing actions are hard-coded. Send a special
6324 ;; signal to `org-export-dispatch'.
6325 ((eq first-key ?P)
6326 (case key
6327 (?f 'publish-current-file)
6328 (?p 'publish-current-project)
6329 (?x 'publish-choose-project)
6330 (?a 'publish-all)))
6331 ;; Return first action associated to FIRST-KEY + KEY
6332 ;; path. Indeed, derived backends can share the same
6333 ;; FIRST-KEY.
6334 (t (catch 'found
6335 (mapc (lambda (entry)
6336 (let ((match (assq key (nth 2 entry))))
6337 (when match (throw 'found (nth 2 match)))))
6338 (member (assq first-key entries) entries)))))
6339 options))
6340 ;; Otherwise, enter sub-menu.
6341 (t (org-export--dispatch-ui options key expertp)))))
6345 (provide 'ox)
6347 ;; Local variables:
6348 ;; generated-autoload-file: "org-loaddefs.el"
6349 ;; End:
6351 ;;; ox.el ends here