| blob | 28aed704d320e37bde862ed7a6109df0543c9f9d |
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
241 "Alist between filters properties and initial values.
243 The key of each association is a property name accessible through
244 the communication channel. Its value is a configurable global
245 variable defining initial filters.
247 This list is meant to install user specified filters. Back-end
248 developers may install their own filters using
249 `org-export-define-backend'. Filters defined there will always
250 be prepended to the current list, so they always get applied
259 "Default rule for link matching an inline image.
260 This rule applies to links with no description. By default, it
261 will be considered as an inline image if it targets a local file
264 See `org-export-inline-image-p' for more information about
268 "Non-nil means asynchronous export process should leave data behind.
272 located in `temporary-file-directory'.
274 When non-nil, it will also set `debug-on-error' to a non-nil
278 "Record asynchronously generated export results and processes.
279 This is an alist: its CAR is the source of the
280 result (destination file or buffer for a finished process,
281 original buffer for a running one) and its CDR is a list
282 containing the back-end used, as a symbol, and either a process
283 or the time at which it finished. It is used to build the menu
287 "List of backends currently available in the exporter.
288 This variable is set with `org-export-define-backend' and
292 "Last command called from the dispatcher.
293 The value should be a list. Its CAR is the action, as a symbol,
297 "The position where the last export command was created using the dispatcher.
298 This marker will be used with `C-u C-c C-e' to make sure export repetition
301 ;; For compatibility with Org < 8
303 "Name, if any, of the back-end used during an export process.
305 Its value is a symbol such as `html', `latex', `ascii', or nil if
306 the back-end is anonymous (see `org-export-create-backend') or if
307 there is no export process in progress.
309 It can be used to teach Babel blocks how to act differently
312 \f
313 ;;; User-configurable Variables
314 ;;
315 ;; Configuration for the masses.
316 ;;
317 ;; They should never be accessed directly, as their value is to be
318 ;; stored in a property list (cf. `org-export-options-alist').
319 ;; Back-ends will read their value from there instead.
322 "Options for exporting Org mode files."
327 "General options for export engine."
332 "Whether sub-trees with the ARCHIVE tag should be exported.
334 This can have three different values:
335 nil Do not export, pretend this tree is not present.
336 t Do export the entire tree.
337 `headline' Only export the headline, but skip the tree below it.
339 This option can also be set with the OPTIONS keyword,
348 "Non-nil means insert author name into the exported file.
349 This option can also be set with the OPTIONS keyword,
355 "Non-nil means export CLOCK keywords.
356 This option can also be set with the OPTIONS keyword,
362 "Non-nil means the postamble should contain a creator sentence.
364 The sentence can be set in `org-export-creator-string' and
367 If the value is `comment' insert it as a comment."
375 "Non-nil means insert date in the exported document.
376 This option can also be set with the OPTIONS keyword,
382 "Time-stamp format string to use for DATE keyword.
384 The format string, when specified, only applies if date consists
385 in a single time-stamp. Otherwise its value will be ignored.
387 See `format-time-string' for details on how to build this
388 string."
396 emacs-version
398 "Information about the creator of the document.
399 This option can also be set on with the CREATOR keyword."
404 "Non-nil means export contents of standard drawers.
406 When t, all drawers are exported. This may also be a list of
407 drawer names to export, as strings. If that list starts with
408 `not', only drawers with such names will be ignored.
410 This variable doesn't apply to properties drawers. See
411 `org-export-with-properties' instead.
413 This option can also be set with the OPTIONS keyword,
426 :inline t
430 "Non-nil means insert author email into the exported file.
431 This option can also be set with the OPTIONS keyword,
437 "Non-nil means interpret *word*, /word/, _word_ and +word+.
439 If the export target supports emphasizing text, the word will be
440 typeset in bold, italic, with an underline or strike-through,
441 respectively.
443 This option can also be set with the OPTIONS keyword,
449 "Tags that exclude a tree from export.
451 All trees carrying any of these tags will be excluded from
452 export. This is without condition, so even subtrees inside that
453 carry one of the `org-export-select-tags' will be removed.
455 This option can also be set with the EXCLUDE_TAGS keyword."
461 This option can also be set with the OPTIONS keyword,
469 "Non-nil means Org footnotes should be exported.
470 This option can also be set with the OPTIONS keyword,
476 "Non-nil means process LaTeX environments and fragments.
478 This option can also be set with the OPTIONS line,
481 nil Ignore math snippets.
482 `verbatim' Keep everything in verbatim.
483 t Allow export of math snippets."
493 "The last level which is still exported as a headline.
495 Inferior levels will usually produce itemize or enumerate lists
496 when exported, but back-end behaviour may differ.
498 This option can also be set with the OPTIONS keyword,
504 "The default language for export and clocktable translations, as a string.
505 This may have an association in
506 `org-clock-clocktable-language-setup',
507 `org-export-smart-quotes-alist' and `org-export-dictionary'.
508 This option can also be set with the LANGUAGE keyword."
513 "Non-nil means preserve all line breaks when exporting.
514 This option can also be set with the OPTIONS keyword,
520 "Non-nil means interpret entities when exporting.
523 Å.
525 For a list of supported names, see the constant `org-entities'
526 and the user option `org-entities-user'.
528 This option can also be set with the OPTIONS keyword,
534 "Non-nil means inlinetasks should be exported.
535 This option can also be set with the OPTIONS keyword,
543 "Non-nil means include planning info in export.
545 Planning info is the line containing either SCHEDULED:,
546 DEADLINE:, CLOSED: time-stamps, or a combination of them.
548 This option can also be set with the OPTIONS keyword,
556 "Non-nil means include priority cookies in export.
557 This option can also be set with the OPTIONS keyword,
563 "Non-nil means export contents of properties drawers.
565 When t, all properties are exported. This may also be a list of
566 properties to export, as strings.
568 This option can also be set with the OPTIONS keyword,
580 "Non-nil means add section numbers to headlines when exporting.
582 When set to an integer n, numbering will only happen for
583 headlines whose relative level is higher or equal to n.
585 This option can also be set with the OPTIONS keyword,
591 "Tags that select a tree for export.
593 If any such tag is found in a buffer, all trees that do not carry
594 one of these tags will be ignored during export. Inside trees
595 that are selected like this, you can still deselect a subtree by
596 tagging it with one of the `org-export-exclude-tags'.
598 This option can also be set with the SELECT_TAGS keyword."
603 "Non-nil means activate smart quotes during export.
604 This option can also be set with the OPTIONS keyword,
607 When setting this to non-nil, you need to take care of
608 using the correct Babel package when exporting to LaTeX.
609 E.g., you can load Babel for french like this:
620 When this option is turned on, these strings will be exported as:
622 Org HTML LaTeX UTF-8
623 -----+----------+--------+-------
625 -- – -- –
626 --- — --- —
629 This option can also be set with the OPTIONS keyword,
635 "Non-nil means include statistics cookies in export.
636 This option can also be set with the OPTIONS keyword,
646 If you want to control how Org displays those characters, see
647 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
648 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
649 it is not anymore.
651 When this option is turned on, you can use TeX-like syntax for
652 sub- and superscripts and see them exported correctly.
654 You can also set the option with #+OPTIONS: ^:t
657 single item - so grouping with {} is normally not needed. For
658 example, the following things will be parsed as single sub- or
659 superscripts:
661 10^24 or 10^tau several digits will be considered 1 item.
662 10^-12 or 10^-tau a leading sign with digits or a word
663 x^2-y^3 will be read as x^2 - y^3, because items are
664 terminated by almost any nonword/nondigit char.
665 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
667 Still, ambiguity is possible. So when in doubt, use {} to enclose
668 the sub/superscript. If you set this variable to the symbol `{}',
669 the braces are *required* in order to trigger interpretations as
671 frequently in plain text."
681 "Non-nil means create a table of contents in exported files.
683 The TOC contains headlines with levels up
684 to`org-export-headline-levels'. When an integer, include levels
685 up to N in the toc, this may then be different from
686 `org-export-headline-levels', but it will not be allowed to be
687 larger than the number of headline levels. When nil, no table of
688 contents is made.
690 This option can also be set with the OPTIONS keyword,
699 "Non-nil means export tables.
700 This option can also be set with the OPTIONS keyword,
708 "If nil, do not export tags, just remove them from headlines.
710 If this is the symbol `not-in-toc', tags will be removed from
711 table of contents entries, but still be shown in the headlines of
712 the document.
714 This option can also be set with the OPTIONS keyword,
723 "Non-nil means include TODO items for export.
725 This may have the following values:
726 t include tasks independent of state.
727 `todo' include only tasks that are not yet done.
728 `done' include only tasks that are already done.
729 nil ignore all tasks.
730 list of keywords include tasks with these keywords.
732 This option can also be set with the OPTIONS keyword,
744 "Non-nil means insert a time stamp into the exported file.
745 The time stamp shows when the file was created. This option can
751 "Non nil means allow timestamps in export.
753 It can be set to any of the following values:
754 t export all timestamps.
755 `active' export active timestamps only.
756 `inactive' export inactive timestamps only.
757 nil do not export timestamps
759 This only applies to timestamps isolated in a paragraph
760 containing only timestamps. Other timestamps are always
761 exported.
763 This option can also be set with the OPTIONS keyword, e.g.
773 "Non-nil means include TODO keywords in export.
774 When nil, remove all these keywords from the export. This option
780 "Non-nil means BIND keywords can define local variable values.
781 This is a potential security risk, which is why the default value
782 is nil. You can also allow them through local buffer variables."
789 "Alist between export snippets back-ends and exporter back-ends.
791 This variable allows to provide shortcuts for export snippets.
795 HTML code while every other back-end will ignore it."
804 "Coding system for the exported file."
811 "Should we push exported content to the kill ring?"
820 "The initial scope when exporting with `org-export-dispatch'.
821 This variable can be either set to `buffer' or `subtree'."
828 "Non-nil means show buffer after exporting to temp buffer.
829 When Org exports to a file, the buffer visiting that file is ever
830 shown, but remains buried. However, when exporting to
831 a temporary buffer, that buffer is popped up in a second window.
832 When this variable is nil, the buffer remains buried also in
833 these cases."
838 "Non-nil means export and publishing commands will run in background.
839 Results from an asynchronous export are never displayed
847 "File used to initialize external export process.
849 Value must be either nil or an absolute file name. When nil, the
850 external process is launched like a regular Emacs session,
851 loading user's initialization file and any site specific
852 configuration. If a file is provided, it, and only it, is loaded
853 at start-up.
855 Therefore, using a specific configuration makes the process to
856 load faster and the export more portable."
865 "Non-nil means using a non-intrusive `org-export-dispatch'.
866 In that case, no help buffer is displayed. Though, an indicator
872 asynchronous). Also, \[?] allows to switch back to standard
873 mode."
880 \f
881 ;;; Defining Back-ends
882 ;;
883 ;; An export back-end is a structure with `org-export-backend' type
884 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
885 ;; and `menu' slots.
886 ;;
887 ;; At the lowest level, a back-end is created with
888 ;; `org-export-create-backend' function.
889 ;;
890 ;; A named back-end can be registered with
891 ;; `org-export-register-backend' function. A registered back-end can
892 ;; later be referred to by its name, with `org-export-get-backend'
893 ;; function. Also, such a back-end can become the parent of a derived
894 ;; back-end from which slot values will be inherited by default.
895 ;; `org-export-derived-backend-p' can check if a given back-end is
896 ;; derived from a list of back-end names.
897 ;;
898 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
899 ;; `org-export-get-all-filters' return the full alist of transcoders,
900 ;; options and filters, including those inherited from ancestors.
901 ;;
902 ;; At a higher level, `org-export-define-backend' is the standard way
903 ;; to define an export back-end. If the new back-end is similar to
904 ;; a registered back-end, `org-export-define-derived-backend' may be
905 ;; used instead.
906 ;;
907 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
908 ;; when a given back-end hasn't been registered yet.
912 name parent transcoders options filters blocks menu)
915 "Return export back-end named after NAME.
916 NAME is a symbol. Return nil if no such back-end is found."
923 "Register BACKEND as a known export back-end.
924 BACKEND is a structure with `org-export-backend' type."
925 ;; Refuse to register an unnamed back-end.
928 ;; Refuse to register a back-end with an unknown parent.
932 ;; Register dedicated export blocks in the parser.
936 ;; If a back-end with the same name as BACKEND is already
937 ;; registered, replace it with BACKEND. Otherwise, simply add
938 ;; BACKEND to the list of registered back-ends.
944 "Signal an error if BACKEND isn't defined."
949 "Non-nil if BACKEND is derived from one of BACKENDS.
950 BACKEND is an export back-end, as returned by, e.g.,
951 `org-export-create-backend', or a symbol referring to
952 a registered back-end. BACKENDS is constituted of symbols."
964 "Return full translation table for BACKEND.
966 BACKEND is an export back-end, as return by, e.g,,
967 `org-export-create-backend'. Return value is an alist where
968 keys are element or object types, as symbols, and values are
969 transcoders.
971 Unlike to `org-export-backend-transcoders', this function
972 also returns transcoders inherited from parent back-ends,
973 if any."
977 parent)
982 transcoders)))
985 "Return export options for BACKEND.
987 BACKEND is an export back-end, as return by, e.g,,
988 `org-export-create-backend'. See `org-export-options-alist'
989 for the shape of the return value.
991 Unlike to `org-export-backend-options', this function also
992 returns options inherited from parent back-ends, if any."
996 parent)
1000 options)))
1003 "Return complete list of filters for BACKEND.
1005 BACKEND is an export back-end, as return by, e.g,,
1006 `org-export-create-backend'. Return value is an alist where
1007 keys are symbols and values lists of functions.
1009 Unlike to `org-export-backend-filters', this function also
1010 returns filters inherited from parent back-ends, if any."
1014 parent)
1018 filters)))
1021 "Define a new back-end BACKEND.
1023 TRANSCODERS is an alist between object or element types and
1024 functions handling them.
1026 These functions should return a string without any trailing
1027 space, or nil. They must accept three arguments: the object or
1028 element itself, its contents or nil when it isn't recursive and
1029 the property list used as a communication channel.
1031 Contents, when not nil, are stripped from any global indentation
1032 \(although the relative one is preserved). They also always end
1033 with a single newline character.
1035 If, for a given type, no function is found, that element or
1036 object type will simply be ignored, along with any blank line or
1037 white space at its end. The same will happen if the function
1038 returns the nil value. If that function returns the empty
1039 string, the type will be ignored, but the blank lines or white
1040 spaces will be kept.
1042 In addition to element and object types, one function can be
1043 associated to the `template' (or `inner-template') symbol and
1044 another one to the `plain-text' symbol.
1046 The former returns the final transcoded string, and can be used
1047 to add a preamble and a postamble to document's body. It must
1048 accept two arguments: the transcoded string and the property list
1049 containing export options. A function associated to `template'
1051 A function associated to `inner-template' is always applied.
1053 The latter, when defined, is to be called on every text not
1054 recognized as an element or an object. It must accept two
1055 arguments: the text string and the information channel. It is an
1056 appropriate place to protect special chars relative to the
1057 back-end.
1059 BODY can start with pre-defined keyword arguments. The following
1060 keywords are understood:
1062 :export-block
1064 String, or list of strings, representing block names that
1065 will not be parsed. This is used to specify blocks that will
1066 contain raw code specific to the back-end. These blocks
1067 still have to be handled by the relative `export-block' type
1068 translator.
1070 :filters-alist
1072 Alist between filters and function, or list of functions,
1073 specific to the back-end. See `org-export-filters-alist' for
1074 a list of all allowed filters. Filters defined here
1075 shouldn't make a back-end test, as it may prevent back-ends
1076 derived from this one to behave properly.
1078 :menu-entry
1080 Menu entry for the export dispatcher. It should be a list
1081 like:
1083 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1085 where :
1087 KEY is a free character selecting the back-end.
1089 DESCRIPTION-OR-ORDINAL is either a string or a number.
1091 If it is a string, is will be used to name the back-end in
1092 its menu entry. If it is a number, the following menu will
1093 be displayed as a sub-menu of the back-end with the same
1094 KEY. Also, the number will be used to determine in which
1095 order such sub-menus will appear (lowest first).
1097 ACTION-OR-MENU is either a function or an alist.
1099 If it is an action, it will be called with four
1100 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1101 BODY-ONLY. See `org-export-as' for further explanations on
1102 some of them.
1104 If it is an alist, associations should follow the
1105 pattern:
1107 '(KEY DESCRIPTION ACTION)
1109 where KEY, DESCRIPTION and ACTION are described above.
1111 Valid values include:
1115 or
1120 \(lambda (a s v b)
1121 \(if a (org-latex-export-to-pdf t s v b)
1122 \(org-open-file
1123 \(org-latex-export-to-pdf nil s v b)))))))
1125 or the following, which will be added to the previous
1126 sub-menu,
1128 '(?l 1
1132 :options-alist
1134 Alist between back-end specific properties introduced in
1135 communication channel and how their value are acquired. See
1136 `org-export-options-alist' for more information about
1137 structure of the values."
1151 :transcoders transcoders
1152 :options options
1153 :filters filters
1154 :blocks blocks
1158 "Create a new back-end as a variant of an existing one.
1160 CHILD is the name of the derived back-end. PARENT is the name of
1161 the parent back-end.
1163 BODY can start with pre-defined keyword arguments. The following
1164 keywords are understood:
1166 :export-block
1168 String, or list of strings, representing block names that
1169 will not be parsed. This is used to specify blocks that will
1170 contain raw code specific to the back-end. These blocks
1171 still have to be handled by the relative `export-block' type
1172 translator.
1174 :filters-alist
1176 Alist of filters that will overwrite or complete filters
1177 defined in PARENT back-end. See `org-export-filters-alist'
1178 for a list of allowed filters.
1180 :menu-entry
1182 Menu entry for the export dispatcher. See
1183 `org-export-define-backend' for more information about the
1184 expected value.
1186 :options-alist
1188 Alist of back-end specific properties that will overwrite or
1189 complete those defined in PARENT back-end. Refer to
1190 `org-export-options-alist' for more information about
1191 structure of the values.
1193 :translate-alist
1195 Alist of element and object types and transcoders that will
1196 overwrite or complete transcode table from PARENT back-end.
1197 Refer to `org-export-define-backend' for detailed information
1198 about transcoders.
1201 as a variant of `latex' back-end with a custom template function:
1203 \(org-export-define-derived-backend 'my-latex 'latex
1204 :translate-alist '((template . my-latex-template-fun)))
1206 The back-end could then be called with, for example:
1223 :parent parent
1224 :transcoders transcoders
1225 :options options
1226 :filters filters
1227 :blocks blocks
1231 \f
1232 ;;; The Communication Channel
1233 ;;
1234 ;; During export process, every function has access to a number of
1235 ;; properties. They are of two types:
1236 ;;
1237 ;; 1. Environment options are collected once at the very beginning of
1238 ;; the process, out of the original buffer and configuration.
1239 ;; Collecting them is handled by `org-export-get-environment'
1240 ;; function.
1241 ;;
1242 ;; Most environment options are defined through the
1243 ;; `org-export-options-alist' variable.
1244 ;;
1245 ;; 2. Tree properties are extracted directly from the parsed tree,
1246 ;; just before export, by `org-export-collect-tree-properties'.
1247 ;;
1248 ;; Here is the full list of properties available during transcode
1249 ;; process, with their category and their value type.
1250 ;;
1251 ;; + `:author' :: Author's name.
1252 ;; - category :: option
1253 ;; - type :: string
1254 ;;
1255 ;; + `:back-end' :: Current back-end used for transcoding.
1256 ;; - category :: tree
1257 ;; - type :: structure
1258 ;;
1259 ;; + `:creator' :: String to write as creation information.
1260 ;; - category :: option
1261 ;; - type :: string
1262 ;;
1263 ;; + `:date' :: String to use as date.
1264 ;; - category :: option
1265 ;; - type :: string
1266 ;;
1267 ;; + `:description' :: Description text for the current data.
1268 ;; - category :: option
1269 ;; - type :: string
1270 ;;
1271 ;; + `:email' :: Author's email.
1272 ;; - category :: option
1273 ;; - type :: string
1274 ;;
1275 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1276 ;; process.
1277 ;; - category :: option
1278 ;; - type :: list of strings
1279 ;;
1280 ;; + `:export-options' :: List of export options available for current
1281 ;; process.
1282 ;; - category :: none
1283 ;; - type :: list of symbols, among `subtree', `body-only' and
1284 ;; `visible-only'.
1285 ;;
1286 ;; + `:exported-data' :: Hash table used for memoizing
1287 ;; `org-export-data'.
1288 ;; - category :: tree
1289 ;; - type :: hash table
1290 ;;
1291 ;; + `:filetags' :: List of global tags for buffer. Used by
1292 ;; `org-export-get-tags' to get tags with inheritance.
1293 ;; - category :: option
1294 ;; - type :: list of strings
1295 ;;
1296 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1297 ;; their definition, as parsed data. Only non-inlined footnotes
1298 ;; are represented in this alist. Also, every definition isn't
1299 ;; guaranteed to be referenced in the parse tree. The purpose of
1300 ;; this property is to preserve definitions from oblivion
1301 ;; (i.e. when the parse tree comes from a part of the original
1302 ;; buffer), it isn't meant for direct use in a back-end. To
1303 ;; retrieve a definition relative to a reference, use
1304 ;; `org-export-get-footnote-definition' instead.
1305 ;; - category :: option
1306 ;; - type :: alist (STRING . LIST)
1307 ;;
1308 ;; + `:headline-levels' :: Maximum level being exported as an
1309 ;; headline. Comparison is done with the relative level of
1310 ;; headlines in the parse tree, not necessarily with their
1311 ;; actual level.
1312 ;; - category :: option
1313 ;; - type :: integer
1314 ;;
1315 ;; + `:headline-offset' :: Difference between relative and real level
1316 ;; of headlines in the parse tree. For example, a value of -1
1317 ;; means a level 2 headline should be considered as level
1318 ;; 1 (cf. `org-export-get-relative-level').
1319 ;; - category :: tree
1320 ;; - type :: integer
1321 ;;
1322 ;; + `:headline-numbering' :: Alist between headlines and their
1323 ;; numbering, as a list of numbers
1324 ;; (cf. `org-export-get-headline-number').
1325 ;; - category :: tree
1326 ;; - type :: alist (INTEGER . LIST)
1327 ;;
1328 ;; + `:id-alist' :: Alist between ID strings and destination file's
1329 ;; path, relative to current directory. It is used by
1330 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1331 ;; external file.
1332 ;; - category :: option
1333 ;; - type :: alist (STRING . STRING)
1334 ;;
1335 ;; + `:ignore-list' :: List of elements and objects that should be
1336 ;; ignored during export.
1337 ;; - category :: tree
1338 ;; - type :: list of elements and objects
1339 ;;
1340 ;; + `:input-buffer' :: Original buffer name.
1341 ;; - category :: option
1342 ;; - type :: string
1343 ;;
1344 ;; + `:input-file' :: Full path to input file, if any.
1345 ;; - category :: option
1346 ;; - type :: string or nil
1347 ;;
1348 ;; + `:keywords' :: List of keywords attached to data.
1349 ;; - category :: option
1350 ;; - type :: string
1351 ;;
1352 ;; + `:language' :: Default language used for translations.
1353 ;; - category :: option
1354 ;; - type :: string
1355 ;;
1356 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1357 ;; transcoding.
1358 ;; - category :: option
1359 ;; - type :: list (as returned by `org-element-parse-buffer')
1360 ;;
1361 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1362 ;; all line breaks.
1363 ;; - category :: option
1364 ;; - type :: symbol (nil, t)
1365 ;;
1366 ;; + `:section-numbers' :: Non-nil means transcoding should add
1367 ;; section numbers to headlines.
1368 ;; - category :: option
1369 ;; - type :: symbol (nil, t)
1370 ;;
1371 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1372 ;; in transcoding. When such a tag is present, subtrees without
1373 ;; it are de facto excluded from the process. See
1374 ;; `use-select-tags'.
1375 ;; - category :: option
1376 ;; - type :: list of strings
1377 ;;
1378 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1379 ;; a time stamp in the output.
1380 ;; - category :: option
1381 ;; - type :: symbol (nil, t)
1382 ;;
1383 ;; + `:translate-alist' :: Alist between element and object types and
1384 ;; transcoding functions relative to the current back-end.
1385 ;; Special keys `inner-template', `template' and `plain-text' are
1386 ;; also possible.
1387 ;; - category :: option
1388 ;; - type :: alist (SYMBOL . FUNCTION)
1389 ;;
1390 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1391 ;; also be transcoded. If it is set to the `headline' symbol,
1392 ;; only the archived headline's name is retained.
1393 ;; - category :: option
1394 ;; - type :: symbol (nil, t, `headline')
1395 ;;
1396 ;; + `:with-author' :: Non-nil means author's name should be included
1397 ;; in the output.
1398 ;; - category :: option
1399 ;; - type :: symbol (nil, t)
1400 ;;
1401 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1402 ;; - category :: option
1403 ;; - type :: symbol (nil, t)
1404 ;;
1405 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1406 ;; inserted at the end of the transcoded string. If the value
1407 ;; is `comment', it should be commented.
1408 ;; - category :: option
1409 ;; - type :: symbol (`comment', nil, t)
1410 ;;
1411 ;; + `:with-date' :: Non-nil means output should contain a date.
1412 ;; - category :: option
1413 ;; - type :. symbol (nil, t)
1414 ;;
1415 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1416 ;; its value is a list of names, only drawers with such names
1417 ;; will be transcoded. If that list starts with `not', drawer
1418 ;; with these names will be skipped.
1419 ;; - category :: option
1420 ;; - type :: symbol (nil, t) or list of strings
1421 ;;
1422 ;; + `:with-email' :: Non-nil means output should contain author's
1423 ;; email.
1424 ;; - category :: option
1425 ;; - type :: symbol (nil, t)
1426 ;;
1427 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1428 ;; interpreted.
1429 ;; - category :: option
1430 ;; - type :: symbol (nil, t)
1431 ;;
1432 ;; + `:with-fixed-width' :: Non-nil if transcoder should export
1433 ;; strings starting with a colon as a fixed-with (verbatim) area.
1434 ;; - category :: option
1435 ;; - type :: symbol (nil, t)
1436 ;;
1437 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1438 ;; footnotes.
1439 ;; - category :: option
1440 ;; - type :: symbol (nil, t)
1441 ;;
1442 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1443 ;; `latex-fragment' objects should appear in export output. When
1444 ;; this property is set to `verbatim', they will be left as-is.
1445 ;; - category :: option
1446 ;; - type :: symbol (`verbatim', nil, t)
1447 ;;
1448 ;; + `:with-planning' :: Non-nil means transcoding should include
1449 ;; planning info.
1450 ;; - category :: option
1451 ;; - type :: symbol (nil, t)
1452 ;;
1453 ;; + `:with-priority' :: Non-nil means transcoding should include
1454 ;; priority cookies.
1455 ;; - category :: option
1456 ;; - type :: symbol (nil, t)
1457 ;;
1458 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1459 ;; plain text.
1460 ;; - category :: option
1461 ;; - type :: symbol (nil, t)
1462 ;;
1463 ;; + `:with-special-strings' :: Non-nil means transcoding should
1464 ;; interpret special strings in plain text.
1465 ;; - category :: option
1466 ;; - type :: symbol (nil, t)
1467 ;;
1468 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1469 ;; interpret subscript and superscript. With a value of "{}",
1470 ;; only interpret those using curly brackets.
1471 ;; - category :: option
1472 ;; - type :: symbol (nil, {}, t)
1473 ;;
1474 ;; + `:with-tables' :: Non-nil means transcoding should export tables.
1475 ;; - category :: option
1476 ;; - type :: symbol (nil, t)
1477 ;;
1478 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1479 ;; headlines. A `not-in-toc' value will remove them from the
1480 ;; table of contents, if any, nonetheless.
1481 ;; - category :: option
1482 ;; - type :: symbol (nil, t, `not-in-toc')
1483 ;;
1484 ;; + `:with-tasks' :: Non-nil means transcoding should include
1485 ;; headlines with a TODO keyword. A `todo' value will only
1486 ;; include headlines with a todo type keyword while a `done'
1487 ;; value will do the contrary. If a list of strings is provided,
1488 ;; only tasks with keywords belonging to that list will be kept.
1489 ;; - category :: option
1490 ;; - type :: symbol (t, todo, done, nil) or list of strings
1491 ;;
1492 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1493 ;; time stamps. Special value `active' (resp. `inactive') ask to
1494 ;; export only active (resp. inactive) timestamps. Otherwise,
1495 ;; completely remove them.
1496 ;; - category :: option
1497 ;; - type :: symbol: (`active', `inactive', t, nil)
1498 ;;
1499 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1500 ;; added to the output. An integer value limits its depth.
1501 ;; - category :: option
1502 ;; - type :: symbol (nil, t or integer)
1503 ;;
1504 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1505 ;; include TODO keywords.
1506 ;; - category :: option
1507 ;; - type :: symbol (nil, t)
1510 ;;;; Environment Options
1511 ;;
1512 ;; Environment options encompass all parameters defined outside the
1513 ;; scope of the parsed data. They come from five sources, in
1514 ;; increasing precedence order:
1515 ;;
1516 ;; - Global variables,
1517 ;; - Buffer's attributes,
1518 ;; - Options keyword symbols,
1519 ;; - Buffer keywords,
1520 ;; - Subtree properties.
1521 ;;
1522 ;; The central internal function with regards to environment options
1523 ;; is `org-export-get-environment'. It updates global variables with
1524 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1525 ;; the different sources.
1526 ;;
1527 ;; The internal functions doing the retrieval are:
1528 ;; `org-export--get-global-options',
1529 ;; `org-export--get-buffer-attributes',
1530 ;; `org-export--parse-option-keyword',
1531 ;; `org-export--get-subtree-options' and
1532 ;; `org-export--get-inbuffer-options'
1533 ;;
1534 ;; Also, `org-export--list-bound-variables' collects bound variables
1535 ;; along with their value in order to set them as buffer local
1536 ;; variables later in the process.
1539 "Collect export options from the current buffer.
1541 Optional argument BACKEND is an export back-end, as returned by
1542 `org-export-create-backend'.
1544 When optional argument SUBTREEP is non-nil, assume the export is
1545 done against the current sub-tree.
1547 Third optional argument EXT-PLIST is a property list with
1548 external parameters overriding Org default settings, but still
1549 inferior to file-local settings."
1550 ;; First install #+BIND variables since these must be set before
1551 ;; global options are read.
1554 ;; Get and prioritize export options...
1556 ;; ... from global variables...
1558 ;; ... from an external property list...
1559 ext-plist
1560 ;; ... from in-buffer settings...
1562 ;; ... and from subtree, when appropriate.
1564 ;; Eventually add misc. properties.
1566 :back-end
1567 backend
1569 :footnote-definition-alist
1570 ;; Footnotes definitions must be collected in the original
1571 ;; buffer, as there's no insurance that they will still be in
1572 ;; the parse tree, due to possible narrowing.
1586 alist))))
1587 alist))
1588 :id-alist
1589 ;; Collect id references.
1600 alist))))
1603 "Parse an OPTIONS line and return values as a plist.
1604 Optional argument BACKEND is an export back-end, as returned by,
1605 e.g., `org-export-create-backend'. It specifies which back-end
1606 specific items to read, if any."
1608 ;; Priority is given to back-end specific options.
1610 org-export-options-alist))
1611 plist)
1620 options))
1622 property
1625 plist))
1628 "Get export options in subtree at point.
1629 Optional argument BACKEND is an export back-end, as returned by,
1630 e.g., `org-export-create-backend'. It specifies back-end used
1631 for export. Return options as a plist."
1632 ;; For each buffer keyword, create a headline property setting the
1633 ;; same property in communication channel. The name for the property
1634 ;; is the keyword with "EXPORT_" appended to it.
1637 ;; Make sure point is at a heading.
1639 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1640 ;; title (with no todo keyword, priority cookie or tag) as its
1641 ;; fallback value.
1647 plist :title
1650 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1654 ;; Handle other keywords. TITLE keyword is excluded as it has
1655 ;; been handled already.
1663 ;; Export properties are not case-sensitive.
1670 plist
1671 property
1673 ;; Parse VALUE if required.
1677 ;; If BEHAVIOR is `split' expected value is
1678 ;; a list of strings, not a string.
1681 ;; Look for both general keywords and back-end specific
1682 ;; options, with priority given to the latter.
1684 org-export-options-alist)))
1685 ;; Return value.
1686 plist)))
1689 "Return current buffer export options, as a plist.
1691 Optional argument BACKEND, when non-nil, is an export back-end,
1692 as returned by, e.g., `org-export-create-backend'. It specifies
1693 which back-end specific options should also be read in the
1694 process.
1696 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1698 get-options ; For byte-compiler.
1701 ;; Priority is given to back-end specific options.
1703 org-export-options-alist))
1706 org-export-special-keywords))))
1709 ;; Return all properties associated to KEYWORD.
1716 ;; Recursively read keywords in buffer. FILES is a list
1717 ;; of files read so far. PLIST is the current property
1718 ;; list obtained.
1727 ;; Options in `org-export-special-keywords'.
1731 ;; Avoid circular dependencies.
1741 plist
1746 plist
1752 ;; Options in `org-export-options-alist'.
1757 plist property
1758 ;; Handle value depending on specified
1759 ;; BEHAVIOR.
1765 " "
1778 ;; Return final value.
1779 plist))))
1780 ;; Read options in the current buffer.
1783 ;; Parse keywords specified in `org-element-document-properties'
1784 ;; and return PLIST.
1795 "Return properties related to buffer attributes, as a plist."
1796 ;; Store full path of input file name, or nil. For internal use.
1799 :input-file visited-file
1805 "Return global export options as a plist.
1806 Optional argument BACKEND, if non-nil, is an export back-end, as
1807 returned by, e.g., `org-export-create-backend'. It specifies
1808 which back-end specific export options should also be read in the
1809 process."
1811 ;; Priority is given to back-end specific options.
1813 org-export-options-alist)))
1820 plist
1821 prop
1822 ;; Eval default value provided. If keyword is
1823 ;; a member of `org-element-document-properties',
1824 ;; parse it as a secondary string before storing it.
1831 value)))))))))))
1834 "Return variables bound from BIND keywords in current buffer.
1835 Also look for BIND keywords in setup files. The return value is
1836 an alist where associations are (VARIABLE-NAME VALUE)."
1841 ;; Return an alist between variable names and their
1842 ;; value. FILES is a list of setup files names read so
1843 ;; far, used to avoid circular dependencies. ALIST is
1844 ;; the alist collected so far.
1855 ;; Enter setup file.
1865 alist))))))))))
1866 alist)))))
1867 ;; Return value in appropriate order of appearance.
1871 ;;;; Tree Properties
1872 ;;
1873 ;; Tree properties are information extracted from parse tree. They
1874 ;; are initialized at the beginning of the transcoding process by
1875 ;; `org-export-collect-tree-properties'.
1876 ;;
1877 ;; Dedicated functions focus on computing the value of specific tree
1878 ;; properties during initialization. Thus,
1879 ;; `org-export--populate-ignore-list' lists elements and objects that
1880 ;; should be skipped during export, `org-export--get-min-level' gets
1881 ;; the minimal exportable level, used as a basis to compute relative
1882 ;; level for headlines. Eventually
1883 ;; `org-export--collect-headline-numbering' builds an alist between
1884 ;; headlines and their numbering.
1887 "Extract tree properties from parse tree.
1889 DATA is the parse tree from which information is retrieved. INFO
1890 is a list holding export options.
1892 Following tree properties are set or updated:
1894 `:exported-data' Hash table used to memoize results from
1895 `org-export-data'.
1897 `:footnote-definition-alist' List of footnotes definitions in
1898 original buffer and current parse tree.
1900 `:headline-offset' Offset between true level of headlines and
1901 local level. An offset of -1 means a headline
1902 of level 2 should be considered as a level
1903 1 headline in the context.
1905 `:headline-numbering' Alist of all headlines as key an the
1906 associated numbering as value.
1908 `:ignore-list' List of elements that should be ignored during
1909 export.
1911 Return updated plist."
1912 ;; Install the parse tree in the communication channel, in order to
1913 ;; use `org-export-get-genealogy' and al.
1915 ;; Get the list of elements and objects to ignore, and put it into
1916 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1917 ;; been done during parse tree filtering.
1920 :ignore-list
1923 ;; Compute `:headline-offset' in order to be able to use
1924 ;; `org-export-get-relative-level'.
1927 :headline-offset
1929 ;; Update footnotes definitions list with definitions in parse tree.
1930 ;; This is required since buffer expansion might have modified
1931 ;; boundaries of footnote definitions contained in the parse tree.
1932 ;; This way, definitions in `footnote-definition-alist' are bound to
1933 ;; match those in the parse tree.
1939 defs)))
1941 ;; Properties order doesn't matter: get the rest of the tree
1942 ;; properties.
1946 info))
1949 "Return minimum exportable headline's level in DATA.
1950 DATA is parsed tree as returned by `org-element-parse-buffer'.
1951 OPTIONS is a plist holding export options."
1962 ;; If no headline was found, for the sake of consistency, set
1963 ;; minimum level to 1 nonetheless.
1967 "Return numbering of all exportable headlines in a parse tree.
1969 DATA is the parse tree. OPTIONS is the plist holding export
1970 options.
1972 Return an alist whose key is a headline and value is its
1973 associated numbering \(in the shape of a list of numbers\) or nil
1974 for a footnotes section."
1982 headline
1984 for idx from 0 to org-export-max-depth
1988 options)))
1991 "Return list of elements and objects to ignore during export.
1992 DATA is the parse tree to traverse. OPTIONS is the plist holding
1993 export options."
1995 ;; First find trees containing a select tag, if any.
1997 ;; If a select tag is active, also ignore the section before
1998 ;; the first headline, if any.
2002 first-element))))
2005 ;; Collect ignored elements or objects into IGNORE-LIST.
2011 ;; If headline is archived but tree below has
2012 ;; to be skipped, add it to ignore list.
2015 ;; Move into secondary string, if any.
2020 ;; Move into recursive objects/elements.
2022 ;; Main call.
2024 ;; Return value.
2025 ignore))
2028 "Return list of headlines and inlinetasks with a select tag in their tree.
2029 DATA is parsed data as returned by `org-element-parse-buffer'.
2030 INFO is a plist holding export options."
2032 walk-data ; For byte-compiler.
2042 ;; When a select tag is found, mark full
2043 ;; genealogy and every headline within the tree
2044 ;; as acceptable.
2047 genealogy
2050 selected-trees))
2051 ;; If at a headline, continue searching in tree,
2052 ;; recursively.
2062 selected-trees))
2065 "Non-nil when element or object BLOB should be skipped during export.
2066 OPTIONS is the plist holding export options. SELECTED, when
2067 non-nil, is a list of headlines or inlinetasks belonging to
2068 a tree with a select tag."
2075 ;; If `:with-drawers' value starts with `not', ignore
2076 ;; every drawer whose name belong to that list.
2077 ;; Otherwise, ignore drawers whose name isn't in that
2078 ;; list.
2095 ;; Ignore subtrees with an exclude tag.
2098 ;; When a select tag is present in the buffer, ignore any tree
2099 ;; without it.
2101 ;; Ignore commented sub-trees.
2103 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2105 ;; Ignore tasks, if specified by `:with-tasks' property.
2117 properties-set))))))
2128 ;; `:with-timestamps' only applies to isolated timestamps
2129 ;; objects, i.e. timestamp objects in a paragraph containing only
2130 ;; timestamps and whitespaces.
2138 options t))))
2147 \f
2148 ;;; The Transcoder
2149 ;;
2150 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2151 ;; `org-element-parse-buffer') and transcodes it into a specified
2152 ;; back-end output. It takes care of filtering out elements or
2153 ;; objects according to export options and organizing the output blank
2154 ;; lines and white space are preserved. The function memoizes its
2155 ;; results, so it is cheap to call it within transcoders.
2156 ;;
2157 ;; It is possible to modify locally the back-end used by
2158 ;; `org-export-data' or even use a temporary back-end by using
2159 ;; `org-export-data-with-backend'.
2160 ;;
2161 ;; Internally, three functions handle the filtering of objects and
2162 ;; elements during the export. In particular,
2163 ;; `org-export-ignore-element' marks an element or object so future
2164 ;; parse tree traversals skip it and `org-export-expand' transforms
2165 ;; the others back into their original shape.
2166 ;;
2167 ;; `org-export-transcoder' is an accessor returning appropriate
2168 ;; translator function for a given element or object.
2171 "Return appropriate transcoder for BLOB.
2172 INFO is a plist containing export directives."
2174 ;; Return contents only for complete parse trees.
2180 "Convert DATA into current back-end format.
2182 DATA is a parse tree, an element or an object or a secondary
2183 string. INFO is a plist holding export options.
2185 Return transcoded string."
2191 ;; Ignored element/object.
2193 ;; Plain text.
2199 info))
2200 ;; Secondary string.
2203 ;; Element/Object without contents or, as a special case,
2204 ;; headline with archive tag and archived trees restricted
2205 ;; to title only.
2213 ;; Export snippets never return a nil value so
2214 ;; that white spaces following them are never
2215 ;; ignored.
2217 ;; Element/Object with contents.
2230 ;; Elements directly containing objects
2231 ;; must have their indentation normalized
2232 ;; first.
2234 data
2235 ;; When normalizing contents of the first
2236 ;; paragraph in an item or a footnote
2237 ;; definition, ignore first line's
2238 ;; indentation: there is none and it
2239 ;; might be misleading.
2244 data)
2251 info))))))))
2252 ;; Final result will be memoized before being returned.
2254 data
2258 ;; Append the same white space between elements or objects as in
2259 ;; the original buffer, and call appropriate filters.
2270 info)))
2271 results)))
2275 "Convert DATA into BACKEND format.
2277 DATA is an element, an object, a secondary string or a string.
2278 BACKEND is a symbol. INFO is a plist used as a communication
2279 channel.
2281 Unlike to `org-export-with-backend', this function will
2282 recursively convert DATA using BACKEND translation table."
2285 data
2286 ;; Set-up a new communication channel with translations defined in
2287 ;; BACKEND as the translate table and a new hash table for
2288 ;; memoization.
2290 info
2293 ;; Size of the hash table is reduced since this function
2294 ;; will probably be used on small trees.
2298 "Change uninterpreted elements back into Org syntax.
2299 DATA is the parse tree. INFO is a plist containing export
2300 options. Each uninterpreted element or object is changed back
2301 into a string. Contents, if any, are not modified. The parse
2302 tree is modified by side effect and returned by the function."
2306 prop
2309 info))))
2312 "Change uninterpreted elements back into Org syntax.
2313 DATA is a parse tree or a secondary string. INFO is a plist
2314 containing export options. It is modified by side effect and
2315 returned by the function."
2318 subscript superscript underline)
2322 ;; ... entities...
2329 ?\s)))))
2330 ;; ... emphasis...
2342 marker
2346 ?\s)))))))
2347 ;; ... LaTeX environments and fragments...
2351 ;; ... sub/superscripts...
2360 "_"
2369 ?\s)))))))))))
2371 ;; Splice NEW at BLOB location in parse tree.
2374 info)
2375 ;; Return modified parse tree.
2376 data)
2379 "Expand a parsed element or object to its original state.
2381 BLOB is either an element or an object. CONTENTS is its
2382 contents, as a string or nil.
2384 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2385 keywords before output."
2390 blob contents))))
2393 "Add ELEMENT to `:ignore-list' in INFO.
2395 Any element in `:ignore-list' will be skipped when using
2396 `org-element-map'. INFO is modified by side effects."
2400 \f
2401 ;;; The Filter System
2402 ;;
2403 ;; Filters allow end-users to tweak easily the transcoded output.
2404 ;; They are the functional counterpart of hooks, as every filter in
2405 ;; a set is applied to the return value of the previous one.
2406 ;;
2407 ;; Every set is back-end agnostic. Although, a filter is always
2408 ;; called, in addition to the string it applies to, with the back-end
2409 ;; used as argument, so it's easy for the end-user to add back-end
2410 ;; specific filters in the set. The communication channel, as
2411 ;; a plist, is required as the third argument.
2412 ;;
2413 ;; From the developer side, filters sets can be installed in the
2414 ;; process with the help of `org-export-define-backend', which
2415 ;; internally stores filters as an alist. Each association has a key
2416 ;; among the following symbols and a function or a list of functions
2417 ;; as value.
2418 ;;
2419 ;; - `:filter-options' applies to the property list containing export
2420 ;; options. Unlike to other filters, functions in this list accept
2421 ;; two arguments instead of three: the property list containing
2422 ;; export options and the back-end. Users can set its value through
2423 ;; `org-export-filter-options-functions' variable.
2424 ;;
2425 ;; - `:filter-parse-tree' applies directly to the complete parsed
2426 ;; tree. Users can set it through
2427 ;; `org-export-filter-parse-tree-functions' variable.
2428 ;;
2429 ;; - `:filter-final-output' applies to the final transcoded string.
2430 ;; Users can set it with `org-export-filter-final-output-functions'
2431 ;; variable
2432 ;;
2433 ;; - `:filter-plain-text' applies to any string not recognized as Org
2434 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2435 ;; configure it.
2436 ;;
2437 ;; - `:filter-TYPE' applies on the string returned after an element or
2438 ;; object of type TYPE has been transcoded. A user can modify
2439 ;; `org-export-filter-TYPE-functions'
2440 ;;
2441 ;; All filters sets are applied with
2442 ;; `org-export-filter-apply-functions' function. Filters in a set are
2443 ;; applied in a LIFO fashion. It allows developers to be sure that
2444 ;; their filters will be applied first.
2445 ;;
2446 ;; Filters properties are installed in communication channel with
2447 ;; `org-export-install-filters' function.
2448 ;;
2449 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2450 ;; `org-export-before-parsing-hook') are run at the beginning of the
2451 ;; export process and just before parsing to allow for heavy structure
2452 ;; modifications.
2455 ;;;; Hooks
2458 "Hook run at the beginning of the export process.
2460 This is run before include keywords and macros are expanded and
2461 Babel code blocks executed, on a copy of the original buffer
2462 being exported. Visibility and narrowing are preserved. Point
2463 is at the beginning of the buffer.
2465 Every function in this hook will be called with one argument: the
2469 "Hook run before parsing an export buffer.
2471 This is run after include keywords and macros have been expanded
2472 and Babel code blocks executed, on a copy of the original buffer
2473 being exported. Visibility and narrowing are preserved. Point
2474 is at the beginning of the buffer.
2476 Every function in this hook will be called with one argument: the
2480 ;;;; Special Filters
2483 "List of functions applied to the export options.
2484 Each filter is called with two arguments: the export options, as
2485 a plist, and the back-end, as a symbol. It must return
2489 "List of functions applied to the parsed tree.
2490 Each filter is called with three arguments: the parse tree, as
2491 returned by `org-element-parse-buffer', the back-end, as
2492 a symbol, and the communication channel, as a plist. It must
2496 "List of functions applied to plain text.
2497 Each filter is called with three arguments: a string which
2498 contains no Org syntax, the back-end, as a symbol, and the
2499 communication channel, as a plist. It must return a string or
2503 "List of functions applied to the transcoded string.
2504 Each filter is called with three arguments: the full transcoded
2505 string, the back-end, as a symbol, and the communication channel,
2506 as a plist. It must return a string that will be used as the
2510 ;;;; Elements Filters
2513 "List of functions applied to a transcoded babel-call.
2514 Each filter is called with three arguments: the transcoded data,
2515 as a string, the back-end, as a symbol, and the communication
2519 "List of functions applied to a transcoded center block.
2520 Each filter is called with three arguments: the transcoded data,
2521 as a string, the back-end, as a symbol, and the communication
2525 "List of functions applied to a transcoded clock.
2526 Each filter is called with three arguments: the transcoded data,
2527 as a string, the back-end, as a symbol, and the communication
2531 "List of functions applied to a transcoded comment.
2532 Each filter is called with three arguments: the transcoded data,
2533 as a string, the back-end, as a symbol, and the communication
2537 "List of functions applied to a transcoded comment-block.
2538 Each filter is called with three arguments: the transcoded data,
2539 as a string, the back-end, as a symbol, and the communication
2543 "List of functions applied to a transcoded diary-sexp.
2544 Each filter is called with three arguments: the transcoded data,
2545 as a string, the back-end, as a symbol, and the communication
2549 "List of functions applied to a transcoded drawer.
2550 Each filter is called with three arguments: the transcoded data,
2551 as a string, the back-end, as a symbol, and the communication
2555 "List of functions applied to a transcoded dynamic-block.
2556 Each filter is called with three arguments: the transcoded data,
2557 as a string, the back-end, as a symbol, and the communication
2561 "List of functions applied to a transcoded example-block.
2562 Each filter is called with three arguments: the transcoded data,
2563 as a string, the back-end, as a symbol, and the communication
2567 "List of functions applied to a transcoded export-block.
2568 Each filter is called with three arguments: the transcoded data,
2569 as a string, the back-end, as a symbol, and the communication
2573 "List of functions applied to a transcoded fixed-width.
2574 Each filter is called with three arguments: the transcoded data,
2575 as a string, the back-end, as a symbol, and the communication
2579 "List of functions applied to a transcoded footnote-definition.
2580 Each filter is called with three arguments: the transcoded data,
2581 as a string, the back-end, as a symbol, and the communication
2585 "List of functions applied to a transcoded headline.
2586 Each filter is called with three arguments: the transcoded data,
2587 as a string, the back-end, as a symbol, and the communication
2591 "List of functions applied to a transcoded horizontal-rule.
2592 Each filter is called with three arguments: the transcoded data,
2593 as a string, the back-end, as a symbol, and the communication
2597 "List of functions applied to a transcoded inlinetask.
2598 Each filter is called with three arguments: the transcoded data,
2599 as a string, the back-end, as a symbol, and the communication
2603 "List of functions applied to a transcoded item.
2604 Each filter is called with three arguments: the transcoded data,
2605 as a string, the back-end, as a symbol, and the communication
2609 "List of functions applied to a transcoded keyword.
2610 Each filter is called with three arguments: the transcoded data,
2611 as a string, the back-end, as a symbol, and the communication
2615 "List of functions applied to a transcoded latex-environment.
2616 Each filter is called with three arguments: the transcoded data,
2617 as a string, the back-end, as a symbol, and the communication
2621 "List of functions applied to a transcoded node-property.
2622 Each filter is called with three arguments: the transcoded data,
2623 as a string, the back-end, as a symbol, and the communication
2627 "List of functions applied to a transcoded paragraph.
2628 Each filter is called with three arguments: the transcoded data,
2629 as a string, the back-end, as a symbol, and the communication
2633 "List of functions applied to a transcoded plain-list.
2634 Each filter is called with three arguments: the transcoded data,
2635 as a string, the back-end, as a symbol, and the communication
2639 "List of functions applied to a transcoded planning.
2640 Each filter is called with three arguments: the transcoded data,
2641 as a string, the back-end, as a symbol, and the communication
2645 "List of functions applied to a transcoded property-drawer.
2646 Each filter is called with three arguments: the transcoded data,
2647 as a string, the back-end, as a symbol, and the communication
2651 "List of functions applied to a transcoded quote block.
2652 Each filter is called with three arguments: the transcoded quote
2653 data, as a string, the back-end, as a symbol, and the
2654 communication channel, as a plist. It must return a string or
2658 "List of functions applied to a transcoded quote-section.
2659 Each filter is called with three arguments: the transcoded data,
2660 as a string, the back-end, as a symbol, and the communication
2664 "List of functions applied to a transcoded section.
2665 Each filter is called with three arguments: the transcoded data,
2666 as a string, the back-end, as a symbol, and the communication
2670 "List of functions applied to a transcoded special block.
2671 Each filter is called with three arguments: the transcoded data,
2672 as a string, the back-end, as a symbol, and the communication
2676 "List of functions applied to a transcoded src-block.
2677 Each filter is called with three arguments: the transcoded data,
2678 as a string, the back-end, as a symbol, and the communication
2682 "List of functions applied to a transcoded table.
2683 Each filter is called with three arguments: the transcoded data,
2684 as a string, the back-end, as a symbol, and the communication
2688 "List of functions applied to a transcoded table-cell.
2689 Each filter is called with three arguments: the transcoded data,
2690 as a string, the back-end, as a symbol, and the communication
2694 "List of functions applied to a transcoded table-row.
2695 Each filter is called with three arguments: the transcoded data,
2696 as a string, the back-end, as a symbol, and the communication
2700 "List of functions applied to a transcoded verse block.
2701 Each filter is called with three arguments: the transcoded data,
2702 as a string, the back-end, as a symbol, and the communication
2706 ;;;; Objects Filters
2709 "List of functions applied to transcoded bold text.
2710 Each filter is called with three arguments: the transcoded data,
2711 as a string, the back-end, as a symbol, and the communication
2715 "List of functions applied to transcoded code text.
2716 Each filter is called with three arguments: the transcoded data,
2717 as a string, the back-end, as a symbol, and the communication
2721 "List of functions applied to a transcoded entity.
2722 Each filter is called with three arguments: the transcoded data,
2723 as a string, the back-end, as a symbol, and the communication
2727 "List of functions applied to a transcoded export-snippet.
2728 Each filter is called with three arguments: the transcoded data,
2729 as a string, the back-end, as a symbol, and the communication
2733 "List of functions applied to a transcoded footnote-reference.
2734 Each filter is called with three arguments: the transcoded data,
2735 as a string, the back-end, as a symbol, and the communication
2739 "List of functions applied to a transcoded inline-babel-call.
2740 Each filter is called with three arguments: the transcoded data,
2741 as a string, the back-end, as a symbol, and the communication
2745 "List of functions applied to a transcoded inline-src-block.
2746 Each filter is called with three arguments: the transcoded data,
2747 as a string, the back-end, as a symbol, and the communication
2751 "List of functions applied to transcoded italic text.
2752 Each filter is called with three arguments: the transcoded data,
2753 as a string, the back-end, as a symbol, and the communication
2757 "List of functions applied to a transcoded latex-fragment.
2758 Each filter is called with three arguments: the transcoded data,
2759 as a string, the back-end, as a symbol, and the communication
2763 "List of functions applied to a transcoded line-break.
2764 Each filter is called with three arguments: the transcoded data,
2765 as a string, the back-end, as a symbol, and the communication
2769 "List of functions applied to a transcoded link.
2770 Each filter is called with three arguments: the transcoded data,
2771 as a string, the back-end, as a symbol, and the communication
2775 "List of functions applied to a transcoded radio-target.
2776 Each filter is called with three arguments: the transcoded data,
2777 as a string, the back-end, as a symbol, and the communication
2781 "List of functions applied to a transcoded statistics-cookie.
2782 Each filter is called with three arguments: the transcoded data,
2783 as a string, the back-end, as a symbol, and the communication
2787 "List of functions applied to transcoded strike-through text.
2788 Each filter is called with three arguments: the transcoded data,
2789 as a string, the back-end, as a symbol, and the communication
2793 "List of functions applied to a transcoded subscript.
2794 Each filter is called with three arguments: the transcoded data,
2795 as a string, the back-end, as a symbol, and the communication
2799 "List of functions applied to a transcoded superscript.
2800 Each filter is called with three arguments: the transcoded data,
2801 as a string, the back-end, as a symbol, and the communication
2805 "List of functions applied to a transcoded target.
2806 Each filter is called with three arguments: the transcoded data,
2807 as a string, the back-end, as a symbol, and the communication
2811 "List of functions applied to a transcoded timestamp.
2812 Each filter is called with three arguments: the transcoded data,
2813 as a string, the back-end, as a symbol, and the communication
2817 "List of functions applied to transcoded underline text.
2818 Each filter is called with three arguments: the transcoded data,
2819 as a string, the back-end, as a symbol, and the communication
2823 "List of functions applied to transcoded verbatim text.
2824 Each filter is called with three arguments: the transcoded data,
2825 as a string, the back-end, as a symbol, and the communication
2829 ;;;; Filters Tools
2830 ;;
2831 ;; Internal function `org-export-install-filters' installs filters
2832 ;; hard-coded in back-ends (developer filters) and filters from global
2833 ;; variables (user filters) in the communication channel.
2834 ;;
2835 ;; Internal function `org-export-filter-apply-functions' takes care
2836 ;; about applying each filter in order to a given data. It ignores
2837 ;; filters returning a nil value but stops whenever a filter returns
2838 ;; an empty string.
2841 "Call every function in FILTERS.
2843 Functions are called with arguments VALUE, current export
2844 back-end's name and INFO. A function returning a nil value will
2845 be skipped. If it returns the empty string, the process ends and
2846 VALUE is ignored.
2848 Call is done in a LIFO fashion, to be sure that developer
2849 specified filters, if any, are called first."
2860 "Install filters properties in communication channel.
2861 INFO is a plist containing the current communication channel.
2862 Return the updated communication channel."
2864 ;; Install user-defined filters with `org-export-filters-alist'
2865 ;; and filters already in INFO (through ext-plist mechanism).
2872 ;; Filters in INFO will be called
2873 ;; before those user provided.
2876 default-value)))))
2877 org-export-filters-alist)
2878 ;; Prepend back-end specific filters to that list.
2880 ;; Single values get consed, lists are appended.
2885 plist key
2889 ;; Return new communication channel.
2893 \f
2894 ;;; Core functions
2895 ;;
2896 ;; This is the room for the main function, `org-export-as', along with
2897 ;; its derivative, `org-export-string-as'.
2898 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2899 ;; function should be added to kill ring.
2900 ;;
2901 ;; Note that `org-export-as' doesn't really parse the current buffer,
2902 ;; but a copy of it (with the same buffer-local variables and
2903 ;; visibility), where macros and include keywords are expanded and
2904 ;; Babel blocks are executed, if appropriate.
2905 ;; `org-export-with-buffer-copy' macro prepares that copy.
2906 ;;
2907 ;; File inclusion is taken care of by
2908 ;; `org-export-expand-include-keyword' and
2909 ;; `org-export--prepare-file-contents'. Structure wise, including
2910 ;; a whole Org file in a buffer often makes little sense. For
2911 ;; example, if the file contains a headline and the include keyword
2912 ;; was within an item, the item should contain the headline. That's
2913 ;; why file inclusion should be done before any structure can be
2914 ;; associated to the file, that is before parsing.
2915 ;;
2916 ;; `org-export-insert-default-template' is a command to insert
2917 ;; a default template (or a back-end specific template) at point or in
2918 ;; current subtree.
2921 "Return a copy of the current buffer.
2922 The copy preserves Org buffer-local variables, visibility and
2923 narrowing."
2929 new-buf))
2932 "Apply BODY in a copy of the current buffer.
2933 The copy preserves local variables, visibility and contents of
2934 the original buffer. Point is at the beginning of the buffer
2935 when BODY is applied."
2944 ;; Kill copy without confirmation.
2950 "Generate a function duplicating BUFFER.
2952 The copy will preserve local variables, visibility, contents and
2953 narrowing of the original buffer. If a region was active in
2954 BUFFER, contents will be narrowed to that region instead.
2956 The resulting function can be evaluated at a later time, from
2957 another buffer, effectively cloning the original buffer there.
2959 The function assumes BUFFER's major mode is `org-mode'."
2963 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2964 ;; already in BUFFER.
2966 ;; Copy specific buffer local variables and variables set
2967 ;; through BIND keywords.
2969 vars)
2975 ;; Do not share cache across
2976 ;; buffers as values are
2977 ;; modified by side effect.
2978 org-element--cache)))
2981 buffer-file-name
2982 buffer-file-coding-system))
2986 ;; Skip unreadable values, as they cannot be
2987 ;; sent to external process.
2991 vars))))))
2992 ;; Whole buffer contents.
2997 ;; Narrowing.
3001 ;; Current position of point.
3003 ;; Overlays with invisible property.
3013 ov-set))))
3015 ov-set)))))
3017 ;;;###autoload
3020 "Transcode current Org buffer into BACKEND code.
3022 BACKEND is either an export back-end, as returned by, e.g.,
3023 `org-export-create-backend', or a symbol referring to
3024 a registered back-end.
3026 If narrowing is active in the current buffer, only transcode its
3027 narrowed part.
3029 If a region is active, transcode that region.
3031 When optional argument SUBTREEP is non-nil, transcode the
3032 sub-tree at point, extracting information from the headline
3033 properties first.
3035 When optional argument VISIBLE-ONLY is non-nil, don't export
3036 contents of hidden elements.
3038 When optional argument BODY-ONLY is non-nil, only return body
3039 code, without surrounding template.
3041 Optional argument EXT-PLIST, when provided, is a property list
3042 with external parameters overriding Org default settings, but
3043 still inferior to file-local settings.
3045 Return code as a string."
3050 ;; Narrow buffer to an appropriate region or subtree for
3051 ;; parsing. If parsing subtree, be sure to remove main headline
3052 ;; too.
3060 ;; Initialize communication channel with original buffer
3061 ;; attributes, unavailable in its copy.
3070 tree)
3071 ;; Update communication channel and get parse tree. Buffer
3072 ;; isn't parsed directly. Instead, a temporary copy is
3073 ;; created, where include keywords, macros are expanded and
3074 ;; code blocks are evaluated.
3076 ;; Run first hook with current back-end's name as argument.
3080 ;; Update macro templates since #+INCLUDE keywords might have
3081 ;; added some new ones.
3085 ;; Update radio targets since keyword inclusion might have
3086 ;; added some more.
3088 ;; Run last hook with current back-end's name as argument.
3093 ;; Update communication channel with environment. Also
3094 ;; install user's and developer's filters.
3099 ;; Expand export-specific set of macros: {{{author}}},
3100 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3101 ;; once regular macros have been expanded, since document
3102 ;; keywords may contain one of them.
3108 ;; EMAIL is not a parsed keyword: store it as-is.
3112 ;; Parse buffer.
3114 ;; Handle left-over uninterpreted elements or objects in
3115 ;; parse tree and communication channel.
3117 ;; Call options filters and update export options. We do not
3118 ;; use `org-export-filter-apply-functions' here since the
3119 ;; arity of such filters is different.
3124 ;; Parse buffer, handle uninterpreted elements or objects,
3125 ;; then call parse-tree filters.
3129 ;; Now tree is complete, compute its properties and add them
3130 ;; to communication channel.
3134 ;; Eventually transcode TREE. Wrap the resulting string into
3135 ;; a template.
3144 ;; Remove all text properties since they cannot be
3145 ;; retrieved from an external process. Finally call
3146 ;; final-output filter and return result.
3152 info))))))))
3154 ;;;###autoload
3156 "Transcode STRING into BACKEND code.
3158 BACKEND is either an export back-end, as returned by, e.g.,
3159 `org-export-create-backend', or a symbol referring to
3160 a registered back-end.
3162 When optional argument BODY-ONLY is non-nil, only return body
3163 code, without preamble nor postamble.
3165 Optional argument EXT-PLIST, when provided, is a property list
3166 with external parameters overriding Org default settings, but
3167 still inferior to file-local settings.
3169 Return code as a string."
3175 ;;;###autoload
3177 "Replace the active region by its export to BACKEND.
3178 BACKEND is either an export back-end, as returned by, e.g.,
3179 `org-export-create-backend', or a symbol referring to
3180 a registered back-end."
3190 ;;;###autoload
3192 "Insert all export keywords with default values at beginning of line.
3194 BACKEND is a symbol referring to the name of a registered export
3195 back-end, for which specific export options should be added to
3196 the template, or `default' for default template. When it is nil,
3197 the user will be prompted for a category.
3199 If SUBTREEP is non-nil, export configuration will be set up
3200 locally for the subtree through node properties."
3210 "Options category: "
3214 org-export--registered-backends))))))
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