| blob | 33775ce5d1744a9902979da88f7582a04a219a7c |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; 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 BEHAVIOUR) 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 BEHAVIOUR 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 as its fallback value.
1646 plist :title
1649 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1653 ;; Handle other keywords. TITLE keyword is excluded as it has
1654 ;; been handled already.
1662 ;; Export properties are not case-sensitive.
1669 plist
1670 property
1672 ;; Parse VALUE if required.
1676 ;; If BEHAVIOUR is `split' expected value is
1677 ;; a list of strings, not a string.
1680 ;; Look for both general keywords and back-end specific
1681 ;; options, with priority given to the latter.
1683 org-export-options-alist)))
1684 ;; Return value.
1685 plist)))
1688 "Return current buffer export options, as a plist.
1690 Optional argument BACKEND, when non-nil, is an export back-end,
1691 as returned by, e.g., `org-export-create-backend'. It specifies
1692 which back-end specific options should also be read in the
1693 process.
1695 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1697 get-options ; For byte-compiler.
1700 ;; Priority is given to back-end specific options.
1702 org-export-options-alist))
1705 org-export-special-keywords))))
1708 ;; Return all properties associated to KEYWORD.
1715 ;; Recursively read keywords in buffer. FILES is a list
1716 ;; of files read so far. PLIST is the current property
1717 ;; list obtained.
1726 ;; Options in `org-export-special-keywords'.
1730 ;; Avoid circular dependencies.
1740 plist
1745 plist
1751 ;; Options in `org-export-options-alist'.
1756 plist property
1757 ;; Handle value depending on specified
1758 ;; BEHAVIOUR.
1764 " "
1777 ;; Return final value.
1778 plist))))
1779 ;; Read options in the current buffer.
1782 ;; Parse keywords specified in `org-element-document-properties'
1783 ;; and return PLIST.
1794 "Return properties related to buffer attributes, as a plist."
1795 ;; Store full path of input file name, or nil. For internal use.
1798 :input-file visited-file
1804 "Return global export options as a plist.
1805 Optional argument BACKEND, if non-nil, is an export back-end, as
1806 returned by, e.g., `org-export-create-backend'. It specifies
1807 which back-end specific export options should also be read in the
1808 process."
1810 ;; Priority is given to back-end specific options.
1812 org-export-options-alist)))
1819 plist
1820 prop
1821 ;; Eval default value provided. If keyword is
1822 ;; a member of `org-element-document-properties',
1823 ;; parse it as a secondary string before storing it.
1830 value)))))))))))
1833 "Return variables bound from BIND keywords in current buffer.
1834 Also look for BIND keywords in setup files. The return value is
1835 an alist where associations are (VARIABLE-NAME VALUE)."
1840 ;; Return an alist between variable names and their
1841 ;; value. FILES is a list of setup files names read so
1842 ;; far, used to avoid circular dependencies. ALIST is
1843 ;; the alist collected so far.
1854 ;; Enter setup file.
1864 alist))))))))))
1865 alist)))))
1866 ;; Return value in appropriate order of appearance.
1870 ;;;; Tree Properties
1871 ;;
1872 ;; Tree properties are information extracted from parse tree. They
1873 ;; are initialized at the beginning of the transcoding process by
1874 ;; `org-export-collect-tree-properties'.
1875 ;;
1876 ;; Dedicated functions focus on computing the value of specific tree
1877 ;; properties during initialization. Thus,
1878 ;; `org-export--populate-ignore-list' lists elements and objects that
1879 ;; should be skipped during export, `org-export--get-min-level' gets
1880 ;; the minimal exportable level, used as a basis to compute relative
1881 ;; level for headlines. Eventually
1882 ;; `org-export--collect-headline-numbering' builds an alist between
1883 ;; headlines and their numbering.
1886 "Extract tree properties from parse tree.
1888 DATA is the parse tree from which information is retrieved. INFO
1889 is a list holding export options.
1891 Following tree properties are set or updated:
1893 `:exported-data' Hash table used to memoize results from
1894 `org-export-data'.
1896 `:footnote-definition-alist' List of footnotes definitions in
1897 original buffer and current parse tree.
1899 `:headline-offset' Offset between true level of headlines and
1900 local level. An offset of -1 means a headline
1901 of level 2 should be considered as a level
1902 1 headline in the context.
1904 `:headline-numbering' Alist of all headlines as key an the
1905 associated numbering as value.
1907 `:ignore-list' List of elements that should be ignored during
1908 export.
1910 Return updated plist."
1911 ;; Install the parse tree in the communication channel, in order to
1912 ;; use `org-export-get-genealogy' and al.
1914 ;; Get the list of elements and objects to ignore, and put it into
1915 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1916 ;; been done during parse tree filtering.
1919 :ignore-list
1922 ;; Compute `:headline-offset' in order to be able to use
1923 ;; `org-export-get-relative-level'.
1926 :headline-offset
1928 ;; Update footnotes definitions list with definitions in parse tree.
1929 ;; This is required since buffer expansion might have modified
1930 ;; boundaries of footnote definitions contained in the parse tree.
1931 ;; This way, definitions in `footnote-definition-alist' are bound to
1932 ;; match those in the parse tree.
1938 defs)))
1940 ;; Properties order doesn't matter: get the rest of the tree
1941 ;; properties.
1945 info))
1948 "Return minimum exportable headline's level in DATA.
1949 DATA is parsed tree as returned by `org-element-parse-buffer'.
1950 OPTIONS is a plist holding export options."
1961 ;; If no headline was found, for the sake of consistency, set
1962 ;; minimum level to 1 nonetheless.
1966 "Return numbering of all exportable headlines in a parse tree.
1968 DATA is the parse tree. OPTIONS is the plist holding export
1969 options.
1971 Return an alist whose key is a headline and value is its
1972 associated numbering \(in the shape of a list of numbers\) or nil
1973 for a footnotes section."
1981 headline
1983 for idx from 0 to org-export-max-depth
1987 options)))
1990 "Return list of elements and objects to ignore during export.
1991 DATA is the parse tree to traverse. OPTIONS is the plist holding
1992 export options."
1994 ;; First find trees containing a select tag, if any.
1996 ;; If a select tag is active, also ignore the section before
1997 ;; the first headline, if any.
2001 first-element))))
2004 ;; Collect ignored elements or objects into IGNORE-LIST.
2010 ;; If headline is archived but tree below has
2011 ;; to be skipped, add it to ignore list.
2014 ;; Move into secondary string, if any.
2019 ;; Move into recursive objects/elements.
2021 ;; Main call.
2023 ;; Return value.
2024 ignore))
2027 "Return list of headlines and inlinetasks with a select tag in their tree.
2028 DATA is parsed data as returned by `org-element-parse-buffer'.
2029 INFO is a plist holding export options."
2031 walk-data ; For byte-compiler.
2041 ;; When a select tag is found, mark full
2042 ;; genealogy and every headline within the tree
2043 ;; as acceptable.
2046 genealogy
2049 selected-trees))
2050 ;; If at a headline, continue searching in tree,
2051 ;; recursively.
2061 selected-trees))
2064 "Non-nil when element or object BLOB should be skipped during export.
2065 OPTIONS is the plist holding export options. SELECTED, when
2066 non-nil, is a list of headlines or inlinetasks belonging to
2067 a tree with a select tag."
2074 ;; If `:with-drawers' value starts with `not', ignore
2075 ;; every drawer whose name belong to that list.
2076 ;; Otherwise, ignore drawers whose name isn't in that
2077 ;; list.
2094 ;; Ignore subtrees with an exclude tag.
2097 ;; When a select tag is present in the buffer, ignore any tree
2098 ;; without it.
2100 ;; Ignore commented sub-trees.
2102 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2104 ;; Ignore tasks, if specified by `:with-tasks' property.
2116 properties-set))))))
2127 ;; `:with-timestamps' only applies to isolated timestamps
2128 ;; objects, i.e. timestamp objects in a paragraph containing only
2129 ;; timestamps and whitespaces.
2137 options t))))
2146 \f
2147 ;;; The Transcoder
2148 ;;
2149 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2150 ;; `org-element-parse-buffer') and transcodes it into a specified
2151 ;; back-end output. It takes care of filtering out elements or
2152 ;; objects according to export options and organizing the output blank
2153 ;; lines and white space are preserved. The function memoizes its
2154 ;; results, so it is cheap to call it within transcoders.
2155 ;;
2156 ;; It is possible to modify locally the back-end used by
2157 ;; `org-export-data' or even use a temporary back-end by using
2158 ;; `org-export-data-with-backend'.
2159 ;;
2160 ;; Internally, three functions handle the filtering of objects and
2161 ;; elements during the export. In particular,
2162 ;; `org-export-ignore-element' marks an element or object so future
2163 ;; parse tree traversals skip it and `org-export-expand' transforms
2164 ;; the others back into their original shape.
2165 ;;
2166 ;; `org-export-transcoder' is an accessor returning appropriate
2167 ;; translator function for a given element or object.
2170 "Return appropriate transcoder for BLOB.
2171 INFO is a plist containing export directives."
2173 ;; Return contents only for complete parse trees.
2179 "Convert DATA into current back-end format.
2181 DATA is a parse tree, an element or an object or a secondary
2182 string. INFO is a plist holding export options.
2184 Return transcoded string."
2190 ;; Ignored element/object.
2192 ;; Plain text.
2198 info))
2199 ;; Secondary string.
2202 ;; Element/Object without contents or, as a special case,
2203 ;; headline with archive tag and archived trees restricted
2204 ;; to title only.
2212 ;; Export snippets never return a nil value so
2213 ;; that white spaces following them are never
2214 ;; ignored.
2216 ;; Element/Object with contents.
2229 ;; Elements directly containing objects
2230 ;; must have their indentation normalized
2231 ;; first.
2233 data
2234 ;; When normalizing contents of the first
2235 ;; paragraph in an item or a footnote
2236 ;; definition, ignore first line's
2237 ;; indentation: there is none and it
2238 ;; might be misleading.
2243 data)
2250 info))))))))
2251 ;; Final result will be memoized before being returned.
2253 data
2257 ;; Append the same white space between elements or objects as in
2258 ;; the original buffer, and call appropriate filters.
2269 info)))
2270 results)))
2274 "Convert DATA into BACKEND format.
2276 DATA is an element, an object, a secondary string or a string.
2277 BACKEND is a symbol. INFO is a plist used as a communication
2278 channel.
2280 Unlike to `org-export-with-backend', this function will
2281 recursively convert DATA using BACKEND translation table."
2284 data
2285 ;; Set-up a new communication channel with translations defined in
2286 ;; BACKEND as the translate table and a new hash table for
2287 ;; memoization.
2289 info
2292 ;; Size of the hash table is reduced since this function
2293 ;; will probably be used on small trees.
2297 "Change uninterpreted elements back into Org syntax.
2298 DATA is the parse tree. INFO is a plist containing export
2299 options. Each uninterpreted element or object is changed back
2300 into a string. Contents, if any, are not modified. The parse
2301 tree is modified by side effect and returned by the function."
2305 prop
2308 info))))
2311 "Change uninterpreted elements back into Org syntax.
2312 DATA is a parse tree or a secondary string. INFO is a plist
2313 containing export options. It is modified by side effect and
2314 returned by the function."
2317 subscript superscript underline)
2321 ;; ... entities...
2328 ?\s)))))
2329 ;; ... emphasis...
2341 marker
2345 ?\s)))))))
2346 ;; ... LaTeX environments and fragments...
2350 ;; ... sub/superscripts...
2359 "_"
2368 ?\s)))))))))))
2370 ;; Splice NEW at BLOB location in parse tree.
2373 info)
2374 ;; Return modified parse tree.
2375 data)
2378 "Expand a parsed element or object to its original state.
2380 BLOB is either an element or an object. CONTENTS is its
2381 contents, as a string or nil.
2383 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2384 keywords before output."
2389 blob contents))))
2392 "Add ELEMENT to `:ignore-list' in INFO.
2394 Any element in `:ignore-list' will be skipped when using
2395 `org-element-map'. INFO is modified by side effects."
2399 \f
2400 ;;; The Filter System
2401 ;;
2402 ;; Filters allow end-users to tweak easily the transcoded output.
2403 ;; They are the functional counterpart of hooks, as every filter in
2404 ;; a set is applied to the return value of the previous one.
2405 ;;
2406 ;; Every set is back-end agnostic. Although, a filter is always
2407 ;; called, in addition to the string it applies to, with the back-end
2408 ;; used as argument, so it's easy for the end-user to add back-end
2409 ;; specific filters in the set. The communication channel, as
2410 ;; a plist, is required as the third argument.
2411 ;;
2412 ;; From the developer side, filters sets can be installed in the
2413 ;; process with the help of `org-export-define-backend', which
2414 ;; internally stores filters as an alist. Each association has a key
2415 ;; among the following symbols and a function or a list of functions
2416 ;; as value.
2417 ;;
2418 ;; - `:filter-options' applies to the property list containing export
2419 ;; options. Unlike to other filters, functions in this list accept
2420 ;; two arguments instead of three: the property list containing
2421 ;; export options and the back-end. Users can set its value through
2422 ;; `org-export-filter-options-functions' variable.
2423 ;;
2424 ;; - `:filter-parse-tree' applies directly to the complete parsed
2425 ;; tree. Users can set it through
2426 ;; `org-export-filter-parse-tree-functions' variable.
2427 ;;
2428 ;; - `:filter-final-output' applies to the final transcoded string.
2429 ;; Users can set it with `org-export-filter-final-output-functions'
2430 ;; variable
2431 ;;
2432 ;; - `:filter-plain-text' applies to any string not recognized as Org
2433 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2434 ;; configure it.
2435 ;;
2436 ;; - `:filter-TYPE' applies on the string returned after an element or
2437 ;; object of type TYPE has been transcoded. A user can modify
2438 ;; `org-export-filter-TYPE-functions'
2439 ;;
2440 ;; All filters sets are applied with
2441 ;; `org-export-filter-apply-functions' function. Filters in a set are
2442 ;; applied in a LIFO fashion. It allows developers to be sure that
2443 ;; their filters will be applied first.
2444 ;;
2445 ;; Filters properties are installed in communication channel with
2446 ;; `org-export-install-filters' function.
2447 ;;
2448 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2449 ;; `org-export-before-parsing-hook') are run at the beginning of the
2450 ;; export process and just before parsing to allow for heavy structure
2451 ;; modifications.
2454 ;;;; Hooks
2457 "Hook run at the beginning of the export process.
2459 This is run before include keywords and macros are expanded and
2460 Babel code blocks executed, on a copy of the original buffer
2461 being exported. Visibility and narrowing are preserved. Point
2462 is at the beginning of the buffer.
2464 Every function in this hook will be called with one argument: the
2468 "Hook run before parsing an export buffer.
2470 This is run after include keywords and macros have been expanded
2471 and Babel code blocks executed, on a copy of the original buffer
2472 being exported. Visibility and narrowing are preserved. Point
2473 is at the beginning of the buffer.
2475 Every function in this hook will be called with one argument: the
2479 ;;;; Special Filters
2482 "List of functions applied to the export options.
2483 Each filter is called with two arguments: the export options, as
2484 a plist, and the back-end, as a symbol. It must return
2488 "List of functions applied to the parsed tree.
2489 Each filter is called with three arguments: the parse tree, as
2490 returned by `org-element-parse-buffer', the back-end, as
2491 a symbol, and the communication channel, as a plist. It must
2495 "List of functions applied to plain text.
2496 Each filter is called with three arguments: a string which
2497 contains no Org syntax, the back-end, as a symbol, and the
2498 communication channel, as a plist. It must return a string or
2502 "List of functions applied to the transcoded string.
2503 Each filter is called with three arguments: the full transcoded
2504 string, the back-end, as a symbol, and the communication channel,
2505 as a plist. It must return a string that will be used as the
2509 ;;;; Elements Filters
2512 "List of functions applied to a transcoded babel-call.
2513 Each filter is called with three arguments: the transcoded data,
2514 as a string, the back-end, as a symbol, and the communication
2518 "List of functions applied to a transcoded center block.
2519 Each filter is called with three arguments: the transcoded data,
2520 as a string, the back-end, as a symbol, and the communication
2524 "List of functions applied to a transcoded clock.
2525 Each filter is called with three arguments: the transcoded data,
2526 as a string, the back-end, as a symbol, and the communication
2530 "List of functions applied to a transcoded comment.
2531 Each filter is called with three arguments: the transcoded data,
2532 as a string, the back-end, as a symbol, and the communication
2536 "List of functions applied to a transcoded comment-block.
2537 Each filter is called with three arguments: the transcoded data,
2538 as a string, the back-end, as a symbol, and the communication
2542 "List of functions applied to a transcoded diary-sexp.
2543 Each filter is called with three arguments: the transcoded data,
2544 as a string, the back-end, as a symbol, and the communication
2548 "List of functions applied to a transcoded drawer.
2549 Each filter is called with three arguments: the transcoded data,
2550 as a string, the back-end, as a symbol, and the communication
2554 "List of functions applied to a transcoded dynamic-block.
2555 Each filter is called with three arguments: the transcoded data,
2556 as a string, the back-end, as a symbol, and the communication
2560 "List of functions applied to a transcoded example-block.
2561 Each filter is called with three arguments: the transcoded data,
2562 as a string, the back-end, as a symbol, and the communication
2566 "List of functions applied to a transcoded export-block.
2567 Each filter is called with three arguments: the transcoded data,
2568 as a string, the back-end, as a symbol, and the communication
2572 "List of functions applied to a transcoded fixed-width.
2573 Each filter is called with three arguments: the transcoded data,
2574 as a string, the back-end, as a symbol, and the communication
2578 "List of functions applied to a transcoded footnote-definition.
2579 Each filter is called with three arguments: the transcoded data,
2580 as a string, the back-end, as a symbol, and the communication
2584 "List of functions applied to a transcoded headline.
2585 Each filter is called with three arguments: the transcoded data,
2586 as a string, the back-end, as a symbol, and the communication
2590 "List of functions applied to a transcoded horizontal-rule.
2591 Each filter is called with three arguments: the transcoded data,
2592 as a string, the back-end, as a symbol, and the communication
2596 "List of functions applied to a transcoded inlinetask.
2597 Each filter is called with three arguments: the transcoded data,
2598 as a string, the back-end, as a symbol, and the communication
2602 "List of functions applied to a transcoded item.
2603 Each filter is called with three arguments: the transcoded data,
2604 as a string, the back-end, as a symbol, and the communication
2608 "List of functions applied to a transcoded keyword.
2609 Each filter is called with three arguments: the transcoded data,
2610 as a string, the back-end, as a symbol, and the communication
2614 "List of functions applied to a transcoded latex-environment.
2615 Each filter is called with three arguments: the transcoded data,
2616 as a string, the back-end, as a symbol, and the communication
2620 "List of functions applied to a transcoded node-property.
2621 Each filter is called with three arguments: the transcoded data,
2622 as a string, the back-end, as a symbol, and the communication
2626 "List of functions applied to a transcoded paragraph.
2627 Each filter is called with three arguments: the transcoded data,
2628 as a string, the back-end, as a symbol, and the communication
2632 "List of functions applied to a transcoded plain-list.
2633 Each filter is called with three arguments: the transcoded data,
2634 as a string, the back-end, as a symbol, and the communication
2638 "List of functions applied to a transcoded planning.
2639 Each filter is called with three arguments: the transcoded data,
2640 as a string, the back-end, as a symbol, and the communication
2644 "List of functions applied to a transcoded property-drawer.
2645 Each filter is called with three arguments: the transcoded data,
2646 as a string, the back-end, as a symbol, and the communication
2650 "List of functions applied to a transcoded quote block.
2651 Each filter is called with three arguments: the transcoded quote
2652 data, as a string, the back-end, as a symbol, and the
2653 communication channel, as a plist. It must return a string or
2657 "List of functions applied to a transcoded quote-section.
2658 Each filter is called with three arguments: the transcoded data,
2659 as a string, the back-end, as a symbol, and the communication
2663 "List of functions applied to a transcoded section.
2664 Each filter is called with three arguments: the transcoded data,
2665 as a string, the back-end, as a symbol, and the communication
2669 "List of functions applied to a transcoded special block.
2670 Each filter is called with three arguments: the transcoded data,
2671 as a string, the back-end, as a symbol, and the communication
2675 "List of functions applied to a transcoded src-block.
2676 Each filter is called with three arguments: the transcoded data,
2677 as a string, the back-end, as a symbol, and the communication
2681 "List of functions applied to a transcoded table.
2682 Each filter is called with three arguments: the transcoded data,
2683 as a string, the back-end, as a symbol, and the communication
2687 "List of functions applied to a transcoded table-cell.
2688 Each filter is called with three arguments: the transcoded data,
2689 as a string, the back-end, as a symbol, and the communication
2693 "List of functions applied to a transcoded table-row.
2694 Each filter is called with three arguments: the transcoded data,
2695 as a string, the back-end, as a symbol, and the communication
2699 "List of functions applied to a transcoded verse block.
2700 Each filter is called with three arguments: the transcoded data,
2701 as a string, the back-end, as a symbol, and the communication
2705 ;;;; Objects Filters
2708 "List of functions applied to transcoded bold text.
2709 Each filter is called with three arguments: the transcoded data,
2710 as a string, the back-end, as a symbol, and the communication
2714 "List of functions applied to transcoded code text.
2715 Each filter is called with three arguments: the transcoded data,
2716 as a string, the back-end, as a symbol, and the communication
2720 "List of functions applied to a transcoded entity.
2721 Each filter is called with three arguments: the transcoded data,
2722 as a string, the back-end, as a symbol, and the communication
2726 "List of functions applied to a transcoded export-snippet.
2727 Each filter is called with three arguments: the transcoded data,
2728 as a string, the back-end, as a symbol, and the communication
2732 "List of functions applied to a transcoded footnote-reference.
2733 Each filter is called with three arguments: the transcoded data,
2734 as a string, the back-end, as a symbol, and the communication
2738 "List of functions applied to a transcoded inline-babel-call.
2739 Each filter is called with three arguments: the transcoded data,
2740 as a string, the back-end, as a symbol, and the communication
2744 "List of functions applied to a transcoded inline-src-block.
2745 Each filter is called with three arguments: the transcoded data,
2746 as a string, the back-end, as a symbol, and the communication
2750 "List of functions applied to transcoded italic text.
2751 Each filter is called with three arguments: the transcoded data,
2752 as a string, the back-end, as a symbol, and the communication
2756 "List of functions applied to a transcoded latex-fragment.
2757 Each filter is called with three arguments: the transcoded data,
2758 as a string, the back-end, as a symbol, and the communication
2762 "List of functions applied to a transcoded line-break.
2763 Each filter is called with three arguments: the transcoded data,
2764 as a string, the back-end, as a symbol, and the communication
2768 "List of functions applied to a transcoded link.
2769 Each filter is called with three arguments: the transcoded data,
2770 as a string, the back-end, as a symbol, and the communication
2774 "List of functions applied to a transcoded radio-target.
2775 Each filter is called with three arguments: the transcoded data,
2776 as a string, the back-end, as a symbol, and the communication
2780 "List of functions applied to a transcoded statistics-cookie.
2781 Each filter is called with three arguments: the transcoded data,
2782 as a string, the back-end, as a symbol, and the communication
2786 "List of functions applied to transcoded strike-through text.
2787 Each filter is called with three arguments: the transcoded data,
2788 as a string, the back-end, as a symbol, and the communication
2792 "List of functions applied to a transcoded subscript.
2793 Each filter is called with three arguments: the transcoded data,
2794 as a string, the back-end, as a symbol, and the communication
2798 "List of functions applied to a transcoded superscript.
2799 Each filter is called with three arguments: the transcoded data,
2800 as a string, the back-end, as a symbol, and the communication
2804 "List of functions applied to a transcoded target.
2805 Each filter is called with three arguments: the transcoded data,
2806 as a string, the back-end, as a symbol, and the communication
2810 "List of functions applied to a transcoded timestamp.
2811 Each filter is called with three arguments: the transcoded data,
2812 as a string, the back-end, as a symbol, and the communication
2816 "List of functions applied to transcoded underline text.
2817 Each filter is called with three arguments: the transcoded data,
2818 as a string, the back-end, as a symbol, and the communication
2822 "List of functions applied to transcoded verbatim text.
2823 Each filter is called with three arguments: the transcoded data,
2824 as a string, the back-end, as a symbol, and the communication
2828 ;;;; Filters Tools
2829 ;;
2830 ;; Internal function `org-export-install-filters' installs filters
2831 ;; hard-coded in back-ends (developer filters) and filters from global
2832 ;; variables (user filters) in the communication channel.
2833 ;;
2834 ;; Internal function `org-export-filter-apply-functions' takes care
2835 ;; about applying each filter in order to a given data. It ignores
2836 ;; filters returning a nil value but stops whenever a filter returns
2837 ;; an empty string.
2840 "Call every function in FILTERS.
2842 Functions are called with arguments VALUE, current export
2843 back-end's name and INFO. A function returning a nil value will
2844 be skipped. If it returns the empty string, the process ends and
2845 VALUE is ignored.
2847 Call is done in a LIFO fashion, to be sure that developer
2848 specified filters, if any, are called first."
2859 "Install filters properties in communication channel.
2860 INFO is a plist containing the current communication channel.
2861 Return the updated communication channel."
2863 ;; Install user-defined filters with `org-export-filters-alist'
2864 ;; and filters already in INFO (through ext-plist mechanism).
2871 ;; Filters in INFO will be called
2872 ;; before those user provided.
2875 default-value)))))
2876 org-export-filters-alist)
2877 ;; Prepend back-end specific filters to that list.
2879 ;; Single values get consed, lists are appended.
2884 plist key
2888 ;; Return new communication channel.
2892 \f
2893 ;;; Core functions
2894 ;;
2895 ;; This is the room for the main function, `org-export-as', along with
2896 ;; its derivative, `org-export-string-as'.
2897 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2898 ;; function should be added to kill ring.
2899 ;;
2900 ;; Note that `org-export-as' doesn't really parse the current buffer,
2901 ;; but a copy of it (with the same buffer-local variables and
2902 ;; visibility), where macros and include keywords are expanded and
2903 ;; Babel blocks are executed, if appropriate.
2904 ;; `org-export-with-buffer-copy' macro prepares that copy.
2905 ;;
2906 ;; File inclusion is taken care of by
2907 ;; `org-export-expand-include-keyword' and
2908 ;; `org-export--prepare-file-contents'. Structure wise, including
2909 ;; a whole Org file in a buffer often makes little sense. For
2910 ;; example, if the file contains a headline and the include keyword
2911 ;; was within an item, the item should contain the headline. That's
2912 ;; why file inclusion should be done before any structure can be
2913 ;; associated to the file, that is before parsing.
2914 ;;
2915 ;; `org-export-insert-default-template' is a command to insert
2916 ;; a default template (or a back-end specific template) at point or in
2917 ;; current subtree.
2920 "Return a copy of the current buffer.
2921 The copy preserves Org buffer-local variables, visibility and
2922 narrowing."
2928 new-buf))
2931 "Apply BODY in a copy of the current buffer.
2932 The copy preserves local variables, visibility and contents of
2933 the original buffer. Point is at the beginning of the buffer
2934 when BODY is applied."
2943 ;; Kill copy without confirmation.
2949 "Generate a function duplicating BUFFER.
2951 The copy will preserve local variables, visibility, contents and
2952 narrowing of the original buffer. If a region was active in
2953 BUFFER, contents will be narrowed to that region instead.
2955 The resulting function can be evaluated at a later time, from
2956 another buffer, effectively cloning the original buffer there.
2958 The function assumes BUFFER's major mode is `org-mode'."
2962 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2963 ;; already in BUFFER.
2965 ;; Copy specific buffer local variables and variables set
2966 ;; through BIND keywords.
2968 vars)
2974 ;; Do not share cache across
2975 ;; buffers as values are
2976 ;; modified by side effect.
2977 org-element--cache)))
2980 buffer-file-name
2981 buffer-file-coding-system))
2985 ;; Skip unreadable values, as they cannot be
2986 ;; sent to external process.
2990 vars))))))
2991 ;; Whole buffer contents.
2996 ;; Narrowing.
3000 ;; Current position of point.
3002 ;; Overlays with invisible property.
3012 ov-set))))
3014 ov-set)))))
3016 ;;;###autoload
3019 "Transcode current Org buffer into BACKEND code.
3021 BACKEND is either an export back-end, as returned by, e.g.,
3022 `org-export-create-backend', or a symbol referring to
3023 a registered back-end.
3025 If narrowing is active in the current buffer, only transcode its
3026 narrowed part.
3028 If a region is active, transcode that region.
3030 When optional argument SUBTREEP is non-nil, transcode the
3031 sub-tree at point, extracting information from the headline
3032 properties first.
3034 When optional argument VISIBLE-ONLY is non-nil, don't export
3035 contents of hidden elements.
3037 When optional argument BODY-ONLY is non-nil, only return body
3038 code, without surrounding template.
3040 Optional argument EXT-PLIST, when provided, is a property list
3041 with external parameters overriding Org default settings, but
3042 still inferior to file-local settings.
3044 Return code as a string."
3049 ;; Narrow buffer to an appropriate region or subtree for
3050 ;; parsing. If parsing subtree, be sure to remove main headline
3051 ;; too.
3059 ;; Initialize communication channel with original buffer
3060 ;; attributes, unavailable in its copy.
3069 tree)
3070 ;; Update communication channel and get parse tree. Buffer
3071 ;; isn't parsed directly. Instead, a temporary copy is
3072 ;; created, where include keywords, macros are expanded and
3073 ;; code blocks are evaluated.
3075 ;; Run first hook with current back-end's name as argument.
3079 ;; Update macro templates since #+INCLUDE keywords might have
3080 ;; added some new ones.
3084 ;; Update radio targets since keyword inclusion might have
3085 ;; added some more.
3087 ;; Run last hook with current back-end's name as argument.
3092 ;; Update communication channel with environment. Also
3093 ;; install user's and developer's filters.
3098 ;; Expand export-specific set of macros: {{{author}}},
3099 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3100 ;; once regular macros have been expanded, since document
3101 ;; keywords may contain one of them.
3107 ;; EMAIL is not a parsed keyword: store it as-is.
3111 ;; Parse buffer.
3113 ;; Handle left-over uninterpreted elements or objects in
3114 ;; parse tree and communication channel.
3116 ;; Call options filters and update export options. We do not
3117 ;; use `org-export-filter-apply-functions' here since the
3118 ;; arity of such filters is different.
3123 ;; Parse buffer, handle uninterpreted elements or objects,
3124 ;; then call parse-tree filters.
3128 ;; Now tree is complete, compute its properties and add them
3129 ;; to communication channel.
3133 ;; Eventually transcode TREE. Wrap the resulting string into
3134 ;; a template.
3143 ;; Remove all text properties since they cannot be
3144 ;; retrieved from an external process. Finally call
3145 ;; final-output filter and return result.
3151 info))))))))
3153 ;;;###autoload
3155 "Transcode STRING into BACKEND code.
3157 BACKEND is either an export back-end, as returned by, e.g.,
3158 `org-export-create-backend', or a symbol referring to
3159 a registered back-end.
3161 When optional argument BODY-ONLY is non-nil, only return body
3162 code, without preamble nor postamble.
3164 Optional argument EXT-PLIST, when provided, is a property list
3165 with external parameters overriding Org default settings, but
3166 still inferior to file-local settings.
3168 Return code as a string."
3174 ;;;###autoload
3176 "Replace the active region by its export to BACKEND.
3177 BACKEND is either an export back-end, as returned by, e.g.,
3178 `org-export-create-backend', or a symbol referring to
3179 a registered back-end."
3189 ;;;###autoload
3191 "Insert all export keywords with default values at beginning of line.
3193 BACKEND is a symbol referring to the name of a registered export
3194 back-end, for which specific export options should be added to
3195 the template, or `default' for default template. When it is nil,
3196 the user will be prompted for a category.
3198 If SUBTREEP is non-nil, export configuration will be set up
3199 locally for the subtree through node properties."
3209 "Options category: "
3213 org-export--registered-backends))))))
3214 options keywords)
3215 ;; Populate OPTIONS and KEYWORDS.
3232 ;; Move to an appropriate location in order to insert options.
3234 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3235 ;; list of available keywords.
3263 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3281 ;; And the rest of keywords.
3292 "Expand every include keyword in buffer.
3293 Optional argument INCLUDED is a list of included file names along
3294 with their line restriction, when appropriate. It is used to
3295 avoid infinite recursion. Optional argument DIR is the current
3296 working directory. It is used to properly resolve relative
3297 paths."
3304 ;; Extract arguments from keyword's value.
3312 dir)
3317 value)
3323 ;; Minimal level of included file defaults to the child
3324 ;; level of the current headline, if any, or one. It
3325 ;; only applies is the file is meant to be included as
3326 ;; an Org one.
3334 ;; Remove keyword.
3340 ;; Check if files has already been parsed. Look after
3341 ;; inclusion lines too, as different parts of the same file
3342 ;; can be included too.
3354 ind-str contents ind-str))))
3362 ind-str env contents ind-str))))
3375 "Prepare the contents of FILE for inclusion and return them as a string.
3377 When optional argument LINES is a string specifying a range of
3378 lines, include only those lines.
3380 Optional argument IND, when non-nil, is an integer specifying the
3381 global indentation of returned contents. Since its purpose is to
3382 allow an included file to stay in the same environment it was
3383 created \(i.e. a list item), it doesn't apply past the first
3384 headline encountered.
3386 Optional argument MINLEVEL, when non-nil, is an integer
3387 specifying the level that any top-level headline in the included
3388 file should have."
3404 ;; Remove blank lines at beginning and end of contents. The logic
3405 ;; behind that removal is that blank lines around include keyword
3406 ;; override blank lines in included file.
3415 ;; If IND is set, preserve indentation of include keyword until
3416 ;; the first headline encountered.
3423 ;; Do not move footnote definitions out of column 0.
3429 ;; When MINLEVEL is specified, compute minimal level for headlines
3430 ;; in the file (CUR-MIN), and remove stars to each headline so
3431 ;; that headlines with minimal level have a level of MINLEVEL.
3442 ;; Only change stars, don't bother moving whole
3443 ;; sections.
3450 "Execute every Babel code in the visible part of current buffer."
3451 ;; Get a pristine copy of current buffer so Babel references can be
3452 ;; properly resolved.
3459 "Return a non-nil value when output should be added to the kill ring.
3460 See also `org-export-copy-to-kill-ring'."
3466 \f
3467 ;;; Tools For Back-Ends
3468 ;;
3469 ;; A whole set of tools is available to help build new exporters. Any
3470 ;; function general enough to have its use across many back-ends
3471 ;; should be added here.
3473 ;;;; For Affiliated Keywords
3474 ;;
3475 ;; `org-export-read-attribute' reads a property from a given element
3476 ;; as a plist. It can be used to normalize affiliated keywords'
3477 ;; syntax.
3478 ;;
3479 ;; Since captions can span over multiple lines and accept dual values,
3480 ;; their internal representation is a bit tricky. Therefore,
3481 ;; `org-export-get-caption' transparently returns a given element's
3482 ;; caption as a secondary string.
3485 "Turn ATTRIBUTE property from ELEMENT into a plist.
3487 When optional argument PROPERTY is non-nil, return the value of
3488 that property within attributes.
3492 properties.
3494 All values will become strings except the empty string and
3497 will become the empty string."
3511 s)
3516 ;; Ignore any string before first property with `cdr'.
3521 "Return caption from ELEMENT as a secondary string.
3523 When optional argument SHORTP is non-nil, return short caption,
3524 as a secondary string, instead.
3526 Caption lines are separated by a white space."
3534 ;;;; For Derived Back-ends
3535 ;;
3536 ;; `org-export-with-backend' is a function allowing to locally use
3537 ;; another back-end to transcode some object or element. In a derived
3538 ;; back-end, it may be used as a fall-back function once all specific
3539 ;; cases have been treated.
3542 "Call a transcoder from BACKEND on DATA.
3543 BACKEND is an export back-end, as returned by, e.g.,
3544 `org-export-create-backend', or a symbol referring to
3545 a registered back-end. DATA is an Org element, object, secondary
3546 string or string. CONTENTS, when non-nil, is the transcoded
3547 contents of DATA element, as a string. INFO, when non-nil, is
3548 the communication channel used for export, as a plist."
3558 transcoder data contents
3561 :translate-alist all-transcoders
3565 ;;;; For Export Snippets
3566 ;;
3567 ;; Every export snippet is transmitted to the back-end. Though, the
3568 ;; latter will only retain one type of export-snippet, ignoring
3569 ;; others, based on the former's target back-end. The function
3570 ;; `org-export-snippet-backend' returns that back-end for a given
3571 ;; export-snippet.
3574 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3575 Translation, with `org-export-snippet-translation-alist', is
3576 applied."
3580 back-end))))
3583 ;;;; For Footnotes
3584 ;;
3585 ;; `org-export-collect-footnote-definitions' is a tool to list
3586 ;; actually used footnotes definitions in the whole parse tree, or in
3587 ;; a headline, in order to add footnote listings throughout the
3588 ;; transcoded data.
3589 ;;
3590 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3591 ;; back-ends, when they need to attach the footnote definition only to
3592 ;; the first occurrence of the corresponding label.
3593 ;;
3594 ;; `org-export-get-footnote-definition' and
3595 ;; `org-export-get-footnote-number' provide easier access to
3596 ;; additional information relative to a footnote reference.
3599 "Return an alist between footnote numbers, labels and definitions.
3601 DATA is the parse tree from which definitions are collected.
3602 INFO is the plist used as a communication channel.
3604 Definitions are sorted by order of references. They either
3605 appear as Org data or as a secondary string for inlined
3606 footnotes. Unreferenced definitions are ignored."
3608 collect-fn ; for byte-compiler.
3612 ;; Collect footnote number, label and definition in DATA.
3620 def)
3621 num-alist)
3622 ;; Also search in definition for nested footnotes.
3625 ;; Don't enter footnote definitions since it will happen
3626 ;; when their first reference is found.
3632 "Non-nil when a footnote reference is the first one for its label.
3634 FOOTNOTE-REFERENCE is the footnote reference being considered.
3635 INFO is the plist used as a communication channel."
3637 ;; Anonymous footnotes are always a first reference.
3639 ;; Otherwise, return the first footnote with the same LABEL and
3640 ;; test if it is equal to FOOTNOTE-REFERENCE.
3650 ;; If FN isn't inlined, be sure to traverse its
3651 ;; definition before resuming search. See
3652 ;; comments in `org-export-get-footnote-number'
3653 ;; for more information.
3657 ;; Don't enter footnote definitions since it will
3658 ;; happen when their first reference is found.
3661 footnote-reference)))))
3664 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3665 INFO is the plist used as a communication channel. If no such
3667 string."
3674 "Return number associated to a footnote.
3676 FOOTNOTE is either a footnote reference or a footnote definition.
3677 INFO is the plist used as a communication channel."
3679 seen-refs
3680 search-ref ; For byte-compiler.
3684 ;; Search footnote references through DATA, filling
3685 ;; SEEN-REFS along the way.
3690 ;; Anonymous footnote match: return number.
3693 ;; Labels match: return number.
3696 ;; Anonymous footnote: it's always a new one.
3697 ;; Also, be sure to return nil from the `cond' so
3698 ;; `first-match' doesn't get us out of the loop.
3700 ;; Label not seen so far: add it so SEEN-REFS.
3701 ;;
3702 ;; Also search for subsequent references in
3703 ;; footnote definition so numbering follows
3704 ;; reading logic. Note that we don't have to care
3705 ;; about inline definitions, since
3706 ;; `org-element-map' already traverses them at the
3707 ;; right time.
3708 ;;
3709 ;; Once again, return nil to stay in the loop.
3714 nil))))
3715 ;; Don't enter footnote definitions since it will
3716 ;; happen when their first reference is found.
3721 ;;;; For Headlines
3722 ;;
3723 ;; `org-export-get-relative-level' is a shortcut to get headline
3724 ;; level, relatively to the lower headline level in the parsed tree.
3725 ;;
3726 ;; `org-export-get-headline-number' returns the section number of an
3727 ;; headline, while `org-export-number-to-roman' allows to convert it
3728 ;; to roman numbers.
3729 ;;
3730 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3731 ;; `org-export-last-sibling-p' are three useful predicates when it
3732 ;; comes to fulfill the `:headline-levels' property.
3733 ;;
3734 ;; `org-export-get-tags', `org-export-get-category' and
3735 ;; `org-export-get-node-property' extract useful information from an
3736 ;; headline or a parent headline. They all handle inheritance.
3737 ;;
3738 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3739 ;; as a secondary string, suitable for table of contents. It falls
3740 ;; back onto default title.
3743 "Return HEADLINE relative level within current parsed tree.
3744 INFO is a plist holding contextual information."
3749 "Non-nil when HEADLINE is considered as low level.
3751 INFO is a plist used as a communication channel.
3753 A low level headlines has a relative level greater than
3754 `:headline-levels' property value.
3756 Return value is the difference between HEADLINE relative level
3757 and the last level being considered as high enough, or nil."
3764 "Return HEADLINE numbering as a list of numbers.
3765 INFO is a plist holding contextual information."
3769 "Return a non-nil value if HEADLINE element should be numbered.
3770 INFO is a plist used as a communication channel."
3776 "Convert integer N into a roman numeral."
3789 res)))
3792 "Return list of tags associated to ELEMENT.
3794 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3795 is a plist used as a communication channel.
3797 Select tags (see `org-export-select-tags') and exclude tags (see
3798 `org-export-exclude-tags') are removed from the list.
3800 When non-nil, optional argument TAGS should be a list of strings.
3801 Any tag belonging to this list will also be removed.
3803 When optional argument INHERITED is non-nil, tags can also be
3804 inherited from parent headlines and FILETAGS keywords."
3810 ;; Build complete list of inherited tags.
3821 ;; Add FILETAGS keywords and return results.
3825 "Return node PROPERTY value for BLOB.
3827 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3828 element or object.
3830 If optional argument INHERITED is non-nil, the value can be
3831 inherited from a parent headline.
3833 Return value is a string or nil."
3845 "Return category for element or object BLOB.
3847 INFO is a plist used as a communication channel.
3849 CATEGORY is automatically inherited from a parent headline, from
3850 #+CATEGORY: keyword or created out of original file name. If all
3854 ;; Almost like `org-export-node-property', but we cannot trust
3855 ;; `plist-member' as every headline has a `:CATEGORY'
3856 ;; property, would it be nil or equal to "???" (which has the
3857 ;; same meaning).
3875 "Return alternative title for HEADLINE, as a secondary string.
3876 INFO is a plist used as a communication channel. If no optional
3877 title is defined, fall-back to the regular title."
3882 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3883 INFO is a plist used as a communication channel."
3888 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3889 INFO is a plist used as a communication channel."
3893 ;;;; For Keywords
3894 ;;
3895 ;; `org-export-get-date' returns a date appropriate for the document
3896 ;; to about to be exported. In particular, it takes care of
3897 ;; `org-export-date-timestamp-format'.
3900 "Return date value for the current document.
3902 INFO is a plist used as a communication channel. FMT, when
3903 non-nil, is a time format string that will be applied on the date
3904 if it consists in a single timestamp object. It defaults to
3905 `org-export-date-timestamp-format' when nil.
3907 A proper date can be a secondary string, a string or nil. It is
3908 meant to be translated with `org-export-data' or alike."
3919 ;;;; For Links
3920 ;;
3921 ;; `org-export-solidify-link-text' turns a string into a safer version
3922 ;; for links, replacing most non-standard characters with hyphens.
3923 ;;
3924 ;; `org-export-get-coderef-format' returns an appropriate format
3925 ;; string for coderefs.
3926 ;;
3927 ;; `org-export-inline-image-p' returns a non-nil value when the link
3928 ;; provided should be considered as an inline image.
3929 ;;
3930 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3931 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3932 ;; returns an appropriate unique identifier when found, or nil.
3933 ;;
3934 ;; `org-export-resolve-id-link' returns the first headline with
3935 ;; specified id or custom-id in parse tree, the path to the external
3936 ;; file with the id or nil when neither was found.
3937 ;;
3938 ;; `org-export-resolve-coderef' associates a reference to a line
3939 ;; number in the element it belongs, or returns the reference itself
3940 ;; when the element isn't numbered.
3943 "Take link text S and make a safe target out of it."
3948 "Return format string for code reference link.
3949 PATH is the link path. DESC is its description."
3957 "Non-nil if LINK object points to an inline image.
3959 Optional argument is a set of RULES defining inline images. It
3960 is an alist where associations have the following shape:
3962 \(TYPE . REGEXP)
3964 Applying a rule means apply REGEXP against LINK's path when its
3965 type is TYPE. The function will return a non-nil value if any of
3966 the provided rules is non-nil. The default rule is
3967 `org-export-default-inline-image-rule'.
3969 This only applies to links without a description."
3980 rules)
3981 ;; Return nil if no rule matched.
3982 nil))))
3985 "Resolve a code reference REF.
3987 INFO is a plist used as a communication channel.
3989 Return associated line number in source code, or REF itself,
3990 depending on src-block or example element's switches."
3997 org-coderef-label-format)))
4001 ;; Element containing REF is found. Resolve it to either
4002 ;; a label or a line number, as needed.
4012 "Return LINK destination.
4014 INFO is a plist holding contextual information.
4016 Return value can be an object, an element, or nil:
4018 - If LINK path matches a target object (i.e. <<path>>) return it.
4020 - If LINK path exactly matches the name affiliated keyword
4021 \(i.e. #+NAME: path) of an element, return that element.
4023 - If LINK path exactly matches any headline name, return that
4024 element. If more than one headline share that name, priority
4025 will be given to the one with the closest common ancestor, if
4026 any, or the first one in the parse tree otherwise.
4028 - Otherwise, return nil.
4031 significant."
4034 ;; Split PATH at white spaces so matches are space
4035 ;; insensitive.
4038 ;; Cache for destinations that are not position dependent.
4046 ;; Destination is not position dependent: use cached value.
4048 ;; First try to find a matching "<<path>>" unless user specified
4049 ;; he was looking for a headline (path starts with a "*"
4050 ;; character).
4056 path)
4057 blob))
4060 ;; Then try to find an element with a matching "#+NAME: path"
4061 ;; affiliated keyword.
4064 org-element-all-elements
4069 el)))
4072 ;; Last case: link either points to a headline or to nothingness.
4073 ;; Try to find the source, with priority given to headlines with
4074 ;; the closest common ancestor. If such candidate is found,
4075 ;; return it, otherwise return nil.
4079 ;; Return first headline whose `:raw-value' property is
4080 ;; NAME in parse tree DATA, or nil. Statistics cookies
4081 ;; are ignored.
4089 name)
4090 headline))
4092 ;; Search among headlines sharing an ancestor with link, from
4093 ;; closest to farthest.
4102 ;; No destination found: return nil.
4106 "Return headline referenced as LINK destination.
4108 INFO is a plist used as a communication channel.
4110 Return value can be the headline element matched in current parse
4114 ;; First check if id is within the current parse tree.
4119 headline))
4121 ;; Otherwise, look for external files.
4125 "Return radio-target object referenced as LINK destination.
4127 INFO is a plist used as a communication channel.
4129 Return value can be a radio-target object or nil. Assume LINK
4138 nil nil path nil nil t)
4139 t)
4140 radio))
4144 ;;;; For References
4145 ;;
4146 ;; `org-export-get-ordinal' associates a sequence number to any object
4147 ;; or element.
4150 "Return ordinal number of an element or object.
4152 ELEMENT is the element or object considered. INFO is the plist
4153 used as a communication channel.
4155 Optional argument TYPES, when non-nil, is a list of element or
4156 object types, as symbols, that should also be counted in.
4157 Otherwise, only provided element's type is considered.
4159 Optional argument PREDICATE is a function returning a non-nil
4160 value if the current element or object should be counted in. It
4161 accepts two arguments: the element or object being considered and
4162 the plist used as a communication channel. This allows to count
4163 only a certain type of objects (i.e. inline images).
4165 Return value is a list of numbers if ELEMENT is a headline or an
4166 item. It is nil for keywords. It represents the footnote number
4167 for footnote definitions and footnote references. If ELEMENT is
4168 a target, return the same value as if ELEMENT was the closest
4169 table, item or headline containing the target. In any other
4170 case, return the sequence number of ELEMENT among elements or
4171 objects of the same type."
4172 ;; Ordinal of a target object refer to the ordinal of the closest
4173 ;; table, item, or headline containing the object.
4177 when
4181 table))
4182 return parent)))
4184 ;; Special case 1: A headline returns its number as a list.
4186 ;; Special case 2: An item returns its number as a list.
4190 struct
4197 ;; Increment counter until ELEMENT is found again.
4208 ;;;; For Src-Blocks
4209 ;;
4210 ;; `org-export-get-loc' counts number of code lines accumulated in
4211 ;; src-block or example-block elements with a "+n" switch until
4212 ;; a given element, excluded. Note: "-n" switches reset that count.
4213 ;;
4214 ;; `org-export-unravel-code' extracts source code (along with a code
4215 ;; references alist) from an `element-block' or `src-block' type
4216 ;; element.
4217 ;;
4218 ;; `org-export-format-code' applies a formatting function to each line
4219 ;; of code, providing relative line number and code reference when
4220 ;; appropriate. Since it doesn't access the original element from
4221 ;; which the source code is coming, it expects from the code calling
4222 ;; it to know if lines should be numbered and if code references
4223 ;; should appear.
4224 ;;
4225 ;; Eventually, `org-export-format-code-default' is a higher-level
4226 ;; function (it makes use of the two previous functions) which handles
4227 ;; line numbering and code references inclusion, and returns source
4228 ;; code in a format suitable for plain text or verbatim output.
4231 "Return accumulated lines of code up to ELEMENT.
4233 INFO is the plist used as a communication channel.
4235 ELEMENT is excluded from count."
4241 ;; ELEMENT is reached: Quit the loop.
4243 ;; Only count lines from src-block and example-block elements
4244 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4248 ;; Accumulate locs or reset them.
4252 ;; Return nil to stay in the loop.
4253 nil)))
4255 ;; Return value.
4256 loc))
4259 "Clean source code and extract references out of it.
4261 ELEMENT has either a `src-block' an `example-block' type.
4263 Return a cons cell whose CAR is the source code, cleaned from any
4264 reference, protective commas and spurious indentation, and CDR is
4265 an alist between relative line number (integer) and name of code
4266 reference on that line (string)."
4269 ;; Get code and clean it. Remove blank lines at its
4270 ;; beginning and end.
4277 value
4279 ;; Get format used for references.
4282 org-coderef-label-format)))
4283 ;; Build a regexp matching a loc with a reference.
4288 ;; Return value.
4290 ;; Code with references removed.
4296 ;; Ref line: remove ref, and signal its position in REFS.
4300 ;; Reference alist.
4301 refs)))
4304 "Format CODE by applying FUN line-wise and return it.
4306 CODE is a string representing the code to format. FUN is
4307 a function. It must accept three arguments: a line of
4308 code (string), the current line number (integer) or nil and the
4309 reference associated to the current line (string) or nil.
4311 Optional argument NUM-LINES can be an integer representing the
4312 number of code lines accumulated until the current code. Line
4313 numbers passed to FUN will take it into account. If it is nil,
4314 FUN's second argument will always be nil. This number can be
4315 obtained with `org-export-get-loc' function.
4317 Optional argument REF-ALIST can be an alist between relative line
4318 number (i.e. ignoring NUM-LINES) and the name of the code
4319 reference on it. If it is nil, FUN's third argument will always
4320 be nil. It can be obtained through the use of
4321 `org-export-unravel-code' function."
4333 "Return source code from ELEMENT, formatted in a standard way.
4335 ELEMENT is either a `src-block' or `example-block' element. INFO
4336 is a plist used as a communication channel.
4338 This function takes care of line numbering and code references
4339 inclusion. Line numbers, when applicable, appear at the
4340 beginning of the line, separated from the code by two white
4341 spaces. Code references, on the other hand, appear flushed to
4342 the right, separated by six white spaces from the widest line of
4343 code."
4344 ;; Extract code and references.
4351 ;; Handle line numbering.
4360 ;; Prepare references display, if required. Any reference
4361 ;; should start six columns after the widest line of code,
4362 ;; wrapped with parenthesis.
4367 code
4371 number-str
4372 loc
4378 num-start refs)))))
4381 ;;;; For Tables
4382 ;;
4383 ;; `org-export-table-has-special-column-p' and and
4384 ;; `org-export-table-row-is-special-p' are predicates used to look for
4385 ;; meta-information about the table structure.
4386 ;;
4387 ;; `org-table-has-header-p' tells when the rows before the first rule
4388 ;; should be considered as table's header.
4389 ;;
4390 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4391 ;; and `org-export-table-cell-borders' extract information from
4392 ;; a table-cell element.
4393 ;;
4394 ;; `org-export-table-dimensions' gives the number on rows and columns
4395 ;; in the table, ignoring horizontal rules and special columns.
4396 ;; `org-export-table-cell-address', given a table-cell object, returns
4397 ;; the absolute address of a cell. On the other hand,
4398 ;; `org-export-get-table-cell-at' does the contrary.
4399 ;;
4400 ;; `org-export-table-cell-starts-colgroup-p',
4401 ;; `org-export-table-cell-ends-colgroup-p',
4402 ;; `org-export-table-row-starts-rowgroup-p',
4403 ;; `org-export-table-row-ends-rowgroup-p',
4404 ;; `org-export-table-row-starts-header-p' and
4405 ;; `org-export-table-row-ends-header-p' indicate position of current
4406 ;; row or cell within the table.
4409 "Non-nil when TABLE has a special column.
4410 All special columns will be ignored during export."
4411 ;; The table has a special column when every first cell of every row
4412 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4413 ;; "*" "_" and "^". Though, do not consider a first row containing
4414 ;; only empty cells as special.
4430 "Non-nil when TABLE has a header.
4432 INFO is a plist used as a communication channel.
4434 A table has a header when it contains at least two row groups."
4443 table
4454 cache)))))
4457 "Non-nil if TABLE-ROW is considered special.
4459 INFO is a plist used as the communication channel.
4461 All special rows will be ignored during export."
4465 ;; A row is special either when...
4467 ;; ... it starts with a field only containing "/",
4469 ;; ... the table contains a special column and the row start
4470 ;; with a marking character among, "^", "_", "$" or "!",
4474 ;; ... it contains only alignment cookies and empty cells.
4480 ;; Since VALUE is a secondary string, the following
4481 ;; checks avoid expanding it with `org-export-data'.
4493 "Return TABLE-ROW's group number, as an integer.
4495 INFO is a plist used as the communication channel.
4497 Return value is the group number, as an integer, or nil for
4498 special rows and rows separators. First group is also table's
4499 header."
4517 "Return TABLE-CELL contents width.
4519 INFO is a plist used as the communication channel.
4521 Return value is the width given by the last width cookie in the
4522 same column as TABLE-CELL, or nil."
4541 ;; In a special row, try to find a width cookie at COLUMN.
4545 ;; The following checks avoid expanding unnecessarily
4546 ;; the cell with `org-export-data'.
4556 "Return TABLE-CELL contents alignment.
4558 INFO is a plist used as the communication channel.
4560 Return alignment as specified by the last alignment cookie in the
4561 same column as TABLE-CELL. If no such cookie is found, a default
4562 alignment value will be deduced from fraction of numbers in the
4563 column (see `org-table-number-fraction' for more information).
4564 Possible values are `left', `right' and `center'."
4565 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4582 cookie-align
4583 previous-cell-number-p)
4586 ;; In a special row, try to find an alignment cookie at
4587 ;; COLUMN.
4591 ;; Since VALUE is a secondary string, the following
4592 ;; checks avoid useless expansion through
4593 ;; `org-export-data'.
4601 ;; Ignore table rules.
4603 ;; In a standard row, check if cell's contents are
4604 ;; expressing some kind of number. Increase NUMBER-CELLS
4605 ;; accordingly. Though, don't bother if an alignment
4606 ;; cookie has already defined cell's alignment.
4611 info)))
4613 ;; Treat an empty cell as a number if it follows
4614 ;; a number.
4620 ;; Return value. Alignment specified by cookies has
4621 ;; precedence over alignment deduced from cell's contents.
4623 column
4628 org-table-number-fraction)
4633 "Return TABLE-CELL borders.
4635 INFO is a plist used as a communication channel.
4637 Return value is a list of symbols, or nil. Possible values are:
4638 `top', `bottom', `above', `below', `left' and `right'. Note:
4639 `top' (resp. `bottom') only happen for a cell in the first
4640 row (resp. last row) of the table, ignoring table rules, if any.
4642 Returned borders ignore special rows."
4645 borders)
4646 ;; Top/above border? TABLE-CELL has a border above when a rule
4647 ;; used to demarcate row groups can be found above. Hence,
4648 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4649 ;; another regular row has to be found above that rule.
4658 ;; Look at every row before the current one.
4660 ;; No rule above, or rule found starts the table (ignoring any
4661 ;; special row): TABLE-CELL is at the top of the table.
4664 ;; Bottom/below border? TABLE-CELL has a border below when next
4665 ;; non-regular row below is a rule.
4674 ;; Look at every row after the current one.
4676 ;; No rule below, or rule found ends the table (modulo some
4677 ;; special row): TABLE-CELL is at the bottom of the table.
4680 ;; Right/left borders? They can only be specified by column
4681 ;; groups. Column groups are defined in a row starting with "/".
4682 ;; Also a column groups row only contains "<", "<>", ">" or blank
4683 ;; cells.
4700 ;; There's a left border when previous cell, if
4701 ;; any, ends a group, or current one starts one.
4707 ;; There's a right border when next cell, if any,
4708 ;; starts a group, or current one ends one.
4715 ;; Table rows are read in reverse order so last column groups
4716 ;; row has precedence over any previous one.
4718 ;; Return value.
4719 borders))
4722 "Non-nil when TABLE-CELL is at the beginning of a column group.
4723 INFO is a plist used as a communication channel."
4724 ;; A cell starts a column group either when it is at the beginning
4725 ;; of a row (or after the special column, if any) or when it has
4726 ;; a left border.
4729 table-cell)
4733 "Non-nil when TABLE-CELL is at the end of a column group.
4734 INFO is a plist used as a communication channel."
4735 ;; A cell ends a column group either when it is at the end of a row
4736 ;; or when it has a right border.
4739 table-cell)
4743 "Non-nil when TABLE-ROW is at the beginning of a row group.
4744 INFO is a plist used as a communication channel."
4752 "Non-nil when TABLE-ROW is at the end of a row group.
4753 INFO is a plist used as a communication channel."
4761 "Non-nil when TABLE-ROW is the first table header's row.
4762 INFO is a plist used as a communication channel."
4769 "Non-nil when TABLE-ROW is the last table header's row.
4770 INFO is a plist used as a communication channel."
4777 "Return TABLE-ROW number.
4778 INFO is a plist used as a communication channel. Return value is
4779 zero-based and ignores separators. The function returns nil for
4780 special columns and separators."
4792 "Return TABLE dimensions.
4794 INFO is a plist used as a communication channel.
4796 Return value is a CONS like (ROWS . COLUMNS) where
4797 ROWS (resp. COLUMNS) is the number of exportable
4798 rows (resp. columns)."
4800 ;; Set number of rows, and extract first one.
4806 ;; Set number of columns.
4808 ;; Return value.
4812 "Return address of a regular TABLE-CELL object.
4814 TABLE-CELL is the cell considered. INFO is a plist used as
4815 a communication channel.
4817 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4818 zero-based index. Only exportable cells are considered. The
4819 function returns nil for other cells."
4831 "Return regular table-cell object at ADDRESS in TABLE.
4833 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4834 zero-based index. TABLE is a table type element. INFO is
4835 a plist used as a communication channel.
4837 If no table-cell, among exportable cells, is found at ADDRESS,
4838 return nil."
4841 ;; Row at (car address) or nil.
4849 'table-cell
4856 ;;;; For Tables Of Contents
4857 ;;
4858 ;; `org-export-collect-headlines' builds a list of all exportable
4859 ;; headline elements, maybe limited to a certain depth. One can then
4860 ;; easily parse it and transcode it.
4861 ;;
4862 ;; Building lists of tables, figures or listings is quite similar.
4863 ;; Once the generic function `org-export-collect-elements' is defined,
4864 ;; `org-export-collect-tables', `org-export-collect-figures' and
4865 ;; `org-export-collect-listings' can be derived from it.
4868 "Collect headlines in order to build a table of contents.
4870 INFO is a plist used as a communication channel.
4872 When optional argument N is an integer, it specifies the depth of
4873 the table of contents. Otherwise, it is set to the value of the
4874 last headline level. See `org-export-headline-levels' for more
4875 information.
4877 Return a list of all exportable headlines as parsed elements.
4878 Footnote sections, if any, will be ignored."
4886 info)))
4889 "Collect referenceable elements of a determined type.
4891 TYPE can be a symbol or a list of symbols specifying element
4892 types to search. Only elements with a caption are collected.
4894 INFO is a plist used as a communication channel.
4896 When non-nil, optional argument PREDICATE is a function accepting
4897 one argument, an element of type TYPE. It returns a non-nil
4898 value when that element should be collected.
4900 Return a list of all elements found, in order of appearance."
4905 element))
4906 info))
4909 "Build a list of tables.
4910 INFO is a plist used as a communication channel.
4912 Return a list of table elements with a caption."
4916 "Build a list of figures.
4918 INFO is a plist used as a communication channel. PREDICATE is
4919 a function which accepts one argument: a paragraph element and
4920 whose return value is non-nil when that element should be
4921 collected.
4923 A figure is a paragraph type element, with a caption, verifying
4925 a vague concept that may depend on back-end.
4927 Return a list of elements recognized as figures."
4931 "Build a list of src blocks.
4933 INFO is a plist used as a communication channel.
4935 Return a list of src-block elements with a caption."
4939 ;;;; Smart Quotes
4940 ;;
4941 ;; The main function for the smart quotes sub-system is
4942 ;; `org-export-activate-smart-quotes', which replaces every quote in
4943 ;; a given string from the parse tree with its "smart" counterpart.
4944 ;;
4945 ;; Dictionary for smart quotes is stored in
4946 ;; `org-export-smart-quotes-alist'.
4947 ;;
4948 ;; Internally, regexps matching potential smart quotes (checks at
4949 ;; string boundaries are also necessary) are defined in
4950 ;; `org-export-smart-quotes-regexps'.
4954 ;; one may use: »...«, "...", ›...‹, or '...'.
4955 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4956 ;; LaTeX quotes require Babel!
5001 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5010 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5019 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5028 ;; 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
5029 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5040 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5046 )
5047 "Smart quotes translations.
5049 Alist whose CAR is a language string and CDR is an alist with
5050 quote type as key and a plist associating various encodings to
5051 their translation as value.
5053 A quote type can be any symbol among `opening-double-quote',
5054 `closing-double-quote', `opening-single-quote',
5055 `closing-single-quote' and `apostrophe'.
5057 Valid encodings include `:utf-8', `:html', `:latex' and
5058 `:texinfo'.
5064 ;; Possible opening quote at beginning of string.
5066 ;; Possible closing quote at beginning of string.
5068 ;; Possible apostrophe at beginning of string.
5070 ;; Opening single and double quotes.
5072 ;; Closing single and double quotes.
5074 ;; Apostrophe.
5076 ;; Possible opening quote at end of string.
5078 ;; Possible closing quote at end of string.
5080 ;; Possible apostrophe at end of string.
5082 "List of regexps matching a quote or an apostrophe.
5088 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5089 `:utf-8'. INFO is a plist used as a communication channel.
5091 The function has to retrieve information about string
5092 surroundings in parse tree. It can only happen with an
5093 unmodified string. Thus, if S has already been through another
5094 process, a non-nil ORIGINAL optional argument will provide that
5095 original string.
5097 Return the new string."
5100 ;; Try to be flexible when computing number of blanks
5101 ;; before object. The previous object may be a string
5102 ;; introduced by the back-end and not completely parsed.
5105 ;; A string with missing `:post-blank'
5106 ;; property.
5110 ;; Fallback value.
5115 ;; Return smart quote associated to a give quote Q, as
5116 ;; a string. TYPE is a symbol among `open', `close' and
5117 ;; `apostrophe'.
5127 org-export-smart-quotes-alist))))
5128 encoding)
5129 q)))))
5131 ;; Only a quote: no regexp can match. We have to check both
5132 ;; sides and decide what to do.
5140 ;; 1. Replace quote character at the beginning of S.
5142 ;; Apostrophe?
5148 ;; Closing quote?
5154 ;; Opening quote?
5160 ;; 2. Replace quotes in the middle of the string.
5162 ;; Opening quotes.
5168 ;; Closing quotes.
5174 ;; Apostrophes.
5179 ;; 3. Replace quote character at the end of S.
5181 ;; Apostrophe?
5186 ;; Closing quote?
5192 ;; Opening quote?
5197 ;; Return string with smart quotes.
5198 s))))
5200 ;;;; Topology
5201 ;;
5202 ;; Here are various functions to retrieve information about the
5203 ;; neighbourhood of a given element or object. Neighbours of interest
5204 ;; are direct parent (`org-export-get-parent'), parent headline
5205 ;; (`org-export-get-parent-headline'), first element containing an
5206 ;; object, (`org-export-get-parent-element'), parent table
5207 ;; (`org-export-get-parent-table'), previous element or object
5208 ;; (`org-export-get-previous-element') and next element or object
5209 ;; (`org-export-get-next-element').
5210 ;;
5211 ;; `org-export-get-genealogy' returns the full genealogy of a given
5212 ;; element or object, from closest parent to full parse tree.
5215 "Return full genealogy relative to a given element or object.
5217 BLOB is the element or object being considered.
5219 Ancestors are returned from closest to farthest, the last one
5220 being the full parse tree."
5227 "Return BLOB parent headline or nil.
5228 BLOB is the element or object being considered."
5232 parent))
5235 "Return first element containing OBJECT or nil.
5236 OBJECT is the object to consider."
5240 parent))
5243 "Return OBJECT parent table or nil.
5244 OBJECT is either a `table-cell' or `table-element' type object."
5248 parent))
5251 "Return previous element or object.
5253 BLOB is an element or object. INFO is a plist used as
5254 a communication channel. Return previous exportable element or
5255 object, a string, or nil.
5257 When optional argument N is a positive integer, return a list
5258 containing up to N siblings before BLOB, from farthest to
5259 closest. With any other non-nil value, return a list containing
5260 all of them."
5266 prev)
5276 "Return next element or object.
5278 BLOB is an element or object. INFO is a plist used as
5279 a communication channel. Return next exportable element or
5280 object, a string, or nil.
5282 When optional argument N is a positive integer, return a list
5283 containing up to N siblings after BLOB, from closest to farthest.
5284 With any other non-nil value, return a list containing all of
5285 them."
5292 next)
5302 ;;;; Translation
5303 ;;
5304 ;; `org-export-translate' translates a string according to the language
5305 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5306 ;; the dictionary used for the translation.
5353 ("ru" :html "(Продолжение следует)"
5451 ("ru" :html "Список распечаток"
5464 ("ru" :html "Список таблиц"
5544 ("ru" :html "Неизвестная ссылка"
5547 "Dictionary for export engine.
5549 Alist whose CAR is the string to translate and CDR is an alist
5550 whose CAR is the language string and CDR is a plist whose
5551 properties are possible charsets and values translated terms.
5553 It is used as a database for `org-export-translate'. Since this
5554 function returns the string as-is if no translation was found,
5555 the variable only needs to record values different from the
5559 "Translate string S according to language specification.
5561 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5562 and `:utf-8'. INFO is a plist used as a communication channel.
5564 Translation depends on `:language' property. Return the
5565 translated string. If no translation is found, try to fall back
5566 to `:default' encoding. If it fails, return S."
5572 s)))
5575 \f
5576 ;;; Asynchronous Export
5577 ;;
5578 ;; `org-export-async-start' is the entry point for asynchronous
5579 ;; export. It recreates current buffer (including visibility,
5580 ;; narrowing and visited file) in an external Emacs process, and
5581 ;; evaluates a command there. It then applies a function on the
5582 ;; returned results in the current process.
5583 ;;
5584 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5585 ;; allow to export to a buffer or a file, asynchronously or not.
5586 ;;
5587 ;; `org-export-output-file-name' is an auxiliary function meant to be
5588 ;; used with `org-export-to-file'. With a given extension, it tries
5589 ;; to provide a canonical file name to write export output to.
5590 ;;
5591 ;; Asynchronously generated results are never displayed directly.
5592 ;; Instead, they are stored in `org-export-stack-contents'. They can
5593 ;; then be retrieved by calling `org-export-stack'.
5594 ;;
5595 ;; Export Stack is viewed through a dedicated major mode
5596 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5597 ;;`org-export-stack-delete', `org-export-stack-view' and
5598 ;;`org-export-stack-clear'.
5599 ;;
5600 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5601 ;; It should be used whenever `org-export-async-start' is called.
5604 "Call function FUN on the results returned by BODY evaluation.
5606 BODY evaluation happens in an asynchronous process, from a buffer
5607 which is an exact copy of the current one.
5609 Use `org-export-add-to-stack' in FUN in order to register results
5610 in the stack.
5612 This is a low level function. See also `org-export-to-buffer'
5613 and `org-export-to-file' for more specialized functions."
5616 ;; Write the full sexp evaluating BODY in a copy of the current
5617 ;; buffer to a temporary file, as it may be too long for program
5618 ;; args in `start-process'.
5625 ;; Null characters (from variable values) are inserted
5626 ;; within the file. As a consequence, coding system for
5627 ;; buffer contents will not be recognized properly. So,
5628 ;; we make sure it is the same as the one used to display
5629 ;; the original buffer.
5631 ,coding
5634 ;; Ignore `kill-emacs-hook' and code evaluation
5635 ;; queries from Babel as we need a truly
5636 ;; non-interactive process.
5638 org-babel-confirm-evaluate-answer-no t)
5639 ;; Initialize export framework.
5641 ;; Re-create current buffer there.
5644 ;; Sexp to evaluate in the buffer.
5646 ;; Start external process.
5649 (,process
5651 #'start-process
5654 ,proc-buffer
5661 ;; Register running process in stack.
5663 ;; Set-up sentinel in order to catch results.
5666 ,process
5688 ;;;###autoload
5691 &optional async subtreep visible-only body-only ext-plist
5692 post-process)
5693 "Call `org-export-as' with output to a specified buffer.
5695 BACKEND is either an export back-end, as returned by, e.g.,
5696 `org-export-create-backend', or a symbol referring to
5697 a registered back-end.
5699 BUFFER is the name of the output buffer. If it already exists,
5700 it will be erased first, otherwise, it will be created.
5702 A non-nil optional argument ASYNC means the process should happen
5703 asynchronously. The resulting buffer should then be accessible
5704 through the `org-export-stack' interface. When ASYNC is nil, the
5705 buffer is displayed if `org-export-show-temporary-export-buffer'
5706 is non-nil.
5708 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5709 EXT-PLIST are similar to those used in `org-export-as', which
5710 see.
5712 Optional argument POST-PROCESS is a function which should accept
5713 no argument. It is always called within the current process,
5714 from BUFFER, with point at its beginning. Export back-ends can
5715 use it to set a major mode there, e.g,
5717 \(defun org-latex-export-as-latex
5718 \(&optional async subtreep visible-only body-only ext-plist)
5719 \(interactive)
5721 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5723 This function returns BUFFER."
5751 buffer)))
5753 ;;;###autoload
5756 post-process)
5757 "Call `org-export-as' with output to a specified file.
5759 BACKEND is either an export back-end, as returned by, e.g.,
5760 `org-export-create-backend', or a symbol referring to
5761 a registered back-end. FILE is the name of the output file, as
5762 a string.
5764 A non-nil optional argument ASYNC means the process should happen
5765 asynchronously. The resulting buffer will then be accessible
5766 through the `org-export-stack' interface.
5768 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5769 EXT-PLIST are similar to those used in `org-export-as', which
5770 see.
5772 Optional argument POST-PROCESS is called with FILE as its
5773 argument and happens asynchronously when ASYNC is non-nil. It
5774 has to return a file name, or nil. Export back-ends can use this
5775 to send the output file through additional processing, e.g,
5777 \(defun org-latex-export-to-latex
5778 \(&optional async subtreep visible-only body-only ext-plist)
5779 \(interactive)
5781 \(org-export-to-file 'latex outfile
5782 async subtreep visible-only body-only ext-plist
5783 \(lambda (file) (org-latex-compile file)))
5785 The function returns either a file name returned by POST-PROCESS,
5786 or FILE."
5804 backend subtreep visible-only body-only ext-plist)))
5811 ;; Get proper return value.
5813 file))))))
5816 "Return output file's name according to buffer specifications.
5818 EXTENSION is a string representing the output file extension,
5819 with the leading dot.
5821 With a non-nil optional argument SUBTREEP, try to determine
5823 of subtree at point.
5825 When optional argument PUB-DIR is set, use it as the publishing
5826 directory.
5828 When optional argument VISIBLE-ONLY is non-nil, don't export
5829 contents of hidden elements.
5831 Return file name as a string."
5834 ;; File name may come from EXPORT_FILE_NAME subtree
5835 ;; property, assuming point is at beginning of said
5836 ;; sub-tree.
5843 ;; File name may be extracted from buffer's associated
5844 ;; file, if any.
5846 ;; Can't determine file name on our own: Ask user.
5850 "Output file: " pub-dir nil nil nil
5854 ;; Build file name. Enforce EXTENSION over whatever user
5855 ;; may have come up with. PUB-DIR, if defined, always has
5856 ;; precedence over any provided path.
5861 extension))
5864 ;; If writing to OUTPUT-FILE would overwrite original file, append
5865 ;; EXTENSION another time to final name.
5868 output-file)))
5871 "Add a new result to export stack if not present already.
5873 SOURCE is a buffer or a file name containing export results.
5874 BACKEND is a symbol representing export back-end used to generate
5875 it.
5877 Entries already pointing to SOURCE and unavailable entries are
5878 removed beforehand. Return the new stack."
5884 "Menu for asynchronous export results and running processes."
5894 "Return source from export results at point in stack."
5901 source
5902 ;; SOURCE is not consistent with current line. The stack
5903 ;; view is outdated.
5907 "Remove all entries from export stack."
5912 "Refresh the asynchronous export stack.
5913 DUMMY is ignored. Unavailable sources are removed from the list.
5914 Return the new stack."
5924 ;; Back-end.
5926 ;; Age.
5929 ;; Compute age of the results.
5931 "%4h:%.2m "
5933 ;; Source.
5938 ;; Clear stack from exited processes, dead buffers or
5939 ;; non-existent files.
5951 "Remove export results at point from stack.
5952 If optional argument SOURCE is non-nil, remove it instead."
5957 org-export-stack-contents))))
5960 "View export results at point in stack.
5961 With an optional prefix argument IN-EMACS, force viewing files
5962 within Emacs."
5976 (define-key km "p" 'previous-line)
5977 (define-key km "\C-p" 'previous-line)
5978 (define-key km "\C-?" 'previous-line)
5979 (define-key km [up] 'previous-line)
5980 (define-key km "C" 'org-export-stack-clear)
5981 (define-key km "v" 'org-export-stack-view)
5982 (define-key km (kbd "RET") 'org-export-stack-view)
5983 (define-key km "d" 'org-export-stack-remove)
5984 km)
5985 "Keymap for Org Export Stack.")
5987 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5988 "Mode for displaying asynchronous export stack.
5991 stack.
5993 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5994 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5995 stack completely.
5997 Removing entries in an Org Export Stack buffer doesn't affect
5998 files or buffers, only the display.
6001 (abbrev-mode 0)
6002 (auto-fill-mode 0)
6003 (setq buffer-read-only t
6004 buffer-undo-list t
6005 truncate-lines t
6006 header-line-format
6007 '(:eval
6008 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6009 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6010 (set (make-local-variable 'revert-buffer-function)
6011 'org-export-stack-refresh))
6014 \f
6015 ;;; The Dispatcher
6016 ;;
6017 ;; `org-export-dispatch' is the standard interactive way to start an
6018 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6019 ;; for its interface, which, in turn, delegates response to key
6020 ;; pressed to `org-export--dispatch-action'.
6022 ;;;###autoload
6023 (defun org-export-dispatch (&optional arg)
6024 "Export dispatcher for Org mode.
6026 It provides an access to common export related tasks in a buffer.
6027 Its interface comes in two flavors: standard and expert.
6029 While both share the same set of bindings, only the former
6030 displays the valid keys associations in a dedicated buffer.
6031 Scrolling (resp. line-wise motion) in this buffer is done with
6032 SPC and DEL (resp. C-n and C-p) keys.
6034 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6035 flavor or the other.
6038 of options used back then, on the current buffer.
6040 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6041 (interactive "P")
6042 (let* ((input
6043 (cond ((equal arg '(16)) '(stack))
6044 ((and arg org-export-dispatch-last-action))
6045 (t (save-window-excursion
6046 (unwind-protect
6047 (progn
6048 ;; Remember where we are
6049 (move-marker org-export-dispatch-last-position
6050 (point)
6051 (org-base-buffer (current-buffer)))
6052 ;; Get and store an export command
6053 (setq org-export-dispatch-last-action
6054 (org-export--dispatch-ui
6055 (list org-export-initial-scope
6056 (and org-export-in-background 'async))
6057 nil
6058 org-export-dispatch-use-expert-ui)))
6059 (and (get-buffer "*Org Export Dispatcher*")
6060 (kill-buffer "*Org Export Dispatcher*")))))))
6061 (action (car input))
6062 (optns (cdr input)))
6063 (unless (memq 'subtree optns)
6064 (move-marker org-export-dispatch-last-position nil))
6065 (case action
6066 ;; First handle special hard-coded actions.
6067 (template (org-export-insert-default-template nil optns))
6068 (stack (org-export-stack))
6069 (publish-current-file
6070 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6071 (publish-current-project
6072 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6073 (publish-choose-project
6074 (org-publish (assoc (org-icompleting-read
6075 "Publish project: "
6076 org-publish-project-alist nil t)
6077 org-publish-project-alist)
6078 (memq 'force optns)
6079 (memq 'async optns)))
6080 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6081 (otherwise
6082 (save-excursion
6083 (when arg
6084 ;; Repeating command, maybe move cursor to restore subtree
6085 ;; context.
6086 (if (eq (marker-buffer org-export-dispatch-last-position)
6087 (org-base-buffer (current-buffer)))
6088 (goto-char org-export-dispatch-last-position)
6089 ;; We are in a different buffer, forget position.
6090 (move-marker org-export-dispatch-last-position nil)))
6091 (funcall action
6092 ;; Return a symbol instead of a list to ease
6093 ;; asynchronous export macro use.
6094 (and (memq 'async optns) t)
6095 (and (memq 'subtree optns) t)
6096 (and (memq 'visible optns) t)
6097 (and (memq 'body optns) t)))))))
6099 (defun org-export--dispatch-ui (options first-key expertp)
6100 "Handle interface for `org-export-dispatch'.
6102 OPTIONS is a list containing current interactive options set for
6103 export. It can contain any of the following symbols:
6104 `body' toggles a body-only export
6105 `subtree' restricts export to current subtree
6106 `visible' restricts export to visible part of buffer.
6107 `force' force publishing files.
6108 `async' use asynchronous export process
6110 FIRST-KEY is the key pressed to select the first level menu. It
6111 is nil when this menu hasn't been selected yet.
6113 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6114 buffer is provided, but indications about currently active
6115 options are given in the prompt. Moreover, \[?] allows to switch
6116 back to standard interface."
6117 (let* ((fontify-key
6118 (lambda (key &optional access-key)
6119 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6120 ;; non-nil is the required first-level key to activate
6121 ;; KEY. When its value is t, activate KEY independently
6122 ;; on the first key, if any. A nil value means KEY will
6123 ;; only be activated at first level.
6124 (if (or (eq access-key t) (eq access-key first-key))
6125 (org-propertize key 'face 'org-warning)
6126 key)))
6127 (fontify-value
6128 (lambda (value)
6129 ;; Fontify VALUE string.
6130 (org-propertize value 'face 'font-lock-variable-name-face)))
6131 ;; Prepare menu entries by extracting them from registered
6132 ;; back-ends and sorting them by access key and by ordinal,
6133 ;; if any.
6134 (entries
6135 (sort (sort (delq nil
6136 (mapcar 'org-export-backend-menu
6137 org-export--registered-backends))
6138 (lambda (a b)
6139 (let ((key-a (nth 1 a))
6140 (key-b (nth 1 b)))
6141 (cond ((and (numberp key-a) (numberp key-b))
6142 (< key-a key-b))
6143 ((numberp key-b) t)))))
6144 'car-less-than-car))
6145 ;; Compute a list of allowed keys based on the first key
6146 ;; pressed, if any. Some keys
6147 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6148 ;; available.
6149 (allowed-keys
6150 (nconc (list 2 22 19 6 1)
6151 (if (not first-key) (org-uniquify (mapcar 'car entries))
6152 (let (sub-menu)
6153 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6154 (when (eq (car entry) first-key)
6155 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6156 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6157 ((not first-key) (list ?P)))
6158 (list ?& ?#)
6159 (when expertp (list ??))
6160 (list ?q)))
6161 ;; Build the help menu for standard UI.
6162 (help
6163 (unless expertp
6164 (concat
6165 ;; Options are hard-coded.
6166 (format "[%s] Body only: %s [%s] Visible only: %s
6167 \[%s] Export scope: %s [%s] Force publishing: %s
6169 (funcall fontify-key "C-b" t)
6170 (funcall fontify-value
6171 (if (memq 'body options) "On " "Off"))
6172 (funcall fontify-key "C-v" t)
6173 (funcall fontify-value
6174 (if (memq 'visible options) "On " "Off"))
6175 (funcall fontify-key "C-s" t)
6176 (funcall fontify-value
6177 (if (memq 'subtree options) "Subtree" "Buffer "))
6178 (funcall fontify-key "C-f" t)
6179 (funcall fontify-value
6180 (if (memq 'force options) "On " "Off"))
6181 (funcall fontify-key "C-a" t)
6182 (funcall fontify-value
6183 (if (memq 'async options) "On " "Off")))
6184 ;; Display registered back-end entries. When a key
6185 ;; appears for the second time, do not create another
6186 ;; entry, but append its sub-menu to existing menu.
6187 (let (last-key)
6188 (mapconcat
6189 (lambda (entry)
6190 (let ((top-key (car entry)))
6191 (concat
6192 (unless (eq top-key last-key)
6193 (setq last-key top-key)
6195 (funcall fontify-key (char-to-string top-key))
6196 (nth 1 entry)))
6197 (let ((sub-menu (nth 2 entry)))
6198 (unless (functionp sub-menu)
6199 ;; Split sub-menu into two columns.
6200 (let ((index -1))
6201 (concat
6202 (mapconcat
6203 (lambda (sub-entry)
6204 (incf index)
6205 (format
6206 (if (zerop (mod index 2)) " [%s] %-26s"
6208 (funcall fontify-key
6209 (char-to-string (car sub-entry))
6210 top-key)
6211 (nth 1 sub-entry)))
6212 sub-menu "")
6214 entries ""))
6215 ;; Publishing menu is hard-coded.
6217 [%s] Current file [%s] Current project
6219 (funcall fontify-key "P")
6220 (funcall fontify-key "f" ?P)
6221 (funcall fontify-key "p" ?P)
6222 (funcall fontify-key "x" ?P)
6223 (funcall fontify-key "a" ?P))
6225 (funcall fontify-key "&" t)
6226 (funcall fontify-key "#" t))
6227 (format "[%s] %s"
6228 (funcall fontify-key "q" t)
6229 (if first-key "Main menu" "Exit")))))
6230 ;; Build prompts for both standard and expert UI.
6231 (standard-prompt (unless expertp "Export command: "))
6232 (expert-prompt
6233 (when expertp
6234 (format
6235 "Export command (C-%s%s%s%s%s) [%s]: "
6236 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6237 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6238 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6239 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6240 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6241 (mapconcat (lambda (k)
6242 ;; Strip control characters.
6243 (unless (< k 27) (char-to-string k)))
6244 allowed-keys "")))))
6245 ;; With expert UI, just read key with a fancy prompt. In standard
6246 ;; UI, display an intrusive help buffer.
6247 (if expertp
6248 (org-export--dispatch-action
6249 expert-prompt allowed-keys entries options first-key expertp)
6250 ;; At first call, create frame layout in order to display menu.
6251 (unless (get-buffer "*Org Export Dispatcher*")
6252 (delete-other-windows)
6253 (org-switch-to-buffer-other-window
6254 (get-buffer-create "*Org Export Dispatcher*"))
6255 (setq cursor-type nil
6256 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6257 ;; Make sure that invisible cursor will not highlight square
6258 ;; brackets.
6259 (set-syntax-table (copy-syntax-table))
6260 (modify-syntax-entry ?\[ "w"))
6261 ;; At this point, the buffer containing the menu exists and is
6262 ;; visible in the current window. So, refresh it.
6263 (with-current-buffer "*Org Export Dispatcher*"
6264 ;; Refresh help. Maintain display continuity by re-visiting
6265 ;; previous window position.
6266 (let ((pos (window-start)))
6267 (erase-buffer)
6268 (insert help)
6269 (set-window-start nil pos)))
6270 (org-fit-window-to-buffer)
6271 (org-export--dispatch-action
6272 standard-prompt allowed-keys entries options first-key expertp))))
6274 (defun org-export--dispatch-action
6275 (prompt allowed-keys entries options first-key expertp)
6276 "Read a character from command input and act accordingly.
6278 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6279 a list of characters available at a given step in the process.
6280 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6281 EXPERTP are the same as defined in `org-export--dispatch-ui',
6282 which see.
6284 Toggle export options when required. Otherwise, return value is
6285 a list with action as CAR and a list of interactive export
6286 options as CDR."
6287 (let (key)
6288 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6289 ;; C-p, SPC, DEL).
6290 (while (and (setq key (read-char-exclusive prompt))
6291 (not expertp)
6292 (memq key '(14 16 ?\s ?\d)))
6293 (case key
6294 (14 (if (not (pos-visible-in-window-p (point-max)))
6295 (ignore-errors (scroll-up 1))
6296 (message "End of buffer")
6297 (sit-for 1)))
6298 (16 (if (not (pos-visible-in-window-p (point-min)))
6299 (ignore-errors (scroll-down 1))
6300 (message "Beginning of buffer")
6301 (sit-for 1)))
6302 (?\s (if (not (pos-visible-in-window-p (point-max)))
6303 (scroll-up nil)
6304 (message "End of buffer")
6305 (sit-for 1)))
6306 (?\d (if (not (pos-visible-in-window-p (point-min)))
6307 (scroll-down nil)
6308 (message "Beginning of buffer")
6309 (sit-for 1)))))
6310 (cond
6311 ;; Ignore undefined associations.
6312 ((not (memq key allowed-keys))
6313 (ding)
6314 (unless expertp (message "Invalid key") (sit-for 1))
6315 (org-export--dispatch-ui options first-key expertp))
6316 ;; q key at first level aborts export. At second level, cancel
6317 ;; first key instead.
6318 ((eq key ?q) (if (not first-key) (error "Export aborted")
6319 (org-export--dispatch-ui options nil expertp)))
6320 ;; Help key: Switch back to standard interface if expert UI was
6321 ;; active.
6322 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6323 ;; Send request for template insertion along with export scope.
6324 ((eq key ?#) (cons 'template (memq 'subtree options)))
6325 ;; Switch to asynchronous export stack.
6326 ((eq key ?&) '(stack))
6327 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6328 ((memq key '(2 22 19 6 1))
6329 (org-export--dispatch-ui
6330 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6331 (6 'force) (1 'async))))
6332 (if (memq option options) (remq option options)
6333 (cons option options)))
6334 first-key expertp))
6335 ;; Action selected: Send key and options back to
6336 ;; `org-export-dispatch'.
6337 ((or first-key (functionp (nth 2 (assq key entries))))
6338 (cons (cond
6339 ((not first-key) (nth 2 (assq key entries)))
6340 ;; Publishing actions are hard-coded. Send a special
6341 ;; signal to `org-export-dispatch'.
6342 ((eq first-key ?P)
6343 (case key
6344 (?f 'publish-current-file)
6345 (?p 'publish-current-project)
6346 (?x 'publish-choose-project)
6347 (?a 'publish-all)))
6348 ;; Return first action associated to FIRST-KEY + KEY
6349 ;; path. Indeed, derived backends can share the same
6350 ;; FIRST-KEY.
6351 (t (catch 'found
6352 (mapc (lambda (entry)
6353 (let ((match (assq key (nth 2 entry))))
6354 (when match (throw 'found (nth 2 match)))))
6355 (member (assq first-key entries) entries)))))
6356 options))
6357 ;; Otherwise, enter sub-menu.
6358 (t (org-export--dispatch-ui options key expertp)))))
6362 (provide 'ox)
6364 ;; Local variables:
6365 ;; generated-autoload-file: "org-loaddefs.el"
6366 ;; End:
6368 ;;; ox.el ends here